diff options
Diffstat (limited to 'dom/webtransport/shared/PWebTransport.ipdl')
-rw-r--r-- | dom/webtransport/shared/PWebTransport.ipdl | 102 |
1 files changed, 102 insertions, 0 deletions
diff --git a/dom/webtransport/shared/PWebTransport.ipdl b/dom/webtransport/shared/PWebTransport.ipdl new file mode 100644 index 0000000000..6256322425 --- /dev/null +++ b/dom/webtransport/shared/PWebTransport.ipdl @@ -0,0 +1,102 @@ +/* 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/. */ + +include PBackgroundSharedTypes; + +[RefCounted] using class mozilla::ipc::DataPipeReceiver from "mozilla/ipc/DataPipe.h"; +[RefCounted] using class mozilla::ipc::DataPipeSender from "mozilla/ipc/DataPipe.h"; +using mozilla::TimeStamp from "mozilla/TimeStamp.h"; + +namespace mozilla { +namespace dom { + +struct UnidirectionalStream { + uint64_t streamId; + nullable DataPipeSender outStream; +}; + +union UnidirectionalStreamResponse { + nsresult; + UnidirectionalStream; +}; + +struct BidirectionalStream { + uint64_t streamId; + nullable DataPipeReceiver inStream; + nullable DataPipeSender outStream; +}; + +union BidirectionalStreamResponse { + nsresult; + BidirectionalStream; +}; + +struct ResetError { + nsresult error; +}; + +struct StopSendingError { + nsresult error; +}; + +union StreamResetOrStopSendingError { + ResetError; + StopSendingError; +}; + +[ChildProc=anydom] +async protocol PWebTransport +{ + parent: + /** + * TODO: documentation + */ + async Close(uint32_t code, nsCString reason); + async CreateUnidirectionalStream(int64_t? sendOrder) + returns(UnidirectionalStreamResponse response); + async CreateBidirectionalStream(int64_t? sendOrder) + returns(BidirectionalStreamResponse response); + + /** + * IPC for sending webtransport datagrams + * @param expirationTime time at which the datagram expires + * @param data represents the datagram to be transferred + */ + async OutgoingDatagram(uint8_t[] data, TimeStamp expirationTime) + returns(nsresult response); + + /** + * Get the maximum supported datagram size from necko stack + */ + async GetMaxDatagramSize() + returns(uint64_t maxDatagramSize); + + /** + * Set the sendOrder for an existing stream + */ + async SetSendOrder(uint64_t streamId, int64_t? sendOrder); + + child: + + async IncomingUnidirectionalStream(uint64_t streamId, nullable DataPipeReceiver receive); + async IncomingBidirectionalStream(uint64_t streamId, nullable DataPipeReceiver receive, nullable DataPipeSender send); + + /** + * IPC for receiving webtransport datagrams + * @param receivedTime is the time at which the parent received the datagram + * @param data is the datagram received + */ + async IncomingDatagram(uint8_t[] data, TimeStamp receivedTime); + + async RemoteClosed(bool cleanly, uint32_t code, nsCString reason); + + async OnStreamResetOrStopSending(uint64_t streamId, + StreamResetOrStopSendingError error); + + async CloseAll() + returns(nsresult rv); +}; + +} // namespace dom +} // namespace mozilla |