AbstractMessage (Red5 Server Documentation)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.red5.compatibility.flex.messaging.messages
Class AbstractMessage

java.lang.Object
  org.red5.compatibility.flex.messaging.messages.AbstractMessage

All Implemented Interfaces:: Serializable, Message

Direct Known Subclasses:: AsyncMessage

public class AbstractMessage
extends Object
implements Message, Serializable
extends Object
implements Message, Serializable

Base class for all Flex compatibility messages.

Author:: The Red5 Project ([email protected]), Joachim Bauch ([email protected])
See Also:: Serialized Form

Field Summary
`Object`	`body`
`String`	`clientId`
`protected byte[]`	`clientIdBytes`
`String`	`destination`
`Map<String,Object>`	`headers`
`String`	`messageId`
`protected byte[]`	`messageIdBytes`
`long`	`timestamp`
`long`	`timeToLive`

Fields inherited from interface org.red5.compatibility.flex.messaging.messages.Message
`DESTINATION_CLIENT_ID_HEADER, ENDPOINT_HEADER, FLEX_CLIENT_ID_HEADER, MESSAGING_VERSION, NEEDS_CONFIG_HEADER, POLL_WAIT_HEADER, PRESERVE_DURABLE_HEADER, REMOTE_CREDENTIALS_HEADER, REMOVE_SUBSCRIPTIONS, SELECTOR_HEADER, SUBSCRIPTION_INVALIDATED_HEADER, SUBTOPIC_SEPARATOR, SYNC_HEADER`

Constructor Summary
`AbstractMessage()` Initialize default message fields.

Method Summary
`protected void`	`addParameters(StringBuilder result)` Add message properties to string.
`Object`	`getBody()` Returns the body of the message.
`String`	`getClientId()` Returns the client id indicating the client that sent the message.
`String`	`getDestination()` Returns the destination that the message targets.
`Object`	`getHeader(String name)` Returns a header value corresponding to the passed header name.
`Map<String,Object>`	`getHeaders()` Returns the headers for the message.
`String`	`getMessageId()` Returns the unique message id.
`long`	`getTimestamp()` Returns the timestamp for the message.
`long`	`getTimeToLive()` Returns the time to live for the message.
`boolean`	`headerExists(String name)` Tests whether a header with the passed name exists.
`void`	`readExternal(IDataInput input)`
`protected short[]`	`readFlags(IDataInput input)`
`void`	`setBody(Object value)` Sets the body of the message.
`void`	`setClientId(String value)` Sets the client id indicating the client that sent the message.
`void`	`setDestination(String value)` Sets the destination that the message targets.
`void`	`setHeader(String name, Object value)` Sets a header on the message.
`void`	`setHeaders(Map<String,Object> value)` Sets the headers for the message.
`void`	`setMessageId(String value)` Sets the unique message id.
`void`	`setTimestamp(long value)` Sets the timestamp for the message.
`void`	`setTimeToLive(long value)` Sets the time to live for the message.
`String`	`toString()` Return string representation of the message.
`void`	`writeExternal(IDataOutput output)`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

Field Detail

timestamp

public long timestamp

headers

public Map<String,Object> headers

body

public Object body

messageId

public String messageId

messageIdBytes

protected byte[] messageIdBytes

timeToLive

public long timeToLive

clientId

public String clientId

clientIdBytes

protected byte[] clientIdBytes

destination

public String destination

Constructor Detail

AbstractMessage

public AbstractMessage()

Initialize default message fields.

Method Detail

addParameters

protected void addParameters(StringBuilder result)

Add message properties to string.

Parameters:: result - StringBuilder to add properties to