lokinet/llarp/link/session.hpp

#ifndef LLARP_LINK_SESSION_HPP
#define LLARP_LINK_SESSION_HPP

#include <crypto/types.hpp>
#include <net/net.hpp>
#include <router_contact.hpp>
#include <util/types.hpp>

#include <functional>

namespace llarp
{
  struct LinkIntroMessage;
  struct ILinkMessage;
  struct ILinkLayer;
  struct ILinkSession : public util::IStateful
  {
    virtual ~ILinkSession(){};

    /// called every event loop tick
    std::function< void(void) > Pump;

    /// called every timer tick
    std::function< void(llarp_time_t) > Tick;

    /// send a message buffer to the remote endpoint
    std::function< bool(const llarp_buffer_t &) > SendMessageBuffer;

    /// start the connection
    std::function< void(void) > Start;

    /// send a keepalive to the remote endpoint
    std::function< bool(void) > SendKeepAlive;

    /// send close message
    std::function< void(void) > SendClose;

    /// return true if we are established
    std::function< bool(void) > IsEstablished;

    /// return true if this session has timed out
    std::function< bool(llarp_time_t) > TimedOut;

    /// get remote public identity key
    std::function< PubKey(void) > GetPubKey;

    /// get remote address
    std::function< Addr(void) > GetRemoteEndpoint;

    // get remote rc
    std::function< RouterContact(void) > GetRemoteRC;

    /// handle a valid LIM
    std::function< bool(const LinkIntroMessage *msg) > GotLIM;

    /// send queue current blacklog
    std::function< size_t(void) > SendQueueBacklog;

    /// get parent link layer
    std::function< ILinkLayer *(void) > GetLinkLayer;

    /// renegotiate session when we have a new RC locally
    std::function< bool(void) > RenegotiateSession;

    /// return true if we should send an explicit keepalive message
    std::function< bool(void) > ShouldPing;
  };
}  // namespace llarp

#endif