rom/dos/abortpkt.c

   1 /*
   2     Copyright © 1995-2012, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc: Cancel an asynchronous packet.
   6     Lang: English
   7 */
   8
   9 #include <proto/exec.h>
  10
  11 #include "dos_intern.h"
  12
  13 /*****************************************************************************
  14
  15     NAME */
  16 #include <dos/dosextens.h>
  17 #include <proto/dos.h>
  18
  19         AROS_LH2(void, AbortPkt,
  20
  21 /*  SYNOPSIS */
  22         AROS_LHA(struct MsgPort   *, port, D1),
  23         AROS_LHA(struct DosPacket *, pkt, D2),
  24
  25 /*  LOCATION */
  26         struct DosLibrary *, DOSBase, 44, Dos)
  27
  28 /*  FUNCTION
  29         This function currently does nothing. You can use WaitForChar()
  30         to poll for characters from an interactive handler.
  31
  32         The planned purpose of this function is:
  33         Tries to abort an asynchronous packet. There is no guarantee
  34         that this succeeds. You must wait with WaitPkt() for the packet
  35         to return before you can reuse or deallocate it.
  36
  37     INPUTS
  38         port - The message port to where the packet was sent.
  39         pkt  - The packet to be aborted.
  40
  41     RESULT
  42
  43     NOTES
  44
  45     EXAMPLE
  46
  47     BUGS
  48
  49     SEE ALSO
  50         SendPkt(), WaitForChar(), WaitPkt()
  51
  52     INTERNALS
  53
  54 *****************************************************************************/
  55 {
  56     AROS_LIBFUNC_INIT
  57
  58     /* TODO: implement this for real packets (is it possible at all) ? */
  59
  60     AROS_LIBFUNC_EXIT
  61 } /* AbortPkt */