Builtin |
An instance of one connection to the Built-in Memory Server.
Inheritance HierarchySystemObject
Demo3D.NetProtocolSocket
Demo3D.NetProtocolInstance
Demo3D.PLC.Comms.BuiltinBuiltinMemoryProtocolBuitinConnection
Demo3D.PLC.Comms.BuiltinBuiltinNotifyMemoryProtocolBuitinConnection
Demo3D.NetProtocolSocket
Demo3D.NetProtocolInstance
Demo3D.PLC.Comms.BuiltinBuiltinMemoryProtocolBuitinConnection
Demo3D.PLC.Comms.BuiltinBuiltinNotifyMemoryProtocolBuitinConnection
Namespace: Demo3D.PLC.Comms.Builtin
Assembly: PLC (in PLC.dll) Version: 19.01.00
SyntaxC#
public class BuitinConnection : ProtocolInstance, ISymbolTable, IDirectMemoryAccessService
The BuiltinMemoryProtocolBuitinConnection type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Address |
The protocol address used by this instance.
(Inherited from ProtocolInstance) |
| DownStream |
The downstream socket.
(Inherited from ProtocolSocket) |
| ID |
A description of this instance.
(Inherited from ProtocolInstance) |
 | InternalRunning |
Returns true if the connection has been established.
(Overrides ProtocolInstanceInternalRunning) |
| Log |
Log messages.
(Inherited from ProtocolSocket) |
| Protocol |
The protocol.
(Inherited from ProtocolInstance) |
| ProtocolProperties |
Protocol property bag.
(Inherited from ProtocolInstance) |
| Running |
Returns whether the instance is still running.
(Inherited from ProtocolInstance) |
Methods| Name | Description | |
|---|---|---|
 | AddAspect |
Adds an aspect to a socket.
(Inherited from ProtocolSocket) |
| AddOrUpdateAspect |
Adds or updates an aspect of the socket.
(Inherited from ProtocolSocket) |
| CloseAsync |
Closes the socket.
(Inherited from ProtocolInstance) |
| FindAspect(Type) |
Returns an aspect of the given type, or return null.
(Inherited from ProtocolSocket) |
| FindAspectT |
Returns an aspect of the given type, or return null.
(Inherited from ProtocolSocket) |
| FindService(Type, ServiceBindingFlags, String) |
Returns an object that implements a specific API, or null.
For example, an IO API such as IPacketIOService.
(Inherited from ProtocolInstance) |
| FindServiceT(ServiceBindingFlags, String) |
Returns an object that implements a specific API, or null.
For example, an IO API such as IPacketIOService.
(Inherited from ProtocolSocket) |
 | GetDownStream |
Returns the downstream socket.
(Inherited from ProtocolSocket) |
| GetHead |
Returns the protocol head.
(Inherited from ProtocolInstance) |
| GetOrAddAspect |
Adds an aspect to a socket by using the specified function, if the key does not already exist.
(Inherited from ProtocolSocket) |
| GetServiceT |
Returns an object that implements a specific API, or throws an exception.
For example, an IO API such as IPacketIOService.
(Inherited from ProtocolSocket) |
| GetStream |
Returns the head of the protocol stream (the first protocol instance).
(Inherited from ProtocolSocket) |
| InitializeAsync |
When overridden in a derived class, initializes the socket.
(Inherited from ProtocolSocket) |
| InternalBeforeOpenAsync |
Called before opening the instance.
(Inherited from ProtocolInstance) |
| InternalCloseAsync |
Disconnects from the server.
(Overrides ProtocolInstanceInternalCloseAsync(Boolean)) |
| InternalOpenAsync |
Connects to the server.
(Overrides ProtocolInstanceInternalOpenAsync(Boolean, Flags)) |
| InternalShutdownAsync |
Forcibly shuts down the underlying protocol, causing all other users to throw an error.
(Inherited from ProtocolInstance) |
| NotifyPropertyChanged(PropertyChangedEventArgs) |
Raises the PropertyChanged event.
(Inherited from ProtocolSocket) |
| NotifyPropertyChanged(String) |
Raises the PropertyChanged event.
(Inherited from ProtocolSocket) |
| OpenAsync |
Opens (or reopens) the socket.
(Inherited from ProtocolInstance) |
| RegisterClosing |
Registers a function to call when Close has been called but before the socket has been closed.
(Inherited from ProtocolSocket) |
| RegisterOpen |
Registers a function to call after the socket is opened, but before the OnOpenedAsync event is fired.
(Inherited from ProtocolSocket) |
| RemoveAspect |
Removes an aspect from a socket.
(Inherited from ProtocolSocket) |
| SetDownStream |
Sets the downstream socket.
(Inherited from ProtocolInstance) |
| SetLog |
Sets the current log.
(Inherited from ProtocolSocket) |
| Shutdown(Boolean) |
Forcibly shuts down the socket, without logging an error.
(Inherited from ProtocolSocket) |
| Shutdown(Exception) |
Forcibly shuts down the socket, and then logs an error.
(Inherited from ProtocolSocket) |
| Shutdown(String, Boolean) |
Forcibly shuts down the socket, and then logs an error.
(Inherited from ProtocolSocket) |
| Shutdown(LogMessageLogLevel, String, Object) |
Forcibly shuts down the socket, and then logs an error.
(Inherited from ProtocolSocket) |
| ShutdownAsync(Boolean, Boolean) |
Forcibly shuts down the socket, without logging an error.
(Inherited from ProtocolSocket) |
| ShutdownAsync(Boolean, Exception) |
Forcibly shuts down the socket, and then logs an error.
(Inherited from ProtocolSocket) |
| ShutdownAsync(Boolean, String, Boolean) |
Forcibly shuts down the socket, and then logs an error.
(Inherited from ProtocolSocket) |
| ShutdownAsync(Boolean, LogMessageLogLevel, String, Object) |
Forcibly shuts down the socket, and then logs an error.
(Inherited from ProtocolSocket) |
| ToString |
Returns a description of this socket.
(Inherited from ProtocolInstance) |
| TryCreateService |
Returns an object that implements a specific API, or null.
For example, an IO API such as IPacketIOService.
(Inherited from ProtocolInstance) |
| UnregisterClosing |
Unregister a previously registered function.
(Inherited from ProtocolSocket) |
| UnregisterOpen |
Unregister a previously registered function.
(Inherited from ProtocolSocket) |
Events| Name | Description | |
|---|---|---|
 | OnClosedAsync |
Occurs after the socket is closed.
(Inherited from ProtocolSocket) |
| OnDisposed |
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).
(Inherited from ProtocolSocket) |
| OnOpenedAsync |
Occurs after the socket is opened.
(Inherited from ProtocolSocket) |
| OnShutdownAsync |
Occurs after the socket is shutdown.
(Inherited from ProtocolSocket) |
| PropertyChanged |
Occurs when a property value changes.
(Inherited from ProtocolSocket) |
Fields
Extension Methods| Name | Description | |
|---|---|---|
 | ReadV |
Vectored read request.
(Defined by DirectMemoryAccessService) |
| WriteV |
Vectored write request.
(Defined by DirectMemoryAccessService) |
See Also