25 #ifndef __XRD_CL_POST_MASTER_INTERFACES_HH__
26 #define __XRD_CL_POST_MASTER_INTERFACES_HH__
99 virtual uint16_t
Examine( std::shared_ptr<Message> &msg ) = 0;
118 virtual uint16_t
GetSid()
const = 0;
140 uint32_t &bytesRead )
184 virtual bool IsRaw()
const {
return false; }
197 uint32_t &bytesWritten )
282 static const uint16_t
Name = 1;
283 static const uint16_t
Auth = 2;
409 uint16_t subStreamId ) = 0;
463 #endif // __XRD_CL_POST_MASTER_INTERFACES_HH__
virtual void MessageSent(Message *msg, uint16_t subStream, uint32_t bytesSent, AnyObject &channelData)=0
Notify the transport about a message having been sent.
Definition: XrdClAnyObject.hh:32
const uint16_t stOK
Everything went OK.
Definition: XrdClStatus.hh:31
virtual uint8_t OnStreamEvent(StreamEvent event, XRootDStatus status)
Definition: XrdClPostMasterInterfaces.hh:153
virtual void FinalizeChannel(AnyObject &channelData)=0
Finalize channel.
virtual void DecFileInstCnt(AnyObject &channelData)=0
Decrement file object instance count bound to this channel.
HandShakeData(const URL *addr, uint16_t subStream)
Constructor.
Definition: XrdClPostMasterInterfaces.hh:249
The message representation used throughout the system.
Definition: XrdClMessage.hh:29
virtual uint16_t GetSid() const =0
const XrdNetAddr * serverAddr
Server address.
Definition: XrdClPostMasterInterfaces.hh:260
time_t startTime
Timestamp of when the handshake started.
Definition: XrdClPostMasterInterfaces.hh:258
virtual ~ChannelEventHandler()
Destructor.
Definition: XrdClPostMasterInterfaces.hh:225
StreamAction
Stream actions that may be triggered by incoming control messages.
Definition: XrdClPostMasterInterfaces.hh:296
const URL * url
Destination URL.
Definition: XrdClPostMasterInterfaces.hh:256
Definition: XrdClOperationTimeout.hh:19
virtual PathID Multiplex(Message *msg, AnyObject &channelData, PathID *hint=0)=0
Definition: XrdClPostMasterInterfaces.hh:269
const uint16_t suDone
Definition: XrdClStatus.hh:38
uint16_t subStreamId
Sub-stream id.
Definition: XrdClPostMasterInterfaces.hh:257
Message handler.
Definition: XrdClPostMasterInterfaces.hh:50
virtual XRootDStatus ReadMessageBody(Message *msg, Socket *socket, uint32_t &bytesRead)
Definition: XrdClPostMasterInterfaces.hh:138
std::string clientName
Client name (an IPv6 representation)
Definition: XrdClPostMasterInterfaces.hh:261
static const uint16_t Name
Transport name, returns const char *.
Definition: XrdClPostMasterInterfaces.hh:282
virtual XRootDStatus WriteMessageBody(Socket *socket, uint32_t &bytesWritten)
Definition: XrdClPostMasterInterfaces.hh:196
Message * in
Message that has been received.
Definition: XrdClPostMasterInterfaces.hh:255
virtual uint32_t MessageReceived(Message &msg, uint16_t subStream, AnyObject &channelData)=0
Check if the message invokes a stream action.
virtual bool NeedEncryption(HandShakeData *handShakeData, AnyObject &channelData)=0
Action
Actions to be taken after a message is processed by the handler.
Definition: XrdClPostMasterInterfaces.hh:56
uint16_t up
Definition: XrdClPostMasterInterfaces.hh:272
Definition: XrdNetAddr.hh:41
Procedure execution status.
Definition: XrdClStatus.hh:113
Definition: XrdClPostMasterInterfaces.hh:69
StreamEvent
Events that may have occurred to the stream.
Definition: XrdClPostMasterInterfaces.hh:78
virtual void OnStatusReady(const Message *message, XRootDStatus status)=0
The requested action has been performed and the status is available.
virtual void Process()
Definition: XrdClPostMasterInterfaces.hh:125
uint16_t step
Handshake step.
Definition: XrdClPostMasterInterfaces.hh:253
virtual URL GetBindPreference(const URL &url, AnyObject &channelData)=0
Get bind preference for the next data stream.
Send a close request.
Definition: XrdClPostMasterInterfaces.hh:309
virtual uint16_t Examine(std::shared_ptr< Message > &msg)=0
virtual Status IsStreamBroken(time_t inactiveTime, AnyObject &channelData)=0
virtual Status Query(uint16_t query, AnyObject &result, AnyObject &channelData)=0
Query the channel.
virtual Status GetSignature(Message *toSign, Message *&sign, AnyObject &channelData)=0
Get signature for given message.
Definition: XrdClPostMasterInterfaces.hh:66
Data structure that carries the handshake information.
Definition: XrdClPostMasterInterfaces.hh:244
Definition: XrdClPostMasterInterfaces.hh:299
Stream has been broken and won't be recovered.
Definition: XrdClPostMasterInterfaces.hh:83
virtual bool HandShakeDone(HandShakeData *handShakeData, AnyObject &channelData)=0
virtual uint16_t InspectStatusRsp()=0
virtual ~TransportHandler()
Definition: XrdClPostMasterInterfaces.hh:313
Perform the handshake and the authentication for each physical stream.
Definition: XrdClPostMasterInterfaces.hh:289
Stream has been broken and won't be recovered.
Definition: XrdClPostMasterInterfaces.hh:219
none object for initializing empty Optional
Definition: XrdClOptional.hh:35
The stream is broken.
Definition: XrdClPostMasterInterfaces.hh:218
virtual ~MsgHandler()
Event types that the message handler may receive.
Definition: XrdClPostMasterInterfaces.hh:90
Request status.
Definition: XrdClXRootDResponses.hh:218
Channel event handler.
Definition: XrdClPostMasterInterfaces.hh:209
The stream has become connected.
Definition: XrdClPostMasterInterfaces.hh:217
A place holder.
Definition: XrdClPostMasterInterfaces.hh:59
virtual uint16_t SubStreamNumber(AnyObject &channelData)=0
Return a number of substreams per stream that should be created.
j template void())
Definition: XrdOucJson.hh:4121
virtual bool IsStreamTTLElapsed(time_t inactiveTime, AnyObject &channelData)=0
Check if the stream should be disconnected.
virtual bool IsRaw() const
Definition: XrdClPostMasterInterfaces.hh:184
Ignore the message.
Definition: XrdClPostMasterInterfaces.hh:60
uint16_t down
Definition: XrdClPostMasterInterfaces.hh:273
The stream has become connected.
Definition: XrdClPostMasterInterfaces.hh:80
Definition: XrdClPostMasterInterfaces.hh:306
Definition: XrdClPostMasterInterfaces.hh:301
Definition: XrdClPostMasterInterfaces.hh:280
virtual time_t GetExpiration()=0
URL representation.
Definition: XrdClURL.hh:30
virtual void WaitBeforeExit()=0
Wait before exit.
No action.
Definition: XrdClPostMasterInterfaces.hh:298
virtual bool OnChannelEvent(ChannelEvent event, Status status)=0
virtual void InitializeChannel(const URL &url, AnyObject &channelData)=0
Initialize channel.
PathID(uint16_t u=0, uint16_t d=0)
Definition: XrdClPostMasterInterfaces.hh:271
Definition: XrdClPostMasterInterfaces.hh:61
ChannelEvent
Events that may have occurred to the channel.
Definition: XrdClPostMasterInterfaces.hh:215
virtual void OnReadyToSend(Message *msg)
Definition: XrdClPostMasterInterfaces.hh:174
virtual XRootDStatus HandShake(HandShakeData *handShakeData, AnyObject &channelData)=0
HandHake.
virtual XRootDStatus GetBody(Message &message, Socket *socket)=0
Definition: XrdClPostMasterInterfaces.hh:304
virtual void Disconnect(AnyObject &channelData, uint16_t subStreamId)=0
The stream has been disconnected, do the cleanups.
virtual XRootDStatus GetHeader(Message &message, Socket *socket)=0
there are more (non-raw) data to be read
Definition: XrdClPostMasterInterfaces.hh:72
Message * out
Message to be sent out.
Definition: XrdClPostMasterInterfaces.hh:254
The stream is broken.
Definition: XrdClPostMasterInterfaces.hh:81
A network socket.
Definition: XrdClSocket.hh:42
virtual PathID MultiplexSubStream(Message *msg, AnyObject &channelData, PathID *hint=0)=0
Stop sending requests [not yet implemented].
Definition: XrdClPostMasterInterfaces.hh:308
std::string streamName
Name of the stream.
Definition: XrdClPostMasterInterfaces.hh:262
Definition: XrdClPostMasterInterfaces.hh:63
static const uint16_t Auth
Transport name, returns std::string *.
Definition: XrdClPostMasterInterfaces.hh:283