io.appulse.encon.spring

Class MailboxOperations

java.lang.Object

io.appulse.encon.spring.MailboxOperations

public class MailboxOperations
extends Object

Since:

1.6.0

Author:

alabazin

Constructor Summary

Constructors

Constructor and Description
MailboxOperations()

Method Summary

Modifier and Type	Method and Description
String	name() Returns the name of the mailbox.
Node	node() Returns the Node of the mailbox.
io.appulse.encon.terms.type.ErlangPid	pid() Returns the PID of the mailbox.
io.appulse.encon.terms.ErlangTerm	receive() Returns a new mailbox message.
<T> T	receive(Class<T> type) Returns a new mailbox message.
<T> Optional<T>	receive(Class<T> type, long timeout, TimeUnit unit) Returns a new mailbox message.
Optional<io.appulse.encon.terms.ErlangTerm>	receive(long timeout, TimeUnit unit) Returns a new mailbox message.
void	send(io.appulse.encon.terms.type.ErlangPid to, Object object) Sends a message.
void	send(io.appulse.encon.common.NodeDescriptor descriptor, String mailbox, Object object) Sends a message.
void	send(io.appulse.encon.common.RemoteNode remote, String mailbox, Object object) Sends a message.
void	send(String mailbox, Object object) Sends a message.
void	send(String node, String mailbox, Object object) Sends a message.

Methods inherited from class java.lang.Object

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

Constructor Detail

MailboxOperations

public MailboxOperations()

Method Detail

name

public String name()

Returns the name of the mailbox.

Returns:

mailbox's name

pid

public io.appulse.encon.terms.type.ErlangPid pid()

Returns the PID of the mailbox.

Returns:

mailbox's PID

node

public Node node()

Returns the Node of the mailbox.

Returns:

mailbox's Node

send

public void send(@NonNull
                 io.appulse.encon.terms.type.ErlangPid to,
                 @NonNull
                 Object object)

Sends a message.

Parameters:

to - destination PID

object - message payload

send

public void send(@NonNull
                 String mailbox,
                 @NonNull
                 Object object)

Sends a message.

Parameters:

mailbox - destination mailbox name

object - message payload

send

public void send(@NonNull
                 String node,
                 @NonNull
                 String mailbox,
                 @NonNull
                 Object object)

Sends a message.

Parameters:

node - destination node name

mailbox - destination mailbox name

object - message payload

send

public void send(@NonNull
                 io.appulse.encon.common.NodeDescriptor descriptor,
                 @NonNull
                 String mailbox,
                 @NonNull
                 Object object)

Sends a message.

Parameters:

descriptor - destination node descriptor

mailbox - destination mailbox name

object - message payload

send

public void send(@NonNull
                 io.appulse.encon.common.RemoteNode remote,
                 @NonNull
                 String mailbox,
                 @NonNull
                 Object object)

Sends a message.

Parameters:

remote - destination node remote descriptor

mailbox - destination mailbox name

object - message payload

receive

public io.appulse.encon.terms.ErlangTerm receive()

Returns a new mailbox message.

Returns:

a new mailbox message

receive

public Optional<io.appulse.encon.terms.ErlangTerm> receive(long timeout,
                                                           TimeUnit unit)

Returns a new mailbox message.

Parameters:

timeout - how long to wait before giving up, in units of unit

unit - a TimeUnit determining how to interpret the timeout parameter

Returns:

a new mailbox message, or empty

receive

public <T> T receive(Class<T> type)

Returns a new mailbox message.

Parameters:

type - the type of expected message

Returns:

a new mailbox message

receive

public <T> Optional<T> receive(Class<T> type,
                               long timeout,
                               TimeUnit unit)

Returns a new mailbox message.

Parameters:

type - the type of expected message

timeout - how long to wait before giving up, in units of unit

unit - a TimeUnit determining how to interpret the timeout parameter

Returns:

a new mailbox message, or empty