io.nats.stan

Class Message

java.lang.Object

io.nats.stan.Message

public class Message
extends Object

A Message object is used to send a message containing a stream of uninterpreted bytes.

Method Summary

Modifier and Type	Method and Description
void	ack() Acknowledges the message to the STAN cluster.
int	getCRC32() Returns the CRC32 checksum for the message.
byte[]	getData() Returns the message payload data.
Instant	getInstant() Returns timestamp as an Instant.
String	getReplyTo() Returns the reply subject.
long	getSequence() Returns the message sequence number.
String	getSubject() Returns the message subject.
long	getTimestamp() The message timestamp in nanoseconds.
boolean	isRedelivered() Determines whether or not this message has been redelivered to this client's connection.
void	setData(byte[] data) Sets the message payload data.
void	setData(byte[] data, int offset, int length) Sets the message payload data.
void	setReplyTo(String reply) Sets the message reply subject.
void	setSubject(String subject) Sets the message subject.
String	toString()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

getInstant

public Instant getInstant()

Returns timestamp as an Instant.

Returns:

a java.time.Instant representing the message timestamp

getSequence

public long getSequence()

Returns the message sequence number.

Returns:

the message sequence number

getSubject

public String getSubject()

Returns the message subject.

Returns:

the message subject

setSubject

public void setSubject(String subject)

Sets the message subject.

Parameters:

subject - the message subject

Throws:

IllegalStateException - if the message is immutable

getReplyTo

public String getReplyTo()

Returns the reply subject.

Returns:

the reply subject

setReplyTo

public void setReplyTo(String reply)

Sets the message reply subject.

Parameters:

reply - the reply subject

Throws:

IllegalStateException - if the message is immutable

getData

public byte[] getData()

Returns the message payload data.

Returns:

the message payload data

setData

public void setData(byte[] data)

Sets the message payload data.

Parameters:

data - the payload data

setData

public void setData(byte[] data,
                    int offset,
                    int length)

Sets the message payload data.

Parameters:

data - the payload data

offset - the beginning offset to copy from

length - the length to copy

getTimestamp

public long getTimestamp()

The message timestamp in nanoseconds.

Returns:

the message timestamp in nanoseconds

isRedelivered

public boolean isRedelivered()

Determines whether or not this message has been redelivered to this client's connection.

Returns:

true if the STAN cluster believes this message has been redelivered, otherwise false

getCRC32

public int getCRC32()

Returns the CRC32 checksum for the message.

Returns:

the CRC32 checksum

ack

public void ack()
         throws IOException,
                TimeoutException

Acknowledges the message to the STAN cluster.

Throws:

IOException - if an I/O exception occurs

TimeoutException - if the acknowledgement times out

toString

public String toString()

Overrides:

toString in class Object