Here is the quickstart of our Typescript Orchestra toolkit.
You can visit the npmjs package page : https://www.npmjs.com/package/@ledr/orchestra-toolkit
Open a terminal and run the command:
> npm i @ledr/orchestra-toolkit
The session will setup a socket pool, encode/decode Frames and values manage log. You can use it seamlessly in nodejs or browser environements.
import { Session } from "../build/index";
const Orchestra = new Session({
host: "localhost",
port: 20057,
auth: new Avial.values.V_Authorization("00000000-0000-0000-0000-000000000001"),
sockets: 4,
logs: true,
ca_paths: ["server-cert.pem"], // only needed for nodejs environnement
});
Then, you can execute a call
const requestFrame = new Avial.Frame({
command: "INVOKE",
method: "RETRIEVE",
entity: "<1>",
})
// execute a call
const responseFrame = await Orchestra.call(requestFrame)
// check if response is an error (TS will desambiguish Error|Frame after .isError() call on response)
if (responseFrame.isError()) {
console.log(responseFrame.constructor) // Error
return
}
// only then you can access to full response frame
console.log(responseFrame.constructor) // Frame
// and access frame fields such as value
console.log(responseFrame.value); // V_Value
You can define a global auth that will be used for each calls.
Global auth can be override into the call itself if you want use another auth.
const Orchestra = new Session({
host: "localhost",
port: 20057,
auth: new Avial.values.V_Authorization("00000000-0000-0000-0000-000000000001"),
sockets: 4,
logs: true,
ca_paths: ["server-cert.pem"], // only needed for nodejs environnement
});
const requestFrame1 = new Avial.Frame({
command: "INVOKE",
method: "RETRIEVE",
entity: "<1>",
// no auth provided, global session's auth will be used
})
const requestFrame2 = new Avial.Frame({
command: "INVOKE",
method: "RETRIEVE",
entity: "<1>",
authorisation: "00000000-0000-0000-0000-000000000002" // override global session's auth for this call,
})
// requestFrame1 will be executed with Session's auth 0x1
// requestFrame2 will override global session's auth and will be executed with 0x2
Every calls will take as argument a Frame, and return [Error|Frame]
Here is a call with a Frame instance:
const responseFrame = await Orchestra.call(
new Avial.Frame({
command: "INVOKE",
method: "RETRIEVE",
entity: "<1>",
})
)
You can shorthand by providing Frame like anonym object, in this case object will be later be converted as Frame by the session before encode and send procedures.
const responseFrame = await Orchestra.call({
command: "INVOKE",
method: "RETRIEVE",
entity: "<1>",
})
If enabled, Logs will output as :
I|2024-12-20 15:24:29.32 [0] send COMMAND INVOKE METHOD RETRIEVE ENTITY <0|0|1>
S|2024-12-20 15:24:29.34 [0] recv TAG INTERCHANGE EXTENSION 1603 VALUE {"Name":"AvesTerra Registry","Key":"AvesTerra","Properties":[["<AvesTerra Server>","<AvesTerra>",{"ENTITY":"<0|0|100036>"}],["AvesTerra Registry","Ave... (1503 more chars)
You can redirect logs anywhere you want by providing a log callback argument to the session
And you can use onRequest to track request's evolutions, as mutable object that will emit 'changed' event at each step of its lifecycle [init | socket ack | sending | receiving] and timer info wait, send, recv).
const Orchestra = new Session({
host: "localhost",
port: 20057,
auth: new Avial.values.V_Authorization("00000000-0000-0000-0000-000000000001"),
sockets: 4,
logs: true,
log: (log) => {
console.log(log.msg)
},
onRequest: (requestLog: RequestLog) => {
requestLog.on('changed', async () => {
const {
socketId, // undefined | int
req, // undefined | Frame
res, // undefined | Frame | Error
time
} = requestLog;
const {
wait, // milliseconds call waiting free socket
send, // milliseconds for sending
recv // milliseconds to receive the whole response
} = time;
})
},
});
You can send and receive V_Values such as :
Just by passing them as call value. It will be automatically serialised and encoded before sending, and decoded as well at reception.
import Avial, { Session } from "../build/index";
const responseFrame = await Orchestra.call({
command: "INVOKE",
method: "RETRIEVE",
entity: "<1>",
value: new Avial.values.V_String("Hello world"),
})