System Class Reference

Public Member Functions
def	__init__ (self, str ipc_path)
def	__enter__ (self)
def	__exit__ (self, exc_type, exc_val, exc_tb)
def	close (self)
Factory	factory (self)
def	get_handle (self)
Converter	json_converter (self)
def	set_bfbs_path (self, path)
def	start (self, bool bo_start_broker)
bool	stop (self, bool bo_force_provider_stop)

Detailed Description

Datalayer System Instance.

Hint see python context manager for instance handling

Definition at line 15 of file system.py.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
		str	ipc_path
	)

Creates a datalayer system.

Parameters

[in]

ipc_path

Path for interprocess communication - use null pointer for automatic detection

Definition at line 22 of file system.py.

References Client.__closed, Provider.__closed, ProviderNode.__closed, SubscriptionAsync.__closed, SubscriptionSync.__closed, System.__closed, Variant.__closed, and System.__system.

Member Function Documentation

factory()

Factory factory

(

self

)

Returns the factory to create clients and provider for the datalayer.

Returns

<Factory>

Definition at line 77 of file system.py.

References System.__system.

json_converter()

Converter json_converter

(

self

)

Returns converter between JSON and Variant.

Returns

<Converter>

Definition at line 86 of file system.py.

References System.__system.

set_bfbs_path()

def set_bfbs_path	(		self,
			path
	)

Sets the base path to bfbs files.

Parameters

[in]

path

Base path to bfbs files

Definition at line 95 of file system.py.

References System.__system.

start()

def start	(		self,
		bool	bo_start_broker
	)

Starts a datalayer system.

Parameters

[in]

bo_start_broker

Use true to start a broker. If you are a user of the datalayer - call with false!

Definition at line 60 of file system.py.

References System.__system.

stop()

bool stop	(		self,
		bool	bo_force_provider_stop
	)

Stops a datalayer system.

Parameters

[in]

bo_force_provider_stop

Force stop off all created providers for this datalayer system

Returns

<bool> false if there is a client or provider active

Definition at line 69 of file system.py.

References System.__system.

Referenced by System.close().