Goby3  3.1.5a
2024.05.23
goby::middleware::io::detail::TCPSession< TCPServerThreadType > Class Template Referenceabstract

#include <goby/middleware/io/detail/tcp_server_interface.h>

Inheritance diagram for goby::middleware::io::detail::TCPSession< TCPServerThreadType >:
goby::middleware::io::TCPSessionCOBS< TCPServerThreadType > goby::middleware::io::TCPSessionLineBased< TCPServerThreadType >

Public Member Functions

 TCPSession (boost::asio::ip::tcp::socket socket, TCPServerThreadType &server)
 
virtual ~TCPSession ()
 
void start ()
 
const boost::asio::ip::tcp::endpoint & remote_endpoint ()
 
const boost::asio::ip::tcp::endpoint & local_endpoint ()
 
const std::string & glog_group ()
 
virtual void async_write (std::shared_ptr< const goby::middleware::protobuf::IOData > io_msg)
 

Protected Member Functions

void handle_write_success (std::size_t bytes_transferred)
 
void handle_write_error (const boost::system::error_code &ec)
 
void handle_read_success (std::size_t bytes_transferred, std::shared_ptr< goby::middleware::protobuf::IOData > io_msg)
 
void handle_read_error (const boost::system::error_code &ec)
 
const TCPServerThreadType::ConfigType & cfg ()
 
boost::asio::ip::tcp::socket & mutable_socket ()
 

Detailed Description

template<typename TCPServerThreadType>
class goby::middleware::io::detail::TCPSession< TCPServerThreadType >

Definition at line 75 of file tcp_server_interface.h.

Constructor & Destructor Documentation

◆ TCPSession()

template<typename TCPServerThreadType >
goby::middleware::io::detail::TCPSession< TCPServerThreadType >::TCPSession ( boost::asio::ip::tcp::socket  socket,
TCPServerThreadType &  server 
)
inline

Definition at line 78 of file tcp_server_interface.h.

◆ ~TCPSession()

template<typename TCPServerThreadType >
virtual goby::middleware::io::detail::TCPSession< TCPServerThreadType >::~TCPSession ( )
inlinevirtual

Definition at line 86 of file tcp_server_interface.h.

Member Function Documentation

◆ async_write()

template<typename TCPServerThreadType >
virtual void goby::middleware::io::detail::TCPSession< TCPServerThreadType >::async_write ( std::shared_ptr< const goby::middleware::protobuf::IOData io_msg)
inlinevirtual

Definition at line 125 of file tcp_server_interface.h.

◆ cfg()

template<typename TCPServerThreadType >
const TCPServerThreadType::ConfigType& goby::middleware::io::detail::TCPSession< TCPServerThreadType >::cfg ( )
inlineprotected

Definition at line 170 of file tcp_server_interface.h.

◆ glog_group()

template<typename TCPServerThreadType >
const std::string& goby::middleware::io::detail::TCPSession< TCPServerThreadType >::glog_group ( )
inline

Definition at line 122 of file tcp_server_interface.h.

◆ handle_read_error()

template<typename TCPServerThreadType >
void goby::middleware::io::detail::TCPSession< TCPServerThreadType >::handle_read_error ( const boost::system::error_code &  ec)
inlineprotected

Definition at line 162 of file tcp_server_interface.h.

◆ handle_read_success()

template<typename TCPServerThreadType >
void goby::middleware::io::detail::TCPSession< TCPServerThreadType >::handle_read_success ( std::size_t  bytes_transferred,
std::shared_ptr< goby::middleware::protobuf::IOData io_msg 
)
inlineprotected

Definition at line 153 of file tcp_server_interface.h.

◆ handle_write_error()

template<typename TCPServerThreadType >
void goby::middleware::io::detail::TCPSession< TCPServerThreadType >::handle_write_error ( const boost::system::error_code &  ec)
inlineprotected

Definition at line 147 of file tcp_server_interface.h.

◆ handle_write_success()

template<typename TCPServerThreadType >
void goby::middleware::io::detail::TCPSession< TCPServerThreadType >::handle_write_success ( std::size_t  bytes_transferred)
inlineprotected

Definition at line 143 of file tcp_server_interface.h.

◆ local_endpoint()

template<typename TCPServerThreadType >
const boost::asio::ip::tcp::endpoint& goby::middleware::io::detail::TCPSession< TCPServerThreadType >::local_endpoint ( )
inline

Definition at line 120 of file tcp_server_interface.h.

◆ mutable_socket()

template<typename TCPServerThreadType >
boost::asio::ip::tcp::socket& goby::middleware::io::detail::TCPSession< TCPServerThreadType >::mutable_socket ( )
inlineprotected

Definition at line 172 of file tcp_server_interface.h.

◆ remote_endpoint()

template<typename TCPServerThreadType >
const boost::asio::ip::tcp::endpoint& goby::middleware::io::detail::TCPSession< TCPServerThreadType >::remote_endpoint ( )
inline

Definition at line 119 of file tcp_server_interface.h.

◆ start()

template<typename TCPServerThreadType >
void goby::middleware::io::detail::TCPSession< TCPServerThreadType >::start ( )
inline

Definition at line 101 of file tcp_server_interface.h.


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