org.digitalmediaserver.cast

Class Channel.ResultProcessor<T extends Response>

java.lang.Object

org.digitalmediaserver.cast.Channel.ResultProcessor<T>

Type Parameters:

T - the response type.

Enclosing class:

Channel

protected class Channel.ResultProcessor<T extends Response>
extends Object

Internal class used to tie responses to requests based on request IDs.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	closed Whether the associated Session has been closed
protected long	requestTimeout The timeout in milliseconds
protected Class<T>	responseClass The expected response Class
protected Channel.ResultProcessorResult<T>	result The Channel.ResultProcessorResult
protected Session	session The Session if one applies

Constructor Summary

Constructors

Constructor and Description
ResultProcessor(Session session, Class<T> responseClass, long requestTimeout) Creates a new instance using the specified parameters.

Method Summary

Modifier and Type	Method and Description
Channel.ResultProcessorResult<T>	get() Returns the Channel.ResultProcessorResult when it is due.
Session	getSession()
void	process(String jsonMSG) Processes the specified message that has been routed to this Channel.ResultProcessor by its request ID.
void	sessionClosed() Called if the Session linked to this Channel.ResultProcessor is closed.

Methods inherited from class java.lang.Object

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

Field Detail

session

@Nullable
protected final Session session

The Session if one applies

responseClass

protected final Class<T extends Response> responseClass

The expected response Class

requestTimeout

protected final long requestTimeout

The timeout in milliseconds

closed

protected boolean closed

Whether the associated Session has been closed

result

protected Channel.ResultProcessorResult<T extends Response> result

The Channel.ResultProcessorResult

Constructor Detail

ResultProcessor

public ResultProcessor(@Nullable
                       Session session,
                       @Nonnull
                       Class<T> responseClass,
                       long requestTimeout)

Creates a new instance using the specified parameters.

Parameters:

session - the Session if one applies to the request.

responseClass - the expected response class.

requestTimeout - the timeout value in milliseconds.

Method Detail

sessionClosed

public void sessionClosed()

Called if the Session linked to this Channel.ResultProcessor is closed.

process

public void process(String jsonMSG)
             throws com.fasterxml.jackson.databind.JsonMappingException,
                    com.fasterxml.jackson.core.JsonProcessingException

Processes the specified message that has been routed to this Channel.ResultProcessor by its request ID.

Parameters:

jsonMSG - the message content formatted as JSON.

Throws:

com.fasterxml.jackson.databind.JsonMappingException - If the JSON mapping fails.

com.fasterxml.jackson.core.JsonProcessingException - If the JSON can't be processed.

get

@Nonnull
public Channel.ResultProcessorResult<T> get()
                                               throws InterruptedException,
                                                      TimeoutException,
                                                      CastException

Returns the Channel.ResultProcessorResult when it is due. If the response hasn't been received yet, this method will block until it is or the timeout expires.

Returns:

The response.

Throws:

InterruptedException - If the thread is interrupted while waiting for the response.

TimeoutException - If waiting for the response times out.

CastException - If the Session is closed while waiting for the response.

getSession

@Nullable
public Session getSession()

Returns:

The Session tied to this Channel.ResultProcessor, if any.