netpoll cpp
1.0.0
Это сетевая библиотека C++ NIO с производительностью и простотой использования. Он поддерживает C++14 и выше и охватывает три основных основных платформ.
Основная модель ввода-вывода заимствует one loop per thread сетевой библиотеки Muduo, что делает EPI-инкапсуляции API-защиты более эффективной и простой.
Интерфейс API, предоставленный верхним уровнем, заимствует из Netpoll Nio Nio Nio Nio Nio Language Note Language Nio, и абстрагирует Listener и Dialer , чтобы наконец предоставить услуги через EventLoop .
Для того, как используется эта библиотека, вы можете проверить быстрый старт.
Для конкретных примеров использования см. Примеры.
Уже поддерживается :
windows/linux/macos реализуется с использованием самой высокой реализации мультиплексирования платформы (Epoll/Epoll/Kqueue, реализованная IOCP).EventLoop для реализации асинхронных вызовов. Если операционная система поддерживает вызовы sendfile , вызов с нулевой копией будет вызовы вместо того, чтобы вызовать стандартную библиотеку C.echo , вам нужен только следующий код: struct server
{
NETPOLL_TCP_MESSAGE (conn, buffer){conn-> send (buffer-> readAll ());}
};
int main ()
{
auto loop = netpoll::NewEventLoop ();
auto listener = netpoll::tcp::Listener::New ({ 6666 });
listener. bind <server>();
loop. serve (listener);
}100^8s , что может потребовать только 100*8byte ). Для получения подробной информации вы можете проверить блог: подробное введение.one loop per threadfuture для синхронизации, что может быть полезно для клиентского программирования. netpoll::SignalTask::Register ({SIGINT,SIGTERM});
netpoll::SignalTask::Add ([](){
// do something
});Поддержат его в будущем :
Производительность чрезвычайно высока, и я временно протестировал Asio (C ++)/Netty (Java)/NetPoll (GO Language).
Я тестировал Asio/Netty в системе Windows, а следующий тест диаграммы основан на Linux, и я не очень хорош в развертывании программ Java на Linux, поэтому в следующей диаграмме нет производительности Netty.
Средняя задержка единого подключенного сервиса Echo в различных ситуациях параллелизма заключается в следующем (AVG):
Основная архитектура модели на стороне сервера:
Инкапсуляция Listener упрощает использование TcpServer , все вызовы следующие:
namespace netpoll ::tcp{
class Listener {
template < typename T>
void bind (Args &&...args); // 用于绑定任意类的对应方法到回调
template < typename T>
std::shared_ptr<T> instance () // 返回内部帮你创建的实例
static Listener New( const InetAddress &address,
const StringView &name = " tcp_listener " ,
bool reUseAddr = true , bool reUsePort = true ); // 建立Listener实例
void enableKickoffIdle ( size_t timeout); // 用于开启剔除空闲连接
}
} Инкапсуляция Dialer упрощает использование TcpClient , а используемые вызовы следующие:
namespace netpoll ::tcp{
class Dialer {
template < typename T>
void bind (Args &&...args); // 用于绑定任意类的对应方法到回调
template < typename T>
std::shared_ptr<T> instance () // 返回内部帮你创建的实例
static Dialer New( const InetAddress &address,
const StringView &name = " tcp_dialer " ); // 建立Listener实例
void enableRetry (); // 在连接失败后重试
// 以下调用方均是为了在没有C++17的if constexpr情况下的替代品,否则应该直接使用bind
template < typename T, typename ... Args>
static std::shared_ptr<T> Register (Args &&...args);
void onMessage (netpoll::RecvMessageCallback const &cb);
void onConnection (netpoll::ConnectionCallback const &cb);
void onConnectionError (netpoll::ConnectionErrorCallback const &cb);
void onWriteComplete (netpoll::WriteCompleteCallback const &cb);
}
} Стратегия балансировки нагрузки EventLoop не имеет отдельных настроек, и все они используют Round Robin .
API, связанные с EventLoop, следующие:
NewEventLoop(size_t threadNum=2,const netpoll::StringView&name="eventloop") : создать экземпляр EventLoop и установить количество потоков для EventLoop.
Метод serve : после того, как вы вновь выходите из номерона или слушателя, вы можете предоставить им услуги с помощью этого метода.
Метод serveAsDaemon : эффект такой же, как и метод подачи, но открытие нового потока для обслуживания не будет блокировать текущий поток.
Метод enableQuit : позволяет активному вызову для цикла выхода. По умолчанию он не может активно выходить из всех циклов и используется в сочетании с методом QuitAllEventLoop .
Метод QuitAllEventLoop : выйти из всех петлей.
BessageBuffer - это промежуточный кэш для чтения и написания данных буфера ядра. На самом деле это вариабельный буфер, и он также очень прост в реализации. Для различных типов реализаций буфера вы можете ознакомиться с моей статьей: реализация переменной длины и неизменной длины буфера
Я не буду описывать здесь различные звонки. Если вы хотите знать, вы можете напрямую посмотреть на соответствующий файл заголовка: NetPoll/util/message_buffer.h.
Позвольте мне кратко рассказать о основных моментах реализации этого буфера:
При расширении, избегая побочных эффектов изменения размера, он также может упростить открытие памяти и копирование.
void MessageBuffer::ensureWritableBytes ( size_t len)
{
if ( writableBytes () >= len) return ;
// move readable bytes
if (m_head + writableBytes () >= (len + kBufferOffset ))
{
std::copy ( begin () + m_head, begin () + m_tail, begin () + kBufferOffset );
m_tail = kBufferOffset + (m_tail - m_head);
m_head = kBufferOffset ;
return ;
}
// create new buffer
size_t newLen;
if ((m_buffer. size () * 2 ) > ( kBufferOffset + readableBytes () + len))
newLen = m_buffer. size () * 2 ;
else newLen = kBufferOffset + readableBytes () + len;
// Avoid the inefficiency of using resize
MessageBuffer newbuffer (newLen);
newbuffer. pushBack (* this );
swap (newbuffer);
}Предоставьте метод Readfd, который считывает данные соответствующего буфера FD чтения для Buffer. Контент читается каждый раз, когда достаточно большой. Например, если регистрация для записи Buffer Message Buffer меньше 8 КБ, то включен кэш альтернативного чтения 8 КБ.
ssize_t MessageBuffer::readFd ( int fd, int *retErrno)
{
char extBuffer[ 8192 ];
struct iovec vec[ 2 ];
size_t writable = writableBytes ();
vec[ 0 ]. iov_base = begin () + m_tail;
vec[ 0 ]. iov_len = static_cast < int >(writable);
vec[ 1 ]. iov_base = extBuffer;
vec[ 1 ]. iov_len = sizeof (extBuffer);
const int iovcnt = (writable < sizeof extBuffer) ? 2 : 1 ;
ssize_t n = :: readv (fd, vec, iovcnt);
if (n < 0 ) { *retErrno = errno; }
else if ( static_cast < size_t >(n) <= writable) { m_tail += n; }
else
{
m_tail = m_buffer. size ();
pushBack ({extBuffer, n - writable});
}
return n;
}Класс TCPConnection - это абстрактный класс, который используется с помощью умных указателей при использовании.
Этот интерфейс указывает следующие функции:
Отправить данные (включая строку/буфер/файл/поток).
/* *
* @brief Send some data to the peer.
*
* @param msg
* @param len
*/
virtual void send (StringView const &msg) = 0;
virtual void send ( const MessageBuffer &buffer) = 0;
virtual void send (MessageBuffer &&buffer) = 0;
virtual void send ( const std::shared_ptr<MessageBuffer> &msgPtr) = 0;
/* *
* @brief Send a file to the peer.
*
* @param fileName in UTF-8
* @param offset
* @param length
*/
virtual void sendFile (StringView const &fileName, size_t offset = 0 ,
size_t length = 0 ) = 0;
/* *
* @brief Send a stream to the peer.
*
* @param callback function to retrieve the stream data (stream ends when a
* zero size is returned) the callback will be called with nullptr when the
* send is finished/interrupted, so that it cleans up any internal data (ex:
* close file).
* @warning The buffer size should be >= 10 to allow http chunked-encoding
* data stream
*/
// (buffer, buffer size) -> size
// of data put in buffer
virtual void sendStream (
std::function<std:: size_t ( char *, std:: size_t )> callback) = 0;Получите информацию об подключении, такую как информация о адресах или статус соединения или буфер, который получает данные.
/* *
* @brief New the local address of the connection.
*
* @return const InetAddress&
*/
virtual const InetAddress & localAddr () const = 0;
/* *
* @brief New the remote address of the connection.
*
* @return const InetAddress&
*/
virtual const InetAddress & peerAddr () const = 0;
/* *
* @brief Return true if the connection is established.
*
* @return true
* @return false
*/
virtual bool connected () const = 0;
/* *
* @brief Return false if the connection is established.
*
* @return true
* @return false
*/
virtual bool disconnected () const = 0;
/* *
* @brief New the buffer in which the received data stored.
*
* @return MsgBuffer*
*/
virtual MessageBuffer * getRecvBuffer () = 0;Установите обратный вызов подключения или статус (отсоедините или установите Tcpnodelay/Keepalive).
/* *
* @brief Set the high water mark callback
*
* @param cb The callback is called when the data in sending buffer is
* larger than the water mark.
* @param markLen The water mark in bytes.
*/
virtual void setHighWaterMarkCallback ( const HighWaterMarkCallback &cb,
size_t markLen) = 0;
/* *
* @brief Set the TCP_NODELAY option to the socket.
*
* @param on
*/
virtual void setTcpNoDelay ( bool on) = 0;
/* *
* @brief Shutdown the connection.
* @note This method only closes the writing direction.
*/
virtual void shutdown () = 0;
/* *
* @brief Close the connection forcefully.
*
*/
virtual void forceClose () = 0;
/* *
* @brief Call this method to avoid being kicked off by TcpServer, refer to
* the kickoffIdleConnections method in the TcpServer class.
*
*/
virtual void keepAlive () = 0;
/* *
* @brief Return true if the keepAlive() method is called.
*
* @return true
* @return false
*/
virtual bool isKeepAlive () = 0;Устанавливает контекст соединения для обработки выделенной бизнес -логики для соединения.
/* *
* @brief Set the custom data on the connection.
*
* @param context
*/
void setContext ( const Any &context) { m_context = context; }
void setContext (Any &&context) { m_context = std::move (context); }
/* *
* @brief New mutable context
*
* @return Any
*/
Any & getContextRefMut () { return m_context; }
/* *
* @brief New unmutable context
*
* @return Any
*/
Any const & getContextRef () const { return m_context; }
/* *
* @brief Return true if the custom data is set by user.
*
* @return true
* @return false
*/
bool hasContext () const
{
# if __cplusplus >= 201703L
return m_context. has_value ();
# else
return m_context. empty ();
# endif
}
/* *
* @brief Clear the custom data.
*
*/
void clearContext ()
{
# if __cplusplus >= 201703L
m_context. reset ();
# else
m_context. clear ();
# endif
}Соединение накапливает объем данных, отправляемых и полученных данными.
/* *
* @brief Return the number of bytes sent
*
* @return size_t
*/
virtual size_t bytesSent () const = 0;
/* *
* @brief Return the number of bytes received.
*
* @return size_t
*/
virtual size_t bytesReceived () const = 0;Получите соответствующий цикл для этого соединения.
/* *
* @brief New the event loop in which the connection I/O is handled.
*
* @return EventLoop*
*/
virtual EventLoop * getLoop () = 0;Следующие два варианта использования временно предоставляются:
