FACE::RETURN_CODE_TYPE Struct Reference

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Provide a mechanism for the TSS to return a status indicating the condition of completion of the requested action More...

#include <Common.hpp>

Public Types
enum	Value {   NO_ERROR, NO_ACTION, NOT_AVAILABLE, INVALID_PARAM,   INVALID_CONFIG, INVALID_MODE, TIMED_OUT, ADDR_IN_USE,   PERMISSION_DENIED, MESSAGE_STALE, IN_PROGRESS, CONNECTION_CLOSED,   DATA_BUFFER_TOO_SMALL, DATA_OVERFLOW }
	<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Enum values of RETURN_CODE_TYPE. Each indicate different results of a given operation that return it. More...

Detailed Description

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Provide a mechanism for the TSS to return a status indicating the condition of completion of the requested action

Member Enumeration Documentation

enum FACE::RETURN_CODE_TYPE::Value

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Enum values of RETURN_CODE_TYPE. Each indicate different results of a given operation that return it.

This enumeration defines the possible set of status codes which may be returned by a method defined in the FACE API. The first set of codes (through TIMED_OUT) is constrained to match the set defined in the ARINC 653 standard.

Enumerator:

NO_ERROR	<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Request valid and operation performed
NO_ACTION	<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Status of system unaffected by request
NOT_AVAILABLE	<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> No message was available
INVALID_PARAM	<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Invalid parameter specified in request
INVALID_CONFIG	<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Parameter incompatible with configuration
INVALID_MODE	<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Request incompatible with current mode
TIMED_OUT	<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> The time expired before the request could be filled
ADDR_IN_USE	<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Address currently in use
PERMISSION_DENIED	<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> No permission to send or connecting to wrong partition
MESSAGE_STALE	<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Current time - timestamp exceeds configured limits
IN_PROGRESS	<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Asynchronous connection in progress
CONNECTION_CLOSED	<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Connection was closed
DATA_BUFFER_TOO_SMALL	<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Data Buffer was too small for message
DATA_OVERFLOW	<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> A loss of messages due to data buffer overflow