Ignore:
Timestamp:
Nov 7, 2005 3:47:28 PM (14 years ago)
Author:
bennylp
Message:

Added file I/O and file access API

File:
1 edited

Legend:

Unmodified
Added
Removed
  • pjproject/main/pjlib/include/pj/ioqueue.h

    r14 r18  
    1515 
    1616/** 
    17  * @defgroup PJ_IO Network I/O 
    18  * @brief Network I/O 
     17 * @defgroup PJ_IO Input/Output 
     18 * @brief Input/Output 
    1919 * @ingroup PJ_OS 
    2020 * 
     
    5353 * completed. 
    5454 * 
     55 * The I/O Queue can work on both socket and file descriptors. For  
     56 * asynchronous file operations however, one must make sure that the correct 
     57 * file I/O back-end is used, because not all file I/O back-end can be 
     58 * used with the ioqueue. Please see \ref PJ_FILE_IO for more details. 
     59 * 
    5560 * The framework works natively in platforms where asynchronous operation API 
    5661 * exists, such as in Windows NT with IoCompletionPort/IOCP. In other  
     
    6166 * The I/O queue provides more than just unified abstraction. It also: 
    6267 *  - makes sure that the operation uses the most effective way to utilize 
    63  *    the underlying mechanism, to provide the maximum theoritical 
     68 *    the underlying mechanism, to achieve the maximum theoritical 
    6469 *    throughput possible on a given platform. 
    6570 *  - choose the most efficient mechanism for event polling on a given 
     
    488493                                          int *addrlen); 
    489494 
    490  
    491495/** 
    492496 * Instruct the I/O Queue to write to the handle. This function will return 
     
    530534 
    531535/** 
    532  * This function behaves similarly as #pj_ioqueue_write(), except that 
    533  * pj_sock_sendto() (or equivalent) will be called to send the data. 
     536 * Instruct the I/O Queue to write to the handle. This function will return 
     537 * immediately (i.e. non-blocking) regardless whether some data has been  
     538 * transfered. If the function can't complete immediately, the caller will 
     539 * be notified about the completion when it calls pj_ioqueue_poll(). If  
     540 * operation completes immediately and data has been transfered, the function 
     541 * returns PJ_SUCCESS and the callback will NOT be called. 
    534542 * 
    535543 * @param key       the key that identifies the handle. 
Note: See TracChangeset for help on using the changeset viewer.