AP_Chunk Class Reference

Base class for all 'chunk' classes. More...

#include <correlator_plugin.hpp>

Public Member Functions
virtual	~AP_Chunk ()
	Pure virtual destructor. More...
virtual AP_Chunk *	copy (const AP_Context &ctx) const =0
	Chunk cloning method (typically calls a copy constructor in the derived class). More...
	AP_Chunk (const AP_Context &)
	Obsolete constructor retained for backward compatability. More...
	AP_Chunk ()
	Default constructor declared because there's a non-default one, which is deprecated. More...

Detailed Description

Base class for all 'chunk' classes.

Plugins should inherit from this class and add suitable data and function members in the derived class to manage their private data structures, in memory allocated by the plugin itself. AP_Chunk instances are passed in and out of plugin functions as the 'chunk value' of AP_Type objects, and referenced in MontitorScript code as variables of type 'chunk'. Note that the contents of a chunk are entirely opaque to MonitorScript.

Constructor & Destructor Documentation

virtual AP_Chunk::~AP_Chunk ( )

inlinevirtual

Pure virtual destructor.

It is essential that every AP_Chunk derived class implements this method to free any resources allocated by the derived class. The Engine will arrange for the destructor to be called when the associated MonitorScript chunk object is deleted.

The correlator interface may not be used from a chunk's destructor.

Also, correlator interface calls on another thread may block until the chunk's destructor returns. Chunk destructors that can block should therefore be careful to avoid deadlocking against such a thread.

AP_Chunk::AP_Chunk ( const AP_Context &  )

inlineexplicit

Obsolete constructor retained for backward compatability.

Deprecated:

This function is deprecated. The default constructor should be used instead.

AP_Chunk::AP_Chunk ( )

inline

Default constructor declared because there's a non-default one, which is deprecated.

This default constructor should be used.

Member Function Documentation

virtual AP_Chunk* AP_Chunk::copy ( const AP_Context &  ctx ) const

pure virtual

Chunk cloning method (typically calls a copy constructor in the derived class).

As with the destructor, it is essential for AP_Chunk derived classes to implement this method, to ensure that MonitorScript assignments to/from chunk objects work correctly.

Parameters

ctx	Execution context for the copy operation.

Returns

Pointer to a copy of this AP_Chunk object.

---

The documentation for this class was generated from the following file:

• correlator_plugin.hpp