ot::Ip6::Tcp class

Implements TCP message handling.

Syntax

Show:

Summary

Declaration

from tcp6.hpp:86

class Tcp : public InstanceLocator, private NonCopyable { public: class Endpoint : public otTcpEndpoint, public LinkedListEntry<Endpoint>, public GetProvider<Endpoint> { friend class Tcp; friend class LinkedList<Endpoint >; public: Error Initialize(Instance &aInstance, const otTcpEndpointInitializeArgs &aArgs); Instance &GetInstance(void) const; void *GetContext(void) { return mContext; } const SockAddr &GetLocalAddress(void) const; const SockAddr &GetPeerAddress(void) const; Error Bind(const SockAddr &aSockName); Error Connect(const SockAddr &aSockName, uint32_t aFlags); Error SendByReference(otLinkedBuffer &aBuffer, uint32_t aFlags); Error SendByExtension(size_t aNumBytes, uint32_t aFlags); Error ReceiveByReference(const otLinkedBuffer *&aBuffer); Error ReceiveContiguify(void); Error CommitReceive(size_t aNumBytes, uint32_t aFlags); Error SendEndOfStream(void); Error Abort(void); Error Deinitialize(void); static Endpoint &FromTcb(struct tcpcb &aTcb) { return *reinterpret_cast<Endpoint *>(&aTcb); } struct tcpcb &GetTcb(void) { return *reinterpret_cast<struct tcpcb *>(&mTcb); } const struct tcpcb &GetTcb(void) const { return *reinterpret_cast<const struct tcpcb *>(&mTcb); } bool IsClosed(void) const; private: friend void ::tcplp_sys_set_timer(struct tcpcb *aTcb, uint8_t aTimerFlag, uint32_t aDelay); friend void ::tcplp_sys_stop_timer(struct tcpcb *aTcb, uint8_t aTimerFlag); enum : uint8_t { kTimerDelack = 0, kTimerRexmtPersist = 1, kTimerKeep = 2, kTimer2Msl = 3, kNumTimers = 4, }; static uint8_t TimerFlagToIndex(uint8_t aTimerFlag); bool IsTimerActive(uint8_t aTimerIndex); void SetTimer(uint8_t aTimerFlag, uint32_t aDelay); void CancelTimer(uint8_t aTimerFlag); bool FirePendingTimers(TimeMilli aNow, bool &aHasFutureTimer, TimeMilli &aEarliestFutureExpiry); void PostCallbacksAfterSend(size_t aSent, size_t aBacklogBefore); bool FirePendingCallbacks(void); size_t GetSendBufferBytes(void) const; size_t GetInFlightBytes(void) const; size_t GetBacklogBytes(void) const; Address &GetLocalIp6Address(void); const Address &GetLocalIp6Address(void) const; Address &GetForeignIp6Address(void); const Address &GetForeignIp6Address(void) const; bool Matches(const MessageInfo &aMessageInfo) const; }; class Listener : public otTcpListener, public LinkedListEntry<Listener>, public GetProvider<Listener> { friend class LinkedList<Listener >; public: Error Initialize(Instance &aInstance, const otTcpListenerInitializeArgs &aArgs); Instance &GetInstance(void) const; void *GetContext(void) { return mContext; } Error Listen(const SockAddr &aSockName); Error StopListening(void); Error Deinitialize(void); static Listener &FromTcbListen(struct tcpcb_listen &aTcbListen) { return *reinterpret_cast<Listener *>(&aTcbListen); } struct tcpcb_listen &GetTcbListen(void) { return *reinterpret_cast<struct tcpcb_listen *>(&mTcbListen); } const struct tcpcb_listen &GetTcbListen(void) const { return *reinterpret_cast<const struct tcpcb_listen *>(&mTcbListen); } bool IsClosed(void) const; private: Address &GetLocalIp6Address(void); const Address &GetLocalIp6Address(void) const; bool Matches(const MessageInfo &aMessageInfo) const; }; OT_TOOL_PACKED_BEGIN class Header : public Clearable<Header> { public: static constexpr uint8_t kChecksumFieldOffset = 16; uint16_t GetSourcePort(void) const { return BigEndian::HostSwap16(mSource); } uint16_t GetDestinationPort(void) const { return BigEndian::HostSwap16(mDestination); } uint32_t GetSequenceNumber(void) const { return BigEndian::HostSwap32(mSequenceNumber); } uint32_t GetAcknowledgmentNumber(void) const { return BigEndian::HostSwap32(mAckNumber); } uint16_t GetFlags(void) const { return BigEndian::HostSwap16(mFlags); } uint16_t GetWindow(void) const { return BigEndian::HostSwap16(mWindow); } uint16_t GetChecksum(void) const { return BigEndian::HostSwap16(mChecksum); } uint16_t GetUrgentPointer(void) const { return BigEndian::HostSwap16(mUrgentPointer); } private: uint16_t mSource; uint16_t mDestination; uint32_t mSequenceNumber; uint32_t mAckNumber; uint16_t mFlags; uint16_t mWindow; uint16_t mChecksum; uint16_t mUrgentPointer; } OT_TOOL_PACKED_END; explicit Tcp(Instance &aInstance); Error HandleMessage(ot::Ip6::Header &aIp6Header, Message &aMessage, MessageInfo &aMessageInfo); bool AutoBind(const SockAddr &aPeer, SockAddr &aToBind, bool aBindAddress, bool aBindPort); bool IsInitialized(const Endpoint &aEndpoint) const { return mEndpoints.Contains(aEndpoint); } bool IsInitialized(const Listener &aListener) const { return mListeners.Contains(aListener); } private: enum { kDynamicPortMin = 49152, kDynamicPortMax = 65535, }; static constexpr uint8_t kEstablishedCallbackFlag = (1 << 0); static constexpr uint8_t kSendDoneCallbackFlag = (1 << 1); static constexpr uint8_t kForwardProgressCallbackFlag = (1 << 2); static constexpr uint8_t kReceiveAvailableCallbackFlag = (1 << 3); static constexpr uint8_t kDisconnectedCallbackFlag = (1 << 4); void ProcessSignals(Endpoint &aEndpoint, otLinkedBuffer *aPriorHead, size_t aPriorBacklog, struct tcplp_signals &aSignals) const; static Error BsdErrorToOtError(int aBsdError); bool CanBind(const SockAddr &aSockName); void HandleTimer(void); void ProcessCallbacks(void); using TcpTasklet = TaskletIn<Tcp, &Tcp::ProcessCallbacks>; using TcpTimer = TimerMilliIn<Tcp, &Tcp::HandleTimer>; TcpTimer mTimer; TcpTasklet mTasklet; LinkedList<Endpoint> mEndpoints; LinkedList<Listener> mListeners; uint16_t mEphemeralPort; };