oasys::RateLimitedSocket Class Reference

#include <RateLimitedSocket.h>

Inheritance diagram for oasys::RateLimitedSocket:

List of all members.

---

Detailed Description

The RateLimitedSocket class contains a socket class and a token bucket and provides an interface to send data only if there is enough space to send it out in.

Note that the rate is configured in bits per second.

Definition at line 57 of file RateLimitedSocket.h.

Public Member Functions
	RateLimitedSocket (const char *logpath, u_int32_t rate, IPSocket *socket=NULL)
	Constructor.
int	send (const char *bp, size_t len, int flags)
	Send the given data on the socket iff the rate controller indicates that there is space.
int	sendto (char *bp, size_t len, int flags, in_addr_t addr, u_int16_t port)
	Send the given data on the socket iff the rate controller indicates that there is space.
TokenBucket *	bucket ()
	Accessors.
IPSocket *	socket ()
	Accessors.
void	set_socket (IPSocket *sock)
	Setters.
Protected Attributes
TokenBucket	bucket_
IPSocket *	socket_

---

Constructor & Destructor Documentation

oasys::RateLimitedSocket::RateLimitedSocket	(	const char *	logpath,
		u_int32_t	rate,
		IPSocket *	socket = NULL
	)

Constructor.

Definition at line 44 of file RateLimitedSocket.cc.

---

Member Function Documentation

int oasys::RateLimitedSocket::send	(	const char *	bp,
		size_t	len,
		int	flags
	)

Send the given data on the socket iff the rate controller indicates that there is space.

Returns:

IORATELIMIT if there isn't space in the token bucket for the given number of bytes, the return from IPSocket::send if there is space.

Definition at line 55 of file RateLimitedSocket.cc.

References ASSERT, bucket_, oasys::TokenBucket::drain(), oasys::IORATELIMIT, log_debug, oasys::TokenBucket::rate(), oasys::IPSocket::send(), socket_, and oasys::TokenBucket::tokens().

int oasys::RateLimitedSocket::sendto	(	char *	bp,
		size_t	len,
		int	flags,
		in_addr_t	addr,
		u_int16_t	port
	)

Send the given data on the socket iff the rate controller indicates that there is space.

Returns:

IORATELIMIT if there isn't space in the token bucket for the given number of bytes, the return from IPSocket::sendto if there is space.

Definition at line 76 of file RateLimitedSocket.cc.

References ASSERT, bucket_, oasys::TokenBucket::drain(), oasys::IORATELIMIT, log_debug, oasys::TokenBucket::rate(), oasys::IPSocket::sendto(), socket_, and oasys::TokenBucket::tokens().

TokenBucket* oasys::RateLimitedSocket::bucket

(

)

[inline]

Accessors.

Definition at line 89 of file RateLimitedSocket.h.

References bucket_.

Referenced by dtn::UDPConvergenceLayer::Sender::init().

IPSocket* oasys::RateLimitedSocket::socket

(

)

[inline]

Accessors.

Definition at line 90 of file RateLimitedSocket.h.

References socket_.

void oasys::RateLimitedSocket::set_socket

(

IPSocket *

sock

)

[inline]

Setters.

Definition at line 94 of file RateLimitedSocket.h.

References socket_.

---

Member Data Documentation

TokenBucket oasys::RateLimitedSocket::bucket_ [protected]

Definition at line 98 of file RateLimitedSocket.h.

Referenced by bucket(), send(), and sendto().

IPSocket* oasys::RateLimitedSocket::socket_ [protected]

Definition at line 99 of file RateLimitedSocket.h.

Referenced by send(), sendto(), set_socket(), and socket().

---

The documentation for this class was generated from the following files:

• RateLimitedSocket.h
• RateLimitedSocket.cc

---