Inheritance diagram for uringpp::socket:

Collaboration diagram for uringpp::socket:

Public Member Functions
int	fd () const
	Get the file descriptor of the socket. More...

	socket (socket &&other) noexcept
	Move construct a new socket object. More...

	socket (std::shared_ptr< event_loop > loop, int domain, int type, int protocol)
	Construct a new socket object. More...

	socket (std::shared_ptr< event_loop > loop, int fd)
	Construct a new socket object from a file descriptor. More...

	~socket ()
	Destroy the socket object. If the socket is still open, it will be closed. More...

task< void >	close ()
	Close the socket. More...

sqe_awaitable	read (void *buf, size_t count)
	Read data from the socket. More...

sqe_awaitable	write (void const *buf, size_t count)
	Write data to the socket. More...

sqe_awaitable	readv (struct iovec const *iov, int iovcnt)
	Vectorized read from the socket. More...

sqe_awaitable	writev (struct iovec const *iov, int iovcnt)
	Vectorized write data to the socket. More...

sqe_awaitable	read_fixed (void *buf, size_t count, int buf_index)
	Read data to a preregistered buffer from the socket. More...

sqe_awaitable	write_fixed (void const *buf, size_t count, int buf_index)
	Write data from a preregistered buffer to the socket. More...

sqe_awaitable	sendmsg (struct msghdr const *msg, int flags=0)
	Send messages to the socket. More...

sqe_awaitable	recvmsg (struct msghdr *msg, int flags=0)
	Receive messages from the socket. More...

sqe_awaitable	send (void const *buf, size_t len, int flags=0)
	Send data to the socket. More...

sqe_awaitable	recv (void *buf, size_t len, int flags=0)
	Receive data from the socket. More...

sqe_awaitable	shutdown (int how)
	Shutdown the socket. More...

sqe_awaitable	tee (file const &out, size_t count, unsigned int flags)
	Tee the socket to a file. More...

sqe_awaitable	tee (socket const &out, size_t count, unsigned int flags)
	Tee the socket to another socket. More...

sqe_awaitable	splice_to (pipe const &out, size_t nbytes, unsigned flags)
	Splice the socket to a pipe. More...

sqe_awaitable	splice_from (pipe const &in, size_t nbytes, unsigned flags)
	Splice from a pipe to the socket. More...

Public Member Functions inherited from uringpp::noncopyable
	noncopyable (noncopyable &&)=default

	noncopyable (noncopyable const &)=delete

noncopyable &	operator= (noncopyable const &)=delete

noncopyable &	operator= (noncopyable &&)=default

Static Public Member Functions
static task< socket >	connect (std::shared_ptr< event_loop > loop, std::string const &hostname, std::string const &port)
	Connect to a remote host. More...

Friends
class	listener

Detailed Description

Examples: helloworld.cc.

Constructor & Destructor Documentation

◆ socket() [1/3]

uringpp::socket::socket ( socket && other )

inlinenoexcept

Move construct a new socket object.

Parameters

other

◆ socket() [2/3]

uringpp::socket::socket	(	std::shared_ptr< event_loop >	loop,
		int	domain,
		int	type,
		int	protocol
	)

inline

Construct a new socket object.

Parameters

loop	The event loop.
domain	The domain of the socket.
type	The type of the socket.
protocol	The protocol of the socket.

◆ socket() [3/3]

uringpp::socket::socket	(	std::shared_ptr< event_loop >	loop,
		int	fd
	)

inline

Construct a new socket object from a file descriptor.

Parameters

loop	The event loop.
fd	The file descriptor.

◆ ~socket()

uringpp::socket::~socket ( )

inline

Destroy the socket object. If the socket is still open, it will be closed.

Member Function Documentation

◆ close()

task< void > uringpp::socket::close ( )

inline

Close the socket.

Returns: task<void>

◆ connect()

static task< socket > uringpp::socket::connect	(	std::shared_ptr< event_loop >	loop,
		std::string const &	hostname,
		std::string const &	port
	)

inlinestatic

Connect to a remote host.

Parameters

loop	The event loop.
hostname	The hostname of the remote host.
port	The port of the remote host.

Returns: task<socket> The socket object.

Examples: helloworld.cc.

◆ fd()

int uringpp::socket::fd ( ) const

inline

Get the file descriptor of the socket.

Returns: int The file descriptor of the socket.

◆ read()

sqe_awaitable uringpp::socket::read	(	void *	buf,
		size_t	count
	)

inline

Read data from the socket.

Parameters

buf	The buffer to read into.
count	The number of bytes to read.

Returns: sqe_awaitable

◆ read_fixed()

sqe_awaitable uringpp::socket::read_fixed	(	void *	buf,
		size_t	count,
		int	buf_index
	)

inline

Read data to a preregistered buffer from the socket.

Parameters

buf	The preregistered buffer to read into.
count	The number of bytes to read.
buf_index	The index of the preregistered buffer to read into.

Returns: sqe_awaitable

◆ readv()

sqe_awaitable uringpp::socket::readv	(	struct iovec const *	iov,
		int	iovcnt
	)

inline

Vectorized read from the socket.

Parameters

iov	The vector of buffers to read into.
iovcnt	The number of buffers to read.

Returns: sqe_awaitable

◆ recv()

sqe_awaitable uringpp::socket::recv	(	void *	buf,
		size_t	len,
		int	flags = `0`
	)

inline

Receive data from the socket.

Parameters

buf	The buffer to receive into.
len	The number of bytes to receive.
flags	The flags to use.

Returns: sqe_awaitable

◆ recvmsg()

sqe_awaitable uringpp::socket::recvmsg	(	struct msghdr *	msg,
		int	flags = `0`
	)

inline

Receive messages from the socket.

Parameters

msg	The messages to receive.
flags	The flags to use.

Returns: sqe_awaitable

◆ send()

sqe_awaitable uringpp::socket::send	(	void const *	buf,
		size_t	len,
		int	flags = `0`
	)

inline

Send data to the socket.

Parameters

buf	The buffer to send.
len	The number of bytes to send.
flags	The flags to use.

Returns: sqe_awaitable

◆ sendmsg()

sqe_awaitable uringpp::socket::sendmsg	(	struct msghdr const *	msg,
		int	flags = `0`
	)

inline

Send messages to the socket.

Parameters

msg	The messages to send.
flags	The flags to use.

Returns: sqe_awaitable

◆ shutdown()

sqe_awaitable uringpp::socket::shutdown ( int how )

inline

Shutdown the socket.

Parameters

how	Which sides of the socket to shutdown.

Returns: sqe_awaitable

◆ splice_from()

sqe_awaitable uringpp::socket::splice_from	(	pipe const &	in,
		size_t	nbytes,
		unsigned	flags
	)

inline

Splice from a pipe to the socket.

Parameters

in	The pipe to splice from.
nbytes	The number of bytes to splice.
flags	The flags to use.

Returns: sqe_awaitable

◆ splice_to()

sqe_awaitable uringpp::socket::splice_to	(	pipe const &	out,
		size_t	nbytes,
		unsigned	flags
	)

inline

Splice the socket to a pipe.

Parameters

out	The pipe to splice to.
off_out	The offset to splice to.
nbytes	The number of bytes to splice.
flags	The flags to use.

Returns: sqe_awaitable

◆ tee() [1/2]

sqe_awaitable uringpp::socket::tee	(	file const &	out,
		size_t	count,
		unsigned int	flags
	)

Tee the socket to a file.

Parameters

out	The file to tee to.
count	The number of bytes to tee.
flags	The flags to use.

Returns: sqe_awaitable

◆ tee() [2/2]

sqe_awaitable uringpp::socket::tee	(	socket const &	out,
		size_t	count,
		unsigned int	flags
	)

inline

Tee the socket to another socket.

Parameters

out	The socket to tee to.
count	The number of bytes to tee.
flags	The flags to use.

Returns: sqe_awaitable

◆ write()

sqe_awaitable uringpp::socket::write	(	void const *	buf,
		size_t	count
	)

inline

Write data to the socket.

Parameters

buf	The buffer to write from.
count	The number of bytes to write.

Returns: sqe_awaitable

◆ write_fixed()

sqe_awaitable uringpp::socket::write_fixed	(	void const *	buf,
		size_t	count,
		int	buf_index
	)

inline

Write data from a preregistered buffer to the socket.

Parameters

buf	The preregistered buffer to write from.
count	The number of bytes to write.
buf_index	The index of the preregistered buffer to write from.

Returns: sqe_awaitable

◆ writev()

sqe_awaitable uringpp::socket::writev	(	struct iovec const *	iov,
		int	iovcnt
	)

inline

Vectorized write data to the socket.

Parameters

iov	The iovec to write from.
iovcnt	The number of iovecs to write.

Returns: sqe_awaitable

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

include/uringpp/socket.h

Public Member Functions

Static Public Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ socket() [1/3]

◆ socket() [2/3]

◆ socket() [3/3]

◆ ~socket()

Member Function Documentation

◆ close()

◆ connect()

◆ fd()

◆ read()

◆ read_fixed()

◆ readv()

◆ recv()

◆ recvmsg()

◆ send()

◆ sendmsg()

◆ shutdown()

◆ splice_from()

◆ splice_to()

◆ tee() [1/2]

◆ tee() [2/2]

◆ write()

◆ write_fixed()

◆ writev()