org.dcache.xrootd.protocol.messages

Interface XrootdResponse<T extends XrootdRequest>

All Known Implementing Classes:

AbstractXrootdResponse, AsyncResponse, AuthenticationResponse, AwaitAsyncResponse, DirListResponse, DirListStatResponse, ErrorResponse, LocateResponse, LoginResponse, OkResponse, OpenResponse, ProtocolResponse, QueryResponse, ReadResponse, ReadVResponse, RedirectResponse, SetResponse, StatResponse, StatxResponse, StringResponse, ZeroCopyReadResponse

public interface XrootdResponse<T extends XrootdRequest>

An xrootd response message. Response objects may be reference counted.

Method Summary

Modifier and Type	Method and Description
int	getDataLength() Returns the length of the response body.
T	getRequest() Returns the request this is a response to.
int	getStatus() The xrootd response status code.
void	writeTo(io.netty.channel.ChannelHandlerContext ctx, io.netty.channel.ChannelPromise promise) Writes the encoded message to the given channel context.

Method Detail

getRequest

T getRequest()

Returns the request this is a response to.

getStatus

int getStatus()

The xrootd response status code.

writeTo

void writeTo(io.netty.channel.ChannelHandlerContext ctx,
             io.netty.channel.ChannelPromise promise)

Writes the encoded message to the given channel context. Does not flush the channel. This is a destructive call and must at most be called once. Decreases the reference count by 1 and deallocates this object if the reference count reaches 0.

getDataLength

int getDataLength()

Returns the length of the response body. This is the value of the dlen field in the Xrootd Server Response Format. This does not include the length of the 8 byte header.