FreeNOS
Public Member Functions | Private Attributes
UDPFactory Class Reference

User Datagram Protocol (UDP). More...

#include <UDPFactory.h>

Inheritance diagram for UDPFactory:
File

Public Member Functions

 UDPFactory (const u32 inode, UDP *udp)
 Constructor. More...
 
virtual ~UDPFactory ()
 Destructor. More...
 
virtual FileSystem::Result read (IOBuffer &buffer, Size &size, const Size offset)
 Create UDP socket. More...
 
- 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. More...
 
virtual ~File ()
 Destructor function. More...
 
u32 getInode () const
 Get inode number. More...
 
FileSystem::FileType getType () const
 Retrieve our filetype. More...
 
virtual FileSystem::Result write (IOBuffer &buffer, Size &size, const Size offset)
 Write bytes to the file. More...
 
virtual FileSystem::Result status (FileSystem::FileStat &st)
 Retrieve file statistics. More...
 
virtual bool canRead () const
 Check if the File has data ready for reading. More...
 
virtual bool canWrite () const
 Check if the File can be written to. More...
 

Private Attributes

UDPm_udp
 UDP protocol instance. More...
 

Additional Inherited Members

- Protected Attributes inherited from File
const u32 m_inode
 Inode number. More...
 
const FileSystem::FileType m_type
 Type of this file. More...
 
UserID m_uid
 Owner of the file. More...
 
GroupID m_gid
 Group of the file. More...
 
FileSystem::FileModes m_access
 Access permissions. More...
 
Size m_size
 Size of the file, in bytes. More...
 

Detailed Description

User Datagram Protocol (UDP).

The UDP factory creates new sockets for applications.

Definition at line 38 of file UDPFactory.h.

Constructor & Destructor Documentation

◆ UDPFactory()

UDPFactory::UDPFactory ( const u32  inode,
UDP udp 
)

Constructor.

Parameters
inodeInode number
udpUDP object pointer

Definition at line 22 of file UDPFactory.cpp.

◆ ~UDPFactory()

UDPFactory::~UDPFactory ( )
virtual

Destructor.

Definition at line 29 of file UDPFactory.cpp.

Member Function Documentation

◆ read()

FileSystem::Result UDPFactory::read ( IOBuffer buffer,
Size size,
const Size  offset 
)
virtual

Create UDP socket.

Parameters
bufferInput/Output buffer to output bytes to.
sizeMaximum number of bytes to read on input. On output, the actual number of bytes read.
offsetOffset inside the file to start reading.
Returns
Result code

Reimplemented from File.

Definition at line 33 of file UDPFactory.cpp.

References UDP::createSocket(), DEBUG, ERROR, ChannelMessage::from, IOBuffer::getMessage(), FileSystem::IOError, String::length(), m_udp, FileSystem::Success, and IOBuffer::write().

Field Documentation

◆ m_udp

UDP* UDPFactory::m_udp
private

UDP protocol instance.

Definition at line 73 of file UDPFactory.h.

Referenced by read().


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