summaryrefslogtreecommitdiffstats
path: root/src/core/transport/tcp/axis2_simple_tcp_svr_conn.h
blob: c0d3b8914ed96fabbd42dbe3d0869f621186089d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      tcp://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef AXIS2_SIMPLE_HTTP_SVR_CONN_H
#define AXIS2_SIMPLE_HTTP_SVR_CONN_H

/**
 * @ingroup axis2_core_transport_tcp
 * @{
 */

/**
 * @file axis2_simple_tcp_svr_conn.h
 * @brief Axis2 simple tcp server connection
 */

#include <axis2_const.h>
#include <axis2_defines.h>
#include <axutil_env.h>
#include <axutil_stream.h>

#ifdef __cplusplus
extern "C"
{
#endif

    typedef struct axis2_simple_tcp_svr_conn axis2_simple_tcp_svr_conn_t;

    /**
     * @param svr_conn pointer to server connection struct
     * @param env pointer to environment struct
     * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
     */
    AXIS2_EXTERN axis2_status_t AXIS2_CALL
    axis2_simple_tcp_svr_conn_close(
        axis2_simple_tcp_svr_conn_t * svr_conn,
        const axutil_env_t * env);

    /**
     * @param svr_conn pointer to server connection struct
     * @param env pointer to environment struct
     */
    AXIS2_EXTERN axis2_bool_t AXIS2_CALL
    axis2_simple_tcp_svr_conn_is_open(
        axis2_simple_tcp_svr_conn_t * svr_conn,
        const axutil_env_t * env);

    /**
     * @param svr_conn pointer to server connection struct
     * @param env pointer to environment struct
     */

    AXIS2_EXTERN axutil_stream_t *AXIS2_CALL

    axis2_simple_tcp_svr_conn_get_stream(
        const axis2_simple_tcp_svr_conn_t * svr_conn,
        const axutil_env_t * env);

    /**
     * @param svr_conn pointer to server connection struct
     * @param env pointer to environment struct
     */
    AXIS2_EXTERN axis2_char_t *AXIS2_CALL

    axis2_simple_tcp_svr_conn_read_request(
        axis2_simple_tcp_svr_conn_t * svr_conn,
        const axutil_env_t * env);

    /**
     * @param svr_conn pointer to server connection struct
     * @param env pointer to environment struct
     * @param timeout timeout
     * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
     */
    AXIS2_EXTERN axis2_status_t AXIS2_CALL

    axis2_simple_tcp_svr_conn_set_rcv_timeout(
        axis2_simple_tcp_svr_conn_t * svr_conn,
        const axutil_env_t * env,
        int timeout);

    /**
     * @param svr_conn pointer to server connection struct
     * @param env pointer to environment struct
     * @param timeout timeout
     * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
     */
    AXIS2_EXTERN axis2_status_t AXIS2_CALL

    axis2_simple_tcp_svr_conn_set_snd_timeout(
        axis2_simple_tcp_svr_conn_t * svr_conn,
        const axutil_env_t * env,
        int timeout);

    /**
     * @param svr_conn pointer to server connection struct
     * @param env pointer to environment struct
     */
    AXIS2_EXTERN axis2_char_t *AXIS2_CALL

    axis2_simple_tcp_svr_conn_get_svr_ip(
        const axis2_simple_tcp_svr_conn_t * svr_conn,
        const axutil_env_t * env);

    /**
     * @param svr_conn pointer to server connection struct
     * @param env pointer to environment struct
     */
    AXIS2_EXTERN axis2_char_t *AXIS2_CALL

    axis2_simple_tcp_svr_conn_get_peer_ip(
        const axis2_simple_tcp_svr_conn_t * svr_conn,
        const axutil_env_t * env);

    /**
     * @param svr_conn pointer to server connection struct
     * @param env pointer to environment struct
     * @return AXIS2_SUCCESS on success, else AXIS2_FAILURE
     */
    AXIS2_EXTERN void AXIS2_CALL
    axis2_simple_tcp_svr_conn_free(
        axis2_simple_tcp_svr_conn_t * svr_conn,
        const axutil_env_t * env);

    /**
     * creates axis2_simple_tcp_svr_conn struct
     * @param env pointer to environment struct
     * @param sockfd sockfd
     */
    AXIS2_EXTERN axis2_simple_tcp_svr_conn_t *AXIS2_CALL

    axis2_simple_tcp_svr_conn_create(
        const axutil_env_t * env,
        int sockfd);

#ifdef __cplusplus
}
#endif

#endif                          /* AXIS2_SIMPLE_HTTP_SVR_CONN_H */