pikalabs/pink

A high performance network library

Pink

Pink is a wrapper of pthread. Why you need it?

When you use pthread, you always define many type of thread, such as:

In network programming scenario, some thread used for accept the client's connection, some thread used for pass message to other thread, some thread used for communicate with client using protobuf.

So pink wrap a thin capsulation upon pthread to offer more convinent function.

Model

DispatchThread + Multi WorkerThread

Now pink support these type of thread:

DispatchThread:

DispatchThread is used for listen a port, and get an accept connection. And then dispatch this connection to the worker thread, you can use different protocol, now we have support google protobuf protocol. And you just need write the protocol, and then generate the code. The worker threads will deal with the protocol analysis, so it simplify your job.

Basic usage example:

PikaConnFactory conn_factory;
PikaServerHandle server_handle;
ServerThread *t = new NewDispatchThread(9211, /* server port */
                                        4,    /* worker's number */
                                        &conn_factory,
                                        1000,  /* cron interval */
                                        1000,  /* queue limit */
                                        &server_handle);
t->StartThread();

You can see example/mydispatch_srv.cc for more detail

HolyThread:

HolyThread just like the redis's main thread, it is the thread that both listen a port and do the job. When should you use HolyThread and When should you use DispatchThread combine with WorkerThread, if your job is not so busy, so you can use HolyThread do the all job. if your job is deal lots of client's request, we suggest you use DispathThread with worker threads.

Basic usage example:

PikaConnFactory conn_factory;
PikaServerHandle server_handle;
ServerThread *t = new NewHolyThread(9211, /* server port */
                                    &conn_factory,
                                    1000,  /* cron interval */
                                    &server_handle);
t->StartThread();

You can see example/myholy_srv_chandle.cc example/myholy_srv.cc for more detail

Now we will use pink build our project pika, floyd, zeppelin

In the future, I will add some thread manager in pink.

Dependencies

• slash v1.0+

• protobuf v2.5.0

• OpenSSL if enable ssl

Performance

Test machines:

  --------         --------------
 |        |  <--- | Clients x200 |
 | Server |        --------------
 |        |        --------------
  --------   <--- | Clients x200 |
                   --------------

CPU, Intel(R) Xeon(R) CPU E5-2630 0 @ 2.30GHz, 24 cores

Memory, 142 GB

test program

pink's Issues

Add pink benchmark

we have write an benchmark example in code.
However we havn't gave our test result, we need add the test result

improve or redesign bg_thread?

when I use bg_thread, sometime user was blocking in the function Schedule function, but pink tell the user nothing. And it's not easy to debug the problem.
So can we add some logs there, or the schedule function will return some flag to tell the caller.

add Chinese ReadMe file

Add pink wiki

版本发布计划

现在只有一个很久之前发布的release，有版本发布计划吗？

include/http_conn.h中引用了src下的头文件

#include "pink/src/pink_util.h"

可以把pink_util.h也移到include下面

update pink readme

since pink has update to version 2, the Readme is too old.
we need update it

server_thread中new 出来的socket_p可能不会被 delete

https://github.com/Qihoo360/pink/blob/fe8cb932b271859f0b7e1a25616f270a90339f1d/pink/src/server_thread.cc#L136

如果这个地方return, 那上面new 出来的socket_p什么时候被 delete?

improve code style with cpplint.py

@gaodq

../include/pink_conn.h:5:  #ifndef header guard has wrong style, please use: PINK_INCLUDE_PINK_CONN_H_  [build/header_guard] [5]
../include/pink_conn.h:121:  #endif line should be "#endif  // PINK_INCLUDE_PINK_CONN_H_"  [build/header_guard] [5]
../include/pink_conn.h:27:  Line ends in whitespace.  Consider deleting these extra spaces.  [whitespace/end_of_line] [4]
../include/pink_conn.h:40:  Line ends in whitespace.  Consider deleting these extra spaces.  [whitespace/end_of_line] [4]
../include/pink_conn.h:42:  You don't need a ; after a }  [readability/braces] [4]
../include/pink_conn.h:41:  Line ends in whitespace.  Consider deleting these extra spaces.  [whitespace/end_of_line] [4]
../include/pink_conn.h:43:  Line ends in whitespace.  Consider deleting these extra spaces.  [whitespace/end_of_line] [4]
../include/pink_conn.h:44:  Line ends in whitespace.  Consider deleting these extra spaces.  [whitespace/end_of_line] [4]
../include/pink_conn.h:68:  You don't need a ; after a }  [readability/braces] [4]
../include/pink_conn.h:111:  You don't need a ; after a }  [readability/braces] [4]
../include/pink_conn.h:119:  Namespace should be terminated with "// namespace pink"  [readability/namespace] [5]

try to improve these code.

add gtest in our project

pink is lack of test, we can consider add gtest in our project

[Question] Relation with evpp

Hi, what's the connection with evpp? And do you think pink can have benefit by adopting libevent too? Thinking of a model like wangle or proxygen that specifically differentiates IO-related and CPU-related pools.