TCP

A TCP Integration Channel.

Properties

backlog : nonNegativeInt

The server backlog size (the maximum number of pending connections that are waiting to be accepted by the listener). If the value is 0, then the system default value will be used.

Valid values based on“int”.
0 (minInclusive)

category : string

The category of the channel.

combine

Resolution algorithm for multiple bound services processing the same message. (Default none - meaning multiple services with the same message is not supported)

Valid values based on“string”.
none	Multiple services declaring the same message in their associated Interface Request messages are not supported. (Default)
first	Only the first one among the bound services with a matching message in their Interface Request messages is invoked.
all	All the services with a matching message in their Interface Request messages are invoked. When multiple services are bound to a channel and a message is forwarded to more than one of those services, the initial "this" variable in those services refers to the same object. This should be taken into account if the original message object can be updated in any of the services – you might want to modify a copy of the message instead.

connectionTimeout : nonNegativeInt

Timeout in milliseconds for establishing TCP connections, 0 for infinite timeout.

Valid values based on“int”.
0 (minInclusive)

defaultUser : string

User account for processing the TCP messages.

description : string

Channel description.

encoding : string

Character encoding for string messages. If not specified, the messages are binary.

idle : boolean

True to disable the channel if it is not used by an enabled channel.

idleTimeout : nonNegativeInt

The number of minutes this channel will be allowed to remain inactive before it is forcibly closed. A value of zero indicates an infinite limit.

This timeout only applies to inactivity between messages. For inactivity while receiving a message, refer to the "readTimeout" property.

Valid values based on“int”.
0 (minInclusive)

keepAlive : boolean

True if the TCP keep-alive property should be set on the underlying socket.

localHost : string

Local hostname or IP address to listen on. If not specified, then "localhost".

localPort : unsignedShort

Local TCP port (0 or empty for a random port).

maxReceivers : nonNegativeInt

Maximum TCP receiver threads per server.

Valid values based on“int”.
0 (minInclusive)

maxSenders : integer

Maximum TCP sender connections per server, -1 for unlimited.

noDelay : boolean

True if the TCP no-delay property should be set on the underlying socket.

queue : identifier

Message queue where to forward the received messages.

Valid values based on“string”.
:?[\p{L}_][\p{L}\p{N}_](:[\p{L}_][\p{L}\p{N}_])*	Value must begin with a letter or an underscore. Case and length are not restricted. Letters, numbers and underscores are allowed. Colon is used as a scope separator. Spaces and other punctuation characters are not allowed.

receive : boolean

True if the channel can receive messages.

receiverBufferSize : nonNegativeInt

The SO_RCVBUF option for the underlying socket, 0 for system default.

Valid values based on“int”.
0 (minInclusive)

receiverReadTimeout : nonNegativeInt

The TCP Receiver's message read timeout in milliseconds. This is the maximum time the TCP Receiver will block while in the process of receiving a message. If a timeout occurs, a nexj.core.rpc.tcp.TCPTimeoutException will be thrown. A value of zero indicates an infinite timeout.

Valid values based on“int”.
0 (minInclusive)

remotePort : positiveUnsignedShort

Remote TCP port.

Valid values based on“unsignedShort”.
1 (minInclusive)

resolve : boolean

True to resolve ip addresses to hostnames.

secure : boolean

True if this channel should use SSL/TLS.

send : boolean

True if the channel can send messages.

senderBufferSize : nonNegativeInt

The SO_SNDBUF option for the underlying socket, 0 for system default.

Valid values based on“int”.
0 (minInclusive)

senderReadTimeout : nonNegativeInt

The TCP Sender's message read timeout in milliseconds. This is the maximum time the TCP Sender will block while in the process of receiving a response message. If a timeout occurs, a nexj.core.rpc.tcp.TCPTimeoutException will be thrown. A value of zero indicates an infinite timeout.

Valid values based on“int”.
0 (minInclusive)

splitter : string

The name of the associated message stream factory component.

stealth : boolean

True to supress the debug logging, unless nexj.system.core.meta.integration.Channel.<name> category dump logging is enabled.

tos : unsignedByte

RFC 1349 type-of-service value (sum of lowCost=2, reliability=4, throughput=8, lowDelay=16).

warningTimeout : nonNegativeLong

Timeout in milliseconds before a warning is generated, 0 for infinite timeout.

Valid values based on“long”.
0 (minInclusive)

Content

Sequence of:
- t_Channel_SenderProperties [0..1]
- t_Channel_ReceiverProperties [0..1]
- t_Channel_ServiceBindings [0..1] - Services bound to the incomming traffic on the channel.

t_Channel_SenderProperties
t_Channel_ReceiverProperties
t_Channel_ServiceBindings
Services bound to the incomming traffic on the channel.

Parent topic: references