[This is preliminary documentation and is subject to change.]
The ErlLocalNode type exposes the following members.Constructors
Name | Description | |
---|---|---|
![]() | ErlLocalNode(String, IConfigSectionNode) | Initializes a new instance of the ErlLocalNode class |
![]() | ErlLocalNode(String, Boolean, Boolean) |
Create a node with the given name and the default cookie
|
![]() | ErlLocalNode(String, ErlAtom, Boolean, Boolean) |
Create a node with the given name, cookie, and short name indicator
|
Methods
Name | Description | |
---|---|---|
![]() | ____ObtainPrivateServiceStatusLockObject |
WARNING: Developers never call this method!!!
It is used by advanced derived implementations that need to synchronize status updates.
We do not want to make statuslock protected as it is almost never needed, hence this accessor
(Inherited from Service.) |
![]() | __setComponentDirector | (Inherited from ApplicationComponent.) |
![]() | AbortStart |
Allows to abort unsuccessful DoStart() overridden implementation.
This method must be called from within DoStart()
(Inherited from Service.) |
![]() | AcceptManagerVisit |
Accepts a visit of a manager entity - this call is useful for periodic updates of service status,
i.e. when service does not have a thread of its own it can be periodically managed by some other service through this method.
The default implementation of DoAcceptManagerVisit(object, DateTime) does nothing
(Inherited from Service.) |
![]() | Add |
Add a connection to collection
|
![]() | ApplicationFinishAfterCleanup | |
![]() | ApplicationFinishBeforeCleanup | |
![]() | BreakLinks |
Break links of all pids linked to pids on the fromNode node
|
![]() | CheckForCompleteStop |
Non-blocking call that returns true when the service instance has completely stopped after SignalStop()
(Inherited from Service.) |
![]() | CheckServiceActive |
Checks for service activity and throws exception if service is not in ControlStatus.Active state
(Inherited from Service.) |
![]() | CheckServiceActiveOrStarting |
Checks for service activity and throws exception if service is not in ControlStatus.Active state
(Inherited from Service.) |
![]() | CheckServiceInactive |
Checks for service inactivity and throws exception if service is running (started, starting or stopping)
(Inherited from Service.) |
![]() | CloseMbox |
Close the given mailbox
|
![]() | Configure |
Configures service from configuration node (and possibly it's sub-nodes)
(Inherited from Service.) |
![]() | Connection(String, Nullable ErlAtom ) | |
![]() | Connection(ErlAtom, Nullable ErlAtom ) | |
![]() | Connection(String, IConfigSectionNode, Nullable ErlAtom ) | |
![]() | CreateMbox(String) |
Create a new named mailbox (emulates spawning a new Pid)
|
![]() | CreateMbox(ErlAtom) |
Create a new named mailbox (emulates spawning a new Pid)
|
![]() ![]() | CreateNullPid |
Create an Erlang ErlPid that belongs to current node
|
![]() | CreatePid |
Create an Erlang ErlPid. Erlang pids are based
upon some node specific information; this method creates a pid
using the information in this node. Each call to this method
produces a unique pid
|
![]() | CreatePort |
Create an Erlang ErlPort. Erlang ports are
based upon some node specific information; this method creates a
port using the information in this node. Each call to this method
produces a unique port. It may not be meaningful to create a port
in a non-Erlang environment, but this method is provided for
completeness
|
![]() | CreateRef |
Create an Erlang {@link Ref reference}. Erlang
references are based upon some node specific information; this
method creates a reference using the information in this node.
Each call to this method produces a unique reference
|
![]() | Deliver(ErlConnectionException) | |
![]() | Deliver(ErlMsg) | |
![]() | Deliver(ErlAtom, ErlMsg) | |
![]() | Destructor | (Inherited from Service.) |
![]() | Disconnect | |
![]() | Dispose |
Deterministically disposes object. DO NOT OVERRIDE this method, override Destructor() instead
(Inherited from DisposableObject.) |
![]() | DoAcceptManagerVisit |
Accepts a visit from external manager. Base implementation does nothing.
Override in services that need external management calls
to update their state periodically, i.e. when they don't have a thread on their own
(Inherited from Service.) |
![]() | DoCheckForCompleteStop |
Provides implementation for checking whether the service has completely stopped
(Inherited from Service.) |
![]() | DoConfigure | (Overrides ErlAbstractNode DoConfigure(IConfigSectionNode).) |
![]() | DoSignalStop |
Provides implementation that signals service to stop. This is expected not to block
(Inherited from Service.) |
![]() | DoStart |
Start current node. This optionally creates a socket listener
and I/O server
(Overrides Service DoStart .) |
![]() | DoWaitForCompleteStop | (Overrides Service DoWaitForCompleteStop .) |
![]() | EnsureObjectNotDisposed |
Checks to see whether object dispose started or has already been disposed and throws an exception if Dispose() was called
(Inherited from DisposableObject.) |
![]() | ![]() | Determines whether the specified object is equal to the current object. (Inherited from ![]() |
![]() | Finalize | (Inherited from DisposableObject.) |
![]() | FindMbox |
Determine the mailbox corresponding to a
registered name on this ErlLocalNode |
![]() | ![]() | Serves as the default hash function. (Inherited from ![]() |
![]() | ![]() | Gets the (Inherited from ![]() ![]() |
![]() | LocalizedTimeToUniversalTime |
Converts localized time to UTC time as of TimeLocation property
(Inherited from Service.) |
![]() ![]() | MakeLocalNodeForThisAppOnThisHost |
Makes local node name based on app id and local host name
|
![]() | ![]() | Creates a shallow copy of the current (Inherited from ![]() ![]() |
![]() | OnConnectAttempt | |
![]() | OnEpmdFailedConnectAttempt | |
![]() | OnIoOutput | |
![]() | OnNodeStatusChange | |
![]() | OnReadWrite | |
![]() | OnTrace(ErlTraceLevel, Direction, Func String , String, Int32) | |
![]() | OnTrace(ErlTraceLevel, Direction, String, String, Int32) | |
![]() | OnTraceCore | |
![]() | OnUnhandledMsg | |
![]() | RemoteNodeConfig |
Get configuration settings for a given remote node
|
![]() | Remove |
Remove a connection from collection
|
![]() | RPC | |
![]() | Send(ErlPid, IErlObject) | |
![]() | Send(ErlPid, ErlAtom, IErlObject) |
Send a message to a named mailbox on local node
|
![]() | Send(ErlPid, ErlAtom, ErlAtom, IErlObject) |
Send a message to a named mailbox on a given remote node
|
![]() | SetNodeName | (Inherited from ErlAbstractNode.) |
![]() | SignalStop |
Non-blocking call that initiates the stopping of the service
(Inherited from Service.) |
![]() | Start |
Blocking call that starts the service instance
(Inherited from Service.) |
![]() | StartByApplication |
Blocking call that starts the service instance
(Inherited from Service.) |
![]() | ToString | (Inherited from ErlAbstractNode.) |
![]() | UniversalTimeToLocalizedTime |
Converts universal time to local time as of TimeLocation property
(Inherited from Service.) |
![]() | WaitAny( ErlMbox ) | |
![]() | WaitAny(Int32, ErlMbox ) | |
![]() | WaitAny( ErlMbox , Int32) |
Wait for arrival of messages in any one of the given mailboxes
|
![]() | WaitAny(IEnumerable ErlMbox , Int32) | |
![]() | WaitForCompleteStop |
Blocks execution of current thread until this service has completely stopped
(Inherited from Service.) |
Extension Methods
Fields
Name | Description | |
---|---|---|
![]() | m_Creation | (Inherited from ErlAbstractNode.) |
![]() | m_Mailboxes | |
![]() | m_OnReadWrite |
Delegate invoked on read/write from socket
|
![]() | m_TcpKeepAlive | (Inherited from ErlAbstractNode.) |
![]() | m_TcpLinger | (Inherited from ErlAbstractNode.) |
![]() | m_TcpNoDelay | (Inherited from ErlAbstractNode.) |
![]() | m_TcpRcvBufSize | (Inherited from ErlAbstractNode.) |
![]() | m_TcpSndBufSize | (Inherited from ErlAbstractNode.) |
Properties
Name | Description | |
---|---|---|
![]() | AcceptAddressPort |
Configuration Address and Port information for the listener in
the "address:port" format
|
![]() | AcceptConnections |
If true local node will start a listener
|
![]() | AliveName |
Get the alivename part of the hostname. Nodenames are composed of
two parts, an alivename and a hostname, separated by '@'. This
method returns the part of the nodename preceding the '@'
(Inherited from ErlAbstractNode.) |
![]() | AllNodeConfigs |
Configs for remote nodes
|
![]() | ApplicationDontAutoStartService |
Checks whether the class is decorated with ApplicationDontAutoStartServiceAttribute
(Inherited from Service.) |
![]() | ComponentCommonName |
Returns the common name used to identify the component, for example "Glue" for various IGlue implementations.
This name is searched-by some management tools that allow to find component by this name that does not change between
application restarts like ComponentSID does. Subordinate (non-root) components return null
(Inherited from ApplicationComponent.) |
![]() | ComponentDirector |
Returns a reference to an object that this app component services/operates under, or null
(Inherited from ApplicationComponent.) |
![]() | ComponentSID |
Returns process/instance unique app component system id
(Inherited from ApplicationComponent.) |
![]() | ComponentStartTime |
Returns local computer time of component start (not from application container time)
(Inherited from ApplicationComponent.) |
![]() | Connections | |
![]() | Cookie |
Get the authorization cookie used by this node
(Inherited from ErlAbstractNode.) |
![]() | Creation |
Contains node creation bits that facilitate Pid uniqueness
upon node restart
|
![]() | Disposed |
Indicates whether this object was already disposed - the Dispose() has finished
(Inherited from DisposableObject.) |
![]() | DisposeStarted |
Indicates whether this object Dispose() has been called and dispose started but not finished yet
(Inherited from DisposableObject.) |
![]() | DistChoose | (Inherited from ErlAbstractNode.) |
![]() | DistHigh | (Inherited from ErlAbstractNode.) |
![]() | DistLow | (Inherited from ErlAbstractNode.) |
![]() | Epmd |
Get/Set the Epmd socket after publishing this nodes listen port to Epmd
(Inherited from ErlAbstractNode.) |
![]() | Flags | (Inherited from ErlAbstractNode.) |
![]() | GroupLeader |
Mailbox for handling all I/O directed from remote nodes
|
![]() | Host |
Get the hostname part of the nodename. Nodenames are composed of
two parts, an alivename and a hostname, separated by '@'. This
method returns the part of the nodename following the '@'
(Inherited from ErlAbstractNode.) |
![]() | LocalizedTime |
Returns current time localized per TimeLocation
(Inherited from Service.) |
![]() | LogUnhandledMsgs |
Record unhandled msgs to log
|
![]() | Mailboxes | |
![]() | MboxFreelist |
Cache of freed mailboxes that can be reused for RPC calls
|
![]() | Name |
Provides textual name for the service
(Inherited from Service.) |
![]() | NodeLongName |
Get the long name of this node
(Inherited from ErlAbstractNode.) |
![]() | NodeName |
Get the name of this node (short or long depending on UseShortName)
(Inherited from ErlAbstractNode.) |
![]() | Ntype | (Inherited from ErlAbstractNode.) |
![]() | Port |
Get the port number used by this node.
For local node the value may be 0 if the node was not registered with
the EPMD port mapper
(Inherited from ErlAbstractNode.) |
![]() | Proto | (Inherited from ErlAbstractNode.) |
![]() | RemoteNodeConfigs | |
![]() | Running |
Returns true when service is active or about to become active.
Check in service implementation loops/threads/tasks
(Inherited from Service.) |
![]() | Status |
Current service status
(Inherited from Service.) |
![]() | TcpKeepAlive | (Inherited from ErlAbstractNode.) |
![]() | TcpLinger | (Inherited from ErlAbstractNode.) |
![]() | TcpNoDelay | (Inherited from ErlAbstractNode.) |
![]() | TcpRcvBufSize | (Inherited from ErlAbstractNode.) |
![]() | TcpSndBufSize | (Inherited from ErlAbstractNode.) |
![]() | TimeLocation |
Returns time location of this LocalizedTimeProvider implementation
(Inherited from Service.) |
![]() | TraceLevel |
Set the trace level for this connection. Normally tracing is off by default
|
![]() | TraceToLog |
Save trace events to log
|
![]() | UseShortName | (Inherited from ErlAbstractNode.) |
Events
Name | Description | |
---|---|---|
![]() | ConnectAttempt | |
![]() | EpmdFailedConnectAttempt | |
![]() | IoOutput | |
![]() | NodeStatusChange | |
![]() | ReadWrite | |
![]() | Trace |
Trace callback executed if connection tracing is enabled
|
![]() | UnhandledMsg |
See Also