Generic IOC state facility. More...
#include "shareLib.h"
Go to the source code of this file.
Typedefs | |
| typedef struct dbState * | dbStateId |
Functions | |
| epicsShareFunc dbStateId | dbStateCreate (const char *name) |
| Create db state. More... | |
| epicsShareFunc dbStateId | dbStateFind (const char *name) |
| Find db state. More... | |
| epicsShareFunc void | dbStateSet (dbStateId id) |
| Set db state to TRUE. More... | |
| epicsShareFunc void | dbStateClear (dbStateId id) |
| Set db state to FALSE. More... | |
| epicsShareFunc int | dbStateGet (dbStateId id) |
| Get db state. More... | |
| epicsShareFunc void | dbStateShow (dbStateId id, unsigned int level) |
| Print info about db state. More... | |
| epicsShareFunc void | dbStateShowAll (unsigned int level) |
| Print info about all db states. More... | |
Detailed Description
This library provides a simple global flag facility that can be used to synchronize e.g. plugins with IOC-wide states, that may be derived from events (either soft events or hard events coming from specialized timing and event hardware).
A subset of this API is provided as IOC Shell commands to allow command line debugging.
Definition in file dbState.h.
Function Documentation
◆ dbStateCreate()
| epicsShareFunc dbStateId dbStateCreate | ( | const char * | name | ) |
Creates a new db state with the specified 'name', returning the new id. If state with that name already exists, the existing state's id is returned.
Also provided as an IOC Shell command.
- Parameters
-
name Db state name.
- Returns
- Id of db state, NULL for failure.
◆ dbStateFind()
| epicsShareFunc dbStateId dbStateFind | ( | const char * | name | ) |
- Parameters
-
name Db state name.
- Returns
- Id of db state, NULL if not found.
◆ dbStateSet()
| epicsShareFunc void dbStateSet | ( | dbStateId | id | ) |
Also provided as an IOC Shell command.
- Parameters
-
id Db state id.
◆ dbStateClear()
| epicsShareFunc void dbStateClear | ( | dbStateId | id | ) |
Also provided as an IOC Shell command.
- Parameters
-
id Db state id.
◆ dbStateGet()
| epicsShareFunc int dbStateGet | ( | dbStateId | id | ) |
- Parameters
-
id Db state id.
- Returns
- Current db state (0|1).
◆ dbStateShow()
| epicsShareFunc void dbStateShow | ( | dbStateId | id, |
| unsigned int | level | ||
| ) |
Also provided as an IOC Shell command.
- Parameters
-
id Db state id. level Interest level.
◆ dbStateShowAll()
| epicsShareFunc void dbStateShowAll | ( | unsigned int | level | ) |
Also provided as an IOC Shell command.
- Parameters
-
level Interest level.
