io.scalecube.cluster.transport.api

Interface Transport

public interface Transport

Transport is responsible for maintaining existing p2p connections to/from other transports. It allows to send messages to other transports and listen for incoming messages.

Method Summary

Modifier and Type	Method and Description
io.scalecube.net.Address	address() Returns local Address on which current instance of transport listens for incoming messages.
boolean	isStopped() Return transport's stopped state.
reactor.core.publisher.Flux<Message>	listen() Returns stream of received messages.
reactor.core.publisher.Mono<Message>	requestResponse(io.scalecube.net.Address address, Message request) Sends message to the given address.
reactor.core.publisher.Mono<Void>	send(io.scalecube.net.Address address, Message message) Sends message to the given address.
reactor.core.publisher.Mono<Void>	stop() Stop transport, disconnect all connections and release all resources which belong to this transport.

Method Detail

address

io.scalecube.net.Address address()

Returns local Address on which current instance of transport listens for incoming messages.

Returns:

address

stop

reactor.core.publisher.Mono<Void> stop()

Stop transport, disconnect all connections and release all resources which belong to this transport. After transport is stopped it can't be used again. Observable returned from method listen() will immediately emit onComplete event for all subscribers.

isStopped

boolean isStopped()

Return transport's stopped state.

Returns:

true if transport was stopped; false otherwise

send

reactor.core.publisher.Mono<Void> send(io.scalecube.net.Address address,
                                       Message message)

Sends message to the given address. It will issue connect in case if no transport channel by given transport address exists already. Send is an async operation.

Parameters:

address - address where message will be sent

message - message to send

Returns:

promise which will be completed with result of sending (void or exception)

Throws:

IllegalArgumentException - if message or address is null

requestResponse

reactor.core.publisher.Mono<Message> requestResponse(io.scalecube.net.Address address,
                                                     Message request)

Sends message to the given address. It will issue connect in case if no transport channel by given transport address exists already. Send is an async operation and expecting a response by a provided correlationId and sender address of the caller.

Parameters:

address - address where message will be sent

request - to send message must contain correlctionId and sender to handle reply.

Returns:

promise which will be completed with result of sending (message or exception)

Throws:

IllegalArgumentException - if message or address is null

listen

reactor.core.publisher.Flux<Message> listen()

Returns stream of received messages. For each observers subscribed to the returned observable:

• rx.Observer#onNext(Object) will be invoked when some message arrived to current transport
• rx.Observer#onCompleted() will be invoked when there is no possibility that server will receive new message observable for already closed transport
• rx.Observer#onError(Throwable) will not be invoked

Returns:

Observable which emit received messages or complete event when transport is closed