Click or drag to resize

ClientT Class

A client connection.
Inheritance Hierarchy
SystemObject
  Demo3D.NetProtocolSocket
    Demo3D.NetConnection
      Demo3D.NetClientT

Namespace:  Demo3D.Net
Assembly:  Demo3D.IO (in Demo3D.IO.dll) Version: 11.0.0.7658
Syntax
C#
public sealed class Client<T> : Connection
where T : class

Type Parameters

T
Required IO services.

The ClientT type exposes the following members.

Properties
  NameDescription
Public propertyAddress
The address used to create this socket.
(Inherited from ProtocolSocket.)
Public propertyDownStream
The downstream socket.
(Inherited from ProtocolSocket.)
Public propertyEditing
True if batch editing.
(Inherited from ProtocolSocket.)
Public propertyID
A description of this socket.
(Inherited from ProtocolSocket.)
Public propertyIO
The IO services provided by the protocol.
Public propertyLogShutdownMessages
Controls whether shutdown messages should be logged to the message log.
(Inherited from Connection.)
Public propertyCode exampleProperties
Protocol and service properties.
(Inherited from ProtocolSocket.)
Public propertyRunning
Returns whether the socket is still running.
(Inherited from Connection.)
Public propertyShutdownInfo
Returns information logged when the socket was last shutdown, or null if the socket is open or was closed normally.
(Inherited from Connection.)
Top
Methods
  NameDescription
Public methodAddAspect
Adds an aspect to a socket.
(Inherited from ProtocolSocket.)
Public methodAddOrUpdateAspect
Adds or updates an aspect of the socket.
(Inherited from ProtocolSocket.)
Public methodBeginEdit
Start batch editing.
(Inherited from ProtocolSocket.)
Public methodClose
Closes the socket.
(Inherited from Connection.)
Public methodClose(Exception)
Logs an error, and then closes the socket.
(Inherited from ProtocolSocket.)
Public methodClose(String)
Logs an error, and then closes the socket.
(Inherited from ProtocolSocket.)
Public methodClose(String, String, Object)
Logs an error, and then closes the socket.
(Inherited from ProtocolSocket.)
Public methodEndEdit
End batch editing.
(Inherited from ProtocolSocket.)
Public methodFindAspect(Type)
Returns an aspect of the given type, or return null.
(Inherited from ProtocolSocket.)
Public methodFindAspectT
Returns an aspect of the given type, or return null.
(Inherited from ProtocolSocket.)
Public methodFindService(Type, ServiceBindingFlags)
Returns an object that implements a specific API, or null. For example, an IO API such as IPacketIOService.
(Inherited from ProtocolSocket.)
Public methodFindServiceT(ServiceBindingFlags)
Returns an object that implements a specific API, or null. For example, an IO API such as IPacketIOService.
(Inherited from ProtocolSocket.)
Public methodGetHead
Returns the protocol head.
(Inherited from Connection.)
Public methodGetOrAddAspect
Adds an aspect to a socket by using the specified function, if the key does not already exist.
(Inherited from ProtocolSocket.)
Public methodGetServiceT
Returns an object that implements a specific API, or throws an exception. For example, an IO API such as IPacketIOService.
(Inherited from ProtocolSocket.)
Public methodGetStream
Returns the head of the protocol stream (the first protocol instance).
(Inherited from ProtocolSocket.)
Public methodLink
Adds a 'link' reference.
(Inherited from Connection.)
Public methodCode exampleOpen
Opens (or reopens) the socket.
(Inherited from ProtocolSocket.)
Public methodStatic memberOpen(ClientParams)
Opens a client connection.
Public methodStatic memberCode exampleOpen(ProtocolAddress, NotifyDataChangedEventHandler)
Opens a client connection, calling dataChangedHandler for each message received.
Public methodStatic memberCode exampleOpen(ProtocolAddress, NotifyDataChangedEventHandler, CallbackContext)
Opens a client connection, calling dataChangedHandler for each message received.
Public methodStatic memberCode exampleOpen(ProtocolAddress, Boolean, ConnectionFlags, ConnectionSharing)
Opens a client connection.
Public methodOpenAsync
Opens the socket.
(Inherited from Connection.)
Public methodStatic memberOpenAsync(ClientParams)
Opens a client connection.
Public methodStatic memberCode exampleOpenAsync(ProtocolAddress, NotifyDataChangedEventHandler)
Opens a client connection, calling dataChangedHandler for each message received.
Public methodStatic memberCode exampleOpenAsync(ProtocolAddress, NotifyDataChangedEventHandler, CallbackContext)
Opens a client connection, calling dataChangedHandler for each message received.
Public methodStatic memberCode exampleOpenAsync(ProtocolAddress, Boolean, ConnectionFlags, ConnectionSharing)
Opens a client connection.
Public methodRegisterClosing
Registers a function to call when Close has been called but before the socket has been closed.
(Inherited from ProtocolSocket.)
Public methodRegisterOpen
Registers a function to call after the socket is opened, but before the OnOpened event is fired.
(Inherited from ProtocolSocket.)
Public methodRemoveAspect
Removes an aspect from a socket.
(Inherited from ProtocolSocket.)
Public methodSetDownStream
Sets the downstream socket.
(Inherited from ProtocolSocket.)
Public methodShutdown
Forcibly shuts down the socket.
(Inherited from Connection.)
Public methodShutdown(Exception)
Logs an error, and then shuts down the socket.
(Inherited from ProtocolSocket.)
Public methodShutdown(String)
Logs an error, and then shuts down the socket.
(Inherited from ProtocolSocket.)
Public methodShutdown(String, String, Object)
Logs an error, and shuts down the socket.
(Inherited from Connection.)
Public methodToString
Returns a description of this socket.
(Inherited from ProtocolSocket.)
Public methodTryFindServiceT
Searches for an object that implements a specific API, or null. Only searches on this ProtocolInstance, and does not create the service if it hasn't already been created.
(Inherited from ProtocolSocket.)
Public methodUnlink
Remove a 'link' reference count.
(Inherited from Connection.)
Public methodUnregisterClosing
Unregister a previously registered function.
(Inherited from ProtocolSocket.)
Public methodUnregisterOpen
Unregister a previously registered function.
(Inherited from ProtocolSocket.)
Top
Events
  NameDescription
Public eventEditBegun
Raised on the first call to BeginEdit.
(Inherited from ProtocolSocket.)
Public eventEditEnded
Raised on the last call to EndEdit.
(Inherited from ProtocolSocket.)
Public eventOnClosed
Occurs after the socket is closed.
(Inherited from ProtocolSocket.)
Public eventOnLinked
Occurs when a link is made to this socket.
(Inherited from Connection.)
Public eventOnOpened
Occurs after the socket is opened.
(Inherited from ProtocolSocket.)
Public eventOnShutdown
Occurs after the socket is shutdown.
(Inherited from ProtocolSocket.)
Public eventOnUnlinked
Occurs when a link is removed from this socket.
(Inherited from Connection.)
Public eventPropertyChanged
Occurs when a property value changes.
(Inherited from ProtocolSocket.)
Top
See Also