Package brisa :: Package upnp :: Module base_service_builder :: Class BaseServiceBuilder
[hide private]
[frames] | no frames]

Class BaseServiceBuilder

source code

object --+
         |
        BaseServiceBuilder

Instance Methods [hide private]
 
__init__(self, service, fd)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature
source code
bool
build(self)
Builds a service given a file descriptor containing the SCPD XML.
source code
bool
_parse_description(self, fd)
Parses the actions and state variables of a service given a file descriptor containing the SCPD XML.
source code
 
_parse_actions(self, tree)
Parses actions from a fetched tree.
source code
 
_parse_variables(self, tree)
Parses variables from a fetched tree.
source code
 
_build_service(self)
Builds a service.
source code
BaseArgument
_create_argument(self, arg_name, arg_direction, arg_state_var)
Factory method that creates an action argument.
source code
BaseAction
_create_action(self, name, args)
Factory method that creates a service action.
source code
BaseStateVariable
_create_state_var(self, name, send_events, multicast, data_type, values)
Factory method that creates a service state variable.
source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __str__, __subclasshook__

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, service, fd)
(Constructor)

source code 

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__
(inherited documentation)

build(self)

source code 

Builds a service given a file descriptor containing the SCPD XML.

Returns: bool
True if service build succeeded, otherwise False.

_parse_description(self, fd)

source code 

Parses the actions and state variables of a service given a file descriptor containing the SCPD XML. File descriptor must be open.

Parameters:
  • fd (file) - file descriptor
Returns: bool
True if service parser succeeded, otherwise False.

_parse_actions(self, tree)

source code 

Parses actions from a fetched tree.

Parameters:
  • tree (ElementTree) - tree containing the actions

_parse_variables(self, tree)

source code 

Parses variables from a fetched tree.

Parameters:
  • tree (ElementTree) - tree containing the actions

_create_argument(self, arg_name, arg_direction, arg_state_var)

source code 

Factory method that creates an action argument.

Returns: BaseArgument
The argument object.

_create_action(self, name, args)

source code 

Factory method that creates a service action.

Returns: BaseAction
The action object.

_create_state_var(self, name, send_events, multicast, data_type, values)

source code 

Factory method that creates a service state variable.

Returns: BaseStateVariable
The state variable object.