XrdOucECMsg.hh

Go to the documentation of this file.

#ifndef __OUC_ECMSG_H__
#define __OUC_ECMSG_H__
/******************************************************************************/
/*                                                                            */
/*                        X r d O u c E C M s g . h h                         */
/*                                                                            */
/* (c) 2023 by the Board of Trustees of the Leland Stanford, Jr., University  */
/*   Produced by Andrew Hanushevsky for Stanford University under contract    */
/*              DE-AC02-76-SFO0515 with the Department of Energy              */
/*                                                                            */
/* This file is part of the XRootD software suite.                            */
/*                                                                            */
/* XRootD is free software: you can redistribute it and/or modify it under    */
/* the terms of the GNU Lesser General Public License as published by the     */
/* Free Software Foundation, either version 3 of the License, or (at your     */
/* option) any later version.                                                 */
/*                                                                            */
/* XRootD is distributed in the hope that it will be useful, but WITHOUT      */
/* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or      */
/* FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public       */
/* License for more details.                                                  */
/*                                                                            */
/* You should have received a copy of the GNU Lesser General Public License   */
/* along with XRootD in a file called COPYING.LESSER (LGPL license) and file  */
/* COPYING (GPL license).  If not, see <http://www.gnu.org/licenses/>.        */
/*                                                                            */
/* The copyright holder's institutional names and contributor's names may not */
/* be used to endorse or promote products derived from this software without  */
/* specific prior written permission of the institution or contributor.       */
/*                                                                            */
/******************************************************************************/
 
#include <cstdarg>
#include <string>
 
#include "XrdSys/XrdSysPthread.hh"
 
class XrdOucECMsg
{
public:
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
XrdOucECMsg& Append(char dlm='\n')
                   {ecMTX.Lock(); Delim = dlm; ecMTX.UnLock(); return *this;}
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
int   Get(std::string& ecm, bool rst=true);
int   Get() {return eCode;}
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
bool  hasMsg() const {ecMTX.Lock(); bool hm = !ecMsg.empty();
                      ecMTX.UnLock(); return hm;
                     }
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
std::string Msg() {ecMTX.Lock(); std::string m = ecMsg; ecMTX.UnLock();
                   return m;
                  }
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
void  Msg(const char* pfx,    const char* txt1,
          const char* txt2=0, const char* txt3=0,
          const char* txt4=0, const char* txt5=0);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
void  Msgf(const char *pfx, const char *fmt, ...);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
void  MsgVA(const char *pfx, const char *fmt, std::va_list aP);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
void  MsgVec(const char* pfx, char const* const* vecP, int vecN);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
void  Set(int ecc, const char*  ecm="")
         {ecMTX.Lock(); eCode = ecc; if (ecm) ecMsg = ecm; ecMTX.UnLock();}
 
void  Set(int ecc, std::string& ecm)
         {ecMTX.Lock(); eCode = ecc; ecMsg = ecm; ecMTX.UnLock();}
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
int   SetErrno(int ecc, int ret=-1, const char *alt=0);
 
//-----------------------------------------------------------------------------
//-----------------------------------------------------------------------------
 
   XrdOucECMsg& operator=(const int rhs)
           {ecMTX.Lock(); eCode = rhs; ecMTX.UnLock(); return *this;}
 
   XrdOucECMsg& operator=(const std::string& rhs)
           {ecMTX.Lock(); ecMsg = rhs; ecMTX.UnLock(); return *this;}
 
   XrdOucECMsg& operator=(const char* rhs)
           {ecMTX.Lock(); ecMsg = rhs; ecMTX.UnLock(); return *this;}
 
   XrdOucECMsg& operator=(XrdOucECMsg& rhs)
           {ecMTX.Lock(); ecMsg = rhs.ecMsg; eCode = rhs.eCode; ecMTX.UnLock();
            return *this;
           }
 
      XrdOucECMsg(const char *msgid=0) : msgID(msgid), eCode(0), Delim(0)  {}
     ~XrdOucECMsg() {}
 
private:
 
void        Setup(const char *pfx, int n);
mutable
XrdSysMutex ecMTX;
const char* msgID;
std::string ecMsg;
int         eCode;
char        Delim;
};
#endif