Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit e3585684 authored by Josh Gao's avatar Josh Gao
Browse files

adb: reformat comments. 

Bug: 67320882
Test: none
Change-Id: Ib484f701f66cdb57f303dbd6d5eb2e5a15abdc0e
(cherry picked from commit 55c8b34f)
parent f0a4fb6e

adb/socket.h

+58 −59
Original line number Diff line number Diff line
@@ -19,18 +19,20 @@ 


#include <stddef.h>



#include <memory>



#include "fdevent.h"



struct apacket;

class atransport;



/* An asocket represents one half of a connection between a local and

** remote entity.  A local asocket is bound to a file descriptor.  A

** remote asocket is bound to the protocol engine.

 * remote entity.  A local asocket is bound to a file descriptor.  A

 * remote asocket is bound to the protocol engine.

 */

struct asocket {

    /* chain pointers for the local/remote list of

        ** asockets that this asocket lives in

     * asockets that this asocket lives in

     */

    asocket* next;

    asocket* prev;
@@ -40,7 +42,7 @@ struct asocket { 
    unsigned id;



    /* flag: set when the socket's peer has closed

        ** but packets are still queued for delivery

     * but packets are still queued for delivery

     */

    int closing;
@@ -49,49 +51,46 @@ struct asocket { 
    bool has_write_error;



    /* flag: quit adbd when both ends close the

        ** local service socket

     * local service socket

     */

    int exit_on_close;



        /* the asocket we are connected to

        */



    // the asocket we are connected to

    asocket* peer;



    /* For local asockets, the fde is used to bind

        ** us to our fd event system.  For remote asockets

        ** these fields are not used.

     * us to our fd event system.  For remote asockets

     * these fields are not used.

     */

    fdevent fde;

    int fd;



        /* queue of apackets waiting to be written

        */

    // queue of apackets waiting to be written

    apacket* pkt_first;

    apacket* pkt_last;



    /* enqueue is called by our peer when it has data

        ** for us.  It should return 0 if we can accept more

        ** data or 1 if not.  If we return 1, we must call

        ** peer->ready() when we once again are ready to

        ** receive data.

     * for us.  It should return 0 if we can accept more

     * data or 1 if not.  If we return 1, we must call

     * peer->ready() when we once again are ready to

     * receive data.

     */

    int (*enqueue)(asocket* s, apacket* pkt);



    /* ready is called by the peer when it is ready for

        ** us to send data via enqueue again

     * us to send data via enqueue again

     */

    void (*ready)(asocket* s);



    /* shutdown is called by the peer before it goes away.

        ** the socket should not do any further calls on its peer.

        ** Always followed by a call to close. Optional, i.e. can be NULL.

     * the socket should not do any further calls on its peer.

     * Always followed by a call to close. Optional, i.e. can be NULL.

     */

    void (*shutdown)(asocket* s);



    /* close is called by the peer when it has gone away.

        ** we are not allowed to make any further calls on the

        ** peer once our close method is called.

     * we are not allowed to make any further calls on the

     * peer once our close method is called.

     */

    void (*close)(asocket* s);