File: zhttp_server.api

package info (click to toggle)
czmq 4.2.1-3
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 9,912 kB
  • sloc: ansic: 30,811; cpp: 19,362; sh: 11,873; python: 11,814; pascal: 11,229; ruby: 8,818; java: 4,363; makefile: 299; perl: 151; javascript: 35
file content (40 lines) | stat: -rw-r--r-- 1,464 bytes parent folder | download | duplicates (3)
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
<class name = "zhttp_server" state = "draft">
    <!--
    Copyright (c) the Contributors as noted in the AUTHORS file.
    This file is part of CZMQ, the high-level C binding for 0MQ:
    http://czmq.zeromq.org.

    This Source Code Form is subject to the terms of the Mozilla Public
    License, v. 2.0. If a copy of the MPL was not distributed with this
    file, You can obtain one at http://mozilla.org/MPL/2.0/.
    -->
    Simple http server.
    To start handling requests:
    1. Create a dealer socket
    2. Connect the socket to the server backend address provided in the options.
    3. Create a zhttp_request.
    4. Call zhttp_request_recv to accept a new request.
    5. Call zhttp_response_send to send a response.

    You can connect as many dealers as you want.
    The Server is using simple dealer socket to route the requests.

    NOTE: when using libmicrohttpd << 0.9.34 the application might experience
    high CPU usage due to the lack of MHD_suspend_connection and
    MHD_resume_connection APIs. It is recommended to use this class only with
    libmicrohttpd at least 0.9.34 in production.

    <constructor>
        Create a new http server
	    <argument name = "options" type = "zhttp_server_options" />
    </constructor>

    <destructor>
        Destroy an http server
    </destructor>

    <method name = "port">
        Return the port the server is listening on.
        <return type = "integer" />
    </method>
</class>