packet_internal.h

Go to the documentation of this file.

/* -*- C -*- */
/*
 * Copyright (c) 2012-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_PACKET_INT_H__
#define __MOTR_RPC_PACKET_INT_H__

#include "lib/vec.h"
#include "lib/tlist.h"
#include "rpc/onwire.h"

/* Imports */
struct m0_rpc_item;
struct m0_rpc_frm;

struct m0_rpc_packet {

        struct m0_rpc_packet_onwire_header rp_ow;

        m0_bcount_t                        rp_size;

        struct m0_tl                       rp_items;

        int                                rp_status;

        struct m0_rpc_frm                 *rp_frm;

        struct m0_rpc_machine             *rp_rmachine;
};

M0_INTERNAL m0_bcount_t m0_rpc_packet_onwire_header_size(void);
M0_INTERNAL m0_bcount_t m0_rpc_packet_onwire_footer_size(void);

M0_TL_DESCR_DECLARE(packet_item, M0_EXTERN);
M0_TL_DECLARE(packet_item, M0_INTERNAL, struct m0_rpc_item);

#define for_each_item_in_packet(item, packet) \
        m0_tl_for(packet_item, &packet->rp_items, item)

#define end_for_each_item_in_packet m0_tl_endfor

M0_INTERNAL bool m0_rpc_packet_invariant(const struct m0_rpc_packet *packet);
M0_INTERNAL void m0_rpc_packet_init(struct m0_rpc_packet *packet,
                                    struct m0_rpc_machine *rmach);
M0_INTERNAL void m0_rpc_packet_fini(struct m0_rpc_packet *packet);

M0_INTERNAL void m0_rpc_packet_discard(struct m0_rpc_packet *packet);

M0_INTERNAL void m0_rpc_packet_add_item(struct m0_rpc_packet *packet,
                                        struct m0_rpc_item *item);

M0_INTERNAL void m0_rpc_packet_remove_item(struct m0_rpc_packet *packet,
                                           struct m0_rpc_item *item);

M0_INTERNAL void m0_rpc_packet_remove_all_items(struct m0_rpc_packet *packet);

M0_INTERNAL bool m0_rpc_packet_is_empty(const struct m0_rpc_packet *packet);

M0_INTERNAL bool m0_rpc_packet_is_carrying_item(const struct m0_rpc_packet
                                                *packet,
                                                const struct m0_rpc_item *item);

M0_INTERNAL int m0_rpc_packet_encode(struct m0_rpc_packet *packet,
                                     struct m0_bufvec *bufvec);

M0_INTERNAL int m0_rpc_packet_encode_using_cursor(struct m0_rpc_packet *packet,
                                                  struct m0_bufvec_cursor
                                                  *cursor);

M0_INTERNAL int m0_rpc_packet_decode(struct m0_rpc_packet *packet,
                                     struct m0_bufvec *bufvec,
                                     m0_bindex_t off, m0_bcount_t len);

M0_INTERNAL int m0_rpc_packet_decode_using_cursor(struct m0_rpc_packet *packet,
                                                  struct m0_bufvec_cursor
                                                  *cursor, m0_bcount_t len);

typedef void item_visit_fn(struct m0_rpc_packet *packet,
                           struct m0_rpc_item *item, int data);

M0_INTERNAL void m0_rpc_packet_traverse_items(struct m0_rpc_packet *p,
                                              item_visit_fn * visit,
                                              int opaque_data);

#endif /* __MOTR_RPC_PACKET_INT_H__ */

/*
 *  Local variables:
 *  c-indentation-style: "K&R"
 *  c-basic-offset: 8
 *  tab-width: 8
 *  fill-column: 80
 *  scroll-step: 1
 *  End:
 */