Parameter values set by the application

S

A value or the address of a halfword binary number specifying the socket descriptor.

MSG

On input, a pointer to a message header into which the message is received upon completion of the call.

Field

Description

NAME

On input, a pointer to a buffer where the sender address is stored upon completion of the call. The storage being pointed to should be for an IPv4 socket address or an IPv6 socket address. The IPv4 socket address structure contains the following fields:

Field: Description
FAMILY: Output parameter. A halfword binary number specifying the IPv4 addressing family. The value for IPv4 socket descriptor (S parameter) is decimal 2, indicating AF_INET.
PORT: Output parameter. A halfword binary number specifying the port number of the sending socket.
IP-ADDRESS: Output parameter. A fullword binary number specifying the 32-bit IPv4 IP address of the sending socket.
RESERVED: Output parameter. An 8-byte reserved field. This field is required, but is not used.

The IPv6 socket address structure contains the following fields:

Field: Description
FAMILY: Output parameter. A halfword binary number specifying the IPv6 addressing family. The value for IPv6 socket descriptor (S parameter) is decimal 19, indicating AF_INET6.
PORT: Output parameter. A halfword binary number specifying the port number of the sending socket.
FLOWINFO: A fullword binary field specifying the traffic class and flow label. This value of this field is undefined.
IP–ADDRESS: Output parameter. A 16 byte binary field specifying the 128–bit IPv6 IP address, in network byte order, of the sending socket.
SCOPE-ID: A fullword binary field which identifies a set of interfaces as appropriate for the scope of the address carried in the IPv6-ADDRESS field. For a link scope IPv6-ADDRESS, SCOPE-ID contains the link index for the IPv6-ADDRESS. For all other address scopes, SCOPE-ID is undefined.

NAME-LEN

On input, a pointer to the size of the NAME.

IOV

On input, a pointer to an array of tripleword structures with the number of structures equal to the value in IOVCNT and the format of the structures as follows:

Fullword 1: A pointer to the address of a data buffer. This data buffer must be in the home address space.
Fullword 2: Reserved. This storage will be cleared.
Fullword 3: A pointer to the length of the data buffer referenced in fullword 1.

In COBOL, the IOV structure must be defined separately in the Linkage section, as shown in the example.

IOVCNT

On input, a pointer to a fullword binary field specifying the number of data buffers provided for this call.

ACCRIGHTS

On input, a pointer to the access rights received. This field is ignored.

ACCRLEN

On input, a pointer to the length of the access rights received. This field is ignored.

FLAGS

A fullword binary field with values as follows:

Literal Value	Binary Value	Description
NO-FLAG	X'00000000'	Read data.
MSG-OOB	X'00000001'	Receive out-of-band data (stream sockets only). Even if the OOB flag is not set, out-of-band data can be read if the SO-OOBINLINE option is set for the socket.
MSG-PEEK	X'00000002'	Peek at the data, but do not destroy data. If the peek flag is set, the next receive operation reads the same data.
MSG-WAITALL	X'00000040'	Requests that the function block until the requested amount of data can be returned (stream sockets only). The function might return a smaller amount of data if the connection is closed, if an error is pending, or if the SO_RCVTIMEO field is set and the timer has expired for the socket.