aboutsummaryrefslogtreecommitdiffstats
path: root/vespalib/src/vespa/vespalib/net/wakeup_pipe.h
blob: 36c88b205c0c1b5556857ed5e58ef6e79096156e (plain) (blame)
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
// Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.

#pragma once

#include "socket_handle.h"

namespace vespalib {

//-----------------------------------------------------------------------------

/**
 * A wakeup pipe is a non-blocking pipe that is used to wake up a
 * blocking call to epoll_wait. The pipe readability is part of the
 * selection set and a wakeup is triggered by writing to the
 * pipe. When a wakeup is detected, pending tokens will be read and
 * discarded to avoid spurious wakeups in the future.
 **/
class WakeupPipe {
private:
    SocketHandle _reader;
    SocketHandle _writer;
public:
    WakeupPipe();
    ~WakeupPipe();
    int get_read_fd() const { return _reader.get(); }
    void write_token();
    void read_tokens();
};

}