mirror of
https://github.com/mozilla/gecko-dev.git
synced 2024-10-24 02:35:41 +00:00
c2ebc3e45e
This allows sending and receiving arbitrarily (we limit to 1 GiB atm) sized messages while not relying on the deprecated PPID fragmentation/reassembly mode. The code already supports the ndata extension but it's not activated, yet. Without the SCTP ndata extension, a large data channel message will monopolise the SCTP association. While this is a problem, it is a temporary solution until the extension is being activated. Keep in mind that every application that uses data channels currently does fragmentation/reassembly on application-level and it's unlikely that this will change until the popular implementations (libwebrtc) implement EOR as well. Moreover, until the WebRTC API specifies an API that hands over partial messages, doing application-level fragmentation/reassembly is still useful for very large messages (sadly). We fall back to PPID-based fragmentation/reassembly mode IFF a=max-message-size is not set in the SDP and the negotiated amount of SCTP inbound streams is exactly 256. Other implementations should avoid using this combination (to be precise, other implementations should send a=max-message-size). It also changes behaviour of RTCDataChannel.send which now raises TypeError in case the message is too large for the other peer to receive. This is a necessity to ensure that implementations that do not look at the EOR flag when receiving are always able to receive our messages. Even if these implementations do not set a=max-message-size, we use a safe default value (64 KiB, dictated by the spec) that every implementation should be able to receive, with or without EOR support. * Due to the use of explicit EOR, this required some major refactoring of all send-related and deferred sending functions (which is now a lot less complex). There's now only one place where `usrsctp_sendv` is being used. * All data channel messages and DCEP messages will be sent without copying them first. Only in case this fails (e.g. usrsctp's buffer is full), the message will be copied and added to a buffer queue. * Queued data channel messages will now be re-sent fairly (round-robin). * Maximum message size and the PPID-based fragmentation are configurable using about:config (media.peerconnection.sctp.force_ppid_fragmentation and media.peerconnection.sctp.force_maximum_message_size). * Enable interleaving of incoming messages for different streams (preparation for SCTP ndata, has no effect until it is enabled). * Enable interleaving of outgoing messages (disabled if SCTP ndata has not been negotiated). * Add pending messages flag to reduce performance impact from frequent calls to SendDeferredMessages. * Handle partial delivery events (for cases where a partially delivered message is being aborted). * Close a data channel/the connection in case the message is too large to be handled (this is only applied in cases where the remote peer ignores our announced local maximum message size). * Various size_t to uint32_t conversions (message length) and back should be safe now. * Remove aUsingDtls/mUsingDtls from DataChannelConnection. * Set maximum message size in SDP and in the data channel stack. * Replace implicit NS_ENSURE_*'s with explicit NS_WARN_IF's. * Add SetMaxMessageSize method for late-applying those signalling parameters when a data channel has been created before the remote SDP was available. * Limit remote maximum message size and add a GetMaxMessageSize method for a future implementation of RTCSctpTransport.maxMessageSize. MozReview-Commit-ID: FlmZrpC5zVI --HG-- extra : rebase_source : 54e1b838c788a3abbded4fb32fe7c2788f8a9bc0
150 lines
4.4 KiB
C++
150 lines
4.4 KiB
C++
/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
|
|
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
|
|
/* This Source Code Form is subject to the terms of the Mozilla Public
|
|
* License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
|
|
|
|
#ifndef nsDOMDataChannel_h
|
|
#define nsDOMDataChannel_h
|
|
|
|
#include "mozilla/Attributes.h"
|
|
#include "mozilla/DOMEventTargetHelper.h"
|
|
#include "mozilla/dom/DataChannelBinding.h"
|
|
#include "mozilla/dom/TypedArray.h"
|
|
#include "mozilla/net/DataChannelListener.h"
|
|
#include "nsIDOMDataChannel.h"
|
|
#include "nsIInputStream.h"
|
|
|
|
|
|
namespace mozilla {
|
|
namespace dom {
|
|
class Blob;
|
|
}
|
|
|
|
class DataChannel;
|
|
};
|
|
|
|
class nsDOMDataChannel final : public mozilla::DOMEventTargetHelper,
|
|
public nsIDOMDataChannel,
|
|
public mozilla::DataChannelListener
|
|
{
|
|
public:
|
|
nsDOMDataChannel(already_AddRefed<mozilla::DataChannel>& aDataChannel,
|
|
nsPIDOMWindowInner* aWindow);
|
|
|
|
nsresult Init(nsPIDOMWindowInner* aDOMWindow);
|
|
|
|
NS_DECL_ISUPPORTS_INHERITED
|
|
NS_DECL_NSIDOMDATACHANNEL
|
|
|
|
NS_REALLY_FORWARD_NSIDOMEVENTTARGET(mozilla::DOMEventTargetHelper)
|
|
|
|
NS_DECL_CYCLE_COLLECTION_CLASS_INHERITED(nsDOMDataChannel,
|
|
mozilla::DOMEventTargetHelper)
|
|
|
|
// EventTarget
|
|
using EventTarget::EventListenerAdded;
|
|
virtual void EventListenerAdded(nsIAtom* aType) override;
|
|
|
|
using EventTarget::EventListenerRemoved;
|
|
virtual void EventListenerRemoved(nsIAtom* aType) override;
|
|
|
|
virtual JSObject* WrapObject(JSContext* aCx, JS::Handle<JSObject*> aGivenProto)
|
|
override;
|
|
nsPIDOMWindowInner* GetParentObject() const
|
|
{
|
|
return GetOwner();
|
|
}
|
|
|
|
// WebIDL
|
|
// Uses XPIDL GetLabel.
|
|
bool Reliable() const;
|
|
mozilla::dom::RTCDataChannelState ReadyState() const;
|
|
uint32_t BufferedAmount() const;
|
|
uint32_t BufferedAmountLowThreshold() const;
|
|
void SetBufferedAmountLowThreshold(uint32_t aThreshold);
|
|
IMPL_EVENT_HANDLER(open)
|
|
IMPL_EVENT_HANDLER(error)
|
|
IMPL_EVENT_HANDLER(close)
|
|
// Uses XPIDL Close.
|
|
IMPL_EVENT_HANDLER(message)
|
|
IMPL_EVENT_HANDLER(bufferedamountlow)
|
|
mozilla::dom::RTCDataChannelType BinaryType() const
|
|
{
|
|
return static_cast<mozilla::dom::RTCDataChannelType>(
|
|
static_cast<int>(mBinaryType));
|
|
}
|
|
void SetBinaryType(mozilla::dom::RTCDataChannelType aType)
|
|
{
|
|
mBinaryType = static_cast<DataChannelBinaryType>(
|
|
static_cast<int>(aType));
|
|
}
|
|
void Send(const nsAString& aData, mozilla::ErrorResult& aRv);
|
|
void Send(mozilla::dom::Blob& aData, mozilla::ErrorResult& aRv);
|
|
void Send(const mozilla::dom::ArrayBuffer& aData, mozilla::ErrorResult& aRv);
|
|
void Send(const mozilla::dom::ArrayBufferView& aData,
|
|
mozilla::ErrorResult& aRv);
|
|
|
|
// Uses XPIDL GetProtocol.
|
|
bool Ordered() const;
|
|
uint16_t Id() const;
|
|
|
|
nsresult
|
|
DoOnMessageAvailable(const nsACString& aMessage, bool aBinary);
|
|
|
|
virtual nsresult
|
|
OnMessageAvailable(nsISupports* aContext, const nsACString& aMessage) override;
|
|
|
|
virtual nsresult
|
|
OnBinaryMessageAvailable(nsISupports* aContext, const nsACString& aMessage) override;
|
|
|
|
virtual nsresult OnSimpleEvent(nsISupports* aContext, const nsAString& aName);
|
|
|
|
virtual nsresult
|
|
OnChannelConnected(nsISupports* aContext) override;
|
|
|
|
virtual nsresult
|
|
OnChannelClosed(nsISupports* aContext) override;
|
|
|
|
virtual nsresult
|
|
OnBufferLow(nsISupports* aContext) override;
|
|
|
|
virtual nsresult
|
|
NotBuffered(nsISupports* aContext) override;
|
|
|
|
virtual void
|
|
AppReady();
|
|
|
|
// if there are "strong event listeners" or outgoing not sent messages
|
|
// then this method keeps the object alive when js doesn't have strong
|
|
// references to it.
|
|
void UpdateMustKeepAlive();
|
|
// ATTENTION, when calling this method the object can be released
|
|
// (and possibly collected).
|
|
void DontKeepAliveAnyMore();
|
|
|
|
protected:
|
|
~nsDOMDataChannel();
|
|
|
|
private:
|
|
void Send(nsIInputStream* aMsgStream, const nsACString& aMsgString,
|
|
bool aIsBinary, mozilla::ErrorResult& aRv);
|
|
|
|
void ReleaseSelf();
|
|
|
|
// to keep us alive while we have listeners
|
|
RefPtr<nsDOMDataChannel> mSelfRef;
|
|
// Owning reference
|
|
RefPtr<mozilla::DataChannel> mDataChannel;
|
|
nsString mOrigin;
|
|
enum DataChannelBinaryType {
|
|
DC_BINARY_TYPE_ARRAYBUFFER,
|
|
DC_BINARY_TYPE_BLOB,
|
|
};
|
|
DataChannelBinaryType mBinaryType;
|
|
bool mCheckMustKeepAlive;
|
|
bool mSentClose;
|
|
};
|
|
|
|
#endif // nsDOMDataChannel_h
|