libIntegra
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
integra_session.h
Go to the documentation of this file.
1 /* libIntegra modular audio framework
2  *
3  * Copyright (C) 2007 Birmingham City University
4  *
5  * This program is free software; you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation; either version 2 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
18  * USA.
19  */
20 
25 #ifndef INTEGRA_SESSION_H
26 #define INTEGRA_SESSION_H
27 
28 #include "common_typedefs.h"
29 #include "error.h"
30 #include "server_lock.h"
31 #include "documentation_mainpage.h"
32 
33 
34 namespace integra_api
35 {
36  class CServerStartupInfo;
37  class IServer;
38 
49  class INTEGRA_API CIntegraSession
50  {
51  public:
53  ~CIntegraSession();
54 
62  CError start_session( const CServerStartupInfo &startup_info );
63 
70  CError end_session();
71 
83  CServerLock get_server();
84 
85  private:
86 
87  IServer *m_server;
88  };
89 }
90 
91 
92 
93 #endif
Defines class CServerLock.
Top-level entry point for libIntegraApi.
Definition: integra_session.h:49
Defines class CError.
Locking mechanism for IServer.
Definition: server_lock.h:59
Holds configuration data for libIntegra.
Definition: server_startup_info.h:40
Provides methods to query libIntegra and process commands.
Definition: server.h:51
Represents an enumeration of error codes.
Definition: error.h:40
#defines and typedefs used throughout the application