cosmos::SocketOptions::Linger Struct Reference

Special option struct for getLinger() and setLinger(). More...

#include <SocketOptions.hxx>

Inheritance diagram for cosmos::SocketOptions::Linger:

Public Member Functions
	Linger (const bool on_off, const std::chrono::seconds time)
bool	isEnabled () const
void	setEnabled (const bool on_off)
void	setTime (const std::chrono::seconds time)
std::chrono::seconds	time () const

Public Attributes
friend	SocketOptions

Detailed Description

Special option struct for getLinger() and setLinger().

This struct defines if and how long close() and shutdown() will block to wait for remaining packets.

See also

setLinger().

Definition at line 37 of file SocketOptions.hxx.

Constructor & Destructor Documentation

Linger() [1/2]

cosmos::SocketOptions::Linger::Linger ( )

inline

Definition at line 42 of file SocketOptions.hxx.

                         :
                                Linger{false, std::chrono::seconds{0}}
                {}

Linger() [2/2]

cosmos::SocketOptions::Linger::Linger ( const bool on_off, const std::chrono::seconds time )

inline

Definition at line 46 of file SocketOptions.hxx.

                                                                       {
                        setEnabled(on_off);
                        setTime(time);
                }

Member Function Documentation

isEnabled()

bool cosmos::SocketOptions::Linger::isEnabled ( ) const

inline

Definition at line 51 of file SocketOptions.hxx.

                                       {
                        return l_onoff == 0 ? false : true;
                }

setEnabled()

void cosmos::SocketOptions::Linger::setEnabled ( const bool on_off )

inline

Definition at line 55 of file SocketOptions.hxx.

                                                   {
                        l_onoff = on_off ? 1 : 0;
                }

setTime()

void cosmos::SocketOptions::Linger::setTime ( const std::chrono::seconds time )

inline

Definition at line 59 of file SocketOptions.hxx.

                                                          {
                        l_linger = time.count();
                }

time()

std::chrono::seconds cosmos::SocketOptions::Linger::time ( ) const

inline

Definition at line 63 of file SocketOptions.hxx.

                                              {
                        return std::chrono::seconds{l_linger};
                }

Member Data Documentation

SocketOptions

friend cosmos::SocketOptions::Linger::SocketOptions

Definition at line 40 of file SocketOptions.hxx.

---

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

• include/net/SocketOptions.hxx