Factory for UPnP protocols, the core implementation of the UPnP specification. More...

Inheritance diagram for org.fourthline.cling.protocol.ProtocolFactory:

Collaboration diagram for org.fourthline.cling.protocol.ProtocolFactory:

Public Member Functions
UpnpService	getUpnpService ()

ReceivingAsync	createReceivingAsync (IncomingDatagramMessage message) throws ProtocolCreationException
	Creates a `org.fourthline.cling.protocol.async.ReceivingNotification`, `org.fourthline.cling.protocol.async.ReceivingSearch`, or `org.fourthline.cling.protocol.async.ReceivingSearchResponse` protocol.

ReceivingSync	createReceivingSync (StreamRequestMessage requestMessage) throws ProtocolCreationException
	Creates a `org.fourthline.cling.protocol.sync.ReceivingRetrieval`, `org.fourthline.cling.protocol.sync.ReceivingAction`, `org.fourthline.cling.protocol.sync.ReceivingSubscribe`, `org.fourthline.cling.protocol.sync.ReceivingUnsubscribe`, or `org.fourthline.cling.protocol.sync.ReceivingEvent` protocol.

SendingNotificationAlive	createSendingNotificationAlive (LocalDevice localDevice)
	Called by the `org.fourthline.cling.registry.Registry`, creates a protocol for announcing local devices.

SendingNotificationByebye	createSendingNotificationByebye (LocalDevice localDevice)
	Called by the `org.fourthline.cling.registry.Registry`, creates a protocol for announcing local devices.

SendingSearch	createSendingSearch (UpnpHeader searchTarget, int mxSeconds)
	Called by the `org.fourthline.cling.controlpoint.ControlPoint`, creates a protocol for a multicast search.

SendingAction	createSendingAction (ActionInvocation actionInvocation, URL controlURL)
	Called by the `org.fourthline.cling.controlpoint.ControlPoint`, creates a protocol for executing an action.

SendingSubscribe	createSendingSubscribe (RemoteGENASubscription subscription) throws ProtocolCreationException
	Called by the `org.fourthline.cling.controlpoint.ControlPoint`, creates a protocol for GENA subscription.

SendingRenewal	createSendingRenewal (RemoteGENASubscription subscription)
	Called by the `org.fourthline.cling.controlpoint.ControlPoint`, creates a protocol for GENA renewal.

SendingUnsubscribe	createSendingUnsubscribe (RemoteGENASubscription subscription)
	Called by the `org.fourthline.cling.controlpoint.ControlPoint`, creates a protocol for GENA unsubscription.

SendingEvent	createSendingEvent (LocalGENASubscription subscription)
	Called by the `org.fourthline.cling.model.gena.GENASubscription`, creates a protocol for sending GENA events.

Detailed Description

Factory for UPnP protocols, the core implementation of the UPnP specification.

This factory creates an executable protocol either based on the received UPnP messsage, or on local device/search/service metadata). A protocol is an aspect of the UPnP specification, you can override individual protocols to customize the behavior of the UPnP stack.

An implementation has to be thread-safe.

Author: Christian Bauer

Member Function Documentation

◆ createReceivingAsync()

ReceivingAsync org.fourthline.cling.protocol.ProtocolFactory.createReceivingAsync ( IncomingDatagramMessage message ) throws ProtocolCreationException

Creates a org.fourthline.cling.protocol.async.ReceivingNotification, org.fourthline.cling.protocol.async.ReceivingSearch, or org.fourthline.cling.protocol.async.ReceivingSearchResponse protocol.

Parameters

message The incoming message, either org.fourthline.cling.model.message.UpnpRequest or org.fourthline.cling.model.message.UpnpResponse.

Returns: The appropriate protocol that handles the messages or null if the message should be dropped.

Exceptions

ProtocolCreationException If no protocol could be found for the message.

Implemented in org.fourthline.cling.protocol.ProtocolFactoryImpl.

◆ createReceivingSync()

ReceivingSync org.fourthline.cling.protocol.ProtocolFactory.createReceivingSync ( StreamRequestMessage requestMessage ) throws ProtocolCreationException

Creates a org.fourthline.cling.protocol.sync.ReceivingRetrieval, org.fourthline.cling.protocol.sync.ReceivingAction, org.fourthline.cling.protocol.sync.ReceivingSubscribe, org.fourthline.cling.protocol.sync.ReceivingUnsubscribe, or org.fourthline.cling.protocol.sync.ReceivingEvent protocol.

Parameters

requestMessage The incoming message, examime org.fourthline.cling.model.message.UpnpRequest.Method to determine the protocol.

Returns: The appropriate protocol that handles the messages.

Exceptions

ProtocolCreationException If no protocol could be found for the message.

Implemented in org.fourthline.cling.protocol.ProtocolFactoryImpl.

◆ createSendingAction()

SendingAction org.fourthline.cling.protocol.ProtocolFactory.createSendingAction	(	ActionInvocation	actionInvocation,
		URL	controlURL
	)

Called by the org.fourthline.cling.controlpoint.ControlPoint, creates a protocol for executing an action.

Implemented in org.fourthline.cling.protocol.ProtocolFactoryImpl.

◆ createSendingEvent()

SendingEvent org.fourthline.cling.protocol.ProtocolFactory.createSendingEvent ( LocalGENASubscription subscription )

Called by the org.fourthline.cling.model.gena.GENASubscription, creates a protocol for sending GENA events.

Implemented in org.fourthline.cling.protocol.ProtocolFactoryImpl.

◆ createSendingNotificationAlive()

SendingNotificationAlive org.fourthline.cling.protocol.ProtocolFactory.createSendingNotificationAlive ( LocalDevice localDevice )

Called by the org.fourthline.cling.registry.Registry, creates a protocol for announcing local devices.

Implemented in org.fourthline.cling.protocol.ProtocolFactoryImpl.

◆ createSendingNotificationByebye()

SendingNotificationByebye org.fourthline.cling.protocol.ProtocolFactory.createSendingNotificationByebye ( LocalDevice localDevice )

Called by the org.fourthline.cling.registry.Registry, creates a protocol for announcing local devices.

Implemented in org.fourthline.cling.protocol.ProtocolFactoryImpl.

◆ createSendingRenewal()

SendingRenewal org.fourthline.cling.protocol.ProtocolFactory.createSendingRenewal ( RemoteGENASubscription subscription )

Called by the org.fourthline.cling.controlpoint.ControlPoint, creates a protocol for GENA renewal.

Implemented in org.fourthline.cling.protocol.ProtocolFactoryImpl.

◆ createSendingSearch()

SendingSearch org.fourthline.cling.protocol.ProtocolFactory.createSendingSearch	(	UpnpHeader	searchTarget,
		int	mxSeconds
	)

Called by the org.fourthline.cling.controlpoint.ControlPoint, creates a protocol for a multicast search.

Implemented in org.fourthline.cling.protocol.ProtocolFactoryImpl.

◆ createSendingSubscribe()

SendingSubscribe org.fourthline.cling.protocol.ProtocolFactory.createSendingSubscribe ( RemoteGENASubscription subscription ) throws ProtocolCreationException

Called by the org.fourthline.cling.controlpoint.ControlPoint, creates a protocol for GENA subscription.

Implemented in org.fourthline.cling.protocol.ProtocolFactoryImpl.

◆ createSendingUnsubscribe()

SendingUnsubscribe org.fourthline.cling.protocol.ProtocolFactory.createSendingUnsubscribe ( RemoteGENASubscription subscription )

Called by the org.fourthline.cling.controlpoint.ControlPoint, creates a protocol for GENA unsubscription.

Implemented in org.fourthline.cling.protocol.ProtocolFactoryImpl.

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

/github/workspace/yaacc/src/main/java/org/fourthline/cling/protocol/ProtocolFactory.java

Public Member Functions

Detailed Description

Member Function Documentation

◆ createReceivingAsync()

◆ createReceivingSync()

◆ createSendingAction()

◆ createSendingEvent()

◆ createSendingNotificationAlive()

◆ createSendingNotificationByebye()

◆ createSendingRenewal()

◆ createSendingSearch()

◆ createSendingSubscribe()

◆ createSendingUnsubscribe()