Server : Apache/2.4.41 (Ubuntu) System : Linux absol.cf 5.4.0-198-generic #218-Ubuntu SMP Fri Sep 27 20:18:53 UTC 2024 x86_64 User : www-data ( 33) PHP Version : 7.4.33 Disable Function : pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,pcntl_unshare, Directory : /proc/self/root/usr/local/lib/node_modules/mediasoup/src/
Upload File :
Current File : //proc/self/root/usr/local/lib/node_modules/mediasoup/src/DataConsumer.ts
import { Logger } from './Logger';
import { EnhancedEventEmitter } from './EnhancedEventEmitter';
import { Channel } from './Channel';
import { PayloadChannel } from './PayloadChannel';
import { SctpStreamParameters } from './SctpParameters';
export type DataConsumerOptions =
{
/**
* The id of the DataProducer to consume.
*/
dataProducerId: string;
/**
* Just if consuming over SCTP.
* Whether data messages must be received in order. If true the messages will
* be sent reliably. Defaults to the value in the DataProducer if it has type
* 'sctp' or to true if it has type 'direct'.
*/
ordered?: boolean;
/**
* Just if consuming over SCTP.
* When ordered is false indicates the time (in milliseconds) after which a
* SCTP packet will stop being retransmitted. Defaults to the value in the
* DataProducer if it has type 'sctp' or unset if it has type 'direct'.
*/
maxPacketLifeTime?: number;
/**
* Just if consuming over SCTP.
* When ordered is false indicates the maximum number of times a packet will
* be retransmitted. Defaults to the value in the DataProducer if it has type
* 'sctp' or unset if it has type 'direct'.
*/
maxRetransmits?: number;
/**
* Custom application data.
*/
appData?: any;
}
export type DataConsumerStat =
{
type: string;
timestamp: number;
label: string;
protocol: string;
messagesSent: number;
bytesSent: number;
bufferedAmount: number;
}
/**
* DataConsumer type.
*/
export type DataConsumerType = 'sctp' | 'direct';
const logger = new Logger('DataConsumer');
export class DataConsumer extends EnhancedEventEmitter
{
// Internal data.
private readonly _internal:
{
routerId: string;
transportId: string;
dataProducerId: string;
dataConsumerId: string;
};
// DataConsumer data.
private readonly _data:
{
type: DataConsumerType;
sctpStreamParameters?: SctpStreamParameters;
label: string;
protocol: string;
};
// Channel instance.
private readonly _channel: Channel;
// PayloadChannel instance.
private readonly _payloadChannel: PayloadChannel;
// Closed flag.
private _closed = false;
// Custom app data.
private readonly _appData?: any;
// Observer instance.
private readonly _observer = new EnhancedEventEmitter();
/**
* @private
* @emits transportclose
* @emits dataproducerclose
* @emits message - (message: Buffer, ppid: number)
* @emits sctpsendbufferfull
* @emits bufferedamountlow - (bufferedAmount: number)
* @emits @close
* @emits @dataproducerclose
*/
constructor(
{
internal,
data,
channel,
payloadChannel,
appData
}:
{
internal: any;
data: any;
channel: Channel;
payloadChannel: PayloadChannel;
appData: any;
}
)
{
super();
logger.debug('constructor()');
this._internal = internal;
this._data = data;
this._channel = channel;
this._payloadChannel = payloadChannel;
this._appData = appData;
this._handleWorkerNotifications();
}
/**
* DataConsumer id.
*/
get id(): string
{
return this._internal.dataConsumerId;
}
/**
* Associated DataProducer id.
*/
get dataProducerId(): string
{
return this._internal.dataProducerId;
}
/**
* Whether the DataConsumer is closed.
*/
get closed(): boolean
{
return this._closed;
}
/**
* DataConsumer type.
*/
get type(): DataConsumerType
{
return this._data.type;
}
/**
* SCTP stream parameters.
*/
get sctpStreamParameters(): SctpStreamParameters | undefined
{
return this._data.sctpStreamParameters;
}
/**
* DataChannel label.
*/
get label(): string
{
return this._data.label;
}
/**
* DataChannel protocol.
*/
get protocol(): string
{
return this._data.protocol;
}
/**
* App custom data.
*/
get appData(): any
{
return this._appData;
}
/**
* Invalid setter.
*/
set appData(appData: any) // eslint-disable-line no-unused-vars
{
throw new Error('cannot override appData object');
}
/**
* Observer.
*
* @emits close
*/
get observer(): EnhancedEventEmitter
{
return this._observer;
}
/**
* Close the DataConsumer.
*/
close(): void
{
if (this._closed)
return;
logger.debug('close()');
this._closed = true;
// Remove notification subscriptions.
this._channel.removeAllListeners(this._internal.dataConsumerId);
this._payloadChannel.removeAllListeners(this._internal.dataConsumerId);
this._channel.request('dataConsumer.close', this._internal)
.catch(() => {});
this.emit('@close');
// Emit observer event.
this._observer.safeEmit('close');
}
/**
* Transport was closed.
*
* @private
*/
transportClosed(): void
{
if (this._closed)
return;
logger.debug('transportClosed()');
this._closed = true;
// Remove notification subscriptions.
this._channel.removeAllListeners(this._internal.dataConsumerId);
this._payloadChannel.removeAllListeners(this._internal.dataConsumerId);
this.safeEmit('transportclose');
// Emit observer event.
this._observer.safeEmit('close');
}
/**
* Dump DataConsumer.
*/
async dump(): Promise<any>
{
logger.debug('dump()');
return this._channel.request('dataConsumer.dump', this._internal);
}
/**
* Get DataConsumer stats.
*/
async getStats(): Promise<DataConsumerStat[]>
{
logger.debug('getStats()');
return this._channel.request('dataConsumer.getStats', this._internal);
}
/**
* Set buffered amount low threshold.
*/
async setBufferedAmountLowThreshold(threshold: number): Promise<void>
{
logger.debug('setBufferedAmountLowThreshold() [threshold:%s]', threshold);
const reqData = { threshold };
await this._channel.request(
'dataConsumer.setBufferedAmountLowThreshold', this._internal, reqData);
}
/**
* Send data.
*/
async send(message: string | Buffer, ppid?: number): Promise<void>
{
if (typeof message !== 'string' && !Buffer.isBuffer(message))
{
throw new TypeError('message must be a string or a Buffer');
}
/*
* +-------------------------------+----------+
* | Value | SCTP |
* | | PPID |
* +-------------------------------+----------+
* | WebRTC String | 51 |
* | WebRTC Binary Partial | 52 |
* | (Deprecated) | |
* | WebRTC Binary | 53 |
* | WebRTC String Partial | 54 |
* | (Deprecated) | |
* | WebRTC String Empty | 56 |
* | WebRTC Binary Empty | 57 |
* +-------------------------------+----------+
*/
if (typeof ppid !== 'number')
{
ppid = (typeof message === 'string')
? message.length > 0 ? 51 : 56
: message.length > 0 ? 53 : 57;
}
// Ensure we honor PPIDs.
if (ppid === 56)
message = ' ';
else if (ppid === 57)
message = Buffer.alloc(1);
const requestData = { ppid };
await this._payloadChannel.request(
'dataConsumer.send', this._internal, requestData, message);
}
/**
* Get buffered amount size.
*/
async getBufferedAmount(): Promise<number>
{
logger.debug('getBufferedAmount()');
const { bufferedAmount } =
await this._channel.request('dataConsumer.getBufferedAmount', this._internal);
return bufferedAmount;
}
private _handleWorkerNotifications(): void
{
this._channel.on(this._internal.dataConsumerId, (event: string, data: any) =>
{
switch (event)
{
case 'dataproducerclose':
{
if (this._closed)
break;
this._closed = true;
// Remove notification subscriptions.
this._channel.removeAllListeners(this._internal.dataConsumerId);
this._payloadChannel.removeAllListeners(this._internal.dataConsumerId);
this.emit('@dataproducerclose');
this.safeEmit('dataproducerclose');
// Emit observer event.
this._observer.safeEmit('close');
break;
}
case 'sctpsendbufferfull':
{
this.safeEmit('sctpsendbufferfull');
break;
}
case 'bufferedamountlow':
{
const { bufferedAmount } = data as { bufferedAmount: number };
this.safeEmit('bufferedamountlow', bufferedAmount);
break;
}
default:
{
logger.error('ignoring unknown event "%s" in channel listener', event);
}
}
});
this._payloadChannel.on(
this._internal.dataConsumerId,
(event: string, data: any | undefined, payload: Buffer) =>
{
switch (event)
{
case 'message':
{
if (this._closed)
break;
const ppid = data.ppid as number;
const message = payload;
this.safeEmit('message', message, ppid);
break;
}
default:
{
logger.error('ignoring unknown event "%s" in payload channel listener', event);
}
}
});
}
}
Server : Apache/2.4.41 (Ubuntu)