MpxClientSocket MembersNFX Class Library

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

The MpxClientSocket type exposes the following members.
Constructors

  NameDescription
Protected methodMpxClientSocket
Initializes a new instance of the MpxClientSocket class
Back to Top
Methods

  NameDescription
Public methodAcceptManagerVisit
Override to perform maintenance i.e. trim excessive m_SendChunk size etc.. This method is called by Glue/Binding/Transport runtime. Also resets last last idle manager visit timestamp which is used for socket closing
(Inherited from MpxSocket TTransport .)
Protected methodDestructor (Inherited from MpxSocket TTransport .)
Public methodDispose
Deterministically disposes object. DO NOT OVERRIDE this method, override Destructor() instead
(Inherited from DisposableObject.)
Protected methodDoReleaseMemChunksAfterAsyncOperations
Do not call this method, override only when freeing more than 2 standard chunks (send/recv)
(Inherited from MpxSocket TTransport .)
Protected methodDoSend (Inherited from MpxSocket TTransport .)
Public methodEnsureObjectNotDisposed
Checks to see whether object dispose started or has already been disposed and throws an exception if Dispose() was called
(Inherited from DisposableObject.)
Public methodOnlineEquals
Determines whether the specified object is equal to the current object.
(Inherited from OnlineObject.)
Protected methodFinalize (Inherited from DisposableObject.)
Public methodOnlineGetHashCode
Serves as the default hash function.
(Inherited from OnlineObject.)
Public methodGetSendChunk
Reserves a chunk of memory of the suggested size for network send operation. The buffer must be released by a call to ReleaseSendBuffer(). Keep in mind that this method is NOT RE-ENTRANT by this or any other thread until corresponding ReleaseSendChunk() is called. MpxSocket is not thread safe for sends in general.
(Inherited from MpxSocket TTransport .)
Public methodOnlineGetType
Gets the OnlineType of the current instance.
(Inherited from OnlineObject.)
Protected methodInvokeReceive
Calls ReceiveAction callback guarding for possible unhandled receive action errors
(Inherited from MpxSocket TTransport .)
Protected methodOnlineMemberwiseClone
Creates a shallow copy of the current OnlineObject.
(Inherited from OnlineObject.)
Protected methodReleaseMemChunksAfterAsyncOperations
Releases socket memory chunks. This method MUST BE called AFTER all pending async IO is done, otherwise the chunks may get released to the pool and get corrupted by the prior operation
(Inherited from MpxSocket TTransport .)
Public methodReleaseSendChunk
Releases previously reserved buffer, i.e. may trim excess allocation after a large message
(Inherited from MpxSocket TTransport .)
Public methodSend
Adds the specified socket msg to the outgoing stack. This is a synchronous blocking call that executes until the data is written into socket stack (but not necessarily delivered). If send error occurs then socket is marked as !Active (Disposed)
(Inherited from MpxSocket TTransport .)
Public methodOnlineToString
Returns a string that represents the current object.
(Inherited from OnlineObject.)
Back to Top
Extension Methods

  NameDescription
Public Extension MethodAsBool (Defined by ObjectValueConversion.)
Public Extension MethodAsByte (Defined by ObjectValueConversion.)
Public Extension MethodAsChar (Defined by ObjectValueConversion.)
Public Extension MethodAsDateTime Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsDateTime(DateTime, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsDecimal (Defined by ObjectValueConversion.)
Public Extension MethodAsDouble (Defined by ObjectValueConversion.)
Public Extension MethodAsEnum TEnum  (Defined by ObjectValueConversion.)
Public Extension MethodAsFloat (Defined by ObjectValueConversion.)
Public Extension MethodAsGDID Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGDID(GDID, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGDIDSymbol Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGDIDSymbol(GDIDSymbol, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGUID (Defined by ObjectValueConversion.)
Public Extension MethodAsInt (Defined by ObjectValueConversion.)
Public Extension MethodAsJSONConfig (Defined by ObjectValueConversion.)
Public Extension MethodAsLaconicConfig (Defined by ObjectValueConversion.)
Public Extension MethodAsLong (Defined by ObjectValueConversion.)
Public Extension MethodAsNonNullOrEmptyString (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableBool (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableByte (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableChar (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableDateTime (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableDecimal (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableDouble (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableEnum TEnum  (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableFloat (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableGDID (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableGDIDSymbol (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableGUID (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableInt (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableLong (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableSByte (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableShort (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableTimeSpan (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableUInt (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableULong (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableUShort (Defined by ObjectValueConversion.)
Public Extension MethodAsSByte (Defined by ObjectValueConversion.)
Public Extension MethodAsShort (Defined by ObjectValueConversion.)
Public Extension MethodAsString (Defined by ObjectValueConversion.)
Public Extension MethodAsTimeSpan Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsTimeSpan(TimeSpan, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsUInt (Defined by ObjectValueConversion.)
Public Extension MethodAsULong (Defined by ObjectValueConversion.)
Public Extension MethodAsUri (Defined by ObjectValueConversion.)
Public Extension MethodAsUShort (Defined by ObjectValueConversion.)
Public Extension MethodAsXMLConfig (Defined by ObjectValueConversion.)
Public Extension MethodToErlObject Overloaded.
Try to convert .NET native object type to corresponding Erlang term. Throw exception if conversion is not possible
(Defined by ErlObject.)
Public Extension MethodToErlObject(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.)
Public Extension MethodToJSON(JSONWritingOptions)Overloaded.
Serializes object into JSON string
(Defined by JSONExtensions.)
Public Extension MethodToJSON(TextWriter, JSONWritingOptions)Overloaded.
Serializes object into JSON format using provided TextWriter
(Defined by JSONExtensions.)
Public Extension MethodToJSON(Stream, JSONWritingOptions, Encoding)Overloaded.
Serializes object into JSON format using provided stream and optional encoding
(Defined by JSONExtensions.)
Back to Top
Fields

  NameDescription
Protected fieldm_ClientSite (Inherited from MpxSocket TTransport .)
Protected fieldm_Disposing (Inherited from MpxSocket TTransport .)
Protected fieldm_EndPoint (Inherited from MpxSocket TTransport .)
Protected fieldm_LastIdleManagerVisit (Inherited from MpxSocket TTransport .)
Protected fieldm_ReceiveChunk (Inherited from MpxSocket TTransport .)
Protected fieldm_SendChunk (Inherited from MpxSocket TTransport .)
Protected fieldm_Socket (Inherited from MpxSocket TTransport .)
Protected fieldm_Transport (Inherited from MpxSocket TTransport .)
Back to Top
Properties

  NameDescription
Public propertyActive
True when socket is not disposing and runtime is not shutting down
(Inherited from MpxSocket TTransport .)
Public propertyClientSite
Returns client site for the computer that initiated the call. Server socket returns the transmitted value from client. Client socket returns the one that was sent to server upon handshake
(Inherited from MpxSocket TTransport .)
Public propertyDisposed
Indicates whether this object was already disposed - the Dispose() has finished
(Inherited from DisposableObject.)
Public propertyDisposeStarted
Indicates whether this object Dispose() has been called and dispose started but not finished yet
(Inherited from DisposableObject.)
Public propertyEndPoint
Returns IP End point that this socket services, remote server for client socket and remote client for server sockets
(Inherited from MpxSocket TTransport .)
Public propertyLastIdleManagerVisit
Returns timestamp of last manager visit since then no traffic came through. Null indicates that traffic came though and socket has not been idle since last visit. Manager is an extrenal visitor that closes idle sockets
(Inherited from MpxSocket TTransport .)
Public propertySocket
Returns the underlying socket
(Inherited from MpxSocket TTransport .)
Public propertyTransport
Returns transport that this socket is under
(Inherited from MpxSocket TTransport .)
Back to Top
See Also