A Discrete-Event Network Simulator
API
udp-socket.h
Go to the documentation of this file.
1/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/*
3 * Copyright (c) 2006 Georgia Tech Research Corporation
4 * 2007 INRIA
5 *
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License version 2 as
8 * published by the Free Software Foundation;
9 *
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
14 *
15 * You should have received a copy of the GNU General Public License
16 * along with this program; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
18 *
19 * Authors: George F. Riley<riley@ece.gatech.edu>
20 * Mathieu Lacage <mathieu.lacage@sophia.inria.fr>
21 */
22
23#ifndef UDP_SOCKET_H
24#define UDP_SOCKET_H
25
26#include "ns3/socket.h"
27#include "ns3/traced-callback.h"
28#include "ns3/callback.h"
29#include "ns3/ptr.h"
30#include "ns3/object.h"
31
32namespace ns3 {
33
34class Node;
35class Packet;
36
47class UdpSocket : public Socket
48{
49public:
55 static TypeId GetTypeId (void);
56
57 UdpSocket (void);
58 virtual ~UdpSocket (void);
59
84 virtual int MulticastJoinGroup (uint32_t interface, const Address &groupAddress) = 0;
85
104 virtual int MulticastLeaveGroup (uint32_t interface, const Address &groupAddress) = 0;
105
106private:
107 // Indirect the attribute setting and getting through private virtual methods
112 virtual void SetRcvBufSize (uint32_t size) = 0;
117 virtual uint32_t GetRcvBufSize (void) const = 0;
122 virtual void SetIpMulticastTtl (uint8_t ipTtl) = 0;
127 virtual uint8_t GetIpMulticastTtl (void) const = 0;
132 virtual void SetIpMulticastIf (int32_t ipIf) = 0;
137 virtual int32_t GetIpMulticastIf (void) const = 0;
147 virtual void SetIpMulticastLoop (bool loop) = 0;
157 virtual bool GetIpMulticastLoop (void) const = 0;
163 virtual void SetMtuDiscover (bool discover) = 0;
169 virtual bool GetMtuDiscover (void) const = 0;
170};
171
172} // namespace ns3
173
174#endif /* UDP_SOCKET_H */
175
176
a polymophic address class
Definition: address.h:91
A low-level Socket API based loosely on the BSD Socket API.
Definition: socket.h:67
a unique identifier for an interface.
Definition: type-id.h:59
(abstract) base class of all UdpSockets
Definition: udp-socket.h:48
virtual ~UdpSocket(void)
Definition: udp-socket.cc:85
virtual void SetIpMulticastIf(int32_t ipIf)=0
Set the IP multicast interface.
virtual uint8_t GetIpMulticastTtl(void) const =0
Get the IP multicast TTL.
virtual int MulticastLeaveGroup(uint32_t interface, const Address &groupAddress)=0
Corresponds to socket option MCAST_LEAVE_GROUP.
virtual int MulticastJoinGroup(uint32_t interface, const Address &groupAddress)=0
Corresponds to socket option MCAST_JOIN_GROUP.
virtual bool GetIpMulticastLoop(void) const =0
Get the IP multicast loop capability.
virtual int32_t GetIpMulticastIf(void) const =0
Get the IP multicast interface.
virtual void SetRcvBufSize(uint32_t size)=0
Set the receiving buffer size.
virtual uint32_t GetRcvBufSize(void) const =0
Get the receiving buffer size.
virtual void SetIpMulticastLoop(bool loop)=0
Set the IP multicast loop capability.
virtual bool GetMtuDiscover(void) const =0
Get the MTU discover capability.
static TypeId GetTypeId(void)
Get the type ID.
Definition: udp-socket.cc:36
virtual void SetMtuDiscover(bool discover)=0
Set the MTU discover capability.
virtual void SetIpMulticastTtl(uint8_t ipTtl)=0
Set the IP multicast TTL.
Every class exported by the ns3 library is enclosed in the ns3 namespace.