smartuniverse/ts/smartuniverse.classes.universemessage.ts

109 lines
3.2 KiB
TypeScript
Raw Permalink Normal View History

2018-03-13 05:15:40 +00:00
import * as plugins from './smartuniverse.plugins';
2019-04-11 16:50:43 +00:00
import * as interfaces from './interfaces';
2018-03-13 05:15:40 +00:00
2019-01-31 01:52:18 +00:00
import { Objectmap } from '@pushrocks/lik';
2019-01-31 01:52:18 +00:00
import { Timer, TimeStamp } from '@pushrocks/smarttime';
2018-05-23 22:14:57 +00:00
import { Universe } from './smartuniverse.classes.universe';
import { UniverseChannel } from './smartuniverse.classes.universechannel';
import { UniverseCache } from './smartuniverse.classes.universecache';
2019-08-13 13:48:20 +00:00
import { SocketConnection } from '@pushrocks/smartsocket';
2018-03-13 05:15:40 +00:00
2018-04-13 13:45:48 +00:00
/**
* represents a message within a universe
* acts as a container to save message states like authentication status
2018-04-13 13:45:48 +00:00
*/
2019-04-11 16:50:43 +00:00
export class UniverseMessage implements interfaces.IUniverseMessage {
2019-09-01 15:04:25 +00:00
public static createMessageFromPayload(
socketConnectionArg: SocketConnection,
dataArg: interfaces.IUniverseMessage
) {
2019-08-13 13:48:20 +00:00
const universeMessageInstance = new UniverseMessage(dataArg);
universeMessageInstance.socketConnection = socketConnectionArg;
return universeMessageInstance;
2019-08-12 12:59:37 +00:00
}
2019-04-22 07:58:36 +00:00
public id: string;
public timestamp: number;
public smartTimestamp: TimeStamp;
public messageText: string;
public passphrase: string;
public payload: any;
public payloadStringType;
public targetChannelName: string;
2019-08-13 13:48:20 +00:00
public socketConnection: SocketConnection;
2018-05-07 16:50:07 +00:00
/**
* the UniverseCache the message is attached to
2018-05-07 16:50:07 +00:00
*/
public universeCache: UniverseCache;
2018-05-19 22:41:59 +00:00
/**
* enables unprotected grouping of messages for efficiency purposes.
*/
public universeChannelList = new Objectmap<UniverseChannel>();
/**
* wether the message is authenticated
*/
2019-08-12 13:12:31 +00:00
public authenticated: boolean = false;
2019-04-22 22:28:57 +00:00
2018-05-19 22:41:59 +00:00
/**
2019-04-22 07:58:36 +00:00
* a destruction timer for this message
2018-05-19 22:41:59 +00:00
*/
2018-04-29 12:17:26 +00:00
public destructionTimer: Timer; // a timer to take care of message destruction
2018-03-13 05:15:40 +00:00
2018-04-29 12:17:26 +00:00
/**
* the constructor to create a universe message
2018-05-07 16:50:07 +00:00
* @param messageArg
* @param attachedPayloadArg
2018-04-29 12:17:26 +00:00
*/
2019-08-13 13:48:20 +00:00
constructor(messageDescriptor: interfaces.IUniverseMessage) {
2019-04-22 07:58:36 +00:00
this.smartTimestamp = new TimeStamp(this.timestamp);
this.messageText = messageDescriptor.messageText;
this.targetChannelName = messageDescriptor.targetChannelName;
this.passphrase = messageDescriptor.passphrase;
this.payload = messageDescriptor.payload;
// prevent memory issues
2018-05-19 22:41:59 +00:00
this.fallBackDestruction();
}
public setUniverseCache(universeCacheArg: UniverseCache) {
this.universeCache = universeCacheArg;
2018-05-19 22:41:59 +00:00
}
2019-09-01 15:04:25 +00:00
public setTargetChannel() {}
2019-08-13 13:48:20 +00:00
2018-05-23 21:50:45 +00:00
public setDestructionTimer(selfdestructAfterArg: number) {
2018-05-19 22:41:59 +00:00
if (selfdestructAfterArg) {
this.destructionTimer = new Timer(selfdestructAfterArg);
this.destructionTimer.start();
2018-03-13 05:15:40 +00:00
// set up self destruction by removing this from the parent messageCache
2018-05-19 22:41:59 +00:00
this.destructionTimer.completed.then(async () => {
this.universeCache.messageMap.remove(this);
2018-05-19 22:41:59 +00:00
});
} else {
this.fallBackDestruction();
}
2018-05-23 21:50:45 +00:00
}
2018-05-19 22:41:59 +00:00
/**
* handles bad messages for further analysis
*/
2019-04-22 07:58:36 +00:00
public handleAsBadMessage() {
2019-08-13 13:55:01 +00:00
plugins.smartlog.defaultLogger.log('warn', 'received a bad message');
}
2018-05-19 22:41:59 +00:00
/**
2018-05-23 21:50:45 +00:00
* prevents memory leaks if channels have no default
2018-05-19 22:41:59 +00:00
*/
2018-05-23 21:50:45 +00:00
private fallBackDestruction() {
2018-05-19 22:41:59 +00:00
plugins.smartdelay.delayFor(1000).then(() => {
if (!this.destructionTimer) {
this.setDestructionTimer(6000);
}
2018-03-20 07:16:54 +00:00
});
2018-03-13 05:15:40 +00:00
}
}