Skip to content

socket

Socket

Bases: Section

Systemd [Socket] Section Directives

Source code in systemd_py/core/models/socket.py 
 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
class Socket(Section):
    """
    Systemd [Socket] Section Directives
    """

    listen_stream: Optional[Union[str, List[str]]] = Field(
        None,
        title="ListenStream",
        description="This defines an address for a stream socket which supports sequential, reliable "
                    "communication. Services that use TCP should use this socket type."
    )
    listen_datagram: Optional[Union[str, List[str]]] = Field(
        None,
        title="ListenDatagram",
        description="This defines an address for a datagram socket which supports fast, unreliable "
                    "communication packets. Services that use UDP should set this socket type."
    )
    listen_sequential_packet: Optional[Union[str, List[str]]] = Field(
        None,
        title="ListenSequentialPacket",
        description="This defines an address for sequential, reliable communication with max length "
                    "datagrams that preserves message boundaries. This is found most often for Unix sockets."
    )
    listen_fifo: Optional[Union[str, List[str]]] = Field(
        None,
        title="ListenFIFO",
        description="Along with the other listening types, you can also specify a FIFO buffer instead of a socket."
    )
    accept: Optional[bool] = Field(
        None,
        title="Accept",
        description="This determines whether an additional instance of the service will be each connection. "
                    "If set to false (the default), one instance will handle all connections."
    )
    socket_user: Optional[str] = Field(
        None,
        title="SocketUser",
        description="With a Unix socket, specifies the owner of the socket. This will be the root user if left unset."
    )
    socket_group: Optional[str] = Field(
        None,
        title="SocketGroup",
        description="With a Unix socket, specifies the group owner of the socket. This will be the root "
                    "group if neither this or the above are set. If only the SocketUser= is set, "
                    "systemd will try to find a matching group."
    )
    socket_mode: Optional[str] = Field(
        None,
        title="SocketMode",
        description="For Unix sockets or FIFO buffers, this sets the permissions on the created entity."
    )
    service: Optional[str] = Field(
        None,
        title="Service",
        description="If the service name does not match the .socket name, the service can be "
                    "specified with this directive."
    )

    class Config:
        fields = {
            'ListenStream': 'listen_stream',
            'ListenDatagram': 'listen_datagram',
            'ListenSequentialPacket': 'listen_sequential_packet',
            'ListenFIFO': 'listen_fifo',
            'Accept': 'accept',
            'SocketUser': 'socket_user',
            'SocketGroup': 'socket_group',
            'SocketMode': 'socket_mode',
            'Service': 'service'
        }