ACE_ICMP_Socket Class Reference

An abstract class that forms the basis for usage of the ICMP protocol (that is, support for things such as ping). More...

#include <ICMP_Socket.h>

Inheritance diagram for ACE_ICMP_Socket:

Collaboration diagram for ACE_ICMP_Socket:

Data transfer routines.
Data transfer routines.
	ACE_ALLOC_HOOK_DECLARE
	Declare the dynamic allocation hooks.
ssize_t	send (void const *buf, size_t n, ACE_Addr const &addr, int flags=0) const
ssize_t	recv (void *buf, size_t n, ACE_Addr &addr, int flags=0) const
ssize_t	recv (void *buf, size_t n, int flags, ACE_Time_Value const *timeout) const
	TODO: comment.
int	open (ACE_Addr const &local=ACE_Addr::sap_any, int protocol=IPPROTO_ICMP, int reuse_addr=0)
	Wrapper around the BSD-style socket system call (no QoS).
void	dump () const
	Dump the state of object.
	ACE_ICMP_Socket ()
	Default constructor.
	ACE_ICMP_Socket (ACE_Addr const &local, int protocol=IPPROTO_ICMP, int reuse_addr=0)
	Constructor that takes a local listening address.
int	shared_open (ACE_Addr const &local)
	Wrapper around BSD-style bind system call.
unsigned short	calculate_checksum (unsigned short *paddress, int len)
	Calculates check-sum.

Additional Inherited Members
Public Member Functions inherited from ACE_SOCK
int	set_option (int level, int option, void *optval, int optlen) const
	Wrapper around the setsockopt system call.
int	get_option (int level, int option, void *optval, int *optlen) const
	Wrapper around the getsockopt system call.
int	close ()
int	get_local_addr (ACE_Addr &) const
int	get_remote_addr (ACE_Addr &) const
void	dump () const
	Dump the state of an object.
int	open (int type, int protocol_family, int protocol, int reuse_addr)
	Wrapper around the BSD-style socket system call (no QoS).
int	open (int type, int protocol_family, int protocol, ACE_Protocol_Info *protocolinfo, ACE_SOCK_GROUP g, u_long flags, int reuse_addr)
	Wrapper around the QoS-enabled WSASocket function.
Public Member Functions inherited from ACE_IPC_SAP
int	control (int cmd, void *) const
	Interface for <ioctl>.
int	enable (int value) const
int	disable (int value) const
ACE_HANDLE	get_handle () const
	Get the underlying handle.
void	set_handle (ACE_HANDLE handle)
	Set the underlying handle.
void	dump () const
	Dump the state of an object.
Public Attributes inherited from ACE_SOCK
	ACE_ALLOC_HOOK_DECLARE
	Declare the dynamic allocation hooks.
Public Attributes inherited from ACE_IPC_SAP
	ACE_ALLOC_HOOK_DECLARE
	Declare the dynamic allocation hooks.
Protected Member Functions inherited from ACE_SOCK
	ACE_SOCK (int type, int protocol_family, int protocol=0, int reuse_addr=0)
	ACE_SOCK (int type, int protocol_family, int protocol, ACE_Protocol_Info *protocolinfo, ACE_SOCK_GROUP g, u_long flags, int reuse_addr)
	ACE_SOCK ()
	~ACE_SOCK ()=default
	Protected destructor.
Protected Member Functions inherited from ACE_IPC_SAP
	ACE_IPC_SAP ()
	Default constructor.
	~ACE_IPC_SAP ()
	Protected destructor.

Detailed Description

An abstract class that forms the basis for usage of the ICMP protocol (that is, support for things such as ping).

Constructor & Destructor Documentation

ACE_ICMP_Socket() [1/2]

ACE_ICMP_Socket::ACE_ICMP_Socket ( )

protected

Default constructor.

ACE_ICMP_Socket() [2/2]

ACE_ICMP_Socket::ACE_ICMP_Socket ( ACE_Addr const & local, int protocol = IPPROTO_ICMP, int reuse_addr = 0 )

protected

Constructor that takes a local listening address.

Member Function Documentation

calculate_checksum()

unsigned short ACE_ICMP_Socket::calculate_checksum ( unsigned short * paddress, int len )

protected

Calculates check-sum.

dump()

void ACE_ICMP_Socket::dump

(

)

const

Dump the state of object.

open()

int ACE_ICMP_Socket::open	(	ACE_Addr const &	local = ACE_Addr::sap_any,
		int	protocol = IPPROTO_ICMP,
		int	reuse_addr = 0 )

Wrapper around the BSD-style socket system call (no QoS).

recv() [1/2]

ssize_t ACE_ICMP_Socket::recv	(	void *	buf,
		size_t	n,
		ACE_Addr &	addr,
		int	flags = 0 ) const

Receive an n byte buf from the datagram socket (uses recvfrom(3) ).

recv() [2/2]

ssize_t ACE_ICMP_Socket::recv	(	void *	buf,
		size_t	n,
		int	flags,
		ACE_Time_Value const *	timeout ) const

TODO: comment.

send()

ssize_t ACE_ICMP_Socket::send	(	void const *	buf,
		size_t	n,
		ACE_Addr const &	addr,
		int	flags = 0 ) const

Send an n byte buf to the datagram socket (uses sendto(3) ).

shared_open()

int ACE_ICMP_Socket::shared_open ( ACE_Addr const & local )

protected

Wrapper around BSD-style bind system call.

Member Data Documentation

ACE_ALLOC_HOOK_DECLARE

ACE_ICMP_Socket::ACE_ALLOC_HOOK_DECLARE

Declare the dynamic allocation hooks.

---

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

• ICMP_Socket.h
• ICMP_Socket.cpp