1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
//! Client Library: Client Functions, Structs, Traits
/// gRPC object traits to provide wrappers for grpc functions
#[tonic::async_trait]
pub trait Client<T>
where
Self: Sized + lib_common::grpc::Client<T> + lib_common::grpc::ClientConnect<T>,
T: Send + Clone,
{
/// The type expected for ReadyRequest structs.
type ReadyRequest;
/// The type expected for ReadyResponse structs.
type ReadyResponse;
/// Returns a [`tonic::Response`] containing a [`ReadyResponse`](Self::ReadyResponse)
/// Takes an [`ReadyRequest`](Self::ReadyRequest).
///
/// # Errors
///
/// Returns [`tonic::Status`] with [`tonic::Code::Unknown`] if the server is not ready.
///
/// # Examples
/// ```
/// use lib_common::grpc::get_endpoint_from_env;
/// use scheduler::{ReadyRequest, SchedulerClient};
/// use svc_scheduler_client_grpc::prelude::*;
///
/// async fn example () -> Result<(), Box<dyn std::error::Error>> {
/// let (host, port) = get_endpoint_from_env("SERVER_HOSTNAME", "SERVER_PORT_GRPC");
/// let connection = SchedulerClient::new_client(&host, port, "scheduler");
/// let response = connection
/// .is_ready(ReadyRequest {})
/// .await?;
/// println!("RESPONSE={:?}", response.into_inner());
/// Ok(())
/// }
/// ```
async fn is_ready(
&self,
request: Self::ReadyRequest,
) -> Result<tonic::Response<Self::ReadyResponse>, tonic::Status>;
/// wrapper
async fn query_flight(
&self,
request: super::QueryFlightRequest,
) -> Result<tonic::Response<super::QueryFlightResponse>, tonic::Status>;
/// wrapper
async fn create_itinerary(
&self,
request: super::CreateItineraryRequest,
) -> Result<tonic::Response<super::TaskResponse>, tonic::Status>;
/// wrapper
async fn cancel_itinerary(
&self,
request: super::CancelItineraryRequest,
) -> Result<tonic::Response<super::TaskResponse>, tonic::Status>;
/// wrapper
async fn cancel_task(
&self,
request: super::TaskRequest,
) -> Result<tonic::Response<super::TaskResponse>, tonic::Status>;
/// wrapper
async fn get_task_status(
&self,
request: super::TaskRequest,
) -> Result<tonic::Response<super::TaskResponse>, tonic::Status>;
}