summaryrefslogtreecommitdiffstats
path: root/ospfclient/ospf_apiclient.h
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-09 13:16:35 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-09 13:16:35 +0000
commite2bbf175a2184bd76f6c54ccf8456babeb1a46fc (patch)
treef0b76550d6e6f500ada964a3a4ee933a45e5a6f1 /ospfclient/ospf_apiclient.h
parentInitial commit. (diff)
downloadfrr-e2bbf175a2184bd76f6c54ccf8456babeb1a46fc.tar.xz
frr-e2bbf175a2184bd76f6c54ccf8456babeb1a46fc.zip
Adding upstream version 9.1.upstream/9.1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'ospfclient/ospf_apiclient.h')
-rw-r--r--ospfclient/ospf_apiclient.h89
1 files changed, 89 insertions, 0 deletions
diff --git a/ospfclient/ospf_apiclient.h b/ospfclient/ospf_apiclient.h
new file mode 100644
index 0000000..c90b1fb
--- /dev/null
+++ b/ospfclient/ospf_apiclient.h
@@ -0,0 +1,89 @@
+// SPDX-License-Identifier: GPL-2.0-or-later
+/*
+ * Client side of OSPF API.
+ * Copyright (C) 2001, 2002, 2003 Ralph Keller
+ */
+
+#ifndef _OSPF_APICLIENT_H
+#define _OSPF_APICLIENT_H
+
+/* Structure for the OSPF API client */
+struct ospf_apiclient {
+
+ /* Sockets for sync requests and async notifications */
+ int fd_sync;
+ int fd_async;
+
+ /* Pointer to callback functions */
+ void (*ready_notify)(uint8_t lsa_type, uint8_t opaque_type,
+ struct in_addr addr);
+ void (*new_if)(struct in_addr ifaddr, struct in_addr area_id);
+ void (*del_if)(struct in_addr ifaddr);
+ void (*ism_change)(struct in_addr ifaddr, struct in_addr area_id,
+ uint8_t status);
+ void (*nsm_change)(struct in_addr ifaddr, struct in_addr nbraddr,
+ struct in_addr router_id, uint8_t status);
+ void (*update_notify)(struct in_addr ifaddr, struct in_addr area_id,
+ uint8_t self_origin, struct lsa_header *lsa);
+ void (*delete_notify)(struct in_addr ifaddr, struct in_addr area_id,
+ uint8_t self_origin, struct lsa_header *lsa);
+};
+
+
+/* ---------------------------------------------------------
+ * API function prototypes.
+ * --------------------------------------------------------- */
+
+/* Open connection to OSPF daemon. Two ports will be allocated on
+ client, sync channel at syncport and reverse channel at syncport+1 */
+struct ospf_apiclient *ospf_apiclient_connect(char *host, int syncport);
+
+/* Shutdown connection to OSPF daemon. */
+int ospf_apiclient_close(struct ospf_apiclient *oclient);
+
+/* Synchronous request to register opaque type. */
+int ospf_apiclient_register_opaque_type(struct ospf_apiclient *oclient,
+ uint8_t ltype, uint8_t otype);
+
+/* Synchronous request to register event mask. */
+int ospf_apiclient_register_events(struct ospf_apiclient *oclient,
+ uint32_t mask);
+
+/* Register callback functions.*/
+void ospf_apiclient_register_callback(
+ struct ospf_apiclient *oclient,
+ void (*ready_notify)(uint8_t lsa_type, uint8_t opaque_type,
+ struct in_addr addr),
+ void (*new_if)(struct in_addr ifaddr, struct in_addr area_id),
+ void (*del_if)(struct in_addr ifaddr),
+ void (*ism_change)(struct in_addr ifaddr, struct in_addr area_id,
+ uint8_t status),
+ void (*nsm_change)(struct in_addr ifaddr, struct in_addr nbraddr,
+ struct in_addr router_id, uint8_t status),
+ void (*update_notify)(struct in_addr ifaddr, struct in_addr area_id,
+ uint8_t selforig, struct lsa_header *lsa),
+ void (*delete_notify)(struct in_addr ifaddr, struct in_addr area_id,
+ uint8_t selforig, struct lsa_header *lsa));
+
+/* Synchronous request to synchronize LSDB. */
+int ospf_apiclient_sync_lsdb(struct ospf_apiclient *oclient);
+
+/* Synchronous request to originate or update opaque LSA. */
+int ospf_apiclient_lsa_originate(struct ospf_apiclient *oclient,
+ struct in_addr ifaddr, struct in_addr area_id,
+ uint8_t lsa_type, uint8_t opaque_type,
+ uint32_t opaque_id, void *opaquedata,
+ int opaquelen);
+
+
+/* Synchronous request to delete opaque LSA. Parameter opaque_id is in
+ host byte order */
+int ospf_apiclient_lsa_delete(struct ospf_apiclient *oclient,
+ struct in_addr addr, uint8_t lsa_type,
+ uint8_t opaque_type, uint32_t opaque_id,
+ uint8_t flags);
+
+/* Fetch async message and handle it */
+int ospf_apiclient_handle_async(struct ospf_apiclient *oclient);
+
+#endif /* _OSPF_APICLIENT_H */