Base functionality for a INET domain Socket This call should be the starting point for all other unix domain sockets. More...

#include "socket_ip.h"

Inheritance diagram for Socket_IP:

Public Member Functions
	Socket_IP ()
	Def Constructor.

	Socket_IP (SOCKET in)
	Assigns an existing socket to this class.

virtual	~Socket_IP ()
	Destructor.

bool	Active ()
	Ask if the socket is open (allocated)

void	Close ()
	Closes a socket if it is open (allocated).

virtual TypeHandle	force_init_type ()

virtual TypeHandle	get_type () const

Socket_Address	GetPeerName (void) const
	Wrapper on berkly getpeername...

SOCKET	GetSocket ()
	Gets the base socket type.

SOCKET	GetSocket () const
	Get The RAW file id of the socket.

int	SetBlocking ()
	Set the socket to block on subsequent calls to socket functions that address this socket.

int	SetNonBlocking ()
	this function will throw a socket into non-blocking mode

int	SetRecvBufferSize (int size)
	Ok it sets the recv buffer size for both tcp and UDP.

bool	SetReuseAddress (bool flag=true)
	Informs a socket to reuse IP address as needed.

void	SetSocket (SOCKET ins)
	Assigns an existing socket to this class.

bool	SetV6Only (bool flag)
	Sets a flag indicating whether this IPv6 socket should operate in dual-stack mode or not.

Public Member Functions inherited from TypedObject
	TypedObject (const TypedObject &copy)=default

TypedObject *	as_typed_object ()
	Returns the object, upcast (if necessary) to a TypedObject pointer.

const TypedObject *	as_typed_object () const
	Returns the object, upcast (if necessary) to a TypedObject pointer.

int	get_best_parent_from_Set (const std::set< int > &) const

int	get_type_index () const
	Returns the internal index number associated with this object's TypeHandle, a unique number for each different type.

bool	is_exact_type (TypeHandle handle) const
	Returns true if the current object is the indicated type exactly.

bool	is_of_type (TypeHandle handle) const
	Returns true if the current object is or derives from the indicated type.

TypedObject &	operator= (const TypedObject &copy)=default

Public Member Functions inherited from MemoryBase
void	operator delete (void , void )

void	operator delete (void *ptr)

void	operator delete[] (void , void )

void	operator delete[] (void *ptr)

void *	operator new (size_t size)

void *	operator new (size_t size, void *ptr)

void *	operator new[] (size_t size)

void *	operator new[] (size_t size, void *ptr)

Static Public Member Functions
static TypeHandle	get_class_type ()

static int	GetLastError ()
	Gets the last errcode from a socket operation.

static void	init_type ()

static int	InitNetworkDriver ()

Static Public Member Functions inherited from TypedObject
static TypeHandle	get_class_type ()

static void	init_type ()
	This function is declared non-inline to work around a compiler bug in g++ 2.96.

Friends
class	Socket_TCP

class	Socket_TCP_Listen

class	Socket_TCP_SSL

class	Socket_UDP

class	Socket_UDP_Incoming

class	Socket_UDP_Outgoing

Additional Inherited Members
Public Attributes inherited from TypedObject
	get_type

Detailed Description

Base functionality for a INET domain Socket This call should be the starting point for all other unix domain sockets.

SocketIP | ------------------------------------------------------------------- | | | | SocketTCP SocketTCP_Listen SocketUDP_Incoming SocketUDP_OutBound

Definition at line 27 of file socket_ip.h.

Constructor & Destructor Documentation

◆ Socket_IP() [1/2]

Socket_IP::Socket_IP ( )

inline

Def Constructor.

Definition at line 107 of file socket_ip.h.

◆ Socket_IP() [2/2]

Socket_IP::Socket_IP ( SOCKET in )

inline

Assigns an existing socket to this class.

Definition at line 115 of file socket_ip.h.

◆ ~Socket_IP()

Socket_IP::~Socket_IP ( )

inlinevirtual

Destructor.

Definition at line 123 of file socket_ip.h.

References Close().

Member Function Documentation

◆ Active()

bool Socket_IP::Active ( )

inline

Ask if the socket is open (allocated)

Definition at line 99 of file socket_ip.h.

Referenced by Close().

◆ Close()

void Socket_IP::Close ( )

inline

Closes a socket if it is open (allocated).

Definition at line 131 of file socket_ip.h.

References Active().

Referenced by Buffered_DatagramConnection::~Buffered_DatagramConnection(), ~Socket_IP(), ConnectionManager::close_connection(), Socket_UDP_Incoming::InitNoAddress(), Socket_UDP_Outgoing::InitNoAddress(), Socket_UDP_Incoming::OpenForInput(), Socket_UDP_Incoming::OpenForInput(), Socket_UDP_Incoming::OpenForInputMCast(), and SetSocket().

◆ force_init_type()

virtual TypeHandle Socket_IP::force_init_type ( )

inlinevirtual

Implements TypedObject.

Definition at line 73 of file socket_ip.h.

◆ get_class_type()

static TypeHandle Socket_IP::get_class_type ( )

inlinestatic

Definition at line 62 of file socket_ip.h.

◆ get_type()

virtual TypeHandle Socket_IP::get_type ( ) const

inlinevirtual

Implements TypedObject.

Definition at line 70 of file socket_ip.h.

◆ GetLastError()

int Socket_IP::GetLastError ( )

inlinestatic

Gets the last errcode from a socket operation.

Definition at line 147 of file socket_ip.h.

Referenced by Buffered_DatagramConnection::Flush(), and Socket_UDP_Incoming::GetPacket().

◆ GetPeerName()

Socket_Address Socket_IP::GetPeerName ( void ) const

inline

Wrapper on berkly getpeername...

Definition at line 260 of file socket_ip.h.

◆ GetSocket() [1/2]

SOCKET Socket_IP::GetSocket ( )

inline

Gets the base socket type.

Definition at line 244 of file socket_ip.h.

Referenced by Socket_fdset::IsSetFor(), and Socket_UDP_Incoming::OpenForInputMCast().

◆ GetSocket() [2/2]

SOCKET Socket_IP::GetSocket ( ) const

inline

Get The RAW file id of the socket.

Definition at line 252 of file socket_ip.h.

◆ init_type()

static void Socket_IP::init_type ( )

inlinestatic

Definition at line 65 of file socket_ip.h.

◆ InitNetworkDriver()

static int Socket_IP::InitNetworkDriver ( )

inlinestatic

Definition at line 47 of file socket_ip.h.

◆ SetBlocking()

int Socket_IP::SetBlocking ( )

inline

Set the socket to block on subsequent calls to socket functions that address this socket.

Definition at line 198 of file socket_ip.h.

◆ SetNonBlocking()

int Socket_IP::SetNonBlocking ( )

inline

this function will throw a socket into non-blocking mode

Definition at line 176 of file socket_ip.h.

Referenced by Socket_TCP::ActiveOpenNonBlocking().

◆ SetRecvBufferSize()

int Socket_IP::SetRecvBufferSize ( int size )

inline

Ok it sets the recv buffer size for both tcp and UDP.

Definition at line 164 of file socket_ip.h.

◆ SetReuseAddress()

bool Socket_IP::SetReuseAddress ( bool flag = true )

inline

Informs a socket to reuse IP address as needed.

Definition at line 219 of file socket_ip.h.

Referenced by Socket_TCP::ActiveOpenNonBlocking(), Socket_TCP_Listen::OpenForListen(), and Socket_TCP_Listen::OpenForListen().

◆ SetSocket()

void Socket_IP::SetSocket ( SOCKET ins )

inline

Assigns an existing socket to this class.

Definition at line 155 of file socket_ip.h.

References Close().

◆ SetV6Only()

bool Socket_IP::SetV6Only ( bool flag )

inline

Sets a flag indicating whether this IPv6 socket should operate in dual-stack mode or not.

Definition at line 232 of file socket_ip.h.

Referenced by Socket_UDP_Incoming::InitNoAddress(), Socket_UDP_Incoming::OpenForInput(), and Socket_TCP_Listen::OpenForListen().

Friends And Related Symbol Documentation

◆ Socket_TCP

friend class Socket_TCP

friend

Definition at line 54 of file socket_ip.h.

◆ Socket_TCP_Listen

friend class Socket_TCP_Listen

friend

Definition at line 56 of file socket_ip.h.

◆ Socket_TCP_SSL

friend class Socket_TCP_SSL

friend

Definition at line 59 of file socket_ip.h.

◆ Socket_UDP

friend class Socket_UDP

friend

Definition at line 55 of file socket_ip.h.

◆ Socket_UDP_Incoming

friend class Socket_UDP_Incoming

friend

Definition at line 57 of file socket_ip.h.

◆ Socket_UDP_Outgoing

friend class Socket_UDP_Outgoing

friend

Definition at line 58 of file socket_ip.h.

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

panda/src/nativenet/socket_ip.h
panda/src/nativenet/socket_ip.cxx

Public Member Functions

Static Public Member Functions

Friends

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Socket_IP() [1/2]

◆ Socket_IP() [2/2]

◆ ~Socket_IP()

Member Function Documentation

◆ Active()

◆ Close()

◆ force_init_type()

◆ get_class_type()

◆ get_type()

◆ GetLastError()

◆ GetPeerName()

◆ GetSocket() [1/2]

◆ GetSocket() [2/2]

◆ init_type()

◆ InitNetworkDriver()

◆ SetBlocking()

◆ SetNonBlocking()

◆ SetRecvBufferSize()

◆ SetReuseAddress()

◆ SetSocket()

◆ SetV6Only()

Friends And Related Symbol Documentation

◆ Socket_TCP

◆ Socket_TCP_Listen

◆ Socket_TCP_SSL

◆ Socket_UDP

◆ Socket_UDP_Incoming

◆ Socket_UDP_Outgoing