Class RedisTransporter

java.lang.Object

services.moleculer.service.MoleculerComponent

services.moleculer.transporter.Transporter

services.moleculer.transporter.RedisTransporter

All Implemented Interfaces:

io.lettuce.core.event.EventBus, io.lettuce.core.pubsub.RedisPubSubListener<byte[],byte[]>, MetricConstants, MoleculerLifecycle

public class RedisTransporter
extends Transporter
implements io.lettuce.core.event.EventBus, io.lettuce.core.pubsub.RedisPubSubListener<byte[],byte[]>

Redis Transporter. Redis is an open source (BSD licensed), in-memory data structure store, used as a database, cache and message broker (website: https://redis.io). Usage:

ServiceBroker broker = ServiceBroker.builder().nodeID("node1")
.transporter(new RedisTransporter("localhost")).build();

Required dependency:

// https://mvnrepository.com/artifact/biz.paluch.redis/lettuce
compile group: 'biz.paluch.redis', name: 'lettuce', version: '4.5.0.Final'

See Also:

• TcpTransporter
• NatsTransporter
• MqttTransporter
• JmsTransporter
• KafkaTransporter
• AmqpTransporter

Field Summary

Fields

Modifier and Type	Field	Description
protected RedisPubSubClient	clientPub
protected RedisPubSubClient	clientSub
protected String	password
protected boolean	secure
protected final AtomicInteger	status
protected static final int	STATUS_CONNECTED
protected static final int	STATUS_CONNECTING_1
protected static final int	STATUS_CONNECTING_2
protected static final int	STATUS_DISCONNECTED
protected static final int	STATUS_DISCONNECTING
protected String[]	urls

Fields inherited from class Transporter

checkTimeoutTimer, counterTransporterPacketsReceivedBytes, counterTransporterPacketsReceivedTotal, counterTransporterPacketsSentBytes, counterTransporterPacketsSentTotal, debug, debugHeartbeats, disconnectChannel, discoverBroadcastChannel, discoverChannel, eventbus, eventChannel, executor, gaugeTransitConnected, heartbeatChannel, heartbeatInterval, heartbeatTimeout, heartBeatTimer, infoBroadcastChannel, infoChannel, infoScheduled, infoScheduledAt, instanceID, lastReceivedMessageAt, metrics, monitor, namespace, nodeID, nodes, offlineTimeout, PACKET_DISCONNECT, PACKET_DISCOVER, PACKET_EVENT, PACKET_HEARTBEAT, PACKET_INFO, PACKET_PING, PACKET_PONG, PACKET_REQUEST, PACKET_RESPONSE, pingChannel, pongChannel, preferHostname, prefix, protocolVersion, registry, requestChannel, responseChannel, scheduler, serializer, serviceInvoker, subscriptionTimeout, uidGenerator, usingJsonSerializer

Fields inherited from class MoleculerComponent

broker, logger, name

Fields inherited from interface 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	Description
RedisTransporter()
RedisTransporter(String... urls)
RedisTransporter(String password, boolean secure, String... urls)

Method Summary

Modifier and Type	Method	Description
void	connect()
protected io.datatree.Promise	disconnect()
protected void	error(Throwable cause)	Any I/O error occurred.
reactor.core.publisher.Flux<io.lettuce.core.event.Event>	get()
String	getPassword()
String[]	getUrls()
boolean	isSecure()
void	message(byte[] channel, byte[] message)
void	message(byte[] pattern, byte[] channel, byte[] message)
void	psubscribed(byte[] pattern, long count)
void	publish(io.lettuce.core.event.Event event)
void	publish(String channel, io.datatree.Tree message)
void	punsubscribed(byte[] pattern, long count)
protected void	reconnect()
void	setPassword(String password)
void	setSecure(boolean secure)
void	setUrls(String[] urls)
void	stopped()	Closes transporter.
io.datatree.Promise	subscribe(String channel)
void	subscribed(byte[] channel, long count)
protected void	unableToConnect(Exception cause)
void	unsubscribed(byte[] channel, long count)

Methods inherited from class Transporter

broadcastInfoPacket, broadcastNodeConnected, broadcastNodeDisconnected, broadcastNodeUpdated, broadcastTransporterConnected, broadcastTransporterDisconnected, channel, checkTimeouts, connected, connected, createPingPacket, getAddress, getAllNodeIDs, getCpuUsage, getDescriptor, getHeartbeatInterval, getHeartbeatTimeout, getInstanceID, getLastHeartbeatTime, getNamespace, getOfflineTimeout, getPrefix, getSerializer, getSubscriptionTimeout, isDebug, isDebugHeartbeats, isOnline, isPreferHostname, processReceivedMessage, processReceivedMessage, publish, received, scheduleInfoPacket, sendClosePacket, sendDataPacket, sendDisconnectPacket, sendDiscoverPacket, sendErrorPacket, sendEventPacket, sendHeartbeatPacket, sendInfoPacket, sendPongPacket, sendRequestPacket, setDebug, setDebugHeartbeats, setHeartbeatInterval, setHeartbeatTimeout, setNamespace, setOfflineTimeout, setPreferHostname, setPrefix, setSerializer, setSubscriptionTimeout, started, subscribe, updateNodeInfo

Methods inherited from class MoleculerComponent

getBroker, getLogger, getName

Methods inherited from class Object

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

Methods inherited from interface io.lettuce.core.pubsub.RedisPubSubListener

smessage, ssubscribed, sunsubscribed

Field Details

STATUS_DISCONNECTING

protected static final int STATUS_DISCONNECTING

See Also:

• Constant Field Values

STATUS_DISCONNECTED

protected static final int STATUS_DISCONNECTED

See Also:

• Constant Field Values

STATUS_CONNECTING_1

protected static final int STATUS_CONNECTING_1

See Also:

• Constant Field Values

STATUS_CONNECTING_2

protected static final int STATUS_CONNECTING_2

See Also:

• Constant Field Values

STATUS_CONNECTED

protected static final int STATUS_CONNECTED

See Also:

• Constant Field Values

status

protected final AtomicInteger status

password

protected String password

secure

protected boolean secure

urls

protected String[] urls

clientSub

protected RedisPubSubClient clientSub

clientPub

protected RedisPubSubClient clientPub

Constructor Details

RedisTransporter

public RedisTransporter()

RedisTransporter

public RedisTransporter(String... urls)

RedisTransporter

public RedisTransporter(String password,
 boolean secure,
 String... urls)

Method Details

connect

public void connect()

Specified by:

connect in class Transporter

unableToConnect

protected void unableToConnect(Exception cause)

disconnect

protected io.datatree.Promise disconnect()

reconnect

protected void reconnect()

error

protected void error(Throwable cause)

Description copied from class: Transporter

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

Overrides:

error in class Transporter

Parameters:

cause - I/O error

stopped

public void stopped()

Closes transporter.

Specified by:

stopped in interface MoleculerLifecycle

Overrides:

stopped in class Transporter

subscribe

public io.datatree.Promise subscribe(String channel)

Specified by:

subscribe in class Transporter

publish

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

Specified by:

publish in class Transporter

message

public void message(byte[] channel,
 byte[] message)

Specified by:

message in interface io.lettuce.core.pubsub.RedisPubSubListener<byte[],byte[]>

message

public void message(byte[] pattern,
 byte[] channel,
 byte[] message)

Specified by:

message in interface io.lettuce.core.pubsub.RedisPubSubListener<byte[],byte[]>

subscribed

public void subscribed(byte[] channel,
 long count)

Specified by:

subscribed in interface io.lettuce.core.pubsub.RedisPubSubListener<byte[],byte[]>

psubscribed

public void psubscribed(byte[] pattern,
 long count)

Specified by:

psubscribed in interface io.lettuce.core.pubsub.RedisPubSubListener<byte[],byte[]>

unsubscribed

public void unsubscribed(byte[] channel,
 long count)

Specified by:

unsubscribed in interface io.lettuce.core.pubsub.RedisPubSubListener<byte[],byte[]>

punsubscribed

public void punsubscribed(byte[] pattern,
 long count)

Specified by:

punsubscribed in interface io.lettuce.core.pubsub.RedisPubSubListener<byte[],byte[]>

publish

public void publish(io.lettuce.core.event.Event event)

Specified by:

publish in interface io.lettuce.core.event.EventBus

get

public reactor.core.publisher.Flux<io.lettuce.core.event.Event> get()

Specified by:

get in interface io.lettuce.core.event.EventBus

getUrls

public String[] getUrls()

setUrls

public void setUrls(String[] urls)

getPassword

public String getPassword()

setPassword

public void setPassword(String password)

isSecure

public boolean isSecure()

setSecure

public void setSecure(boolean secure)