Package org.dcache.xrootd.protocol.messages

Class AbstractXrootdResponse<T extends XrootdRequest>

java.lang.Object

org.dcache.xrootd.protocol.messages.AbstractXrootdResponse<T>

All Implemented Interfaces:

XrootdResponse<T>

Direct Known Subclasses:

AuthenticationResponse, AwaitAsyncResponse, DirListResponse, ErrorResponse, LocateResponse, LoginResponse, OkResponse, OpenResponse, ProtocolResponse, RedirectResponse, StatResponse, StatxResponse, StringResponse, WaitRetryResponse

public abstract class AbstractXrootdResponse<T extends XrootdRequest>
extends java.lang.Object
implements XrootdResponse<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected T	request
protected int	stat

Constructor Summary

Constructors

Constructor	Description
AbstractXrootdResponse(T request, int stat)

Method Summary

Modifier and Type	Method	Description
protected abstract void	getBytes(io.netty.buffer.ByteBuf buffer)
abstract 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.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

request

protected final T extends XrootdRequest request

stat

protected final int stat

Constructor Detail

AbstractXrootdResponse

public AbstractXrootdResponse(T request,
                              int stat)

Method Detail

getRequest

public T getRequest()

Description copied from interface: XrootdResponse

Returns the request this is a response to.

Specified by:

getRequest in interface XrootdResponse<T extends XrootdRequest>

getStatus

public int getStatus()

Description copied from interface: XrootdResponse

The xrootd response status code.

Specified by:

getStatus in interface XrootdResponse<T extends XrootdRequest>

writeTo

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

Description copied from interface: XrootdResponse

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.

Specified by:

writeTo in interface XrootdResponse<T extends XrootdRequest>

getDataLength

public abstract int getDataLength()

Description copied from interface: XrootdResponse

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.

Specified by:

getDataLength in interface XrootdResponse<T extends XrootdRequest>

getBytes

protected abstract void getBytes(io.netty.buffer.ByteBuf buffer)