Local Interface SL3TCPIP::TCPIPArgBuilder

Local Interface SL3TCPIP::TCPIPArgBuilder

local interface TCPIPArgBuilder
    inherits from SL3AQArgs::GenericArgBuilder
An object of this interface is created by the Argument Factory Object. It aids in creating the Credentials Acquisition Argument for TCPIP based Transport Credentials.

Operation Index

addSupportCSIv1
This operation adds Transport Credentials CSIv1 protocol version capability.
addSupportCSIv2
This operation adds Transport Credentials CSIv2 protocol version capability.
addTCPIPAcceptorOptions
This operation adds Transport Credentials Acceptor Options to the acquisition argument.
addTCPIPInitiatorOptions
This operation adds Transport Credentials Initiator Options to the acquisition argument.

Operations

addSupportCSIv1
void addSupportCSIv1(in boolean support);

This operation adds Transport Credentials CSIv1 protocol version capability.

Parameters:
support - If false, the associated transports will always be expected to carry CSIv2 information. Default is true. For CSIv2 capability without the ability to use these credentials for CSIv1 transports, this argument must be explicitly stated with a value of false.

addSupportCSIv2
void addSupportCSIv2(in boolean support);

This operation adds Transport Credentials CSIv2 protocol version capability.

Parameters:
support - If false, the associated transports will not, or be expected to carry CSIv2 information. If true, they must, if CSIv1 support is false. It's default value is false.

addTCPIPAcceptorOptions
void addTCPIPAcceptorOptions(in CORBA::StringSeq hosts,
                             in string bind,
                             in long low_port,
                             in long high_port,
                             in long backlog,
                             in boolean numeric);

This operation adds Transport Credentials Acceptor Options to the acquisition argument. This argument is only relevant when the Credentials Usage include Accept.

Parameters:
hosts - This operation contains a list of "hosts", or addresses that should be placed in the IOR of objects associated with these credentials.
bind - This argument contains the interface to which to bind. An empty string signifies to use the operating system default.
low_port - If this argument is 0, the system select the port. If this argument is not 0, then connections will attempt to bind to this port or higher.
high_port - If low_port is not 0, and this argument is greater than or equal to low_port, then the lowest available port within the range will be selected.
backlog - Socket Listening Backlog. 0 means use operating system default.
numeric - If this argument is true, all addresses associated with these credentials that are placed in IORs will be in numeric form.

addTCPIPInitiatorOptions
void addTCPIPInitiatorOptions(in string bind,
                              in long low_port,
                              in long high_port,
                              in long timeout);

This operation adds Transport Credentials Initiator Options to the acquisition argument. This argument is only relevant when the Credentials Usage include Initiate.

Parameters:
bind - This argument contains the interface to which to bind. An empty string signifies to use the operating system default.
low_port - If this argument is 0, the system select the port. If this argument is not 0, then connections will attempt to bind to this port or higher.
high_port - If low_port is not 0, and this argument is greater than or equal to low_port, then the lowest available port within the range will be selected.
timeout - Timeout (in milliseconds) for connection establishment. The value 0 indicates an indefinite wait.

Generated by the ORBacus IDL-to-HTML translator