dbLink.h

Go to the documentation of this file.

/*************************************************************************\
* Copyright (c) 2010 The UChicago Argonne LLC, as Operator of Argonne
*     National Laboratory.
* Copyright (c) 2002 The Regents of the University of California, as
*     Operator of Los Alamos National Laboratory.
* SPDX-License-Identifier: EPICS
* EPICS BASE is distributed subject to a Software License Agreement found
* in file LICENSE that is included with this distribution.
\*************************************************************************/
/* dbLink.h
 *
 *  Created on: Mar 21, 2010
 *      Author: Andrew Johnson
 */

#ifndef INC_dbLink_H
#define INC_dbLink_H

#include "link.h"
#include "dbCoreAPI.h"
#include "epicsTypes.h"
#include "epicsTime.h"
#include "dbAddr.h"
#include "dbChannel.h"

#ifdef __cplusplus
extern "C" {
#endif

struct dbLocker;

typedef long (*dbLinkUserCallback)(struct link *plink, void *priv);

typedef struct lset {
    /* Characteristics of the link type */

    const unsigned isConstant:1;

    const unsigned isVolatile:1;

    void (*openLink)(struct link *plink);

    void (*removeLink)(struct dbLocker *locker, struct link *plink);

    /* Constant link initialization and data type hinting */

    long (*loadScalar)(struct link *plink, short dbrType, void *pbuffer);

    long (*loadLS)(struct link *plink, char *pbuffer, epicsUInt32 size,
            epicsUInt32 *plen);

    long (*loadArray)(struct link *plink, short dbrType, void *pbuffer,
            long *pnRequest);

    /* Metadata */

    int (*isConnected)(const struct link *plink);

    int (*getDBFtype)(const struct link *plink);

    /* Get data */

    long (*getElements)(const struct link *plink, long *pnElements);

    long (*getValue)(struct link *plink, short dbrType, void *pbuffer,
            long *pnRequest);

    long (*getControlLimits)(const struct link *plink, double *lo, double *hi);

    long (*getGraphicLimits)(const struct link *plink, double *lo, double *hi);

    long (*getAlarmLimits)(const struct link *plink, double *lolo, double *lo,
            double *hi, double *hihi);

    long (*getPrecision)(const struct link *plink, short *precision);

    long (*getUnits)(const struct link *plink, char *units, int unitsSize);

    long (*getAlarm)(const struct link *plink, epicsEnum16 *status,
            epicsEnum16 *severity);

    long (*getTimeStamp)(const struct link *plink, epicsTimeStamp *pstamp);

    /* Put data */

    long (*putValue)(struct link *plink, short dbrType,
            const void *pbuffer, long nRequest);

    long (*putAsync)(struct link *plink, short dbrType,
            const void *pbuffer, long nRequest);

    /* Process */

    void (*scanForward)(struct link *plink);

    /* Atomicity */

    long (*doLocked)(struct link *plink, dbLinkUserCallback rtn, void *priv);

    long (*getAlarmMsg)(const struct link *plink, epicsEnum16 *status,
                        epicsEnum16 *severity, char *msgbuf, size_t msgbuflen);

    long (*getTimeStampTag)(const struct link *plink, epicsTimeStamp *pstamp, epicsUTag *ptag);
} lset;

#define dbGetSevr(link, sevr) \
    dbGetAlarm(link, NULL, sevr)

DBCORE_API const char * dbLinkFieldName(const struct link *plink);

DBCORE_API void dbInitLink(struct link *plink, short dbfType);
DBCORE_API void dbAddLink(struct dbLocker *locker, struct link *plink,
        short dbfType, dbChannel *ptarget);

DBCORE_API void dbLinkOpen(struct link *plink);
DBCORE_API void dbRemoveLink(struct dbLocker *locker, struct link *plink);

DBCORE_API int dbLinkIsDefined(const struct link *plink);  /* 0 or 1 */
DBCORE_API int dbLinkIsConstant(const struct link *plink); /* 0 or 1 */
DBCORE_API int dbLinkIsVolatile(const struct link *plink); /* 0 or 1 */

DBCORE_API long dbLoadLink(struct link *plink, short dbrType,
        void *pbuffer);
DBCORE_API long dbLoadLinkArray(struct link *, short dbrType, void *pbuffer,
        long *pnRequest);

DBCORE_API long dbGetNelements(const struct link *plink, long *pnElements);
DBCORE_API int dbIsLinkConnected(const struct link *plink); /* 0 or 1 */
DBCORE_API int dbGetLinkDBFtype(const struct link *plink);
DBCORE_API long dbTryGetLink(struct link *, short dbrType, void *pbuffer,
        long *nRequest);
DBCORE_API long dbGetLink(struct link *, short dbrType, void *pbuffer,
        long *options, long *nRequest);
DBCORE_API long dbGetControlLimits(const struct link *plink, double *low,
        double *high);
DBCORE_API long dbGetGraphicLimits(const struct link *plink, double *low,
        double *high);
DBCORE_API long dbGetAlarmLimits(const struct link *plink, double *lolo,
        double *low, double *high, double *hihi);
DBCORE_API long dbGetPrecision(const struct link *plink, short *precision);
DBCORE_API long dbGetUnits(const struct link *plink, char *units,
        int unitsSize);
DBCORE_API long dbGetAlarm(const struct link *plink, epicsEnum16 *status,
        epicsEnum16 *severity);
DBCORE_API long dbGetAlarmMsg(const struct link *plink, epicsEnum16 *status,
        epicsEnum16 *severity, char *msgbuf, size_t msgbuflen);
#define dbGetAlarmMsg(LINK, STAT, SEVR, BUF, BUFLEN) dbGetAlarmMsg(LINK, STAT, SEVR, BUF, BUFLEN)
DBCORE_API long dbGetTimeStamp(const struct link *plink,
        epicsTimeStamp *pstamp);
DBCORE_API long dbGetTimeStampTag(const struct link *plink,
        epicsTimeStamp *pstamp, epicsUTag *ptag);
#define dbGetTimeStampTag(LINK, STAMP, TAG) dbGetTimeStampTag(LINK, STAMP, TAG)
DBCORE_API long dbPutLink(struct link *plink, short dbrType,
        const void *pbuffer, long nRequest);
DBCORE_API void dbLinkAsyncComplete(struct link *plink);
DBCORE_API long dbPutLinkAsync(struct link *plink, short dbrType,
        const void *pbuffer, long nRequest);
DBCORE_API void dbScanFwdLink(struct link *plink);

DBCORE_API long dbLinkDoLocked(struct link *plink, dbLinkUserCallback rtn,
        void *priv);

DBCORE_API long dbLoadLinkLS(struct link *plink, char *pbuffer,
        epicsUInt32 size, epicsUInt32 *plen);
DBCORE_API long dbGetLinkLS(struct link *plink, char *pbuffer,
        epicsUInt32 buffer_size, epicsUInt32 *plen);
DBCORE_API long dbPutLinkLS(struct link *plink, char *pbuffer,
        epicsUInt32 len);

#ifdef __cplusplus
}
#endif

#endif /* INC_dbLink_H */