|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.fourthline.cling.transport.spi.UpnpStream
public abstract class UpnpStream
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.fourthline.cling.model.message.StreamRequestMessage)
,
responseSent(org.fourthline.cling.model.message.StreamResponseMessage)
and
responseException(Throwable)
methods.
An implementation does not have to be thread-safe.
Field Summary | |
---|---|
protected ProtocolFactory |
protocolFactory
|
protected ReceivingSync |
syncProtocol
|
Constructor Summary | |
---|---|
protected |
UpnpStream(ProtocolFactory protocolFactory)
|
Method Summary | |
---|---|
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()
|
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface java.lang.Runnable |
---|
run |
Field Detail |
---|
protected final ProtocolFactory protocolFactory
protected ReceivingSync syncProtocol
Constructor Detail |
---|
protected UpnpStream(ProtocolFactory protocolFactory)
Method Detail |
---|
public ProtocolFactory getProtocolFactory()
public StreamResponseMessage process(StreamRequestMessage requestMsg)
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.
requestMsg
- The TCP (HTTP) stream request message.
null
if a 404 should be send to the client.protected void responseSent(StreamResponseMessage responseMessage)
responseMessage
- The response message successfully sent to the client.protected void responseException(Throwable t)
t
- The reason why the response wasn't delivered.public String toString()
toString
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |