XrdSsiTaskReal Class Reference

#include <XrdSsiTaskReal.hh>

Inheritance diagram for XrdSsiTaskReal:

Collaboration diagram for XrdSsiTaskReal:

Classes
struct	dlQ

Public Types
enum	TaskStat {   isPend =0 , isWrite , isSync , isReady ,   isDone , isDead }
enum	respType { isBad =0 , isAlert , isData , isStream }
Public Types inherited from XrdSsiStream
enum	StreamType { isActive = 0 , isPassive }

Public Member Functions
void	Detach (bool force=false)
void	Finished (XrdSsiRequest &rqstR, const XrdSsiRespInfo &rInfo, bool cancel=false)
void *	Implementation ()
bool	Kill ()
int	ID ()
void	Init (XrdSsiRequest *rP, unsigned short tmo=0)
void	PostError ()
const char *	RequestID ()
void	SchedError (XrdSsiErrInfo *eInfo=0)
void	SendError ()
bool	SendRequest (const char *node)
int	SetBuff (XrdSsiErrInfo &eRef, char *buff, int blen, bool &last)
bool	SetBuff (XrdSsiErrInfo &eRef, char *buff, int blen)
void	SetTaskID (uint32_t tid, uint32_t sid)
int	XeqEvent (XrdCl::XRootDStatus *status, XrdCl::AnyObject **respP)
void	XeqEvFin ()
	XrdSsiTaskReal (XrdSsiSessReal *sP)
	~XrdSsiTaskReal ()
Public Member Functions inherited from XrdSsiEvent
void	AddEvent (XrdCl::XRootDStatus *st, XrdCl::AnyObject *resp)
void	ClrEvent ()
virtual void	DoIt ()
virtual void	HandleResponse (XrdCl::XRootDStatus *status, XrdCl::AnyObject *response)
	XrdSsiEvent ()
	~XrdSsiEvent ()
Public Member Functions inherited from XrdJob
	XrdJob (const char *desc="")
virtual	~XrdJob ()
Public Member Functions inherited from XrdCl::ResponseHandler
virtual	~ResponseHandler ()
virtual void	HandleResponseWithHosts (XRootDStatus *status, AnyObject *response, HostList *hostList)
Public Member Functions inherited from XrdSsiResponder
void	BindRequest (XrdSsiRequest &rqstR)
bool	UnBindRequest ()
Public Member Functions inherited from XrdSsiStream
virtual Buffer *	GetBuff (XrdSsiErrInfo &eRef, int &dlen, bool &last)
StreamType	Type ()
	XrdSsiStream (StreamType stype)
virtual	~XrdSsiStream ()

Public Attributes
dlQ	attList
Public Attributes inherited from XrdJob
XrdJob *	NextJob
const char *	Comment

Private Member Functions
bool	Ask4Resp ()
respType	GetResp (XrdCl::AnyObject **respP, char *&dbuf, int &dlen)
bool	RespErr (XrdCl::XRootDStatus *status)

Private Attributes
XrdSsiErrInfo	errInfo
XrdSsiSessReal *	sessP
XrdSsiRequest *	rqstP
XrdCl::AnyObject *	mdResp
XrdSysSemaphore *	wPost
char *	dataBuff
int	dataRlen
TaskStat	tStat
uint32_t	tskID
int	defer
unsigned short	tmOut
bool	mhPend

Additional Inherited Members
Static Public Member Functions inherited from XrdCl::ResponseHandler
static ResponseHandler *	Wrap (std::function< void(XRootDStatus &, AnyObject &)> func)
static ResponseHandler *	Wrap (std::function< void(XRootDStatus *, AnyObject *)> func)
Static Public Attributes inherited from XrdSsiResponder
static const int	MaxDirectXfr = 2097152
Protected Types inherited from XrdSsiResponder
enum	Status { wasPosted =0 , notPosted , notActive }
Protected Member Functions inherited from XrdSsiResponder
void	Alert (XrdSsiRespInfoMsg &aMsg)
char *	GetRequest (int &dlen)
void	ReleaseRequestBuffer ()
Status	SetMetadata (const char *buff, int blen)
Status	SetErrResponse (const char *eMsg, int eNum)
Status	SetNilResponse ()
Status	SetResponse (const char *buff, int blen)
Status	SetResponse (long long fsize, int fdnum)
Status	SetResponse (XrdSsiStream *strmP)
	XrdSsiResponder ()
virtual	~XrdSsiResponder ()
Protected Attributes inherited from XrdSsiEvent
char	tident [24]
Protected Attributes inherited from XrdSsiStream
const StreamType	SType
Static Protected Attributes inherited from XrdSsiResponder
static const int	MaxMetaDataSZ = 2097152
	2MB metadata limit

Member Enumeration Documentation

respType

enum XrdSsiTaskReal::respType

Enumerator
isBad
isAlert
isData
isStream

TaskStat

enum XrdSsiTaskReal::TaskStat

Enumerator
isPend
isWrite
isSync
isReady
isDone
isDead

Constructor & Destructor Documentation

XrdSsiTaskReal()

XrdSsiTaskReal::XrdSsiTaskReal ( XrdSsiSessReal *  sP )

inline

~XrdSsiTaskReal()

XrdSsiTaskReal::~XrdSsiTaskReal ( )

inline

References mdResp.

Member Function Documentation

Ask4Resp()

bool XrdSsiTaskReal::Ask4Resp ( )

private

Detach()

void XrdSsiTaskReal::Detach

(

bool

force = false

)

Finished()

void XrdSsiTaskReal::Finished ( XrdSsiRequest &  rqstR, const XrdSsiRespInfo &  rInfo, bool  cancel = false  )

virtual

Notify the responder that a request either completed or was canceled. This allows the responder to release any resources given to the request object (e.g. data response buffer or a stream). This method is invoked when XrdSsiRequest::Finished() is called by the client.

Parameters

rqstR	reference to the object describing the request.
rInfo	reference to the object describing the response.
cancel	False -> the request/response interaction completed. True -> the request/response interaction aborted because of an error or the client requested that the request be canceled.

Implements XrdSsiResponder.

GetResp()

respType XrdSsiTaskReal::GetResp ( XrdCl::AnyObject **  respP, char *&  dbuf, int &  dlen  )

private

ID()

int XrdSsiTaskReal::ID ( )

inline

References tskID.

Implementation()

void * XrdSsiTaskReal::Implementation ( )

inline

Init()

void XrdSsiTaskReal::Init ( XrdSsiRequest *  rP, unsigned short  tmo = 0  )

inline

References attList, defer, isPend, mdResp, mhPend, XrdSsiTaskReal::dlQ::next, XrdSsiTaskReal::dlQ::prev, rqstP, tmOut, tStat, and wPost.

Kill()

bool XrdSsiTaskReal::Kill

(

)

PostError()

void XrdSsiTaskReal::PostError

(

)

RequestID()

const char * XrdSsiTaskReal::RequestID ( )

inline

References XrdSsiRequest::GetRequestID(), and rqstP.

RespErr()

bool XrdSsiTaskReal::RespErr ( XrdCl::XRootDStatus *  status )

private

SchedError()

void XrdSsiTaskReal::SchedError

(

XrdSsiErrInfo *

eInfo = 0

)

SendError()

void XrdSsiTaskReal::SendError

(

)

SendRequest()

bool XrdSsiTaskReal::SendRequest

(

const char *

node

)

SetBuff() [1/2]

bool XrdSsiTaskReal::SetBuff ( XrdSsiErrInfo &  eRef, char *  buff, int  blen  )

virtual

Asynchronously obtain data from a passive stream (client-side only).

Parameters

eRef	reference to where error information is to be placed for encountered before during the stream initiation. When data is ready for processing, the ProcessResponseData() callback is called on the request associated with this stream. Also see XrdSsiRequest::GetResponseData() helper method.
buff	pointer to the buffer to receive the data. The buffer must remain valid until ProcessResponse() is called.
blen	the length of the buffer (i.e. maximum that can be returned).

Returns

true The stream has been successfully scheduled to return the data.

false The stream could not be scheduled; eRef holds the reason.

Reimplemented from XrdSsiStream.

SetBuff() [2/2]

int XrdSsiTaskReal::SetBuff ( XrdSsiErrInfo &  eRef, char *  buff, int  blen, bool &  last  )

virtual

Synchronously obtain data from a passive stream (client- or server-side).

Parameters

eRef	The object to receive any error description.
buff	pointer to the buffer to receive the data. request object is notified that the operation completed.
blen	the length of the buffer (i.e. maximum that can be returned).
last	input: should be set to false. output: if true it indicates that no more data remains to be returned either for this call or on the next call.

Returns

>0 The number of bytes placed in buff.

=0 No more data remains and the stream becomes invalid.

<0 Fatal error occurred; eRef holds the reason.

Reimplemented from XrdSsiStream.

SetTaskID()

void XrdSsiTaskReal::SetTaskID ( uint32_t  tid, uint32_t  sid  )

inline

References XrdSsiEvent::tident, and tskID.

XeqEvent()

int XrdSsiTaskReal::XeqEvent ( XrdCl::XRootDStatus *  status, XrdCl::AnyObject **  respP  )

virtual

Implements XrdSsiEvent.

XeqEvFin()

void XrdSsiTaskReal::XeqEvFin ( )

virtual

Implements XrdSsiEvent.

Member Data Documentation

attList

dlQ XrdSsiTaskReal::attList

Referenced by Init().

dataBuff

char* XrdSsiTaskReal::dataBuff

private

dataRlen

int XrdSsiTaskReal::dataRlen

private

defer

int XrdSsiTaskReal::defer

private

Referenced by Init().

errInfo

XrdSsiErrInfo XrdSsiTaskReal::errInfo

private

mdResp

XrdCl::AnyObject* XrdSsiTaskReal::mdResp

private

Referenced by Init(), and ~XrdSsiTaskReal().

mhPend

bool XrdSsiTaskReal::mhPend

private

Referenced by Init().

rqstP

XrdSsiRequest* XrdSsiTaskReal::rqstP

private

Referenced by Init(), and RequestID().

sessP

XrdSsiSessReal* XrdSsiTaskReal::sessP

private

tmOut

unsigned short XrdSsiTaskReal::tmOut

private

Referenced by Init().

tskID

uint32_t XrdSsiTaskReal::tskID

private

Referenced by ID(), and SetTaskID().

tStat

TaskStat XrdSsiTaskReal::tStat

private

Referenced by Init().

wPost

XrdSysSemaphore* XrdSsiTaskReal::wPost

private

Referenced by Init().

---

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

• XrdSsiTaskReal.hh