version: "0.4.2"
classes:
  - name: "SocketTarget"
    doc: >
      Socket targets allow logs to be sent to a Unix domain socket, like the
      frequently used /dev/log or /var/run/syslog sockets associated with syslog
      daemons.
    namespace: "stumpless"
    equivalent-struct:
      name: "stumpless_target"
      includes: "stumpless/target.h"
    constants:
      - name: "DEFAULT_SOCKET"
        doc: "A string literal with the default socket logged to."
        type: "char *"
        value: "STUMPLESS_DEFAULT_SOCKET"
    constructors:
      - doc: >
          Opens a socket target.
        wrapped-function:
          name: "stumpless_open_socket_target"
          includes: "stumpless/target/socket.h"
          params:
            - name: "name"
              doc: >
                The name of the socket to send logs to.
              type: "const char *"
            - name: "local_socket"
              doc: >
                The name of the Unix domain socket to connect from. This can be
                set to NULL if you'd like to simply let the target generate one.
              type: "const char *"
          return:
            type: "equivalent-struct-pointer"
          use-template: "pointer-return-error-check"
    destructor:
      doc: >
        Closes this target and releases all memory and other resources held by
        it. Notably, the connection to the socket is closed, and the local
        socket is cleaned up.
      wrapped-function:
        name: "stumpless_close_socket_target"
        includes: "stumpless/target/socket.h"
        params:
          - name: "equivalent-struct-pointer"
    functions:
      - use-template: "common-target-functions"