#include <XrdSsiRequest.hh>
◆ XrdSsiRequest()
XrdSsiRequest::XrdSsiRequest |
( |
const char * |
reqid = 0 , |
|
|
uint16_t |
tmo = 0 |
|
) |
| |
Constructor
- Parameters
-
reqid | Pointer to a request ID that can be used to group requests. See ProcessResponseData() and RestartDataReponse(). If reqid is nil then held responses are placed in the global queue. The pointer must be valid for the life of this object. |
tmo | The request initiation timeout value 0 equals default). |
◆ ~XrdSsiRequest()
virtual XrdSsiRequest::~XrdSsiRequest |
( |
| ) |
|
|
inlineprotectedvirtual |
Destructor. This object can only be deleted by the object creator. Once the object is passed to XrdSsiService::ProcessRequest() it may only be deleted after Finished() is called to allow the service to reclaim any resources allocated for the request object.
◆ Alert()
Send or receive a server generated alert.
The Alert() method is used server-side to send one or more alerts before a response is posted (alerts afterwards are ignored). To avoid race conditions, server-side alerts should be sent via the Responder's Alert() method. Clients must implement this method in order to receive alerts.
- Parameters
-
aMsg | Reference to the message object containing the alert message. Non-positive alert lengths cause the alert call to be ignored. You should call the message RecycleMsg() method once you have consumed the message to release its resources. |
Reimplemented in XrdSsiFileReq.
References XrdSsiRespInfoMsg::RecycleMsg().
Referenced by XrdSsiRRAgent::Alert().
◆ BindDone()
virtual void XrdSsiRequest::BindDone |
( |
| ) |
|
|
inlineprivatevirtual |
◆ CleanUp()
void XrdSsiRequest::CleanUp |
( |
| ) |
|
|
private |
◆ CopyData()
bool XrdSsiRequest::CopyData |
( |
char * |
buff, |
|
|
int |
blen |
|
) |
| |
|
private |
◆ Dispose()
virtual void XrdSsiRequest::Dispose |
( |
| ) |
|
|
inlineprivatevirtual |
◆ Finished()
bool XrdSsiRequest::Finished |
( |
bool |
cancel = false | ) |
|
Indicate that request processing has been finished. This method calls XrdSsiResponder::Finished() on the associated responder object.
Note: This method locks the object's recursive mutex.
- Parameters
-
cancel | False -> the request/response sequence completed normally. True -> the request/response sequence aborted because of an error or the client cancelled the request. |
- Returns
- true Finish accepted. Request object may be reclaimed.
-
false Finish cannot be accepted because this request object is not bound to a responder. This indicates a logic error.
◆ GetDetachTTL()
uint32_t XrdSsiRequest::GetDetachTTL |
( |
| ) |
|
|
inline |
Obtain the detached request time to live value. If the value is non-zero, the request is detached. Otherwise, it is an attached request and requires a live TCP connection during it execution.
- Returns
- The detached time to live value in seconds.
References detTTL.
◆ GetEndPoint()
std::string XrdSsiRequest::GetEndPoint |
( |
| ) |
|
Obtain the endpoint host name.
- Returns
- A string containing the endpoint host name. If a null string is returned, the endpoint has not yet been determined. Generally, the endpoint is available on the first callback to this object.
◆ GetMetadata()
const char * XrdSsiRequest::GetMetadata |
( |
int & |
dlen | ) |
|
Obtain the metadata associated with a response.
Note: This method locks the object's recursive mutex.
- Parameters
-
dlen | holds the length of the metadata after the call. |
- Returns
- =0 No metadata available, dlen has been set to zero.
-
!0 Pointer to the buffer holding the metadata, dlen has the length
◆ GetRequest()
virtual char * XrdSsiRequest::GetRequest |
( |
int & |
dlen | ) |
|
|
pure virtual |
Obtain the request data sent by a client.
This method is duplicated in XrdSsiResponder to allow calling consistency.
- Parameters
-
dlen | holds the length of the request after the call. |
- Returns
- =0 No request data available, dlen has been set to zero.
-
!0 Pointer to the buffer holding the request, dlen has the length
Implemented in XrdSsiFileReq.
◆ GetRequestID()
const char * XrdSsiRequest::GetRequestID |
( |
| ) |
|
|
inline |
Get the request ID established at object creation time.
- Returns
- Pointer to the request ID or nil if there is none.
References reqID.
Referenced by XrdSsiTaskReal::RequestID().
◆ GetResponseData()
void XrdSsiRequest::GetResponseData |
( |
char * |
buff, |
|
|
int |
blen |
|
) |
| |
Asynchronously obtain response data. This is a helper method that allows a client to deal with a passive stream response. This method also handles data response, albeit inefficiently by copying the data response. However, this allows for uniform response processing regardless of response type.
- Parameters
-
buff | pointer to the buffer to receive the data. The buffer must remain valid until ProcessResponseData() is called. |
blen | the length of the buffer (i.e. maximum that can be returned). |
◆ GetTimeOut()
uint16_t XrdSsiRequest::GetTimeOut |
( |
| ) |
|
|
inline |
Get timeout for initiating the request.
- Returns
- The timeout value.
References tOut.
◆ ProcessResponse()
Notify request that a response is ready to be processed. This method must be supplied by the request object's implementation.
- Parameters
-
eInfo | Error information. You can check if an error occurred using eInfo.hasError() or eInfo.isOK(). |
rInfo | Raw response information. |
- Returns
- true Response processed.
-
false Response could not be processed, the request is not active.
Implemented in XrdSsiFileReq.
◆ ProcessResponseData()
virtual void XrdSsiRequest::ProcessResponseData |
( |
const XrdSsiErrInfo & |
eInfo, |
|
|
char * |
buff, |
|
|
int |
blen, |
|
|
bool |
last |
|
) |
| |
|
inlinevirtual |
Handle incoming async stream data or error. This method is called by a stream object after a successful GetResponseData() or an asynchronous stream SetBuff() call.
- Parameters
-
eInfo | Error information. You can check if an error occurred using eInfo.hasError() or eInfo.isOK(). |
buff | Pointer to the buffer given to XrdSsiStream::SetBuff(). |
blen | The number of bytes in buff or an error indication if blen < 0. |
last | true This is the last stream segment, no more data remains. false More data may remain in the stream. |
◆ ReleaseRequestBuffer()
void XrdSsiRequest::ReleaseRequestBuffer |
( |
| ) |
|
Release the request buffer of the request bound to this object. This method duplicates the protected method RelRequestBuffer() and exists here for calling safety and consistency relative to the responder.
◆ RelRequestBuffer()
virtual void XrdSsiRequest::RelRequestBuffer |
( |
| ) |
|
|
inlineprotectedvirtual |
Release the request buffer. Use this method to optimize storage use; this is especially relevant for long-running requests. If the request buffer has been consumed and is no longer needed, early return of the buffer will minimize memory usage. This method is also invoked via XrdSsiResponder.
Note: This method is called with the object's recursive mutex locked when it is invoked via XrdSsiResponder's ReleaseRequestBuffer().
Reimplemented in XrdSsiFileReq.
◆ SetDetachTTL()
void XrdSsiRequest::SetDetachTTL |
( |
uint32_t |
dttl | ) |
|
|
inlineprotected |
Set the detached request time to live value.
By default, requests are executed in the foreground (i.e. during its execution, if the TCP connection drops, the request is automatically cancelled. When a non-zero time to live is set, the request is executed in the background (i.e. detached) and no persistent TCP connection is required. You must use the XrdSsiService::Attach() method to foreground such a request within the number of seconds specified for dttl or the request is automatically cancelled. The value must be set before passing the request to XrdSsiService::ProcessRequest(). Once the request is started, a request handle is returned which can be passed to XrdSsiService::Attach().
- Parameters
-
dttl | The detach time to live value. |
References detTTL.
◆ SetRetry()
void XrdSsiRequest::SetRetry |
( |
bool |
onoff | ) |
|
|
protected |
Set request retry notification. If a non-default value is desired, it must be set prior to calling XrdSsiService::ProcessRequest(). This is a one-time request and retry mode is turned off in the request object afterwards.
- Parameters
-
onoff | True to turn retry on and false to turn it off. |
◆ SetTimeOut()
void XrdSsiRequest::SetTimeOut |
( |
uint16_t |
tmo | ) |
|
|
inlineprotected |
◆ XrdSsiResponder
◆ XrdSsiRRAgent
◆ detTTL
uint32_t XrdSsiRequest::detTTL |
|
private |
◆ epNode
const char* XrdSsiRequest::epNode |
|
private |
◆ errInfo
◆ flags
char XrdSsiRequest::flags |
|
private |
◆ isaRetry
const int XrdSsiRequest::isaRetry = 1 |
|
staticprivate |
◆ onClient
bool XrdSsiRequest::onClient |
|
private |
◆ reqID
const char* XrdSsiRequest::reqID |
|
private |
◆ Resp
◆ rrMutex
◆ rsvd1
long long XrdSsiRequest::rsvd1 |
|
private |
◆ theRespond
◆ tOut
uint16_t XrdSsiRequest::tOut |
|
private |
The documentation for this class was generated from the following file: