Liking cljdoc? Tell your friends :D

jiface.otp.nodes


abstract-node-behaviourclj

source

AbstractNodeObjectcljprotocol

). The location of a user's home directory is determined using the system property user.home, which may not be automatically set on all platforms.

Instances of this class cannot be created directly, use one of the subclasses instead.

). The location of a user's home directory is determined
using the system property `user.home`, which may not be automatically set
on all platforms.

Instances of this class cannot be created directly, use one of the subclasses
instead.

->strclj

(->str this)

Return a string representation of the node.

Return a string representation of the node.

create-server-transportclj

(create-server-transport this port-num)

Create instance of OtpServerTransport.

Create instance of `OtpServerTransport`.

create-transportclj

(create-transport this addr port-num)

Create instance of OtpTransport.

Create instance of `OtpTransport`.

get-alivenameclj

(get-alivename this)

Get the alivename part of the hostname.

Get the alivename part of the hostname.

get-cookieclj

(get-cookie this)

Get the authorization cookie used by this node.

Get the authorization cookie used by this node.

get-hostnameclj

(get-hostname this)

Get the hostname part of the nodename.

Get the hostname part of the nodename.

get-nameclj

(get-name this)

Get the name of this node.

Get the name of this node.

set-cookieclj

(set-cookie this value)

Set the authorization cookie used by this node.

Set the authorization cookie used by this node.
sourceraw docstring

default-nodeclj

Get the default node.

The results of this function are memoized as the intent is to obtain a singleton instance of the default node. (The Erlang JInterface docs recommend that only one node be run per JVM instance.)

Get the default node.

The results of this function are memoized as the intent is to obtain a
singleton instance of the default node. (The Erlang JInterface docs
recommend that only one node be run per JVM instance.)
sourceraw docstring

local-node-behaviourclj

source

LocalNodeObjectcljprotocol

This class represents local node types. It is used to group the node types OtpNode and OtpSelf.

This class represents local node types. It is used to group the node types
`OtpNode` and `OtpSelf`.

create-pidclj

(create-pid this)

Create an Erlang pid.

Create an Erlang pid.

create-portclj

(create-port this)

Create an Erlang port.

Create an Erlang port.

create-refclj

(create-ref this)

Create an Erlang ref.

Create an Erlang ref.

get-portclj

(get-port this)

Get the port number used by this node.

Get the port number used by this node.
sourceraw docstring

nodeclj

(node node-name & args)

Constructor for OtpNode.

If one arg is passed, it must be of type String, representing the node name.

If two args are passed, the first must be of type String and the second must be either an OtpTransportFactory or a String representing the Erlang cookie.

If three args are passed, they must be:

  • node name (String)
  • Erlang cookie (String)
  • port number (Integer) or an OtpTransportFactory

If four args are passed, they must be:

  • node name (String)
  • Erlang cookie (String)
  • port number (Integer)
  • an OtpTransportFactory
Constructor for `OtpNode`.

If one arg is passed, it must be of type `String`, representing the node
name.

If two args are passed, the first must be of type `String` and the
second must be either an `OtpTransportFactory` or a `String` representing
the Erlang cookie.

If three args are passed, they must be:

* node name (`String`)
* Erlang cookie (`String`)
* port number (`Integer`) or an `OtpTransportFactory`

If four args are passed, they must be:

* node name (`String`)
* Erlang cookie (`String`)
* port number (`Integer`)
* an `OtpTransportFactory`
sourceraw docstring

node-behaviourclj

source

NodeObjectcljprotocol

Represents a local OTP node. This class is used when you do not wish to manage connections yourself - outgoing connections are established as needed, and incoming connections accepted automatically. This class supports the use of a mailbox API for communication, while management of the underlying communication mechanism is automatic and hidden from the application programmer.

Once an instance of this class has been created, obtain one or more mailboxes in order to send or receive messages. The first message sent to a given node will cause a connection to be set up to that node. Any messages received will be delivered to the appropriate mailboxes.

To shut down the node, call (close). This will prevent the node from accepting additional connections and it will cause all existing connections to be closed. Any unread messages in existing mailboxes can still be read, however no new messages will be delivered to the mailboxes.

Note that the use of this class requires that EPMD (Erlang Port Mapper Daemon) is running on each cooperating host. This class does not start EPMD automatically as Erlang does, you must start it manually or through some other means. See the Erlang documentation for more information about this.

Represents a local OTP node. This class is used when you do not wish to
manage connections yourself - outgoing connections are established as
needed, and incoming connections accepted automatically. This class
supports the use of a mailbox API for communication, while management of
the underlying communication mechanism is automatic and hidden from the
application programmer.

Once an instance of this class has been created, obtain one or more
mailboxes in order to send or receive messages. The first message sent to
a given node will cause a connection to be set up to that node. Any
messages received will be delivered to the appropriate mailboxes.

To shut down the node, call `(close)`. This will prevent the node from
accepting additional connections and it will cause all existing
connections to be closed. Any unread messages in existing mailboxes can
still be read, however no new messages will be delivered to the mailboxes.

Note that the use of this class requires that EPMD (Erlang Port Mapper
Daemon) is running on each cooperating host. This class does not start EPMD
automatically as Erlang does, you must start it manually or through some
other means. See the Erlang documentation for more information about this.

set-flagsclj

(set-flags this flags)

register-mboxclj

(register-mbox this mbox-name mbox)

Register or remove a name for the given mailbox.

Register or remove a name for the given mailbox.

pingclj

(ping this node-name timeout)

Determine if another node is alive.

Determine if another node is alive.

get-namesclj

(get-names this)

Get a list of all known registered names on this node.

Get a list of all known registered names on this node.

closeclj

(close this)

Close the node.

Close the node.

close-mboxclj

(close-mbox this mbox)
(close-mbox this mbox reason)

Close the specified mailbox. If not reason is provided, the default reason of 'normal' is used.

Close the specified mailbox. If not reason is provided, the default
reason of 'normal' is used.

create-mboxclj

(create-mbox this)
(create-mbox this name)

Create a mailbox that can be used to send and receive messages with other, similar mailboxes and with Erlang processes. If a name name is not provided, the Mbox is simply unnamed.

Create a mailbox that can be used to send and receive messages with other,
similar mailboxes and with Erlang processes. If a name name is not
provided, the Mbox is simply unnamed.

register-status-handlerclj

(register-status-handler this handler)

Register interest in certain system events.

Register interest in certain system events.

whereisclj

(whereis this mbox-name)

Determine the pid corresponding to a registered name on this node.

Determine the pid corresponding to a registered name on this node.
sourceraw docstring

peerclj

(peer node-name & args)

Constructor for OtpPeer.

Represents a remote OTP node. It acts only as a container for the nodename and other node-specific information that is needed by the OtpConnection class.

If one arg is passed, it must be of type String, representing the node name.

If two args are passed, the first must be of type String and the second must be an OtpTransportFactory.

Constructor for `OtpPeer`.

Represents a remote OTP node. It acts only as a container for the nodename
and other node-specific information that is needed by the `OtpConnection`
class.

If one arg is passed, it must be of type `String`, representing the node
name.

If two args are passed, the first must be of type `String` and the
second must be an `OtpTransportFactory`.
sourceraw docstring

selfclj

(self node-name & args)

Constructor for OtpSelf.

If one arg is passed, it must be of type String, representing the node name.

If two args are passed, the first must be of type String and the second must be either an OtpTransportFactory or a String representing the Erlang cookie.

If three args are passed, they must be:

  • node name (String)
  • Erlang cookie (String)
  • port number (Integer) or an OtpTransportFactory

If four args are passed, they must be:

  • node name (String)
  • Erlang cookie (String)
  • port number (Integer)
  • an OtpTransportFactory
Constructor for `OtpSelf`.

If one arg is passed, it must be of type `String`, representing the node
name.

If two args are passed, the first must be of type `String` and the
second must be either an `OtpTransportFactory` or a `String` representing
the Erlang cookie.

If three args are passed, they must be:

* node name (`String`)
* Erlang cookie (`String`)
* port number (`Integer`) or an `OtpTransportFactory`

If four args are passed, they must be:

* node name (`String`)
* Erlang cookie (`String`)
* port number (`Integer`)
* an `OtpTransportFactory`
sourceraw docstring

self-behaviourclj

source

SelfObjectcljprotocol

Represents an OTP node. It is used to connect to remote nodes or accept incoming connections from remote nodes.

When the Java node will be connecting to a remote Erlang, Java or C node, it must first identify itself as a node by creating an instance of this class, after which it may connect to the remote node.

When you create an instance of this class, it will bind a socket to a port so that incoming connections can be accepted. However the port number will not be made available to other nodes wishing to connect until you explicitely register with the port mapper daemon by calling publishPort().

Represents an OTP node. It is used to connect to remote nodes or accept
incoming connections from remote nodes.

When the Java node will be connecting to a remote Erlang, Java or C node, it
must first identify itself as a node by creating an instance of this class,
after which it may connect to the remote node.

When you create an instance of this class, it will bind a socket to a port so
that incoming connections can be accepted. However the port number will not
be made available to other nodes wishing to connect until you explicitely
register with the port mapper daemon by calling publishPort(). 

acceptclj

(accept this)

Accept an incoming connection from a remote node.

Accept an incoming connection from a remote node.

connectclj

(connect this peer)

Open a connection to a remote node.

Open a connection to a remote node.

get-pidclj

(get-pid this)

Get the Erlang PID that will be used as the sender id in all "anonymous" messages sent by this node.

Get the Erlang PID that will be used as the sender id in all "anonymous"
messages sent by this node.

publish-portclj

(publish-port this)

Make public the information needed by remote nodes that may wish to connect to this one.

Make public the information needed by remote nodes that may wish to
connect to this one.

unpublish-portclj

(unpublish-port this)

Unregister the server node's name and port number from the Erlang port mapper, thus preventing any new connections from remote nodes.

Unregister the server node's name and port number from the Erlang port
mapper, thus preventing any new connections from remote nodes.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close