Package io.ably.lib.types

Class ProtocolMessage

java.lang.Object

io.ably.lib.types.ProtocolMessage

public class ProtocolMessage
extends 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	Description
static enum	ProtocolMessage.Action
static class	ProtocolMessage.ActionSerializer
static class	ProtocolMessage.AuthDetails	Contains the token string used to authenticate a client with Ably.
static enum	ProtocolMessage.Flag

Field Summary

Fields

Modifier and Type	Field	Description
ProtocolMessage.Action	action
Annotation[]	annotations
ProtocolMessage.AuthDetails	auth
String	channel
String	channelSerial
ConnectionDetails	connectionDetails
String	connectionId
int	count
ErrorInfo	error
int	flags
String	id
Message[]	messages
Long	msgSerial
Map<String,String>	params
PresenceMessage[]	presence
@Nullable Object[]	state	This will be null if we skipped decoding this property due to user not requesting Objects functionality JsonAdapter annotation supports java version (1.8) mentioned in build.gradle This is targeted and specific to the state field, so won't affect other fields
long	timestamp

Constructor Summary

Constructors

Constructor	Description
ProtocolMessage()
ProtocolMessage(ProtocolMessage.Action action)
ProtocolMessage(ProtocolMessage.Action action, String channel)

Method Summary

Modifier and Type	Method	Description
static boolean	ackRequired(ProtocolMessage msg)	(RTN7a)
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 Details

action

public ProtocolMessage.Action action

flags

public int flags

count

public int count

error

public ErrorInfo error

id

public String id

channel

public String channel

channelSerial

public String channelSerial

connectionId

public String connectionId

msgSerial

public 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 Map<String,String> params

annotations

public Annotation[] annotations

state

@Nullable
public @Nullable Object[] state

This will be null if we skipped decoding this property due to user not requesting Objects functionality JsonAdapter annotation supports java version (1.8) mentioned in build.gradle This is targeted and specific to the state field, so won't affect other fields

Constructor Details

ProtocolMessage

public ProtocolMessage()

ProtocolMessage

public ProtocolMessage(ProtocolMessage.Action action)

ProtocolMessage

public ProtocolMessage(ProtocolMessage.Action action,
 String channel)

Method Details

ackRequired

public static boolean ackRequired(ProtocolMessage msg)

(RTN7a)

hasFlag

public boolean hasFlag(ProtocolMessage.Flag flag)

setFlag

public void setFlag(ProtocolMessage.Flag flag)

setFlags

public void setFlags(int flags)