service.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_NET_TEST_SERVICE_H__
#define __MOTR_NET_TEST_SERVICE_H__

#include "lib/time.h"                   /* m0_time_t */
#include "lib/thread.h"                 /* m0_thread */

#include "net/test/commands.h"          /* m0_net_test_cmd_ctx */

struct m0_net_test_service;

struct m0_net_test_service_cmd_handler {
        enum m0_net_test_cmd_type ntsch_type;
        int (*ntsch_handler)(void *ctx,
                             const struct m0_net_test_cmd *cmd,
                             struct m0_net_test_cmd *reply);
};

enum m0_net_test_service_state {
        M0_NET_TEST_SERVICE_UNINITIALIZED = 0,
        M0_NET_TEST_SERVICE_READY,
        M0_NET_TEST_SERVICE_FINISHED,
        M0_NET_TEST_SERVICE_FAILED,
        M0_NET_TEST_SERVICE_NR
};

struct m0_net_test_service_ops {
        void *(*ntso_init)(struct m0_net_test_service *svc);
        void (*ntso_fini)(void *ctx);
        int  (*ntso_step)(void *ctx);
        struct m0_net_test_service_cmd_handler *ntso_cmd_handler;
        size_t                                  ntso_cmd_handler_nr;
};

struct m0_net_test_service {
        void                           *nts_svc_ctx;
        struct m0_net_test_service_ops *nts_ops;
        enum m0_net_test_service_state  nts_state;
        int                             nts_errno;
};

int m0_net_test_service_init(struct m0_net_test_service *svc,
                             struct m0_net_test_service_ops *ops);

void m0_net_test_service_fini(struct m0_net_test_service *svc);

bool m0_net_test_service_invariant(struct m0_net_test_service *svc);

int m0_net_test_service_step(struct m0_net_test_service *svc);

int m0_net_test_service_cmd_handle(struct m0_net_test_service *svc,
                                   struct m0_net_test_cmd *cmd,
                                   struct m0_net_test_cmd *reply);

void m0_net_test_service_state_change(struct m0_net_test_service *svc,
                                      enum m0_net_test_service_state state);

enum m0_net_test_service_state
m0_net_test_service_state_get(struct m0_net_test_service *svc);

#endif /*  __MOTR_NET_TEST_SERVICE_H__ */

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