Version

menu_open

include/AK/Comm/AkCommunication.h

Go to the documentation of this file.
00001 /*******************************************************************************
00002 The content of this file includes portions of the AUDIOKINETIC Wwise Technology
00003 released in source code form as part of the SDK installer package.
00004 
00005 Commercial License Usage
00006 
00007 Licensees holding valid commercial licenses to the AUDIOKINETIC Wwise Technology
00008 may use this file in accordance with the end user license agreement provided 
00009 with the software or, alternatively, in accordance with the terms contained in a
00010 written agreement between you and Audiokinetic Inc.
00011 
00012 Apache License Usage
00013 
00014 Alternatively, this file may be used under the Apache License, Version 2.0 (the 
00015 "Apache License"); you may not use this file except in compliance with the 
00016 Apache License. You may obtain a copy of the Apache License at 
00017 http://www.apache.org/licenses/LICENSE-2.0.
00018 
00019 Unless required by applicable law or agreed to in writing, software distributed
00020 under the Apache License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
00021 OR CONDITIONS OF ANY KIND, either express or implied. See the Apache License for
00022 the specific language governing permissions and limitations under the License.
00023 
00024   Version: <VERSION>  Build: <BUILDNUMBER>
00025   Copyright (c) <COPYRIGHTYEAR> Audiokinetic Inc.
00026 *******************************************************************************/
00027 
00034 
00035 #ifndef _AK_COMMUNICATION_H
00036 #define _AK_COMMUNICATION_H
00037 
00038 #include <AK/SoundEngine/Common/AkTypes.h>
00039 #include <AK/SoundEngine/Common/AkMemoryMgr.h>
00040 #include <AK/Tools/Common/AkPlatformFuncs.h>
00041 
00042 #define AK_COMM_SETTINGS_MAX_STRING_SIZE 64
00043 
00048 struct AkCommSettings
00049 {
00050     AkCommSettings()
00051     {
00052         szAppNetworkName[0] = 0;
00053     }
00054     AkUInt32    uPoolSize;      
00055 #if defined(AK_3DS) || defined(AK_USE_NX_HTCS)
00056     AkThreadProperties threadProperties; 
00057 #endif
00058 
00068     struct Ports
00069     {
00071         Ports()
00072             : uDiscoveryBroadcast( AK_COMM_DEFAULT_DISCOVERY_PORT )
00073 #if defined( AK_COMM_NO_DYNAMIC_PORTS )
00074             , uCommand( AK_COMM_DEFAULT_DISCOVERY_PORT + 1 )
00075             , uNotification( AK_COMM_DEFAULT_DISCOVERY_PORT + 2 )
00076 #else
00077             , uCommand( 0 )
00078             , uNotification( 0 )
00079 #endif
00080         {
00081         }
00082 
00089         AkUInt16 uDiscoveryBroadcast;
00090 
00093         AkUInt16 uCommand;
00094 
00097         AkUInt16 uNotification;
00098     };
00099 
00105     Ports ports;    
00106 
00111     bool bInitSystemLib;
00112 
00115     char szAppNetworkName[AK_COMM_SETTINGS_MAX_STRING_SIZE];
00116 };
00117 
00118 namespace AK
00119 {
00120     namespace Comm
00121     {
00124 
00125 
00147         AK_EXTERNAPIFUNC( AKRESULT, Init )(
00148             const AkCommSettings &  in_settings
00149             );
00150 
00153         AK_EXTERNAPIFUNC(AkInt32, GetLastError());
00154 
00159         AK_EXTERNAPIFUNC( void, GetDefaultInitSettings )(
00160             AkCommSettings &    out_settings    
00161             );
00162         
00167         AK_EXTERNAPIFUNC( void, Term )();
00168 
00179         AK_EXTERNAPIFUNC( AKRESULT, Reset )();
00180         
00181 
00186         AK_EXTERNAPIFUNC( const AkCommSettings&, GetCurrentSettings )();
00187 
00189     }
00190 }
00191 
00192 #endif // _AK_COMMUNICATION_H

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise