services.moleculer.transporter

Class Transporter

java.lang.Object

services.moleculer.service.MoleculerComponent

services.moleculer.transporter.Transporter

All Implemented Interfaces:

MetricConstants, MoleculerLifecycle

Direct Known Subclasses:

AmqpTransporter, FileSystemTransporter, InternalTransporter, JmsTransporter, KafkaTransporter, MqttTransporter, NatsStreamingTransporter, NatsTransporter, NullTransporter, RedisTransporter, TcpTransporter

public abstract class Transporter
extends MoleculerComponent
implements MetricConstants

Base superclass of all Transporter implementations.

See Also:

TcpTransporter, RedisTransporter, NatsTransporter, NatsStreamingTransporter, MqttTransporter, JmsTransporter, KafkaTransporter, AmqpTransporter

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.concurrent.ScheduledFuture<?>	checkTimeoutTimer Cancelable "Check Activities / Infos" timer
protected MetricCounter	counterTransporterPacketsReceivedBytes
protected MetricCounter	counterTransporterPacketsReceivedTotal
protected MetricCounter	counterTransporterPacketsSentBytes
protected MetricCounter	counterTransporterPacketsSentTotal
protected boolean	debug Writes the communication of method calls and events into the log.
protected boolean	debugHeartbeats Writes the communication of heartbeats/gossiping into the log.
java.lang.String	disconnectChannel
java.lang.String	discoverBroadcastChannel
java.lang.String	discoverChannel
protected Eventbus	eventbus
java.lang.String	eventChannel
protected java.util.concurrent.ExecutorService	executor
protected MetricGauge	gaugeTransitConnected
java.lang.String	heartbeatChannel
protected int	heartbeatInterval Heartbeat sending period in SECONDS.
protected int	heartbeatTimeout Heartbeat timeout in SECONDS.
protected java.util.concurrent.ScheduledFuture<?>	heartBeatTimer Cancelable "Heart Beat" timer
java.lang.String	infoBroadcastChannel
java.lang.String	infoChannel
protected java.util.concurrent.atomic.AtomicBoolean	infoScheduled
protected java.util.concurrent.atomic.AtomicLong	infoScheduledAt
protected java.lang.String	instanceID
protected java.util.concurrent.atomic.AtomicLong	lastReceivedMessageAt
protected Metrics	metrics
protected Monitor	monitor
protected java.lang.String	namespace Namespace of channels.
protected java.lang.String	nodeID Local Node ID.
protected java.util.concurrent.ConcurrentHashMap<java.lang.String,NodeDescriptor>	nodes
protected int	offlineTimeout How long keep information in registry about the offline nodes (SECONDS).
static java.lang.String	PACKET_DISCONNECT
static java.lang.String	PACKET_DISCOVER
static java.lang.String	PACKET_EVENT
static java.lang.String	PACKET_HEARTBEAT
static java.lang.String	PACKET_INFO
static java.lang.String	PACKET_PING
static java.lang.String	PACKET_PONG
static java.lang.String	PACKET_REQUEST
static java.lang.String	PACKET_RESPONSE
java.lang.String	pingChannel
java.lang.String	pongChannel
protected boolean	preferHostname Use hostnames instead of IP addresses As the DHCP environment is dynamic, any later attempt to use IPs instead hostnames would most likely yield false results.
protected java.lang.String	prefix Prefix of channels.
protected java.lang.String	protocolVersion ServiceBroker's protocol version
protected ServiceRegistry	registry
java.lang.String	requestChannel
java.lang.String	responseChannel
protected java.util.concurrent.ScheduledExecutorService	scheduler
protected Serializer	serializer
protected ServiceInvoker	serviceInvoker
protected int	subscriptionTimeout Timeout of channel subscriptions (SECONDS).
protected UidGenerator	uidGenerator
protected boolean	usingJsonSerializer

Fields inherited from class services.moleculer.service.MoleculerComponent

broker, logger, name

Fields inherited from interface services.moleculer.metrics.MetricConstants

MOLECULER_CACHER_CLEAN_TIME, MOLECULER_CACHER_CLEAN_TIME_DESC, MOLECULER_CACHER_CLEAN_TOTAL, MOLECULER_CACHER_CLEAN_TOTAL_DESC, MOLECULER_CACHER_DEL_TIME, MOLECULER_CACHER_DEL_TIME_DESC, MOLECULER_CACHER_DEL_TOTAL, MOLECULER_CACHER_DEL_TOTAL_DESC, MOLECULER_CACHER_EXPIRED_TOTAL, MOLECULER_CACHER_EXPIRED_TOTAL_DESC, MOLECULER_CACHER_FOUND_TOTAL, MOLECULER_CACHER_FOUND_TOTAL_DESC, MOLECULER_CACHER_GET_TIME, MOLECULER_CACHER_GET_TIME_DESC, MOLECULER_CACHER_GET_TOTAL, MOLECULER_CACHER_GET_TOTAL_DESC, MOLECULER_CACHER_SET_TIME, MOLECULER_CACHER_SET_TIME_DESC, MOLECULER_CACHER_SET_TOTAL, MOLECULER_CACHER_SET_TOTAL_DESC, MOLECULER_CIRCUIT_BREAKER_HALF_OPENED_ACTIVE, MOLECULER_CIRCUIT_BREAKER_HALF_OPENED_ACTIVE_DESC, MOLECULER_CIRCUIT_BREAKER_OPENED_ACTIVE, MOLECULER_CIRCUIT_BREAKER_OPENED_ACTIVE_DESC, MOLECULER_CIRCUIT_BREAKER_OPENED_TOTAL, MOLECULER_CIRCUIT_BREAKER_OPENED_TOTAL_DESC, MOLECULER_EVENT_BROADCAST_TOTAL, MOLECULER_EVENT_BROADCAST_TOTAL_DESC, MOLECULER_EVENT_BROADCASTLOCAL_TOTAL, MOLECULER_EVENT_BROADCASTLOCAL_TOTAL_DESC, MOLECULER_EVENT_EMIT_TOTAL, MOLECULER_EVENT_EMIT_TOTAL_DESC, MOLECULER_EVENT_RECEIVED_ACTIVE, MOLECULER_EVENT_RECEIVED_ACTIVE_DESC, MOLECULER_EVENT_RECEIVED_ERROR_TOTAL, MOLECULER_EVENT_RECEIVED_ERROR_TOTAL_DESC, MOLECULER_EVENT_RECEIVED_TIME, MOLECULER_EVENT_RECEIVED_TIME_DESC, MOLECULER_EVENT_RECEIVED_TOTAL, MOLECULER_EVENT_RECEIVED_TOTAL_DESC, MOLECULER_EXECUTOR, MOLECULER_REQUEST_ACTIVE, MOLECULER_REQUEST_ACTIVE_DESC, MOLECULER_REQUEST_ERROR_TOTAL, MOLECULER_REQUEST_ERROR_TOTAL_DESC, MOLECULER_REQUEST_LEVELS, MOLECULER_REQUEST_LEVELS_DESC, MOLECULER_REQUEST_RETRY_ATTEMPTS_TOTAL, MOLECULER_REQUEST_RETRY_ATTEMPTS_TOTAL_DESC, MOLECULER_REQUEST_TIME, MOLECULER_REQUEST_TIME_DESC, MOLECULER_REQUEST_TIMEOUT_TOTAL, MOLECULER_REQUEST_TIMEOUT_TOTAL_DESC, MOLECULER_REQUEST_TOTAL, MOLECULER_REQUEST_TOTAL_DESC, MOLECULER_SCHEDULER, MOLECULER_TRANSIT_CONNECTED, MOLECULER_TRANSIT_CONNECTED_DESC, MOLECULER_TRANSIT_ORPHAN_RESPONSE_TOTAL, MOLECULER_TRANSIT_ORPHAN_RESPONSE_TOTAL_DESC, MOLECULER_TRANSIT_REQUESTS_ACTIVE, MOLECULER_TRANSIT_REQUESTS_ACTIVE_DESC, MOLECULER_TRANSIT_STREAMS_RECEIVE_ACTIVE, MOLECULER_TRANSIT_STREAMS_RECEIVE_ACTIVE_DESC, MOLECULER_TRANSPORTER_PACKETS_RECEIVED_BYTES, MOLECULER_TRANSPORTER_PACKETS_RECEIVED_BYTES_DESC, MOLECULER_TRANSPORTER_PACKETS_RECEIVED_TOTAL, MOLECULER_TRANSPORTER_PACKETS_RECEIVED_TOTAL_DESC, MOLECULER_TRANSPORTER_PACKETS_SENT_BYTES, MOLECULER_TRANSPORTER_PACKETS_SENT_BYTES_DESC, MOLECULER_TRANSPORTER_PACKETS_SENT_TOTAL, MOLECULER_TRANSPORTER_PACKETS_SENT_TOTAL_DESC

Constructor Summary

Constructors

Constructor and Description
Transporter()
Transporter(Serializer serializer)

Method Summary

Modifier and Type	Method and Description
void	broadcastInfoPacket()
protected void	broadcastNodeConnected(io.datatree.Tree info, boolean reconnected)
protected void	broadcastNodeDisconnected(io.datatree.Tree info, boolean unexpected)
protected void	broadcastNodeUpdated(io.datatree.Tree info)
protected void	broadcastTransporterConnected()
protected void	broadcastTransporterDisconnected()
protected java.lang.String	channel(java.lang.String cmd, java.lang.String nodeID)
protected void	checkTimeouts()
abstract void	connect()
protected void	connected()
protected void	connected(boolean waitFor)
io.datatree.Tree	createPingPacket(java.lang.String id)
protected void	error(java.lang.Throwable error) Any I/O error occurred.
RemoteAddress	getAddress(java.lang.String nodeID)
java.util.Set<java.lang.String>	getAllNodeIDs()
int	getCpuUsage(java.lang.String nodeID)
io.datatree.Tree	getDescriptor(java.lang.String nodeID)
int	getHeartbeatInterval()
int	getHeartbeatTimeout()
java.lang.String	getInstanceID()
long	getLastHeartbeatTime(java.lang.String nodeID)
java.lang.String	getNamespace()
int	getOfflineTimeout()
java.lang.String	getPrefix()
Serializer	getSerializer()
int	getSubscriptionTimeout()
boolean	isDebug()
boolean	isDebugHeartbeats()
boolean	isOnline(java.lang.String nodeID)
boolean	isPreferHostname()
protected void	processReceivedMessage(java.lang.String channel, byte[] message) Process incoming message directly (without new Task).
protected void	processReceivedMessage(java.lang.String channel, io.datatree.Tree message) Process incoming message directly (without new Task).
void	publish(java.lang.String cmd, java.lang.String nodeID, io.datatree.Tree message)
abstract void	publish(java.lang.String channel, io.datatree.Tree message)
protected void	received(java.lang.String channel, byte[] message) Process incoming message later (in a new Runnable or JoinForkTask).
protected void	scheduleInfoPacket()
void	sendClosePacket(java.lang.String cmd, java.lang.String nodeID, Context ctx, long sequence)
void	sendDataPacket(java.lang.String cmd, java.lang.String nodeID, Context ctx, byte[] bytes, long sequence)
protected void	sendDisconnectPacket()
protected void	sendDiscoverPacket(java.lang.String channel)
void	sendErrorPacket(java.lang.String cmd, java.lang.String nodeID, Context ctx, java.lang.Throwable cause, long sequence)
void	sendEventPacket(java.lang.String nodeID, Context ctx, Groups groups, boolean broadcast)
protected void	sendHeartbeatPacket()
protected void	sendInfoPacket(java.lang.String channel)
protected void	sendPongPacket(java.lang.String channel, io.datatree.Tree data)
void	sendRequestPacket(java.lang.String nodeID, Context ctx)
void	setDebug(boolean debug)
void	setDebugHeartbeats(boolean debugHeartbeats)
void	setHeartbeatInterval(int heartbeatInterval)
void	setHeartbeatTimeout(int heartbeatTimeout)
void	setNamespace(java.lang.String namespace)
void	setOfflineTimeout(int offlineTimeout)
void	setPreferHostname(boolean preferHostname)
void	setPrefix(java.lang.String prefix)
void	setSerializer(Serializer serializer)
void	setSubscriptionTimeout(int subscriptionTimeout)
void	started(ServiceBroker broker) Initializes transporter instance.
void	stopped() Closes transporter.
abstract io.datatree.Promise	subscribe(java.lang.String channel)
io.datatree.Promise	subscribe(java.lang.String cmd, java.lang.String nodeID)
protected void	updateNodeInfo(java.lang.String sender, io.datatree.Tree info)

Methods inherited from class services.moleculer.service.MoleculerComponent

getBroker, getLogger, getName

Methods inherited from class java.lang.Object

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

Field Detail

PACKET_EVENT

public static final java.lang.String PACKET_EVENT

See Also:

Constant Field Values

PACKET_REQUEST

public static final java.lang.String PACKET_REQUEST

See Also:

Constant Field Values

PACKET_RESPONSE

public static final java.lang.String PACKET_RESPONSE

See Also:

Constant Field Values

PACKET_DISCOVER

public static final java.lang.String PACKET_DISCOVER

See Also:

Constant Field Values

PACKET_INFO

public static final java.lang.String PACKET_INFO

See Also:

Constant Field Values

PACKET_DISCONNECT

public static final java.lang.String PACKET_DISCONNECT

See Also:

Constant Field Values

PACKET_HEARTBEAT

public static final java.lang.String PACKET_HEARTBEAT

See Also:

Constant Field Values

PACKET_PING

public static final java.lang.String PACKET_PING

See Also:

Constant Field Values

PACKET_PONG

public static final java.lang.String PACKET_PONG

See Also:

Constant Field Values

eventChannel

public java.lang.String eventChannel

requestChannel

public java.lang.String requestChannel

responseChannel

public java.lang.String responseChannel

discoverBroadcastChannel

public java.lang.String discoverBroadcastChannel

discoverChannel

public java.lang.String discoverChannel

infoBroadcastChannel

public java.lang.String infoBroadcastChannel

infoChannel

public java.lang.String infoChannel

disconnectChannel

public java.lang.String disconnectChannel

heartbeatChannel

public java.lang.String heartbeatChannel

pingChannel

public java.lang.String pingChannel

pongChannel

public java.lang.String pongChannel

namespace

protected java.lang.String namespace

Namespace of channels.

prefix

protected java.lang.String prefix

Prefix of channels.

nodeID

protected java.lang.String nodeID

Local Node ID.

protocolVersion

protected java.lang.String protocolVersion

ServiceBroker's protocol version

heartbeatInterval

protected int heartbeatInterval

Heartbeat sending period in SECONDS.

heartbeatTimeout

protected int heartbeatTimeout

Heartbeat timeout in SECONDS.

offlineTimeout

protected int offlineTimeout

How long keep information in registry about the offline nodes (SECONDS).

subscriptionTimeout

protected int subscriptionTimeout

Timeout of channel subscriptions (SECONDS).

preferHostname

protected boolean preferHostname

Use hostnames instead of IP addresses As the DHCP environment is dynamic, any later attempt to use IPs instead hostnames would most likely yield false results. Therefore, use hostnames if you are using DHCP.

debug

protected boolean debug

Writes the communication of method calls and events into the log.

debugHeartbeats

protected boolean debugHeartbeats

Writes the communication of heartbeats/gossiping into the log.

serializer

protected Serializer serializer

usingJsonSerializer

protected boolean usingJsonSerializer

instanceID

protected final java.lang.String instanceID

executor

protected java.util.concurrent.ExecutorService executor

scheduler

protected java.util.concurrent.ScheduledExecutorService scheduler

registry

protected ServiceRegistry registry

serviceInvoker

protected ServiceInvoker serviceInvoker

eventbus

protected Eventbus eventbus

monitor

protected Monitor monitor

uidGenerator

protected UidGenerator uidGenerator

metrics

protected Metrics metrics

heartBeatTimer

protected volatile java.util.concurrent.ScheduledFuture<?> heartBeatTimer

Cancelable "Heart Beat" timer

checkTimeoutTimer

protected volatile java.util.concurrent.ScheduledFuture<?> checkTimeoutTimer

Cancelable "Check Activities / Infos" timer

nodes

protected final java.util.concurrent.ConcurrentHashMap<java.lang.String,NodeDescriptor> nodes

infoScheduled

protected final java.util.concurrent.atomic.AtomicBoolean infoScheduled

infoScheduledAt

protected final java.util.concurrent.atomic.AtomicLong infoScheduledAt

lastReceivedMessageAt

protected final java.util.concurrent.atomic.AtomicLong lastReceivedMessageAt

gaugeTransitConnected

protected MetricGauge gaugeTransitConnected

counterTransporterPacketsSentTotal

protected MetricCounter counterTransporterPacketsSentTotal

counterTransporterPacketsSentBytes

protected MetricCounter counterTransporterPacketsSentBytes

counterTransporterPacketsReceivedTotal

protected MetricCounter counterTransporterPacketsReceivedTotal

counterTransporterPacketsReceivedBytes

protected MetricCounter counterTransporterPacketsReceivedBytes

Constructor Detail

Transporter

public Transporter()

Transporter

public Transporter(Serializer serializer)

Method Detail

started

public void started(ServiceBroker broker)
             throws java.lang.Exception

Initializes transporter instance.

Specified by:

started in interface MoleculerLifecycle

Overrides:

started in class MoleculerComponent

Parameters:

broker - parent ServiceBroker

Throws:

java.lang.Exception

channel

protected java.lang.String channel(java.lang.String cmd,
                                   java.lang.String nodeID)

connect

public abstract void connect()

connected

protected void connected()

connected

protected void connected(boolean waitFor)

stopped

public void stopped()

Closes transporter.

Specified by:

stopped in interface MoleculerLifecycle

Overrides:

stopped in class MoleculerComponent

sendInfoPacket

protected void sendInfoPacket(java.lang.String channel)

sendDiscoverPacket

protected void sendDiscoverPacket(java.lang.String channel)

sendHeartbeatPacket

protected void sendHeartbeatPacket()

sendDisconnectPacket

protected void sendDisconnectPacket()

sendPongPacket

protected void sendPongPacket(java.lang.String channel,
                              io.datatree.Tree data)

createPingPacket

public io.datatree.Tree createPingPacket(java.lang.String id)

sendEventPacket

public void sendEventPacket(java.lang.String nodeID,
                            Context ctx,
                            Groups groups,
                            boolean broadcast)

sendRequestPacket

public void sendRequestPacket(java.lang.String nodeID,
                              Context ctx)

sendDataPacket

public void sendDataPacket(java.lang.String cmd,
                           java.lang.String nodeID,
                           Context ctx,
                           byte[] bytes,
                           long sequence)

sendErrorPacket

public void sendErrorPacket(java.lang.String cmd,
                            java.lang.String nodeID,
                            Context ctx,
                            java.lang.Throwable cause,
                            long sequence)

sendClosePacket

public void sendClosePacket(java.lang.String cmd,
                            java.lang.String nodeID,
                            Context ctx,
                            long sequence)

publish

public void publish(java.lang.String cmd,
                    java.lang.String nodeID,
                    io.datatree.Tree message)

publish

public abstract void publish(java.lang.String channel,
                             io.datatree.Tree message)

subscribe

public io.datatree.Promise subscribe(java.lang.String cmd,
                                     java.lang.String nodeID)

subscribe

public abstract io.datatree.Promise subscribe(java.lang.String channel)

received

protected void received(java.lang.String channel,
                        byte[] message)

Process incoming message later (in a new Runnable or JoinForkTask).

Parameters:

channel - incoming channel

message - incoming message

processReceivedMessage

protected void processReceivedMessage(java.lang.String channel,
                                      byte[] message)

Process incoming message directly (without new Task).

Parameters:

channel - incoming channel

message - incoming message

processReceivedMessage

protected void processReceivedMessage(java.lang.String channel,
                                      io.datatree.Tree message)

Process incoming message directly (without new Task).

Parameters:

channel - incoming channel

message - incoming message

updateNodeInfo

protected void updateNodeInfo(java.lang.String sender,
                              io.datatree.Tree info)
                       throws java.lang.Exception

Throws:

java.lang.Exception

broadcastTransporterConnected

protected void broadcastTransporterConnected()

broadcastTransporterDisconnected

protected void broadcastTransporterDisconnected()

broadcastNodeConnected

protected void broadcastNodeConnected(io.datatree.Tree info,
                                      boolean reconnected)

broadcastNodeUpdated

protected void broadcastNodeUpdated(io.datatree.Tree info)

broadcastNodeDisconnected

protected void broadcastNodeDisconnected(io.datatree.Tree info,
                                         boolean unexpected)

broadcastInfoPacket

public void broadcastInfoPacket()

scheduleInfoPacket

protected void scheduleInfoPacket()

checkTimeouts

protected void checkTimeouts()

getCpuUsage

public int getCpuUsage(java.lang.String nodeID)

getLastHeartbeatTime

public long getLastHeartbeatTime(java.lang.String nodeID)

isOnline

public boolean isOnline(java.lang.String nodeID)

getAllNodeIDs

public java.util.Set<java.lang.String> getAllNodeIDs()

getDescriptor

public io.datatree.Tree getDescriptor(java.lang.String nodeID)

getAddress

public RemoteAddress getAddress(java.lang.String nodeID)

error

protected void error(java.lang.Throwable error)

Any I/O error occurred. Implementation-specific error handling goes here (reconnection, etc.).

Parameters:

error - I/O error

getSerializer

public Serializer getSerializer()

setSerializer

public void setSerializer(Serializer serializer)

getHeartbeatInterval

public int getHeartbeatInterval()

setHeartbeatInterval

public void setHeartbeatInterval(int heartbeatInterval)

getHeartbeatTimeout

public int getHeartbeatTimeout()

setHeartbeatTimeout

public void setHeartbeatTimeout(int heartbeatTimeout)

isDebug

public boolean isDebug()

setDebug

public void setDebug(boolean debug)

getOfflineTimeout

public int getOfflineTimeout()

setOfflineTimeout

public void setOfflineTimeout(int offlineTimeout)

getNamespace

public java.lang.String getNamespace()

setNamespace

public void setNamespace(java.lang.String namespace)

getPrefix

public java.lang.String getPrefix()

setPrefix

public void setPrefix(java.lang.String prefix)

isPreferHostname

public boolean isPreferHostname()

setPreferHostname

public void setPreferHostname(boolean preferHostname)

getSubscriptionTimeout

public int getSubscriptionTimeout()

setSubscriptionTimeout

public void setSubscriptionTimeout(int subscriptionTimeout)

isDebugHeartbeats

public boolean isDebugHeartbeats()

setDebugHeartbeats

public void setDebugHeartbeats(boolean debugHeartbeats)

getInstanceID

public java.lang.String getInstanceID()