Click or drag to resize

BuiltinMemoryProtocolBuitinConnection Class

An instance of one connection to the Built-in Memory Server.
Inheritance Hierarchy

Namespace:  Demo3D.PLC.Comms.Builtin
Assembly:  PLC (in PLC.dll) Version: 15.0.2.11458
Syntax
C#
public class BuitinConnection : ProtocolInstance, 
	ISymbolTable, IDirectMemoryAccessService

The BuiltinMemoryProtocolBuitinConnection type exposes the following members.

Properties
  NameDescription
Public propertyAddress
The protocol address used by this instance.
(Inherited from ProtocolInstance.)
Public propertyDownStream
The downstream socket.
(Inherited from ProtocolSocket.)
Public propertyID
A description of this instance.
(Inherited from ProtocolInstance.)
Protected propertyInternalRunning
Returns true if the connection has been established.
(Overrides ProtocolInstanceInternalRunning.)
Public propertyLog
Log messages.
(Inherited from ProtocolSocket.)
Public propertyProperties
Protocol and service properties.
(Inherited from ProtocolInstance.)
Public propertyProtocol
The protocol.
(Inherited from ProtocolInstance.)
Public propertyProtocolProperties
Protocol property bag.
(Inherited from ProtocolInstance.)
Public propertyRunning
Returns whether the instance is still running.
(Inherited from ProtocolInstance.)
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 methodBeginEditAsync
Start batch editing.
(Inherited from ProtocolSocket.)
Public methodClose
Closes the socket.
(Inherited from ProtocolInstance.)
Public methodEndEditAsync
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, String)
Returns an object that implements a specific API, or null. For example, an IO API such as IPacketIOService.
(Inherited from ProtocolInstance.)
Public methodFindServiceT(ServiceBindingFlags, String)
Returns an object that implements a specific API, or null. For example, an IO API such as IPacketIOService.
(Inherited from ProtocolSocket.)
Protected methodGetDownStream
Returns the downstream socket.
(Inherited from ProtocolSocket.)
Public methodGetHead
Returns the protocol head.
(Inherited from ProtocolInstance.)
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.)
Protected methodInitializeAsync
When overridden in a derived class, initializes the socket.
(Inherited from ProtocolSocket.)
Protected methodInternalClose
Disconnects from the server.
(Overrides ProtocolInstanceInternalClose.)
Protected methodInternalOpenAsync
Connects to the server.
(Overrides ProtocolInstanceInternalOpenAsync(Boolean, Flags).)
Protected methodInternalShutdown
Forcibly shuts down the underlying protocol, causing all other users to throw an error.
(Inherited from ProtocolInstance.)
Protected methodNotifyEditBegunAsync
Notify EditBegunAsync raised.
(Inherited from ProtocolInstance.)
Protected methodNotifyEditEndedAsync
Notify EditEndedAsync raised.
(Inherited from ProtocolInstance.)
Protected methodNotifyPropertyChanged(PropertyChangedEventArgs)
Raises the PropertyChanged event.
(Inherited from ProtocolSocket.)
Protected methodNotifyPropertyChanged(String)
Raises the PropertyChanged event.
(Inherited from ProtocolSocket.)
Protected methodOpenAsync
Opens (or reopens) the socket.
(Inherited from ProtocolInstance.)
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 OnOpenedAsync 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 ProtocolInstance.)
Public methodSetLog
Sets the current log.
(Inherited from ProtocolSocket.)
Public methodShutdown
Forcibly shuts down the socket, without logging an error.
(Inherited from ProtocolSocket.)
Public methodShutdown(Exception)
Forcibly shuts down the socket, and then logs an error.
(Inherited from ProtocolSocket.)
Public methodShutdown(String)
Forcibly shuts down the socket, and then logs an error.
(Inherited from ProtocolSocket.)
Public methodShutdown(LogMessageLogLevel, String, Object)
Forcibly shuts down the socket, and then logs an error.
(Inherited from ProtocolSocket.)
Public methodToString
Returns a description of this socket.
(Inherited from ProtocolInstance.)
Protected methodTryCreateService
Returns an object that implements a specific API, or null. For example, an IO API such as IPacketIOService.
(Inherited from ProtocolInstance.)
Public methodUnregisterClosing
Unregister a previously registered function.
(Inherited from ProtocolSocket.)
Public methodUnregisterOpen
Unregister a previously registered function.
(Inherited from ProtocolSocket.)
Top
Events
  NameDescription
Public eventEditBegunAsync
Raised on the first call to BeginEdit.
(Inherited from ProtocolSocket.)
Public eventEditEndedAsync
Raised on the last call to EndEdit.
(Inherited from ProtocolSocket.)
Public eventOnClosed
Occurs after the socket is closed.
(Inherited from ProtocolSocket.)
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).
(Inherited from ProtocolSocket.)
Public eventOnOpenedAsync
Occurs after the socket is opened.
(Inherited from ProtocolSocket.)
Public eventOnShutdown
Occurs after the socket is shutdown.
(Inherited from ProtocolSocket.)
Public eventPropertyChanged
Occurs when a property value changes.
(Inherited from ProtocolSocket.)
Top
Fields
  NameDescription
Protected fieldserver
The example server.
Top
Extension Methods
  NameDescription
Public Extension MethodReadV
Vectored read request.
(Defined by DirectMemoryAccessService.)
Public Extension MethodWriteV
Vectored write request.
(Defined by DirectMemoryAccessService.)
Top
See Also