de.yaacc.upnp.protocol.ReceivingSync< IN extends StreamRequestMessage, OUT extends StreamResponseMessage > Class Template Reference

Supertype for all synchronously executing protocols, handling reception of UPnP messages and return a response. More...

Inheritance diagram for de.yaacc.upnp.protocol.ReceivingSync< IN extends StreamRequestMessage, OUT extends StreamResponseMessage >:

Collaboration diagram for de.yaacc.upnp.protocol.ReceivingSync< IN extends StreamRequestMessage, OUT extends StreamResponseMessage >:

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 de.yaacc.upnp.protocol.ReceivingAsync< IN >
M	getInputMessage ()
void	run ()
String	toString ()

Protected Member Functions
	ReceivingSync (IN inputMessage)
final void	execute () throws IOException
abstract OUT	executeSync () throws IOException
Protected Member Functions inherited from de.yaacc.upnp.protocol.ReceivingAsync< IN >
	ReceivingAsync (M inputMessage)
boolean	waitBeforeExecution () throws InterruptedException
	Provides an opportunity to pause before executing the protocol.
abstract void	execute () throws IOException

Protected Attributes
final RemoteClientInfo	remoteClientInfo
OUT	outputMessage

Detailed Description

Supertype for all synchronously executing protocols, handling reception of UPnP messages and return a response.

The returned response will be available to the client of this protocol. The client will then call either responseSent(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.

Author

Christian Bauer

Member Function Documentation

responseException()

void de.yaacc.upnp.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.

Reimplemented in de.yaacc.upnp.protocol.sync.ReceivingSubscribe.

Referenced by de.yaacc.upnp.server.http.YaaccUpnpServerProtocolRequestHandler.responseException().

Here is the caller graph for this function:

responseSent()

void de.yaacc.upnp.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.

Reimplemented in de.yaacc.upnp.protocol.sync.ReceivingSubscribe.

Referenced by de.yaacc.upnp.server.http.YaaccUpnpServerProtocolRequestHandler.responseSent().

Here is the caller graph for this function:

---

The documentation for this class was generated from the following file:

• /github/workspace/yaacc/src/main/java/de/yaacc/upnp/protocol/ReceivingSync.java