NetworkSocket Class Reference

Network socket represents a single logical connection on a protocol. More...

#include <NetworkSocket.h>

Inheritance diagram for NetworkSocket:

Public Member Functions
	NetworkSocket (const u32 inode, const Size packetSize, const ProcessID pid)
	Constructor.
virtual	~NetworkSocket ()
	Destructor.
ProcessID	getProcessID () const
	Get owner ProcessID.
virtual FileSystem::Result	process (const NetworkQueue::Packet *pkt)=0
	Process incoming network packet.
Public Member Functions inherited from File
	File (const u32 inode, const FileSystem::FileType type=FileSystem::RegularFile, const UserID uid=ZERO, const GroupID gid=ZERO)
	Constructor function.
virtual	~File ()
	Destructor function.
u32	getInode () const
	Get inode number.
FileSystem::FileType	getType () const
	Retrieve our filetype.
virtual FileSystem::Result	read (IOBuffer &buffer, Size &size, const Size offset)
	Read bytes from the file.
virtual FileSystem::Result	write (IOBuffer &buffer, Size &size, const Size offset)
	Write bytes to the file.
virtual FileSystem::Result	status (FileSystem::FileStat &st)
	Retrieve file statistics.
virtual bool	canRead () const
	Check if the File has data ready for reading.
virtual bool	canWrite () const
	Check if the File can be written to.

Protected Attributes
const ProcessID	m_pid
	ProcessID which owns this socket.
NetworkQueue	m_receive
	Receive queue.
NetworkQueue	m_transmit
	Transmit queue.
NetworkClient::SocketInfo	m_info
	Socket connection.
Protected Attributes inherited from File
const u32	m_inode
	Inode number.
const FileSystem::FileType	m_type
	Type of this file.
UserID	m_uid
	Owner of the file.
GroupID	m_gid
	Group of the file.
FileSystem::FileModes	m_access
	Access permissions.
Size	m_size
	Size of the file, in bytes.

Detailed Description

Network socket represents a single logical connection on a protocol.

Definition at line 37 of file NetworkSocket.h.

Constructor & Destructor Documentation

NetworkSocket()

NetworkSocket::NetworkSocket	(	const u32	inode,
		const Size	packetSize,
		const ProcessID	pid
	)

Constructor.

Parameters

inode	Inode number
packetSize	Size of each network packet
pid	ProcessID which owns this socket

Definition at line 21 of file NetworkSocket.cpp.

References m_info, and MemoryBlock::set().

~NetworkSocket()

NetworkSocket::~NetworkSocket ( )

virtual

Destructor.

Definition at line 32 of file NetworkSocket.cpp.

Member Function Documentation

getProcessID()

ProcessID NetworkSocket::getProcessID

(

)

const

Get owner ProcessID.

Returns

ProcessID

Definition at line 36 of file NetworkSocket.cpp.

References m_pid.

Referenced by ICMP::unregisterSockets(), and UDP::unregisterSockets().

process()

virtual FileSystem::Result NetworkSocket::process ( const NetworkQueue::Packet *  pkt )

pure virtual

Process incoming network packet.

Parameters

pkt	Incoming packet pointer

Returns

Result code

Implemented in ARPSocket, ICMPSocket, and UDPSocket.

Field Documentation

m_info

NetworkClient::SocketInfo NetworkSocket::m_info

protected

Socket connection.

Definition at line 85 of file NetworkSocket.h.

Referenced by ICMPSocket::getAddress(), ICMPSocket::ICMPSocket(), NetworkSocket(), ICMPSocket::write(), and UDPSocket::write().

m_pid

const ProcessID NetworkSocket::m_pid

protected

ProcessID which owns this socket.

Definition at line 76 of file NetworkSocket.h.

Referenced by getProcessID().

m_receive

NetworkQueue NetworkSocket::m_receive

protected

Receive queue.

Definition at line 79 of file NetworkSocket.h.

m_transmit

NetworkQueue NetworkSocket::m_transmit

protected

Transmit queue.

Definition at line 82 of file NetworkSocket.h.

---

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

• lib/libnet/NetworkSocket.h
• lib/libnet/NetworkSocket.cpp