io.ably.lib.types

Class ProtocolMessage

java.lang.Object

io.ably.lib.types.ProtocolMessage

public class ProtocolMessage
extends java.lang.Object

A message sent and received over the Realtime protocol. A ProtocolMessage always relates to a single channel only, but can contain multiple individual Messages or PresenceMessages. ProtocolMessages are serially numbered on a connection. See the Ably client library developer documentation for further details on the members of a ProtocolMessage.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProtocolMessage.Action
static class	ProtocolMessage.ActionSerializer
static class	ProtocolMessage.AuthDetails Contains the token string used to authenticate a client with Ably.
static class	ProtocolMessage.Flag

Field Summary

Fields

Modifier and Type	Field and Description
ProtocolMessage.Action	action
ProtocolMessage.AuthDetails	auth
java.lang.String	channel
java.lang.String	channelSerial
ConnectionDetails	connectionDetails
java.lang.String	connectionId
java.lang.Long	connectionSerial
int	count
ErrorInfo	error
int	flags
java.lang.String	id
Message[]	messages
java.lang.Long	msgSerial
java.util.Map<java.lang.String,java.lang.String>	params
PresenceMessage[]	presence
long	timestamp

Constructor Summary

Constructors

Constructor and Description
ProtocolMessage()
ProtocolMessage(ProtocolMessage.Action action)
ProtocolMessage(ProtocolMessage.Action action, java.lang.String channel)

Method Summary

Modifier and Type	Method and Description
static boolean	ackRequired(ProtocolMessage msg)
boolean	hasFlag(ProtocolMessage.Flag flag)
void	setFlag(ProtocolMessage.Flag flag)
void	setFlags(int flags)

Methods inherited from class java.lang.Object

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

Field Detail

action

public ProtocolMessage.Action action

flags

public int flags

count

public int count

error

public ErrorInfo error

id

public java.lang.String id

channel

public java.lang.String channel

channelSerial

public java.lang.String channelSerial

connectionId

public java.lang.String connectionId

connectionSerial

public java.lang.Long connectionSerial

msgSerial

public java.lang.Long msgSerial

timestamp

public long timestamp

messages

public Message[] messages

presence

public PresenceMessage[] presence

connectionDetails

public ConnectionDetails connectionDetails

auth

public ProtocolMessage.AuthDetails auth

params

public java.util.Map<java.lang.String,java.lang.String> params

Constructor Detail

ProtocolMessage

public ProtocolMessage()

ProtocolMessage

public ProtocolMessage(ProtocolMessage.Action action)

ProtocolMessage

public ProtocolMessage(ProtocolMessage.Action action,
                       java.lang.String channel)

Method Detail

ackRequired

public static boolean ackRequired(ProtocolMessage msg)

hasFlag

public boolean hasFlag(ProtocolMessage.Flag flag)

setFlag

public void setFlag(ProtocolMessage.Flag flag)

setFlags

public void setFlags(int flags)