PInterfaceMonitor Class Reference

#include <psockbun.h>

Inheritance diagram for PInterfaceMonitor:


Public Types
typedef PIPSocket::InterfaceEntry	InterfaceEntry
	DefaultRefreshInterval = 60000
enum	{ DefaultRefreshInterval = 60000 }
Public Member Functions
	PInterfaceMonitor (unsigned refreshInterval=DefaultRefreshInterval, bool runMonitorThread=true)
virtual	~PInterfaceMonitor ()
void	SetRefreshInterval (unsigned refresh)
	Change the refresh interval.
void	SetRunMonitorThread (bool runMonitorThread)
	Change whether the monitor thread should run.
void	Start ()
void	Stop ()
	Stop monitoring network interfaces.
PStringArray	GetInterfaces (bool includeLoopBack=false, const PIPSocket::Address &destination=PIPSocket::GetDefaultIpAny())
bool	IsValidBindingForDestination (const PIPSocket::Address &binding, const PIPSocket::Address &destination)
bool	GetInterfaceInfo (const PString &iface, InterfaceEntry &info) const
void	SetInterfaceFilter (PInterfaceFilter *filter)
bool	HasInterfaceFilter () const
virtual void	RefreshInterfaceList ()
void	OnRemoveNatMethod (const PNatMethod *natMethod)
Static Public Member Functions
static PInterfaceMonitor &	GetInstance ()
	Return the singleton interface for the network monitor.
static bool	IsMatchingInterface (const PString &iface, const InterfaceEntry &entry)
Protected Types
typedef PSmartPtr< PInterfaceMonitorClient >	ClientPtr
typedef std::list< PInterfaceMonitorClient * >	ClientList_T
Protected Member Functions
virtual void	OnShutdown ()
void	UpdateThreadMain ()
void	AddClient (PInterfaceMonitorClient *)
void	RemoveClient (PInterfaceMonitorClient *)
virtual void	OnInterfacesChanged (const PIPSocket::InterfaceTable &addedInterfaces, const PIPSocket::InterfaceTable &removedInterfaces)
Protected Attributes
ClientList_T	m_clients
PMutex	m_clientsMutex
PIPSocket::InterfaceTable	m_interfaces
PMutex	m_interfacesMutex
bool	m_runMonitorThread
PTimeInterval	m_refreshInterval
PMutex	m_threadMutex
PThread *	m_updateThread
PSyncPoint	m_signalUpdate
bool	m_threadRunning
PInterfaceFilter *	m_interfaceFilter
Friends
class	PInterfaceMonitorClient

Detailed Description

This class is a singleton that will monitor the network interfaces on a machine and update a list aof clients on any changes to the number or addresses of the interfaces.

A user may override this singleton by creating a derived class and making a static instance of it before any monitor client classes are created. This would typically be done in the users main program.

Member Typedef Documentation

typedef std::list<PInterfaceMonitorClient *> PInterfaceMonitor::ClientList_T [protected]

typedef PSmartPtr<PInterfaceMonitorClient> PInterfaceMonitor::ClientPtr [protected]

typedef PIPSocket::InterfaceEntry PInterfaceMonitor::InterfaceEntry

Member Enumeration Documentation

anonymous enum

Enumerator:

DefaultRefreshInterval

Constructor & Destructor Documentation

PInterfaceMonitor::PInterfaceMonitor	(	unsigned	refreshInterval = `DefaultRefreshInterval`,
		bool	runMonitorThread = `true`
	)

virtual PInterfaceMonitor::~PInterfaceMonitor ( ) [virtual]

Member Function Documentation

void PInterfaceMonitor::AddClient ( PInterfaceMonitorClient * ) [protected]

static PInterfaceMonitor& PInterfaceMonitor::GetInstance ( ) [static]

Return the singleton interface for the network monitor.

bool PInterfaceMonitor::GetInterfaceInfo	(	const PString &	iface,
		InterfaceEntry &	info
	)			const

Return information about an active interface given the descriptor string. Note that when searchin the descriptor may be a partial match e.g. "10.0.1.11" or "%eth0" may be used.

Parameters:

info

Interface desciptor name Information on the interface

PStringArray PInterfaceMonitor::GetInterfaces	(	bool	includeLoopBack = `false`,
		const PIPSocket::Address &	destination = `PIPSocket::GetDefaultIpAny()`
	)

Get an array of all current interface descriptors, possibly including the loopback (127.0.0.1) interface. Note the names are of the form ipname, eg "10.0.1.11%3Com 3C90x Ethernet Adapter" or "192.168.0.10%eth0"

Parameters:

destination

Flag for if loopback is to included in list

bool PInterfaceMonitor::HasInterfaceFilter ( ) const [inline]

static bool PInterfaceMonitor::IsMatchingInterface	(	const PString &	iface,
		const InterfaceEntry &	entry
	)			`[static]`

Returns whether the descriptor string equals the interface entry. Note that when searching the descriptor may be a partial match e.g. "10.0.1.11" or "%eth0" may be used.

Parameters:

entry

Interface descriptor Interface entry

bool PInterfaceMonitor::IsValidBindingForDestination	(	const PIPSocket::Address &	binding,
		const PIPSocket::Address &	destination
	)

Returns whether destination is reachable through binding or not. The default behaviour returns true unless there is an interface filter installed an the filter does not return 'binding' among it's interfaces.

virtual void PInterfaceMonitor::OnInterfacesChanged	(	const PIPSocket::InterfaceTable &	addedInterfaces,
		const PIPSocket::InterfaceTable &	removedInterfaces
	)			`[protected, virtual]`

void PInterfaceMonitor::OnRemoveNatMethod ( const PNatMethod * natMethod )

virtual void PInterfaceMonitor::OnShutdown ( ) [protected, virtual]

Reimplemented from PProcessStartup.

virtual void PInterfaceMonitor::RefreshInterfaceList ( ) [virtual]

void PInterfaceMonitor::RemoveClient ( PInterfaceMonitorClient * ) [protected]

void PInterfaceMonitor::SetInterfaceFilter ( PInterfaceFilter * filter )

Sets the monitor's interface filter. Note that the monitor instance handles deletion of the filter.

void PInterfaceMonitor::SetRefreshInterval ( unsigned refresh )

Change the refresh interval.

void PInterfaceMonitor::SetRunMonitorThread ( bool runMonitorThread )

Change whether the monitor thread should run.

void PInterfaceMonitor::Start ( )

Start monitoring network interfaces. If the monitoring thread is already running, then this will cause an refresh of the interface list as soon as possible. Note that this will happen asynchronously.

void PInterfaceMonitor::Stop ( )

Stop monitoring network interfaces.

void PInterfaceMonitor::UpdateThreadMain ( ) [protected]