page generated on
04.05.2024
-
04:45
TINE Local Alarm Server plus API routines.
More...
|
int | AppendAlarmInfoTable (char *eqm, ADS *ads) |
| Inserts an alarm definition into the alarm definition table. More...
|
|
int | AppendAlarmInfoTableEx (char *eqm, ADS *ads, char *filterString) |
| Inserts an alarm definition into the alarm definition table. The extended call accepts a parseable filter string. More...
|
|
int | AppendAlarmWatchTable (char *eqm, char *prp, char *dev, int siz, int fmt, int atyp, int sev, int sys, ALM_THRESHOLDS *thr) |
| Inserts a property to be monitored into the local alarm server's Watch Table. More...
|
|
int | ApplyAlarmWatchFilter (char *eqm, char *prp, char *dev, char *parsableFilterString) |
| Applies a filter to an existing local alarm server's Watch Table. More...
|
|
void | ClearAlarm (char *eqm, int devNr) |
| Instructs the local alarm server table that the given alarm is to be cleared. More...
|
|
void | ClearDeviceAlarm (char *eqm, char *devname) |
| Instructs the local alarm server table that the given alarm is to be cleared. More...
|
|
int | GetAlarmCodeOscillationWindow (const char *eqm, int code) |
| Gets the size of the alarm oscillation window in clear counts. More...
|
|
int | GetAlarmCollapseWindow (void) |
| Gets the size of the alarm collapse window in counts. More...
|
|
int | GetAlarmDataChangeWindow (void) |
| Gets the size of the alarm datachange window in seconds. More...
|
|
int | GetAlarmDefinition (char *eqm, UINT32 code, ADS *ads) |
| Gets the alarm definition for the alarm code specified. More...
|
|
int | GetAlarmHeartbeat (void) |
| Gets the size of the heartbeat alarm window in seconds before the 'heartbeat' flag is applied to an alarm. More...
|
|
int | GetAlarmOscillationWindow (void) |
| Gets the size of the alarm oscillation window in clear counts. More...
|
|
int | GetAlarmTableMaximumSize (void) |
| Gets the maximum number of alarms managed by the local alarm server. More...
|
|
int | GetAlarmTerminationWindow (void) |
| Gets the size of the termination window in seconds before a terminated alarm is discarded from the local alarm list. More...
|
|
int | GetAllowOfflineAlarms (void) |
| Gets the local alarm server setting to allow or disallow alarms for devices declared offline. More...
|
|
int | GetNewAlarmWindow (void) |
| Gets the size of the new alarm window in seconds before a new alarm is no longer declared as new. More...
|
|
void | RemoveAlarm (char *eqm, int devNr, UINT32 code) |
| Instructs the local alarm server table that the given alarm is to be marked for removal. More...
|
|
void | RemoveDeviceAlarm (char *eqm, char *devname, UINT32 code) |
| Instructs the local alarm server table that the given alarm is to be marked for removal. More...
|
|
int | SetAlarm (char *eqm, int devNr, UINT32 almCode, BYTE *almData) |
| Inserts an alarm into the local alarm server table. More...
|
|
int | SetAlarmCodeOscillationWindow (const char *eqm, int code, int value) |
| Sets the size of the alarm oscillation window in clear counts. More...
|
|
int | SetAlarmCollapseWindow (int value) |
| Sets the size of the alarm collapse window in counts. More...
|
|
void | SetAlarmDataChangeWindow (int timeInSeconds) |
| Sets the size of the alarm datachange window in seconds. More...
|
|
int | SetAlarmEx (char *eqm, int devNr, UINT32 almCode, BYTE *almData, BYTE flags) |
| Inserts an alarm into the local alarm server table. More...
|
|
void | SetAlarmHeartbeat (int timeInSeconds) |
| Sets the size of the heartbeat alarm window in seconds before the 'heartbeat' flag is applied to an alarm. More...
|
|
int | SetAlarmOscillationWindow (int value) |
| Sets the size of the alarm oscillation window in clear counts. More...
|
|
void | SetAlarmTableMaximumSize (int tableSize) |
| Sets the maximum number of alarms managed by the local alarm server. More...
|
|
void | SetAlarmTerminationWindow (int timeInSeconds) |
| Sets the size of the termination window in seconds before a terminated alarm is discarded from the local alarm list. More...
|
|
void | SetAllowOfflineAlarms (int value) |
| Instructs the local alarm server to allow or disallow alarms for devices declared offline. More...
|
|
void | SetAvailableMemoryThreshold (UINT32 minAvailBytes) |
| Sets the threshold (in bytes) used in setting 'low main memory' alarms. More...
|
|
int | SetDeviceAlarm (char *eqm, char *devname, UINT32 almCode, BYTE *almData, BYTE flags) |
| Inserts an alarm into the local alarm server table. More...
|
|
int | SetFreeBlocksAlarmThreshold (char *path, UINT32 minFreeBlocks) |
| Sets the threshold (in blocks) used in setting 'low disk space' alarms. More...
|
|
void | SetNewAlarmWindow (int timeInSeconds) |
| Sets the size of the new alarm window in seconds before a new alarm is no longer declared as new. More...
|
|
|
int | AlarmDataChangeWindow = DEFAULT_ALARM_DATACHANGE_WINDOW |
| Determines the minimum time a data change alarm is to keep its timestamp in the local alarm table. More...
|
|
int | AlarmHeartbeat = DEFAULT_ALARM_HEARTBEAT |
| Determines the time interval at the 'HEARTBEAT' flag will be re-issued for persistent alarms. More...
|
|
int | AlarmInstantWindow = DEFAULT_INSTANT_WINDOW |
| Determines the minimum time an alarm is to remain in the local alarm table before it can be removed. More...
|
|
int | AlarmTestState = 0 |
| Determines the minimum time an alarm is to remain in the local alarm table before it can be removed. More...
|
|
int | AlarmWindow = DEFAULT_ALARM_WINDOW |
| Determines the minimum time an alarm is to remain in the local alarm table before it can be removed. More...
|
|
int | MaxNumberAlarms = MAXALARMS |
| Determines the maximum number of alarms which can be maintained in the local alarm server's alarm list. More...
|
|
int | TerminationWindow = DEFAULT_TERMINATION_WINDOW |
| Determines the minimum time an expired alarm is to remain in the local alarm table. More...
|
|
TINE Local Alarm Server plus API routines.
The API routines offered here pertain directly to the TINE Local Alarm Server maintained on the running server. A server can of course run without setting alarms. However a control system will suffer if important information relating to the health of the system is surpressed. One can set a certain category of alarms (threshold alarms) without issuing any API call, but instead supplying a startup configuration file 'almwatch.csv' with instructions as to which properties to call and into what range the data returned must fall in order to function properly. Otherwise calls to ClearAlarm() and SetAlarm() for instance should be made inside a server's IO loop where necessary.
◆ AppendAlarmInfoTable()
int AppendAlarmInfoTable |
( |
char * |
eqm, |
|
|
ADS * |
ads |
|
) |
| |
Inserts an alarm definition into the alarm definition table.
As an alternative to the <local name>-alarms.csv configuration file, the front end server can make use of this API call in order to fill in the alarm definition table describing locally generated alarms. This is particularly useful for embedded platforms where there is no file system, or where a TINE server is used as a translation layer and needs to map a given alarm system onto the TINE alarm system.
- Parameters
-
eqm | is the 6-character local equipment identifier name, which is internal to server. |
ads | is a pointer to an Alarm Definition Structure (ADS) containing the alarm table information which is to be appended to the alarm definition table. |
- Returns
- 0 upon success, otherwise a TINE error code.
strncpy(ads.alarmTag,"Threshold exceeded",16);
ads.alarmCode = 512;
ads.alarmMask = 0xff;
ads.alarmSeverity = 7;
ads.alarmDataFormat = BFMT(CF_FLOAT);
ads.alarmDataArraySize = 1;
ads.alarmSystem = 640;
strncpy(ads.alarmText,"Take action immediately!",40);
strncpy(ads.dataText,"Current threshold setting",40);
strncpy(ads.url,"alarm512.html",40);
{
feclog(
"appendAlarmInfoTable : %s",erlst[cc]);
}
References AppendAlarmInfoTableEx().
◆ AppendAlarmInfoTableEx()
int AppendAlarmInfoTableEx |
( |
char * |
eqm, |
|
|
ADS * |
ads, |
|
|
char * |
filterString |
|
) |
| |
Inserts an alarm definition into the alarm definition table. The extended call accepts a parseable filter string.
As an alternative to the <local name>-alarms.csv configuration file, the front end server can make use of this API call in order to fill in the alarm definition table describing locally generated alarms. This is particularly useful for embedded platforms where there is no file system, or where a TINE server is used as a translation layer and needs to map a given alarm system onto the TINE alarm system.
- Parameters
-
eqm | is the 6-character local equipment identifier name, which is internal to server. |
ads | is a pointer to an Alarm Definition Structure (ADS) containing the alarm table information which is to be appended to the alarm definition table. |
filterString | is a parsable filter string defining the filter condition. This should be of the form /<context>/<server/<device>[<property>]<comparator><value> where <comparator> is one of '=', '!=', '>', or '<' and <value> is the filter's threshold value. The filter target address should deliver (or be able to deliver) a single numeric or string name value. If the filter string cannot be parsed of the target address does not exists, then no filter will be established. The filter conditions must be met for the alarm specified in the ADS to be applied via any of the SetAlarm() methods. Unless, in addition, the filterString has been concatenated with an optional severity, which should be used when the filter criterion is not met. The optional serverity should be specified by appending &sev=<severity> at the end of the filter string. |
- Returns
- 0 upon success, otherwise a TINE error code.
strncpy(ads.alarmTag,"Threshold exceeded",16);
ads.alarmCode = 512;
ads.alarmMask = 0xff;
ads.alarmSeverity = 7;
ads.alarmDataFormat = BFMT(CF_FLOAT);
ads.alarmDataArraySize = 1;
ads.alarmSystem = 640;
strncpy(ads.alarmText,"Take action immediately!",40);
strncpy(ads.dataText,"Current threshold setting",40);
strncpy(ads.url,"alarm512.html",40);
{
feclog(
"appendAlarmInfoTable : %s",erlst[cc]);
}
Referenced by AppendAlarmInfoTable().
◆ AppendAlarmWatchTable()
int AppendAlarmWatchTable |
( |
char * |
eqm, |
|
|
char * |
prp, |
|
|
char * |
dev, |
|
|
int |
siz, |
|
|
int |
fmt, |
|
|
int |
atyp, |
|
|
int |
sev, |
|
|
int |
sys, |
|
|
ALM_THRESHOLDS * |
thr |
|
) |
| |
Inserts a property to be monitored into the local alarm server's Watch Table.
Certain alarms are to be set whenever the value of a property exceeds a defineable threshold. Such alarms can be managed automatically by the local alarm server if the alarm criteria are entered into the alarm watch table. This can be achieved by calling this routine (or supplying a startup configuration file almwatch.csv).
- Parameters
-
eqm | is the 6-character local equipment identifier name, which is internal to server. |
prp | is the property which is to be called by the local alarm server |
dev | is the device name associated with the property to be called by the local alarm server |
siz | is the data array size to be called by the local alarm server |
fmt | is the TINE data format to be called by the local alarm server |
atyp | is the TINE data array type to be applied to the property called by the local alarm server |
sev | is the severity of the alarm issued when the data returned by the call exceed the given thresholds. |
sys | is the alarm system identifier to be associated with the alarm. |
thr | is an ALM_THRESHOLDS object specifying the threshold criteria for setting the alarm |
- Note
- Information can also be entered into the alarm watch table by supplying the startup configuration file almwatch.csv, where the input parameters are given in the relevant columns. This is frequently the preferred way of inputting such alarm information, since if does not involve hard-coding such alarm criteria.
- Returns
- 0 upon success, otherwise a TINE error code.
References argument_list_error, and out_of_server_memory.
◆ ApplyAlarmWatchFilter()
int ApplyAlarmWatchFilter |
( |
char * |
eqm, |
|
|
char * |
prp, |
|
|
char * |
dev, |
|
|
char * |
parsableFilterString |
|
) |
| |
Applies a filter to an existing local alarm server's Watch Table.
A server can filter out automatic watch table alarms by applying a filter condition which must be satisfied.
- Parameters
-
eqm | is the 6-character local equipment identifier name, which is internal to server. |
prp | is the property which is to be called by the local alarm server |
dev | is the device name associated with the property to be called by the local alarm server |
parsableFilterString | is a parsable filter string defining the filter condition. This should be of the form /<context>/<server/<device>[<property>]<comparator><value> where <comparator> is one of '=', '!=', '>', or '<' and <value> is the filter's threshold value. The filter target address should deliver (or be able to deliver) a single numeric or string name value. If the filter string cannot be parsed of the target address does not exists, then no filter will be established. In addition, the filterString can be concatenated with an optional severity, which should be used when the filter criterion is not met. The optional serverity should be specified by appending &sev=<severity> at the end of the filter string. |
- Returns
- 0 upon success, otherwise a TINE error code.
◆ ClearAlarm()
void ClearAlarm |
( |
char * |
eqm, |
|
|
int |
devNr |
|
) |
| |
Instructs the local alarm server table that the given alarm is to be cleared.
A server can clear alarms for specific device by giving its device number.
Note that all alarms for the device specified are cleared. Also note, that "clearing" an alarm means that its "clear" counter is incremented.
It is not removed immediately from the local alarm list. For further information, please see the discussion of the local alarm server.
- Parameters
-
eqm | is the 6-character local equipment identifier name, which is internal to server. |
devNr | is the device number of the device for which all alarms is to be cleared. |
Referenced by ClearDeviceAlarm().
◆ ClearDeviceAlarm()
void ClearDeviceAlarm |
( |
char * |
eqm, |
|
|
char * |
devname |
|
) |
| |
Instructs the local alarm server table that the given alarm is to be cleared.
A server can clear alarms for specific device by giving its registered device name.
Note that all alarms for the device specified are cleared. Also note, that "clearing" an alarm means that its "clear" counter is incremented.
It is not removed immediately from the local alarm list. For further information, please see the discussion of the local alarm server.
- Parameters
-
eqm | is the 6-character local equipment identifier name, which is internal to server. |
devname | is the registered device name of the device for which all alarms is to be cleared. |
References ClearAlarm(), and GetDeviceNumber().
◆ GetAlarmCodeOscillationWindow()
int GetAlarmCodeOscillationWindow |
( |
const char * |
eqm, |
|
|
int |
code |
|
) |
| |
Gets the size of the alarm oscillation window in clear counts.
A call to a member of the ClearAlarm() family will increment the alarm's clear counter. Typically ClearAlarm() is always called at the beginning of an i/o loop and SetAlarm() is called if warranted according to alarm conditions later in the same loop. If the clear counter has reached the current oscillation window setting, the alarm is then marked for termination and removal. If the clear counter has been incremented by more than a single count AND a SetAlarm() is then called, the alarm is marked as 'oscillating' as it appears to the alarm sub system that the alarm conditions are not persistent by appear to come and go. The oscillation window is by default set to 8 counts. As a terminated alarm will nonetheless reside in the local alarm tables for a time equal to the current termination window (default = 30 seconds) the oscillation window will automatically 'grow' if an alarm has been marked as terminated but reappears within the termination window. The maximum oscillation window will however not exceed 128 (corresponding to approximately 2 minutes, assuming a 1 Hz i/o loop is in play).
Unlike GetAlarmOscillationWindow(), this routine targets a specific alarm code.
- Parameters
-
eqm | is the 6-character local equipment identifier name, which is internal to server. |
code | is the alarm code for which the oscillation window is to be applied |
- Returns
- the size of the alarm oscillation window (default = 8), or, if negative, the negative value of a TINE return code (e.g. non_existent if the given equipment module does not exist or the alarm code is unknown).
- See also
- SetAlarmCodeOscillationWindow()
◆ GetAlarmCollapseWindow()
int GetAlarmCollapseWindow |
( |
void |
| ) |
|
Gets the size of the alarm collapse window in counts.
At any given time the prevailing alarm conditions might give rise to an 'alarm storm', where an unusally large number of alarms are seen (due to e.g. hardware modules that are turned off during a shutdown). Such alarms are generally 'not interesting' and should not create extra network traffic, resource allocation, archiving, etc. if this can be avoided. As such, if the number of alarms for a given equipment module exceeds the current 'alarm collapse window' setting, the alarm information will be 'compressed' to a single alarm indicating that there are 'more than' the collapse window number of alarms.
- Returns
- the size of the alarm collapse window. (default = 100).
- See also
- SetAlarmCollapseWindow()
◆ GetAlarmDataChangeWindow()
int GetAlarmDataChangeWindow |
( |
void |
| ) |
|
Gets the size of the alarm datachange window in seconds.
When an alarm provides alarm data with the appropriate SetAlarm() call, the alarm will be tagged with the 'DATACHANGE' flag if the supplied data differ from that provided with the previous call to SetAlarm(). The alarm timestamp will be adjusted to the current time ONLY if the data change is seen outside of the current AlarmDataChangeWindow (in seconds). The value of the alarm timestamp is relevant in the acquisition of the existing alarm table by the central alarm server. If this window is too short and the alarm data is constantly changing this can result in very long 'alarm chains' to display and archive. Default is 30 seconds. The caller can discover this time window with this call.
- Returns
- the size of the alarm data change window.
References AlarmDataChangeWindow.
◆ GetAlarmDefinition()
int GetAlarmDefinition |
( |
char * |
eqm, |
|
|
UINT32 |
code, |
|
|
ADS * |
ads |
|
) |
| |
Gets the alarm definition for the alarm code specified.
- Parameters
-
eqm | (input) is the 6-character local equipment identifier name, which is internal to server. |
code | (input) is the alarm code for which the alarm definition is desired. |
ads | (output) is a pointer reference to an alarm definition structure (ADS) to be filled in upon successful completion. |
- Returns
- 0 upon success, otherwise a TINE error code.
References invalid_parameter.
◆ GetAlarmHeartbeat()
int GetAlarmHeartbeat |
( |
void |
| ) |
|
Gets the size of the heartbeat alarm window in seconds before the 'heartbeat' flag is applied to an alarm.
A server flags an alarm with a heartbeat when it has persistent in the local alarm list for a time span equal to this window. Default is 1200 seconds. The caller can discover this time window with this call.
- Parameters
-
timeInSeconds | is the size of the heartbeat window. |
References AlarmHeartbeat.
◆ GetAlarmOscillationWindow()
int GetAlarmOscillationWindow |
( |
void |
| ) |
|
Gets the size of the alarm oscillation window in clear counts.
A call to a member of the ClearAlarm() family will increment the alarm's clear counter. Typically ClearAlarm() is always called at the beginning of an i/o loop and SetAlarm() is called if warranted according to alarm conditions later in the same loop. If the clear counter has reached the current oscillation window setting, the alarm is then marked for termination and removal. If the clear counter has been incremented by more than a single count AND a SetAlarm() is then called, the alarm is marked as 'oscillating' as it appears to the alarm sub system that the alarm conditions are not persistent by appear to come and go. The oscillation window is by default set to 8 counts. As a terminated alarm will nonetheless reside in the local alarm tables for a time equal to the current termination window (default = 30 seconds) the oscillation window will automatically 'grow' if an alarm has been marked as terminated but reappears within the termination window. The maximum oscillation window will however not exceed 128 (corresponding to approximately 2 minutes, assuming a 1 Hz i/o loop is in play).
- Returns
- the size of the alarm oscillation window. (default = 8).
- See also
- SetAlarmOscillationWindow()
◆ GetAlarmTableMaximumSize()
int GetAlarmTableMaximumSize |
( |
void |
| ) |
|
Gets the maximum number of alarms managed by the local alarm server.
A server keeps a maximum number of alarms in its local table at one time before it begins to discard the older alarms. The caller can retrieve this number with this call. Default is 500.
- Returns
- the maximum number of alarms to be maintained in the local alarm table.
References MaxNumberAlarms.
◆ GetAlarmTerminationWindow()
int GetAlarmTerminationWindow |
( |
void |
| ) |
|
Gets the size of the termination window in seconds before a terminated alarm is discarded from the local alarm list.
A server keeps keeps a terminated alarm in its list (marked as terminated) for a length of time specified by the termination window. This allows the central alarm server and/or other interested parties enough time to discover that the alarm has been terminated. Default is 4 seconds. The caller can discover this time window with this call.
- Returns
- the size of the termination window.
References TerminationWindow.
◆ GetAllowOfflineAlarms()
int GetAllowOfflineAlarms |
( |
void |
| ) |
|
Gets the local alarm server setting to allow or disallow alarms for devices declared offline.
- Returns
- the current setting (DEFAULT = FALSE)
◆ GetNewAlarmWindow()
int GetNewAlarmWindow |
( |
void |
| ) |
|
Gets the size of the new alarm window in seconds before a new alarm is no longer declared as new.
A server flags an alarm as new when it first appears in its list. After a short time span, the 'new' flag is removed by additional calls to SetAlarm for the same alarm. Default is 3 seconds. The caller can discover this time window with this call.
- Returns
- the size of the new alarm window.
References AlarmWindow.
◆ RemoveAlarm()
void RemoveAlarm |
( |
char * |
eqm, |
|
|
int |
devNr, |
|
|
UINT32 |
code |
|
) |
| |
Instructs the local alarm server table that the given alarm is to be marked for removal.
A server can remove alarms for specific device by giving its device number.
Note that only the alarm specified for the device specified is removed. Also note, that "removing" an alarm means that termination bit will be set. It is subsequently marked for removal from the local alarm list. For further information, please see the discussion of the local alarm server.
- Parameters
-
eqm | is the 6-character local equipment identifier name, which is internal to server. |
devNr | is the device number of the device for which all alarms is to be removed. |
code | is the alarm code, which identifies the specific alarm to be removed |
◆ RemoveDeviceAlarm()
void RemoveDeviceAlarm |
( |
char * |
eqm, |
|
|
char * |
devname, |
|
|
UINT32 |
code |
|
) |
| |
Instructs the local alarm server table that the given alarm is to be marked for removal.
A server can remove alarms for specific device by giving its registered device name.
Note that only the alarm specified for the device specified is removed. Also note, that "removing" an alarm means that termination bit will be set. It is subsequently marked for removal from the local alarm list. For further information, please see the discussion of the local alarm server.
- Parameters
-
eqm | is the 6-character local equipment identifier name, which is internal to server. |
devname | is the registered device name of the device for which all alarms is to be removed. |
code | is the alarm code, which identifies the specific alarm to be removed |
References GetDeviceNumber().
◆ SetAlarm()
int SetAlarm |
( |
char * |
eqm, |
|
|
int |
devNr, |
|
|
UINT32 |
almCode, |
|
|
BYTE * |
almData |
|
) |
| |
Inserts an alarm into the local alarm server table.
A server can set an alarm for a specific device by giving its device number.
For further information, please see the discussion of the local alarm server.
- Parameters
-
eqm | is the 6-character local equipment identifier name, which is internal to server. |
devNr | is the device number of the device for which the alarm is to be set. |
almCode | is the registered alarm code which defines the alarm |
almData | is (up to 64-byte) the optional alarm data set, which supplies additional information for the alarm. |
- Returns
- 0 upon success, otherwise a TINE error code.
if ((cc=
SetAlarm(
"EQP1",1,512,NULL)) != 0)
{
feclog(
"Couldn’t set alarm : %s\n",erlst[cc]);
}
References SetAlarmEx().
◆ SetAlarmCodeOscillationWindow()
int SetAlarmCodeOscillationWindow |
( |
const char * |
eqm, |
|
|
int |
code, |
|
|
int |
value |
|
) |
| |
Sets the size of the alarm oscillation window in clear counts.
A call to a member of the ClearAlarm() family will increment the alarm's clear counter. Typically ClearAlarm() is always called at the beginning of an i/o loop and SetAlarm() is called if warranted according to alarm conditions later in the same loop. If the clear counter has reached the current oscillation window setting, the alarm is then marked for termination and removal. If the clear counter has been incremented by more than a single count AND a SetAlarm() is then called, the alarm is marked as 'oscillating' as it appears to the alarm sub system that the alarm conditions are not persistent by appear to come and go. The oscillation window is by default set to 8 counts. As a terminated alarm will nonetheless reside in the local alarm tables for a time equal to the current termination window (default = 30 seconds) the oscillation window will automatically 'grow' if an alarm has been marked as terminated but reappears within the termination window. The maximum oscillation window will however not exceed 128 (corresponding to approximately 2 minutes, assuming a 1 Hz i/o loop is in play). A call to this routine will not only fix the alarm oscillation window but 'pin' it to the value given (i.e. so that it will not automatically grow).
Unlike SetAlarmOscillationWindow(), this routine can be used to apply an oscillation window to a specific alarm code, without affecting the behavior of other alarm types.
- Parameters
-
eqm | is the 6-character local equipment identifier name, which is internal to server. |
code | is the alarm code for which the oscillation window is to be applied |
clearCounts | is the size of the alarm oscillation window. (default = 8). |
- Note
- calling this routine will pin the oscillation window to the given setting so that the value will not 'grow' following the re-setting of a terminated alarm.
- See also
- SetAlarmOscillationWindow(), GetAlarmCodeOscillationWindow()
◆ SetAlarmCollapseWindow()
int SetAlarmCollapseWindow |
( |
int |
value | ) |
|
Sets the size of the alarm collapse window in counts.
At any given time the prevailing alarm conditions might give rise to an 'alarm storm', where an unusally large number of alarms are seen (due to e.g. hardware modules that are turned off during a shutdown). Such alarms are generally 'not interesting' and should not create extra network traffic, resource allocation, archiving, etc. if this can be avoided. As such, if the number of alarms for a given equipment module exceeds the current 'alarm collapse window' setting, the alarm information will be 'compressed' to a single alarm indicating that there are 'more than' the collapse window number of alarms. The value of the collapse window can be set via this call.
- Parameters
-
value | is the size of the alarm collapse window. (default = 100). |
- Note
- the alarm collapse window is applied to ALL alarms independent of alarm code or device.
- See also
- GetAlarmCollapseWindow()
References feclog(), and out_of_range.
◆ SetAlarmDataChangeWindow()
void SetAlarmDataChangeWindow |
( |
int |
timeInSeconds | ) |
|
Sets the size of the alarm datachange window in seconds.
When an alarm provides alarm data with the appropriate SetAlarm() call, the alarm will be tagged with the 'DATACHANGE' flag if the supplied data differ from that provided with the previous call to SetAlarm(). The alarm timestamp will be adjusted to the current time ONLY if the data change is seen outside of the current AlarmDataChangeWindow (in seconds). The value of the alarm timestamp is relevant in the acquisition of the existing alarm table by the central alarm server. If this window is too short and the alarm data is constantly changing this can result in very long 'alarm chains' to display and archive. Default is 30 seconds. The caller can discover this time window with this call.
- Parameters
-
timeInSeconds | is the size of the alarm data change window. (default = 30). |
References AlarmDataChangeWindow.
◆ SetAlarmEx()
int SetAlarmEx |
( |
char * |
eqm, |
|
|
int |
devNr, |
|
|
UINT32 |
almCode, |
|
|
BYTE * |
almData, |
|
|
BYTE |
almFlags |
|
) |
| |
Inserts an alarm into the local alarm server table.
This is the extended call corresponding to SetAlarm(), the difference being the additional argument �flags� which can be used to set the alarm descriptor. A server can set an alarm for a specific device by giving its device number.
For further information, please see the discussion of the local alarm server.
- Parameters
-
eqm | is the 6-character local equipment identifier name, which is internal to server. |
devNr | is the device number of the device for which the alarm is to be set. |
almCode | is the registered alarm code which defines the alarm |
almData | is (up to 64-byte) the optional alarm data set, which supplies additional information for the alarm. |
almFlags | is the optional alarm flag which is used in the alarm descriptor information. |
- Returns
- 0 upon success, otherwise a TINE error code.
if ((cc=
SetAlarmEx(
"EQP1",1,512,NULL,almNEW)) != 0)
{
feclog(
"Couldn’t set alarm : %s\n",erlst[cc]);
}
Referenced by SetAlarm().
◆ SetAlarmHeartbeat()
void SetAlarmHeartbeat |
( |
int |
timeInSeconds | ) |
|
Sets the size of the heartbeat alarm window in seconds before the 'heartbeat' flag is applied to an alarm.
A server flags an alarm with a heartbeat when it has persistent in the local alarm list for a time span equal to this window. Default is 1200 seconds. The caller can set this window with this call.
- Parameters
-
timeInSeconds | is the size of the heartbeat window. |
References AlarmHeartbeat.
◆ SetAlarmOscillationWindow()
int SetAlarmOscillationWindow |
( |
int |
clearCounts | ) |
|
Sets the size of the alarm oscillation window in clear counts.
A call to a member of the ClearAlarm() family will increment the alarm's clear counter. Typically ClearAlarm() is always called at the beginning of an i/o loop and SetAlarm() is called if warranted according to alarm conditions later in the same loop. If the clear counter has reached the current oscillation window setting, the alarm is then marked for termination and removal. If the clear counter has been incremented by more than a single count AND a SetAlarm() is then called, the alarm is marked as 'oscillating' as it appears to the alarm sub system that the alarm conditions are not persistent by appear to come and go. The oscillation window is by default set to 8 counts. As a terminated alarm will nonetheless reside in the local alarm tables for a time equal to the current termination window (default = 30 seconds) the oscillation window will automatically 'grow' if an alarm has been marked as terminated but reappears within the termination window. The maximum oscillation window will however not exceed 128 (corresponding to approximately 2 minutes, assuming a 1 Hz i/o loop is in play). A call to this routine will not only fix the alarm oscillation window but 'pin' it to the value given (i.e. so that it will not automatically grow).
- Parameters
-
clearCounts | is the size of the alarm oscillation window. (default = 8). |
- Note
- calling this routine will pin the oscillation window to the given setting so that the value will not 'grow' following the re-setting of a terminated alarm.
-
the alarm oscillation window is applied to ALL alarms independent of alarm code or device. Once called, this will effectively 'pin' the alarm oscillation value for all alarm types to this value. Applying an oscillation window to a specific alarm can be achieved by calling SetAlarmCodeOscillationWindow();
- See also
- GetAlarmOscillationWindow(), SetAlarmCodeOscillationWindow()
References out_of_range.
◆ SetAlarmTableMaximumSize()
void SetAlarmTableMaximumSize |
( |
int |
tableSize | ) |
|
Sets the maximum number of alarms managed by the local alarm server.
A server keeps a maximum number of alarms in its local table at one time before it begins to discard the older alarms. The caller can adjust this number with this call. Default is 500.
- Parameters
-
tableSize | is the maximum number of alarms to be maintained in the local alarm table. |
References MaxNumberAlarms.
◆ SetAlarmTerminationWindow()
void SetAlarmTerminationWindow |
( |
int |
timeInSeconds | ) |
|
Sets the size of the termination window in seconds before a terminated alarm is discarded from the local alarm list.
A server keeps keeps a terminated alarm in its list (marked as terminated) for a length of time specified by the termination window. This allows the central alarm server and/or other interested parties enough time to discover that the alarm has been terminated. The caller can set this window with this call.
- Parameters
-
timeInSeconds | is the size of the termination window. (Default: 30) |
References TerminationWindow.
◆ SetAllowOfflineAlarms()
void SetAllowOfflineAlarms |
( |
int |
value | ) |
|
Instructs the local alarm server to allow or disallow alarms for devices declared offline.
- Parameters
-
value | is the desired setting (DEFAULT = FALSE) |
◆ SetAvailableMemoryThreshold()
void SetAvailableMemoryThreshold |
( |
UINT32 |
minAvailBytes | ) |
|
Sets the threshold (in bytes) used in setting 'low main memory' alarms.
A server can set automatic 'low_main_memory' alarms by setting this threshold to a positive non-zero number. (default = 0).
- Parameters
-
minAvailBytes | gives the minimum number of bytes which should be available main memory before an alarm in is issued. |
◆ SetDeviceAlarm()
int SetDeviceAlarm |
( |
char * |
eqm, |
|
|
char * |
devname, |
|
|
UINT32 |
almCode, |
|
|
BYTE * |
almData, |
|
|
BYTE |
almFlags |
|
) |
| |
Inserts an alarm into the local alarm server table.
Analogous to SetAlarmEx(), this call inserts alarms into the local alarm server table. A server can set an alarm for a specific device by giving its device name. This is sometime preferred over specifying its device number as in SetAlarm() or SetAlarmEx(). For further information, please see the discussion of the local alarm server.
- Parameters
-
eqm | is the 6-character local equipment identifier name, which is internal to server. |
devname | is the registered device name of the device for which the alarm is to be set. |
almCode | is the registered alarm code which defines the alarm |
almData | is (up to 64-byte) the optional alarm data set, which supplies additional information for the alarm. |
almFlags | is the optional alarm flag which is used in the alarm descriptor information. |
- Returns
- 0 upon success, otherwise a TINE error code.
{
feclog(
"Couldn’t set alarm : %s\n",erlst[cc]);
}
◆ SetFreeBlocksAlarmThreshold()
int SetFreeBlocksAlarmThreshold |
( |
char * |
path, |
|
|
UINT32 |
minFreeBlocks |
|
) |
| |
Sets the threshold (in blocks) used in setting 'low disk space' alarms.
A server can set automatic 'low_disk_space' alarms by setting this threshold to a positive non-zero number for the disk path in question.
(default = 0).
- Parameters
-
path | gives a path defining a disk mount to be monitored |
minFreeBlocks | gives the minimum number of (1-Kbyte) blocks which should be available before an alarm is issued. |
- Returns
- 0 upon success of a tine error code (resources_exhausted if an attempt to monitor more than 10 disks is attempted.
- Note
- This routine is only available for those operating systems with disks!
Example
◆ SetNewAlarmWindow()
void SetNewAlarmWindow |
( |
int |
timeInSeconds | ) |
|
Sets the size of the new alarm window in seconds before a new alarm is no longer declared as new.
A server flags an alarm as new when it first appears in its list. After a short time span, the 'new' flag is removed by additional calls to SetAlarm for the same alarm. Default is 3 seconds. The caller can set this window with this call.
- Parameters
-
timeInSeconds | is the size of the new alarm window. |
References AlarmWindow.
◆ AlarmDataChangeWindow
int AlarmDataChangeWindow = DEFAULT_ALARM_DATACHANGE_WINDOW |
Determines the minimum time a data change alarm is to keep its timestamp in the local alarm table.
Alarms supplying data can be updating the alarm data quite often. Each change of alarm data will be represented in the alarm itself. However the timestamp of the alarm will not be updated unless a time interval larger than the AlarmDataChangeWindow has occured.
Default: 30 sec
Example:
AlarmDataChangeWindow = 40; // make the data change window a bit longer
Referenced by GetAlarmDataChangeWindow(), and SetAlarmDataChangeWindow().
◆ AlarmHeartbeat
int AlarmHeartbeat = DEFAULT_ALARM_HEARTBEAT |
Determines the time interval at the 'HEARTBEAT' flag will be re-issued for persistent alarms.
The purpose of an alarm is to alert operators or maintenance staff to a problem.
If an alarm persists and is not dealt with, its timestamp is adjusted to the current time at intervals given by the AlarmHeartbeat value. This will call attention to the alarm. It also places the alarm at regular intervals in an archive of alarms. The developer can set this to any desired value (usually at initialization time).
Default: 1200 sec
Example:
AlarmHeartbeat = 3600; // heartbeat once per hour
Referenced by GetAlarmHeartbeat(), and SetAlarmHeartbeat().
◆ AlarmInstantWindow
int AlarmInstantWindow = DEFAULT_INSTANT_WINDOW |
Determines the minimum time an alarm is to remain in the local alarm table before it can be removed.
Transient alarms (with no duration) are immediately marked for termination as soon as they are set. The AlarmInstantWindow determines the amount of time in seconds an "Instant" Alarm is to remain in the alarm list (default 4 seconds).
Default: 30 sec
Example:
AlarmInstantWindow = 40; // keep transient alarms in the table a bit longer
◆ AlarmTestState
Determines the minimum time an alarm is to remain in the local alarm table before it can be removed.
When developing the alarm logic for a particular server is frequently useful to mark the alarms being set with the almTEST bit. This can either be done on an individual basis using the SetAlarmEx() call, or one can set the global variable AlarmTestState to a non-zero value.
Default: FALSE
Example:
AlarmTestState = TRUE; // just testing ...
◆ AlarmWindow
int AlarmWindow = DEFAULT_ALARM_WINDOW |
Determines the minimum time an alarm is to remain in the local alarm table before it can be removed.
IO routines can sometimes set and clear alarms at such a high frequency that an alarm could go unnoticed if it appeared and disappeared before a client had a chance to read it. The AlarmWindow value determines the amount of time (in seconds) an alarm must remain in the local alarm list before it can be removed. The default is 3 seconds, which is generally fine for a central alarm reader polling at 1 second intervals.
Default: 3 sec
Example:
AlarmWindow = 10; // keep alarms in the table a bit longer
Referenced by GetNewAlarmWindow(), and SetNewAlarmWindow().
◆ MaxNumberAlarms
int MaxNumberAlarms = MAXALARMS |
Determines the maximum number of alarms which can be maintained in the local alarm server's alarm list.
Each registered device can have an associated alarm link list. The length of this list will not exceed the value entered for MaxNumAlarms (default 100). The default is generally more than enough. Primarily this variable serves as a safety valve against sudden alarm avalanches.
Default: 100
Example:
MaxNumberAlarms = 500;
Referenced by GetAlarmTableMaximumSize(), and SetAlarmTableMaximumSize().
◆ TerminationWindow
int TerminationWindow = DEFAULT_TERMINATION_WINDOW |
Determines the minimum time an expired alarm is to remain in the local alarm table.
Terminated alarms remain in the local alarm table for an amount of time specified by this variable. Thus a client monitoring the local alarm list will be able tosee that the alarm was set and has finished.
Default: 30 sec
Example:
TerminationWindow = 40; // keep terminated alarms in the table a bit longer
Referenced by GetAlarmTerminationWindow(), and SetAlarmTerminationWindow().
void SetDefaultTransportMode(int value)
Sets the default TINE transport mode used in client-side links.
Definition: client.c:107
short EqmNumProperties
Definition: srvcore.h:1805
GrpMember * GetGroupMemberList(GrpTblEntry *grp)
Returns a linked list of the group members for the callback group supplied.
Definition: client.c:1078
char fltr[256]
Definition: almlib.h:392
Defines a TINE sextuple data object containing an 80-character fixed-length string followed by a long...
Definition: tinetype.h:777
int RegisterCycleTriggerFunction(CYCBFCNP fcn, char *eqm, char *prpLst, void *reference)
Registers a cycle trigger callback dispatch function.
Definition: client.c:6726
SINT32 pollingRate
Definition: srvcore.h:2489
int SetBurstLimit(int npackets)
Sets the burst limit in number of packets which are allowed to be set consecutively.
Definition: syslib.c:5954
@ hardware_busy
Definition: errors.h:96
@ tcp_connection_closed
Definition: errors.h:274
SINT32 i2val
Definition: tinetype.h:616
void SetAllowBackgroundTaskReentrancy(int value)
Determines whether equipment module background tasks may be re-entered (boolean).
Definition: srvdbase.c:9431
UINT16 * memidx
Definition: hstlib.h:110
char name[16]
Definition: tinetype.h:244
char prpName[PROPERTY_NAME_SIZE]
Definition: tinetype.h:4103
int GetServerIdleState(char *eqm)
Gets the server's idle state.
Definition: syslib.c:5232
SINT32 i2val
Definition: tinetype.h:600
int GetLinkCallbackDelay(int linkId)
Gets the client-side callback notification.
Definition: client.c:10382
Defines a TINE 64-character fixed-length string data object.
Definition: tinetype.h:272
double GetCurrentDataTimeStampFromCallbackId(int id)
Returns the data timestamp associated with the callback identifier supplied.
Definition: client.c:9849
float rngMinValue
Definition: tinetype.h:4121
int GetAlarmCodeOscillationWindow(const char *eqm, int code)
Gets the size of the alarm oscillation window in clear counts.
Definition: Alarm API Calls:2472
int GetAccessLockInformation(char *context, char *server, NAME32 *callerName, NAME32 *callerIp, NAME32 *timeLeft)
Acquires access lock information from the server specified.
Definition: client.c:10342
double d1val
Definition: tinetype.h:391
int FindNameServerOnNetwork()
Issues a multicast (or broadcast) to which the TINE equipment name server responds.
Definition: srvdbase.c:7478
UINT16 GetTransferFlagFromCallbackId(int id)
Gets the data transfer flag for the give callback identifier.
Definition: client.c:10019
SINT32 tm
Definition: tinetype.h:732
void SetRespondToServiceRequests(int value)
Establishes whether a server can respond to multicast queries for its address.
int SetDeviceRegion(char *eqm, char *devname, char *region)
Assigns a region code to the device in question.
Definition: srvdbase.c:8027
@ name_unknown
Definition: errors.h:141
MXHANDLE hEqmBusyMutex
Definition: srvcore.h:1851
char EqmName[EQM_NAME_SIZE]
Definition: srvcore.h:1787
UINT16 prpArrayType
Definition: tinetype.h:4125
@ not_posted
Definition: errors.h:181
char * cptr
Definition: tinetype.h:974
Defines the definitive (non-legacy) property query structure.
Definition: tinetype.h:4101
void SetLinkQueueDepth(int linkId, int depth)
Sets the client-side receive queue depth for the link in question.
Definition: client.c:10371
int UnlockEquipmentModules(void)
Unlocks all equipment modules.
Definition: syslib.c:6082
Defines a TINE quintet data object containing a long integer value followed by a float triplet follow...
Definition: tinetype.h:712
void SetDieAnotherDay(int value)
Revokes an 'exit' due to a 'die on' condition.
Definition: syslib.c:217
int GetLastStoredData(char *eqm, char *prp, char *dev, int index, BYTE *data, int fmt, int len)
Retreives the last stored data set from disk for the given input parameters.
Definition: hstlib.c:4724
AMSDynSet amsDynSet
Definition: srvcore.h:1816
int depthShort
Definition: hstlib.h:191
double GetCurrentDataTimeStamp(int i)
Returns the data timestamp associated with the input link index.
Definition: client.c:9844
Defines a TINE sextuple data object containing an 80-character fixed-length string followed by a long...
Definition: tinetype.h:752
double GetGlobalsTimeStampFromCallbackId(int id)
Returns the timestamp of the globals keyword with the given link callback ID.
Definition: client.c:9922
int lowarnsev
Definition: almlib.h:372
Defines a TINE septuple data object containing an 80-character fixed-length string followed by a long...
Definition: tinetype.h:798
@ un_allocated
Definition: errors.h:89
short adsTableSize
Definition: srvcore.h:1814
void SetUseMultiThreadedEquipmentFunctions(int value)
Determines whether an equipment module equipment function can run in a separate threads (boolean).
Definition: syslib.c:2742
SCCBFCNP staChgCb
Definition: srvcore.h:1840
int srvlog(char *filename, char *tag, char *text,...)
Puts entries into a named log file.
Definition: syslib.c:5700
UINT32 prpNumOverloads
Definition: tinetype.h:4113
float rngMaxValue
Definition: XPropertyQueryStruct.txt:13
int GetLastGlobalDataSize(int id)
Returns the most recent data size of the global link index supplied.
Definition: client.c:9927
Defines a TINE pairwise data object containing a 64-character fixed-length string followed by a 4-byt...
Definition: tinetype.h:331
ExportDeviceType * EqmDevLst
Definition: srvcore.h:1803
int RedirectProperty(char *eqm, char *property, char *rdr)
Applies the redirection string to the given property.
Definition: srvdbase.c:8653
@ software_error
Definition: errors.h:195
@ runtime_error
Definition: errors.h:94
void SetUseStandardHistoryFiles(int value)
Instructs the server to use the so-called 'standard' set of local history files.
Definition: hstlib.c:308
int AppendAlarmWatchTable(char *eqm, char *prp, char *dev, int siz, int fmt, int atyp, int sev, int sys, ALM_THRESHOLDS *thr)
Inserts a property to be monitored into the local alarm server's Watch Table.
Definition: Alarm API Calls:2238
int region
Definition: srvcore.h:1754
double min
Definition: tinetype.h:667
@ illegal_command
Definition: errors.h:164
int ResubmitDataLink(int id)
Resubmits a (CM_SINGLE) data link.
Definition: client.c:9782
int AlarmInstantWindow
Determines the minimum time an alarm is to remain in the local alarm table before it can be removed.
Definition: Alarm API Calls:68
int GetDefaultDeviceRegion(char *eqmName)
Returns the default device region.
Definition: srvdbase.c:292
void SetSystemDataStamp(int value)
Sets the global system data stamp with which to tag outbound data sets.
Definition: syslib.c:6546
@ out_of_server_memory
Definition: errors.h:162
int _SystemAssignBufferSpaceEx(UINT32 clnRcvBufferSpace, UINT32 srvRcvBufferSpace, UINT32 clnSndBufferSpace, UINT32 srvSndBufferSpace)
Assigns specific buffer capacity for certain configurable TINE sockets (extended version).
Definition: iplib.c:685
int SetAlarm(char *eqm, int devNr, UINT32 almCode, BYTE *almData)
Inserts an alarm into the local alarm server table.
Definition: Alarm API Calls:2411
@ reacquire_address
Definition: errors.h:168
@ mcast_init_error
Definition: errors.h:231
NAME64 * followers
Definition: srvcore.h:1822
Defines an extended property query structure (legacy)
Definition: XPropertyQueryStruct.txt:1
float y
Definition: tinetype.h:415
int RegisterPropertyAlias(char *eqm, char *property, char *alias)
Assigns an alias to the specified property.
Definition: srvdbase.c:8249
void SetSuppressHeartbeatNotification(int value)
Determines whether CM_DATACHANGE data links signal incoming data by calling the corresonding callback...
Definition: client.c:10024
SINT32 * usrstamp
Definition: hstlib.h:109
@ illegal_delimiter
Definition: errors.h:81
void SetEnforceMcaAcquisition(int value)
Forces multi-channel array handshaking if set to TRUE.
Definition: srvdbase.c:9407
float s_start
Definition: tinetype.h:826
int AppendAlarmInfoTable(char *eqm, ADS *ads)
Inserts an alarm definition into the alarm definition table.
Definition: Alarm API Calls:2175
int GetEnforceMcaAcquisition(void)
returns the setting for multi-channel array handshaking enforcement.
Definition: srvdbase.c:9411
@ already_assigned
Definition: errors.h:229
int GetRejectOverloadedMetaProperties(void)
returns the current setting
Definition: srvdbase.c:9291
void SystemStartCycleTimer(void)
Starts a TINE engine 'cycler' running (SystemCycle()) in a separate thread.
Definition: tine32.c:243
int GetContractListCapacity(void)
Gets the maximum number of contracts a server will service.
Definition: srvdbase.c:7243
int RegisterStateChangeCallback(SCCBFCNP fcn, const char *eqm, const char *stateKey, void *reference)
Registers a state change callback dispatch function.
Definition: srvdbase.c:7233
int RegisterFecInformation(char *name, char *sub, char *cntxt, char *dsc, char *loc, char *hdw, char *resp, UINT16 poff)
Assigns a FEC Name and descriptive information to the server process.
Definition: srvdbase.c:8204
int heartbeat
Definition: hstlib.h:86
BYTE prpGraphType
Definition: tinetype.h:4058
int IsServerRunning(void)
Returns TRUE (non zero) if the server kernel is fully initialized and ready.
Definition: syslib.c:6554
void ** GetContractDataReference(ExportListStruct *el)
returns a pointer to a useable reference pointer associated with the contract currently being accesse...
Definition: srvdbase.c:7608
float aTolerance
Definition: hstlib.h:195
int GetDeviceNumber(char *eqm, char *devname)
Gives the registered device number for the specified device name.
Definition: srvdbase.c:7752
int RegisterServer(char *expName, int numdevices, char *deviceNameList[])
Registers an internal equipment module with the TINE server engine An internal equipment module is pr...
Definition: srvdbase.c:6906
int SetCycleMicroDelay(int usecs)
Sets the delay time in microseconds following a 'burst' of ethernet packets (as defined by SetBurstLi...
Definition: syslib.c:5975
float prpMinValue
Definition: tinetype.h:4048
@ illegal_read_write
Definition: errors.h:161
DUNION data
Definition: tinetype.h:1006
int SetServerThreadPriority(int priority)
Determines the priority of the server cycle thread as well as other associated server-side threads.
Definition: syslib.c:4195
int GetClientThreadPriority(void)
Returns the priority of the client cycle thread as well as other associated client-side threads.
Definition: syslib.c:4207
@ connection_timeout
Definition: errors.h:188
@ function_deprecated
Definition: errors.h:154
int lastArchiveSts
Definition: hstlib.h:102
char * GetLastLinkError(short cc, char *errstr)
The error string associated with the input error number.
Definition: client.c:9974
int GetAutoLinkErrorAlarms(void)
Gets the current setting of the autoLinkErrorAlarms flag.
Definition: client.c:10494
Defines a TINE quintet data object containing a long integer value followed by a float doublet follow...
Definition: tinetype.h:695
int storeSummary
Definition: hstlib.h:97
int SetCycleDelay(int msecs)
Sets the delay time in milliseconds following a 'burst' of ethernet packets (as defined by SetBurstLi...
Definition: syslib.c:5965
int ModifyLinkAttributes(int i, short access, int pollingRate, void(*cbFcn)(int, int), int mode, UINT32 cbId)
Allows the caller to assign new link attributes to an active link.
Definition: client.c:10387
describes the fields within the named bitfield
char name[32]
Definition: tinetype.h:254
@ header_not_found
Definition: errors.h:166
@ system_error
Definition: errors.h:95
@ parsing_error
Definition: errors.h:157
int GetSystemRequireAcknowledgments(void)
Gets the require acknowledgments flag to the value given.
Definition: syslib.c:6542
@ invalid_index
Definition: errors.h:149
int hasDataPool
Definition: hstlib.h:98
@ address_unresolved
Definition: errors.h:138
@ out_of_tolerance
Definition: errors.h:282
CONTRACT c
Definition: hstlib.h:79
@ illegal_protocol
Definition: errors.h:184
int RemoveProperty(char *eqm, char *property)
Removes a property name from an equipment module's property list.
Definition: srvdbase.c:8638
int hiwarnsev
Definition: almlib.h:489
void SetUseMultiThreadedBackgroundTasks(int value)
Determines whether equipment module background tasks are to run in separate threads (boolean).
Definition: syslib.c:2733
int GetAlarmOscillationWindow(void)
Gets the size of the alarm oscillation window in clear counts.
Definition: Alarm API Calls:2458
int GetCycleMicroDelay(void)
Gets the delay time in microseconds following a 'burst' of ethernet packets (as defined by SetBurstLi...
Definition: syslib.c:5987
struct ExportListTag * next
Definition: srvcore.h:1871
BYTE prpFormat
Definition: tinetype.h:4030
UINT32 SystemGetProcessId(void)
Returns the process id of the running application if available.
Definition: srvdbase.c:342
int GetForceSharedMemory(void)
returns the current setting of this feature.
double MakeDataTimeStamp(void)
Returns a data timestamp according to the current system time.
Definition: syslib.c:5934
void SetGlobalsHeartbeat(int value)
sets the heartbeat (in seconds) during which time no 'timeout' messages will be sent to a globals dis...
Definition: client.c:10328
int PollExternalDescriptor(SOCKET s, int events)
registers an external socket to the server's poll set
@ semaphore_busy
Definition: errors.h:174
int netsScanFlag
Definition: srvcore.h:1865
BYTE prpAccess
Definition: tinetype.h:4031
int AttachLinkEx(const char *devName, const char *devProperty, DTYPE *dout, DTYPE *din, short access, int pollingRate, void(*cbFcn)(int, int), int mode, UINT32 cbId)
Initiates an asynchronous link.
Definition: client.c:9267
char EqmGroup[EXPORT_NAME_SIZE]
Definition: srvcore.h:1789
int GetBitfieldAsString(char *srv, char *tag, UINT32 value, char *strbuf, int buflen)
Retrieves the requested field value from a bit field as a string value.
Definition: srvdbase.c:9215
int GetAlarmTerminationWindow(void)
Gets the size of the termination window in seconds before a terminated alarm is discarded from the lo...
Definition: Alarm API Calls:2355
int gStartupDebug
Determines whether server initialization messages are displayed or not.
Definition: syslib.c:111
int GetSubscriptionRenewalThreshold(int linkId, int *thresholdInPercent)
Gets the current client-side subscription threshold for the link in question.
Definition: client.c:2991
Defines a TINE quadruplet data object containing a long integer doublet followed by a float doublet.
Definition: tinetype.h:625
int _SystemAssignUdpSendBufferSpace(UINT32 sndBufferSpace)
Assigns explicit udp send buffer capacity.
Definition: iplib.c:674
int ApplyHistoryFilter(int idx, char *parsableFilterString)
Applies a history filter to an existing local history record.
Definition: hstlib.c:4390
char comment[80]
Definition: tinetype.h:800
int LastCompletionDataType
Supplies the data type of the most recent link.
Definition: client.c:478
short registered
Definition: srvcore.h:1809
int GetLastGlobalDataSizeFromCallbackId(int id)
Returns the most recent data size of the global link callback id supplied.
Definition: client.c:9933
short xferReason
Definition: tinetype.h:1000
char context[32]
Definition: tinetype.h:191
int GetAlarmCollapseWindow(void)
Gets the size of the alarm collapse window in counts.
Definition: Alarm API Calls:2486
int feclog(char *text,...)
Puts entries into a server's FEC log file.
Definition: syslib.c:5666
NAME64 * GetExportedDeviceList(char *eqm)
Returns the list of exported device names explicitly associated with the equipment module passed as t...
Definition: srvdbase.c:7687
@ driver_not_installed
Definition: errors.h:171
@ device_error
Definition: errors.h:238
void _SystemStop(int exitOnFree)
Free all system resources and optionally exit.
Definition: syslib.c:6089
Defines a TINE triplet data object containing a 64-character fixed-length string value followed by a ...
Definition: tinetype.h:494
int codeHigh
Definition: almlib.h:500
SINT32 * lptr
Definition: tinetype.h:979
int depthDays
Definition: hstlib.h:84
@ link_not_open
Definition: errors.h:128
void SetAllowRemoteManagement(int value)
Determines whether remote management via stock properties is possible.
Definition: srvdbase.c:9303
int GetRegisteredUsers(const char *eqm, NAME16 *userlist, int *listsize)
retrieves the currently assigned users with WRITE permissions on the equipment module in question.
Definition: srvdbase.c:1248
struct DeviceInfoStruct DeviceInfoStruct
int SetScanForUsersFiles(const char *eqm)
Instructs the initialization process to look for device and property specific 'users' files.
Definition: srvdbase.c:2045
void SetServerTransportCeiling(int value)
Sets the server-side transport ceiling (in bytes) which gives the maximum transport size for supporte...
Definition: server.c:174
int GetTcpConnectionTableSize(void)
returns the current setting of the tcp connection table size.
int MaxNumClients
Determines the maximum number of clients a server will service.
Definition: srvdbase.c:7090
int SetSubscriptionRenewalThreshold(int linkId, int thresholdInPercent)
Gets the current client-side subscription threshold for the link in question.
Definition: client.c:2976
int SetSystemAlias(char *alias, char *name)
Sets an alias for either a registered property or registered device.
Definition: srvdbase.c:9439
int GetGlobalsSystemStamp(int glbId)
Gets the system data stamp with which the incoming globals data set has been tagged.
Definition: client.c:9992
SINT32 ival
Definition: tinetype.h:378
int GetSystemStampDelay(void)
Returns the registered system cycle delay.
Definition: client.c:6777
int recvNetGlobalEx(const char *keyword, DTYPE *dout, void(*cbFcn)(int, int), UINT32 cbId)
Initiates a net globals data link (extended call).
Definition: client.c:10299
char name[48]
Definition: tinetype.h:321
Defines a TINE pairwise data object containing a 16-character fixed-length string followed by a 4-byt...
Definition: tinetype.h:295
int SetMCastTTL(int ttl)
Sets the TINE multicast Time-To-Live.
Definition: iplib.c:402
float prpMinValue
Definition: tinetype.h:4109
int _SystemReset(int level)
Flushes all entry tables and returns all counters and semaphores to their initial state.
Definition: syslib.c:6236
@ unauthorised_action
Definition: errors.h:113
char rmvFileName[32]
Definition: hstlib.h:106
@ not_initialized
Definition: errors.h:248
NAME64 * EqmWcPrpLst
Definition: srvcore.h:1802
int useMonthlyHistoryFiles
Instructs the local history server to keep monthly archive files instead of daily files.
Definition: hstlib.c:244
UINT16 rowSize
Definition: XPropertyQueryStruct.txt:17
void SystemWaitCycleTimer(void)
Waits for the TINE engine 'cycler' thread to stop running.
Definition: tine32.c:237
void SetDieFunction(DIEFCNP fcn)
Sets a dispatch routine to call if and when the FEC process dies due to e.g. 'address in use'.
Definition: syslib.c:223
int GetCycleMicroDelay(void)
Gets the delay time in microseconds following a 'burst' of ethernet packets (as defined by SetBurstLi...
Definition: syslib.c:5987
int SetServerThreadPriority(int priority)
Determines the priority of the server cycle thread as well as other associated server-side threads.
Definition: syslib.c:4195
int SetAlarmEx(char *eqm, int devNr, UINT32 almCode, BYTE *almData, BYTE flags)
Inserts an alarm into the local alarm server table.
Definition: Alarm API Calls:2415
int cntThreshold
Definition: almlib.h:377
int GetSystemSubscriptionRenewalLength(void)
Gets the current contract subscription renewal length.
Definition: srvdbase.c:9370
@ name_server_unknown
Definition: errors.h:245
int GetDeviceGroups(char *eqm, NAME64 *groups, int *len)
Gets a NAME64 list of registered device groups.
Definition: srvdbase.c:8055
@ address_unknown
Definition: errors.h:140
int CloseLink(int linkId)
Cancels an active data link.
Definition: client.c:9461
void SetDieOnAddressInUse(int value)
Determines whether a server will exit() if an 'address in use' message is delivered by the ENS upon r...
Definition: syslib.c:208
int SetClientThreadPriority(int priority)
Determines the priority of the client cycle thread as well as other associated client-side threads.
Definition: syslib.c:4203
TImageFrameHeader frameHeader
Definition: tinetype.h:927
void SetUseMultiThreadedBackgroundTasks(int value)
Determines whether equipment module background tasks are to run in separate threads (boolean).
Definition: syslib.c:2733
int SetPropertySubscriptionRenewalLength(char *eqm, char *prpName, int value)
Sets the current subscription renewal length for the property specified.
Definition: srvdbase.c:3927
@ max_alarms_exceeded
Definition: errors.h:207
struct ExportListTag ExportListStruct
Linked list structure used to hold equipment module information.
@ at_limit
Definition: errors.h:210
UINT16 numRows
Definition: XPropertyQueryStruct.txt:16
int RegisterPropertyInformation(char *eqm, char *prp, DTYPE *dout, DTYPE *din, short acc, short atype, UINT16 rowlen, char *dsc, int pid, char *rdr)
Assigns pertinent information for the specified property.
Definition: srvdbase.c:8632
float f1val
Definition: tinetype.h:683
double timeSent
Definition: tinetype.h:197
char * GetSystemVersionString(void)
Returns the system version appended with the library build id as a character string.
Definition: srvdbase.c:5262
Definition: srvcore.h:1745
Defines a TINE 32-character fixed-length string data object.
Definition: tinetype.h:252
char * GetHistoryFilesRepository(void)
Returns the directory location where local history files are maintained.
Definition: hstlib.c:210
short GetCompletionSourceFromCallbackId(int id)
Returns the error source associated with the callback identifier supplied.
Definition: client.c:9838
@ information_static
Definition: errors.h:268
double PutDataTimeStamp(double toffset, time_t tsec, int tmsec)
Returns a data timestamp according to the input parameters given.
Definition: syslib.c:5938
int capacity
Definition: hstlib.h:69
SINT32 i3val
Definition: tinetype.h:601
Defines a TINE triplet data object containing a float value followed by a long integer doublet.
Definition: tinetype.h:521
int GetRespondToServiceRequests(void)
Returns whether a server can respond to multicast queries for its address.
Defines a TINE mapped data object corresponding to a doocs GSPECTRUM.
Definition: tinetype.h:821
@ has_bitfield_tag
Definition: errors.h:253
float s_start
Definition: tinetype.h:781
int AlarmWindow
Determines the minimum time an alarm is to remain in the local alarm table before it can be removed.
Definition: Alarm API Calls:66
int RegisterPropertyAndHandlerEx(char *eqm, XEQMFCNP hndlr, char *prp, DTYPE *dout, DTYPE *din, short acc, short atype, UINT16 rowlen, char *dsc, PrpEgu *egu, PrpEgu *xegu, int pid, void *ref)
Registers a device property and a property handler with the TINE server engine (extended call)....
Definition: srvdbase.c:6871
int GetDieOnSocketError(void)
Returns the current setting for this feature.
Definition: syslib.c:231
void * EqmRef
Definition: srvcore.h:1857
float range
Definition: hstlib.h:89
int FeclogDepth
Determines the approximate size of the server's log file in lines.
Definition: syslib.c:5508
@ invalid_property
Definition: errors.h:139
int GetCycleDelay(void)
Gets the delay time in milliseconds following a 'burst' of ethernet packets (as defined by SetBurstLi...
Definition: syslib.c:5971
void SetAllowRemoteDebugging(int value)
enables/disables remote debugging
char * GetCompletionStatus(int i)
Returns the error string associated with the input link index.
Definition: client.c:9806
int GetRegisteredPropertyList(char *eqm, NAME64 *prpNames, int *nprps)
Returns the list of registered properties explicitly associated with the equipment module passed as t...
Definition: srvdbase.c:5827
HashXRefStruct ** EqmDevXRef
Definition: srvcore.h:1804
int failoverState
Definition: srvcore.h:1867
@ remitted_data_lost
Definition: errors.h:130
@ reset_mca_property
Definition: errors.h:269
@ operation_busy
Definition: errors.h:187
SINT32 i2val
Definition: tinetype.h:351
UINT16 prpArrayType
Definition: XPropertyQueryStruct.txt:18
struct ClnInfoStruct ClnInfo
Client Information Structure used in GetCallerInformation.
SINT32 ival
Definition: tinetype.h:298
SINT32 tm
Definition: tinetype.h:755
int SetNumberDataOutputBuffers(int value)
sets the number of allocated buffers to use in contract access of a a registered property.
Definition: server.c:468
void SetStreamTransportRetryLimit(int value)
Sets the stream transport retry limit.
Definition: syslib.c:4576
@ out_of_client_memory
Definition: errors.h:136
int ReassignLinkData(int id, void *buffer, UINT32 length)
Reassigns the bound data buffer for the link table id given.
Definition: client.c:5368
int GetBackgroundThreadPriority(void)
Returns the priority of the registered background threads.
Definition: syslib.c:4215
char EqmGroupDevPostfix[XFIX_SIZE]
Definition: srvcore.h:1791
Defines a TINE triplet data object containing a double triplet.
Definition: tinetype.h:585
Used to reflect the doocs THUMBNAIL type for summarized archive data.
Definition: tinetype.h:662
char * GetFecHome(void)
Gets the current setting for the fec home database repository.
Definition: syslib.c:5909
BYTE prpAccess
Definition: tinetype.h:4118
BYTE * GetPropertyBuffer(char *eqmName, char *prpName)
Returns the address of the buffer previously assigned to the property given.
Definition: srvdbase.c:3945
short hasRegisteredDevicesNames
Definition: srvcore.h:1800
void SetFeclogDepth(int value)
Determines the approximate size of the server's log file in lines.
Definition: syslib.c:5509
@ link_error
Definition: errors.h:151
int normalIsAlarm
Definition: almlib.h:498
@ not_running
Definition: errors.h:179
void * vptr
Definition: tinetype.h:973
short ncontracts
Definition: srvcore.h:1819
Defines a TINE 16-character fixed-length string data object.
Definition: tinetype.h:242
@ no_file_space
Definition: errors.h:127
int cnt
Definition: almlib.h:376
UINT32 frameBufferSize
Definition: tinetype.h:928
int RegisterErrorCode(int code, char *msgShort, char *msgLong)
Registers the error code given and associates with the given message strings.
int dStamp
Definition: tinetype.h:1001
int SetDeviceLocation(char *eqm, char *devname, char *location)
Assigns a device location text to the specified device.
Definition: srvdbase.c:7984
void SystemWaitCycleTimer(void)
Waits for the TINE engine 'cycler' thread to stop running.
Definition: tine32.c:237
char * SystemGetStartupDirectory(void)
Returns the working directory in use when this process started.
Definition: srvdbase.c:329
int hiwarnsev
Definition: almlib.h:370
UINT32 starttime
Definition: srvcore.h:2490
void ** GetContractDataReference(ExportListStruct *el)
returns a pointer to a useable reference pointer associated with the contract currently being accesse...
Definition: srvdbase.c:7608
int GetGroupDeviceMembers(char *eqm, char *grpname, NAME64 *members, int *len)
Gets the NAME64 list of member devices associated with the given group.
Definition: srvdbase.c:8076
int RegisterMultiChannelGroupDevice(char *eqm, char *grpname, char *devname, int grpindex, int grpsize)
Assigns a device name to the specified multi-channel group device.
Definition: srvdbase.c:8034
int FindServerOnNetwork(char *context, char *eqmName, char *exportName, FecAddrStruct *fec, ExpDataStruct *srv)
Issues a multicast (or broadcast) to which configured TINE central servers respond.
Definition: srvdbase.c:6764
int GetBurstLimit(void)
Gets the burst limit in number of packets which are allowed to be sent consecutively.
Definition: syslib.c:5961
int archiveRate
Definition: hstlib.h:149
@ udp_socket_error
Definition: errors.h:225
int GetFieldFromBitfield(char *srv, char *tag, char *field, UINT32 value)
Retrieves the requested field value from a bit field.
Definition: srvdbase.c:9232
@ link_exists
Definition: errors.h:206
Defines a TINE pairwise data object containing a 48-character fixed-length string followed by a 4-byt...
Definition: tinetype.h:319
int AssignPropertyList(char *eqm, char *devname, char *listname, int listsize, NAME64 *list)
Assigns the given property list to the given device to be used in device-oriented queries.
Definition: srvdbase.c:7338
short almdone
Definition: srvcore.h:1831
UINT32 LastCompletionDataSize
Supplies the data size of the most recent link.
Definition: client.c:477
int SetSystemAttribute(char *attribute, void *value, int format)
Definition: srvdbase.c:9502
int RegisteredPropertyIsWritable(char *eqm, char *prpName)
Returns TRUE if the given property is registered with the CA_WRITE access bit (in at least one overlo...
Definition: srvdbase.c:6392
@ illegal_device_number
Definition: errors.h:116
int CloseGlobalLink(int linkId)
Closes an active globals data link.
Definition: client.c:9279
int GetMCastTTL(void)
Gets the TINE multicast Time-To-Live.
Definition: iplib.c:409
int losev
Definition: almlib.h:490
BYTE prpGraphType
Definition: tinetype.h:4119
int GetSchedulerInterval(void)
Gets the system scheduler interval.
Definition: srvdbase.c:9328
Multi-Dimension array aXis.
Definition: tinetype.h:1023
void SetAppDate(time_t appdate)
Sets the compilation date of the current running server process.
Definition: srvdbase.c:8913
void SetForceSharedMemory(int value)
Disables or enables the 'useLoopBack' flag according to the value given (boolean).
double timeLogged
Definition: tinetype.h:198
int GetGlobalsDataStamp(int glbId)
Gets the data stamp with which the incoming globals data set has been tagged.
Definition: client.c:10008
@ mutex_error
Definition: errors.h:226
@ server_name_in_use
Definition: errors.h:133
void SetInitializeIdle(int value)
When set to TRUE, all equipment modules are initialized in an 'idle' state.
Definition: srvdbase.c:244
char logger[32]
Definition: tinetype.h:193
UINT16 numRows
Definition: tinetype.h:4123
UINT8 * bptr
Definition: tinetype.h:976
ExportPropertyListStruct * GetPropertyListStruct(char *eqm, char *prpName, char *devName)
Definition: srvdbase.c:5540
PrpRedirBlk * prd
Definition: hstlib.h:111
@ tcp_socket_error
Definition: errors.h:201
@ device_not_connected
Definition: errors.h:112
int GetCompletionDataSizeFromCallbackId(int id)
Returns the most recent data size of the link associated with the callback id supplied.
Definition: client.c:9770
int siz
Definition: almlib.h:364
@ gpib_error
Definition: errors.h:185
TErrorList
Definition: errors.h:74
void _SystemDelay(int msec)
Blocks any activity inside a TINE task or equipment modules for the specified amount of time.
Definition: syslib.c:6054
int _SystemSchedulePropertyEx(char *eqm, char *prp, int scope)
Schedules the given property for immediate delivery to all attached clients according scope specified...
Definition: syslib.c:6331
@ get_subscription_id
Definition: errors.h:211
double * dptr
Definition: tinetype.h:988
int GetConnectionList(char *lstbuf, int bufsize)
Gets the current connection table.
Definition: client.c:630
int SetKernelPriority(int priority)
Determines the priority of TINE kernel threads.
Definition: syslib.c:4219
char * ResolveSystemAlias(char *alias)
Gets the registered property or registered device name for the given alias.
Definition: srvdbase.c:9447
float fval
Definition: tinetype.h:523
int GetRetardSingleContractRemoval(void)
returns the current setting of this feature.
Definition: srvdbase.c:9427
Defines a TINE triplet data object containing a set of three long integer values.
Definition: tinetype.h:569
int GetAlarmDataChangeWindow(void)
Gets the size of the alarm datachange window in seconds.
Definition: Alarm API Calls:2357
int SetStandAlone(int value)
Sets stand-alone mode.
Definition: srvdbase.c:252
int hisev
Definition: almlib.h:488
float pTolerance
Definition: hstlib.h:153
float hi
Definition: almlib.h:492
SINT32 i1val
Definition: tinetype.h:524
float d_spect_array[SPECTRUM_STD_SIZE]
Definition: tinetype.h:759
char EqmAlias[EQM_NAME_SIZE]
Definition: srvcore.h:1788
@ invalid_field
Definition: errors.h:230
Defines a TINE quad data object containing a 64-character fixed-length string value followed by a dou...
Definition: tinetype.h:507
SINT32 i1val
Definition: tinetype.h:627
int GetNumContracts(char *eqm)
Returns the current number of contracts associated with the equipment module given.
Definition: srvdbase.c:7756
int RegisterUserFunction(char *name, int(*fcn)(int argc, char *argv[]))
Registers a user-defined function which can be accessed via the TINE command line interpreter.
Definition: ttycmd.c:2011
UINT32 normal
Definition: almlib.h:375
@ out_of_shared_memory
Definition: errors.h:147
char dTag[TAG_NAME_SIZE]
Definition: tinetype.h:1005
short region
Definition: srvcore.h:1810
@ not_defined
Definition: errors.h:192
@ host_not_resolved
Definition: errors.h:199
int GetDataStamp(int linkId)
Gets the data stamp with which the incoming data set has been tagged.
Definition: client.c:9998
int datacmp(BYTE *d1, BYTE *d2, int siz, int fmt, double t)
Definition: syslib.c:1434
int GetSystemSubscriptionRenewalLength(void)
Gets the current contract subscription renewal length.
Definition: srvdbase.c:9370
@ non_existent_fec
Definition: errors.h:176
char text[256]
Definition: tinetype.h:194
int GetSuspendCallbacks(void)
returns the suspends asynchronous callback notification setting
Definition: client.c:4995
float fval
Definition: tinetype.h:430
int GetSizeDeviceCapacity(char *eqm)
Gives the maximum size of the device table associated with the equiment module name given.
Definition: srvdbase.c:6403
int AppendAlarmInfoTableEx(char *eqm, ADS *ads, char *filterString)
Inserts an alarm definition into the alarm definition table. The extended call accepts a parseable fi...
Definition: Alarm API Calls:2179
@ syntax_error
Definition: errors.h:124
float f1val
Definition: tinetype.h:715
int GetMinimumAllowedPollingInterval(void)
returns the minimum polling rate in milliseconds a server will allow.
Definition: srvdbase.c:9403
int GetLinkQueueDepth(int linkId)
Gets the client-side receive queue depth for the link in question.
Definition: client.c:9749
int PutLnkErrorValue(int i, void *errValue)
Flags a link so that the given error value is used as the data value in case of any link error.
Definition: client.c:2536
@ device_busy
Definition: errors.h:240
short tineProtocol
Definition: srvcore.h:2496
int IsStandAlone(void)
Determines whether a client or server process is running in stand-alone mode.
Definition: srvdbase.c:248
@ non_existent_elem
Definition: errors.h:175
void SetAlwaysRetry(int value)
Sets the 'Always Retry' flag to the value given.
Definition: client.c:10312
int codeLowWarn
Definition: almlib.h:503
CRS EqmCrs
Definition: srvcore.h:1846
int GetUseCycleTrigger(void)
Returns whether a server listens for a CycleNumber trigger from a CYCLER.
Definition: server.c:170
@ is_terminating
Definition: errors.h:244
@ has_query_function
Definition: errors.h:221
EQMTSKP eqmBkg
Definition: srvcore.h:1825
SINT32 i2val
Definition: tinetype.h:447
int SetMCastAddr(char *addr)
Sets the cannonical multicast address the server will use when requested to send payloads via multica...
Definition: iplib.c:305
void SetRunTransportInSeparateThread(int value)
Determines whether the (tcp) transport is run in its own thread (boolean).
UINT16 prpHistoryDepthLong
Definition: tinetype.h:4115
int depthLong
Definition: hstlib.h:83
SINT32 i1val
Definition: tinetype.h:538
BYTE prpGraphType
Definition: XPropertyQueryStruct.txt:26
int ExecLocalLink(const char *devName, const char *devProperty, DTYPE *dout, DTYPE *din, short access)
Executes a synchronous link within the local process.
Definition: srvdbase.c:7380
char * GetFecLogPath(void)
Gets the current setting for the fec log repository.
Definition: syslib.c:5905
float f1val
Definition: tinetype.h:698
char netsFileName[32]
Definition: srvcore.h:1861
int ServerIsInitialized(const char *eqm)
Determines whether the server has initialized;.
Definition: server.c:292
UINT32 status
Definition: tinetype.h:828
int GetGlobalDataType(int id)
Returns the data type of global link index supplied.
Definition: client.c:9939
float zpos
Definition: srvcore.h:1752
int useStandardSet
Definition: hstlib.h:95
int SetBackgroundThreadPriority(int priority)
Determines the priority of any registered background threads.
Definition: syslib.c:4211
void SetSystemSynchronizeContracts(int value)
Establishes the setting for general contract synchronization at the server.
Definition: srvdbase.c:9415
int GetIgnoreCommonFiles(void)
returns the current setting (default = FALSE)
Definition: srvdbase.c:2114
char * GetDeviceLocation(char *eqm, int devnr)
Gives the registered device location (if known) for the device number.
Definition: srvdbase.c:7652
void SetMaximumHistoryTableRecords(int value)
Sets the maximum local history table size.
Definition: hstlib.c:239
@ file_not_open
Definition: errors.h:283
void SetSystemCleanupFunction(SYSTSKP fcn)
Sets a user-specific cleanup routine to be executed as a final step during a normal cleanup phase (e....
Definition: syslib.c:6124
char * GetCompletionStatusFromCallbackId(int id)
Returns the error string associated with the callback identifier supplied.
Definition: client.c:9828
@ not_registered
Definition: errors.h:257
short capfollowers
Definition: srvcore.h:1821
int GetServerThreadPriority(void)
Returns the priority of the server cycle thread as well as other associated server-side threads.
Definition: syslib.c:4199
@ tcp_not_supported
Definition: errors.h:197
int SetPropertySubscriptionRenewalLength(char *eqm, char *prpName, int value)
Sets the current subscription renewal length for the property specified.
Definition: srvdbase.c:3927
void SetSystemSubscriptionRenewalLength(int value)
Sets the contract subscription renewal length.
Definition: srvdbase.c:9357
@ not_supported
Definition: errors.h:155
@ thread_error
Definition: errors.h:243
ExportPropertyListStruct * GetPropertyListStruct(char *eqm, char *prpName, char *devName)
Definition: srvdbase.c:5540
int RemoveRegisteredNetsList(const char *eqm, NAME64 *ipaddr, int rmvsiz)
removes those networks in the name list given from the current network address access list.
Definition: srvdbase.c:1203
int GetDeviceNumberEx(char *eqm, char *devname, char *prpname)
Gives the registered device number for the specified device name and property name.
Definition: srvdbase.c:7706
UINT16 reserved1
Definition: srvcore.h:2488
char userName[USERNAME_SIZE]
Definition: srvcore.h:2493
float prpMaxValue
Definition: XPropertyQueryStruct.txt:11
int SetPropertyBuffer(char *eqmName, char *prpName, BYTE *buffer)
Assigns a fixed buffer to handle output data for the given property.
Definition: srvdbase.c:3982
char name[64]
Definition: tinetype.h:496
int hisev
Definition: almlib.h:369
int AttachLink(const char *devName, const char *devProperty, DTYPE *dout, DTYPE *din, short access, int pollingRate, void(*cbFcn)(int, int), int mode)
Initiates an asynchronous link.
Definition: client.c:9273
SINT32 tm
Definition: tinetype.h:825
void SetPreSystemInitFunction(SYSTSKP fcn)
Sets a user-specific initialization routine to be executed prior to server initialization.
Definition: syslib.c:6116
float prpMaxValue
Definition: tinetype.h:4110
char eqm[EQM_NAME_SIZE]
Definition: almlib.h:361
@ not_locked
Definition: errors.h:254
int SetNameServerAddress(char *ens)
Sets the address of the Equipment Name Server via API call.
Definition: srvdbase.c:8924
void SetRedirectionParameters(char *eqm, char *rdrCnt, char *rdrSrv, char *rdrDev, char *rdrPrp)
Sets the redirection string to accompany the current server call.
Definition: srvdbase.c:8970
SINT32 status
Definition: tinetype.h:804
int heartbeat
Definition: hstlib.h:152
@ profibus_error
Definition: errors.h:251
int status
Definition: tinetype.h:196
void SetDefaultDeviceRegion(char *eqmName, char *region)
Sets the default device region to the value specified.
Definition: srvdbase.c:286
GrpTblEntry * GetCallbackGroup(size_t id)
Returns a reference to the callback Group Table Entry associated with the identifier supplied.
Definition: client.c:1070
@ work_area_full
Definition: errors.h:83
MDX axis[MAX_MDA_DIMS]
Definition: tinetype.h:1044
UINT32 GetWorkAreaSize(void)
Gets the server-side work area size which is coupled to the maximum transport size for supported by a...
Definition: syslib.c:6001
short GetCompletionSource(int i)
Returns the error source associated with the input link index.
Definition: client.c:9821
@ not_owner
Definition: errors.h:190
double d1val
Definition: tinetype.h:497
SINT32 tm
Definition: tinetype.h:801
float pTolerance
Definition: hstlib.h:87
void SetPointsOfInterestRangeFactor(float value)
Sets the definitive property range (maximum-minimum) factor which determines whether a value is consi...
Definition: hstlib.c:1639
void SetSystemRequireAcknowledgments(int value)
Sets the require acknowledgments flag to the value given.
Definition: syslib.c:6538
double d1val
Definition: tinetype.h:472
Defines an Alarm Watch List Query Structure for stock property queries.
Definition: almlib.h:359
int depthLong
Definition: hstlib.h:192
void SetLogFileAllowScan(int value)
Sets the allowed range of log file retrieval from a FEC process (via stock property SRVLOGFILE).
Definition: srvdbase.c:9314
history record structure used in stock properties
Definition: hstlib.h:142
FilterLink * fltr
Definition: hstlib.h:114
GrpMember * GetGroupMemberList(GrpTblEntry *grp)
Returns a linked list of the group members for the callback group supplied.
Definition: client.c:1078
char * GetDataTimeString(double ts, int useLongStringFormat)
Returns the TINE data timestamp as a human-readable string.
Definition: syslib.c:5759
int SetFreeBlocksAlarmThreshold(char *path, UINT32 minFreeBlocks)
Sets the threshold (in blocks) used in setting 'low disk space' alarms.
Definition: Alarm API Calls:303
UINT16 prpHistoryDepthLong
Definition: tinetype.h:4054
UINT16 counter
Definition: srvcore.h:2491
SINT32 i1val
Definition: tinetype.h:615
int fmt
Definition: tinetype.h:1043
@ invalid_value
Definition: errors.h:237
@ not_implemented
Definition: errors.h:120
int LockEquipmentModules(void)
Locks all equipment modules.
Definition: syslib.c:6075
int SetCycleMicroDelay(int usecs)
Sets the delay time in microseconds following a 'burst' of ethernet packets (as defined by SetBurstLi...
Definition: syslib.c:5975
int RegisterPropertySignalFunction(const char *eqm, const char *prp, PRPSIG fcn, int mask, void *ref)
Registers a property signal function.
Definition: srvdbase.c:7205
@ invalid_data
Definition: errors.h:194
float lo
Definition: almlib.h:494
int SetCallPropertyInSeparateThread(char *eqm, char *property, int value)
Determines whether the specified property is called in a separate handler thread or not.
Definition: srvdbase.c:8718
@ no_such_column
Definition: errors.h:134
int SetBackgroundThreadPriority(int priority)
Determines the priority of any registered background threads.
Definition: syslib.c:4211
@ non_existent_client
Definition: errors.h:177
void SetAllowDependentLinks(int value)
turns the ability to manage identical (dependent) links ON or OFF
Definition: client.c:118
void SetUseCycleTrigger(int value)
Establishes whether a server listens for a CycleNumber trigger from a CYCLER.
Definition: server.c:165
@ access_denied
Definition: errors.h:196
@ value_too_low
Definition: errors.h:216
int GetCompletionDataSize(int i)
Returns the most recent data size of the link index supplied.
Definition: client.c:9755
float hi
Definition: almlib.h:378
@ hardware_error
Definition: errors.h:114
UINT32 mask
Definition: srvcore.h:1753
int hasReference
Definition: srvcore.h:1856
int GetClientListCapacity(void)
Gets the maximum number of clients a server will service.
Definition: srvdbase.c:7253
int GetCallerInformation(char *eqm, ClnInfo *clnInfoList, int *num)
Returns the user name, network address and other information of all callers interested in the current...
Definition: srvdbase.c:7552
int AppendHistoryInformationEx(char *eqm, char *prp, char *dev, int len, int fmt, int idx, HistorySpecification *hspec, int hstFlags)
Inserts a local history element into the local history server.
Definition: hstlib.c:4433
void * GetLinkCallbackReference(int id)
Returns the supplied callback reference for the link ID in question.
Definition: client.c:9912
int GetUseMultiThreadedStockFunctions(void)
Returns whether stock propery calls can run in a separate threads (boolean).
Definition: syslib.c:2755
float s_inc
Definition: tinetype.h:782
SINT32 i4val
Definition: tinetype.h:602
void SetSynchronizationTolerance(double toleranceInSeconds)
Sets the tolerance used in deciding whether to apply a timestamp offset or not.
Definition: client.c:10485
int SetDeviceAlarm(char *eqm, char *devname, UINT32 almCode, BYTE *almData, BYTE flags)
Inserts an alarm into the local alarm server table.
Definition: Alarm API Calls:2426
int GetDieOnFecIsAlias(void)
Returns the current setting for this feature.
Definition: syslib.c:240
float aTolerance
Definition: hstlib.h:154
int GetAllowedRemoteManagement(void)
Returns whether remote management via stock properties is possible.
Definition: srvdbase.c:9309
int RegisterEquipmentModuleEx(char *expName, char *eqmName, int numdevices, int(*fcn)(char *, char *, DTYPE *, DTYPE *, short, void *), void(*ini)(void *), void(*tsk)(void *), int rate, void(*exi)(void *), void *reference)
Registers an equipment module with the TINE server engine (extended call)
Definition: srvdbase.c:8190
double * timestamp
Definition: hstlib.h:107
char usersFileName[32]
Definition: srvcore.h:1860
Defines a TINE pairwise data object containing a 4-byte integer doublet.
Definition: tinetype.h:348
@ resources_exhausted
Definition: errors.h:165
int GetGlobalLinkId(char *keyword)
retrieves the link ID for a globals link
Definition: client.c:7331
UINT32 prpSize
Definition: tinetype.h:4111
@ lock_expired
Definition: errors.h:255
SINT32 ival
Definition: tinetype.h:334
int GetDefaultTransportMode(void)
Gets the default TINE transport mode used in client-side links.
Definition: client.c:111
void SetClientListCapacity(int value)
Sets the maximum number of clients a server will service.
Definition: srvdbase.c:7257
@ struct_sealed
Definition: errors.h:122
UINT32 prpNumOverloads
Definition: tinetype.h:4079
int SystemRunning
Determines whether a server has been successfully initialized or not.
Definition: server.c:273
int heartbeat
Definition: hstlib.h:193
float s_start
Definition: tinetype.h:756
void SetLinkCallbackDelay(int linkId, int cyclesToDelay)
Sets a client-side callback notification.
Definition: client.c:10377
@ not_applicable
Definition: errors.h:261
@ zero_divide
Definition: errors.h:82
@ argument_list_error
Definition: errors.h:97
void SetAllowNetworkAddressResolution(int value)
Determines whether NETWORK address resolution is allowed.
Definition: srvdbase.c:9451
@ service_unavailable
Definition: errors.h:275
int UpdateDataStampsFromCallbackId(int id, DTYPE *dout)
Fills in the given DTYPE data object with all data stamp information.
Definition: client.c:9889
float lowarn
Definition: almlib.h:495
char EqmExportName[EXPORT_NAME_SIZE]
Definition: srvcore.h:1785
@ string_too_long
Definition: errors.h:105
@ name_already_exists
Definition: errors.h:228
int GetPropertySubscriptionRenewalLength(char *eqm, char *prpName, int *value)
Gets the current subscription renewal length for the property specified.
Definition: srvdbase.c:3937
int chkAcl
Definition: srvcore.h:1863
int isScheduled
Definition: hstlib.h:93
int failoverType
Definition: srvcore.h:1866
SINT32 i1val
Definition: tinetype.h:446
int GetRegisteredPropertyListStruct(char *eqm, char *prpName, ExportPropertyListStruct *prpLstStruct)
Returns the ExportPropertyListStruct structure for the registered property specified by the first two...
Definition: srvdbase.c:6384
int GetRegisteredNetworks(const char *eqm, NAME64 *list, int *listsize)
retrieves network list of ip addresses and subnets for which WRITE access is allowed
Definition: srvdbase.c:1220
@ is_switching
Definition: errors.h:209
void SetSystemSchedulePropertyLazy(int value)
Sets the 'lazy' flag for scheduling properties.
Definition: syslib.c:6323
BYTE prpFormatIn
Definition: tinetype.h:4117
@ memory_overwrite
Definition: errors.h:259
int SetConnectionTableCapacity(int value)
Sets the maximum number of entries in the connection table.
Definition: client.c:9054
int codeHigh
Definition: almlib.h:383
char * GetSystemAlias(char *name)
Gets the alias for either a registered property or registered device.
Definition: srvdbase.c:9443
double d3val
Definition: tinetype.h:589
@ use_stream_transport
Definition: errors.h:101
Defines a TINE History Specification object.
Definition: hstlib.h:187
char * GetMCastAddr(void)
Gets the cannonical multicast address a server will use when requested to send payloads via multicast...
Definition: iplib.c:309
@ has_structure_tag
Definition: errors.h:264
int FindServerOnNetwork(char *context, char *eqmName, char *exportName, FecAddrStruct *fec, ExpDataStruct *srv)
Issues a multicast (or broadcast) to which configured TINE central servers respond.
Definition: srvdbase.c:6764
int GetGCastTableCapacity(void)
gets the globals multicast table capacity (server-side)
Definition: srvdbase.c:9283
@ non_existent_function
Definition: errors.h:233
int SetAlarmCollapseWindow(int value)
Sets the size of the alarm collapse window in counts.
Definition: Alarm API Calls:2478
@ configuration_error
Definition: errors.h:203
UINT32 prpNumOverloads
Definition: tinetype.h:4052
int GetSystemSynchronizeContracts(void)
Returns the setting for general contract synchronization at the server.
Definition: srvdbase.c:9419
int GetDeviceOfflineStatus(char *eqm, int devnr)
Gives the current off line status for the device in question.
Definition: srvdbase.c:7671
SINT32 i1val
Definition: tinetype.h:571
void SetAvailableMemoryThreshold(UINT32 minAvailBytes)
Sets the threshold (in bytes) used in setting 'low main memory' alarms.
Definition: Alarm API Calls:275
void SetPostSystemInitFunction(SYSTSKP fcn)
Sets a user-specific initialization routine to be executed following server initialization.
Definition: syslib.c:6120
SINT32 ival
Definition: tinetype.h:431
int RegisterPropertyAccessDeadband(char *eqm, char *property, int access, int deadbandInMilliSeconds)
Assigns a minimum access deadband to the designated property.
Definition: srvdbase.c:8265
@ property_is_mca_elevated
Definition: errors.h:280
short ncontracts
Definition: srvcore.h:2495
short busycnt
Definition: srvcore.h:1834
@ invalid_structure_size
Definition: errors.h:249
Defines a TINE pairwise data object containing a double value followed by a 4-byte integer value.
Definition: tinetype.h:375
int SetClnUDPPort(int port)
Sets the TINE client UDP base port.
Definition: iplib.c:232
int SetDeviceOfflineStatus(char *eqm, char *devname, int offline)
Assigns an offline status to the specified device.
Definition: srvdbase.c:8010
int GetDataFromLinkId(int linkId, DTYPE *dout, UINT16 *status)
Supplies the DTYPE data object and call status for the link ID in question.
Definition: client.c:9894
int microsleep(int usecs)
sleep for given number of micro-seconds
Definition: syslib.c:1641
UINT16 reserved3
Definition: srvcore.h:2498
double GetSynchronizationTolerance(void)
Gets the tolerance used in deciding whether to apply a timestamp offset or not.
Definition: client.c:9980
int MaxNumContracts
Determines the maximum number of contracts a server will service.
Definition: srvdbase.c:7089
char prpName[32]
Definition: XPropertyQueryStruct.txt:3
SINT16 * sptr
Definition: tinetype.h:977
int code
Definition: almlib.h:499
char * GetGCastAddr(void)
Gets the cannonical globals multicast address the server will use when sending payloads via multicast...
Definition: iplib.c:394
BYTE * data
Definition: hstlib.h:112
int SetKernelPriority(int priority)
Determines the priority of TINE kernel threads.
Definition: syslib.c:4219
double d2val
Definition: tinetype.h:473
void SetHistoryFilesRepository(char *path)
Sets the directory location where local history files are maintained.
Definition: hstlib.c:201
SINT32 ival
Definition: tinetype.h:714
double ave
Definition: tinetype.h:664
Defines a TINE 48-character fixed-length string data object.
Definition: tinetype.h:262
@ tcp_connect_error
Definition: errors.h:200
@ call_redirection
Definition: errors.h:223
@ non_existent_property
Definition: errors.h:258
float max
Definition: tinetype.h:2380
BYTE prpFormat
Definition: XPropertyQueryStruct.txt:23
int GetNumberRegisteredDevices(char *eqm)
Gives the number of registered devices explicitly associated with the equiment module name given.
Definition: srvdbase.c:6397
int RedirectDeviceName(char *eqm, char *devname, char *rdr)
Applies the redirection string to the given device for all properties.
Definition: srvdbase.c:7941
Defines a TINE 8-character fixed-length string data object.
Definition: tinetype.h:232
float rngMinValue
Definition: XPropertyQueryStruct.txt:12
void SetSystemStampOffset(int cycleOffset)
Establishes a system cycle offset.
Definition: client.c:6764
Defines a TINE triplet data object containing a 16-character fixed-length string value followed by tw...
Definition: tinetype.h:443
int datacmp(BYTE *d1, BYTE *d2, int siz, int fmt, double t)
Definition: syslib.c:1434
int GetDefaultTransportMode(void)
Gets the default TINE transport mode used in client-side links.
Definition: client.c:111
BYTE prpFormat
Definition: tinetype.h:4055
char * GetMCastMask(char *pattern)
Gets the cannonical multicast address mask the server will use when requested to send payloads via mu...
Definition: iplib.c:369
int GetConnectionList(char *lstbuf, int bufsize)
Gets the current connection table.
Definition: client.c:630
EQMTSKP eqmExi
Definition: srvcore.h:1839
ExportListStruct * GetExportListItem(char *eqm)
Returns a reference to the Export List Structure of the given equipment module.
Definition: srvdbase.c:2920
float f2val
Definition: tinetype.h:630
int GetUseMultiThreadedStockFunctions(void)
Returns whether stock propery calls can run in a separate threads (boolean).
Definition: syslib.c:2755
int GetConfigurationCoded(void)
Returns whether TINE configuration files will be scanned.
Definition: srvdbase.c:240
BYTE * frameBuffer
Definition: tinetype.h:932
int GetServerCycleState(char *cycleStateString)
Returns the current server cycle state.
Definition: server.c:159
@ illegal_arithmetic
Definition: errors.h:79
Defines a TINE Alarm Watch Threshold object.
Definition: almlib.h:485
float f2val
Definition: tinetype.h:716
@ ipx_not_supported
Definition: errors.h:198
char EqmMaster[EXPORT_NAME_SIZE]
Definition: srvcore.h:1868
char * GetExportedContext(char *eqmName)
Returns the exported context associated with the equipment function name given.
Definition: srvdbase.c:262
@ link_blacklisted
Definition: errors.h:205
void SetSystemStampDelay(int cycleDelay)
Establishes the system cycle delay.
Definition: client.c:6772
struct timeval lastBkg
Definition: srvcore.h:1837
void SetUseLoopback(int value)
Sets the 'useLoopBack' flag to the value given (boolean).
char device[DEVICE_NAME_SIZE]
Definition: hstlib.h:145
@ illegal_property
Definition: errors.h:118
int AssignDeviceNetsList(const char *eqm, const char *dev, NAME64 *ipnets, int nipnets)
Assigns an ip nets access list for the device given.
Definition: srvdbase.c:7118
float GetDeviceZPosition(char *eqm, int devnr)
Gives the registered device Z (or longitudinal) position for the device number.
Definition: srvdbase.c:7679
double GetDataTimeStampOffset(void)
Returns a the current data timestamp offset as assigned by the TINE global time service.
Definition: syslib.c:1338
int AttachLinkEx2(const char *devName, const char *devProperty, DTYPE *dout, DTYPE *din, short access, int pollingRate, void(*cbFcn)(int, int, void *), int mode, UINT32 cbId, void *reference)
Initiates an asynchronous link.
Definition: client.c:9261
float * d_spect_array
Definition: tinetype.h:784
int AlarmTestState
Determines the minimum time an alarm is to remain in the local alarm table before it can be removed.
Definition: Alarm API Calls:73
void SetDieOnFecIsAlias(int value)
Determines whether a server will exit() if a 'FEC has an alias' message is delivered by the ENS upon ...
Definition: syslib.c:236
char * GetSystemAlias(char *name)
Gets the alias for either a registered property or registered device.
Definition: srvdbase.c:9443
int fmt
Definition: almlib.h:365
double d2val
Definition: tinetype.h:460
int GetNumCalls(char *eqm)
Returns the current number of calls to the given equipment module since startup.
Definition: srvdbase.c:7778
int RegisterProperty(char *eqm, char *property, int siz, short fmt, short acc, char *dsc)
Assigns pertinent information for the specified property.
Definition: srvdbase.c:8700
AccessLock accessLock
Definition: srvcore.h:1870
float f1val
Definition: tinetype.h:629
@ no_such_line
Definition: errors.h:90
float rngMaxValue
Definition: tinetype.h:4122
void SetPointsOfInterestToleranceFactor(float value)
Sets the definitive property tolerance factor which determines whether a value is consider a point of...
Definition: hstlib.c:1645
void SetDataTimeStamp(double ts)
Sets the intrinsic data timestamp to the value given.
Definition: syslib.c:5991
@ invalid_datarequest
Definition: errors.h:278
@ code_failure
Definition: errors.h:152
short nclients
Definition: srvcore.h:1818
@ invalid_mcast_group
Definition: errors.h:232
double GetGlobalsTimeStamp(int linkId)
Returns the timestamp of the globals keyword with the given link ID.
Definition: client.c:9917
@ invalid_link
Definition: errors.h:143
@ server_redirection
Definition: errors.h:214
double dTimeStamp
Definition: tinetype.h:1003
Defines a TINE triplet data object containing a 32-character fixed-length string value followed by a ...
Definition: tinetype.h:469
int _SystemInit(int chkcmd)
Required call for the TINE server engine to function property.
Definition: syslib.c:6128
int codeHighWarn
Definition: almlib.h:384
SINT32 status
Definition: tinetype.h:735
int pollingRate
Definition: hstlib.h:189
int keepPointsOfInterest
Definition: hstlib.h:94
int GetPutCommandsInFeclog(void)
Returns the current setting for putCommandsInFeclog (which determines whether all in-coming WRITE acc...
Definition: syslib.c:5504
char * GetGCastMask(char *addr)
Gets the cannonical multicast address mask the server will use when sending payloads via multicast as...
Definition: iplib.c:398
void SetUseMultiThreadedStockFunctions(int value)
Determines whether stock propery calls can run in a separate threads (boolean).
Definition: syslib.c:2751
void RemoveDeviceAlarm(char *eqm, char *devname, UINT32 code)
Instructs the local alarm server table that the given alarm is to be marked for removal.
Definition: Alarm API Calls:2398
EQMFCNP eqmFcn
Definition: srvcore.h:1824
int GetPacketMTU(void)
Gets the TINE UDP server packet MTU.
Definition: iplib.c:593
void ** GetContractDataReferenceByEqmName(char *eqm)
returns a pointer to a useable reference pointer associated with the contract currently being accesse...
Definition: srvdbase.c:7604
@ ambiguous
Definition: errors.h:80
char * GetExportedSubSystem(char *eqmName)
Returns the exported subsystem associated with the equipment function name given.
Definition: srvdbase.c:298
Defines a TINE quadruplet data object containing a long integer value followed by a float triplet.
Definition: tinetype.h:680
int GetMaxTcpMessageSize(void)
Gets the TINE server maximum STREAM message segment size.
Definition: iplib.c:1405
@ data_size_mismatch
Definition: errors.h:86
int GetUseMultiThreadedEquipmentFunctions(void)
Returns whether an equipment module equipment function can run in a separate threads (boolean).
Definition: syslib.c:2746
void SetSystemStampDelay(int cycleDelay)
Establishes the system cycle delay.
Definition: client.c:6772
int GetUseMCastLegacyRules(void)
Returns whether legacy mutlicast systematics are in effect or not.
Definition: iplib.c:141
Defines a TINE pairwise data object containing a pairwise float doublet.
Definition: tinetype.h:401
float prpMinValue
Definition: XPropertyQueryStruct.txt:10
@ not_accepted
Definition: errors.h:182
int GetSystemStampDelay(void)
Returns the registered system cycle delay.
Definition: client.c:6777
void SetSystemSubscriptionRenewalLength(int value)
Sets the contract subscription renewal length.
Definition: srvdbase.c:9357
void SetStandardSpillOverSize(int value)
Sets the amount of additional space (number of addition records) to allocate as a worst case when usi...
Definition: hstlib.c:247
Defines a TINE quadruplet data object containing four long integer values.
Definition: tinetype.h:597
double d2val
Definition: tinetype.h:498
short accessMode
Definition: srvcore.h:2487
int nRegionItems
Definition: srvcore.h:1811
int SetNotificationToleranceEx(int linkId, float toleranceAbsolute, float tolerancePercent, int offset, int length, int flags)
Allows the caller to apply a tolerance pertaining to link notification (extended call).
Definition: client.c:10453
int GetClnRecvQueueDepth(void)
Gets the default client-side receive queue depth for all client links.
Definition: client.c:9745
int RemoveDevice(char *eqm, char *devname)
Removes a device name from an equipment module's device list.
Definition: srvdbase.c:7848
int FreeAccessLock(char *context, char *server)
Frees an access lock on the server specified.
Definition: client.c:9725
@ invalid_transport_size
Definition: errors.h:109
int GetLastContractId(void)
Returns the last contract identifier.
Definition: syslib.c:6572
int AppendHistoryInformation(char *eqm, char *prp, char *dev, int len, int fmt, int idx, HistorySpecification *hspec)
Inserts a local history element into the local history server.
Definition: hstlib.c:4499
int GetAlarmDefinition(char *eqm, UINT32 code, ADS *ads)
Gets the alarm definition for the alarm code specified.
Definition: Alarm API Calls:1664
int SetFailoverSlave(char *eqm, char *masterName, char *slaveMaster)
Declares the server a failover slave and targets the designated server.
Definition: srvdbase.c:8109
DUNION data
Definition: tinetype.h:1045
float s_start
Definition: tinetype.h:802
char str[80]
Definition: tinetype.h:701
double d2val
Definition: tinetype.h:392
void SetAutoAdjustWorkAreaSize(int value)
Sets 'auto-adjust work area size' (based on number of registered properties)
Definition: srvdbase.c:490
int recvNetGlobalEx2(const char *keyword, DTYPE *dout, void(*cbFcn)(int, int, void *), UINT32 cbId, void *reference)
Initiates a net globals data link (doubly extended call).
Definition: client.c:10295
int codeHighWarn
Definition: almlib.h:501
void SetUseCycleTrigger(int value)
Establishes whether a server listens for a CycleNumber trigger from a CYCLER.
Definition: server.c:165
int recordIndex
Definition: hstlib.h:90
@ name_not_found
Definition: errors.h:281
void SetFailoverThreshold(int errorCounts)
Sets the server failover threshold to the value given.
Definition: srvdbase.c:4037
void SetSystemCleanupFunction(SYSTSKP fcn)
Sets a user-specific cleanup routine to be executed as a final step during a normal cleanup phase (e....
Definition: syslib.c:6124
float fval
Definition: tinetype.h:539
int atyp
Definition: almlib.h:366
@ device_offline
Definition: errors.h:276
@ shm_error
Definition: errors.h:273
float s_inc
Definition: tinetype.h:803
char * GetDeviceName(char *eqm, int devnr)
Gives the registered device name for the specified equipment module and device number.
Definition: srvdbase.c:7629
int AddFieldToBitField(char *srv, char *tag, UINT32 mask, char *field)
Adds a field definition to a registered bitfield.
Definition: srvdbase.c:9193
@ operation_timeout
Definition: errors.h:183
int exportId
Definition: srvcore.h:1794
int GetCatchConsoleBreak(void)
Returns the current setting for this feature.
Definition: syslib.c:203
char * GetLocalName(char *exportName)
Returns the local equipment module name associated with the export name given.
Definition: srvdbase.c:6441
int codeLow
Definition: almlib.h:502
@ lock_required
Definition: errors.h:247
int usersScanFlag
Definition: srvcore.h:1864
float min
Definition: tinetype.h:1029
@ warn_too_high
Definition: errors.h:217
void SetRejectOverloadedMetaProperties(int value)
Enables/Disables overloaded meta properties.
Definition: srvdbase.c:9287
int hasSavedFiles
Definition: hstlib.h:96
ExportPropertyListStruct * EqmPrpLst[PROPERTY_HASH_SIZE+1]
Definition: srvcore.h:1796
int GetServerWaiting(void)
Gets the server's waiting state.
Definition: syslib.c:5224
short dFormat
Definition: tinetype.h:999
int RegisterStateChangeCallback(SCCBFCNP fcn, const char *eqm, const char *stateKey, void *reference)
Registers a state change callback dispatch function.
Definition: srvdbase.c:7233
void SetSuspendCallbacks(int value)
set suspends asynchronous callback notification ON or OFF
Definition: client.c:4978
char EqmGroupDevPrefix[XFIX_SIZE]
Definition: srvcore.h:1790
UINT32 spectBufferSize
Definition: tinetype.h:805
char name[64]
Definition: tinetype.h:484
int recordCapacity
Definition: hstlib.h:100
void ** GetContractDataReferenceByEqmName(char *eqm)
returns a pointer to a useable reference pointer associated with the contract currently being accesse...
Definition: srvdbase.c:7604
void SetFailoverPollingInterval(int pollingInterval)
Sets the server failover interval to the value given.
Definition: srvdbase.c:4031
int gRequireAcknowledgments
Determines whether acknowledgements are expected following data changes where contracts use CM_DATACH...
Definition: server.c:118
double d1val
Definition: tinetype.h:587
char * GetDeviceDescription(char *eqm, int devnr)
Gives the registered device description (if known) for the device number.
Definition: srvdbase.c:7639
int AlarmDataChangeWindow
Determines the minimum time a data change alarm is to keep its timestamp in the local alarm table.
Definition: Alarm API Calls:69
int SetMCastAddrLegacy(char *addr)
Sets the cannonical legacy multicast address the server will use when where necessary.
Definition: iplib.c:313
UINT32 tMax
Definition: tinetype.h:669
char EqmSlaveMaster[EXPORT_NAME_SIZE]
Definition: srvcore.h:1869
short bkgbusy
Definition: srvcore.h:1828
int AcquireAndRegisterBitfield(const char *devName, char *tag)
Acquires the bitfield specified by the bitfield tag from the specified device server.
Definition: srvdbase.c:9189
UINT32 * ulptr
Definition: tinetype.h:980
int UnlockEquipmentModules(void)
Unlocks all equipment modules.
Definition: syslib.c:6082
int AssignPropertyAccessList(const char *eqm, const char *prp, NAME16 *users, int nusers)
Assigns an access list for the property given.
Definition: srvdbase.c:7147
int GetCurrentFailoverState(void)
Returns current master slave state of server.
Definition: srvdbase.c:4105
int SetFecLogPath(char *path)
Sets the fec log repository.
Definition: syslib.c:1867
int SetDeviceMask(char *eqm, char *devname, int mask)
Assigns a device mask to the specified device.
Definition: srvdbase.c:8003
int feclogEx(int logLevel, char *text,...)
Puts entries into a server's FEC log file and in error.log file if certain conditions match.
Definition: syslib.c:5621
int UnregisterCycleTriggerFunction(CYCBFCNP fcn, void *reference)
Unregisters a previously registered cycle trigger callback dispatch function.
Definition: client.c:6747
int GetNumberDataOutputBuffers(void)
gets the number of allocated buffers to use in contract access of a a registered property.
Definition: server.c:479
int GetDataStampFromCallbackId(int id)
Gets the global system data stamp with which the incoming data set has been tagged.
Definition: client.c:10003
double dval
Definition: tinetype.h:377
SINT32 status
Definition: tinetype.h:783
int SetSystemAttribute(char *attribute, void *value, int format)
Definition: srvdbase.c:9502
void FlushContractTable(void)
Flushes the current contract and client entry tables.
Definition: srvdbase.c:7264
short alarmSystem
Definition: srvcore.h:1815
SINT32 ival
Definition: tinetype.h:322
@ illegal_format
Definition: errors.h:78
float hiwarn
Definition: almlib.h:380
char * GetMCastAddrLegacy(void)
Gets the cannonical legacy multicast address a pre-release 4.5.2 server will use when requested to se...
Definition: iplib.c:318
int GetRunServerCycleInSeparateThread(void)
Returns whether the server cycle is run in its own thread (boolean).
int GetSystemStampOffset(void)
Returns the registered system cycle offset.
Definition: client.c:6768
Defines a TINE data object.
Definition: tinetype.h:996
int GetConnectionTableCapacity(void)
Gets the maximum number of entries allowed in the connection table.
Definition: client.c:9097
char * GetDataTimeStringEx(double ts, int useLongStringFormat, char *tsstr)
Returns the TINE data timestamp as a human-readable string.
Definition: syslib.c:5764
@ no_data_in_range
Definition: errors.h:88
int GetInetAddress(SCKADR *sckadr, char *addr)
Gets the address (ip address and port) of the given socket address as a string.
Definition: iplib.c:2666
void SetServerTransportCeiling(int value)
Sets the server-side transport ceiling (in bytes) which gives the maximum transport size for supporte...
Definition: server.c:174
void SetPreSystemInitFunction(SYSTSKP fcn)
Sets a user-specific initialization routine to be executed prior to server initialization.
Definition: syslib.c:6116
int GetAlarmHeartbeat(void)
Gets the size of the heartbeat alarm window in seconds before the 'heartbeat' flag is applied to an a...
Definition: Alarm API Calls:2353
@ invalid_keyword
Definition: errors.h:142
float f2val
Definition: tinetype.h:643
int GetUseMultiThreadedBackgroundTasks(void)
Returns whether equipment module background tasks are to run in separate threads (boolean).
Definition: syslib.c:2737
void ClearAlarm(char *eqm, int devNr)
Instructs the local alarm server table that the given alarm is to be cleared.
Definition: Alarm API Calls:2314
Defines a TINE pairwise data object containing a float value followed by a 4-byte integer value.
Definition: tinetype.h:360
double lastAccessTime
Definition: hstlib.h:103
double d1val
Definition: tinetype.h:510
void SetAppVersion(int major, int minor, int revision)
Sets the application version of the current running server process.
Definition: srvdbase.c:8918
SINT32 t1
Definition: tinetype.h:613
float x
Definition: tinetype.h:414
int GetSystemDataStampFromCallbackId(int id)
Gets the system data stamp with which the incoming data set has been tagged.
Definition: client.c:9987
Defines an Alarm Watch Structure.
void SetPostSystemInitFunction(SYSTSKP fcn)
Sets a user-specific initialization routine to be executed following server initialization.
Definition: syslib.c:6120
double GetDataTimeStamp(void)
Returns the last established data timestamp.
Definition: syslib.c:5899
float s_inc
Definition: tinetype.h:757
int GetSystemCycleDeadband(void)
Gets the system cycle deadband.
Definition: srvdbase.c:9385
int SetCycleDelay(int msecs)
Sets the delay time in milliseconds following a 'burst' of ethernet packets (as defined by SetBurstLi...
Definition: syslib.c:5965
int GetLastContractTableId(void)
Returns the last contract table identifier.
Definition: syslib.c:6577
short RegisterXPropertyQueryFunction(char *eqm, int(*fcn)(char *devName, XPropertyQueryStruct **xpqs), int numprops)
Registers an extended property query function.
Definition: srvdbase.c:8737
float prpMaxValue
Definition: tinetype.h:4049
int SetLinkWatchdogPollingInterval(int value)
Sets the link watchdog polling interval to the value given.
Definition: client.c:7734
void SystemKillCycleTimer(void)
Stops the TINE engine 'cycler' thread.
Definition: tine32.c:247
BYTE prpFormat
Definition: tinetype.h:4116
int clslog(char *context, char *tag, char *logger, int priority, int status, char *text,...)
Sends a logging entry to the central logging server.
Definition: syslib.c:5440
int recvNetGlobal(const char *keyword, DTYPE *dout, void(*cbFcn)(int, int))
Initiates a net globals data link.
Definition: client.c:10303
int ResetMultiChannelProperty(char *eqm, char *prp)
sends (schedules) a 'reset_mca_property' signal to any listening client
Definition: syslib.c:6438
@ renegotiate_contract
Definition: errors.h:212
@ illegal_equipment_name
Definition: errors.h:150
char ** strptr
Definition: tinetype.h:975
double GetTimeStampFromString(char *timestr)
Returns a TINE timestamp converted from the string argument given.
Definition: syslib.c:5809
int ApplyAlarmWatchFilter(char *eqm, char *prp, char *dev, char *parsableFilterString)
Applies a filter to an existing local alarm server's Watch Table.
Definition: Alarm API Calls:2204
UINT32 mask
Definition: almlib.h:496
float * fptr
Definition: tinetype.h:987
int gRequireAcknowledgments
Determines whether acknowledgements are expected following data changes where contracts use CM_DATACH...
Definition: server.c:118
int GetGlobalDataTypeFromCallbackId(int id)
Returns the data type of global link callback id supplied.
Definition: client.c:9944
@ not_signalled
Definition: errors.h:222
void RemoveAlarm(char *eqm, int devNr, UINT32 code)
Instructs the local alarm server table that the given alarm is to be marked for removal.
Definition: Alarm API Calls:2358
int SetScanForNetsFiles(const char *eqm)
Instructs the initialization process to look for device and property specific 'ipnets' files.
Definition: srvdbase.c:2058
@ illegal_device
Definition: errors.h:117
struct timeval * GetDataTimeStampAsTimeval(void)
Returns the last established data timestamp as a pointer to a struct timeval.
Definition: syslib.c:5802
int SetAlarmCodeOscillationWindow(const char *eqm, int code, int value)
Sets the size of the alarm oscillation window in clear counts.
Definition: Alarm API Calls:2462
@ invalid_transport
Definition: errors.h:85
void SetAllowOfflineAlarms(int value)
Instructs the local alarm server to allow or disallow alarms for devices declared offline.
Definition: Alarm API Calls:1059
double lastArchiveTime
Definition: hstlib.h:104
DeviceRegionItem * regionsLst
Definition: srvcore.h:1812
int GetNumberDataOutputBuffers(void)
gets the number of allocated buffers to use in contract access of a a registered property.
Definition: server.c:479
void SetHistoryStaticFilesRepository(char *path)
Sets the directory location where static local history files are maintained.
Definition: hstlib.c:215
char name[32]
Definition: tinetype.h:309
@ out_of_range
Definition: errors.h:119
int groupIndex
Definition: srvcore.h:1793
void SetMinimumDiskSpaceInBlocks(UINT32 spaceInBlocks)
Sets the amount of free disk space the local history subsystem should try to maintain.
Definition: hstlib.c:259
int GetNumConsumers(char *eqm)
Returns the current number of consumers associated with the equipment module given.
Definition: srvdbase.c:7769
char name[DEVICE_NAME_SIZE]
Definition: srvcore.h:1749
BYTE graph
Definition: tinetype.h:2381
@ data_stale
Definition: errors.h:252
void SetTcpConnectionTableSize(int value)
sets the tcp connection table size.
@ illegal_equipment_number
Definition: errors.h:115
int GetGlobalsHeartbeat(void)
gets the heartbeat (in seconds) during which time no 'timeout' messages will be sent to a globals dis...
Definition: client.c:10332
float f2val
Definition: tinetype.h:699
UINT32 prpSize
Definition: XPropertyQueryStruct.txt:14
void * staChgRef
Definition: srvcore.h:1841
int GetSystemUseDataProtection(void)
Gets the data protection flag to the value given.
Definition: syslib.c:6534
void SetIdleConnectionDuration(int allowedIdleSeconds)
sets the time-to-live for an unused TCP connection to a server
@ async_access_required
Definition: errors.h:173
int depthShort
Definition: hstlib.h:82
double d2val
Definition: tinetype.h:511
int GetSubscriptionRenewalThreshold(int linkId, int *thresholdInPercent)
Gets the current client-side subscription threshold for the link in question.
Definition: client.c:2991
short inidone
Definition: srvcore.h:1829
int UpdateDataStampsFromLinkId(int linkId, DTYPE *dout)
Fills in the given DTYPE data object with all data stamp information.
Definition: client.c:9874
short isbusy
Definition: srvcore.h:1833
int GetCompletionDataTypeFromCallbackId(int id)
Returns the most recent data type of the link associated with the callback id supplied.
Definition: client.c:9801
int recordLength
Definition: hstlib.h:91
void SetDieOnSocketError(int value)
Determines whether a server will exit() if there are continuous socket errors on important server soc...
Definition: syslib.c:227
@ net_read_error
Definition: errors.h:107
@ square_root_negative
Definition: errors.h:103
int recordInitialized
Definition: hstlib.h:92
Defines a TINE image data object containing an image source header, an image frame header and the ima...
Definition: tinetype.h:924
int archiveRate
Definition: hstlib.h:190
@ invalid_return_code
Definition: errors.h:204
double dev
Definition: tinetype.h:665
char * GetRegisteredContext(char *eqm)
Gives the registered context.
Definition: srvdbase.c:5821
void SetExportedSubSystem(char *eqmName, char *subsystem)
Assigns the exported subsystem associated with the equipment function name given.
Definition: srvdbase.c:307
@ invalid_reference
Definition: errors.h:263
int RegisterFecName(char *name, char *desc, char *os, char *loc, char *hdw, char *resp, UINT16 poff)
Assigns a FEC Name to the server process.
Definition: srvdbase.c:8245
float f1val
Definition: tinetype.h:558
int RegisterPropertyEx(char *eqm, char *property, int siz, short fmt, short acc, char *dsc, int pid)
Assigns pertinent information for the specified property.
Definition: srvdbase.c:8685
void SetGlobalsTableCapacity(int value)
sets the globals table capacity
Definition: client.c:9101
SINT32 * sysstamp
Definition: hstlib.h:108
int SetDeviceZPosition(char *eqm, char *devname, float zpos)
Assigns a Z (logitudinal) direction to the specified device.
Definition: srvdbase.c:8020
@ sedac_error
Definition: errors.h:167
Structure used to hold engineering units, ranges, etc. for properties.
Definition: tinetype.h:2376
Defines a TINE quintuplet data object containing an 80-character fixed-length string followed by a lo...
Definition: tinetype.h:729
char * GetExportedName(char *eqm)
Returns the exported name associated with the equipment function name given.
Definition: srvdbase.c:7623
int MaxNumberAlarms
Determines the maximum number of alarms which can be maintained in the local alarm server's alarm lis...
Definition: Alarm API Calls:70
Defines a TINE quadruplet data object containing a long integer doublet giving a time range followed ...
Definition: tinetype.h:611
int GetGlobalsTableCapacity(void)
gets the globals table capacity (client-side)
Definition: client.c:9106
void SetAlarmTerminationWindow(int timeInSeconds)
Sets the size of the termination window in seconds before a terminated alarm is discarded from the lo...
Definition: Alarm API Calls:2500
char * GetSystemErrorString(short cc, char *errstr)
Gets the system error code in plain text.
Definition: syslib.c:6464
float f3val
Definition: tinetype.h:717
void SetNewAlarmWindow(int timeInSeconds)
Sets the size of the new alarm window in seconds before a new alarm is no longer declared as new.
Definition: Alarm API Calls:2506
@ no_such_computer
Definition: errors.h:121
int GetAllowNetworkAddressResolution(void)
returns whether NETWORK address resolution is allowed
Definition: srvdbase.c:9457
int AssignDataStampsToGlobal(char *keyword, int dataStamp, int sysStamp)
Assigns additional data stamps to the registered global keyword.
Definition: srvdbase.c:8826
int GetCurrentLinkStatusFromCallbackId(int id)
Returns the completion code associated with the callback identifier supplied.
Definition: client.c:9859
BYTE isterminating
Definition: srvcore.h:1836
@ illegal_operator
Definition: errors.h:159
@ semaphore_error
Definition: errors.h:170
char cmt[80]
Definition: tinetype.h:1041
SINT32 rateBkg
Definition: srvcore.h:1827
int GetCallerInfo(char *eqm, NAME16 *un, BYTE *ipx, UINT32 *ip, short *prot, int *num)
Returns the user name(s) and network address(es) of all callers interested in the current contract.
Definition: srvdbase.c:7528
int losev
Definition: almlib.h:371
int GetServerThreadPriority(void)
Returns the priority of the server cycle thread as well as other associated server-side threads.
Definition: syslib.c:4199
int SetDeviceDescription(char *eqm, char *devname, char *description)
Assigns a device description to the specified device.
Definition: srvdbase.c:7961
int ExecLinkEx(const char *devName, const char *devProperty, DTYPE *dout, DTYPE *din, short access, UINT16 timeout)
Executes a synchronous link (Extended call).
Definition: client.c:9519
void SetAlarmDataChangeWindow(int timeInSeconds)
Sets the size of the alarm datachange window in seconds.
Definition: Alarm API Calls:2511
short EqmNumDevices
Definition: srvcore.h:1806
@ cannot_select
Definition: errors.h:220
char * GetExportedFecName(void)
Returns the FEC name exported at the time of server initialization.
Definition: srvdbase.c:323
int GetContractAccessRate(int id)
Returns the access rate (interval) associated with the given contract.
Definition: syslib.c:6581
void SetAllowBackgroundTaskReentrancy(int value)
Determines whether equipment module background tasks may be re-entered (boolean).
Definition: srvdbase.c:9431
int GetRunTransportInSeparateThread(void)
Returns whether the (tcp) transport is run in its own thread (boolean).
void SetConfigurationCoded(int value)
Determines whether TINE configuration files will be scanned or not.
Definition: srvdbase.c:236
UINT32 cnt
Definition: tinetype.h:671
ExportListStruct * GetExportListItem(char *eqm)
Returns a reference to the Export List Structure of the given equipment module.
Definition: srvdbase.c:2920
@ port_not_available
Definition: errors.h:172
short hasDevQry
Definition: srvcore.h:1808
int SystemPresetMemory
Determines whether data requests preset the calling buffer to zero before issuing the call.
Definition: server.c:66
int GetNumCallers(char *eqm)
Returns the current number of callers associated with the equipment module given.
Definition: srvdbase.c:7765
@ access_locked
Definition: errors.h:262
ADSList * adsTable
Definition: srvcore.h:1813
int lowarnsev
Definition: almlib.h:491
SINT32 i2val
Definition: tinetype.h:525
void SetMaxTcpMessageSize(int value)
Sets the TINE server maximum STREAM message segment size.
Definition: iplib.c:1399
UINT32 prpSizeIn
Definition: tinetype.h:4051
@ server_idle
Definition: errors.h:260
float f2val
Definition: tinetype.h:684
Defines an Alarm Message Structure.
int SetClientThreadPriority(int priority)
Determines the priority of the client cycle thread as well as other associated client-side threads.
Definition: syslib.c:4203
int GetAllowBackgroundTaskReentrancy(void)
Returns whether equipment module background tasks may be re-entered (boolean).
Definition: srvdbase.c:9435
Defines a TINE triplet data object containing a 16-character fixed-length string value followed by a ...
Definition: tinetype.h:456
int RegisterFecNameEx(char *name, char *desc, char *os, char *loc, char *hdw, char *resp, UINT16 poff, char *context)
Assigns a FEC Name to the server process. Extended call.
Definition: srvdbase.c:8234
int pollingRate
Definition: hstlib.h:148
int SetAccessLock(char *context, char *server, int lockType, int lockDuration)
Acquires an access lock to the server specified.
Definition: client.c:10336
int GetPropertySubscriptionRenewalLength(char *eqm, char *prpName, int *value)
Gets the current subscription renewal length for the property specified.
Definition: srvdbase.c:3937
int GetContractId(const char *eqm)
Returns the last contract identifier for the equipment module specified.
Definition: syslib.c:6558
Defines a simple property query structure (legacy, minimal information)
Definition: tinetype.h:4025
int RegisterEquipmentModule(char *expName, char *eqmName, int numdevices, int(*fcn)(char *, char *, DTYPE *, DTYPE *, short), void(*ini)(void), void(*tsk)(void), int rate, void(*exi)(void))
Registers an equipment module with the TINE server engine.
Definition: srvdbase.c:8177
SINT32 i1val
Definition: tinetype.h:599
char EqmRegion[TAG_NAME_SIZE]
Definition: srvcore.h:1792
UINT16 prpHistoryDepthLong
Definition: XPropertyQueryStruct.txt:21
SINT32 ival
Definition: tinetype.h:682
int getLinkOutputStatus(int lnkId, char *strSts, int maxKeyLength, int splitlines)
Definition: client.c:590
int RemoveRegisteredBCastNetsList(NAME64 *ipaddr, int rmvsiz)
removes those networks in the name list given from the current broadcast list.
Definition: srvdbase.c:1209
float f3val
Definition: tinetype.h:685
int length
Definition: hstlib.h:70
@ warn_disk_space
Definition: errors.h:265
@ canbus_error
Definition: errors.h:250
Client Information Structure used in GetCallerInformation.
Definition: srvcore.h:2485
int SetSizeDeviceCapacity(char *eqm, int size)
Sets (increases) the maximum size of the device table and associated tables.
Definition: srvdbase.c:6410
@ net_write_error
Definition: errors.h:193
@ invalid_parameter
Definition: errors.h:98
void ResetSuspendCallbacks(void)
stops suspending callbacks and resets the reference counter
Definition: client.c:4999
int SetPacketMTU(int mtu)
Sets the TINE Packet MTU for the UDP server socket.
Definition: iplib.c:579
SINT32 ival
Definition: tinetype.h:310
void SetRunServerCycleInSeparateThread(int value)
Determines whether the server cycle is run in its own thread (boolean).
int CloseNetGlobal(const char *keyword)
Closes an active globals data link according to the globals Keyword.
Definition: client.c:9489
int GetCurrentLinkStatus(int i)
Returns the completion code associated with the input link index.
Definition: client.c:9854
Defines a TINE triplet data object containing a float doublet followed by a long integer value.
Definition: tinetype.h:556
BYTE prpAccess
Definition: XPropertyQueryStruct.txt:25
int sysStamp
Definition: tinetype.h:1002
void SetRetardSingleContractRemoval(int value)
sets the retard contract removal state
Definition: srvdbase.c:9423
int GetCompletionDataType(int i)
Returns the most recent data type of the link index supplied.
Definition: client.c:9789
int SetNumberDataOutputBuffers(int value)
sets the number of allocated buffers to use in contract access of a a registered property.
Definition: server.c:468
UINT16 prpSize
Definition: tinetype.h:4029
SINT32 i3val
Definition: tinetype.h:573
void SetUseMultiThreadedEquipmentFunctions(int value)
Determines whether an equipment module equipment function can run in a separate threads (boolean).
Definition: syslib.c:2742
int gErrorLogLevel
Determines which messages are written to error.log file.
Definition: syslib.c:5498
float lo
Definition: almlib.h:379
int GetSystemLogging(void)
Returns the current system logging setting (TRUE or FALSE)
Definition: syslib.c:5929
char property[PROPERTY_NAME_SIZE]
Definition: hstlib.h:144
int GetInterpretConsoleCommands(void)
Returns the setting for whether console commands will be interpreted or not.
char name[64]
Definition: tinetype.h:333
int SetSystemUserName(char *usr)
Sets the current value for the application user.
Definition: syslib.c:6458
BYTE prpFormatIn
Definition: XPropertyQueryStruct.txt:24
@ mcast_access_required
Definition: errors.h:137
int GetClnUDPPort(void)
Gets the TINE client UDP base port.
Definition: iplib.c:238
int useGlobalSynchronization
Determines whether data timestamps are to be externally synchronized.
Definition: syslib.c:5519
Defines a TINE pairwise data object containing an 8-character fixed-length string followed by a 4-byt...
Definition: tinetype.h:283
int GetBackgroundThreadPriority(void)
Returns the priority of the registered background threads.
Definition: syslib.c:4215
@ value_too_high
Definition: errors.h:215
int RegisterUserCommand(char *cmd, int(*fcn)(int, int, int, int), int *iparam, float *fparam, int access)
Registers a user-defined command or variable which can be accessed via the TINE command line interpre...
Definition: ttycmd.c:1989
void SystemKillCycleTimer(void)
Stops the TINE engine 'cycler' thread.
Definition: tine32.c:247
int RegisterCycleTriggerFunction(CYCBFCNP fcn, char *eqm, char *prpLst, void *reference)
Registers a cycle trigger callback dispatch function.
Definition: client.c:6726
@ file_already_exists
Definition: errors.h:126
double dval
Definition: tinetype.h:485
short hstdone
Definition: srvcore.h:1830
SINT32 i2val
Definition: tinetype.h:540
char * SystemGetStartupCommand(void)
Returns the command line used to start this process.
Definition: srvdbase.c:354
@ dimension_error
Definition: errors.h:102
int SetFecHome(char *fecHomePath)
Sets the current fec home database repository.
Definition: syslib.c:5913
int AppendRegisteredUsers(const char *eqm, NAME16 *userlist, int listsize)
appends the current users access list with the name list given
Definition: srvdbase.c:1261
int GetCurrentDataStatusFromCallbackId(int id)
Returns the data status code associated with the callback identifier supplied.
Definition: client.c:9869
int PutLnkTimeStamp(int i)
Flags a link so that the local timestamp is used for all incoming data sets.
Definition: client.c:2529
int GetSystemStampOffset(void)
Returns the registered system cycle offset.
Definition: client.c:6768
@ unix_socket_error
Definition: errors.h:271
char * ResolveSystemAlias(char *alias)
Gets the registered property or registered device name for the given alias.
Definition: srvdbase.c:9447
char * rhsPropertyName
Definition: hstlib.h:197
int GetCallerInformation(char *eqm, ClnInfo *clnInfoList, int *num)
Returns the user name, network address and other information of all callers interested in the current...
Definition: srvdbase.c:7552
UINT16 prpHistoryDepthShort
Definition: XPropertyQueryStruct.txt:20
int reserved
Definition: tinetype.h:1026
int GetPortOffset(const char *fecName)
Obtains the FEC port offset appropriate for the give FEC name.
Definition: srvdbase.c:6704
@ non_existent_server
Definition: errors.h:153
@ illegal_character
Definition: errors.h:156
char * GetCaller(char *eqm)
Gives the user name of the current caller.
Definition: srvdbase.c:7518
char * GetSystemUserName(void)
Gets the current value for the application user.
Definition: syslib.c:5925
int archiveRate
Definition: hstlib.h:81
@ not_exported
Definition: errors.h:208
@ end_of_file
Definition: errors.h:131
Defines a TINE pairwise data object containing a pairwise float doublet.
Definition: tinetype.h:412
int SetGCastAddr(char *addr)
Sets the cannonical globals multicast address the server will use when sending payloads via multicast...
Definition: iplib.c:386
int GetFormatSizeInBytesFromDataType(DTYPE *d)
Gives the size of bytes according to the DTYPE fields.
Definition: syslib.c:747
BYTE isinside
Definition: srvcore.h:1835
char * GetErrorText(int code, char *errstr, int length)
Returns the error text associated with an error code.
@ data_not_local
Definition: errors.h:227
int AssignDeviceAccessList(const char *eqm, const char *dev, NAME16 *users, int nusers)
Assigns an access list for the device given.
Definition: srvdbase.c:7094
int _SystemFireEvent(char *eqm, char *prp)
Schedules an event for the given property for immediate delivery to all attached clients.
Definition: syslib.c:6434
int len
Definition: tinetype.h:1025
int priority
Definition: tinetype.h:195
char ctx[CONTEXT_NAME_SIZE]
Definition: srvcore.h:1747
int GetAllowOfflineAlarms(void)
Gets the local alarm server setting to allow or disallow alarms for devices declared offline.
Definition: Alarm API Calls:1063
int hasPropertyHandler
Definition: srvcore.h:1823
int RemoveEquipmentModule(const char *eqm)
Unregisters an equipment module with the TINE server engine and frees all associated memory.
Definition: srvdbase.c:5941
UINT32 MaxSystemTransportSize
Determines the maximum size in bytes of any call supported by the server.
Definition: server.c:112
int GetUseGlobalSynchronization(void)
Returns whether data timestamps are to be externally synchronized.
Definition: syslib.c:5530
BYTE * data
Definition: hstlib.h:71
int GetBurstLimit(void)
Gets the burst limit in number of packets which are allowed to be sent consecutively.
Definition: syslib.c:5961
float * spectBuffer
Definition: tinetype.h:806
float f1val
Definition: tinetype.h:403
void SetSchedulerInterval(int value)
Sets the system scheduler interval.
Definition: srvdbase.c:9324
float f1val
Definition: tinetype.h:641
Defines a TINE triplet data object containing a 16-character fixed-length string value followed by a ...
Definition: tinetype.h:427
int LockEquipmentModules(void)
Locks all equipment modules.
Definition: syslib.c:6075
int EqmNumCalls
Definition: srvcore.h:1844
time_t eqmStartupTime
Definition: srvcore.h:1858
char tag[32]
Definition: tinetype.h:192
void SystemStartCycleTimer(void)
Starts a TINE engine 'cycler' running (SystemCycle()) in a separate thread.
Definition: tine32.c:243
@ illegal_line
Definition: errors.h:77
@ buffer_too_small
Definition: errors.h:104
SINT32 i1val
Definition: tinetype.h:642
@ notification_pending
Definition: errors.h:242
char desc[DEVICE_DESC_SIZE]
Definition: srvcore.h:1750
int JoinEquipmentGroup(char *eqmName, char *groupname, int groupindex)
Instructs the equipment module to join the specified equipment group.
Definition: srvdbase.c:7790
MXHANDLE hDataProtectionMutex
Definition: srvcore.h:1852
UINT32 SetWorkAreaSize(UINT32 size)
Sets the server-side work area size which is coupled to the maximum transport size for supported by a...
Definition: syslib.c:6000
@ ipx_socket_error
Definition: errors.h:106
@ completion_waiting
Definition: errors.h:219
int sev
Definition: almlib.h:368
short isidle
Definition: srvcore.h:1832
UINT16 * usptr
Definition: tinetype.h:978
int datafmt
Definition: hstlib.h:147
char archiveFileName[32]
Definition: hstlib.h:105
Defines a TINE doublet data object containing a 64-character fixed-length string value followed by a ...
Definition: tinetype.h:482
int AssignNumDevices(char *eqm, int num)
Fixes the number of modules (devices) attached to the specified equipment module.
Definition: srvdbase.c:7316
void SetServerWaiting(int value)
Sets the server's waiting state to the value given.
Definition: syslib.c:5228
int SetBurstLimit(int npackets)
Sets the burst limit in number of packets which are allowed to be set consecutively.
Definition: syslib.c:5954
@ file_error
Definition: errors.h:100
de-references the data set in a DTYPE object
Definition: tinetype.h:971
int GetGlobalLinkIdFromCallbackId(int cbId)
retrieves the link ID for a globals link
Definition: client.c:7343
int ndim
Definition: tinetype.h:1042
void SetDefaultTransportMode(int value)
Sets the default TINE transport mode used in client-side links.
Definition: client.c:107
int GetPropertyId(char *eqm, char *prpName)
Gives the associated property identifier for the given property name.
Definition: srvdbase.c:7784
@ string_expected
Definition: errors.h:144
void SetStreamTransportRetryLimit(int value)
Sets the stream transport retry limit.
Definition: syslib.c:4576
void SetCatchConsoleBreak(int value)
Determines whether an application will catch an interrupt or break signal (such as control-C) and iss...
Definition: syslib.c:199
int SetSystemAlias(char *alias, char *name)
Sets an alias for either a registered property or registered device.
Definition: srvdbase.c:9439
float f2val
Definition: tinetype.h:559
void SetAlarmHeartbeat(int timeInSeconds)
Sets the size of the heartbeat alarm window in seconds before the 'heartbeat' flag is applied to an a...
Definition: Alarm API Calls:2490
int GetServerTransportCeiling(void)
Gets the server-side transport ceiling (in bytes) which gives the maximum transport size for supporte...
Definition: server.c:180
int nofeclog
Determines whether a server is to keep a log file on the local disk.
Definition: syslib.c:5496
Defines a TINE triplet data object containing a long integer value followed by a float followed by a ...
Definition: tinetype.h:536
void SetAutoLinkWatchdogs(int value)
Enables/Disables automatic link watchdogs.
Definition: client.c:10308
SINT32 tm
Definition: tinetype.h:780
float pTolerance
Definition: hstlib.h:194
void SetMinimumAllowedPollingInterval(int value)
Sets the minimum polling interval in milliseconds a server will allow.
Definition: srvdbase.c:9389
UINT32 normal
Definition: almlib.h:497
int cnt
Definition: almlib.h:487
int datacmp(BYTE *d1, BYTE *d2, int siz, int fmt, double t)
Definition: syslib.c:1434
@ record_too_long
Definition: errors.h:270
int RegisterPropertyInformationEx(char *eqm, char *prp, DTYPE *dout, DTYPE *din, short acc, short atype, UINT16 rowlen, char *dsc, PrpEgu *egu, PrpEgu *xegu, int pid, char *rdr)
Assigns pertinent information for the specified property (extended version).
Definition: srvdbase.c:8386
Defines a TINE quadruplet data object containing a float value followed by a long integer followed by...
Definition: tinetype.h:639
int depthShort
Definition: hstlib.h:150
int GetAlwaysRetry(void)
Gets the current setting of the 'Always Retry' flag.
Definition: client.c:10316
int GetUseLoopback(void)
Returns the current value of the 'useLoopBack' flag.
SINT32 i2val
Definition: tinetype.h:572
structure used in the local alarm linked list
SINT32 ival
Definition: tinetype.h:560
@ illegal_context
Definition: errors.h:93
short hasPropertyDeviceNames
Definition: srvcore.h:1799
THRHANDLE hEqmBkg
Definition: srvcore.h:1826
int datasiz
Definition: hstlib.h:146
int EqmLastErrorCode
Definition: srvcore.h:1843
int GetAllowBackgroundTaskReentrancy(void)
Returns whether equipment module background tasks may be re-entered (boolean).
Definition: srvdbase.c:9435
int RegisterPropertyAndHandler(char *eqm, EQMFCNP hndlr, char *prp, DTYPE *dout, DTYPE *din, short acc, short atype, UINT16 rowlen, char *dsc, PrpEgu *egu, PrpEgu *xegu, int pid)
Registers a device property and a property handler with the TINE server engine. If no equipment modul...
Definition: srvdbase.c:6895
Uses an Alarm Watch Structure + extra override information.
SINT32 i2val
Definition: tinetype.h:644
float s_start
Definition: tinetype.h:733
SCKADR addr
Definition: srvcore.h:2494
int GetDeviceMask(char *eqm, int devnr)
Gives the registered device mask for the device number.
Definition: srvdbase.c:7663
short EqmDevLstCapacity
Definition: srvcore.h:1807
int GetFeclogDepth(void)
Returns the maximum size of the server's log file in lines.
Definition: syslib.c:5515
UINT16 rowSize
Definition: tinetype.h:4124
void SetContractListCapacity(int value)
Sets the maximum number of contracts a server will service.
Definition: srvdbase.c:7247
@ io_error
Definition: errors.h:92
float s_inc
Definition: tinetype.h:827
void SetEqmCompletion(char *eqm, char *errstr)
Sets the error string to accompany the current server call.
Definition: srvdbase.c:8956
@ illegal_data_size
Definition: errors.h:91
float fval
Definition: tinetype.h:362
@ operation_success
Definition: errors.h:76
int GetLastStoredDataEx(char *eqm, char *prp, char *dev, int index, BYTE *data, int fmt, int len, double *tstamp)
Retreives the last stored data set from disk for the given input parameters (extended call).
Definition: hstlib.c:4728
char dev[DEVICE_NAME_SIZE]
Definition: almlib.h:362
time_t eqmBaseline
Definition: srvcore.h:1859
int RegisterDeviceName(char *eqm, char *devname, int devnr)
Assigns a device name to the specified device number.
Definition: srvdbase.c:7882
double PutDataTimeStampU(double toffset, time_t tsec, int tusec)
Returns a data timestamp according to the input parameters given.
Definition: syslib.c:5946
short inetProtocol
Definition: srvcore.h:2497
EQMTSKP eqmIni
Definition: srvcore.h:1838
float min
Definition: tinetype.h:2379
UINT16 prpHistoryDepthShort
Definition: tinetype.h:4114
UINT32 mask
Definition: almlib.h:374
void SetContractSignalFunction(CONSIG fcn, int mask, void *ref)
Registers a contract signal function.
Definition: srvdbase.c:7226
@ invalid_interval
Definition: errors.h:241
Datatype: Multi-Dimensional Array.
Definition: tinetype.h:1039
int gConTblCapacity
Determines the maximum number of entries in the connection table.
Definition: client.c:9040
Defines an Alarm Definition Structure.
int code
Definition: almlib.h:382
int AppendRegisteredBCastNetsList(NAME64 *ipaddr, int addsiz)
appends the current network broadcast list with the name list given
Definition: srvdbase.c:1199
int _SystemCycle(int chkcmd)
Required call for the TINE engine to function property.
Definition: syslib.c:6005
short nfollowers
Definition: srvcore.h:1820
int GetSystemSchedulePropertyLazy(void)
Gets the 'lazy' flag for scheduling properties.
Definition: syslib.c:6327
int GetServerCycleState(char *cycleStateString)
Returns the current server cycle state.
Definition: server.c:159
@ out_of_sequence
Definition: errors.h:277
@ not_allowed
Definition: errors.h:160
int SetMCastMask(char *addr)
Sets the cannonical multicast address mask the server will use when requested to send payloads via mu...
Definition: iplib.c:322
int microsleep(int usecs)
sleep for given number of micro-seconds
Definition: syslib.c:1641
@ out_of_local_memory
Definition: errors.h:145
void SetAlarmTableMaximumSize(int tableSize)
Sets the maximum number of alarms managed by the local alarm server.
Definition: Alarm API Calls:2495
int dataPtr
Definition: hstlib.h:85
SINT32 tm
Definition: tinetype.h:700
void SetAutoLinkErrorAlarms(int value)
Sets the autoLinkErrorAlarms flag.
Definition: client.c:10490
int GetUseMultiThreadedBackgroundTasks(void)
Returns whether equipment module background tasks are to run in separate threads (boolean).
Definition: syslib.c:2737
void SetSystemStampOffset(int cycleOffset)
Establishes a system cycle offset.
Definition: client.c:6764
int TerminationWindow
Determines the minimum time an expired alarm is to remain in the local alarm table.
Definition: Alarm API Calls:71
int SetGCastMask(char *addr)
Sets the cannonical multicast address mask the server will use when sending payloads via multicast as...
Definition: iplib.c:390
int GetServerTransportCeiling(void)
Gets the server-side transport ceiling (in bytes) which gives the maximum transport size for supporte...
Definition: server.c:180
int putCommandsInFeclog
Determines whether all in-coming WRITE access calls are automatically included in the server's log fi...
Definition: syslib.c:5499
int asys
Definition: almlib.h:367
@ archive_busy
Definition: errors.h:132
void SetServerIdleState(char *eqm, int value)
Sets the server's idle state to the value given.
Definition: syslib.c:5237
int GetStandardSpillOverSize(void)
Gets the amount of additional space (number of addition records) to allocate as a worst case when usi...
Definition: hstlib.c:252
int GetClientThreadPriority(void)
Returns the priority of the client cycle thread as well as other associated client-side threads.
Definition: syslib.c:4207
@ no_such_file
Definition: errors.h:125
char prpDescription[PROPERTY_DESC_SIZE]
Definition: tinetype.h:4104
int GetUseCycleTrigger(void)
Returns whether a server listens for a CycleNumber trigger from a CYCLER.
Definition: server.c:170
int AssertIsAdministrator(const char *usr)
returns TRUE if the given user is a registered administrator
Definition: srvdbase.c:8169
char loc[DEVICE_LOCATION_SIZE]
Definition: srvcore.h:1751
void SetUseMultiThreadedStockFunctions(int value)
Determines whether stock propery calls can run in a separate threads (boolean).
Definition: syslib.c:2751
@ rs232_error
Definition: errors.h:186
int GetConnectionTable(ConTblInfo *tbl, int *tblSize)
Gets the current connection table.
Definition: client.c:548
@ illegal_mode
Definition: errors.h:189
int AppendRegisteredNetsList(const char *eqm, NAME64 *ipaddr, int addsiz)
appends the current network access list with the name list given
Definition: srvdbase.c:1193
int lastAccessSts
Definition: hstlib.h:101
char * GetRegisteredExportName(char *eqm)
Gives the registered exported equipment module name.
Definition: srvdbase.c:5815
int OpenBitField(char *srv, char *tag, int fmt)
Declares a bit field type and registers with the bitfield registry.
Definition: srvdbase.c:9248
BYTE prpFormatIn
Definition: tinetype.h:4056
SINT32 ival
Definition: tinetype.h:286
int SetNotificationTolerance(int linkId, float toleranceAbsolute, float tolerancePercent)
Allows the caller to apply a tolerance pertaining to link notification.
Definition: client.c:10481
char comment[80]
Definition: tinetype.h:779
void SetIgnoreCommonFiles(int value)
turns searching for common database files in the FEC_HOME directory on or off
Definition: srvdbase.c:2110
SINT32 status
Definition: tinetype.h:758
char EqmContext[CONTEXT_NAME_SIZE]
Definition: srvcore.h:1784
float lowarn
Definition: almlib.h:381
UINT32 prpSizeIn
Definition: XPropertyQueryStruct.txt:15
int GetAccessLockStatus(char *context, char *server)
Acquires the current access lock status on a client's access lock.
Definition: client.c:9729
int AddFieldToStruct(char *tag, int addr, int size, int fmt, char *field)
Adds a field description to a tagged structure.
Definition: srvdbase.c:7268
void SetGCastTableCapacity(int value)
sets the globals multicast table capacity
Definition: srvdbase.c:9278
float hiwarn
Definition: almlib.h:493
BYTE * SystemVersion(void)
Returns the system version as a 4-byte array containg the major and minor version numbers as the firs...
Definition: syslib.c:6315
UINT16 reserved2
Definition: srvcore.h:2492
SINT32 ival
Definition: tinetype.h:363
void SetlookupRedirectionNameStub(int(*fcn)(char *eqm, char *prpName, char *devName))
Sets a stub to an existing lookupRedirectionNameStub function for cases where a Property Query Functi...
Definition: srvdbase.c:8993
int poolEntryCapacity
Definition: hstlib.h:99
int GetSystemDataStamp(int linkId)
Gets the system data stamp with which the incoming data set has been tagged.
Definition: client.c:9981
int GetValidDeviceNumber(char *eqm, char *devname, char *prpname, int ceiling)
Gives the valid registered device number for the specified device name and property name.
Definition: srvdbase.c:7710
int GetStreamTransportRetryLimit(void)
Returns the stream transport retry limit.
Definition: syslib.c:4580
char * GetHistoryStaticFilesRepository(void)
Returns the directory location where static local history files are maintained.
Definition: hstlib.c:231
int _SystemScheduleProperty(char *eqm, char *prp)
Schedules the given property for immediate delivery to all attached clients.
Definition: syslib.c:6430
char srv[EXPORT_NAME_SIZE]
Definition: srvcore.h:1748
int MakeSystemDataStamp(void)
Returns the current valid global system data stamp.
Definition: syslib.c:6550
int AssignDeviceListToProperty(char *eqm, char *prp, NAME64 *devlst, int lstlen)
Assigns the given device list to the given registered property.
Definition: srvdbase.c:6342
int JoinEquipmentGroupEx(char *eqmName, char *groupname, int groupindex, char *devPrefix, char *devPostfix)
Instructs the equipment module to join the specified equipment group.
Definition: srvdbase.c:7801
int GetAllowDependentLinks(void)
returns the setting for this value
Definition: client.c:122
double d1val
Definition: tinetype.h:459
int GetNewAlarmWindow(void)
Gets the size of the new alarm window in seconds before a new alarm is no longer declared as new.
Definition: Alarm API Calls:2356
int ExecLink(const char *devName, const char *devProperty, DTYPE *dout, DTYPE *din, short access)
Executes a synchronous link.
Definition: client.c:9705
@ low_disk_space
Definition: errors.h:266
int GetConnectionTable(ConTblInfo *tbl, int *tblSize)
Gets the current connection table.
Definition: client.c:548
int codeLowWarn
Definition: almlib.h:386
UINT32 ts
Definition: tinetype.h:668
@ log_negative
Definition: errors.h:111
int UnregisterCycleTriggerFunction(CYCBFCNP fcn, void *reference)
Unregisters a previously registered cycle trigger callback dispatch function.
Definition: client.c:6747
int pollingRate
Definition: hstlib.h:80
int EqmWcPrpLstCapacity
Definition: srvcore.h:1801
short RegisterPropertyQueryFunction(char *eqm, int(*fcn)(char *devName, PrpQueryStruct **prpqs), int numprops)
Registers a property query function.
Definition: srvdbase.c:8704
int GetCurrentDataStatus(int i)
Returns the data status code associated with the input link index.
Definition: client.c:9864
char units[16]
Definition: tinetype.h:2378
int GetCycleDelay(void)
Gets the delay time in milliseconds following a 'burst' of ethernet packets (as defined by SetBurstLi...
Definition: syslib.c:5971
@ invalid_structure_tag
Definition: errors.h:148
char prp[PROPERTY_NAME_SIZE]
Definition: almlib.h:363
void SetPutCommandsInFeclog(int value)
Determines whether all in-coming WRITE access calls are automatically included in the server's log fi...
Definition: syslib.c:5500
short lastLnkErrSrc
Gives the signature of the last Link Error.
Definition: client.c:81
UINT32 prpSize
Definition: tinetype.h:4050
double d3val
Definition: tinetype.h:512
int depthLong
Definition: hstlib.h:151
@ database_not_loaded
Definition: errors.h:163
@ not_ready
Definition: errors.h:108
@ cannot_lock
Definition: errors.h:178
SINT32 t2
Definition: tinetype.h:614
GrpTblEntry * GetCallbackGroup(size_t id)
Returns a reference to the callback Group Table Entry associated with the identifier supplied.
Definition: client.c:1070
UINT32 tMin
Definition: tinetype.h:670
char * GetLinkName(int i)
Returns the full link name associated with the input link index.
Definition: client.c:9950
char * rhsServerName
Definition: hstlib.h:196
@ non_existent
Definition: errors.h:84
char EqmSubSystem[SUBSYSTEM_NAME_SIZE]
Definition: srvcore.h:1786
int _SystemAssignBufferSpace(UINT32 rcvBufferSpace, UINT32 sndBufferSpace)
Assigns specific buffer capacity for certain configurable TINE sockets.
Definition: iplib.c:681
void SetUseMCastLegacyRules(int value)
Establishes legacy mutlicast systematics or not.
Definition: iplib.c:136
int AppendHistoryData(char *eqm, char *prp, char *dev, DTYPE *dout)
Inserts local history data into the local history ring buffer.
Definition: hstlib.c:2627
int GetDieOnAddressInUse(void)
Returns the current setting for this feature.
Definition: syslib.c:212
AclInfoType aclLst
Definition: srvcore.h:1862
double max
Definition: tinetype.h:666
char * GetLinkNameFromCallbackId(int id)
Returns the full link name associated with the callback identifier supplied.
Definition: client.c:9961
int ResetServerBaseline(const char *eqm)
Resets a server baseline timestamp to the current time.
Definition: srvdbase.c:7078
void SetExportedContext(char *eqmName, char *context)
Assigns the exported context associated with the equipment function name given.
Definition: srvdbase.c:270
Defines a TINE pairwise data object containing a 32-character fixed-length string followed by a 4-byt...
Definition: tinetype.h:307
Defines a TINE pairwise data object containing a pairwise double doublet.
Definition: tinetype.h:389
float s_inc
Definition: tinetype.h:734
@ pipe_error
Definition: errors.h:272
int chkNormal
Definition: almlib.h:373
void SetSystemUseDataProtection(int value)
Sets the data protection flag to the value given.
Definition: syslib.c:6530
float f2val
Definition: tinetype.h:404
int GetDataFromCallbackId(int id, DTYPE *dout, UINT16 *status)
Supplies the DTYPE data object and call status for the callback ID in question.
Definition: client.c:9906
void SetSystemLogging(int value)
Sets system logging (output to fec.log) to TRUE or FALSE.
Definition: syslib.c:5996
int sendNetGlobal(char *keyword, DTYPE *din, void(*callback)(int, int), int minPeriod, int maxPeriod, double tolerance)
registers and sends the accompanying keyword and data as a network global.
Definition: srvdbase.c:8843
double d2val
Definition: tinetype.h:588
int RemoveRegisteredUser(char *eqm, NAME16 *userlist, int listsize)
removes those users in the name list given from the current users access list.
Definition: srvdbase.c:1117
float max
Definition: tinetype.h:1030
int GetHostNameFromAddress(char *addr, char *host, int length)
Gets the host name from the address given.
BYTE prpAccess
Definition: tinetype.h:4057
Linked list structure used to hold equipment module information.
Definition: srvcore.h:1782
void ClearDeviceAlarm(char *eqm, char *devname)
Instructs the local alarm server table that the given alarm is to be cleared.
Definition: Alarm API Calls:2347
Defines an extended property query structure (legacy)
Definition: tinetype.h:4040
int GetAlarmTableMaximumSize(void)
Gets the maximum number of alarms managed by the local alarm server.
Definition: Alarm API Calls:2354
int AlarmHeartbeat
Determines the time interval at the 'HEARTBEAT' flag will be re-issued for persistent alarms.
Definition: Alarm API Calls:67
char name[64]
Definition: tinetype.h:274
int SealTaggedStruct(char *tag, int size, int number)
Seals a tagged structure (registration finished!).
Definition: srvdbase.c:8751
SINT32 i2val
Definition: tinetype.h:628
@ link_timeout
Definition: errors.h:129
int GetUseMultiThreadedEquipmentFunctions(void)
Returns whether an equipment module equipment function can run in a separate threads (boolean).
Definition: syslib.c:2746
@ invalid_name
Definition: errors.h:236
UINT16 prpHistoryDepthShort
Definition: tinetype.h:4053
int SetFailoverMaster(char *eqm, char *masterName)
Sets the designated server as a failover master.
Definition: srvdbase.c:8098
void SetUseGlobalSynchronization(int value)
Determines whether data timestamps are to be externally synchronized.
Definition: syslib.c:5520
@ low_main_memory
Definition: errors.h:284
UINT32 dArrayLength
Definition: tinetype.h:998
void SetSystemCycleDeadband(int value)
Sets the system cycle deadband.
Definition: srvdbase.c:9374
void SetClnRecvQueueDepth(int depth)
Sets the default client-side receive queue depth for all client links.
Definition: client.c:10367
char name[16]
Definition: tinetype.h:297
int useMinimalStorage
Instructs the local history server to use a simple UTC timestamp (4-byte integer) when saving data to...
Definition: hstlib.c:245
int FecIsInitialized(void)
Determines whether the FEC process has initialized services and all known equipment modules.
Definition: server.c:2575
@ warn_too_low
Definition: errors.h:218
@ device_not_ready
Definition: errors.h:239
UINT16 GetTransferFlag(int linkId)
Gets the data transfer flag for the given link ID.
Definition: client.c:10014
@ property_is_mca
Definition: errors.h:234
int SetSubscriptionRenewalThreshold(int linkId, int thresholdInPercent)
Gets the current client-side subscription threshold for the link in question.
Definition: client.c:2976
defines the standard central logger entry structure
Definition: tinetype.h:189
@ tcp_access_required
Definition: errors.h:285
int GetStreamTransportRetryLimit(void)
Returns the stream transport retry limit.
Definition: syslib.c:4580
int AssignPropertyNetsList(const char *eqm, const char *prp, NAME64 *ipnets, int nipnets)
Assigns an ip nets access list for the property given.
Definition: srvdbase.c:7169
TImageSourceHeader sourceHeader
Definition: tinetype.h:926
int codeLow
Definition: almlib.h:385
float aTolerance
Definition: hstlib.h:88
SINT32 ival
Definition: tinetype.h:697
SINT32 i1val
Definition: tinetype.h:350
int SetAlarmOscillationWindow(int value)
Sets the size of the alarm oscillation window in clear counts.
Definition: Alarm API Calls:2450
UINT32 prpSizeIn
Definition: tinetype.h:4112
int sendNetGlobalEx(char *context, char *keyword, DTYPE *din, void(*callback)(int, int), int minPeriod, int maxPeriod, double tolerance)
registers and sends the accompanying keyword and data as a network global for the specific context gi...
Definition: srvdbase.c:8835
AlmInfo almInfo
Definition: srvcore.h:1817
int GetAllowRemoteDebugging(void)
returns the current setting of this value
int number
Definition: srvcore.h:1755
Impressum
|
Imprint
|
Datenschutzerklaerung
|
Data Privacy Policy
|
Declaration of Accessibility
|
Erklaerung zur Barrierefreiheit
Generated for TINE API by
1.5.8