mirror of
https://github.com/clusterio/clusterio.git
synced 2026-11-22 08:13:12 +09:00
Rename MessageSrcDst to MessageRoutable
This commit is contained in:
1 parent
d088219d8d
commit
94fbb8a92f
5 files changed
+18
-21
No files matched your search
@@ -21,7 +21,7 @@ export default class ControllerRouter {
|
|||||||
*/
|
*/
|
||||||
forwardMessage(
|
forwardMessage(
|
||||||
origin: ControlConnection | HostConnection,
|
origin: ControlConnection | HostConnection,
|
||||||
message: lib.MessageSrcDst,
|
message: lib.MessageRoutable,
|
||||||
hasFallback: boolean
|
hasFallback: boolean
|
||||||
): boolean {
|
): boolean {
|
||||||
if (!["request", "response", "responseError", "event"].includes(message.type)) {
|
if (!["request", "response", "responseError", "event"].includes(message.type)) {
|
||||||
@@ -95,7 +95,7 @@ export default class ControllerRouter {
|
|||||||
|
|
||||||
broadcastMessage(
|
broadcastMessage(
|
||||||
origin: lib.Link,
|
origin: lib.Link,
|
||||||
message: lib.MessageSrcDst,
|
message: lib.MessageRoutable,
|
||||||
) {
|
) {
|
||||||
let dst = message.dst;
|
let dst = message.dst;
|
||||||
if (message.type !== "event") {
|
if (message.type !== "event") {
|
||||||
@@ -118,7 +118,7 @@ export default class ControllerRouter {
|
|||||||
}
|
}
|
||||||
|
|
||||||
warnUnrouted(
|
warnUnrouted(
|
||||||
message: lib.MessageSrcDst,
|
message: lib.MessageRoutable,
|
||||||
msg: string
|
msg: string
|
||||||
) {
|
) {
|
||||||
let dst = message.dst;
|
let dst = message.dst;
|
||||||
|
|||||||
@@ -84,7 +84,7 @@ export default class HostConnection extends BaseConnection {
|
|||||||
this.handle(lib.InstancePlayerUpdateEvent, this.handleInstancePlayerUpdateEvent.bind(this));
|
this.handle(lib.InstancePlayerUpdateEvent, this.handleInstancePlayerUpdateEvent.bind(this));
|
||||||
}
|
}
|
||||||
|
|
||||||
validateIngress(message: lib.MessageSrcDst) {
|
validateIngress(message: lib.MessageRoutable) {
|
||||||
let origin = this.connector.dst;
|
let origin = this.connector.dst;
|
||||||
switch (message.src.type) {
|
switch (message.src.type) {
|
||||||
case lib.Address.control:
|
case lib.Address.control:
|
||||||
|
|||||||
@@ -172,7 +172,7 @@ export class Message {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
export type MessageSrcDst = MessageRequest | MessageResponse | MessageResponseError | MessageEvent;
|
export type MessageRoutable = MessageRequest | MessageResponse | MessageResponseError | MessageEvent;
|
||||||
|
|
||||||
export class HelloData {
|
export class HelloData {
|
||||||
constructor(
|
constructor(
|
||||||
|
|||||||
@@ -81,12 +81,6 @@ export abstract class BaseConnector extends events.EventEmitter {
|
|||||||
}
|
}
|
||||||
|
|
||||||
type ConnectorState = "closed" | "connecting" | "connected" | "resuming";
|
type ConnectorState = "closed" | "connecting" | "connected" | "resuming";
|
||||||
type ReliableMessages =
|
|
||||||
| libData.MessageRequest
|
|
||||||
| libData.MessageResponse
|
|
||||||
| libData.MessageResponseError
|
|
||||||
| libData.MessageEvent
|
|
||||||
;
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Base connector for links
|
* Base connector for links
|
||||||
@@ -102,7 +96,7 @@ export abstract class WebSocketBaseConnector extends BaseConnector {
|
|||||||
_heartbeatId: ReturnType<typeof setInterval> | null = null;
|
_heartbeatId: ReturnType<typeof setInterval> | null = null;
|
||||||
_heartbeatInterval: number | null = null;
|
_heartbeatInterval: number | null = null;
|
||||||
_lastReceivedSeq = undefined;
|
_lastReceivedSeq = undefined;
|
||||||
_sendBuffer: (ReliableMessages)[] = [];
|
_sendBuffer: (libData.MessageRoutable)[] = [];
|
||||||
|
|
||||||
constructor(src: libData.Address, dst: libData.Address) {
|
constructor(src: libData.Address, dst: libData.Address) {
|
||||||
super(src, dst);
|
super(src, dst);
|
||||||
@@ -249,7 +243,7 @@ export abstract class WebSocketBaseConnector extends BaseConnector {
|
|||||||
*
|
*
|
||||||
* @param message - Message to send.
|
* @param message - Message to send.
|
||||||
*/
|
*/
|
||||||
send(message: ReliableMessages) {
|
send(message: libData.MessageRoutable) {
|
||||||
if (!["connected", "resuming"].includes(this._state)) {
|
if (!["connected", "resuming"].includes(this._state)) {
|
||||||
throw new libErrors.SessionLost("No session");
|
throw new libErrors.SessionLost("No session");
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ import { BaseConnector, WebSocketBaseConnector } from "./connectors";
|
|||||||
import { strict as assert } from "assert";
|
import { strict as assert } from "assert";
|
||||||
import type { PluginInfo } from "../plugin";
|
import type { PluginInfo } from "../plugin";
|
||||||
import type { User } from "../users";
|
import type { User } from "../users";
|
||||||
import type { AddressType, JSONDeserialisable, Message, MessageRequest, MessageEvent } from "../data";
|
import type { AddressType, JSONDeserialisable, MessageRoutable, MessageRequest, MessageEvent } from "../data";
|
||||||
|
|
||||||
export interface Request<Req, Res> {
|
export interface Request<Req, Res> {
|
||||||
constructor: Partial<JSONDeserialisable<Request<Req, Res>>> & {
|
constructor: Partial<JSONDeserialisable<Request<Req, Res>>> & {
|
||||||
@@ -71,7 +71,7 @@ export type RequestHandler<Req, Res> = (request: Req, src: libData.Address, dst:
|
|||||||
export type EventHandler<T> = (event: T, src: libData.Address, dst: libData.Address) => Promise<void>;
|
export type EventHandler<T> = (event: T, src: libData.Address, dst: libData.Address) => Promise<void>;
|
||||||
|
|
||||||
interface Router {
|
interface Router {
|
||||||
forwardMessage(origin: Link, message: Message, fallback: boolean): boolean,
|
forwardMessage(origin: Link, message: MessageRoutable, fallback: boolean): boolean,
|
||||||
}
|
}
|
||||||
|
|
||||||
// Some definitions for the terminology used here:
|
// Some definitions for the terminology used here:
|
||||||
@@ -166,7 +166,7 @@ export class Link {
|
|||||||
* @throws {libErrors.InvalidMessage} if the message is invalid or not handled.
|
* @throws {libErrors.InvalidMessage} if the message is invalid or not handled.
|
||||||
*/
|
*/
|
||||||
_processMessage(
|
_processMessage(
|
||||||
message: libData.MessageRequest | libData.MessageResponse | libData.MessageResponseError | libData.MessageEvent
|
message: MessageRoutable
|
||||||
) {
|
) {
|
||||||
if (!["request", "response", "responseError", "event"].includes(message.type)) {
|
if (!["request", "response", "responseError", "event"].includes(message.type)) {
|
||||||
throw new libErrors.InvalidMessage(`Unhandled message type ${message.type}`);
|
throw new libErrors.InvalidMessage(`Unhandled message type ${message.type}`);
|
||||||
@@ -175,7 +175,10 @@ export class Link {
|
|||||||
let entry = this._validateMessage(message);
|
let entry = this._validateMessage(message);
|
||||||
if (entry && this.connector.dst.type === libData.Address.control) {
|
if (entry && this.connector.dst.type === libData.Address.control) {
|
||||||
try {
|
try {
|
||||||
this.validatePermission(message, entry); // Somewhat hacky, defined in ControlConnection
|
this.validatePermission(
|
||||||
|
message as libData.MessageRequest | libData.MessageEvent,
|
||||||
|
entry
|
||||||
|
); // Somewhat hacky, defined in ControlConnection
|
||||||
} catch (err) {
|
} catch (err) {
|
||||||
if (err instanceof libErrors.PermissionError) {
|
if (err instanceof libErrors.PermissionError) {
|
||||||
return;
|
return;
|
||||||
@@ -229,10 +232,10 @@ export class Link {
|
|||||||
* @param message - Message to check.
|
* @param message - Message to check.
|
||||||
* @throws {libErrors.InvalidMessage} if the message is invalid.
|
* @throws {libErrors.InvalidMessage} if the message is invalid.
|
||||||
*/
|
*/
|
||||||
validateIngress(message: libData.Message) { }
|
validateIngress(message: MessageRoutable) { }
|
||||||
|
|
||||||
_validateMessage(
|
_validateMessage(
|
||||||
message: libData.MessageRequest | libData.MessageResponse | libData.MessageResponseError | libData.MessageEvent
|
message: MessageRoutable
|
||||||
) {
|
) {
|
||||||
try {
|
try {
|
||||||
if (message.src.type === libData.Address.broadcast) {
|
if (message.src.type === libData.Address.broadcast) {
|
||||||
@@ -307,9 +310,9 @@ export class Link {
|
|||||||
* @param entry - Request or Event entry for this Message.
|
* @param entry - Request or Event entry for this Message.
|
||||||
* @throws {libErrors.PermissionError} if unauthorized.
|
* @throws {libErrors.PermissionError} if unauthorized.
|
||||||
*/
|
*/
|
||||||
validatePermission(message: libData.Message, entry: RequestEntry | EventEntry) { }
|
validatePermission(message: libData.MessageRequest | libData.MessageEvent, entry: RequestEntry | EventEntry) { }
|
||||||
|
|
||||||
_routeMessage(message: libData.Message, entry?: RequestEntry | EventEntry) {
|
_routeMessage(message: MessageRoutable, entry?: RequestEntry | EventEntry) {
|
||||||
if (!this.router) {
|
if (!this.router) {
|
||||||
let err = new libErrors.InvalidMessage(
|
let err = new libErrors.InvalidMessage(
|
||||||
`Received message addressed to ${(message as libData.MessageRequest).dst} but this link `+
|
`Received message addressed to ${(message as libData.MessageRequest).dst} but this link `+
|
||||||
|
|||||||
Reference in new issue
Block a user