XrdOucSxeq Class Reference

#include <XrdOucSxeq.hh>

Collaboration diagram for XrdOucSxeq:

Public Member Functions
	XrdOucSxeq (const char *sfx, const char *sfx1=0, const char *Dir="/tmp/")
	XrdOucSxeq (int sOpts, const char *path)
	~XrdOucSxeq ()
int	Detach ()
int	lastError ()
int	Release ()
int	Serialize (int Opts=0)

Static Public Member Functions
static int	Release (int fileD)
static int	Serialize (int fileD, int Opts)

Static Public Attributes
static const int	Lock = 0x0008
static const int	noWait = 0x0001
static const int	Share = 0x0002
static const int	Unlink = 0x0004

Detailed Description

Definition at line 33 of file XrdOucSxeq.hh.

Constructor & Destructor Documentation

XrdOucSxeq() [1/2]

XrdOucSxeq::XrdOucSxeq	(	int	sOpts,
		const char *	path
	)

Definition at line 48 of file XrdOucSxeq.cc.

{
   static const int AMode = S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH;
   lokFN = strdup(path);
   lokUL = 0;
 
// Open the file, creating it
//
   if ((lokFD = open(lokFN, O_CREAT|O_RDWR, AMode)) < 0) lokRC = errno;
      else {lokRC = 0;
            if (sOpts) Serialize(sOpts);
           }
}

References open, and Serialize().

Here is the call graph for this function:

XrdOucSxeq() [2/2]

XrdOucSxeq::XrdOucSxeq	(	const char *	sfx,
		const char *	sfx1 = 0,
		const char *	Dir = "/tmp/"
	)

Definition at line 64 of file XrdOucSxeq.cc.

{
   static const int AMode = S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH;
   char pbuff[MAXPATHLEN+1], *pP;
 
// Construct the lock file name
//
   strcpy(pbuff, Dir);
   pP = pbuff + strlen(Dir);
   if (*sfx1 != '/' && *(pP-1) != '/') *pP++ = '/';
   strcpy(pP, sfx1);
   if (sfx2) strcpy(pP+strlen(sfx1), sfx2);
   lokFN = strdup(pbuff);
   lokUL = 0;
 
// Open the file, creating it
//
   if ((lokFD = open(lokFN, O_CREAT|O_RDWR, AMode)) < 0) lokRC = errno;
      else lokRC = 0;
}

References Dir, and open.

~XrdOucSxeq()

XrdOucSxeq::~XrdOucSxeq

(

)

Definition at line 89 of file XrdOucSxeq.cc.

{
 
// Check if we should unlink this file we need to do so while it's locked)
//
   if (lokFD >= 0 && lokUL) unlink(lokFN);
 
// Close the file and free th file name
//
   if (lokFD >= 0) close(lokFD);
   free(lokFN);
}

References close, and unlink.

Member Function Documentation

Detach()

int XrdOucSxeq::Detach ( )

inline

Definition at line 42 of file XrdOucSxeq.hh.

{int lFD = lokFD; lokFD = -1; return lFD;}

Referenced by XrdFrcXLock::Init().

Here is the caller graph for this function:

lastError()

int XrdOucSxeq::lastError ( )

inline

Definition at line 54 of file XrdOucSxeq.hh.

{return lokRC;}

Release() [1/2]

int XrdOucSxeq::Release

(

)

Definition at line 106 of file XrdOucSxeq.cc.

{
   FLOCK_t lock_args;
   int rc;
 
// If the file is not open, return failure
//
   if (lokFD < 0) return 0;
 
// Establish locking options
//
   bzero(&lock_args, sizeof(lock_args));
   lock_args.l_type = F_UNLCK;
 
// Now perform the action
//
   do {rc = fcntl(lokFD, F_SETLKW, &lock_args);}
      while(rc < 0 && errno == EINTR);
 
// Determine result
//
   if (rc < 0) {lokRC = errno; return 0;}
 
// We succeeded, unlink is not possible now
//
   lokUL = 0;
   lokRC = 0;
   return 1;
}

References fcntl(), and FLOCK_t.

Referenced by XrdFrcXLock::~XrdFrcXLock().

Here is the call graph for this function:

Here is the caller graph for this function:

Release() [2/2]

int XrdOucSxeq::Release ( int  fileD )

static

Definition at line 137 of file XrdOucSxeq.cc.

{
   FLOCK_t lock_args;
   int rc;
 
// If the file is not open, return failure
//
   if (fileD < 0) return EBADF;
 
// Establish locking options
//
   bzero(&lock_args, sizeof(lock_args));
   lock_args.l_type = F_UNLCK;
 
// Now perform the action
//
   do {rc = fcntl(fileD, F_SETLKW, &lock_args);}
      while(rc < 0 && errno == EINTR);
 
// Return result
//
   return (rc ? errno : 0);
}

References fcntl(), and FLOCK_t.

Here is the call graph for this function:

Serialize() [1/2]

int XrdOucSxeq::Serialize ( int  fileD, int  Opts  )

static

Definition at line 200 of file XrdOucSxeq.cc.

{
    FLOCK_t lock_args;
 
// Make sure we have a lock outstanding
//
    if (fileD < 0) return EBADF;
 
// Establish locking options
//
    bzero(&lock_args, sizeof(lock_args));
    if (opts & Share) lock_args.l_type = F_RDLCK;
       else           lock_args.l_type = F_WRLCK;
 
// Perform action.
//
    if (fcntl(fileD, (opts & noWait ? F_SETLK : F_SETLKW), &lock_args))
       return errno;
    return 0;
}

References fcntl(), FLOCK_t, noWait, opts, and Share.

Here is the call graph for this function:

Serialize() [2/2]

int XrdOucSxeq::Serialize

(

int

Opts = 0

)

Definition at line 165 of file XrdOucSxeq.cc.

{
   FLOCK_t lock_args;
   int Act, rc;
 
// If the file is not open, return failure
//
   if (lokFD < 0) return 0;
 
// Establish lock flags
//
 
// Establish locking options
//
   bzero(&lock_args, sizeof(lock_args));
   lock_args.l_type = (Opts & Share ? F_RDLCK : F_WRLCK);
   Act = (Opts & noWait ? F_SETLK : F_SETLKW);
 
// Now perform the action
//
   do {rc = fcntl(lokFD, Act, &lock_args);} while(rc < 0 && errno == EINTR);
 
// Determine result
//
   if (rc < 0) {lokRC = errno; return 0;}
 
// We succeeded check if an unlink is possible
//
   if (Opts & Unlink && !(Opts & Share)) lokUL = 1;
   lokRC = 0;
   return 1;
}

References fcntl(), FLOCK_t, noWait, Share, and Unlink.

Referenced by XrdFrcXLock::XrdFrcXLock(), and XrdOucSxeq().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

Lock

const int XrdOucSxeq::Lock = 0x0008

static

Definition at line 40 of file XrdOucSxeq.hh.

noWait

const int XrdOucSxeq::noWait = 0x0001

static

Definition at line 37 of file XrdOucSxeq.hh.

Referenced by Serialize(), and Serialize().

Share

const int XrdOucSxeq::Share = 0x0002

static

Definition at line 38 of file XrdOucSxeq.hh.

Referenced by Serialize(), and Serialize().

Unlink

const int XrdOucSxeq::Unlink = 0x0004

static

Definition at line 39 of file XrdOucSxeq.hh.

Referenced by Serialize().

---

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

• XrdOucSxeq.hh
• XrdOucSxeq.cc