FW Profile - C1 Implementation
FwRtConstants.h File Reference

Header file to define all constants and types for the RT Container Module of the FW Profile. More...

Go to the source code of this file.

Data Structures

struct  FwRtDesc
 Structure representing a RT Container Descriptor. More...
 

Typedefs

typedef struct FwRtDescFwRtDesc_t
 Forward declaration for the pointer to a RT Container Descriptor. More...
 
typedef int FwRtBool_t
 Type used for booleans (0 is "false" and 1 is "true"). More...
 
typedef int FwRtOutcome_t
 Type used for the outcome of a container action. More...
 
typedef short int FwRtCounterU2_t
 Type used for unsigned integers with a "medium" range. More...
 
typedef FwRtOutcome_t(* FwRtAction_t) (FwRtDesc_t)
 Type for a pointer to a container action. More...
 

Enumerations

Detailed Description

Header file to define all constants and types for the RT Container Module of the FW Profile.

This header file should be included by all applications which use the RT Container Module of the FW Profile.

Author
Vaclav Cechticky vacla.nosp@m.v.ce.nosp@m.chtic.nosp@m.ky@p.nosp@m.np-so.nosp@m.ftwa.nosp@m.re.co.nosp@m.m
Alessandro Pasetti paset.nosp@m.ti@p.nosp@m.np-so.nosp@m.ftwa.nosp@m.re.co.nosp@m.m

This file is part of the FW Profile.

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at http://mozilla.org/MPL/2.0/.

For information on alternative licensing, please contact P&P Software GmbH.

Definition in file FwRtConstants.h.

Typedef Documentation

typedef FwRtOutcome_t(* FwRtAction_t) (FwRtDesc_t)

Type for a pointer to a container action.

A container action is a function which encapsulates an action executed by either the Notification Procedure or the Activation Procedure of a RT Container. Container actions return an outcome. The semantics of the outcome depends on the kind of action.

Definition at line 50 of file FwRtConstants.h.

typedef int FwRtBool_t

Type used for booleans (0 is "false" and 1 is "true").

Definition at line 34 of file FwRtConstants.h.

typedef short int FwRtCounterU2_t

Type used for unsigned integers with a "medium" range.

Definition at line 40 of file FwRtConstants.h.

typedef struct FwRtDesc* FwRtDesc_t

Forward declaration for the pointer to a RT Container Descriptor.

A RT Container Descriptor is a data structure which holds all the information describing a RT Container instance.

Definition at line 31 of file FwRtConstants.h.

typedef int FwRtOutcome_t

Type used for the outcome of a container action.

Definition at line 37 of file FwRtConstants.h.

Enumeration Type Documentation

Enumerated type for the state of the RT Container.

The only nominal values are rtContStopped and rtContStarted. If the container is not in one of these two states, its behaviour is undefined. All other values indicate that an error has been reported by a system call. The error code reported by the system call is stored in the error code field of the RT Container Descriptor.

Enumerator
rtContUninitialized 

The RT Container has not yet been initialized.

rtContStopped 

The RT Container is in state STOPPED.

rtContStarted 

The RT Container is in state STARTED.

rtThreadCreateErr 

The function to create the Activation Thread has reported an error.

rtMutexInitErr 

The function to initialize the container mutex has reported an error.

rtMutexDestroyErr 

The function to destroy the container mutex has reported an error.

rtCondInitErr 

The function to initialize the container condition has reported an error.

rtCondDestroyErr 

The function to destroy the container condition has reported an error.

rtMutexLockErr 

The function to lock the container mutex has reported an error.

rtMutexUnlockErr 

The function to unlock the container mutex has reported an error.

rtCondSignalErr 

The function to signal a condition has reported an error.

rtCondWaitErr 

The function to wait on a condition has reported an error.

rtMutexAttrInitErr 

The function to initialize a mutex attribute has reported an error.

rtCondAttrInitErr 

The function to initialize a mutex attribute has reported an error.

rtThreadAttrInitErr 

The function to initialize a thread attribute has reported an error.

rtMutexAttrDestroyErr 

The function to destroy a mutex attribute has reported an error.

rtCondAttrDestroyErr 

The function to destroy a mutex attribute has reported an error.

rtThreadAttrDestroyErr 

The function to destroy a thread attribute has reported an error.

rtJoinErr 

The function to wait on a thread join has reported an error.

rtConfigErr 

A configuration function has been called during the container's normal operation (i.e.

after FwRtInit has been called but before FwRtShutdown is called)

Definition at line 60 of file FwRtConstants.h.

P&P Software GmbH, Copyright 2011, All Rights Reserved