Changeset 26 in libcf for trunk/include/cf_socket.h


Ignore:
Timestamp:
02/04/13 17:00:53 (11 years ago)
Author:
cheese
Message:

#1 documentation with doxygen

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/include/cf_socket.h

    r21 r26  
    11/**
    2  * cf_socket.h
     2 * @file    cf_socket.h
     3 * @author  myusgun <myusgun@gmail.com>
     4 * @version 0.1
     5
     6 * @remark TCP 소켓만 지원됨
    37 */
    48#ifndef __CF_SOCKET_H__
    … …  
    4448#endif
    4549
     50/**
     51 * 소켓이 초기화 상태 확인
     52 *
     53 * @return 초기화 된 경우, CF_TRUE; 그렇지 않은 경우, CF_FALSE
     54 */
    4655CF_EXPORT CF_BOOL
    4756CF_Socket_IsInitialized (void);
    4857
     58/**
     59 * 소켓 초기화
     60 *
     61 * @return 성공 시, CF_OK; 실패 시, 오류 코드
     62 */
    4963CF_EXPORT int
    5064CF_Socket_Initialize    (void);
    5165
     66/**
     67 * 소켓 해제
     68 *
     69 * @return 성공 시, CF_OK; 실패 시, 오류 코드
     70 */
    5271CF_EXPORT int
    5372CF_Socket_Finalize      (void);
    5473
     74/**
     75 * 소켓 닫기
     76 *
     77 * @return 성공 시, CF_OK; 실패 시, 오류 코드
     78 *
     79 * @param sock 소켓
     80 */
    5581CF_EXPORT int
    5682CF_Socket_Close         (const int sock);
    5783
     84/**
     85 * 소켓 옵션 설정
     86 *
     87 * @return 성공 시 CF_OK; 실패 시, 오류 코드
     88 *
     89 * @param sock      소켓
     90 * @param optname   옵션 이름
     91 * @param optval    설정할 옵션 값의 메모리
     92 * @param optlen    설정할 옵션의 길이
     93 */
    5894CF_EXPORT int
    5995CF_Socket_SetOption     (const int      sock,
    … …  
    6298                         const size_t   optlen);
    6399
     100/**
     101 * 소켓 옵션 얻기
     102 *
     103 * @return 성공 시 CF_OK; 실패 시, 오류 코드
     104 *
     105 * @param sock      소켓
     106 * @param optname   옵션 이름
     107 * @param optval    옵션 값을 가져올 메모리
     108 * @param optlen    옵션 길이를 가져올 메모리
     109 */
    64110CF_EXPORT int
    65111CF_Socket_GetOption     (const int  sock,
    … …  
    68114                         size_t     * optlen);
    69115
     116/**
     117 * 소켓에 타임아웃 설정
     118 *
     119 * @return 성공 시 CF_OK; 실패 시, 오류 코드
     120 *
     121 * @param sock      소켓
     122 * @param timeout   타임아웃(sec)
     123 */
    70124CF_EXPORT int
    71125CF_Socket_SetTimeout    (const int  sock,
    72126                         const int  timeout);
    73127
     128/**
     129 * 소켓 연결
     130 *
     131 * @return 성공 시, 연결된 소켓; 실패 시, 오류 코드
     132 *
     133 * @param ip    연결할 호스트의 주소 (도메인 이름 가능)
     134 * @param port  연결할 호스트의 포트번호
     135 */
    74136CF_EXPORT int
    75137CF_Socket_Connect       (const char             * ip,
    76138                         const unsigned short   port);
    77139
     140/**
     141 * 서버 열기
     142 *
     143 * @return 성공 시, 서버 소켓; 실패 시, 오류 코드
     144 *
     145 * @param port      서버 포트
     146 * @param backlog   listen 시의 backlog 수
     147 */
    78148CF_EXPORT int
    79149CF_Socket_Server        (const unsigned short   port,
    80150                         const int              backlog);
    81151
     152/**
     153 * 소켓 연결
     154 *
     155 * @return 성공 시, 연결된 소켓; 실패 시, 오류 코드
     156 *
     157 * @param sock      서버 소켓
     158 * @param address   [옵션] 클라이언트 정보를 담을 sockaddr_in 구조체 포인터
     159 */
    82160CF_EXPORT int
    83161CF_Socket_Accept        (const int          sock,
    84162                         struct sockaddr_in * address);
    85163
     164/**
     165 * 데이터 송신
     166 *
     167 * @return 성공 시, CF_OK; 실패 시, 오류 코드
     168 *
     169 * @param sock  소켓
     170 * @param buf   송신할 데이터
     171 * @param len   송신할 데이터의 길이
     172 */
    86173CF_EXPORT int
    87174CF_Socket_Send          (const int  sock,
    … …  
    89176                         const int  len);
    90177
     178/**
     179 * 데이터 수신
     180 *
     181 * @return 성공 시, 수신한 데이터의 길이; 실패 시, 오류 코드
     182 *
     183 * @param sock  소켓
     184 * @param buf   데이터를 수신할 버퍼
     185 * @param len   데이터를 수신할 버퍼의 최대 크기
     186 */
    91187CF_EXPORT int
    92188CF_Socket_Recv          (const int  sock,
Note: See TracChangeset for help on using the changeset viewer.