com.vmware.vapi.protocol.server.rpc

Interface RequestReceiver

All Known Implementing Classes:

JsonServerConnection

public interface RequestReceiver

Receiver of requests.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	RequestReceiver.RequestContext Auxiliary (optional) information about the request which triggered the API invocation.
static interface	RequestReceiver.TransportContext Transport handle which can be used to send responses or retrieve transport specific information.

Method Summary

Modifier and Type	Method and Description
void	requestReceived(InputStream request, RequestReceiver.TransportContext transport) Notifies the request receiver that a new request is received.

Method Detail

requestReceived

void requestReceived(InputStream request,
                     RequestReceiver.TransportContext transport)
              throws IOException

Notifies the request receiver that a new request is received.

There is no guarantee that the request is completely handled when this method exits. The implementation is free to handle the request asynchronously. Only after the RequestReceiver.TransportContext.send(java.io.InputStream, int, boolean) with true value for the isFinal parameter is invoked, it is certain that the request is completely processed and all responses have been sent.

Parameters:

request - request frame; must not be null

transport - transport handle which can be used to send responses; this handle is strongly correlated with the request; use it to send responses only for this particular request; must not be null

Throws:

IOException - propagate an error coming from the transport module (e.g. thrown by the request stream or by the transport handle)