Main Page | Class Hierarchy | Class List | Directories | File List | Class Members | File Members | Related Pages | Examples

ArServerDeleteFileOnServer Class Reference

#include <ArServerFileUtils.h>

List of all members.

Public Member Functions

void addPostDeleteCallback (ArFunctor *functor, ArListPos::Pos position=ArListPos::LAST)
 Adds a callback to be called after moving from temp dir to final loc.
void addPreDeleteCallback (ArFunctor *functor, ArListPos::Pos position=ArListPos::LAST)
 Adds a callback to be called before moving from temp dir to final loc.
 ArServerDeleteFileOnServer (ArServerBase *server, const char *topDir)
 Constructor.
void deleteFile (ArServerClient *client, ArNetPacket *packet)
 Deletes the file.
const char * getDeletingFileName (void)
 Gets the filename of the file we're deleting.
void remPostDeleteCallback (ArFunctor *functor)
 Removes a callback to be called after moving from temp dir to final loc.
void remPreDeleteCallback (ArFunctor *functor)
 Removes a callback to be called before moving from temp dir to final loc.
virtual ~ArServerDeleteFileOnServer ()
 Destructor.

Protected Attributes

char myBaseDir [2048]
ArFunctor2C< ArServerDeleteFileOnServer,
ArServerClient *, ArNetPacket * > 
myDeleteFileCB
std::string myDeletingFileName
std::list< ArFunctor * > myPostDeleteCallbacks
std::list< ArFunctor * > myPreDeleteCallbacks
ArServerBasemyServer


Detailed Description

Note:
Linux only
This class is set up so that a client can get delete files on the robot, this class ONLY deletes files. You should use this class by using ArClientDeleteFileOnServer and NOT by using this classes interface directly, this is because the API is and will remain fairly volatile... if you need more functionality let us know and we'll add it if its reasonable.

Definition at line 195 of file ArServerFileUtils.h.


Constructor & Destructor Documentation

ArServerDeleteFileOnServer::ArServerDeleteFileOnServer ArServerBase server,
const char *  topDir
 

Constructor.

Definition at line 1058 of file ArServerFileUtils.cpp.

References ArServerBase::addData(), ArUtil::appendSlash(), ArUtil::fixSlashes(), myBaseDir, myDeleteFileCB, and myServer.

ArServerDeleteFileOnServer::~ArServerDeleteFileOnServer  )  [virtual]
 

Destructor.

Definition at line 1078 of file ArServerFileUtils.cpp.


Member Function Documentation

void ArServerDeleteFileOnServer::addPostDeleteCallback ArFunctor functor,
ArListPos::Pos  position = ArListPos::LAST
 

Adds a callback to be called after moving from temp dir to final loc.

Definition at line 1223 of file ArServerFileUtils.cpp.

References ArLog::log(), and myPostDeleteCallbacks.

void ArServerDeleteFileOnServer::addPreDeleteCallback ArFunctor functor,
ArListPos::Pos  position = ArListPos::LAST
 

Adds a callback to be called before moving from temp dir to final loc.

Definition at line 1205 of file ArServerFileUtils.cpp.

References ArLog::log(), and myPreDeleteCallbacks.

void ArServerDeleteFileOnServer::deleteFile ArServerClient client,
ArNetPacket packet
 

Deletes the file.

Definition at line 1085 of file ArServerFileUtils.cpp.

References client, ArUtil::fixSlashes(), ArLog::log(), myBaseDir, myDeletingFileName, myPostDeleteCallbacks, myPreDeleteCallbacks, ArClientBase::sendPacketTcp(), ArBasePacket::strToBuf(), and ArBasePacket::uByte2ToBuf().

const char* ArServerDeleteFileOnServer::getDeletingFileName void   )  [inline]
 

Gets the filename of the file we're deleting.

Definition at line 217 of file ArServerFileUtils.h.

References myDeletingFileName.

void ArServerDeleteFileOnServer::remPostDeleteCallback ArFunctor functor  ) 
 

Removes a callback to be called after moving from temp dir to final loc.

Definition at line 1235 of file ArServerFileUtils.cpp.

References myPostDeleteCallbacks.

void ArServerDeleteFileOnServer::remPreDeleteCallback ArFunctor functor  ) 
 

Removes a callback to be called before moving from temp dir to final loc.

Definition at line 1217 of file ArServerFileUtils.cpp.

References myPreDeleteCallbacks.


Member Data Documentation

char ArServerDeleteFileOnServer::myBaseDir[2048] [protected]
 

Definition at line 219 of file ArServerFileUtils.h.

Referenced by ArServerDeleteFileOnServer(), and deleteFile().

ArFunctor2C<ArServerDeleteFileOnServer, ArServerClient *, ArNetPacket *> ArServerDeleteFileOnServer::myDeleteFileCB [protected]
 

Definition at line 222 of file ArServerFileUtils.h.

Referenced by ArServerDeleteFileOnServer().

std::string ArServerDeleteFileOnServer::myDeletingFileName [protected]
 

Definition at line 223 of file ArServerFileUtils.h.

Referenced by deleteFile(), and getDeletingFileName().

std::list<ArFunctor *> ArServerDeleteFileOnServer::myPostDeleteCallbacks [protected]
 

Definition at line 225 of file ArServerFileUtils.h.

Referenced by addPostDeleteCallback(), deleteFile(), and remPostDeleteCallback().

std::list<ArFunctor *> ArServerDeleteFileOnServer::myPreDeleteCallbacks [protected]
 

Definition at line 224 of file ArServerFileUtils.h.

Referenced by addPreDeleteCallback(), deleteFile(), and remPreDeleteCallback().

ArServerBase* ArServerDeleteFileOnServer::myServer [protected]
 

Definition at line 220 of file ArServerFileUtils.h.

Referenced by ArServerDeleteFileOnServer().


The documentation for this class was generated from the following files:
Generated on Tue Feb 20 10:51:51 2007 for ArNetworking by  doxygen 1.4.0