netpoll cpp
1.0.0
Dies ist eine C++ NIO -Netzwerkbibliothek mit Leistung und Benutzerfreundlichkeit. Es unterstützt C++14 und höher und umfasst drei Haupt -Mainstream -Plattformen.
Das zugrunde liegende IO-Modell leiht one loop per thread der Muduo-Netzwerkbibliothek, wodurch die Thread-sffe-API-Einkapselung effizienter und einfacher wird.
Die API -Schnittstelle, die von der oberen Ebene bereitgestellt wird, leiht sich von der Open Source Go Language NIO -Netzwerkbibliothek von ByTedance NOSPOLD und abstraktiert Listener und Dialer , um schließlich Dienste über EventLoop bereitzustellen.
Um wie diese Bibliothek verwendet wird, können Sie den schnellen Start überprüfen.
Beispiele für bestimmte Verwendungsbeispiele finden Sie unter Beispiele.
Bereits unterstützt :
windows/linux/macos -Plattformen werden mit der höchsten Leistungsmultiplexing -Implementierung der Plattform (EPOLL/EPOLL/KQUEUE implementiert von IOCP) implementiert.EventLoop , um asynchrone Anrufe zu implementieren. Wenn das Betriebssystem sendfile -Anrufe unterstützt, wird der Aufruf von Null-Kopie aufgerufen, anstatt die C-Standardbibliothek aufzurufen.echo -Server schreiben möchten, benötigen Sie nur den folgenden Code: 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 , die möglicherweise nur 100*8byte erfordern). Für Details können Sie den Blog: Detaillierte Einführung überprüfen.one loop per thread Modell ab. Lockfree_queuefuture für die Synchronisation zurückgeben wird, was bei der Client -Programmierung nützlich sein kann. netpoll::SignalTask::Register ({SIGINT,SIGTERM});
netpoll::SignalTask::Add ([](){
// do something
});Wird es in Zukunft unterstützen :
Die Leistung ist extrem hoch, und ich habe ASIO (C ++)/Netty (Java)/Netpoll (GO -Sprache) vorübergehend getestet.
Ich habe ASIO/Netty unter Windows -System getestet, und der folgende Diagramm -Test basiert auf Linux, und ich bin nicht sehr gut darin, Java -Programme unter Linux bereitzustellen, sodass das folgende Diagramm nicht die Leistung von Netty hat.
Die durchschnittliche Latenz eines einzelnen verbundenen Echo -Dienstes unter verschiedenen Parallelitätssituationen ist wie folgt (AVG):
Die zugrunde liegende Modellarchitektur der Serverseite:
Listener -Kapselung vereinfacht die Verwendung von TcpServer , alle Aufrufe sind wie folgt:
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 -Kapselung vereinfacht die Verwendung von TcpClient , und die verwendeten Aufrufe sind wie folgt:
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);
}
} Die Lastausgleichsstrategie von EventLoop enthält keine separaten Einstellungen, und alle verwenden Round Robin .
Die APIs mit EventLoop sind wie folgt:
NewEventLoop(size_t threadNum=2,const netpoll::StringView&name="eventloop") : Erstellen Sie eine EventLoop -Instanz und legen Sie die Anzahl der Threads für EventLoop fest.
serve : Nachdem Sie den Dialer oder Hörer neu beendet haben, können Sie diese Dienste über diese Methode zur Verfügung stellen.
serveAsDaemon -Methode: Der Effekt ist der gleiche wie die Servicemethode, aber das Öffnen eines neuen Fadens blockiert den aktuellen Thread nicht.
enableQuit : Ermöglichen Sie den aktiven Aufruf zum Schlaufe -Exit -Methoden. Standardmäßig kann es nicht alle Schleifenfäden aktiv beenden und wird in Verbindung mit der QuitAllEventLoop -Methode verwendet.
QuitAllEventLoop -Methode: Beenden Sie alle Schleifen.
MessageBuffer ist ein mittlerer Cache zum Lesen und Schreiben von Kernel -Pufferdaten. Es ist tatsächlich ein variabler Puffer und es ist auch sehr einfach zu implementieren. Für verschiedene Arten von Pufferimplementierungen können Sie meinen Artikel untersuchen: Implementierung der variablen Länge und unveränderlichen Längenpuffer
Ich werde hier nicht verschiedene Anrufe beschreiben. Wenn Sie wissen möchten, können Sie sich die entsprechende Header -Datei direkt ansehen: netpoll/util/message_buffer.h.
Lassen Sie mich kurz über die Höhepunkte der Implementierung dieses Puffers sprechen:
Bei Erweiterung, Vermeidung der Nebenwirkungen der Größe der Größe kann es auch die Speicheröffnung und das Kopieren von Vorgängen vereinfachen.
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);
}Geben Sie die READFD -Methode an, die die Daten des entsprechenden FD -Lesepuffers dem MessageBuffer liest. Der Inhalt liest jedes Mal groß genug. Wenn der MessageBuffer -Schreibbereich beispielsweise weniger als 8 KB beträgt, ist der 8 -KB -alternative Lesecache aktiviert.
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;
}Die TCPConnection -Klasse ist eine abstrakte Klasse, die bei der Verwendung durch intelligente Zeiger verwendet wird.
Diese Schnittstelle gibt die folgenden Funktionen an:
Daten senden (einschließlich String/Puffer/Datei/Stream).
/* *
* @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;Erhalten Sie Verbindungsinformationen wie Adressinformationen oder Verbindungsstatus oder einen Puffer, der Daten empfängt.
/* *
* @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;Setzen Sie den Verbindungsrückruf oder den Verbindungsstatus (setzen Sie 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;Legt den Kontext der Verbindung fest, um die dedizierte Geschäftslogik für die Verbindung zu verarbeiten.
/* *
* @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
}Die Verbindung sammelt die von den Daten gesendete und empfangene Datenmenge.
/* *
* @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;Holen Sie sich die entsprechende Schleife für diese Verbindung.
/* *
* @brief New the event loop in which the connection I/O is handled.
*
* @return EventLoop*
*/
virtual EventLoop * getLoop () = 0;Die folgenden zwei Anwendungsfälle werden vorübergehend bereitgestellt:
