|
|||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||
Defines generic behavior for the server
part of a connector or an adaptor. Most connectors or adaptors extend CommunicatorServer
and inherit this behavior. Connectors or adaptors that do not fit into this model do not extend
CommunicatorServer.
An CommunicatorServer is an active object, it listens for client requests
and processes them in its own thread. When necessary, a CommunicatorServer
creates other threads to process multiple requests concurrently.
A CommunicatorServer object can be stopped by calling the stop
method. When it is stopped, the CommunicatorServer no longer listens to client
requests and no longer holds any thread or communication resources.
It can be started again by calling the start method.
A CommunicatorServer has a state property which reflects its
activity.
| CommunicatorServer | State |
|---|---|
stopped | OFFLINE |
starting | STARTING |
running | ONLINE |
stopping | STOPPING |
The STARTING state marks the transition from OFFLINE to
ONLINE.
The STOPPING state marks the transition from ONLINE to
OFFLINE. This occurs when the CommunicatorServer is
finishing or interrupting active requests.
A CommunicatorServer may serve several clients concurrently. The
number of concurrent clients can be limited using the property
maxActiveClientCount. The default value of this property is
defined by the subclasses.
When a CommunicatorServer is unregistered from the MBeanServer,
it is stopped automatically.
| Method Summary | |
String |
getHost()
Gets the host name used by this CommunicatorServer. |
int |
getPort()
Gets the port number used by this CommunicatorServer. |
String |
getProtocol()
Gets the protocol being used by this CommunicatorServer. |
int |
getState()
Gets the state of this CommunicatorServer as an integer. |
String |
getStateString()
Gets the state of this CommunicatorServer as a string. |
boolean |
isActive()
Tests if the CommunicatorServer is active. |
void |
setPort(int port)
Sets the port number used by this CommunicatorServer. |
void |
start()
Starts this CommunicatorServer. |
void |
stop()
Stops this CommunicatorServer. |
boolean |
waitState(int state,
long timeout)
Waits until either the State attribute of this MBean equals the specified state parameter, or the specified timeout has elapsed. |
| Method Detail |
public void start()
CommunicatorServer.
Has no effect if this CommunicatorServer is ONLINE or
STOPPING.
public void stop()
CommunicatorServer.
Has no effect if this CommunicatorServer is OFFLINE or
STOPPING.
public boolean isActive()
CommunicatorServer is active.
ONLINE; false otherwise.
public boolean waitState(int state,
long timeout)
waitState returns with a boolean value indicating whether
the specified state parameter equals the value of this
MBean's State attribute at the time the method terminates.
Two special cases for the timeout parameter value are:
waitState
returns immediately (i.e. does not wait at all),waitState
waits until the value of this MBean's State attribute
is the same as the state parameter (i.e. will wait
indefinitely if this condition is never met).
state - The value of this MBean's State attribute to wait for.
state can be one of:
CommunicatorServer.OFFLINE,
CommunicatorServer.ONLINE,
CommunicatorServer.STARTING,
CommunicatorServer.STOPPING.timeout - The maximum time to wait for, in
milliseconds, if positive.
Infinite time out if 0, or no waiting at all if negative.
public int getState()
CommunicatorServer as an integer.
ONLINE, OFFLINE, STARTING or STOPPING.public String getStateString()
CommunicatorServer as a string.
public String getHost()
CommunicatorServer.
CommunicatorServer.public int getPort()
CommunicatorServer.
CommunicatorServer.
public void setPort(int port)
throws IllegalStateException
CommunicatorServer.
port - The port number used by this CommunicatorServer.
IllegalStateException - This method has been invoked
while the communicator was ONLINE or STARTING.public String getProtocol()
CommunicatorServer.
|
FCS Release jdmk-5_1-b34.2 2005.11.29_16:24:00_MET |
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||