System i: Programming Secure Sockets APIs - IBM

gsk_secure_soc_startRecv()—Start asynchronous receive operation on
a secure session
Syntax
#include
#include
int gsk_secure_soc_startRecv (gsk_handle my_session_handle,
int IOCompletionPort,
Qso_OverlappedIO_t * communicationsArea)
Service Program Name: QSYS/QSOSSLSR
Default Public Authority: *USE
Threadsafe: Yes
The gsk_secure_soc_startRecv() function is used to initiate an asynchronous receive operation on a secure
session. The supplied receive buffer cannot be reused by the calling application until the receive is
complete or the I/O completion port specified on the gsk_secure_soc_startRecv() has been destroyed.
This API supports sockets with an address family of AF_INET or AF_INET6 and type SOCK_STREAM
only.
Parameters
my_session_handle (Input)
The handle, returned from gsk_secure_soc_open() and used on the gsk_secure_soc_init() API call
that initialized the secure session over which data is to be read.
int IOCompletionPort (Input)
The I/O completion port that should be posted when the operation completes.
Qso_OverlappedIO_t * communicationsArea (Input/Output)
A pointer to a structure that contains the following information:
descriptorHandle (Input) - The descriptor handle is application specific and is never used by the system.
This field is intended to make it easier for the application to keep track of information
regarding a given socket connection.
buffer (Input) - A pointer to a buffer into which data should be read.
bufferLength (Input) - The length of the buffer into which data should be read. Also represents the
amount of data requested.
postFlag (Input) - The postFlag indicates if this operation should be posted to the I/O
completion port even if it completes immediately.
v A 0 value indicates that if the operation is already complete upon return to the
application, then do not post to the I/O completion port.
v A 1 value indicates that even if the operation completes immediately upon return to
the application, the result should still be posted to the I/O completion port.
postFlagResult (Output) - This field is valid if gsk_secure_soc_startRecv() returns with 1 and postFlag
was set to 1. In this scenario, postFlagResult set to 1 denotes the operation completed
and been posted to the I/O completion port specified. A value of 0 denotes the
operation could not be completed immediately, but will be handled asynchronously.
fillBuffer (Input) - The fillBuffer flag indicates when this operation should complete. If the
fillBuffer flag is 0, then the operation will complete as soon as any data is available to
be received. If the fillBuffer flag is non-zero, this operation will not complete until
enough data has been received to fill the buffer, an end-of-file condition occurs on the
socket, or an error occurs on a socket.
52 System i: Programming Secure Sockets APIs