client.DeploymentDaemonClient Class Reference

This class provides methods to invoke deployment daemon commands. More...

Public Member Functions
def	set_name (self, name)
	Sets the name of the deployment daemon that we want to talk with.
def	set_timeouts (self, time_out)
	Sets the timeouts for both request and reply for the command invocation.
def	set_service_discovery_uri (self, service_discovery_uri)
	Sets the service discovery URI (endpoint).
def	deploy (self, deployment_set)
	Invokes 'Deploy' command of the deployment daemon.
def	undeploy (self)
	Invokes 'Undeploy' command of the deployment daemon.
def	get_active_deployment (self)
	Invokes 'GetActiveDeployment' command of the deployment daemon.
def	get_description (self)
	Invokes 'GetDescription' command of the deployment daemon.
def	get_deployment_sets (self)
	Invokes 'GetDeploymentSets' command of the deployment daemon.
def	get_components (self)
	Invokes 'GetComponents' command of the deployment daemon.
def	get_active_components (self)
	Invokes 'GetActiveComponents' command of the deployment daemon.
def	start_component (self, component_name)
	Invokes 'StartComponent' command of the deployment daemon.
def	stop_component (self, component_name)
	Invokes 'StopComponent' command of the deployment daemon.
def	get_state (self)
	Invokes 'GetState' command of the deployment daemon.
def	reset (self)
	Invokes 'Reset' command of the deployment daemon.
def	exit (self)
	Invokes 'Exit' command of the deployment daemon.
def	set_log_level (self, log_info)
	Invokes 'SetLogLevel' command of the deployment daemon.

Public Attributes
	dd_name
	conn_to
	reply_to
	service_discovery_uri
	request_reply_str

Static Public Attributes
str	dd_name = "deployment_daemon"
str	cmd_namespace = "::rtctkif::DeploymentCmds::"
str	request_reply_str = ""
datetime	conn_to = datetime.timedelta(seconds=20)
datetime	reply_to = datetime.timedelta(seconds=20)
MsgSend	sender = MsgSend([])

Protected Member Functions
def	_get_service_discovery (self)
	Retrieves from the service discovery the daemon endpoint.

Detailed Description

This class provides methods to invoke deployment daemon commands.

It is important to invoke get_endpoint method before any other deployment daemon command.

Member Function Documentation

_get_service_discovery()

def client.DeploymentDaemonClient._get_service_discovery (   self )

protected

Retrieves from the service discovery the daemon endpoint.

deploy()

def client.DeploymentDaemonClient.deploy	(		self,
			deployment_set
	)

Invokes 'Deploy' command of the deployment daemon.

exit()

def client.DeploymentDaemonClient.exit

(

self

)

Invokes 'Exit' command of the deployment daemon.

get_active_components()

def client.DeploymentDaemonClient.get_active_components

(

self

)

Invokes 'GetActiveComponents' command of the deployment daemon.

get_active_deployment()

def client.DeploymentDaemonClient.get_active_deployment

(

self

)

Invokes 'GetActiveDeployment' command of the deployment daemon.

get_components()

def client.DeploymentDaemonClient.get_components

(

self

)

Invokes 'GetComponents' command of the deployment daemon.

get_deployment_sets()

def client.DeploymentDaemonClient.get_deployment_sets

(

self

)

Invokes 'GetDeploymentSets' command of the deployment daemon.

get_description()

def client.DeploymentDaemonClient.get_description

(

self

)

Invokes 'GetDescription' command of the deployment daemon.

get_state()

def client.DeploymentDaemonClient.get_state

(

self

)

Invokes 'GetState' command of the deployment daemon.

reset()

def client.DeploymentDaemonClient.reset

(

self

)

Invokes 'Reset' command of the deployment daemon.

set_log_level()

def client.DeploymentDaemonClient.set_log_level	(		self,
			log_info
	)

Invokes 'SetLogLevel' command of the deployment daemon.

set_name()

def client.DeploymentDaemonClient.set_name	(		self,
			name
	)

Sets the name of the deployment daemon that we want to talk with.

If name is not provided is taken default name: 'deployment_daemon'

set_service_discovery_uri()

def client.DeploymentDaemonClient.set_service_discovery_uri	(		self,
			service_discovery_uri
	)

Sets the service discovery URI (endpoint).

set_timeouts()

def client.DeploymentDaemonClient.set_timeouts	(		self,
			time_out
	)

Sets the timeouts for both request and reply for the command invocation.

Default is 20s

start_component()

def client.DeploymentDaemonClient.start_component	(		self,
			component_name
	)

Invokes 'StartComponent' command of the deployment daemon.

stop_component()

def client.DeploymentDaemonClient.stop_component	(		self,
			component_name
	)

Invokes 'StopComponent' command of the deployment daemon.

undeploy()

def client.DeploymentDaemonClient.undeploy

(

self

)

Invokes 'Undeploy' command of the deployment daemon.

Member Data Documentation

cmd_namespace

str client.DeploymentDaemonClient.cmd_namespace = "::rtctkif::DeploymentCmds::"

static

conn_to [1/2]

datetime client.DeploymentDaemonClient.conn_to = datetime.timedelta(seconds=20)

static

conn_to [2/2]

client.DeploymentDaemonClient.conn_to

dd_name [1/2]

str client.DeploymentDaemonClient.dd_name = "deployment_daemon"

static

dd_name [2/2]

client.DeploymentDaemonClient.dd_name

reply_to [1/2]

datetime client.DeploymentDaemonClient.reply_to = datetime.timedelta(seconds=20)

static

reply_to [2/2]

client.DeploymentDaemonClient.reply_to

request_reply_str [1/2]

str client.DeploymentDaemonClient.request_reply_str = ""

static

request_reply_str [2/2]

client.DeploymentDaemonClient.request_reply_str

sender

MsgSend client.DeploymentDaemonClient.sender = MsgSend([])

static

service_discovery_uri

client.DeploymentDaemonClient.service_discovery_uri

---

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

• clients/deploymentDaemonClient/src/rtctk/deployment_daemon/client.py