gsk_secure_socket_open()

Creates a secure socket connection.

Format

   #include <gskssl.h>

   gsk_status gsk_secure_socket_open (
                                       gsk_handle       env_handle,
                                       gsk_handle *     soc_handle)

Parameters

env_handle
Specifies the SSL environment handle returned by the gsk_environment_open() routine.
soc_handle
Returns the handle for the secure connection. The application should call the gsk_secure_socket_close() routine to release the connection when it is no longer needed.

Results

The function return value will be 0 (GSK_OK) if no error is detected. Otherwise, it will be one of the return codes listed in the gskssl.h include file. These are some possible errors:
[GSK_INSUFFICIENT_STORAGE]
Insufficient storage is available.
[GSK_INVALID_HANDLE]
The environment handle is not valid.
[GSK_INVALID_STATE]
The environment is not in the initialized state.

Usage

The gsk_secure_socket_open() routine creates a secure socket connection. The connection will be initialized with values obtained from the SSL environment. These values can be changed by the application using the appropriate gsk_attribute_set_*() routines. The gsk_secure_socket_init() routine should then be called to initialize the connection. This connection can then be used to send and receive data with the remote partner.

Related topics