Common

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Contains the FACE::Common documentation More...

Data Structures
struct	FACE::RETURN_CODE_TYPE
	<<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...

Macros
#define	FACE_INF_TIME_VALUE   ((FACE::SYSTEM_TIME_TYPE)-1)
	<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> This type is used to represent an infinitely long time value. It is often used to specify that the caller is willing to wait forever for an operation to complete and does not wish to timeout.
#define	FACE_STRING_TYPE_bound_value   ((FACE::UnsignedLong)0)
	<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Provide bound for the string type. FACE::UnsignedLong of 0 or 256 if FACE_SEQUENCE_AND_STRING_IMPLEMENTED
#define	FACE_UNBOUNDED_STRING_TYPE_bound_value   STRING_TYPE_bound_value
	<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Defined by STRING_TYPE_bound_value

Typedefs
typedef FACE::LongLong	FACE::SYSTEM_TIME_TYPE
	<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> This type is used to represent 64-bit signed integer with a 1 nanosecond resolution.
typedef const char *	FACE::STRING_TYPE
	<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> This type is used to represent a bounded string of characters.
typedef STRING_TYPE	FACE::UNBOUNDED_STRING_TYPE
	<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> This type is used to represent an unbounded string of characters.
typedef STRING_TYPE	FACE::CONFIGURATION_RESOURCE
	<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> This string is used to specify the location of the configuration resource in both the IOSS and TSS initialize functions. This may be local, a file name reference, or a reference to a configuration service.
typedef void *	FACE::SYSTEM_ADDRESS_TYPE
	<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> This type is used to represent a system address.
typedef SYSTEM_TIME_TYPE	FACE::TIMEOUT_TYPE
	<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> This type has a one nanosecond resolution.
typedef FACE::LongLong	FACE::GUID_TYPE
	<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> This type is used to represent Globally Unique Identifiers.

Detailed Description

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Contains the FACE::Common documentation

The FACE Technical Standard defines multiple APIs and those APIs are designed to have a common appearance. Elements such as the return status codes from FACE services used by more than one API are described in this module.

Macro Definition Documentation

#define FACE_INF_TIME_VALUE   ((FACE::SYSTEM_TIME_TYPE)-1)

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> This type is used to represent an infinitely long time value. It is often used to specify that the caller is willing to wait forever for an operation to complete and does not wish to timeout.

#define FACE_STRING_TYPE_bound_value   ((FACE::UnsignedLong)0)

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Provide bound for the string type. FACE::UnsignedLong of 0 or 256 if FACE_SEQUENCE_AND_STRING_IMPLEMENTED

#define FACE_UNBOUNDED_STRING_TYPE_bound_value   STRING_TYPE_bound_value

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> Defined by STRING_TYPE_bound_value

Typedef Documentation

typedef FACE::LongLong FACE::SYSTEM_TIME_TYPE

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> This type is used to represent 64-bit signed integer with a 1 nanosecond resolution.

typedef const char* FACE::STRING_TYPE

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> This type is used to represent a bounded string of characters.

typedef STRING_TYPE FACE::UNBOUNDED_STRING_TYPE

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> This type is used to represent an unbounded string of characters.

typedef STRING_TYPE FACE::CONFIGURATION_RESOURCE

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> This string is used to specify the location of the configuration resource in both the IOSS and TSS initialize functions. This may be local, a file name reference, or a reference to a configuration service.

typedef void* FACE::SYSTEM_ADDRESS_TYPE

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> This type is used to represent a system address.

typedef SYSTEM_TIME_TYPE FACE::TIMEOUT_TYPE

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> This type has a one nanosecond resolution.

typedef FACE::LongLong FACE::GUID_TYPE

<<Connext Micro>> <<Connext Pro>> <<SafetyBase or Stricter>> This type is used to represent Globally Unique Identifiers.