[This is preliminary documentation and is subject to change.]
The ErlRemoteNode type exposes the following members.Constructors
Name | Description | |
---|---|---|
![]() | ErlRemoteNode(ErlLocalNode) |
Constructor used for creating a remote node by the Acceptor of incoming connections
|
![]() | ErlRemoteNode(ErlLocalNode, ErlAtom, Nullable ErlAtom ) |
Create a peer node
|
![]() | ErlRemoteNode(ErlLocalNode, String, Nullable ErlAtom ) |
Create a peer node
|
![]() | ErlRemoteNode(ErlLocalNode, ErlAtom, IConfigSettings, Nullable ErlAtom ) |
Create a peer node
|
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.) |
![]() | AppendSSHParamsToTransport | |
![]() | 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.) |
![]() | Configure |
Configures service from configuration node (and possibly it's sub-nodes)
(Inherited from Service.) |
![]() | Connect |
Create a connection to a remote node
|
![]() | Destructor | (Inherited from Service.) |
![]() | 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 | (Inherited from ErlAbstractNode.) |
![]() | DoSignalStop |
Provides implementation that signals service to stop. This is expected not to block
(Inherited from Service.) |
![]() | DoStart |
Provides implementation that starts the service
(Inherited from Service.) |
![]() | DoWaitForCompleteStop |
Provides implementation for a blocking call that returns only after a complete service stop
(Inherited from Service.) |
![]() | 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.) |
![]() | ![]() | 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.) |
![]() | ![]() | Creates a shallow copy of the current (Inherited from ![]() ![]() |
![]() | 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.) |
![]() | 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_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 | |
---|---|---|
![]() | 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.) |
![]() | 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.) |
![]() | ConnectTimeout |
Connect timeout, ms
|
![]() | Cookie |
Get the authorization cookie used by this node
(Inherited from ErlAbstractNode.) |
![]() | 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.) |
![]() | 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.) |
![]() | 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.) |
![]() | Running |
Returns true when service is active or about to become active.
Check in service implementation loops/threads/tasks
(Inherited from Service.) |
![]() | SSHAuthenticationType |
Type of auth on SSH server
|
![]() | SSHPrivateKeyFilePath |
Private key file path (only for AuthenticationType = PublicKey)
Required SSH2 ENCRYPTED PRIVATE KEY format.
|
![]() | SSHServerPort |
Port of SSH server
|
![]() | SSHUserName |
SSH user name
|
![]() | 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.) |
![]() | TransportClassName |
Full name of transport class (if not specified - it uses ErlTcpTransport)
|
![]() | UseShortName | (Inherited from ErlAbstractNode.) |
See Also