module tutorial.engines.template_minimum_messages;

import prelude open;

Template Minimum Messages¶

These are the messages that the Template Minimum engine can receive/respond to.

Message interface¶

type TemplateMinimumMsg :=
  | TemplateMinimumMsgJustHi
  | TemplateMinimumMsgExampleRequest ExampleRequest
  | TemplateMinimumMsgExampleReply ExampleReply;

Message sequence diagrams¶

ExampleRequest and ExampleReply¶

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed ut purus eget sapien. Nulla facilisi.

sequenceDiagram
    participant TemplateMinimumClient
    participant TemplateMinimum

    TemplateMinimumClient ->> TemplateMinimum: ExampleRequest
    TemplateMinimum ->> TemplateMinimumClient: ExampleReplyOk

    TemplateMinimumClient ->> TemplateMinimum: ExampleRequest
    TemplateMinimum ->> TemplateMinimumClient: ExampleReplyErrorOne

Message types¶

TemplateMinimumMsgJustHi¶

Lorem ipsum dolor sit amet, consectetur adipiscing elit.

ExampleRequest¶

Example request.

type ExampleRequest :=
  mkExampleRequest@{
    argOne : Nat;
    argTwo : Nat;
  };

ExampleReply¶

type ReplyPayload :=
  mkReplyPayload@{
    payload : String;
  };

type ReplyError :=
  mkReplyError@{
    error : String;
  };

ExampleReply : Type := Result ReplyError ReplyPayload;

TemplateMinimumMsg¶

type TemplateMinimumMsg :=
  | TemplateMinimumMsgJustHi
  | TemplateMinimumMsgExampleRequest ExampleRequest
  | TemplateMinimumMsgExampleReply ExampleReply;

Engine components¶

• Template Minimum Configuration
• Template Minimum Environment
• Template Minimum Behaviour