Oracle® C++ Call Interface Programmer's Guide 10g Release 1 (10.1) Part Number B10778-01 |
|
|
View PDF |
The Listener
class encapsulates the ability to listen for Message
s, on behalf of registered Agent
s, at specified queues.
Table 10-20 Summary of Listener Methods
Method | Summary |
---|---|
Listener() |
Listener class constructor. |
getAgentList() |
Retrieve the list of Agent s for which the Listener provides its services. |
getTimeOutForListen() |
Retrieve the time out for a call. |
listen() |
Listens for Message s and returns the name of the Agent for whom a Message is intended. |
setAgentList() |
Specifies the list of Agent s for which the Listener provides its services. |
setTimeOutForListen() |
Specifies the time out for a listen() call. |
Listener
class constructor.
Syntax | Description |
---|---|
Listener( const Connection* conn); |
Creates a Listener object. |
Listener( const Connection* conn vector<Agent> &aglist, int waitTime=0); |
Creates a Listener object and sets the list of Agent s on behalf of which it listens on queues. Also sets the waiting time; default: no waiting. |
Parameter | Description |
---|---|
conn |
The connection of the new Listener object. |
aglist |
The list of agents on behalf of which the Listener object waits on queues; clients of this Listener . |
waitTime |
The time to wait on queues for messages of interest for the clients; in seconds. |
Retrieve the list of Agent
s for which the Listener
provides its services.
vector<Agent> getAgentList() const;
Retrieve the time out for a call.
int getTimeOutForListen() const;
Listens for Message
s on behalf of specified Agent
s for the amount of time specified by a previous setTimeOutForListen() call. Returns the Agent
for which there is a Message
.
Agent listen();
Note: This is a blocking call. Prior to this call, the following steps should be completed:
|
Specifies the list of Agent
s for which the Listener
provides its services.
void setAgentList( vector<Agent>& list);
Parameter | Description |
---|---|
list |
The list of Agent s. |
Specifies the time out for a listen() call.
void setTimeOutForListen( int timeOut);
Parameter | Description |
---|---|
timeOut |
The time interval, in seconds, during which the Listener is waiting for Message s at specified queues. |