EMANE::FlowControlManager Class Reference

Flow Control Manager (token producer) side. More...

#include <flowcontrolmanager.h>

Public Member Functions
	FlowControlManager (EMANE::DownstreamTransport &transport)
	~FlowControlManager ()
void	start (std::uint16_t u16TotalTokensAvailable)
void	stop ()
std::pair< std::uint16_t, bool >	removeToken ()
std::pair< std::uint16_t, bool >	addToken (std::uint16_t u16Tokens=1)
void	processFlowControlMessage (const Controls::FlowControlControlMessage *pMsg)

Detailed Description

Flow Control Manager (token producer) side.

Definition at line 47 of file flowcontrolmanager.h.

Constructor & Destructor Documentation

FlowControlManager()

EMANE::FlowControlManager::FlowControlManager

(

EMANE::DownstreamTransport &

transport

)

Creates an instance

Parameters

transport

reference to the DownstremTransport

Definition at line 183 of file flowcontrolmanager.cc.

~FlowControlManager()

EMANE::FlowControlManager::~FlowControlManager

(

)

Destroys an instance

Definition at line 187 of file flowcontrolmanager.cc.

Member Function Documentation

addToken()

std::pair< std::uint16_t, bool > EMANE::FlowControlManager::addToken

(

std::uint16_t

u16Tokens = 1

)

Add one or more flow control token(s)

Parameters

u16Tokens

number of tokens

Returns

Total number of tokens available and a flag indicating success

Definition at line 199 of file flowcontrolmanager.cc.

processFlowControlMessage()

void EMANE::FlowControlManager::processFlowControlMessage

(

const Controls::FlowControlControlMessage *

pMsg

)

Handles a flow control update message

Parameters

pMsg	Flow control message

Definition at line 209 of file flowcontrolmanager.cc.

removeToken()

std::pair< std::uint16_t, bool > EMANE::FlowControlManager::removeToken

(

)

Removes a flow control token

Returns

Total number of tokens available and a flag indicating success

Definition at line 204 of file flowcontrolmanager.cc.

start()

void EMANE::FlowControlManager::start

(

std::uint16_t

u16TotalTokensAvailable

)

Starts flow control processing

Parameters

u16TotalTokensAvailable

initial number of flow control tokens available

Definition at line 189 of file flowcontrolmanager.cc.

stop()

void EMANE::FlowControlManager::stop

(

)

Stops flow control processing

Definition at line 194 of file flowcontrolmanager.cc.

---

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

• flowcontrolmanager.h
• flowcontrolmanager.cc