CINOSBusHookCore Class Reference

Public Member Functions
	CINOSBusHookCore ()
	Create bus hook core handler.
	~CINOSBusHookCore ()
	Destroy bus hook core handler.
uint32	Setup (uint8 auCategories)
	Setup hook core with the given number of categories.
uint32	SetupCategory (uint8 auCategory, uint32 auCycletimeNs, uint32 auFlags)
	Setup hook category.
uint32	SetupDone (uint16 auHooks)
	Finalysing hook core setup with given max. number of hooks.
uint32	Shutdown (class CINOSBusHooks *apParent)
	Shutdown hook core handler.
bool	IsCategoryValid (uint8 auCategory)
	Check whether the given category number is valid.
bool	IsCategoryEnabled (uint8 auCategory)
	Check whether the given category number is enabled.

Protected Member Functions
	DECLARE_DYNAMIC (CINOSBusHookCore)

Protected Attributes
uint32	m_uCategories {}
CINOSBusHookCategory *	m_pCategories {}

Friends
class	CINOSBusHooks

Member Function Documentation

IsCategoryEnabled()

bool CINOSBusHookCore::IsCategoryEnabled

(

uint8

auCategory

)

Check whether the given category number is enabled.

Parameters

[in]

auCategory

Category number to check

Returns

true if enabled, false otherwise

IsCategoryValid()

bool CINOSBusHookCore::IsCategoryValid

(

uint8

auCategory

)

Check whether the given category number is valid.

Parameters

[in]

auCategory

Category number to check

Returns

true if valid, false otherwise

Setup()

uint32 CINOSBusHookCore::Setup

(

uint8

auCategories

)

Setup hook core with the given number of categories.

Parameters

[in]

auCategories

Requested number of categories

Returns

INOS_OK or an appropriate error

SetupCategory()

uint32 CINOSBusHookCore::SetupCategory	(	uint8	auCategory,
		uint32	auCycletimeNs,
		uint32	auFlags
	)

Setup hook category.

Parameters

[in]	auCategory	Number of category to set up
[in]	auCycletimeNs	Requested cycletime of this category
[in]	auFlags	Requested category flags (e.g. eFlgEnabled)

Returns

INOS_OK or an appropriate error

SetupDone()

uint32 CINOSBusHookCore::SetupDone

(

uint16

auHooks

)

Finalysing hook core setup with given max. number of hooks.

Parameters

[in]

auHooks

Max. number of hooks the hook handler owns

Returns

INOS_OK or an appropriate error

Shutdown()

uint32 CINOSBusHookCore::Shutdown

(

class CINOSBusHooks *

apParent

)

Shutdown hook core handler.

Parameters

[in]

apParent

Pointer to parent hook handler

Returns

INOS_OK or an appropriate error

Member Data Documentation

m_pCategories

CINOSBusHookCategory* CINOSBusHookCore::m_pCategories {}

protected

array of core handlers

m_uCategories

uint32 CINOSBusHookCore::m_uCategories {}

protected

max. number of categories

---

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

• /home/jenkins/workspace/inos_doxygen/os/inos/inc/cinosbushooks.h