sock.h

Go to the documentation of this file.

/* SPDX-License-Identifier: LGPL-3.0-or-later
   SPDX-FileCopyrightText: Copyright © 2023 Erez Geva <ErezGeva2@gmail.com> */
 
#ifndef __PTPMGMT_C_SOCK_H
#define __PTPMGMT_C_SOCK_H
 
#ifdef __PTPMGMT_HAVE_SYS_TYPES_H
#include <sys/types.h>
#else
typedef long ssize_t;
#endif /* __PTPMGMT_HAVE_SYS_TYPES_H */
#include "c/cfg.h"
#include "c/ptp.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct ptpmgmt_sk_t *ptpmgmt_sk;
 
typedef const struct ptpmgmt_sk_t *const_ptpmgmt_sk;
 
struct ptpmgmt_sk_t {
    void *_this; 
    void (*free)(ptpmgmt_sk sk);
 
    void (*close)(ptpmgmt_sk sk);
    bool (*init)(ptpmgmt_sk sk);
    bool (*send)(const_ptpmgmt_sk sk, const void *msg, size_t len);
    ssize_t (*rcv)(const_ptpmgmt_sk sk, void *buf, size_t bufSize, bool block);
    int (*getFd)(const_ptpmgmt_sk sk);
    int (*fileno)(const_ptpmgmt_sk sk);
    bool (*poll)(const_ptpmgmt_sk sk, uint64_t timeout_ms);
    bool (*tpoll)(const_ptpmgmt_sk sk, uint64_t *timeout_ms);
    const char *(*getPeerAddress)(const_ptpmgmt_sk sk);
    bool (*isPeerAddressAbstract)(const_ptpmgmt_sk sk);
    bool (*setPeerAddress)(ptpmgmt_sk sk, const char *string);
    bool (*setPeerAddressAbstract)(ptpmgmt_sk sk, const char *string);
    bool (*setPeerAddressCfg)(ptpmgmt_sk sk, const_ptpmgmt_cfg cfg,
        const char *section);
    const char *(*getSelfAddress)(const_ptpmgmt_sk sk);
    bool (*isSelfAddressAbstract)(const_ptpmgmt_sk sk);
    bool (*setSelfAddress)(ptpmgmt_sk sk, const char *string);
    bool (*setSelfAddressAbstract)(ptpmgmt_sk sk, const char *string);
    bool (*setDefSelfAddress)(ptpmgmt_sk sk, const char *rootBase,
        const char *useDef);
    const char *(*getHomeDir)();
    bool (*sendTo)(const_ptpmgmt_sk sk, const void *msg, size_t len,
        const char *addrStr);
    bool (*sendToA)(const_ptpmgmt_sk sk, const void *msg, size_t len,
        const char *addrStr);
    ssize_t (*rcvFrom)(ptpmgmt_sk sk, void *buf, size_t bufSize, char *from,
        size_t *fromSize, bool block);
    ssize_t (*rcvFromA)(ptpmgmt_sk sk, void *buf, size_t bufSize, bool block);
    const char *(*getLastFrom)(const_ptpmgmt_sk sk);
    bool (*isLastFromAbstract)(const_ptpmgmt_sk sk);
    bool (*setIfUsingName)(ptpmgmt_sk sk, const char *ifName);
    bool (*setIfUsingIndex)(ptpmgmt_sk sk, int ifIndex);
    bool (*setIf)(ptpmgmt_sk sk, const_ptpmgmt_ifInfo ifObj);
    bool (*setAll)(ptpmgmt_sk sk, const_ptpmgmt_ifInfo ifObj,
        const_ptpmgmt_cfg cfg, const char *section);
    bool (*setAllInit)(ptpmgmt_sk sk, const_ptpmgmt_ifInfo ifObj,
        const_ptpmgmt_cfg cfg, const char *section);
    bool (*setUdpTtl)(ptpmgmt_sk sk, uint8_t udp_ttl);
    bool (*setUdpTtlCfg)(ptpmgmt_sk sk, const_ptpmgmt_cfg cfg,
        const char *section);
    bool (*setScope)(ptpmgmt_sk sk, uint8_t udp6_scope);
    bool (*setScopeCfg)(ptpmgmt_sk sk, const_ptpmgmt_cfg cfg,
        const char *section);
    bool (*setPtpDstMacStr)(ptpmgmt_sk sk, const char *string);
    bool (*setPtpDstMac)(ptpmgmt_sk sk, const void *ptp_dst_mac,
        size_t len);
    bool (*setPtpDstMacCfg)(ptpmgmt_sk sk, const_ptpmgmt_cfg cfg,
        const char *section);
    bool (*setSocketPriority)(ptpmgmt_sk sk, uint8_t socket_priority);
    bool (*setSocketPriorityCfg)(ptpmgmt_sk sk, const_ptpmgmt_cfg cfg,
        const char *section);
};
 
const char *ptpmgmt_sk_getHomeDir();
 
enum ptpmgmt_socket_class {
    ptpmgmt_SockUnix,
    ptpmgmt_SockIp4,
    ptpmgmt_SockIp6,
    ptpmgmt_SockRaw,
};
 
ptpmgmt_sk ptpmgmt_sk_alloc(enum ptpmgmt_socket_class type);
 
#ifdef __cplusplus
}
#endif
 
#endif /* __PTPMGMT_C_SOCK_H */