Source code for wishful_upis.mgmt

__author__ = "Piotr Gawlowicz, Mikolaj Chwalisz, Zubow"
__copyright__ = "Copyright (c) 2015, Technische Universitat Berlin"
__version__ = "0.1.0"
__email__ = "{gawlowicz, chwalisz, zubow}@tkn.tu-berlin.de"

'''
    The WiSHFUL management interface.
'''

''' Wishful rule-matching engine '''
[docs]def add_rule(rule):
    '''Add new rule to rule-matching engine
    '''
    pass


[docs]def delete_rule(rule_id):
    '''Remove rule to rule-matching engine
    '''
    pass

'''
    Framework functionality
'''

[docs]def start_local_control_program(program_name, program_code):
    '''Install and execute a given control program on a local node remotely.
    
    Args:
        program_name (string): The name of the local CP.
        program_code (function): A python function containing the local CP control logic. 
    '''
    pass


[docs]def stop_local_control_program(program_id):
    '''Stops execution of a given control program on loca/remote node.
    '''
    pass


[docs]def send_msg_to_local_control_program(program_id, msg):
    '''Hierarchical control function allows the global control program to send messages to local control programs.
    '''
    pass

[docs]def transaction_begin():
    '''Start a transaction

    i.e. all subsequent UPI calls are executed in transactional scope.
    '''
    pass


[docs]def transaction_abort():
    '''Aborts a running transaction

    i.e. all changes are roll backed.
    '''
    pass


[docs]def transaction_commit():
    '''Commit an open transaction.
    '''
    pass