MaxNetCallBack Class Reference

#include <maxnet_manager.h>

Class Description

See also

Class MaxNetManager

Description:

If you want to use the call back mechanisms provided by the MaxNetManager class, you create your own class derived from MaxNetCallBack and pass it as the argument for MaxNetManager::SetCallBack(). All methods are optional. You need only to implement those you want.

Inheritance diagram for MaxNetCallBack:

Public Member Functions
virtual	~MaxNetCallBack ()
virtual bool	Progress (int total, int current)
virtual void	ProgressMsg (const MCHAR *message)
virtual void	ManagerDown ()
virtual void	Update ()
virtual void	QueryControl (const MCHAR *station)
virtual void	QueueControl ()

Additional Inherited Members
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator. More...
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator. More...

Constructor & Destructor Documentation

virtual ~MaxNetCallBack ( )

inlinevirtual

Remarks

Destructor.

{;}

Member Function Documentation

virtual bool Progress ( int  total, int  current  )

inlinevirtual

Remarks

This method is called whenever a lengthy operation is under way. This includes large block transfers, file transfers, etc.

Parameters:

int total

A total amount of information to process.

int current

From the total amount, this is the current position.

Returns

TRUE if you want to cancel the operation, otherwise FALSE.

{return false;}

virtual void ProgressMsg ( const MCHAR *  message )

inlinevirtual

Remarks

This method is called to provide a textual message regarding the current process which is under way (connecting to a Manager, waiting for a reply, etc.)

Parameters:

const MCHAR* message

The text message.

{;}

virtual void ManagerDown ( )

inlinevirtual

Remarks

This method is called for messages which are sent to indicate that the Manager was shut down and is no longer available to service any requests.

{;}

virtual void Update ( )

inlinevirtual

Remarks

This method is called to indicate something has changed. This message is sent whenever a new job is sent to the queue, a Server changed its state, an error occurred, etc. This allows you to be kept up to date without the need to poll the Manager from time to time. Note that these messages are queued up. That is, if 10 jobs are deleted at once or any number of changes occur within a short period, you will only receive one Update() call.

{;}

virtual void QueryControl ( const MCHAR *  station )

inlinevirtual

Remarks

This method is called if someone requests control over the queue. If you do not have control over the queue, you do not need to respond to this message. If you have control over the queue and do nothing when this call is received, the Manager will timeout and take control over the queue. If you have control over the queue, you should respond to this message using MaxNetManager::GrantManagerControl() passing either a true value, indicating you are granting control, or a false value, indicating you do not want to relinquish control.

Parameters:

MCHAR* station

The name of the computer requesting control.

{;}

virtual void QueueControl ( )

inlinevirtual

Remarks

This method is called in order to notify that someone took control of the queue.

{;}