core::socket::stream::tls::SocketWriter Class Reference

#include <SocketWriter.h>

Inheritance diagram for core::socket::stream::tls::SocketWriter:

Collaboration diagram for core::socket::stream::tls::SocketWriter:

Protected Member Functions
virtual bool	doSSLHandshake (const std::function< void()> &onSuccess, const std::function< void()> &onTimeout, const std::function< void(int)> &onStatus)=0
Protected Member Functions inherited from core::socket::stream::SocketWriter
	SocketWriter (const std::string &instanceName, const std::function< void(int)> &onStatus, const utils::Timeval &timeout, std::size_t blockSize, const utils::Timeval &terminateTimeout)
void	setBlockSize (std::size_t writeBlockSize)
void	sendToPeer (const char *chunk, std::size_t chunkLen)
bool	streamToPeer (core::pipe::Source *source)
void	streamEof ()
void	shutdownWrite (const std::function< void()> &onShutdown)
Protected Member Functions inherited from core::eventreceiver::WriteEventReceiver
	WriteEventReceiver (const std::string &name, const utils::Timeval &timeout)
virtual void	writeTimeout ()
Protected Member Functions inherited from core::DescriptorEventReceiver
bool	enable (int fd)
void	disable ()
void	suspend ()
void	resume ()
Protected Member Functions inherited from core::Observer
void	observed ()
void	unObserved ()
virtual void	unobservedEvent ()=0
	Observer ()=default
	Observer (Observer &)=delete
	Observer (Observer &&)=delete
virtual	~Observer ()
Protected Member Functions inherited from core::EventReceiver
virtual	~EventReceiver ()=default
	EventReceiver (const std::string &name)
	EventReceiver (EventReceiver &)=delete
	EventReceiver (EventReceiver &&)=delete
EventReceiver &	operator= (EventReceiver &)=delete
EventReceiver &	operator= (EventReceiver &&)=delete
virtual void	destruct ()
void	span ()
void	relax ()
const std::string &	getName () const

Protected Attributes
SSL *	ssl = nullptr
bool	closeNotifyIsEOF = true
Protected Attributes inherited from core::socket::stream::SocketWriter
bool	markShutdown = false
std::function< void()>	onShutdown
std::vector< char >	writePuffer
bool	shutdownInProgress = false
utils::Timeval	terminateTimeout

Private Types
using	Super = core::socket::stream::SocketWriter

Private Member Functions
ssize_t	write (const char *chunk, std::size_t chunkLen) override

Additional Inherited Members
Public Member Functions inherited from core::socket::stream::SocketWriter
	SocketWriter ()=delete
Public Member Functions inherited from core::DescriptorEventReceiver
	DescriptorEventReceiver (const std::string &name, DescriptorEventPublisher &descriptorEventPublisher, const utils::Timeval &timeout=TIMEOUT::DISABLE)
int	getRegisteredFd () const
bool	isEnabled () const
bool	isSuspended () const
void	setTimeout (const utils::Timeval &timeout)
utils::Timeval	getTimeout (const utils::Timeval &currentTime) const
void	checkTimeout (const utils::Timeval &currentTime)
Public Member Functions inherited from core::EventReceiver
	EventReceiver (const std::string &name)
	EventReceiver (EventReceiver &)=delete
	EventReceiver (EventReceiver &&)=delete
EventReceiver &	operator= (EventReceiver &)=delete
EventReceiver &	operator= (EventReceiver &&)=delete
virtual void	destruct ()
void	span ()
void	relax ()
const std::string &	getName () const
Static Public Member Functions inherited from core::EventReceiver
static void	atNextTick (const std::function< void(void)> &callBack)
Static Protected Member Functions inherited from core::EventReceiver
static void	atNextTick (const std::function< void(void)> &callBack)

Detailed Description

Definition at line 36 of file SocketWriter.h.

Member Typedef Documentation

Super

using core::socket::stream::tls::SocketWriter::Super = core::socket::stream::SocketWriter

private

Definition at line 38 of file SocketWriter.h.

Member Function Documentation

doSSLHandshake()

virtual bool core::socket::stream::tls::SocketWriter::doSSLHandshake ( const std::function< void()> & onSuccess, const std::function< void()> & onTimeout, const std::function< void(int)> & onStatus )

protectedpure virtual

write()

ssize_t core::socket::stream::tls::SocketWriter::write ( const char * chunk, std::size_t chunkLen )

overrideprivatevirtual

Reimplemented from core::socket::stream::SocketWriter.

Definition at line 36 of file SocketWriter.cpp.

                                                                     {
        ssize_t ret = 0;
 
        if ((SSL_get_shutdown(ssl) & SSL_SENT_SHUTDOWN) != 0) {
            ret = Super::write(chunk, chunkLen);
        } else {
            ret = SSL_write(ssl, chunk, static_cast<int>(chunkLen));
 
            if (ret <= 0) {
                const int ssl_err = SSL_get_error(ssl, static_cast<int>(ret));
 
                switch (ssl_err) {
                    case SSL_ERROR_WANT_READ:
                        LOG(TRACE) << getName() << " SSL/TLS: Start renegotiation on read";
                        doSSLHandshake(
                            [this]() {
                                LOG(DEBUG) << getName() << " SSL/TLS: Renegotiation on read success";
                            },
                            [this]() {
                                LOG(WARNING) << getName() << " SSL/TLS: Renegotiation on read timed out";
                            },
                            [this](int ssl_err) {
                                ssl_log(getName() + " SSL/TLS: Renegotiation", ssl_err);
                            });
                        errno = EAGAIN;
                        ret = -1;
                        break;
                    case SSL_ERROR_WANT_WRITE:
                        errno = EAGAIN;
                        ret = -1;
                        break;
                    case SSL_ERROR_ZERO_RETURN: // shutdown cleanly
                        LOG(DEBUG) << getName() << " SSL/TLS: Close_notify received. Is EOF? " << (closeNotifyIsEOF ? "true" : "false");
                        errno = closeNotifyIsEOF ? EPIPE : EAGAIN;
                        ret = -1; // on the write side this means a TCP broken pipe
                        break;
                    case SSL_ERROR_SYSCALL:
                        // In case ret is -1 a real syscall error (RST = ECONNRESET)
                        {
                            const utils::PreserveErrno pe;
 
                            if (errno == EPIPE) {
                                PLOG(WARNING) << getName() << " SSL/TLS: Syscal error (SIGPIPE detected) on write.";
                            } else if (errno == ECONNRESET) {
                                PLOG(WARNING) << getName() << " SSL/TLS: Connection reset by peer (ECONNRESET).";
                            } else {
                                PLOG(WARNING) << getName() << " SSL/TLS: Syscall error on write";
                            }
                        }
                        ret = -1;
                        break;
                    case SSL_ERROR_SSL:
                        ssl_log(getName() + " SSL/TLS: Failed", ssl_err);
                        ret = -1;
                        break;
                    default:
                        ssl_log(getName() + " SSL/TLS: Unexpected error", ssl_err);
                        errno = EIO;
                        ret = -1;
                        break;
                }
            }
        }
 
        return ret;
    }

Member Data Documentation

closeNotifyIsEOF

bool core::socket::stream::tls::SocketWriter::closeNotifyIsEOF = true

protected

Definition at line 50 of file SocketWriter.h.

ssl

SSL* core::socket::stream::tls::SocketWriter::ssl = nullptr

protected

Definition at line 48 of file SocketWriter.h.

---

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

• core/socket/stream/tls/SocketWriter.h
• core/socket/stream/tls/SocketWriter.cpp