Svc::FileDownlink Class Reference

#include <Svc/FileDownlink/FileDownlink.hpp>

Inheritance diagram for Svc::FileDownlink:

Public Member Functions
	FileDownlink (const char *const compName)
void	init (const NATIVE_INT_TYPE queueDepth, const NATIVE_INT_TYPE instance)
void	configure (U32 timeout, U32 cooldown, U32 cycleTime, U32 fileQueueDepth)
void	preamble ()
	~FileDownlink ()

Detailed Description

Definition at line 25 of file FileDownlink.hpp.

Constructor & Destructor Documentation

FileDownlink()

Svc::FileDownlink::FileDownlink

(

const char *const

compName

)

Construct object FileDownlink

Parameters

compName

The component name

Definition at line 25 of file FileDownlink.cpp.

~FileDownlink()

Svc::FileDownlink::~FileDownlink

(

)

Destroy object FileDownlink

Definition at line 82 of file FileDownlink.cpp.

Member Function Documentation

configure()

void Svc::FileDownlink::configure	(	U32	timeout,
		U32	cooldown,
		U32	cycleTime,
		U32	fileQueueDepth
	)

Configure FileDownlink component

Parameters

timeout	Timeout threshold (milliseconds) while in WAIT state
cooldown	Cooldown (in ms) between finishing a downlink and starting the next file.
cycleTime	Rate at which we are running
fileQueueDepth	Max number of items in file downlink queue

Definition at line 55 of file FileDownlink.cpp.

init()

void Svc::FileDownlink::init	(	const NATIVE_INT_TYPE	queueDepth,
		const NATIVE_INT_TYPE	instance
	)

Initialize object FileDownlink

Parameters

queueDepth	The queue depth
instance	The instance number

Definition at line 46 of file FileDownlink.cpp.

preamble()

void Svc::FileDownlink::preamble

(

)

Start FileDownlink component The component must be configured with configure() before starting.

Definition at line 76 of file FileDownlink.cpp.

---

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

• Svc/FileDownlink/FileDownlink.hpp
• Svc/FileDownlink/FileDownlink.cpp