The RECVMSG macro receives messages on a socket with descriptor s and stores them in an array of message headers. If a datagram packet is too long to fit in the supplied buffer, datagram sockets discard extra bytes.

Keyword

Description

S

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

MSG

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

NAME

On input, a pointer to a buffer where the sender's IPv4 or IPv6 address will be stored on completion of the call. The storage being pointed to should be for an IPv4 or IPv6 socket address. Include the SYS1.MACLIB(BPXYSOCK) macro to get the assembler mappings for the socket address structure. The socket address structure mappings begin at the SOCKADDR label. The AF_INET socket address structure fields start at the SOCK_SIN label. The AF_INET6 socket address structure fields start at the SOCK_SIN6 label.

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 the IPv4 socket descriptor (S parameter) is a decimal 2, indicating AF_INET.

PORT

Output parameter. A halfword binary number specifying the port number of the sending socket.

IPv4-ADDRESS

Output parameter. A fullword binary number specifying the 32-bit IPv4 Internet 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

NAMELEN

Output parameter. A 1-byte binary field specifying the length of this IPv6 socket address structure. Any value specified by the use of this field is ignored when processed as input and the field is set to 0 when processed as output.

FAMILY

Output parameter. A 1-byte binary field specifying the IPv6 addressing family. The value for the IPv6 socket descriptor (S parameter) is a decimal 19, indicating AF_INET6.

PORT

Output parameter. A halfword binary number specifying the port number of the sending socket.

FLOW-INFO

Output parameter. A fullword binary field specifying the traffic class and flow label. This value of this field is undefined.

IPv6-ADDRESS

Output parameter. A 16-byte binary field specifying the 128-bit IPv6 Internet 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.

IOV

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

Fullword 1

Input parameter. The address of a data buffer.

Fullword 2

Input parameter. The ALET for this buffer. If the buffer is in the primary address space, this should be zeros.

If a nonzero ALET is specified, the ALET must represent a valid entry in the dispatchable unit access list (DU-AL) for the task issuing this call. Note that ALETs can only be specified for synchronous socket calls (for example, ECB/REQAREA cannot be specified). An exception to this is an ALET representing a SCOPE=COMMON data space.

Fullword 3

Input parameter. The length of the data buffer referenced in Fullword 1.

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.

ERRNO

Output parameter. A fullword binary field. If RETCODE is negative, this contains an error number.

RETCODE

Output parameter. A fullword binary field with the following values:

Value

Description

-1

Call returned error. See ERRNO field.

0

Connection partner has closed connection.

>0

Number of bytes read.

FLAGS

Input parameter. FLAGS can be a literal value or a fullword binary field.

Literal Value	Binary Value	Description
'MSG_OOB'	X'00000001'	Receive out-of-band data (stream sockets only). Out-of-band data can be read if the SO_OOBINLINE option is set for the socket regardless of whether the MSG_OOB flag is set.
'MSG_PEEK'	X'00000002'	Peek at the data, but do not destroy the 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 full amount of requested data can be returned (stream sockets only). The function might return a smaller amount of data if the connection is terminated, if an error is pending, or if the SO_RCVTIMEO field is set and the timer expired for the socket.

ECB or REQAREA

Input parameter. This parameter is required if you are using APITYPE=3. It points to a 104-byte field containing:

For ECB

A 4-byte ECB posted by TCP/IP when the macro completes.

For REQAREA

A 4-byte user token (set by you) that is presented to your exit when the response to this function request is complete.

For ECB/REQAREA

The last 100 bytes is a storage field used by the interface to save the state information.

Note: This storage must not be modified until the macro function has completed and the ECB has been posted, or the asynchronous exit has been driven.

ERROR

Input parameter. The location in your program to receive control when the application programming interface (API) processing module cannot be loaded.

TASK

Input parameter. The location of the task storage area in your program.