xroad.node.Node Class Reference

class represents xroad node. More...

Inheritance diagram for xroad.node.Node:

Collaboration diagram for xroad.node.Node:

Public Member Functions
def	__init__ (self, name=None, cback=None, out_of_system=False)
	create Node object param[in] name - node name. More...
def	__del__ (self)
def	__enter__ (self)
def	__exit__ (self, exc_type, exc_val, _)
def	get_fun (self, name)
	get function from routing library (dll.c, etc) More...
def	catch_signal (self, signal)
	catch signal if any More...
def	free_signal (self, signal)
	free signal if any More...
def	receive (self)
	receive and dispatch message from link
def	system (self)
	get system More...
def	data (self)
	get node system slot More...
def	reconfigure (self)
	reconfigure node
def	config (self)
	get node Config More...
def	get_env_param (self, name, def_val=None)
	get variable from environment More...
def	working_dir (self)
	get node home directory
Any	create_object (self, obj_type)
	create new object More...
Any	get_object (self, obj_type, obj_id)
	return object from cache More...
def	create_cursor (self, obj_type, offset=0)
	create new cache cursor More...
def	clear_cache (self, obj_type, force=False)
	clear cache table
def	get_object_count (self, obj_type)
def	epoll_fd (self)
	return epoll file descriptor

Detailed Description

class represents xroad node.

User node classes should be derived from xroad.Node

Constructor & Destructor Documentation

__init__()

def xroad.node.Node.__init__	(		self,
			name = None,
			cback = None,
			out_of_system = False
	)

create Node object param[in] name - node name.

Must be corresponded to node configured in init.xml or None param[in] cback - events callback: "on_object" -> on_object(obj, node_id) - when object received "on_signal" -> on_signal(signal) - when signal received param[in] out_of_system - true if node is out of system (can not send/receive objects)

Reimplemented in xroad.process.Process.

Member Function Documentation

catch_signal()

def xroad.node.Node.catch_signal	(		self,
			signal
	)

catch signal if any

Parameters

[in]

signal

- signal to catch

config()

def xroad.node.Node.config

(

self

)

get node Config

Returns

See also

Config

create_cursor()

def xroad.node.Node.create_cursor	(		self,
			obj_type,
			offset = 0
	)

create new cache cursor

Parameters

[in]

type

- type of cursor

Returns

See also

NodeCursor

create_object()

Any xroad.node.Node.create_object	(		self,
			obj_type
	)

create new object

Parameters

[in]

type

- type of object to create

data()

def xroad.node.Node.data

(

self

)

get node system slot

Returns

See also

NodeData

free_signal()

def xroad.node.Node.free_signal	(		self,
			signal
	)

free signal if any

Parameters

[in]

signal

- signal to catch

get_env_param()

def xroad.node.Node.get_env_param	(		self,
			name,
			def_val = None
	)

get variable from environment

Returns

variable value

get_fun()

def xroad.node.Node.get_fun	(		self,
			name
	)

get function from routing library (dll.c, etc)

Parameters

[in]

name

- function name

Returns

function pointer or None

get_object()

Any xroad.node.Node.get_object	(		self,
			obj_type,
			obj_id
	)

return object from cache

Parameters

[in]	type	- type of object
[in]	obj_id	- id of object

system()

def xroad.node.Node.system

(

self

)

get system

Returns

system

---

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

• /home/dmitryme/dev/xroad/release/sdk/python/xroad/node.py