Files
pvxs/ioc/groupsource.h
T
2023-05-09 10:17:32 -07:00

92 lines
3.4 KiB
C++

/*
* Copyright - See the COPYRIGHT that is included with this distribution.
* pvxs is distributed subject to a Software License Agreement found
* in file LICENSE that is included with this distribution.
*
* Author George S. McIntyre <george@level-n.com>, 2023
*
*/
#ifndef PVXS_GROUPSOURCE_H
#define PVXS_GROUPSOURCE_H
#include "dbeventcontextdeleter.h"
#include "groupsrcsubscriptionctx.h"
#include "iocserver.h"
#include "iocsource.h"
#include "securityclient.h"
namespace pvxs {
namespace ioc {
class GroupSource : public server::Source {
public:
GroupSource();
void onCreate(std::unique_ptr<server::ChannelControl>&& channelControl) final;
/**
* Implementation of the onList() interface of pvxs::server::Source to return a list of all records
* managed by this source.
*
* @return all records managed by this source
*/
List onList() final {
return allRecords;
}
void onSearch(Search& searchOperation) final;
void show(std::ostream& outputStream) final;
private:
// List of all database records that this single source serves
List allRecords;
// The event context for all subscriptions
DBEventContext eventContext;
// Create request and subscription handlers for single record sources
void createRequestAndSubscriptionHandlers(std::unique_ptr<server::ChannelControl>& channelControl,
Group& group);
// Handles all get, put and subscribe requests
static void onOp(Group& group, std::unique_ptr<server::ConnectOp>&& channelConnectOperation);
//////////////////////////////
// Get
//////////////////////////////
static void get(Group& group, std::unique_ptr<server::ExecOp>& getOperation);
static void groupGet(Group& group, const std::function<void(Value&)>& returnFn,
const std::function<void(const char*)>& errorFn);
static bool getGroupField(const Field& field, Value valueTarget, const std::string& groupName,
const std::function<void(const char*)>& errorFn);
//////////////////////////////
// Put
//////////////////////////////
static void putGroup(Group& group, std::unique_ptr<server::ExecOp>& putOperation, const Value& value,
const GroupSecurityCache& groupSecurityCache);
//////////////////////////////
// Subscriptions
//////////////////////////////
// Called when values are requested by a subscription
static void
subscriptionValueCallback(void* userArg, dbChannel* pDbChannel, int eventsRemaining, db_field_log* pDbFieldLog);
static void
subscriptionPropertiesCallback(void* userArg, dbChannel* pDbChannel, int eventsRemaining,
db_field_log* pDbFieldLog);
static void
subscriptionCallback(FieldSubscriptionCtx* fieldSubscriptionCtx,
GetOperationType getOperationType, struct db_field_log* pDbFieldLog);
static void onDisableSubscription(const std::shared_ptr<GroupSourceSubscriptionCtx>& groupSubscriptionCtx);
static void onStartSubscription(const std::shared_ptr<GroupSourceSubscriptionCtx>& groupSubscriptionCtx);
void onSubscribe(const std::shared_ptr<GroupSourceSubscriptionCtx>& groupSubscriptionCtx,
std::unique_ptr<server::MonitorSetupOp>&& subscriptionOperation) const;
static void onStart(const std::shared_ptr<GroupSourceSubscriptionCtx>& groupSubscriptionCtx, bool isStarting);
static void putGroupField(const Value& value, const Field& field, const SecurityClient& securityClient);
};
} // ioc
} // pvxs
#endif //PVXS_GROUPSOURCE_H