Interface OCI::Connector

interface Connector

An interface for Connector objects. A Connector is used by CORBA clients to initiate a connection to a server. It also provides operations for the management of IOR profiles.

See Also:
ConFactory
Transport


Attribute Index

tag
The profile id tag.

Operation Index

connect
Used by CORBA clients to establish a connection to a CORBA server.
connect_timeout
Similar to connect, but it is possible to specify a timeout.
get_info
Returns the information object associated with the Connector.
is_usable
Checks whether this Connector can be used for a specific IOR.
is_usable_with_policies
Checks whether this Connector can be used for a specific IOR with a given set of polcies.

Attributes

tag
readonly attribute ProfileId tag;

The profile id tag.



Operations

connect
Transport connect();

Used by CORBA clients to establish a connection to a CORBA server. It returns a Transport object, which can be used for sending and receiving octet streams to and from the server.

Returns:
The new Transport object.

connect_timeout
Transport connect_timeout(in unsigned long timeout);

Similar to connect, but it is possible to specify a timeout. On return the caller can test whether there was a timeout by checking whether a nil object reference was returned.

Parameters:
timeout - The timeout value in milliseconds.
Returns:
The new Transport object.

get_info
ConnectorInfo get_info();

Returns the information object associated with the Connector.

Returns:
The Connector information object.

is_usable
ObjectKey is_usable(in IOR ior);

Checks whether this Connector can be used for a specific IOR. That is, the IOR must contain at least one profile that matches this Connector.

Parameters:
ior - The IOR to check for.
Returns:
The object key of the matching profile if the Connector can be used for the given IOR, or an empty object key otherwise.

is_usable_with_policies
ObjectKey is_usable_with_policies(in IOR ior,
                                  in CORBA::PolicyList policies);

Checks whether this Connector can be used for a specific IOR with a given set of polcies. That is, the IOR must contain at least one profile that matches this Connector and the Connector must also satisfy the provided list of policies for the given IOR.

Parameters:
ior - The IOR to check for.
policies - The policies that must be satisfied.
Returns:
The object key of the matching profile if the Connector can be used for the given IOR and policies, or an empty object key otherwise.


Generated by the ORBacus IDL-to-HTML translator (non-commercial)