ismp 2512.1.0

Rust implementation of the interoperable state machine protocol
Documentation 
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

// Copyright (C) Polytope Labs Ltd.
// SPDX-License-Identifier: Apache-2.0

// 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.

//! ISMPModule definition

use crate::{
	events::Event,
	router::{GetResponse, PostRequest, Request},
	Error,
};
use sp_weights::Weight;
/// A type alias for dispatch results
pub type DispatchResult = Result<Event, anyhow::Error>;

/// Individual modules which live on a state machine must conform to this interface in order to send
/// and receive ISMP requests and responses
pub trait IsmpModule {
	/// Called by the message handler on a module, to notify module of a new POST request
	/// the module may choose to respond immediately, or in a later block
	fn on_accept(&self, _request: PostRequest) -> Result<Weight, anyhow::Error> {
		Err(Error::CannotHandleMessage)?
	}

	/// Called by the message handler on a module, to notify module of a response to a previously
	/// sent out request
	fn on_response(&self, _response: GetResponse) -> Result<Weight, anyhow::Error> {
		Err(Error::CannotHandleMessage)?
	}

	/// Called by the message handler on a module, to notify module of requests that were previously
	/// sent but have now timed-out
	fn on_timeout(&self, _request: Request) -> Result<Weight, anyhow::Error> {
		Err(Error::CannotHandleMessage)?
	}
}