Interface that represents an emphemeral master session. More...

#include <opendnp3/master/IMasterSession.h>

Public Member Functions
virtual	~IMasterSession ()=default

virtual void	BeginShutdown ()=0

virtual StackStatistics	GetStackStatistics ()=0

Public Member Functions inherited from opendnp3::IMasterOperations
virtual	~IMasterOperations ()

virtual std::shared_ptr< IMasterScan >	AddAllObjectsScan (GroupVariationID gvId, TimeDuration period, std::shared_ptr< ISOEHandler > soe_handler, const TaskConfig &config=TaskConfig::Default())=0
	Add a scan that requests all objects using qualifier code 0x06 @ return A proxy class used to manipulate the scan. More...

virtual std::shared_ptr< IMasterScan >	AddClassScan (const ClassField &field, TimeDuration period, std::shared_ptr< ISOEHandler > soe_handler, const TaskConfig &config=TaskConfig::Default())=0
	Add a class-based scan to the master. More...

virtual std::shared_ptr< IMasterScan >	AddRangeScan (GroupVariationID gvId, uint16_t start, uint16_t stop, TimeDuration period, std::shared_ptr< ISOEHandler > soe_handler, const TaskConfig &config=TaskConfig::Default())=0
	Add a start/stop (range) scan to the master. More...

virtual std::shared_ptr< IMasterScan >	AddScan (TimeDuration period, const std::vector< Header > &headers, std::shared_ptr< ISOEHandler > soe_handler, const TaskConfig &config=TaskConfig::Default())=0
	Add a recurring user-defined scan from a vector of headers @ return A proxy class used to manipulate the scan. More...

virtual void	PerformFunction (const std::string &name, FunctionCode func, const std::vector< Header > &headers, const TaskConfig &config=TaskConfig::Default())=0
	Perform any operation that requires just a function code. More...

virtual void	Restart (RestartType op, const RestartOperationCallbackT &callback, TaskConfig config=TaskConfig::Default())=0
	Perform a cold or warm restart and get back the time-to-complete value. More...

virtual void	Scan (const std::vector< Header > &headers, std::shared_ptr< ISOEHandler > soe_handler, const TaskConfig &config=TaskConfig::Default())=0
	Initiate a single user defined scan via a vector of headers. More...

virtual void	ScanAllObjects (GroupVariationID gvId, std::shared_ptr< ISOEHandler > soe_handler, const TaskConfig &config=TaskConfig::Default())=0
	Initiate a single scan that requests all objects (0x06 qualifier code) for a certain group and variation. More...

virtual void	ScanClasses (const ClassField &field, std::shared_ptr< ISOEHandler > soe_handler, const TaskConfig &config=TaskConfig::Default())=0
	Initiate a single class-based scan. More...

virtual void	ScanRange (GroupVariationID gvId, uint16_t start, uint16_t stop, std::shared_ptr< ISOEHandler > soe_handler, const TaskConfig &config=TaskConfig::Default())=0
	Initiate a single start/stop (range) scan. More...

virtual void	SetLogFilters (const opendnp3::LogLevels &filters)=0

virtual void	Write (const TimeAndInterval &value, uint16_t index, const TaskConfig &config=TaskConfig::Default())=0
	Write a time and interval object to a specific index. More...

Public Member Functions inherited from opendnp3::ICommandProcessor
virtual void	DirectOperate (CommandSet &&commands, const CommandResultCallbackT &callback, const TaskConfig &config=TaskConfig::Default())=0
	Direct operate a set of commands. More...

template<class T >
void	DirectOperate (const T &command, uint16_t index, const CommandResultCallbackT &callback, const TaskConfig &config=TaskConfig::Default())
	Direct operate a single command. More...

virtual void	SelectAndOperate (CommandSet &&commands, const CommandResultCallbackT &callback, const TaskConfig &config=TaskConfig::Default())=0
	Select and operate a set of commands. More...

template<class T >
void	SelectAndOperate (const T &command, uint16_t index, const CommandResultCallbackT &callback, const TaskConfig &config=TaskConfig::Default())
	Select/operate a single command. More...

Detailed Description

Interface that represents an emphemeral master session.

Definition at line 31 of file IMasterSession.h.

Constructor & Destructor Documentation

◆ ~IMasterSession()

virtual opendnp3::IMasterSession::~IMasterSession ( )

virtualdefault

Member Function Documentation

◆ BeginShutdown()

virtual void opendnp3::IMasterSession::BeginShutdown ( )

pure virtual

◆ GetStackStatistics()

virtual StackStatistics opendnp3::IMasterSession::GetStackStatistics ( )