Change Connection Attribute (QTOCCCNA) API
| 1 | Change information | Input | Char(*) |
| 2 | Length of change information | Input | Binary(4) |
| 3 | Change information format | Input | Char(8) |
| 4 | Error code | I/O | Char(*) |
Threadsafe: Yes
The Change Connection Attribute (QTOCCCNA) API can change the attribute of a socket or connection directly. A valid socket descriptor is not required. Instead, the socket or connection to be changed is identified by specifying the associated port and IP address information.
The SO_DEBUG socket option is the only attribute that can be changed.
Authorities and Locks
- Default public authority
- *EXCLUDE.
Required Parameter Group
- Change information
- INPUT; CHAR(*)
The socket or connection that is changed.
- Change information format
- INPUT; CHAR(8)
The format of the change information input data. The possible values are:
TCPA0001 Change the connection attribute of a connection. The connection is identified by specifying the local and remote values for the IP address and port number. See TCPA0001 Format below. UDPA0001 Change the connection attribute of a socket. The socket is identified by specifying its local IP address and local port number. See UDPA0001 Format below. TCPA0101 Change the connection attribute of a connection. The connection is identified by specifying the local and remote values for the IPv6 address and port number. See TCPA0101 Format below. UDPA0101 Change the connection attribute of a socket. The socket is identified by specifying its local IPv6 address and local port number. See UDPA0101 Format below.
- Length of change information
- INPUT; BINARY(4)
The total length in bytes of the change information input variable.
- Error code
- I/O; CHAR(*)
The structure in which to return error information. For the format of the structure, see Error code parameter. If this parameter is omitted, diagnostic and escape messages are issued to the application.
TCPA0001 Format
Use this format when changing a connection. For detailed descriptions of the fields in this table, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Attribute to change |
| 4 | 4 | BINARY(4) | Attribute value |
| 8 | 8 | BINARY(4) | Local IP address binary |
| 12 | C | BINARY(4) | Local port number |
| 16 | 10 | BINARY(4) | Remote IP address binary |
| 20 | 14 | BINARY(4) | Remote port number |
| 24 | 18 | ||
UDPA0001 Format
Use this format when changing a socket. For detailed descriptions of the fields in this table, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Attribute to change |
| 4 | 4 | BINARY(4) | Attribute value |
| 8 | 8 | BINARY(4) | Local IP address binary |
| 12 | C | BINARY(4) | Local port number |
| 16 | 10 | ||
Field Descriptions
Attribute to change. The possible value is:
| 1 | Change the debug attribute (SO_DEBUG socket option) of the connection. |
Attribute value. Possible values are:
| 0 | The debug attribute is not set. |
| 1 | The debug attribute is set. |
Local IP address. The local internet address used by the connection in binary form.
Local port number. The local system port number used by the connection.
Remote IP address. The remote internet address used by the connection in binary form.
Remote port number. The remote system port number used by the connection.
TCPA0101 Format
Use this format when changing an IPv6 connection. For detailed descriptions of the fields in this table, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Attribute to change |
| 4 | 4 | BINARY(4) | Attribute value |
| 8 | 8 | CHAR(16) | Local IPv6 address binary |
| 24 | 18 | BINARY(4) | Local port number |
| 28 | 1C | CHAR(16) | Remote IPv6 address binary |
| 44 | 2C | BINARY(4) | Remote port number |
| 48 | 30 | ||
UDPA0101 Format
Use this format when changing an IPv6 socket. For detailed descriptions of the fields in this table, see Field Descriptions.
| Offset | Type | Field | |
|---|---|---|---|
| Dec | Hex | ||
| 0 | 0 | BINARY(4) | Attribute to change |
| 4 | 4 | BINARY(4) | Attribute value |
| 8 | 8 | CHAR(16) | Local IPv6 address binary |
| 24 | 18 | BINARY(4) | Local port number |
| 28 | 1C | ||
Field Descriptions
Attribute to change. The possible value is:
| 1 | Change the debug attribute (SO_DEBUG socket option) of the connection. |
Attribute value. Possible values are:
| 0 | The debug attribute is not set. |
| 1 | The debug attribute is set. |
Local IPv6 address. The local IPv6 address used by the connection in binary form.
Local port number. The local system port number used by the connection.
Remote IPv6 address. The remote IPv6 address used by the connection in binary form.
Remote port number. The remote system port number used by the connection.
Error Messages
| Message ID | Error Message Text |
|---|---|
| CPF3C17 E | Error occurred with input data parameter. |
| CPF3C21 E | Format name &1 is not valid. |
| CPF3C1E E | Required parameter &1 omitted. |
| CPF3CF1 E | Error code parameter not valid. |
| CPF3CF2 E | Error(s) occurred during running of &1 API. |
| CPF9872 E | Program or service program &1 in library &2 ended. Reason code &3. |
| TCP3842 E | Error processing internal data request. |
| TCP3B03 E | Connection &1:&2, &3:&4, not found. |
| TCP3B04 E | Socket &1:&2, &3:&4, not found. |
| TCP84C0 E | TCP/IP stack not active. |
| TCP8A0B E | IPv6 internal error - &1. |
| TCP923F E | Value for parameter &2 for API &1 not valid. |
API introduced: V5R1