summaryrefslogblamecommitdiff
path: root/server/ptp.rst
blob: ef7af57c4f9654150157d59c2d46b1601e1b8b80 (plain) (tree)
1
2
3
4
5
6
7
8
9
10
11










                                    
                                    






                                    
                                    






                 


                                            




            



                                       
                

                      
                      






                  


                                                           




            



                          
                


                            






                 

                                                           
                                                           




            
                          
                          

                          
                


                            






                      

                                              
                                              




            


                                                    
        
                        




                                          
                                          
 
Piztor Transmission Protocol v0.1
---------------------------------

- General 

  - Request

    ::
    
        +---1b---+-------?b--------+
        | OPT ID |  SPECIFIC DATA  |
        +-uchar--+-----------------+

  - Response

    ::
    
        +---1b---+------?b---------+
        | OPT ID |  SPECIFIC DATA  |
        +-uchar--+-----------------+

- Authentication 

  - Request

    :: 

        +--1b---+-----?b------+-----?b-----+
        | 0x00  |   USERNAME  |  PASSWORD  |
        +-uchar-+-------------+------------+

  - Response

    ::
    
       +--1b---+-----4b-----+---1b----+
       | 0x00  | USER_TOKEN |  STATUS |
       +-uchar-+-----int----+--uchar--+

    ``STATUS`` :
    
    - 0x00 for success
    - 0x01 for failure

- Message Sending 

  - Request

    ::
    
        +--1b---+------4b------+------4b-----+-----?b-----+
        | 0x01  | SENDER_TOKEN | RECEIVER_ID |  MSG_BODY  |
        +-uchar-+------int-----+-----int-----+------------+

  - Response
        
    ::

        +--1b---+---1b---+
        | 0x01  | STATUS |
        +-uchar-+--uchar-+

    ``STATUS`` :

    - 0x00 for success
    - 0x01 for invalid token

- Location Update

  - Request

    ::
    
        +--1b---+------4b------+-----8b-----+------8b-----+
        | 0x02  | SENDER_TOKEN |  LATITUDE  |  LONGITUDE  |
        +-uchar-+------int-----+---double---+---double----+

  - Response

    ::

        +--1b---+---1b---+
        | 0x02  | STATUS |
        +-uchar-+--uchar-+

    ``STATUS`` :

    - 0x00 for success
    - 0x01 for invalid token

- Location Information

  - Request

    ::
    
        +--1b---+-----4b-------+------4b-----+
        | 0x03  | SENDER_TOKEN |  GROUP_ID   |
        +-uchar-+-----int------+-----int-----+

  - Response

    ::

        +--1b---+-----4b----+------20b-------+-----+
        | 0x03  | ENTRY_CNT | LOCATION_ENTRY | ... |
        +-uchar-+---int-----+----------------+-----+
        
    ``LOCATION_ENTRY`` :

    :: 

        +---4b----+----8b----+-----8b----+
        | USER_ID | LATITUDE | LONGITUDE |
        +---int---+--double--+--double---+