summaryrefslogtreecommitdiff
path: root/src/network/socket_handler.hpp
blob: 165f732b76a967d433c2386252899b2b61540741 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
#ifndef SOCKET_HANDLER_INCLUDED
# define SOCKET_HANDLER_INCLUDED

typedef int socket_t;

class Poller;

/**
 * An interface, with a series of callbacks that should be implemented in
 * subclasses that deal with a socket. These callbacks are called on various events
 * (read/write/timeout, etc) when they are notified to a poller
 * (select/poll/epoll etc)
 */
class SocketHandler
{
public:
  explicit SocketHandler():
    poller(nullptr)
  {}
  /**
   * Set the pointer to the given Poller, to communicate with it.
   */
  void set_poller(Poller* poller)
  {
    this->poller = poller;
  };
  /**
   * Happens when the socket is ready to be received from.
   */
  virtual void on_recv() = 0;
  /**
   * Happens when the socket is ready to be written to.
   */
  virtual void on_send() = 0;
  /**
   * Returns the socket that should be handled by the poller.
   */
  virtual socket_t get_socket() const = 0;
  /**
   * Close the connection.
   */
  virtual void close() = 0;

protected:
  /**
   * A pointer to the poller that manages us, because we need to communicate
   * with it, sometimes (for example to tell it that he now needs to watch
   * write events for us). Do not ever try to delete it.
   *
   * And a raw pointer because we are not owning it, it is owning us
   * (actually it is sharing our ownership with a Bridge).
   */
  Poller* poller;

private:
  SocketHandler(const SocketHandler&) = delete;
  SocketHandler(SocketHandler&&) = delete;
  SocketHandler& operator=(const SocketHandler&) = delete;
  SocketHandler& operator=(SocketHandler&&) = delete;
};

#endif // SOCKET_HANDLER_INCLUDED