Interface | osid.transport.OutboundStreamSession | ||
---|---|---|---|
Implements | osid.OsidSession | ||
Description |
The outbound stream session is used to send and receive arbitrary data to and from a remote end point. The methods accept and return a data stream. Some protocols may send or receive all data within a single stream while others may use the streams as channels or frames of data. A stream may be available for reading before all the data as arrived and as such multiple streams may be processed simultaneously. | ||
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 | sendData | ||
Description |
Sends data to the remote transport endpoint. | ||
Return | osid.transport.DataOutputStream | the output stream in which to send data | |
Errors | OPERATION_FAILED | unable to complete request | |
Compliance | mandatory | This method must be implemented. | |
Method | hasDataAvailable | ||
Description |
Tests to see if an input stream is available for retrieval. | ||
Return | boolean | true if a stream is available for reading, false
otherwise | |
Compliance | mandatory | This method must be implemented. | |
Method | receiveData | ||
Description |
Receives data from the remote transport endpoint. | ||
Return | osid.transport.DataInputStream | the input stream containing the received data | |
Errors | ILLEGAL_STATE | hasDataAvailable() is false | |
OPERATION_FAILED | unable to complete request | ||
Compliance | mandatory | This method must be implemented. |