org.jacorb.orb.etf
Class ListenerBase

java.lang.Object
  _ListenerLocalBase
      org.jacorb.orb.etf.ListenerBase

All Implemented Interfaces:

org.apache.avalon.framework.configuration.Configurable

Direct Known Subclasses:

IIOPListener

public abstract class ListenerBase
extends _ListenerLocalBase
implements org.apache.avalon.framework.configuration.Configurable

Version:

$Id: ListenerBase.java,v 1.4 2006/06/26 08:09:30 alphonse.bendt Exp $

Author:

Andre Spiegel

Nested Class Summary

protected class

ListenerBase.Acceptor

Field Summary

protected ListenerBase.Acceptor	acceptor The primary acceptor of this listener.
protected org.jacorb.config.Configuration	configuration The configuration.
protected org.apache.avalon.framework.logger.Logger	logger The logger.
protected ORB	orb The ORB.
protected Profile	profile The profile of this listener's endpoint.
protected org.omg.ETF.Handle	up Reference to the ORB, for delivering incoming connections via upcalls.

Constructor Summary

ListenerBase()

Method Summary

Connection	accept() This call is an alternative to using set_handle() to initiate the callback-style of accepting new connections.
void	completed_data(Connection conn) The connection instance is returned to the Listener.
void	configure(org.apache.avalon.framework.configuration.Configuration config)
protected void	deliverConnection(Connection connection) Method the Acceptor implementation should call to pass an opened connection to the ORB.
void	destroy() The Listener is instructed to close its endpoint.
Profile	endpoint() Returns a copy of the profile describing the endpoint of this instance.
void	listen() It is possible that connection requests arrive after the initial creation of the Listener instance but before the conclusion of the configuration of the specific endpoint in this plugin.
void	set_handle(Handle up) This call establishes the link between the ORB (i.e.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

orb

protected ORB orb

The ORB.

profile

protected Profile profile

The profile of this listener's endpoint.

acceptor

protected ListenerBase.Acceptor acceptor

The primary acceptor of this listener.

configuration

protected org.jacorb.config.Configuration configuration

The configuration.

logger

protected org.apache.avalon.framework.logger.Logger logger

The logger.

up

protected org.omg.ETF.Handle up

Reference to the ORB, for delivering incoming connections via upcalls.

Constructor Detail

ListenerBase

public ListenerBase()

Method Detail

configure

public void configure(org.apache.avalon.framework.configuration.Configuration config)
               throws org.apache.avalon.framework.configuration.ConfigurationException

Specified by:

configure in interface org.apache.avalon.framework.configuration.Configurable

Throws:

org.apache.avalon.framework.configuration.ConfigurationException

set_handle

public void set_handle(Handle up)

This call establishes the link between the ORB (i.e. the Handle instance) and a server endpoint of the plugged-in transport. All calls upwards into the ORB shall use the given instance.

listen

public void listen()

It is possible that connection requests arrive after the initial creation of the Listener instance but before the conclusion of the configuration of the specific endpoint in this plugin. In order to provide a clear end of this configuration state, we added the listen() method. It is called by the ORB when it ready for incoming connection and thus signals the Listener instance to start processing the incoming connection requests. Therefore, a Listener instance shall not deliver incoming connections to the ORB before this method was called.

deliverConnection

protected void deliverConnection(Connection connection)

Method the Acceptor implementation should call to pass an opened connection to the ORB.

accept

public Connection accept()

This call is an alternative to using set_handle() to initiate the callback-style of accepting new connections. This call blocks until a client connects to the server. Then a new Connection instance is returned. The transport plug-in must ensure that a thread blocked in accept() returns when destroy() is called with a null object reference. The transport plug-in must raise the CORBA::BAD_INV_ORDER with minor code {TBD} if the ORB calls this operation and set_handle() has ever been called previously on the same listener instance.

completed_data

public void completed_data(Connection conn)

The connection instance is returned to the Listener. It now shall signal any incoming data to the Handle.

destroy

public void destroy()

The Listener is instructed to close its endpoint. It shall no longer accept any connection requests and shall close all connections opened by it.

endpoint

public Profile endpoint()

Returns a copy of the profile describing the endpoint of this instance.