Klasse UpnpStream

java.lang.Object

org.jupnp.transport.spi.UpnpStream

Alle implementierten Schnittstellen:

Runnable

Bekannte direkte Unterklassen:

HttpExchangeUpnpStream, ServletUpnpStream

public abstract class UpnpStream
extends Object
implements Runnable

A runnable representation of a single HTTP request/response procedure.

Instantiated by the StreamServer, executed by the Router. See the pseudo-code example in the documentation of StreamServer. An implementation's run() method has to call the process(org.jupnp.model.message.StreamRequestMessage), responseSent(org.jupnp.model.message.StreamResponseMessage) and responseException(Throwable) methods.

An implementation does not have to be thread-safe.

Autor:

Christian Bauer

Feldübersicht

Felder

Modifizierer und Typ	Feld	Beschreibung
protected final ProtocolFactory	protocolFactory
protected ReceivingSync	syncProtocol

Konstruktorübersicht

Konstruktoren

Modifizierer	Konstruktor	Beschreibung
protected	UpnpStream(ProtocolFactory protocolFactory)

Methodenübersicht

Modifizierer und Typ	Methode	Beschreibung
ProtocolFactory	getProtocolFactory()
StreamResponseMessage	process(StreamRequestMessage requestMsg)	Selects a UPnP protocol, runs it within the calling thread, returns the response.
protected void	responseException(Throwable t)	Must be called by a subclass if the response was not delivered to the client.
protected void	responseSent(StreamResponseMessage responseMessage)	Must be called by a subclass after the response has been successfully sent to the client.
String	toString()

Von Klasse geerbte Methoden java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Von Schnittstelle geerbte Methoden java.lang.Runnable

run

Felddetails

protocolFactory

protected final ProtocolFactory protocolFactory

syncProtocol

protected ReceivingSync syncProtocol

Konstruktordetails

UpnpStream

protected UpnpStream(ProtocolFactory protocolFactory)

Methodendetails

getProtocolFactory

public ProtocolFactory getProtocolFactory()

process

public StreamResponseMessage process(StreamRequestMessage requestMsg)

Selects a UPnP protocol, runs it within the calling thread, returns the response.

This method will return null if the UPnP protocol returned null. The HTTP response in this case is always 404 NOT FOUND. Any other (HTTP) error condition will be encapsulated in the returned response message and has to be passed to the HTTP client as it is.

Parameter:

requestMsg - The TCP (HTTP) stream request message.

Gibt zurück:

The TCP (HTTP) stream response message, or null if a 404 should be send to the client.

responseSent

protected void responseSent(StreamResponseMessage responseMessage)

Must be called by a subclass after the response has been successfully sent to the client.

Parameter:

responseMessage - The response message successfully sent to the client.

responseException

protected void responseException(Throwable t)

Must be called by a subclass if the response was not delivered to the client.

Parameter:

t - The reason why the response wasn't delivered.

toString

public String toString()

Setzt außer Kraft:

toString in Klasse Object