org.zeromq.api

Class RoutedMessage

java.lang.Object

org.zeromq.api.Message

org.zeromq.api.RoutedMessage

All Implemented Interfaces:

Iterable<Message.Frame>

public class RoutedMessage
extends Message

Routed message contains route frames and payload frames.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RoutedMessage.Route Represents a route, or address frame, which will be combined with a blank frame over the wire.

Nested classes/interfaces inherited from class org.zeromq.api.Message

Message.Frame, Message.FrameBuilder

Field Summary

Fields inherited from class org.zeromq.api.Message

CHARSET, EMPTY_FRAME

Constructor Summary

Constructors

Constructor and Description
RoutedMessage() Construct an empty message.
RoutedMessage(List<RoutedMessage.Route> routes) Takes routes with no frames.
RoutedMessage(List<RoutedMessage.Route> routes, Message message) Takes the existing message and adds routes to the beginning of it.
RoutedMessage(RoutedMessage.Route route) Takes a route with no frames.
RoutedMessage(RoutedMessage.Route route, Message message) Takes the existing message and adds a route to the beginning of it.

Method Summary

Modifier and Type	Method and Description
Message	getPayload() Get the message portion of the routed message, which is the frames after all routing frames.
List<RoutedMessage.Route>	getRoutes()
RoutedMessage.Route	unwrap() Mutates this Message, to remove the top-most Route, which is then returned.

Methods inherited from class org.zeromq.api.Message

addBuffer, addByte, addBytes, addClobs, addEmptyFrame, addFrame, addFrames, addFrames, addInt, addLong, addMap, addShort, addString, addStrings, dump, getFirstFrame, getFrames, isEmpty, isMissing, iterator, popByte, popBytes, popClobs, popFrame, popInt, popLong, popMap, popShort, popString, popStrings, pushBuffer, pushByte, pushBytes, pushClobs, pushFrame, pushFrames, pushFrames, pushInt, pushLong, pushMap, pushShort, pushString, pushStrings, size, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

RoutedMessage

public RoutedMessage()

Construct an empty message.

RoutedMessage

public RoutedMessage(RoutedMessage.Route route)

Takes a route with no frames.

Parameters:

route - The initial route

RoutedMessage

public RoutedMessage(List<RoutedMessage.Route> routes)

Takes routes with no frames.

Parameters:

routes - An initial list of routes

RoutedMessage

public RoutedMessage(RoutedMessage.Route route,
                     Message message)

Takes the existing message and adds a route to the beginning of it.

Parameters:

route - The initial route

message - A message containing frames to be added

RoutedMessage

public RoutedMessage(List<RoutedMessage.Route> routes,
                     Message message)

Takes the existing message and adds routes to the beginning of it.

Parameters:

routes - An initial list of routes

message - A message containing frames to be added

Method Detail

getPayload

public Message getPayload()

Get the message portion of the routed message, which is the frames after all routing frames.

Returns:

The message payload

getRoutes

public List<RoutedMessage.Route> getRoutes()

unwrap

public RoutedMessage.Route unwrap()

Mutates this Message, to remove the top-most Route, which is then returned.

Returns:

The unwrapped Route