Commit 7f77655d authored by Scott Vokes's avatar Scott Vokes
Browse files

Add architectural notes draft and time sequence diagrams to DEVELOP.md.

parent 43c8a3e6

DEVELOP.md

+4 −0
Original line number Diff line number Diff line
@@ -24,6 +24,10 @@ API Documentation 
    * The ByteArray and ByteBuffer types are used for exchanging variable length byte-arrays with kinetic-c

        * e.g. object keys, object value data, etc.



There are also some additional [architectural notes](docs) and time-sequence diagrams.



[docs]: https://github.com/Seagate/kinetic-c/blob/master/docs/sequence_diagrams/arch_docs.md



Common Developer Tasks

----------------------

* Build the library

docs/sequence_diagrams/arch_docs.md

+22 −0
Original line number Diff line number Diff line
@@ -10,6 +10,28 @@ This boxed_msg goes from the Client thread to the Listener thread, then the call 
Socket connections must be registered with the message bus, via `bus_register_socket`. This defines whether they should use SSL or not, and binds other protocol-specific data to them. When a socket is disconnected, `bus_release_socket` will free the internal resources.





# Diagrams



A full request/response cycle flowing through the library.



![](request_response.png?raw=true)





A message going through the message bus, with no errors.



![](msg_handling-no_errors.png?raw=true)





A message going through the message bus, with no reply (a time-out error).



![](msg_handling-no_reply.wsd?raw=true)





A message going through the message bus, with a hang-up error while sending.



![](msg_handling-send_error.wsd?raw=true)





# Entities



## Client Thread