Implement a BSD compatible socket device. More...

#include <Socket.hxx>

Inheritance diagram for Socket:

Protected Member Functions
	Socket (const char *name)
	Constructor.

	~Socket ()
	Destructor.

int	ioctl (File *file, unsigned long int key, unsigned long data) override
	Request an ioctl transaction.

bool	select (File *file, int mode) override
	Device select method.

Protected Member Functions inherited from Node
	Node (const char *name)
	Constructor.

virtual	~Node ()
	Destructor.

int	open (File , const char , int, int) OVERRIDE
	Open method.

int	close (File *) OVERRIDE
	Close method.

virtual int	fstat (File file, struct stat stat) override
	Get the status information of a file or device.

Protected Member Functions inherited from FileIO
	FileIO (const char *name)
	Constructor.

virtual	~FileIO ()
	Destructor.

virtual int	fcntl (File *file, int cmd, unsigned long data)
	Manipulate a file descriptor.

Protected Attributes
SelectInfo	selInfoRd
	select wakeup metadata for read active

SelectInfo	selInfoWr
	select wakeup metadata for write active

Protected Attributes inherited from Node
OSMutex	lock_
	protects internal structures.

mode_t	mode_
	File open mode, such as O_NONBLOCK.

unsigned int	references_
	number of open references

Protected Attributes inherited from FileIO
const char *	name
	device name

Private Member Functions
ssize_t	read (File file, void buf, size_t count) override
	Read from a file or device.

ssize_t	write (File file, const void buf, size_t count) override
	Write to a file or device.

off_t	lseek (File *f, off_t offset, int whence) override
	Seek method.

void	enable () override
	function to enable device

void	disable () override
	This will be called when reference count goes from non-zero to 0.

void	flush_buffers () override
	function to disable device

	DISALLOW_COPY_AND_ASSIGN (Socket)

Additional Inherited Members
Public Member Functions inherited from Device
	Device (const char *name)
	Constructor.

virtual	~Device ()
	Destructor.

Static Public Member Functions inherited from Device
static int	open (struct _reent reent, const char path, int flags, int mode)
	Open a file or device.

static int	close (struct _reent *reent, int fd)
	Close a file or device.

static int	stat (struct _reent reent, const char path, struct stat *stat)
	Get the status information of a file or device.

static int	select (int nfds, fd_set readfds, fd_set writefds, fd_set *exceptfds, long long timeout)
	POSIX select().

static void	select_clear ()
	Clears the current thread's select bits.

Static Public Member Functions inherited from FileIO
static ssize_t	read (struct _reent reent, int fd, void buf, size_t count)
	Read from a file or device.

static ssize_t	write (struct _reent reent, int fd, const void buf, size_t count)
	Write to a file or device.

static _off_t	lseek (struct _reent *reent, int fd, _off_t offset, int whence)
	Change the offset index of a file or device.

static int	fstat (struct _reent reent, int fd, struct stat stat)
	Get the status information of a file or device.

static int	ioctl (int fd, unsigned long int key, unsigned long data)
	Request and ioctl transaction.

static int	fcntl (int fd, int cmd, unsigned long data)
	Manipulate a file descriptor.

static bool	is_device (int fd)
	Test if the file descriptor belongs to a device.

Static Protected Member Functions inherited from Device
static void	select_insert (SelectInfo *info)
	Add client to list of clients needing woken.

static void	select_wakeup (SelectInfo *info)
	Wakeup the list of clients needing woken.

static void	select_wakeup_from_isr (SelectInfo info, int woken)
	Wakeup the list of clients needing woken.

Static Protected Member Functions inherited from FileIO
static int	fd_alloc (void)
	Allocate a free file descriptor.

static void	fd_free (int fd)
	Free up a file descriptor.

static File *	file_lookup (int fd)
	Looks up a reference to a File corresponding to a given file descriptor.

static int	fd_lookup (File *file)
	Looks up a file descriptor corresponding to a given File reference.

Static Protected Attributes inherited from FileIO
static const unsigned int	numOpenFiles = 20

static File	files []
	File descriptor pool.

static OSMutex	mutex
	mutual exclusion for fileio

Detailed Description

Implement a BSD compatible socket device.

Definition at line 44 of file Socket.hxx.

Constructor & Destructor Documentation

◆ Socket()

Socket::Socket ( const char * name )

inlineprotected

Constructor.

Parameters

name	device name in file system

Definition at line 50 of file Socket.hxx.

◆ ~Socket()

Socket::~Socket ( )

inlineprotected

Destructor.

Definition at line 60 of file Socket.hxx.

Member Function Documentation

◆ disable()

void Socket::disable ( )

inlineoverrideprivatevirtual

This will be called when reference count goes from non-zero to 0.

Called with lock_ held.

Implements Node.

Definition at line 114 of file Socket.hxx.

◆ enable()

void Socket::enable ( )

inlineoverrideprivatevirtual

function to enable device

Implements Node.

Definition at line 113 of file Socket.hxx.

◆ flush_buffers()

void Socket::flush_buffers ( )

inlineoverrideprivatevirtual

function to disable device

Discards all pending buffers. Called after disable().

Implements Node.

Definition at line 117 of file Socket.hxx.

◆ ioctl()

int Socket::ioctl	(	File *	file,
		unsigned long int	key,
		unsigned long	data
	)

overrideprotectedvirtual

Request an ioctl transaction.

Parameters

file	file reference for this device
key	ioctl key
data	key data
file	file reference for this device
node	node reference for this device
key	ioctl key
data	key data

Reimplemented from FileIO.

Definition at line 83 of file Socket.cxx.

◆ lseek()

off_t Socket::lseek	(	File *	f,
		off_t	offset,
		int	whence
	)

inlineoverrideprivatevirtual

Seek method.

Not valid for a socket.

Parameters

f	file reference for this device
offset	offset in bytes from whence directive
whence	SEEK_SET if to set the file offset to an abosolute position, SEEK_CUR if to set the file offset from current position

Returns: -ESPIPE

Reimplemented from FileIO.

Definition at line 108 of file Socket.hxx.

◆ read()

ssize_t Socket::read	(	File *	file,
		void *	buf,
		size_t	count
	)

overrideprivatevirtual

Read from a file or device.

Parameters

file	file reference for this device
buf	location to place read data
count	number of bytes to read

Returns: number of bytes read upon success, negative errno containing the cause

Implements FileIO.

Definition at line 50 of file Socket.cxx.

◆ select()

bool Socket::select	(	File *	file,
		int	mode
	)

overrideprotectedvirtual

Device select method.

Default implementation returns true.

Parameters

file	reference to the file
mode	FREAD for read active, FWRITE for write active, 0 for exceptions

Returns: true if active, false if inactive

Default impementation returns true.

Parameters

file	reference to the file
mode	FREAD for read active, FWRITE for write active, 0 for exceptions

Returns: true if active, false if inactive

Reimplemented from FileIO.

Definition at line 94 of file Socket.cxx.

◆ write()

ssize_t Socket::write	(	File *	file,
		const void *	buf,
		size_t	count
	)

overrideprivatevirtual

Write to a file or device.

Parameters

file	file reference for this device
buf	location to find write data
count	number of bytes to write

Returns: number of bytes written upon success, negative errno containing the cause

Implements FileIO.

Definition at line 67 of file Socket.cxx.

Member Data Documentation

◆ selInfoRd

SelectInfo Socket::selInfoRd

protected

select wakeup metadata for read active

Definition at line 79 of file Socket.hxx.

◆ selInfoWr

SelectInfo Socket::selInfoWr

protected

select wakeup metadata for write active

Definition at line 80 of file Socket.hxx.

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

Protected Member Functions

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Socket()

◆ ~Socket()

Member Function Documentation

◆ disable()

◆ enable()

◆ flush_buffers()

◆ ioctl()

◆ lseek()

◆ read()

◆ select()

◆ write()

Member Data Documentation

◆ selInfoRd

◆ selInfoWr