/**********
|
This library is free software; you can redistribute it and/or modify it under
|
the terms of the GNU Lesser General Public License as published by the
|
Free Software Foundation; either version 3 of the License, or (at your
|
option) any later version. (See <http://www.gnu.org/copyleft/lesser.html>.)
|
|
This library is distributed in the hope that it will be useful, but WITHOUT
|
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
|
FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for
|
more details.
|
|
You should have received a copy of the GNU Lesser General Public License
|
along with this library; if not, write to the Free Software Foundation, Inc.,
|
51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
**********/
|
// "liveMedia"
|
// Copyright (c) 1996-2017 Live Networks, Inc. All rights reserved.
|
// A generic media server class, used to implement a RTSP server, and any other server that uses
|
// "ServerMediaSession" objects to describe media to be served.
|
// C++ header
|
|
#ifndef _GENERIC_MEDIA_SERVER_HH
|
#define _GENERIC_MEDIA_SERVER_HH
|
|
#ifndef _MEDIA_HH
|
#include "Media.hh"
|
#endif
|
#ifndef _SERVER_MEDIA_SESSION_HH
|
#include "ServerMediaSession.hh"
|
#endif
|
|
#ifndef REQUEST_BUFFER_SIZE
|
#define REQUEST_BUFFER_SIZE 20000 // for incoming requests
|
#endif
|
#ifndef RESPONSE_BUFFER_SIZE
|
#define RESPONSE_BUFFER_SIZE 20000
|
#endif
|
|
class GenericMediaServer: public Medium {
|
public:
|
void addServerMediaSession(ServerMediaSession* serverMediaSession);
|
|
virtual ServerMediaSession*
|
lookupServerMediaSession(char const* streamName, Boolean isFirstLookupInSession = True);
|
|
void removeServerMediaSession(ServerMediaSession* serverMediaSession);
|
// Removes the "ServerMediaSession" object from our lookup table, so it will no longer be accessible by new clients.
|
// (However, any *existing* client sessions that use this "ServerMediaSession" object will continue streaming.
|
// The "ServerMediaSession" object will not get deleted until all of these client sessions have closed.)
|
// (To both delete the "ServerMediaSession" object *and* close all client sessions that use it,
|
// call "deleteServerMediaSession(serverMediaSession)" instead.)
|
void removeServerMediaSession(char const* streamName);
|
// ditto
|
|
void closeAllClientSessionsForServerMediaSession(ServerMediaSession* serverMediaSession);
|
// Closes (from the server) all client sessions that are currently using this "ServerMediaSession" object.
|
// Note, however, that the "ServerMediaSession" object remains accessible by new clients.
|
void closeAllClientSessionsForServerMediaSession(char const* streamName);
|
// ditto
|
|
void deleteServerMediaSession(ServerMediaSession* serverMediaSession);
|
// Equivalent to:
|
// "closeAllClientSessionsForServerMediaSession(serverMediaSession); removeServerMediaSession(serverMediaSession);"
|
void deleteServerMediaSession(char const* streamName);
|
// Equivalent to:
|
// "closeAllClientSessionsForServerMediaSession(streamName); removeServerMediaSession(streamName);
|
|
unsigned numClientSessions() const { return fClientSessions->numEntries(); }
|
|
protected:
|
GenericMediaServer(UsageEnvironment& env, int ourSocket, Port ourPort,
|
unsigned reclamationSeconds);
|
// If "reclamationSeconds" > 0, then the "ClientSession" state for each client will get
|
// reclaimed if no activity from the client is detected in at least "reclamationSeconds".
|
// we're an abstract base class
|
virtual ~GenericMediaServer();
|
void cleanup(); // MUST be called in the destructor of any subclass of us
|
|
static int setUpOurSocket(UsageEnvironment& env, Port& ourPort);
|
|
static void incomingConnectionHandler(void*, int /*mask*/);
|
void incomingConnectionHandler();
|
void incomingConnectionHandlerOnSocket(int serverSocket);
|
|
public: // should be protected, but some old compilers complain otherwise
|
// The state of a TCP connection used by a client:
|
class ClientConnection {
|
protected:
|
ClientConnection(GenericMediaServer& ourServer, int clientSocket, struct sockaddr_in clientAddr);
|
virtual ~ClientConnection();
|
|
UsageEnvironment& envir() { return fOurServer.envir(); }
|
void closeSockets();
|
|
static void incomingRequestHandler(void*, int /*mask*/);
|
void incomingRequestHandler();
|
virtual void handleRequestBytes(int newBytesRead) = 0;
|
void resetRequestBuffer();
|
|
protected:
|
friend class GenericMediaServer;
|
friend class ClientSession;
|
friend class RTSPServer; // needed to make some broken Windows compilers work; remove this in the future when we end support for Windows
|
GenericMediaServer& fOurServer;
|
int fOurSocket;
|
struct sockaddr_in fClientAddr;
|
unsigned char fRequestBuffer[REQUEST_BUFFER_SIZE];
|
unsigned char fResponseBuffer[RESPONSE_BUFFER_SIZE];
|
unsigned fRequestBytesAlreadySeen, fRequestBufferBytesLeft;
|
};
|
|
// The state of an individual client session (using one or more sequential TCP connections) handled by a server:
|
class ClientSession {
|
protected:
|
ClientSession(GenericMediaServer& ourServer, u_int32_t sessionId);
|
virtual ~ClientSession();
|
|
UsageEnvironment& envir() { return fOurServer.envir(); }
|
void noteLiveness();
|
static void noteClientLiveness(ClientSession* clientSession);
|
static void livenessTimeoutTask(ClientSession* clientSession);
|
|
protected:
|
friend class GenericMediaServer;
|
friend class ClientConnection;
|
GenericMediaServer& fOurServer;
|
u_int32_t fOurSessionId;
|
ServerMediaSession* fOurServerMediaSession;
|
TaskToken fLivenessCheckTask;
|
};
|
|
protected:
|
virtual ClientConnection* createNewClientConnection(int clientSocket, struct sockaddr_in clientAddr) = 0;
|
virtual ClientSession* createNewClientSession(u_int32_t sessionId) = 0;
|
|
ClientSession* createNewClientSessionWithId();
|
// Generates a new (unused) random session id, and calls the "createNewClientSession()"
|
// virtual function with this session id as parameter.
|
|
// Lookup a "ClientSession" object by sessionId (integer, and string):
|
ClientSession* lookupClientSession(u_int32_t sessionId);
|
ClientSession* lookupClientSession(char const* sessionIdStr);
|
|
// An iterator over our "ServerMediaSession" objects:
|
class ServerMediaSessionIterator {
|
public:
|
ServerMediaSessionIterator(GenericMediaServer& server);
|
virtual ~ServerMediaSessionIterator();
|
ServerMediaSession* next();
|
private:
|
HashTable::Iterator* fOurIterator;
|
};
|
|
protected:
|
friend class ClientConnection;
|
friend class ClientSession;
|
friend class ServerMediaSessionIterator;
|
int fServerSocket;
|
Port fServerPort;
|
unsigned fReclamationSeconds;
|
|
private:
|
HashTable* fServerMediaSessions; // maps 'stream name' strings to "ServerMediaSession" objects
|
HashTable* fClientConnections; // the "ClientConnection" objects that we're using
|
HashTable* fClientSessions; // maps 'session id' strings to "ClientSession" objects
|
};
|
|
// A data structure used for optional user/password authentication:
|
|
class UserAuthenticationDatabase {
|
public:
|
UserAuthenticationDatabase(char const* realm = NULL,
|
Boolean passwordsAreMD5 = False);
|
// If "passwordsAreMD5" is True, then each password stored into, or removed from,
|
// the database is actually the value computed
|
// by md5(<username>:<realm>:<actual-password>)
|
virtual ~UserAuthenticationDatabase();
|
|
virtual void addUserRecord(char const* username, char const* password);
|
virtual void removeUserRecord(char const* username);
|
|
virtual char const* lookupPassword(char const* username);
|
// returns NULL if the user name was not present
|
|
char const* realm() { return fRealm; }
|
Boolean passwordsAreMD5() { return fPasswordsAreMD5; }
|
|
protected:
|
HashTable* fTable;
|
char* fRealm;
|
Boolean fPasswordsAreMD5;
|
};
|
|
#endif
|
