/usr/include/Netxx/Probe.h is in libnetxx-dev 0.3.2-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
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 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 | /*
* Copyright (C) 2001-2003 Peter J Jones (pjones@pmade.org)
* All Rights Reserved
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in
* the documentation and/or other materials provided with the
* distribution.
* 3. Neither the name of the Author nor the names of its contributors
* may be used to endorse or promote products derived from this software
* without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS''
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
* TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
* PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR
* OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
* USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
* AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
* OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
* SUCH DAMAGE.
*/
/** @file
* This file contains the defintion of the Netxx::Probe class.
**/
#ifndef _Netxx_Probe_h_
#define _Netxx_Probe_h_
// Netxx includes
#include <Netxx/Types.h>
#include <Netxx/Timeout.h>
#include <Netxx/ProbeInfo.h>
// standard includes
#include <vector>
#include <utility>
namespace Netxx {
/**
* The Netxx::Probe class is a wrapper around one of the Netxx probe
* classes. The reason that we have a wrapper is because most operating
* systems support select(2) but some also support more advanced APIs like
* kqueue(2) or /dev/poll.
**/
class Probe {
public:
/*
* Bitmask for telling Probe exactly what you want and for testing the
* return value from Probe::ready().
*/
enum ReadyType {
ready_none = 0x000000, ///< Nothing or Everything depeding on the context
ready_read = 0x000001, ///< Readable
ready_write = 0x000002, ///< Writable
ready_oobd = 0x000004 ///< Readable Out-of-band Data
};
/// type for holding the bitmask
typedef unsigned int ready_type;
/// type returned from ready()
typedef std::pair<socket_type, ready_type> result_type;
//####################################################################
/**
* Construct a new Netxx::Probe object.
*
* @author Peter Jones
**/
//####################################################################
Probe (void);
//####################################################################
/**
* Netxx::Probe copy constructor.
*
* @param other The other Probe object to copy from.
* @author Peter Jones
**/
//####################################################################
Probe (const Probe &other);
//####################################################################
/**
* Netxx::Probe assignment operator.
*
* @param other The other Probe object to copy from.
* @return *this.
* @author Peter Jones
**/
//####################################################################
Probe& operator= (const Probe &other);
//####################################################################
/**
* Swap this Probe and another one. Similar to std::swap().
*
* @param other The other Probe to swap with.
* @author Peter Jones
**/
//####################################################################
void swap(Probe &other);
//####################################################################
/**
* Netxx::Probe destructor.
*
* @author Peter Jones
**/
//####################################################################
~Probe (void);
//####################################################################
/**
* Clear the Probe. All objects will be removed from the Probe and it
* will be in a brand-new like state.
*
* @author Peter Jones
**/
//####################################################################
void clear (void);
//####################################################################
/**
* Preform the probe. This function will block until either some data is
* ready or the given timeout expires. You may also supply a bitmask for
* the type of data you want in this probe.
*
* @param timeout How long to wait for data. Can be a NULL timeout to block until probe data is avaliable.
* @param rt A bitmask to control what is returned. ready_none means all data in this context.
* @return a std::pair where first is the ready socket and second is a bitmask to tell you what it is ready for.
* @return a std::pair with first set to -1 to signal a timeout.
* @author Peter Jones
**/
//####################################################################
result_type ready (const Timeout &timeout=Timeout(), ready_type rt=ready_none);
//####################################################################
/**
* Add an object to the Probe. The object must support the
* Netxx::ProbeInfo class. All Netxx classes such as Stream and Datagram
* support the ProbeInfo class.
*
* You can optionally give a bitmask that will tell Probe what type of
* data to probe for. The default is to probe for all data. In this
* case, ready_none means probe for all data.
*
* @param t The object to add to the Probe.
* @param rt A bitmask that tells Probe what to probe for.
* @author Peter Jones
**/
//####################################################################
template <typename T> void add (const T &t, ready_type rt=ready_none) {
// implemented inline to work around bug in MSVC
const ProbeInfo *pi = t.get_probe_info();
std::vector<socket_type>::const_iterator i=pi->get_sockets().begin(), end=pi->get_sockets().end();
for (; i!=end; ++i) { if (pi->needs_pending_check()) add_socket(pi, *i, rt); else add_socket(*i, rt); }
}
//####################################################################
/**
* Remove the given object from the Probe.
*
* @param t The object to remove from the Probe.
* @author Peter Jones
**/
//####################################################################
template <typename T> void remove (const T &t) {
// implemented inline to work around bug in MSVC
const ProbeInfo *pi = t.get_probe_info();
std::vector<socket_type>::const_iterator i=pi->get_sockets().begin(), end=pi->get_sockets().end();
for (; i!=end; ++i) remove_socket(*i);
}
private:
void add_socket (socket_type socketfd, ready_type rt);
void add_socket (const ProbeInfo *pi, socket_type socketfd, ready_type rt);
void remove_socket (socket_type socketfd);
struct pimpl; pimpl *pimpl_;
}; // end Probe class
} // end Netxx namespace
#endif
|