This file is indexed.

/usr/include/Netxx/StreamBase.h is in libnetxx-dev 0.3.2-2ubuntu1.

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
/*
 * 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 definition of the Netxx::StreamBase class.
**/

#ifndef _Netxx_StreamBase_h_
#define _Netxx_StreamBase_h_

// Netxx includes
#include <Netxx/Types.h>
#include <Netxx/Address.h>
#include <Netxx/Timeout.h>

namespace Netxx {
    // forward declarations
    class Socket;
    class ProbeInfo;
	
/**
 * The Netxx::StreamBase class acts as a base class for the various stream
 * classes. You cannot directly instianciate an object of this class because
 * it has pure virtual funtions.
**/
class StreamBase {
public:
    //####################################################################
    /** 
     * Create a new StreamBase and set the timeout for stream operations.
     *
     * @param timeout The timeout to use for stream operations.
     * @author Peter Jones
    **/
    //####################################################################
    explicit StreamBase (const Timeout &timeout=Timeout());

    //####################################################################
    /** 
     * StreamBase virutal destructor. Cleanup the streambase.
     *
     * @author Peter Jones
    **/
    //####################################################################
    virtual ~StreamBase (void);

    //####################################################################
    /** 
     * Set the timeout that is used for various stream operations.
     *
     * @param timeout The timeout to use.
     * @author Peter Jones
    **/
    //####################################################################
    void set_timeout (const Timeout &timeout);

    //####################################################################
    /** 
     * Get the current timeout value that is used for stream operations.
     *
     * @return The current timeout value.
     * @author Peter Jones
    **/
    //####################################################################
    const Timeout& get_timeout (void) const;

    //####################################################################
    /** 
     * Read data from the stream into the given buffer. This operation will
     * place the read data into the buffer unless there is an error or
     * timeout. If a stream fatal error occures an exception is throw.
     *
     * @param buffer The buffer to place read data into.
     * @param length The avaliable size for the given buffer.
     * @return Greater than 0: For the bytes read into the buffer.
     * @return 0 If the peer closed the connection
     * @return -1: For a timeout
     * @author Peter Jones
    **/
    //####################################################################
    virtual signed_size_type read (void *buffer, size_type length) = 0;

    //####################################################################
    /** 
     * Write data from a buffer into the stream. If a stream fatal error
     * occures an exception is thrown.
     *
     * @param buffer The data to write to the stream.
     * @param length The amount of data to use from the buffer.
     * @return Greater than 0: The number of bytes written to the stream.
     * @return 0 If the peer closed the connection.
     * @return -1: for a timeout.
     * @author Peter Jones
    **/
    //####################################################################
    virtual signed_size_type write (const void *buffer, size_type length) = 0;

    //####################################################################
    /** 
     * Close the stream connection with the peer. After the connection is
     * closed you should not use any of the other stream member functions.
     *
     * @author Peter Jones
    **/
    //####################################################################
    virtual void close (void) = 0;

    //####################################################################
    /** 
     * Return the file descriptor that is being used for the stream
     * connection.
     *
     * @return The file descriptor for this connection.
     * @author Peter Jones
    **/
    //####################################################################
    virtual socket_type get_socketfd (void) const = 0;

    //####################################################################
    /** 
     * Get information about how this StreamBase should be probed from
     * the Netxx::Probe class.
     *
     * @return A Netxx::ProbeInfo object.
     * @author Peter Jones
    **/
    //####################################################################
    virtual const ProbeInfo* get_probe_info (void) const = 0;
protected:
    //####################################################################
    /** 
     * This protected member function is used to establish a connection with
     * one of the addresses given. This function will throw an exception if
     * it cannot make a connection with any of the given addresses.
     *
     * @param socket On successful return this will be the socket for the conection
     * @param address The list of addresses to try
     * @author Peter Jones
    **/
    //####################################################################
    void make_connection (Socket &socket, const Address &address);

    //####################################################################
    /** 
     * Used by the stream classes so they can implement a swap() member
     * function.
     *
     * @param other The other StreamBase to swap with.
     * @author Peter Jones
    **/
    //####################################################################
    void swap_base (StreamBase &other);
private:
    Timeout timeout_;
}; // end Netxx::StreamBase class

} // end Netxx namespace
#endif