AbstractXrootdOutboundRequest (xrootd4j core protocol 4.4.4 API)

java.lang.Object
- org.dcache.xrootd.tpc.protocol.messages.AbstractXrootdOutboundRequest

All Implemented Interfaces:

XrootdOutboundRequest

Direct Known Subclasses:

OutboundAuthenticationRequest, OutboundChecksumRequest, OutboundCloseRequest, OutboundEndSessionRequest, OutboundLoginRequest, OutboundOpenReadOnlyRequest, OutboundReadRequest, OutboundSigverRequest
```
public abstract class AbstractXrootdOutboundRequest
extends java.lang.Object
implements XrootdOutboundRequest
```
Supports outgoing client requests to the source server in third-party copies.
According to protocol, all client requests must have the following packet structure:

kXR_char streamid[2]

kXR_unt16 requestid

kXR_char parms[16]

kXR_int32 dlen

kXR_char data[dlen]

For the purposes of the third-party-client, none of these make use of the data or data length fields.

Field Summary

Fields
Modifier and Type Field Description

protected int requestId

protected int streamId

Constructor Summary

Constructors
Modifier Constructor Description

protected AbstractXrootdOutboundRequest(int streamId, int requestId)

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method	Description
`protected abstract void`	`getParams(io.netty.buffer.ByteBuf buffer)`
`protected abstract int`	`getParamsLen()`
`int`	`getRequestId()`
`int`	`getStreamId()`
`void`	`writeTo(io.netty.channel.ChannelHandlerContext ctx, io.netty.channel.ChannelPromise promise)`	Marshals this request object into a buffer and writes it to the context.
`protected void`	`writeToBuffer(io.netty.buffer.ByteBuf buffer)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

streamId
```
protected final int streamId
```

requestId
```
protected final int requestId
```

Constructor Detail

AbstractXrootdOutboundRequest

protected AbstractXrootdOutboundRequest(int streamId,
                                        int requestId)

Method Detail

getStreamId
```
public int getStreamId()
```
Specified by:

getStreamId in interface XrootdOutboundRequest

getRequestId
```
public int getRequestId()
```

writeTo
```
public void writeTo(io.netty.channel.ChannelHandlerContext ctx,
                    io.netty.channel.ChannelPromise promise)
```
Description copied from interface: XrootdOutboundRequest

Marshals this request object into a buffer and writes it to the context.

Specified by:

writeTo in interface XrootdOutboundRequest

writeToBuffer

protected void writeToBuffer(io.netty.buffer.ByteBuf buffer)

getParams

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

getParamsLen
```
protected abstract int getParamsLen()
```