search

cpp-redis / cpp_redis

C++11 Lightweight Redis client: async, thread-safe, no dependency, pipelining, multi-platform
MIT License
720 stars 199 forks source link

Update Custom Network Module in Wiki #38

Open sdilts opened 5 years ago

sdilts commented 5 years ago

I'm writing a network module using the Qt framework instead of Taco Pie, and I have come across several parts of the Wiki that are missing or require clarification.

  1. For the function async_read, the size member of a read_request struct appears to be the requested size of the read buffer rather than the number of bytes that are expected. It is the value of __CPP_REDIS_READ_SIZE as defined in network/redis_connection.hpp.

  2. The function set_on_disconnect_handler is not mentioned, and the documentation in network/tcp_client_iface.hpp isn't very specific. Is the function supposed to be called when any disconnect occurs, or only one that occurs because of an error? https://github.com/cpp-redis/cpp_redis/blob/d1fc9c7cc61111958a30a9e366a7d6acea1306c4/includes/cpp_redis/network/tcp_client_iface.hpp#L183-L195

  3. The sidebar links to the archive repository instead of this one. Any change in the Wiki for this repository could easily be missed.