C# Class Opc.Ua.Com.Server.ComProxy

A base class for classes that implement an OPC COM specification.

Inheritance: IDisposable

Mostrar archivo Open project: OPCFoundation/UA-.NETStandardLibrary

Public Methods

Method	Description
ComProxy ( ) : System	Initializes a new instance of the ComProxy class.
Dispose ( ) : void	Frees any unmanaged resources.
GetAvailableLocaleIds ( ) : int[]	Returns the available locales.
GetLocaleId ( ) : int	Gets the current locale.
Load ( System.Guid clsid, ApplicationConfiguration configuration ) : void	Called when the object is loaded by the COM process.
SetLocaleId ( int localeId ) : void	Sets the current locale.
Unload ( ) : void	Unloads this instance.

Protected Methods

Method	Description
Dispose ( bool disposing ) : void	An overrideable version of the Dispose.
LoadConfiguredEndpoint ( System.Guid clsid ) : ConfiguredEndpoint	Reads the UA endpoint information associated the CLSID
OnReconnectInProgress ( int secondsToReconnect ) : void	Called when a session reconnect is scheduled.
OnSessionCreated ( ) : void	Called when a new session is created.
OnSessionReconected ( ) : void	Called when a session is reconnected.
OnSessionRemoved ( ) : void	Called when a session is removed.
SaveConfiguration ( ) : void	Saves the current endpoint configuration.
SaveConfiguredEndpoint ( System.Guid clsid, ConfiguredEndpoint endpoint ) : void	Saves the UA endpoint information associated the CLSID.
ThrowIfNotConnected ( ) : Session	Throws if disposed or not connected.

Private Methods

Method	Description
Connect ( System.Guid clsid ) : Task	Connects to the UA server identfied by the CLSID.
OnCreateSession ( object state ) : void	Creates a session with the server.
OnReconnectSession ( object state ) : void	Creates a session with the server.
Session_KeepAlive ( Session session, KeepAliveEventArgs e ) : void	The session the keep alive handler.

Method Details

ComProxy() public method

Initializes a new instance of the ComProxy class.

public ComProxy ( ) : System
return	System

Dispose() public method

Frees any unmanaged resources.

public Dispose ( ) : void
return	void

Dispose() protected method

An overrideable version of the Dispose.

protected Dispose ( bool disposing ) : void
disposing	bool
return	void

GetAvailableLocaleIds() public method

Returns the available locales.

public GetAvailableLocaleIds ( ) : int[]
return	int[]

GetLocaleId() public method

Gets the current locale.

public GetLocaleId ( ) : int
return	int

Load() public method

Called when the object is loaded by the COM process.

public Load ( System.Guid clsid, ApplicationConfiguration configuration ) : void
clsid	System.Guid	The CLSID used to activate the server.
configuration	ApplicationConfiguration	The application configuration for the COM process.
return	void

LoadConfiguredEndpoint() protected method

Reads the UA endpoint information associated the CLSID

protected LoadConfiguredEndpoint ( System.Guid clsid ) : ConfiguredEndpoint
clsid	System.Guid	The CLSID used to activate the COM server.
return	ConfiguredEndpoint

OnReconnectInProgress() protected method

Called when a session reconnect is scheduled.

protected OnReconnectInProgress ( int secondsToReconnect ) : void
secondsToReconnect	int
return	void

OnSessionCreated() protected method

Called when a new session is created.

protected OnSessionCreated ( ) : void
return	void

OnSessionReconected() protected method

Called when a session is reconnected.

protected OnSessionReconected ( ) : void
return	void

OnSessionRemoved() protected method

Called when a session is removed.

protected OnSessionRemoved ( ) : void
return	void

SaveConfiguration() protected method

Saves the current endpoint configuration.

protected SaveConfiguration ( ) : void
return	void

SaveConfiguredEndpoint() protected method

Saves the UA endpoint information associated the CLSID.

protected SaveConfiguredEndpoint ( System.Guid clsid, ConfiguredEndpoint endpoint ) : void
clsid	System.Guid	The CLSID used to activate the COM server.
endpoint	ConfiguredEndpoint	The endpoint.
return	void

SetLocaleId() public method

Sets the current locale.

public SetLocaleId ( int localeId ) : void
localeId	int
return	void

ThrowIfNotConnected() protected method

Throws if disposed or not connected.

protected ThrowIfNotConnected ( ) : Session
return	Opc.Ua.Client.Session

Unload() public method

Unloads this instance.

public Unload ( ) : void
return	void