de.yaacc.upnp.protocol.sync.ReceivingSubscribe Class Reference

Handles reception of GENA event subscription (initial and renewal) messages. More...

Inheritance diagram for de.yaacc.upnp.protocol.sync.ReceivingSubscribe:

Collaboration diagram for de.yaacc.upnp.protocol.sync.ReceivingSubscribe:

Public Member Functions
	ReceivingSubscribe (Registry registry, HttpRequestSender httpRequestSender, StreamRequestMessage inputMessage)
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.
Public Member Functions inherited from de.yaacc.upnp.protocol.ReceivingSync< IN extends StreamRequestMessage, OUT extends StreamResponseMessage >
OUT	getOutputMessage ()
RemoteClientInfo	getRemoteClientInfo ()
String	toString ()
Public Member Functions inherited from de.yaacc.upnp.protocol.ReceivingAsync< IN >
M	getInputMessage ()
void	run ()
String	toString ()

Protected Member Functions
OutgoingSubscribeResponseMessage	executeSync () throws IOException
OutgoingSubscribeResponseMessage	processRenewal (LocalService service, IncomingSubscribeRequestMessage requestMessage)
OutgoingSubscribeResponseMessage	processNewSubscription (LocalService service, IncomingSubscribeRequestMessage requestMessage)
Protected Member Functions inherited from de.yaacc.upnp.protocol.ReceivingSync< IN extends StreamRequestMessage, OUT extends StreamResponseMessage >
	ReceivingSync (IN inputMessage)
final void	execute () 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
LocalGENASubscription	subscription
Protected Attributes inherited from de.yaacc.upnp.protocol.ReceivingSync< IN extends StreamRequestMessage, OUT extends StreamResponseMessage >
final RemoteClientInfo	remoteClientInfo
OUT	outputMessage

Detailed Description

Handles reception of GENA event subscription (initial and renewal) messages.

This protocol tries to find a local event subscription URI matching the requested URI, then creates a new LocalGENASubscription if no subscription identifer was supplied.

The subscription is however only registered with the local service, and monitoring of state changes is established, if the response of this protocol was successfully delivered to the client which requested the subscription.

Once registration and monitoring is active, an initial event with the current state of the service is send to the subscriber. This will only happen after the subscription response message was successfully delivered to the subscriber.

Author

Christian Bauer

Member Function Documentation

executeSync()

OutgoingSubscribeResponseMessage de.yaacc.upnp.protocol.sync.ReceivingSubscribe.executeSync ( ) throws IOException

protected

Reimplemented from de.yaacc.upnp.protocol.ReceivingSync< IN extends StreamRequestMessage, OUT extends StreamResponseMessage >.

responseException()

void de.yaacc.upnp.protocol.sync.ReceivingSubscribe.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 from de.yaacc.upnp.protocol.ReceivingSync< IN extends StreamRequestMessage, OUT extends StreamResponseMessage >.

Here is the call graph for this function:

responseSent()

void de.yaacc.upnp.protocol.sync.ReceivingSubscribe.responseSent

(

StreamResponseMessage

responseMessage

)

Called by the client of this protocol after the returned response has been successfully delivered.

NOOP by default.

Reimplemented from de.yaacc.upnp.protocol.ReceivingSync< IN extends StreamRequestMessage, OUT extends StreamResponseMessage >.

Here is the call 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/sync/ReceivingSubscribe.java