IFactory Interface Reference

The factory interface. More...

Public Member Functions
IClient	CreateClient (string remote)
	Creates the client for accessing data of the Datalayer. More...
IClient	CreateIpcClient ()
	Creates the client with Inter-Process communication protocol (IPC) for accessing data of the Datalayer. <note type="caution"> IPC works only if process runs on same device as Datalayer broker. </note> More...
IProvider	CreateIpcProvider ()
	Creates the provider with Inter-Process communication protocol (IPC) for accessing data of the Datalayer. <note type="caution"> IPC works only if process runs on same device as datalayer broker. </note> More...
IProvider	CreateProvider (string remote)
	Creates the provider which provides data to the Datalayer. More...
IClient	CreateTcpClient (IPAddress ipAddress, int port, string username, string password)
	Creates the client with TCP protocol for accessing data of the Datalayer. More...
IProvider	CreateTcpProvider (IPAddress ipAddress, int port, string username, string password)
	Creates the provider with TCP protocol for accessing data of the Datalayer. More...

Detailed Description

The factory interface.

Definition at line 8 of file IFactory.cs.

Member Function Documentation

CreateClient()

IClient CreateClient

(

string

remote

)

Creates the client for accessing data of the Datalayer.

Parameters

remote

Remote address of the data layer

Returns

The created Client

CreateIpcClient()

IClient CreateIpcClient

(

)

Creates the client with Inter-Process communication protocol (IPC) for accessing data of the Datalayer. <note type="caution"> IPC works only if process runs on same device as Datalayer broker. </note>

Returns

The created Client

CreateIpcProvider()

IProvider CreateIpcProvider

(

)

Creates the provider with Inter-Process communication protocol (IPC) for accessing data of the Datalayer. <note type="caution"> IPC works only if process runs on same device as datalayer broker. </note>

Returns

The created Provider

CreateProvider()

IProvider CreateProvider

(

string

remote

)

Creates the provider which provides data to the Datalayer.

Parameters

remote

Remote address of the data layer

Returns

The created Provider

CreateTcpClient()

IClient CreateTcpClient	(	IPAddress	ipAddress,
		int	port,
		string	username,
		string	password
	)

Creates the client with TCP protocol for accessing data of the Datalayer.

Parameters

ipAddress	IP address of the ctrlX device, e.g. 127.0.0.1
port	Port for client TCP communication, default: 2069
username	Username for authentication
password	Password for authentication

Returns

The created Client

Example

using var system = new DatalayerSystem();  
using var client = system.Factory.CreateTcpClient(IPAddress.Loopback,
                   DatalayerSystem.DefaultClientPort,  
                   "username",
                   "password");

CreateTcpProvider()

IProvider CreateTcpProvider	(	IPAddress	ipAddress,
		int	port,
		string	username,
		string	password
	)

Creates the provider with TCP protocol for accessing data of the Datalayer.

Parameters

ipAddress	IP address of the ctrlX device, e.g. 127.0.0.1
port	Port for client TCP communication, default: 2070
username	Username for authentication
password	Password for authentication

Returns

The created Provider

Example

using var system = new DatalayerSystem();  
using var provider = system.Factory.CreateTcpProvider(IPAddress.Loopback,
                  DatalayerSystem.DefaultProviderPort, 
                   "username",
                   "password");

---

The documentation for this interface was generated from the following file:

• D:/Jenkins/workspace/sdk.datalayer.csharp/datalayer/IFactory.cs