ErlMbox Members

NFX Class Library

[This is preliminary documentation and is subject to change.]

The ErlMbox type exposes the following members.

Constructors

	Name	Description
	ErlMbox(ErlLocalNode, ErlPid, ErlAtom)	Initializes a new instance of the ErlMbox class
	ErlMbox(ErlLocalNode, ErlPid, String)	Create a mailbox with optional name

Methods

	Name	Description
	AsyncRPC(ErlAtom, ErlAtom, ErlAtom, ErlList, Nullable ErlAtom )
	AsyncRPC(ErlAtom, String, String, ErlList, Nullable ErlAtom )
	AsyncRPC(ErlAtom, ErlAtom, ErlAtom, ErlList, IErlObject, Nullable ErlAtom )	Send RPC call to a given node.
	AsyncRPC(ErlAtom, String, String, ErlList, ErlPid, Nullable ErlAtom )
	BreakLinks(ErlAtom)	Used to break all known links to this mbox
	BreakLinks(ErlAtom, IErlObject)	Used to break all known links to this mbox
	Clear
	Close	Close this mailbox
	Deliver(ErlConnectionException)
	Deliver(ErlMsg)	Called to deliver message to this mailbox
	Dequeue
	Destructor	(Overrides DisposableObject Destructor .)
	Dispose	Deterministically disposes object. DO NOT OVERRIDE this method, override Destructor() instead (Inherited from DisposableObject.)
	Down
	Enqueue
	EnsureObjectNotDisposed	Checks to see whether object dispose started or has already been disposed and throws an exception if Dispose() was called (Inherited from DisposableObject.)
	Equals	Determine if two mailboxes are equal (Overrides Object Equals(Object).)
	Finalize	(Inherited from DisposableObject.)
	GetHashCode	(Overrides Object GetHashCode .)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	Link	Link to a remote mailbox or Erlang process. Links are idempotent, calling this method multiple times will not result in more than one link being created
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnMailboxMessage
	Receive	Wait for a message to arrive for this mailbox. On timeout return null
	receiveBuf	Wait for a message to arrive for this mailbox
	ReceiveMatch(ErlPatternMatcher, Int32)	Receive a message and match it against a given pattern
	ReceiveMatch(IErlObject, Int32)	Receive a message and match it against a given pattern
	ReceiveRPC
	Register(String)	Register a name for this mailbox. Registering a name for a mailbox enables others to send messages without knowing the ErlPid of the mailbox. A mailbox can have at most one name; if the mailbox already had a name, calling this method will supercede that name
	Register(ErlAtom)
	RPC(ErlAtom, ErlAtom, ErlAtom, ErlList, Nullable ErlAtom )
	RPC(ErlAtom, String, String, ErlList, Nullable ErlAtom )
	RPC(ErlAtom, ErlAtom, ErlAtom, ErlList, Int32, Nullable ErlAtom )
	RPC(ErlAtom, String, String, ErlList, Int32, Nullable ErlAtom )
	RPCcast(ErlAtom, ErlAtom, ErlAtom, ErlList)
	RPCcast(ErlAtom, ErlAtom, ErlAtom, ErlList, IErlObject)
	Send	Send a message to a named mailbox created from another node
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	Unlink	Remove a link to a remote mailbox or Erlang process. This method removes a link created with ErlLink Links are idempotent; calling this method once will remove all links between this mailbox and the remote ErlPid

Extension Methods

	Name	Description
	AsBool	(Defined by ObjectValueConversion.)
	AsByte	(Defined by ObjectValueConversion.)
	AsChar	(Defined by ObjectValueConversion.)
	AsDateTime	Overloaded. (Defined by ObjectValueConversion.)
	AsDateTime(DateTime, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsDecimal	(Defined by ObjectValueConversion.)
	AsDouble	(Defined by ObjectValueConversion.)
	AsEnum TEnum	(Defined by ObjectValueConversion.)
	AsFloat	(Defined by ObjectValueConversion.)
	AsGDID	Overloaded. (Defined by ObjectValueConversion.)
	AsGDID(GDID, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsGDIDSymbol	Overloaded. (Defined by ObjectValueConversion.)
	AsGDIDSymbol(GDIDSymbol, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsGUID	(Defined by ObjectValueConversion.)
	AsInt	(Defined by ObjectValueConversion.)
	AsJSONConfig	(Defined by ObjectValueConversion.)
	AsLaconicConfig	(Defined by ObjectValueConversion.)
	AsLong	(Defined by ObjectValueConversion.)
	AsNonNullOrEmptyString	(Defined by ObjectValueConversion.)
	AsNullableBool	(Defined by ObjectValueConversion.)
	AsNullableByte	(Defined by ObjectValueConversion.)
	AsNullableChar	(Defined by ObjectValueConversion.)
	AsNullableDateTime	(Defined by ObjectValueConversion.)
	AsNullableDecimal	(Defined by ObjectValueConversion.)
	AsNullableDouble	(Defined by ObjectValueConversion.)
	AsNullableEnum TEnum	(Defined by ObjectValueConversion.)
	AsNullableFloat	(Defined by ObjectValueConversion.)
	AsNullableGDID	(Defined by ObjectValueConversion.)
	AsNullableGDIDSymbol	(Defined by ObjectValueConversion.)
	AsNullableGUID	(Defined by ObjectValueConversion.)
	AsNullableInt	(Defined by ObjectValueConversion.)
	AsNullableLong	(Defined by ObjectValueConversion.)
	AsNullableSByte	(Defined by ObjectValueConversion.)
	AsNullableShort	(Defined by ObjectValueConversion.)
	AsNullableTimeSpan	(Defined by ObjectValueConversion.)
	AsNullableUInt	(Defined by ObjectValueConversion.)
	AsNullableULong	(Defined by ObjectValueConversion.)
	AsNullableUShort	(Defined by ObjectValueConversion.)
	AsSByte	(Defined by ObjectValueConversion.)
	AsShort	(Defined by ObjectValueConversion.)
	AsString	(Defined by ObjectValueConversion.)
	AsTimeSpan	Overloaded. (Defined by ObjectValueConversion.)
	AsTimeSpan(TimeSpan, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsUInt	(Defined by ObjectValueConversion.)
	AsULong	(Defined by ObjectValueConversion.)
	AsUri	(Defined by ObjectValueConversion.)
	AsUShort	(Defined by ObjectValueConversion.)
	AsXMLConfig	(Defined by ObjectValueConversion.)
	ToErlObject	Overloaded. Try to convert .NET native object type to corresponding Erlang term. Throw exception if conversion is not possible (Defined by ErlObject.)
	ToErlObject(ErlTypeOrder, Boolean)	Overloaded. Try to convert .NET native object type to corresponding Erlang term of given type. Throw exception if conversion is not possible (Defined by ErlObject.)
	ToJSON(JSONWritingOptions)	Overloaded. Serializes object into JSON string (Defined by JSONExtensions.)
	ToJSON(TextWriter, JSONWritingOptions)	Overloaded. Serializes object into JSON format using provided TextWriter (Defined by JSONExtensions.)
	ToJSON(Stream, JSONWritingOptions, Encoding)	Overloaded. Serializes object into JSON format using provided stream and optional encoding (Defined by JSONExtensions.)

Properties

	Name	Description
	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.)
	Empty	Return true if there are no messages waiting in the receive queue of this connection
	Handle	Queue not empty status notification handle
	LastUsed	Timestamps when this mailbox was last used - this is used internally by mailbox caching
	MsgCount	Return the number of messages currently waiting in the receive queue of this connection
	Name	Get the registered name of this mailbox, or string.Empty if the mailbox doesn't have a registered name
	Node
	QueueActive
	Self	Get the Pid identifying associated with this mailbox

Events

	Name	Description
	MailboxMessage	If this event is assigned, it will be called on arrival of a message, but the messages will not be put in the queue