SSLSocket

Secure socket functions.

dmSSLSocket::Result

result enumeration

Result enumeration.

MEMBERS

dmSSLSocket::RESULT_OK - (0)

dmSSLSocket::RESULT_SSL_INIT_FAILED - (-2000)

dmSSLSocket::RESULT_HANDSHAKE_FAILED - (-2001)

dmSSLSocket::RESULT_WOULDBLOCK - (-2002)

dmSSLSocket::RESULT_CONNREFUSED - (-2003)


Socket

Socket type definition

Socket type definition


dmSSLSocket::INVALID_SOCKET_HANDLE

SSLSocket socket handle

SSLSocket socket handle


dmSSLSocket::New(socket, host, timeout, sslsocket)

create a secure socket

Create a new secure socket

PARAMETERS

socket - The socket to wrap

host - The name of the host (e.g. "httpbin.org")

timeout - The timeout for the handshake procedure. (microseconds)

sslsocket - Pointer to a secure socket

RETURN

RESULT_OK - on succcess

EXAMPLES

dmSSLSocket::Result result;
dmSSLSocket::Socket sslsocket;
result = dmSSLSocket::New(socket, "httpbin.org", 500*1000, &sslsocket);
if (dmSSLSocket::RESULT_OK == result)
{
    // ...
} else {
    // ...
}


dmSSLSocket::Delete(socket)

delete a secure socket

Delete a secure socket. Does not close the underlying socket

PARAMETERS

socket - Secure socket to close

RETURN

RESULT_OK - on success

EXAMPLES

dmSSLSocket::Delete(sslsocket);


dmSSLSocket::Send(socket, buffer, length, sent_bytes)

send a message on a secure socket

Send a message on a secure socket

PARAMETERS

socket - SSL socket to send a message on

buffer - Buffer to send

length - Length of buffer to send

sent_bytes - Number of bytes sent (result)

RETURN

RESULT_OK - on success


dmSSLSocket::Receive(socket, buffer, length, received_bytes)

receive data on a secure socket

Receive data on a secure socket

PARAMETERS

socket - Socket to receive data on

buffer - Buffer to receive to

length - Receive buffer length

received_bytes - Number of received bytes (result)

RETURN

RESULT_OK - on success


dmSocket::SetReceiveTimeout(socket, timeout)

Set socket receive timeout

Set socket receive timeout

PARAMETERS

socket - socket

timeout - timeout in microseconds

RETURN

RESULT_OK - on success