item_source.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 2013-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_RPC_ITEM_SOURCE_H__
#define __MOTR_RPC_ITEM_SOURCE_H__


struct m0_rpc_item_source;
struct m0_rpc_item_source_ops;

struct m0_rpc_item_source {
        uint64_t                             ris_magic;
        const char                          *ris_name;
        const struct m0_rpc_item_source_ops *ris_ops;
        struct m0_rpc_conn                  *ris_conn;
        struct m0_tlink                      ris_tlink;
};

struct m0_rpc_item_source_ops {
        bool (*riso_has_item)(const struct m0_rpc_item_source *ris);

        struct m0_rpc_item *(*riso_get_item)(struct m0_rpc_item_source *ris,
                                             m0_bcount_t max_payload_size);

        void (*riso_conn_terminating)(struct m0_rpc_item_source *ris);
};

void m0_rpc_item_source_init(struct m0_rpc_item_source *ris,
                             const char *name,
                             const struct m0_rpc_item_source_ops *ops);

bool m0_rpc_item_source_is_registered(const struct m0_rpc_item_source *ris);

void m0_rpc_item_source_fini(struct m0_rpc_item_source *ris);

void m0_rpc_item_source_register(struct m0_rpc_conn *conn,
                                struct m0_rpc_item_source *ris);

void m0_rpc_item_source_register_locked(struct m0_rpc_conn *conn,
                                        struct m0_rpc_item_source *ris);

void m0_rpc_item_source_deregister(struct m0_rpc_item_source *ris);

#endif /* __MOTR_RPC_ITEM_SOURCE_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
 */