/src/ftk_pipe.h

http://ftk.googlecode.com/ · C Header · 54 lines · 15 code · 9 blank · 30 comment · 0 complexity · ad593561cd2f431ab111ecf979e4776d MD5 · raw file 

    

  1. /*
    2. 

  2.  * File: ftk_pipe.h    
    3. 

  3.  * Author:  Li XianJing <xianjimli@hotmail.com>
    4. 

  4.  * Brief:   pipe
    5. 

  5.  *
    6. 

  6.  * Copyright (c) 2009 - 2010  Li XianJing <xianjimli@hotmail.com>
    7. 

  7.  *
    8. 

  8.  * Licensed under the Academic Free License version 2.1
    9. 

  9.  *
    10. 

  10.  * This program is free software; you can redistribute it and/or modify
    11. 

  11.  * it under the terms of the GNU General Public License as published by
    12. 

  12.  * the Free Software Foundation; either version 2 of the License, or
    13. 

  13.  * (at your option) any later version.
    14. 

  14.  *
    15. 

  15.  * This program is distributed in the hope that it will be useful,
    16. 

  16.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
    17. 

  17.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    18. 

  18.  * GNU General Public License for more details.
    19. 

  19.  *
    20. 

  20.  * You should have received a copy of the GNU General Public License
    21. 

  21.  * along with this program; if not, write to the Free Software
    22. 

  22.  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
    23. 

  23.  */
    24. 

  24. 

  25. /*
    26. 

  26.  * History:
    27. 

  27.  * ================================================================
    28. 

  28.  * 2010-01-20 Li XianJing <xianjimli@hotmail.com> created

    29. 

  29.  * 2010-10-02 Jiao JinXing <jiaojinxing1987@gmail.com> add ftk_pipe_check.
    30. 

  30.  *
    31. 

  31.  */
    32. 

  32. 

  33. #ifndef FTK_PIPE_H
    34. 

  34. #define FTK_PIEP_H
    35. 

  35. 

  36. #include "ftk_typedef.h"
    37. 

  37. 

  38. FTK_BEGIN_DECLS
    39. 

  39. 

  40. struct _FtkPipe;
    41. 

  41. typedef struct _FtkPipe FtkPipe;
    42. 

  42. 

  43. FtkPipe* ftk_pipe_create(void);
    44. 

  44. int   ftk_pipe_read(FtkPipe* thiz, void* buff, size_t length);
    45. 

  45. int   ftk_pipe_write(FtkPipe* thiz, const void* buff, size_t length);
    46. 

  46. int   ftk_pipe_get_read_handle(FtkPipe* thiz);
    47. 

  47. int   ftk_pipe_get_write_handle(FtkPipe* thiz);
    48. 

  48. void  ftk_pipe_destroy(FtkPipe* thiz);

    49. 

  49. int   ftk_pipe_check(FtkPipe* thiz);
    50. 

  50. 

  51. FTK_END_DECLS
    52. 

  52. 

  53. #endif/*FTK_MMAP_H*/
    54.