System i: Programming Secure Sockets APIs - IBM

eturnValue (Output) - IF gsk_secure_soc_startRecv() completes synchronously (function return
value equals GSK_OK), then this field is set to GSK_OK and field secure data transfer
size indicates number of bytes received.
errnoValue (Output) - When the operation has completed asynchronously and returnValue is
GSK_ERROR_IO, this field will contain an errno further defining the failure.
operationCompleted (Output) - If the operation is posted to the I/O completion port, this field is updated
to indicate that the operation was a GSKSECURESOCSTARTRECV.
secureDataTransferSize (Output) - Number of bytes received when gsk_secure_soc_startRecv() completes
synchronously (return value equals GSK_OK).
bytesAvailable Not used.
operationWaitTime (Input) - A timeval structure which specifies the maximum time allowed for this
operation to complete asynchronously.
struct timeval {
long tv_sec; /* second */
long tv_usec; /* microseconds */
};
If this timer expires, the operation will be posted to the I/O completion port with
errnoValue set to EAGAIN.
If this field is set to zero, the operation’s asynchronous completion will not be timed.
If socketDescriptor is closed before the operation completes or times out, the operation
will be posted to the I/O completion port with errnoValue set to ECLOSED.
The minimum operationWaitTime is 1 second. The microseconds field (tv_usec) in the
timeval is not used and must be set to zero.
postedDescriptor Not used - Must be set to zero.
operationId (Input) - An identifier to uniquely identify this operation or a group of operations. It
can be set with the return value from QsoGenerateOperationId() or with an
application-defined value.
This value is preserved but ignored by all APIs except QsoCancelOperation() and
QsoIsOperationPending().
reserved1 (Output) - Must be set to hexadecimal zeroes.
reserved2 (Input) - Must be set to hexadecimal zeroes.
Authorities
No authorization is required.
Return Values
gsk_secure_soc_startRecv() returns an integer. Possible values are:
v GSK_OK - The function has completed synchronously. The Qso_OverlappedIO_t communications
structure has been updated but nothing has nor will be posted to the I/O completion port for this
operation. Inspect field secureDataTransferSize in the Qso_OverlappedIO_t communications structure
to determine the number of bytes received.
v GSK_AS400_ASYNCHRONOUS_RECV - The function has been started. When the function completes
(or times out if operationWaitTime was specified), the Qso_OverlappedIO_t communications structure
will be updated with the results and the I/O completion port will be posted.
v If the function fails, possible values are:
[GSK_INVALID_HANDLE]
Secure Sockets APIs 53