Network socket. More...

#include <cmsis-plus/posix-io/socket.h>

Inheritance diagram for os::posix::socket:

Public Types
Types & Constants
enum	type : type_t { unknown = 0 , not_set = 1 << 0 , char_device = 1 << 1 , block_device = 1 << 2 , tty = 1 << 3 , file = 1 << 4 , socket = 1 << 5 }

using	type_t = unsigned int

Public Member Functions
Constructors & Destructor
	socket (socket_impl &impl, class net_stack &ns)

virtual	~socket () override

Public Member Functions
virtual class socket *	accept (struct sockaddr address, socklen_t address_len)

virtual int	bind (const struct sockaddr *address, socklen_t address_len)

virtual int	connect (const struct sockaddr *address, socklen_t address_len)

virtual int	getpeername (struct sockaddr address, socklen_t address_len)

virtual int	getsockname (struct sockaddr address, socklen_t address_len)

virtual int	getsockopt (int level, int option_name, void option_value, socklen_t option_len)

virtual int	listen (int backlog)

virtual ssize_t	recv (void *buffer, size_t length, int flags)

virtual ssize_t	recvfrom (void buffer, size_t length, int flags, struct sockaddr address, socklen_t *address_len)

virtual ssize_t	recvmsg (struct msghdr *message, int flags)

virtual ssize_t	send (const void *buffer, size_t length, int flags)

virtual ssize_t	sendmsg (const struct msghdr *message, int flags)

virtual ssize_t	sendto (const void message, size_t length, int flags, const struct sockaddr dest_addr, socklen_t dest_len)

virtual int	setsockopt (int level, int option_name, const void *option_value, socklen_t option_len)

virtual int	shutdown (int how)

virtual int	sockatmark (void)

class net_stack *	net_stack (void)

socket_impl &	impl (void) const

Public Member Functions
virtual int	close (void)

virtual ssize_t	read (void *buf, std::size_t nbyte)

virtual ssize_t	write (const void *buf, std::size_t nbyte)

virtual ssize_t	writev (const struct iovec *iov, int iovcnt)

int	fcntl (int cmd,...)

virtual int	vfcntl (int cmd, std::va_list args)

int	isatty (void)

virtual int	fstat (struct stat *buf)

virtual off_t	lseek (off_t offset, int whence)

type_t	get_type (void) const

file_descriptor_t	file_descriptor (void) const

bool	is_opened (void)

Protected Member Functions
Private Member Functions
void	file_descriptor (file_descriptor_t fildes)

void	clear_file_descriptor (void)

io *	alloc_file_descriptor (void)

Detailed Description

Network socket.

Definition at line 73 of file posix-io/socket.h.

Member Typedef Documentation

◆ type_t

using os::posix::io::type_t = unsigned int

inherited

Definition at line 132 of file io.h.

Member Enumeration Documentation

◆ type

enum os::posix::io::type : type_t

inherited

Enumerator
unknown
not_set
char_device
block_device
tty
file
socket

Definition at line 133 of file io.h.

Constructor & Destructor Documentation

◆ socket()

os::posix::socket::socket	(	socket_impl &	impl,
		class net_stack &	ns
	)

Definition at line 48 of file socket.cpp.

◆ ~socket()

os::posix::socket::~socket ( )

overridevirtual

Definition at line 58 of file socket.cpp.

Member Function Documentation

◆ accept()

class socket * os::posix::socket::accept	(	struct sockaddr *	address,
		socklen_t *	address_len
	)

virtual

Reimplemented in os::posix::socket_lockable< T, L >.

Definition at line 70 of file socket.cpp.

◆ alloc_file_descriptor()

io * os::posix::io::alloc_file_descriptor ( void )

protectedinherited

Definition at line 201 of file io.cpp.

◆ bind()

int os::posix::socket::bind	(	const struct sockaddr *	address,
		socklen_t	address_len
	)

virtual

Reimplemented in os::posix::socket_lockable< T, L >.

Definition at line 85 of file socket.cpp.

◆ clear_file_descriptor()

void os::posix::io::clear_file_descriptor ( void )

inlineprotectedinherited

Definition at line 435 of file io.h.

◆ close()

int os::posix::io::close ( void )

virtualinherited

Reimplemented in os::posix::block_device_lockable< T, L >, os::posix::device, os::posix::file, os::posix::file_lockable< T, L >, and os::posix::socket_lockable< T, L >.

Definition at line 176 of file io.cpp.

◆ connect()

int os::posix::socket::connect	(	const struct sockaddr *	address,
		socklen_t	address_len
	)

virtual

Reimplemented in os::posix::socket_lockable< T, L >.

Definition at line 94 of file socket.cpp.

◆ fcntl()

int os::posix::io::fcntl	(	int	cmd,
			...
	)

inherited

Definition at line 375 of file io.cpp.

◆ file_descriptor() [1/2]

void os::posix::io::file_descriptor ( file_descriptor_t fildes )

inlineprotectedinherited

Definition at line 429 of file io.h.

◆ file_descriptor() [2/2]

file_descriptor_t os::posix::io::file_descriptor ( void ) const

inlineinherited

Definition at line 441 of file io.h.

◆ fstat()

int os::posix::io::fstat ( struct stat * buf )

virtualinherited

Reimplemented in os::posix::file_lockable< T, L >.

Definition at line 422 of file io.cpp.

◆ get_type()

io::type_t os::posix::io::get_type ( void ) const

inlineinherited

Definition at line 423 of file io.h.

◆ getpeername()

int os::posix::socket::getpeername	(	struct sockaddr *	address,
		socklen_t *	address_len
	)

virtual

Reimplemented in os::posix::socket_lockable< T, L >.

Definition at line 103 of file socket.cpp.

◆ getsockname()

int os::posix::socket::getsockname	(	struct sockaddr *	address,
		socklen_t *	address_len
	)

virtual

Reimplemented in os::posix::socket_lockable< T, L >.

Definition at line 112 of file socket.cpp.

◆ getsockopt()

int os::posix::socket::getsockopt	(	int	level,
		int	option_name,
		void *	option_value,
		socklen_t *	option_len
	)

virtual

Reimplemented in os::posix::socket_lockable< T, L >.

Definition at line 121 of file socket.cpp.

◆ impl()

socket_impl & os::posix::socket::impl ( void ) const

inline

Definition at line 556 of file posix-io/socket.h.

◆ is_opened()

bool os::posix::io::is_opened ( void )

inlineinherited

Definition at line 447 of file io.h.

◆ isatty()

int os::posix::io::isatty ( void )

inherited

Definition at line 412 of file io.cpp.

◆ listen()

int os::posix::socket::listen ( int backlog )

virtual

Reimplemented in os::posix::socket_lockable< T, L >.

Definition at line 132 of file socket.cpp.

◆ lseek()

off_t os::posix::io::lseek	(	off_t	offset,
		int	whence
	)

virtualinherited

Reimplemented in os::posix::block_device_lockable< T, L >, and os::posix::file_lockable< T, L >.

Definition at line 453 of file io.cpp.

◆ net_stack()

net_stack * os::posix::socket::net_stack ( void )

inline

Definition at line 550 of file posix-io/socket.h.

◆ read()

ssize_t os::posix::io::read	(	void *	buf,
		std::size_t	nbyte
	)

virtualinherited

Reimplemented in os::posix::block_device_lockable< T, L >, and os::posix::file_lockable< T, L >.

Definition at line 229 of file io.cpp.

◆ recv()

ssize_t os::posix::socket::recv	(	void *	buffer,
		size_t	length,
		int	flags
	)

virtual

Reimplemented in os::posix::socket_lockable< T, L >.

Definition at line 141 of file socket.cpp.

◆ recvfrom()

ssize_t os::posix::socket::recvfrom	(	void *	buffer,
		size_t	length,
		int	flags,
		struct sockaddr *	address,
		socklen_t *	address_len
	)

virtual

Reimplemented in os::posix::socket_lockable< T, L >.

Definition at line 150 of file socket.cpp.

◆ recvmsg()

ssize_t os::posix::socket::recvmsg	(	struct msghdr *	message,
		int	flags
	)

virtual

Reimplemented in os::posix::socket_lockable< T, L >.

Definition at line 160 of file socket.cpp.

◆ send()

ssize_t os::posix::socket::send	(	const void *	buffer,
		size_t	length,
		int	flags
	)

virtual

Reimplemented in os::posix::socket_lockable< T, L >.

Definition at line 169 of file socket.cpp.

◆ sendmsg()

ssize_t os::posix::socket::sendmsg	(	const struct msghdr *	message,
		int	flags
	)

virtual

Reimplemented in os::posix::socket_lockable< T, L >.

Definition at line 178 of file socket.cpp.

◆ sendto()

ssize_t os::posix::socket::sendto	(	const void *	message,
		size_t	length,
		int	flags,
		const struct sockaddr *	dest_addr,
		socklen_t	dest_len
	)

virtual

Reimplemented in os::posix::socket_lockable< T, L >.

Definition at line 187 of file socket.cpp.

◆ setsockopt()

int os::posix::socket::setsockopt	(	int	level,
		int	option_name,
		const void *	option_value,
		socklen_t	option_len
	)

virtual

Reimplemented in os::posix::socket_lockable< T, L >.

Definition at line 197 of file socket.cpp.

◆ shutdown()

int os::posix::socket::shutdown ( int how )

virtual

Reimplemented in os::posix::socket_lockable< T, L >.

Definition at line 208 of file socket.cpp.

◆ sockatmark()

int os::posix::socket::sockatmark ( void )

virtual

Reimplemented in os::posix::socket_lockable< T, L >.

Definition at line 217 of file socket.cpp.

◆ vfcntl()

int os::posix::io::vfcntl	(	int	cmd,
		std::va_list	args
	)

virtualinherited

Reimplemented in os::posix::block_device_lockable< T, L >, and os::posix::file_lockable< T, L >.

Definition at line 387 of file io.cpp.

◆ write()

ssize_t os::posix::io::write	(	const void *	buf,
		std::size_t	nbyte
	)

virtualinherited

Reimplemented in os::posix::block_device_lockable< T, L >, and os::posix::file_lockable< T, L >.

Definition at line 280 of file io.cpp.

◆ writev()

ssize_t os::posix::io::writev	(	const struct iovec *	iov,
		int	iovcnt
	)

virtualinherited

Reimplemented in os::posix::block_device_lockable< T, L >, and os::posix::file_lockable< T, L >.

Definition at line 333 of file io.cpp.

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

Public Types

Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ type_t

Member Enumeration Documentation

◆ type

Constructor & Destructor Documentation

◆ socket()

◆ ~socket()

Member Function Documentation

◆ accept()

◆ alloc_file_descriptor()

◆ bind()

◆ clear_file_descriptor()

◆ close()

◆ connect()

◆ fcntl()

◆ file_descriptor() [1/2]

◆ file_descriptor() [2/2]

◆ fstat()

◆ get_type()

◆ getpeername()

◆ getsockname()

◆ getsockopt()

◆ impl()

◆ is_opened()

◆ isatty()

◆ listen()

◆ lseek()

◆ net_stack()

◆ read()

◆ recv()

◆ recvfrom()

◆ recvmsg()

◆ send()

◆ sendmsg()

◆ sendto()

◆ setsockopt()

◆ shutdown()

◆ sockatmark()

◆ vfcntl()

◆ write()

◆ writev()