atobase 3.2.0
ATOMAS atobase

General types used across the ATO BASE API. More...

Modules

 Module defines
 Each module within the library is individually defined by a name and id.
 
 Other defines
 

Typedefs

typedef struct _ato_Ctx ato_Ctx
 The thread local context object.
 

Enumerations

enum  ato_eParamAction { ATO_PARAMACTION_DEFAULT = 0 , ATO_PARAMACTION_COPY , ATO_PARAMACTION_CONST , ATO_PARAMACTION_FREE }
 Parameter semantics when passing information to some API methods. More...
 
enum  ato_eLoglevel {
  ATO_LOG_OFF = 1 , ATO_LOG_FATAL , ATO_LOG_ERR , ATO_LOG_WARN ,
  ATO_LOG_INFO , ATO_LOG_DEBUG , ATO_LOG_TRACE , ATO_LOG_ALL
}
 Loglevels. More...
 

Detailed Description

General types used across the ATO BASE API.

Enumeration Type Documentation

◆ ato_eParamAction

Parameter semantics when passing information to some API methods.

Enumerator
ATO_PARAMACTION_DEFAULT 

Action is up to individual method.

ATO_PARAMACTION_COPY 

Take a deep copy of the parameter.

ATO_PARAMACTION_CONST 

Reference the parameter but treat as const so don't free.

ATO_PARAMACTION_FREE 

Reference the parameter but take on ownership so free when finished with it.

◆ ato_eLoglevel

Loglevels.

Enumerator
ATO_LOG_OFF 

Do not log.

ATO_LOG_FATAL 

Typically this will be an assertion for invalid arguments or out of memory.

ATO_LOG_ERR 

An infrastructure type error has occured, such as a network error or no configuration.

ATO_LOG_WARN 

Usually a business level error such as wrong password.

ATO_LOG_INFO 

Information usually indicating a method succeeded.

ATO_LOG_DEBUG 

Additional information, useful where errors have occurred.

ATO_LOG_TRACE 

Trace the entry and exit calls of methods (exits do not occur on errors)

ATO_LOG_ALL 

Log everything.