interface.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 2016-2020 Seagate Technology LLC and/or its Affiliates
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * For any questions about this software or licensing,
 * please email opensource@seagate.com or cortx-questions@seagate.com.
 *
 */


#pragma once

#ifndef __MOTR_HA_HALON_INTERFACE_H__
#define __MOTR_HA_HALON_INTERFACE_H__

#include "lib/types.h"          /* bool */

struct m0_rpc_machine;
struct m0_reqh;
struct m0_halon_interface_internal;
struct m0_ha_link;
struct m0_ha_msg;
struct m0_fid;
struct m0_spiel;
struct m0_thread;

struct m0_halon_interface {
        struct m0_halon_interface_internal *hif_internal;
};

int m0_halon_interface_init(struct m0_halon_interface **hi_out,
                            const char                 *build_git_rev_id,
                            const char                 *build_configure_opts,
                            const char                 *debug_options,
                            const char                 *node_uuid);

void m0_halon_interface_fini(struct m0_halon_interface *hi);

int m0_halon_interface_start(struct m0_halon_interface *hi,
                             const char                *local_rpc_endpoint,
                             const struct m0_fid       *process_fid,
                             const struct m0_fid       *ha_service_fid,
                             const struct m0_fid       *rm_service_fid,
                             void                     (*entrypoint_request_cb)
                                (struct m0_halon_interface         *hi,
                                 const struct m0_uint128           *req_id,
                                 const char             *remote_rpc_endpoint,
                                 const struct m0_fid    *process_fid,
                                 const char             *git_rev_id,
                                 uint64_t                pid,
                                 bool                    first_request),
                             void                     (*msg_received_cb)
                                (struct m0_halon_interface *hi,
                                 struct m0_ha_link         *hl,
                                 const struct m0_ha_msg    *msg,
                                 uint64_t                   tag),
                             void                     (*msg_is_delivered_cb)
                                (struct m0_halon_interface *hi,
                                 struct m0_ha_link         *hl,
                                 uint64_t                   tag),
                             void                     (*msg_is_not_delivered_cb)
                                (struct m0_halon_interface *hi,
                                 struct m0_ha_link         *hl,
                                 uint64_t                   tag),
                             void                    (*link_connected_cb)
                                (struct m0_halon_interface *hi,
                                 const struct m0_uint128   *req_id,
                                 struct m0_ha_link         *link),
                             void                    (*link_reused_cb)
                                (struct m0_halon_interface *hi,
                                 const struct m0_uint128   *req_id,
                                 struct m0_ha_link         *link),
                             void                    (*link_absent_cb)
                                (struct m0_halon_interface *hi,
                                 const struct m0_uint128   *req_id),
                             void                    (*link_is_disconnecting_cb)
                                (struct m0_halon_interface *hi,
                                 struct m0_ha_link         *link),
                             void                     (*link_disconnected_cb)
                                (struct m0_halon_interface *hi,
                                 struct m0_ha_link         *link));

void m0_halon_interface_stop(struct m0_halon_interface *hi);

void m0_halon_interface_entrypoint_reply(
                struct m0_halon_interface  *hi,
                const struct m0_uint128    *req_id,
                int                         rc,
                uint32_t                    confd_nr,
                const struct m0_fid        *confd_fid_data,
                const char                **confd_eps_data,
                uint32_t                    confd_quorum,
                const struct m0_fid        *rm_fid,
                const char                 *rm_eps);

void m0_halon_interface_send(struct m0_halon_interface *hi,
                             struct m0_ha_link         *hl,
                             const struct m0_ha_msg    *msg,
                             uint64_t                  *tag);

void m0_halon_interface_delivered(struct m0_halon_interface *hi,
                                  struct m0_ha_link         *hl,
                                  const struct m0_ha_msg    *msg);


void m0_halon_interface_disconnect(struct m0_halon_interface *hi,
                                   struct m0_ha_link         *hl);

struct m0_rpc_machine *
m0_halon_interface_rpc_machine(struct m0_halon_interface *hi);

struct m0_reqh *m0_halon_interface_reqh(struct m0_halon_interface *hi);

struct m0_spiel *m0_halon_interface_spiel(struct m0_halon_interface *hi);

M0_INTERNAL int m0_halon_interface_thread_adopt(struct m0_halon_interface *hi,
                                                struct m0_thread *thread);
M0_INTERNAL void m0_halon_interface_thread_shun(void);

#endif /* __MOTR_HA_HALON_INTERFACE_H__ */

/*
 *  Local variables:
 *  c-indentation-style: "K&R"
 *  c-basic-offset: 8
 *  tab-width: 8
 *  fill-column: 80
 *  scroll-step: 1
 *  End:
 */
/*
 * vim: tabstop=8 shiftwidth=8 noexpandtab textwidth=80 nowrap
 */