Interface OCI::Acceptor

interface Acceptor

An interface for an Acceptor object, which is used by CORBA servers to accept client connection requests. It also provides operations for the management of IOR profiles.

See Also:
AccRegistry
Transport


Attribute Index

handle
The "handle" for this Acceptor.
tag
The profile id tag.

Operation Index

accept
Used by CORBA servers to accept client connection requests.
add_profile
Adds a new profile that matches this Acceptor to an IOR.
close
Closes the Transport.
get_info
Returns the information object associated with the Acceptor.
is_local
Checks whether an IOR is for a local object, taking only profiles into account matching this Acceptor.
listen
Sets the acceptor up to listen for incoming connections.
shutdown
Shuts down the Transport.

Attributes

handle
readonly attribute Handle handle;

The "handle" for this Acceptor. Like with the handle for Transports, the handle may only be used with operations like select(). A handle value of -1 indicates that the protocol plug-in does not support "selectable" Transports.


tag
readonly attribute ProfileId tag;

The profile id tag.



Operations

accept
Transport accept();

Used by CORBA servers to accept client connection requests. It returns a Transport object, which can be used for sending and receiving octet streams to and from the client.

Returns:
The new Transport object.

add_profile
void add_profile(in ObjectKey key,
                 inout IOR ior);

Adds a new profile that matches this Acceptor to an IOR.

Parameters:
key - The object key to use for the new profile.
ior - The IOR.

close
void close();

Closes the Transport. accept or listen must not be called after close has been called.


get_info
AcceptorInfo get_info();

Returns the information object associated with the Acceptor.

Returns:
The Acceptor information object.

is_local
ObjectKey is_local(in IOR ior);

Checks whether an IOR is for a local object, taking only profiles into account matching this Acceptor.

Parameters:
ior - The IOR to check for.
Returns:
If the IOR is for a local object, the object key for that local object, or an empty object key otherwise.

listen
void listen();

Sets the acceptor up to listen for incoming connections. Until this method is called on the acceptor, new connection requests should result in a connection request failure.


shutdown
void shutdown();

Shuts down the Transport. After calling shutdown, calls to accept or listen result in an appropriate CORBA::COMM_FAILURE exception being raised.



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