Click or drag to resize

ProtocolSocket Class

A connection to a peer (either a client or a server connection), or a protocol server.
Inheritance Hierarchy

Namespace: Demo3D.Net
Assembly: Demo3D.IO (in Demo3D.IO.dll) Version: 19.00.00
Syntax
C#
Copy
[TypeConverterAttribute(typeof(ExpandableObjectConverter))]
public abstract class ProtocolSocket : IServiceProvider, 
	INotifyPropertyChanged

The ProtocolSocket type exposes the following members.

Constructors
 NameDescription
Protected methodProtocolSocketInitializes a new instance of the ProtocolSocket class
Top
Properties
 NameDescription
Public propertyAddress The address used to create this socket.
Public propertyDownStream The downstream socket.
Public propertyID A description of this socket.
Public propertyLog Log messages.
Public propertyCode exampleProperties Protocol and service properties.
Public propertyRunning Returns whether the socket is still running.
Top
Methods
 NameDescription
Public methodAddAspect Adds an aspect to a socket.
Public methodAddOrUpdateAspect Adds or updates an aspect of the socket.
Public methodFindAspect(Type) Returns an aspect of the given type, or return null.
Public methodFindAspectT Returns an aspect of the given type, or return null.
Public methodFindService(Type, ServiceBindingFlags, String) Returns an object that implements a specific API, or null. For example, an IO API such as IPacketIOService.
Public methodFindServiceT(ServiceBindingFlags, String) Returns an object that implements a specific API, or null. For example, an IO API such as IPacketIOService.
Protected methodGetDownStream Returns the downstream socket.
Public methodGetHead Returns the protocol head.
Public methodGetOrAddAspect Adds an aspect to a socket by using the specified function, if the key does not already exist.
Public methodGetServiceT Returns an object that implements a specific API, or throws an exception. For example, an IO API such as IPacketIOService.
Public methodGetStream Returns the head of the protocol stream (the first protocol instance).
Protected methodInitializeAsync When overridden in a derived class, initializes the socket.
Protected methodNotifyPropertyChanged(PropertyChangedEventArgs) Raises the PropertyChanged event.
Protected methodNotifyPropertyChanged(String) Raises the PropertyChanged event.
Protected methodOpenAsync Opens (or reopens) the socket.
Public methodRegisterClosing Registers a function to call when Close has been called but before the socket has been closed.
Public methodRegisterOpen Registers a function to call after the socket is opened, but before the OnOpenedAsync event is fired.
Public methodRemoveAspect Removes an aspect from a socket.
Public methodSetDownStream Sets the downstream socket.
Public methodSetLog Sets the current log.
Public methodShutdown(Boolean) Forcibly shuts down the socket, without logging an error.
Public methodShutdown(Exception) Forcibly shuts down the socket, and then logs an error.
Public methodShutdown(String, Boolean) Forcibly shuts down the socket, and then logs an error.
Public methodShutdown(LogMessageLogLevel, String, Object) Forcibly shuts down the socket, and then logs an error.
Public methodShutdownAsync(Boolean, Boolean) Forcibly shuts down the socket, without logging an error.
Public methodShutdownAsync(Boolean, Exception) Forcibly shuts down the socket, and then logs an error.
Public methodShutdownAsync(Boolean, String, Boolean) Forcibly shuts down the socket, and then logs an error.
Public methodShutdownAsync(Boolean, LogMessageLogLevel, String, Object) Forcibly shuts down the socket, and then logs an error.
Public methodToString Returns a description of this socket.
(Overrides ObjectToString)
Public methodUnregisterClosing Unregister a previously registered function.
Public methodUnregisterOpen Unregister a previously registered function.
Top
Events
 NameDescription
Public eventOnClosedAsync Occurs after the socket is closed.
Public eventOnDisposed Occurs when the socket is disposed. A socket is disposed when it's closed and uncached from the connection registry. User script may retain a reference, and may resurrect the socket by calling OpenAsync(Boolean, OpenFlags, Object).
Public eventOnOpenedAsync Occurs after the socket is opened.
Public eventOnShutdownAsync Occurs after the socket is shutdown.
Public eventPropertyChanged Occurs when a property value changes.
Top
See Also