| 1 |
tlsio_cyclonessl_socket |
| 2 |
============= |
| 3 |
|
| 4 |
## Overview |
| 5 |
|
| 6 |
tlsio_cyclonessl_socket provides an implementation for creating/destroying BSD sockets to be used by the CycloneSSL TLS library. |
| 7 |
|
| 8 |
## References |
| 9 |
|
| 10 |
[CycloneSSL official page](http://www.oryx-embedded.com/cyclone_ssl.html) |
| 11 |
|
| 12 |
## Exposed API |
| 13 |
|
| 14 |
```c |
| 15 |
MOCKABLE_FUNCTION(, int, tlsio_cyclonessl_socket_create, const char*, hostname, int, port, TlsSocket* new_socket); |
| 16 |
MOCKABLE_FUNCTION(, void, tlsio_cyclonessl_socket_destroy, TlsSocket, socket); |
| 17 |
``` |
| 18 |
|
| 19 |
### tlsio_cyclonessl_socket_create |
| 20 |
|
| 21 |
```c |
| 22 |
int tlsio_cyclonessl_socket_create(const char* hostname, int port, TlsSocket* new_socket); |
| 23 |
``` |
| 24 |
|
| 25 |
**SRS_TLSIO_CYCLONESSL_SOCKET_BSD_01_001: [** tlsio_cyclonessl_socket_create shall create a new socket to be used by CycloneSSL. **]** |
| 26 |
|
| 27 |
**SRS_TLSIO_CYCLONESSL_SOCKET_BSD_01_008: [** On success tlsio_cyclonessl_socket_create shall return 0 and fill in the socket handle in the new_socket out argument. **]** |
| 28 |
|
| 29 |
**SRS_TLSIO_CYCLONESSL_SOCKET_BSD_01_002: [** If hostname or new_socket is NULL, then tlsio_cyclonessl_socket_create shall fail and it shall return a non-zero value. **]** |
| 30 |
|
| 31 |
**SRS_TLSIO_CYCLONESSL_SOCKET_BSD_01_003: [** tlsio_cyclonessl_socket_create shall call socket to create a TCP socket. **]** |
| 32 |
|
| 33 |
**SRS_TLSIO_CYCLONESSL_SOCKET_BSD_01_004: [** tlsio_cyclonessl_socket_create shall call getaddrinfo to obtain a hint ADDRINFO. **]** |
| 34 |
|
| 35 |
**SRS_TLSIO_CYCLONESSL_SOCKET_BSD_01_006: [** tlsio_cyclonessl_socket_create shall call connect and pass the constructed address in order to connect the socket. **]** |
| 36 |
|
| 37 |
**SRS_TLSIO_CYCLONESSL_SOCKET_BSD_01_007: [** If any of the socket calls fails, then tlsio_cyclonessl_socket_create shall fail and return a non-zero value. **]** |
| 38 |
|
| 39 |
### tlsio_cyclonessl_socket_destroy |
| 40 |
|
| 41 |
```c |
| 42 |
void tlsio_cyclonessl_socket_destroy(TlsSocket socket) |
| 43 |
``` |
| 44 |
|
| 45 |
**SRS_TLSIO_CYCLONESSL_SOCKET_BSD_01_009: [** tlsio_cyclonessl_socket_destroy shall close the socket passed as argument by calling the function close. **]** |
| 46 |
|
| 47 |
**SRS_TLSIO_CYCLONESSL_SOCKET_BSD_01_010: [** If socket is INVALID_SOCKET (-1), tlsio_cyclonessl_socket_destroy shall do nothing. **]** |