com.borland.vbroker.NativeMessaging
Interface RequestAgentOperations

All Known Subinterfaces:

RequestAgent, RequestAgentEx, RequestAgentExOperations

public interface RequestAgentOperations

The Request Agent interface defines operations on the Native Messaging Request Agent.

Since:

5.1

See Also:

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

destroy_request

void destroy_request(Object req)
                     throws RequestNotExist

Destroys an async request.

Parameters:

req - The async request object reference to be destroyed.

Throws:

RequestNotExist

poll

byte[][] poll(java.lang.String polling_group,
              int timeout,
              boolean unmask)
              throws PollingGroupIsEmpty

Returns the sequence of tags whose replies are ready.

Parameters:

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.

Returns:

sequence of request tags.

Throws:

PollingGroupIsEmpty

create_request

Object create_request(RequestDesc desc)
                      throws DuplicatedRequestTag

Creates and returns an async request object.

Parameters:

desc - The RequestDesc structure containing information about the request to be created.

Returns:

the async request object.

Throws:

DuplicatedRequestTag