mycroft.util.signal Namespace Reference

Functions
def	check_for_signal (signal_name, sec_lifetime=0)
def	create_file (filename)
def	create_signal (signal_name)
def	ensure_directory_exists (directory, domain=None)
def	get_ipc_directory (domain=None)

Function Documentation

def mycroft.util.signal.check_for_signal	(		signal_name,
			sec_lifetime = 0
	)

See if a named signal exists

Args:
    signal_name (str): The signal's name.  Must only contain characters
        valid in filenames.
    sec_lifetime (int, optional): How many seconds the signal should
        remain valid.  If 0 or not specified, it is a single-use signal.
        If -1, it never expires.

Returns:
    bool: True if the signal is defined, False otherwise

Definition at line 105 of file signal.py.

def mycroft.util.signal.create_file

(

filename

)

Create the file filename and create any directories needed

    Args:
        filename: Path to the file to be created

Definition at line 76 of file signal.py.

def mycroft.util.signal.create_signal

(

signal_name

)

Create a named signal

Args:
    signal_name (str): The signal's name.  Must only contain characters
        valid in filenames.

Definition at line 90 of file signal.py.

def mycroft.util.signal.ensure_directory_exists	(		directory,
			domain = None
	)

Create a directory and give access rights to all

Args:
    domain (str): The IPC domain.  Basically a subdirectory to prevent
        overlapping signal filenames.

Returns:
    str: a path to the directory

Definition at line 46 of file signal.py.

def mycroft.util.signal.get_ipc_directory

(

domain = None

)

Get the directory used for Inter Process Communication

Files in this folder can be accessed by different processes on the
machine.  Useful for communication.  This is often a small RAM disk.

Args:
    domain (str): The IPC domain.  Basically a subdirectory to prevent
        overlapping signal filenames.

Returns:
    str: a path to the IPC directory

Definition at line 25 of file signal.py.