Struct dendrite_auth::dendrite::axon_server::control::platform_service_client::PlatformServiceClient

pub struct PlatformServiceClient<T> { /* private fields */ }

Service describing operations for connecting to the AxonServer platform.

Clients are expected to use this service on any of the Platform’s Admin nodes to obtain connection information of the node that it should set up the actual connection with. On that second node, the clients should open an instruction stream (see OpenStream), so that AxonServer and the client application can exchange information and instructions.

Implementations

impl PlatformServiceClient<Channel>

pub async fn connect<D>(dst: D) -> Result<PlatformServiceClient<Channel>, Error>

where D: TryInto<Endpoint>, <D as TryInto<Endpoint>>::Error: Into<Box<dyn Error + Sync + Send>>,

Attempt to create a new client by connecting to a given endpoint.

impl<T> PlatformServiceClient<T>

where T: GrpcService<UnsyncBoxBody<Bytes, Status>>, <T as GrpcService<UnsyncBoxBody<Bytes, Status>>>::Error: Into<Box<dyn Error + Sync + Send>>, <T as GrpcService<UnsyncBoxBody<Bytes, Status>>>::ResponseBody: Body<Data = Bytes> + Send + 'static, <<T as GrpcService<UnsyncBoxBody<Bytes, Status>>>::ResponseBody as Body>::Error: Into<Box<dyn Error + Sync + Send>> + Send,

pub fn new(inner: T) -> PlatformServiceClient<T>

pub fn with_origin(inner: T, origin: Uri) -> PlatformServiceClient<T>

pub fn with_interceptor<F>( inner: T, interceptor: F ) -> PlatformServiceClient<InterceptedService<T, F>>

where F: Interceptor, <T as GrpcService<UnsyncBoxBody<Bytes, Status>>>::ResponseBody: Default, T: Service<Request<UnsyncBoxBody<Bytes, Status>>, Response = Response<<T as GrpcService<UnsyncBoxBody<Bytes, Status>>>::ResponseBody>>, <T as Service<Request<UnsyncBoxBody<Bytes, Status>>>>::Error: Into<Box<dyn Error + Sync + Send>> + Send + Sync,

pub fn send_compressed( self, encoding: CompressionEncoding ) -> PlatformServiceClient<T>

Compress requests with the given encoding.

This requires the server to support it otherwise it might respond with an error.

pub fn accept_compressed( self, encoding: CompressionEncoding ) -> PlatformServiceClient<T>

Enable decompressing responses.

pub fn max_decoding_message_size(self, limit: usize) -> PlatformServiceClient<T>

Limits the maximum size of a decoded message.

Default: 4MB

pub fn max_encoding_message_size(self, limit: usize) -> PlatformServiceClient<T>

Limits the maximum size of an encoded message.

Default: usize::MAX

pub async fn get_platform_server( &mut self, request: impl IntoRequest<ClientIdentification> ) -> Result<Response<PlatformInfo>, Status>

Obtains connection information for the Server that a Client should use for its connections.

pub async fn open_stream( &mut self, request: impl IntoStreamingRequest<Message = PlatformInboundInstruction> ) -> Result<Response<Streaming<PlatformOutboundInstruction>>, Status>

Opens an instruction stream to the Platform, allowing AxonServer to provide management instructions to the application

Trait Implementations

impl<T> Clone for PlatformServiceClient<T>

where T: Clone,

fn clone(&self) -> PlatformServiceClient<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Debug for PlatformServiceClient<T>

where T: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.