File: YOpenConnection.3

package info (click to toggle)
yiff 2.06-3
  • links: PTS
  • area: main
  • in suites: potato
  • size: 3,464 kB
  • ctags: 3,028
  • sloc: ansic: 47,463; makefile: 218; sh: 77
file content (46 lines) | stat: -rw-r--r-- 1,737 bytes parent folder | download
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
YOpenConnection(3)       YLIB FUNCTIONS      YOpenConnection(3)

NAME
        YOpenConnection - connect to Y server

SYNTAX
        #include <Y2/Y.h>
        #include <Y2/Ylib.h>

        YConnection *YOpenConnection(
                char *start_arg,
                char *con_arg
        )

ARGUMENTS
        start_arg       Specifies the null terminated command
                        to be executed to start the Y server.
                        This command is only used if the Y
                        server does not appear to be currently
                        running. If you do not want the Y server
                        to be started if it is not running, then
                        just pass NULL.

        con_arg         Specifies the connect argument to
                        connect to the Y server. The format is a
                        null terminated string of the format
                        "<address>:<port>" where <address>
                        specifies the address of the Y server
                        and <port> specifies the port number it
                        is polling for incoming connections on.
                        An example connect argument would be
                        "127.0.0.1:9433" which would connect to
                        localhost on port 9433 (standard port
                        number).

DESCRIPTION
        The YOpenConnection returns a YConnection pointer that
        serves as the connection to the Y server and that
        contains all the information about that Y server. It
        can also return NULL if it failed to start the Y server
        (as needed or requested) and/or connect to it.

SEE ALSO
        YCloseConnection(3)

Y Version 2