|
A Discrete-Event Network Simulator
|
API |
|
|
A Discrete-Event Network Simulator
|
API |
(abstract) base class of all TcpSockets More...
#include <tcp-socket.h>
Inheritance diagram for ns3::TcpSocket:Static Public Member Functions | |
| static TypeId | GetTypeId (void) |
| Static Public Member Functions inherited from ns3::Socket | |
| static Ptr< Socket > | CreateSocket (Ptr< Node > node, TypeId tid) |
| static TypeId | GetTypeId (void) |
| Static Public Member Functions inherited from ns3::Object | |
| static TypeId | GetTypeId (void) |
| Static Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
| static void | Cleanup (void) |
| Static Public Member Functions inherited from ns3::ObjectBase | |
| static TypeId | GetTypeId (void) |
Private Member Functions | |
| virtual uint32_t | GetConnCount (void) const =0 |
| virtual Time | GetConnTimeout (void) const =0 |
| virtual uint32_t | GetDelAckMaxCount (void) const =0 |
| virtual Time | GetDelAckTimeout (void) const =0 |
| virtual uint32_t | GetInitialCwnd (void) const =0 |
| virtual Time | GetPersistTimeout (void) const =0 |
| virtual uint32_t | GetRcvBufSize (void) const =0 |
| virtual uint32_t | GetSegSize (void) const =0 |
| virtual uint32_t | GetSndBufSize (void) const =0 |
| virtual uint32_t | GetSSThresh (void) const =0 |
| virtual bool | GetTcpNoDelay (void) const =0 |
| virtual void | SetConnCount (uint32_t count)=0 |
| virtual void | SetConnTimeout (Time timeout)=0 |
| virtual void | SetDelAckMaxCount (uint32_t count)=0 |
| virtual void | SetDelAckTimeout (Time timeout)=0 |
| virtual void | SetInitialCwnd (uint32_t count)=0 |
| virtual void | SetPersistTimeout (Time timeout)=0 |
| virtual void | SetRcvBufSize (uint32_t size)=0 |
| virtual void | SetSegSize (uint32_t size)=0 |
| virtual void | SetSndBufSize (uint32_t size)=0 |
| virtual void | SetSSThresh (uint32_t threshold)=0 |
| virtual void | SetTcpNoDelay (bool noDelay)=0 |
Additional Inherited Members | |
| Public Types inherited from ns3::Socket | |
| enum | SocketErrno { ERROR_NOTERROR, ERROR_ISCONN, ERROR_NOTCONN, ERROR_MSGSIZE, ERROR_AGAIN, ERROR_SHUTDOWN, ERROR_OPNOTSUPP, ERROR_AFNOSUPPORT, ERROR_INVAL, ERROR_BADF, ERROR_NOROUTETOHOST, ERROR_NODEV, ERROR_ADDRNOTAVAIL, ERROR_ADDRINUSE, SOCKET_ERRNO_LAST } |
| enum | SocketType { NS3_SOCK_STREAM, NS3_SOCK_SEQPACKET, NS3_SOCK_DGRAM, NS3_SOCK_RAW } |
| Public Member Functions inherited from ns3::Socket | |
| virtual int | Bind (const Address &address)=0 |
| Allocate a local endpoint for this socket. More... | |
| virtual int | Bind ()=0 |
| Allocate a local IPv4 endpoint for this socket. More... | |
| virtual int | Bind6 ()=0 |
| Allocate a local IPv6 endpoint for this socket. More... | |
| virtual void | BindToNetDevice (Ptr< NetDevice > netdevice) |
| Bind a socket to specific device. More... | |
| virtual int | Close (void)=0 |
| Close a socket. More... | |
| virtual int | Connect (const Address &address)=0 |
| Initiate a connection to a remote host. More... | |
| virtual bool | GetAllowBroadcast () const =0 |
| Query whether broadcast datagram transmissions are allowed. More... | |
| Ptr< NetDevice > | GetBoundNetDevice () |
| Returns socket's bound netdevice, if any. More... | |
| virtual enum Socket::SocketErrno | GetErrno (void) const =0 |
| uint8_t | GetIpTos (void) const |
| virtual uint8_t | GetIpTtl (void) const |
| virtual uint8_t | GetIpv6HopLimit (void) const |
| uint8_t | GetIpv6Tclass (void) const |
| virtual Ptr< Node > | GetNode (void) const =0 |
| virtual uint32_t | GetRxAvailable (void) const =0 |
| virtual enum Socket::SocketType | GetSocketType (void) const =0 |
| virtual int | GetSockName (Address &address) const =0 |
| virtual uint32_t | GetTxAvailable (void) const =0 |
| Returns the number of bytes which can be sent in a single call to Send. More... | |
| bool | IsIpRecvTos (void) const |
| Ask if the socket is currently passing information about IP Type of Service up the stack. More... | |
| bool | IsIpRecvTtl (void) const |
| Ask if the socket is currently passing information about IP_TTL up the stack. More... | |
| bool | IsIpv6RecvHopLimit (void) const |
| Ask if the socket is currently passing information about IPv6 Hop Limit up the stack. More... | |
| bool | IsIpv6RecvTclass (void) const |
| Ask if the socket is currently passing information about IPv6 Traffic Class up the stack. More... | |
| bool | IsRecvPktInfo () const |
| Get status indicating whether enable/disable packet information to socket. More... | |
| virtual int | Listen (void)=0 |
| Listen for incoming connections. More... | |
| virtual Ptr< Packet > | Recv (uint32_t maxSize, uint32_t flags)=0 |
| Read data from the socket. More... | |
| Ptr< Packet > | Recv (void) |
| Read a single packet from the socket. More... | |
| int | Recv (uint8_t *buf, uint32_t size, uint32_t flags) |
| Recv data (or dummy data) from the remote host. More... | |
| virtual Ptr< Packet > | RecvFrom (uint32_t maxSize, uint32_t flags, Address &fromAddress)=0 |
| Read a single packet from the socket and retrieve the sender address. More... | |
| Ptr< Packet > | RecvFrom (Address &fromAddress) |
| Read a single packet from the socket and retrieve the sender address. More... | |
| int | RecvFrom (uint8_t *buf, uint32_t size, uint32_t flags, Address &fromAddress) |
| Read a single packet from the socket and retrieve the sender address. More... | |
| virtual int | Send (Ptr< Packet > p, uint32_t flags)=0 |
| Send data (or dummy data) to the remote host. More... | |
| int | Send (Ptr< Packet > p) |
| Send data (or dummy data) to the remote host. More... | |
| int | Send (const uint8_t *buf, uint32_t size, uint32_t flags) |
| Send data (or dummy data) to the remote host. More... | |
| virtual int | SendTo (Ptr< Packet > p, uint32_t flags, const Address &toAddress)=0 |
| Send data to a specified peer. More... | |
| int | SendTo (const uint8_t *buf, uint32_t size, uint32_t flags, const Address &address) |
| Send data to a specified peer. More... | |
| void | SetAcceptCallback (Callback< bool, Ptr< Socket >, const Address & > connectionRequest, Callback< void, Ptr< Socket >, const Address & > newConnectionCreated) |
| Accept connection requests from remote hosts. More... | |
| virtual bool | SetAllowBroadcast (bool allowBroadcast)=0 |
| Configure whether broadcast datagram transmissions are allowed. More... | |
| void | SetCloseCallbacks (Callback< void, Ptr< Socket > > normalClose, Callback< void, Ptr< Socket > > errorClose) |
| Detect socket recv() events such as graceful shutdown or error. More... | |
| void | SetConnectCallback (Callback< void, Ptr< Socket > > connectionSucceeded, Callback< void, Ptr< Socket > > connectionFailed) |
| Specify callbacks to allow the caller to determine if the connection succeeds of fails. More... | |
| void | SetDataSentCallback (Callback< void, Ptr< Socket >, uint32_t > dataSent) |
| Notify application when a packet has been sent from transport protocol (non-standard socket call) More... | |
| void | SetIpRecvTos (bool ipv4RecvTos) |
| Tells a socket to pass information about IP Type of Service up the stack. More... | |
| void | SetIpRecvTtl (bool ipv4RecvTtl) |
| Tells a socket to pass information about IP_TTL up the stack. More... | |
| void | SetIpTos (uint8_t ipTos) |
| virtual void | SetIpTtl (uint8_t ipTtl) |
| virtual void | SetIpv6HopLimit (uint8_t ipHopLimit) |
| void | SetIpv6RecvHopLimit (bool ipv6RecvHopLimit) |
| Tells a socket to pass information about IPv6 Hop Limit up the stack. More... | |
| void | SetIpv6RecvTclass (bool ipv6RecvTclass) |
| Tells a socket to pass information about IPv6 Traffic Class up the stack. More... | |
| void | SetIpv6Tclass (int ipTclass) |
| void | SetRecvCallback (Callback< void, Ptr< Socket > >) |
| Notify application when new data is available to be read. More... | |
| void | SetRecvPktInfo (bool flag) |
| Enable/Disable receive packet information to socket. More... | |
| void | SetSendCallback (Callback< void, Ptr< Socket >, uint32_t > sendCb) |
| Notify application when space in transmit buffer is added. More... | |
| virtual int | ShutdownRecv (void)=0 |
| virtual int | ShutdownSend (void)=0 |
| Public Member Functions inherited from ns3::Object | |
| void | AggregateObject (Ptr< Object > other) |
| void | Dispose (void) |
| AggregateIterator | GetAggregateIterator (void) const |
| virtual TypeId | GetInstanceTypeId (void) const |
| template<typename T > | |
| Ptr< T > | GetObject (void) const |
| template<typename T > | |
| Ptr< T > | GetObject (TypeId tid) const |
| void | Initialize (void) |
| Public Member Functions inherited from ns3::SimpleRefCount< Object, ObjectBase, ObjectDeleter > | |
| SimpleRefCount (const SimpleRefCount &o) | |
| uint32_t | GetReferenceCount (void) const |
| SimpleRefCount & | operator= (const SimpleRefCount &o) |
| void | Ref (void) const |
| void | Unref (void) const |
| Public Member Functions inherited from ns3::ObjectBase | |
| void | GetAttribute (std::string name, AttributeValue &value) const |
| bool | GetAttributeFailSafe (std::string name, AttributeValue &attribute) const |
| void | SetAttribute (std::string name, const AttributeValue &value) |
| bool | SetAttributeFailSafe (std::string name, const AttributeValue &value) |
| bool | TraceConnect (std::string name, std::string context, const CallbackBase &cb) |
| bool | TraceConnectWithoutContext (std::string name, const CallbackBase &cb) |
| bool | TraceDisconnect (std::string name, std::string context, const CallbackBase &cb) |
| bool | TraceDisconnectWithoutContext (std::string name, const CallbackBase &cb) |
| Protected Member Functions inherited from ns3::Socket | |
| virtual void | DoDispose (void) |
| bool | IsManualIpTos (void) const |
| bool | IsManualIpTtl (void) const |
| bool | IsManualIpv6HopLimit (void) const |
| bool | IsManualIpv6Tclass (void) const |
| void | NotifyConnectionFailed (void) |
| bool | NotifyConnectionRequest (const Address &from) |
| void | NotifyConnectionSucceeded (void) |
| void | NotifyDataRecv (void) |
| void | NotifyDataSent (uint32_t size) |
| void | NotifyErrorClose (void) |
| void | NotifyNewConnectionCreated (Ptr< Socket > socket, const Address &from) |
| void | NotifyNormalClose (void) |
| void | NotifySend (uint32_t spaceAvailable) |
| Protected Member Functions inherited from ns3::Object | |
| Object (const Object &o) | |
| virtual void | DoInitialize (void) |
| virtual void | NotifyNewAggregate (void) |
| Protected Member Functions inherited from ns3::ObjectBase | |
| void | ConstructSelf (const AttributeConstructionList &attributes) |
| virtual void | NotifyConstructionCompleted (void) |
| Protected Attributes inherited from ns3::Socket | |
| Ptr< NetDevice > | m_boundnetdevice |
| bool | m_recvPktInfo |
(abstract) base class of all TcpSockets
This class exists solely for hosting TcpSocket attributes that can be reused across different implementations.
Doxygen introspection did not find any typical Config paths.
No TraceSources are defined for this type.
Definition at line 62 of file tcp-socket.h.
1.8.6 
