|
A Discrete-Event Network Simulator
|
API |
|
|
A Discrete-Event Network Simulator
|
API |
Default trace to send. More...
#include <udp-trace-client.h>
Inheritance diagram for ns3::UdpTraceClient: Collaboration diagram for ns3::UdpTraceClient:Classes | |
| struct | TraceEntry |
| Entry to send. More... | |
Public Member Functions | |
| UdpTraceClient () | |
| UdpTraceClient (Ipv4Address ip, uint16_t port, char *traceFile) | |
| Creates a traceBasedStreamer application. More... | |
| ~UdpTraceClient () | |
| uint16_t | GetMaxPacketSize (void) |
| Return the maximum packet size. More... | |
| void | SetMaxPacketSize (uint16_t maxPacketSize) |
| Set the maximum packet size. More... | |
| void | SetRemote (Ipv4Address ip, uint16_t port) |
| set the remote address and port More... | |
| void | SetRemote (Ipv6Address ip, uint16_t port) |
| set the remote address and port More... | |
| void | SetRemote (Address ip, uint16_t port) |
| set the remote address and port More... | |
| void | SetTraceFile (std::string filename) |
| Set the trace file to be used by the application. More... | |
| Public Member Functions inherited from ns3::Application | |
| Application () | |
| virtual | ~Application () |
| Ptr< Node > | GetNode () const |
| void | SetNode (Ptr< Node > node) |
| void | SetStartTime (Time start) |
| Specify application start time. More... | |
| void | SetStopTime (Time stop) |
| Specify application stop time. More... | |
| Public Member Functions inherited from ns3::Object | |
| Object () | |
| Constructor. More... | |
| virtual | ~Object () |
| Destructor. More... | |
| void | AggregateObject (Ptr< Object > other) |
| Aggregate two Objects together. More... | |
| void | Dispose (void) |
| Dispose of this Object. More... | |
| AggregateIterator | GetAggregateIterator (void) const |
| Get an iterator to the Objects aggregated to this one. More... | |
| virtual TypeId | GetInstanceTypeId (void) const |
| Implement the GetInstanceTypeId method defined in ObjectBase. More... | |
| template<typename T > | |
| Ptr< T > | GetObject (void) const |
| Get a pointer to the requested aggregated Object. More... | |
| template<typename T > | |
| Ptr< T > | GetObject (TypeId tid) const |
| Get a pointer to the requested aggregated Object. More... | |
| void | Initialize (void) |
| Invoke DoInitialize on all Objects aggregated to this one. More... | |
| Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
| SimpleRefCount () | |
| Constructor. More... | |
| SimpleRefCount (const SimpleRefCount &o) | |
| Copy constructor. More... | |
| uint32_t | GetReferenceCount (void) const |
| Get the reference count of the object. More... | |
| SimpleRefCount & | operator= (const SimpleRefCount &o) |
| Assignment. More... | |
| void | Ref (void) const |
| Increment the reference count. More... | |
| void | Unref (void) const |
| Decrement the reference count. More... | |
| Public Member Functions inherited from ns3::ObjectBase | |
| virtual | ~ObjectBase () |
| Virtual destructor. More... | |
| void | GetAttribute (std::string name, AttributeValue &value) const |
| Get the value of an attribute, raising fatal errors if unsuccessful. More... | |
| bool | GetAttributeFailSafe (std::string name, AttributeValue &value) const |
| Get the value of an attribute without raising erros. More... | |
| void | SetAttribute (std::string name, const AttributeValue &value) |
| Set a single attribute, raising fatal errors if unsuccessful. More... | |
| bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
| Set a single attribute without raising errors. More... | |
| bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
| Connect a TraceSource to a Callback with a context. More... | |
| bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
| Connect a TraceSource to a Callback without a context. More... | |
| bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
| Disconnect from a TraceSource a Callback previously connected with a context. More... | |
| bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
| Disconnect from a TraceSource a Callback previously connected without a context. More... | |
Static Public Member Functions | |
| static TypeId | GetTypeId (void) |
| Get the type ID. More... | |
| Static Public Member Functions inherited from ns3::Application | |
| static TypeId | GetTypeId (void) |
| Get the type ID. More... | |
| Static Public Member Functions inherited from ns3::Object | |
| static TypeId | GetTypeId (void) |
| Register this type. More... | |
| Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
| static void | Cleanup (void) |
| Noop. More... | |
| Static Public Member Functions inherited from ns3::ObjectBase | |
| static TypeId | GetTypeId (void) |
| Get the type ID. More... | |
Protected Member Functions | |
| virtual void | DoDispose (void) |
| Destructor implementation. More... | |
| Protected Member Functions inherited from ns3::Application | |
| virtual void | DoInitialize (void) |
| Initialize() implementation. More... | |
| Protected Member Functions inherited from ns3::Object | |
| Object (const Object &o) | |
| Copy an Object. More... | |
| virtual void | NotifyNewAggregate (void) |
| Notify all Objects aggregated to this one of a new Object being aggregated. More... | |
| Protected Member Functions inherited from ns3::ObjectBase | |
| void | ConstructSelf (const AttributeConstructionList &attributes) |
| Complete construction of ObjectBase; invoked by derived classes. More... | |
| virtual void | NotifyConstructionCompleted (void) |
| Notifier called once the ObjectBase is fully constructed. More... | |
Private Member Functions | |
| void | LoadDefaultTrace (void) |
| Load the default trace. More... | |
| void | LoadTrace (std::string filename) |
| Load a trace file. More... | |
| void | Send (void) |
| Send a packet. More... | |
| void | SendPacket (uint32_t size) |
| Send a packet of a given size. More... | |
| virtual void | StartApplication (void) |
| Application specific startup code. More... | |
| virtual void | StopApplication (void) |
| Application specific shutdown code. More... | |
Private Attributes | |
| uint32_t | m_currentEntry |
| Current entry index. More... | |
| std::vector< struct TraceEntry > | m_entries |
| Entries in the trace to send. More... | |
| uint16_t | m_maxPacketSize |
| Maximum packet size to send (including the SeqTsHeader) More... | |
| Address | m_peerAddress |
| Remote peer address. More... | |
| uint16_t | m_peerPort |
| Remote peer port. More... | |
| EventId | m_sendEvent |
| Event to send the next packet. More... | |
| uint32_t | m_sent |
| Counter for sent packets. More... | |
| Ptr< Socket > | m_socket |
| Socket. More... | |
Static Private Attributes | |
| static struct TraceEntry | g_defaultEntries [] |
| Default trace to send. More... | |
Additional Inherited Members | |
| Protected Attributes inherited from ns3::Application | |
| Ptr< Node > | m_node |
| The node that this application is installed on. More... | |
| EventId | m_startEvent |
| The event that will fire at m_startTime to start the application. More... | |
| Time | m_startTime |
| The simulation time that the application will start. More... | |
| EventId | m_stopEvent |
| The event that will fire at m_stopTime to end the application. More... | |
| Time | m_stopTime |
| The simulation time that the application will end. More... | |
| Related Functions inherited from ns3::ObjectBase | |
| static TypeId | GetObjectIid (void) |
| Ensure the TypeId for ObjectBase gets fully configured to anchor the inheritance tree properly. More... | |
Default trace to send.
A trace based streamer.
ns3::UdpTraceClient is accessible through the following paths with Config::Set and Config::Connect:
No TraceSources are defined for this type.
Size of this type is 200 bytes (on a 64-bit architecture).
Sends UDP packets based on a trace file of an MPEG4 stream trace files could be downloaded form: http://www2.tkn.tu-berlin.de/research/trace/ltvt.html (the 2 first lines of the file should be removed) A valid trace file is a file with 4 columns:
If no valid MPEG4 trace file is provided to the application the trace from g_defaultEntries array will be loaded.
Definition at line 47 of file udp-trace-client.cc.
| ns3::UdpTraceClient::UdpTraceClient | ( | ) |
Definition at line 91 of file udp-trace-client.cc.
References m_maxPacketSize, m_sendEvent, m_sent, m_socket, and NS_LOG_FUNCTION.
| ns3::UdpTraceClient::UdpTraceClient | ( | Ipv4Address | ip, |
| uint16_t | port, | ||
| char * | traceFile | ||
| ) |
Creates a traceBasedStreamer application.
| ip | the destination ip address to which the stream will be sent |
| port | the destination udp port to which the stream will be sent |
| traceFile | a path to an MPEG4 trace file formatted as follows: FrameNo Frametype Time[ms] Length [byte] FrameNo Frametype Time[ms] Length [byte] ... |
Definition at line 100 of file udp-trace-client.cc.
References m_currentEntry, m_maxPacketSize, m_peerAddress, m_peerPort, m_sendEvent, m_sent, m_socket, NS_LOG_FUNCTION, port, and SetTraceFile().
Here is the call graph for this function:| ns3::UdpTraceClient::~UdpTraceClient | ( | ) |
Definition at line 117 of file udp-trace-client.cc.
References m_entries, and NS_LOG_FUNCTION.
|
protectedvirtual |
Destructor implementation.
This method is called by Dispose() or by the Object's destructor, whichever comes first.
Subclasses are expected to implement their real destruction code in an overriden version of this method and chain up to their parent's implementation once they are done. i.e, for simplicity, the destructor of every subclass should be empty and its content should be moved to the associated DoDispose() method.
It is safe to call GetObject() from within this method.
Reimplemented from ns3::Application.
Definition at line 180 of file udp-trace-client.cc.
References ns3::Application::DoDispose(), and NS_LOG_FUNCTION.
Here is the call graph for this function:| uint16_t ns3::UdpTraceClient::GetMaxPacketSize | ( | void | ) |
Return the maximum packet size.
Definition at line 172 of file udp-trace-client.cc.
References m_maxPacketSize, and NS_LOG_FUNCTION.
|
static |
Get the type ID.
Definition at line 61 of file udp-trace-client.cc.
References m_maxPacketSize, m_peerAddress, m_peerPort, ns3::MakeAddressAccessor(), ns3::MakeAddressChecker(), ns3::MakeStringAccessor(), ns3::MakeStringChecker(), ns3::MakeUintegerAccessor(), ns3::TypeId::SetParent(), and SetTraceFile().
Referenced by ns3::UdpTraceClientHelper::UdpTraceClientHelper().
Here is the call graph for this function: Here is the caller graph for this function:
|
private |
Load the default trace.
Definition at line 221 of file udp-trace-client.cc.
References ns3::UdpTraceClient::TraceEntry::frameType, g_defaultEntries, m_currentEntry, m_entries, NS_LOG_FUNCTION, and ns3::UdpTraceClient::TraceEntry::timeToSend.
Referenced by LoadTrace(), and SetTraceFile().
Here is the caller graph for this function:
|
private |
Load a trace file.
| filename | the trace file path |
Definition at line 187 of file udp-trace-client.cc.
References ns3::UdpTraceClient::TraceEntry::frameType, LoadDefaultTrace(), m_currentEntry, m_entries, NS_LOG_FUNCTION, ns3::UdpTraceClient::TraceEntry::packetSize, and ns3::UdpTraceClient::TraceEntry::timeToSend.
Referenced by SetTraceFile().
Here is the call graph for this function: Here is the caller graph for this function:
|
private |
Send a packet.
Definition at line 321 of file udp-trace-client.cc.
References ns3::EventId::IsExpired(), m_currentEntry, m_entries, m_maxPacketSize, m_sendEvent, ns3::MilliSeconds(), NS_ASSERT, NS_LOG_FUNCTION, ns3::UdpTraceClient::TraceEntry::packetSize, ns3::Simulator::Schedule(), SendPacket(), and ns3::UdpTraceClient::TraceEntry::timeToSend.
Referenced by StartApplication().
Here is the call graph for this function: Here is the caller graph for this function:
|
private |
Send a packet of a given size.
| size | the packet size |
Definition at line 275 of file udp-trace-client.cc.
References ns3::Packet::AddHeader(), ns3::Ipv4Address::ConvertFrom(), ns3::Ipv6Address::ConvertFrom(), ns3::Ipv4Address::IsMatchingType(), ns3::Ipv6Address::IsMatchingType(), m_peerAddress, m_sent, m_socket, NS_LOG_FUNCTION, NS_LOG_INFO, packetSize, ns3::Socket::Send(), and ns3::SeqTsHeader::SetSeq().
Referenced by Send().
Here is the call graph for this function: Here is the caller graph for this function:| void ns3::UdpTraceClient::SetMaxPacketSize | ( | uint16_t | maxPacketSize | ) |
Set the maximum packet size.
| maxPacketSize | The maximum packet size |
Definition at line 165 of file udp-trace-client.cc.
References m_maxPacketSize, and NS_LOG_FUNCTION.
| void ns3::UdpTraceClient::SetRemote | ( | Ipv4Address | ip, |
| uint16_t | port | ||
| ) |
set the remote address and port
| ip | remote IPv4 address |
| port | remote port |
Definition at line 133 of file udp-trace-client.cc.
References m_entries, m_peerAddress, m_peerPort, NS_LOG_FUNCTION, and port.
| void ns3::UdpTraceClient::SetRemote | ( | Ipv6Address | ip, |
| uint16_t | port | ||
| ) |
set the remote address and port
| ip | remote IPv6 address |
| port | remote port |
Definition at line 142 of file udp-trace-client.cc.
References m_entries, m_peerAddress, m_peerPort, NS_LOG_FUNCTION, and port.
| void ns3::UdpTraceClient::SetRemote | ( | Address | ip, |
| uint16_t | port | ||
| ) |
set the remote address and port
| ip | remote IP address |
| port | remote port |
Definition at line 124 of file udp-trace-client.cc.
References m_entries, m_peerAddress, m_peerPort, NS_LOG_FUNCTION, and port.
| void ns3::UdpTraceClient::SetTraceFile | ( | std::string | filename | ) |
Set the trace file to be used by the application.
| filename | a path to an MPEG4 trace file formatted as follows: Frame No Frametype Time[ms] Length [byte] Frame No Frametype Time[ms] Length [byte] ... |
Definition at line 151 of file udp-trace-client.cc.
References LoadDefaultTrace(), LoadTrace(), and NS_LOG_FUNCTION.
Referenced by GetTypeId(), and UdpTraceClient().
Here is the call graph for this function: Here is the caller graph for this function:
|
privatevirtual |
Application specific startup code.
The StartApplication method is called at the start time specified by Start This method should be overridden by all or most application subclasses.
Reimplemented from ns3::Application.
Definition at line 244 of file udp-trace-client.cc.
References ns3::Socket::Bind(), ns3::Socket::Bind6(), ns3::Socket::Connect(), ns3::Ipv4Address::ConvertFrom(), ns3::Ipv6Address::ConvertFrom(), ns3::Socket::CreateSocket(), ns3::Application::GetNode(), ns3::Ipv4Address::IsMatchingType(), ns3::Ipv6Address::IsMatchingType(), ns3::TypeId::LookupByName(), m_peerAddress, m_peerPort, m_sendEvent, m_socket, ns3::MakeNullCallback(), NS_LOG_FUNCTION, ns3::Simulator::Schedule(), ns3::Seconds(), Send(), and ns3::Socket::SetRecvCallback().
Here is the call graph for this function:
|
privatevirtual |
Application specific shutdown code.
The StopApplication method is called at the stop time specified by Stop This method should be overridden by all or most application subclasses.
Reimplemented from ns3::Application.
Definition at line 268 of file udp-trace-client.cc.
References ns3::Simulator::Cancel(), m_sendEvent, and NS_LOG_FUNCTION.
Here is the call graph for this function:
|
staticprivate |
Default trace to send.
Definition at line 165 of file udp-trace-client.h.
Referenced by LoadDefaultTrace().
|
private |
Current entry index.
Definition at line 164 of file udp-trace-client.h.
Referenced by LoadDefaultTrace(), LoadTrace(), Send(), and UdpTraceClient().
|
private |
Entries in the trace to send.
Definition at line 163 of file udp-trace-client.h.
Referenced by LoadDefaultTrace(), LoadTrace(), Send(), SetRemote(), and ~UdpTraceClient().
|
private |
Maximum packet size to send (including the SeqTsHeader)
Definition at line 166 of file udp-trace-client.h.
Referenced by GetMaxPacketSize(), GetTypeId(), Send(), SetMaxPacketSize(), and UdpTraceClient().
|
private |
Remote peer address.
Definition at line 159 of file udp-trace-client.h.
Referenced by GetTypeId(), SendPacket(), SetRemote(), StartApplication(), and UdpTraceClient().
|
private |
Remote peer port.
Definition at line 160 of file udp-trace-client.h.
Referenced by GetTypeId(), SetRemote(), StartApplication(), and UdpTraceClient().
|
private |
Event to send the next packet.
Definition at line 161 of file udp-trace-client.h.
Referenced by Send(), StartApplication(), StopApplication(), and UdpTraceClient().
|
private |
Counter for sent packets.
Definition at line 157 of file udp-trace-client.h.
Referenced by SendPacket(), and UdpTraceClient().
Definition at line 158 of file udp-trace-client.h.
Referenced by SendPacket(), StartApplication(), and UdpTraceClient().
1.8.9.1 
