org.digitalmediaserver.cast

Class ImmutableCastMessage

java.lang.Object

org.digitalmediaserver.cast.ImmutableCastMessage

Direct Known Subclasses:

ImmutableCastMessage.ImmutableBinaryCastMessage, ImmutableCastMessage.ImmutableStringCastMessage

@Immutable
public abstract class ImmutableCastMessage
extends Object

An immutable implementation of the essential data of a CastChannel.CastMessage, which allows incoming messages be passed around to multiple threads without risking mutation.

Author:

Nadahar

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ImmutableCastMessage.ImmutableBinaryCastMessage An ImmutableCastMessage implementation for binary payloads.
static class	ImmutableCastMessage.ImmutableStringCastMessage An ImmutableCastMessage implementation for string payloads.

Field Summary

Fields

Modifier and Type	Field and Description
protected String	destinationId The destination ID.
protected String	namespace The namespace, the core multiplexing key.
protected CastChannel.CastMessage.ProtocolVersion	protocolVersion The protocol version
protected String	sourceId The source ID.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ImmutableCastMessage(String destinationId, String namespace, CastChannel.CastMessage.ProtocolVersion protocolVersion, String sourceId) Abstract constructor.

Method Summary

Modifier and Type	Method and Description
static ImmutableCastMessage	create(CastChannel.CastMessage message) Creates either an ImmutableCastMessage.ImmutableStringCastMessage or an ImmutableCastMessage.ImmutableBinaryCastMessage depending on the payload type, which holds the data from the specified CastChannel.CastMessage.
String	getDestinationId() The source and destination IDs identify the origin and destination of a message.
String	getNamespace()
CastChannel.CastMessage.ProtocolVersion	getProtocolVersion()
String	getSourceId() The source and destination IDs identify the origin and destination of a message.

Methods inherited from class java.lang.Object

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

Field Detail

destinationId

@Nonnull
protected final String destinationId

The destination ID.

The source and destination IDs identify the origin and destination of a message. They are used to route messages between endpoints that share a device-to-device channel.

For messages between applications:

• The sender application id is a unique identifier generated on behalf of the sender application.
• The receiver id is always the the session id for the application.

For messages to or from the sender or receiver platform, the special IDs 'sender-0' and 'receiver-0' can be used.

For messages intended for all endpoints using a given channel, the wildcard destination_id '*' can be used.

namespace

@Nonnull
protected final String namespace

The namespace, the core multiplexing key. All messages are sent on a namespace and endpoints sharing a channel listen on one or more namespaces. The namespace defines the protocol and semantics of the message.

protocolVersion

@Nonnull
protected final CastChannel.CastMessage.ProtocolVersion protocolVersion

The protocol version

sourceId

@Nonnull
protected final String sourceId

The source ID.

The source and destination IDs identify the origin and destination of a message. They are used to route messages between endpoints that share a device-to-device channel.

For messages between applications:

• The sender application id is a unique identifier generated on behalf of the sender application.
• The receiver id is always the the session id for the application.

For messages to or from the sender or receiver platform, the special IDs 'sender-0' and 'receiver-0' can be used.

For messages intended for all endpoints using a given channel, the wildcard destination_id '*' can be used.

Constructor Detail

ImmutableCastMessage

protected ImmutableCastMessage(@Nonnull
                               String destinationId,
                               @Nonnull
                               String namespace,
                               @Nonnull
                               CastChannel.CastMessage.ProtocolVersion protocolVersion,
                               @Nonnull
                               String sourceId)

Abstract constructor.

Parameters:

destinationId - the destination ID.

namespace - the namespace.

protocolVersion - the protocol version.

sourceId - the source ID.

Throws:

IllegalArgumentException - If any of the parameters are null.

Method Detail

getDestinationId

@Nonnull
public String getDestinationId()

The source and destination IDs identify the origin and destination of a message. They are used to route messages between endpoints that share a device-to-device channel.

For messages between applications:

• The sender application id is a unique identifier generated on behalf of the sender application.
• The receiver id is always the the session id for the application.

For messages to or from the sender or receiver platform, the special IDs 'sender-0' and 'receiver-0' can be used.

For messages intended for all endpoints using a given channel, the wildcard destination_id '*' can be used.

Returns:

The destination ID.

getNamespace

@Nonnull
public String getNamespace()

Returns:

The namespace, the core multiplexing key. All messages are sent on a namespace and endpoints sharing a channel listen on one or more namespaces. The namespace defines the protocol and semantics of the message.

getProtocolVersion

@Nonnull
public CastChannel.CastMessage.ProtocolVersion getProtocolVersion()

Returns:

The protocol version.

getSourceId

@Nonnull
public String getSourceId()

The source and destination IDs identify the origin and destination of a message. They are used to route messages between endpoints that share a device-to-device channel.

For messages between applications:

• The sender application id is a unique identifier generated on behalf of the sender application.
• The receiver id is always the the session id for the application.

For messages to or from the sender or receiver platform, the special IDs 'sender-0' and 'receiver-0' can be used.

For messages intended for all endpoints using a given channel, the wildcard destination_id '*' can be used.

Returns:

The source ID.

create

@Nonnull
public static ImmutableCastMessage create(@Nonnull
                                                    CastChannel.CastMessage message)

Creates either an ImmutableCastMessage.ImmutableStringCastMessage or an ImmutableCastMessage.ImmutableBinaryCastMessage depending on the payload type, which holds the data from the specified CastChannel.CastMessage.

Parameters:

message - the CastChannel.CastMessage to get the data from.

Returns:

The new ImmutableCastMessage instance.

Throws:

IllegalArgumentException - If any of the required fields of message is null.