Interface | osid.transport.OutboundMessageSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
This session provides access to a request/response protocol
provider. The data and format of the requests and responses
are identified through their respective While multiple requests may be submitted before receiving a response, the requests may or may not be queued. | ||
Method | getEndpointId | ||
Description |
Gets the | ||
Return | osid.id.Id | the Endpoint Id associated with this session | |
Compliance | mandatory | This method must be implemented. | |
Method | getEndpoint | ||
Description |
Gets the | ||
Return | osid.transport.Endpoint | the Endpoint associated with this session | |
Errors | OPERATION_FAILED | unable to complete request | |
PERMISSION_DENIED | authorization failure | ||
Compliance | mandatory | This method must be implemented. | |
Method | getRequest | ||
Description |
Gets a | ||
Return | osid.transport.Request | a request | |
Compliance | mandatory | This method must be implemented. | |
Method | makeRequest | ||
Description |
Sends a request to the remote transport endpoint and waits for a response. | ||
Parameters | osid.transport.Request | request | the request |
osid.transport.Response | response | callback for the response | |
Errors | NULL_ARGUMENT | request or receiver is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | request is not supported | ||
Compliance | mandatory | This method must be implemented. | |
Method | sendRequest | ||
Description |
Sends data to the remote transport endpoint and sends the response to the callback. | ||
Parameters | osid.transport.Request | request | the request |
osid.transport.MessageReceiver | callback | callback for the response | |
Errors | NULL_ARGUMENT | request or callback is null | |
OPERATION_FAILED | unable to complete request | ||
UNSUPPORTED | request is not supported | ||
Compliance | mandatory | This method must be implemented. |