summaryrefslogtreecommitdiffstats
path: root/dom/media/android/AndroidMediaResourceServer.h
diff options
context:
space:
mode:
authorMatt A. Tobin <mattatobin@localhost.localdomain>2018-02-02 04:16:08 -0500
committerMatt A. Tobin <mattatobin@localhost.localdomain>2018-02-02 04:16:08 -0500
commit5f8de423f190bbb79a62f804151bc24824fa32d8 (patch)
tree10027f336435511475e392454359edea8e25895d /dom/media/android/AndroidMediaResourceServer.h
parent49ee0794b5d912db1f95dce6eb52d781dc210db5 (diff)
downloadUXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar
UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.gz
UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.lz
UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.xz
UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.zip
Add m-esr52 at 52.6.0
Diffstat (limited to 'dom/media/android/AndroidMediaResourceServer.h')
-rw-r--r--dom/media/android/AndroidMediaResourceServer.h96
1 files changed, 96 insertions, 0 deletions
diff --git a/dom/media/android/AndroidMediaResourceServer.h b/dom/media/android/AndroidMediaResourceServer.h
new file mode 100644
index 000000000..68200f9c0
--- /dev/null
+++ b/dom/media/android/AndroidMediaResourceServer.h
@@ -0,0 +1,96 @@
+/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* vim:set ts=2 sw=2 sts=2 et cindent: */
+/* 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/. */
+#if !defined(AndroidMediaResourceServer_h_)
+#define AndroidMediaResourceServer_h_
+
+#include <map>
+#include "nsIServerSocket.h"
+#include "MediaResource.h"
+
+namespace mozilla {
+
+class MediaResource;
+
+/*
+ AndroidMediaResourceServer instantiates a socket server that understands
+ HTTP requests for MediaResource instances. The server runs on an
+ automatically selected port and MediaResource instances are registered.
+ The registration returns a string URL than can be used to fetch the
+ resource. That URL contains a randomly generated path to make it
+ difficult for other local applications on the device to guess it.
+
+ The HTTP protocol is limited in that it supports only what the
+ Android DataSource implementation uses to fetch media. It
+ understands HTTP GET and byte range requests.
+
+ The intent of this class is to be used in Media backends that
+ have a system component that does its own network requests. These
+ requests are made against this server which then uses standard
+ Gecko network requests and media cache usage.
+
+ The AndroidMediaResourceServer can be instantiated on any thread and
+ its methods are threadsafe - they can be called on any thread.
+ The server socket itself is always run on the main thread and
+ this is done by the Start() static method by synchronously
+ dispatching to the main thread.
+*/
+class AndroidMediaResourceServer : public Runnable
+{
+private:
+ // Mutex protecting private members of AndroidMediaResourceServer.
+ // All member variables below this point in the class definition
+ // must acquire the mutex before access.
+ mozilla::Mutex mMutex;
+
+ // Server socket used to listen for incoming connections
+ nsCOMPtr<nsIServerSocket> mSocket;
+
+ // Mapping between MediaResource URL's to the MediaResource
+ // object served at that URL.
+ typedef std::map<nsCString,
+ RefPtr<mozilla::MediaResource> > ResourceMap;
+ ResourceMap mResources;
+
+ // Create a AndroidMediaResourceServer that will listen on an automatically
+ // selected port when started. This is private as it should only be
+ // called internally from the public 'Start' method.
+ AndroidMediaResourceServer();
+ NS_IMETHOD Run();
+
+ // Append a random URL path to a string. This is used for creating a
+ // unique URl for a resource which helps prevent malicious software
+ // running on the same machine as the server from guessing the URL
+ // and accessing video data.
+ nsresult AppendRandomPath(nsCString& aURL);
+
+public:
+ // Create a AndroidMediaResourceServer and start it listening. This call will
+ // perform a synchronous request on the main thread.
+ static already_AddRefed<AndroidMediaResourceServer> Start();
+
+ // Stops the server from listening and accepting further connections.
+ void Stop();
+
+ // Add a MediaResource to be served by this server. Stores the
+ // absolute URL that can be used to access the resource in 'aUrl'.
+ nsresult AddResource(mozilla::MediaResource* aResource, nsCString& aUrl);
+
+ // Remove a MediaResource so it is no longer served by this server.
+ // The URL provided must match exactly that provided by a previous
+ // call to "AddResource".
+ void RemoveResource(nsCString const& aUrl);
+
+ // Returns the prefix for HTTP requests to the server. This plus
+ // the result of AddResource results in an Absolute URL.
+ nsCString GetURLPrefix();
+
+ // Returns the resource asociated with a given URL
+ already_AddRefed<mozilla::MediaResource> GetResource(nsCString const& aUrl);
+};
+
+} // namespace mozilla
+
+#endif