NAME

fttl_get_template_length - Returns the length of a specified template.

SYNOPSIS

kern_return_t fttl_get_template_length(template, length)
ft_template_t template;
timespec_t *length;

DESCRIPTION

The length of a template is measured in units of time. The fttl_get_template_length system call returns the length in seconds.nanoseconds of the specified template. The length of the default template is defined in the kernel (ft_timeline.c). The length of any other template is defined by the application when the template is created (see fttl_create_template). Typically the length of a template is chosen to be the least common multi- ple of the periods of the threads to be scheduled on the tem- plate.

Timeline templates are intended to be fixed in length at the time they are created. However, the fttl_enable_periodic system call can be used to change the length of a template after it is creat- ed but this has the side effect of removing all threads from the template.

PARAMETERS

template Specifies a template previously created by create_template or the default template, (template = NULL).
length The address of a timespec_t variable in which to store the length of the template.

RETURN VALUE

KERN_SUCCESS The call was successful.
KERN_INVALID_ARGUMENT template is invalid.

RELATED INFORMATION

Functions:

rt_thread_exit, thread_create, thread_terminate, thread_get_attribute, thread_set_attribute, fttl_thread_create, fttl_thread_attribute_init, rt_set_scheduling_policy, fttl_set_fault_flag, fttl_set_fault_interval, fttl_activate_persist_thread, fttl_enable_periodic, fttl_disable_periodic, fttl_create_template, fttl_activate_template, fttl_add_to_template, fttl_remove_from_template, fttl_clear_template. fttl_get_template_length.