|
VisiBroker for Java |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface RequestAgentOperations
The Request Agent interface defines operations on the Native Messaging Request Agent.
RequestAgentEx
Method Summary | |
---|---|
Object |
create_request(RequestDesc desc)
Creates and returns an async request object. |
void |
destroy_request(Object req)
Destroys an async request. |
byte[][] |
poll(java.lang.String polling_group,
int timeout,
boolean unmask)
Returns the sequence of tags whose replies are ready. |
Method Detail |
---|
void destroy_request(Object req) throws RequestNotExist
req
- The async request object reference to be destroyed.
RequestNotExist
byte[][] poll(java.lang.String polling_group, int timeout, boolean unmask) throws PollingGroupIsEmpty
polling_group
- Name of the polling group.timeout
- Timeout interval in milliseconds to wait if the polling group has no readily available
replies. The values have the following meaning:
timeout > 0
: poll will block for that much time. If after the timeout, there are
still no replies available, an empty sequence of request tags is returned.timeout = 0
: poll will not block. If there are any replies available, their
tags will be returned to the called. If there are no replies available, an empty sequence
is returned.timeout < 0
(or timeout=2^(32-1))
): poll will block until a reply
is available.unmask
- If this flag is false
, subsequent calls to poll on the same polling group
will also return the request tags returned in the previous polls, until those requests get destroyed
either as a result of manual or automatic trash. If this flag is true
, once a request tag
is returned in the poll, it will not appear in subsequent polls.
PollingGroupIsEmpty
Object create_request(RequestDesc desc) throws DuplicatedRequestTag
desc
- The RequestDesc
structure containing information about the request to be created.
DuplicatedRequestTag
|
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |