org.teleal.cling.transport.spi
Interface StreamClient<C extends StreamClientConfiguration>

Type Parameters:
C - The type of the service's configuration.
All Known Implementing Classes:
StreamClientImpl, StreamClientImpl

public interface StreamClient<C extends StreamClientConfiguration>

Service for sending TCP (HTTP) stream request messages.

An implementation has to be thread-safe. Its constructor may throw InitializationException.

Author:
Christian Bauer

Method Summary
 C getConfiguration()
           
 StreamResponseMessage sendRequest(StreamRequestMessage message)
          Sends the given request via TCP (HTTP) and returns the response.
 

Method Detail

sendRequest

StreamResponseMessage sendRequest(StreamRequestMessage message)
Sends the given request via TCP (HTTP) and returns the response.

This method will always try to complete execution without throwing an exception. It will return null if an error occurs, and optionally log any exception messages.

This method is required to add a Host HTTP header to the outgoing HTTP request, even if the given StreamRequestMessage does not contain such a header.

This method might add a User-Agent HTTP header to the outgoing HTTP request.

Parameters:
message - The message to send.
Returns:
The response or null if no response has been received or an error occured.

getConfiguration

C getConfiguration()
Returns:
This service's configuration.


Copyright © 2011 Teleal GmbH, Switzerland. All Rights Reserved.