Supertype for all synchronously executing protocols, handling reception of UPnP messages and return a response. More...
Public Member Functions | |
| OUT | getOutputMessage () |
| void | responseSent (StreamResponseMessage responseMessage) |
| Called by the client of this protocol after the returned response has been successfully delivered. | |
| void | responseException (Throwable t) |
| Called by the client of this protocol if the returned response was not delivered. | |
| RemoteClientInfo | getRemoteClientInfo () |
| String | toString () |
 Public Member Functions inherited from org.fourthline.cling.protocol.ReceivingAsync< IN > | |
| UpnpService | getUpnpService () |
| M | getInputMessage () |
| void | run () |
| String | toString () |
Protected Member Functions | |
| ReceivingSync (UpnpService upnpService, IN inputMessage) | |
| final void | execute () throws RouterException |
| abstract OUT | executeSync () throws RouterException |
| Protected Member Functions inherited from org.fourthline.cling.protocol.ReceivingAsync< IN > | |
| ReceivingAsync (UpnpService upnpService, M inputMessage) | |
| boolean | waitBeforeExecution () throws InterruptedException |
| Provides an opportunity to pause before executing the protocol. | |
| abstract void | execute () throws RouterException |
Protected Attributes | |
| final RemoteClientInfo | remoteClientInfo |
| OUT | outputMessage |
Detailed Description
Supertype for all synchronously executing protocols, handling reception of UPnP messages and return a response.
After instantiation by the ProtocolFactory, this protocol run()s and calls its own waitBeforeExecution() method. By default, the protocol does not wait before then proceeding with executeSync().
The returned response will be available to the client of this protocol. The client will then call either responseSent(org.fourthline.cling.model.message.StreamResponseMessage) or responseException(Throwable), depending on whether the response was successfully delivered. The protocol can override these methods to decide if the whole procedure it is implementing was successful or not, including not only creation but also delivery of the response.
- Parameters
-
<IN> The type of incoming UPnP message handled by this protocol. <OUT> The type of response UPnP message created by this protocol.
Member Function Documentation
◆ responseException()
| void org.fourthline.cling.protocol.ReceivingSync< IN extends StreamRequestMessage, OUT extends StreamResponseMessage >.responseException | ( | Throwable | t | ) |
Called by the client of this protocol if the returned response was not delivered.
NOOP by default.
- Parameters
-
t The reason why the response wasn't delivered.
◆ responseSent()
| void org.fourthline.cling.protocol.ReceivingSync< IN extends StreamRequestMessage, OUT extends StreamResponseMessage >.responseSent | ( | StreamResponseMessage | responseMessage | ) |
Called by the client of this protocol after the returned response has been successfully delivered.
NOOP by default.
The documentation for this class was generated from the following file:
- /github/workspace/yaacc/src/main/java/org/fourthline/cling/protocol/ReceivingSync.java
