← Back to branch summary

~ubuntu-branches/ubuntu/gutsy/poco/gutsy

« back to all changes in this revision

Viewing changes to Net/include/Poco/Net/ICMPSocket.h

  • Committer: Bazaar Package Importer
  • Author(s): Krzysztof Burghardt
  • Date: 2007-04-27 18:33:48 UTC
  • Revision ID: james.westby@ubuntu.com-20070427183348-xgnpct0qd6a2ip34
Tags: upstream-1.2.9
Import upstream version 1.2.9

Show diffs side-by-side

added added

removed removed

Lines of Context:
Net/include/Poco/Net/ICMPSocket.h
 
1
//
 
2
// ICMPSocket.h
 
3
//
 
4
// $Id: //poco/1.2/Net/include/Poco/Net/ICMPSocket.h#1 $
 
5
//
 
6
// Library: Net
 
7
// Package: ICMP
 
8
// Module:  ICMPSocket
 
9
//
 
10
// Definition of the ICMPSocket class.
 
11
//
 
12
// Copyright (c) 2006, Applied Informatics Software Engineering GmbH.
 
13
// and Contributors.
 
14
//
 
15
// Permission is hereby granted, free of charge, to any person or organization
 
16
// obtaining a copy of the software and accompanying documentation covered by
 
17
// this license (the "Software") to use, reproduce, display, distribute,
 
18
// execute, and transmit the Software, and to prepare derivative works of the
 
19
// Software, and to permit third-parties to whom the Software is furnished to
 
20
// do so, all subject to the following:
 
21
// 
 
22
// The copyright notices in the Software and this entire statement, including
 
23
// the above license grant, this restriction and the following disclaimer,
 
24
// must be included in all copies of the Software, in whole or in part, and
 
25
// all derivative works of the Software, unless such copies or derivative
 
26
// works are solely in the form of machine-executable object code generated by
 
27
// a source language processor.
 
28
// 
 
29
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 
30
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 
31
// FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
 
32
// SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
 
33
// FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
 
34
// ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
 
35
// DEALINGS IN THE SOFTWARE.
 
36
//
 
37
 
 
38
 
 
39
#ifndef Net_ICMPSocket_INCLUDED
 
40
#define Net_ICMPSocket_INCLUDED
 
41
 
 
42
 
 
43
#include "Poco/Net/Net.h"
 
44
#include "Poco/Net/Socket.h"
 
45
 
 
46
 
 
47
namespace Poco {
 
48
namespace Net {
 
49
 
 
50
 
 
51
class Net_API ICMPSocket: public Socket
 
52
        /// This class provides an interface to an
 
53
        /// ICMP client socket.
 
54
{
 
55
public:
 
56
        ICMPSocket(IPAddress::Family family, int dataSize = 48, int ttl = 128, int timeout = 500000);
 
57
                /// Creates an unconnected ICMP socket.
 
58
                ///
 
59
                /// The socket will be created for the
 
60
                /// given address family.
 
61
 
 
62
        ICMPSocket(const Socket& socket);
 
63
                /// Creates the ICMPSocket with the SocketImpl
 
64
                /// from another socket. The SocketImpl must be
 
65
                /// a DatagramSocketImpl, otherwise an InvalidArgumentException
 
66
                /// will be thrown.
 
67
 
 
68
        ~ICMPSocket();
 
69
                /// Destroys the ICMPSocket.
 
70
 
 
71
        ICMPSocket& operator = (const Socket& socket);
 
72
                /// Assignment operator.
 
73
                ///
 
74
                /// Releases the socket's SocketImpl and
 
75
                /// attaches the SocketImpl from the other socket and
 
76
                /// increments the reference count of the SocketImpl.   
 
77
 
 
78
        int sendTo(const SocketAddress& address, int flags = 0);
 
79
                /// Sends an ICMP request through
 
80
                /// the socket to the given address.
 
81
                ///
 
82
                /// Returns the number of bytes sent.
 
83
 
 
84
        int receiveFrom(SocketAddress& address, int flags = 0);
 
85
                /// Receives data from the socket.
 
86
                /// Stores the address of the sender in address.
 
87
                ///
 
88
                /// Returns the time elapsed since the originating 
 
89
                /// request was sent.
 
90
 
 
91
        int dataSize() const;
 
92
                /// Returns the data size in bytes.
 
93
 
 
94
        int ttl() const;
 
95
                /// Returns the Time-To-Live value.
 
96
 
 
97
        int timeout() const;
 
98
                /// Returns the socket timeout value.
 
99
 
 
100
protected:
 
101
        ICMPSocket(SocketImpl* pImpl);
 
102
                /// Creates the Socket and attaches the given SocketImpl.
 
103
                /// The socket takes owership of the SocketImpl.
 
104
                ///
 
105
                /// The SocketImpl must be a ICMPSocketImpl, otherwise
 
106
                /// an InvalidArgumentException will be thrown.
 
107
 
 
108
private:
 
109
        int _dataSize; 
 
110
        int _ttl;
 
111
        int _timeout;
 
112
};
 
113
 
 
114
 
 
115
//
 
116
// inlines
 
117
//
 
118
inline int ICMPSocket::dataSize() const
 
119
{
 
120
        return _dataSize;
 
121
}
 
122
 
 
123
 
 
124
inline int ICMPSocket::ttl() const
 
125
{
 
126
        return _ttl;
 
127
}
 
128
 
 
129
 
 
130
inline int ICMPSocket::timeout() const
 
131
{
 
132
        return _timeout;
 
133
}
 
134
 
 
135
 
 
136
} } // namespace Poco::Net
 
137
 
 
138
 
 
139
#endif // Net_ICMPSocket_INCLUDED