amarquee.library/QGo           amarquee.library/QGo

   NAME
    QGo - Instructs the TCP thread to begin transmitting the
          currently accumulated transaction packet.

   SYNOPSIS
    #include 

    LONG QGo(struct QSession * session, ULONG flags)

   FUNCTION
    All of the Q#?Op() functions in amarquee.library create
    transaction packets which are queued on the client computer.  
    That is, they are not immediately transmitted to the AMarquee 
    server.  Rather, when you wish to transmit the operations you 
    have accumulated, you should call this function.
    
   NOTE
    The QGOF_SYNC option of this command is different from
    doing a QPingOp, because with this option you
    are guaranteed that all other server processes have seen your
    new data by the time you get the back ping packet that this
    operation generated.

   INPUTS
    session - The session you wish to begin transmission.
    flags   - A bit chord of the QGOF_* flags defined in AMarquee.h
              Flags currently supported are:
              
      QGOF_SYNC - If set, the AMarquee server will be return a ping 
                  packet after all of the operations currently queued 
                  have executed, and all other AMarquee server threads 
                  have been notified of any updates made.  The ping
                  packet will have a qm_ID equal to the return value 
                  of this function.

      QGOF_NOTIFY - If set, the client TCP thread will notify your
                    application via a QMessage as soon as it has 
                    finished sending the data in this transaction.
                    The returned QMessage will have a qm_Status of
                    QERROR_SEND_DONE, and a qm_ID equal to the return
                    value of this function.  (This flag was introduced
                    in v47 of amarquee.library, and will be ignored
                    by earlier versions)

   RESULTS
    Returns the assigned ID number of the QGo operation or 0
    to indicate failure.  

   EXAMPLE
    LONG goID;
    
    /* ... do various Q*Op() calls ... */
    
    if (goID = QGo(0L))
       printf("Go succeeded, was given id #%li\n",goID);
    else 
       printf("Go failed.  (no memory?)\n");


   AREXX EXAMPLE
    LONG goID;
    
    /* ... do various Q*Op() calls ... */

    goID = QGo('QGOF_SYNC|QGOF_NOTIFY')
    if (goID > 0) then
       say "Go succeeded, was given id #" || goID
    else 
       say "Go failed.  (no memory?)"
    
   SEE ALSO
    QMessages