Re: Documentation for Binary Client Protocol

2018-01-22 Thread Pavel Tupitsyn
Thanks Denis, makes sense. On Fri, Jan 19, 2018 at 10:55 PM, Denis Magda wrote: > Added the proposed callout to the top of the page: > https://cwiki.apache.org/confluence/display/IGNITE/IEP- > 9+Thin+Client+Protocol > > > On Jan 19, 2018, at 9:36 AM, Denis Magda

Re: Documentation for Binary Client Protocol

2018-01-19 Thread Denis Magda
Added the proposed callout to the top of the page: https://cwiki.apache.org/confluence/display/IGNITE/IEP-9+Thin+Client+Protocol > On Jan 19, 2018, at 9:36 AM, Denis Magda wrote: > > Pavel, > > Do you plan to maintain this page? Frankly, since it’s an IEP and Prachi >

Re: Documentation for Binary Client Protocol

2018-01-19 Thread Denis Magda
Pavel, Do you plan to maintain this page? Frankly, since it’s an IEP and Prachi already prepared an official documentation I would suggest us to but a teaser on the top of the page saying that the most up-to-date and detailed information about the protocol is on readme.io .

Re: Documentation for Binary Client Protocol

2018-01-18 Thread Pavel Tupitsyn
Hi everyone, Just a reminder that initial spec is on wiki: https://cwiki.apache.org/confluence/display/IGNITE/IEP-9+Thin+Client+Protocol It is quite terse and may be harder to understand. Prachi tried to document all of this in a more user-friendly manner with examples and so on. On Fri, Jan

Re: Documentation for Binary Client Protocol

2018-01-18 Thread Denis Magda
Lucas, thanks for chiming in, The protocol itself consists of all these magic constants (type and operations codes). See type codes table from this section: https://apacheignite.readme.io/docs/binary-client-protocol#section-data-objects

Re: Documentation for Binary Client Protocol

2018-01-18 Thread Denis Magda
Documentation consists of a set of unrelated code snippets for various operations. Do not treat it as a complete application or sample (the protocol is huge). This is why it’s totally fine to use numerical constants in the doc and leave it as as responsibility of a developer to define and use

Re: Documentation for Binary Client Protocol

2018-01-18 Thread Lucas Beeler
Hi Igniters, I’m with Alexey here: hard-coded “magic” literals make code hard to read and neither communicate coding professionalism nor comport with published Sun/Oracle style guides. So I suggest that: For already defined symbolic constants, let’s use them instead of literal values If there

Re: Documentation for Binary Client Protocol

2018-01-18 Thread Alexey Kuznetsov
Prachi, Denis, It is OK that we are using numbers in code samples instead of named constants? For example: writeByteLittleEndian(3, out); // Integer type code It could be smth. like this: writeByteLittleEndian(TYPE_INT, out); // Integer type code Where TYPE_INT is declared at some

Documentation for Binary Client Protocol

2018-01-18 Thread Prachi Garg
Igniters, The document for Binary Client Protocol (awaiting 2.4 release) is ready on Apache Ignite readme.io. This document explains: - How to connect to Ignite cluster - Common message format (Request/Response header) - Supported Data types and their format - Request/Response format