pax_global_header00006660000000000000000000000064125570025550014520gustar00rootroot0000000000000052 comment=6c492f7452a6b4b240f1b572dbda2f2bcc4faf2d alljoyn-15.04b/000077500000000000000000000000001255700255500133435ustar00rootroot00000000000000alljoyn-15.04b/.gitignore000066400000000000000000000002551255700255500153350ustar00rootroot00000000000000#ignore files created by kdiff3 mergetool *.orig whitespace.db .sconsign.dblite build/ alljoyn_core/tags alljoyn_java/cscope.out alljoyn_java/sconsoutput alljoyn_java/tags alljoyn-15.04b/README.md000066400000000000000000000025231255700255500146240ustar00rootroot00000000000000Notice of Export Control Law ============================ Cryptographic software is subject to the US government export control and economic sanctions laws (“US export laws”) including the US Department of Commerce Bureau of Industry and Security’s (“BIS”) Export Administration Regulations (“EAR”, 15 CFR 730 et seq., http://www.bis.doc.gov/). You may also be subject to US export laws, including the requirements of license exception TSU in accordance with part 740.13(e) of the EAR. Software and/or technical data subject to the US export laws may not be directly or indirectly exported, reexported, transferred, or released (“exported”) to US embargoed or sanctioned destinations currently including Cuba, Iran, North Korea, Sudan, or Syria, but any amendments to this list shall apply. In addition, software and/or technical data may not be exported to any entity barred by the US government from participating in export activities. Denied persons or entities include those listed on BIS’s Denied Persons and Entities Lists, and the US Department of Treasury’s Office of Foreign Assets Control’s Specially Designated Nationals List. The country in which you are currently located may have restrictions on the import, possession, use of encryption software. You are responsible for compliance with the laws where You are located. alljoyn-15.04b/README.txt000066400000000000000000000005641255700255500150460ustar00rootroot00000000000000Welcome to AllJoyn ========================================== The documentation for the project as a whole can be found in the `alljoyn_core/docs` directory. Most notably: **Build instructions** are found in: `alljoyn_core/docs/BUILD.txt` (there is also and HTML version available in the directory. **Release Notes** are found in: `alljoyn_core/docs/ReleaseNotes.txt` alljoyn-15.04b/SConstruct000066400000000000000000000074471255700255500154110ustar00rootroot00000000000000# Copyright AllSeen Alliance. All rights reserved. # # Permission to use, copy, modify, and/or distribute this software for any # purpose with or without fee is hereby granted, provided that the above # copyright notice and this permission notice appear in all copies. # # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. # import os # Get the global environment env = SConscript(['build_core/SConscript']) vars = Variables() vars.Add('BINDINGS', 'Bindings to build (comma separated list): cpp, c, java, js', 'cpp,c,java,js') vars.Add('SERVICES', 'AllJoyn services libraries to build (comma separated list): config,controlpanel,notification,onboarding,time,audio', '') vars.Add(EnumVariable('BUILD_SERVICES_SAMPLES', 'Build the services samples that require libxml2 and json libraries.', 'on', allowed_values = ['on', 'off'])) vars.Add(BoolVariable('BUILD_DDAPI', 'Flag to indicate if data-driven API has to be built or not', 0)) vars.Update(env) Help(vars.GenerateHelpText(env)) bindings = set([ b.strip() for b in env['BINDINGS'].split(',') if b.strip() == 'cpp' or os.path.exists('alljoyn_%s/SConscript' % b.strip()) ]) services = set([ s.strip() for s in env['SERVICES'].split(',') if os.path.exists('../../services/base/%s/SConscript' % s.strip())]) print 'Building bindings: %s' % ', '.join(bindings) print 'Building services: %s' % ', '.join(services) env['bindings'] = bindings env['services'] = services # Always build AllJoyn Core env.SConscript(['alljoyn_core/SConscript']) if 'c' in bindings: env.SConscript(['alljoyn_c/SConscript']) if 'java' in bindings: env.SConscript(['alljoyn_java/SConscript']) if 'js' in bindings: env.SConscript(['alljoyn_js/SConscript']) # Always build AboutService. env.SConscript(['services/about/SConscript']) if services.intersection(['config', 'controlpanel', 'notification', 'onboarding', 'time', 'audio']): env['APP_COMMON_DIR'] = env.Dir('../../services/base/sample_apps') if services.intersection(['config', 'onboarding']): # onboarding also depends on config env.SConscript(['../../services/base/config/SConscript']) if 'onboarding' in services: env.SConscript(['../../services/base/onboarding/SConscript']) if services.intersection(['controlpanel', 'notification']): # controlpanel also depends on notification env.SConscript(['../../services/base/notification/SConscript']) if 'controlpanel' in services: env.SConscript(['../../services/base/controlpanel/SConscript']) if 'time' in services: env.SConscript(['../../services/base/time/SConscript']) if 'audio' in services: env.SConscript(['../../services/audio/SConscript']) #Build Win7 SDK installer if env.has_key('WIN7_MSI') and env['WIN7_MSI'] == 'true': win7Sdk = env.SConscript(['alljoyn_core/install/Win7/SConscript']) env.Depends(win7Sdk, installedFiles) # Always build Datadriven_api if it is present if env['BUILD_DDAPI'] == 1: if os.path.exists('../../data/datadriven_api/SConscript'): env.SConscript(['../../data/datadriven_api/SConscript']) # Build Alias to make cleaning, building and rebuilding the documentation when # working only on the documentation simpler. This can be run by using # `scons all_docs` env.Alias('all_docs', ['core_docs', 'c_docs']) alljoyn-15.04b/alljoyn_c/000077500000000000000000000000001255700255500153155ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_c/.gitignore000066400000000000000000000004231255700255500173040ustar00rootroot00000000000000.sconsign.dblite build/ # the following header files are copied into the alljoyn_c project via the SCons build # system to aid with development they should not be checked into the repository. inc/alljoyn_c/DBusStdDefines.h inc/alljoyn_c/Status.h inc/qcc *.pdb whitespace.db alljoyn-15.04b/alljoyn_c/SConscript000066400000000000000000000103271255700255500173320ustar00rootroot00000000000000# Copyright AllSeen Alliance. All rights reserved. # # Permission to use, copy, modify, and/or distribute this software for any # purpose with or without fee is hereby granted, provided that the above # copyright notice and this permission notice appear in all copies. # # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. # import os import sys Import('env') # Dependent Projects if not env.has_key('_ALLJOYNCORE_'): env.SConscript('../alljoyn_core/SConscript') # Indicate that this SConscript file has been loaded already env['_ALLJOYNC_'] = True clibenv = env.Clone() vars = Variables(); vars.Update(clibenv) Help(vars.GenerateHelpText(clibenv)) # C binding requires a couple of header files in alljoyn_core/src clibenv.Append(CPPPATH = [clibenv.Dir('../alljoyn_core/src').srcnode()]) sys.path.append(str(clibenv.Dir('../build_core/tools/scons').srcnode())) # Make alljoyn C dist a sub-directory of the alljoyn dist. clibenv['C_DISTDIR'] = clibenv['DISTDIR'] + '/c' clibenv['C_TESTDIR'] = clibenv['TESTDIR'] + '/c' clibenv['OBJDIR_ALLJOYN_C'] = clibenv['OBJDIR'] + '/alljoyn_c' # Add support for multiple build targets in the same workset clibenv.VariantDir('$OBJDIR_ALLJOYN_C', 'src', duplicate = 0) clibenv.VariantDir('$OBJDIR_ALLJOYN_C/samples', 'samples', duplicate = 0) # Install headers # C bindings use the following headers from alljoyn_core alljoyn_core_headers = clibenv.Install('inc/alljoyn_c', '$DISTDIR/cpp/inc/alljoyn/DBusStdDefines.h') alljoyn_core_headers += clibenv.Install('inc/alljoyn_c', '$DISTDIR/cpp/inc/alljoyn/Status.h') alljoyn_core_headers += clibenv.Install('inc/qcc/${OS_GROUP}', '$DISTDIR/cpp/inc/qcc/${OS_GROUP}/platform_types.h') if clibenv['OS_GROUP'] == 'windows': alljoyn_core_headers += clibenv.Install('inc/qcc/${OS_GROUP}', '$DISTDIR/cpp/inc/qcc/${OS_GROUP}/mapping.h') c_headers = clibenv.Install('$C_DISTDIR/inc/alljoyn_c', clibenv.Glob('inc/alljoyn_c/*.h')) c_headers += clibenv.Install('$C_DISTDIR/inc/qcc', clibenv.Glob('inc/qcc/*.h')) c_headers += clibenv.Install('$C_DISTDIR/inc/qcc/${OS_GROUP}', clibenv.Glob('inc/qcc/${OS_GROUP}/*.h')) # make sure the headers from alljoyn_core have been copied into the alljoyn_c headers clibenv.Depends(c_headers, alljoyn_core_headers) # AllJoyn Libraries, and shared object files. static_lib, shared_lib, env['AJ_C_OBJS'] = clibenv.SConscript('$OBJDIR_ALLJOYN_C/SConscript', exports = {'env':clibenv}) libs = [static_lib, shared_lib] dlibs = clibenv.Install('$C_DISTDIR/lib', libs) # the variable dlibs contains the file nodes for the static library and the # shared library however it may contain more files such as .pdb files on windows. # Search through the list and assign the static library to the ALLJOYN_C_LIB_STATIC # clibenv variable and the shared library to ALLJOYN_C_LIB_SHARED clibenv variable. for x in dlibs: if clibenv['OS_GROUP'] == 'windows': if 'alljoyn_c_static' + clibenv['LIBSUFFIX'] in str(x): clibenv['ALLJOYN_C_LIB_STATIC'] = x; else: if 'alljoyn_c' + clibenv['LIBSUFFIX'] in str(x): clibenv['ALLJOYN_C_LIB_STATIC'] = x; if 'alljoyn_c' + clibenv['SHLIBSUFFIX'] in str(x): clibenv['ALLJOYN_C_LIB_SHARED'] = x; # Build docs c_docs = clibenv.SConscript('docs/SConscript', exports = {'env':clibenv}) clibenv.Depends(c_docs, c_headers) # Sample programs clibenv.SConscript('$OBJDIR_ALLJOYN_C/samples/SConscript', exports = {'env':clibenv}) # Test programs clibenv.SConscript('test/SConscript', variant_dir='$OBJDIR_ALLJOYN_C/test', duplicate=0, exports = {'env':clibenv}) # Build unit Tests clibenv.SConscript('unit_test/SConscript', variant_dir='$OBJDIR_ALLJOYN_C/unittest', duplicate=0, exports = {'env':clibenv}) # don't try and build the samples till the header files are copied into place #clibenv.Depends(dlibs, c_headers) alljoyn-15.04b/alljoyn_c/docs/000077500000000000000000000000001255700255500162455ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_c/docs/.gitignore000066400000000000000000000000061255700255500202310ustar00rootroot00000000000000html/ alljoyn-15.04b/alljoyn_c/docs/Doxygen_html000066400000000000000000001743461255700255500206500ustar00rootroot00000000000000# Doxyfile 1.6.1 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project # # All text after a hash (#) is considered a comment and will be ignored # The format is: # TAG = value [value, ...] # For lists items can also be appended using: # TAG += value [value, ...] # Values that contain spaces should be placed between quotes (" ") #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- # This tag specifies the encoding used for all characters in the config file # that follow. The default is UTF-8 which is also the encoding used for all # text before the first occurrence of this tag. Doxygen uses libiconv (or the # iconv built into libc) for the transcoding. See # http://www.gnu.org/software/libiconv for the list of possible encodings. DOXYFILE_ENCODING = UTF-8 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded # by quotes) that should identify the project. PROJECT_NAME = "AllJoyn™ C API Reference Manual" # The PROJECT_NUMBER tag can be used to enter a project or revision number. # This could be handy for archiving the generated documentation or # if some version control system is used. PROJECT_NUMBER = "Version 15.04.00b" # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) # base path where the generated documentation will be put. # If a relative path is entered, it will be relative to the location # where doxygen was started. If left blank the current directory will be used. OUTPUT_DIRECTORY = $(C_DISTDIR)/docs # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create # 4096 sub-directories (in 2 levels) under the output directory of each output # format and will distribute the generated files over these directories. # Enabling this option can be useful when feeding doxygen a huge amount of # source files, where putting all generated files in the same directory would # otherwise cause performance problems for the file system. CREATE_SUBDIRS = NO # The OUTPUT_LANGUAGE tag is used to specify the language in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all constant output in the proper language. # The default language is English, other supported languages are: # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. OUTPUT_LANGUAGE = English # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will # include brief member descriptions after the members that are listed in # the file and class documentation (similar to JavaDoc). # Set to NO to disable this. BRIEF_MEMBER_DESC = YES # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend # the brief description of a member or function before the detailed description. # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. REPEAT_BRIEF = YES # This tag implements a quasi-intelligent brief description abbreviator # that is used to form the text in various listings. Each string # in this list, if found as the leading text of the brief description, will be # stripped from the text and the result after processing the whole list, is # used as the annotated text. Otherwise, the brief description is used as-is. # If left blank, the following values are used ("$name" is automatically # replaced with the name of the entity): "The $name class" "The $name widget" # "The $name file" "is" "provides" "specifies" "contains" # "represents" "a" "an" "the" ABBREVIATE_BRIEF = # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then # Doxygen will generate a detailed section even if there is only a brief # description. ALWAYS_DETAILED_SEC = NO # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all # inherited members of a class in the documentation of that class as if those # members were ordinary class members. Constructors, destructors and assignment # operators of the base classes will not be shown. INLINE_INHERITED_MEMB = NO # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full # path before files name in the file list and in the header files. If set # to NO the shortest path that makes the file name unique will be used. FULL_PATH_NAMES = NO # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag # can be used to strip a user-defined part of the path. Stripping is # only done if one of the specified strings matches the left-hand part of # the path. The tag can be used to show relative paths in the file list. # If left blank the directory from which doxygen is run is used as the # path to strip. STRIP_FROM_PATH = # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of # the path mentioned in the documentation of a class, which tells # the reader which header file to include in order to use a class. # If left blank only the name of the header file containing the class # definition is used. Otherwise one should specify the include paths that # are normally passed to the compiler using the -I flag. STRIP_FROM_INC_PATH = # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter # (but less readable) file names. This can be useful is your file systems # doesn't support long names like on DOS, Mac, or CD-ROM. SHORT_NAMES = NO # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen # will interpret the first line (until the first dot) of a JavaDoc-style # comment as the brief description. If set to NO, the JavaDoc # comments will behave just like regular Qt-style comments # (thus requiring an explicit @brief command for a brief description.) JAVADOC_AUTOBRIEF = YES # If the QT_AUTOBRIEF tag is set to YES then Doxygen will # interpret the first line (until the first dot) of a Qt-style # comment as the brief description. If set to NO, the comments # will behave just like regular Qt-style comments (thus requiring # an explicit \brief command for a brief description.) QT_AUTOBRIEF = NO # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen # treat a multi-line C++ special comment block (i.e. a block of //! or /// # comments) as a brief description. This used to be the default behaviour. # The new default is to treat a multi-line C++ comment block as a detailed # description. Set this tag to YES if you prefer the old behaviour instead. MULTILINE_CPP_IS_BRIEF = NO # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented # member inherits the documentation from any documented member that it # re-implements. INHERIT_DOCS = YES # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce # a new page for each member. If set to NO, the documentation of a member will # be part of the file/class/namespace that contains it. SEPARATE_MEMBER_PAGES = NO # The TAB_SIZE tag can be used to set the number of spaces in a tab. # Doxygen uses this value to replace tabs by spaces in code fragments. TAB_SIZE = 4 # This tag can be used to specify a number of aliases that acts # as commands in the documentation. An alias has the form "name=value". # For example adding "sideeffect=\par Side Effects:\n" will allow you to # put the command \sideeffect (or @sideeffect) in the documentation, which # will result in a user-defined paragraph with heading "Side Effects:". # You can put \n's in the value part of an alias to insert newlines. ALIASES = # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C # sources only. Doxygen will then generate output that is more tailored for C. # For instance, some of the names that are used will be different. The list # of all members will be omitted, etc. OPTIMIZE_OUTPUT_FOR_C = YES # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java # sources only. Doxygen will then generate output that is more tailored for # Java. For instance, namespaces will be presented as packages, qualified # scopes will look different, etc. OPTIMIZE_OUTPUT_JAVA = NO # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran # sources only. Doxygen will then generate output that is more tailored for # Fortran. OPTIMIZE_FOR_FORTRAN = NO # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL # sources. Doxygen will then generate output that is tailored for # VHDL. OPTIMIZE_OUTPUT_VHDL = NO # Doxygen selects the parser to use depending on the extension of the files it parses. # With this tag you can assign which parser to use for a given extension. # Doxygen has a built-in mapping, but you can override or extend it using this tag. # The format is ext=language, where ext is a file extension, and language is one of # the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP, # Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat # .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran), # use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. EXTENSION_MAPPING = # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want # to include (a tag file for) the STL sources as input, then you should # set this tag to YES in order to let doxygen match functions declarations and # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. # func(std::string) {}). This also make the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. BUILTIN_STL_SUPPORT = YES # If you use Microsoft's C++/CLI language, you should set this option to YES to # enable parsing support. CPP_CLI_SUPPORT = NO # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. # Doxygen will parse them like normal C++ but will assume all classes use public # instead of private inheritance when no explicit protection keyword is present. SIP_SUPPORT = NO # For Microsoft's IDL there are propget and propput attributes to indicate getter # and setter methods for a property. Setting this option to YES (the default) # will make doxygen to replace the get and set methods by a property in the # documentation. This will only work if the methods are indeed getting or # setting a simple type. If this is not the case, or you want to show the # methods anyway, you should set this option to NO. IDL_PROPERTY_SUPPORT = YES # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC # tag is set to YES, then doxygen will reuse the documentation of the first # member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. DISTRIBUTE_GROUP_DOC = NO # Set the SUBGROUPING tag to YES (the default) to allow class member groups of # the same type (for instance a group of public functions) to be put as a # subgroup of that type (e.g. under the Public Functions section). Set it to # NO to prevent subgrouping. Alternatively, this can be done per class using # the \nosubgrouping command. SUBGROUPING = YES # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum # is documented as struct, union, or enum with the name of the typedef. So # typedef struct TypeS {} TypeT, will appear in the documentation as a struct # with name TypeT. When disabled the typedef will appear as a member of a file, # namespace, or class. And the struct will be named TypeS. This can typically # be useful for C code in case the coding convention dictates that all compound # types are typedef'ed and only the typedef is referenced, never the tag name. TYPEDEF_HIDES_STRUCT = NO # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to # determine which symbols to keep in memory and which to flush to disk. # When the cache is full, less often used symbols will be written to disk. # For small to medium size projects (<1000 input files) the default value is # probably good enough. For larger projects a too small cache size can cause # doxygen to be busy swapping symbols to and from disk most of the time # causing a significant performance penality. # If the system has enough physical memory increasing the cache will improve the # performance by keeping more symbols in memory. Note that the value works on # a logarithmic scale so increasing the size by one will rougly double the # memory usage. The cache size is given by this formula: # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, # corresponding to a cache size of 2^16 = 65536 symbols #SYMBOL_CACHE_SIZE = 0 #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in # documentation are documented, even if no documentation was available. # Private class members and static file members will be hidden unless # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES EXTRACT_ALL = NO # If the EXTRACT_PRIVATE tag is set to YES all private members of a class # will be included in the documentation. EXTRACT_PRIVATE = NO # If the EXTRACT_STATIC tag is set to YES all static members of a file # will be included in the documentation. EXTRACT_STATIC = YES # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) # defined locally in source files will be included in the documentation. # If set to NO only classes defined in header files are included. EXTRACT_LOCAL_CLASSES = NO # This flag is only useful for Objective-C code. When set to YES local # methods, which are defined in the implementation section but not in # the interface are included in the documentation. # If set to NO (the default) only methods in the interface are included. EXTRACT_LOCAL_METHODS = NO # If this flag is set to YES, the members of anonymous namespaces will be # extracted and appear in the documentation as a namespace called # 'anonymous_namespace{file}', where file will be replaced with the base # name of the file that contains the anonymous namespace. By default # anonymous namespace are hidden. EXTRACT_ANON_NSPACES = NO # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all # undocumented members of documented classes, files or namespaces. # If set to NO (the default) these members will be included in the # various overviews, but no documentation section is generated. # This option has no effect if EXTRACT_ALL is enabled. HIDE_UNDOC_MEMBERS = NO # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. # If set to NO (the default) these classes will be included in the various # overviews. This option has no effect if EXTRACT_ALL is enabled. HIDE_UNDOC_CLASSES = NO # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all # friend (class|struct|union) declarations. # If set to NO (the default) these declarations will be included in the # documentation. HIDE_FRIEND_COMPOUNDS = NO # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any # documentation blocks found inside the body of a function. # If set to NO (the default) these blocks will be appended to the # function's detailed documentation block. HIDE_IN_BODY_DOCS = NO # The INTERNAL_DOCS tag determines if documentation # that is typed after a \internal command is included. If the tag is set # to NO (the default) then the documentation will be excluded. # Set it to YES to include the internal documentation. INTERNAL_DOCS = NO # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate # file names in lower-case letters. If set to YES upper-case letters are also # allowed. This is useful if you have classes or files whose names only differ # in case and if your file system supports case sensitive file names. Windows # and Mac users are advised to set this option to NO. CASE_SENSE_NAMES = NO # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen # will show members with their full class and namespace scopes in the # documentation. If set to YES the scope will be hidden. HIDE_SCOPE_NAMES = NO # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen # will put a list of the files that are included by a file in the documentation # of that file. SHOW_INCLUDE_FILES = YES # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] # is inserted in the documentation for inline members. INLINE_INFO = YES # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen # will sort the (detailed) documentation of file and class members # alphabetically by member name. If set to NO the members will appear in # declaration order. SORT_MEMBER_DOCS = YES # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the # brief documentation of file, namespace and class members alphabetically # by member name. If set to NO (the default) the members will appear in # declaration order. SORT_BRIEF_DOCS = NO # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. SORT_MEMBERS_CTORS_1ST = YES # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the # hierarchy of group names into alphabetical order. If set to NO (the default) # the group names will appear in their defined order. SORT_GROUP_NAMES = NO # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be # sorted by fully-qualified names, including namespaces. If set to # NO (the default), the class list will be sorted only by class name, # not including the namespace part. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. # Note: This option applies only to the class list, not to the # alphabetical list. SORT_BY_SCOPE_NAME = NO # The GENERATE_TODOLIST tag can be used to enable (YES) or # disable (NO) the todo list. This list is created by putting \todo # commands in the documentation. GENERATE_TODOLIST = YES # The GENERATE_TESTLIST tag can be used to enable (YES) or # disable (NO) the test list. This list is created by putting \test # commands in the documentation. GENERATE_TESTLIST = YES # The GENERATE_BUGLIST tag can be used to enable (YES) or # disable (NO) the bug list. This list is created by putting \bug # commands in the documentation. GENERATE_BUGLIST = YES # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or # disable (NO) the deprecated list. This list is created by putting # \deprecated commands in the documentation. GENERATE_DEPRECATEDLIST= YES # The ENABLED_SECTIONS tag can be used to enable conditional # documentation sections, marked by \if sectionname ... \endif. ENABLED_SECTIONS = # The MAX_INITIALIZER_LINES tag determines the maximum number of lines # the initial value of a variable or define consists of for it to appear in # the documentation. If the initializer consists of more lines than specified # here it will be hidden. Use a value of 0 to hide initializers completely. # The appearance of the initializer of individual variables and defines in the # documentation can be controlled using \showinitializer or \hideinitializer # command in the documentation regardless of this setting. MAX_INITIALIZER_LINES = 30 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated # at the bottom of the documentation of classes and structs. If set to YES the # list will mention the files that were used to generate the documentation. SHOW_USED_FILES = YES # If the sources in your project are distributed over multiple directories # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy # in the documentation. The default is NO. #SHOW_DIRECTORIES = NO # Set the SHOW_FILES tag to NO to disable the generation of the Files page. # This will remove the Files entry from the Quick Index and from the # Folder Tree View (if specified). The default is YES. SHOW_FILES = YES # Set the SHOW_NAMESPACES tag to NO to disable the generation of the # Namespaces page. # This will remove the Namespaces entry from the Quick Index # and from the Folder Tree View (if specified). The default is YES. SHOW_NAMESPACES = YES # The FILE_VERSION_FILTER tag can be used to specify a program or script that # doxygen should invoke to get the current version for each file (typically from # the version control system). Doxygen will invoke the program by executing (via # popen()) the command , where is the value of # the FILE_VERSION_FILTER tag, and is the name of an input file # provided by doxygen. Whatever the program writes to standard output # is used as the file version. See the manual for examples. FILE_VERSION_FILTER = # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by # doxygen. The layout file controls the global structure of the generated output files # in an output format independent way. The create the layout file that represents # doxygen's defaults, run doxygen with the -l option. You can optionally specify a # file name after the option, if omitted DoxygenLayout.xml will be used as the name # of the layout file. LAYOUT_FILE = #--------------------------------------------------------------------------- # configuration options related to warning and progress messages #--------------------------------------------------------------------------- # The QUIET tag can be used to turn on/off the messages that are generated # by doxygen. Possible values are YES and NO. If left blank NO is used. QUIET = YES # The WARNINGS tag can be used to turn on/off the warning messages that are # generated by doxygen. Possible values are YES and NO. If left blank # NO is used. WARNINGS = YES # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings # for undocumented members. If EXTRACT_ALL is set to YES then this flag will # automatically be disabled. WARN_IF_UNDOCUMENTED = YES # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for # potential errors in the documentation, such as not documenting some # parameters in a documented function, or documenting parameters that # don't exist or using markup commands wrongly. WARN_IF_DOC_ERROR = YES # This WARN_NO_PARAMDOC option can be abled to get warnings for # functions that are documented, but have no documentation for their parameters # or return value. If set to NO (the default) doxygen will only warn about # wrong or incomplete parameter documentation, but not about the absence of # documentation. WARN_NO_PARAMDOC = YES # The WARN_FORMAT tag determines the format of the warning messages that # doxygen can produce. The string should contain the $file, $line, and $text # tags, which will be replaced by the file and line number from which the # warning originated and the warning text. Optionally the format may contain # $version, which will be replaced by the version of the file (if it could # be obtained via FILE_VERSION_FILTER) WARN_FORMAT = "$file:$line: $text" # The WARN_LOGFILE tag can be used to specify a file to which warning # and error messages should be written. If left blank the output is written # to stderr. WARN_LOGFILE = #--------------------------------------------------------------------------- # configuration options related to the input files #--------------------------------------------------------------------------- # The INPUT tag can be used to specify the files and/or directories that contain # documented source files. You may enter file names like "myfile.cpp" or # directories like "/usr/src/myproject". Separate the files or directories # with spaces. INPUT = $(C_DISTDIR)/inc/alljoyn_c \ $(C_DISTDIR)/inc/qcc \ allJoynDocumentation # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is # also the default input encoding. Doxygen uses libiconv (or the iconv built # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for # the list of possible encodings. INPUT_ENCODING = UTF-8 # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp # and *.h) to filter out the source-files in the directories. If left # blank the following patterns are tested: # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 FILE_PATTERNS = # The RECURSIVE tag can be used to turn specify whether or not subdirectories # should be searched for input files as well. Possible values are YES and NO. # If left blank NO is used. RECURSIVE = YES # The EXCLUDE tag can be used to specify files and/or directories that should # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. EXCLUDE = # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded # from the input. EXCLUDE_SYMLINKS = NO # If the value of the INPUT tag contains directories, you can use the # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude # certain files from those directories. Note that the wildcards are matched # against the file with absolute path, so to exclude all test directories # for example use the pattern */test/* EXCLUDE_PATTERNS = # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the # output. The symbol name can be a fully qualified name, a word, or if the # wildcard * is used, a substring. Examples: ANamespace, AClass, # AClass::ANamespace, ANamespace::*Test EXCLUDE_SYMBOLS = # The EXAMPLE_PATH tag can be used to specify one or more files or # directories that contain example code fragments that are included (see # the \include command). EXAMPLE_PATH = # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp # and *.h) to filter out the source-files in the directories. If left # blank all files are included. EXAMPLE_PATTERNS = # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be # searched for input files to be used with the \include or \dontinclude # commands irrespective of the value of the RECURSIVE tag. # Possible values are YES and NO. If left blank NO is used. EXAMPLE_RECURSIVE = NO # The IMAGE_PATH tag can be used to specify one or more files or # directories that contain image that are included in the documentation (see # the \image command). IMAGE_PATH = # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program # by executing (via popen()) the command , where # is the value of the INPUT_FILTER tag, and is the name of an # input file. Doxygen will then use the output that the filter program writes # to standard output. # If FILTER_PATTERNS is specified, this tag will be # ignored. INPUT_FILTER = # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern # basis. # Doxygen will compare the file name with each pattern and apply the # filter if there is a match. # The filters are a list of the form: # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER # is applied to all files. FILTER_PATTERNS = # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using # INPUT_FILTER) will be used to filter the input files when producing source # files to browse (i.e. when SOURCE_BROWSER is set to YES). FILTER_SOURCE_FILES = NO #--------------------------------------------------------------------------- # configuration options related to source browsing #--------------------------------------------------------------------------- # If the SOURCE_BROWSER tag is set to YES then a list of source files will # be generated. Documented entities will be cross-referenced with these sources. # Note: To get rid of all source code in the generated output, make sure also # VERBATIM_HEADERS is set to NO. SOURCE_BROWSER = NO # Setting the INLINE_SOURCES tag to YES will include the body # of functions and classes directly in the documentation. INLINE_SOURCES = NO # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct # doxygen to hide any special comment blocks from generated source code # fragments. Normal C and C++ comments will always remain visible. STRIP_CODE_COMMENTS = YES # If the REFERENCED_BY_RELATION tag is set to YES # then for each documented function all documented # functions referencing it will be listed. REFERENCED_BY_RELATION = NO # If the REFERENCES_RELATION tag is set to YES # then for each documented function all documented entities # called/used by that function will be listed. REFERENCES_RELATION = NO # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will # link to the source code. # Otherwise they will link to the documentation. REFERENCES_LINK_SOURCE = YES # If the USE_HTAGS tag is set to YES then the references to source code # will point to the HTML generated by the htags(1) tool instead of doxygen # built-in source browser. The htags tool is part of GNU's global source # tagging system (see http://www.gnu.org/software/global/global.html). You # will need version 4.8.6 or higher. USE_HTAGS = NO # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen # will generate a verbatim copy of the header file for each class for # which an include is specified. Set to NO to disable this. VERBATIM_HEADERS = YES #--------------------------------------------------------------------------- # configuration options related to the alphabetical class index #--------------------------------------------------------------------------- # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index # of all compounds will be generated. Enable this if the project # contains a lot of classes, structs, unions or interfaces. ALPHABETICAL_INDEX = NO # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns # in which this list will be split (can be a number in the range [1..20]) COLS_IN_ALPHA_INDEX = 5 # In case all classes in a project start with a common prefix, all # classes will be put under the same header in the alphabetical index. # The IGNORE_PREFIX tag can be used to specify one or more prefixes that # should be ignored while generating the index headers. IGNORE_PREFIX = #--------------------------------------------------------------------------- # configuration options related to the HTML output #--------------------------------------------------------------------------- # If the GENERATE_HTML tag is set to YES (the default) Doxygen will # generate HTML output. GENERATE_HTML = YES # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `html' will be used as the default path. HTML_OUTPUT = html # The HTML_FILE_EXTENSION tag can be used to specify the file extension for # each generated HTML page (for example: .htm,.php,.asp). If it is left blank # doxygen will generate files with .html extension. HTML_FILE_EXTENSION = .html # The HTML_HEADER tag can be used to specify a personal HTML header for # each generated HTML page. If it is left blank doxygen will generate a # standard header. # 20120131: header.html should no longer be used in production builds [MBUS-463] # doxygen 1.7.4 and later will generate buggy html if header.html is included HTML_HEADER = # The HTML_FOOTER tag can be used to specify a personal HTML footer for # each generated HTML page. If it is left blank doxygen will generate a # standard footer. HTML_FOOTER = footer.html # The HTML_STYLESHEET tag can be used to specify a user-defined cascading # style sheet that is used by each HTML page. It can be used to # fine-tune the look of the HTML output. If the tag is left blank doxygen # will generate a default style sheet. Note that doxygen will try to copy # the style sheet file to the HTML output directory, so don't put your own # stylesheet in the HTML output directory as well, or it will be erased! HTML_STYLESHEET = # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, # files or namespaces will be aligned in HTML using tables. If set to # NO a bullet list will be used. #HTML_ALIGN_MEMBERS = YES # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # documentation will contain sections that can be hidden and shown after the # page has loaded. For this to work a browser that supports # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). HTML_DYNAMIC_SECTIONS = NO # If the GENERATE_DOCSET tag is set to YES, additional index files # will be generated that can be used as input for Apple's Xcode 3 # integrated development environment, introduced with OSX 10.5 (Leopard). # To create a documentation set, doxygen will generate a Makefile in the # HTML output directory. Running make will produce the docset in that # directory and running "make install" will install the docset in # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find # it at startup. # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information. GENERATE_DOCSET = NO # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the # feed. A documentation feed provides an umbrella under which multiple # documentation sets from a single provider (such as a company or product suite) # can be grouped. DOCSET_FEEDNAME = "Doxygen generated docs" # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that # should uniquely identify the documentation set bundle. This should be a # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen # will append .docset to the name. DOCSET_BUNDLE_ID = org.doxygen.Project # If the GENERATE_HTMLHELP tag is set to YES, additional index files # will be generated that can be used as input for tools like the # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) # of the generated HTML documentation. GENERATE_HTMLHELP = NO # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can # be used to specify the file name of the resulting .chm file. You # can add a path in front of the file if the result should not be # written to the html output directory. CHM_FILE = # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can # be used to specify the location (absolute path including file name) of # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run # the HTML help compiler on the generated index.hhp. HHC_LOCATION = # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag # controls if a separate .chi index file is generated (YES) or that # it should be included in the master .chm file (NO). GENERATE_CHI = NO # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING # is used to encode HtmlHelp index (hhk), content (hhc) and project file # content. CHM_INDEX_ENCODING = # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag # controls whether a binary table of contents is generated (YES) or a # normal table of contents (NO) in the .chm file. BINARY_TOC = NO # The TOC_EXPAND flag can be set to YES to add extra items for group members # to the contents of the HTML help documentation and to the tree view. TOC_EXPAND = NO # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER # are set, an additional index file will be generated that can be used as input for # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated # HTML documentation. GENERATE_QHP = NO # If the QHG_LOCATION tag is specified, the QCH_FILE tag can # be used to specify the file name of the resulting .qch file. # The path specified is relative to the HTML output folder. QCH_FILE = # The QHP_NAMESPACE tag specifies the namespace to use when generating # Qt Help Project output. For more information please see # http://doc.trolltech.com/qthelpproject.html#namespace QHP_NAMESPACE = # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating # Qt Help Project output. For more information please see # http://doc.trolltech.com/qthelpproject.html#virtual-folders QHP_VIRTUAL_FOLDER = doc # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. # For more information please see # http://doc.trolltech.com/qthelpproject.html#custom-filters QHP_CUST_FILTER_NAME = # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see # Qt Help Project / Custom Filters. QHP_CUST_FILTER_ATTRS = # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's # filter section matches. # Qt Help Project / Filter Attributes. QHP_SECT_FILTER_ATTRS = # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can # be used to specify the location of Qt's qhelpgenerator. # If non-empty doxygen will try to run qhelpgenerator on the generated # .qhp file. QHG_LOCATION = # The DISABLE_INDEX tag can be used to turn on/off the condensed index at # top of each HTML page. The value NO (the default) enables the index and # the value YES disables it. DISABLE_INDEX = NO # This tag can be used to set the number of enum values (range [1..20]) # that doxygen will group on one line in the generated HTML documentation. ENUM_VALUES_PER_LINE = 4 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index # structure should be generated to display hierarchical information. # If the tag value is set to YES, a side panel will be generated # containing a tree-like index structure (just like the one that # is generated for HTML Help). For this to work a browser that supports # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). # Windows users are probably better off using the HTML help feature. GENERATE_TREEVIEW = NO # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, # and Class Hierarchy pages using a tree view instead of an ordered list. #USE_INLINE_TREES = YES # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be # used to set the initial width (in pixels) of the frame in which the tree # is shown. TREEVIEW_WIDTH = 250 # Use this tag to change the font size of Latex formulas included # as images in the HTML documentation. The default is 10. Note that # when you change the font size after a successful doxygen run you need # to manually remove any form_*.png images from the HTML output directory # to force them to be regenerated. FORMULA_FONTSIZE = 10 # When the SEARCHENGINE tag is enable doxygen will generate a search box for the HTML output. The underlying search engine uses javascript # and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP) or Qt help (GENERATE_QHP) # there is already a search function so this one should typically # be disabled. SEARCHENGINE = YES #--------------------------------------------------------------------------- # configuration options related to the LaTeX output #--------------------------------------------------------------------------- # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will # generate Latex output. GENERATE_LATEX = NO # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `latex' will be used as the default path. LATEX_OUTPUT = latex # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be # invoked. If left blank `latex' will be used as the default command name. LATEX_CMD_NAME = latex # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to # generate index for LaTeX. If left blank `makeindex' will be used as the # default command name. MAKEINDEX_CMD_NAME = makeindex # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact # LaTeX documents. This may be useful for small projects and may help to # save some trees in general. COMPACT_LATEX = NO # The PAPER_TYPE tag can be used to set the paper type that is used # by the printer. Possible values are: a4, a4wide, letter, legal and # executive. If left blank a4wide will be used. PAPER_TYPE = a4wide # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX # packages that should be included in the LaTeX output. EXTRA_PACKAGES = # The LATEX_HEADER tag can be used to specify a personal LaTeX header for # the generated latex document. The header should contain everything until # the first chapter. If it is left blank doxygen will generate a # standard header. Notice: only use this tag if you know what you are doing! LATEX_HEADER = # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated # is prepared for conversion to pdf (using ps2pdf). The pdf file will # contain links (just like the HTML output) instead of page references # This makes the output suitable for online browsing using a pdf viewer. PDF_HYPERLINKS = YES # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of # plain latex in the generated Makefile. Set this option to YES to get a # higher quality PDF documentation. USE_PDFLATEX = YES # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. # command to the generated LaTeX files. This will instruct LaTeX to keep # running if errors occur, instead of asking the user for help. # This option is also used when generating formulas in HTML. LATEX_BATCHMODE = NO # If LATEX_HIDE_INDICES is set to YES then doxygen will not # include the index chapters (such as File Index, Compound Index, etc.) # in the output. LATEX_HIDE_INDICES = NO # If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER. LATEX_SOURCE_CODE = NO #--------------------------------------------------------------------------- # configuration options related to the RTF output #--------------------------------------------------------------------------- # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output # The RTF output is optimized for Word 97 and may not look very pretty with # other RTF readers or editors. GENERATE_RTF = NO # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `rtf' will be used as the default path. RTF_OUTPUT = rtf # If the COMPACT_RTF tag is set to YES Doxygen generates more compact # RTF documents. This may be useful for small projects and may help to # save some trees in general. COMPACT_RTF = NO # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated # will contain hyperlink fields. The RTF file will # contain links (just like the HTML output) instead of page references. # This makes the output suitable for online browsing using WORD or other # programs which support those fields. # Note: wordpad (write) and others do not support links. RTF_HYPERLINKS = NO # Load stylesheet definitions from file. Syntax is similar to doxygen's # config file, i.e. a series of assignments. You only have to provide # replacements, missing definitions are set to their default value. RTF_STYLESHEET_FILE = # Set optional variables used in the generation of an rtf document. # Syntax is similar to doxygen's config file. RTF_EXTENSIONS_FILE = #--------------------------------------------------------------------------- # configuration options related to the man page output #--------------------------------------------------------------------------- # If the GENERATE_MAN tag is set to YES (the default) Doxygen will # generate man pages GENERATE_MAN = NO # The MAN_OUTPUT tag is used to specify where the man pages will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `man' will be used as the default path. MAN_OUTPUT = man # The MAN_EXTENSION tag determines the extension that is added to # the generated man pages (default is the subroutine's section .3) MAN_EXTENSION = .3 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, # then it will generate one additional man file for each entity # documented in the real man page(s). These additional files # only source the real man page, but without them the man command # would be unable to find the correct page. The default is NO. MAN_LINKS = NO #--------------------------------------------------------------------------- # configuration options related to the XML output #--------------------------------------------------------------------------- # If the GENERATE_XML tag is set to YES Doxygen will # generate an XML file that captures the structure of # the code including all documentation. GENERATE_XML = NO # The XML_OUTPUT tag is used to specify where the XML pages will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `xml' will be used as the default path. XML_OUTPUT = xml # The XML_SCHEMA tag can be used to specify an XML schema, # which can be used by a validating XML parser to check the # syntax of the XML files. XML_SCHEMA = # The XML_DTD tag can be used to specify an XML DTD, # which can be used by a validating XML parser to check the # syntax of the XML files. XML_DTD = # If the XML_PROGRAMLISTING tag is set to YES Doxygen will # dump the program listings (including syntax highlighting # and cross-referencing information) to the XML output. Note that # enabling this will significantly increase the size of the XML output. XML_PROGRAMLISTING = YES #--------------------------------------------------------------------------- # configuration options for the AutoGen Definitions output #--------------------------------------------------------------------------- # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will # generate an AutoGen Definitions (see autogen.sf.net) file # that captures the structure of the code including all # documentation. Note that this feature is still experimental # and incomplete at the moment. GENERATE_AUTOGEN_DEF = NO #--------------------------------------------------------------------------- # configuration options related to the Perl module output #--------------------------------------------------------------------------- # If the GENERATE_PERLMOD tag is set to YES Doxygen will # generate a Perl module file that captures the structure of # the code including all documentation. Note that this # feature is still experimental and incomplete at the # moment. GENERATE_PERLMOD = NO # If the PERLMOD_LATEX tag is set to YES Doxygen will generate # the necessary Makefile rules, Perl scripts and LaTeX code to be able # to generate PDF and DVI output from the Perl module output. PERLMOD_LATEX = NO # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be # nicely formatted so it can be parsed by a human reader. # This is useful # if you want to understand what is going on. # On the other hand, if this # tag is set to NO the size of the Perl module output will be much smaller # and Perl will parse it just the same. PERLMOD_PRETTY = YES # The names of the make variables in the generated doxyrules.make file # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. # This is useful so different doxyrules.make files included by the same # Makefile don't overwrite each other's variables. PERLMOD_MAKEVAR_PREFIX = #--------------------------------------------------------------------------- # Configuration options related to the preprocessor #--------------------------------------------------------------------------- # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will # evaluate all C-preprocessor directives found in the sources and include # files. ENABLE_PREPROCESSING = YES # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro # names in the source code. If set to NO (the default) only conditional # compilation will be performed. Macro expansion can be done in a controlled # way by setting EXPAND_ONLY_PREDEF to YES. MACRO_EXPANSION = YES # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES # then the macro expansion is limited to the macros specified with the # PREDEFINED and EXPAND_AS_DEFINED tags. EXPAND_ONLY_PREDEF = YES # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files # in the INCLUDE_PATH (see below) will be search if a #include is found. SEARCH_INCLUDES = YES # The INCLUDE_PATH tag can be used to specify one or more directories that # contain include files that are not input files but should be processed by # the preprocessor. INCLUDE_PATH = # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard # patterns (like *.h and *.hpp) to filter out the header-files in the # directories. If left blank, the patterns specified with FILE_PATTERNS will # be used. INCLUDE_FILE_PATTERNS = # The PREDEFINED tag can be used to specify one or more macro names that # are defined before the preprocessor is started (similar to the -D option of # gcc). The argument of the tag is a list of macros of the form: name # or name=definition (no spaces). If the definition and the = are # omitted =1 is assumed. To prevent a macro definition from being # undefined via #undef or recursively expanded use the := operator # instead of the = operator. PREDEFINED = "QCC_DEPRECATED(func)=func" DOXYGEN_DOC # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then # this tag can be used to specify a list of macro names that should be expanded. # The macro definition that is found in the sources will be used. # Use the PREDEFINED tag if you want to use a different macro definition. EXPAND_AS_DEFINED = # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then # doxygen's preprocessor will remove all function-like macros that are alone # on a line, have an all uppercase name, and do not end with a semicolon. Such # function macros are typically used for boiler-plate code, and will confuse # the parser if not removed. SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- # Configuration::additions related to external references #--------------------------------------------------------------------------- # The TAGFILES option can be used to specify one or more tagfiles. # Optionally an initial location of the external documentation # can be added for each tagfile. The format of a tag file without # this location is as follows: # # TAGFILES = file1 file2 ... # Adding location for the tag files is done as follows: # # TAGFILES = file1=loc1 "file2 = loc2" ... # where "loc1" and "loc2" can be relative or absolute paths or # URLs. If a location is present for each tag, the installdox tool # does not have to be run to correct the links. # Note that each tag file must have a unique name # (where the name does NOT include the path) # If a tag file is not located in the directory in which doxygen # is run, you must also specify the path to the tagfile here. TAGFILES = # When a file name is specified after GENERATE_TAGFILE, doxygen will create # a tag file that is based on the input files it reads. GENERATE_TAGFILE = # If the ALLEXTERNALS tag is set to YES all external classes will be listed # in the class index. If set to NO only the inherited external classes # will be listed. ALLEXTERNALS = NO # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed # in the modules index. If set to NO, only the current project's groups will # be listed. EXTERNAL_GROUPS = YES # The PERL_PATH should be the absolute path and name of the perl script # interpreter (i.e. the result of `which perl'). PERL_PATH = /usr/bin/perl #--------------------------------------------------------------------------- # Configuration options related to the dot tool #--------------------------------------------------------------------------- # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base # or super classes. Setting the tag to NO turns the diagrams off. Note that # this option is superseded by the HAVE_DOT option below. This is only a # fallback. It is recommended to install and use dot, since it yields more # powerful graphs. CLASS_DIAGRAMS = YES # You can define message sequence charts within doxygen comments using the \msc # command. Doxygen will then run the mscgen tool (see # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the # documentation. The MSCGEN_PATH tag allows you to specify the directory where # the mscgen tool resides. If left empty the tool is assumed to be found in the # default search path. MSCGEN_PATH = # If set to YES, the inheritance and collaboration graphs will hide # inheritance and usage relations if the target is undocumented # or is not a class. HIDE_UNDOC_RELATIONS = YES # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is # available from the path. This tool is part of Graphviz, a graph visualization # toolkit from AT&T and Lucent Bell Labs. The other options in this section # have no effect if this option is set to NO (the default) HAVE_DOT = YES # By default doxygen will write a font called FreeSans.ttf to the output # directory and reference it in all dot files that doxygen generates. This # font does not include all possible unicode characters however, so when you need # these (or just want a differently looking font) you can specify the font name # using DOT_FONTNAME. You need need to make sure dot is able to find the font, # which can be done by putting it in a standard location or by setting the # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory # containing the font. #DOT_FONTNAME = FreeSans # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. # The default size is 10pt. DOT_FONTSIZE = 10 # By default doxygen will tell dot to use the output directory to look for the # FreeSans.ttf font (which doxygen will put there itself). If you specify a # different font using DOT_FONTNAME you can set the path where dot # can find it using this tag. DOT_FONTPATH = # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen # will generate a graph for each documented class showing the direct and # indirect inheritance relations. Setting this tag to YES will force the # the CLASS_DIAGRAMS tag to NO. CLASS_GRAPH = YES # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen # will generate a graph for each documented class showing the direct and # indirect implementation dependencies (inheritance, containment, and # class references variables) of the class with other documented classes. COLLABORATION_GRAPH = YES # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen # will generate a graph for groups, showing the direct groups dependencies GROUP_GRAPHS = YES # If the UML_LOOK tag is set to YES doxygen will generate inheritance and # collaboration diagrams in a style similar to the OMG's Unified Modeling # Language. UML_LOOK = NO # If set to YES, the inheritance and collaboration graphs will show the # relations between templates and their instances. TEMPLATE_RELATIONS = NO # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT # tags are set to YES then doxygen will generate a graph for each documented # file showing the direct and indirect include dependencies of the file with # other documented files. INCLUDE_GRAPH = YES # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and # HAVE_DOT tags are set to YES then doxygen will generate a graph for each # documented header file showing the documented files that directly or # indirectly include this file. INCLUDED_BY_GRAPH = YES # If the CALL_GRAPH and HAVE_DOT options are set to YES then # doxygen will generate a call dependency graph for every global function # or class method. Note that enabling this option will significantly increase # the time of a run. So in most cases it will be better to enable call graphs # for selected functions only using the \callgraph command. CALL_GRAPH = NO # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then # doxygen will generate a caller dependency graph for every global function # or class method. Note that enabling this option will significantly increase # the time of a run. So in most cases it will be better to enable caller # graphs for selected functions only using the \callergraph command. CALLER_GRAPH = NO # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen # will graphical hierarchy of all classes instead of a textual one. GRAPHICAL_HIERARCHY = YES # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES # then doxygen will show the dependencies a directory has on other directories # in a graphical way. The dependency relations are determined by the #include # relations between the files in the directories. DIRECTORY_GRAPH = YES # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images # generated by dot. Possible values are png, jpg, or gif # If left blank png will be used. DOT_IMAGE_FORMAT = png # The tag DOT_PATH can be used to specify the path where the dot tool can be # found. If left blank, it is assumed the dot tool can be found in the path. DOT_PATH = # The DOTFILE_DIRS tag can be used to specify one or more directories that # contain dot files that are included in the documentation (see the # \dotfile command). DOTFILE_DIRS = # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of # nodes that will be shown in the graph. If the number of nodes in a graph # becomes larger than this value, doxygen will truncate the graph, which is # visualized by representing a node as a red box. Note that doxygen if the # number of direct children of the root node in a graph is already larger than # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. DOT_GRAPH_MAX_NODES = 50 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the # graphs generated by dot. A depth value of 3 means that only nodes reachable # from the root by following a path via at most 3 edges will be shown. Nodes # that lay further from the root node will be omitted. Note that setting this # option to 1 or 2 may greatly reduce the computation time needed for large # code bases. Also note that the size of a graph can be further restricted by # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. MAX_DOT_GRAPH_DEPTH = 3 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent # background. This is disabled by default, because dot on Windows does not # seem to support this out of the box. Warning: Depending on the platform used, # enabling this option may lead to badly anti-aliased labels on the edges of # a graph (i.e. they become hard to read). DOT_TRANSPARENT = NO # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output # files in one run (i.e. multiple -o and -T options on the command line). This # makes dot run faster, but since only newer versions of dot (>1.8.10) # support this, this feature is disabled by default. DOT_MULTI_TARGETS = YES # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will # generate a legend page explaining the meaning of the various boxes and # arrows in the dot generated graphs. GENERATE_LEGEND = YES # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will # remove the intermediate dot files that are used to generate # the various graphs. DOT_CLEANUP = YES alljoyn-15.04b/alljoyn_c/docs/SConscript000066400000000000000000000023411255700255500202570ustar00rootroot00000000000000# Copyright AllSeen Alliance. All rights reserved. # # Permission to use, copy, modify, and/or distribute this software for any # purpose with or without fee is hereby granted, provided that the above # copyright notice and this permission notice appear in all copies. # # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. # import os Import('env') docenv = env.Clone() docenv['ENV']['C_DISTDIR'] = str(env.Dir('$C_DISTDIR')) # Build docs installDocs = [] if docenv['DOCS'] == 'html': installDocs = docenv.Doxygen(source='Doxygen_html') # Build Alias to make cleaning, building and rebuilding the documentation when # working only on the documentation simpler. This can be run by using # `scons c_docs` docenv.Alias('c_docs', installDocs) Return('installDocs') alljoyn-15.04b/alljoyn_c/docs/allJoynDocumentation000066400000000000000000000110351255700255500223320ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ /*This file will contain documentation for AllJoyn that does not fit in the source code. * This is also a location to document things that don't have a clear place where they * should be documented in the code. (i.e. namespace ajn). * * This file will be parsed by doxygen. Only text within the doxygen tags will show up in * the final documentation. */ /** @mainpage AllJoyn Documentation AllJoyn C API Reference Manual @section subsection1 Overview AllJoyn is a device-to-device communication protocol which enables mobile devices to support peer-to-peer applications such as multi-player gaming and social networking. AllJoyn is designed as a backwards-compatible extension of DBus, a standard protocol for inter-application communication in the Linux desktop environment. It offers the following features: - Cross platform/OS/device - Peer-to-peer communication - Simplified service discovery - Flexible security framework and trust models - Transport agnostic / multi-protocol support - Multi-language support for the AllJoyn API This document describes the C language binding for the AllJoyn API. It covers the following topics: - @ref section2 "Type Signatures" - @ref section3 "Messages" - @ref section4 "Signals" @section section2 Type Signatures AllJoyn uses the same type signatures that are used by the Dbus protocol. The type signature is made up of type codes . Type code is an ASCII character that represents a standard data type. The following table summarizes the AllJoyn types.
Conventional NameCodeDescription
INVALID0 (ASCII NUL)Not a valid type code, used to terminate signatures
BYTE121 (ASCII 'y')8-bit unsigned integer
BOOLEAN98 (ASCII 'b')Boolean value, 0 is FALSE and 1 is TRUE. Everything else is invalid.
INT16110 (ASCII 'n')16-bit signed integer
UINT16113 (ASCII 'q')16-bit unsigned integer
INT32105 (ASCII 'i')32-bit signed integer
UINT32117 (ASCII 'u')32-bit unsigned integer
INT64120 (ASCII 'x')64-bit signed integer
UINT64116 (ASCII 't')64-bit unsigned integer
DOUBLE100 (ASCII 'd')IEEE 754 double
STRING115 (ASCII 's')UTF-8 string (must be valid UTF-8). Must be nul terminated and contain no other nul bytes.
OBJECT_PATH111 (ASCII 'o')Name of an object instance
SIGNATURE103 (ASCII 'g')A type signature
ARRAY97 (ASCII 'a')Array
STRUCT114 (ASCII 'r'), 40 (ASCII '('), 41 (ASCII ')')Struct
VARIANT118 (ASCII 'v') Variant type (the type of the value is part of the value itself)
DICT_ENTRY101 (ASCII 'e'), 123 (ASCII '{'), 125 (ASCII '}') Entry in a dict or map (array of key-value pairs)
For of the types are container types. STRUCT, ARRAY, VARIANT, and DICT_ENTRY . All other types are a common basic data type. @section section3 Message A message is a unit of communication via the AllJoyn protocol. A message can send an receive any number of values. @section section4 Signals A signal is an outbound value that is transmitted on the bus. */ alljoyn-15.04b/alljoyn_c/docs/footer.html000077500000000000000000000024311255700255500204340ustar00rootroot00000000000000
$projectname $projectnumber ($datetime)
Copyright AllSeen Alliance, Inc. All Rights Reserved.

AllSeen, AllSeen Alliance, and AllJoyn are trademarks of the AllSeen Alliance, Inc in the United States and other jurisdictions.

THIS DOCUMENT AND ALL INFORMATION CONTAIN HEREIN ARE PROVIDED ON AN "AS-IS" BASIS WITHOUT WARRANTY OF ANY KIND.
MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATION
 alljoyn-15.04b/alljoyn_c/inc/000077500000000000000000000000001255700255500160665ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_c/inc/alljoyn_c/000077500000000000000000000000001255700255500200405ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_c/inc/alljoyn_c/AboutData.h000066400000000000000000000776331255700255500220750ustar00rootroot00000000000000/** * @file * alljoyn_aboutdata is responsible for storing data for the org.alljoyn.About interface. * This code is experimental, and as such has not been fully tested. * Please help make it more robust by contributing fixes if you find problems. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_ABOUTDATA_C_H #define _ALLJOYN_ABOUTDATA_C_H #include #include #ifdef __cplusplus extern "C" { #endif /** * alljoyn_aboutdata is responsible for holding the org.alljoyn.about interface * Data fields */ typedef struct _alljoyn_aboutdata_handle* alljoyn_aboutdata; /** * Allocate a new empty alljoyn_aboutdata object. The default language is not set. * Set the language using either one of the following functions: * - alljoyn_about_setdefaultlanguage * - alljoyn_about_createfrommsgarg * - alljoyn_about_createfromxml * * The default language should be specified before any tag that requires * localization. These tags are the following: * - DeviceName * - AppName * - Manufacturer * - Description * * @return The allocated alljoyn_aboutdata. */ extern AJ_API alljoyn_aboutdata AJ_CALL alljoyn_aboutdata_create_empty(); /** * Allocate a new alljoyn_aboutdata object setting the default language. * * @param defaultLanguage the default RFC 5646 language tag for the About data fields * * @return The allocated alljoyn_aboutdata. */ extern AJ_API alljoyn_aboutdata AJ_CALL alljoyn_aboutdata_create(const char* defaultLanguage); /** * Allocate a new alljoyn_aboutdata object filling in the fields of the About data * using an alljoyn_msgarg. The provided alljoyn_msgarg must contain a dictionary * with signature a{sv} with About data fields. * * If the passed in alljoyn_msgarg is an ill formed About data alljoyn_msgarg * this call fails silently. If the alljoyn_msgarg does not come from an About * Announce signal it is best to create an empty alljoyn_aboutdata object * and use the alljoyn_about_createfrommsgarg function to fill in the About data. * * @param arg alljoyn_msgarg with signature a{sv}containing About data fields. * @param language the language of the arg alljoyn_msgarg. Use NULL for default language * * @return The allocated alljoyn_aboutdata. */ extern AJ_API alljoyn_aboutdata AJ_CALL alljoyn_aboutdata_create_full(const alljoyn_msgarg arg, const char* language); /** * Free an alljoyn_aboutdata object. * * @param data The alljoyn_aboutdata to be freed. */ extern AJ_API void AJ_CALL alljoyn_aboutdata_destroy(alljoyn_aboutdata data); /** * Initialize the About data held by the specified alljoyn_aboutdata object * from a character string containing the XML representation of the About data * specified as an \ element containing \, \, etc. * * The AllJoyn software version (AJSoftwareVersion) is automatically set to * the version of Alljoyn that is being used. The SupportedLanguages tag is * automatically implied from the DefaultLanguage tag and the lang annotation * from tags that are localizable. * * @param[in] data alljoyn_aboutdata object this call is made for * @param[in] aboutDataXml a string that contains an XML representation of * the About data fields. * @return ER_OK on success */ extern AJ_API QStatus AJ_CALL alljoyn_aboutdata_createfromxml(alljoyn_aboutdata data, const char* aboutDataXml); /** * Validate if the About data has all of the required fields. If a language * field is given this will return if all required fields are listed for the * given language. If no language is given default language will be checked. * * @param[in] data alljoyn_aboutdata object this call is made for * @param[in] language IETF language tag specified by RFC 5646 * * @return true if all required field are listed for the given language */ extern AJ_API bool AJ_CALL alljoyn_aboutdata_isvalid(alljoyn_aboutdata data, const char* language); /** * Fill in the About Data fields from the given alljoyn_msgarg. This alljoyn_msgarg * must contain a dictionary of type a{sv} and is expected to be either obtained * from an Announce signal or from the GetAboutData method of the org.alljoyn.about * interface. * * @param data alljoyn_aboutdata object this call is made for * @param arg alljoyn_msgarg contain About data dictionary * @param language the language for the alljoyn_msgarg About data * If NULL the default language is used * * @return ER_OK on success */ extern AJ_API QStatus AJ_CALL alljoyn_aboutdata_createfrommsgarg(alljoyn_aboutdata data, const alljoyn_msgarg arg, const char* language); /** * Set the AppId for the About data * * AppId (the appId argument) must be a 128-bit UUID as specified by RFC 4122 * * AppId IS required * AppId IS part of the Announce signal * AppId CAN NOT be localized for other languages * * @param[in] data alljoyn_aboutdata object this call is made for * @param[in] appId the a globally unique array of bytes used as an Id for the application * @param[in] num the number of bytes in the appId array * * @return * - ER_OK on success * - #ER_ABOUT_INVALID_ABOUTDATA_FIELD_VALUE if appId is not 128-bits (16 bytes) in size */ extern AJ_API QStatus AJ_CALL alljoyn_aboutdata_setappid(alljoyn_aboutdata data, const uint8_t* appId, const size_t num); /** * Set the AppId for the About data using a character string. * * The string must be a ether a 32-character hex digit string * (for example "4a354637564945188a48323c158bc02d") or a UUID string as * specified in RFC 4122 (for example: "4a354637-5649-4518-8a48-323c158bc02d"). * The AppId contained by this string must be a 128-bit UUID as specified by RFC 4122. * * AppId IS required * AppId IS part of the Announce signal * AppId CAN NOT be localized for other languages * * @param[in] data alljoyn_aboutdata object this call is made for * @param[in] appId the a globally unique string of characters used as an Id for the application * * @return * - #ER_OK on success * - #ER_ABOUT_INVALID_ABOUTDATA_FIELD_VALUE if the AppId is not a 128-bits (16 bytes) in size */ extern AJ_API QStatus AJ_CALL alljoyn_aboutdata_setappid_fromstring(alljoyn_aboutdata data, const char* appId); /** * Get the AppId from the About data * * AppId IS required * AppId IS part of the Announce signal * AppId CAN NOT be localized for other languages * * @param[in] data alljoyn_aboutdata object this call is made for * @param[out] appId a pointer to an array of bytes used as a globally unique ID for an application * @param[out] num the size of the appId array * * @return ER_OK on success */ extern AJ_API QStatus AJ_CALL alljoyn_aboutdata_getappid(alljoyn_aboutdata data, uint8_t** appId, size_t* num); /** * The given language is automatically added to the SupportedLanguage list. * The language tag should be an IETF language tag specified by RFC 5646. * * DefaultLanguage is Required * DefaultLanguage is part of the Announce signal * * @param[in] data alljoyn_aboutdata object this call is made for * @param[in] defaultLanguage the IETF language tag * * @return ER_OK on success */ extern AJ_API QStatus AJ_CALL alljoyn_aboutdata_setdefaultlanguage(alljoyn_aboutdata data, const char* defaultLanguage); /** * Get the DefaultLanguage from the About data * * @param[in] data alljoyn_aboutdata object this call is made for * @param[out] defaultLanguage a pointer to the default language tag * * @return ER_OK on success */ extern AJ_API QStatus AJ_CALL alljoyn_aboutdata_getdefaultlanguage(alljoyn_aboutdata data, char** defaultLanguage); /** * Set the DeviceName to the About data * * DeviceName is not required * DeviceName is part of the Announce signal * DeviceName can be localized for other languages * * @param[in] data alljoyn_aboutdata object this call is made for * @param[in] deviceName the deviceName (alljoyn_aboutdata data, UTF-8 encoded string) * @param[in] language the IETF language tag specified by RFC 5646 * If language is NULL the DeviceName will be set for the default language * * @return * - #ER_OK on success * - #ER_ABOUT_DEFAULT_LANGUAGE_NOT_SPECIFIED if language tag was not specified * and the default language is also * not found. */ extern AJ_API QStatus AJ_CALL alljoyn_aboutdata_setdevicename(alljoyn_aboutdata data, const char* deviceName, const char* language); /** * Get the DeviceName from the About data * * DeviceName is not required * DeviceName is part of the Announce signal * DeviceName can be localized for other languages * * @param[in] data alljoyn_aboutdata object this call is made for * @param[out] deviceName the deviceName found in the About data (alljoyn_aboutdata data, UTF-8 encoded string) * @param[in] language the IETF language tag specified by RFC 5646 * If language is NULL the DeviceName for the default language will be returned * * @return ER_OK on success */ extern AJ_API QStatus AJ_CALL alljoyn_aboutdata_getdevicename(alljoyn_aboutdata data, char** deviceName, const char* language); /** * Set the DeviceId from the About data * * DeviceId IS required * DeviceId IS part of the announce signal * DeviceId CAN NOT be localized for other languages * * @param[in] data alljoyn_aboutdata object this call is made for * @param[in] deviceId is a string with a value generated using platform specific means * * @return ER_OK on success */ extern AJ_API QStatus AJ_CALL alljoyn_aboutdata_setdeviceid(alljoyn_aboutdata data, const char* deviceId); /** * Get the DeviceId from the About data * * DeviceId IS required * DeviceId IS part of the announce signal * DeviceId CAN NOT be localized for other languages * * @param[in] data alljoyn_aboutdata object this call is made for * @param[out] deviceId UTF-8 string with a value generated using platform specific means * * @return ER_OK on success */ extern AJ_API QStatus AJ_CALL alljoyn_aboutdata_getdeviceid(alljoyn_aboutdata data, char** deviceId); /** * Set the AppName to the About data * * AppName is required * AppName is part of the announce signal * AppName can be localized for other languages * * @param[in] data alljoyn_aboutdata object this call is made for * @param[in] appName the AppName (alljoyn_aboutdata data, UTF-8 encoded string) * @param[in] language the IETF language tag specified by RFC 5646 * If language is NULL the AppName will be set for the default language. * * @return * - #ER_OK on success * - #ER_ABOUT_DEFAULT_LANGUAGE_NOT_SPECIFIED if language tag was not specified * and the default language is also * not found. */ extern AJ_API QStatus AJ_CALL alljoyn_aboutdata_setappname(alljoyn_aboutdata data, const char* appName, const char* language); /** * Get the AppName from the About data * * AppName is required * AppName is part of the announce signal * AppName can be localized for other languages * * @param[in] data alljoyn_aboutdata object this call is made for * @param[out] appName the AppName found in the About data (alljoyn_aboutdata data, UTF-8 encoded string) * @param[in] language the IETF language tag specified by RFC 5646 * If language is NULL the AppName for the default language will be returned. * * @return ER_OK on success */ extern AJ_API QStatus AJ_CALL alljoyn_aboutdata_getappname(alljoyn_aboutdata data, char** appName, const char* language); /** * Set the Manufacturer to the About data * * Manufacturer is required * Manufacturer is part of the announce signal * Manufacturer can be localized for other languages * * @param[in] data alljoyn_aboutdata object this call is made for * @param[in] manufacturer the Manufacturer (alljoyn_aboutdata data, UTF-8 encoded string) * @param[in] language the IETF language tag specified by RFC 5646 * If language is NULL the Manufacture will be set for the default language. * * @return * - #ER_OK on success * - #ER_ABOUT_DEFAULT_LANGUAGE_NOT_SPECIFIED if language tag was not specified * and the default language is also * not found. */ extern AJ_API QStatus AJ_CALL alljoyn_aboutdata_setmanufacturer(alljoyn_aboutdata data, const char* manufacturer, const char* language); /** * Get the Manufacturer from the About data * * Manufacturer is required * Manufacturer is part of the announce signal * Manufacturer can be localized for other languages * * @param[in] data alljoyn_aboutdata object this call is made for * @param[out] manufacturer the Manufacturer found in the About data (alljoyn_aboutdata data, UTF-8 encoded string) * @param[in] language the IETF language tag specified by RFC 5646 * If language is NULL the Manufacturer for the default language will be returned. * * @return ER_OK on success */ extern AJ_API QStatus AJ_CALL alljoyn_aboutdata_getmanufacturer(alljoyn_aboutdata data, char** manufacturer, const char* language); /** * Set the ModelNumber to the About data * * ModelNumber is required * ModelNumber is part of the announce signal * ModelNumber can not be localized for other languages * * @param[in] data alljoyn_aboutdata object this call is made for * @param[in] modelNumber the application model number * * @return ER_OK on success */ extern AJ_API QStatus AJ_CALL alljoyn_aboutdata_setmodelnumber(alljoyn_aboutdata data, const char* modelNumber); /** * Get the ModelNumber from the About data * * ModelNumber IS required * ModelNumber IS part of the announce signal * ModelNumber CAN NOT be localized for other languages * * @param[in] data alljoyn_aboutdata object this call is made for * @param[out] modelNumber the application model number * * @return ER_OK on success */ extern AJ_API QStatus AJ_CALL alljoyn_aboutdata_getmodelnumber(alljoyn_aboutdata data, char** modelNumber); /** * Set a supported language. * * This is a string representing the a single language. The language is * specified using IETF language tags specified by the RFC 5646. * * If the language tag has already been added ER_OK will be returned with no * additional changes being made. * * @param[in] data alljoyn_aboutdata object this call is made for * @param[in] language the IETF language tag * * @return ER_OK on success */ extern AJ_API QStatus AJ_CALL alljoyn_aboutdata_setsupportedlanguage(alljoyn_aboutdata data, const char* language); /** * Get an array of supported languages * * @param data alljoyn_aboutdata object this call is made for * @param languageTags a pointer to a languageTags array to receive the * language tags. Can be NULL in which case no * language tags are returned and the return value gives * the number of language tags available. * @param num the size of the languageTags array. * * @return The number of languageTags returned or the total number of * language tags if languageTags is NULL. */ extern AJ_API size_t AJ_CALL alljoyn_aboutdata_getsupportedlanguages(alljoyn_aboutdata data, const char** languageTags, size_t num); /** * Set the Description to the About data * * Description IS required * Description IS NOT part of the announce signal * Description CAN BE localized for other languages * * @param[in] data alljoyn_aboutdata object this call is made for * @param[in] description the Description (alljoyn_aboutdata data, UTF-8 encoded string) * @param[in] language the IETF language tag specified by RFC 5646 * If language is NULL the Description will be set for the default language. * * @return * - #ER_OK on success * - #ER_ABOUT_DEFAULT_LANGUAGE_NOT_SPECIFIED if language tag was not specified and * the default language is also not found. */ extern AJ_API QStatus AJ_CALL alljoyn_aboutdata_setdescription(alljoyn_aboutdata data, const char* description, const char* language); /** * Get the Description from the About data * * Description IS required * Description IS NOT part of the announce signal * Description CAN BE localized for other languages * * @param[in] data alljoyn_aboutdata object this call is made for * @param[out] description the Description found in the About data (alljoyn_aboutdata data, UTF-8 encoded string) * @param[in] language the IETF language tag specified by RFC 5646 * If language is NULL the Description for the default language will be returned. * * @return ER_OK on success */ extern AJ_API QStatus AJ_CALL alljoyn_aboutdata_getdescription(alljoyn_aboutdata data, char** description, const char* language); /** * Set the DateOfManufacture to the About data * * The date of manufacture using the format YYYY-MM-DD. Known as XML * DateTime format. * * DateOfManufacture IS NOT required * DateOfManufacture IS NOT part of the announce signal * DateOfManufacture CAN NOT be localized for other languages * * @param[in] data alljoyn_aboutdata object this call is made for * @param[in] dateOfManufacture the date of manufacture using YYYY-MM-DD format * * @return ER_OK on success */ extern AJ_API QStatus AJ_CALL alljoyn_aboutdata_setdateofmanufacture(alljoyn_aboutdata data, const char* dateOfManufacture); /** * Get the DateOfManufacture from the About data * * The date of manufacture using the format YYYY-MM-DD. Known as XML * DateTime format. * * DateOfManufacture IS NOT required * DateOfManufacture IS NOT part of the announce signal * DateOfManufacture CAN NOT be localized for other languages * * @param[in] data alljoyn_aboutdata object this call is made for * @param[out] dateOfManufacture the date of manufacture using YYYY-MM-DD format * * @return ER_OK on success */ extern AJ_API QStatus AJ_CALL alljoyn_aboutdata_getdateofmanufacture(alljoyn_aboutdata data, char** dateOfManufacture); /** * Set the SoftwareVersion to the About data * * SoftwareVersion IS required * SoftwareVersion IS NOT part of the announce signal * SoftwareVersion CAN NOT be localized for other languages * * @param[in] data alljoyn_aboutdata object this call is made for * @param[in] softwareVersion the software version for the OEM software * * @return ER_OK on success */ extern AJ_API QStatus AJ_CALL alljoyn_aboutdata_setsoftwareversion(alljoyn_aboutdata data, const char* softwareVersion); /** * Get the SoftwareVersion from the About data * * SoftwareVersion IS required * SoftwareVersion IS NOT part of the announce signal * SoftwareVersion CAN NOT be localized for other languages * * @param[in] data alljoyn_aboutdata object this call is made for * @param[out] softwareVersion the software version for the OEM software * * @return ER_OK on success */ extern AJ_API QStatus AJ_CALL alljoyn_aboutdata_getsoftwareversion(alljoyn_aboutdata data, char** softwareVersion); /** * Get the AJSoftwareVersion from the About data * * The AJSoftwareVersion is automatically set when the About data is created * or when it is read from remote device. * * AJSoftwareVersion IS required * AJSoftwareVersion IS NOT part of the announce signal * AJSoftwareVersion CAN NOT be localized for other languages * * @param[in] data alljoyn_aboutdata object this call is made for * @param[out] ajSoftwareVersion the current version of AllJoyn SDK utilized * by the application * * @return ER_OK on success */ extern AJ_API QStatus AJ_CALL alljoyn_aboutdata_getajsoftwareversion(alljoyn_aboutdata data, char** ajSoftwareVersion); /** * Set the HardwareVersion to the About data * * HardwareVersion IS NOT required * HardwareVersion IS NOT part of the announce signal * HardwareVersion CAN NOT be localized for other languages * * @param[in] data alljoyn_aboutdata object this call is made for * @param[in] hardwareVersion the device hardware version * * @return ER_OK on success */ extern AJ_API QStatus AJ_CALL alljoyn_aboutdata_sethardwareversion(alljoyn_aboutdata data, const char* hardwareVersion); /** * Get the HardwareVersion from the About data * * HardwareVersion IS NOT required * HardwareVersion IS NOT part of the announce signal * HardwareVersion CAN NOT be localized for other languages * * @param[in] data alljoyn_aboutdata object this call is made for * @param[out] hardwareVersion the device hardware version * * @return ER_OK on success */ extern AJ_API QStatus AJ_CALL alljoyn_aboutdata_gethardwareversion(alljoyn_aboutdata data, char** hardwareVersion); /** * Set the SupportUrl to the About data * * SupportUrl IS NOT required * SupportUrl IS NOT part of the announce signal * SupportUrl CAN NOT be localized for other languages * * @param[in] data alljoyn_aboutdata object this call is made for * @param[in] supportUrl the support URL to be populated by OEM * * @return ER_OK on success */ extern AJ_API QStatus AJ_CALL alljoyn_aboutdata_setsupporturl(alljoyn_aboutdata data, const char* supportUrl); /** * Get the SupportUrl from the About data * * SupportUrl IS NOT required * SupportUrl IS NOT part of the announce signal * SupportUrl CAN NOT be localized for other languages * * @param[in] data alljoyn_aboutdata object this call is made for * @param[out] supportUrl the support URL * * @return ER_OK on success */ extern AJ_API QStatus AJ_CALL alljoyn_aboutdata_getsupporturl(alljoyn_aboutdata data, char** supportUrl); /** * Generic way to set a new field. Everything could be done this way. * * Unless the generic field is one of the pre-defined fields when they are * set they will have the following specifications * NOT required * NOT part of the announce signal * CAN be localized * * Since every field can be localized even if the field is not localized it * must be set for every language. * * @param[in] data alljoyn_aboutdata object this call is made for * @param[in] name the name of the field to set * @param[in] value a alljoyn_msgarg that contains the value that is set for the field * @param[in] language the IETF language tag specified by RFC 5646 * if language is NULL the default language will be used. Only * used for fields that are marked as localizable. * * @return * - #ER_OK on success * - #ER_ABOUT_DEFAULT_LANGUAGE_NOT_SPECIFIED if language tag was not specified * and the default language is also * not found. */ extern AJ_API QStatus AJ_CALL alljoyn_aboutdata_setfield(alljoyn_aboutdata data, const char* name, alljoyn_msgarg value, const char* language); /** * Generic way to get a field. * * @param[in] data alljoyn_aboutdata object this call is made for * @param[in] name the name of the field to get * @param[out] value alljoyn_msgarg holding a variant value that represents the field * @param[in] language the IETF language tag specified by RFC 5646 * If language is NULL the field for the default language will be returned. * * @return ER_OK on success */ extern AJ_API QStatus AJ_CALL alljoyn_aboutdata_getfield(alljoyn_aboutdata data, const char* name, alljoyn_msgarg* value, const char* language); /** * Get a list of the fields contained in this alljoyn_aboutdata object. * This is required if the About data comes from a remote source. User defined fields * are permitted. Use the GetFields method to get a list of all fields * currently found known by the alljoyn_aboutdata. * * @param[in] data alljoyn_aboutdata object this call is made for * @param[out] fields an array of const char* that will contain all the strings * @param[in] num_fields the size of the array * * @return * The number of fields returned or the total number of fields if the fields parameter is NULL */ extern AJ_API size_t AJ_CALL alljoyn_aboutdata_getfields(alljoyn_aboutdata data, const char** fields, size_t num_fields); /** * @param[in] data alljoyn_aboutdata object this call is made for * @param[out] msgArg the dictionary containing all of the About data fields for * the specified language. If language is not specified the default * language will be returned * @param[in] language IETF language tag specified by RFC 5646 if the string * is NULL or an empty string for the default language * * @return * - ER_OK on success * - ER_LANGUAGE_NOT_SUPPORTED if language is not supported * - ER_ABOUT_ABOUTDATA_MISSING_REQUIRED_FIELD if a required field is missing * - other error indicating failure */ extern AJ_API QStatus AJ_CALL alljoyn_aboutdata_getaboutdata(alljoyn_aboutdata data, alljoyn_msgarg msgArg, const char* language); /** * Return a alljoyn_msgarg pointer containing dictionary containing the About data that * is announced with the org.alljoyn.About.announce signal. * This will always be the default language and will only contain the fields * that are announced. * * The fields that will be part of the announced alljoyn_msgarg are: * - AppId * - DefaultLanguage * - DeviceName * - DeviceId * - AppName * - Manufacture * - ModelNumber * * If you require other fields or need the localized About data the * org.alljoyn.About.GetAboutData method can be used. * * @param[in] data alljoyn_aboutdata object this call is made for * @param[out] msgArg a alljoyn_msgarg dictionary with the a{sv} that contains the Announce * data. * @return ER_OK if successful */ extern AJ_API QStatus AJ_CALL alljoyn_aboutdata_getannouncedaboutdata(alljoyn_aboutdata data, alljoyn_msgarg msgArg); /** * Is the given field name required to make an About announcement * * @param[in] data alljoyn_aboutdata object this call is made for * @param[in] fieldName the name of the field * * @return * - true if the field is required to make an About announcement * - false otherwise. If the fieldName is unknown false will be returned */ extern AJ_API bool AJ_CALL alljoyn_aboutdata_isfieldrequired(alljoyn_aboutdata data, const char* fieldName); /** * Is the given field part of the announce signal * * @param[in] data alljoyn_aboutdata object this call is made for * @param[in] fieldName the name of the field * * @return * - true if the field is part of the announce signal * - false otherwise. If the fieldName is unknown false will be returned */ extern AJ_API bool AJ_CALL alljoyn_aboutdata_isfieldannounced(alljoyn_aboutdata data, const char* fieldName); /** * Is the given field a localized field. * * Localized fields should be provided for every supported language * * @param[in] data alljoyn_aboutdata object this call is made for * @param[in] fieldName the name of the field * * @return * - true if the field is a localizable value * - false otherwise. If the fieldName is unknown false will be returned. */ extern AJ_API bool AJ_CALL alljoyn_aboutdata_isfieldlocalized(alljoyn_aboutdata data, const char* fieldName); /** * Get the signature for the given field. * * @param[in] data alljoyn_aboutdata object this call is made for * @param[in] fieldName the name of the field * * @return * - the signature of the field * - NULL is field is unknown */ extern AJ_API const char* AJ_CALL alljoyn_aboutdata_getfieldsignature(alljoyn_aboutdata data, const char* fieldName); #ifdef __cplusplus } /* extern "C" */ #endif #endif alljoyn-15.04b/alljoyn_c/inc/alljoyn_c/AboutDataListener.h000066400000000000000000000142041255700255500235640ustar00rootroot00000000000000/* * @file * alljoyn_aboutdatalistener provides a Listener implemented by AllJoyn apps and called * by AllJoyn. The Listener is responsible for providing a well formed alljoyn_msgarg * dictionary of type a{sv} that contain the fields specified in the About interface. * This code is experimental, and as such has not been fully tested. * Please help make it more robust by contributing fixes if you find problems. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_ABOUTDATALISTENER_C_H #define _ALLJOYN_ABOUTDATALISTENER_C_H #include #include #ifdef __cplusplus extern "C" { #endif typedef struct _alljoyn_aboutdatalistener_handle* alljoyn_aboutdatalistener; /** * Type for the GetAboutData callback. * * This callback is invoked to create the alljoyn_msgarg that is returned when * a user calls org.alljoyn.About.GetAboutData. The returned alljoyn_msgarg contains * the AboutData dictionary for the specified language. * * The alljoyn_msgarg must contain the signature `a{sv}`. * * Custom fields are allowed. Since the proxy object only receives the field * name and the alljoyn_msgarg containing the contents of that for that field * the default assumption is that user defined fields are: * - not required * - not announced * - localized if the alljoyn_msgarg contains a String (not localized otherwise) * * Important: All implementations of GetAboutData should handle language * specified as an empty string or NULL. In the case that the language is * not specified the GetAboutData is expected to return the default language. * * If the language tag given is not supported return the QStatus * #ER_LANGUAGE_NOT_SUPPORTED. If the user has not provided ALL of the * required fields return the QStatus #ER_ABOUT_ABOUTDATA_MISSING_REQUIRED_FIELD * * @param[in] context the context pointer that was passed into the * alljoyn_aboutdatalistener_create function * @param[out] msgArg dictionary containing all of the AboutData fields for * the specified language. If language is not specified the default * language will be returned * @param[in] language IETF language tags specified by RFC 5646 if the string * is NULL or an empty string the MsgArg for the default * language will be returned * * @return * - #ER_OK on successful * - #ER_LANGUAGE_NOT_SUPPORTED if language is not supported * - #ER_ABOUT_ABOUTDATA_MISSING_REQUIRED_FIELD if a required field is missing * - other error indicating failure */ typedef QStatus (AJ_CALL * alljoyn_aboutdatalistener_getaboutdata_ptr)(const void* context, alljoyn_msgarg msgArg, const char* language); /** * Type for the GetAnnouncedAboutData callback. * * This callback is invoked to return an alljoyn_msgarg object containing * a dictionary with the Announce portion of the AboutData. * * The Announced values must use the default language and must only contain * the fields that are announced. * * The fields required to be part of the announced alljoyn_msgarg are: * - AppId * - DefaultLanguage * - DeviceName (Optional since v14.12) * - DeviceId * - AppName * - Manufacture * - ModelNumber * * To read other fields or get the localized value of a field use the * org.alljoyn.About.GetAboutData method. This method is available using the * AboutProxy class. * * @param[in] context the context pointer that was passed into the * alljoyn_aboutdatalistener_create function * @param[out] msgArg an alljoyn_msgarg dictionary with the a{sv} that contains * the Announce data * @return ER_OK if successful */ typedef QStatus (AJ_CALL * alljoyn_aboutdatalistener_getannouncedaboutdata_ptr)(const void* context, alljoyn_msgarg msgArg); /** * Struct containing callbacks used for creation of an alljoyn_aboutdatalistener. */ typedef struct { /** * Handler to get the complete alljoyn_aboutdata for a given language */ alljoyn_aboutdatalistener_getaboutdata_ptr about_datalistener_getaboutdata; /** * Handler to get the announced alljoyn_aboutdata for the default language */ alljoyn_aboutdatalistener_getannouncedaboutdata_ptr about_datalistener_getannouncedaboutdata; } alljoyn_aboutdatalistener_callbacks; /** * Create a new alljoyn_aboutdatalistener object. * This object will invoke the provided callbacks passing in the provided context. * @return The allocated alljoyn_aboutdatalistener. */ extern AJ_API alljoyn_aboutdatalistener AJ_CALL alljoyn_aboutdatalistener_create(const alljoyn_aboutdatalistener_callbacks* callbacks, const void* context); /** * Free an alljoyn_aboutdatalistener object. * * @param listener The alljoyn_aboutdatalistener to be freed. */ extern AJ_API void AJ_CALL alljoyn_aboutdatalistener_destroy(alljoyn_aboutdatalistener listener); #ifdef __cplusplus } /* extern "C" */ #endif #endif /* _ALLJOYN_ABOUTDATALISTENER_C_H */ alljoyn-15.04b/alljoyn_c/inc/alljoyn_c/AboutIcon.h000066400000000000000000000120071255700255500220740ustar00rootroot00000000000000/** * @file * alljoyn_abouticon is a container that holds information about an About icon. * This code is experimental, and as such has not been fully tested. * Please help make it more robust by contributing fixes if you find problems. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_ABOUTICON_C_H #define _ALLJOYN_ABOUTICON_C_H #include #include #ifdef __cplusplus extern "C" { #endif /** * container to hold information about the Icon */ typedef struct _alljoyn_abouticon_handle* alljoyn_abouticon; /** * Allocate a new empty alljoyn_abouticon object. * @return The allocated alljoyn_abouticon. */ extern AJ_API alljoyn_abouticon AJ_CALL alljoyn_abouticon_create(); /** * Free an alljoyn_abouticon object. * * @param icon the alljoyn_abouticon to be freed. */ extern AJ_API void AJ_CALL alljoyn_abouticon_destroy(alljoyn_abouticon icon); /** * Set the content for an icon. The content must fit into a alljoyn_msgarg so the * largest size for the icon data is ALLJOYN_MAX_ARRAY_LEN bytes. * * Note as long as the Media Type matches it is possible to set both icon content * and icon URL * * If an error is returned the icon content will remain unchanged. * * @param[in] icon the alljoyn_abouticon object this call is made for * @param[in] type a Media Type indicating the icon image type. Typical * value will be `image/jpeg` or `image/png` * @param[in] data pointer to an array of bytes that represent an icon * @param[in] csize the number of bytes in data * @param[in] ownsData if true the alljoyn_abouticon contain gains ownership of the * data that data points to. The alljoyn_abouticon object will * be responsible for freeing the memory. If false user is * is responsible for freeing memory pointed to by data. * @return * - ER_OK on success * - ER_BUS_BAD_VALUE if the data is to large to be marshaled * - other status indicating failure */ extern AJ_API QStatus AJ_CALL alljoyn_abouticon_setcontent(alljoyn_abouticon icon, const char* type, uint8_t* data, size_t csize, bool ownsData); /** * Set a url that contain the icon for the application. * * Note as long as the Media Type matches it is possible to set both icon content * and icon URL * * @param[in] icon the alljoyn_abouticon object this call is made for * @param[in] type a Media Type indicating the icon image type. Typical * value will be `image/jpeg` or `image/png` * @param[in] url a URL that contain the location of the icon hosted in * the cloud. * @return * - #ER_OK on success * - other status indicating failure */ extern AJ_API QStatus AJ_CALL alljoyn_abouticon_seturl(alljoyn_abouticon icon, const char* type, const char* url); /** * Clear the alljoyn_abouticon. This will change all strings to empty strings * set the content to NULL and the contentSize to zero. * * @param[in] icon the alljoyn_abouticon object this call is made for */ extern AJ_API void AJ_CALL alljoyn_abouticon_clear(alljoyn_abouticon icon); /** * Add the IconContent from an alljoyn_msgarg. This will make a local copy of the * alljoyn_msgarg passed in and expose the contents as the member variables content * and contentSize. * * @param[in] icon the alljoyn_abouticon object this call is made for * @param[in] arg the alljoyn_msgarg containing the Icon * * @return * - ER_OK on success * - status indicating failure otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_abouticon_setcontent_frommsgarg(alljoyn_abouticon icon, const alljoyn_msgarg arg); #ifdef __cplusplus } /* extern "C" */ #endif #endif //_ALLJOYN_ABOUTICON_C_H alljoyn-15.04b/alljoyn_c/inc/alljoyn_c/AboutIconObj.h000066400000000000000000000045251255700255500225350ustar00rootroot00000000000000/** * @file * alljoyn_abouticonobj represents a bus object that implements the org.alljoyn.Icon interface. * This code is experimental, and as such has not been fully tested. * Please help make it more robust by contributing fixes if you find problems. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_ABOUTICONOBJ_C_H #define _ALLJOYN_ABOUTICONOBJ_C_H #include #include #include #include #ifdef __cplusplus extern "C" { #endif /** * alljoyn_abouticonobj is an AllJoyn BusObject that implements the * org.alljoyn.Icon standard interface. Applications that provide AllJoyn IoE * services to receive info about the Icon of the service. */ typedef struct _alljoyn_abouticonobj_handle* alljoyn_abouticonobj; /** * Allocate a new alljoyn_abouticonobj object. * * @param bus the bus * @param icon the icon content * * @return The allocated alljoyn_abouticonobj. */ extern AJ_API alljoyn_abouticonobj AJ_CALL alljoyn_abouticonobj_create(alljoyn_busattachment bus, alljoyn_abouticon icon); /** * Free an alljoyn_abouticonobj object. * * @param icon the alljoyn_abouticonobj to be freed. */ extern AJ_API void AJ_CALL alljoyn_abouticonobj_destroy(alljoyn_abouticonobj icon); #ifdef __cplusplus } /* extern "C" */ #endif #endif /* _ALLJOYN_ABOUTICONOBJ_C_H */ alljoyn-15.04b/alljoyn_c/inc/alljoyn_c/AboutIconProxy.h000066400000000000000000000070231255700255500231400ustar00rootroot00000000000000/** * @file * alljoyn_abouticonproxy implements a proxy bus object used to interact with * a remote org.alljoyn.Icon interface. * This code is experimental, and as such has not been fully tested. * Please help make it more robust by contributing fixes if you find problems. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_ABOUTICONPROXY_C_H #define _ALLJOYN_ABOUTICONPROXY_C_H #include #include #include #include #ifdef __cplusplus extern "C" { #endif /** * alljoyn_abouticonproxy enables the user to interact with the remote AboutIcon * BusObject. */ typedef struct _alljoyn_abouticonproxy_handle* alljoyn_abouticonproxy; /** * Allocate a new alljoyn_abouticonproxy object. * * @param bus reference to bus attachment object * @param[in] busName Unique or well-known name of an AllJoyn bus you have joined * @param[in] sessionId the session received after joining an AllJoyn session * * @return The allocated alljoyn_abouticonproxy. */ extern AJ_API alljoyn_abouticonproxy AJ_CALL alljoyn_abouticonproxy_create(alljoyn_busattachment bus, const char* busName, alljoyn_sessionid sessionId); /** * Free an alljoyn_abouticonproxy object. * * @param proxy The alljoyn_abouticonproxy to be freed. */ extern AJ_API void AJ_CALL alljoyn_abouticonproxy_destroy(alljoyn_abouticonproxy proxy); /** * This method makes multiple proxy bus object method calls to fill in the * content of the alljoyn_abouticon. Its possible for any of the method calls * to fail causing this member function to return an error status. * * @param[in] proxy alljoyn_abouticonproxy object * @param[out] icon alljoyn_abouticon that holds icon content * @return * - #ER_OK if successful * - an error status indicating failure to get the icon content */ extern AJ_API QStatus AJ_CALL alljoyn_abouticonproxy_geticon(alljoyn_abouticonproxy proxy, alljoyn_abouticon icon); /** * @param[in] proxy alljoyn_abouticonproxy object * @param[out] version the version of the remote AboutIcon BusObject * * @return * - #ER_OK if successful * - an error status indicating failure */ extern AJ_API QStatus AJ_CALL alljoyn_abouticonproxy_getversion(alljoyn_abouticonproxy proxy, uint16_t* version); #ifdef __cplusplus } /* extern "C" */ #endif #endif /* _ALLJOYN_ABOUTICONPROXY_C_H */ alljoyn-15.04b/alljoyn_c/inc/alljoyn_c/AboutListener.h000066400000000000000000000106161255700255500227750ustar00rootroot00000000000000/** * @file * alljoyn_aboutlistener provides a callback for the org.alljoyn.About.Announce signal. * This code is experimental, and as such has not been fully tested. * Please help make it more robust by contributing fixes if you find problems. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_ABOUTLISTENER_C_H #define _ALLJOYN_ABOUTLISTENER_C_H #include #include #include #include #include #ifdef __cplusplus extern "C" { #endif /** * alljoyn_aboutlistener is called by AllJoyn to inform users of About interface * related events. */ typedef struct _alljoyn_aboutlistener_handle* alljoyn_aboutlistener; /** * Callback type for the handler of an org.alljoyn.About.Anounce sessionless signal. * * The objectDescriptionArg contains an array with a signature of `a(oas)` * this is an array object paths with a list of interfaces found at those paths. * * The aboutDataArg contains a dictionary with About data fields that have been * announced. These fields are the following: * - AppId * - DefaultLanguage * - DeviceName * - DeviceId * - AppName * - Manufacturer * - ModelNumber * * The DeviceName is optional and is allowed to not be included in the aboutDataArg. * * DeviceName, AppName, Manufacturer are localizable values. The localization * for these values in the aboutDataArg will always be for the language specified * in the DefaultLanguage field. * * @param[in] context the context pointer that was passed into the * alljoyn_aboutlistener_create function * @param[in] busName well known name of the remote BusAttachment * @param[in] version version of the Announce signal from the remote About Object * @param[in] port session port used by the announcer * @param[in] objectDescriptionArg the list of object paths and interfaces in the announcement * @param[in] aboutDataArg alljoyn_msgarg containing a dictionary of Key/Value pairs of the About data */ typedef void (AJ_CALL * alljoyn_about_announced_ptr)(const void* context, const char* busName, uint16_t version, alljoyn_sessionport port, const alljoyn_msgarg objectDescriptionArg, const alljoyn_msgarg aboutDataArg); /** * The callback used for creation of an alljoyn_aboutlistener. */ typedef struct { /** * handler for the org.alljoyn.About.Anounce sessionless signal */ alljoyn_about_announced_ptr about_listener_announced; } alljoyn_aboutlistener_callback; /** * Allocate a new alljoyn_aboutlistener. * @param callback Callback to trigger for About interface associated events. * @param context Context to pass along to callback functions. * @return allocated alljoyn_aboutlistener */ extern AJ_API alljoyn_aboutlistener AJ_CALL alljoyn_aboutlistener_create(const alljoyn_aboutlistener_callback* callback, const void* context); /** * Free an alljoyn_aboutlistener. */ extern AJ_API void AJ_CALL alljoyn_aboutlistener_destroy(alljoyn_aboutlistener listener); #ifdef __cplusplus } /* extern "C" */ #endif #endif //_ALLJOYN_ABOUTLISTENER_C_H alljoyn-15.04b/alljoyn_c/inc/alljoyn_c/AboutObj.h000066400000000000000000000140771255700255500217270ustar00rootroot00000000000000/** * @file * alljoyn_aboutobj represents a bus object that implements the org.alljoyn.About interface. * This code is experimental, and as such has not been fully tested. * Please help make it more robust by contributing fixes if you find problems. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_ABOUT_C_H #define _ALLJOYN_ABOUT_C_H #include #include #include #include #include #include #include #ifdef __cplusplus extern "C" { #endif /** * An AllJoyn BusObject that implements the org.alljoyn.About interface. * * This BusObject is used to announce the capabilities and other identifying * details of the application or device. */ typedef struct _alljoyn_aboutobj_handle* alljoyn_aboutobj; /** * Allocate a new About object as an alljoyn_aboutobj * * This object is responsible for transmitting information about the * interfaces that are available for other applications to use. It also * provides application specific information that is contained in the * alljoyn_aboutdata object and helps applications to respond to certain * requests concerning the interfaces. * * By default the org.alljoyn.About interface is excluded from the list of * announced interfaces. Since simply receiving the announce signal tells * the client that the service implements the org.alljoyn.About interface. * Changing the isAnnounced flag from UNANNOUNCED, its default, to ANNOUNCED, * will cause the org.alljoyn.About interface to be part of the announce signal. * Unless the application is talking with a legacy application that expects * the org.alljoyn.About interface to be part of the announce signal it is best * to leave the isAnnounced to use its default value. * * @param[in] bus the alljoyn_busattachment that will contain the about information * @param[in] isAnnounced will the org.alljoyn.About interface be part of the announced interfaces. * * @return allocated alljoyn_aboutobj */ extern AJ_API alljoyn_aboutobj AJ_CALL alljoyn_aboutobj_create(alljoyn_busattachment bus, alljoyn_about_announceflag isAnnounced); /** * Free an alljoyn_aboutobj object. * * @param obj The alljoyn_aboutobj to be freed. */ extern AJ_API void AJ_CALL alljoyn_aboutobj_destroy(alljoyn_aboutobj obj); /** * This is used to send the Announce signal. It announces the list of all * interfaces available at given object paths as well as the announced * fields from the About data. * * This method will automatically obtain the announced object description from the * alljoyn_busattachment that was used to create the alljoyn_aboutobj. Only alljoyn_busattachment * objects that have marked their interfaces as announced and are registered will be announced. * * @see alljoyn_busattachment_registerbusobject * @see alljoyn_busobject_addinterface * * @param obj the alljoyn_aboutobj object this call is made for * @param sessionPort the session port the interfaces can be connected with * @param aboutData the alljoyn_aboutdata that contains the About data for this announce signal * * @return * - ER_OK on success * - ER_ABOUT_SESSIONPORT_NOT_BOUND if the SessionPort given is not bound */ extern AJ_API QStatus AJ_CALL alljoyn_aboutobj_announce(alljoyn_aboutobj obj, alljoyn_sessionport sessionPort, alljoyn_aboutdata aboutData); /** * This is used to send the Announce signal. It announces the list of all * interfaces available at given object paths as well as the announced * fields from the About data. * * This method will automatically obtain the announced object description from the * alljoyn_busattachment that was used to create the alljoyn_aboutobj. Only alljoyn_busattachment * objects that have marked their interfaces as announced and are registered will be announced. * * @see alljoyn_busattachment_registerbusobject * @see alljoyn_busobject_addinterface * * @param obj the alljoyn_aboutobj object this call is made for * @param sessionPort the session port the interfaces can be connected with * @param aboutListener the alljoyn_aboutdatalistener that contains the About data for this announce signal * * @return * - ER_OK on success * - ER_ABOUT_SESSIONPORT_NOT_BOUND if the SessionPort given is not bound */ QStatus AJ_CALL alljoyn_aboutobj_announce_using_datalistener(alljoyn_aboutobj obj, alljoyn_sessionport sessionPort, alljoyn_aboutdatalistener aboutListener); /** * Cancel the last announce signal sent. If no signals have been sent this * method call will return. * * @param obj the AllJoyn About object * * @return * - ER_OK on success * - annother status indicating failure. */ extern AJ_API QStatus AJ_CALL alljoyn_aboutobj_unannounce(alljoyn_aboutobj obj); #ifdef __cplusplus } /* extern "C" */ #endif #endif //_ALLJOYN_ABOUT_C_H alljoyn-15.04b/alljoyn_c/inc/alljoyn_c/AboutObjectDescription.h000066400000000000000000000234441255700255500246250ustar00rootroot00000000000000/** * @file * alljoyn_aboutobjectdescription holds a list of the bus object interfaces and their paths. * This code is experimental, and as such has not been fully tested. * Please help make it more robust by contributing fixes if you find problems. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_ABOUTOBJECTDESCRIPTION_C_H #define _ALLJOYN_ABOUTOBJECTDESCRIPTION_C_H #include #include #ifdef __cplusplus extern "C" { #endif /** * alljoyn_aboutobjectdescription is a helper for accessing the ObjectDescription * alljoyn_msgarg that is sent as part of an announce signal. It contains helper * functions for quickly determining if an alljoyn_aboutobjectdescription * contains a specified path or interface. */ typedef struct _alljoyn_aboutobjectdescription_handle* alljoyn_aboutobjectdescription; /** * Allocate a new empty alljoyn_aboutobjectdescription object. * Use the alljoyn_aboutobjectdescription_createfrommsgarg method to fill in data. * * @return The allocated alljoyn_aboutobjectdescription. */ extern AJ_API alljoyn_aboutobjectdescription AJ_CALL alljoyn_aboutobjectdescription_create(); /** * Allocate a new alljoyn_aboutdata object filling in the fields of the About data * using an alljoyn_msgarg. The provided alljoyn_msgarg must contain a dictionary * with signature a{sv} with About data fields. * * If the passed in alljoyn_msgarg is an ill formed About data alljoyn_msgarg this call * will fail silently. If the alljoyn_msgarg does not come from About Announce signal * it is best to create an empty alljoyn_aboutdata object and use the * alljoyn_about_createfrommsgarg function to fill in the About data. * Allocate a new alljoyn_aboutobjectdescription object filling in the data * from an alljoyn_msgarg. * * The alljoyn_msgarg must contain an array of type a(oas) The expected use of this * object is to fill in the object description using an alljoyn_msgarg obtained from * the Announce signal or the GetObjectDescription method from org.alljoyn.About interface. * * If the arg came from the org.alljoyn.About.Announce signal or the * org.alljoyn.AboutGetObjectDescrption method then it can be used to create * the alljoyn_aboutobjectdescription. If the arg came from any other source * it is recommended to create first an empty alljoyn_aboutobjectdescription object * and use the alljoyn_aboutobjectdescription_createfrommsgarg. * * @param arg alljoyn_msgarg contain About Object Description data * * @return The allocated alljoyn_aboutobjectdescription. */ extern AJ_API alljoyn_aboutobjectdescription AJ_CALL alljoyn_aboutobjectdescription_create_full(const alljoyn_msgarg arg); /** * Fill in the ObjectDescription fields using an alljoyn_msgarg * * The alljoyn_msgarg must contain an array of type a(oas) The expected use * of this object is to fill in the ObjectDescription using a MsgArg obtain * from the Announce signal or the GetObjectDescription method from * the org.alljoyn.about interface. * * @param[in] description The alljoyn_aboutobjectdescription object this call is made for * @param[in] arg alljoyn_msgarg contain About data dictionary * * @return ER_OK on success */ extern AJ_API QStatus AJ_CALL alljoyn_aboutobjectdescription_createfrommsgarg(alljoyn_aboutobjectdescription description, const alljoyn_msgarg arg); /** * Free an alljoyn_aboutobjectdescription object. * * @param description The alljoyn_aboutobjectdescription to be freed. */ extern AJ_API void AJ_CALL alljoyn_aboutobjectdescription_destroy(alljoyn_aboutobjectdescription description); /** * Get a list of the paths that are added to this AboutObjectDescription. * * @param[in] description the alljoyn_aboutobjectdescription object this call is made for * @param[out] paths array of paths * @param[in] numPaths the number of paths * * @return * The total number of paths found in the AboutObjectDescription. If this * number is larger than `numPaths` then only `numPaths` of paths will be * returned in the `paths` array. * */ extern AJ_API size_t AJ_CALL alljoyn_aboutobjectdescription_getpaths(alljoyn_aboutobjectdescription description, const char** paths, size_t numPaths); /** * Get a list of interfaces advertised at the given path that are part of * this AboutObjectDescription. * * @param[in] description the alljoyn_aboutobjectdescription object this call is made for * @param[in] path the path we want to get a list of interfaces for * @param[out] interfaces array of interface names * @param[in] numInterfaces number of interface names * * @return * The total number of interfaces found in the AboutObjectDescription for * the specified path. If this number is larger than `numInterfaces` * then only `numInterfaces` of interfaces will be returned in the * `interfaces` array. */ extern AJ_API size_t AJ_CALL alljoyn_aboutobjectdescription_getinterfaces(alljoyn_aboutobjectdescription description, const char* path, const char** interfaces, size_t numInterfaces); /** * Get a list of the paths for a given interface. Its possible to have the * same interface listed under multiple paths. * * @param[in] description the alljoyn_aboutobjectdescription object this call is made for * @param[in] interfaceName the interface we want to get a list of paths for * @param[out] paths array of paths * @param[in] numPaths the number of paths * * @return * The total number of paths found in the AboutObjectDescription for * the specified path. If this number its larger than the `numPaths` * then only `numPaths` of interfaces will be returned in the `paths` * array * */ extern AJ_API size_t AJ_CALL alljoyn_aboutobjectdescription_getinterfacepaths(alljoyn_aboutobjectdescription description, const char* interfaceName, const char** paths, size_t numPaths); /** * Clear all the contents of this AboutObjectDescription * * @param[in] description The alljoyn_aboutobjectdescription object this call is made for * * @return ER_OK */ extern AJ_API void AJ_CALL alljoyn_aboutobjectdescription_clear(alljoyn_aboutobjectdescription description); /** * Returns true if the given path is found * * @param[in] description the alljoyn_aboutobjectdescription object this call is made for * @param[in] path BusObject path * * @return true if the path is found */ extern AJ_API bool AJ_CALL alljoyn_aboutobjectdescription_haspath(alljoyn_aboutobjectdescription description, const char* path); /** * Returns true if the given interface name is found in any path * * @param[in] description the alljoyn_aboutobjectdescription object this call is made for * @param[in] interfaceName the name of the interface you are looking for * * @return true if the interface is found */ extern AJ_API bool AJ_CALL alljoyn_aboutobjectdescription_hasinterface(alljoyn_aboutobjectdescription description, const char* interfaceName); /** * Returns true if the given interface name is found at the given path * * @param[in] description the alljoyn_aboutobjectdescription object this call is made for * @param[in] path path name of the interface * @param[in] interfaceName the name of the interface you are looking for * * @return true if the interface is found at the given path */ extern AJ_API bool AJ_CALL alljoyn_aboutobjectdescription_hasinterfaceatpath(alljoyn_aboutobjectdescription description, const char* path, const char* interfaceName); /** * @param[in] description the alljoyn_aboutobjectdescription object this call is made for * @param[out] msgArg containing a signature a(oas) for an array of object paths and * an array of interfaces found on that object path * * @return ER_OK if successful */ extern AJ_API QStatus AJ_CALL alljoyn_aboutobjectdescription_getmsgarg(alljoyn_aboutobjectdescription description, alljoyn_msgarg msgArg); #ifdef __cplusplus } /* extern "C" */ #endif #endif //_ALLJOYN_ABOUTOBJECTDESCRIPTION_C_H alljoyn-15.04b/alljoyn_c/inc/alljoyn_c/AboutProxy.h000066400000000000000000000104161255700255500223270ustar00rootroot00000000000000/** * @file * alljoyn_aboutproxy gives proxy access to the org.alljoyn.About interface * exposing the following methods: GetObjectDescriptions, GetAboutData and GetVersion. * This code is experimental, and as such has not been fully tested. * Please help make it more robust by contributing fixes if you find problems. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_ABOUTPROXY_C_H_ #define _ALLJOYN_ABOUTPROXY_C_H_ #include #include #include #include #ifdef __cplusplus extern "C" { #endif /** * alljoyn_aboutproxy give proxy access to the org.alljoyn.About interface * alljoyn_aboutproxy object enables the user to interact with the remote * alljoyn_aboutobj instances. * * This exposes the following org.alljoyn.About methods: * - GetObjectDescriptions * - GetAboutData * - GetVersion */ typedef struct _alljoyn_aboutproxy_handle* alljoyn_aboutproxy; /** * Allocate a new alljoyn_aboutproxy object. * * @param[in] bus reference to alljoyn_busattachment * @param[in] busName unique or well-known name of remote AllJoyn bus * @param[in] sessionId the session received after joining AllJoyn session * * @return The allocated alljoyn_aboutproxy. */ extern AJ_API alljoyn_aboutproxy AJ_CALL alljoyn_aboutproxy_create(alljoyn_busattachment bus, const char* busName, alljoyn_sessionid sessionId); /** * Free an alljoyn_aboutproxy object. * * @param proxy The alljoyn_aboutproxy to be freed */ extern AJ_API void AJ_CALL alljoyn_aboutproxy_destroy(alljoyn_aboutproxy proxy); /** * Get the ObjectDescription array for specified bus name. * * @param[in] proxy The alljoyn_aboutproxy object to get object description from * @param[out] objectDesc Description of busName's remote objects. * * @return * - ER_OK if successful. * - ER_BUS_REPLY_IS_ERROR_MESSAGE on unknown failure. */ extern AJ_API QStatus AJ_CALL alljoyn_aboutproxy_getobjectdescription(alljoyn_aboutproxy proxy, alljoyn_msgarg objectDesc); /** * Get the About data for specified bus name. * * @param[in] proxy The alljoyn_aboutproxy object to get the about data from * @param[in] language the language used to request the About data. * @param[out] data reference of About data that is filled by the function * * @return * - ER_OK if successful. * - ER_LANGUAGE_NOT_SUPPORTED if the language specified is not supported * - ER_BUS_REPLY_IS_ERROR_MESSAGE on unknown failure */ extern AJ_API QStatus AJ_CALL alljoyn_aboutproxy_getaboutdata(alljoyn_aboutproxy proxy, const char* language, alljoyn_msgarg data); /** * GetVersion get the About version * * @param[in] proxy The alljoyn_aboutproxy object to get the version from * @param[out] version of the service. * * @return ER_OK on success */ extern AJ_API QStatus AJ_CALL alljoyn_aboutproxy_getversion(alljoyn_aboutproxy proxy, uint16_t* version); #ifdef __cplusplus } /* extern "C" */ #endif #endif /* _ALLJOYN_ABOUTPROXY_C_H_ */ alljoyn-15.04b/alljoyn_c/inc/alljoyn_c/AjAPI.h000066400000000000000000000117071255700255500211030ustar00rootroot00000000000000/** * @file * This file defines the attributes of exported functions. * * This file also defines the deferred callback mechanism used to make sure the * callbacks occur on the same thread that registered for the callback. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_C_AJAPI_H #define _ALLJOYN_C_AJAPI_H #if defined(QCC_OS_GROUP_POSIX) #include #elif defined(QCC_OS_GROUP_WINDOWS) #include #include #else #error No OS GROUP defined. #endif /** * -------------------------------------------------------------------------- * Note: ensure this portion matches the C++ binding */ #if defined(__GNUC__) #define GCC_VERSION ((__GNUC__ * 10000) + (__GNUC_MINOR__ * 100) + __GNUC_PATCHLEVEL__) #if (GCC_VERSION < 40700L) /* * Versions of GCC prior to 4.7.0 have an annoying but intentional bug where * __cplusplus is set to 1 rather than the appropriate date code so that it * would be compatible with Solaris 8. */ #if (GCC_VERSION >= 40600L) && defined(__GXX_EXPERIMENTAL_CXX0X__) /* * GCC 4.6.x supports C++11, at least in terms of unordered_map, etc. when the * -std=gnu++0x option is passed in. Thus, fix the value of __cplusplus. */ #undef __cplusplus #define __cplusplus 201100L #endif // GCC version >= 4.6 and -std=gnu++0x #endif // GCC version < 4.7 #if (__GNUC__ >= 4) || ((__GNUC__ == 3) && (__GNUC_MINOR__ >= 1)) #define QCC_DEPRECATED(func) func __attribute__((deprecated)) /**< mark a function as deprecated in gcc. */ #else #define QCC_DEPRECATED(func) func /**< not all gcc versions support the deprecated attribute. */ #endif #elif defined(_MSC_VER) #define QCC_DEPRECATED(func) __declspec(deprecated) func /**< mark a function as deprecated in msvc. */ #else /* Some unknown compiler */ #define QCC_DEPRECATED(func); /**< mark a function as deprecated. */ #endif /* Compiler type */ /** * Macro used to avoid unused variable warning in release code. * This Macro is only used when a variable is only used in the debug build * variant. When building in release mode the compiler will give an unused * variable warning. * * Example usage: @code String errMsg const char* errName = reply->GetErrorName(&errMsg); QCC_LogError(status, ("TimedPing returned ERROR_MESSAGE (error=%s, \"%s\")", errName, errMsg.c_str())); QCC_UNUSED(errName); // avoid unused variable warning in release build @endcode * * The `QCC_LogError` is an empty macro for release build variants but in debug * build variants it is not empty so it uses the errName variable. */ #define QCC_UNUSED(x) (void)(x) /** Boolean type for C */ typedef int32_t QCC_BOOL; /** Boolean logic true for QCC_BOOL type*/ #define QCC_TRUE 1 /** Boolean logic false for QCC_BOOL type*/ #define QCC_FALSE 0 /** This @#define allows for calling convention redefinition on relevant platforms */ #ifndef AJ_CALL # if defined(QCC_OS_GROUP_WINDOWS) # define AJ_CALL __stdcall # else # define AJ_CALL # endif #endif /** * End match * -------------------------------------------------------------------------- */ /** * This @#define allows for setting of visibility support on relevant platforms */ #ifndef AJ_API # if defined(QCC_OS_GROUP_POSIX) # define AJ_API __attribute__((visibility("default"))) # else # define AJ_API # endif #endif #ifdef __cplusplus extern "C" { #endif /** * Used to specify if an interface is part of an About announcement or not. */ typedef enum { UNANNOUNCED, ///< The interface is not announced ANNOUNCED ///< The interface is announced } alljoyn_about_announceflag; /** * Unity-specific function to process alternate-thread callbacks on the main thread. * * @return the number of callbacks processed. */ extern AJ_API int AJ_CALL alljoyn_unity_deferred_callbacks_process(); /** * Enable/disable main thread callback behavior. */ extern AJ_API void AJ_CALL alljoyn_unity_set_deferred_callback_mainthread_only(QCC_BOOL mainthread_only); #ifdef __cplusplus } /* extern "C" */ #endif #endif alljoyn-15.04b/alljoyn_c/inc/alljoyn_c/AuthListener.h000066400000000000000000000476671255700255500226440ustar00rootroot00000000000000/** * @file * This file defines the alljoyn_authlistener and related functions that provides * the interface between authentication mechansisms and applications. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_C_AUTHLISTENER_H #define _ALLJOYN_C_AUTHLISTENER_H #include #include #ifdef __cplusplus extern "C" { #endif /** * alljoyn_authlistener allows authentication mechanisms to interact with the user or application. */ typedef struct _alljoyn_authlistener_handle* alljoyn_authlistener; /** * Generic struct for describing different authentication credentials. */ typedef struct _alljoyn_credentials_handle* alljoyn_credentials; /** * @name Credential indication Bitmasks * Bitmasks used to indicated what type of credentials are being used. */ // @{ static const uint16_t ALLJOYN_CRED_PASSWORD = 0x0001; /**< Bit 0 indicates credentials include a password, pincode, or passphrase */ static const uint16_t ALLJOYN_CRED_USER_NAME = 0x0002; /**< Bit 1 indicates credentials include a user name */ static const uint16_t ALLJOYN_CRED_CERT_CHAIN = 0x0004; /**< Bit 2 indicates credentials include a chain of PEM-encoded X509 certificates */ static const uint16_t ALLJOYN_CRED_PRIVATE_KEY = 0x0008; /**< Bit 3 indicates credentials include a PEM-encoded private key */ static const uint16_t ALLJOYN_CRED_LOGON_ENTRY = 0x0010; /**< Bit 4 indicates credentials include a logon entry that can be used to logon a remote user */ static const uint16_t ALLJOYN_CRED_EXPIRATION = 0x0020; /**< Bit 5 indicates credentials include an expiration time */ // @} /** * @name Credential request values * These values are only used in a credential request */ // @{ static const uint16_t ALLJOYN_CRED_NEW_PASSWORD = 0x1001; /**< Indicates the credential request is for a newly created password */ static const uint16_t ALLJOYN_CRED_ONE_TIME_PWD = 0x2001; /**< Indicates the credential request is for a one time use password */ // @} /** * Type for the RequestCredentials callback. * * Authentication mechanism requests user credentials. If the user name is not an empty string * the request is for credentials for that specific user. A count allows the listener to decide * whether to allow or reject multiple authentication attempts to the same peer. * * An implementation must provide an alljoyn_authlistener_callbacks or * an alljoyn_authlistenerasync_callbacks but not both. * * @param context The context pointer passed into the alljoyn_authlistener_create function * @param authMechanism The name of the authentication mechanism issuing the request. * @param peerName The name of the remote peer being authenticated. On the initiating * side this will be a well-known-name for the remote peer. On the * accepting side this will be the unique bus name for the remote peer. * @param authCount Count (starting at 1) of the number of authentication request attempts made. * @param userName The user name for the credentials being requested. * @param credMask A bit mask identifying the credentials being requested. The application * may return none, some or all of the requested credentials. * @param[out] credentials The credentials returned. * * @return The caller should return true if the request is being accepted or false if the * requests is being rejected. If the request is rejected the authentication is * complete. */ typedef QCC_BOOL (AJ_CALL * alljoyn_authlistener_requestcredentials_ptr)(const void* context, const char* authMechanism, const char* peerName, uint16_t authCount, const char* userName, uint16_t credMask, alljoyn_credentials credentials); /** * Authentication mechanism asynchronous request for credentials. If the user name is not an empty string * the request is for credentials for that specific user. A count allows the listener to decide * whether to allow or reject multiple authentication attempts to the same peer. * * An implementation must provide an alljoyn_authlistener_callbacks or * an alljoyn_authlistenerasync_callbacks but not both. * * @param context The context pointer passed into the alljoyn_authlistenerasync_create function * @param listener The alljoyn_authlistener used to call this function pointer this should be used * when calling alljoyn_authlistener_requestcredentialsresponse. * @param authMechanism The name of the authentication mechanism issuing the request. * @param peerName The name of the remote peer being authenticated. On the initiating * side this will be a well-known-name for the remote peer. On the * accepting side this will be the unique bus name for the remote peer. * @param authCount Count (starting at 1) of the number of authentication request attempts made. * @param userName The user name for the credentials being requested. * @param credMask A bit mask identifying the credentials being requested. * @param authContext Callback context for associating the request with the returned credentials. * * @return Return * - ER_OK if the request is handled. * - ER_NOT_IMPLEMENTED if implementation not found (default) */ typedef QStatus (AJ_CALL * alljoyn_authlistener_requestcredentialsasync_ptr)(const void* context, alljoyn_authlistener listener, const char* authMechanism, const char* peerName, uint16_t authCount, const char* userName, uint16_t credMask, void* authContext); /** * Respond to a call to alljoyn_authlistener_requestcredentialsasync_ptr. * * @param listener The alljoyn_authlistener responding to the authlistener_requestcredentialsasync * @param authContext Context that was passed in the call out to alljoyn_authlistener_requestcredentialsasync_ptr. * @param accept Returns true to accept the credentials request or false to reject it. * @param credentials The credentials being returned if accept is true. * * @return Returns ER_OK if the credential verification response was expected. Returns an error status if * the credentials verification response was not expected. */ extern AJ_API QStatus AJ_CALL alljoyn_authlistener_requestcredentialsresponse(alljoyn_authlistener listener, void* authContext, QCC_BOOL accept, alljoyn_credentials credentials); /** * Type for the VerifyCredentials callback. * * Authentication mechanism requests verification of credentials from a remote peer. * * @param context The context pointer passed into the alljoyn_authlistener_create function * @param authMechanism The name of the authentication mechanism issuing the request. * @param peerName The name of the remote peer being authenticated. On the initiating * side this will be a well-known-name for the remote peer. On the * accepting side this will be the unique bus name for the remote peer. * @param credentials The credentials to be verified. * * @return The listener should return true if the credentials are acceptable or false if the * credentials are being rejected. */ typedef QCC_BOOL (AJ_CALL * alljoyn_authlistener_verifycredentials_ptr)(const void* context, const char* authMechanism, const char* peerName, const alljoyn_credentials credentials); /** * Authentication mechanism asynchronous request for verification of credentials from a remote peer. * * @param context The context pointer passed into the alljoyn_authlistenerasync_create function. * @param listener The alljoyn_authlistener used to call this function pointer this should be used * when calling alljoyn_authlistener_verifycredentialsresponse. * @param authMechanism The name of the authentication mechanism issuing the request. * @param peerName The name of the remote peer being authenticated. On the initiating * side this will be a well-known-name for the remote peer. On the * accepting side this will be the unique bus name for the remote peer. * @param credentials The credentials to be verified. * @param authContext Callback context for associating the request with the verification response. * * @return Return * - ER_OK if the request is handled. * - ER_NOT_IMPLEMENTED (default) */ typedef QStatus (AJ_CALL * alljoyn_authlistener_verifycredentialsasync_ptr)(const void* context, alljoyn_authlistener listener, const char* authMechanism, const char* peerName, const alljoyn_credentials credentials, void* authContext); /** * Respond to a call to alljoyn_authlistener_verifycredentialsasync_ptr. * * @param listener The alljoyn_authlistener responding to the authlistener_verifycredentialsasync. * @param authContext Context that was passed in the call out to alljoyn_authlistener_verifycredentialsasync_ptr. * @param accept Returns true to accept the credentials or false to reject it. * * @return Returns ER_OK if the credential verification response was expected. Returns an error status if * the credentials verification response was not expected. */ extern AJ_API QStatus AJ_CALL alljoyn_authlistener_verifycredentialsresponse(alljoyn_authlistener listener, void* authContext, QCC_BOOL accept); /** * Type for the SecurityViolation callback. * * Optional function that if implemented allows an application to monitor security violations. This * function is called when an attempt to decrypt an encrypted messages failed or when an unencrypted * message was received on an interface that requires encryption. The message contains only * header information. * * @param context The context pointer passed into the alljoyn_authlistener_create function * @param status A status code indicating the type of security violation. * @param msg The message that cause the security violation. */ typedef void (AJ_CALL * alljoyn_authlistener_securityviolation_ptr)(const void* context, QStatus status, const alljoyn_message msg); /** * Type for the AuthenticationComplete callback. * * Reports successful or unsuccessful completion of authentication. * * @param authMechanism The name of the authentication mechanism that was used or an empty * string if the authentication failed. * @param peerName The name of the remote peer being authenticated. On the initiating * side this will be a well-known-name for the remote peer. On the * accepting side this will be the unique bus name for the remote peer. * @param success true if the authentication was successful, otherwise false. */ typedef void (AJ_CALL * alljoyn_authlistener_authenticationcomplete_ptr)(const void* context, const char* authMechanism, const char* peerName, QCC_BOOL success); /** * Structure used during alljoyn_authlistener_create to provide callbacks into C. * An implementation must provide alljoyn_authlistener_requestcredentials_ptr * and alljoyn_authlistener_authenticationcomplete_ptr. Other values can be set * to NULL if they are not needed. */ typedef struct { /** * Authentication mechanism requests user credentials. */ alljoyn_authlistener_requestcredentials_ptr request_credentials; /** * Authentication mechanism requests verification of credentials from a remote peer. */ alljoyn_authlistener_verifycredentials_ptr verify_credentials; /** * Optional function that if implemented allows an application to monitor security violations. */ alljoyn_authlistener_securityviolation_ptr security_violation; /** * Reports successful or unsuccessful completion of authentication. */ alljoyn_authlistener_authenticationcomplete_ptr authentication_complete; } alljoyn_authlistener_callbacks; /** * Structure used during alljoyn_authlistenerasync_create to provide callbacks into C. * An implementation must provide alljoyn_authlistener_requestcredentialsasync_ptr * and alljoyn_authlistener_authenticationcomplete_ptr. Other values can be set * to NULL if they are not needed. */ typedef struct { /** * Authentication mechanism asynchronous request for credentials. */ alljoyn_authlistener_requestcredentialsasync_ptr request_credentials; /** * Authentication mechanism asynchronous request for verification of credentials from a remote peer */ alljoyn_authlistener_verifycredentialsasync_ptr verify_credentials; /** * Optional function that if implemented allows an application to monitor security violations. */ alljoyn_authlistener_securityviolation_ptr security_violation; /** * Reports successful or unsuccessful completion of authentication. */ alljoyn_authlistener_authenticationcomplete_ptr authentication_complete; } alljoyn_authlistenerasync_callbacks; /** * Create an alljoyn_authlistener which will trigger the provided callbacks, passing along the provided context. * * @param callbacks Callbacks to trigger for associated events. * @param context Context to pass to callback functions * * @return Handle to newly allocated alljoyn_authlistener. */ extern AJ_API alljoyn_authlistener AJ_CALL alljoyn_authlistener_create(const alljoyn_authlistener_callbacks* callbacks, const void* context); /** * Create an alljoyn_authlistener which will trigger the provided callbacks, passing along the provided context. * * @param callbacks Callbacks to trigger for associated events. * @param context Context to pass to callback functions * * @return Handle to newly allocated alljoyn_authlistener. */ extern AJ_API alljoyn_authlistener AJ_CALL alljoyn_authlistenerasync_create(const alljoyn_authlistenerasync_callbacks* callbacks, const void* context); /** * Destroy an alljoyn_authlistener. * * @param listener alljoyn_authlistener to destroy. */ extern AJ_API void AJ_CALL alljoyn_authlistener_destroy(alljoyn_authlistener listener); /** * Destroy an alljoyn_authlistener. * * @param listener alljoyn_authlistener to destroy. */ extern AJ_API void AJ_CALL alljoyn_authlistenerasync_destroy(alljoyn_authlistener listener); /** * Create credentials * * @return Newly created credentials. */ extern AJ_API alljoyn_credentials AJ_CALL alljoyn_credentials_create(); /** * Destroy credentials * * @param cred Credentials to destroy. */ extern AJ_API void AJ_CALL alljoyn_credentials_destroy(alljoyn_credentials cred); /** * Tests if one or more credentials are set. * * @param cred The credentials to test. * @param creds A logical or of the credential bit values. * @return true if the credentials are set. */ extern AJ_API QCC_BOOL AJ_CALL alljoyn_credentials_isset(const alljoyn_credentials cred, uint16_t creds); /** * Sets a requested password, pincode, or passphrase. * * @param cred The credentials to set. * @param pwd The password to set. */ extern AJ_API void AJ_CALL alljoyn_credentials_setpassword(alljoyn_credentials cred, const char* pwd); /** * Sets a requested user name. * * @param cred The credentials to set. * @param userName The user name to set. */ extern AJ_API void AJ_CALL alljoyn_credentials_setusername(alljoyn_credentials cred, const char* userName); /** * Sets a requested public key certificate chain. The certificates must be PEM encoded. * * @param cred The credentials to set. * @param certChain The certificate chain to set. */ extern AJ_API void AJ_CALL alljoyn_credentials_setcertchain(alljoyn_credentials cred, const char* certChain); /** * Sets a requested private key. The private key must be PEM encoded and may be encrypted. If * the private key is encrypted the passphrase required to decrypt it must also be supplied. * * @param cred The credentials to set. * @param pk The private key to set. */ extern AJ_API void AJ_CALL alljoyn_credentials_setprivatekey(alljoyn_credentials cred, const char* pk); /** * Sets a logon entry. For example for the Secure Remote Password protocol in RFC 5054, a * logon entry encodes the N,g, s and v parameters. An SRP logon entry string has the form * N:g:s:v where N,g,s, and v are ASCII encoded hexadecimal strings and are separated by * colons. * * @param cred The credentials to set. * @param logonEntry The logon entry to set. */ extern AJ_API void AJ_CALL alljoyn_credentials_setlogonentry(alljoyn_credentials cred, const char* logonEntry); /** * Sets an expiration time in seconds relative to the current time for the credentials. This value is optional and * can be set on any response to a credentials request. After the specified expiration time has elapsed any secret * keys based on the provided credentials are invalidated and a new authentication exchange will be required. If an * expiration is not set the default expiration time for the requested authentication mechanism is used. * * @param cred The credentials to set. * @param expiration The expiration time in seconds. */ extern AJ_API void AJ_CALL alljoyn_credentials_setexpiration(alljoyn_credentials cred, uint32_t expiration); /** * Gets the password, pincode, or passphrase from this credentials instance. * * @param cred The credentials to query. * @return A password or an empty string. */ extern AJ_API const char* AJ_CALL alljoyn_credentials_getpassword(const alljoyn_credentials cred); /** * Gets the user name from this credentials instance. * * @param cred The credentials to query. * @return A user name or an empty string. */ extern AJ_API const char* AJ_CALL alljoyn_credentials_getusername(const alljoyn_credentials cred); /** * Gets the PEM encoded X509 certificate chain from this credentials instance. * * @param cred The credentials to query. * @return An X509 certificate chain or an empty string. */ extern AJ_API const char* AJ_CALL alljoyn_credentials_getcertchain(const alljoyn_credentials cred); /** * Gets the PEM encoded private key from this credentials instance. * * @param cred The credentials to query. * @return An PEM encode private key or an empty string. */ extern AJ_API const char* AJ_CALL alljoyn_credentials_getprivateKey(const alljoyn_credentials cred); /** * Gets a logon entry. * * @param cred The credentials to query. * @return An encoded logon entry or an empty string. */ extern AJ_API const char* AJ_CALL alljoyn_credentials_getlogonentry(const alljoyn_credentials cred); /** * Get the expiration time in seconds if it is set. * * @param cred The credentials to query. * @return The expiration or the max 32 bit unsigned value if it was not set. */ extern AJ_API uint32_t AJ_CALL alljoyn_credentials_getexpiration(const alljoyn_credentials cred); /** * Clear the credentials. * * @param cred The credentials to clear. */ extern AJ_API void AJ_CALL alljoyn_credentials_clear(alljoyn_credentials cred); #ifdef __cplusplus } /* extern "C" */ #endif #endif alljoyn-15.04b/alljoyn_c/inc/alljoyn_c/BusAttachment.h000066400000000000000000002116701255700255500227620ustar00rootroot00000000000000/** * @file BusAttachment.h is the top-level object responsible for connecting to a * message bus. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_C_BUSATTACHMENT_H #define _ALLJOYN_C_BUSATTACHMENT_H #include #include #include #include #include #include #include #include #include #include #include #include #ifdef __cplusplus extern "C" { #endif #ifndef _ALLJOYN_OPAQUE_BUSATTACHMENT_ #define _ALLJOYN_OPAQUE_BUSATTACHMENT_ /** * alljoyn_busattachment is the top level object responsible for connecting to and * managing an AllJoyn message bus */ typedef struct _alljoyn_busattachment_handle* alljoyn_busattachment; #endif /** * Type for the joinsession callback used with the asynchronous joinsession request. */ typedef void (AJ_CALL * alljoyn_busattachment_joinsessioncb_ptr)(QStatus status, alljoyn_sessionid sessionId, const alljoyn_sessionopts opts, void* context); /** * Type for the setlinktimeout callback used with the asynchronous setlinktimeout request. * * * Called when alljoyn_busattachment_setlinktimeoutasync() completes. * * @param status ER_OK if successful * @param timeout Timeout value (possibly adjusted from original request). * @param context User defined context which will be passed as-is to callback. */ typedef void (AJ_CALL * alljoyn_busattachment_setlinktimeoutcb_ptr)(QStatus status, uint32_t timeout, void* context); /** * Allocate an alljoyn_busattachment. * * By default this will create an alljoyn_busattachment capable of handling 4 concurrent method and signal handlers. * This is the recommended default value. If for some reason the application must be able to handle a different * number of concurrent methods use alljoyn_busattachment_create_concurrency. * * @note Any alljoyn_busattachment allocated using this function must be freed using alljoyn_busattachment_destroy * * @see alljoyn_busattachment_create_concurrency * @see alljoyn_busattachment_destroy * * @param applicationName Name of the application. * @param allowRemoteMessages QCC_TRUE if this attachment is allowed to receive messages from remote devices. * * @return the allocated alljoyn_busattachment */ extern AJ_API alljoyn_busattachment AJ_CALL alljoyn_busattachment_create(const char* applicationName, QCC_BOOL allowRemoteMessages); /** * Allocate an alljoyn_busattachment. * * This will Allocate an alljoyn_busattachment that is capable of using a different value for concurrency then * the default value of 4. * * @note Any alljoyn_busattachment allocated using this function must be freed using alljoyn_busattachment_destroy * * @see alljoyn_busattachment_create * @see alljoyn_busattachment_destroy * * @param applicationName Name of the application. * @param allowRemoteMessages True if this attachment is allowed to receive messages from remote devices. * @param concurrency The maximum number of concurrent method and signal handlers locally executing. * * @return the allocated alljoyn_busattachment */ extern AJ_API alljoyn_busattachment AJ_CALL alljoyn_busattachment_create_concurrency(const char* applicationName, QCC_BOOL allowRemoteMessages, uint32_t concurrency); /** * Free an allocated alljoyn_busattachment. * * @param bus alljoyn_busattachment to free. */ extern AJ_API void AJ_CALL alljoyn_busattachment_destroy(alljoyn_busattachment bus); /** * @brief Start the process of spinning up the independent threads used in * the bus attachment, preparing it for action. * * This function only begins the process of starting the bus. Sending and * receiving messages cannot begin until the bus is Connect()ed. * * There are two ways to determine whether the bus is currently connected: * -# alljoyn_busattachment() returns QCC_TRUE * -# alljoyn_busobject_callback object_registered is called by the bus * * In most cases, it is not required to understand the threading model of * the bus attachment, with one important exception: The bus attachment may * send callbacks to registered listeners using its own internal threads. * This means that any time a listener of any kind is used in a program, the * implication is that a the overall program is multithreaded, irrespective * of whether or not threads are explicitly used. This, in turn, means that * any time shared state is accessed in listener callback functions, that state * must be protected. * * As soon as Start() is called, clients of a bus attachment with listeners * must be prepared to receive callbacks on those listeners in the context * of a thread that will be different from the thread running the main * program or any other thread in the client. * * Although intimate knowledge of the details of the threading model are not * required to use a bus attachment (beyond the caveat above) we do provide * functions on the bus attachment that help users reason about more complex * threading situations. This will apply to situations where clients of the * bus attachment are multithreaded and need to interact with the * multithreaded bus attachment. These functions can be especially useful * during shutdown, when the two separate threading systems need to be * gracefully brought down together. * * The alljoyn_busattachment function alljoyn_busattachment_start(), * alljoyn_busattachment_stop() and alljoyn_busattacment_join() all work together to * manage the autonomous activities that can happen in an alljoyn_busattachment. * These activities are carried out by so-called hardware threads. POSIX * defines functions used to control hardware threads, which it calls * pthreads. Many threading packages use similar constructs. * * In a threading package, a start function asks the underlying system to * arrange for the start of thread execution. Threads are not necessarily * running when the start function returns, but they are being *started*. Some time later, * a thread of execution appears in a thread run function, at which point the * thread is considered *running*. At some later time, executing a stop function asks the * underlying system to arrange for a thread to end its execution. The system * typically sends a message to the thread to ask it to stop doing what it is doing. * The thread is running until it responds to the stop message, at which time the * run function exits and the thread is considered *stopping*. * * Note that neither alljoyn_busattachment_start() nor alljoyn_busattachment_stop() * are synchronous in the sense that one has actually accomplished the desired * effect upon the return from a call. Of particular interest is the fact that * after a call to alljoyn_busattachment_stop(), threads will still be *running* for * some non-deterministic time. * * In order to wait until all of the threads have actually stopped, a * blocking call is required. In threading packages this is typically * called join, and our corresponding function is called alljoyn_busattachment_join(). * * An alljoyn_busattachment_start() function call should be thought of as mapping * to a threading package start function. it causes the activity threads in the * alljoyn_busattachment to be spun up and gets the attachment ready to do its main * job. As soon as alljoyn_busattachment_start() is called, the user should be prepared * for one or more of these threads of execution to pop out of the bus attachment * and into a listener callback. * * The alljoyn_busattachment_stop() function should be thought of as mapping to a * threading package stop function. It asks the alljoyn_busattachment to begin * shutting down its various threads of execution, but does not wait for any * threads to exit. * * A call to the alljoyn_busattachment_join() function should be thought of as mapping * to a threading package join function call. It blocks and waits until all of * the threads in the alljoyn_busattachment have in fact exited their Run functions, * gone through the stopping state and have returned their status. When * the alljoyn_busattachment_join() function returns, one may be assured that no * threads are running in the bus attachment, and therefore there will be no callbacks * in progress and no further callbacks will ever come out of a particular * instance of a bus attachment. * * It is important to understand that since alljoyn_busattachment_start(), * alljoyn_busattachment_stop() and alljoyn_busattachment_join() map to threads * concepts and functions, one should not expect them to clean up any bus * attachment state when they are called. These functions are only present to * help in orderly termination of complex threading systems. * * @see alljoyn_busattachment_stop() * @see alljoyn_busattachment_join() * * @param bus The alljoyn_busattachment to start. * * @return * - #ER_OK if successful. * - #ER_BUS_BUS_ALREADY_STARTED if already started * - Other error status codes indicating a failure */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_start(alljoyn_busattachment bus); /** * @brief Ask the threading subsystem in the bus attachment to begin the * process of ending the execution of its threads. * * The alljoyn_busattachment_stop() function call on a bus attachment should be * thought of as mapping to a threading package stop function. It asks the * alljoyn_busattachment to begin shutting down its various threads of execution, but * does not wait for any threads to exit. * * A call to alljoyn_busattachment_stop() is implied as one of the first steps in * the destruction of a bus attachment. * * @warning There is no guarantee that a listener callback may begin executing * after a call to alljoyn_busattachment_stop(). To achieve that effect, the * alljoyn_busattachment_stop() must be followed by an alljoyn_busattachment_join(). * * @see alljoyn_busattachment_start() * @see alljoyn_busattachment_join() * * @param bus alljoyn_busattachment to stop. * * @return * - #ER_OK if successful. * - An error status if unable to stop the message bus */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_stop(alljoyn_busattachment bus); /** * @brief Wait for all of the threads spawned by the bus attachment to be * completely exited. * * A call to the alljoyn_busattachment_join() function should be thought of as * mapping to a threading package join function call. It blocks and waits * until all of the threads in the alljoyn_busattachment have, in fact, exited * their Run functions, gone through the stopping state and have returned their * status. When the alljoyn_busattachment_join() function returns, one may be * assured that no threads are running in the bus attachment, and therefore * there will be no callbacks in progress and no further callbacks will ever * come out of the instance of a bus attachment on which * alljoyn_busattachment_join() was called. * * A call to alljoyn_busattachment_join() is implied as one of the first steps * in the destruction of a bus attachment. Thus, when a bus attachment is * destroyed, it is guaranteed that before it completes its destruction process, * there will be no callbacks in process. * * @warning If alljoyn_busattachment_join() is called without a previous * alljoyn_busattachment_stop() it will result in blocking "forever." * * @see alljoyn_busattachment_start() * @see alljoyn_busattachment_stop() * * @param bus alljoyn_busattachment to join. * * @return * - #ER_OK if successful. * - #ER_BUS_BUS_ALREADY_STARTED if already started * - Other error status codes indicating a failure */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_join(alljoyn_busattachment bus); /** * Get the concurrent method and signal handler limit. * * @param bus The alljoyn_busattachment on which to get the concurrent method and * signal handler limit. * * @return The maximum number of concurrent method and signal handlers. */ extern AJ_API uint32_t AJ_CALL alljoyn_busattachment_getconcurrency(alljoyn_busattachment bus); /** * Get the connect spec used by the alljoyn_busattachment * * @param bus The alljoyn_busattachment to obtain the connect spec from. * * @return The string representing the connect spec used by the alljoyn_busattachment */ extern AJ_API const char* AJ_CALL alljoyn_busattachment_getconnectspec(alljoyn_busattachment bus); /** * Allow the currently executing method/signal handler to enable concurrent callbacks * during the scope of the handler's execution. * * @param bus The alljoyn_busattachment to enable concurrent callbacks on * */ extern AJ_API void AJ_CALL alljoyn_busattachment_enableconcurrentcallbacks(alljoyn_busattachment bus); /** * Create an interface description with a given name. * * Interfaces created using the this function will automatically use * AJ_IFC_SCURITY_INHERIT as its security policy. To create an interface that * uses a different security policy @see alljoyn_busattachment_createinterface_secure * * @param bus The alljoyn_busattachment on which to create an interface. * @param name The requested interface name. * @param[out] iface * - Interface description * - NULL if cannot be created. * * @return * - #ER_OK if creation was successful. * - #ER_BUS_IFACE_ALREADY_EXISTS if requested interface already exists */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_createinterface(alljoyn_busattachment bus, const char* name, alljoyn_interfacedescription* iface); /** * Create an interface description with a given name. * * @param bus The alljoyn_busattachment on which to create an interface. * @param name The requested interface name. * @param[out] iface * - Interface description * - NULL if cannot be created. * @param secPolicy security policy of this interface it can be AJ_IFC_SECURITY_INHERIT, * AJ_IFC_SECURITY_REQUIRED, or AJ_IFC_SECURITY_OFF * @see alljoyn_interfacedescription_securitypolicy * @see alljoyn_busattachment_createinterface * * @return * - #ER_OK if creation was successful. * - #ER_BUS_IFACE_ALREADY_EXISTS if requested interface already exists */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_createinterface_secure(alljoyn_busattachment bus, const char* name, alljoyn_interfacedescription* iface, alljoyn_interfacedescription_securitypolicy secPolicy); /** * Connect to a remote bus address. * * @param bus The alljoyn_busattachment to be connected. * @param connectSpec A transport connection spec string of the form: * @c ":=,=...[;]" * if connectSpec is NULL the bus attachment will attempt to * connect to the bus using a built in connectSpec. * * @return * - #ER_OK if successful. * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_connect(alljoyn_busattachment bus, const char* connectSpec); /** * Register an object that will receive bus event notifications. * * @param bus The alljoyn_busattachment on which to attach an alljoyn_buslistener. * @param listener Object instance that will receive bus event notifications. */ extern AJ_API void AJ_CALL alljoyn_busattachment_registerbuslistener(alljoyn_busattachment bus, alljoyn_buslistener listener); /** * Unregister an object that was previously registered with * alljoyn_busattachment_registerbuslistener. * * @param bus The alljoyn_busattachment from which to detach an alljoyn_buslistener. * @param listener Object instance to un-register as a listener. */ extern AJ_API void AJ_CALL alljoyn_busattachment_unregisterbuslistener(alljoyn_busattachment bus, alljoyn_buslistener listener); /** * Register interest in a well-known name prefix for the purpose of discovery over transports included in TRANSPORT_ANY. * This method is a shortcut/helper that issues an org.alljoyn.Bus.FindAdvertisedName method call to the local router * and interprets the response. * * @param bus The alljoyn_busattachment on which to register interest in the namePrefix. * @param[in] namePrefix Well-known name prefix that application is interested in receiving * alljoyn_buslistener_foundadvertisedname notifications about. * * @return * - #ER_OK iff router response was received and discovery was successfully started. * - #ER_BUS_NOT_CONNECTED if a connection has not been made with a local bus. * - Other error status codes indicating a failure. */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_findadvertisedname(alljoyn_busattachment bus, const char* namePrefix); /** * Register interest in a well-known name prefix for the purpose of discovery over specified transports. * This method is a shortcut/helper that issues an org.alljoyn.Bus.FindAdvertisedNameByTransport method call to the local router * and interprets the response. * * @param bus The alljoyn_busattachment on which to register interest in the namePrefix. * @param[in] namePrefix Well-known name prefix that application is interested in receiving * alljoyn_buslistener_foundadvertisedname notifications about. * @param[in] transports Set of transports to use for discovery. * * @return * - #ER_OK iff router response was received and discovery was successfully started. * - #ER_BUS_NOT_CONNECTED if a connection has not been made with a local bus. * - Other error status codes indicating a failure. */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_findadvertisednamebytransport(alljoyn_busattachment bus, const char* namePrefix, alljoyn_transportmask transports); /** * Cancel interest in a well-known name prefix that was previously registered * with alljoyn_busattachment_findadvertisedname over transports included in TRANSPORT_ANY. * This method is a shortcut/helper * that issues an org.alljoyn.Bus.CancelFindAdvertisedName method call to the * local router and interprets the response. * * @param bus The alljoyn_busattachment from which to remove interest in the namePrefix. * @param[in] namePrefix Well-known name prefix that application is no longer interested in receiving * BusListener::FoundAdvertisedName notifications about. * * @return * - #ER_OK iff router response was received and cancel was successfully completed. * - #ER_BUS_NOT_CONNECTED if a connection has not been made with a local bus. * - Other error status codes indicating a failure. */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_cancelfindadvertisedname(alljoyn_busattachment bus, const char* namePrefix); /** * Cancel interest in a well-known name prefix that was previously registered * with alljoyn_busattachment_findadvertisedname over specified transports. This method is a shortcut/helper * that issues an org.alljoyn.Bus.CancelFindAdvertisedNameByTransport method call to the * local router and interprets the response. * * @param bus The alljoyn_busattachment from which to remove interest in the namePrefix. * @param[in] namePrefix Well-known name prefix that application is no longer interested in receiving * BusListener::FoundAdvertisedName notifications about. * @param[in] transports Set of transports to cancel discovery on. * * @return * - #ER_OK iff router response was received and cancel was successfully completed. * - #ER_BUS_NOT_CONNECTED if a connection has not been made with a local bus. * - Other error status codes indicating a failure. */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_cancelfindadvertisednamebytransport(alljoyn_busattachment bus, const char* namePrefix, alljoyn_transportmask transports); /** * Advertise the existence of a well-known name to other (possibly disconnected) AllJoyn routers. * * This method is a shortcut/helper that issues an org.alljoyn.Bus.AdvertisedName method call to the local router * and interprets the response. * * @param[in] bus The bus on which to advertise the name. * @param[in] name the well-known name to advertise. (Must be owned by the caller via RequestName). * @param[in] transports Set of transports to use for sending advertisment. * * @return * - #ER_OK iff router response was received and advertise was successful. * - #ER_BUS_NOT_CONNECTED if a connection has not been made with a local bus. * - Other error status codes indicating a failure. */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_advertisename(alljoyn_busattachment bus, const char* name, alljoyn_transportmask transports); /** * Stop advertising the existence of a well-known name to other AllJoyn routers. * * This method is a shortcut/helper that issues an org.alljoyn.Bus.CancelAdvertiseName method call to the local router * and interprets the response. * @param[in] bus The bus on which we wish to cancel the name advertisement * @param[in] name A well-known name that was previously advertised via AdvertiseName. * @param[in] transports Set of transports whose name advertisment will be cancelled. * * @return * - #ER_OK iff router response was received and advertisements were sucessfully stopped. * - #ER_BUS_NOT_CONNECTED if a connection has not been made with a local bus. * - Other error status codes indicating a failure. */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_canceladvertisename(alljoyn_busattachment bus, const char* name, alljoyn_transportmask transports); /** * Retrieve an existing activated alljoyn_interfacedescription. * * @param bus The alljoyn_busattachment from which to retrieve the interface. * @param name Interface name. * * @return * - A pointer to the registered interface * - NULL if interface doesn't exist */ extern AJ_API const alljoyn_interfacedescription AJ_CALL alljoyn_busattachment_getinterface(alljoyn_busattachment bus, const char* name); /** * Join a session. * This method is a shortcut/helper that issues an org.alljoyn.Bus.JoinSession method call to the local router * and interprets the response. * * @param[in] bus alljoyn_busattachment with which to join a session. * @param[in] sessionHost Bus name of attachment that is hosting the session to be joined. * @param[in] sessionPort alljoyn_sessionport of sessionHost to be joined. * @param[in] listener Optional listener called when session related events occur. May be NULL. * @param[out] sessionId Unique identifier for session. * @param[in,out] opts Session options. * * @return * - #ER_OK iff router response was received and the session was successfully joined. * - #ER_BUS_NOT_CONNECTED if a connection has not been made with a local bus. * - Other error status codes indicating a failure. */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_joinsession(alljoyn_busattachment bus, const char* sessionHost, alljoyn_sessionport sessionPort, alljoyn_sessionlistener listener, alljoyn_sessionid* sessionId, alljoyn_sessionopts opts); /** * Join a session. * This method is a shortcut/helper that issues an org.alljoyn.Bus.JoinSession method call to the local router * and interprets the response. * * This call executes asynchronously. When the JoinSession response is received, the callback will be called. * * @param[in] bus alljoyn_busattachment with which to join a session. * @param[in] sessionHost Bus name of attachment that is hosting the session to be joined. * @param[in] sessionPort alljoyn_sessionport of sessionHost to be joined. * @param[in] listener Optional listener called when session related events occur. May be NULL. * @param[in] opts Session options. * @param[in] callback Called when JoinSession response is received. * @param[in] context User defined context which will be passed as-is to callback. * * @return * - #ER_OK iff method call to local router response was was successful. * - #ER_BUS_NOT_CONNECTED if a connection has not been made with a local bus. * - Other error status codes indicating a failure. */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_joinsessionasync(alljoyn_busattachment bus, const char* sessionHost, alljoyn_sessionport sessionPort, alljoyn_sessionlistener listener, const alljoyn_sessionopts opts, alljoyn_busattachment_joinsessioncb_ptr callback, void* context); /** * Register a BusObject * * @param bus The bus on which to register the object. * @param obj BusObject to register. * * @return * - #ER_OK if successful. * - #ER_BUS_BAD_OBJ_PATH for a bad object path * - #ER_BUS_OBJ_ALREADY_EXISTS if an object is already registered at this path */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_registerbusobject(alljoyn_busattachment bus, alljoyn_busobject obj); /** * Register a BusObject. Bus objects registered using this function will require * authentication. Unless the interfaces security policy is AJ_IFC_SECURITY_OFF. * * * @param bus The bus on which to register the object. * @param obj BusObject to register. * * @return * - #ER_OK if successful. * - #ER_BUS_BAD_OBJ_PATH for a bad object path * - #ER_BUS_OBJ_ALREADY_EXISTS if an object is already registered at this path * * @see alljoyn_busattachment_registerbusobject */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_registerbusobject_secure(alljoyn_busattachment bus, alljoyn_busobject obj); /** * Unregister a BusObject * * @param bus The bus from which to unregister the object. * @param object Object to be unregistered. */ extern AJ_API void AJ_CALL alljoyn_busattachment_unregisterbusobject(alljoyn_busattachment bus, alljoyn_busobject object); /** * Request a well-known name. * This method is a shortcut/helper that issues an org.freedesktop.DBus.RequestName method call to the local router * and interprets the response. * * @param[in] bus The bus on which to request the specified name. * @param[in] requestedName Well-known name being requested. * @param[in] flags Bitmask of DBUS_NAME_FLAG_* defines (see DBusStdDefines.h) * * @return * - #ER_OK iff router response was received and request was successful. * - #ER_BUS_NOT_CONNECTED if a connection has not been made with a local bus. * - Other error status codes indicating a failure. */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_requestname(alljoyn_busattachment bus, const char* requestedName, uint32_t flags); /** * Release a previously requeted well-known name. * This method is a shortcut/helper that issues an org.freedesktop.DBus.ReleaseName method call to the local router * and interprets the response. * * @param[in] bus The alljoyn_busattachment from which to release the name. * @param[in] name Well-known name being released. * * @return * - #ER_OK iff router response was received amd the name was successfully released. * - #ER_BUS_NOT_CONNECTED if a connection has not been made with a local bus. * - Other error status codes indicating a failure. */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_releasename(alljoyn_busattachment bus, const char* name); /** * Make an alljoyn_sessionport available for external alljoyn_busattachments to join. * * Each alljoyn_busattachment binds its own set of alljoyn_sessionports. Session joiners use the * bound session port along with the name of the attachment to create a persistent logical * connection (called a Session) with the original alljoyn_busattachment. * * An alljoyn_sessionport and bus name form a unique identifier that * alljoyn_busattachments use when joining a session. * * alljoyn_sessionport values can be pre-arranged between AllJoyn services and their clients (well-known * alljoyn_sessionports). * * Once a session is joined using one of the service's well-known alljoyn_sessionports, * the service may bind additional alljoyn_sessionports (dynamically) and share * these alljoyn_sessionports with the joiner over the original session. * The joiner can then create additional sessions with the service by calling * JoinSession with these dynamic alljoyn_sessionport ids. * * @param[in] bus The bus on which to make the session port available. * @param[in,out] sessionPort alljoyn_sessionport value to bind or SESSION_PORT_ANY to allow this method * to choose an available port. On successful return, this value * contains the chosen alljoyn_sessionport. * * @param[in] opts Session options that joiners must agree to in order to * successfully join the session. * * @param[in] listener Called by the bus when session related events occur. * * @return * - #ER_OK iff router response was received and the bind operation was successful. * - #ER_BUS_NOT_CONNECTED if a connection has not been made with a local bus. * - Other error status codes indicating a failure. */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_bindsessionport(alljoyn_busattachment bus, alljoyn_sessionport* sessionPort, const alljoyn_sessionopts opts, alljoyn_sessionportlistener listener); /** * Cancel an existing port binding. * * @param[in] bus The bus on which to cancel the port binding. * @param[in] sessionPort Existing session port to be un-bound. * * @return * - #ER_OK iff router response was received and the bind operation was successful. * - #ER_BUS_NOT_CONNECTED if a connection has not been made with a local bus. * - Other error status codes indicating a failure. */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_unbindsessionport(alljoyn_busattachment bus, alljoyn_sessionport sessionPort); /** * Enable peer-to-peer security. This function must be called by applications that * want to use authentication and encryption . The bus must have been started by calling * alljoyn_busattachment_start() before this function is called. If the application * is providing its own key store implementation it must have already called * alljoyn_busattachment_registerkeystorelistener() before calling this function. * * Once peer security has been enabled it is not possible to change the authMechanism set without * clearing it first (setting authMechanism to NULL). This is true regardless of whether the BusAttachment * has been disconnected or not. * * @param bus The bus on which to enable security. * * @param authMechanisms The authentication mechanism(s) to use for peer-to-peer authentication. * If this parameter is NULL peer-to-peer authentication is disabled. * This is a space separated list of any of the following values: ALLJOYN_SRP_LOGON, * ALLJOYN_SRP_KEYX, ALLJOYN_ECDHE_NULL, ALLJOYN_ECDHE_PSK, ALLJOYN_ECDHE_ECDSA, GSSAPI. * * @param listener Passes password and other authentication related requests to the application. * * @param keyStoreFileName Optional parameter to specify the filename of the default key store. The * default value is the applicationName parameter of alljoyn_busattachment_create(). * Note that this parameter is only meaningful when using the default * key store implementation. * * @param isShared Optional parameter that indicates if the key store is shared between multiple * applications. It is generally harmless to set this to true even when the * key store is not shared but it adds some unnecessary calls to the key store * listener to load and store the key store in this case. * * @return * - #ER_OK if peer security was enabled. * - #ER_BUS_BUS_NOT_STARTED alljoyn_busattachment_start has not been called */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_enablepeersecurity(alljoyn_busattachment bus, const char* authMechanisms, alljoyn_authlistener listener, const char* keyStoreFileName, QCC_BOOL isShared); /** * Check is peer security has been enabled for this bus attachment. * * @param bus The bus on which to query if peer security is enabled. * * @return Returns QCC_TRUE if peer security has been enabled, QCC_FALSE otherwise. */ extern AJ_API QCC_BOOL AJ_CALL alljoyn_busattachment_ispeersecurityenabled(alljoyn_busattachment bus); /** * Initialize one more interface descriptions from an XML string in DBus introspection format. * The root tag of the XML can be a \ or a standalone \ tag. To initialize more * than one interface the interfaces need to be nested in a \ tag. * * Note that when this method fails during parsing, the return code will be set accordingly. * However, any interfaces which were successfully parsed prior to the failure may be registered * with the bus. * * @param bus The bus on which to create interfaces. * @param xml An XML string in DBus introspection format. * * @return * - #ER_OK if parsing is completely successful. * - An error status otherwise. */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_createinterfacesfromxml(alljoyn_busattachment bus, const char* xml); /** * Returns the existing activated InterfaceDescriptions. * * @param bus The bus to obtaining the interfaces from * @param ifaces A pointer to an InterfaceDescription array to receive the interfaces. Can be NULL in * which case no interfaces are returned and the return value gives the number * of interfaces available. * @param numIfaces The size of the InterfaceDescription array. If this value is smaller than the total * number of interfaces only numIfaces will be returned. * * @return The number of interfaces returned or the total number of interfaces if ifaces is NULL. */ extern AJ_API size_t AJ_CALL alljoyn_busattachment_getinterfaces(const alljoyn_busattachment bus, const alljoyn_interfacedescription* ifaces, size_t numIfaces); /** * Delete an interface description with a given name. * * Deleting an interface is only allowed if that interface has never been activated. * * @param bus The bus from which to delete the interface. * @param iface The un-activated interface to be deleted. * * @return * - #ER_OK if deletion was successful * - #ER_BUS_NO_SUCH_INTERFACE if interface was not found */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_deleteinterface(alljoyn_busattachment bus, alljoyn_interfacedescription iface); /** * Returns QCC_TRUE if the mesage bus has been started. * * @param bus The bus to query. * * @return true if the message bus has been started i.e. alljoyn_busattachment_start() has been called. */ extern AJ_API QCC_BOOL AJ_CALL alljoyn_busattachment_isstarted(alljoyn_busattachment bus); /** * Indicates #alljoyn_busattachment_stop() has been called * * @param bus The bus to query. * * @return QCC_TRUE if the mesage bus has been requested to stop. */ extern AJ_API QCC_BOOL AJ_CALL alljoyn_busattachment_isstopping(alljoyn_busattachment bus); /** * Indicate whether bus is currently connected. * * Messages can only be sent or received when the bus is connected. * * @param bus The bus to query. * @return true if the bus is connected. */ extern AJ_API QCC_BOOL AJ_CALL alljoyn_busattachment_isconnected(const alljoyn_busattachment bus); /** * Disconnect a remote bus address connection. * * @param bus The bus to disconnect. * @param unused Deprecated parameter. * * @return * - #ER_OK if successful * - #ER_BUS_BUS_NOT_STARTED if the bus is not started * - #ER_BUS_NOT_CONNECTED if the %alljoyn_busattachment is not connected to the bus * - Other error status codes indicating a failure */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_disconnect(alljoyn_busattachment bus, const char* unused); /** * Get the org.freedesktop.DBus proxy object. * * @param bus The bus from which to get the object. * * @return org.freedesktop.DBus proxy object */ extern AJ_API const alljoyn_proxybusobject AJ_CALL alljoyn_busattachment_getdbusproxyobj(alljoyn_busattachment bus); /** * Get the org.alljoyn.Bus proxy object. * * @param bus The bus from which to get the object. * * @return org.alljoyn.Bus proxy object */ extern AJ_API const alljoyn_proxybusobject AJ_CALL alljoyn_busattachment_getalljoynproxyobj(alljoyn_busattachment bus); /** * Get the org.alljoyn.Debug proxy object. * * @param bus The bus from which to get the object. * * @return org.alljoyn.Debug proxy object */ extern AJ_API const alljoyn_proxybusobject AJ_CALL alljoyn_busattachment_getalljoyndebugobj(alljoyn_busattachment bus); /** * Get the unique name of this alljoyn_busattachment. * * @param bus The bus to query. * * @return The unique name of this alljoyn_busattachment. */ extern AJ_API const char* AJ_CALL alljoyn_busattachment_getuniquename(const alljoyn_busattachment bus); /** * Get the guid of the local router as a string * * @param bus The bus to query. * * @return GUID of local AllJoyn router as a string. */ extern AJ_API const char* AJ_CALL alljoyn_busattachment_getglobalguidstring(const alljoyn_busattachment bus); /** * Register a signal handler. * * Signals are forwarded to the signalHandler if sender, interface, member and path * qualifiers are ALL met. * * @param bus The alljoyn_busattachment to register the signal handler with * @param signal_handler The signal handler method. * @param member The interface/member of the signal. * @param srcPath The object path of the emitter of the signal or NULL for all paths. * @return #ER_OK */ /* * may need to create another registersignalhandler that takes a MessageReceiver * type. */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_registersignalhandler(alljoyn_busattachment bus, alljoyn_messagereceiver_signalhandler_ptr signal_handler, const alljoyn_interfacedescription_member member, const char* srcPath); /** * Register a signal handler with a filter rule. * * Signals are forwarded to the signalHandler if sender, interface, member and rule * qualifiers are ALL met. * * @param bus The alljoyn_busattachment to register the signal handler with * @param signal_handler The signal handler method. * @param member The interface/member of the signal. * @param matchRule The filter rule. * @return #ER_OK */ /* * may need to create another registersignalhandler that takes a MessageReceiver * type. */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_registersignalhandlerwithrule(alljoyn_busattachment bus, alljoyn_messagereceiver_signalhandler_ptr signal_handler, const alljoyn_interfacedescription_member member, const char* matchRule); /** * Unregister a signal handler. * * Remove the signal handler that was registered with the given parameters. * * @param bus The alljoyn_busattachment to unregister the signal handler with * @param signal_handler The signal handler method. * @param member The interface/member of the signal. * @param srcPath The object path of the emitter of the signal or NULL for all paths. * @return #ER_OK */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_unregistersignalhandler(alljoyn_busattachment bus, alljoyn_messagereceiver_signalhandler_ptr signal_handler, const alljoyn_interfacedescription_member member, const char* srcPath); /** * Unregister a signal handler with a filter rule. * * Remove the signal handler that was registered with the given parameters. * * @param bus The alljoyn_busattachment to unregister the signal handler with * @param signal_handler The signal handler method. * @param member The interface/member of the signal. * @param matchRule The filter rule. * @return #ER_OK */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_unregistersignalhandlerwithrule(alljoyn_busattachment bus, alljoyn_messagereceiver_signalhandler_ptr signal_handler, const alljoyn_interfacedescription_member member, const char* matchRule); /** * Unregister a signal handler with a filter rule. * * Remove the signal handler that was registered with the given parameters. * * @param bus The alljoyn_busattachment to unregister the signal handler with * @param signal_handler The signal handler method. * @param member The interface/member of the signal. * @param matchRule The filter rule. * @return #ER_OK */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_unregistersignalhandlerwithrule(alljoyn_busattachment bus, alljoyn_messagereceiver_signalhandler_ptr signal_handler, const alljoyn_interfacedescription_member member, const char* matchRule); /** * Unregister all signal and reply handlers for the specified alljoyn_busattachment. * * @param bus The alljoyn_busattachment to unregister the signal handler with * @return ER_OK if successful. */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_unregisterallhandlers(alljoyn_busattachment bus); /** * Set a key store listener to listen for key store load and store requests. * This overrides the internal key store listener. * * @param bus The bus on which to register the key store listener. * @param listener The key store listener to set. * * @return * - #ER_OK if the key store listener was set * - #ER_BUS_LISTENER_ALREADY_SET if a listener has been set by this function or because * EnablePeerSecurity has been called. */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_registerkeystorelistener(alljoyn_busattachment bus, alljoyn_keystorelistener listener); /** * Reloads the key store for this bus attachment. This function would normally only be called in * the case where a single key store is shared between multiple bus attachments, possibly by different * applications. It is up to the applications to coordinate how and when the shared key store is * modified. * * @param bus The bus on which to reload the key store. * * @return - ER_OK if the key store was succesfully reloaded * - An error status indicating that the key store reload failed. */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_reloadkeystore(alljoyn_busattachment bus); /** * Clears all stored keys from the key store. All store keys and authentication information is * deleted and cannot be recovered. Any passwords or other credentials will need to be reentered * when establishing secure peer connections. * * @param bus The bus on which to clear the key store. */ extern AJ_API void AJ_CALL alljoyn_busattachment_clearkeystore(alljoyn_busattachment bus); /** * Clear the keys associated with aa specific remote peer as identified by its peer GUID. The * peer GUID associated with a bus name can be obtained by calling GetPeerGUID(). * * @param bus The bus from which to clear specific keys. * @param guid The guid of a remote authenticated peer. * * @return - ER_OK if the keys were cleared * - ER_UNKNOWN_GUID if there is no peer with the specified GUID * - Other errors */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_clearkeys(alljoyn_busattachment bus, const char* guid); /** * Set the expiration time on keys associated with a specific remote peer as identified by its * peer GUID. The peer GUID associated with a bus name can be obtained by calling GetPeerGUID(). * If the timeout is 0 this is equivalent to calling ClearKeys(). * * @param bus The bus on which to set a key expiration. * @param guid The GUID of a remote authenticated peer. * @param timeout The time in seconds relative to the current time to expire the keys. * * @return - ER_OK if the expiration time was succesfully set. * - ER_UNKNOWN_GUID if there is no authenticated peer with the specified GUID * - Other errors */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_setkeyexpiration(alljoyn_busattachment bus, const char* guid, uint32_t timeout); /** * Get the expiration time on keys associated with a specific authenticated remote peer as * identified by its peer GUID. The peer GUID associated with a bus name can be obtained by * calling GetPeerGUID(). * * @param bus The bus to query. * @param guid The GUID of a remote authenticated peer. * @param timeout The time in seconds relative to the current time when the keys will expire. * * @return - ER_OK if the expiration time was succesfully set. * - ER_UNKNOWN_GUID if there is no authenticated peer with the specified GUID * - Other errors */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_getkeyexpiration(alljoyn_busattachment bus, const char* guid, uint32_t* timeout); /** * Adds a logon entry string for the requested authentication mechanism to the key store. This * allows an authenticating server to generate offline authentication credentials for securely * logging on a remote peer using a user-name and password credentials pair. This only applies * to authentication mechanisms that support a user name + password logon functionality. * * @param bus The bus on which to add a logon entry. * @param authMechanism The authentication mechanism. * @param userName The user name to use for generating the logon entry. * @param password The password to use for generating the logon entry. If the password is * NULL the logon entry is deleted from the key store. * * @return * - #ER_OK if the logon entry was generated. * - #ER_BUS_INVALID_AUTH_MECHANISM if the authentication mechanism does not support * logon functionality. * - #ER_BAD_ARG_2 indicates a null string was used as the user name. * - #ER_BAD_ARG_3 indicates a null string was used as the password. * - Other error status codes indicating a failure */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_addlogonentry(alljoyn_busattachment bus, const char* authMechanism, const char* userName, const char* password); /** * Add a DBus match rule. * This method is a shortcut/helper that issues an org.freedesktop.DBus.AddMatch method call to the local router. * * @param[in] bus The bus on which to add the match rule. * @param[in] rule Match rule to be added (see DBus specification for format of this string). * * @return * - #ER_OK if the AddMatch request was successful. * - #ER_BUS_NOT_CONNECTED if a connection has not been made with a local bus. * - Other error status codes indicating a failure. */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_addmatch(alljoyn_busattachment bus, const char* rule); /** * Remove a DBus match rule. * This method is a shortcut/helper that issues an org.freedesktop.DBus.RemoveMatch method call to the local router. * * @param[in] bus The bus from which to remove the match rule. * @param[in] rule Match rule to be removed (see DBus specification for format of this string). * * @return * - #ER_OK if the RemoveMatch request was successful. * - #ER_BUS_NOT_CONNECTED if a connection has not been made with a local bus. * - Other error status codes indicating a failure. */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_removematch(alljoyn_busattachment bus, const char* rule); /** * Set the SessionListener for an existing sessionId. * Calling this method will override the listener set by a previoius call to SetSessionListener or any * listener specified in JoinSession. * * @param bus The bus on which to assign the SessionListener. * @param sessionId The session id of an existing session. * @param listener The SessionListener to associate with the session. May be NULL to clear previous listener. * @return ER_OK if successful. */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_setsessionlistener(alljoyn_busattachment bus, alljoyn_sessionid sessionId, alljoyn_sessionlistener listener); /** * Leave an existing session. * This method is a shortcut/helper that issues an org.alljoyn.Bus.LeaveSession method call to the local router * and interprets the response. * * @param[in] bus The bus on which to leave the session. * @param[in] sessionId Session id. * * @return * - #ER_OK iff router response was received and the leave operation was successfully completed. * - #ER_BUS_NOT_CONNECTED if a connection has not been made with a local bus. * - Other error status codes indicating a failure. */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_leavesession(alljoyn_busattachment bus, alljoyn_sessionid sessionId); /** * Remove a member from an existing multipoint session. * This function may be called by the binder of the session to forcefully remove a member from a session. * * This method is a shortcut/helper that issues an org.alljoyn.Bus.RemoveSessionMember method call to the local router * and interprets the response. * * @param[in] bus The bus which the member is being removed from * @param[in] sessionId Session id. * @param[in] memberName Member to remove. * * @return * - #ER_OK iff router response was received and the remove member operation was successfully completed. * - #ER_BUS_NOT_CONNECTED if a connection has not been made with a local bus. * - Other error status codes indicating a failure. */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_removesessionmember(alljoyn_busattachment bus, alljoyn_sessionid sessionId, const char* memberName); /** * Set the link timeout for a session. * * Link timeout is the maximum number of seconds that an unresponsive router-to-router connection * will be monitored before declaring the session lost (via SessionLost callback). Link timeout * defaults to 0 which indicates that AllJoyn link monitoring is disabled. * * Each transport type defines a lower bound on link timeout to avoid defeating transport * specific power management algorithms. * * @param bus The bus containing the link to modify. * @param sessionid Id of session whose link timeout will be modified. * @param linkTimeout [IN/OUT] Max number of seconds that a link can be unresponsive before being * declared lost. 0 indicates that AllJoyn link monitoring will be disabled. On * return, this value will be the resulting (possibly upward) adjusted linkTimeout * value that acceptable to the underlying transport. * * @return * - #ER_OK if successful * - #ER_ALLJOYN_SETLINKTIMEOUT_REPLY_NOT_SUPPORTED if local router does not support SetLinkTimeout * - #ER_ALLJOYN_SETLINKTIMEOUT_REPLY_NO_DEST_SUPPORT if SetLinkTimeout not supported by destination * - #ER_BUS_NO_SESSION if the Session id is not valid * - #ER_ALLJOYN_SETLINKTIMEOUT_REPLY_FAILED if SetLinkTimeout failed * - #ER_BUS_NOT_CONNECTED if the alljoyn_busattachment is not connected to the router */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_setlinktimeout(alljoyn_busattachment bus, alljoyn_sessionid sessionid, uint32_t* linkTimeout); /** * Set the link timeout for a session. * * Link timeout is the maximum number of seconds that an unresponsive * router-to-router connection will be monitored before declaring the session * lost (via SessionLost callback). Link timeout defaults to 0 which indicates * that AllJoyn link monitoring is disabled. * * Each transport type defines a lower bound on link timeout to avoid defeating * transport specific power management algorithms. * * This call executes asynchronously. When the alljoyn_busattachment_setlinktimeoutasync * response is received, the callback will be called. * * @param[in] bus The bus containing the link to modify. * @param[in] sessionid Id of session whose link timeout will be modified. * @param[in] linkTimeout Max number of seconds that a link can be unresponsive before being * declared lost. 0 indicates that AllJoyn link monitoring will be disabled. On * return, this value will be the resulting (possibly upward) adjusted linkTimeout * value that acceptable to the underlying transport. * @param[in] callback alljoyn_busattachment_setlinktimeoutcb_ptr function * Called when alljoyn_busattachment_setlinktimeoutasync * response is received. * @param[in] context User defined context which will be passed as-is to callback. * * @return * - #ER_OK iff method call to local router response was was successful. * - #ER_BUS_NOT_CONNECTED if a connection has not been made with a local bus. * - Other error status codes indicating a failure. */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_setlinktimeoutasync(alljoyn_busattachment bus, alljoyn_sessionid sessionid, uint32_t linkTimeout, alljoyn_busattachment_setlinktimeoutcb_ptr callback, void* context); /** * Determine whether a given well-known name exists on the bus. * This method is a shortcut/helper that issues an org.freedesktop.DBus.NameHasOwner method call to the router * and interprets the response. * * @param[in] bus The bus to query. * @param[in] name The well known name that the caller is inquiring about. * @param[out] hasOwner If return is ER_OK, indicates whether name exists on the bus. * If return is not ER_OK, param is not modified. * @return * - #ER_OK if name ownership was able to be determined. * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_namehasowner(alljoyn_busattachment bus, const char* name, QCC_BOOL* hasOwner); /** * Get the peer GUID for this peer of the local peer or an authenticated remote peer. The bus * names of a remote peer can change over time, specifically the unique name is different each * time the peer connects to the bus and a peer may use different well-known-names at different * times. The peer GUID is the only persistent identity for a peer. Peer GUIDs are used by the * authentication mechanisms to uniquely and identify a remote application instance. The peer * GUID for a remote peer is only available if the remote peer has been authenticated. * * @param bus The bus on which to get the peer GUID. * @param name Name of a remote peer or NULL to get the local (this application's) peer GUID. * @param guid Returns the guid for the local or remote peer depending on the value of name, or NULL to get size. * @param guidSz Size of the provided guid buffer, upon exit size of guid string. * * @return * - #ER_OK if the requested GUID was obtained. * - An error status otherwise. */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_getpeerguid(alljoyn_busattachment bus, const char* name, char* guid, size_t* guidSz); /** * This sets the debug level of the local AllJoyn router if that router * was built in debug mode. * * The debug level can be set for individual subsystems or for "ALL" * subsystems. Common subsystems are "ALLJOYN" for core AllJoyn code, * "ALLJOYN_OBJ" for the sessions management code and "ALLJOYN_NS" * for the TCP name services. Debug levels for specific subsystems * override the setting for "ALL" subsystems. For example if "ALL" is * set to 7, but "ALLJOYN_OBJ" is set to 1, then detailed debug output * will be generated for all subsystems expcept for "ALLJOYN_OBJ" * which will only generate high level debug output. "ALL" defaults * to 0 which is off, or no debug output. * * The debug output levels are actually a bit field that controls what * output is generated. Those bit fields are described below: * * - 0x1: High level debug prints (these debug printfs are not common) * - 0x2: Normal debug prints (these debug printfs are common) * - 0x4: Function call tracing (these debug printfs are used * sporadically) * - 0x8: Data dump (really only used in the "SOCKET" module - can * generate a *lot* of output) * * Typically, when enabling debug for a subsystem, the level would be set * to 7 which enables High level debug, normal debug, and function call * tracing. Setting the level 0, forces debug output to be off for the * specified subsystem. * * @param bus bus on which to set debugging. * @param module name of the module to generate debug output * @param level debug level to set for the module * * @return * - #ER_OK if debug request was successfully sent to the AllJoyn * router. * - #ER_BUS_NO_SUCH_OBJECT if router was not built in debug mode. */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_setdaemondebug(alljoyn_busattachment bus, const char* module, uint32_t level); /** * Returns the current non-absolute real-time clock used internally by AllJoyn. This value can be * compared with the timestamps on messages to calculate the time since a timestamped message * was sent. * * @return The current timestamp in milliseconds. */ extern AJ_API uint32_t AJ_CALL alljoyn_busattachment_gettimestamp(); /** * Determine if you are able to find a remote connection based on its BusName. * The BusName can be the Unique or well-known name. * * @param bus alljoyn_busattachment * @param name The unique or well-known name to ping * @param timeout Timeout specified in milliseconds to wait for reply * @return * - #ER_OK the name is present and responding * - #ER_ALLJOYN_PING_REPLY_UNREACHABLE the name is no longer present *
* The following return values indicate that the router cannot determine if the * remote name is present and responding: * - #ER_ALLJOYN_PING_REPLY_TIMEOUT Ping call timed out * - #ER_ALLJOYN_PING_REPLY_UNKNOWN_NAME name not found currently or not part of any known session * - #ER_ALLJOYN_PING_REPLY_INCOMPATIBLE_REMOTE_ROUTING_NODE the remote routing node does not implement Ping *
* The following return values indicate an error with the ping call itself: * - #ER_ALLJOYN_PING_FAILED Ping failed * - #ER_BUS_UNEXPECTED_DISPOSITION An unexpected disposition was returned and has been treated as an error * - #ER_BUS_NOT_CONNECTED the BusAttachment is not connected to the bus * - #ER_BUS_BAD_BUS_NAME the name parameter is not a valid bus name * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_ping(alljoyn_busattachment bus, const char* name, uint32_t timeout); /** * Registers a handler to receive the org.alljoyn.about Announce signal. * * The handler is only called if a call to alljoyn_busattachment_whoimplements_* * has been has been called. * * This function is experimental, and as such has not been fully tested. * Please help make it more robust by contributing fixes if you find problems. * * Important: the alljoyn_aboutlistener should be registered before calling * alljoyn_busattachment_whoimplments_* * * @param[in] bus alljoyn_busattachment this call is made for * @param[in] aboutListener alljoyn_aboutlistener to be registered */ extern AJ_API void AJ_CALL alljoyn_busattachment_registeraboutlistener(alljoyn_busattachment bus, alljoyn_aboutlistener aboutListener); /** * Unregisters the AnnounceHandler from receiving the org.alljoyn.about Announce signal. * * This function is experimental, and as such has not been fully tested. * Please help make it more robust by contributing fixes if you find problems. * * @param[in] bus alljoyn_busattachment this call is made for * @param[in] aboutListener alljoyn_aboutlistener to be unregistered */ extern AJ_API void AJ_CALL alljoyn_busattachment_unregisteraboutlistener(alljoyn_busattachment bus, alljoyn_aboutlistener aboutListener); /** * Unregisters all AboutListeners from receiving any org.alljoyn.about Announce signal * * This function is experimental, and as such has not been fully tested. * Please help make it more robust by contributing fixes if you find problems. * * @param[in] bus alljoyn_busattachment this call is made for */ extern AJ_API void AJ_CALL alljoyn_busattachment_unregisterallaboutlisteners(alljoyn_busattachment bus); /** * List the interfaces the application is interested in. If a remote device * is announcing that interface then all registered listeners for About * will be called. * * It's the About listener's responsibility to parse through the reported * interfaces to figure out what should be done in response to the Announce * signal. * * This call is ref counted. If this function is called with the same * list of interfaces multiple times then alljoyn_busattachment_cancelwhoimplements_interfaces * must also be called multiple times with the same list of interfaces. * * Note: specifying NULL for the implementsInterfaces parameter could have * significant impact on network performance and should be avoided unless * all announcements are needed. * * This function is experimental, and as such has not been fully tested. * Please help make it more robust by contributing fixes if you find problems. * * @param[in] bus alljoyn_busattachment this call is made for * @param[in] implementsInterfaces a list of interfaces that the Announce signal * reports as implemented. NULL to receive all * Announce signals regardless of interfaces * @param[in] numberInterfaces the number of interfaces in the * implementsInterfaces list * @return status */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_whoimplements_interfaces(alljoyn_busattachment bus, const char** implementsInterfaces, size_t numberInterfaces); /** * List an interface the application is interested in. If a remote device * is announcing that interface then all registered listeners for the * Announce signal will be called. * * This is identical to alljoyn_busattachment_whoimplements_interfaces * except this is specialized for a single interface not several interfaces. * * Note: specifying NULL for the interface parameter could have significant * impact on network performance and should be avoided unless all * announcements are needed. * * This function is experimental, and as such has not been fully tested. * Please help make it more robust by contributing fixes if you find problems. * * @see alljoyn_busattachment_whoimplements_interfaces(const char**, size_t) * @param[in] bus alljoyn_busattachment this call is made for * @param[in] implementsInterface interface that must be implemented in order * to receive the announce signal. * @return * - #ER_OK on success * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_whoimplements_interface(alljoyn_busattachment bus, const char* implementsInterface); /** * Stop showing interest in the listed interfaces. Stop receiving announce * signals from the devices with the listed interfaces. * * Note if alljoyn_busattachment_whoimplements_interfaces has been called multiple * times the announce signal will still be received for any interfaces that still remain. * * This function is experimental, and as such has not been fully tested. * Please help make it more robust by contributing fixes if you find problems. * * @param[in] bus alljoyn_busattachment this call is made for * @param[in] implementsInterfaces a list of interfaces. The list must match the * list previously passed to the WhoImplements * member function * @param[in] numberInterfaces the number of interfaces in the * implementsInterfaces list * @return * - #ER_OK on success * - #ER_BUS_MATCH_RULE_NOT_FOUND if interfaces added using the WhoImplements * member function were not found. * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_cancelwhoimplements_interfaces(alljoyn_busattachment bus, const char** implementsInterfaces, size_t numberInterfaces); /** * Stop showing interest in the listed interfaces. Stop receiving announce * signals from the devices with the listed interfaces. * * This is identical to alljoyn_busattachment_cancelwhoimplements_interfaces * except this is specialized for a single interface not several interfaces. * * This function is experimental, and as such has not been fully tested. * Please help make it more robust by contributing fixes if you find problems. * * @see alljoyn_busattachment_cancelwhoimplements(const char**, size_t) * @param[in] bus alljoyn_busattachment this call is made for * @param[in] implementsInterface interface that must be implement in order to * receive the announce signal. * * @return * - #ER_OK on success * - #ER_BUS_MATCH_RULE_NOT_FOUND if interface added using the WhoImplements * member function were not found. * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_busattachment_cancelwhoimplements_interface(alljoyn_busattachment bus, const char* implementsInterface); #ifdef __cplusplus } /* extern "C" */ #endif #endif alljoyn-15.04b/alljoyn_c/inc/alljoyn_c/BusListener.h000066400000000000000000000205151255700255500224530ustar00rootroot00000000000000/** * @file * BusListener is an abstract base class (interface) implemented by users of the * AllJoyn API in order to asynchronously receive bus related event information. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_C_BUSLISTENER_H #define _ALLJOYN_C_BUSLISTENER_H #include #include #include #ifdef __cplusplus extern "C" { #endif /** * alljoyn_buslistener consists of a collection of function pointers implemented by * AllJoyn users and called by AllJoyn to inform users of bus related events. */ typedef struct _alljoyn_buslistener_handle* alljoyn_buslistener; #ifndef _ALLJOYN_OPAQUE_BUSATTACHMENT_ #define _ALLJOYN_OPAQUE_BUSATTACHMENT_ /** * alljoyn_busattachment is the top level object responsible for connecting to and * managing an AllJoyn message bus */ typedef struct _alljoyn_busattachment_handle* alljoyn_busattachment; #endif /** * Type for the ListenerRegistered callback. * * Called by the bus when the listener is registered. This gives the listener implementation the * opportunity to save a reference to the bus. * * @param context The context pointer that was passed into the alljoyn_buslistener_create function * @param bus The alljoyn_busattachment the listener is registered with. */ typedef void (AJ_CALL * alljoyn_buslistener_listener_registered_ptr)(const void* context, alljoyn_busattachment bus); /** * Type for the ListenerUnregistered callback. * * Called by the bus when the listener is unregistered. * * @param context The context pointer that was passed into the alljoyn_buslistener_create function */ typedef void (AJ_CALL * alljoyn_buslistener_listener_unregistered_ptr)(const void* context); /** * Type for the FoundAdvertisedName callback. * * Called by the bus when an external bus is discovered that is advertising a well-known name * that this attachment has registered interest in via a DBus call to org.alljoyn.Bus.FindAdvertisedName * * @param context The context pointer that was passed into the alljoyn_buslistener_create function * @param name A well known name that the remote bus is advertising. * @param transport Transport that received the advertisement. * @param namePrefix The well-known name prefix used in call to FindAdvertisedName that triggered this callback. */ typedef void (AJ_CALL * alljoyn_buslistener_found_advertised_name_ptr)(const void* context, const char* name, alljoyn_transportmask transport, const char* namePrefix); /** * This callback is deprecated, it will not be called any more. Use the property change notification mechanism for proxy bus objects. * Type for the LostAdvertisedName callback. * * Called by the bus when an advertisement previously reported through FoundName has become unavailable. * * @param context The context pointer that was passed into the alljoyn_buslistener_create function * @param name A well known name that the remote bus is advertising that is of interest to this attachment. * @param transport Transport that stopped receiving the given advertised name. * @param namePrefix The well-known name prefix that was used in a call to FindAdvertisedName that triggered this callback. */ typedef void (AJ_CALL * alljoyn_buslistener_lost_advertised_name_ptr)(const void* context, const char* name, alljoyn_transportmask transport, const char* namePrefix); /** * Type for the NameOwnerChanged callback. * * Called by the bus when the ownership of any well-known name changes. * * @param context The context pointer that was passed into the alljoyn_buslistener_create function * @param busName The well-known name that has changed. * @param previousOwner The unique name that previously owned the name or NULL if there was no previous owner. * @param newOwner The unique name that now owns the name or NULL if there is no new owner. */ typedef void (AJ_CALL * alljoyn_buslistener_name_owner_changed_ptr)(const void* context, const char* busName, const char* previousOwner, const char* newOwner); /** * Type for the BusStopping callback. * * @param context The context pointer that was passed into the alljoyn_buslistener_create function */ typedef void (AJ_CALL * alljoyn_buslistener_bus_stopping_ptr)(const void* context); /** * Type for the BusDisconnected callback. * * @param context The context pointer that was passed into the alljoyn_buslistener_create function */ typedef void (AJ_CALL * alljoyn_buslistener_bus_disconnected_ptr)(const void* context); /** * Type for the PropertyChanged callback. * * Called by the bus when the value of a property changes if that property has annotation * * @param context The context pointer that was passed into the alljoyn_buslistener_create function * @param propName The well-known name that has changed. * @param propValue The new value of the property; NULL if not present */ typedef void (AJ_CALL * alljoyn_buslistener_bus_prop_changed_ptr)(const void* context, const char* prop_name, alljoyn_msgarg prop_value); /** * Struct containing callbacks used for creation of an alljoyn_buslistener. */ typedef struct { /** * Function pointer called by the bus when the listener is registered */ alljoyn_buslistener_listener_registered_ptr listener_registered; /** * Function pointer called by the bus when the listener is unregistered */ alljoyn_buslistener_listener_unregistered_ptr listener_unregistered; /** * Function pointer called by the bus when an external bus is discovered that is advertising * a well-known name that this alljoyn_busattachment has registered interest * in via a DBus call to org.alljoyn.Bus.FindAdvertisedName */ alljoyn_buslistener_found_advertised_name_ptr found_advertised_name; /** * Function pointer called by the bus when an advertisement previously reported through FoundName has become unavailable. */ alljoyn_buslistener_lost_advertised_name_ptr lost_advertised_name; /** * Function pointer called by the bus when the ownership of any well-known name changes. */ alljoyn_buslistener_name_owner_changed_ptr name_owner_changed; /** * Function pointer called when an alljoyn_busattachment this listener is registered with is stopping. */ alljoyn_buslistener_bus_stopping_ptr bus_stopping; /** * Function pointer called when an alljoyn_busattachment this listener is registered with has become disconnected from * the bus. */ alljoyn_buslistener_bus_disconnected_ptr bus_disconnected; /** * Function pointer called by the bus when the value of a property changes if that property has annotation */ alljoyn_buslistener_bus_prop_changed_ptr property_changed; } alljoyn_buslistener_callbacks; /** * Create an alljoyn_buslistener which will trigger the provided callbacks, passing along the provided context. * * @param callbacks Callbacks to trigger for associated events. * @param context Context to pass to callback functions * * @return Handle to newly allocated alljoyn_buslistener. */ extern AJ_API alljoyn_buslistener AJ_CALL alljoyn_buslistener_create(const alljoyn_buslistener_callbacks* callbacks, const void* context); /** * Destroy an alljoyn_buslistener. * * @param listener alljoyn_buslistener to destroy. */ extern AJ_API void AJ_CALL alljoyn_buslistener_destroy(alljoyn_buslistener listener); #ifdef __cplusplus } /* extern "C" */ #endif #endif alljoyn-15.04b/alljoyn_c/inc/alljoyn_c/BusObject.h000066400000000000000000000510611255700255500220740ustar00rootroot00000000000000/** * @file * * This file defines the base class for message bus objects that * are implemented and registered locally. * */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_C_LOCALBUSOBJECT_H #define _ALLJOYN_C_LOCALBUSOBJECT_H #include #include #include #include #include #include #ifdef __cplusplus extern "C" { #endif /* #ifdef __cplusplus */ #ifndef _ALLJOYN_OPAQUE_BUSOBJECT_ #define _ALLJOYN_OPAQUE_BUSOBJECT_ /** * alljoyn_busobjects are objects that are implemented and registered locally. * An alljoyn_busobject can contain multiple interfaces that can be called remotely. */ typedef struct _alljoyn_busobject_handle* alljoyn_busobject; #endif /** * Callback for property get method. * * Handle a bus request to read a property from this object. * alljoyn_busobjects that implement properties should provide an implementation * of this function. * The default version simply returns ER_BUS_NO_SUCH_PROPERTY. * * @param context context pointer passed in when creating a new alljoyn_busobject * @param ifcName Identifies the interface that the property is defined on * @param propName Identifies the property to get * @param[out] val Returns the property value. The type of this value is the actual value * type. * @return #ER_BUS_NO_SUCH_PROPERTY (Should be changed to #ER_OK by user implementation of alljoyn_busobject_prop_get_ptr * if the request results in successfully reading a property from the object.) */ typedef QStatus (AJ_CALL * alljoyn_busobject_prop_get_ptr)(const void* context, const char* ifcName, const char* propName, alljoyn_msgarg val); /** * Callback for property set method. * * Handle a bus attempt to write a property value to this object. * alljoyn_busobjects that implement properties should provide an implementation * of this function. * This default version just replies with ER_BUS_NO_SUCH_PROPERTY * * @param context context pointer passed in when creating a new alljoyn_busobject * @param ifcName Identifies the interface that the property is defined on * @param propName Identifies the property to set * @param val The property value to set. The type of this value is the actual value * type. * @return #ER_BUS_NO_SUCH_PROPERTY (Should be changed to #ER_OK by user implementation of alljoyn_busobject_prop_set_ptr * is the set request results in successfully changing the property.) */ typedef QStatus (AJ_CALL * alljoyn_busobject_prop_set_ptr)(const void* context, const char* ifcName, const char* propName, alljoyn_msgarg val); /** * Callback for ObjectRegistered and ObjectUnregistered * * ObjectRegistered is called by the bus when the alljoyn_busobject has been successfully registered * ObjectUnregistered is called by the bus when the alljoyn_busobject has been successfully unregistered * * @param context context pointer passed in when creating a new alljoyn_busobject */ typedef void (AJ_CALL * alljoyn_busobject_object_registration_ptr)(const void* context); /** * a structure containing a collection of function pointers. * These functions are call by AllJoyn in response to certain events and requests */ typedef struct { /** * Handle a bus request to read a property from the alljoyn_busobject */ alljoyn_busobject_prop_get_ptr property_get; /** * Handle a bus request to write a property value to the alljoyn_busobject */ alljoyn_busobject_prop_set_ptr property_set; /** * Called by the message bus when the object has been successfully registered. * * The object can perform any initialization such as adding match rules at this time */ alljoyn_busobject_object_registration_ptr object_registered; /** * Called by the message bus when the object has been successfully unregistered. */ alljoyn_busobject_object_registration_ptr object_unregistered; } alljoyn_busobject_callbacks; /** * Type used to add mulitple methods at one time. * @see AddMethodHandlers() */ typedef struct { const alljoyn_interfacedescription_member* member; /**< Pointer to method's member */ alljoyn_messagereceiver_methodhandler_ptr method_handler; /**< Method implementation */ } alljoyn_busobject_methodentry; /** * Create an %alljoyn_busobject. * * @param path Object path for object. * @param isPlaceholder Place-holder objects are created by the bus itself and serve only * as parent objects (in the object path sense) to other objects. * @param callbacks_in an alljoyn_busobject_callbacks struct containing pointer to * callback functions NULL if no callbacks busoject callback functions * are needed. * @param context_in a context pointer that can be used in the callback functions * * @return allocated alljoyn_busobject */ extern AJ_API alljoyn_busobject AJ_CALL alljoyn_busobject_create(const char* path, QCC_BOOL isPlaceholder, const alljoyn_busobject_callbacks* callbacks_in, const void* context_in); /** * Destroy an alljoyn_busobject * * @param bus Bus to destroy. */ extern AJ_API void AJ_CALL alljoyn_busobject_destroy(alljoyn_busobject bus); /** * Return the path for the object * * @param bus alljoyn_busobject on which to get the path. * @return Object path */ extern AJ_API const char* AJ_CALL alljoyn_busobject_getpath(alljoyn_busobject bus); /** * Emit PropertiesChanged to signal the bus that this property has been updated * * @param bus alljoyn_busobject with which to emit the signal * @param ifcName The name of the interface * @param propName The name of the property being changed * @param val The new value of the property * @param id ID of the session we broadcast the signal to (0 for all) */ extern AJ_API void AJ_CALL alljoyn_busobject_emitpropertychanged(alljoyn_busobject bus, const char* ifcName, const char* propName, alljoyn_msgarg val, alljoyn_sessionid id); /** * Emit PropertiesChanged to signal the bus that this list of properties have been updated * * @param bus alljoyn_busobject with which to emit the signal * @param ifcName The name of the interface * @param propNames The array of properties being changed * @param numProps The size of the propNames array * @param id ID of the session we broadcast the signal to (0 for all) */ extern AJ_API void AJ_CALL alljoyn_busobject_emitpropertieschanged(alljoyn_busobject bus, const char* ifcName, const char** propNames, size_t numProps, alljoyn_sessionid id); /** * Get the name of this object. * The name is the last component of the path. * * If the buffer is NULL or the bufferSz is 0, the length of the name + nul will be returned. * * @param bus alljoyn_busobject on which to get the name. * @param buffer A buffer into which to copy the name. * @param bufferSz The size of the buffer provided. * @return The size of the name string, if the returned value is > bufferSz, the entire name was not copied into buffer. */ extern AJ_API size_t AJ_CALL alljoyn_busobject_getname(alljoyn_busobject bus, char* buffer, size_t bufferSz); /** * Add an unnanounced interface to this object. If the interface has properties this will also add the * standard property access interface. An interface must be added before its method handlers can be * added. Note that the Peer interface (org.freedesktop.DBus.peer) is implicit on all objects and * cannot be explicitly added, and the Properties interface (org.freedesktop,DBus.Properties) is * automatically added when needed and cannot be explicitly added. * * Once an object is registered, it should not add any additional interfaces. Doing so would * confuse remote objects that may have already introspected this object. * * @param bus The bus on which to add the interface * @param iface The interface to add * * @return * - #ER_OK if the interface was successfully added. * - #ER_BUS_IFACE_ALREADY_EXISTS if the interface already exists. * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_busobject_addinterface(alljoyn_busobject bus, const alljoyn_interfacedescription iface); /** * Add a method handler to this object. The interface for the method handler must have already * been added by calling AddInterface(). * * @param bus The alljoyn_busobject onto which the method handler will be added. * @param member Interface member implemented by handler. * @param handler Method handler. * @param context An optional context. This is mainly intended for implementing language * bindings and should normally be NULL. * * @return * - #ER_OK if the method handler was added. * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_busobject_addmethodhandler(alljoyn_busobject bus, const alljoyn_interfacedescription_member member, alljoyn_messagereceiver_methodhandler_ptr handler, void* context); /** * Add a set of method handers at once. * * @param bus The bus on which to add method handlers. * @param entries Array of alljoyn_busobject_methodentry. * @param numEntries Number of entries in array. * * @return * - #ER_OK if all the methods were added * - #ER_BUS_NO_SUCH_INTERFACE is method can not be added because interface does not exist. */ extern AJ_API QStatus AJ_CALL alljoyn_busobject_addmethodhandlers(alljoyn_busobject bus, const alljoyn_busobject_methodentry* entries, size_t numEntries); /** * Reply to a method call * * @param bus The bus on which to reply. * @param msg The method call message * @param args The reply arguments (can be NULL) * @param numArgs The number of arguments * @return * - #ER_OK if successful * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_busobject_methodreply_args(alljoyn_busobject bus, alljoyn_message msg, const alljoyn_msgarg args, size_t numArgs); /** * Reply to a method call with an error message * * @param bus The bus on which to reply. * @param msg The method call message * @param error The name of the error * @param errorMessage An error message string * @return * - #ER_OK if successful * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_busobject_methodreply_err(alljoyn_busobject bus, alljoyn_message msg, const char* error, const char* errorMessage); /** * Reply to a method call with an error message * * @param bus The bus on which to reply. * @param msg The method call message * @param status The status code for the error * @return * - #ER_OK if successful * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_busobject_methodreply_status(alljoyn_busobject bus, alljoyn_message msg, QStatus status); /** * Get a reference to the underlying alljoyn_busattachment * * There is no need to call alljoyn_busattachment_create or * alljoyn_busattachment_destory for the return value. * This is handled in the code that registered the alljoyn_busobject with * the alljoyn_busattachment. * * @see alljoyn_busattachment_registerbusobject * * @param bus The alljoyn_busobject to obtain the alljoyn_busattachment from * * @return a reference to the alljoyn_busattachment */ extern AJ_API const alljoyn_busattachment AJ_CALL alljoyn_busobject_getbusattachment(alljoyn_busobject bus); /** * Send a signal. * * @param bus The bus used to send the signal * @param destination The unique or well-known bus name or the signal recipient (NULL for broadcast signals) * @param sessionId A unique SessionId for this AllJoyn session instance. Use ALLJOYN_SESSION_ID_ALL_HOSTED * to emit the signal on all sessions hosted by this bus object's bus attachment. * Use 0 for broadcast and sessionless signals. * @param signal Interface member of signal being emitted. * @param args The arguments for the signal (can be NULL) * @param numArgs The number of arguments * @param timeToLive If non-zero this specifies the useful lifetime for this signal. * For sessionless signals the units are seconds. * For all other signals the units are milliseconds. * If delivery of the signal is delayed beyond the timeToLive due to * network congestion or other factors the signal may be discarded. There is * no guarantee that expired signals will not still be delivered. * @param flags Logical OR of the message flags for this signals. The following flags apply to signals: * - If #ALLJOYN_MESSAGE_FLAG_GLOBAL_BROADCAST is set broadcast signal (null destination) will be forwarded across bus-to-bus connections. * - If #ALLJOYN_MESSAGE_FLAG_ENCRYPTED is set the message is authenticated and the payload if any is encrypted. * - IF #ALLJOYN_MESSAGE_FLAG_SESSIONLESS is set the message will be sent using the sessionless signal mechanism. * @param[out] msg If non-null, the sent signal message is returned to the caller. * @return * - #ER_OK if successful * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_busobject_signal(alljoyn_busobject bus, const char* destination, alljoyn_sessionid sessionId, const alljoyn_interfacedescription_member signal, const alljoyn_msgarg args, size_t numArgs, uint16_t timeToLive, uint8_t flags, alljoyn_message msg); /** * Remove sessionless message sent from this object from local router's * store/forward cache. * * @param bus The bus used to send cancel the sessionless message * @param serialNumber Serial number of previously sent sessionless signal. * @return ER_OK if successful. */ extern AJ_API QStatus AJ_CALL alljoyn_busobject_cancelsessionlessmessage_serial(alljoyn_busobject bus, uint32_t serialNumber); /** * Remove sessionless message sent from this object from local router's * store/forward cache. * * @param bus The bus used to send cancel the sessionless message * @param msg Message to be removed. * @return ER_OK if successful. */ extern AJ_API QStatus AJ_CALL alljoyn_busobject_cancelsessionlessmessage(alljoyn_busobject bus, const alljoyn_message msg); /** * Indicates if this object is secure. * * @param bus The busobject we want to check for security * * @return Return QCC_TRUE if authentication is required to emit signals or * call methods on this object. */ extern AJ_API QCC_BOOL AJ_CALL alljoyn_busobject_issecure(alljoyn_busobject bus); /** * Get a list of the interfaces that are added to this alljoyn_busobject that will be announced. * * This function is experimental, and as such has not been fully tested. * Please help make it more robust by contributing fixes if you find problems. * * @param[in] bus The bus which contains the interfaces * @param[in] interfaces the array of interface names * @param[in] numInterfaces the number of interface names * * @return * The total number of interfaces found that are announced. If this number * is larger than `numInterfaces` then only `numInterfaces` will be returned. * */ extern AJ_API size_t AJ_CALL alljoyn_busobject_getannouncedinterfacenames(alljoyn_busobject bus, const char** interfaces, size_t numInterfaces); /** * Change the announce flag for an already added interface. Changes in the * announce flag are not visible to other devices till Announce is called. * * This function is experimental, and as such has not been fully tested. * Please help make it more robust by contributing fixes if you find problems. * * @see alljoyn_aboutobj_announce() * * @param[in] bus The bus which contains the interface * @param[in] iface alljoyn_interfacedescription for the interface to set * the announce flag for * @param[in] isAnnounced This interface should be part of the Announce signal * UNANNOUNCED - this interface will not be part of the Announce signal * ANNOUNCED - this interface will be part of the Announce signal * @return * - #ER_OK if successful * - #ER_BUS_OBJECT_NO_SUCH_INTERFACE if the interface is not part of the bus object. */ extern AJ_API QStatus AJ_CALL alljoyn_busobject_setannounceflag(alljoyn_busobject bus, const alljoyn_interfacedescription iface, alljoyn_about_announceflag isAnnounced); /** * Add an announced interface to this object. If the interface has properties this will also add the * standard property access interface. An interface must be added before its method handlers can be * added. Note that the Peer interface (org.freedesktop.DBus.peer) is implicit on all objects and * cannot be explicitly added, and the Properties interface (org.freedesktop,DBus.Properties) is * automatically added when needed and cannot be explicitly added. * * Once an object is registered, it should not add any additional interfaces. Doing so would * confuse remote objects that may have already introspected this object. * * This function is experimental, and as such has not been fully tested. * Please help make it more robust by contributing fixes if you find problems. * * @param bus The bus on which to add the interface * @param iface The interface to add * * @return * - #ER_OK if the interface was successfully added. * - #ER_BUS_IFACE_ALREADY_EXISTS if the interface already exists. * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_busobject_addinterface_announced(alljoyn_busobject bus, const alljoyn_interfacedescription iface); #ifdef __cplusplus } /* extern "C" */ #endif #endif alljoyn-15.04b/alljoyn_c/inc/alljoyn_c/Init.h000066400000000000000000000072771255700255500211310ustar00rootroot00000000000000/** * @file * Functions required to startup and cleanup AllJoyn. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_C_INIT_H #define _ALLJOYN_C_INIT_H #include #include #ifdef __cplusplus extern "C" { #endif /** * This must be called prior to instantiating or using any AllJoyn * functionality. * * alljoyn_shutdown must be called for each invocation of alljoyn_init. * * @return * - #ER_OK on success * - error code indicating failure otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_init(void); /** * Call this to release any resources acquired in alljoyn_init(). No AllJoyn * functionality may be used after calling this. * * alljoyn_shutdown must be called for each invocation of alljoyn_init. * alljoyn_shutdown must not be called without a prior alljoyn_init call. * * @return * - #ER_OK on success * - error code indicating failure otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_shutdown(void); #ifdef DOXYGEN_DOC /** * This must be called before using any AllJoyn router functionality. * * For an application that is a routing node (either standalone or bundled), the * complete initialization sequence is: * @code * alljoyn_init(); * alljoyn_routerinit(); * @endcode * * alljoyn_routershutdown must be called for each invocation of alljoyn_routerinit. * * @return * - #ER_OK on success * - error code indicating failure otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_routerinit(void); /** * Call this to release any resources acquired in alljoyn_routerinit(). * * For an application that is a routing node (either standalone or bundled), the * complete shutdown sequence is: * @code * alljoyn_routershutdown(); * alljoyn_shutdown(); * @endcode * * alljoyn_routershutdown must be called for each invocation of alljoyn_routerinit. * alljoyn_routershutdown must not be called without a prior alljoyn_routerinit call. * * @return * - #ER_OK on success * - error code indicating failure otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_routershutdown(void); #else /* * For usage, see the docs above for alljoyn_routerinit() and * alljoyn_routershutdown(). * * The macro magic here is to allow compilation with or without router support. * * When router support is not compiled in, alljoyn_routerinit is not used and * there is no undefined reference to AllJoynRouterInit. When router support is * compiled in, alljoyn_routerinit is used and the reference to * AllJoynRouterInit is contained in the router library. */ extern AJ_API QStatus AJ_CALL AllJoynRouterInit(void); #define alljoyn_routerinit AllJoynRouterInit extern AJ_API QStatus AJ_CALL AllJoynRouterShutdown(void); #define alljoyn_routershutdown AllJoynRouterShutdown #endif #ifdef __cplusplus } /* extern "C" */ #endif #endif alljoyn-15.04b/alljoyn_c/inc/alljoyn_c/InterfaceDescription.h000066400000000000000000000730461255700255500243270ustar00rootroot00000000000000/** * @file * This file defines types for statically describing a message bus interface */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_C_INTERFACEDESCRIPTION_H #define _ALLJOYN_C_INTERFACEDESCRIPTION_H #include #include #include #ifdef __cplusplus extern "C" { #endif /** * * alljoyn_interfacedescription is an object for describing message bus interfaces. * alljoyn_interfacedescription objects describe the methods, * signals and properties of an alljoyn_busobject or an alljoyn_proxybusobject. * * Calling #alljoyn_proxybusobject_addinterface() adds the AllJoyn interface described by an * alljoyn_interfacedescription to a ProxyBusObject instance. After an * %alljoyn_interfacedescription has been added, the methods described in the interface * can be called. Similarly calling #alljoyn_busobject_addinterface adds the interface * and its methods, properties, and signal to an #alljoyn_busobject. After an interface * has been added method handlers for the methods described in the interface can be * added by calling #alljoyn_busobject_addmethodhandler or #alljoyn_busobject_addmethodhandlers. * * An alljoyn_interfacedescription can be constructed piecemeal by calling * #alljoyn_interfacedescription_addmethod, #alljoyn_interfacedescription_addmember(), * #alljoyn_interfacedescription_addsignal and #alljoyn_interfacedescription_addproperty(). * Alternatively, calling #alljoyn_proxybusobject_parsexml() will create the * alljoyn_interfacedescription instances for that proxy object directly from an XML * string. Calling #alljoyn_proxybusobject_introspectremoteobject or * #alljoyn_proxybusobject_introspectremoteobjectasync also creates the * alljoyn_interfacedescription instances from XML but in this case the XML is obtained * by making a remote Introspect method call on a bus object. */ typedef struct _alljoyn_interfacedescription_handle* alljoyn_interfacedescription; /** @name Access type */ // @{ static const uint8_t ALLJOYN_PROP_ACCESS_READ = 1; /**< Read Access type */ static const uint8_t ALLJOYN_PROP_ACCESS_WRITE = 2; /**< Write Access type */ static const uint8_t ALLJOYN_PROP_ACCESS_RW = 3; /**< Read-Write Access type */ // @} /** @name Anotation flags */ // @{ static const uint8_t ALLJOYN_MEMBER_ANNOTATE_NO_REPLY = 1; /**< No reply annotate flag */ static const uint8_t ALLJOYN_MEMBER_ANNOTATE_DEPRECATED = 2; /**< Deprecated annotate flag */ // @} /** * The interface security policy can be inherit, required, or off. If security is * required on an interface, methods on that interface can only be called by an authenticated peer * and signals emitted from that interfaces can only be received by an authenticated peer. If * security is not specified for an interface the interface inherits the security of the objects * that implement it. If security is not applicable (off) to an interface, authentication is never * required even when implemented by a secure object. For example, security does not apply to * the Introspection interface otherwise secure objects would not be introspectable. */ typedef enum { AJ_IFC_SECURITY_INHERIT, /**< Inherit the security of the object that implements the interface */ AJ_IFC_SECURITY_REQUIRED, /**< Security is required for an interface */ AJ_IFC_SECURITY_OFF /**< Security does not apply to this interface */ } alljoyn_interfacedescription_securitypolicy; /** * Structure representing the member to be added to the Interface */ typedef struct { alljoyn_interfacedescription iface; /**< Interface that this member belongs to */ alljoyn_messagetype memberType; /**< %Member type */ const char* name; /**< %Member name */ const char* signature; /**< Method call IN arguments (NULL for signals) */ const char* returnSignature; /**< Signal or method call OUT arguments */ const char* argNames; /**< Comma separated list of argument names - can be NULL */ const void* internal_member; /**< For internal use only */ } alljoyn_interfacedescription_member; /** * find out the amount of annotations the alljoyn_interfacedescription_member has * * The number of the annotation is only valid as long as no annotations have * been removed or added to the interface. For this reason this function should * only be used after calling alljoyn_interfacedescription_activate. * * @param[in] member The alljoyn interfacedescription member that we want the * annotations count from * @return the number of annotations */ extern AJ_API size_t AJ_CALL alljoyn_interfacedescription_member_getannotationscount(alljoyn_interfacedescription_member member); /** * Obtain the name and value for the annotation index. * The order of the annotation is only valid as long as no new annotations are * removed or added to the interface. For this reason this function should * only be used after calling alljoyn_interfacedescription_activate. * * @param[in] member the alljoyn interfacedescription member that we want to read annotations from * @param[in] index the index of the annotation of interest * @param[out] name the name of the annotation * @param[in,out] name_size the size of the name string if name==NULL this will return the size of the name string plus nul character * @param[out] value the value of the annotation * @param[in,out] value_size the size of the value string if value == NULL this will return the size of the value string plus nul character */ extern AJ_API void AJ_CALL alljoyn_interfacedescription_member_getannotationatindex(alljoyn_interfacedescription_member member, size_t index, char* name, size_t* name_size, char* value, size_t* value_size); /** * Get this member's annotation value return the size of the value string if * name is NULL. * * @param[in] member The AllJoyn alljoyn_interfacedescription member that we want the annotation from * @param[in] name Name of the annotation to look for * @param[out] value Value to compare with * @param[in,out] value_size size of the value string if value == NULL it will return the size of the value string plus nul character * @return true iff annotations[name] == value */ extern AJ_API QCC_BOOL AJ_CALL alljoyn_interfacedescription_member_getannotation(alljoyn_interfacedescription_member member, const char* name, char* value, size_t* value_size); /** * Structure representing properties of the Interface */ typedef struct { const char* name; /**< %Property name */ const char* signature; /**< %Property type */ uint8_t access; /**< Access is #ALLJOYN_PROP_ACCESS_READ, #ALLJOYN_PROP_ACCESS_WRITE, or #ALLJOYN_PROP_ACCESS_RW */ const void* internal_property; /**< For internal use only */ } alljoyn_interfacedescription_property; /** * find out the amount of annotations the alljoyn_interfacedescription_member has * * The number of the annotation is only valid as long as no annotations have * been removed or added to the interface. For this reason this function should * only be used after calling alljoyn_interfacedescription_activate. * * @param[in] property The alljoyn interfacedescription property that we want the * annotations count from * @return the number of annotations */ extern AJ_API size_t AJ_CALL alljoyn_interfacedescription_property_getannotationscount(alljoyn_interfacedescription_property property); /** * Obtain the name and value for the annotation index. * The order of the annotation is only valid as long as no new annotations are * removed or added to the interface. For this reason this function should * only be used after calling alljoyn_interfacedescription_activate. * * @param[in] property the alljoyn interfacedescription property that we want to read annotations from * @param[in] index the index of the annotation of interest * @param[out] name the name of the annotation * @param[in,out] name_size the size of the name string if name==NULL this will return the size of the name string plus nul character * @param[out] value the value of the annotation * @param[in,out] value_size the size of the value string if value == NULL this will return the size of the value string plus nul character */ extern AJ_API void AJ_CALL alljoyn_interfacedescription_property_getannotationatindex(alljoyn_interfacedescription_property property, size_t index, char* name, size_t* name_size, char* value, size_t* value_size); /** * Get this member's annotation value return the size of the value string if * name is NULL. * * @param[in] property The AllJoyn alljoyn_interfacedescription property that we want the annotation from. * @param[in] name Name of the annotation to look for * @param[out] value Value to compare with * @param[in,out] value_size size of the value string if value == NULL it will return the size of the value string plus nul character * @return true iff annotations[name] == value */ extern AJ_API QCC_BOOL AJ_CALL alljoyn_interfacedescription_property_getannotation(alljoyn_interfacedescription_property property, const char* name, char* value, size_t* value_size); /** * Activate this interface. An interface must be activated before it can be used. Activating an * interface locks the interface so that is can no longer be modified. * * @param iface alljoyn_interfacedescription to activate. */ extern AJ_API void AJ_CALL alljoyn_interfacedescription_activate(alljoyn_interfacedescription iface); /** * Add an annotation to the interface. * * @param iface Interface onto which the annotation will be added * @param name Name of annotation. * @param value Value of the annotation * @return * - #ER_OK if successful. * - #ER_BUS_PROPERTY_ALREADY_EXISTS if the property can not be added * because it already exists. */ extern AJ_API QStatus AJ_CALL alljoyn_interfacedescription_addannotation(alljoyn_interfacedescription iface, const char* name, const char* value); /** * Lookup an interface annotation * * @param iface Interface on which to lookup the member * @param name Name of the annotation to lookup * @param[out] value The value of the annotation * @param[in,out] value_size return the size of the string if value == NULL plus nul character or * specifies the max size of value if value != NULL. * * @return QC_FALSE if annotation does not exist, QC_TRUE otherwise. */ extern AJ_API QCC_BOOL AJ_CALL alljoyn_interfacedescription_getannotation(alljoyn_interfacedescription iface, const char* name, char* value, size_t* value_size); /** * find out the amount of annotations the alljoyn_interfacedescription has * * The number of the annotation is only valid as long as no annotations have * been removed or added to the interface. For this reason this function should * only be used after calling alljoyn_interfacedescription_activate. * * @param[in] iface The alljoyn_interfacedescription that we want the annotations count from * * @return the number of annotations */ extern AJ_API size_t AJ_CALL alljoyn_interfacedescription_getannotationscount(alljoyn_interfacedescription iface); /** * Obtain the name and value for the annotation index. * The order of the annotation is only valid as long as no new annotations are * removed or added to the interface. For this reason this function should * only be used after calling alljoyn_interfacedescription_activate. * * @param[in] iface the alljoyn interfacedescription that we want to read annotations from * @param[in] index the index of the annotation of interest * @param[out] name the name of the annotation * @param[in,out] name_size the size of the name string if name==NULL this will return the size of the name string plus nul character * @param[out] value the value of the annotation * @param[in,out] value_size the size of the value string if value == NULL this will return the size of the value string plus nul character */ extern AJ_API void AJ_CALL alljoyn_interfacedescription_getannotationatindex(alljoyn_interfacedescription iface, size_t index, char* name, size_t* name_size, char* value, size_t* value_size); /** * Lookup a member description by name * * @param iface Interface on which to lookup the member * @param name Name of the member to lookup * @param[out] member The description of the member * * @return QCC_FALSE if member does not exist, QCC_TRUE otherwise. */ extern AJ_API QCC_BOOL AJ_CALL alljoyn_interfacedescription_getmember(const alljoyn_interfacedescription iface, const char* name, alljoyn_interfacedescription_member* member); /** * Add a member to the interface. * * @param iface Interface on which to add the member. * @param type Message type. * @param name Name of member. * @param inputSig Signature of input parameters or NULL for none. * @param outSig Signature of output parameters or NULL for none. * @param argNames Comma separated list of input and then output arg names used in annotation XML. * @param annotation Annotation flags. * * @return * - #ER_OK if successful * - #ER_BUS_MEMBER_ALREADY_EXISTS if member already exists */ extern AJ_API QStatus AJ_CALL alljoyn_interfacedescription_addmember(alljoyn_interfacedescription iface, alljoyn_messagetype type, const char* name, const char* inputSig, const char* outSig, const char* argNames, uint8_t annotation); /** * Add an annotation to a member * * @param iface Interface on which to add the member. * @param member Name of member. * @param name Name of annotation * @param value Value for the annotation * * @return * - #ER_OK if successful * - #ER_BUS_MEMBER_ALREADY_EXISTS if member already exists */ extern AJ_API QStatus AJ_CALL alljoyn_interfacedescription_addmemberannotation(alljoyn_interfacedescription iface, const char* member, const char* name, const char* value); /** * Add an annotation to a member * * @param iface Interface on which to add the member. * @param member Name of member. * @param name Name of annotation * @param[out] value Value for the annotation * @param[in,out] value_size The size value. If value == NULL returns the size * of the string plus nul character so a new char* can be allocated. * If value != NULL specifies the size of value. * * @return QC_FALSE if annotation does not exist, QC_TRUE otherwise. */ AJ_API QCC_BOOL AJ_CALL alljoyn_interfacedescription_getmemberannotation(alljoyn_interfacedescription iface, const char* member, const char* name, char* value, size_t* value_size); /** * Get all the members. * * @param iface The interface from which to get all members. * @param members A pointer to a Member array to receive the members. Can be NULL in * which case no members are returned and the return value gives the number * of members available. * @param numMembers The size of the Member array. If this value is smaller than the total * number of members only numMembers will be returned. * * @return The number of members returned or the total number of members if members is NULL. */ extern AJ_API size_t AJ_CALL alljoyn_interfacedescription_getmembers(const alljoyn_interfacedescription iface, alljoyn_interfacedescription_member* members, size_t numMembers); /** * Check for existence of a member. Optionally check the signature also. * @remark * if the a signature is not provided this method will only check to see if * a member with the given @c name exists. If a signature is provided a * member with the given @c name and @c signature must exist for this to return true. * * @param iface Interface to query for a member. * @param name Name of the member to lookup * @param inSig Input parameter signature of the member to lookup * @param outSig Output parameter signature of the member to lookup (leave NULL for signals) * @return QCC_TRUE if the member name exists. */ extern AJ_API QCC_BOOL AJ_CALL alljoyn_interfacedescription_hasmember(alljoyn_interfacedescription iface, const char* name, const char* inSig, const char* outSig); /** * Add a method call member to the interface. * * @param iface Interface on which to add the method member. * @param name Name of method call member. * @param inputSig Signature of input parameters or NULL for none. * @param outSig Signature of output parameters or NULL for none. * @param argNames Comma separated list of input and then output arg names used in annotation XML. * @param annotation Annotation flags. Default value 0. * @param accessPerms Access permission requirements on this call. Default value 0. * * @return * - #ER_OK if successful * - #ER_BUS_MEMBER_ALREADY_EXISTS if member already exists */ extern AJ_API QStatus AJ_CALL alljoyn_interfacedescription_addmethod(alljoyn_interfacedescription iface, const char* name, const char* inputSig, const char* outSig, const char* argNames, uint8_t annotation, const char* accessPerms); /** * Lookup a member method description by name * * @param iface Interface on which to lookup the method. * @param name Name of the method to lookup * @param[out] member The description of the member * @return * - Pointer to member. * - NULL if does not exist. */ extern AJ_API QCC_BOOL AJ_CALL alljoyn_interfacedescription_getmethod(alljoyn_interfacedescription iface, const char* name, alljoyn_interfacedescription_member* member); /** * Add a signal member to the interface. * * @param iface Interface on which to add the signal member. * @param name Name of method call member. * @param sig Signature of parameters or NULL for none. * @param argNames Comma separated list of arg names used in annotation XML. * @param annotation Annotation flags. Default value 0. * @param accessPerms Access permission requirements on this call. Default value 0. * * @return * - #ER_OK if successful * - #ER_BUS_MEMBER_ALREADY_EXISTS if member already exists */ extern AJ_API QStatus AJ_CALL alljoyn_interfacedescription_addsignal(alljoyn_interfacedescription iface, const char* name, const char* sig, const char* argNames, uint8_t annotation, const char* accessPerms); /** * Lookup a member signal description by name * * @param iface Interface to query for signal * @param name Name of the signal to lookup * @param[out] member return a pointer to the signal member or NULL if the * signal does not exist. * * @return QCC_TRUE is the signal was found QCC_FALSE otherwise */ extern AJ_API QCC_BOOL AJ_CALL alljoyn_interfacedescription_getsignal(alljoyn_interfacedescription iface, const char* name, alljoyn_interfacedescription_member* member); /** * Lookup a property description by name * * @param iface Interface to query for a property. * @param name Name of the property to lookup * @param property The description of the property * @return QCC_TRUE if the property was found, QCC_FALSE otherwise */ extern AJ_API QCC_BOOL AJ_CALL alljoyn_interfacedescription_getproperty(const alljoyn_interfacedescription iface, const char* name, alljoyn_interfacedescription_property* property); /** * Get all the properties. * * @param iface Interface to query for properties. * @param props A pointer to a Property array to receive the properties. Can be NULL in * which case no properties are returned and the return value gives the number * of properties available. * @param numProps The size of the Property array. If this value is smaller than the total * number of properties only numProperties will be returned. * * * @return The number of properties returned or the total number of properties if props is NULL. */ extern AJ_API size_t AJ_CALL alljoyn_interfacedescription_getproperties(const alljoyn_interfacedescription iface, alljoyn_interfacedescription_property* props, size_t numProps); /** * Add a property to the interface. * * @param iface Interface on which to add the property. * @param name Name of property. * @param signature Property type. * @param access #ALLJOYN_PROP_ACCESS_READ, #ALLJOYN_PROP_ACCESS_WRITE or #ALLJOYN_PROP_ACCESS_RW * @return * - #ER_OK if successful. * - #ER_BUS_PROPERTY_ALREADY_EXISTS if the property can not be added * because it already exists. */ extern AJ_API QStatus AJ_CALL alljoyn_interfacedescription_addproperty(alljoyn_interfacedescription iface, const char* name, const char* signature, uint8_t access); /** * Add an annotation to an existing property * @param iface Interface on which to add the property. * @param property Name of property. * @param name Name of annotation * @param value value of annotation * * @return * - #ER_OK if successful. * - #ER_BUS_PROPERTY_ALREADY_EXISTS if the annotation can not be added to the property because it already exists. */ extern AJ_API QStatus AJ_CALL alljoyn_interfacedescription_addpropertyannotation(alljoyn_interfacedescription iface, const char* property, const char* name, const char* value); /** * Get the annotation value for a property * @param iface Interface on which to add the property. * @param property Name of the property * @param name Name of annotation * @param[out] value Value for the annotation use NULL to obtain the size of the string in value * @param[in,out] str_size the size of the char* value if value == NULL return the size of the value string plus nul character * * @code * size_t str_size; * alljoyn_interfacedescription_getpropertyannotation(iface, "myProperty", "org.freedesktop.DBus.Property.EmitsChangedSignal", NULL, &str_size); * char* value = (char*)malloc(sizeof(char) * str_size); * QCC_BOOL success = alljoyn_interfacedescription_getpropertyannotation(iface, "myProperty", "org.freedesktop.DBus.Property.EmitsChangedSignal", value, &str_size); * if (success == QCC_TRUE) { * \/\/ code that does something with the value * } * free(value); * @endcode * * @return QCC_TRUE if found, QCC_FALSE if not found */ extern AJ_API QCC_BOOL AJ_CALL alljoyn_interfacedescription_getpropertyannotation(alljoyn_interfacedescription iface, const char* property, const char* name, char* value, size_t* str_size); /** * Check for existence of a property. * * @param iface Interface to query. * @param name Name of the property to lookup * @return true if the property exists. */ extern AJ_API QCC_BOOL AJ_CALL alljoyn_interfacedescription_hasproperty(const alljoyn_interfacedescription iface, const char* name); /** * Check for existence of any properties * * @param iface Interface to query. * @return true if interface has any properties. */ extern AJ_API QCC_BOOL AJ_CALL alljoyn_interfacedescription_hasproperties(const alljoyn_interfacedescription iface); /** * Returns the name of the interface * * @param iface Interface to query. * @return the interface name. */ extern AJ_API const char* AJ_CALL alljoyn_interfacedescription_getname(const alljoyn_interfacedescription iface); /** * Returns a description of the interface in introspection XML format * @return The interface description in introspection XML format. * * @param iface Interface to query * @param[out] str The character string that will hold the XML string * representation of the interface * @param[in] buf The size of the char* array that will hold the string * @param indent Number of space chars to use in XML indentation. * @return The number of characters (including the terminating null byte) which * would have been written to the final string if enough space is * available. Thus returning a value larger than buf means the output * was truncated. */ extern AJ_API size_t AJ_CALL alljoyn_interfacedescription_introspect(const alljoyn_interfacedescription iface, char* str, size_t buf, size_t indent); /** * Indicates if this interface is secure. Secure interfaces require end-to-end authentication. * The arguments for methods calls made to secure interfaces and signals emitted by secure * interfaces are encrypted. * @param iface Interface to query. * @return true if the interface is secure. */ extern AJ_API QCC_BOOL AJ_CALL alljoyn_interfacedescription_issecure(const alljoyn_interfacedescription iface); /** * Get the security policy that applies to this interface. * * @param iface Interface to query. for its security policy * * @return Returns the security policy for this interface. */ extern AJ_API alljoyn_interfacedescription_securitypolicy AJ_CALL alljoyn_interfacedescription_getsecuritypolicy(const alljoyn_interfacedescription iface); /** * Equality operation. * * @param one Interface to compare to other * @param other Interface to compare to one * * @return QCC_TRUE if one == other */ extern AJ_API QCC_BOOL AJ_CALL alljoyn_interfacedescription_eql(const alljoyn_interfacedescription one, const alljoyn_interfacedescription other); /** * Equality operation. * * @param one alljoyn_interfacedescription_member to compare to other * @param other alljoyn_interfacedescription_member to compare to one * * @return QCC_TRUE if one == other */ extern AJ_API QCC_BOOL AJ_CALL alljoyn_interfacedescription_member_eql(const alljoyn_interfacedescription_member one, const alljoyn_interfacedescription_member other); /** * Equality operation. * * @param one alljoyn_interfacedescription_property to compare to other * @param other alljoyn_interfacedescription_property to compare to one * * @return QCC_TRUE if one == other */ extern AJ_API QCC_BOOL AJ_CALL alljoyn_interfacedescription_property_eql(const alljoyn_interfacedescription_property one, const alljoyn_interfacedescription_property other); #ifdef __cplusplus } /* extern "C" */ #endif #undef QCC_MODULE #endif alljoyn-15.04b/alljoyn_c/inc/alljoyn_c/KeyStoreListener.h000066400000000000000000000156071255700255500234750ustar00rootroot00000000000000/** * @file * The alljoyn_keystorelistener handles requests to load or store the key store. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_C_KEYSTORE_LISTENER_H #define _ALLJOYN_C_KEYSTORE_LISTENER_H #include #include #ifdef __cplusplus extern "C" { #endif /** * The alljoyn_keystore manages storing and loading of key blobs from * external storage. */ typedef struct _alljoyn_keystore_handle* alljoyn_keystore; /** * An application can provide a key store listener to override the default key store * load request and store request behavior. If an alljoyn_keystorelistener is provided it will * override the default key store behavior. */ typedef struct _alljoyn_keystorelistener_handle* alljoyn_keystorelistener; /** * Type for the LoadRequest callback. * * This function is called when a key store needs to be loaded. * @remark The application must call #alljoyn_keystorelistener_putkeys to put the new key store data into the * internal key store. * * @param context The context pointer passed into the alljoyn_keystorelistener_create function * @param listener The listener that is responsible for the LoadRequest callback. * This listener should be used when calling the @c alljoyn_keystorelistener_putkeys * function. * @param keyStore Reference to the alljoyn_keystore to be loaded. * * @return * - #ER_OK if the load request was satisfied * - An error status otherwise * */ typedef QStatus (AJ_CALL * alljoyn_keystorelistener_loadrequest_ptr)(const void* context, alljoyn_keystorelistener listener, alljoyn_keystore keyStore); /** * Type for the StoreRequest callback. * * This function is called when a key store needs to be stored. * @remark The application must call #alljoyn_keystorelistener_getkeys to obtain the key data to be stored. * * @param context The context pointer passed into the alljoyn_keystorelistener_create function * @param listener The listener that responsible for the StoreRequest callback. * This listener should be used when calling the @c alljoyn_keystorelistener_getkeys * function. * @param keyStore Reference to the @c alljoyn_keystore to be stored. * * @return * - #ER_OK if the store request was satisfied * - An error status otherwise */ typedef QStatus (AJ_CALL * alljoyn_keystorelistener_storerequest_ptr)(const void* context, alljoyn_keystorelistener listener, alljoyn_keystore keyStore); /** * Structure used during alljoyn_keystorelistener_create to provide callbacks into C. * An implementation must provide both * alljoyn_keystorelistener_loadrequest_ptr * alljoyn_keystorelistener_storerequest_ptr */ typedef struct { /** * This function is called when a key store needs to be loaded. */ alljoyn_keystorelistener_loadrequest_ptr load_request; /** * This function is called when a key store needs to be stored. */ alljoyn_keystorelistener_storerequest_ptr store_request; } alljoyn_keystorelistener_callbacks; /** * Create an alljoyn_keystorelistener * * @param callbacks Callbacks to trigger for associated events. * @param context Context to pass along to callback functions. * * @return an allocated alljoyn_keystorelistener */ extern AJ_API alljoyn_keystorelistener AJ_CALL alljoyn_keystorelistener_create(const alljoyn_keystorelistener_callbacks* callbacks, const void* context); /** * Destroy an alljoyn_keystorelistener * * @param listener The alljoyn_keystorelistener to destroy. */ extern AJ_API void AJ_CALL alljoyn_keystorelistener_destroy(alljoyn_keystorelistener listener); /** * Put keys into the key store from an encrypted byte string. * * @param listener The alljoyn_keystorelistener into which to put the keys. * @param keyStore The keyStore to put to. This is the keystore indicated in the LoadRequest call. * @param source The byte string containing the encrypted key store contents. * @param password The password required to decrypt the key data * * @return * - #ER_OK if successful * - An error status otherwise * */ extern AJ_API QStatus AJ_CALL alljoyn_keystorelistener_putkeys(alljoyn_keystorelistener listener, alljoyn_keystore keyStore, const char* source, const char* password); /** * Get the current keys from the key store as an encrypted byte string. * * @code * QStatus status; * char* sink; * size_t sink_sz; * alljoyn_keystorelistener_getkeys(listener, keyStore, NULL, &sink_sz); * sink = (char*) malloc(sizeof(char) * sink_sz); * status = alljoyn_keystorelistener_getkeys(listener, keyStore, sink, &sink_sz); * assert(status == ER_OK); * @endcode * * @param listener The alljoyn_keystorelistener from which to get the keys. * @param keyStore The keyStore to get from. This is the keystore indicated in * the StoreRequest call. * @param sink The byte string to write the keys to. If sink is NULL then the * sink_sz parameter will return the size of the sink plus the * terminating nul character. * @param[in,out] sink_sz The size of the byte string provided. This will return * the actual size of the sink plus the terminating nul * character. If the sink_sz out should be larger than or * equal to the sink_sz in. * @return * - #ER_OK if successful * - #ER_BUFFER_TOO_SMALL if the specified sink_sz is is not large enough * to hold the sink * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_keystorelistener_getkeys(alljoyn_keystorelistener listener, alljoyn_keystore keyStore, char* sink, size_t* sink_sz); #ifdef __cplusplus } /* extern "C" */ #endif #endif alljoyn-15.04b/alljoyn_c/inc/alljoyn_c/Message.h000066400000000000000000000372461255700255500216110ustar00rootroot00000000000000/** * @file * This file defines a class for parsing and generating message bus messages */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_C_MESSAGE_H #define _ALLJOYN_C_MESSAGE_H #include #include #include #include #ifdef __cplusplus extern "C" { #endif /** * alljoyn_message for parsing and generating message bus messages */ typedef struct _alljoyn_message_handle* alljoyn_message; /// @cond ALLJOYN_DEV #ifndef _ALLJOYN_OPAQUE_BUSATTACHMENT_ #define _ALLJOYN_OPAQUE_BUSATTACHMENT_ /// @endcond /** * alljoyn_busattachment is the top level object responsible for connecting to and * managing an AllJoyn message bus */ typedef struct _alljoyn_busattachment_handle* alljoyn_busattachment; #endif /** @name Endianness indicators */ // @{ /** indicates the bus is little endian */ static const uint8_t ALLJOYN_LITTLE_ENDIAN = 'l'; /** indicates the bus is big endian */ static const uint8_t ALLJOYN_BIG_ENDIAN = 'B'; // @} /** @name Flag types */ /* @{ */ /** No reply is expected */ #define ALLJOYN_MESSAGE_FLAG_NO_REPLY_EXPECTED 0x01 /** Auto start the service */ #define ALLJOYN_MESSAGE_FLAG_AUTO_START 0x02 /** Allow messages from remote hosts (valid only in Hello message) */ #define ALLJOYN_MESSAGE_FLAG_ALLOW_REMOTE_MSG 0x04 /** Sessionless message */ #define ALLJOYN_MESSAGE_FLAG_SESSIONLESS 0x10 /** Global (bus-to-bus) broadcast */ #define ALLJOYN_MESSAGE_FLAG_GLOBAL_BROADCAST 0x20 /** * Header is compressed * * @deprecated March 2015 for 15.04 release */ #define ALLJOYN_MESSAGE_FLAG_COMPRESSED (attempted_use_of_deprecated_definition = 0x40) /** Body is encrypted */ #define ALLJOYN_MESSAGE_FLAG_ENCRYPTED 0x80 /* @} */ /** * The default timeout for method calls */ static const uint32_t ALLJOYN_MESSAGE_DEFAULT_TIMEOUT = 25000; /** Message types */ typedef enum { ALLJOYN_MESSAGE_INVALID = 0, ///< an invalid message type ALLJOYN_MESSAGE_METHOD_CALL = 1, ///< a method call message type ALLJOYN_MESSAGE_METHOD_RET = 2, ///< a method return message type ALLJOYN_MESSAGE_ERROR = 3, ///< an error message type ALLJOYN_MESSAGE_SIGNAL = 4 ///< a signal message type } alljoyn_messagetype; /** * Create an alljoyn_message object. * * @param bus The alljoyn_busattachment that this alljoyn_message is sent or received on. * * @return the allocated alljoyn_message */ extern AJ_API alljoyn_message AJ_CALL alljoyn_message_create(alljoyn_busattachment bus); /** * Destroy an alljoyn_message object. * * @param msg The alljoyn_message to destroy */ extern AJ_API void AJ_CALL alljoyn_message_destroy(alljoyn_message msg); /** * Determine if message is a broadcast signal. * * @param msg alljoyn_message we wish to determine if it is a broadcast signal. * * @return Return true if this is a broadcast signal. */ extern AJ_API QCC_BOOL AJ_CALL alljoyn_message_isbroadcastsignal(alljoyn_message msg); /** * Messages broadcast to all devices are global broadcast messages. * * @param msg alljoyn_message we wish to determine if it is a global broadcast signal. * * @return Return true if this is a global broadcast message. */ extern AJ_API QCC_BOOL AJ_CALL alljoyn_message_isglobalbroadcast(alljoyn_message msg); /** * Messages sent without sessions are sessionless. * * @param msg alljoyn_message we wish to determine if it is a sessionless signal. * * @return Return true if this is a sessionless message. */ extern AJ_API QCC_BOOL AJ_CALL alljoyn_message_issessionless(alljoyn_message msg); /** * Returns the flags for the message. * * @param msg alljoyn_message we wish to get the flags from. * * @return flags for the message * * @see flag types in Message.h file */ extern AJ_API uint8_t AJ_CALL alljoyn_message_getflags(alljoyn_message msg); /** * Return true if message's TTL header indicates that it is expired * * @param msg alljoyn_message we are checking the TTL header for expiration. * * @param[out] tillExpireMS Written with number of milliseconds before message expires if non-null * If message never expires value is set to the maximum uint32_t value. * * @return Returns true if the message's TTL header indicates that is has expired. */ extern AJ_API QCC_BOOL AJ_CALL alljoyn_message_isexpired(alljoyn_message msg, uint32_t* tillExpireMS); /** * Determine if the message is marked as unreliable. Unreliable messages have a non-zero * time-to-live and may be silently discarded. * * @param msg alljoyn_message being checked to see if it is marked as unrliable * * @return Returns true if the message is unreliable, that is, has a non-zero time-to-live. */ extern AJ_API QCC_BOOL AJ_CALL alljoyn_message_isunreliable(alljoyn_message msg); /** * Determine if the message was encrypted. * * @param msg alljoyn_message being checked to see if it was encrypted * * @return Returns true if the message was encrypted. */ extern AJ_API QCC_BOOL AJ_CALL alljoyn_message_isencrypted(alljoyn_message msg); /** * Get the name of the authentication mechanism that was used to generate the encryption key if * the message is encrypted. * * @param msg alljoyn_message the authentication mechanism is being obtained from * * @return the name of an authentication mechanism or an empty string. */ extern AJ_API const char* AJ_CALL alljoyn_message_getauthmechanism(alljoyn_message msg); /** * Return the type of the message * * @param msg alljoyn_message being read for its alljoyn_messagetype * * @return message type */ extern AJ_API alljoyn_messagetype AJ_CALL alljoyn_message_gettype(alljoyn_message msg); /** * Return the arguments for this message. * * @param[in] msg The alljoyn_message from which to extract the arguments. * @param[out] numArgs The number of arguments * @param[out] args Returns the arguments */ extern AJ_API void AJ_CALL alljoyn_message_getargs(alljoyn_message msg, size_t* numArgs, alljoyn_msgarg* args); /** * Return a specific argument. * * @param msg The alljoyn_message from which to extract an argument. * @param argN The index of the argument to get. * * @return * - The argument * - NULL if unmarshal failed or there is not such argument. */ extern AJ_API const alljoyn_msgarg AJ_CALL alljoyn_message_getarg(alljoyn_message msg, size_t argN); /** * Unpack and return the arguments for this message. This function uses the * functionality from alljoyn_msgarg_get() see MsgArg.h for documentation. * * @param[in] msg The alljoyn_message from which to extract the arguments. * @param[in] signature The signature to match against the message arguments. * @param[out] ... Pointers to return references to the unpacked values. * @return ER_OK if successful. */ extern AJ_API QStatus AJ_CALL alljoyn_message_parseargs(alljoyn_message msg, const char* signature, ...); /** * Accessor function to get serial number for the message. Usually only important for * #ALLJOYN_MESSAGE_METHOD_CALL for matching up the reply to the call. * * @param[in] msg The alljoyn_message from which to extract the serial. * * @return the serial number of the %Message */ extern AJ_API uint32_t AJ_CALL alljoyn_message_getcallserial(alljoyn_message msg); /** * Accessor function to get the signature for this message * * @param[in] msg The alljoyn_message from which to extract the signature. * * @return * - The AllJoyn SIGNATURE string stored in the AllJoyn header field * - An empty string if unable to find the AllJoyn signature */ extern AJ_API const char* AJ_CALL alljoyn_message_getsignature(alljoyn_message msg); /** * Accessor function to get the object path for this message * * @param[in] msg The alljoyn_message from which to extract the object path. * * @return * - The AllJoyn object path string stored in the AllJoyn header field * - An empty string if unable to find the AllJoyn object path */ extern AJ_API const char* AJ_CALL alljoyn_message_getobjectpath(alljoyn_message msg); /** * Accessor function to get the interface for this message * * @param[in] msg The alljoyn_message from which to extract the interface name. * * @return * - The AllJoyn interface string stored in the AllJoyn header field * - An empty string if unable to find the interface */ extern AJ_API const char* AJ_CALL alljoyn_message_getinterface(alljoyn_message msg); /** * Accessor function to get the member (method/signal) name for this message * * @param[in] msg The alljoyn_message from which to extract the member name. * * @return * - The AllJoyn member (method/signal) name string stored in the AllJoyn header field * - An empty string if unable to find the member name */ extern AJ_API const char* AJ_CALL alljoyn_message_getmembername(alljoyn_message msg); /** * Accessor function to get the reply serial number for the message. Only meaningful for #ALLJOYN_MESSAGE_METHOD_RET * * @param[in] msg The alljoyn_message from which to extract the reply serial. * * @return * - The serial number for the message stored in the AllJoyn header field * - Zero if unable to find the serial number. Note that 0 is an invalid serial number. */ extern AJ_API uint32_t AJ_CALL alljoyn_message_getreplyserial(alljoyn_message msg); /** * Accessor function to get the sender for this message. * * @param[in] msg The alljoyn_message from which to extract the sender information. * * @return * - The senders well-known name string stored in the AllJoyn header field. * - An empty string if the message did not specify a sender. */ extern AJ_API const char* AJ_CALL alljoyn_message_getsender(alljoyn_message msg); /** * Get the unique name of the endpoint that the message was received on. * * @param[in] msg The alljoyn_message from which to extract the endpoint information. * * @return * - The unique name of the endpoint that the message was received on. */ extern AJ_API const char* AJ_CALL alljoyn_message_getreceiveendpointname(alljoyn_message msg); /** * Accessor function to get the destination for this message * * @param[in] msg The alljoyn_message from which to extract the destination information. * * @return * - The message destination string stored in the AllJoyn header field. * - An empty string if unable to find the message destination. */ extern AJ_API const char* AJ_CALL alljoyn_message_getdestination(alljoyn_message msg); /** * Accessor function to get the compression token for the message. * * @param[in] msg The alljoyn_message from which to extract the compression token information. * * @return * - 0 'zero' if there is no compression token. * * @deprecated Header compression was deprecated in March 2015 for 15.04 * release */ QCC_DEPRECATED(extern AJ_API uint32_t AJ_CALL alljoyn_message_getcompressiontoken(alljoyn_message msg)); /** * Accessor function to get the session id for the message. * * @param[in] msg The alljoyn_message from which to extract the session id information. * @return * - Session id for the message * - 0 'zero' if sender did not specify a session */ extern AJ_API alljoyn_sessionid AJ_CALL alljoyn_message_getsessionid(alljoyn_message msg); /** * If the message is an error message returns the error name and optionally the error message string * * @param[in] msg The alljoyn_message from which to extract the error name information. * @param[out] errorMessage * - Return the error message string stored * - leave errorMessage unchanged if error message string not found * @param[in,out] errorMessage_size size of the errorMessage string (including the terminating nul byte) * if errorMessage == NULL this will be changed to the * size of the string so a buffer can be allocated to * hold the string. * * @return * - If error detected return error name stored in the AllJoyn header field * - NULL if error not detected */ extern AJ_API const char* AJ_CALL alljoyn_message_geterrorname(alljoyn_message msg, char* errorMessage, size_t* errorMessage_size); /** * Returns an XML string representation of the message * * @param[in] msg The alljoyn_message which to return an XML representation of. * @param[out] str The character string that will hold the XML string * representation of the alljoyn_message * @param[in] buf The size of the char* array that will hold the string * * @return The number of characters (including the terminating nul byte) which * would have been written to the final string if enough space * available. Thus returning a value of buf or larger means the output * was truncated. * */ extern AJ_API size_t AJ_CALL alljoyn_message_tostring(alljoyn_message msg, char* str, size_t buf); /** * Returns a string that provides a brief description of the message * * @param[in] msg The alljoyn_message which to return an XML representation of. * @param[out] str The character string that will hold the description of the * message * @param[in] buf The size of the char* array that will hold the string * * @return The number of characters (including the terminating nul byte) which * would have been written to the final string if enough space * available. Thus returning a value of buf or larger means the output * was truncated. */ extern AJ_API size_t AJ_CALL alljoyn_message_description(alljoyn_message msg, char* str, size_t buf); /** * Returns the timestamp (in milliseconds) for this message. If the message header contained a * timestamp this is the estimated timestamp for when the message was sent by the remote device, * otherwise it is the timestamp for when the message was unmarshaled. Note that the timestamp * is always relative to local time. * * @param[in] msg The alljoyn_message from which to extract the timestamp information. * * @return The timestamp for this message. */ extern AJ_API uint32_t AJ_CALL alljoyn_message_gettimestamp(alljoyn_message msg); /** * Equality operation. * * @param one alljoyn_interfacedescription_member to compare to other * @param other alljoyn_interfacedescription_member to compare to one * * @return QCC_TRUE if one == other */ extern AJ_API QCC_BOOL AJ_CALL alljoyn_message_eql(const alljoyn_message one, const alljoyn_message other); /** * Set the endianness for outgoing messages. This is mainly for testing purposes. * * @param endian Either ALLJOYN_LITTLE_ENDIAN or ALLJOYN_BIG_ENDIAN. Any other value * sets the endianness to the native endianness for this platform. * * */ extern AJ_API void AJ_CALL alljoyn_message_setendianess(const char endian); #ifdef __cplusplus } /* extern "C" */ #endif #endif //_ALLJOYN_C_MESSAGE_H alljoyn-15.04b/alljoyn_c/inc/alljoyn_c/MessageReceiver.h000066400000000000000000000060331255700255500232640ustar00rootroot00000000000000/** * @file * MessageReceiver is a base class implemented by any class * which wishes to receive AllJoyn messages */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_C_MESSAGERECEIVER_H #define _ALLJOYN_C_MESSAGERECEIVER_H #include #include #ifdef __cplusplus extern "C" { #endif #ifndef _ALLJOYN_OPAQUE_BUSOBJECT_ #define _ALLJOYN_OPAQUE_BUSOBJECT_ /** * Message bus object */ typedef struct _alljoyn_busobject_handle* alljoyn_busobject; #endif /** * MethodHandlers are %MessageReceiver functions which are called by AllJoyn library * to forward AllJoyn method_calls to AllJoyn library users. * * @param bus The bus object triggering this callback. * @param member Method interface member entry. * @param message The received method call message. */ typedef void (AJ_CALL * alljoyn_messagereceiver_methodhandler_ptr)(alljoyn_busobject bus, const alljoyn_interfacedescription_member* member, alljoyn_message message); /** * ReplyHandlers are %MessageReceiver functions which are called by AllJoyn library * to forward AllJoyn method_reply and error responses to AllJoyn library users. * * @param message The received message. * @param context User-defined context passed to MethodCall and returned upon reply. */ typedef void (AJ_CALL * alljoyn_messagereceiver_replyhandler_ptr)(alljoyn_message message, void* context); /** * SignalHandlers are %MessageReceiver functions which are called by AllJoyn library * to forward AllJoyn received signals to AllJoyn library users. * * @param member Method or signal interface member entry. * @param srcPath Object path of signal emitter. * @param message The received message. */ typedef void (AJ_CALL * alljoyn_messagereceiver_signalhandler_ptr)(const alljoyn_interfacedescription_member* member, const char* srcPath, alljoyn_message message); #ifdef __cplusplus } /* extern "C" */ #endif #endif alljoyn-15.04b/alljoyn_c/inc/alljoyn_c/MsgArg.h000066400000000000000000002034731255700255500214020ustar00rootroot00000000000000/** * @file * This file defines a class for message bus data types and values */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_C_MSGARG_H #define _ALLJOYN_C_MSGARG_H #include #include #include #ifdef __cplusplus extern "C" { #endif /** * Definition for a message arg. * alljoyn_msgarg deals with the message bus types and the operations on them. * * alljoyn_msgargs are designed to be light-weight. An alljoyn_msgarg will normally hold references to * the data (strings etc.) it wraps and will only copy that data if the alljoyn_msgarg is copied. For * example no additional memory is allocated for an #ALLJOYN_STRING that references an existing * const char*. If an alljoyn_msgarg is copied using the alljoyn_msgarg_copy function the destination * receives a copy of the contents of the source. The alljoyn_msgarg_stabilize function can also be * called to explicitly force contents of the alljoyn_msgarg to be copied into the alljoyn_msgarg. */ typedef struct _alljoyn_msgarg_handle* alljoyn_msgarg; /** * Enumeration of the various message arg types. * @remark Most of these map directly to the values used in the * DBus wire protocol but some are specific to the AllJoyn implementation. */ typedef enum { ALLJOYN_INVALID = 0, ///< AllJoyn INVALID typeId ALLJOYN_ARRAY = 'a', ///< AllJoyn array container type ALLJOYN_BOOLEAN = 'b', ///< AllJoyn boolean basic type, @c 0 is @c FALSE and @c 1 is @c TRUE - Everything else is invalid ALLJOYN_DOUBLE = 'd', ///< AllJoyn IEEE 754 double basic type ALLJOYN_DICT_ENTRY = 'e', ///< AllJoyn dictionary or map container type - an array of key-value pairs ALLJOYN_SIGNATURE = 'g', ///< AllJoyn signature basic type ALLJOYN_HANDLE = 'h', ///< AllJoyn socket handle basic type ALLJOYN_INT32 = 'i', ///< AllJoyn 32-bit signed integer basic type ALLJOYN_INT16 = 'n', ///< AllJoyn 16-bit signed integer basic type ALLJOYN_OBJECT_PATH = 'o', ///< AllJoyn Name of an AllJoyn object instance basic type ALLJOYN_UINT16 = 'q', ///< AllJoyn 16-bit unsigned integer basic type ALLJOYN_STRUCT = 'r', ///< AllJoyn struct container type ALLJOYN_STRING = 's', ///< AllJoyn UTF-8 NULL terminated string basic type ALLJOYN_UINT64 = 't', ///< AllJoyn 64-bit unsigned integer basic type ALLJOYN_UINT32 = 'u', ///< AllJoyn 32-bit unsigned integer basic type ALLJOYN_VARIANT = 'v', ///< AllJoyn variant container type ALLJOYN_INT64 = 'x', ///< AllJoyn 64-bit signed integer basic type ALLJOYN_BYTE = 'y', ///< AllJoyn 8-bit unsigned integer basic type ALLJOYN_STRUCT_OPEN = '(', /**< Never actually used as a typeId: specified as ALLJOYN_STRUCT */ ALLJOYN_STRUCT_CLOSE = ')', /**< Never actually used as a typeId: specified as ALLJOYN_STRUCT */ ALLJOYN_DICT_ENTRY_OPEN = '{', /**< Never actually used as a typeId: specified as ALLJOYN_DICT_ENTRY */ ALLJOYN_DICT_ENTRY_CLOSE = '}', /**< Never actually used as a typeId: specified as ALLJOYN_DICT_ENTRY */ ALLJOYN_BOOLEAN_ARRAY = ('b' << 8) | 'a', ///< AllJoyn array of booleans ALLJOYN_DOUBLE_ARRAY = ('d' << 8) | 'a', ///< AllJoyn array of IEEE 754 doubles ALLJOYN_INT32_ARRAY = ('i' << 8) | 'a', ///< AllJoyn array of 32-bit signed integers ALLJOYN_INT16_ARRAY = ('n' << 8) | 'a', ///< AllJoyn array of 16-bit signed integers ALLJOYN_UINT16_ARRAY = ('q' << 8) | 'a', ///< AllJoyn array of 16-bit unsigned integers ALLJOYN_UINT64_ARRAY = ('t' << 8) | 'a', ///< AllJoyn array of 64-bit unsigned integers ALLJOYN_UINT32_ARRAY = ('u' << 8) | 'a', ///< AllJoyn array of 32-bit unsigned integers ALLJOYN_INT64_ARRAY = ('x' << 8) | 'a', ///< AllJoyn array of 64-bit signed integers ALLJOYN_BYTE_ARRAY = ('y' << 8) | 'a', ///< AllJoyn array of 8-bit unsigned integers ALLJOYN_WILDCARD = '*' ///< This never appears in a signature but is used for matching arbitrary message args } alljoyn_typeid; /** * Create a new message argument. * calling alljoyn_msgarg_create() is the same as calling * alljoyn_msgarg_array_create(1). * * @return the created message argument */ extern AJ_API alljoyn_msgarg AJ_CALL alljoyn_msgarg_create(); /** * Build a message argument that has its value already set. If the setting the * message argument value fails for any reason the message argument type will be * set to #ALLJOYN_INVALID. See the description of the #alljoyn_msgarg_set() function * for information about the signature and parameters. For initializing complex * values it is recommended to use the alljoyn_msgarg_create and alljoyn_msgarg_set * functions so the success of setting the value can be explicitly checked. * * @param signature The signature for alljoyn_msgarg value. * @param ... One or more values to initialize the alljoyn_msgarg. * * @return the created alljoyn_msgarg */ extern AJ_API alljoyn_msgarg AJ_CALL alljoyn_msgarg_create_and_set(const char* signature, ...); /** * Destroy a message argument. * * @param arg The message argument to destroy. */ extern AJ_API void AJ_CALL alljoyn_msgarg_destroy(alljoyn_msgarg arg); /** * Create an array of message arguments * * This returns and alljoyn_msgarg however the individual array elements can only * be accessed using alljoyn_msgarg_array_element() function. * * the alljoyn_msgarg returned can be used in any functions that states says * alljoyn_msgarg_array_*. and alljoyn_msgarg created using alljoyn_msgarg_create() * is an array of message arguments with size of 1. * * If the function does not specifically say it is for an array it is assumed that * the message argument was created using alljoyn_msgarg_create() and will be treated * like an array with only one element. * * For example the following code would only copy the first msgarg in the array. * An alljoyn_msgarg of the string "hello". Not both array elements. * * @code * alljoyn_msgarg args = alljoyn_msgarg_array_create(2); * alljoyn_msgarg_array_set(args, 2, "ss", "hello", "world"); * alljoyn_msgarg arg = alljoyn_msgarg_copy(args); * @endcode * * To make a copy of an alljoyn_msgarg that contains an array of elements requires * a for loop. * * @code * alljoyn_msgarg args = alljoyn_msgarg_array_create(2); * alljoyn_msgarg_array_set(args, 2, "ss", "hello", "world"); * alljoyn_msgarg cp_args = alljoyn_msgarg_array_create(2); * for (size_t i = 0; i < 2; ++i) { * alljoyn_msgarg_array_element(cp_args, i) = alljoyn_msgarg_copy(alljoyn_msgarg_array_element(args, i)); * } * @endcode * * @param size the size of the array of alljoyn_msgargs * * @return the created array of message arguments */ extern AJ_API alljoyn_msgarg AJ_CALL alljoyn_msgarg_array_create(size_t size); /** * when working with an array of message arguments this will return the nth item * in the array. * @param arg the alljoyn_msgarg that contains an array of msgargs * @param index the index number of the element we wish to access. * * @return the individual alljoyn_msgarg specified by the index */ extern AJ_API alljoyn_msgarg AJ_CALL alljoyn_msgarg_array_element(alljoyn_msgarg arg, size_t index); /** * Set value of a message arg from a signature and a list of values. Note that any values or * alljoyn_msgarg pointers passed in must remain valid until this alljoyn_msgarg is freed using * alljoyn_msgarg_delete. * * - @c 'a' The array length followed by: * - If the element type is a basic type a pointer to an array of values of that type. * - If the element type is string a pointer to array of const char*, if array length is * non-zero, and the char* pointer is NULL, the NULL must be followed by a pointer to * an array of const qcc::String. * - If the element type is an @ref ALLJOYN_ARRAY "ARRAY", @ref ALLJOYN_STRUCT "STRUCT", * @ref ALLJOYN_DICT_ENTRY "DICT_ENTRY" or @ref ALLJOYN_VARIANT "VARIANT" a pointer to an * array of alljoyn_msgargs where each alljoyn_msgarg has the signature specified by the * element type. * - If the element type is specified using the wildcard character '*', a pointer to * an array of alljoyn_msgargs. The array element type is determined from the type of the * first alljoyn_msgarg in the array, all the elements must have the same type. * - @c 'b' A bool value * - @c 'd' A double (64 bits) * - @c 'g' A pointer to a NUL terminated string (pointer must remain valid for lifetime of the alljoyn_msgarg) * - @c 'h' A qcc::SocketFd * - @c 'i' An int (32 bits) * - @c 'n' An int (16 bits) * - @c 'o' A pointer to a NUL terminated string (pointer must remain valid for lifetime of the alljoyn_msgarg) * - @c 'q' A uint (16 bits) * - @c 's' A pointer to a NUL terminated string (pointer must remain valid for lifetime of the alljoyn_msgarg) * - @c 't' A uint (64 bits) * - @c 'u' A uint (32 bits) * - @c 'v' Not allowed, the actual type must be provided. * - @c 'x' An int (64 bits) * - @c 'y' A byte (8 bits) * * - @c '(' and @c ')' The list of values that appear between the parentheses using the notation above * - @c '{' and @c '}' A pair values using the notation above. * * - @c '*' A pointer to an alljoyn_msgarg. * * Examples: * * An array of strings * * @code * char* fruits[3] = { "apple", "banana", "orange" }; * alljoyn_msgarg bowl; * bowl = alljoyn_msgarg_create(); * alljoyn_msgarg_set(bowl, "as", 3, fruits); * @endcode * * A struct with a uint and two string elements. * * @code alljoyn_msgarg_set(arg, "(uss)", 1024, "hello", "world"); @endcode * * An array of 3 dictionary entries where each entry has an integer key and string value. * * @code * alljoyn_msgarg dict = alljoyn_msgarg_array_create(3) * alljoyn_msgarg_set(alljoyn_msgarg_array_element(0), "{is}", 1, "red"); * alljoyn_msgarg_set(alljoyn_msgarg_array_element(1), "{is}", 2, "green"); * alljoyn_msgarg_set(alljoyn_msgarg_array_element(2), "{is}", 3, "blue"); * alljoyn_msgarg arg = alljoyn_msgarg_create(); * alljoyn_msgarg_set(arg, "a{is}", 3, dict); * @endcode * * An array of uint_16's * * @code * uint16_t aq[] = { 1, 2, 3, 5, 6, 7 }; * alljoyn_msgarg_set(arg, "aq", sizeof(aq) / sizeof(uint16_t), aq); * @endcode * * @param arg The alljoyn_msgarg being set * @param signature The signature for alljoyn_msgarg value * @param ... One or more values to initialize the alljoyn_msgarg. * * @return * - #ER_OK if the alljoyn_msgarg was successfully set * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_set(alljoyn_msgarg arg, const char* signature, ...); /** * Matches a signature to the alljoyn_msgarg and if the signature matches unpacks the component * values of an alljoyn_msgarg. Note that the values returned are references into the * alljoyn_msgarg itself so unless copied will become invalid if the alljoyn_msgarg is freed or * goes out of scope. This function resolves through variants, so if the alljoyn_msgarg is a * variant that references a 32 bit integer it can be unpacked directly into a 32 bit integer * pointer. * * - @c 'a' A pointer to a length of type size_t that returns the number of elements in the array followed by: * - If the element type is a scalar type a pointer to a pointer of the correct type for the values. * - Otherwise a pointer to a pointer to an alljoyn_msgarg. * * - @c 'b' A pointer to a bool * - @c 'd' A pointer to a double (64 bits) * - @c 'g' A pointer to a char* (character string is valid for the lifetime of the alljoyn_msgarg) * - @c 'h' A pointer to a qcc::SocketFd * - @c 'i' A pointer to a uint32_t * - @c 'n' A pointer to an int16_t * - @c 'o' A pointer to a char* (character string is valid for the lifetime of the alljoyn_msgarg) * - @c 'q' A pointer to a uint16_t * - @c 's' A pointer to a char* (character string is valid for the lifetime of the alljoyn_msgarg) * - @c 't' A pointer to a uint64_t * - @c 'u' A pointer to a uint32_t * - @c 'v' A pointer to a pointer to an alljoyn_msgarg, matches to a variant but returns a pointer to * the alljoyn_msgarg of the underlying real type. * - @c 'x' A pointer to an int64_t * - @c 'y' A pointer to a uint8_t * * - @c '(' and @c ')' A list of pointers as required for each of the struct members. * - @c '{' and @c '}' Pointers as required for the key and value members. * * - @c '*' A pointer to a pointer to an alljoyn_msgarg. This matches any value type. * * Examples: * * A struct with and uint32 and two string elements. * * @code * struct { * uint32_t i; * char *hello; * char *world; * } myStruct; * alljoyn_msgarg_get(arg, "(uss)", &myStruct.i, &myStruct.hello, &myStruct.world); * @endcode * * A variant where it is known that the value is a uint32, a string, or double. Note that the * variant is resolved away. * * @code * uint32_t i; * double d; * char *str; * QStatus status = alljoyn_msgarg_get(arg, "i", &i); * if (status == ER_BUS_SIGNATURE_MISMATCH) { * status = alljoyn_msgarg_get(arg, "s", &str); * if (status == ER_BUS_SIGNATURE_MISMATCH) { * status = alljoyn_msgarg_get(arg, "d", &d); * } * } * @endcode * * An array of dictionary entries where each entry has an integer key and variant. Find the * entries where the variant value is a string or a struct of 2 strings. * * @code * alljoyn_msgarg entries; * size_t num; * alljoyn_msgarg_get(arg, "a{iv}", &num, &entries); * for (size_t i = 0; i < num; ++i) { * char *str1; * char *str2; * uint32_t key; * status = alljoyn_msgarg_get(alljoyn_msgarg_array_element(entries, i), "{is}", &key, &str1); * if (status == ER_BUS_SIGNATURE_MISMATCH) { * status = alljoyn_msgarg_get(alljoyn_msgarg_array_element(entries, i), "{i(ss)}", &key, &str1, &str2); * } * } * @endcode * * An array of uint_16's * * @code * uint16_t *vals; * size_t numVals; * alljoyn_msgarg_get(arg, "aq", &numVals, &vals); * @endcode * * @param arg The alljoyn_msgarg we are reading from * @param signature The signature for alljoyn_msgarg value * @param ... Pointers to return the unpacked values. * * @return * - #ER_OK if the signature matched and alljoyn_msgarg was successfully unpacked. * - #ER_BUS_SIGNATURE_MISMATCH if the signature did not match. * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_get(alljoyn_msgarg arg, const char* signature, ...); /** * create a copy of a message argument. This will create a new alljoyn_msgarg and * must be cleaned up using alljoyn_msgarg_detroy. * * @param source the alljoyn_msgarg to be copied * * @return copy of the source message argument is returned */ extern AJ_API alljoyn_msgarg AJ_CALL alljoyn_msgarg_copy(const alljoyn_msgarg source); /** * Copy the contents of the source alljoyn_msgarg into the Destination alljoyn_msgarg. If the * destination already contains information it will be cleared before the source * alljoyn_msgarg is copied in. * * @param destination the alljoyn_msgarg that will hold the copy * @param source the alljoyn_msgarg to be copied */ extern AJ_API void AJ_CALL alljoyn_msgarg_clone(alljoyn_msgarg destination, const alljoyn_msgarg source); /** * Equality operator. * * @param lhv The alljoyn_msgarg to compare. * @param rhv The other alljoyn_msgarg to compare * * @return Returns true if the two message args have the same signatures and values. */ extern AJ_API QCC_BOOL AJ_CALL alljoyn_msgarg_equal(alljoyn_msgarg lhv, alljoyn_msgarg rhv); /** * Set an array of alljoyn_msgargs by applying the alljoyn_msgarg_set() function to each alljoyn_msgarg in turn. * * @param args An array of alljoyn_msgargs to set. * @param numArgs [in,out] On input the size of the args array. On output the number of alljoyn_msgargs * that were set. There must be at least enough alljoyn_msgargs to completely * initialize the signature. * * @param signature The signature for alljoyn_msgarg values * @param ... One or more values to initialize the alljoyn_msgarg list. * * @return * - #ER_OK if the alljoyn_msgargs were successfully set. * - #ER_BUS_TRUNCATED if the signature was longer than expected. * - Other error status codes indicating a failure. */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_array_set(alljoyn_msgarg args, size_t* numArgs, const char* signature, ...); /** * Unpack an array of alljoyn_msgargs by applying the alljoyn_msgarg_get() function to each alljoyn_msgarg in turn. * * @param args An array of alljoyn_msgargs to unpack. * @param numArgs The size of the alljoyn_msgargs array. * @param signature The signature to match against the alljoyn_msgarg values * @param ... Pointers to return references to the unpacked values. * * @return * - #ER_OK if the alljoyn_msgargs were successfully set. * - #ER_BUS_SIGNATURE_MISMATCH if the signature did not match. * - Other error status codes indicating a failure. */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_array_get(const alljoyn_msgarg args, size_t numArgs, const char* signature, ...); /** * Returns an XML string representation of this type * * @param[in] arg The message arg to generate the XML string representation of * @param[out] str The character string that will hold the XML string * representation of the alljoyn_msgarg * @param[in] buf The size of the char* array that will hold the string * @param[in] indent Number of spaces to indent the generated xml (default value 0) * * @return The number of characters (including the terminating nul byte) which * would have been written to the final string if enough space * available. Thus returning a value of buf or larger means the output * was truncated. */ extern AJ_API size_t AJ_CALL alljoyn_msgarg_tostring(alljoyn_msgarg arg, char* str, size_t buf, size_t indent); /** * Returns an XML string representation for an array of message args. * * @param[in] args The message arg array to generate the XML string representation of * @param[in] numArgs The size of the message arg array. * @param[out] str The character string that will hold the XML string * representation of the alljoyn_msgarg array * @param[in] buf The size of the char* array that will hold the string * @param[in] indent Number of spaces to indent the generated xml (default value 0) * * @return The number of characters (including the terminating nul byte) which * would have been written to the final string if enough space is * available. Thus returning a value of buf or larger means the output * was truncated. */ extern AJ_API size_t AJ_CALL alljoyn_msgarg_array_tostring(const alljoyn_msgarg args, size_t numArgs, char* str, size_t buf, size_t indent); /** * Returns a string for the signature of this value * * @param[in] arg the argument to read the signature from * @param[out] str a string containing the signature of the alljoyn_msgarg use NULL pointer * to find string size. * @param[in] buf The size of the char* array that will hold the string * * @return The number of characters (including the terminating nul byte) which * would have been written to the final string if enough space is * available. Thus returning a value of buf or larger means the output * was truncated. */ extern AJ_API size_t AJ_CALL alljoyn_msgarg_signature(alljoyn_msgarg arg, char* str, size_t buf); /** * Returns a string representation of the signature of an array of message args. * * @param[in] values A pointer to an array of message arg values * @param[in] numValues Length of the array * @param[out] str a string containing the signature of the alljoyn_msgarg use NULL * pointer to find string size. * @param[in] buf The size of the char* array that will hold the string * * @return The number of characters (including the terminating nul byte) which * would have been written to the final string if enough space is * available. Thus returning a value of buf or larger means the output * was truncated. */ extern AJ_API size_t AJ_CALL alljoyn_msgarg_array_signature(alljoyn_msgarg values, size_t numValues, char* str, size_t buf); /** * Checks the signature of this arg. * * @param arg The message argument we want to check the signature of * @param signature The signature to check * * @return true if this arg has the specified signature, otherwise returns false. */ extern AJ_API QCC_BOOL AJ_CALL alljoyn_msgarg_hassignature(alljoyn_msgarg arg, const char* signature); /** * Helper function for accessing dictionary elements. The alljoyn_msgarg must be an array of dictionary * elements. The second parameter is the key value, this is expressed according to the rules for * alljoyn_msgarg_set so is either a scalar, a pointer to a string, or for 64 bit values a pointer to * the value. This value is matched against the dictionary array to locate the matching element. * The third and subsequent parameters are unpacked according to the rules of alljoyn_msgarg_get. * * For example, where the key is a string and the values are structs: * * @code * uint8_t age; * uint32_t height; * const char* address; * QStatus status = alljoyn_msgarg_getdictelement(arg, "{s(yus)}", "fred", &age, &height, &address); * @endcode * * This function is particularly useful for extracting specific properties from the array of property * values returned by ProxyBusObject::GetAllProperties. * * @param arg a message argument containing an array of dictionary elements * @param elemSig The expected signature for the dictionary element, e.g. "{su}" * @param ... Pointers to return unpacked key values. * * @return * - #ER_OK if the dictionary signature matched and alljoyn_msgarg was successfully unpacked. * - #ER_BUS_NOT_A_DICTIONARY if this function is called on an alljoyn_msgarg that is not a dictionary. * - #ER_BUS_SIGNATURE_MISMATCH if the signature did not match. * - #ER_BUS_ELEMENT_NOT_FOUND if the key was not found in the dictionary. * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_getdictelement(alljoyn_msgarg arg, const char* elemSig, ...); /** * Get the alljoyn_typeid of the alljoyn_msgarg * * @param arg the message argument we want to know the alljoyn_typeid of. * * @return the alljoyn_typeid of the alljoyn_msgarg */ extern AJ_API alljoyn_typeid AJ_CALL alljoyn_msgarg_gettype(alljoyn_msgarg arg); /** * Clear the alljoyn_msgarg setting the type to ALLJOYN_INVALID and freeing any memory allocated for the * alljoyn_msgarg value. * * @param arg the message argument to be cleared. */ extern AJ_API void AJ_CALL alljoyn_msgarg_clear(alljoyn_msgarg arg); /** * Makes an alljoyn_msgarg stable by completely copying the contents into locally * managed memory. After an alljoyn_msgarg has been stabilized any values used to * initialize or set the message arg can be freed. * * @param arg the message argument to stabilize */ extern AJ_API void AJ_CALL alljoyn_msgarg_stabilize(alljoyn_msgarg arg); /// @cond ALLJOYN_DEV /* ******************************************************************************* * This set of functions were originally designed for the alljoyn_unity bindings * however they did not not properly map with the C++ MsgArg Class. * * No Functions below this point should be used by any code except for the * AllJoyn Unity Extension. The functions could be changed at any time. ******************************************************************************* */ /** * Set an array of alljoyn_msgargs by applying the alljoyn_msgarg_set() function * to each alljoyn_msgarg in turn. * * @param args An array of alljoyn_msgargs to set. * @param argOffset Offset from the start of the alljoyn_msgarg array. * @param numArgs [in,out] On input the number of args to set. On output the number of alljoyn_msgargs * that were set. There must be at least enough alljoyn_msgargs to completely * initialize the signature. * there should at least enough. * @param signature The signature for alljoyn_msgarg values * @param ... One or more values to initialize the alljoyn_msgarg list. * * @return * - #ER_OK if the alljoyn_msgargs were successfully set. * - #ER_BUS_TRUNCATED if the signature was longer than expected. * - Other error status codes indicating a failure. */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_array_set_offset(alljoyn_msgarg args, size_t argOffset, size_t* numArgs, const char* signature, ...); /** * This function is identical to alljoyn_msgarg_set except after the values * in the message arg have been set the alljoyn_msgarg will be stabilized. * This is useful when the call is made from a manage language like C sharp where * objects like strings may be garbage collected. * * @param arg The alljoyn_msgarg being set * @param signature The signature for alljoyn_msgarg value * @param ... One or more values to initialize the alljoyn_msgarg. * * @return * - #ER_OK if the alljoyn_msgarg was successfully set * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_set_and_stabilize(alljoyn_msgarg arg, const char* signature, ...); /******************************************************************************* * MsgArg set functions for each of the basic data types *******************************************************************************/ /** * Set the value of an alljoyn_msgarg to hold an uint8 (byte). * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_set * * @param arg the alljoyn_msgarg that will hold the uint8 (byte) * @param y a uint8 * * @return * - #ER_OK if the alljoyn_msgarg walljoyn_msgargcessfully set * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_set_uint8(alljoyn_msgarg arg, uint8_t y); /** * Set the value of an alljoyn_msgarg to hold a QCC_BOOL. * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_set * * @param arg the alljoyn_msgarg that will hold the QCC_BOOL * @param b a QCC_BOOL * * @return * - #ER_OK if the alljoyn_msgarg was successfully set * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_set_bool(alljoyn_msgarg arg, QCC_BOOL b); /** * Set the value of an alljoyn_msgarg to hold an int16. * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_set * * @param arg the alljoyn_msgarg that will hold the int16 * @param n an int16 * * @return * - #ER_OK if the alljoyn_msgarg was successfully set * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_set_int16(alljoyn_msgarg arg, int16_t n); /** * Set the value of an alljoyn_msgarg to hold an uint16. * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_set * * @param arg the alljoyn_msgarg that will hold the uint16 * @param q an uint16 * * @return * - #ER_OK if the alljoyn_msgarg was successfully set * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_set_uint16(alljoyn_msgarg arg, uint16_t q); /** * Set the value of an alljoyn_msgarg to hold an int32. * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_set * * @param arg the alljoyn_msgarg that will hold the int32 * @param i an int32 * * @return * - #ER_OK if the alljoyn_msgarg was successfully set * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_set_int32(alljoyn_msgarg arg, int32_t i); /** * Set the value of an alljoyn_msgarg to hold an uint32. * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_set * * @param arg the alljoyn_msgarg that will hold the uint32 * @param u an uint32 * * @return * - #ER_OK if the alljoyn_msgarg was successfully set * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_set_uint32(alljoyn_msgarg arg, uint32_t u); /** * Set the value of an alljoyn_msgarg to hold an int64. * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_set * * @param arg the alljoyn_msgarg that will hold the int64 * @param x an int64 * * @return * - #ER_OK if the alljoyn_msgarg was successfully set * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_set_int64(alljoyn_msgarg arg, int64_t x); /** * Set the value of an alljoyn_msgarg to hold an uint64. * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_set * * @param arg the alljoyn_msgarg that will hold the uint64 * @param t an uint64 * * @return * - #ER_OK if the alljoyn_msgarg was successfully set * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_set_uint64(alljoyn_msgarg arg, uint64_t t); /** * Set the value of an alljoyn_msgarg to hold an double. * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_set * * @param arg the alljoyn_msgarg that will hold the double * @param d an double * * @return * - #ER_OK if the alljoyn_msgarg was successfully set * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_set_double(alljoyn_msgarg arg, double d); /** * Set the value of an alljoyn_msgarg to hold a string. * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_set * * @param arg the alljoyn_msgarg that will hold the string * @param s an string * * @return * - #ER_OK if the alljoyn_msgarg was successfully set * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_set_string(alljoyn_msgarg arg, const char* s); /** * Set the value of an alljoyn_msgarg to hold an object path * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_set * * @param arg the alljoyn_msgarg that will hold the object path * @param o an object path string * * @return * - #ER_OK if the alljoyn_msgarg was successfully set * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_set_objectpath(alljoyn_msgarg arg, const char* o); /** * Set the value of an alljoyn_msgarg to hold a signature. * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_set * * @param arg the alljoyn_msgarg that will hold the signature * @param g a signature string * * @return * - #ER_OK if the alljoyn_msgarg was successfully set * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_set_signature(alljoyn_msgarg arg, const char* g); /******************************************************************************* * MsgArg get functions for each of the basic data types *******************************************************************************/ /** * Get an uint8 (bytes) from an alljoyn_msgarg * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_get. * * @param arg the alljoyn_msgarg to obtain the data from * @param[out] y a pointer to the uint8 (byte) * * @return * - #ER_OK if the signature matched and alljoyn_msgarg was successfully unpacked. * - #ER_BUS_SIGNATURE_MISMATCH if the signature did not match. * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_get_uint8(const alljoyn_msgarg arg, uint8_t* y); /** * Get a QCC_BOOL from an alljoyn_msgarg * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_get. * * @param arg the alljoyn_msgarg to obtain the data from * @param[out] b a pointer to the QCC_BOOL * * @return * - #ER_OK if the signature matched and alljoyn_msgarg was successfully unpacked. * - #ER_BUS_SIGNATURE_MISMATCH if the signature did not match. * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_get_bool(const alljoyn_msgarg arg, QCC_BOOL* b); /** * Get an int16 from an alljoyn_msgarg * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_get. * * @param arg the alljoyn_msgarg to obtain the data from * @param[out] n a pointer to the int16 * * @return * - #ER_OK if the signature matched and alljoyn_msgarg was successfully unpacked. * - #ER_BUS_SIGNATURE_MISMATCH if the signature did not match. * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_get_int16(const alljoyn_msgarg arg, int16_t* n); /** * Get an uint16 from an alljoyn_msgarg * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_get. * * @param arg the alljoyn_msgarg to obtain the data from * @param[out] q a pointer to the uint16 * * @return * - #ER_OK if the signature matched and alljoyn_msgarg was successfully unpacked. * - #ER_BUS_SIGNATURE_MISMATCH if the signature did not match. * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_get_uint16(const alljoyn_msgarg arg, uint16_t* q); /** * Get an int32 from an alljoyn_msgarg * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_get. * * @param arg the alljoyn_msgarg to obtain the data from * @param[out] i a pointer to the int32 * * @return * - #ER_OK if the signature matched and alljoyn_msgarg was successfully unpacked. * - #ER_BUS_SIGNATURE_MISMATCH if the signature did not match. * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_get_int32(const alljoyn_msgarg arg, int32_t* i); /** * Get an uint32 from an alljoyn_msgarg * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_get. * * @param arg the alljoyn_msgarg to obtain the data from * @param[out] u a pointer to the uint32 * * @return * - #ER_OK if the signature matched and alljoyn_msgarg was successfully unpacked. * - #ER_BUS_SIGNATURE_MISMATCH if the signature did not match. * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_get_uint32(const alljoyn_msgarg arg, uint32_t* u); /** * Get an int64 from an alljoyn_msgarg * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_get. * * @param arg the alljoyn_msgarg to obtain the data from * @param[out] x a pointer to the int64 * * @return * - #ER_OK if the signature matched and alljoyn_msgarg was successfully unpacked. * - #ER_BUS_SIGNATURE_MISMATCH if the signature did not match. * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_get_int64(const alljoyn_msgarg arg, int64_t* x); /** * Get an uint64 from an alljoyn_msgarg * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_get. * * @param arg the alljoyn_msgarg to obtain the data from * @param[out] t a pointer to the uint64 * * @return * - #ER_OK if the signature matched and alljoyn_msgarg was successfully unpacked. * - #ER_BUS_SIGNATURE_MISMATCH if the signature did not match. * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_get_uint64(const alljoyn_msgarg arg, uint64_t* t); /** * Get a double from an alljoyn_msgarg * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_get. * * @param arg the alljoyn_msgarg to obtain the data from * @param[out] d a pointer to the double * * @return * - #ER_OK if the signature matched and alljoyn_msgarg was successfully unpacked. * - #ER_BUS_SIGNATURE_MISMATCH if the signature did not match. * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_get_double(const alljoyn_msgarg arg, double* d); /** * Get a string from an alljoyn_msgarg * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_get. * * @param arg the alljoyn_msgarg to obtain the data from * @param[out] s a pointer to the string * * @return * - #ER_OK if the signature matched and alljoyn_msgarg was successfully unpacked. * - #ER_BUS_SIGNATURE_MISMATCH if the signature did not match. * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_get_string(const alljoyn_msgarg arg, char** s); /** * Get an object path from an alljoyn_msgarg * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_get. * * @param arg the alljoyn_msgarg to obtain the data from * @param[out] o a pointer to the object path string * * @return * - #ER_OK if the signature matched and alljoyn_msgarg was successfully unpacked. * - #ER_BUS_SIGNATURE_MISMATCH if the signature did not match. * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_get_objectpath(const alljoyn_msgarg arg, char** o); /** * Get a signature from an alljoyn_msgarg * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_get. * * @param arg the alljoyn_msgarg to obtain the data from * @param[out] g a pointer to the signature string * * @return * - #ER_OK if the signature matched and alljoyn_msgarg was successfully unpacked. * - #ER_BUS_SIGNATURE_MISMATCH if the signature did not match. * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_get_signature(const alljoyn_msgarg arg, char** g); /** * Get the alljoyn_msgarg from an variant alljoyn_msgarg * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_get. * * @param arg the alljoyn_msgarg to obtain the data from * @param[out] v the alljoyn_msgarg that will be returned * * @return * - #ER_OK if the signature matched and alljoyn_msgarg was successfully unpacked. * - #ER_BUS_SIGNATURE_MISMATCH if the signature did not match. * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_get_variant(const alljoyn_msgarg arg, alljoyn_msgarg v); /******************************************************************************* * MsgArg set function for arrays of each basic data type *******************************************************************************/ /** * Set the value of an alljoyn_msgarg to hold an array of uint8s (bytes). * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_set * * @param arg the alljoyn_msgarg to set * @param length the size of the array of uint8s (bytes) * @param ay a pointer to an array of uint8s (bytes) * * @return * - #ER_OK if the alljoyn_msgarg was successfully set * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_set_uint8_array(alljoyn_msgarg arg, size_t length, uint8_t* ay); /** * Set the value of an alljoyn_msgarg to hold an array of QCC_BOOLs. * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_set * * @param arg the alljoyn_msgarg to set * @param length the size of the array of QCC_BOOLs * @param ab a pointer to an array of QCC_BOOLs * * @return * - #ER_OK if the alljoyn_msgarg was successfully set * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_set_bool_array(alljoyn_msgarg arg, size_t length, QCC_BOOL* ab); /** * Set the value of an alljoyn_msgarg to hold an array of int16s. * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_set * * @param arg the alljoyn_msgarg to set * @param length the size of the array of int16s * @param an a pointer to an array of int16s * * @return * - #ER_OK if the alljoyn_msgarg was successfully set * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_set_int16_array(alljoyn_msgarg arg, size_t length, int16_t* an); /** * Set the value of an alljoyn_msgarg to hold an array of uint16s. * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_set * * @param arg the alljoyn_msgarg to set * @param length the size of the array of uint16s * @param aq a pointer to an array of uint16s * * @return * - #ER_OK if the alljoyn_msgarg was successfully set * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_set_uint16_array(alljoyn_msgarg arg, size_t length, uint16_t* aq); /** * Set the value of an alljoyn_msgarg to hold an array of int32s. * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_set * * @param arg the alljoyn_msgarg to set * @param length the size of the array of int32s * @param ai a pointer to an array of int32s * * @return * - #ER_OK if the alljoyn_msgarg was successfully set * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_set_int32_array(alljoyn_msgarg arg, size_t length, int32_t* ai); /** * Set the value of an alljoyn_msgarg to hold an array of uint32s. * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_set * * @param arg the alljoyn_msgarg to set * @param length the size of the array of uint32s * @param au a pointer to an array of uint32s * * @return * - #ER_OK if the alljoyn_msgarg was successfully set * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_set_uint32_array(alljoyn_msgarg arg, size_t length, uint32_t* au); /** * Set the value of an alljoyn_msgarg to hold an array of int64s. * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_set * * @param arg the alljoyn_msgarg to set * @param length the size of the array of int64s * @param ax a pointer to an array of int64s * * @return * - #ER_OK if the alljoyn_msgarg was successfully set * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_set_int64_array(alljoyn_msgarg arg, size_t length, int64_t* ax); /** * Set the value of an alljoyn_msgarg to hold an array of uint64s. * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_set * * @param arg the alljoyn_msgarg to set * @param length the size of the array of uint64s * @param at a pointer to an array of uint64s * * @return * - #ER_OK if the alljoyn_msgarg was successfully set * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_set_uint64_array(alljoyn_msgarg arg, size_t length, uint64_t* at); /** * Set the value of an alljoyn_msgarg to hold an array of doubles. * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_set * * @param arg the alljoyn_msgarg to set * @param length the size of the array of dobules * @param ad a pointer to an array of doubles * * @return * - #ER_OK if the alljoyn_msgarg was successfully set * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_set_double_array(alljoyn_msgarg arg, size_t length, double* ad); /** * Set the value of an alljoyn_msgarg to hold an array of strings. * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_set * * @param arg the alljoyn_msgarg to set * @param length the size of the array of object paths * @param as a pointer to an array of object paths * * @return * - #ER_OK if the alljoyn_msgarg was successfully set * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_set_string_array(alljoyn_msgarg arg, size_t length, const char** as); /** * Set the value of an alljoyn_msgarg to hold an array of object paths. * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_set * * @param arg the alljoyn_msgarg to set * @param length the size of the array of object paths * @param ao a pointer to an array of object paths * * @return * - #ER_OK if the alljoyn_msgarg was successfully set * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_set_objectpath_array(alljoyn_msgarg arg, size_t length, const char** ao); /** * Set the value of an alljoyn_msgarg to hold an array of signatures. * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_set * * @param arg the alljoyn_msgarg to set * @param[out] length the size of the array of signatures * @param[out] ag a pointer to an array of signatures * * @return * - #ER_OK if the alljoyn_msgarg was successfully set * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_set_signature_array(alljoyn_msgarg arg, size_t length, const char** ag); /******************************************************************************* * MsgArg get function for arrays of each basic data type *******************************************************************************/ /** * get an array of uint8s (bytes) from an alljoyn_msgarg * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_get. * * @param arg the alljoyn_msgarg to obtain the data from * @param[out] length the size of the uint8 (byte) array * @param[out] ay a pointer to the uint8 (byte) array * * @return * - #ER_OK if the signature matched and alljoyn_msgarg was successfully unpacked. * - #ER_BUS_SIGNATURE_MISMATCH if the signature did not match. * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_get_uint8_array(const alljoyn_msgarg arg, size_t* length, uint8_t* ay); /** * get an array of QCC_BOOLs from an alljoyn_msgarg * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_get. * * @param arg the alljoyn_msgarg to obtain the data from * @param[out] length the size of the QCC_BOOL array * @param[out] ab a pointer to the QCC_BOOL array * * @return * - #ER_OK if the signature matched and alljoyn_msgarg was successfully unpacked. * - #ER_BUS_SIGNATURE_MISMATCH if the signature did not match. * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_get_bool_array(const alljoyn_msgarg arg, size_t* length, QCC_BOOL* ab); /** * get an array of int16 from an alljoyn_msgarg * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_get. * * @param arg the alljoyn_msgarg to obtain the data from * @param[out] length the size of the int16 array * @param[out] an a pointer to the int16 array * * @return * - #ER_OK if the signature matched and alljoyn_msgarg was successfully unpacked. * - #ER_BUS_SIGNATURE_MISMATCH if the signature did not match. * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_get_int16_array(const alljoyn_msgarg arg, size_t* length, int16_t* an); /** * get an array of uint16s from an alljoyn_msgarg * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_get. * * @param arg the alljoyn_msgarg to obtain the data from * @param[out] length the size of the uint16 array * @param[out] aq a pointer to the uint16 array * * @return * - #ER_OK if the signature matched and alljoyn_msgarg was successfully unpacked. * - #ER_BUS_SIGNATURE_MISMATCH if the signature did not match. * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_get_uint16_array(const alljoyn_msgarg arg, size_t* length, uint16_t* aq); /** * get an array of int32 from an alljoyn_msgarg * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_get. * * @param arg the alljoyn_msgarg to obtain the data from * @param[out] length the size of the int32 array * @param[out] ai a pointer to the int32 array * * @return * - #ER_OK if the signature matched and alljoyn_msgarg was successfully unpacked. * - #ER_BUS_SIGNATURE_MISMATCH if the signature did not match. * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_get_int32_array(const alljoyn_msgarg arg, size_t* length, int32_t* ai); /** * get an array of uint32 from an alljoyn_msgarg * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_get. * * @param arg the alljoyn_msgarg to obtain the data from * @param[out] length the size of the uint32 array * @param[out] au a pointer to the uint32 array * * @return * - #ER_OK if the signature matched and alljoyn_msgarg was successfully unpacked. * - #ER_BUS_SIGNATURE_MISMATCH if the signature did not match. * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_get_uint32_array(const alljoyn_msgarg arg, size_t* length, uint32_t* au); /** * get an array of int64s from an alljoyn_msgarg * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_get. * * @param arg the alljoyn_msgarg to obtain the data from * @param[out] length the size of the int64 array * @param[out] ax a pointer to the int64 array * * @return * - #ER_OK if the signature matched and alljoyn_msgarg was successfully unpacked. * - #ER_BUS_SIGNATURE_MISMATCH if the signature did not match. * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_get_int64_array(const alljoyn_msgarg arg, size_t* length, int64_t* ax); /** * get an array of uint64s from an alljoyn_msgarg * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_get. * * @param arg the alljoyn_msgarg to obtain the data from * @param[out] length the size of the uint64 array * @param[out] at a pointer to the uint64 array * * @return * - #ER_OK if the signature matched and alljoyn_msgarg was successfully unpacked. * - #ER_BUS_SIGNATURE_MISMATCH if the signature did not match. * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_get_uint64_array(const alljoyn_msgarg arg, size_t* length, uint64_t* at); /** * get an array of doubles from an alljoyn_msgarg * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_get. * * @param arg the alljoyn_msgarg to obtain the data from * @param[out] length the size of the double array * @param[out] ad a pointer to the double array * * @return * - #ER_OK if the signature matched and alljoyn_msgarg was successfully unpacked. * - #ER_BUS_SIGNATURE_MISMATCH if the signature did not match. * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_get_double_array(const alljoyn_msgarg arg, size_t* length, double* ad); /** * get an array of alljoyn_msgargs from an alljoyn_msgarg. * * This function can be used for any array that contains an array of alljoyn_msgargs. * This would be non-scalar arrays. i.e. as, ao, ag, a{is}, av etc. * * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_get. * * @param arg the alljoyn_msgarg to obtain the data from * @param arg the signature of the array * @param[out] length the size of the array * @param[out] av a pointer to the alljoyn_msgarg array * * @return * - #ER_OK if the signature matched and alljoyn_msgarg was successfully unpacked. * - #ER_BUS_SIGNATURE_MISMATCH if the signature did not match. * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_get_variant_array(const alljoyn_msgarg arg, const char* signature, size_t* length, alljoyn_msgarg* av); /******************************************************************************* * MsgArg get functions for Arrays of Arrays *******************************************************************************/ /** * How many elements are in the alljoyn array * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_set * @see alljoyn_msgarg_get. * * @param arg The alljoyn_msgarg that contains the array elements * * @return the number of elements in the alljoyn_msgarg */ extern AJ_API size_t AJ_CALL alljoyn_msgarg_get_array_numberofelements(const alljoyn_msgarg arg); /** * Obtain a single alljoyn_msgarg element from an array of alljoyn_msgarg elements * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_set * @see alljoyn_msgarg_get. * * @param arg The alljoyn_msgarg that contains the array element * @param index The index value for the individual alljoyn_msgarg * @param[out] element The alljoyn_msgarg located at the index */ extern AJ_API void AJ_CALL alljoyn_msgarg_get_array_element(const alljoyn_msgarg arg, size_t index, alljoyn_msgarg* element); /** * Obtain the signature of an element inside an array of alljoyn_msgargs * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * @see alljoyn_msgarg_set * @see alljoyn_msgarg_get. * * @param arg The alljoyn_msgarg that contains the signature * @param index The index value for the individual alljoyn_msgarg * * @return the string representing the signature of the element */ extern AJ_API const char* AJ_CALL alljoyn_msgarg_get_array_elementsignature(const alljoyn_msgarg arg, size_t index); /******************************************************************************* * MsgArg functions for dictionaries *******************************************************************************/ /* * Obtain the alljoyn_msgarg used as the key for a key/value pair in an AllJoyn * dictionary entry. * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * * @param arg An alljoyn_msgarg that contains a single key/value pair dictionary * entry. * * @return an alljoyn_msgarg containing the key portion of a key/value pair */ extern AJ_API alljoyn_msgarg AJ_CALL alljoyn_msgarg_getkey(alljoyn_msgarg arg); /* * Obtain the alljoyn_msgarg used as the value for a key/value pair in an AllJoyn * dictionary entry. * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * * @param arg An alljoyn_msgarg that contains a single key/value pair dictionary * entry. * * @return an alljoyn_msgarg containing the value portion of a key/value pair */ extern AJ_API alljoyn_msgarg AJ_CALL alljoyn_msgarg_getvalue(alljoyn_msgarg arg); /* * Create a key/value pair for an AllJoyn dictionary entry. * * the alljoyn_msgargs used for the key and value will be copied into the arg * and will not be managed by the alljoyn_msgarg arg. * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * * @param arg The alljoyn_msgarg to set with a key/value pair * @param key An alljoyn_msgarg containing the key in a key/value pair * @param value An alljoyn_msgarg containing the value in a key/value pair * * @return #ER_OK */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_setdictentry(alljoyn_msgarg arg, alljoyn_msgarg key, alljoyn_msgarg value); /******************************************************************************* * MsgArg functions for structs *******************************************************************************/ /* * Set the values for an AllJoyn Struct entry. * an AllJoyn struct is passed in as an array of alljoyn_msgargs with each element * representing a member of the struct. * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * * @param arg an alljoyn_msgarg that will hold the values of the struct * @param struct_members an alljoyn_msgarg array that represents a struct * @param num_members the number of members in the struct * * @return #ER_OK */ extern AJ_API QStatus AJ_CALL alljoyn_msgarg_setstruct(alljoyn_msgarg arg, alljoyn_msgarg struct_members, size_t num_members); /* * Obtain the number of members in an AllJoyn struct * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * * @param arg the alljoyn_msgarg containing a struct * * @return the number of members contained in the struct */ extern AJ_API size_t AJ_CALL alljoyn_msgarg_getnummembers(alljoyn_msgarg arg); /* * obtain the member of an AllJoyn struct at the index location * @remark This function exists for development of other language bindings and may * be changed or removed in future updates and should not be used for reading * values from an alljoyn_msgarg. * * @param arg the alljoyn_msgarg containing a struct * @param index the index of the member * * @return the alljoyn_msgarg at the index */ extern AJ_API alljoyn_msgarg AJ_CALL alljoyn_msgarg_getmember(alljoyn_msgarg arg, size_t index); /// @endcond #ifdef __cplusplus } /* extern "C" */ #endif #endif alljoyn-15.04b/alljoyn_c/inc/alljoyn_c/Observer.h000066400000000000000000000265001255700255500220030ustar00rootroot00000000000000/** * @file * The alljoyn_observer takes care of discovery, session management and * alljoyn_proxybusobject creation for bus objects that implement a * specific set of interfaces. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_OBSERVER_C_H #define _ALLJOYN_OBSERVER_C_H #include #include #include #ifdef __cplusplus extern "C" { #endif /* the proxybusobject_ref part */ /** * Data structure holding a reference to an alljoyn_proxybusobject and an * associated reference count. If the reference count reaches zero, both * the proxy bus object and the reference structure get destroyed. */ typedef struct _alljoyn_proxybusobject_ref_handle* alljoyn_proxybusobject_ref; /** * Create a new refcounted proxy bus object reference with initial refcount 1. * * @param proxy The proxy bus object that will be managed by this reference. * * @return the newly created reference * * @note The alljoyn_proxybusobject_ref will take over ownership of the * alljoyn_proxybusobject, and will destroy it when the refcount reaches zero. */ AJ_API alljoyn_proxybusobject_ref AJ_CALL alljoyn_proxybusobject_ref_create(alljoyn_proxybusobject proxy); /** * Get the alljoyn_proxybusobject managed by this reference. * * @param ref the alljoyn_proxybusobject_ref to dereference * * @return the alljoyn_proxybusobject managed by this reference. * * @note This does not increase the refcount of the reference. */ AJ_API alljoyn_proxybusobject AJ_CALL alljoyn_proxybusobject_ref_get(alljoyn_proxybusobject_ref ref); /** * Increase the refcount of the alljoyn_proxybusobject reference. * * @param ref the alljoyn_proxybusobject_ref to dereference */ AJ_API void AJ_CALL alljoyn_proxybusobject_ref_incref(alljoyn_proxybusobject_ref ref); /** * Decrease the refcount of the alljoyn_proxybusobject reference. * * If the refcount reaches zero, both the reference and the proxy bus object it * manages will be destroyed. * * @param ref the alljoyn_proxybusobject_ref to dereference */ AJ_API void AJ_CALL alljoyn_proxybusobject_ref_decref(alljoyn_proxybusobject_ref ref); /* The observerlistener part */ /** * Data structure holding the callbacks to be invoked by the * observer whenever objects of interest are discovered or lost. */ typedef struct _alljoyn_observerlistener_handle* alljoyn_observerlistener; /** * Callback to be invoked when a new object has been discovered. * * @param context the context pointer that was passed into the * alljoyn_observerlistener_create function * @param proxyref a reference to a proxy bus object supporting all interfaces * announced in the About signal. * * @note the proxyref is guaranteed to remain valid throughout the execution of * this callback. If you want to keep it around for longer than that, you * have to manually increase the reference count. */ typedef void (AJ_CALL * alljoyn_observer_object_discovered_ptr)(const void* context, alljoyn_proxybusobject_ref proxyref); /** * Callback to be invoked when a previously discovered object has been lost. * * @param context the context pointer that was passed into the * alljoyn_observerlistener_create function * @param proxyref a reference to the proxy bus object representing the object * that has been lost. * * @note the proxyref is guaranteed to remain valid throughout the execution of * this callback. If you want to keep it around for longer than that, you * have to manually increase the reference count. */ typedef void (AJ_CALL * alljoyn_observer_object_lost_ptr)(const void* context, alljoyn_proxybusobject_ref proxyref); /** * The callbacks used for creation of an alljoyn_observerlistener. */ typedef struct { /** * A new object has been discovered. */ alljoyn_observer_object_discovered_ptr object_discovered; /** * A previously discovered object has been lost. */ alljoyn_observer_object_lost_ptr object_lost; } alljoyn_observerlistener_callback; /** * Allocate a new alljoyn_observerlistener. */ extern AJ_API alljoyn_observerlistener AJ_CALL alljoyn_observerlistener_create(const alljoyn_observerlistener_callback* callback, const void* context); /** * Free an alljoyn_observerlistener. */ extern AJ_API void AJ_CALL alljoyn_observerlistener_destroy(alljoyn_observerlistener listener); /* the observer part */ /** An alljoyn_observer takes care of discovery, session management and * ProxyBusObject creation for bus objects that implement a specific set of * interfaces. * * The Observer monitors About announcements, and automatically sets up * sessions with all peers that offer objects of interest (i.e. objects that * implement at least the set of mandatory interfaces for this Observer). The * Observer creates a proxy bus object for each discovered object. * alljoyn_observerlistener objects are used to inform the application about * the discovery of new objects, and about the disappearance of objects from * the bus. * * Objects are considered lost in the following cases: * - they are un-announced via About * - the hosting peer has closed the session * - the hosting peer stopped responding to Ping requests */ typedef struct _alljoyn_observer_handle* alljoyn_observer; /** * Create a new alljoyn_observer. * * @param bus Bus attachment to which the Observer is attached. * @param mandatoryInterfaces Set of interface names that a bus object * MUST implement to be discoverable by this Observer. * @param numMandatoryInterfaces number of elements in the mandatoryInterfaces array. * * @return the newly created Observer. * * Some things to take into account: * - the Observer will only discover objects that are announced through About. * - the interface names in mandatoryInterfaces must correspond with * InterfaceDescriptions that have been registered with the bus attachment * before creation of the Observer. * - mandatoryInterfaces must not be empty or NULL */ extern AJ_API alljoyn_observer AJ_CALL alljoyn_observer_create(alljoyn_busattachment bus, const char* mandatoryInterfaces[], size_t numMandatoryInterfaces); /** * Destroy an alljoyn_observer. * * @param observer the alljoyn_observer to destroy. */ extern AJ_API void AJ_CALL alljoyn_observer_destroy(alljoyn_observer observer); /** * Register a listener. * * @param observer the observer this call is made for * @param listener the listener to register * @param triggerOnExisting trigger object_discovered callbacks for * already-discovered objects */ extern AJ_API void AJ_CALL alljoyn_observer_registerlistener(alljoyn_observer observer, alljoyn_observerlistener listener, QCC_BOOL triggerOnExisting); /** * Unregister a listener. * * @param observer the observer this call is made for * @param listener the listener to unregister */ extern AJ_API void AJ_CALL alljoyn_observer_unregisterlistener(alljoyn_observer observer, alljoyn_observerlistener listener); /** * Unregister all listeners. * * There is no real need to unregister all listeners before the Observer * is destroyed, but it is considered good style to do so. * * @param observer the observer this call is made for */ extern AJ_API void AJ_CALL alljoyn_observer_unregisteralllisteners(alljoyn_observer observer); /** * Get a reference to a proxy object. * * If the requested object is not tracked by this observer, NULL is returned instead. * The reference that is returned belongs to you. You are responsible for decrementing * its refcount to avoid memory leaks. * * @param observer The observer this call is made for * @param uniqueBusName The unique bus name of the peer hosting the object * you want to retrieve. * @param objectPath The path of the object you want to retrieve. * @return an alljoyn_proxybusobject_ref or NULL */ extern AJ_API alljoyn_proxybusobject_ref AJ_CALL alljoyn_observer_get(alljoyn_observer observer, const char* uniqueBusName, const char* objectPath); /** * Get a reference to the first proxy object. * * The getfirst/getnext pair of functions is useful for iterating over all discovered * objects. The iteration is over when either call returns NULL. * * The reference remains valid until you pass it into alljoyn_observer_getnext. If you * want to keep it around for longer than that, you have to manually increase the reference * count. If you never call alljoyn_observer_getnext with this reference, then it's up to * you to decrement the reference count when you're done with it. * * @param observer the observer this call is made for * @return an alljoyn_proxybusobject_ref or NULL */ extern AJ_API alljoyn_proxybusobject_ref AJ_CALL alljoyn_observer_getfirst(alljoyn_observer observer); /** * Get a reference to the next proxy object. * * The getfirst/getnext pair of functions is useful for iterating over all discovered * objects. The iteration is over when either call returns NULL. * * The reference remains valid until you pass it into alljoyn_observer_getnext. If you * want to keep it around for longer than that, you have to manually increase the reference * count. If you never call alljoyn_observer_getnext with this reference, then it's up to * you to decrement the reference count when you're done with it. * * @param observer the observer this call is made for * @param proxyref This method will return the proxy object immediately following this one * @return an alljoyn_proxybusobject or NULL */ extern AJ_API alljoyn_proxybusobject_ref AJ_CALL alljoyn_observer_getnext(alljoyn_observer observer, alljoyn_proxybusobject_ref proxyref); #ifdef __cplusplus } /* extern "C" */ #endif #endif //_ALLJOYN_OBSERVER_C_H alljoyn-15.04b/alljoyn_c/inc/alljoyn_c/PasswordManager.h000066400000000000000000000041521255700255500233100ustar00rootroot00000000000000/** * @file PasswordManager.h is the top-level object that provides the interface to * set credentials used for the authentication of thin clients. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_C_PASSWORDMANAGER_H #define _ALLJOYN_C_PASSWORDMANAGER_H #include #include #ifdef __cplusplus extern "C" { #endif /** * @brief Set credentials used for the authentication of thin clients. * * @warning Before invoking Connect() to BusAttachment, the application should call SetCredentials * if it expects to be able to communicate to/from thin clients. * The bundled router will start advertising the name as soon as it is started and MUST have * the credentials set to be able to authenticate any thin clients that may try to use the * bundled router to communicate with the app. * @param authMechanism The name of the authentication mechanism issuing the request. * @param password The password. * * @return * - #ER_OK if the credentials was successfully set. */ extern AJ_API QStatus AJ_CALL alljoyn_passwordmanager_setcredentials(const char* authMechanism, const char* password); #ifdef __cplusplus } /* extern "C" */ #endif #endif alljoyn-15.04b/alljoyn_c/inc/alljoyn_c/ProxyBusObject.h000066400000000000000000001252361255700255500231440ustar00rootroot00000000000000/** * @file * This file defines the alljoyn_proxybusobject and related functions. * The alljoyn_proxybusobject represents a single object registered on the bus. * alljoyn_proxybusobjects are used to make method calls on these remotely located DBus objects. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_C_REMOTEBUSOBJECT_H #define _ALLJOYN_C_REMOTEBUSOBJECT_H #include #include #include #include #include #include #ifdef __cplusplus extern "C" { #endif /** * The alljoyn_proxybusobject represents a single object registered on the bus. * alljoyn_proxybusobjects are used to make method calls on these remotely * located AllJoyn objects. */ typedef struct _alljoyn_proxybusobject_handle* alljoyn_proxybusobject; #ifndef _ALLJOYN_OPAQUE_BUSATTACHMENT_ #define _ALLJOYN_OPAQUE_BUSATTACHMENT_ /** * alljoyn_busattachment is the top level object responsible for connecting to and * managing an AllJoyn message bus */ typedef struct _alljoyn_busattachment_handle* alljoyn_busattachment; #endif /** * Callback registered with alljoyn_proxybusobject_introspectremoteobjectasync() * * @param status ER_OK if successful * @param obj Remote bus object that was introspected * @param context Context passed in IntrospectRemoteObjectAsync() */ typedef void (AJ_CALL * alljoyn_proxybusobject_listener_introspectcb_ptr)(QStatus status, alljoyn_proxybusobject obj, void* context); /** * Callback registered with alljoyn_proxybusobject_getpropertyasync() * * @param status - #ER_OK if the property get request was successfull or: * - #ER_BUS_OBJECT_NO_SUCH_INTERFACE if the specified interfaces does not exist on the remote object. * - #ER_BUS_NO_SUCH_PROPERTY if the property does not exist * - Other error status codes indicating the reason the get request failed. * @param obj Remote bus object that was introspected * @param value If status is ER_OK a MsgArg containing the returned property value * @param context Caller provided context passed in to alljoyn_proxybusobject_getpropertyasync() */ typedef void (AJ_CALL * alljoyn_proxybusobject_listener_getpropertycb_ptr)(QStatus status, alljoyn_proxybusobject obj, const alljoyn_msgarg value, void* context); /** * Callback registered with alljoyn_proxybusobject_getallpropertiesasync() * * @param status - #ER_OK if the get all properties request was successfull or: * - #ER_BUS_OBJECT_NO_SUCH_INTERFACE if the specified interfaces does not exist on the remote object. * - Other error status codes indicating the reason the get request failed. * @param obj Remote bus object that was introspected * @param values If status is ER_OK an array of dictionary entries, signature "a{sv}" listing the properties. * @param context Caller provided context passed in to alljoyn_proxybusobject_getallpropertiesasync() */ typedef void (AJ_CALL * alljoyn_proxybusobject_listener_getallpropertiescb_ptr)(QStatus status, alljoyn_proxybusobject obj, const alljoyn_msgarg values, void* context); /** * Callback registered with alljoyn_proxybusobject_setpropertyasync() * * @param status - ER_OK if the property was successfully set or: * - #ER_BUS_OBJECT_NO_SUCH_INTERFACE if the specified interfaces does not exist on the remote object. * - #ER_BUS_NO_SUCH_PROPERTY if the property does not exist * - Other error status codes indicating the reason the set request failed. * @param obj Remote bus object that was introspected * @param context Caller provided context passed in to alljoyn_proxybusobject_setpropertyasync() */ typedef void (AJ_CALL * alljoyn_proxybusobject_listener_setpropertycb_ptr)(QStatus status, alljoyn_proxybusobject obj, void* context); /** * Callback to receive property changed events. * * @param obj Remote bus object that owns the property that changed. * @param ifaceName Name of the interface that defines the property. * @param changed Property values that changed as an array of dictionary entries, signature "a{sv}". * @param invalidated Properties whose values have been invalidated, signature "as". * @param context Caller provided context passed in to RegisterPropertiesChangedListener */ typedef void (AJ_CALL * alljoyn_proxybusobject_listener_propertieschanged_ptr)(alljoyn_proxybusobject obj, const char* ifaceName, const alljoyn_msgarg changed, const alljoyn_msgarg invalidated, void* context); /** * Create an empty proxy bus object that refers to an object at given remote service name. Note * that the created proxy bus object does not contain information about the interfaces that the * actual remote object implements with the exception that org.freedesktop.DBus.Peer * interface is special-cased (per the DBus spec) and can always be called on any object. Nor * does it contain information about the child objects that the actual remote object might * contain. * * To fill in this object with the interfaces and child object names that the actual remote * object describes in its introspection data, call alljoyn_proxybusobject_introspectremoteobject() or * alljoyn_proxybusobject_introspectremoteobjectasync(). * * @param bus The bus. * @param service The remote service name (well-known or unique). * @param path The absolute (non-relative) object path for the remote object. * @param sessionId The session id the be used for communicating with remote object. * * @return the allocated alljoyn_proxybusobject */ extern AJ_API alljoyn_proxybusobject AJ_CALL alljoyn_proxybusobject_create(alljoyn_busattachment bus, const char* service, const char* path, alljoyn_sessionid sessionId); /** * Create an empty proxy bus object that refers to an object at given remote service name. Note * that the created proxy bus object does not contain information about the interfaces that the * actual remote object implements with the exception that org.freedesktop.DBus.Peer * interface is special-cased (per the DBus spec) and can always be called on any object. Nor * does it contain information about the child objects that the actual remote object might * contain. * * proxybusobjects created using this function will require authentication. * Unless the interfaces security policy is AJ_IFC_SECURITY_OFF. * * To fill in this object with the interfaces and child object names that the actual remote * object describes in its introspection data, call alljoyn_proxybusobject_introspectremoteobject() or * alljoyn_proxybusobject_introspectremoteobjectasync(). * * @param bus The bus. * @param service The remote service name (well-known or unique). * @param path The absolute (non-relative) object path for the remote object. * @param sessionId The session id the be used for communicating with remote object. * * @return the allocated alljoyn_proxybusobject */ extern AJ_API alljoyn_proxybusobject AJ_CALL alljoyn_proxybusobject_create_secure(alljoyn_busattachment bus, const char* service, const char* path, alljoyn_sessionid sessionId); /** * Destroy a proxy object created using alljoyn_proxybusobject_create. * * @param proxyObj The proxy bus object to destroy. */ extern AJ_API void AJ_CALL alljoyn_proxybusobject_destroy(alljoyn_proxybusobject proxyObj); /** * Add an interface to this alljoyn_proxybusobject. * * Occasionally, AllJoyn library user may wish to call a method on * an %alljoyn_proxybusobject that was not reported during introspection of the remote object. * When this happens, the InterfaceDescription will have to be registered with the * Bus manually and the interface will have to be added to the %alljoyn_proxybusobject using this function. * @remark * The interface added via this call must have been previously registered with the * Bus. (i.e. it must have come from a call to alljoyn_busattachment_getinterface). * * @param proxyObj The proxy bus object onto which the interface is to be added. * @param iface The interface to add to this object. Must come from alljoyn_busattachment_getinterface. * @return * - #ER_OK if successful. * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_proxybusobject_addinterface(alljoyn_proxybusobject proxyObj, const alljoyn_interfacedescription iface); /** * Add an existing interface to this object using the interface's name. * * @param proxyObj The proxy bus object onto which the interface is to be added. * @param name Name of existing interface to add to this object. * @return * - #ER_OK if successful. * - An error status otherwise. */ extern AJ_API QStatus AJ_CALL alljoyn_proxybusobject_addinterface_by_name(alljoyn_proxybusobject proxyObj, const char* name); /** * Returns an array of alljoyn_proxybusobjects for the children of this %alljoyn_proxybusobject. * * @param proxyObj The proxybus object we are getting the children from * @param children An %alljoyn_proxybusobject array to receive the children. Can be NULL in * which case no children are returned and the return value gives the number * of children available. * @param numChildren The size of the %alljoyn_proxybusobject array. If this value is smaller than the total * number of children only numChildren will be returned. * * @return The number of children returned or the total number of children if children is NULL. */ extern AJ_API size_t AJ_CALL alljoyn_proxybusobject_getchildren(alljoyn_proxybusobject proxyObj, alljoyn_proxybusobject* children, size_t numChildren); /** * Get a path descendant alljoyn_proxybusobject (child) by its relative path name. * * For example, if this alljoyn_proxybusobject's path is @c "/foo/bar", then you can * retrieve the alljoyn_proxybusobject for @c "/foo/bar/bat/baz" by calling * @c GetChild("bat/baz") * * @param proxyObj The proxybus object we are getting the descendant from * @param path The relative path for the child. * * @return * - The (potentially deep) descendant alljoyn_proxybusobject * - NULL if not found. */ extern AJ_API alljoyn_proxybusobject AJ_CALL alljoyn_proxybusobject_getchild(alljoyn_proxybusobject proxyObj, const char* path); /** * Add a child object (direct or deep object path descendant) to this object. * If you add a deep path descendant, this function will create intermediate * alljoyn_proxybusobject children as needed. * * @remark * - It is an error to try to add a child that already exists. * - It is an error to try to add a child that has an object path that is not a descendant of this object's path. * * @param proxyObj The proxy bus object onto which the child object is to be added * @param child Child alljoyn_proxybusobject * * @return * - #ER_OK if successful. * - #ER_BUS_BAD_CHILD_PATH if the path is a bad path * - #ER_BUS_OBJ_ALREADY_EXISTS the object already exists on the alljoyn_proxybusobject */ extern AJ_API QStatus AJ_CALL alljoyn_proxybusobject_addchild(alljoyn_proxybusobject proxyObj, const alljoyn_proxybusobject child); /** * Remove a child object and any descendants it may have. * * @param proxyObj The proxy bus object off of which the child object is to be removed * @param path Absolute or relative (to this alljoyn_proxybusobject) object path. * * @return * - #ER_OK if successful. * - #ER_BUS_BAD_CHILD_PATH if the path given was not a valid path * - #ER_BUS_OBJ_NOT_FOUND if the Child object was not found * - #ER_FAIL any other unexpected error. */ extern AJ_API QStatus AJ_CALL alljoyn_proxybusobject_removechild(alljoyn_proxybusobject proxyObj, const char* path); /** * Query the remote object on the bus to determine the interfaces and * children that exist. Use this information to populate this proxy's * interfaces and children. * * This call causes messages to be send on the bus, therefore it cannot * be called within AllJoyn callbacks (method/signal/reply handlers or * ObjectRegistered callbacks, etc.) * * @param proxyObj The proxy bus object that will query the remote object. * * @return * - #ER_OK if successful * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_proxybusobject_introspectremoteobject(alljoyn_proxybusobject proxyObj); /** * Query the remote object on the bus to determine the interfaces and * children that exist. Use this information to populate this object's * interfaces and children. * * This call executes asynchronously. When the introspection response * is received from the actual remote object, this alljoyn_proxybusobject will * be updated and the callback will be called. * * This call exists primarily to allow introspection of remote objects * to be done inside AllJoyn method/signal/reply handlers and ObjectRegistered * callbacks. * * @param proxyObj The proxy bus object that will query the remote object. * @param callback Method on listener that will be called. * @param context User defined context which will be passed as-is to callback. * @return * - #ER_OK if successful. * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_proxybusobject_introspectremoteobjectasync(alljoyn_proxybusobject proxyObj, alljoyn_proxybusobject_listener_introspectcb_ptr callback, void* context); /** * Get a property from an interface on the remote object. * * @param proxyObj The proxy bus object the property will be read from * @param iface Name of interface to retrieve property from. * @param property The name of the property to get. * @param[out] value Property value. * * @return * - #ER_OK if the property was obtained. * - #ER_BUS_OBJECT_NO_SUCH_INTERFACE if the no such interface on this remote object. * - #ER_BUS_NO_SUCH_PROPERTY if the property does not exist */ extern AJ_API QStatus AJ_CALL alljoyn_proxybusobject_getproperty(alljoyn_proxybusobject proxyObj, const char* iface, const char* property, alljoyn_msgarg value); /** * Make an asynchronous request to get a property from an interface on the remote object. * The property value is passed to the callback function. * * @param proxyObj The proxy bus object the property will be read from * @param iface Name of interface to retrieve property from. * @param property The name of the property to get. * @param callback Function that will be called when the getproperty operation is completed. * @param timeout Timeout specified in milliseconds to wait for a reply. * Recommended default #ALLJOYN_MESSAGE_DEFAULT_TIMEOUT which is 25000 ms. * @param context User defined context which will be passed as-is to callback. * * @return * - #ER_OK if the request to get the property was successfully issued . * - #ER_BUS_OBJECT_NO_SUCH_INTERFACE if the no such interface on this remote object. * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_proxybusobject_getpropertyasync(alljoyn_proxybusobject proxyObj, const char* iface, const char* property, alljoyn_proxybusobject_listener_getpropertycb_ptr callback, uint32_t timeout, void* context); /** * Get all properties from an interface on the remote object. * * @param proxyObj The proxy bus object the properties will be read from * @param iface Name of interface to retrieve all properties from. * @param[out] values Property values returned as an array of dictionary entries, signature "a{sv}". * * @return * - #ER_OK if the property was obtained. * - #ER_BUS_OBJECT_NO_SUCH_INTERFACE if the no such interface on this remote object. * - #ER_BUS_NO_SUCH_PROPERTY if the property does not exist */ extern AJ_API QStatus AJ_CALL alljoyn_proxybusobject_getallproperties(alljoyn_proxybusobject proxyObj, const char* iface, alljoyn_msgarg values); /** * Make an asynchronous request to get all properties from an interface on the remote object. * * @param proxyObj The proxy bus object the properties will be read from * @param iface Name of interface to retrieve properties from. * @param callback Function that will be called when the getallproperties operation is completed. * @param timeout Timeout specified in milliseconds to wait for a reply * Recommended default #ALLJOYN_MESSAGE_DEFAULT_TIMEOUT which is 25000 ms. * @param context User defined context which will be passed as-is to callback. * * @return * - #ER_OK if the request to get all properties was successfully issued . * - #ER_BUS_OBJECT_NO_SUCH_INTERFACE if the no such interface on this remote object. * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_proxybusobject_getallpropertiesasync(alljoyn_proxybusobject proxyObj, const char* iface, alljoyn_proxybusobject_listener_getallpropertiescb_ptr callback, uint32_t timeout, void* context); /** * Set a property on an interface on the remote object. * * @param proxyObj The proxy bus object the property will be set on * @param iface Interface that holds the property * @param property The name of the property to set * @param value The value to set * * @return * - #ER_OK if the property was set * - #ER_BUS_OBJECT_NO_SUCH_INTERFACE if the no such interface on this remote object. * - #ER_BUS_NO_SUCH_PROPERTY if the property does not exist */ extern AJ_API QStatus AJ_CALL alljoyn_proxybusobject_setproperty(alljoyn_proxybusobject proxyObj, const char* iface, const char* property, alljoyn_msgarg value); /** * Function to register a handler for property change events. * * @param proxyObj The proxy bus object that will register the property changed * listener * @param iface Remote object's interface on which the property is defined. * @param properties List of names of properties to monitor. * @param numProperties Number of properties to monitor. * @param callback Method on listener that will be called. * @param context User defined context which will be passed as-is to callback. * * @return * - #ER_OK if the handler was registered successfully * - #ER_BUS_OBJECT_NO_SUCH_INTERFACE if the specified interfaces does not * exist on the remote object. * - #ER_BUS_NO_SUCH_PROPERTY if the property does not exist */ extern AJ_API QStatus AJ_CALL alljoyn_proxybusobject_registerpropertieschangedlistener(alljoyn_proxybusobject proxyObj, const char* iface, const char** properties, size_t numProperties, alljoyn_proxybusobject_listener_propertieschanged_ptr callback, void* context); /** * Function to unregister a handler for property change events. * * @param proxyObj The proxy bus object that will register the property changed listener. * @param iface Remote object's interface on which the properties are defined. * @param callback Method on listener that used to be called. * * @return * - #ER_OK if the handler was unregistered successfully * - #ER_BUS_OBJECT_NO_SUCH_INTERFACE if the specified interfaces does not exist on the remote object. */ extern AJ_API QStatus AJ_CALL alljoyn_proxybusobject_unregisterpropertieschangedlistener(alljoyn_proxybusobject proxyObj, const char* iface, alljoyn_proxybusobject_listener_propertieschanged_ptr callback); /** * Make an asynchronous request to set a property on an interface on the remote object. * A callback function reports the success or failure of there operation. * * @param proxyObj The proxy bus object the property will be set o * @param iface Remote object's interface on which the property is defined. * @param property The name of the property to set. * @param value The value to set * @param callback Function that will be called when the setproperty operation is completed. * @param timeout Timeout specified in milliseconds to wait for a reply * Recommended default #ALLJOYN_MESSAGE_DEFAULT_TIMEOUT which is 25000 ms. * @param context User defined context which will be passed as-is to callback. * * @return * - #ER_OK if the request to set the property was successfully issued . * - #ER_BUS_OBJECT_NO_SUCH_INTERFACE if the specified interfaces does not exist on the remote object. * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_proxybusobject_setpropertyasync(alljoyn_proxybusobject proxyObj, const char* iface, const char* property, alljoyn_msgarg value, alljoyn_proxybusobject_listener_setpropertycb_ptr callback, uint32_t timeout, void* context); /** * Make a synchronous method call * * @param proxyObj alljoyn_proxybusobject on which to call the method. * @param ifaceName Name of interface. * @param methodName Name of method. * @param args The arguments for the method call (can be NULL) * @param numArgs The number of arguments * @param replyMsg The reply message received for the method call * @param timeout Timeout specified in milliseconds to wait for a reply * @param flags Logical OR of the message flags for this method call. The following flags apply to method calls: * - If #ALLJOYN_MESSAGE_FLAG_ENCRYPTED is set the message is authenticated and the payload if any is encrypted. * - If #ALLJOYN_MESSAGE_FLAG_AUTO_START is set the bus will attempt to start a service if it is not running. * * @return * - #ER_OK if the method call succeeded and the reply message type is #ALLJOYN_MESSAGE_METHOD_RET * - #ER_BUS_REPLY_IS_ERROR_MESSAGE if the reply message type is #ALLJOYN_MESSAGE_ERROR */ extern AJ_API QStatus AJ_CALL alljoyn_proxybusobject_methodcall(alljoyn_proxybusobject proxyObj, const char* ifaceName, const char* methodName, const alljoyn_msgarg args, size_t numArgs, alljoyn_message replyMsg, uint32_t timeout, uint8_t flags); /** * Make a synchronous method call from this object * * @param proxyObj alljoyn_proxybusobject on which to call the method. * @param method The alljoyn_interfacedescription_member specifying the method being invoked. * @param args The arguments for the method call (can be NULL) * @param numArgs The number of arguments * @param replyMsg The reply message received for the method call * @param timeout Timeout specified in milliseconds to wait for a reply. * Recommended default #ALLJOYN_MESSAGE_DEFAULT_TIMEOUT which is 25000 ms. * @param flags Logical OR of the message flags for this method call. The following flags apply to method calls: * - If #ALLJOYN_MESSAGE_FLAG_ENCRYPTED is set the message is authenticated and the payload if any is encrypted. * - If #ALLJOYN_MESSAGE_FLAG_AUTO_START is set the bus will attempt to start a service if it is not running. * Set value to '0' for no flags. * * * @return * - #ER_OK if the method call succeeded and the reply message type is #ALLJOYN_MESSAGE_METHOD_RET * - #ER_BUS_REPLY_IS_ERROR_MESSAGE if the reply message type is #ALLJOYN_MESSAGE_ERROR */ extern AJ_API QStatus AJ_CALL alljoyn_proxybusobject_methodcall_member(alljoyn_proxybusobject proxyObj, const alljoyn_interfacedescription_member method, const alljoyn_msgarg args, size_t numArgs, alljoyn_message replyMsg, uint32_t timeout, uint8_t flags); /** * Make a fire-and-forget method call from this object. The caller will not be able to tell if * the method call was successful or not. This is equivalent to calling MethodCall() with * flags == ALLJOYN_FLAG_NO_REPLY_EXPECTED. Because this call doesn't block it can be made from * within a signal handler. * * @param proxyObj alljoyn_proxybusobject on which to call the method. * @param ifaceName Name of interface. * @param methodName Name of method. * @param args The arguments for the method call (can be NULL) * @param numArgs The number of arguments * @param flags Logical OR of the message flags for this method call. The following flags apply to method calls: * - If #ALLJOYN_MESSAGE_FLAG_ENCRYPTED is set the message is authenticated and the payload if any is encrypted. * - If #ALLJOYN_MESSAGE_FLAG_AUTO_START is set the bus will attempt to start a service if it is not running. * Set value to '0' for no flags. * * @return * - #ER_OK if the method call succeeded */ extern AJ_API QStatus AJ_CALL alljoyn_proxybusobject_methodcall_noreply(alljoyn_proxybusobject proxyObj, const char* ifaceName, const char* methodName, const alljoyn_msgarg args, size_t numArgs, uint8_t flags); /** * Make a fire-and-forget method call from this object. The caller will not be able to tell if * the method call was successful or not. This is equivalent to calling MethodCall() with * flags == ALLJOYN_FLAG_NO_REPLY_EXPECTED. Because this call doesn't block it can be made from * within a signal handler. * * @param proxyObj alljoyn_proxybusobject on which to call the method. * @param method Method being invoked. * @param args The arguments for the method call (can be NULL) * @param numArgs The number of arguments * @param flags Logical OR of the message flags for this method call. The following flags apply to method calls: * - If #ALLJOYN_MESSAGE_FLAG_ENCRYPTED is set the message is authenticated and the payload if any is encrypted. * - If #ALLJOYN_MESSAGE_FLAG_AUTO_START is set the bus will attempt to start a service if it is not running. * Set value to '0' for no flags. * * @return * - #ER_OK if the method call succeeded */ extern AJ_API QStatus AJ_CALL alljoyn_proxybusobject_methodcall_member_noreply(alljoyn_proxybusobject proxyObj, const alljoyn_interfacedescription_member method, const alljoyn_msgarg args, size_t numArgs, uint8_t flags); /** * Make an asynchronous method call from this object * * @param proxyObj alljoyn_proxybusobject on which to call the method * @param ifaceName Name of interface for method. * @param methodName Name of method. * @param replyFunc The function that is called to deliver the reply * @param args The arguments for the method call (can be NULL) * @param numArgs The number of arguments (can be 0) * @param context User-defined context that will be returned to the reply handler * Recommended default NULL. * @param timeout Timeout specified in milliseconds to wait for a reply * Recommended default #ALLJOYN_MESSAGE_DEFAULT_TIMEOUT which is 25000 ms * @param flags Logical OR of the message flags for this method call. The following flags apply to method calls: * - If #ALLJOYN_MESSAGE_FLAG_ENCRYPTED is set the message is authenticated and the payload if any is encrypted. * - If #ALLJOYN_MESSAGE_FLAG_AUTO_START is set the bus will attempt to start a service if it is not running. * Set value to '0' for no flags. * @return * - ER_OK if successful * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_proxybusobject_methodcallasync(alljoyn_proxybusobject proxyObj, const char* ifaceName, const char* methodName, alljoyn_messagereceiver_replyhandler_ptr replyFunc, const alljoyn_msgarg args, size_t numArgs, void* context, uint32_t timeout, uint8_t flags); /** * Make an asynchronous method call from this object * * @param proxyObj alljoyn_proxybusobject on which to call the method * @param method Method being invoked. * @param replyFunc The function that is called to deliver the reply * @param args The arguments for the method call (can be NULL) * @param numArgs The number of arguments (can be 0) * @param context User-defined context that will be returned to the reply handler * Recommended default NULL. * @param timeout Timeout specified in milliseconds to wait for a reply * Recommended default #ALLJOYN_MESSAGE_DEFAULT_TIMEOUT which is 25000 ms * @param flags Logical OR of the message flags for this method call. The following flags apply to method calls: * - If #ALLJOYN_MESSAGE_FLAG_ENCRYPTED is set the message is authenticated and the payload if any is encrypted. * - If #ALLJOYN_MESSAGE_FLAG_AUTO_START is set the bus will attempt to start a service if it is not running. * Set value to '0' for no flags. * @return * - ER_OK if successful * - An error status otherwise */ extern AJ_API QStatus AJ_CALL alljoyn_proxybusobject_methodcallasync_member(alljoyn_proxybusobject proxyObj, const alljoyn_interfacedescription_member method, alljoyn_messagereceiver_replyhandler_ptr replyFunc, const alljoyn_msgarg args, size_t numArgs, void* context, uint32_t timeout, uint8_t flags); /** * Initialize this proxy object from an XML string. Calling this function does several things: * * -# Create and register any new InterfaceDescription(s) that are mentioned in the XML. * (Interfaces that are already registered with the bus are left "as-is".) * -# Add all the interfaces mentioned in the introspection data to this alljoyn_proxybusobject. * -# Recursively create any child alljoyn_proxybusobject(s) and create/add their associated @n * interfaces as mentioned in the XML. Then add the descendant object(s) to the appropriate * descendant of this alljoyn_proxybusobject (in the children collection). If the named * child object already exists as a child of the appropriate alljoyn_proxybusobject, then it is * updated to include any new interfaces or children mentioned in the XML. * * Note that when this function fails during parsing, the return code will be set accordingly. * However, any interfaces which were successfully parsed prior to the failure * may be registered with the bus. Similarly, any objects that were successfully created * before the failure will exist in this object's set of children. * * @param proxyObj alljoyn_proxybusobject which will be initialized from the XML string * @param xml An XML string in DBus introspection format. * @param identifier An optional identifying string to include in error logging messages. * * @return * - #ER_OK if parsing is completely successful. * - An error status otherwise. */ extern AJ_API QStatus AJ_CALL alljoyn_proxybusobject_parsexml(alljoyn_proxybusobject proxyObj, const char* xml, const char* identifier); /** * Explicitly secure the connection to the remote peer for this proxy object. Peer-to-peer * connections can only be secured if EnablePeerSecurity() was previously called on the bus * attachment for this proxy object. If the peer-to-peer connection is already secure this * function does nothing. Note that peer-to-peer connections are automatically secured when a * method call or signal requiring encryption is sent or received. * * This call causes messages to be sent on the bus, therefore it cannot be called within AllJoyn * callbacks (method/signal/reply handlers or ObjectRegistered callbacks, etc.) * * @param proxyObj alljoyn_proxybusobject to explicitly set up a secure a connection * @param forceAuth If true, forces an re-authentication even if the peer connection is already * authenticated. * Recommended default QCC_FALSE * * @return * - #ER_OK if the connection was secured or an error status indicating that the * connection could not be secured. * - #ER_BUS_NO_AUTHENTICATION_MECHANISM if alljoyn_busattachment_enablepeersecurity() * has not been called. * - #ER_AUTH_FAIL if the attempt(s) to authenticate the peer failed. * - Other error status codes indicating a failure. */ extern AJ_API QStatus AJ_CALL alljoyn_proxybusobject_secureconnection(alljoyn_proxybusobject proxyObj, QCC_BOOL forceAuth); /** * Asynchronously secure the connection to the remote peer for this proxy object. * Peer-to-peer connections can only be secured if alljoyn_busattachment_enablepeersecurity() * was previously called on the bus attachment for this proxy object. If the peer-to-peer * connection is already secure this function does nothing. Note that peer-to-peer * connections are automatically secured when a method call or signal requiring * encryption is sent or received. * * Notification of success or failure is via the AuthListener passed to * alljoyn_busattachment_enablepeersecurity(). * * @param proxyObj alljoyn_proxybusobject to explicitly set up a secure a connection * @param forceAuth If true, forces an re-authentication even if the peer connection is already * authenticated. * Recommended default QCC_FALSE * * @return * - #ER_OK if securing could begin. * - #ER_BUS_NO_AUTHENTICATION_MECHANISM if alljoyn_busattachment_enablepeersecurity() has not been called. * - Other error status codes indicating a failure. */ extern AJ_API QStatus AJ_CALL alljoyn_proxybusobject_secureconnectionasync(alljoyn_proxybusobject proxyObj, QCC_BOOL forceAuth); /** * Returns a pointer to an interface description. Returns NULL if the object does not implement * the requested interface. * * @param proxyObj The proxy bus object to obtain an interface description from. * @param iface The name of interface to get. * * @return * - A pointer to the requested interface description. * - NULL if requested interface is not implemented or not found */ extern AJ_API const alljoyn_interfacedescription AJ_CALL alljoyn_proxybusobject_getinterface(alljoyn_proxybusobject proxyObj, const char* iface); /** * Returns the interfaces implemented by this object. Note that all proxy bus objects * automatically inherit the "org.freedesktop.DBus.Peer" which provides the built-in "ping" * method, so this method always returns at least that one interface. * * @param proxyObj The proxy bus object to obtain an interface descriptions from. * @param ifaces A pointer to an InterfaceDescription array to receive the interfaces. Can be NULL in * which case no interfaces are returned and the return value gives the number * of interfaces available. * @param numIfaces The size of the InterfaceDescription array. If this value is smaller than the total * number of interfaces only numIfaces will be returned. * (DEFAULT) if numInterfaces is 0 then an array of all the interfaces will be returned. * * @return The number of interfaces returned or the total number of interfaces if ifaces is NULL. */ extern AJ_API size_t AJ_CALL alljoyn_proxybusobject_getinterfaces(alljoyn_proxybusobject proxyObj, const alljoyn_interfacedescription* ifaces, size_t numIfaces); /** * Return the absolute object path for the remote object. * * @param proxyObj the proxy bus object to read the object path from. * * @return Object path */ extern AJ_API const char* AJ_CALL alljoyn_proxybusobject_getpath(alljoyn_proxybusobject proxyObj); /** * Return the remote service name for this object. * * @param proxyObj the proxy bus object to read the service name (Bus Name) path from. * * @return Service name (typically a well-known service name but may be a unique name) */ extern AJ_API const char* AJ_CALL alljoyn_proxybusobject_getservicename(alljoyn_proxybusobject proxyObj); /** * Return the remote unique name for this object. * * @param proxyObj the proxy bus object to read the unique name (Bus Name) path from. * * @return Unique name */ extern AJ_API const char* AJ_CALL alljoyn_proxybusobject_getuniquename(alljoyn_proxybusobject proxyObj); /** * Return the session Id for this object. * * @param proxyObj the proxy bus object we wish to obtain the session ID from. * @return Session Id */ extern AJ_API alljoyn_sessionid AJ_CALL alljoyn_proxybusobject_getsessionid(alljoyn_proxybusobject proxyObj); /** * Tests if this object implements the requested interface. * * @param proxyObj the proxy bus object we wish check for the interface * @param iface The interface to check * * @return true if the object implements the requested interface */ extern AJ_API QCC_BOOL AJ_CALL alljoyn_proxybusobject_implementsinterface(alljoyn_proxybusobject proxyObj, const char* iface); /** * create a copy of a proxybusobject. This will create a new alljoyn_proxybusobject and * must be cleaned up using alljoyn_proxybusobject_destroy. * * @param source the alljoyn_proxybusobject to be copied * * @return copy of the alljoyn_proxybusobject argument is returned */ extern AJ_API alljoyn_proxybusobject AJ_CALL alljoyn_proxybusobject_copy(const alljoyn_proxybusobject source); /** * Indicates if this is a valid (usable) proxy bus object. * * @param proxyObj The alljoyn_proxybusobject to be checked for usability * * @return true if a valid proxy bus object, false otherwise. */ extern AJ_API QCC_BOOL AJ_CALL alljoyn_proxybusobject_isvalid(alljoyn_proxybusobject proxyObj); /** * Indicates if the remote object for this proxy bus object is secure. * * @param proxyObj The alljoyn_proxybusobject to be checked for usability * * @return true if the object is secure */ extern AJ_API QCC_BOOL AJ_CALL alljoyn_proxybusobject_issecure(alljoyn_proxybusobject proxyObj); /** * Enable property caching for this proxy bus object. * * @param proxyObj The alljoyn_proxybusobject for which caching must be enabled */ extern AJ_API void AJ_CALL alljoyn_proxybusobject_enablepropertycaching(alljoyn_proxybusobject proxyObj); #ifdef __cplusplus } /* extern "C" */ #endif #endif alljoyn-15.04b/alljoyn_c/inc/alljoyn_c/Session.h000066400000000000000000000156111255700255500216400ustar00rootroot00000000000000/** * @file * AllJoyn session related data types. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_C_SESSION_H #define _ALLJOYN_C_SESSION_H #include #include #ifdef __cplusplus extern "C" { #endif /** * alljoyn_sessionopts contains a set of parameters that define a Session's characteristics. */ typedef struct _alljoyn_sessionopts_handle* alljoyn_sessionopts; /** * alljoyn_sessionport identifies a per-alljoyn_busattachment receiver for incoming * JoinSession requests. * * alljoyn_sessionport values are bound to an alljoyn_busattachment when the attachment calls * alljoyn_busattachment_bindsessionport. * * NOTE: Valid alljoyn_sessionport values range from 1 to 0xFFFF. */ typedef uint16_t alljoyn_sessionport; /** Invalid SessionPort value used to indicate that BindSessionPort should choose any available port */ #define ALLJOYN_SESSION_PORT_ANY (alljoyn_sessionport)0 /** SessionId uniquely identifies an AllJoyn session instance */ typedef uint32_t alljoyn_sessionid; /** Invalid session id value used to indicate that a signal should be emitted on all hosted sessions */ #define ALLJOYN_SESSION_ID_ALL_HOSTED ((alljoyn_sessionid)(-1)) /** @name TrafficType */ // {@ #define ALLJOYN_TRAFFIC_TYPE_MESSAGES 0x01 /**< Session carries message traffic */ #define ALLJOYN_TRAFFIC_TYPE_RAW_UNRELIABLE 0x02 /**< Session carries an unreliable (lossy) byte stream */ #define ALLJOYN_TRAFFIC_TYPE_RAW_RELIABLE 0x04 /**< Session carries a reliable byte stream */ // @} /** @name Proximity */ // {@ #define ALLJOYN_PROXIMITY_ANY 0xFF /**< Accept any proximity options */ #define ALLJOYN_PROXIMITY_PHYSICAL 0x01 /**< Limit the session to the same physical device */ #define ALLJOYN_PROXIMITY_NETWORK 0x02 /**< Limit the session to network proximity */ // @} /** * Construct an alljoyn_sessionopts with specific parameters. * * @param traffic Type of traffic. * @param isMultipoint true iff session supports multipoint (greater than two endpoints). * @param proximity Proximity constraint bitmask. * @param transports Allowed transport types bitmask. * * @return the allocated alljoyn_sessionopts */ extern AJ_API alljoyn_sessionopts AJ_CALL alljoyn_sessionopts_create(uint8_t traffic, QCC_BOOL isMultipoint, uint8_t proximity, alljoyn_transportmask transports); /** * Destroy an alljoyn_sessionopts created with alljoyn_sessionopts_create. * * @param opts alljoyn_sessionopts to destroy */ extern AJ_API void AJ_CALL alljoyn_sessionopts_destroy(alljoyn_sessionopts opts); /** * Get accessor for the traffic member of alljoyn_sessionopts. * * @param opts alljoyn_sessionopts * * @return Traffic type specified by the specified alljoyn_sessionopts. */ extern AJ_API uint8_t AJ_CALL alljoyn_sessionopts_get_traffic(const alljoyn_sessionopts opts); /** * Set accessor for the traffic member of alljoyn_sessionopts. * * @param opts alljoyn_sessionopts * @param traffic Traffic type to set in the alljoyn_sessionopts. */ extern AJ_API void AJ_CALL alljoyn_sessionopts_set_traffic(alljoyn_sessionopts opts, uint8_t traffic); /** * Get accessor for the isMultipoint member of alljoyn_sessionopts. * * @param opts alljoyn_sessionopts * * @return Multipoint value specified by the specified alljoyn_sessionopts. */ extern AJ_API QCC_BOOL AJ_CALL alljoyn_sessionopts_get_multipoint(const alljoyn_sessionopts opts); /** * Set accessor for the isMultipoint member of alljoyn_sessionopts. * * @param opts alljoyn_sessionopts * @param isMultipoint Multipoint value to set in the alljoyn_sessionopts. */ extern AJ_API void AJ_CALL alljoyn_sessionopts_set_multipoint(alljoyn_sessionopts opts, QCC_BOOL isMultipoint); /** * Get accessor for the proximity member of alljoyn_sessionopts. * * @param opts alljoyn_sessionopts * * @return Proximity specified by the specified alljoyn_sessionopts. */ extern AJ_API uint8_t AJ_CALL alljoyn_sessionopts_get_proximity(const alljoyn_sessionopts opts); /** * Set accessor for the proximity member of alljoyn_sessionopts. * * @param opts alljoyn_sessionopts * @param proximity Proximity value to set in the alljoyn_sessionopts. */ extern AJ_API void AJ_CALL alljoyn_sessionopts_set_proximity(alljoyn_sessionopts opts, uint8_t proximity); /** * Get accessor for the transports member of alljoyn_sessionopts. * * @param opts alljoyn_sessionopts * * @return Transports allowed by the specified alljoyn_sessionopts. */ extern AJ_API alljoyn_transportmask AJ_CALL alljoyn_sessionopts_get_transports(const alljoyn_sessionopts opts); /** * Set accessor for the transports member of alljoyn_sessionopts. * * @param opts alljoyn_sessionopts * @param transports change the transports allowed by the specified alljoyn_sessionopts. */ extern AJ_API void AJ_CALL alljoyn_sessionopts_set_transports(alljoyn_sessionopts opts, alljoyn_transportmask transports); /** * Determine whether one alljoyn_sessionopts is compatible with the alljoyn_sessionopts * offered by other * * Compatibility means that the alljoyn_sessionopts share at least one of each * - transport type * - traffic type * - proximity type * * Note that multipoint support is not a condition of compatibility * * @param one Options to be compared against other. * @param other Options to be compared against one. * @return QCC_TRUE iff this alljoyn_sessionopts can use the option set offered by other. */ extern AJ_API QCC_BOOL AJ_CALL alljoyn_sessionopts_iscompatible(const alljoyn_sessionopts one, const alljoyn_sessionopts other); /** * Compare two alljoyn_sessionopts. * * @param one Options to be compared against other. * @param other Options to be compared against one. * @return 0 if the alljoyn_sessionopts are equal, 1 if one > other, -1 if one < other. */ extern AJ_API int32_t AJ_CALL alljoyn_sessionopts_cmp(const alljoyn_sessionopts one, const alljoyn_sessionopts other); #ifdef __cplusplus } /* extern "C" */ #endif #endif alljoyn-15.04b/alljoyn_c/inc/alljoyn_c/SessionListener.h000066400000000000000000000123711255700255500233460ustar00rootroot00000000000000/** * @file * alljoyn_sessionlistener is an collection of callback functions implemented by * users of the AllJoyn API in order to receive sessions related event information. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_C_SESSIONLISTENER_H #define _ALLJOYN_C_SESSIONLISTENER_H #include #include #ifdef __cplusplus extern "C" { #endif /** Reason for the session being lost */ typedef enum { ALLJOYN_SESSIONLOST_INVALID = 0x00, /**< Invalid */ ALLJOYN_SESSIONLOST_REMOTE_END_LEFT_SESSION = 0x01, /**< Remote end called LeaveSession */ ALLJOYN_SESSIONLOST_REMOTE_END_CLOSED_ABRUPTLY = 0x02, /**< Remote end closed abruptly */ ALLJOYN_SESSIONLOST_REMOVED_BY_BINDER = 0x03, /**< Session binder removed this endpoint by calling RemoveSessionMember */ ALLJOYN_SESSIONLOST_LINK_TIMEOUT = 0x04, /**< Link was timed-out */ ALLJOYN_SESSIONLOST_REASON_OTHER = 0x05 /**< Unspecified reason for session loss */ } alljoyn_sessionlostreason; /** * alljoyn_sessionlistener contains callback functions implemented by AllJoyn users * and called by AllJoyn to inform users of session related events. */ typedef struct _alljoyn_sessionlistener_handle* alljoyn_sessionlistener; /** * Type for the SesionLost callback. * * Called by the bus when an existing session becomes disconnected. * * @param context context pointer that was passed into the alljoyn_sessionlistener_create function * @param alljoyn_sessionid Id of session that was lost. * @param reason The reason for the session being lost */ typedef void (AJ_CALL * alljoyn_sessionlistener_sessionlost_ptr)(const void* context, alljoyn_sessionid sessionId, alljoyn_sessionlostreason reason); /** * Type for the SessionMemberAdded callback. * * Called by the bus when a member of a multipoint session is added. * * @param context context pointer that was passed into the alljoyn_sessionlistener_create function * @param alljoyn_sessionid Id of session whose member(s) changed. * @param uniqueName Unique name of member who was added. */ typedef void (AJ_CALL * alljoyn_sessionlistener_sessionmemberadded_ptr)(const void* context, alljoyn_sessionid sessionId, const char* uniqueName); /** * Type for the SessionMemberRemoved callback. * * Called by the bus when a member of a multipoint session is removed. * * @param context context pointer that was passed into the alljoyn_sessionlistener_create function * @param alljoyn_sessionid Id of session whose member(s) changed. * @param uniqueName Unique name of member who was removed. */ typedef void (AJ_CALL * alljoyn_sessionlistener_sessionmemberremoved_ptr)(const void* context, alljoyn_sessionid sessionId, const char* uniqueName); /** * Structure used during alljoyn_sessionlistener_create to provide callbacks into C. */ typedef struct { /** * Called by the bus when an existing session becomes disconnected. */ alljoyn_sessionlistener_sessionlost_ptr session_lost; /** * Called by the bus when a member of a multipoint session is added. */ alljoyn_sessionlistener_sessionmemberadded_ptr session_member_added; /** * Called by the bus when a member of a multipoint session is removed. */ alljoyn_sessionlistener_sessionmemberremoved_ptr session_member_removed; } alljoyn_sessionlistener_callbacks; /** * Create an alljoyn_sessionlistener which will trigger the provided callbacks, * passing along the provided context. * * @param callbacks Callbacks to trigger for associated events. * @param context Context to pass to callback functions * * @return Handle to newly allocated alljoyn_sessionlistener. */ extern AJ_API alljoyn_sessionlistener AJ_CALL alljoyn_sessionlistener_create(const alljoyn_sessionlistener_callbacks* callbacks, const void* context); /** * Destroy an alljoyn_sessionlistener. * * @param listener alljoyn_sessionlistener to destroy. */ extern AJ_API void AJ_CALL alljoyn_sessionlistener_destroy(alljoyn_sessionlistener listener); #ifdef __cplusplus } /* extern "C" */ #endif #endif alljoyn-15.04b/alljoyn_c/inc/alljoyn_c/SessionPortListener.h000066400000000000000000000113311255700255500242060ustar00rootroot00000000000000/** * @file * alljoyn_sessionportlistener is a collection of functions implemented by users * of the AllJoyn API in order to receive session port related event information. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_C_SESSIONPORTLISTENER_H #define _ALLJOYN_C_SESSIONPORTLISTENER_H #include #include #include #ifdef __cplusplus extern "C" { #endif /** * alljoyn_sessionportlistener is an abstract interface implemented by users of the * AllJoyn API in order to receive session port related event information. */ typedef struct _alljoyn_sessionportlistener_handle* alljoyn_sessionportlistener; /** * Type for the AcceptSessionJoiner callback. * Accept or reject an incoming JoinSession request. The session does not exist until * after this function returns. * * This callback is only used by session creators. Therefore it is only called on listeners * passed to alljoyn_busattachment_bindsessionport. * * @param context the context pointer that was passed to alljoyn_sessionportlistener_create * @param sessionPort Session port that was joined. * @param joiner Unique name of potential joiner. * @param opts Session options requested by the joiner. * @return Return true if JoinSession request is accepted. false if rejected. */ typedef QCC_BOOL (AJ_CALL * alljoyn_sessionportlistener_acceptsessionjoiner_ptr)(const void* context, alljoyn_sessionport sessionPort, const char* joiner, const alljoyn_sessionopts opts); /** * Type for the SessionJoined callback. * * Called by the bus when a session has been successfully joined. The session is now fully up. * * This callback is only used by session creators. Therefore it is only called on the alljoyn_sessionportlistener_callbacks * passed in when calling alljoyn_busattachment_bindsessionport. * * @param context the context pointer that was passed to alljoyn_sessionportlistener_create * @param sessionPort Session port that was joined. * @param id Id of session. * @param joiner Unique name of the joiner. */ typedef void (AJ_CALL * alljoyn_sessionportlistener_sessionjoined_ptr)(const void* context, alljoyn_sessionport sessionPort, alljoyn_sessionid id, const char* joiner); /** * Structure used during alljoyn_sessionportlistener_create to provide callbacks into C. */ typedef struct { /** * Accept or reject an incoming JoinSession request. The session does not * exist until this after this function returns. */ alljoyn_sessionportlistener_acceptsessionjoiner_ptr accept_session_joiner; /** * Called by the bus when a session has been successfully joined. The session * is now fully up. */ alljoyn_sessionportlistener_sessionjoined_ptr session_joined; } alljoyn_sessionportlistener_callbacks; /** * Create an alljoyn_sessionportlistener which will trigger the provided callbacks, passing along the provided context. * * @param callbacks Callbacks to trigger for associated events. * @param context Context to pass to callback functions * * @return Handle to newly allocated alljoyn_sessionportlistener. */ extern AJ_API alljoyn_sessionportlistener AJ_CALL alljoyn_sessionportlistener_create(const alljoyn_sessionportlistener_callbacks* callbacks, const void* context); /** * Destroy an alljoyn_sessionportlistener. * * @param listener alljoyn_sessionportlistener to destroy. */ extern AJ_API void AJ_CALL alljoyn_sessionportlistener_destroy(alljoyn_sessionportlistener listener); #ifdef __cplusplus } /* extern "C" */ #endif #endif alljoyn-15.04b/alljoyn_c/inc/alljoyn_c/TransportMask.h000066400000000000000000000055201255700255500230230ustar00rootroot00000000000000/** * @file * Transport type definitions */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_C_TRANPORTMASK_H #define _ALLJOYN_C_TRANPORTMASK_H #include /** Bitmask of all transport types */ typedef uint16_t alljoyn_transportmask; #define ALLJOYN_TRANSPORT_NONE (alljoyn_transportmask)0x0000 /**< no transports */ #define ALLJOYN_TRANSPORT_LOCAL (alljoyn_transportmask)0x0001 /**< Local (same device) transport */ #define ALLJOYN_TRANSPORT_TCP (alljoyn_transportmask)0x0004 /**< TCP/IP transport */ #define ALLJOYN_TRANSPORT_UDP (alljoyn_transportmask)0x0100 /**< UDP/IP transport */ #define ALLJOYN_TRANSPORT_EXPERIMENTAL (alljoyn_transportmask)0x8000 /**< Placeholder for expermimental transports */ #define ALLJOYN_TRANSPORT_IP (ALLJOYN_TRANSPORT_TCP | ALLJOYN_TRANSPORT_UDP) /**< Any IP-based transport */ #define ALLJOYN_TRANSPORT_ANY (ALLJOYN_TRANSPORT_LOCAL | ALLJOYN_TRANSPORT_IP) /**< ANY non-experimental transport */ #define ALLJOYN_TRANSPORT_BLUETOOTH (alljoyn_transportmask)(attempted_use_of_deprecated_definition = 0x0002) /**< Bluetooth transport */ #define ALLJOYN_TRANSPORT_WLAN (alljoyn_transportmask)(attempted_use_of_deprecated_definition = 0x0004) /**< Wireless local-area network transport */ #define ALLJOYN_TRANSPORT_WWAN (alljoyn_transportmask)(attempted_use_of_deprecated_definition = 0x0008) /**< Wireless wide-area network transport */ #define ALLJOYN_TRANSPORT_LAN (alljoyn_transportmask)(attempted_use_of_deprecated_definition = 0x0010) /**< Wired local-area network transport */ #define ALLJOYN_TRANSPORT_PROXIMITY (alljoyn_transportmask)(attempted_use_of_deprecated_definition = 0x0040) /**< Transport using WinRT Proximity Framework */ #define ALLJOYN_TRANSPORT_WFD (alljoyn_transportmask)(attempted_use_of_deprecated_definition = 0x0080) /**< Transport using Wi-Fi Direct transport */ #endif alljoyn-15.04b/alljoyn_c/inc/alljoyn_c/version.h000066400000000000000000000031041255700255500216740ustar00rootroot00000000000000/** * @file * This file provides access to AllJoyn library version and build information. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_C_VERSION_H #define _ALLJOYN_C_VERSION_H #include #ifdef __cplusplus extern "C" { #endif extern AJ_API const char* AJ_CALL alljoyn_getversion(); /**< Gives the version of AllJoyn Library */ extern AJ_API const char* AJ_CALL alljoyn_getbuildinfo(); /**< Gives build information of AllJoyn Library */ extern AJ_API uint32_t AJ_CALL alljoyn_getnumericversion(); /**< Gives the version of AllJoyn Library as a single number */ #ifdef __cplusplus } /* extern "C" */ #endif #endif alljoyn-15.04b/alljoyn_c/samples/000077500000000000000000000000001255700255500167615ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_c/samples/SConscript000066400000000000000000000026611255700255500210000ustar00rootroot00000000000000# Copyright AllSeen Alliance. All rights reserved. # # Permission to use, copy, modify, and/or distribute this software for any # purpose with or without fee is hereby granted, provided that the above # copyright notice and this permission notice appear in all copies. # # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. # Import('env') samples_env = env.Clone() if samples_env['BR'] == 'on': # Build apps with bundled daemon support samples_env.Prepend(LIBS = [samples_env['ajrlib']]) samples_env.Prepend(LIBS = samples_env['ALLJOYN_C_LIB_STATIC']) # Basic Sample programs samples_env.SConscript('basic/SConscript', exports = {'env': samples_env }) # About Sample programs samples_env.SConscript('about/SConscript', exports = {'env': samples_env }) # Security Sample programs samples_env.SConscript('secure/SConscript', exports = {'env': samples_env }) # Observer Sample programs samples_env.SConscript('observer/SConscript', exports = {'env': samples_env }) alljoyn-15.04b/alljoyn_c/samples/about/000077500000000000000000000000001255700255500200735ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_c/samples/about/SConscript000066400000000000000000000022001255700255500220770ustar00rootroot00000000000000# Copyright AllSeen Alliance. All rights reserved. # # Permission to use, copy, modify, and/or distribute this software for any # purpose with or without fee is hereby granted, provided that the above # copyright notice and this permission notice appear in all copies. # # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. # Import('env') clientDistDir = '$C_DISTDIR/samples/about' # Sample Programs progs = [ env.Program('about_service', ['about_service.cc']), env.Program('about_client', ['about_client.cc']) ] if env['OS_GROUP'] in ['windows', 'posix']: env.Install('$C_DISTDIR/bin/samples', progs ) env.Install(clientDistDir, env.Glob('*.cc')) alljoyn-15.04b/alljoyn_c/samples/about/about_client.cc000066400000000000000000000415541255700255500230630ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #include #include #include #include #include #include /* * Please note that we don't have error handling logic here to make the sample * code easier to read. This is for demonstration purpose only; actual * programs should check the return values of all AllJoyn API calls. */ static volatile sig_atomic_t s_interrupt = QCC_FALSE; static const char* INTERFACE_NAME = "com.example.about.feature.interface.sample"; static void CDECL_CALL sig_int_handler(int sig) { QCC_UNUSED(sig); s_interrupt = QCC_TRUE; } alljoyn_busattachment g_bus; /** * Print out the fields found in the AboutData. Only fields with known signatures * are printed out. All others will be treated as an unknown field. */ static void printAboutData(alljoyn_aboutdata aboutData, const char* language, int tabNum) { size_t count = alljoyn_aboutdata_getfields(aboutData, NULL, 0); size_t i = 0; int j = 0; size_t k = 0; const char** fields = (const char**) malloc(sizeof(char*) * count); alljoyn_aboutdata_getfields(aboutData, fields, count); for (i = 0; i < count; ++i) { for (j = 0; j < tabNum; ++j) { printf("\t"); } printf("Key: %s", fields[i]); alljoyn_msgarg tmp = alljoyn_msgarg_create(); alljoyn_aboutdata_getfield(aboutData, fields[i], &tmp, language); printf("\t"); char signature[256] = { 0 }; alljoyn_msgarg_signature(tmp, signature, 16); if (!strncmp(signature, "s", 1)) { const char* tmp_s; alljoyn_msgarg_get(tmp, "s", &tmp_s); printf("%s", tmp_s); } else if (!strncmp(signature, "as", 2)) { size_t las; alljoyn_msgarg as_arg = alljoyn_msgarg_create(); alljoyn_msgarg_get(tmp, "as", &las, &as_arg); for (size_t j = 0; j < las; ++j) { const char* tmp_s; alljoyn_msgarg_get(alljoyn_msgarg_array_element(as_arg, j), "s", &tmp_s); printf("%s ", tmp_s); } } else if (!strncmp(signature, "ay", 2)) { size_t lay; uint8_t* pay; alljoyn_msgarg_get(tmp, "ay", &lay, &pay); for (k = 0; k < lay; ++k) { printf("%02x ", pay[k]); } } else { printf("User Defined Value\tSignature: %s", signature); } printf("\n"); } free((void*)fields); } typedef struct my_about_listener_t { alljoyn_sessionlistener sessionlistener; alljoyn_aboutlistener aboutlistener; }my_about_listener; static void alljoyn_sessionlistener_connect_lost_cb(const void* context, alljoyn_sessionid sessionId, alljoyn_sessionlostreason reason) { QCC_UNUSED(context); printf("SessionLost sessionId = %u, Reason = %d\n", sessionId, reason); } static alljoyn_sessionlistener create_my_alljoyn_sessionlistener() { alljoyn_sessionlistener_callbacks* callbacks = (alljoyn_sessionlistener_callbacks*) malloc(sizeof(alljoyn_sessionlistener_callbacks)); callbacks->session_member_added = NULL; callbacks->session_member_removed = NULL; callbacks->session_lost = alljoyn_sessionlistener_connect_lost_cb; return alljoyn_sessionlistener_create(callbacks, NULL); } static void announced_cb(const void* context, const char* busName, uint16_t version, alljoyn_sessionport port, const alljoyn_msgarg objectDescriptionArg, const alljoyn_msgarg aboutDataArg) { my_about_listener* mylistener = (my_about_listener*) context; alljoyn_aboutobjectdescription objectDescription = alljoyn_aboutobjectdescription_create(); alljoyn_aboutobjectdescription_createfrommsgarg(objectDescription, objectDescriptionArg); printf("*********************************************************************************\n"); printf("Announce signal discovered\n"); printf("\tFrom bus %s\n", busName); printf("\tAbout version %hu\n", version); printf("\tSessionPort %hu\n", port); printf("\tObjectDescription:\n"); alljoyn_aboutobjectdescription aod = alljoyn_aboutobjectdescription_create(); alljoyn_aboutobjectdescription_createfrommsgarg(aod, objectDescriptionArg); size_t path_num = alljoyn_aboutobjectdescription_getpaths(aod, NULL, 0); const char** paths = (const char**) malloc(sizeof(const char*) * path_num); alljoyn_aboutobjectdescription_getpaths(aod, paths, path_num); for (size_t i = 0; i < path_num; ++i) { printf("\t\t%s\n", paths[i]); size_t intf_num = alljoyn_aboutobjectdescription_getinterfaces(aod, paths[i], NULL, 0); const char** intfs = (const char**) malloc(sizeof(const char*) * intf_num); alljoyn_aboutobjectdescription_getinterfaces(aod, paths[i], intfs, intf_num); for (size_t j = 0; j < intf_num; ++j) { printf("\t\t\t%s\n", intfs[j]); } free((void*)intfs); intfs = NULL; } free((void*) paths); paths = NULL; printf("\tAboutData:\n"); alljoyn_aboutdata aboutData = alljoyn_aboutdata_create_full(aboutDataArg, "en"); printAboutData(aboutData, NULL, 2); printf("*********************************************************************************\n"); QStatus status; if (g_bus != NULL) { alljoyn_sessionid sessionId; alljoyn_sessionopts sessionOpts = alljoyn_sessionopts_create(ALLJOYN_TRAFFIC_TYPE_MESSAGES, QCC_FALSE, ALLJOYN_PROXIMITY_ANY, ALLJOYN_TRANSPORT_ANY); alljoyn_busattachment_enableconcurrentcallbacks(g_bus); status = alljoyn_busattachment_joinsession(g_bus, busName, port, mylistener->sessionlistener, &sessionId, sessionOpts); if (ER_OK == status && 0 != sessionId) { alljoyn_aboutproxy aboutProxy = alljoyn_aboutproxy_create(g_bus, busName, sessionId); alljoyn_msgarg objArg = alljoyn_msgarg_create(); alljoyn_aboutproxy_getobjectdescription(aboutProxy, objArg); printf("*********************************************************************************\n"); printf("AboutProxy.GetObjectDescription:\n"); alljoyn_aboutobjectdescription aod2 = alljoyn_aboutobjectdescription_create(); alljoyn_aboutobjectdescription_createfrommsgarg(aod2, objArg); path_num = alljoyn_aboutobjectdescription_getpaths(aod2, NULL, 0); paths = (const char**) malloc(sizeof(const char*) * path_num); alljoyn_aboutobjectdescription_getpaths(aod2, paths, path_num); for (size_t i = 0; i < path_num; ++i) { printf("\t\t%s\n", paths[i]); size_t intf_num = alljoyn_aboutobjectdescription_getinterfaces(aod2, paths[i], NULL, 0); const char** intfs = (const char**) malloc(sizeof(const char*) * intf_num); alljoyn_aboutobjectdescription_getinterfaces(aod2, paths[i], intfs, intf_num); for (size_t j = 0; j < intf_num; ++j) { printf("\t\t\t%s\n", intfs[j]); } free((void*)intfs); intfs = NULL; } free((void*) paths); paths = NULL; alljoyn_msgarg aArg = alljoyn_msgarg_create(); alljoyn_aboutproxy_getaboutdata(aboutProxy, "en", aArg); printf("*********************************************************************************\n"); printf("AboutProxy.GetAboutData: (Default Language)\n"); aboutData = alljoyn_aboutdata_create("en"); alljoyn_aboutdata_createfrommsgarg(aboutData, aArg, "en"); printAboutData(aboutData, NULL, 1); size_t lang_num = alljoyn_aboutdata_getsupportedlanguages(aboutData, NULL, 0); if (lang_num > 1) { const char** langs = (const char**) malloc(sizeof(char*) * lang_num); alljoyn_aboutdata_getsupportedlanguages(aboutData, langs, lang_num); char* defaultLanguage; alljoyn_aboutdata_getdefaultlanguage(aboutData, &defaultLanguage); /* * Print out the AboutData for every language but the * default it has already been printed. */ for (size_t i = 0; i < lang_num; ++i) { if (strcmp(defaultLanguage, langs[i]) != 0) { status = alljoyn_aboutproxy_getaboutdata(aboutProxy, langs[i], aArg); if (ER_OK == status) { alljoyn_aboutdata_createfrommsgarg(aboutData, aArg, langs[i]); printAboutData(aboutData, langs[i], 1); } } } free((void*)langs); langs = NULL; uint16_t ver; alljoyn_aboutproxy_getversion(aboutProxy, &ver); printf("*********************************************************************************\n"); printf("AboutProxy.GetVersion %hd\n", ver); printf("*********************************************************************************\n"); const char* path; alljoyn_aboutobjectdescription_getinterfacepaths(objectDescription, INTERFACE_NAME, &path, 1); alljoyn_proxybusobject proxyObject = alljoyn_proxybusobject_create(g_bus, busName, path, sessionId); status = alljoyn_proxybusobject_introspectremoteobject(proxyObject); if (status != ER_OK) { printf("Failed to introspect remote object.\n"); } alljoyn_msgarg arg = alljoyn_msgarg_create_and_set("s", "ECHO Echo echo...\n"); alljoyn_message replyMsg = alljoyn_message_create(g_bus); alljoyn_proxybusobject_methodcall(proxyObject, INTERFACE_NAME, "Echo", arg, 1, replyMsg, 25000, 0); if (status != ER_OK) { printf("Failed to call Echo method.\n"); return; } char* echoReply; alljoyn_msgarg reply_msgarg = alljoyn_message_getarg(replyMsg, 0); status = alljoyn_msgarg_get(reply_msgarg, "s", &echoReply); if (status != ER_OK) { printf("Failed to read Echo method reply.\n"); } printf("Echo method reply: %s\n", echoReply); alljoyn_message_destroy(replyMsg); alljoyn_msgarg_destroy(arg); alljoyn_proxybusobject_destroy(proxyObject); } alljoyn_msgarg_destroy(aArg); alljoyn_aboutobjectdescription_destroy(aod2); alljoyn_msgarg_destroy(objArg); alljoyn_aboutproxy_destroy(aboutProxy); } alljoyn_sessionopts_destroy(sessionOpts); } else { printf("BusAttachment is NULL\n"); } alljoyn_aboutdata_destroy(aboutData); alljoyn_aboutobjectdescription_destroy(aod); alljoyn_aboutobjectdescription_destroy(objectDescription); } static my_about_listener* create_my_alljoyn_aboutlistener() { my_about_listener* result = (my_about_listener*) malloc(sizeof(my_about_listener)); alljoyn_aboutlistener_callback* callback = (alljoyn_aboutlistener_callback*) malloc(sizeof(alljoyn_aboutlistener_callback)); callback->about_listener_announced = announced_cb; result->aboutlistener = alljoyn_aboutlistener_create(callback, result); result->sessionlistener = create_my_alljoyn_sessionlistener(); return result; } static void destroy_my_alljoyn_aboutlistener(my_about_listener* listener) { if (listener) { if (listener->aboutlistener) { alljoyn_aboutlistener_destroy(listener->aboutlistener); listener->aboutlistener = NULL; } if (listener->sessionlistener) { alljoyn_sessionlistener_destroy(listener->sessionlistener); listener->sessionlistener = NULL; } free(listener); listener = NULL; } } int CDECL_CALL main(int argc, char** argv) { QCC_UNUSED(argc); QCC_UNUSED(argv); /* Install SIGINT handler so Ctrl + C deallocates memory properly */ signal(SIGINT, sig_int_handler); QStatus status = alljoyn_init(); if (ER_OK != status) { printf("alljoyn_init failed (%s)\n", QCC_StatusText(status)); return 1; } #ifdef ROUTER status = alljoyn_routerinit(); if (ER_OK != status) { printf("alljoyn_routerinit failed (%s)\n", QCC_StatusText(status)); alljoyn_shutdown(); return 1; } #endif g_bus = alljoyn_busattachment_create("AboutServiceTest", QCC_TRUE); status = alljoyn_busattachment_start(g_bus); if (ER_OK == status) { printf("BusAttachment started.\n"); } else { printf("FAILED to start BusAttachment (%s)\n", QCC_StatusText(status)); return 1; } status = alljoyn_busattachment_connect(g_bus, NULL); if (ER_OK == status) { printf("BusAttachment connect succeeded. BusName %s\n", alljoyn_busattachment_getuniquename(g_bus)); } else { printf("FAILED to connect to router node (%s)\n", QCC_StatusText(status)); return 1; } my_about_listener* listener = create_my_alljoyn_aboutlistener(); alljoyn_busattachment_registeraboutlistener(g_bus, listener->aboutlistener); const char* interfaces[] = { INTERFACE_NAME }; alljoyn_busattachment_whoimplements_interfaces(g_bus, interfaces, sizeof(interfaces) / sizeof(interfaces[0])); if (ER_OK == status) { printf("WhoImplements called.\n"); } else { printf("WhoImplements call FAILED with status %s\n", QCC_StatusText(status)); return 1; } /* Perform the service asynchronously until the user signals for an exit */ if (ER_OK == status) { while (s_interrupt == QCC_FALSE) { #ifdef _WIN32 Sleep(100); #else usleep(100 * 1000); #endif } } destroy_my_alljoyn_aboutlistener(listener); alljoyn_busattachment_stop(g_bus); alljoyn_busattachment_join(g_bus); alljoyn_busattachment_destroy(g_bus); #ifdef ROUTER alljoyn_routershutdown(); #endif alljoyn_shutdown(); return 0; } alljoyn-15.04b/alljoyn_c/samples/about/about_service.cc000066400000000000000000000270151255700255500232410ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include using namespace ajn; static volatile sig_atomic_t s_interrupt = QCC_FALSE; static void CDECL_CALL sig_int_handler(int sig) { QCC_UNUSED(sig); s_interrupt = QCC_TRUE; } static alljoyn_sessionport ASSIGNED_SESSION_PORT = 900; static const char INTERFACE_NAME[] = "com.example.about.feature.interface.sample"; static void sessionportlistener_sessionjoined_cb(const void* context, alljoyn_sessionport sessionPort, alljoyn_sessionid id, const char* joiner) { QCC_UNUSED(context); QCC_UNUSED(sessionPort); QCC_UNUSED(joiner); printf("Session Joined SessionId = %u\n", id); } static QCC_BOOL sessionportlistener_acceptsessionjoiner_cb(const void* context, alljoyn_sessionport sessionPort, const char* joiner, const alljoyn_sessionopts opts) { QCC_UNUSED(context); QCC_UNUSED(joiner); QCC_UNUSED(opts); if (sessionPort != ASSIGNED_SESSION_PORT) { printf("Rejecting join attempt on unexpected session port %d\n", sessionPort); return QCC_FALSE; } return QCC_TRUE; } static alljoyn_sessionportlistener create_my_alljoyn_sessionportlistener() { alljoyn_sessionportlistener_callbacks* callbacks = (alljoyn_sessionportlistener_callbacks*) malloc(sizeof(alljoyn_sessionportlistener_callbacks)); callbacks->accept_session_joiner = sessionportlistener_acceptsessionjoiner_cb; callbacks->session_joined = sessionportlistener_sessionjoined_cb; return alljoyn_sessionportlistener_create(callbacks, NULL); } /** * Respond to remote method call `Echo` by returning the string back to the sender */ static void echo_cb(alljoyn_busobject object, const alljoyn_interfacedescription_member* member, alljoyn_message msg) { QCC_UNUSED(member); alljoyn_msgarg arg = alljoyn_message_getarg(msg, 0); printf("Echo method called %s\n", ((ajn::MsgArg*)arg)->v_string.str); QStatus status = alljoyn_busobject_methodreply_args(object, msg, arg, 1); if (status != ER_OK) { printf("Failed to created MethodReply.\n"); } } static alljoyn_busobject create_my_alljoyn_busobject(alljoyn_busattachment bus, const char* path) { QStatus status = ER_FAIL; alljoyn_busobject result = NULL; result = alljoyn_busobject_create(path, QCC_FALSE, NULL, NULL); alljoyn_interfacedescription iface = alljoyn_busattachment_getinterface(bus, INTERFACE_NAME); assert(iface != NULL); status = alljoyn_busobject_addinterface(result, iface); alljoyn_busobject_setannounceflag(result, iface, ANNOUNCED); if (status != ER_OK) { printf("Failed to add %s interface to the BusObject\n", INTERFACE_NAME); } alljoyn_interfacedescription_member echomember; alljoyn_interfacedescription_getmember(iface, "Echo", &echomember); const alljoyn_busobject_methodentry methodEntries[] = { { &echomember, echo_cb } }; status = alljoyn_busobject_addmethodhandlers(result, methodEntries, sizeof(methodEntries) / sizeof(methodEntries[0])); return result; } int CDECL_CALL main(int argc, char** argv) { QCC_UNUSED(argc); QCC_UNUSED(argv); /* Install SIGINT handler so Ctrl + C deallocates memory properly */ signal(SIGINT, sig_int_handler); QStatus status = alljoyn_init(); if (ER_OK != status) { printf("alljoyn_init failed (%s)\n", QCC_StatusText(status)); return 1; } #ifdef ROUTER status = alljoyn_routerinit(); if (ER_OK != status) { printf("alljoyn_routerinit failed (%s)\n", QCC_StatusText(status)); alljoyn_shutdown(); return 1; } #endif alljoyn_busattachment bus = alljoyn_busattachment_create("About Service Example", QCC_TRUE); status = alljoyn_busattachment_start(bus); if (ER_OK == status) { printf("BusAttachment started.\n"); } else { printf("FAILED to start BusAttachment (%s)\n", QCC_StatusText(status)); return 1; } status = alljoyn_busattachment_connect(bus, NULL); if (ER_OK == status) { printf("BusAttachment connect succeeded. BusName %s\n", alljoyn_busattachment_getuniquename(bus)); } else { printf("FAILED to connect to router node (%s)\n", QCC_StatusText(status)); return 1; } alljoyn_sessionopts opts = alljoyn_sessionopts_create(ALLJOYN_TRAFFIC_TYPE_MESSAGES, QCC_FALSE, ALLJOYN_PROXIMITY_ANY, ALLJOYN_TRANSPORT_ANY); alljoyn_sessionport sessionPort = ASSIGNED_SESSION_PORT; alljoyn_sessionportlistener listener = create_my_alljoyn_sessionportlistener(); status = alljoyn_busattachment_bindsessionport(bus, &sessionPort, opts, listener); if (ER_OK != status) { printf("Failed to BindSessionPort (%s)", QCC_StatusText(status)); return 1; } /* * Setup the about data * The default language is specified in the constructor. If the default language * is not specified any Field that should be localized will return an error */ alljoyn_aboutdata aboutData = alljoyn_aboutdata_create("en"); /* AppId is a 128bit uuid */ uint8_t appId[] = { 0x01, 0xB3, 0xBA, 0x14, 0x1E, 0x82, 0x11, 0xE4, 0x86, 0x51, 0xD1, 0x56, 0x1D, 0x5D, 0x46, 0xB0 }; status = alljoyn_aboutdata_setappid(aboutData, appId, 16); status = alljoyn_aboutdata_setdevicename(aboutData, "My Device Name", "en"); /* DeviceId is a string encoded 128bit UUID */ status = alljoyn_aboutdata_setdeviceid(aboutData, "93c06771-c725-48c2-b1ff-6a2a59d445b8"); status = alljoyn_aboutdata_setappname(aboutData, "Application", "en"); status = alljoyn_aboutdata_setmanufacturer(aboutData, "Manufacturer", "en"); status = alljoyn_aboutdata_setmodelnumber(aboutData, "123456"); status = alljoyn_aboutdata_setdescription(aboutData, "A poetic description of this application", "en"); status = alljoyn_aboutdata_setdateofmanufacture(aboutData, "2014-03-24"); status = alljoyn_aboutdata_setsoftwareversion(aboutData, "0.1.2"); status = alljoyn_aboutdata_sethardwareversion(aboutData, "0.0.1"); status = alljoyn_aboutdata_setsupporturl(aboutData, "http://www.example.org"); /* * The default language is automatically added to the `SupportedLanguages` * Users don't have to specify the AJSoftwareVersion its automatically added * to the AboutData/ * Adding Spanish Localization values to the AboutData. All strings MUST be * UTF-8 encoded. */ status = alljoyn_aboutdata_setdevicename(aboutData, "Mi dispositivo Nombre", "es"); status = alljoyn_aboutdata_setappname(aboutData, "aplicación", "es"); status = alljoyn_aboutdata_setmanufacturer(aboutData, "fabricante", "es"); status = alljoyn_aboutdata_setdescription(aboutData, "Una descripción poética de esta aplicación", "es"); /* Check to see if the aboutData is valid before sending the About Announcement */ if (!alljoyn_aboutdata_isvalid(aboutData, "en")) { printf("failed to setup about data.\n"); } char interface[256] = { 0 }; snprintf(interface, 256, "" \ "" \ " " \ " " \ " " \ " " \ "" \ "", INTERFACE_NAME); printf("Interface = %s\n", interface); status = alljoyn_busattachment_createinterfacesfromxml(bus, interface); if (ER_OK != status) { printf("Failed to parse the xml interface definition (%s)", QCC_StatusText(status)); return 1; } alljoyn_busobject busObject = create_my_alljoyn_busobject(bus, "/example/path"); status = alljoyn_busattachment_registerbusobject(bus, busObject); if (ER_OK != status) { printf("Failed to register BusObject (%s)", QCC_StatusText(status)); return 1; } /* Announce about signal */ alljoyn_aboutobj aboutObj = alljoyn_aboutobj_create(bus, UNANNOUNCED); /* * Note the ObjectDescription that is part of the Announce signal is found * automatically by introspecting the BusObjects registered with the bus * attachment. */ status = alljoyn_aboutobj_announce(aboutObj, sessionPort, aboutData); if (ER_OK == status) { printf("AboutObj Announce Succeeded.\n"); } else { printf("AboutObj Announce failed (%s)\n", QCC_StatusText(status)); return 1; } /* Perform the service asynchronously until the user signals for an exit */ if (ER_OK == status) { while (s_interrupt == QCC_FALSE) { #ifdef _WIN32 Sleep(100); #else usleep(100 * 1000); #endif } } alljoyn_sessionportlistener_destroy(listener); alljoyn_busattachment_stop(bus); alljoyn_busattachment_join(bus); alljoyn_sessionopts_destroy(opts); alljoyn_aboutdata_destroy(aboutData); alljoyn_busobject_destroy(busObject); alljoyn_aboutobj_destroy(aboutObj); alljoyn_busattachment_destroy(bus); #ifdef ROUTER alljoyn_routershutdown(); #endif alljoyn_shutdown(); return 0; } alljoyn-15.04b/alljoyn_c/samples/basic/000077500000000000000000000000001255700255500200425ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_c/samples/basic/SConscript000066400000000000000000000021751255700255500220610ustar00rootroot00000000000000# Copyright AllSeen Alliance. All rights reserved. # # Permission to use, copy, modify, and/or distribute this software for any # purpose with or without fee is hereby granted, provided that the above # copyright notice and this permission notice appear in all copies. # # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. # Import('env') clientDistDir = '$C_DISTDIR/samples/basic' # Sample Programs progs = [ env.Program('basic_c_service', ['basic_c_service.c']), env.Program('basic_c_client', ['basic_c_client.c']), ] if env['OS'] in ['linux', 'darwin']: env.Install('$C_DISTDIR/bin/samples', progs ) env.Install(clientDistDir, env.Glob('*.c')) alljoyn-15.04b/alljoyn_c/samples/basic/basic_c_client.c000066400000000000000000000205561255700255500231370ustar00rootroot00000000000000/** * @file * @brief Sample implementation of an AllJoyn client in C. */ /****************************************************************************** * * * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _WIN32 #define _BSD_SOURCE /* usleep */ #endif #include #include #include #include #include #include #include #include #include #include #include #include #include #include /** Static top level message bus object */ static alljoyn_busattachment g_msgBus = NULL; /*constants*/ static const char* INTERFACE_NAME = "org.alljoyn.Bus.sample"; static const char* OBJECT_NAME = "org.alljoyn.Bus.sample"; static const char* OBJECT_PATH = "/sample"; static const alljoyn_sessionport SERVICE_PORT = 25; static QCC_BOOL s_joinComplete = QCC_FALSE; static alljoyn_sessionid s_sessionId = 0; /* Static BusListener */ static alljoyn_buslistener g_busListener; static volatile sig_atomic_t g_interrupt = QCC_FALSE; static void CDECL_CALL SigIntHandler(int sig) { g_interrupt = QCC_TRUE; } /* FoundAdvertisedName callback */ void AJ_CALL found_advertised_name(const void* context, const char* name, alljoyn_transportmask transport, const char* namePrefix) { printf("found_advertised_name(name=%s, prefix=%s)\n", name, namePrefix); if (0 == strcmp(name, OBJECT_NAME)) { /* We found a remote bus that is advertising basic service's well-known name so connect to it */ alljoyn_sessionopts opts = alljoyn_sessionopts_create(ALLJOYN_TRAFFIC_TYPE_MESSAGES, QCC_FALSE, ALLJOYN_PROXIMITY_ANY, ALLJOYN_TRANSPORT_ANY); QStatus status; /* enable concurrent callbacks so joinsession can be called */ alljoyn_busattachment_enableconcurrentcallbacks(g_msgBus); status = alljoyn_busattachment_joinsession(g_msgBus, name, SERVICE_PORT, NULL, &s_sessionId, opts); if (ER_OK != status) { printf("alljoyn_busattachment_joinsession failed (status=%s)\n", QCC_StatusText(status)); } else { printf("alljoyn_busattachment_joinsession SUCCESS (Session id=%d)\n", s_sessionId); } alljoyn_sessionopts_destroy(opts); } s_joinComplete = QCC_TRUE; } /* NameOwnerChanged callback */ void AJ_CALL name_owner_changed(const void* context, const char* busName, const char* previousOwner, const char* newOwner) { if (newOwner && (0 == strcmp(busName, OBJECT_NAME))) { printf("name_owner_changed: name=%s, oldOwner=%s, newOwner=%s\n", busName, previousOwner ? previousOwner : "", newOwner ? newOwner : ""); } } /** Main entry point */ /** TODO: Make this C89 compatible. */ int CDECL_CALL main(int argc, char** argv, char** envArg) { QStatus status = ER_OK; char* connectArgs = NULL; alljoyn_interfacedescription testIntf = NULL; /* Create a bus listener */ alljoyn_buslistener_callbacks callbacks = { NULL, NULL, &found_advertised_name, NULL, &name_owner_changed, NULL, NULL, NULL }; if (alljoyn_init() != ER_OK) { return 1; } #ifdef ROUTER if (alljoyn_routerinit() != ER_OK) { alljoyn_shutdown(); return 1; } #endif printf("AllJoyn Library version: %s\n", alljoyn_getversion()); printf("AllJoyn Library build info: %s\n", alljoyn_getbuildinfo()); /* Install SIGINT handler */ signal(SIGINT, SigIntHandler); /* Create message bus */ g_msgBus = alljoyn_busattachment_create("myApp", QCC_TRUE); /* Add org.alljoyn.Bus.method_sample interface */ status = alljoyn_busattachment_createinterface(g_msgBus, INTERFACE_NAME, &testIntf); if (status == ER_OK) { printf("Interface Created.\n"); alljoyn_interfacedescription_addmember(testIntf, ALLJOYN_MESSAGE_METHOD_CALL, "cat", "ss", "s", "inStr1,inStr2,outStr", 0); alljoyn_interfacedescription_activate(testIntf); } else { printf("Failed to create interface 'org.alljoyn.Bus.method_sample'\n"); } /* Start the msg bus */ if (ER_OK == status) { status = alljoyn_busattachment_start(g_msgBus); if (ER_OK != status) { printf("alljoyn_busattachment_start failed\n"); } else { printf("alljoyn_busattachment started.\n"); } } /* Connect to the bus */ if (ER_OK == status) { status = alljoyn_busattachment_connect(g_msgBus, connectArgs); if (ER_OK != status) { printf("alljoyn_busattachment_connect(\"%s\") failed\n", (connectArgs) ? connectArgs : "NULL"); } else { printf("alljoyn_busattachment connected to \"%s\"\n", alljoyn_busattachment_getconnectspec(g_msgBus)); } } g_busListener = alljoyn_buslistener_create(&callbacks, NULL); /* Register a bus listener in order to get discovery indications */ if (ER_OK == status) { alljoyn_busattachment_registerbuslistener(g_msgBus, g_busListener); printf("alljoyn_buslistener Registered.\n"); } /* Begin discovery on the well-known name of the service to be called */ if (ER_OK == status) { status = alljoyn_busattachment_findadvertisedname(g_msgBus, OBJECT_NAME); if (status != ER_OK) { printf("alljoyn_busattachment_findadvertisedname failed (%s))\n", QCC_StatusText(status)); } } /* Wait for join session to complete */ while (s_joinComplete == QCC_FALSE && g_interrupt == QCC_FALSE) { #ifdef _WIN32 Sleep(10); #else usleep(100 * 1000); #endif } if (status == ER_OK && g_interrupt == QCC_FALSE) { alljoyn_message reply; alljoyn_msgarg inputs; size_t numArgs; alljoyn_proxybusobject remoteObj = alljoyn_proxybusobject_create(g_msgBus, OBJECT_NAME, OBJECT_PATH, s_sessionId); const alljoyn_interfacedescription alljoynTestIntf = alljoyn_busattachment_getinterface(g_msgBus, INTERFACE_NAME); assert(alljoynTestIntf); alljoyn_proxybusobject_addinterface(remoteObj, alljoynTestIntf); reply = alljoyn_message_create(g_msgBus); inputs = alljoyn_msgarg_array_create(2); numArgs = 2; status = alljoyn_msgarg_array_set(inputs, &numArgs, "ss", "Hello ", "World!"); if (ER_OK != status) { printf("Arg assignment failed: %s\n", QCC_StatusText(status)); } status = alljoyn_proxybusobject_methodcall(remoteObj, INTERFACE_NAME, "cat", inputs, 2, reply, 5000, 0); if (ER_OK == status) { char* cat_str; status = alljoyn_msgarg_get(alljoyn_message_getarg(reply, 0), "s", &cat_str); printf("%s.%s ( path=%s) returned \"%s\"\n", INTERFACE_NAME, "cat", OBJECT_PATH, cat_str); } else { printf("MethodCall on %s.%s failed\n", INTERFACE_NAME, "cat"); } alljoyn_proxybusobject_destroy(remoteObj); alljoyn_message_destroy(reply); alljoyn_msgarg_destroy(inputs); } /* Deallocate bus */ if (g_msgBus) { alljoyn_busattachment deleteMe = g_msgBus; g_msgBus = NULL; alljoyn_busattachment_destroy(deleteMe); } /* Deallocate bus listener */ alljoyn_buslistener_destroy(g_busListener); printf("basic client exiting with status %d (%s)\n", status, QCC_StatusText(status)); #ifdef ROUTER alljoyn_routershutdown(); #endif alljoyn_shutdown(); return (int) status; } alljoyn-15.04b/alljoyn_c/samples/basic/basic_c_service.c000066400000000000000000000262271255700255500233220ustar00rootroot00000000000000/** * @file * @brief Sample implementation of an AllJoyn service in C. * * This sample will show how to set up an AllJoyn service that will registered with the * wellknown name 'org.alljoyn.Bus.method_sample'. The service will register a method call * with the name 'cat' this method will take two input strings and return a * Concatenated version of the two strings. * */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _WIN32 #define _BSD_SOURCE /* usleep */ #endif #ifdef _WIN32 /* To avoid compilation error in VS generated due to use of snprintf */ #define _CRT_SECURE_NO_WARNINGS 1 #endif #include #include #include #include #include #include #include #include #include #include #include /** Static top level message bus object */ static alljoyn_busattachment g_msgBus = NULL; /* Static SessionPortListener */ static alljoyn_sessionportlistener s_sessionPortListener = NULL; /* Static BusListener */ static alljoyn_buslistener g_busListener = NULL; /*constants*/ static const char* INTERFACE_NAME = "org.alljoyn.Bus.sample"; static const char* OBJECT_NAME = "org.alljoyn.Bus.sample"; static const char* OBJECT_PATH = "/sample"; static const alljoyn_sessionport SERVICE_PORT = 25; static volatile sig_atomic_t g_interrupt = QCC_FALSE; static void CDECL_CALL SigIntHandler(int sig) { g_interrupt = QCC_TRUE; } /* ObjectRegistered callback */ void AJ_CALL busobject_object_registered(const void* context) { printf("ObjectRegistered has been called\n"); } /* NameOwnerChanged callback */ void AJ_CALL name_owner_changed(const void* context, const char* busName, const char* previousOwner, const char* newOwner) { if (newOwner && (0 == strcmp(busName, OBJECT_NAME))) { printf("name_owner_changed: name=%s, oldOwner=%s, newOwner=%s\n", busName, previousOwner ? previousOwner : "", newOwner ? newOwner : ""); } } /* AcceptSessionJoiner callback */ QCC_BOOL AJ_CALL accept_session_joiner(const void* context, alljoyn_sessionport sessionPort, const char* joiner, const alljoyn_sessionopts opts) { QCC_BOOL ret = QCC_FALSE; if (sessionPort != SERVICE_PORT) { printf("Rejecting join attempt on unexpected session port %d\n", sessionPort); } else { printf("Accepting join session request from %s (opts.proximity=%x, opts.traffic=%x, opts.transports=%x)\n", joiner, alljoyn_sessionopts_get_proximity(opts), alljoyn_sessionopts_get_traffic(opts), alljoyn_sessionopts_get_transports(opts)); ret = QCC_TRUE; } return ret; } /* Exposed concatenate method */ void AJ_CALL cat_method(alljoyn_busobject bus, const alljoyn_interfacedescription_member* member, alljoyn_message msg) { QStatus status; alljoyn_msgarg outArg; char* str1; char* str2; /* Concatenate the two input strings and reply with the result. */ char result[256] = { 0 }; status = alljoyn_msgarg_get(alljoyn_message_getarg(msg, 0), "s", &str1); if (ER_OK != status) { printf("Ping: Error reading alljoyn_message\n"); } status = alljoyn_msgarg_get(alljoyn_message_getarg(msg, 1), "s", &str2); if (ER_OK != status) { printf("Ping: Error reading alljoyn_message\n"); } snprintf(result, sizeof(result), "%s%s", str1, str2); outArg = alljoyn_msgarg_create_and_set("s", result); status = alljoyn_busobject_methodreply_args(bus, msg, outArg, 1); if (ER_OK != status) { printf("Ping: Error sending reply\n"); } alljoyn_msgarg_destroy(outArg); } /** Main entry point */ int CDECL_CALL main(int argc, char** argv, char** envArg) { QStatus status = ER_OK; char* connectArgs = NULL; alljoyn_interfacedescription testIntf = NULL; alljoyn_busobject_callbacks busObjCbs = { NULL, NULL, &busobject_object_registered, NULL }; alljoyn_busobject testObj = NULL; alljoyn_interfacedescription exampleIntf; alljoyn_interfacedescription_member cat_member; QCC_BOOL foundMember = QCC_FALSE; alljoyn_busobject_methodentry methodEntries[] = { { &cat_member, cat_method }, }; alljoyn_sessionportlistener_callbacks spl_cbs = { accept_session_joiner, NULL }; alljoyn_sessionopts opts = NULL; if (alljoyn_init() != ER_OK) { return 1; } #ifdef ROUTER if (alljoyn_routerinit() != ER_OK) { alljoyn_shutdown(); return 1; } #endif printf("AllJoyn Library version: %s\n", alljoyn_getversion()); printf("AllJoyn Library build info: %s\n", alljoyn_getbuildinfo()); /* Install SIGINT handler */ signal(SIGINT, SigIntHandler); /* Create message bus */ g_msgBus = alljoyn_busattachment_create("myApp", QCC_TRUE); if (g_msgBus != NULL) { /* Add org.alljoyn.Bus.method_sample interface */ status = alljoyn_busattachment_createinterface(g_msgBus, INTERFACE_NAME, &testIntf); if (status == ER_OK) { alljoyn_interfacedescription_addmember(testIntf, ALLJOYN_MESSAGE_METHOD_CALL, "cat", "ss", "s", "inStr1,inStr2,outStr", 0); alljoyn_interfacedescription_activate(testIntf); printf("Interface Created.\n"); } else { printf("Failed to create interface 'org.alljoyn.Bus.method_sample'\n"); } /* Register a bus listener */ if (ER_OK == status) { /* Create a bus listener */ alljoyn_buslistener_callbacks callbacks = { NULL, NULL, NULL, NULL, &name_owner_changed, NULL, NULL, NULL }; g_busListener = alljoyn_buslistener_create(&callbacks, NULL); alljoyn_busattachment_registerbuslistener(g_msgBus, g_busListener); } /* Set up bus object */ testObj = alljoyn_busobject_create(OBJECT_PATH, QCC_FALSE, &busObjCbs, NULL); exampleIntf = alljoyn_busattachment_getinterface(g_msgBus, INTERFACE_NAME); assert(exampleIntf); alljoyn_busobject_addinterface(testObj, exampleIntf); foundMember = alljoyn_interfacedescription_getmember(exampleIntf, "cat", &cat_member); assert(foundMember == QCC_TRUE); if (!foundMember) { printf("Failed to get cat member of interface\n"); } status = alljoyn_busobject_addmethodhandlers(testObj, methodEntries, sizeof(methodEntries) / sizeof(methodEntries[0])); if (ER_OK != status) { printf("Failed to register method handlers for BasicSampleObject\n"); } /* Start the msg bus */ status = alljoyn_busattachment_start(g_msgBus); if (ER_OK == status) { printf("alljoyn_busattachment started.\n"); /* Register local objects and connect to the daemon */ status = alljoyn_busattachment_registerbusobject(g_msgBus, testObj); /* Create the client-side endpoint */ if (ER_OK == status) { status = alljoyn_busattachment_connect(g_msgBus, connectArgs); if (ER_OK != status) { printf("alljoyn_busattachment_connect(\"%s\") failed\n", (connectArgs) ? connectArgs : "NULL"); } else { printf("alljoyn_busattachment connected to \"%s\"\n", alljoyn_busattachment_getconnectspec(g_msgBus)); } } } else { printf("alljoyn_busattachment_start failed\n"); } /* * Advertise this service on the bus * There are three steps to advertising this service on the bus * 1) Request a well-known name that will be used by the client to discover * this service * 2) Create a session * 3) Advertise the well-known name */ /* Request name */ if (ER_OK == status) { uint32_t flags = DBUS_NAME_FLAG_REPLACE_EXISTING | DBUS_NAME_FLAG_DO_NOT_QUEUE; QStatus status = alljoyn_busattachment_requestname(g_msgBus, OBJECT_NAME, flags); if (ER_OK != status) { printf("alljoyn_busattachment_requestname(%s) failed (status=%s)\n", OBJECT_NAME, QCC_StatusText(status)); } } /* Create session port listener */ s_sessionPortListener = alljoyn_sessionportlistener_create(&spl_cbs, NULL); /* Create session */ opts = alljoyn_sessionopts_create(ALLJOYN_TRAFFIC_TYPE_MESSAGES, QCC_FALSE, ALLJOYN_PROXIMITY_ANY, ALLJOYN_TRANSPORT_ANY); if (ER_OK == status) { alljoyn_sessionport sp = SERVICE_PORT; status = alljoyn_busattachment_bindsessionport(g_msgBus, &sp, opts, s_sessionPortListener); if (ER_OK != status) { printf("alljoyn_busattachment_bindsessionport failed (%s)\n", QCC_StatusText(status)); } } /* Advertise name */ if (ER_OK == status) { status = alljoyn_busattachment_advertisename(g_msgBus, OBJECT_NAME, alljoyn_sessionopts_get_transports(opts)); if (status != ER_OK) { printf("Failed to advertise name %s (%s)\n", OBJECT_NAME, QCC_StatusText(status)); } } if (ER_OK == status) { while (g_interrupt == QCC_FALSE) { #ifdef _WIN32 Sleep(100); #else usleep(100 * 1000); #endif } } } /* Deallocate sessionopts */ if (opts) { alljoyn_sessionopts_destroy(opts); } /* Deallocate bus */ if (g_msgBus) { alljoyn_busattachment deleteMe = g_msgBus; g_msgBus = NULL; alljoyn_busattachment_destroy(deleteMe); } /* Deallocate bus listener */ if (g_busListener) { alljoyn_buslistener_destroy(g_busListener); } /* Deallocate session port listener */ if (s_sessionPortListener) { alljoyn_sessionportlistener_destroy(s_sessionPortListener); } /* Deallocate the bus object */ if (testObj) { alljoyn_busobject_destroy(testObj); } #ifdef ROUTER alljoyn_routershutdown(); #endif alljoyn_shutdown(); return (int) status; } alljoyn-15.04b/alljoyn_c/samples/observer/000077500000000000000000000000001255700255500206105ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_c/samples/observer/SConscript000066400000000000000000000021031255700255500226160ustar00rootroot00000000000000# Copyright AllSeen Alliance. All rights reserved. # # Permission to use, copy, modify, and/or distribute this software for any # purpose with or without fee is hereby granted, provided that the above # copyright notice and this permission notice appear in all copies. # # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. # Import('env') clientDistDir = '$C_DISTDIR/samples/observer' # Sample Programs progs = [ env.Program('door_consumer_c', ['door_consumer.c']), ] if env['OS'] in ['linux', 'darwin']: env.Install('$C_DISTDIR/bin/samples', progs ) env.Install(clientDistDir, env.Glob('*.c')) alljoyn-15.04b/alljoyn_c/samples/observer/door_consumer.c000066400000000000000000000466461255700255500236520ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ /* The door_consumer sample is an illustration of the use of the alljoyn_observer. * To make it do something useful, you also need a companion door_provider application. * You can find one in the samples of alljoyn_core (the C++ language binding), or * in the samples of the data-driven API. */ #include #include #include #include #include #include #include #include #include #define INTF_NAME "com.example.Door" #define MAX_WAIT_MS 3000 static QStatus proxy_get_location(alljoyn_proxybusobject proxy, char** location_ret) { QStatus status; alljoyn_msgarg value = alljoyn_msgarg_create(); *location_ret = NULL; status = alljoyn_proxybusobject_getproperty(proxy, INTF_NAME, "Location", value); if (ER_OK == status) { char* location; status = alljoyn_msgarg_get_string(value, &location); if (ER_OK == status) { *location_ret = malloc(strlen(location) + 1); if (*location_ret != NULL) { strcpy(*location_ret, location); } else { status = ER_OUT_OF_MEMORY; } } } alljoyn_msgarg_destroy(value); return status; } static QStatus proxy_get_isopen(alljoyn_proxybusobject proxy, QCC_BOOL* isopen_ret) { QStatus status; alljoyn_msgarg value = alljoyn_msgarg_create(); *isopen_ret = QCC_FALSE; status = alljoyn_proxybusobject_getproperty(proxy, INTF_NAME, "IsOpen", value); if (ER_OK == status) { status = alljoyn_msgarg_get_bool(value, isopen_ret); } alljoyn_msgarg_destroy(value); return status; } static QStatus proxy_get_keycode(alljoyn_proxybusobject proxy, uint32_t* keycode_ret) { QStatus status; alljoyn_msgarg value = alljoyn_msgarg_create(); *keycode_ret = 0; status = alljoyn_proxybusobject_getproperty(proxy, INTF_NAME, "KeyCode", value); if (ER_OK == status) { status = alljoyn_msgarg_get_uint32(value, keycode_ret); } alljoyn_msgarg_destroy(value); return status; } static void help() { printf("q quit\n"); printf("l list all discovered doors\n"); printf("o open door at \n"); printf("c close door at \n"); printf("k knock-and-run at \n"); printf("h display this help message\n"); } static void list_doors(alljoyn_busattachment bus, alljoyn_observer observer) { alljoyn_proxybusobject_ref proxyref; for (proxyref = alljoyn_observer_getfirst(observer); proxyref; proxyref = alljoyn_observer_getnext(observer, proxyref)) { char* location; QCC_BOOL isOpen; alljoyn_proxybusobject proxy = alljoyn_proxybusobject_ref_get(proxyref); QStatus status = proxy_get_isopen(proxy, &isOpen); if (ER_OK != status) { fprintf(stderr, "Could not get IsOpen property for object %s:%s.\n", alljoyn_proxybusobject_getuniquename(proxy), alljoyn_proxybusobject_getpath(proxy)); continue; } status = proxy_get_location(proxy, &location); if (ER_OK != status) { fprintf(stderr, "Could not get Location property for object %s:%s.\n", alljoyn_proxybusobject_getuniquename(proxy), alljoyn_proxybusobject_getpath(proxy)); continue; } printf("Door location: %s open: %s\n", (location != NULL) ? location : "", isOpen ? "yes" : "no"); free(location); } } /** returns a reference that must be decref'ed by the application */ static alljoyn_proxybusobject_ref get_door_at_location(alljoyn_busattachment bus, alljoyn_observer observer, const char* find_location) { alljoyn_proxybusobject_ref proxyref; for (proxyref = alljoyn_observer_getfirst(observer); proxyref; proxyref = alljoyn_observer_getnext(observer, proxyref)) { char* location; alljoyn_proxybusobject proxy = alljoyn_proxybusobject_ref_get(proxyref); QStatus status = proxy_get_location(proxy, &location); if (ER_OK != status) { fprintf(stderr, "Could not get Location property for object %s:%s.\n", alljoyn_proxybusobject_getuniquename(proxy), alljoyn_proxybusobject_getpath(proxy)); continue; } if (location != NULL && !strcmp(find_location, location)) { free(location); return proxyref; } free(location); } return NULL; } static void open_door(alljoyn_busattachment bus, alljoyn_observer observer, const char* location) { alljoyn_proxybusobject_ref proxyref = get_door_at_location(bus, observer, location); if (proxyref) { alljoyn_proxybusobject proxy = alljoyn_proxybusobject_ref_get(proxyref); alljoyn_message reply = alljoyn_message_create(bus); QStatus status = alljoyn_proxybusobject_methodcall(proxy, INTF_NAME, "Open", NULL, 0, reply, MAX_WAIT_MS, 0); if (ER_OK == status) { /* No error */ printf("Opening of door succeeded\n"); } else if (ER_BUS_REPLY_IS_ERROR_MESSAGE == status) { /* MethodReply Error received (an error string) */ char errmsg[200] = { 0 }; size_t size = sizeof(errmsg); const char* errname = alljoyn_message_geterrorname(reply, errmsg, &size); printf("Opening of door @ location %s returned an error: %s (%s).\n", (location != NULL) ? location : "", (errname != NULL) ? errname : "", errmsg); } else { /* Framework error or MethodReply error code */ printf("Opening of door @ location %s returned an error: %s.\n", (location != NULL) ? location : "", QCC_StatusText(status)); } alljoyn_message_destroy(reply); alljoyn_proxybusobject_ref_decref(proxyref); } } static void close_door(alljoyn_busattachment bus, alljoyn_observer observer, const char* location) { alljoyn_proxybusobject_ref proxyref = get_door_at_location(bus, observer, location); if (proxyref) { alljoyn_proxybusobject proxy = alljoyn_proxybusobject_ref_get(proxyref); alljoyn_message reply = alljoyn_message_create(bus); QStatus status = alljoyn_proxybusobject_methodcall(proxy, INTF_NAME, "Close", NULL, 0, reply, MAX_WAIT_MS, 0); if (ER_OK == status) { /* No error */ printf("Closing of door succeeded\n"); } else if (ER_BUS_REPLY_IS_ERROR_MESSAGE == status) { /* MethodReply Error received (an error string) */ char errmsg[200] = { 0 }; size_t size = sizeof(errmsg); const char* errname = alljoyn_message_geterrorname(reply, errmsg, &size); printf("Closing of door @ location %s returned an error: %s (%s).\n", location, (errname != NULL) ? errname : "", errmsg); } else { /* Framework error or MethodReply error code */ printf("Closing of door @ location %s returned an error: %s.\n", location, QCC_StatusText(status)); } alljoyn_message_destroy(reply); alljoyn_proxybusobject_ref_decref(proxyref); } } static void knock_and_run(alljoyn_busattachment bus, alljoyn_observer observer, const char* location) { alljoyn_proxybusobject_ref proxyref = get_door_at_location(bus, observer, location); if (proxyref) { alljoyn_proxybusobject proxy = alljoyn_proxybusobject_ref_get(proxyref); QStatus status = alljoyn_proxybusobject_methodcall_noreply(proxy, INTF_NAME, "Close", NULL, 0, 0); if (ER_OK != status) { printf("A framework error occurred while trying to knock on door @ location %s\n", location); } alljoyn_proxybusobject_ref_decref(proxyref); } } static QCC_BOOL parse(alljoyn_busattachment bus, alljoyn_observer observer, char* input) { char* cmd; char* arg; char* argend; /* ignore leading whitespace */ for (cmd = input; *cmd && isspace(*cmd); ++cmd) { } if (!*cmd) { return QCC_TRUE; } /* look for an argument */ for (arg = cmd + 1; *arg && isspace(*arg); ++arg) { } for (argend = arg; *argend && !isspace(*argend); ++argend) { } *argend = '\0'; switch (*cmd) { case 'q': return QCC_FALSE; case 'l': list_doors(bus, observer); break; case 'o': open_door(bus, observer, arg); break; case 'c': close_door(bus, observer, arg); break; case 'k': knock_and_run(bus, observer, arg); break; case 'h': default: help(); break; } return QCC_TRUE; } static QStatus build_interface(alljoyn_busattachment bus) { QStatus status; alljoyn_interfacedescription intf = NULL; status = alljoyn_busattachment_createinterface(bus, INTF_NAME, &intf); assert(ER_OK == status); status = alljoyn_interfacedescription_addproperty(intf, "IsOpen", "b", ALLJOYN_PROP_ACCESS_READ); assert(ER_OK == status); status = alljoyn_interfacedescription_addpropertyannotation(intf, "IsOpen", "org.freedesktop.DBus.Property.EmitsChangedSignal", "true"); assert(ER_OK == status); status = alljoyn_interfacedescription_addproperty(intf, "Location", "s", ALLJOYN_PROP_ACCESS_READ); assert(ER_OK == status); status = alljoyn_interfacedescription_addpropertyannotation(intf, "Location", "org.freedesktop.DBus.Property.EmitsChangedSignal", "true"); assert(ER_OK == status); status = alljoyn_interfacedescription_addproperty(intf, "KeyCode", "u", ALLJOYN_PROP_ACCESS_READ); assert(ER_OK == status); status = alljoyn_interfacedescription_addpropertyannotation(intf, "KeyCode", "org.freedesktop.DBus.Property.EmitsChangedSignal", "invalidates"); assert(ER_OK == status); status = alljoyn_interfacedescription_addmethod(intf, "Open", "", "", "", 0, NULL); assert(ER_OK == status); status = alljoyn_interfacedescription_addmethod(intf, "Close", "", "", "", 0, NULL); assert(ER_OK == status); status = alljoyn_interfacedescription_addmethod(intf, "KnockAndRun", "", "", "", ALLJOYN_MEMBER_ANNOTATE_NO_REPLY, NULL); assert(ER_OK == status); status = alljoyn_interfacedescription_addsignal(intf, "PersonPassedThrough", "s", "name", 0, NULL); assert(ER_OK == status); alljoyn_interfacedescription_activate(intf); return status; } static QStatus setup_busattachment(alljoyn_busattachment bus) { QStatus status; status = alljoyn_busattachment_start(bus); assert(ER_OK == status); status = alljoyn_busattachment_connect(bus, NULL); assert(ER_OK == status); status = build_interface(bus); assert(ER_OK == status); return status; } struct _listener_ctx { alljoyn_busattachment bus; alljoyn_observer observer; }; static struct _listener_ctx listener_ctx; static const char* door_intf_props[] = { "IsOpen", "Location", "KeyCode" }; static void properties_changed(alljoyn_proxybusobject proxy, const char* intf, const alljoyn_msgarg changed, const alljoyn_msgarg invalidated, void* context) { QStatus status; size_t nelem; alljoyn_msgarg elems; char* location = NULL; struct _listener_ctx* ctx = (struct _listener_ctx*) context; printf("[listener] Door %s:%s has changed some properties.\n", alljoyn_proxybusobject_getuniquename(proxy), alljoyn_proxybusobject_getpath(proxy)); alljoyn_busattachment_enableconcurrentcallbacks(ctx->bus); status = proxy_get_location(proxy, &location); if (status == ER_OK) { printf("\tThat's actually the door at location %s.\n", (location != NULL) ? location : ""); free(location); } if (ER_OK == status) { status = alljoyn_msgarg_get(changed, "a{sv}", &nelem, &elems); } if (ER_OK == status) { size_t i; for (i = 0; i < nelem; ++i) { const char* prop; alljoyn_msgarg val; status = alljoyn_msgarg_get(alljoyn_msgarg_array_element(elems, i), "{sv}", &prop, &val); if (ER_OK == status) { if (!strcmp(prop, "Location")) { char* newloc; status = alljoyn_msgarg_get_string(val, &newloc); if (ER_OK == status) { printf("-> location: %s\n", newloc); } } else if (!strcmp(prop, "IsOpen")) { QCC_BOOL isopen = QCC_FALSE; status = alljoyn_msgarg_get_bool(val, &isopen); if (ER_OK == status) { printf("-> is open: %s\n", isopen ? "yes" : "no"); } } } else { break; } } } if (ER_OK == status) { status = alljoyn_msgarg_get(invalidated, "as", &nelem, &elems); } if (ER_OK == status) { size_t i; for (i = 0; i < nelem; ++i) { char* prop; status = alljoyn_msgarg_get(alljoyn_msgarg_array_element(elems, i), "s", &prop); if (status == ER_OK) { printf(" invalidated %s\n", prop); } } } printf("> "); fflush(stdout); } static void print_door_state(const alljoyn_proxybusobject proxy) { QStatus status; QCC_BOOL isopen; uint32_t keycode; char* location = NULL; /* get properties */ status = proxy_get_location(proxy, &location); if (status == ER_OK) { status = proxy_get_isopen(proxy, &isopen); } if (status == ER_OK) { status = proxy_get_keycode(proxy, &keycode); } if (status == ER_OK) { printf("\tlocation: %s\n", (location != NULL) ? location : ""); printf("\tis open : %s\n", isopen ? "yes" : "no"); printf("\tkeycode : %u\n", (unsigned) keycode); } else { fprintf(stderr, "Could not retrieve door properties.\n"); } if (location) { free(location); } printf("> "); fflush(stdout); } static void object_discovered(const void* context, alljoyn_proxybusobject_ref proxyref) { QStatus status; struct _listener_ctx* ctx = (struct _listener_ctx*) context; alljoyn_proxybusobject proxy = alljoyn_proxybusobject_ref_get(proxyref); printf("[listener] Door %s:%s has just been discovered.\n", alljoyn_proxybusobject_getuniquename(proxy), alljoyn_proxybusobject_getpath(proxy)); alljoyn_busattachment_enableconcurrentcallbacks(ctx->bus); status = alljoyn_proxybusobject_registerpropertieschangedlistener(proxy, INTF_NAME, door_intf_props, 3, properties_changed, &listener_ctx); if (status != ER_OK) { fprintf(stderr, "Could not register properties changed listener\n"); } alljoyn_proxybusobject_enablepropertycaching(proxy); print_door_state(proxy); } static void object_lost(const void* context, alljoyn_proxybusobject_ref proxyref) { alljoyn_proxybusobject proxy = alljoyn_proxybusobject_ref_get(proxyref); printf("[listener] Door %s:%s no longer exists.\n\tLast known state for lost object:\n", alljoyn_proxybusobject_getuniquename(proxy), alljoyn_proxybusobject_getpath(proxy)); print_door_state(proxy); } static alljoyn_observerlistener_callback listener_cbs = { object_discovered, object_lost }; /** the PersonPassedThrough signal handler */ static void person_passed_through(const alljoyn_interfacedescription_member* member, const char* path, alljoyn_message message) { struct _listener_ctx* ctx = &listener_ctx; //alljoyn_c caveat: no way to pass a cookie into signal handlers. alljoyn_proxybusobject_ref proxyref = alljoyn_observer_get(ctx->observer, alljoyn_message_getsender(message), path); if (proxyref) { QStatus status; char* location = NULL; const char* who = NULL; alljoyn_proxybusobject proxy = alljoyn_proxybusobject_ref_get(proxyref); alljoyn_busattachment_enableconcurrentcallbacks(ctx->bus); status = proxy_get_location(proxy, &location); if (status == ER_OK) { status = alljoyn_message_parseargs(message, "s", &who); } if (status == ER_OK) { printf("[listener] %s passed through the door at location %s\n", who, (location != NULL) ? location : ""); } else { fprintf(stderr, "Something went wrong while parsing the received signal: %s\n", QCC_StatusText(status)); } if (location) { free(location); } alljoyn_proxybusobject_ref_decref(proxyref); } else { fprintf(stderr, "Got PersonPassedThrough signal from an unknown door: %s:%s\n", alljoyn_message_getsender(message), path); } printf("> "); fflush(stdout); } int main(int argc, char** argv) { alljoyn_busattachment bus; alljoyn_observer obs; alljoyn_observerlistener listener; alljoyn_interfacedescription intf; alljoyn_interfacedescription_member member; QCC_BOOL done; const char* intfname = INTF_NAME; if (alljoyn_init() != ER_OK) { return 1; } #ifdef ROUTER if (alljoyn_routerinit() != ER_OK) { alljoyn_shutdown(); return 1; } #endif bus = alljoyn_busattachment_create("door_consumer_c", QCC_TRUE); setup_busattachment(bus); obs = alljoyn_observer_create(bus, &intfname, 1); listener_ctx.observer = obs; listener_ctx.bus = bus; listener = alljoyn_observerlistener_create(&listener_cbs, &listener_ctx); alljoyn_observer_registerlistener(obs, listener, QCC_TRUE); intf = alljoyn_busattachment_getinterface(bus, INTF_NAME); alljoyn_interfacedescription_getmember(intf, "PersonPassedThrough", &member); alljoyn_busattachment_registersignalhandler(bus, person_passed_through, member, NULL); done = QCC_FALSE; while (!done) { char input[200]; char* str; printf("> "); fflush(stdout); str = fgets(input, sizeof(input), stdin); if (str == NULL) { break; } str = strchr(input, '\n'); if (str) { *str = '\0'; } done = !parse(bus, obs, input); } // Cleanup alljoyn_observer_destroy(obs); alljoyn_observerlistener_destroy(listener); /* Deallocate bus */ if (bus) { alljoyn_busattachment deleteMe = bus; bus = NULL; alljoyn_busattachment_destroy(deleteMe); } #ifdef ROUTER alljoyn_routershutdown(); #endif alljoyn_shutdown(); return 0; } alljoyn-15.04b/alljoyn_c/samples/secure/000077500000000000000000000000001255700255500202475ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_c/samples/secure/DeskTopSharedKSClientC.c000066400000000000000000000324631255700255500246230ustar00rootroot00000000000000/** * @file * @brief Sample implementation of an AllJoyn client. That has an implmentation * a secure client that is using a shared keystore file. */ /****************************************************************************** * * * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _WIN32 #define _BSD_SOURCE /* usleep */ #endif #include #include #include #include #include #include #include #include #include #include /** Static top level message bus object */ static alljoyn_busattachment g_msgBus = NULL; /** Static bus listener */ static alljoyn_buslistener g_busListener; /** Static auth listener */ static alljoyn_authlistener g_authListener; /*constants*/ static const char* INTERFACE_NAME = "org.alljoyn.bus.samples.secure.SecureInterface"; static const char* OBJECT_NAME = "org.alljoyn.bus.samples.secure"; static const char* OBJECT_PATH = "/SecureService"; static const alljoyn_sessionport SERVICE_PORT = 42; static QCC_BOOL s_joinComplete = QCC_FALSE; static alljoyn_sessionid s_sessionId = 0; static volatile sig_atomic_t g_interrupt = QCC_FALSE; static void CDECL_CALL SigIntHandler(int sig) { g_interrupt = QCC_TRUE; } /* * get a line of input from the file pointer (most likely stdin). * This will capture the num-1 characters or till a newline character is * entered. * * @param[out] str a pointer to a character array that will hold the user input * @param[in] num the size of the character array 'str' * @param[in] fp the file pointer the sting will be read from. (most likely stdin) * * @return returns the same string as 'str' if there has been a read error a null * pointer will be returned and 'str' will remain unchanged. */ char*get_line(char*str, size_t num, FILE*fp) { char*p = fgets(str, num, fp); // fgets will capture the '\n' character if the string entered is shorter than // num. Remove the '\n' from the end of the line and replace it with nul '\0'. if (p != NULL) { size_t last = strlen(str) - 1; if (str[last] == '\n') { str[last] = '\0'; } } return p; } /* FoundAdvertisedName callback */ void AJ_CALL found_advertised_name(const void* context, const char* name, alljoyn_transportmask transport, const char* namePrefix) { printf("found_advertised_name(name=%s, prefix=%s)\n", name, namePrefix); if (0 == strcmp(name, OBJECT_NAME)) { QStatus status; /* We found a remote bus that is advertising basic service's well-known name so connect to it */ alljoyn_sessionopts opts = alljoyn_sessionopts_create(ALLJOYN_TRAFFIC_TYPE_MESSAGES, QCC_FALSE, ALLJOYN_PROXIMITY_ANY, ALLJOYN_TRANSPORT_ANY); alljoyn_busattachment_enableconcurrentcallbacks(g_msgBus); status = alljoyn_busattachment_joinsession(g_msgBus, name, SERVICE_PORT, NULL, &s_sessionId, opts); if (ER_OK != status) { printf("alljoyn_busattachment_joinsession failed (status=%s)\n", QCC_StatusText(status)); } else { printf("alljoyn_busattachment_joinsession SUCCESS (Session id=%d)\n", s_sessionId); } alljoyn_sessionopts_destroy(opts); } s_joinComplete = QCC_TRUE; } /* NameOwnerChanged callback */ void AJ_CALL name_owner_changed(const void* context, const char* busName, const char* previousOwner, const char* newOwner) { if (newOwner && (0 == strcmp(busName, OBJECT_NAME))) { printf("name_owner_changed: name=%s, oldOwner=%s, newOwner=%s\n", busName, previousOwner ? previousOwner : "", newOwner ? newOwner : ""); } } /* * This is the local implementation of the an AuthListener. SrpKeyXListener is * designed to only handle SRP Key Exchange Authentication requests. * * When a Password request (CRED_PASSWORD) comes in using ALLJOYN_SRP_KEYX the * code will ask the user to enter the pin code that was generated by the * service. The pin code must match the service's pin code for Authentication to * be successful. * * If any other authMechanism is used other than SRP Key Exchange authentication * will fail. */ QCC_BOOL AJ_CALL request_credentials(const void* context, const char* authMechanism, const char* authPeer, uint16_t authCount, const char* userName, uint16_t credMask, alljoyn_credentials credentials) { printf("request_credentials for authenticating %s using mechanism %s\n", authPeer, authMechanism); if (strcmp(authMechanism, "ALLJOYN_SRP_KEYX") == 0) { if (credMask & ALLJOYN_CRED_PASSWORD) { if (authCount <= 3) { const int bufSize = 7; char buf[7]; /* Take input from stdin and send it as a chat messages */ printf("Please enter one time password : "); get_line(buf, bufSize, stdin); alljoyn_credentials_setpassword(credentials, buf); return QCC_TRUE; } else { return QCC_FALSE; } } } return QCC_FALSE; } void AJ_CALL authentication_complete(const void* context, const char* authMechanism, const char* peerName, QCC_BOOL success) { printf("authentication_complete %s %s\n", authMechanism, success == QCC_TRUE ? "successful" : "failed"); } /** Main entry point */ int CDECL_CALL main(int argc, char** argv, char** envArg) { QStatus status = ER_OK; alljoyn_interfacedescription testIntf = NULL; alljoyn_buslistener_callbacks callbacks = { NULL, NULL, &found_advertised_name, NULL, &name_owner_changed, NULL, NULL, NULL }; unsigned int count = 0; if (alljoyn_init() != ER_OK) { return 1; } #ifdef ROUTER if (alljoyn_routerinit() != ER_OK) { alljoyn_shutdown(); return 1; } #endif printf("AllJoyn Library version: %s\n", alljoyn_getversion()); printf("AllJoyn Library build info: %s\n", alljoyn_getbuildinfo()); /* Install SIGINT handler */ signal(SIGINT, SigIntHandler); /* Create message bus */ g_msgBus = alljoyn_busattachment_create("SRPSecurityClientC", QCC_TRUE); /* Add org.alljoyn.bus.samples.secure.SecureInterface interface */ status = alljoyn_busattachment_createinterface_secure(g_msgBus, INTERFACE_NAME, &testIntf, AJ_IFC_SECURITY_REQUIRED); if (status == ER_OK) { alljoyn_interfacedescription_addmember(testIntf, ALLJOYN_MESSAGE_METHOD_CALL, "Ping", "s", "s", "inStr1,outStr", 0); alljoyn_interfacedescription_activate(testIntf); } else { printf("Failed to create interface %s\n", INTERFACE_NAME); } /* Start the msg bus */ if (ER_OK == status) { status = alljoyn_busattachment_start(g_msgBus); if (ER_OK != status) { printf("alljoyn_busattachment_start failed\n"); } else { printf("alljoyn_busattachment started.\n"); } } /* * enable security * note the location of the keystore file has been specified and the * isShared parameter is being set to true. So this keystore file can * be used by multiple applications */ if (ER_OK == status) { alljoyn_authlistener_callbacks callbacks = { request_credentials, NULL, NULL, authentication_complete }; g_authListener = alljoyn_authlistener_create(&callbacks, NULL); /* * alljoyn_busattachment_enablepeersecurity function is called by * applications that want to use authentication and encryption. This * function call must be made after alljoyn_busattachment_start and * before calling alljoyn_busattachment_connect. * * In most situations a per-application keystore file is generated. * However, this code specifies the location of the keystore file and * the isShared parameter is being set to QCC_TRUE. The resulting * keystore file can be used by multiple applications. */ status = alljoyn_busattachment_enablepeersecurity(g_msgBus, "ALLJOYN_SRP_KEYX", g_authListener, "/.alljoyn_keystore/central.ks", QCC_TRUE); if (ER_OK != status) { printf("alljoyn_busattachment_enablepeersecurity failed (%s)\n", QCC_StatusText(status)); } else { printf("alljoyn_busattachment_enablepeersecurity Successful\n"); } } /* Connect to the bus */ if (ER_OK == status) { status = alljoyn_busattachment_connect(g_msgBus, NULL); if (ER_OK != status) { printf("alljoyn_busattachment_connect() failed with status: 0x%04x\n", status); } else { printf("alljoyn_busattachment connected to \"%s\"\n", alljoyn_busattachment_getconnectspec(g_msgBus)); } } /* Create a bus listener */ g_busListener = alljoyn_buslistener_create(&callbacks, NULL); /* Register a bus listener in order to get discovery indications */ if (ER_OK == status) { alljoyn_busattachment_registerbuslistener(g_msgBus, g_busListener); printf("alljoyn_buslistener Registered.\n"); } /* Begin discovery on the well-known name of the service to be called */ if (ER_OK == status) { status = alljoyn_busattachment_findadvertisedname(g_msgBus, OBJECT_NAME); if (status != ER_OK) { printf("alljoyn_busattachment_findadvertisedname failed (%s))\n", QCC_StatusText(status)); } } /* Wait for join session to complete */ while (!s_joinComplete && !g_interrupt) { if (0 == (count++ % 10)) { printf("Waited %u seconds for alljoyn_busattachment_joinsession completion.\n", count / 10); } #ifdef _WIN32 Sleep(100); #else usleep(100 * 1000); #endif } if (status == ER_OK && g_interrupt == QCC_FALSE) { alljoyn_message reply; alljoyn_msgarg inputs; size_t numArgs; alljoyn_proxybusobject remoteObj = alljoyn_proxybusobject_create(g_msgBus, OBJECT_NAME, OBJECT_PATH, s_sessionId); const alljoyn_interfacedescription alljoynTestIntf = alljoyn_busattachment_getinterface(g_msgBus, INTERFACE_NAME); assert(alljoynTestIntf); alljoyn_proxybusobject_addinterface(remoteObj, alljoynTestIntf); /* * Although AllJoyn will automatically try and establish a secure connection * when a method call is made. It will only allow the user the amount of time * specified in the methodcall timeout parameter to enter user input. For the * "Ping" method that is 5 seconds. This is not a reasonable amount of time * for a user to see the security password and enter it. * * By calling alljoyn_proxybusobject_secureconnection the user will have * as much time as they need to to enter the security password to secure * the connection. */ status = alljoyn_proxybusobject_secureconnection(remoteObj, QCC_TRUE); if (ER_OK == status) { reply = alljoyn_message_create(g_msgBus); inputs = alljoyn_msgarg_array_create(1); numArgs = 1; status = alljoyn_msgarg_array_set(inputs, &numArgs, "s", "ClientC says Hello AllJoyn!"); status = alljoyn_proxybusobject_methodcall(remoteObj, INTERFACE_NAME, "Ping", inputs, 1, reply, 5000, 0); if (ER_OK == status) { char* ping_str; status = alljoyn_msgarg_get(alljoyn_message_getarg(reply, 0), "s", &ping_str); printf("%s.%s ( path=%s) returned \"%s\"\n", INTERFACE_NAME, "Ping", OBJECT_PATH, ping_str); } else { printf("alljoyn_proxybusobject_methodcall on %s.%s failed\n", INTERFACE_NAME, "Ping"); } alljoyn_msgarg_destroy(inputs); alljoyn_message_destroy(reply); } alljoyn_proxybusobject_destroy(remoteObj); } /* Deallocate bus */ if (g_msgBus) { alljoyn_busattachment deleteMe = g_msgBus; g_msgBus = NULL; alljoyn_busattachment_destroy(deleteMe); } /* Deallocate bus listener */ alljoyn_buslistener_destroy(g_busListener); /* Deallocate auth listener */ alljoyn_authlistener_destroy(g_authListener); printf("exiting with status %d (%s)\n", status, QCC_StatusText(status)); #ifdef ROUTER alljoyn_routershutdown(); #endif alljoyn_shutdown(); return (int) status; } alljoyn-15.04b/alljoyn_c/samples/secure/SConscript000066400000000000000000000016141255700255500222630ustar00rootroot00000000000000# Copyright AllSeen Alliance. All rights reserved. # # Permission to use, copy, modify, and/or distribute this software for any # purpose with or without fee is hereby granted, provided that the above # copyright notice and this permission notice appear in all copies. # # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. # Import('env') # Sample Programs env.Program('DeskTopSharedKSClientC', ['DeskTopSharedKSClientC.c']), alljoyn-15.04b/alljoyn_c/src/000077500000000000000000000000001255700255500161045ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_c/src/AboutData.cc000066400000000000000000000327001255700255500202610ustar00rootroot00000000000000/** * @file * This code is experimental, and as such has not been fully tested. * Please help make it more robust by contributing fixes if you find problems. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #define QCC_MODULE "ALLJOYN_C" struct _alljoyn_aboutdata { /* Empty by design */ }; alljoyn_aboutdata AJ_CALL alljoyn_aboutdata_create_empty() { QCC_DbgTrace(("%s", __FUNCTION__)); return (alljoyn_aboutdata) new ajn::AboutData(); } alljoyn_aboutdata AJ_CALL alljoyn_aboutdata_create(const char* defaultLanguage) { QCC_DbgTrace(("%s", __FUNCTION__)); return (alljoyn_aboutdata) new ajn::AboutData(defaultLanguage); } alljoyn_aboutdata AJ_CALL alljoyn_aboutdata_create_full(const alljoyn_msgarg arg, const char* language) { QCC_DbgTrace(("%s", __FUNCTION__)); return (alljoyn_aboutdata) new ajn::AboutData(*(ajn::MsgArg*)arg, language); } void AJ_CALL alljoyn_aboutdata_destroy(alljoyn_aboutdata data) { QCC_DbgTrace(("%s", __FUNCTION__)); delete (ajn::AboutData*)data; } QStatus AJ_CALL alljoyn_aboutdata_createfromxml(alljoyn_aboutdata data, const char* aboutDataXml) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutData*)data)->CreateFromXml(aboutDataXml); } bool AJ_CALL alljoyn_aboutdata_isvalid(alljoyn_aboutdata data, const char* language) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutData*)data)->IsValid(language); } QStatus AJ_CALL alljoyn_aboutdata_createfrommsgarg(alljoyn_aboutdata data, const alljoyn_msgarg arg, const char* language) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutData*)data)->CreatefromMsgArg(*(ajn::MsgArg*)arg, language); } QStatus AJ_CALL alljoyn_aboutdata_setappid(alljoyn_aboutdata data, const uint8_t* appId, const size_t num) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutData*)data)->SetAppId(appId, num); } QStatus AJ_CALL alljoyn_aboutdata_setappid_fromstring(alljoyn_aboutdata data, const char* appId) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutData*)data)->SetAppId(appId); } QStatus AJ_CALL alljoyn_aboutdata_getappid(alljoyn_aboutdata data, uint8_t** appId, size_t* num) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutData*)data)->GetAppId(appId, num); } QStatus AJ_CALL alljoyn_aboutdata_setdefaultlanguage(alljoyn_aboutdata data, const char* defaultLanguage) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutData*)data)->SetDefaultLanguage(defaultLanguage); } QStatus AJ_CALL alljoyn_aboutdata_getdefaultlanguage(alljoyn_aboutdata data, char** defaultLanguage) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutData*)data)->GetDefaultLanguage(defaultLanguage); } QStatus AJ_CALL alljoyn_aboutdata_setdevicename(alljoyn_aboutdata data, const char* deviceName, const char* language) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutData*)data)->SetDeviceName(deviceName, language); } QStatus AJ_CALL alljoyn_aboutdata_getdevicename(alljoyn_aboutdata data, char** deviceName, const char* language) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutData*)data)->GetDeviceName(deviceName, language); } QStatus AJ_CALL alljoyn_aboutdata_setdeviceid(alljoyn_aboutdata data, const char* deviceId) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutData*)data)->SetDeviceId(deviceId); } QStatus AJ_CALL alljoyn_aboutdata_getdeviceid(alljoyn_aboutdata data, char** deviceId) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutData*)data)->GetDeviceId(deviceId); } QStatus AJ_CALL alljoyn_aboutdata_setappname(alljoyn_aboutdata data, const char* appName, const char* language) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutData*)data)->SetAppName(appName, language); } QStatus AJ_CALL alljoyn_aboutdata_getappname(alljoyn_aboutdata data, char** appName, const char* language) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutData*)data)->GetAppName(appName, language); } QStatus AJ_CALL alljoyn_aboutdata_setmanufacturer(alljoyn_aboutdata data, const char* manufacturer, const char* language) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutData*)data)->SetManufacturer(manufacturer, language); } QStatus AJ_CALL alljoyn_aboutdata_getmanufacturer(alljoyn_aboutdata data, char** manufacturer, const char* language) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutData*)data)->GetManufacturer(manufacturer, language); } QStatus AJ_CALL alljoyn_aboutdata_setmodelnumber(alljoyn_aboutdata data, const char* modelNumber) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutData*)data)->SetModelNumber(modelNumber); } QStatus AJ_CALL alljoyn_aboutdata_getmodelnumber(alljoyn_aboutdata data, char** modelNumber) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutData*)data)->GetModelNumber(modelNumber); } QStatus AJ_CALL alljoyn_aboutdata_setsupportedlanguage(alljoyn_aboutdata data, const char* language) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutData*)data)->SetSupportedLanguage(language); } size_t AJ_CALL alljoyn_aboutdata_getsupportedlanguages(alljoyn_aboutdata data, const char** languageTags, size_t num) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutData*)data)->GetSupportedLanguages(languageTags, num); } QStatus AJ_CALL alljoyn_aboutdata_setdescription(alljoyn_aboutdata data, const char* description, const char* language) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutData*)data)->SetDescription(description, language); } QStatus AJ_CALL alljoyn_aboutdata_getdescription(alljoyn_aboutdata data, char** description, const char* language) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutData*)data)->GetDescription(description, language); } QStatus AJ_CALL alljoyn_aboutdata_setdateofmanufacture(alljoyn_aboutdata data, const char* dateOfManufacture) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutData*)data)->SetDateOfManufacture(dateOfManufacture); } QStatus AJ_CALL alljoyn_aboutdata_getdateofmanufacture(alljoyn_aboutdata data, char** dateOfManufacture) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutData*)data)->GetDateOfManufacture(dateOfManufacture); } QStatus AJ_CALL alljoyn_aboutdata_setsoftwareversion(alljoyn_aboutdata data, const char* softwareVersion) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutData*)data)->SetSoftwareVersion(softwareVersion); } QStatus AJ_CALL alljoyn_aboutdata_getsoftwareversion(alljoyn_aboutdata data, char** softwareVersion) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutData*)data)->GetSoftwareVersion(softwareVersion); } QStatus AJ_CALL alljoyn_aboutdata_getajsoftwareversion(alljoyn_aboutdata data, char** ajSoftwareVersion) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutData*)data)->GetAJSoftwareVersion(ajSoftwareVersion); } QStatus AJ_CALL alljoyn_aboutdata_sethardwareversion(alljoyn_aboutdata data, const char* hardwareVersion) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutData*)data)->SetHardwareVersion(hardwareVersion); } QStatus AJ_CALL alljoyn_aboutdata_gethardwareversion(alljoyn_aboutdata data, char** hardwareVersion) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutData*)data)->GetHardwareVersion(hardwareVersion); } QStatus AJ_CALL alljoyn_aboutdata_setsupporturl(alljoyn_aboutdata data, const char* supportUrl) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutData*)data)->SetSupportUrl(supportUrl); } QStatus AJ_CALL alljoyn_aboutdata_getsupporturl(alljoyn_aboutdata data, char** supportUrl) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutData*)data)->GetSupportUrl(supportUrl); } QStatus AJ_CALL alljoyn_aboutdata_setfield(alljoyn_aboutdata data, const char* name, alljoyn_msgarg value, const char* language) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutData*)data)->SetField(name, *(ajn::MsgArg*)value, language); } QStatus AJ_CALL alljoyn_aboutdata_getfield(alljoyn_aboutdata data, const char* name, alljoyn_msgarg* value, const char* language) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutData*)data)->GetField(name, (ajn::MsgArg*&) *value, language); } size_t AJ_CALL alljoyn_aboutdata_getfields(alljoyn_aboutdata data, const char** fields, size_t num_fields) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutData*)data)->GetFields(fields, num_fields); } QStatus AJ_CALL alljoyn_aboutdata_getaboutdata(alljoyn_aboutdata data, alljoyn_msgarg msgArg, const char* language) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutData*)data)->GetAboutData((ajn::MsgArg*)msgArg, language); } QStatus AJ_CALL alljoyn_aboutdata_getannouncedaboutdata(alljoyn_aboutdata data, alljoyn_msgarg msgArg) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutData*)data)->GetAnnouncedAboutData((ajn::MsgArg*)msgArg); } bool AJ_CALL alljoyn_aboutdata_isfieldrequired(alljoyn_aboutdata data, const char* fieldName) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutData*)data)->IsFieldRequired(fieldName); } bool AJ_CALL alljoyn_aboutdata_isfieldannounced(alljoyn_aboutdata data, const char* fieldName) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutData*)data)->IsFieldAnnounced(fieldName); } bool AJ_CALL alljoyn_aboutdata_isfieldlocalized(alljoyn_aboutdata data, const char* fieldName) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutData*)data)->IsFieldLocalized(fieldName); } const char* AJ_CALL alljoyn_aboutdata_getfieldsignature(alljoyn_aboutdata data, const char* fieldName) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutData*)data)->GetFieldSignature(fieldName); }alljoyn-15.04b/alljoyn_c/src/AboutDataListener.cc000066400000000000000000000100461255700255500217660ustar00rootroot00000000000000/** * @file * This code is experimental, and as such has not been fully tested. * Please help make it more robust by contributing fixes if you find problems. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include "DeferredCallback.h" #include #define QCC_MODULE "ALLJOYN_C" namespace ajn { class AboutDataListenerCallbackC : AboutDataListener { public: AboutDataListenerCallbackC(const alljoyn_aboutdatalistener_callbacks* in_callbacks, const void* in_context) { QCC_DbgTrace(("%s", __FUNCTION__)); memcpy(&callbacks, in_callbacks, sizeof(alljoyn_aboutdatalistener_callbacks)); context = in_context; } QStatus GetAboutData(MsgArg* msgArg, const char* language) { QCC_DbgTrace(("%s", __FUNCTION__)); QStatus ret = ER_OK; if (callbacks.about_datalistener_getaboutdata != NULL) { if (!DeferredCallback::sMainThreadCallbacksOnly) { ret = callbacks.about_datalistener_getaboutdata(context, (alljoyn_msgarg)msgArg, language); } else { DeferredCallback_3* dcb = new DeferredCallback_3(callbacks.about_datalistener_getaboutdata, context, (alljoyn_msgarg)msgArg, language); ret = DEFERRED_CALLBACK_EXECUTE(dcb); } } return ret; } QStatus GetAnnouncedAboutData(MsgArg* msgArg) { QCC_DbgTrace(("%s", __FUNCTION__)); QStatus ret = ER_OK; if (callbacks.about_datalistener_getannouncedaboutdata != NULL) { if (!DeferredCallback::sMainThreadCallbacksOnly) { ret = callbacks.about_datalistener_getannouncedaboutdata(context, (alljoyn_msgarg)msgArg); } else { DeferredCallback_2* dcb = new DeferredCallback_2(callbacks.about_datalistener_getannouncedaboutdata, context, (alljoyn_msgarg)msgArg); ret = DEFERRED_CALLBACK_EXECUTE(dcb); } } return ret; } protected: alljoyn_aboutdatalistener_callbacks callbacks; const void* context; }; } struct _alljoyn_aboutdatalistener_handle { /* Empty by design */ }; alljoyn_aboutdatalistener AJ_CALL alljoyn_aboutdatalistener_create(const alljoyn_aboutdatalistener_callbacks* callbacks, const void* context) { QCC_DbgTrace(("%s", __FUNCTION__)); return (alljoyn_aboutdatalistener) new ajn::AboutDataListenerCallbackC(callbacks, context); } void AJ_CALL alljoyn_aboutdatalistener_destroy(alljoyn_aboutdatalistener listener) { QCC_DbgTrace(("%s", __FUNCTION__)); delete (ajn::AboutDataListenerCallbackC*)listener; } alljoyn-15.04b/alljoyn_c/src/AboutIcon.cc000066400000000000000000000053421255700255500203020ustar00rootroot00000000000000/** * @file * This code is experimental, and as such has not been fully tested. * Please help make it more robust by contributing fixes if you find problems. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #define QCC_MODULE "ALLJOYN_C" struct _alljoyn_abouticon_handle { /* Empty by design */ }; alljoyn_abouticon AJ_CALL alljoyn_abouticon_create() { QCC_DbgTrace(("%s", __FUNCTION__)); return (alljoyn_abouticon) new ajn::AboutIcon(); } void AJ_CALL alljoyn_abouticon_destroy(alljoyn_abouticon icon) { QCC_DbgTrace(("%s", __FUNCTION__)); delete (ajn::AboutIcon*)icon; } QStatus AJ_CALL alljoyn_abouticon_setcontent(alljoyn_abouticon icon, const char* type, uint8_t* data, size_t csize, bool ownsData) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutIcon*)icon)->SetContent(type, data, csize, ownsData); } QStatus AJ_CALL alljoyn_abouticon_seturl(alljoyn_abouticon icon, const char* type, const char* url) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutIcon*)icon)->SetUrl(type, url); } void AJ_CALL alljoyn_abouticon_clear(alljoyn_abouticon icon) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutIcon*)icon)->Clear(); } QStatus AJ_CALL alljoyn_abouticon_setcontent_frommsgarg(alljoyn_abouticon icon, const alljoyn_msgarg arg) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutIcon*)icon)->SetContent(*(ajn::MsgArg*)arg); }alljoyn-15.04b/alljoyn_c/src/AboutIconObj.cc000066400000000000000000000034551255700255500207400ustar00rootroot00000000000000/** * @file * This code is experimental, and as such has not been fully tested. * Please help make it more robust by contributing fixes if you find problems. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #define QCC_MODULE "ALLJOYN_C" struct _alljoyn_abouticonobj_handle { /* Empty by design */ }; alljoyn_abouticonobj AJ_CALL alljoyn_abouticonobj_create(alljoyn_busattachment bus, alljoyn_abouticon icon) { QCC_DbgTrace(("%s", __FUNCTION__)); return (alljoyn_abouticonobj) new ajn::AboutIconObj(*(ajn::BusAttachment*)bus, *(ajn::AboutIcon*)icon); } void AJ_CALL alljoyn_abouticonobj_destroy(alljoyn_abouticonobj icon) { QCC_DbgTrace(("%s", __FUNCTION__)); delete (ajn::AboutIconObj*)icon; }alljoyn-15.04b/alljoyn_c/src/AboutIconProxy.cc000066400000000000000000000046341255700255500213470ustar00rootroot00000000000000/** * @file * This code is experimental, and as such has not been fully tested. * Please help make it more robust by contributing fixes if you find problems. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #define QCC_MODULE "ALLJOYN_C" struct _alljoyn_abouticonproxy { /* Empty by design */ }; alljoyn_abouticonproxy AJ_CALL alljoyn_abouticonproxy_create(alljoyn_busattachment bus, const char* busName, alljoyn_sessionid sessionId) { QCC_DbgTrace(("%s", __FUNCTION__)); return (alljoyn_abouticonproxy) new ajn::AboutIconProxy(*(ajn::BusAttachment*)bus, busName, (ajn::SessionId)sessionId); } void AJ_CALL alljoyn_abouticonproxy_destroy(alljoyn_abouticonproxy proxy) { QCC_DbgTrace(("%s", __FUNCTION__)); delete (ajn::AboutIconProxy*)proxy; } QStatus AJ_CALL alljoyn_abouticonproxy_geticon(alljoyn_abouticonproxy proxy, alljoyn_abouticon icon) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutIconProxy*)proxy)->GetIcon(*(ajn::AboutIcon*)icon); } AJ_API QStatus AJ_CALL alljoyn_abouticonproxy_getversion(alljoyn_abouticonproxy proxy, uint16_t* version) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutIconProxy*)proxy)->GetVersion(*version); }alljoyn-15.04b/alljoyn_c/src/AboutListener.cc000066400000000000000000000075461255700255500212070ustar00rootroot00000000000000/** * @file * This code is experimental, and as such has not been fully tested. * Please help make it more robust by contributing fixes if you find problems. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include "DeferredCallback.h" #include #define QCC_MODULE "ALLJOYN_C" namespace ajn { class AboutListenerCallbackC : AboutListener { public: AboutListenerCallbackC(const alljoyn_aboutlistener_callback* in_callback, const void* in_context) { QCC_DbgTrace(("%s", __FUNCTION__)); memcpy(&callback, in_callback, sizeof(alljoyn_aboutlistener_callback)); context = in_context; } void Announced(const char* busName, uint16_t version, SessionPort port, const MsgArg& objectDescriptionArg, const MsgArg& aboutDataArg) { QCC_DbgTrace(("%s", __FUNCTION__)); if (callback.about_listener_announced != NULL) { if (!DeferredCallback::sMainThreadCallbacksOnly) { callback.about_listener_announced(context, busName, version, port, (alljoyn_msgarg) & objectDescriptionArg, (alljoyn_msgarg) & aboutDataArg); } else { DeferredCallback_6* dcb = new DeferredCallback_6( callback.about_listener_announced, context, busName, version, port, (alljoyn_msgarg) & objectDescriptionArg, (alljoyn_msgarg) & aboutDataArg); DEFERRED_CALLBACK_EXECUTE(dcb); } } } protected: alljoyn_aboutlistener_callback callback; const void* context; }; } struct _alljoyn_aboutlistener_handle { /* Empty by design */ }; alljoyn_aboutlistener AJ_CALL alljoyn_aboutlistener_create(const alljoyn_aboutlistener_callback* callback, const void* context) { QCC_DbgTrace(("%s", __FUNCTION__)); return (alljoyn_aboutlistener) new ajn::AboutListenerCallbackC(callback, context); } void AJ_CALL alljoyn_aboutlistener_destroy(alljoyn_aboutlistener listener) { QCC_DbgTrace(("%s", __FUNCTION__)); delete (ajn::AboutListenerCallbackC*)listener; } alljoyn-15.04b/alljoyn_c/src/AboutObj.cc000066400000000000000000000053661255700255500201320ustar00rootroot00000000000000/** * @file * This code is experimental, and as such has not been fully tested. * Please help make it more robust by contributing fixes if you find problems. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #define QCC_MODULE "ALLJOYN_C" struct _alljoyn_aboutobj { /* Empty by design */ }; alljoyn_aboutobj AJ_CALL alljoyn_aboutobj_create(alljoyn_busattachment bus, alljoyn_about_announceflag isAnnounced) { QCC_DbgTrace(("%s", __FUNCTION__)); return (alljoyn_aboutobj) new ajn::AboutObj(*(ajn::BusAttachment*)bus, (ajn::BusObject::AnnounceFlag)isAnnounced); } void AJ_CALL alljoyn_aboutobj_destroy(alljoyn_aboutobj obj) { QCC_DbgTrace(("%s", __FUNCTION__)); delete (ajn::AboutObj*)obj; } QStatus AJ_CALL alljoyn_aboutobj_announce(alljoyn_aboutobj obj, alljoyn_sessionport sessionPort, alljoyn_aboutdata aboutData) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutObj*)obj)->Announce((ajn::SessionPort)sessionPort, *(ajn::AboutDataListener*)aboutData); } QStatus AJ_CALL alljoyn_aboutobj_announce_using_datalistener(alljoyn_aboutobj obj, alljoyn_sessionport sessionPort, alljoyn_aboutdatalistener aboutListener) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutObj*)obj)->Announce((ajn::SessionPort)sessionPort, *(ajn::AboutDataListener*)aboutListener); } QStatus AJ_CALL alljoyn_aboutobj_unannounce(alljoyn_aboutobj obj) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutObj*)obj)->Unannounce(); }alljoyn-15.04b/alljoyn_c/src/AboutObjectDescription.cc000066400000000000000000000122141255700255500230200ustar00rootroot00000000000000/** * @file * This code is experimental, and as such has not been fully tested. * Please help make it more robust by contributing fixes if you find problems. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #define QCC_MODULE "ALLJOYN_C" struct _alljoyn_aboutobjectdescription { /* Empty by design */ }; alljoyn_aboutobjectdescription AJ_CALL alljoyn_aboutobjectdescription_create() { QCC_DbgTrace(("%s", __FUNCTION__)); return (alljoyn_aboutobjectdescription) new ajn::AboutObjectDescription(); } alljoyn_aboutobjectdescription AJ_CALL alljoyn_aboutobjectdescription_create_full(const alljoyn_msgarg arg) { QCC_DbgTrace(("%s", __FUNCTION__)); return (alljoyn_aboutobjectdescription) new ajn::AboutObjectDescription(*(ajn::MsgArg*)arg); } void AJ_CALL alljoyn_aboutobjectdescription_destroy(alljoyn_aboutobjectdescription description) { QCC_DbgTrace(("%s", __FUNCTION__)); delete (ajn::AboutObjectDescription*)description; } QStatus AJ_CALL alljoyn_aboutobjectdescription_createfrommsgarg(alljoyn_aboutobjectdescription description, const alljoyn_msgarg arg) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutObjectDescription*)description)->CreateFromMsgArg(*(ajn::MsgArg*)arg); } size_t AJ_CALL alljoyn_aboutobjectdescription_getpaths(alljoyn_aboutobjectdescription description, const char** paths, size_t numPaths) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutObjectDescription*)description)->GetPaths(paths, numPaths); } size_t AJ_CALL alljoyn_aboutobjectdescription_getinterfaces(alljoyn_aboutobjectdescription description, const char* path, const char** interfaces, size_t numInterfaces) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutObjectDescription*)description)->GetInterfaces(path, interfaces, numInterfaces); } size_t AJ_CALL alljoyn_aboutobjectdescription_getinterfacepaths(alljoyn_aboutobjectdescription description, const char* interfaceName, const char** paths, size_t numPaths) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutObjectDescription*)description)->GetInterfacePaths(interfaceName, paths, numPaths); } void AJ_CALL alljoyn_aboutobjectdescription_clear(alljoyn_aboutobjectdescription description) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutObjectDescription*)description)->Clear(); } bool AJ_CALL alljoyn_aboutobjectdescription_haspath(alljoyn_aboutobjectdescription description, const char* path) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutObjectDescription*)description)->HasPath(path); } bool AJ_CALL alljoyn_aboutobjectdescription_hasinterface(alljoyn_aboutobjectdescription description, const char* interfaceName) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutObjectDescription*)description)->HasInterface(interfaceName); } bool AJ_CALL alljoyn_aboutobjectdescription_hasinterfaceatpath(alljoyn_aboutobjectdescription description, const char* path, const char* interfaceName) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutObjectDescription*)description)->HasInterface(path, interfaceName); } QStatus AJ_CALL alljoyn_aboutobjectdescription_getmsgarg(alljoyn_aboutobjectdescription description, alljoyn_msgarg msgArg) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutObjectDescription*)description)->GetMsgArg((ajn::MsgArg*)msgArg); }alljoyn-15.04b/alljoyn_c/src/AboutProxy.cc000066400000000000000000000054521255700255500205350ustar00rootroot00000000000000/** * @file * This code is experimental, and as such has not been fully tested. * Please help make it more robust by contributing fixes if you find problems. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #define QCC_MODULE "ALLJOYN_C" struct _alljoyn_aboutproxy_handle { /* Empty by design */ }; alljoyn_aboutproxy AJ_CALL alljoyn_aboutproxy_create(alljoyn_busattachment bus, const char* busName, alljoyn_sessionid sessionId) { QCC_DbgTrace(("%s", __FUNCTION__)); return (alljoyn_aboutproxy) new ajn::AboutProxy(*(ajn::BusAttachment*)bus, busName, (ajn::SessionId)sessionId); } void AJ_CALL alljoyn_aboutproxy_destroy(alljoyn_aboutproxy proxy) { QCC_DbgTrace(("%s", __FUNCTION__)); delete (ajn::AboutProxy*)proxy; } QStatus AJ_CALL alljoyn_aboutproxy_getobjectdescription(alljoyn_aboutproxy proxy, alljoyn_msgarg objectDesc) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutProxy*)proxy)->GetObjectDescription(*(ajn::MsgArg*)objectDesc); } QStatus AJ_CALL alljoyn_aboutproxy_getaboutdata(alljoyn_aboutproxy proxy, const char* language, alljoyn_msgarg data) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutProxy*)proxy)->GetAboutData(language, *(ajn::MsgArg*)data); } QStatus AJ_CALL alljoyn_aboutproxy_getversion(alljoyn_aboutproxy proxy, uint16_t* version) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AboutProxy*)proxy)->GetVersion(*version); }alljoyn-15.04b/alljoyn_c/src/AuthListener.cc000066400000000000000000000260611255700255500210270ustar00rootroot00000000000000/** * @file * * This file implements a AuthListener subclass for use by the C API */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #define QCC_MODULE "ALLJOYN_C" using namespace qcc; using namespace std; namespace ajn { /** * Abstract base class implemented by AllJoyn users and called by AllJoyn to inform * users of bus related events. */ class AuthListenerCallbackC : public AuthListener { public: AuthListenerCallbackC(const alljoyn_authlistener_callbacks* callbacks_in, const void* context_in) { QCC_DbgTrace(("%s", __FUNCTION__)); memcpy(&callbacks, callbacks_in, sizeof(alljoyn_authlistener_callbacks)); context = context_in; } virtual bool RequestCredentials(const char* authMechanism, const char* peerName, uint16_t authCount, const char* userName, uint16_t credMask, Credentials& credentials) { QCC_DbgTrace(("%s", __FUNCTION__)); assert(callbacks.request_credentials != NULL && "request_credentials callback must be specified"); bool ret = (callbacks.request_credentials(context, authMechanism, peerName, authCount, userName, credMask, (alljoyn_credentials)(&credentials)) == QCC_TRUE ? true : false); return ret; } virtual bool VerifyCredentials(const char* authMechanism, const char* peerName, const Credentials& credentials) { QCC_DbgTrace(("%s", __FUNCTION__)); bool ret = AuthListener::VerifyCredentials(authMechanism, peerName, credentials); if (callbacks.verify_credentials != NULL) { ret = (callbacks.verify_credentials(context, authMechanism, peerName, (alljoyn_credentials)(&credentials)) == QCC_TRUE ? true : false); } return ret; } virtual void SecurityViolation(QStatus status, const Message& msg) { QCC_DbgTrace(("%s", __FUNCTION__)); if (callbacks.security_violation != NULL) { callbacks.security_violation(context, status, (alljoyn_message)(&msg)); } } virtual void AuthenticationComplete(const char* authMechanism, const char* peerName, bool success) { QCC_DbgTrace(("%s", __FUNCTION__)); assert(callbacks.authentication_complete != NULL && "authentication_complete callback must be specified"); callbacks.authentication_complete(context, authMechanism, peerName, (success == true ? QCC_TRUE : QCC_FALSE)); } private: alljoyn_authlistener_callbacks callbacks; const void* context; }; class AuthListenerAsyncCallbackC : public AuthListener { public: AuthListenerAsyncCallbackC(const alljoyn_authlistenerasync_callbacks* callbacks_in, const void* context_in) { QCC_DbgTrace(("%s", __FUNCTION__)); memcpy(&callbacks, callbacks_in, sizeof(alljoyn_authlistener_callbacks)); context = context_in; } virtual QStatus RequestCredentialsAsync(const char* authMechanism, const char* authPeer, uint16_t authCount, const char* userName, uint16_t credMask, void* authContext) { QCC_DbgTrace(("%s", __FUNCTION__)); assert(callbacks.request_credentials != NULL && "request_credentials callback must be specified"); QStatus ret = callbacks.request_credentials(context, (alljoyn_authlistener) this, authMechanism, authPeer, authCount, userName, credMask, authContext); return ret; } virtual QStatus VerifyCredentialsAsync(const char* authMechanism, const char* authPeer, const Credentials& credentials, void* authContext) { QCC_DbgTrace(("%s", __FUNCTION__)); QStatus ret = ER_NOT_IMPLEMENTED; if (callbacks.verify_credentials != NULL) { ret = callbacks.verify_credentials(context, (alljoyn_authlistener) this, authMechanism, authPeer, (alljoyn_credentials)(&credentials), authContext); } return ret; } virtual void SecurityViolation(QStatus status, const Message& msg) { QCC_DbgTrace(("%s", __FUNCTION__)); if (callbacks.security_violation != NULL) { callbacks.security_violation(context, status, (alljoyn_message)(&msg)); } } virtual void AuthenticationComplete(const char* authMechanism, const char* peerName, bool success) { QCC_DbgTrace(("%s", __FUNCTION__)); assert(callbacks.authentication_complete != NULL && "authentication_complete callback must be specified"); callbacks.authentication_complete(context, authMechanism, peerName, (success == true ? QCC_TRUE : QCC_FALSE)); } private: alljoyn_authlistenerasync_callbacks callbacks; const void* context; }; } struct _alljoyn_authlistener_handle { /* Empty by design, this is just to allow the type restrictions to save coders from themselves */ }; alljoyn_authlistener AJ_CALL alljoyn_authlistener_create(const alljoyn_authlistener_callbacks* callbacks, const void* context) { QCC_DbgTrace(("%s", __FUNCTION__)); return (alljoyn_authlistener) new ajn::AuthListenerCallbackC(callbacks, context); } void AJ_CALL alljoyn_authlistener_destroy(alljoyn_authlistener listener) { QCC_DbgTrace(("%s", __FUNCTION__)); assert(listener != NULL && "listener parameter must not be NULL"); delete (ajn::AuthListenerCallbackC*)listener; } alljoyn_authlistener AJ_CALL alljoyn_authlistenerasync_create(const alljoyn_authlistenerasync_callbacks* callbacks, const void* context) { QCC_DbgTrace(("%s", __FUNCTION__)); return (alljoyn_authlistener) new ajn::AuthListenerAsyncCallbackC(callbacks, context); } void AJ_CALL alljoyn_authlistenerasync_destroy(alljoyn_authlistener listener) { QCC_DbgTrace(("%s", __FUNCTION__)); assert(listener != NULL && "listener parameter must not be NULL"); delete (ajn::AuthListenerAsyncCallbackC*)listener; } QStatus AJ_CALL alljoyn_authlistener_requestcredentialsresponse(alljoyn_authlistener listener, void* authContext, QCC_BOOL accept, alljoyn_credentials credentials) { QCC_UNUSED(listener); QCC_DbgTrace(("%s", __FUNCTION__)); assert(listener != NULL && "listener parameter must not be NULL"); return ((ajn::AuthListenerAsyncCallbackC*)listener)->RequestCredentialsResponse(authContext, (accept == QCC_TRUE) ? true : false, *((ajn::AuthListener::Credentials*)credentials)); } QStatus AJ_CALL alljoyn_authlistener_verifycredentialsresponse(alljoyn_authlistener listener, void* authContext, QCC_BOOL accept) { QCC_UNUSED(listener); QCC_DbgTrace(("%s", __FUNCTION__)); assert(listener != NULL && "listener parameter must not be NULL"); return ((ajn::AuthListenerAsyncCallbackC*)listener)->VerifyCredentialsResponse(authContext, (accept == QCC_TRUE) ? true : false); } struct _alljoyn_credentials_handle { /* Empty by design, this is just to allow the type restrictions to save coders from themselves */ }; alljoyn_credentials AJ_CALL alljoyn_credentials_create() { QCC_DbgTrace(("%s", __FUNCTION__)); return (alljoyn_credentials) new ajn::AuthListener::Credentials(); } void AJ_CALL alljoyn_credentials_destroy(alljoyn_credentials cred) { QCC_DbgTrace(("%s", __FUNCTION__)); assert(cred != NULL && "cred parameter must not be NULL"); delete (ajn::AuthListener::Credentials*)cred; } QCC_BOOL AJ_CALL alljoyn_credentials_isset(const alljoyn_credentials cred, uint16_t creds) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AuthListener::Credentials*)cred)->IsSet(creds) == true ? QCC_TRUE : QCC_FALSE; } void AJ_CALL alljoyn_credentials_setpassword(alljoyn_credentials cred, const char* pwd) { QCC_DbgTrace(("%s", __FUNCTION__)); ((ajn::AuthListener::Credentials*)cred)->SetPassword(pwd); } void AJ_CALL alljoyn_credentials_setusername(alljoyn_credentials cred, const char* userName) { QCC_DbgTrace(("%s", __FUNCTION__)); ((ajn::AuthListener::Credentials*)cred)->SetUserName(userName); } void AJ_CALL alljoyn_credentials_setcertchain(alljoyn_credentials cred, const char* certChain) { QCC_DbgTrace(("%s", __FUNCTION__)); ((ajn::AuthListener::Credentials*)cred)->SetCertChain(certChain); } void AJ_CALL alljoyn_credentials_setprivatekey(alljoyn_credentials cred, const char* pk) { QCC_DbgTrace(("%s", __FUNCTION__)); ((ajn::AuthListener::Credentials*)cred)->SetPrivateKey(pk); } void AJ_CALL alljoyn_credentials_setlogonentry(alljoyn_credentials cred, const char* logonEntry) { QCC_DbgTrace(("%s", __FUNCTION__)); ((ajn::AuthListener::Credentials*)cred)->SetLogonEntry(logonEntry); } void AJ_CALL alljoyn_credentials_setexpiration(alljoyn_credentials cred, uint32_t expiration) { QCC_DbgTrace(("%s", __FUNCTION__)); ((ajn::AuthListener::Credentials*)cred)->SetExpiration(expiration); } const char* AJ_CALL alljoyn_credentials_getpassword(const alljoyn_credentials cred) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AuthListener::Credentials*)cred)->GetPassword().c_str(); } const char* AJ_CALL alljoyn_credentials_getusername(const alljoyn_credentials cred) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AuthListener::Credentials*)cred)->GetUserName().c_str(); } const char* AJ_CALL alljoyn_credentials_getcertchain(const alljoyn_credentials cred) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AuthListener::Credentials*)cred)->GetCertChain().c_str(); } const char* AJ_CALL alljoyn_credentials_getprivateKey(const alljoyn_credentials cred) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AuthListener::Credentials*)cred)->GetPrivateKey().c_str(); } const char* AJ_CALL alljoyn_credentials_getlogonentry(const alljoyn_credentials cred) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AuthListener::Credentials*)cred)->GetLogonEntry().c_str(); } uint32_t AJ_CALL alljoyn_credentials_getexpiration(const alljoyn_credentials cred) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::AuthListener::Credentials*)cred)->GetExpiration(); } void AJ_CALL alljoyn_credentials_clear(alljoyn_credentials cred) { QCC_DbgTrace(("%s", __FUNCTION__)); ((ajn::AuthListener::Credentials*)cred)->Clear(); } alljoyn-15.04b/alljoyn_c/src/BusAttachment.cc000066400000000000000000000642471255700255500211720ustar00rootroot00000000000000/** * @file * BusAttachment is the top-level object responsible for connecting to and optionally managing a message bus. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include "BusAttachmentC.h" #include #define QCC_MODULE "ALLJOYN_C" struct _alljoyn_busattachment_handle { /* Empty by design, this is just to allow the type restrictions to save coders from themselves */ }; alljoyn_busattachment AJ_CALL alljoyn_busattachment_create(const char* applicationName, QCC_BOOL allowRemoteMessages) { QCC_DbgTrace(("%s", __FUNCTION__)); bool allowRemoteMessagesBool = (allowRemoteMessages == QCC_TRUE ? true : false); return ((alljoyn_busattachment) new ajn::BusAttachmentC(applicationName, allowRemoteMessagesBool)); } alljoyn_busattachment AJ_CALL alljoyn_busattachment_create_concurrency(const char* applicationName, QCC_BOOL allowRemoteMessages, uint32_t concurrency) { QCC_DbgTrace(("%s", __FUNCTION__)); bool allowRemoteMessagesBool = (allowRemoteMessages == QCC_TRUE ? true : false); return ((alljoyn_busattachment) new ajn::BusAttachmentC(applicationName, allowRemoteMessagesBool, concurrency)); } void AJ_CALL alljoyn_busattachment_destroy(alljoyn_busattachment bus) { QCC_DbgTrace(("%s", __FUNCTION__)); assert(bus != NULL && "NULL parameter passed to alljoyn_destroy_busattachment."); delete (ajn::BusAttachmentC*)bus; } QStatus AJ_CALL alljoyn_busattachment_start(alljoyn_busattachment bus) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->Start(); } QStatus AJ_CALL alljoyn_busattachment_stop(alljoyn_busattachment bus) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->Stop(); } QStatus AJ_CALL alljoyn_busattachment_join(alljoyn_busattachment bus) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->Join(); } uint32_t AJ_CALL alljoyn_busattachment_getconcurrency(alljoyn_busattachment bus) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->GetConcurrency(); } const char* AJ_CALL alljoyn_busattachment_getconnectspec(alljoyn_busattachment bus) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->GetConnectSpec().c_str(); } void AJ_CALL alljoyn_busattachment_enableconcurrentcallbacks(alljoyn_busattachment bus) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->EnableConcurrentCallbacks(); } QStatus AJ_CALL alljoyn_busattachment_createinterface(alljoyn_busattachment bus, const char* name, alljoyn_interfacedescription* iface) { QCC_DbgTrace(("%s", __FUNCTION__)); ajn::InterfaceDescription* ifaceObj = NULL; QStatus ret = ((ajn::BusAttachmentC*)bus)->CreateInterface(name, ifaceObj); *iface = (alljoyn_interfacedescription)ifaceObj; return ret; } QStatus AJ_CALL alljoyn_busattachment_createinterface_secure(alljoyn_busattachment bus, const char* name, alljoyn_interfacedescription* iface, alljoyn_interfacedescription_securitypolicy secPolicy) { QCC_DbgTrace(("%s", __FUNCTION__)); ajn::InterfaceDescription* ifaceObj = NULL; QStatus ret = ((ajn::BusAttachmentC*)bus)->CreateInterface(name, ifaceObj, static_cast(secPolicy)); *iface = (alljoyn_interfacedescription)ifaceObj; return ret; } QStatus AJ_CALL alljoyn_busattachment_connect(alljoyn_busattachment bus, const char* connectSpec) { QCC_DbgTrace(("%s", __FUNCTION__)); if (connectSpec == NULL) { return ((ajn::BusAttachmentC*)bus)->Connect(); } // Because the second parameter to Connect is only used internally it is not exposed to the C interface. return ((ajn::BusAttachmentC*)bus)->Connect(connectSpec); } void AJ_CALL alljoyn_busattachment_registerbuslistener(alljoyn_busattachment bus, alljoyn_buslistener listener) { QCC_DbgTrace(("%s", __FUNCTION__)); ((ajn::BusAttachmentC*)bus)->RegisterBusListener((*(ajn::BusListener*)listener)); } void AJ_CALL alljoyn_busattachment_unregisterbuslistener(alljoyn_busattachment bus, alljoyn_buslistener listener) { QCC_DbgTrace(("%s", __FUNCTION__)); ((ajn::BusAttachmentC*)bus)->UnregisterBusListener((*(ajn::BusListener*)listener)); } QStatus AJ_CALL alljoyn_busattachment_findadvertisedname(alljoyn_busattachment bus, const char* namePrefix) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->FindAdvertisedName(namePrefix); } QStatus AJ_CALL alljoyn_busattachment_findadvertisednamebytransport(alljoyn_busattachment bus, const char* namePrefix, alljoyn_transportmask transports) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->FindAdvertisedNameByTransport(namePrefix, transports); } QStatus AJ_CALL alljoyn_busattachment_cancelfindadvertisedname(alljoyn_busattachment bus, const char* namePrefix) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->CancelFindAdvertisedName(namePrefix); } QStatus AJ_CALL alljoyn_busattachment_cancelfindadvertisednamebytransport(alljoyn_busattachment bus, const char* namePrefix, alljoyn_transportmask transports) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->CancelFindAdvertisedNameByTransport(namePrefix, transports); } const alljoyn_interfacedescription AJ_CALL alljoyn_busattachment_getinterface(alljoyn_busattachment bus, const char* name) { QCC_DbgTrace(("%s", __FUNCTION__)); return (alljoyn_interfacedescription)((ajn::BusAttachmentC*)bus)->GetInterface(name); } QStatus AJ_CALL alljoyn_busattachment_joinsession(alljoyn_busattachment bus, const char* sessionHost, alljoyn_sessionport sessionPort, alljoyn_sessionlistener listener, alljoyn_sessionid* sessionId, alljoyn_sessionopts opts) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->JoinSession(sessionHost, (ajn::SessionPort)sessionPort, (ajn::SessionListener*)listener, *((ajn::SessionId*)sessionId), *((ajn::SessionOpts*)opts)); } QStatus AJ_CALL alljoyn_busattachment_joinsessionasync(alljoyn_busattachment bus, const char* sessionHost, alljoyn_sessionport sessionPort, alljoyn_sessionlistener listener, const alljoyn_sessionopts opts, alljoyn_busattachment_joinsessioncb_ptr callback, void* context) { QCC_DbgTrace(("%s", __FUNCTION__)); /* * the instance of the ajn::JoinsessionCallbackContext is freed when the * JoinSessionCB is called. */ return ((ajn::BusAttachmentC*)bus)->JoinSessionAsync(sessionHost, (ajn::SessionPort)sessionPort, (ajn::SessionListener*)listener, *((ajn::SessionOpts*)opts), (ajn::BusAttachmentC*)bus, (void*)new ajn::JoinsessionCallbackContext(callback, context)); } QStatus AJ_CALL alljoyn_busattachment_registerbusobject(alljoyn_busattachment bus, alljoyn_busobject obj) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->RegisterBusObject(*((ajn::BusObject*)obj)); } QStatus AJ_CALL alljoyn_busattachment_registerbusobject_secure(alljoyn_busattachment bus, alljoyn_busobject obj) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->RegisterBusObject(*((ajn::BusObject*)obj), true); } void AJ_CALL alljoyn_busattachment_unregisterbusobject(alljoyn_busattachment bus, alljoyn_busobject object) { QCC_DbgTrace(("%s", __FUNCTION__)); ((ajn::BusAttachmentC*)bus)->UnregisterBusObject(*((ajn::BusObject*)object)); } QStatus AJ_CALL alljoyn_busattachment_requestname(alljoyn_busattachment bus, const char* requestedName, uint32_t flags) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->RequestName(requestedName, flags); } QStatus AJ_CALL alljoyn_busattachment_bindsessionport(alljoyn_busattachment bus, alljoyn_sessionport* sessionPort, const alljoyn_sessionopts opts, alljoyn_sessionportlistener listener) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->BindSessionPort(*((ajn::SessionPort*)sessionPort), *((const ajn::SessionOpts*)opts), *((ajn::SessionPortListener*)listener)); } QStatus AJ_CALL alljoyn_busattachment_unbindsessionport(alljoyn_busattachment bus, alljoyn_sessionport sessionPort) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->UnbindSessionPort(sessionPort); } QStatus AJ_CALL alljoyn_busattachment_advertisename(alljoyn_busattachment bus, const char* name, alljoyn_transportmask transports) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->AdvertiseName(name, transports); } QStatus AJ_CALL alljoyn_busattachment_canceladvertisename(alljoyn_busattachment bus, const char* name, alljoyn_transportmask transports) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->CancelAdvertiseName(name, transports); } QStatus AJ_CALL alljoyn_busattachment_enablepeersecurity(alljoyn_busattachment bus, const char* authMechanisms, alljoyn_authlistener listener, const char* keyStoreFileName, QCC_BOOL isShared) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->EnablePeerSecurity(authMechanisms, (ajn::AuthListener*)listener, keyStoreFileName, (isShared == QCC_TRUE ? true : false)); } QCC_BOOL AJ_CALL alljoyn_busattachment_ispeersecurityenabled(alljoyn_busattachment bus) { QCC_DbgTrace(("%s", __FUNCTION__)); return (((ajn::BusAttachmentC*)bus)->IsPeerSecurityEnabled() == true ? QCC_TRUE : QCC_FALSE); } QStatus AJ_CALL alljoyn_busattachment_createinterfacesfromxml(alljoyn_busattachment bus, const char* xml) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->CreateInterfacesFromXml(xml); } size_t AJ_CALL alljoyn_busattachment_getinterfaces(const alljoyn_busattachment bus, const alljoyn_interfacedescription* ifaces, size_t numIfaces) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->GetInterfaces((const ajn::InterfaceDescription**)ifaces, numIfaces); } QStatus AJ_CALL alljoyn_busattachment_deleteinterface(alljoyn_busattachment bus, alljoyn_interfacedescription iface) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->DeleteInterface(*((ajn::InterfaceDescription*)iface)); } QCC_BOOL AJ_CALL alljoyn_busattachment_isstarted(alljoyn_busattachment bus) { QCC_DbgTrace(("%s", __FUNCTION__)); return (((ajn::BusAttachmentC*)bus)->IsStarted() == true ? QCC_TRUE : QCC_FALSE); } QCC_BOOL AJ_CALL alljoyn_busattachment_isstopping(alljoyn_busattachment bus) { QCC_DbgTrace(("%s", __FUNCTION__)); return (((ajn::BusAttachmentC*)bus)->IsStopping() == true ? QCC_TRUE : QCC_FALSE); } QCC_BOOL AJ_CALL alljoyn_busattachment_isconnected(const alljoyn_busattachment bus) { QCC_DbgTrace(("%s", __FUNCTION__)); return (((const ajn::BusAttachmentC*)bus)->IsConnected() == true ? QCC_TRUE : QCC_FALSE); } QStatus AJ_CALL alljoyn_busattachment_disconnect(alljoyn_busattachment bus, const char* unused) { QCC_UNUSED(unused); QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->Disconnect(); } const alljoyn_proxybusobject AJ_CALL alljoyn_busattachment_getdbusproxyobj(alljoyn_busattachment bus) { QCC_DbgTrace(("%s", __FUNCTION__)); return (const alljoyn_proxybusobject)(&((ajn::BusAttachmentC*)bus)->GetDBusProxyObj()); } const alljoyn_proxybusobject AJ_CALL alljoyn_busattachment_getalljoynproxyobj(alljoyn_busattachment bus) { QCC_DbgTrace(("%s", __FUNCTION__)); return (const alljoyn_proxybusobject)(&((ajn::BusAttachmentC*)bus)->GetAllJoynProxyObj()); } const alljoyn_proxybusobject AJ_CALL alljoyn_busattachment_getalljoyndebugobj(alljoyn_busattachment bus) { QCC_DbgTrace(("%s", __FUNCTION__)); return (const alljoyn_proxybusobject)(&((ajn::BusAttachmentC*)bus)->GetAllJoynDebugObj()); } const char* AJ_CALL alljoyn_busattachment_getuniquename(const alljoyn_busattachment bus) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((const ajn::BusAttachmentC*)bus)->GetUniqueName().c_str(); } const char* AJ_CALL alljoyn_busattachment_getglobalguidstring(const alljoyn_busattachment bus) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((const ajn::BusAttachmentC*)bus)->GetGlobalGUIDString().c_str(); } QStatus AJ_CALL alljoyn_busattachment_registerkeystorelistener(alljoyn_busattachment bus, alljoyn_keystorelistener listener) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->RegisterKeyStoreListener(*((ajn::KeyStoreListener*)listener)); } QStatus AJ_CALL alljoyn_busattachment_reloadkeystore(alljoyn_busattachment bus) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->ReloadKeyStore(); } void AJ_CALL alljoyn_busattachment_clearkeystore(alljoyn_busattachment bus) { QCC_DbgTrace(("%s", __FUNCTION__)); ((ajn::BusAttachmentC*)bus)->ClearKeyStore(); } QStatus AJ_CALL alljoyn_busattachment_clearkeys(alljoyn_busattachment bus, const char* guid) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->ClearKeys(guid); } QStatus AJ_CALL alljoyn_busattachment_setkeyexpiration(alljoyn_busattachment bus, const char* guid, uint32_t timeout) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->SetKeyExpiration(guid, timeout); } QStatus AJ_CALL alljoyn_busattachment_getkeyexpiration(alljoyn_busattachment bus, const char* guid, uint32_t* timeout) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->GetKeyExpiration(guid, *timeout); } QStatus AJ_CALL alljoyn_busattachment_addlogonentry(alljoyn_busattachment bus, const char* authMechanism, const char* userName, const char* password) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->AddLogonEntry(authMechanism, userName, password); } QStatus AJ_CALL alljoyn_busattachment_releasename(alljoyn_busattachment bus, const char* name) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->ReleaseName(name); } QStatus AJ_CALL alljoyn_busattachment_addmatch(alljoyn_busattachment bus, const char* rule) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->AddMatch(rule); } QStatus AJ_CALL alljoyn_busattachment_removematch(alljoyn_busattachment bus, const char* rule) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->RemoveMatch(rule); } QStatus AJ_CALL alljoyn_busattachment_setsessionlistener(alljoyn_busattachment bus, alljoyn_sessionid sessionId, alljoyn_sessionlistener listener) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->SetSessionListener(sessionId, (ajn::SessionListener*)listener); } QStatus AJ_CALL alljoyn_busattachment_leavesession(alljoyn_busattachment bus, alljoyn_sessionid sessionId) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->LeaveSession(sessionId); } QStatus AJ_CALL alljoyn_busattachment_removesessionmember(alljoyn_busattachment bus, alljoyn_sessionid sessionId, const char* memberName) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->RemoveSessionMember(sessionId, memberName); } QStatus AJ_CALL alljoyn_busattachment_setlinktimeout(alljoyn_busattachment bus, alljoyn_sessionid sessionid, uint32_t* linkTimeout) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->SetLinkTimeout(sessionid, *linkTimeout); } QStatus AJ_CALL alljoyn_busattachment_setlinktimeoutasync(alljoyn_busattachment bus, alljoyn_sessionid sessionid, uint32_t linkTimeout, alljoyn_busattachment_setlinktimeoutcb_ptr callback, void* context) { QCC_DbgTrace(("%s", __FUNCTION__)); /* * the instance of the ajn::SetLinkTimeoutContext is freed when the * SetLinkTimeoutCB is called. */ return ((ajn::BusAttachmentC*)bus)->SetLinkTimeoutAsync(sessionid, linkTimeout, (ajn::BusAttachmentC*)bus, (void*)new ajn::SetLinkTimeoutContext(callback, context)); } QStatus AJ_CALL alljoyn_busattachment_namehasowner(alljoyn_busattachment bus, const char* name, QCC_BOOL* hasOwner) { QCC_DbgTrace(("%s", __FUNCTION__)); bool result; QStatus ret = ((ajn::BusAttachmentC*)bus)->NameHasOwner(name, result); *hasOwner = (result == true ? QCC_TRUE : QCC_FALSE); return ret; } QStatus AJ_CALL alljoyn_busattachment_getpeerguid(alljoyn_busattachment bus, const char* name, char* guid, size_t* guidSz) { QCC_DbgTrace(("%s", __FUNCTION__)); qcc::String guidStr; QStatus ret = ((ajn::BusAttachmentC*)bus)->GetPeerGUID(name, guidStr); if ((guid != nullptr) && (*guidSz >= 1)) { strncpy(guid, guidStr.c_str(), *guidSz); guid[*guidSz - 1] = '\0'; } //size of the string plus the nul character *guidSz = guidStr.length() + 1; return ret; } QStatus AJ_CALL alljoyn_busattachment_registersignalhandler(alljoyn_busattachment bus, alljoyn_messagereceiver_signalhandler_ptr signal_handler, const alljoyn_interfacedescription_member member, const char* srcPath) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->RegisterSignalHandlerC(signal_handler, member, srcPath); } QStatus AJ_CALL alljoyn_busattachment_registersignalhandlerwithrule(alljoyn_busattachment bus, alljoyn_messagereceiver_signalhandler_ptr signal_handler, const alljoyn_interfacedescription_member member, const char* matchRule) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->RegisterSignalHandlerWithRuleC(signal_handler, member, matchRule); } QStatus AJ_CALL alljoyn_busattachment_unregistersignalhandler(alljoyn_busattachment bus, alljoyn_messagereceiver_signalhandler_ptr signal_handler, const alljoyn_interfacedescription_member member, const char* srcPath) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->UnregisterSignalHandlerC(signal_handler, member, srcPath); } QStatus AJ_CALL alljoyn_busattachment_unregistersignalhandlerwithrule(alljoyn_busattachment bus, alljoyn_messagereceiver_signalhandler_ptr signal_handler, const alljoyn_interfacedescription_member member, const char* matchRule) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->UnregisterSignalHandlerWithRuleC(signal_handler, member, matchRule); } QStatus AJ_CALL alljoyn_busattachment_unregisterallhandlers(alljoyn_busattachment bus) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->UnregisterAllHandlersC(); } QStatus AJ_CALL alljoyn_busattachment_setdaemondebug(alljoyn_busattachment bus, const char* module, uint32_t level) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->SetDaemonDebug(module, level); } uint32_t AJ_CALL alljoyn_busattachment_gettimestamp() { QCC_DbgTrace(("%s", __FUNCTION__)); return ajn::BusAttachmentC::GetTimestamp(); } QStatus AJ_CALL alljoyn_busattachment_ping(alljoyn_busattachment bus, const char* name, uint32_t timeout) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->Ping(name, timeout); } /** * This function is experimental, and as such has not been fully tested. * Please help make it more robust by contributing fixes if you find problems. */ void AJ_CALL alljoyn_busattachment_registeraboutlistener(alljoyn_busattachment bus, alljoyn_aboutlistener aboutListener) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->RegisterAboutListener(*(ajn::AboutListener*)aboutListener); } /** * This function is experimental, and as such has not been fully tested. * Please help make it more robust by contributing fixes if you find problems. */ void AJ_CALL alljoyn_busattachment_unregisteraboutlistener(alljoyn_busattachment bus, alljoyn_aboutlistener aboutListener) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->UnregisterAboutListener(*(ajn::AboutListener*)aboutListener); } /** * This function is experimental, and as such has not been fully tested. * Please help make it more robust by contributing fixes if you find problems. */ void AJ_CALL alljoyn_busattachment_unregisterallaboutlisteners(alljoyn_busattachment bus) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->UnregisterAllAboutListeners(); } /** * This function is experimental, and as such has not been fully tested. * Please help make it more robust by contributing fixes if you find problems. */ QStatus AJ_CALL alljoyn_busattachment_whoimplements_interfaces(alljoyn_busattachment bus, const char** implementsInterfaces, size_t numberInterfaces) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->WhoImplements(implementsInterfaces, numberInterfaces); } /** * This function is experimental, and as such has not been fully tested. * Please help make it more robust by contributing fixes if you find problems. */ QStatus AJ_CALL alljoyn_busattachment_whoimplements_interface(alljoyn_busattachment bus, const char* implementsInterface) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->WhoImplements(implementsInterface); } /** * This function is experimental, and as such has not been fully tested. * Please help make it more robust by contributing fixes if you find problems. */ QStatus AJ_CALL alljoyn_busattachment_cancelwhoimplements_interfaces(alljoyn_busattachment bus, const char** implementsInterfaces, size_t numberInterfaces) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->CancelWhoImplements(implementsInterfaces, numberInterfaces); } /** * This function is experimental, and as such has not been fully tested. * Please help make it more robust by contributing fixes if you find problems. */ QStatus AJ_CALL alljoyn_busattachment_cancelwhoimplements_interface(alljoyn_busattachment bus, const char* implementsInterface) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusAttachmentC*)bus)->CancelWhoImplements(implementsInterface); } alljoyn-15.04b/alljoyn_c/src/BusAttachmentC.cc000066400000000000000000000201231255700255500212560ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include "BusAttachmentC.h" #include #include #include #include #include "DeferredCallback.h" #include #include #define QCC_MODULE "ALLJOYN_C" using namespace std; using namespace qcc; namespace ajn { void BusAttachmentC::SignalHandlerC::SignalHandlerRemap(const InterfaceDescription::Member* member, const char* srcPath, Message& message) { QCC_DbgTrace(("%s", __FUNCTION__)); alljoyn_interfacedescription_member c_member; c_member.iface = (alljoyn_interfacedescription)member->iface; c_member.memberType = (alljoyn_messagetype)member->memberType; c_member.name = member->name.c_str(); c_member.signature = member->signature.c_str(); c_member.returnSignature = member->returnSignature.c_str(); c_member.argNames = member->argNames.c_str(); //TODO add back in annotations //c_member.annotation = member->annotation; c_member.internal_member = member; if (!DeferredCallback::sMainThreadCallbacksOnly) { handler(&c_member, srcPath, (alljoyn_message)(&message)); } else { /* * if MainThreadCallbacksOnly is true the memory for dcb will * be freed by the DeferedCallback base class. */ DeferredCallback_3* dcb = new DeferredCallback_3(handler, &c_member, srcPath, (alljoyn_message) & message); DEFERRED_CALLBACK_EXECUTE(dcb); } } QStatus BusAttachmentC::RegisterSignalHandlerC(alljoyn_messagereceiver_signalhandler_ptr signalHandler, const alljoyn_interfacedescription_member member, const char* srcPath) { QCC_DbgTrace(("%s", __FUNCTION__)); QStatus ret = ER_OK; const ajn::InterfaceDescription::Member* cpp_member = (const ajn::InterfaceDescription::Member*)(member.internal_member); signalHandlerMapLock.Lock(MUTEX_CONTEXT); SignalHandlerC* cppHandler; SignalHandlerMap::iterator iter = signalHandlerMap.find(signalHandler); if (iter == signalHandlerMap.end()) { cppHandler = new SignalHandlerC(this, signalHandler); signalHandlerMap.insert(std::make_pair(signalHandler, cppHandler)); } else { cppHandler = iter->second; } cppHandler->AddSubscription(cpp_member, srcPath); ret = RegisterSignalHandler(cppHandler, static_cast(&SignalHandlerC::SignalHandlerRemap), cpp_member, srcPath); signalHandlerMapLock.Unlock(MUTEX_CONTEXT); return ret; } QStatus BusAttachmentC::RegisterSignalHandlerWithRuleC(alljoyn_messagereceiver_signalhandler_ptr signalHandler, const alljoyn_interfacedescription_member member, const char* matchRule) { QCC_DbgTrace(("%s", __FUNCTION__)); QStatus ret = ER_OK; const ajn::InterfaceDescription::Member* cpp_member = (const ajn::InterfaceDescription::Member*)(member.internal_member); /* validate and canonicalize match rule */ Rule rule(matchRule, &ret); if (ER_OK != ret) { return ret; } qcc::String canonicalStr = rule.ToString(); signalHandlerMapLock.Lock(MUTEX_CONTEXT); SignalHandlerC* cppHandler; SignalHandlerMap::iterator iter = signalHandlerMap.find(signalHandler); if (iter == signalHandlerMap.end()) { cppHandler = new SignalHandlerC(this, signalHandler); signalHandlerMap.insert(std::make_pair(signalHandler, cppHandler)); } else { cppHandler = iter->second; } cppHandler->AddSubscription(cpp_member, canonicalStr.c_str()); ret = RegisterSignalHandlerWithRule(cppHandler, static_cast(&SignalHandlerC::SignalHandlerRemap), cpp_member, canonicalStr.c_str()); signalHandlerMapLock.Unlock(MUTEX_CONTEXT); return ret; } QStatus BusAttachmentC::UnregisterSignalHandlerC(alljoyn_messagereceiver_signalhandler_ptr signalHandler, const alljoyn_interfacedescription_member member, const char* srcPath) { QCC_DbgTrace(("%s", __FUNCTION__)); QStatus ret = ER_FAIL; const ajn::InterfaceDescription::Member* cpp_member = (const ajn::InterfaceDescription::Member*)(member.internal_member); signalHandlerMapLock.Lock(MUTEX_CONTEXT); SignalHandlerMap::iterator iter = signalHandlerMap.find(signalHandler); if (iter != signalHandlerMap.end()) { ret = UnregisterSignalHandler(iter->second, static_cast(&SignalHandlerC::SignalHandlerRemap), cpp_member, srcPath); if (ret == ER_OK) { bool removeHandler = iter->second->RemoveSubscription(cpp_member, srcPath); if (removeHandler) { delete iter->second; signalHandlerMap.erase(iter); } } } signalHandlerMapLock.Unlock(MUTEX_CONTEXT); return ret; } QStatus BusAttachmentC::UnregisterSignalHandlerWithRuleC(alljoyn_messagereceiver_signalhandler_ptr signalHandler, const alljoyn_interfacedescription_member member, const char* matchRule) { QCC_DbgTrace(("%s", __FUNCTION__)); QStatus ret = ER_FAIL; const ajn::InterfaceDescription::Member* cpp_member = (const ajn::InterfaceDescription::Member*)(member.internal_member); /* validate and canonicalize match rule */ Rule rule(matchRule, &ret); if (ER_OK != ret) { return ret; } qcc::String canonicalStr = rule.ToString(); ret = ER_FAIL; /* return FAIL if we can't find the handler to remove */ signalHandlerMapLock.Lock(MUTEX_CONTEXT); SignalHandlerMap::iterator iter = signalHandlerMap.find(signalHandler); if (iter != signalHandlerMap.end()) { ret = UnregisterSignalHandlerWithRule(iter->second, static_cast(&SignalHandlerC::SignalHandlerRemap), cpp_member, canonicalStr.c_str()); if (ret == ER_OK) { bool removeHandler = iter->second->RemoveSubscription(cpp_member, canonicalStr.c_str()); if (removeHandler) { delete iter->second; signalHandlerMap.erase(iter); } } } signalHandlerMapLock.Unlock(MUTEX_CONTEXT); return ret; } QStatus BusAttachmentC::UnregisterAllHandlersC() { QCC_DbgTrace(("%s", __FUNCTION__)); QStatus ret = ER_OK; signalHandlerMapLock.Lock(MUTEX_CONTEXT); SignalHandlerMap::iterator iter; for (iter = signalHandlerMap.begin(); iter != signalHandlerMap.end(); ++iter) { QStatus tret = UnregisterAllHandlers(iter->second); delete iter->second; if (ret == ER_OK) { ret = tret; } } signalHandlerMap.clear(); signalHandlerMapLock.Unlock(MUTEX_CONTEXT); return ret; } } alljoyn-15.04b/alljoyn_c/src/BusAttachmentC.h000066400000000000000000000233641255700255500211320ustar00rootroot00000000000000/** * @file * * This file implements the BusAttachmentC class. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_C_BUSATTACHMENTC_H #define _ALLJOYN_C_BUSATTACHMENTC_H #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include namespace ajn { /* * When setting up a joinsession callback handler for C a alljoyn_busattachment_joinsessioncb_ptr * function pointer will be passed in as the callback handler. AllJoyn expects * a method handler. The function handler will be passed as the part of the void* * context that is passed to the internal callback handler and then is used to map * the internal callback handler to the user defined joinsession callback function * pointer. */ class JoinsessionCallbackContext { public: JoinsessionCallbackContext(alljoyn_busattachment_joinsessioncb_ptr joinsessioncb_ptr, void* context) : joinsessioncb_ptr(joinsessioncb_ptr), context(context) { } alljoyn_busattachment_joinsessioncb_ptr joinsessioncb_ptr; void* context; }; /* * When setting up a setlinktimeout callback handler for C a * alljoyn_busattachment_setlinktimeoutcb_ptr function pointer will be passed in * as the callback handler. AllJoyn expects a method handler. The function * handler will be passed as the part of the void* context that is passed to the * internal callback handler and then is used to map the internal callback handler * to the user defined setlinktimeout callback function pointer. */ class SetLinkTimeoutContext { public: SetLinkTimeoutContext(alljoyn_busattachment_setlinktimeoutcb_ptr setlinktimeoutcb_ptr, void* context) : setlinktimeoutcb_ptr(setlinktimeoutcb_ptr), context(context) { } alljoyn_busattachment_setlinktimeoutcb_ptr setlinktimeoutcb_ptr; void* context; }; /* * This class is a child of BusAttachment. This class contains extra methods needed * to map 'C++' callback methods to 'C' callback functions used for signals and * other async method calls. */ class BusAttachmentC : public BusAttachment, public BusAttachment::JoinSessionAsyncCB, public BusAttachment::SetLinkTimeoutAsyncCB { public: BusAttachmentC(const char* applicationName, bool allowRemoteMessages = false, uint32_t concurrency = 4) : BusAttachment(applicationName, allowRemoteMessages, concurrency) { } /** Destructor */ virtual ~BusAttachmentC() { /* remove all signal handers associated with this BusAttachment */ UnregisterAllHandlersC(); } /** * Take a 'C' style SignalHandler and map it to a 'C++' style SignalHandler * Register the 'C++' SignalHandler with the 'C++' code. * * @param receiver The object receiving the signal. * @param signalHandler The signal handler method. * @param member The interface/member of the signal. * @param srcPath The object path of the emitter of the signal or NULL for all paths. * @return #ER_OK */ QStatus RegisterSignalHandlerC(alljoyn_messagereceiver_signalhandler_ptr signalHandler, const alljoyn_interfacedescription_member member, const char* srcPath); /** * Take a 'C' style SignalHandler and map it to a 'C++' style SignalHandler * Register the 'C++' SignalHandler with the 'C++' code. * * @param receiver The object receiving the signal. * @param signalHandler The signal handler method. * @param member The interface/member of the signal. * @param matchRule The filter rule. * @return #ER_OK */ QStatus RegisterSignalHandlerWithRuleC(alljoyn_messagereceiver_signalhandler_ptr signalHandler, const alljoyn_interfacedescription_member member, const char* matchRule); /** * remove the 'C' style SignalHandler from the map and Unregister the 'C++' SignalHandler. * * @param receiver The object receiving the signal. * @param signalHandler The signal handler method. * @param member The interface/member of the signal. * @param srcPath The object path of the emitter of the signal or NULL for all paths. * @return #ER_OK */ QStatus UnregisterSignalHandlerC(alljoyn_messagereceiver_signalhandler_ptr signalHandler, const alljoyn_interfacedescription_member member, const char* srcPath); /** * remove the 'C' style SignalHandler from the map and Unregister the 'C++' SignalHandler. * * @param receiver The object receiving the signal. * @param signalHandler The signal handler method. * @param member The interface/member of the signal. * @param srcPath The filter rule. * @return #ER_OK */ QStatus UnregisterSignalHandlerWithRuleC(alljoyn_messagereceiver_signalhandler_ptr signalHandler, const alljoyn_interfacedescription_member member, const char* matchRule); /** * remove all SignalHandlers associated with the receiver alljoyn_busobject * * @param receiver the object the signals will no longer be registered with. */ QStatus UnregisterAllHandlersC(); void JoinSessionCB(QStatus status, SessionId sessionId, const SessionOpts& opts, void* context) { /* * The JoinsessionCallback in the context pointer is allocated as part * of the alljoyn_busattachment_joinsessionasync function call. Once the * function joinsessioncb_ptr has been called the * JoinsessionCallbackContext instance must be deleted or it will result * in a memory leak. */ JoinsessionCallbackContext* in = (JoinsessionCallbackContext*)context; (in->joinsessioncb_ptr)(status, (alljoyn_sessionid)sessionId, (const alljoyn_sessionopts)&opts, in->context); in->joinsessioncb_ptr = NULL; delete in; } void SetLinkTimeoutCB(QStatus status, uint32_t timeout, void* context) { /* * The setlinktimeoutcb_ptr in the context pointer is allocated as part * of the alljoyn_busattachment_setlinktimeoutasync function call. Once * the function setlintimeoutcb_ptr has been called the * SetLinkTimeoutContext instance must be deleted or it will result * in a memory leak. */ SetLinkTimeoutContext* in = (SetLinkTimeoutContext*)context; (in->setlinktimeoutcb_ptr)(status, timeout, in->context); in->setlinktimeoutcb_ptr = NULL; delete in; } private: struct SignalHandlerC : ajn::MessageReceiver { struct Subscription { const ajn::InterfaceDescription::Member* member; /* qualifier is either * - an empty string (RegisterSignalHandler with srcPath == NULL) * - an object path (RegisterSignalHandler with specified srcPath) * - a match rule (RegisterSignalHandlerWithRule) */ qcc::String qualifier; bool operator<(const Subscription& other) const { return (member < other.member) || ((member == other.member) && (qualifier < other.qualifier)); } }; ajn::BusAttachmentC* bus; alljoyn_messagereceiver_signalhandler_ptr handler; std::multiset subscriptions; /** * Convert the 'C++' SignalHandler callback to a 'C' callback function */ SignalHandlerC(ajn::BusAttachmentC* busC, alljoyn_messagereceiver_signalhandler_ptr cHandler) : bus(busC), handler(cHandler) { } void SignalHandlerRemap(const InterfaceDescription::Member* member, const char* srcPath, ajn::Message& message); void AddSubscription(const ajn::InterfaceDescription::Member* member, const char* qualifier) { Subscription sub = { member, qualifier ? qualifier : "" }; subscriptions.insert(sub); } /** * Remove subscription. * @return true if there are no more subscriptions for this handler. */ bool RemoveSubscription(const ajn::InterfaceDescription::Member* member, const char* qualifier) { Subscription sub = { member, qualifier ? qualifier : "" }; std::multiset::iterator iter = subscriptions.find(sub); if (iter != subscriptions.end()) { subscriptions.erase(iter); } return subscriptions.empty(); } }; typedef std::map SignalHandlerMap; SignalHandlerMap signalHandlerMap; qcc::Mutex signalHandlerMapLock; }; } #endif alljoyn-15.04b/alljoyn_c/src/BusListener.cc000066400000000000000000000177511255700255500206650ustar00rootroot00000000000000/** * @file * This implements the C accessable version of the BusListener class using * function pointers, and a pass-through implementation of BusListener. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include "DeferredCallback.h" #include #define QCC_MODULE "ALLJOYN_C" static void AJ_CALL __PropertyChanged(alljoyn_buslistener_bus_prop_changed_ptr fcn, const void* context, const char* prop_name, alljoyn_msgarg prop_value) { fcn(context, prop_name, prop_value); if (prop_value) { alljoyn_msgarg_destroy(prop_value); } } namespace ajn { /** * Abstract base class implemented by AllJoyn users and called by AllJoyn to inform * users of bus related events. */ class BusListenerCallbackC : BusListener { public: BusListenerCallbackC(const alljoyn_buslistener_callbacks* in_callbacks, const void* in_context) { QCC_DbgTrace(("%s", __FUNCTION__)); memcpy(&callbacks, in_callbacks, sizeof(alljoyn_buslistener_callbacks)); context = in_context; } void ListenerRegistered(BusAttachment* bus) { QCC_DbgTrace(("%s", __FUNCTION__)); if (callbacks.listener_registered != NULL) { if (!DeferredCallback::sMainThreadCallbacksOnly) { callbacks.listener_registered(context, (alljoyn_busattachment)bus); } else { DeferredCallback_2* dcb = new DeferredCallback_2(callbacks.listener_registered, context, (alljoyn_busattachment)bus); DEFERRED_CALLBACK_EXECUTE(dcb); } } } void ListenerUnregistered() { QCC_DbgTrace(("%s", __FUNCTION__)); if (callbacks.listener_unregistered != NULL) { if (!DeferredCallback::sMainThreadCallbacksOnly) { callbacks.listener_unregistered(context); } else { DeferredCallback_1* dcb = new DeferredCallback_1(callbacks.listener_unregistered, context); DEFERRED_CALLBACK_EXECUTE(dcb); } } } void FoundAdvertisedName(const char* name, TransportMask transport, const char* namePrefix) { QCC_DbgTrace(("%s", __FUNCTION__)); if (callbacks.found_advertised_name != NULL) { if (!DeferredCallback::sMainThreadCallbacksOnly) { callbacks.found_advertised_name(context, name, transport, namePrefix); } else { DeferredCallback_4* dcb = new DeferredCallback_4(callbacks.found_advertised_name, context, name, transport, namePrefix); DEFERRED_CALLBACK_EXECUTE(dcb); } } } void LostAdvertisedName(const char* name, TransportMask transport, const char* namePrefix) { QCC_DbgTrace(("%s", __FUNCTION__)); if (callbacks.lost_advertised_name != NULL) { if (!DeferredCallback::sMainThreadCallbacksOnly) { callbacks.lost_advertised_name(context, name, transport, namePrefix); } else { DeferredCallback_4* dcb = new DeferredCallback_4(callbacks.lost_advertised_name, context, name, transport, namePrefix); DEFERRED_CALLBACK_EXECUTE(dcb); } } } void NameOwnerChanged(const char* busName, const char* previousOwner, const char* newOwner) { QCC_DbgTrace(("%s", __FUNCTION__)); if (callbacks.name_owner_changed != NULL) { if (!DeferredCallback::sMainThreadCallbacksOnly) { callbacks.name_owner_changed(context, busName, previousOwner, newOwner); } else { DeferredCallback_4* dcb = new DeferredCallback_4(callbacks.name_owner_changed, context, busName, previousOwner, newOwner); DEFERRED_CALLBACK_EXECUTE(dcb); } } } void BusStopping() { QCC_DbgTrace(("%s", __FUNCTION__)); if (callbacks.bus_stopping != NULL) { if (!DeferredCallback::sMainThreadCallbacksOnly) { callbacks.bus_stopping(context); } else { DeferredCallback_1* dcb = new DeferredCallback_1(callbacks.bus_stopping, context); DEFERRED_CALLBACK_EXECUTE(dcb); } } } void BusDisconnected() { QCC_DbgTrace(("%s", __FUNCTION__)); if (callbacks.bus_disconnected != NULL) { if (!DeferredCallback::sMainThreadCallbacksOnly) { callbacks.bus_disconnected(context); } else { DeferredCallback_1* dcb = new DeferredCallback_1(callbacks.bus_disconnected, context); DEFERRED_CALLBACK_EXECUTE(dcb); } } } void PropertyChanged(const char* propName, const MsgArg* propValue) { QCC_DbgTrace(("%s", __FUNCTION__)); if (callbacks.property_changed != NULL) { alljoyn_msgarg msg_arg = propValue ? alljoyn_msgarg_create_and_set(propValue->Signature().c_str(), propValue->v_variant.val) : NULL; // must wrap the user function in order to properly clean up msg_arg if (!DeferredCallback::sMainThreadCallbacksOnly) { __PropertyChanged(callbacks.property_changed, context, propName, msg_arg); } else { DeferredCallback_4* dcb = new DeferredCallback_4( __PropertyChanged, callbacks.property_changed, context, propName, msg_arg); DEFERRED_CALLBACK_EXECUTE(dcb); } } } protected: alljoyn_buslistener_callbacks callbacks; const void* context; }; } struct _alljoyn_buslistener_handle { /* Empty by design, this is just to allow the type restrictions to save coders from themselves */ }; alljoyn_buslistener AJ_CALL alljoyn_buslistener_create(const alljoyn_buslistener_callbacks* callbacks, const void* context) { QCC_DbgTrace(("%s", __FUNCTION__)); return (alljoyn_buslistener) new ajn::BusListenerCallbackC(callbacks, context); } void AJ_CALL alljoyn_buslistener_destroy(alljoyn_buslistener listener) { QCC_DbgTrace(("%s", __FUNCTION__)); assert(listener != NULL && "listener parameter must not be NULL"); delete (ajn::BusListenerCallbackC*)listener; } alljoyn-15.04b/alljoyn_c/src/BusObjectC.cc000066400000000000000000000431231255700255500204010ustar00rootroot00000000000000/** * @file * * This file implements a BusObject subclass for use by the C API */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include "DeferredCallback.h" #include #define QCC_MODULE "ALLJOYN_C" using namespace qcc; using namespace std; namespace ajn { class BusObjectC : public BusObject { public: BusObjectC(const char* path, QCC_BOOL isPlaceholder, \ const alljoyn_busobject_callbacks* callbacks_in, const void* context_in) : BusObject(path, isPlaceholder == QCC_TRUE ? true : false), callbacks() { context = context_in; QCC_DbgTrace(("%s", __FUNCTION__)); if (callbacks_in == NULL) { callbacks.property_get = NULL; callbacks.property_set = NULL; callbacks.object_registered = NULL; callbacks.object_unregistered = NULL; } else { memcpy(&callbacks, callbacks_in, sizeof(alljoyn_busobject_callbacks)); } } QStatus MethodReplyC(alljoyn_message msg, const alljoyn_msgarg args, size_t numArgs) { QCC_DbgTrace(("%s", __FUNCTION__)); return MethodReply(*((Message*)msg), (const MsgArg*)args, numArgs); } QStatus MethodReplyC(alljoyn_message msg, const char* error, const char* errorMessage) { QCC_DbgTrace(("%s", __FUNCTION__)); return MethodReply(*((Message*)msg), error, errorMessage); } QStatus MethodReplyC(alljoyn_message msg, QStatus status) { QCC_DbgTrace(("%s", __FUNCTION__)); return MethodReply(*((Message*)msg), status); } QStatus SignalC(const char* destination, alljoyn_sessionid sessionId, const InterfaceDescription::Member& signal, const alljoyn_msgarg args, size_t numArgs, uint16_t timeToLive, uint8_t flags, alljoyn_message msg) { QCC_DbgTrace(("%s", __FUNCTION__)); return this->Signal(destination, *(ajn::SessionId*)&sessionId, signal, (const ajn::MsgArg*)args, numArgs, timeToLive, flags, (ajn::Message*)msg); } void EmitPropChangedC(const char* ifcName, const char* propName, alljoyn_msgarg val, alljoyn_sessionid id) { QCC_DbgTrace(("%s", __FUNCTION__)); this->EmitPropChanged(ifcName, propName, *((ajn::MsgArg*) val), id); } void EmitPropChangedC(const char* ifcName, const char** propNames, size_t numProps, alljoyn_sessionid id) { QCC_DbgTrace(("%s", __FUNCTION__)); this->EmitPropChanged(ifcName, propNames, numProps, id); } QStatus AddInterfaceC(const alljoyn_interfacedescription iface, alljoyn_about_announceflag isAnnounced = (alljoyn_about_announceflag)ANNOUNCED) { QCC_DbgTrace(("%s", __FUNCTION__)); return AddInterface(*(const InterfaceDescription*)iface, (BusObject::AnnounceFlag)isAnnounced); } QStatus AddMethodHandlerC(const alljoyn_interfacedescription_member member, alljoyn_messagereceiver_methodhandler_ptr handler, void* context) { QCC_DbgTrace(("%s", __FUNCTION__)); callbackMap.insert(pair( (const ajn::InterfaceDescription::Member*)member.internal_member, handler)); QStatus ret = AddMethodHandler((const ajn::InterfaceDescription::Member*)member.internal_member, static_cast(&BusObjectC::MethodHandlerRemap), context); return ret; } QStatus AddMethodHandlersC(const alljoyn_busobject_methodentry* entries, size_t numEntries) { QCC_DbgTrace(("%s", __FUNCTION__)); MethodEntry* proper_entries = new MethodEntry[numEntries]; for (size_t i = 0; i < numEntries; i++) { proper_entries[i].member = (const ajn::InterfaceDescription::Member*)entries[i].member->internal_member; callbackMap.insert(pair( (const ajn::InterfaceDescription::Member*)entries[i].member->internal_member, entries[i].method_handler)); proper_entries[i].handler = static_cast(&BusObjectC::MethodHandlerRemap); } QStatus ret = AddMethodHandlers(proper_entries, numEntries); delete [] proper_entries; return ret; } protected: virtual QStatus Get(const char* ifcName, const char* propName, MsgArg& val) { QCC_DbgTrace(("%s", __FUNCTION__)); QStatus ret = ER_BUS_NO_SUCH_PROPERTY; if (callbacks.property_get != NULL) { if (!DeferredCallback::sMainThreadCallbacksOnly) { ret = callbacks.property_get(context, ifcName, propName, (alljoyn_msgarg)(&val)); } else { DeferredCallback_4* dcb = new DeferredCallback_4(callbacks.property_get, context, ifcName, propName, (alljoyn_msgarg)(&val)); ret = DEFERRED_CALLBACK_EXECUTE(dcb); } } return ret; } virtual QStatus Set(const char* ifcName, const char* propName, MsgArg& val) { QCC_DbgTrace(("%s", __FUNCTION__)); QStatus ret = ER_BUS_NO_SUCH_PROPERTY; if (callbacks.property_set != NULL) { if (!DeferredCallback::sMainThreadCallbacksOnly) { ret = callbacks.property_set(context, ifcName, propName, (alljoyn_msgarg)(&val)); } else { DeferredCallback_4* dcb = new DeferredCallback_4(callbacks.property_set, context, ifcName, propName, (alljoyn_msgarg)(&val)); ret = DEFERRED_CALLBACK_EXECUTE(dcb); } } return ret; } // TODO: Need to do GenerateIntrospection? virtual void ObjectRegistered(void) { QCC_DbgTrace(("%s", __FUNCTION__)); if (callbacks.object_registered != NULL) { if (!DeferredCallback::sMainThreadCallbacksOnly) { callbacks.object_registered(context); } else { DeferredCallback_1* dcb = new DeferredCallback_1(callbacks.object_registered, context); DEFERRED_CALLBACK_EXECUTE(dcb); } } } virtual void ObjectUnregistered(void) { QCC_DbgTrace(("%s", __FUNCTION__)); // Call parent as per docs BusObject::ObjectUnregistered(); if (callbacks.object_unregistered != NULL) { if (!DeferredCallback::sMainThreadCallbacksOnly) { callbacks.object_unregistered(context); } else { DeferredCallback_1* dcb = new DeferredCallback_1(callbacks.object_unregistered, context); DEFERRED_CALLBACK_EXECUTE(dcb); } } } // TODO: Need to do GetProp, SetProp, GetAllProps, Introspect? private: void MethodHandlerRemap(const InterfaceDescription::Member* member, Message& message) { QCC_DbgTrace(("%s", __FUNCTION__)); /* Populate a C member description for use in the callback */ alljoyn_interfacedescription_member c_member; c_member.iface = (alljoyn_interfacedescription)member->iface; c_member.memberType = (alljoyn_messagetype)member->memberType; c_member.name = member->name.c_str(); c_member.signature = member->signature.c_str(); c_member.returnSignature = member->returnSignature.c_str(); c_member.argNames = member->argNames.c_str(); // TODO Add back in annotations //c_member.annotation = member->annotation; c_member.internal_member = member; /* Look up the C callback via map and invoke */ alljoyn_messagereceiver_methodhandler_ptr remappedHandler = callbackMap[member]; if (!DeferredCallback::sMainThreadCallbacksOnly) { remappedHandler((alljoyn_busobject) this, &c_member, (alljoyn_message)(&message)); } else { DeferredCallback_3* dcb = new DeferredCallback_3(remappedHandler, (alljoyn_busobject) this, &c_member, (alljoyn_message)(&message)); DEFERRED_CALLBACK_EXECUTE(dcb); } } map callbackMap; alljoyn_busobject_callbacks callbacks; const void* context; }; } struct _alljoyn_busobject_handle { /* Empty by design, this is just to allow the type restrictions to save coders from themselves */ }; alljoyn_busobject AJ_CALL alljoyn_busobject_create(const char* path, QCC_BOOL isPlaceholder, const alljoyn_busobject_callbacks* callbacks_in, const void* context_in) { QCC_DbgTrace(("%s", __FUNCTION__)); return (alljoyn_busobject) new ajn::BusObjectC(path, isPlaceholder, callbacks_in, context_in); } void AJ_CALL alljoyn_busobject_destroy(alljoyn_busobject bus) { QCC_DbgTrace(("%s", __FUNCTION__)); delete (ajn::BusObjectC*)bus; } const char* AJ_CALL alljoyn_busobject_getpath(alljoyn_busobject bus) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusObjectC*)bus)->GetPath(); } void AJ_CALL alljoyn_busobject_emitpropertychanged(alljoyn_busobject bus, const char* ifcName, const char* propName, alljoyn_msgarg val, alljoyn_sessionid id) { QCC_DbgTrace(("%s", __FUNCTION__)); ((ajn::BusObjectC*)bus)->EmitPropChangedC(ifcName, propName, val, id); } void AJ_CALL alljoyn_busobject_emitpropertieschanged(alljoyn_busobject bus, const char* ifcName, const char** propNames, size_t numProps, alljoyn_sessionid id) { QCC_DbgTrace(("%s", __FUNCTION__)); ((ajn::BusObjectC*)bus)->EmitPropChangedC(ifcName, propNames, numProps, id); } size_t AJ_CALL alljoyn_busobject_getname(alljoyn_busobject bus, char* buffer, size_t bufferSz) { QCC_DbgTrace(("%s", __FUNCTION__)); qcc::String name = ((ajn::BusObjectC*)bus)->GetName(); if (buffer != NULL && bufferSz > 0) { strncpy(buffer, name.c_str(), bufferSz); //prevent sting not being nul terminated. buffer[bufferSz - 1] = '\0'; } return name.length() + 1; } QStatus AJ_CALL alljoyn_busobject_addinterface(alljoyn_busobject bus, const alljoyn_interfacedescription iface) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusObjectC*)bus)->AddInterfaceC(iface, UNANNOUNCED); } QStatus AJ_CALL alljoyn_busobject_addmethodhandler(alljoyn_busobject bus, const alljoyn_interfacedescription_member member, alljoyn_messagereceiver_methodhandler_ptr handler, void* context) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusObjectC*)bus)->AddMethodHandlerC(member, handler, context); } QStatus AJ_CALL alljoyn_busobject_addmethodhandlers(alljoyn_busobject bus, const alljoyn_busobject_methodentry* entries, size_t numEntries) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusObjectC*)bus)->AddMethodHandlersC(entries, numEntries); } QStatus AJ_CALL alljoyn_busobject_methodreply_args(alljoyn_busobject bus, alljoyn_message msg, const alljoyn_msgarg args, size_t numArgs) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusObjectC*)bus)->MethodReplyC(msg, args, numArgs); } QStatus AJ_CALL alljoyn_busobject_methodreply_err(alljoyn_busobject bus, alljoyn_message msg, const char* error, const char* errorMessage) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusObjectC*)bus)->MethodReplyC(msg, error, errorMessage); } QStatus AJ_CALL alljoyn_busobject_methodreply_status(alljoyn_busobject bus, alljoyn_message msg, QStatus status) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusObjectC*)bus)->MethodReplyC(msg, status); } const alljoyn_busattachment AJ_CALL alljoyn_busobject_getbusattachment(alljoyn_busobject bus) { QCC_DbgTrace(("%s", __FUNCTION__)); return (const alljoyn_busattachment) &((ajn::BusObjectC*)bus)->GetBusAttachment(); } QStatus AJ_CALL alljoyn_busobject_signal(alljoyn_busobject bus, const char* destination, alljoyn_sessionid sessionId, const alljoyn_interfacedescription_member signal, const alljoyn_msgarg args, size_t numArgs, uint16_t timeToLive, uint8_t flags, alljoyn_message msg) { QCC_DbgTrace(("%s", __FUNCTION__)); const ajn::InterfaceDescription::Member* member = ((ajn::InterfaceDescription*)signal.iface)->GetMember(signal.name); if (!member) { return ER_BUS_INTERFACE_NO_SUCH_MEMBER; } /* must call the Signal Method through BusObjectC since Signal is a protected Method */ return ((ajn::BusObjectC*)bus)->SignalC(destination, sessionId, *member, args, numArgs, timeToLive, flags, msg); } QStatus AJ_CALL alljoyn_busobject_cancelsessionlessmessage_serial(alljoyn_busobject bus, uint32_t serialNumber) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusObjectC*)bus)->CancelSessionlessMessage(serialNumber); } QStatus AJ_CALL alljoyn_busobject_cancelsessionlessmessage(alljoyn_busobject bus, const alljoyn_message msg) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusObjectC*)bus)->CancelSessionlessMessage(*((ajn::Message*)msg)); } QCC_BOOL AJ_CALL alljoyn_busobject_issecure(alljoyn_busobject bus) { QCC_DbgTrace(("%s", __FUNCTION__)); return (((ajn::BusObjectC*)bus)->IsSecure() == true ? QCC_TRUE : QCC_FALSE); } /** * This function is experimental, and as such has not been fully tested. * Please help make it more robust by contributing fixes if you find problems. */ size_t AJ_CALL alljoyn_busobject_getannouncedinterfacenames(alljoyn_busobject bus, const char** interfaces, size_t numInterfaces) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusObjectC*)bus)->GetAnnouncedInterfaceNames(interfaces, numInterfaces); } /** * This function is experimental, and as such has not been fully tested. * Please help make it more robust by contributing fixes if you find problems. */ QStatus AJ_CALL alljoyn_busobject_setannounceflag(alljoyn_busobject bus, const alljoyn_interfacedescription iface, alljoyn_about_announceflag isAnnounced) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusObjectC*)bus)->SetAnnounceFlag((ajn::InterfaceDescription*)iface, (ajn::BusObject::AnnounceFlag)isAnnounced); } /** * This function is experimental, and as such has not been fully tested. * Please help make it more robust by contributing fixes if you find problems. */ QStatus AJ_CALL alljoyn_busobject_addinterface_announced(alljoyn_busobject bus, const alljoyn_interfacedescription iface) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::BusObjectC*)bus)->AddInterfaceC(iface, ANNOUNCED); } alljoyn-15.04b/alljoyn_c/src/DeferredCallback.cc000066400000000000000000000033101255700255500215450ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include "DeferredCallback.h" #include #define QCC_MODULE "ALLJOYN_C" namespace ajn { bool DeferredCallback::initilized = false; std::list DeferredCallback::sPendingCallbacks; qcc::Thread* DeferredCallback::sMainThread = NULL; bool DeferredCallback::sMainThreadCallbacksOnly = false; qcc::Mutex DeferredCallback::sCallbackListLock; } int AJ_CALL alljoyn_unity_deferred_callbacks_process() { QCC_DbgTrace(("%s", __FUNCTION__)); return ajn::DeferredCallback::TriggerCallbacks(); } void AJ_CALL alljoyn_unity_set_deferred_callback_mainthread_only(QCC_BOOL mainthread_only) { QCC_DbgTrace(("%s", __FUNCTION__)); ajn::DeferredCallback::sMainThreadCallbacksOnly = (mainthread_only == QCC_TRUE ? true : false); } alljoyn-15.04b/alljoyn_c/src/DeferredCallback.h000066400000000000000000000367751255700255500214340ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_C_DEFERREDCALLBACK_H #define _ALLJOYN_C_DEFERREDCALLBACK_H #include #include #include #include #include /* * The DeferredCallback class is used by the AllJoyn Unity Extension to force * callbacks to be returned from the main thread. The reason for this is when * running Unity on Android devices a single-apartment thread model is used. * By default AllJoyn's callbacks come back on there own threads. * * If the static variable sMainThreadCallbacksOnly is set to true when the * callback is received it will be added to a pending callbacks list. The * programmer is responsible for regularly calling * DeferredCallback::TriggerCallbacks to process the callbacks that have been * added to the pending callbacks list. * * In the code deferred callbacks are expected to be used as follows. * @code * if (!DeferredCallback::sMainThreadCallbacksOnly) { * callbacks.bus_disconnected(context); * } else { * DeferredCallback_1* dcb = * new DeferredCallback_1(callbacks.bus_disconnected, context); * DEFERRED_CALLBACK_EXECUTE(dcb); * } * @endcode * * note the dcb pointer is not deleted. It will be deleted in the * TriggerCallbacks method after the callback has been processed. * * Since the dcb pointer is only freed if the TriggerCallbacks is called the * DeferredCallback class should only be used if the variable * sMainThreadCallbackOnly is true. * * By default sMainThreadCallbackOnly is false. This can be change from the C * bindings by calling * @code * alljoyn_unity_set_deferred_callback_mainthread_only(QCC_TRUE) * @endcode * * The TriggerCallbacks can be called from the C bindings by calling * @code * alljoyn_unity_deferred_callbacks_process() * @endcode * * The DeferredCallback class is explicitly designed for usage in a specific * situation, the AllJoyn Unity Extension on Android. The default settings * (which do not used the DeferredCallback) should not be changed to used the * DeferredCallback except in that specific situation or for testing. */ //#define DEBUG_DEFERRED_CALLBACKS 1 #if DEBUG_DEFERRED_CALLBACKS # include # define DEFERRED_CALLBACK_EXECUTE(cb) cb->Execute(); printf("%s (%d) -- Executing on %s thread\n", __FILE__, __LINE__, DeferredCallback::IsMainThread() ? "main" : "alternate") #else # define DEFERRED_CALLBACK_EXECUTE(cb) cb->Execute() #endif namespace ajn { class DeferredCallback { public: DeferredCallback() : finished(false), executeNow(false) { if (!initilized) { sMainThread = qcc::Thread::GetThread(); initilized = true; } } virtual ~DeferredCallback() { } static int TriggerCallbacks() { int ret = 0; while (!sPendingCallbacks.empty()) { sCallbackListLock.Lock(MUTEX_CONTEXT); if (sPendingCallbacks.empty()) { sCallbackListLock.Unlock(MUTEX_CONTEXT); break; } DeferredCallback* cb = sPendingCallbacks.front(); sPendingCallbacks.pop_front(); sCallbackListLock.Unlock(MUTEX_CONTEXT); cb->runCallbackNow(); while (!cb->finished) qcc::Sleep(1); delete cb; ret++; } return ret; } static bool IsMainThread() { return (sMainThreadCallbacksOnly ? (sMainThread == qcc::Thread::GetThread()) : true); } protected: virtual void runCallbackNow() { }; void Wait() { while (!executeNow) qcc::Sleep(1); } class ScopeFinishedMarker { public: ScopeFinishedMarker(volatile sig_atomic_t* finished) : finishedSig(finished) { } ~ScopeFinishedMarker() { *finishedSig = true; } private: volatile sig_atomic_t* finishedSig; }; public: static bool sMainThreadCallbacksOnly; protected: static bool initilized; volatile sig_atomic_t finished; static std::list sPendingCallbacks; static qcc::Thread* sMainThread; static qcc::Mutex sCallbackListLock; volatile sig_atomic_t executeNow; private: }; template class DeferredCallback_1 : public DeferredCallback { public: typedef R (AJ_CALL * DeferredCallback_1_Callback)(T arg1); DeferredCallback_1(DeferredCallback_1_Callback callback, T param1) : _callback(callback), _param1(param1) { } virtual void runCallbackNow() { retVal = _callback(_param1); executeNow = true; } virtual R Execute() { ScopeFinishedMarker finisher(&finished); if (!sMainThreadCallbacksOnly) { runCallbackNow(); } else { sCallbackListLock.Lock(MUTEX_CONTEXT); sPendingCallbacks.push_back(this); sCallbackListLock.Unlock(MUTEX_CONTEXT); if (!IsMainThread()) { Wait(); } } R ret = retVal; return ret; } protected: DeferredCallback_1_Callback _callback; T _param1; R retVal; }; template class DeferredCallback_1 : public DeferredCallback { public: typedef void (AJ_CALL * DeferredCallback_1_Callback)(T arg1); DeferredCallback_1(DeferredCallback_1_Callback callback, T param1) : _callback(callback), _param1(param1) { } virtual void runCallbackNow() { _callback(_param1); executeNow = true; } virtual void Execute() { ScopeFinishedMarker finisher(&finished); if (!sMainThreadCallbacksOnly) { runCallbackNow(); } else { sCallbackListLock.Lock(MUTEX_CONTEXT); sPendingCallbacks.push_back(this); sCallbackListLock.Unlock(MUTEX_CONTEXT); if (!IsMainThread()) { Wait(); } } } protected: DeferredCallback_1_Callback _callback; T _param1; }; template class DeferredCallback_2 : public DeferredCallback { public: typedef R (AJ_CALL * DeferredCallback_2_Callback)(T arg1, U arg2); DeferredCallback_2(DeferredCallback_2_Callback callback, T param1, U param2) : _callback(callback), _param1(param1), _param2(param2) { } virtual void runCallbackNow() { retVal = _callback(_param1, _param2); executeNow = true; } virtual R Execute() { ScopeFinishedMarker finisher(&finished); if (!sMainThreadCallbacksOnly) { runCallbackNow(); } else { sCallbackListLock.Lock(MUTEX_CONTEXT); sPendingCallbacks.push_back(this); sCallbackListLock.Unlock(MUTEX_CONTEXT); if (!IsMainThread()) { Wait(); } } R ret = retVal; return ret; } protected: DeferredCallback_2_Callback _callback; T _param1; U _param2; R retVal; }; template class DeferredCallback_2 : public DeferredCallback { public: typedef void (AJ_CALL * DeferredCallback_2_Callback)(T arg1, U arg2); DeferredCallback_2(DeferredCallback_2_Callback callback, T param1, U param2) : _callback(callback), _param1(param1), _param2(param2) { } virtual void runCallbackNow() { _callback(_param1, _param2); executeNow = true; } virtual void Execute() { ScopeFinishedMarker finisher(&finished); if (!sMainThreadCallbacksOnly) { runCallbackNow(); } else { sCallbackListLock.Lock(MUTEX_CONTEXT); sPendingCallbacks.push_back(this); sCallbackListLock.Unlock(MUTEX_CONTEXT); if (!IsMainThread()) { Wait(); } } } protected: DeferredCallback_2_Callback _callback; T _param1; U _param2; }; template class DeferredCallback_3 : public DeferredCallback { public: typedef R (AJ_CALL * DeferredCallback_3_Callback)(T arg1, U arg2, V arg3); DeferredCallback_3(DeferredCallback_3_Callback callback, T param1, U param2, V param3) : _callback(callback), _param1(param1), _param2(param2), _param3(param3) { } virtual void runCallbackNow() { retVal = _callback(_param1, _param2, _param3); executeNow = true; } virtual R Execute() { ScopeFinishedMarker finisher(&finished); if (!sMainThreadCallbacksOnly) { runCallbackNow(); } else { sCallbackListLock.Lock(MUTEX_CONTEXT); sPendingCallbacks.push_back(this); sCallbackListLock.Unlock(MUTEX_CONTEXT); if (!IsMainThread()) { Wait(); } } R ret = retVal; return ret; } protected: DeferredCallback_3_Callback _callback; T _param1; U _param2; V _param3; R retVal; }; template class DeferredCallback_3 : public DeferredCallback { public: typedef void (AJ_CALL * DeferredCallback_3_Callback)(T arg1, U arg2, V arg3); DeferredCallback_3(DeferredCallback_3_Callback callback, T param1, U param2, V param3) : _callback(callback), _param1(param1), _param2(param2), _param3(param3) { } virtual void runCallbackNow() { _callback(_param1, _param2, _param3); executeNow = true; } virtual void Execute() { ScopeFinishedMarker finisher(&finished); if (!sMainThreadCallbacksOnly) { runCallbackNow(); } else { sCallbackListLock.Lock(MUTEX_CONTEXT); sPendingCallbacks.push_back(this); sCallbackListLock.Unlock(MUTEX_CONTEXT); if (!IsMainThread()) { Wait(); } } } protected: DeferredCallback_3_Callback _callback; T _param1; U _param2; V _param3; }; template class DeferredCallback_4 : public DeferredCallback { public: typedef R (AJ_CALL * DeferredCallback_4_Callback)(T arg1, U arg2, V arg3, W arg4); DeferredCallback_4(DeferredCallback_4_Callback callback, T param1, U param2, V param3, W param4) : _callback(callback), _param1(param1), _param2(param2), _param3(param3), _param4(param4) { } virtual void runCallbackNow() { retVal = _callback(_param1, _param2, _param3, _param4); executeNow = true; } virtual R Execute() { ScopeFinishedMarker finisher(&finished); if (!sMainThreadCallbacksOnly) { runCallbackNow(); } else { sCallbackListLock.Lock(MUTEX_CONTEXT); sPendingCallbacks.push_back(this); sCallbackListLock.Unlock(MUTEX_CONTEXT); if (!IsMainThread()) { Wait(); } } R ret = retVal; return ret; } protected: DeferredCallback_4_Callback _callback; T _param1; U _param2; V _param3; W _param4; R retVal; }; template class DeferredCallback_4 : public DeferredCallback { public: typedef void (AJ_CALL * DeferredCallback_4_Callback)(T arg1, U arg2, V arg3, W arg4); DeferredCallback_4(DeferredCallback_4_Callback callback, T param1, U param2, V param3, W param4) : _callback(callback), _param1(param1), _param2(param2), _param3(param3), _param4(param4) { } virtual void runCallbackNow() { _callback(_param1, _param2, _param3, _param4); executeNow = true; } virtual void Execute() { ScopeFinishedMarker finisher(&finished); if (!sMainThreadCallbacksOnly) { runCallbackNow(); } else { sCallbackListLock.Lock(MUTEX_CONTEXT); sPendingCallbacks.push_back(this); sCallbackListLock.Unlock(MUTEX_CONTEXT); if (!IsMainThread()) { Wait(); } } } protected: DeferredCallback_4_Callback _callback; T _param1; U _param2; V _param3; W _param4; }; template class DeferredCallback_6 : public DeferredCallback { public: typedef R (AJ_CALL * DeferredCallback_6_Callback)(T arg1, U arg2, V arg3, W arg4, X arg5, Y arg6); DeferredCallback_6(DeferredCallback_6_Callback callback, T param1, U param2, V param3, W param4, X param5, Y param6) : _callback(callback), _param1(param1), _param2(param2), _param3(param3), _param4(param4), _param5(param5), _param6(param6) { } virtual void runCallbackNow() { retVal = _callback(_param1, _param2, _param3, _param4, _param5, _param6); executeNow = true; } virtual R Execute() { ScopeFinishedMarker finisher(&finished); if (!sMainThreadCallbacksOnly) { runCallbackNow(); } else { sCallbackListLock.Lock(MUTEX_CONTEXT); sPendingCallbacks.push_back(this); sCallbackListLock.Unlock(MUTEX_CONTEXT); if (!IsMainThread()) { Wait(); } } R ret = retVal; return ret; } protected: DeferredCallback_6_Callback _callback; T _param1; U _param2; V _param3; W _param4; X _param5; Y _param6; R retVal; }; template class DeferredCallback_6 : public DeferredCallback { public: typedef void (AJ_CALL * DeferredCallback_6_Callback)(T arg1, U arg2, V arg3, W arg4, X arg5, Y arg6); DeferredCallback_6(DeferredCallback_6_Callback callback, T param1, U param2, V param3, W param4, X param5, Y param6) : _callback(callback), _param1(param1), _param2(param2), _param3(param3), _param4(param4), _param5(param5), _param6(param6) { } virtual void runCallbackNow() { _callback(_param1, _param2, _param3, _param4, _param5, _param6); executeNow = true; } virtual void Execute() { ScopeFinishedMarker finisher(&finished); if (!sMainThreadCallbacksOnly) { runCallbackNow(); } else { sCallbackListLock.Lock(MUTEX_CONTEXT); sPendingCallbacks.push_back(this); sCallbackListLock.Unlock(MUTEX_CONTEXT); if (!IsMainThread()) { Wait(); } } } protected: DeferredCallback_6_Callback _callback; T _param1; U _param2; V _param3; W _param4; X _param5; Y _param6; }; } #endif alljoyn-15.04b/alljoyn_c/src/Init.cc000066400000000000000000000023771255700255500173270ustar00rootroot00000000000000/** * @file * Init implements the library init and shutdown functions. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #define QCC_MODULE "ALLJOYN_C" QStatus AJ_CALL alljoyn_init(void) { return AllJoynInit(); } QStatus AJ_CALL alljoyn_shutdown(void) { return AllJoynShutdown(); } alljoyn-15.04b/alljoyn_c/src/InterfaceDescription.cc000066400000000000000000000602721255700255500225260ustar00rootroot00000000000000/** * @file * * This file implements the InterfaceDescription class */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #define QCC_MODULE "ALLJOYN_C" struct _alljoyn_interfacedescription_handle { /* Empty by design, this is just to allow the type restrictions to save coders from themselves */ }; size_t AJ_CALL alljoyn_interfacedescription_member_getannotationscount(alljoyn_interfacedescription_member member) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::InterfaceDescription::Member*)member.internal_member)->GetAnnotations(NULL, NULL, 0); } void AJ_CALL alljoyn_interfacedescription_member_getannotationatindex(alljoyn_interfacedescription_member member, size_t index, char* name, size_t* name_size, char* value, size_t* value_size) { QCC_DbgTrace(("%s", __FUNCTION__)); size_t annotation_size = ((ajn::InterfaceDescription::Member*)member.internal_member)->GetAnnotations(NULL, NULL, 0); qcc::String* inner_names = new qcc::String[annotation_size]; qcc::String* inner_values = new qcc::String[annotation_size]; ((ajn::InterfaceDescription::Member*)member.internal_member)->GetAnnotations(inner_names, inner_values, annotation_size); if ((name != nullptr) && (value != nullptr)) { if (*name_size >= 1) { strncpy(name, inner_names[index].c_str(), *name_size); name[*name_size - 1] = '\0'; } if (*value_size >= 1) { strncpy(value, inner_values[index].c_str(), *value_size); value[*value_size - 1] = '\0'; } } //size of the string plus the nul character *name_size = inner_names[index].size() + 1; //size of the string plus the nul character *value_size = inner_values[index].size() + 1; delete[] inner_names; delete[] inner_values; return; } QCC_BOOL AJ_CALL alljoyn_interfacedescription_member_getannotation(alljoyn_interfacedescription_member member, const char* name, char* value, size_t* value_size) { QCC_DbgTrace(("%s", __FUNCTION__)); QCC_BOOL return_value = QCC_FALSE; qcc::String out_val; bool b = ((ajn::InterfaceDescription::Member*)member.internal_member)->GetAnnotation(name, out_val); if ((value != nullptr) && (*value_size >= 1)) { if (b) { ::strncpy(value, out_val.c_str(), *value_size); value[*value_size - 1] = '\0'; return_value = QCC_TRUE; } else { //return empty string *value = '\0'; } } *value_size = out_val.size() + 1; return return_value; } size_t AJ_CALL alljoyn_interfacedescription_property_getannotationscount(alljoyn_interfacedescription_property property) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::InterfaceDescription::Property*)property.internal_property)->GetAnnotations(NULL, NULL, 0); } void AJ_CALL alljoyn_interfacedescription_property_getannotationatindex(alljoyn_interfacedescription_property property, size_t index, char* name, size_t* name_size, char* value, size_t* value_size) { QCC_DbgTrace(("%s", __FUNCTION__)); size_t annotation_size = ((ajn::InterfaceDescription::Property*)property.internal_property)->GetAnnotations(NULL, NULL, 0); qcc::String* inner_names = new qcc::String[annotation_size]; qcc::String* inner_values = new qcc::String[annotation_size]; ((ajn::InterfaceDescription::Property*)property.internal_property)->GetAnnotations(inner_names, inner_values, annotation_size); if ((name != nullptr) && (value != nullptr)) { if (*name_size >= 1) { strncpy(name, inner_names[index].c_str(), *name_size); name[*name_size - 1] = '\0'; } if (*value_size >= 1) { strncpy(value, inner_values[index].c_str(), *value_size); value[*value_size - 1] = '\0'; } } //size of the string plus the nul character *name_size = inner_names[index].size() + 1; //size of the string plus the nul character *value_size = inner_values[index].size() + 1; delete[] inner_names; delete[] inner_values; return; } QCC_BOOL AJ_CALL alljoyn_interfacedescription_property_getannotation(alljoyn_interfacedescription_property property, const char* name, char* value, size_t* value_size) { QCC_DbgTrace(("%s", __FUNCTION__)); QCC_BOOL return_value = QCC_FALSE; qcc::String out_val; bool b = ((ajn::InterfaceDescription::Property*)property.internal_property)->GetAnnotation(name, out_val); if ((value != nullptr) && (*value_size >= 1)) { if (b) { ::strncpy(value, out_val.c_str(), *value_size); value[*value_size - 1] = '\0'; return_value = QCC_TRUE; } else { //return empty string *value = '\0'; } } *value_size = out_val.size() + 1; return return_value; } void AJ_CALL alljoyn_interfacedescription_activate(alljoyn_interfacedescription iface) { QCC_DbgTrace(("%s", __FUNCTION__)); ((ajn::InterfaceDescription*)iface)->Activate(); } QCC_BOOL AJ_CALL alljoyn_interfacedescription_getmember(const alljoyn_interfacedescription iface, const char* name, alljoyn_interfacedescription_member* member) { QCC_DbgTrace(("%s", __FUNCTION__)); const ajn::InterfaceDescription::Member* found_member = ((const ajn::InterfaceDescription*)iface)->GetMember(name); if (found_member != NULL) { member->iface = (alljoyn_interfacedescription)found_member->iface; member->memberType = (alljoyn_messagetype)found_member->memberType; member->name = found_member->name.c_str(); member->signature = found_member->signature.c_str(); member->returnSignature = found_member->returnSignature.c_str(); member->argNames = found_member->argNames.c_str(); member->internal_member = found_member; } return (found_member == NULL ? QCC_FALSE : QCC_TRUE); } QStatus AJ_CALL alljoyn_interfacedescription_addannotation(alljoyn_interfacedescription iface, const char* name, const char* value) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::InterfaceDescription*)iface)->AddAnnotation(name, value); } QCC_BOOL AJ_CALL alljoyn_interfacedescription_getannotation(alljoyn_interfacedescription iface, const char* name, char* value, size_t* value_size) { QCC_DbgTrace(("%s", __FUNCTION__)); QCC_BOOL return_value = QCC_FALSE; qcc::String out_val; const bool b = ((ajn::InterfaceDescription*)iface)->GetAnnotation(name, out_val); if ((value != nullptr) && (*value_size >= 1)) { if (b) { ::strncpy(value, out_val.c_str(), *value_size); value[*value_size - 1] = '\0'; return_value = QCC_TRUE; } else { //return empty string *value = '\0'; } } *value_size = out_val.size() + 1; return return_value; } size_t AJ_CALL alljoyn_interfacedescription_getannotationscount(alljoyn_interfacedescription iface) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::InterfaceDescription*)iface)->GetAnnotations(NULL, NULL, 0); } void AJ_CALL alljoyn_interfacedescription_getannotationatindex(alljoyn_interfacedescription iface, size_t index, char* name, size_t* name_size, char* value, size_t* value_size) { QCC_DbgTrace(("%s", __FUNCTION__)); size_t annotation_size = ((ajn::InterfaceDescription*)iface)->GetAnnotations(NULL, NULL, 0); qcc::String* inner_names = new qcc::String[annotation_size]; qcc::String* inner_values = new qcc::String[annotation_size]; ((ajn::InterfaceDescription*)iface)->GetAnnotations(inner_names, inner_values, annotation_size); if ((name != nullptr) && (value != nullptr)) { if (*name_size >= 1) { strncpy(name, inner_names[index].c_str(), *name_size); name[*name_size - 1] = '\0'; } if (*value_size >= 1) { strncpy(value, inner_values[index].c_str(), *value_size); value[*value_size - 1] = '\0'; } } //size of the string plus the nul character *name_size = inner_names[index].size() + 1; //size of the string plus the nul character *value_size = inner_values[index].size() + 1; delete[] inner_names; delete[] inner_values; return; } QStatus AJ_CALL alljoyn_interfacedescription_addmember(alljoyn_interfacedescription iface, alljoyn_messagetype type, const char* name, const char* inputSig, const char* outSig, const char* argNames, uint8_t annotation) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::InterfaceDescription*)iface)->AddMember((ajn::AllJoynMessageType)type, name, inputSig, outSig, argNames, annotation); } QStatus AJ_CALL alljoyn_interfacedescription_addmemberannotation(alljoyn_interfacedescription iface, const char* member, const char* name, const char* value) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::InterfaceDescription*)iface)->AddMemberAnnotation(member, name, value); } QCC_BOOL AJ_CALL alljoyn_interfacedescription_getmemberannotation(alljoyn_interfacedescription iface, const char* member, const char* name, char* value, size_t* value_size) { QCC_DbgTrace(("%s", __FUNCTION__)); QCC_BOOL return_value = QCC_FALSE; qcc::String out_val; const bool b = ((ajn::InterfaceDescription*)iface)->GetMemberAnnotation(member, name, out_val); if ((value != nullptr) && (*value_size >= 1)) { if (b) { ::strncpy(value, out_val.c_str(), *value_size); value[*value_size - 1] = '\0'; return_value = QCC_TRUE; } else { //return empty string *value = '\0'; } } *value_size = out_val.size() + 1; return return_value; } size_t AJ_CALL alljoyn_interfacedescription_getmembers(const alljoyn_interfacedescription iface, alljoyn_interfacedescription_member* members, size_t numMembers) { QCC_DbgTrace(("%s", __FUNCTION__)); size_t ret = 0; const ajn::InterfaceDescription::Member** tempMembers = NULL; if (members != NULL) { tempMembers = new const ajn::InterfaceDescription::Member*[numMembers]; ret = ((const ajn::InterfaceDescription*)iface)->GetMembers(tempMembers, numMembers); for (size_t i = 0; i < ret; i++) { members[i].iface = (alljoyn_interfacedescription)tempMembers[i]->iface; members[i].memberType = (alljoyn_messagetype)tempMembers[i]->memberType; members[i].name = tempMembers[i]->name.c_str(); members[i].signature = tempMembers[i]->signature.c_str(); members[i].returnSignature = tempMembers[i]->returnSignature.c_str(); members[i].argNames = tempMembers[i]->argNames.c_str(); members[i].internal_member = tempMembers[i]; } } else { ret = ((const ajn::InterfaceDescription*)iface)->GetMembers(); } if (tempMembers != NULL) { delete [] tempMembers; } return ret; } QCC_BOOL AJ_CALL alljoyn_interfacedescription_hasmember(alljoyn_interfacedescription iface, const char* name, const char* inSig, const char* outSig) { QCC_DbgTrace(("%s", __FUNCTION__)); return (((ajn::InterfaceDescription*)iface)->HasMember(name, inSig, outSig) == true ? QCC_TRUE : QCC_FALSE); } QStatus AJ_CALL alljoyn_interfacedescription_addmethod(alljoyn_interfacedescription iface, const char* name, const char* inputSig, const char* outSig, const char* argNames, uint8_t annotation, const char* accessPerms) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::InterfaceDescription*)iface)->AddMember(ajn::MESSAGE_METHOD_CALL, name, inputSig, outSig, argNames, annotation, accessPerms); } QCC_BOOL AJ_CALL alljoyn_interfacedescription_getmethod(alljoyn_interfacedescription iface, const char* name, alljoyn_interfacedescription_member* member) { QCC_DbgTrace(("%s", __FUNCTION__)); const ajn::InterfaceDescription::Member* found_member = ((const ajn::InterfaceDescription*)iface)->GetMember(name); /* * only return the member if it is a MESSAGE_METHOD_CALL type all others return NULL */ if (found_member && found_member->memberType == ajn::MESSAGE_METHOD_CALL) { member->iface = (alljoyn_interfacedescription)found_member->iface; member->memberType = (alljoyn_messagetype)found_member->memberType; member->name = found_member->name.c_str(); member->signature = found_member->signature.c_str(); member->returnSignature = found_member->returnSignature.c_str(); member->argNames = found_member->argNames.c_str(); member->internal_member = found_member; } else { found_member = NULL; } return (found_member == NULL ? QCC_FALSE : QCC_TRUE); } QStatus AJ_CALL alljoyn_interfacedescription_addsignal(alljoyn_interfacedescription iface, const char* name, const char* sig, const char* argNames, uint8_t annotation, const char* accessPerms) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::InterfaceDescription*)iface)->AddMember(ajn::MESSAGE_SIGNAL, name, sig, NULL, argNames, annotation, accessPerms); } QCC_BOOL AJ_CALL alljoyn_interfacedescription_getsignal(alljoyn_interfacedescription iface, const char* name, alljoyn_interfacedescription_member* member) { QCC_DbgTrace(("%s", __FUNCTION__)); const ajn::InterfaceDescription::Member* found_member = ((const ajn::InterfaceDescription*)iface)->GetMember(name); /* * only return the member if it is a MESSAGE_SIGNAL type all others return NULL */ if (found_member && found_member->memberType == ajn::MESSAGE_SIGNAL) { member->iface = (alljoyn_interfacedescription)found_member->iface; member->memberType = (alljoyn_messagetype)found_member->memberType; member->name = found_member->name.c_str(); member->signature = found_member->signature.c_str(); member->returnSignature = found_member->returnSignature.c_str(); member->argNames = found_member->argNames.c_str(); member->internal_member = found_member; } else { found_member = NULL; } return (found_member == NULL ? QCC_FALSE : QCC_TRUE); } QCC_BOOL AJ_CALL alljoyn_interfacedescription_getproperty(const alljoyn_interfacedescription iface, const char* name, alljoyn_interfacedescription_property* property) { QCC_DbgTrace(("%s", __FUNCTION__)); const ajn::InterfaceDescription::Property* found_prop = ((const ajn::InterfaceDescription*)iface)->GetProperty(name); if (found_prop != NULL) { property->name = found_prop->name.c_str(); property->signature = found_prop->signature.c_str(); property->access = found_prop->access; property->internal_property = found_prop; } return (found_prop == NULL ? QCC_FALSE : QCC_TRUE); } size_t AJ_CALL alljoyn_interfacedescription_getproperties(const alljoyn_interfacedescription iface, alljoyn_interfacedescription_property* props, size_t numProps) { QCC_DbgTrace(("%s", __FUNCTION__)); size_t ret = 0; const ajn::InterfaceDescription::Property** tempProps = NULL; if (props != NULL) { tempProps = new const ajn::InterfaceDescription::Property*[numProps]; ret = ((const ajn::InterfaceDescription*)iface)->GetProperties(tempProps, numProps); for (size_t i = 0; i < ret; i++) { props[i].name = tempProps[i]->name.c_str(); props[i].signature = tempProps[i]->signature.c_str(); props[i].access = tempProps[i]->access; props[i].internal_property = tempProps[i]; } } else { ret = ((const ajn::InterfaceDescription*)iface)->GetProperties(); } if (tempProps != NULL) { delete [] tempProps; } return ret; } QStatus AJ_CALL alljoyn_interfacedescription_addproperty(alljoyn_interfacedescription iface, const char* name, const char* signature, uint8_t access) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::InterfaceDescription*)iface)->AddProperty(name, signature, access); } QCC_BOOL AJ_CALL alljoyn_interfacedescription_hasproperty(const alljoyn_interfacedescription iface, const char* name) { QCC_DbgTrace(("%s", __FUNCTION__)); return (((const ajn::InterfaceDescription*)iface)->HasProperty(name) == true ? QCC_TRUE : QCC_FALSE); } QCC_BOOL AJ_CALL alljoyn_interfacedescription_hasproperties(const alljoyn_interfacedescription iface) { QCC_DbgTrace(("%s", __FUNCTION__)); return (((const ajn::InterfaceDescription*)iface)->HasProperties() == true ? QCC_TRUE : QCC_FALSE); } QStatus AJ_CALL alljoyn_interfacedescription_addpropertyannotation(alljoyn_interfacedescription iface, const char* property, const char* name, const char* value) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::InterfaceDescription*)iface)->AddPropertyAnnotation(property, name, value); } QCC_BOOL AJ_CALL alljoyn_interfacedescription_getpropertyannotation(alljoyn_interfacedescription iface, const char* property, const char* name, char* value, size_t* value_size) { QCC_DbgTrace(("%s", __FUNCTION__)); if (iface == NULL) { return QCC_FALSE; } if (property == NULL) { return QCC_FALSE; } if (name == NULL) { return QCC_FALSE; } QCC_BOOL return_value = QCC_FALSE; qcc::String out_val; const bool b = ((ajn::InterfaceDescription*)iface)->GetPropertyAnnotation(property, name, out_val); //Return the size of the string so memory can be allocated for the string if ((value != nullptr) && (*value_size >= 1)) { if (b) { ::strncpy(value, out_val.c_str(), *value_size); value[*value_size - 1] = '\0'; return_value = QCC_TRUE; } else { //return empty string *value = '\0'; } } *value_size = out_val.size() + 1; return return_value; } const char* AJ_CALL alljoyn_interfacedescription_getname(const alljoyn_interfacedescription iface) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((const ajn::InterfaceDescription*)iface)->GetName(); } size_t AJ_CALL alljoyn_interfacedescription_introspect(const alljoyn_interfacedescription iface, char* str, size_t buf, size_t indent) { QCC_DbgTrace(("%s", __FUNCTION__)); if (iface == nullptr) { return (size_t)0; } qcc::String s = ((const ajn::InterfaceDescription*)iface)->Introspect(indent); /* * it is ok to send in NULL for str when the user is only interested in the * size of the resulting string. */ if ((str != nullptr) && (buf >= 1)) { strncpy(str, s.c_str(), buf); str[buf - 1] = '\0'; } //size of the string plus the nul character return s.size() + 1; } QCC_BOOL AJ_CALL alljoyn_interfacedescription_issecure(const alljoyn_interfacedescription iface) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((const ajn::InterfaceDescription*)iface)->IsSecure(); } alljoyn_interfacedescription_securitypolicy AJ_CALL alljoyn_interfacedescription_getsecuritypolicy(const alljoyn_interfacedescription iface) { QCC_DbgTrace(("%s", __FUNCTION__)); return (alljoyn_interfacedescription_securitypolicy)((const ajn::InterfaceDescription*)iface)->GetSecurityPolicy(); } QCC_BOOL AJ_CALL alljoyn_interfacedescription_eql(const alljoyn_interfacedescription one, const alljoyn_interfacedescription other) { QCC_DbgTrace(("%s", __FUNCTION__)); const ajn::InterfaceDescription& _one = *((const ajn::InterfaceDescription*)one); const ajn::InterfaceDescription& _other = *((const ajn::InterfaceDescription*)other); return (_one == _other ? QCC_TRUE : QCC_FALSE); } QCC_BOOL AJ_CALL alljoyn_interfacedescription_member_eql(const alljoyn_interfacedescription_member one, const alljoyn_interfacedescription_member other) { QCC_DbgTrace(("%s", __FUNCTION__)); const ajn::InterfaceDescription::Member _one = *((ajn::InterfaceDescription::Member*)one.internal_member); const ajn::InterfaceDescription::Member _other = *((ajn::InterfaceDescription::Member*)other.internal_member); return (_one == _other ? QCC_TRUE : QCC_FALSE); } QCC_BOOL AJ_CALL alljoyn_interfacedescription_property_eql(const alljoyn_interfacedescription_property one, const alljoyn_interfacedescription_property other) { QCC_DbgTrace(("%s", __FUNCTION__)); const ajn::InterfaceDescription::Property _one = *((ajn::InterfaceDescription::Property*)one.internal_property); const ajn::InterfaceDescription::Property _other = *((ajn::InterfaceDescription::Property*)other.internal_property); return (_one == _other ? QCC_TRUE : QCC_FALSE); } alljoyn-15.04b/alljoyn_c/src/KeyStoreListener.cc000066400000000000000000000105111255700255500216640ustar00rootroot00000000000000/** * @file * This implements the C accessable version of the SessionPortListener class using * function pointers, and a pass-through implementation of SessionPortListener. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #define QCC_MODULE "ALLJOYN_C" namespace ajn { /** * Abstract base class implemented by AllJoyn users and called by AllJoyn to inform * users of keystore related events. */ class KeyStoreListenerCallbackC : public KeyStoreListener { public: KeyStoreListenerCallbackC(const alljoyn_keystorelistener_callbacks* in_callbacks, const void* in_context) { QCC_DbgTrace(("%s", __FUNCTION__)); memcpy(&callbacks, in_callbacks, sizeof(alljoyn_keystorelistener_callbacks)); context = in_context; } virtual QStatus LoadRequest(KeyStore& keyStore) { QCC_DbgTrace(("%s", __FUNCTION__)); assert(callbacks.load_request != NULL && "load_request callback required."); return callbacks.load_request(context, (alljoyn_keystorelistener) this, (alljoyn_keystore)(&keyStore)); } virtual QStatus StoreRequest(KeyStore& keyStore) { QCC_DbgTrace(("%s", __FUNCTION__)); assert(callbacks.store_request != NULL && "store_request callback required."); return callbacks.store_request(context, (alljoyn_keystorelistener) this, (alljoyn_keystore)(&keyStore)); } protected: alljoyn_keystorelistener_callbacks callbacks; const void* context; }; } struct _alljoyn_keystorelistener_handle { /* Empty by design, this is just to allow the type restrictions to save coders from themselves */ }; alljoyn_keystorelistener AJ_CALL alljoyn_keystorelistener_create(const alljoyn_keystorelistener_callbacks* callbacks, const void* context) { QCC_DbgTrace(("%s", __FUNCTION__)); assert(callbacks->load_request != NULL && "load_request callback required."); assert(callbacks->store_request != NULL && "store_request callback required."); return (alljoyn_keystorelistener) new ajn::KeyStoreListenerCallbackC(callbacks, context); } void AJ_CALL alljoyn_keystorelistener_destroy(alljoyn_keystorelistener listener) { QCC_DbgTrace(("%s", __FUNCTION__)); assert(listener != NULL && "listener parameter must not be NULL"); delete (ajn::KeyStoreListenerCallbackC*)listener; } QStatus AJ_CALL alljoyn_keystorelistener_putkeys(alljoyn_keystorelistener listener, alljoyn_keystore keyStore, const char* source, const char* password) { QCC_DbgTrace(("%s", __FUNCTION__)); ajn::KeyStore& ks = *((ajn::KeyStore*)keyStore); return ((ajn::KeyStoreListener*)listener)->PutKeys(ks, source, password); } QStatus AJ_CALL alljoyn_keystorelistener_getkeys(alljoyn_keystorelistener listener, alljoyn_keystore keyStore, char* sink, size_t* sink_sz) { QCC_DbgTrace(("%s", __FUNCTION__)); qcc::String sinkStr; ajn::KeyStore& ks = *((ajn::KeyStore*)keyStore); QStatus ret = ((ajn::KeyStoreListener*)listener)->GetKeys(ks, sinkStr); if ((sink != nullptr) && (*sink_sz >= 1)) { strncpy(sink, sinkStr.c_str(), *sink_sz); sink[*sink_sz - 1] = '\0'; } if (*sink_sz < sinkStr.length() + 1) { ret = ER_BUFFER_TOO_SMALL; } *sink_sz = sinkStr.length() + 1; return ret; } alljoyn-15.04b/alljoyn_c/src/Message.cc000066400000000000000000000174411255700255500200060ustar00rootroot00000000000000/** * @file * * This file implements the _Message class */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include "BusAttachmentC.h" #include "MsgArgC.h" #include #include #include #define QCC_MODULE "ALLJOYN_C" struct _alljoyn_message_handle { _alljoyn_message_handle(ajn::BusAttachmentC& bus) : msg(bus) { } ajn::Message msg; }; alljoyn_message AJ_CALL alljoyn_message_create(alljoyn_busattachment bus) { QCC_DbgTrace(("%s", __FUNCTION__)); return new struct _alljoyn_message_handle (*((ajn::BusAttachmentC*)bus)); } void AJ_CALL alljoyn_message_destroy(alljoyn_message msg) { QCC_DbgTrace(("%s", __FUNCTION__)); delete msg; } QCC_BOOL AJ_CALL alljoyn_message_isbroadcastsignal(alljoyn_message msg) { QCC_DbgTrace(("%s", __FUNCTION__)); return msg->msg->IsBroadcastSignal(); } QCC_BOOL AJ_CALL alljoyn_message_isglobalbroadcast(alljoyn_message msg) { QCC_DbgTrace(("%s", __FUNCTION__)); return msg->msg->IsGlobalBroadcast(); } QCC_BOOL AJ_CALL alljoyn_message_issessionless(alljoyn_message msg) { QCC_DbgTrace(("%s", __FUNCTION__)); return msg->msg->IsSessionless(); } uint8_t AJ_CALL alljoyn_message_getflags(alljoyn_message msg) { QCC_DbgTrace(("%s", __FUNCTION__)); return msg->msg->GetFlags(); } QCC_BOOL AJ_CALL alljoyn_message_isexpired(alljoyn_message msg, uint32_t* tillExpireMS) { QCC_DbgTrace(("%s", __FUNCTION__)); return msg->msg->IsExpired(tillExpireMS); } QCC_BOOL AJ_CALL alljoyn_message_isunreliable(alljoyn_message msg) { QCC_DbgTrace(("%s", __FUNCTION__)); return msg->msg->IsUnreliable(); } QCC_BOOL AJ_CALL alljoyn_message_isencrypted(alljoyn_message msg) { QCC_DbgTrace(("%s", __FUNCTION__)); return msg->msg->IsEncrypted(); } const char* AJ_CALL alljoyn_message_getauthmechanism(alljoyn_message msg) { QCC_DbgTrace(("%s", __FUNCTION__)); return msg->msg->GetAuthMechanism().c_str(); } alljoyn_messagetype AJ_CALL alljoyn_message_gettype(alljoyn_message msg) { QCC_DbgTrace(("%s", __FUNCTION__)); return (alljoyn_messagetype)msg->msg->GetType(); } void AJ_CALL alljoyn_message_getargs(alljoyn_message msg, size_t* numArgs, alljoyn_msgarg* args) { QCC_DbgTrace(("%s", __FUNCTION__)); const ajn::MsgArg* tmpArgs; msg->msg->GetArgs(*numArgs, tmpArgs); *args = (alljoyn_msgarg)tmpArgs; } const alljoyn_msgarg AJ_CALL alljoyn_message_getarg(alljoyn_message msg, size_t argN) { QCC_DbgTrace(("%s", __FUNCTION__)); return (alljoyn_msgarg)msg->msg->GetArg(argN); } QStatus AJ_CALL alljoyn_message_parseargs(alljoyn_message msg, const char* signature, ...) { QCC_DbgTrace(("%s", __FUNCTION__)); size_t sigLen = (signature ? strlen(signature) : 0); if (sigLen == 0) { return ER_BAD_ARG_2; } const ajn::MsgArg* msgArgs; size_t numMsgArgs; msg->msg->GetArgs(numMsgArgs, msgArgs); va_list argp; va_start(argp, signature); QStatus status = ajn::MsgArgC::VParseArgsC(signature, sigLen, msgArgs, numMsgArgs, &argp); va_end(argp); return status; } uint32_t AJ_CALL alljoyn_message_getcallserial(alljoyn_message msg) { QCC_DbgTrace(("%s", __FUNCTION__)); return msg->msg->GetCallSerial(); } const char* AJ_CALL alljoyn_message_getsignature(alljoyn_message msg) { QCC_DbgTrace(("%s", __FUNCTION__)); return msg->msg->GetSignature(); } const char* AJ_CALL alljoyn_message_getobjectpath(alljoyn_message msg) { QCC_DbgTrace(("%s", __FUNCTION__)); return msg->msg->GetObjectPath(); } const char* AJ_CALL alljoyn_message_getinterface(alljoyn_message msg) { QCC_DbgTrace(("%s", __FUNCTION__)); return msg->msg->GetInterface(); } const char* AJ_CALL alljoyn_message_getmembername(alljoyn_message msg) { QCC_DbgTrace(("%s", __FUNCTION__)); return msg->msg->GetMemberName(); } uint32_t AJ_CALL alljoyn_message_getreplyserial(alljoyn_message msg) { QCC_DbgTrace(("%s", __FUNCTION__)); return msg->msg->GetReplySerial(); } const char* AJ_CALL alljoyn_message_getsender(alljoyn_message msg) { QCC_DbgTrace(("%s", __FUNCTION__)); return msg->msg->GetSender(); } const char* AJ_CALL alljoyn_message_getreceiveendpointname(alljoyn_message msg) { QCC_DbgTrace(("%s", __FUNCTION__)); return msg->msg->GetRcvEndpointName(); } const char* AJ_CALL alljoyn_message_getdestination(alljoyn_message msg) { QCC_DbgTrace(("%s", __FUNCTION__)); return msg->msg->GetDestination(); } uint32_t AJ_CALL alljoyn_message_getcompressiontoken(alljoyn_message msg) { QCC_DbgTrace(("%s", __FUNCTION__)); return msg->msg->GetCompressionToken(); } alljoyn_sessionid AJ_CALL alljoyn_message_getsessionid(alljoyn_message msg) { QCC_DbgTrace(("%s", __FUNCTION__)); return (alljoyn_sessionid)msg->msg->GetSessionId(); } const char* AJ_CALL alljoyn_message_geterrorname(alljoyn_message msg, char* errorMessage, size_t* errorMessage_size) { QCC_DbgTrace(("%s", __FUNCTION__)); qcc::String* str = new qcc::String(""); const char* ret = msg->msg->GetErrorName(str); if ((errorMessage != nullptr) && (*errorMessage_size >= 1)) { strncpy(errorMessage, str->c_str(), *errorMessage_size); errorMessage[*errorMessage_size - 1] = '\0'; } //string plus nul character *errorMessage_size = str->size() + 1; delete str; return ret; } size_t AJ_CALL alljoyn_message_tostring(alljoyn_message msg, char* str, size_t buf) { QCC_DbgTrace(("%s", __FUNCTION__)); if (msg == nullptr) { return (size_t)0; } qcc::String s = msg->msg->ToString(); /* * it is ok to send in NULL for str when the user is only interested in the * size of the resulting string. */ if ((str != nullptr) && (buf >= 1)) { strncpy(str, s.c_str(), buf); str[buf - 1] = '\0'; } //string plus nul character return s.size() + 1; } size_t AJ_CALL alljoyn_message_description(alljoyn_message msg, char* str, size_t buf) { QCC_DbgTrace(("%s", __FUNCTION__)); if (msg == nullptr) { return (size_t)0; } qcc::String s = msg->msg->Description(); /* * it is ok to send in NULL for str when the user is only interested in the * size of the resulting string. */ if ((str != nullptr) && (buf >= 1)) { strncpy(str, s.c_str(), buf); str[buf - 1] = '\0'; } //string plus nul character return s.size() + 1; } uint32_t AJ_CALL alljoyn_message_gettimestamp(alljoyn_message msg) { QCC_DbgTrace(("%s", __FUNCTION__)); return msg->msg->GetTimeStamp(); } QCC_BOOL AJ_CALL alljoyn_message_eql(const alljoyn_message one, const alljoyn_message other) { QCC_DbgTrace(("%s", __FUNCTION__)); return (one->msg == other->msg); } void AJ_CALL alljoyn_message_setendianess(const char endian) { QCC_DbgTrace(("%s", __FUNCTION__)); ajn::_Message::SetEndianess(endian); } alljoyn-15.04b/alljoyn_c/src/MessageReceiverC.h000066400000000000000000000057051255700255500214400ustar00rootroot00000000000000/** * @file * MessageReceiverC is an implementation of the MessagReceiver base class responsible * for mapping a C++ style MessageReceiver to a C style alljoyn_messagereceiver * function pointer */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_C_MESSAGERECEIVERC_H #define _ALLJOYN_C_MESSAGERECEIVERC_H #include namespace ajn { /* * When setting up a asynchronous method call a callback handler for C * alljoyn_messagereceiver_replyhandler_ptr function pointer will be passed in as * the callback handler. AllJoyn expects a MessageReceiver::ReplyHandler method * handler. The function handler will be passed as the part of the void* * context that is passed to the internal callback handler and will then be used * to map the internal callback handler to the user defined * messagereceived_replyhandler callback function pointer. */ class MessageReceiverReplyHandlerCallbackContext { public: MessageReceiverReplyHandlerCallbackContext(alljoyn_messagereceiver_replyhandler_ptr replyhandler_ptr, void* context) : replyhandler_ptr(replyhandler_ptr), context(context) { } alljoyn_messagereceiver_replyhandler_ptr replyhandler_ptr; void* context; }; class MessageReceiverC : public MessageReceiver { public: void ReplyHandler(ajn::Message& message, void* context) { /* * The replyhandler_ptr in the context pointer is allocated as part * of the alljoyn_proxybusobject_methodcallasync function call or the * alljoyn_proxybusobject_methodcallasync_member function call. * Once the function alljoyn_messagereceiver_replyhandler_ptr has been * called the MessageReceiverReplyHandlerCallbackContext instance must * be deleted or it will result in a memory leak. */ MessageReceiverReplyHandlerCallbackContext* in = (MessageReceiverReplyHandlerCallbackContext*)context; (in->replyhandler_ptr)((alljoyn_message) & message, in->context); in->replyhandler_ptr = NULL; delete in; } }; } #endif alljoyn-15.04b/alljoyn_c/src/MsgArg.cc000066400000000000000000000571451255700255500176070ustar00rootroot00000000000000/** * @file * * This file implements the MsgArg class */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #include #include #include "MsgArgC.h" #include #define QCC_MODULE "ALLJOYN_C" struct _alljoyn_msgarg_handle { /* Empty by design, this is just to allow the type restrictions to save coders from themselves */ }; alljoyn_msgarg AJ_CALL alljoyn_msgarg_create() { QCC_DbgTrace(("%s", __FUNCTION__)); ajn::MsgArgC* arg = new ajn::MsgArgC[1]; return (alljoyn_msgarg)arg; } alljoyn_msgarg AJ_CALL alljoyn_msgarg_create_and_set(const char* signature, ...) { QCC_DbgTrace(("%s", __FUNCTION__)); ajn::MsgArgC* arg = new ajn::MsgArgC[1]; arg->typeId = ajn::ALLJOYN_INVALID; va_list argp; va_start(argp, signature); QStatus status = ER_OK; ((ajn::MsgArgC*)arg)->Clear(); size_t sigLen = (signature ? strlen(signature) : 0); if ((sigLen < 1) || (sigLen > 255)) { status = ER_BUS_BAD_SIGNATURE; } else { status = ((ajn::MsgArgC*)arg)->VBuildArgsC(signature, sigLen, ((ajn::MsgArgC*)arg), 1, &argp); if ((status == ER_OK) && (*signature != 0)) { status = ER_BUS_NOT_A_COMPLETE_TYPE; } } va_end(argp); return (alljoyn_msgarg)arg; } void AJ_CALL alljoyn_msgarg_destroy(alljoyn_msgarg arg) { QCC_DbgTrace(("%s", __FUNCTION__)); if (arg != NULL) { delete [] (ajn::MsgArgC*)arg; } } alljoyn_msgarg AJ_CALL alljoyn_msgarg_array_create(size_t size) { QCC_DbgTrace(("%s", __FUNCTION__)); ajn::MsgArgC* args = new ajn::MsgArgC[size]; for (size_t i = 0; i < size; i++) { args[i].Clear(); } return (alljoyn_msgarg)args; } alljoyn_msgarg AJ_CALL alljoyn_msgarg_array_element(alljoyn_msgarg arg, size_t index) { QCC_DbgTrace(("%s", __FUNCTION__)); if (!arg) { return NULL; } ajn::MsgArgC* array_arg = (ajn::MsgArgC*)arg; return (alljoyn_msgarg)(&array_arg[index]); } QStatus AJ_CALL alljoyn_msgarg_set(alljoyn_msgarg arg, const char* signature, ...) { QCC_DbgTrace(("%s", __FUNCTION__)); if (!arg) { return ER_BAD_ARG_1; } va_list argp; va_start(argp, signature); QStatus status = ER_OK; ((ajn::MsgArgC*)arg)->Clear(); size_t sigLen = (signature ? strlen(signature) : 0); if ((sigLen < 1) || (sigLen > 255)) { status = ER_BUS_BAD_SIGNATURE; } else { status = ((ajn::MsgArgC*)arg)->VBuildArgsC(signature, sigLen, ((ajn::MsgArgC*)arg), 1, &argp); if ((status == ER_OK) && (*signature != 0)) { status = ER_BUS_NOT_A_COMPLETE_TYPE; } } va_end(argp); return status; } QStatus AJ_CALL alljoyn_msgarg_get(alljoyn_msgarg arg, const char* signature, ...) { QCC_DbgTrace(("%s", __FUNCTION__)); if (!arg) { return ER_BAD_ARG_1; } size_t sigLen = (signature ? strlen(signature) : 0); if (sigLen == 0) { return ER_BAD_ARG_2; } va_list argp; va_start(argp, signature); QStatus status = ((ajn::MsgArgC*)arg)->VParseArgsC(signature, sigLen, ((ajn::MsgArgC*)arg), 1, &argp); va_end(argp); return status; } alljoyn_msgarg AJ_CALL alljoyn_msgarg_copy(const alljoyn_msgarg source) { QCC_DbgTrace(("%s", __FUNCTION__)); if (!source) { return NULL; } ajn::MsgArgC* ret = new ajn::MsgArgC[1]; *ret = *(ajn::MsgArgC*)source; return (alljoyn_msgarg) ret; } void AJ_CALL alljoyn_msgarg_clone(alljoyn_msgarg destination, const alljoyn_msgarg source) { QCC_DbgTrace(("%s", __FUNCTION__)); (*(ajn::MsgArgC*)destination) = *(ajn::MsgArgC*)source; } QCC_BOOL AJ_CALL alljoyn_msgarg_equal(alljoyn_msgarg lhv, alljoyn_msgarg rhv) { QCC_DbgTrace(("%s", __FUNCTION__)); if (!lhv || !rhv) { return QCC_FALSE; } return (*(ajn::MsgArgC*)lhv) == (*(ajn::MsgArgC*)rhv); } QStatus AJ_CALL alljoyn_msgarg_array_set(alljoyn_msgarg args, size_t* numArgs, const char* signature, ...) { QCC_DbgTrace(("%s", __FUNCTION__)); if (!args) { return ER_BAD_ARG_1; } va_list argp; va_start(argp, signature); QStatus status = ((ajn::MsgArgC*)args)->MsgArgUtilsSetVC(((ajn::MsgArgC*)args), *numArgs, signature, &argp); va_end(argp); return status; } QStatus AJ_CALL alljoyn_msgarg_array_get(const alljoyn_msgarg args, size_t numArgs, const char* signature, ...) { QCC_DbgTrace(("%s", __FUNCTION__)); if (!args) { return ER_BAD_ARG_1; } if (!numArgs) { return ER_BAD_ARG_2; } size_t sigLen = (signature ? strlen(signature) : 0); if (sigLen == 0) { return ER_BAD_ARG_3; } va_list argp; va_start(argp, signature); QStatus status = ((ajn::MsgArgC*)args)->VParseArgsC(signature, sigLen, ((ajn::MsgArgC*)args), numArgs, &argp); va_end(argp); return status; } size_t AJ_CALL alljoyn_msgarg_tostring(alljoyn_msgarg arg, char* str, size_t buf, size_t indent) { QCC_DbgTrace(("%s", __FUNCTION__)); if (arg == nullptr) { return (size_t)0; } qcc::String s = ((ajn::MsgArgC*)arg)->ToString(indent); /* * it is ok to send in NULL for str when the user is only interested in the * size of the resulting string. */ if ((str != nullptr) && (buf >= 1)) { strncpy(str, s.c_str(), buf); str[buf - 1] = '\0'; //prevent sting not being null terminated. } return s.size() + 1; } size_t AJ_CALL alljoyn_msgarg_array_tostring(const alljoyn_msgarg args, size_t numArgs, char* str, size_t buf, size_t indent) { QCC_DbgTrace(("%s", __FUNCTION__)); if (args == nullptr) { return (size_t)0; } qcc::String s = ((ajn::MsgArgC*)args)->ToString((ajn::MsgArgC*)args, numArgs, indent); /* * it is ok to send in NULL for str when the user is only interested in the * size of the resulting string. */ if ((str != nullptr) && (buf >= 1)) { strncpy(str, s.c_str(), buf); str[buf - 1] = '\0'; } return s.size() + 1; } size_t AJ_CALL alljoyn_msgarg_signature(alljoyn_msgarg arg, char* str, size_t buf) { QCC_DbgTrace(("%s", __FUNCTION__)); if (arg == nullptr) { return (size_t)0; } qcc::String s = ((ajn::MsgArgC*)arg)->Signature(); /* * it is ok to send in NULL for str when the user is only interested in the * size of the resulting string. */ if ((str != nullptr) && (buf >= 1)) { strncpy(str, s.c_str(), buf); str[buf - 1] = '\0'; //prevent sting not being null terminated. } return s.size() + 1; } size_t AJ_CALL alljoyn_msgarg_array_signature(alljoyn_msgarg values, size_t numValues, char* str, size_t buf) { QCC_DbgTrace(("%s", __FUNCTION__)); if (values == nullptr) { return (size_t)0; } qcc::String s = ((ajn::MsgArgC*)values)->Signature((ajn::MsgArgC*)values, numValues).c_str(); /* * it is ok to send in NULL for str when the user is only interested in the * size of the resulting string. */ if ((str != nullptr) && (buf >= 1)) { strncpy(str, s.c_str(), buf); str[buf - 1] = '\0'; } return s.size() + 1; } QCC_BOOL AJ_CALL alljoyn_msgarg_hassignature(alljoyn_msgarg arg, const char* signature) { QCC_DbgTrace(("%s", __FUNCTION__)); if (!arg) { return QCC_FALSE; } return ((ajn::MsgArgC*)arg)->HasSignature(signature); } QStatus AJ_CALL alljoyn_msgarg_getdictelement(alljoyn_msgarg arg, const char* elemSig, ...) { QCC_DbgTrace(("%s", __FUNCTION__)); if (!arg) { return ER_BAD_ARG_1; } size_t sigLen = (elemSig ? strlen(elemSig) : 0); if (sigLen < 4) { return ER_BAD_ARG_2; } /* Check this MsgArg is an array of dictionary entries */ if ((((ajn::MsgArgC*)arg)->typeId != ajn::ALLJOYN_ARRAY || ((ajn::MsgArgC*)arg)->v_array.GetElemSig()[0] != '{')) { return ER_BUS_NOT_A_DICTIONARY; } /* Check key has right type */ if (((ajn::MsgArgC*)arg)->v_array.GetElemSig()[1] != elemSig[1]) { return ER_BUS_SIGNATURE_MISMATCH; } va_list argp; va_start(argp, elemSig); /* Get the key as a MsgArg */ ajn::MsgArgC key; size_t numArgs; ++elemSig; QStatus status = ((ajn::MsgArgC*)arg)->VBuildArgsC(elemSig, 1, &key, 1, &argp, &numArgs); if (status == ER_OK) { status = ER_BUS_ELEMENT_NOT_FOUND; /* Linear search to match the key */ const ajn::MsgArg* entry = ((ajn::MsgArgC*)arg)->v_array.GetElements(); for (size_t i = 0; i < ((ajn::MsgArgC*)arg)->v_array.GetNumElements(); ++i, ++entry) { if (*entry->v_dictEntry.key == key) { status = ER_OK; break; } } if (status == ER_OK) { status = ((ajn::MsgArgC*)arg)->VParseArgsC(elemSig, sigLen - 3, entry->v_dictEntry.val, 1, &argp); } } va_end(argp); return status; } void AJ_CALL alljoyn_msgarg_clear(alljoyn_msgarg arg) { QCC_DbgTrace(("%s", __FUNCTION__)); if (!arg) { return; } ((ajn::MsgArgC*)arg)->Clear(); } alljoyn_typeid AJ_CALL alljoyn_msgarg_gettype(alljoyn_msgarg arg) { QCC_DbgTrace(("%s", __FUNCTION__)); if (!arg) { return ALLJOYN_INVALID; } return (alljoyn_typeid)((ajn::MsgArgC*)arg)->typeId; } void AJ_CALL alljoyn_msgarg_stabilize(alljoyn_msgarg arg) { QCC_DbgTrace(("%s", __FUNCTION__)); if (!arg) { return; } ((ajn::MsgArgC*)arg)->Stabilize(); } /******************************************************************************* * This set of functions were originally designed for the alljoyn_unity bindings * however they did not not properly map with the C++ MsgArg Class. * * No Functions below this point should be used by any code except for the * AllJoyn Unity Extension. The functions could be changed at any time. ******************************************************************************/ QStatus AJ_CALL alljoyn_msgarg_array_set_offset(alljoyn_msgarg args, size_t argOffset, size_t* numArgs, const char* signature, ...) { QCC_DbgTrace(("%s", __FUNCTION__)); va_list argp; va_start(argp, signature); QStatus status = ((ajn::MsgArgC*)args)->MsgArgUtilsSetVC(((ajn::MsgArgC*)args) + argOffset, *numArgs, signature, &argp); va_end(argp); return status; } QStatus AJ_CALL alljoyn_msgarg_set_and_stabilize(alljoyn_msgarg arg, const char* signature, ...) { QCC_DbgTrace(("%s", __FUNCTION__)); if (!arg) { return ER_BAD_ARG_1; } va_list argp; va_start(argp, signature); QStatus status = ER_OK; ((ajn::MsgArgC*)arg)->Clear(); size_t sigLen = (signature ? strlen(signature) : 0); if ((sigLen < 1) || (sigLen > 255)) { status = ER_BUS_BAD_SIGNATURE; } else { status = ((ajn::MsgArgC*)arg)->VBuildArgsC(signature, sigLen, ((ajn::MsgArgC*)arg), 1, &argp); if ((status == ER_OK) && (*signature != 0)) { status = ER_BUS_NOT_A_COMPLETE_TYPE; } } va_end(argp); ((ajn::MsgArgC*)arg)->Stabilize(); return status; } QStatus AJ_CALL alljoyn_msgarg_set_uint8(alljoyn_msgarg arg, uint8_t y) { QCC_DbgTrace(("%s", __FUNCTION__)); return alljoyn_msgarg_set(arg, "y", y); } QStatus AJ_CALL alljoyn_msgarg_set_bool(alljoyn_msgarg arg, QCC_BOOL b) { QCC_DbgTrace(("%s", __FUNCTION__)); return alljoyn_msgarg_set(arg, "b", b); } QStatus AJ_CALL alljoyn_msgarg_set_int16(alljoyn_msgarg arg, int16_t n) { QCC_DbgTrace(("%s", __FUNCTION__)); return alljoyn_msgarg_set(arg, "n", n); } QStatus AJ_CALL alljoyn_msgarg_set_uint16(alljoyn_msgarg arg, uint16_t q) { QCC_DbgTrace(("%s", __FUNCTION__)); return alljoyn_msgarg_set(arg, "q", q); } QStatus AJ_CALL alljoyn_msgarg_set_int32(alljoyn_msgarg arg, int32_t i) { QCC_DbgTrace(("%s", __FUNCTION__)); return alljoyn_msgarg_set(arg, "i", i); } QStatus AJ_CALL alljoyn_msgarg_set_uint32(alljoyn_msgarg arg, uint32_t u) { QCC_DbgTrace(("%s", __FUNCTION__)); return alljoyn_msgarg_set(arg, "u", u); } QStatus AJ_CALL alljoyn_msgarg_set_int64(alljoyn_msgarg arg, int64_t x) { QCC_DbgTrace(("%s", __FUNCTION__)); return alljoyn_msgarg_set(arg, "x", x); } QStatus AJ_CALL alljoyn_msgarg_set_uint64(alljoyn_msgarg arg, uint64_t t) { QCC_DbgTrace(("%s", __FUNCTION__)); return alljoyn_msgarg_set(arg, "t", t); } QStatus AJ_CALL alljoyn_msgarg_set_double(alljoyn_msgarg arg, double d) { QCC_DbgTrace(("%s", __FUNCTION__)); return alljoyn_msgarg_set(arg, "d", d); } QStatus AJ_CALL alljoyn_msgarg_set_string(alljoyn_msgarg arg, const char* s) { QCC_DbgTrace(("%s", __FUNCTION__)); return alljoyn_msgarg_set(arg, "s", s); } QStatus AJ_CALL alljoyn_msgarg_set_objectpath(alljoyn_msgarg arg, const char* o) { QCC_DbgTrace(("%s", __FUNCTION__)); return alljoyn_msgarg_set(arg, "o", o); } QStatus AJ_CALL alljoyn_msgarg_set_signature(alljoyn_msgarg arg, const char* g) { QCC_DbgTrace(("%s", __FUNCTION__)); return alljoyn_msgarg_set(arg, "g", g); } QStatus AJ_CALL alljoyn_msgarg_get_uint8(const alljoyn_msgarg arg, uint8_t* y) { QCC_DbgTrace(("%s", __FUNCTION__)); return alljoyn_msgarg_get(arg, "y", y); } QStatus AJ_CALL alljoyn_msgarg_get_bool(const alljoyn_msgarg arg, QCC_BOOL* b) { QCC_DbgTrace(("%s", __FUNCTION__)); bool _b = false; QStatus status = alljoyn_msgarg_get(arg, "b", &_b); if (status == ER_OK) { *b = (_b == true) ? QCC_TRUE : QCC_FALSE; } return status; } QStatus AJ_CALL alljoyn_msgarg_get_int16(const alljoyn_msgarg arg, int16_t* n) { QCC_DbgTrace(("%s", __FUNCTION__)); return alljoyn_msgarg_get(arg, "n", n); } QStatus AJ_CALL alljoyn_msgarg_get_uint16(const alljoyn_msgarg arg, uint16_t* q) { QCC_DbgTrace(("%s", __FUNCTION__)); return alljoyn_msgarg_get(arg, "q", q); } QStatus AJ_CALL alljoyn_msgarg_get_int32(const alljoyn_msgarg arg, int32_t* i) { QCC_DbgTrace(("%s", __FUNCTION__)); return alljoyn_msgarg_get(arg, "i", i); } QStatus AJ_CALL alljoyn_msgarg_get_uint32(const alljoyn_msgarg arg, uint32_t* u) { QCC_DbgTrace(("%s", __FUNCTION__)); return alljoyn_msgarg_get(arg, "u", u); } QStatus AJ_CALL alljoyn_msgarg_get_int64(const alljoyn_msgarg arg, int64_t* x) { QCC_DbgTrace(("%s", __FUNCTION__)); return alljoyn_msgarg_get(arg, "x", x); } QStatus AJ_CALL alljoyn_msgarg_get_uint64(const alljoyn_msgarg arg, uint64_t* t) { QCC_DbgTrace(("%s", __FUNCTION__)); return alljoyn_msgarg_get(arg, "t", t); } QStatus AJ_CALL alljoyn_msgarg_get_double(const alljoyn_msgarg arg, double* d) { QCC_DbgTrace(("%s", __FUNCTION__)); return alljoyn_msgarg_get(arg, "d", d); } QStatus AJ_CALL alljoyn_msgarg_get_string(const alljoyn_msgarg arg, char** s) { QCC_DbgTrace(("%s", __FUNCTION__)); return alljoyn_msgarg_get(arg, "s", s); } QStatus AJ_CALL alljoyn_msgarg_get_objectpath(const alljoyn_msgarg arg, char** o) { QCC_DbgTrace(("%s", __FUNCTION__)); return alljoyn_msgarg_get(arg, "o", o); } QStatus AJ_CALL alljoyn_msgarg_get_signature(const alljoyn_msgarg arg, char** g) { QCC_DbgTrace(("%s", __FUNCTION__)); return alljoyn_msgarg_get(arg, "g", g); } QStatus AJ_CALL alljoyn_msgarg_get_variant(const alljoyn_msgarg arg, alljoyn_msgarg v) { QCC_DbgTrace(("%s", __FUNCTION__)); return alljoyn_msgarg_get(arg, "v", v); } /* * MsgArg set function for arrays of each basic data type */ QStatus AJ_CALL alljoyn_msgarg_set_uint8_array(alljoyn_msgarg arg, size_t length, uint8_t* ay) { QCC_DbgTrace(("%s", __FUNCTION__)); return alljoyn_msgarg_set(arg, "ay", length, ay); } QStatus AJ_CALL alljoyn_msgarg_set_bool_array(alljoyn_msgarg arg, size_t length, QCC_BOOL* ab) { QCC_DbgTrace(("%s", __FUNCTION__)); return alljoyn_msgarg_set(arg, "ab", length, ab); } QStatus AJ_CALL alljoyn_msgarg_set_int16_array(alljoyn_msgarg arg, size_t length, int16_t* an) { QCC_DbgTrace(("%s", __FUNCTION__)); return alljoyn_msgarg_set(arg, "an", length, an); } QStatus AJ_CALL alljoyn_msgarg_set_uint16_array(alljoyn_msgarg arg, size_t length, uint16_t* aq) { QCC_DbgTrace(("%s", __FUNCTION__)); return alljoyn_msgarg_set(arg, "aq", length, aq); } QStatus AJ_CALL alljoyn_msgarg_set_int32_array(const alljoyn_msgarg arg, size_t length, int32_t* ai) { QCC_DbgTrace(("%s", __FUNCTION__)); return alljoyn_msgarg_set(arg, "ai", length, ai); } QStatus AJ_CALL alljoyn_msgarg_set_uint32_array(alljoyn_msgarg arg, size_t length, uint32_t* au) { QCC_DbgTrace(("%s", __FUNCTION__)); return alljoyn_msgarg_set(arg, "au", length, au); } QStatus AJ_CALL alljoyn_msgarg_set_int64_array(alljoyn_msgarg arg, size_t length, int64_t* ax) { QCC_DbgTrace(("%s", __FUNCTION__)); return alljoyn_msgarg_set(arg, "ax", length, ax); } QStatus AJ_CALL alljoyn_msgarg_set_uint64_array(alljoyn_msgarg arg, size_t length, uint64_t* at) { QCC_DbgTrace(("%s", __FUNCTION__)); return alljoyn_msgarg_set(arg, "at", length, at); } QStatus AJ_CALL alljoyn_msgarg_set_double_array(alljoyn_msgarg arg, size_t length, double* ad) { QCC_DbgTrace(("%s", __FUNCTION__)); return alljoyn_msgarg_set(arg, "ad", length, ad); } QStatus AJ_CALL alljoyn_msgarg_set_string_array(alljoyn_msgarg arg, size_t length, const char** as) { QCC_DbgTrace(("%s", __FUNCTION__)); QStatus status = alljoyn_msgarg_set(arg, "as", length, as); alljoyn_msgarg_stabilize(arg); return status; } QStatus AJ_CALL alljoyn_msgarg_set_objectpath_array(alljoyn_msgarg arg, size_t length, const char** ao) { QCC_DbgTrace(("%s", __FUNCTION__)); QStatus status = alljoyn_msgarg_set(arg, "ao", length, ao); alljoyn_msgarg_stabilize(arg); return status; } QStatus AJ_CALL alljoyn_msgarg_set_signature_array(alljoyn_msgarg arg, size_t length, const char** ag) { QCC_DbgTrace(("%s", __FUNCTION__)); QStatus status = alljoyn_msgarg_set(arg, "ag", length, ag); alljoyn_msgarg_stabilize(arg); return status; } /* * MsgArg get funtion for arrays of each basic data type */ QStatus AJ_CALL alljoyn_msgarg_get_uint8_array(const alljoyn_msgarg arg, size_t* length, uint8_t* ay) { QCC_DbgTrace(("%s", __FUNCTION__)); return alljoyn_msgarg_get(arg, "ay", length, ay); } QStatus AJ_CALL alljoyn_msgarg_get_bool_array(const alljoyn_msgarg arg, size_t* length, QCC_BOOL* ab) { QCC_DbgTrace(("%s", __FUNCTION__)); QStatus status = alljoyn_msgarg_get(arg, "ab", length, ab); return status; } QStatus AJ_CALL alljoyn_msgarg_get_int16_array(const alljoyn_msgarg arg, size_t* length, int16_t* an) { QCC_DbgTrace(("%s", __FUNCTION__)); return alljoyn_msgarg_get(arg, "an", length, an); } QStatus AJ_CALL alljoyn_msgarg_get_uint16_array(const alljoyn_msgarg arg, size_t* length, uint16_t* aq) { QCC_DbgTrace(("%s", __FUNCTION__)); return alljoyn_msgarg_get(arg, "aq", length, aq); } QStatus AJ_CALL alljoyn_msgarg_get_int32_array(const alljoyn_msgarg arg, size_t* length, int32_t* ai) { QCC_DbgTrace(("%s", __FUNCTION__)); return alljoyn_msgarg_get(arg, "ai", length, ai); } QStatus AJ_CALL alljoyn_msgarg_get_uint32_array(const alljoyn_msgarg arg, size_t* length, uint32_t* au) { QCC_DbgTrace(("%s", __FUNCTION__)); return alljoyn_msgarg_get(arg, "au", length, au); } QStatus AJ_CALL alljoyn_msgarg_get_int64_array(const alljoyn_msgarg arg, size_t* length, int64_t* ax) { QCC_DbgTrace(("%s", __FUNCTION__)); return alljoyn_msgarg_get(arg, "ax", length, ax); } QStatus AJ_CALL alljoyn_msgarg_get_uint64_array(const alljoyn_msgarg arg, size_t* length, uint64_t* at) { QCC_DbgTrace(("%s", __FUNCTION__)); return alljoyn_msgarg_get(arg, "at", length, at); } QStatus AJ_CALL alljoyn_msgarg_get_double_array(const alljoyn_msgarg arg, size_t* length, double* ad) { QCC_DbgTrace(("%s", __FUNCTION__)); return alljoyn_msgarg_get(arg, "ad", length, ad); } QStatus AJ_CALL alljoyn_msgarg_get_variant_array(const alljoyn_msgarg arg, const char* signature, size_t* length, alljoyn_msgarg* av) { QCC_DbgTrace(("%s", __FUNCTION__)); return alljoyn_msgarg_get(arg, signature, length, av); } size_t AJ_CALL alljoyn_msgarg_get_array_numberofelements(const alljoyn_msgarg arg) { QCC_DbgTrace(("%s", __FUNCTION__)); assert(ALLJOYN_ARRAY == (alljoyn_typeid)((ajn::MsgArgC*)arg)->typeId); return ((ajn::MsgArgC*)arg)->v_array.GetNumElements(); } void AJ_CALL alljoyn_msgarg_get_array_element(const alljoyn_msgarg arg, size_t index, alljoyn_msgarg* element) { QCC_DbgTrace(("%s", __FUNCTION__)); assert(ALLJOYN_ARRAY == (alljoyn_typeid)((ajn::MsgArgC*)arg)->typeId); assert(index < ((ajn::MsgArgC*)arg)->v_array.GetNumElements()); *element = (alljoyn_msgarg) & (((ajn::MsgArgC*)arg)->v_array.GetElements()[index]); } const char* AJ_CALL alljoyn_msgarg_get_array_elementsignature(const alljoyn_msgarg arg, size_t index) { QCC_UNUSED(index); QCC_DbgTrace(("%s", __FUNCTION__)); assert(ALLJOYN_ARRAY == (alljoyn_typeid)((ajn::MsgArgC*)arg)->typeId); return ((ajn::MsgArgC*)arg)->v_array.GetElemSig(); } alljoyn_msgarg AJ_CALL alljoyn_msgarg_getkey(alljoyn_msgarg arg) { QCC_DbgTrace(("%s", __FUNCTION__)); assert(ALLJOYN_DICT_ENTRY == (alljoyn_typeid)((ajn::MsgArgC*)arg)->typeId); return (alljoyn_msgarg)((ajn::MsgArgC*)arg)->v_dictEntry.key; } alljoyn_msgarg AJ_CALL alljoyn_msgarg_getvalue(alljoyn_msgarg arg) { QCC_DbgTrace(("%s", __FUNCTION__)); switch ((alljoyn_typeid)((ajn::MsgArgC*)arg)->typeId) { case ALLJOYN_VARIANT: return (alljoyn_msgarg)((ajn::MsgArgC*)arg)->v_variant.val; case ALLJOYN_DICT_ENTRY: return (alljoyn_msgarg)((ajn::MsgArgC*)arg)->v_dictEntry.val; default: assert(0); return NULL; } } QStatus AJ_CALL alljoyn_msgarg_setdictentry(alljoyn_msgarg arg, alljoyn_msgarg key, alljoyn_msgarg value) { QCC_DbgTrace(("%s", __FUNCTION__)); ((ajn::MsgArgC*)arg)->v_dictEntry.key = ((ajn::MsgArgC*)key); ((ajn::MsgArgC*)arg)->v_dictEntry.val = ((ajn::MsgArgC*)value); ((ajn::MsgArgC*)arg)->typeId = (ajn::AllJoynTypeId)ALLJOYN_DICT_ENTRY; ((ajn::MsgArgC*)arg)->Stabilize(); return ER_OK; } QStatus AJ_CALL alljoyn_msgarg_setstruct(alljoyn_msgarg arg, alljoyn_msgarg struct_members, size_t num_members) { QCC_DbgTrace(("%s", __FUNCTION__)); ((ajn::MsgArgC*)arg)->v_struct.numMembers = num_members; ((ajn::MsgArgC*)arg)->v_struct.members = (ajn::MsgArgC*)struct_members; ((ajn::MsgArgC*)arg)->typeId = (ajn::AllJoynTypeId)ALLJOYN_STRUCT; ((ajn::MsgArgC*)arg)->Stabilize(); return ER_OK; } size_t AJ_CALL alljoyn_msgarg_getnummembers(alljoyn_msgarg arg) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ajn::MsgArgC*)arg)->v_struct.numMembers; } alljoyn_msgarg AJ_CALL alljoyn_msgarg_getmember(alljoyn_msgarg arg, size_t index) { QCC_DbgTrace(("%s", __FUNCTION__)); if (index >= ((ajn::MsgArgC*)arg)->v_struct.numMembers) { return NULL; } return (alljoyn_msgarg)(&((ajn::MsgArgC*)arg)->v_struct.members[index]); } alljoyn-15.04b/alljoyn_c/src/MsgArgC.cc000066400000000000000000000035321255700255500177010ustar00rootroot00000000000000/** * @file * * This file implements the BusAttachmentC class. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include "MsgArgC.h" #include #include #include #define QCC_MODULE "ALLJOYN_C" namespace ajn { QStatus MsgArgC::MsgArgUtilsSetVC(MsgArg* args, size_t& numArgs, const char* signature, va_list* argp) { QCC_DbgTrace(("%s", __FUNCTION__)); return MsgArgUtils::SetV(args, numArgs, signature, argp); } QStatus MsgArgC::VBuildArgsC(const char*& signature, size_t sigLen, MsgArg* arg, size_t maxArgs, va_list* argp, size_t* count) { QCC_DbgTrace(("%s", __FUNCTION__)); return VBuildArgs(signature, sigLen, arg, maxArgs, argp, count); } QStatus MsgArgC::VParseArgsC(const char*& signature, size_t sigLen, const MsgArg* argList, size_t numArgs, va_list* argp) { QCC_DbgTrace(("%s", __FUNCTION__)); return VParseArgs(signature, sigLen, argList, numArgs, argp); } } alljoyn-15.04b/alljoyn_c/src/MsgArgC.h000066400000000000000000000041621255700255500175430ustar00rootroot00000000000000/** * @file * * This file implements the BusAttachmentC class. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_C_MSGARGC_H #define _ALLJOYN_C_MSGARGC_H #include #include #include #include namespace ajn { /** * MsgArgC is used to map 'C' code to the 'C++' MsgArg code where additional handling * is needed to convert from a 'C' type to a 'C++' type. */ class MsgArgC : public MsgArg { friend class MsgArgUtils; public: /** * constructor */ MsgArgC() : MsgArg() { } /** * copy constructor */ MsgArgC(const MsgArgC& other) : MsgArg(static_cast(other)) { } /** * Constructor * * @param typeId The type for the MsgArg */ MsgArgC(AllJoynTypeId typeId) : MsgArg(typeId) { } static QStatus MsgArgUtilsSetVC(MsgArg* args, size_t& numArgs, const char* signature, va_list* argp); static QStatus VBuildArgsC(const char*& signature, size_t sigLen, MsgArg* arg, size_t maxArgs, va_list* argp, size_t* count = NULL); static QStatus VParseArgsC(const char*& signature, size_t sigLen, const MsgArg* argList, size_t numArgs, va_list* argp); }; } #endif alljoyn-15.04b/alljoyn_c/src/Observer.cc000066400000000000000000000420171255700255500202060ustar00rootroot00000000000000/** * @file * An Observer takes care of discovery, session management and ProxyBusObject * creation for bus objects that implement a specific set of interfaces. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include "DeferredCallback.h" #include "CoreObserver.h" #include "BusInternal.h" #include #define QCC_MODULE "ALLJOYN_C" /* {{{ alljoyn_proxybusobject_ref */ struct _alljoyn_proxybusobject_ref_handle { alljoyn_proxybusobject proxy; int refcount; qcc::Mutex lock; }; alljoyn_proxybusobject_ref AJ_CALL alljoyn_proxybusobject_ref_create(alljoyn_proxybusobject proxy) { alljoyn_proxybusobject_ref ref = new _alljoyn_proxybusobject_ref_handle; ref->proxy = proxy; ref->refcount = 1; return ref; } alljoyn_proxybusobject AJ_CALL alljoyn_proxybusobject_ref_get(alljoyn_proxybusobject_ref ref) { return ref->proxy; } void AJ_CALL alljoyn_proxybusobject_ref_incref(alljoyn_proxybusobject_ref ref) { ref->lock.Lock(MUTEX_CONTEXT); ++ref->refcount; ref->lock.Unlock(MUTEX_CONTEXT); } void AJ_CALL alljoyn_proxybusobject_ref_decref(alljoyn_proxybusobject_ref ref) { bool remove = false; ref->lock.Lock(MUTEX_CONTEXT); if (--ref->refcount == 0) { remove = true; } ref->lock.Unlock(MUTEX_CONTEXT); if (remove) { alljoyn_proxybusobject_destroy(ref->proxy); delete ref; } } /* }}} */ /* {{{ alljoyn_observerlistener */ struct _alljoyn_observerlistener_handle { const void* ctx; alljoyn_observerlistener_callback callbacks; }; alljoyn_observerlistener AJ_CALL alljoyn_observerlistener_create(const alljoyn_observerlistener_callback* callback, const void* context) { alljoyn_observerlistener listener = new _alljoyn_observerlistener_handle; listener->ctx = context; listener->callbacks = *callback; return listener; } void AJ_CALL alljoyn_observerlistener_destroy(alljoyn_observerlistener listener) { delete listener; } /* }}} */ namespace ajn { class ObserverC : public CoreObserver { private: /* Private assigment operator - does nothing */ ObserverC operator=(const ObserverC&); BusAttachment& bus; alljoyn_busattachment cbus; /* proxy object bookkeeping */ typedef std::map ObjectMap; ObjectMap proxies; qcc::Mutex proxiesLock; /* listener bookkeeping */ struct WrappedListener { /* WrappedListener exists to keep track of whether a given listener * is already enabled. triggerOnExisting listeners start off as * disabled, until the ObserverManager has the chance to fire the * initial callbacks (for "existing" objects) from the work queue. */ alljoyn_observerlistener listener; bool enabled; WrappedListener(alljoyn_observerlistener listener, bool enabled) : listener(listener), enabled(enabled) { } }; typedef qcc::ManagedObj ProtectedObserverListener; typedef std::set ObserverListenerSet; ObserverListenerSet listeners; qcc::Mutex listenersLock; public: ObserverC(alljoyn_busattachment cbus, InterfaceSet mandatory); virtual ~ObserverC(); /* implementation of public Observer functionality */ void RegisterListener(alljoyn_observerlistener listener, bool triggerOnExisting); void UnregisterListener(alljoyn_observerlistener listener); void UnregisterAllListeners(); void Detach(); alljoyn_proxybusobject_ref Get(const char* busname, const char* path); alljoyn_proxybusobject_ref GetFirst(); alljoyn_proxybusobject_ref GetNext(alljoyn_proxybusobject_ref prevref); /* interface towards ObserverManager */ void ObjectDiscovered(const ObjectId& oid, const std::set& interfaces, SessionId sessionid); void ObjectLost(const ObjectId& oid); /** * Enable all disabled listeners for this observer. * * Called from the ObserverManager work queue to make sure the * initial callbacks of triggerOnExisting listeners are called * from the local endpoint dispatcher threads. */ void EnablePendingListeners(); }; ObserverC::ObserverC(alljoyn_busattachment _cbus, InterfaceSet mandatory) : CoreObserver(mandatory), bus(*(BusAttachment*)_cbus), cbus(_cbus) { ObserverManager& obsmgr = bus.GetInternal().GetObserverManager(); obsmgr.RegisterObserver(this); } ObserverC::~ObserverC() { } void ObserverC::Detach() { UnregisterAllListeners(); ObserverManager& obsmgr = bus.GetInternal().GetObserverManager(); obsmgr.UnregisterObserver(this); } void ObserverC::RegisterListener(alljoyn_observerlistener listener, bool triggerOnExisting) { WrappedListener* wListener = new WrappedListener(listener, !triggerOnExisting); ProtectedObserverListener protectedListener(wListener); listenersLock.Lock(MUTEX_CONTEXT); listeners.insert(protectedListener); listenersLock.Unlock(MUTEX_CONTEXT); if (triggerOnExisting) { /* We don't want to do the callbacks from this thread, as it's * most probably an application thread. Let the ObserverManager * do this for us from the dispatcher thread. To avoid confusion, * we leave this listener disabled so that other announcements on * the work queue don't get reported out of order. */ ObserverManager& obsmgr = bus.GetInternal().GetObserverManager(); obsmgr.EnablePendingListeners(this); } } void ObserverC::UnregisterListener(alljoyn_observerlistener listener) { listenersLock.Lock(MUTEX_CONTEXT); /* Look for listener on ListenerSet */ ObserverListenerSet::iterator it; for (it = listeners.begin(); it != listeners.end(); ++it) { if ((**it)->listener == listener) { break; } } /* Wait for all refs to this ProtectedObserverListener to exit */ while ((it != listeners.end()) && (it->GetRefCount() > 1)) { ProtectedObserverListener l = *it; listenersLock.Unlock(MUTEX_CONTEXT); qcc::Sleep(5); listenersLock.Lock(MUTEX_CONTEXT); it = listeners.find(l); } /* Delete the listeners entry */ if (it != listeners.end()) { ProtectedObserverListener l = *it; listeners.erase(it); delete (*l); } listenersLock.Unlock(MUTEX_CONTEXT); } void ObserverC::UnregisterAllListeners() { listenersLock.Lock(MUTEX_CONTEXT); /* Look for listener on ListenerSet */ ObserverListenerSet::iterator it = listeners.begin(); while (it != listeners.end()) { /* Wait for all refs to ProtectedBusListener to exit */ while ((it != listeners.end()) && (it->GetRefCount() > 1)) { ProtectedObserverListener l = *it; listenersLock.Unlock(MUTEX_CONTEXT); qcc::Sleep(5); listenersLock.Lock(MUTEX_CONTEXT); it = listeners.find(l); } /* Delete the listeners entry */ if (it != listeners.end()) { ProtectedObserverListener l = *it; listeners.erase(it); } it = listeners.begin(); } listenersLock.Unlock(MUTEX_CONTEXT); } void ObserverC::EnablePendingListeners() { /* make a list of all pending listeners */ std::vector pendingListeners; listenersLock.Lock(MUTEX_CONTEXT); ObserverListenerSet::iterator lit; for (lit = listeners.begin(); lit != listeners.end(); ++lit) { ProtectedObserverListener pol = *lit; if ((*pol)->enabled == false) { pendingListeners.push_back(pol); } } listenersLock.Unlock(MUTEX_CONTEXT); /* for each pending listener, invoke object_discovered for all known proxies */ proxiesLock.Lock(MUTEX_CONTEXT); std::vector::iterator plit; for (plit = pendingListeners.begin(); plit != pendingListeners.end(); ++plit) { ProtectedObserverListener pol = *plit; (*pol)->enabled = true; alljoyn_observerlistener listener = (*pol)->listener; if (listener->callbacks.object_discovered == NULL) { continue; } ObjectMap::iterator it = proxies.begin(); while (it != proxies.end()) { ObjectId id = it->first; alljoyn_proxybusobject_ref proxyref = it->second; alljoyn_proxybusobject_ref_incref(proxyref); proxiesLock.Unlock(MUTEX_CONTEXT); listener->callbacks.object_discovered(listener->ctx, proxyref); proxiesLock.Lock(MUTEX_CONTEXT); alljoyn_proxybusobject_ref_decref(proxyref); it = proxies.upper_bound(id); } } proxiesLock.Unlock(MUTEX_CONTEXT); } alljoyn_proxybusobject_ref ObserverC::Get(const char* busname, const char* path) { ObjectId oid(busname, path); if (!oid.IsValid()) { return NULL; } alljoyn_proxybusobject_ref proxyref; proxiesLock.Lock(MUTEX_CONTEXT); ObjectMap::iterator it = proxies.find(oid); if (it != proxies.end()) { proxyref = it->second; alljoyn_proxybusobject_ref_incref(proxyref); } else { proxyref = NULL; } proxiesLock.Unlock(MUTEX_CONTEXT); return proxyref; } alljoyn_proxybusobject_ref ObserverC::GetFirst() { alljoyn_proxybusobject_ref proxyref = NULL; proxiesLock.Lock(MUTEX_CONTEXT); ObjectMap::iterator it = proxies.begin(); if (it != proxies.end()) { proxyref = it->second; alljoyn_proxybusobject_ref_incref(proxyref); } proxiesLock.Unlock(MUTEX_CONTEXT); return proxyref; } alljoyn_proxybusobject_ref ObserverC::GetNext(alljoyn_proxybusobject_ref prevref) { if (NULL == prevref) { return NULL; } ObjectId oid((ajn::ProxyBusObject*)alljoyn_proxybusobject_ref_get(prevref)); alljoyn_proxybusobject_ref_decref(prevref); if (!oid.IsValid()) { return NULL; // should never happen, actually... } alljoyn_proxybusobject_ref proxyref = NULL; proxiesLock.Lock(MUTEX_CONTEXT); ObjectMap::iterator it = proxies.upper_bound(oid); if (it != proxies.end()) { proxyref = it->second; alljoyn_proxybusobject_ref_incref(proxyref); } proxiesLock.Unlock(MUTEX_CONTEXT); return proxyref; } void ObserverC::ObjectDiscovered(const ObjectId& oid, const std::set& interfaces, SessionId sessionid) { /* create proxy object */ //TODO figure out what to do with secure bus objects const char* busname = oid.uniqueBusName.c_str(); const char* path = oid.objectPath.c_str(); QCC_DbgTrace(("ObjectDiscovered(%s:%s)", busname, path)); alljoyn_proxybusobject proxy = alljoyn_proxybusobject_create(cbus, busname, path, sessionid); InterfaceSet::iterator it; for (it = interfaces.begin(); it != interfaces.end(); ++it) { alljoyn_proxybusobject_addinterface_by_name(proxy, it->c_str()); } /* insert in proxy map */ alljoyn_proxybusobject_ref proxyref = alljoyn_proxybusobject_ref_create(proxy); proxiesLock.Lock(MUTEX_CONTEXT); proxies[oid] = proxyref; proxiesLock.Unlock(MUTEX_CONTEXT); /* alert listeners */ alljoyn_proxybusobject_ref_incref(proxyref); listenersLock.Lock(MUTEX_CONTEXT); ObserverListenerSet::iterator lit = listeners.begin(); while (lit != listeners.end()) { ProtectedObserverListener pol = *lit; if ((*pol)->enabled == false) { ++lit; continue; } alljoyn_observerlistener listener = (*pol)->listener; if (listener->callbacks.object_discovered == NULL) { ++lit; continue; } listenersLock.Unlock(MUTEX_CONTEXT); listener->callbacks.object_discovered(listener->ctx, proxyref); listenersLock.Lock(MUTEX_CONTEXT); lit = listeners.upper_bound(pol); } listenersLock.Unlock(MUTEX_CONTEXT); alljoyn_proxybusobject_ref_decref(proxyref); } void ObserverC::ObjectLost(const ObjectId& oid) { /* remove from proxy map */ bool found = false; alljoyn_proxybusobject_ref proxyref = NULL; proxiesLock.Lock(MUTEX_CONTEXT); ObjectMap::iterator it = proxies.find(oid); if (it != proxies.end()) { found = true; proxyref = it->second; proxies.erase(it); } proxiesLock.Unlock(MUTEX_CONTEXT); /* alert listeners */ if (found) { listenersLock.Lock(MUTEX_CONTEXT); ObserverListenerSet::iterator lit = listeners.begin(); while (lit != listeners.end()) { ProtectedObserverListener pol = *lit; if ((*pol)->enabled == false) { ++lit; continue; } alljoyn_observerlistener listener = (*pol)->listener; if (listener->callbacks.object_lost == NULL) { ++lit; continue; } listenersLock.Unlock(MUTEX_CONTEXT); listener->callbacks.object_lost(listener->ctx, proxyref); listenersLock.Lock(MUTEX_CONTEXT); lit = listeners.upper_bound(pol); } listenersLock.Unlock(MUTEX_CONTEXT); alljoyn_proxybusobject_ref_decref(proxyref); } } } struct _alljoyn_observer_handle { }; alljoyn_observer AJ_CALL alljoyn_observer_create(alljoyn_busattachment bus, const char* mandatoryInterfaces[], size_t numMandatoryInterfaces) { std::set mandatory; bool inError = false; if (mandatoryInterfaces) { for (size_t i = 0; i < numMandatoryInterfaces; ++i) { alljoyn_interfacedescription intf = alljoyn_busattachment_getinterface(bus, mandatoryInterfaces[i]); if (NULL == intf) { QCC_LogError(ER_FAIL, ("Interface %s does not exist", mandatoryInterfaces[i])); inError = true; } else { mandatory.insert(mandatoryInterfaces[i]); } } } if (mandatory.empty()) { QCC_LogError(ER_FAIL, ("There must be at least one mandatory interface.")); return NULL; } if (inError) { QCC_LogError(ER_FAIL, ("At least one of the mandatory interfaces is not declared in the bus attachment.")); return NULL; } return (alljoyn_observer) new ajn::ObserverC(bus, mandatory); } void AJ_CALL alljoyn_observer_destroy(alljoyn_observer observer) { /* actual destruction will be done by the ObserverManager in due time */ if (observer != NULL) { ajn::ObserverC* obs = (ajn::ObserverC*) observer; obs->Detach(); } } void AJ_CALL alljoyn_observer_registerlistener(alljoyn_observer observer, alljoyn_observerlistener listener, QCC_BOOL triggerOnExisting) { if (observer != NULL) { ajn::ObserverC* obs = (ajn::ObserverC*) observer; obs->RegisterListener(listener, triggerOnExisting); } } void AJ_CALL alljoyn_observer_unregisterlistener(alljoyn_observer observer, alljoyn_observerlistener listener) { if (observer != NULL) { ajn::ObserverC* obs = (ajn::ObserverC*) observer; obs->UnregisterListener(listener); } } void AJ_CALL alljoyn_observer_unregisteralllisteners(alljoyn_observer observer) { if (observer != NULL) { ajn::ObserverC* obs = (ajn::ObserverC*) observer; obs->UnregisterAllListeners(); } } alljoyn_proxybusobject_ref AJ_CALL alljoyn_observer_get(alljoyn_observer observer, const char* uniqueBusName, const char* objectPath) { if (observer != NULL) { ajn::ObserverC* obs = (ajn::ObserverC*) observer; return obs->Get(uniqueBusName, objectPath); } return NULL; } alljoyn_proxybusobject_ref AJ_CALL alljoyn_observer_getfirst(alljoyn_observer observer) { if (observer != NULL) { ajn::ObserverC* obs = (ajn::ObserverC*) observer; return obs->GetFirst(); } return NULL; } alljoyn_proxybusobject_ref AJ_CALL alljoyn_observer_getnext(alljoyn_observer observer, alljoyn_proxybusobject_ref proxyref) { if (observer != NULL) { ajn::ObserverC* obs = (ajn::ObserverC*) observer; return obs->GetNext(proxyref); } return NULL; } alljoyn-15.04b/alljoyn_c/src/PasswordManager.cc000066400000000000000000000026611255700255500215150ustar00rootroot00000000000000/** * @file * BusAttachment is the top-level object responsible for connecting to and optionally managing a message bus. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #define QCC_MODULE "ALLJOYN_C" QStatus AJ_CALL alljoyn_passwordmanager_setcredentials(const char* authMechanism, const char* password) { QCC_DbgTrace(("%s", __FUNCTION__)); return ajn::PasswordManager::SetCredentials(authMechanism, password); } alljoyn-15.04b/alljoyn_c/src/ProxyBusObject.cc000066400000000000000000000565021255700255500213450ustar00rootroot00000000000000/** * @file * * This file implements the ProxyBusObject class. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include "BusAttachmentC.h" #include "MessageReceiverC.h" #include "ProxyBusObjectListenerC.h" #include #include #define QCC_MODULE "ALLJOYN_C" struct _alljoyn_proxybusobject_handle { /* Empty by design, this is just to allow the type restrictions to save coders from themselves */ }; /* static instances of classes used for Async CallBacks */ static ajn::MessageReceiverC msgReceverC; static ajn::ProxyBusObjectListenerC proxyObjListener; namespace std { // Specialized comparator for properties change listeners. template <> struct less { bool operator()(const ajn::ProxyBusObjectPropertiesChangedListenerC* lhs, const ajn::ProxyBusObjectPropertiesChangedListenerC* rhs) const { return (intptr_t)lhs->GetSignalHandler() < (intptr_t)rhs->GetSignalHandler(); } }; } class ProxyBusObjectC : public ajn::ProxyBusObject { // private typedefs to make some of the code lines shorter and more readable. typedef std::multimap ListenerMap; typedef std::pair ListenerMapEntry; public: ProxyBusObjectC() : ajn::ProxyBusObject() { } ProxyBusObjectC(ajn::BusAttachment& bus, const char* service, const char* path, ajn::SessionId sessionId, bool secure = false) : ProxyBusObject(bus, service, path, sessionId, secure) { } ~ProxyBusObjectC() { /* * Don't bother locking the mutex in the destructor. If the * mutex were to block then the calling code has much bigger * problems since it is destroying an object that is currently * in use. */ while (!listeners.empty()) { free(listeners.begin()->second); delete listeners.begin()->first; listeners.erase(listeners.begin()); } } ajn::ProxyBusObjectPropertiesChangedListenerC* AddListener(const char* iface, alljoyn_proxybusobject_listener_propertieschanged_ptr callback) { ajn::ProxyBusObjectPropertiesChangedListenerC* propListener = new ajn::ProxyBusObjectPropertiesChangedListenerC(callback); lock.Lock(); listeners.insert(ListenerMapEntry(propListener, strdup(iface))); lock.Unlock(); return propListener; } ajn::ProxyBusObjectPropertiesChangedListenerC* RemoveListener(const char* iface, alljoyn_proxybusobject_listener_propertieschanged_ptr callback) { ajn::ProxyBusObjectPropertiesChangedListenerC* propListener = NULL; ajn::ProxyBusObjectPropertiesChangedListenerC lookupPropListener(callback); lock.Lock(); ListenerMap::iterator it = listeners.lower_bound(&lookupPropListener); ListenerMap::iterator end = listeners.upper_bound(&lookupPropListener); while ((it != end) && (strcmp(iface, it->second) != 0)) { ++it; } if (it != end) { free(it->second); propListener = it->first; listeners.erase(it); } lock.Unlock(); return propListener; } private: ListenerMap listeners; mutable qcc::Mutex lock; }; alljoyn_proxybusobject AJ_CALL alljoyn_proxybusobject_create(alljoyn_busattachment bus, const char* service, const char* path, alljoyn_sessionid sessionId) { QCC_DbgTrace(("%s", __FUNCTION__)); ProxyBusObjectC* ret = new ProxyBusObjectC(*((ajn::BusAttachmentC*)bus), service, path, sessionId); return (alljoyn_proxybusobject)ret; } alljoyn_proxybusobject AJ_CALL alljoyn_proxybusobject_create_secure(alljoyn_busattachment bus, const char* service, const char* path, alljoyn_sessionid sessionId) { QCC_DbgTrace(("%s", __FUNCTION__)); ProxyBusObjectC* ret = new ProxyBusObjectC(*((ajn::BusAttachmentC*)bus), service, path, sessionId, true); return (alljoyn_proxybusobject)ret; } void AJ_CALL alljoyn_proxybusobject_destroy(alljoyn_proxybusobject proxyObj) { QCC_DbgTrace(("%s", __FUNCTION__)); assert(proxyObj != NULL && "NULL parameter passed to alljoyn_proxybusobject_destroy."); // Clean up the C++ ProxyBusObject before cleaning up the listeners. delete (ProxyBusObjectC*)proxyObj; } QStatus AJ_CALL alljoyn_proxybusobject_addinterface(alljoyn_proxybusobject proxyObj, const alljoyn_interfacedescription iface) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ProxyBusObjectC*)proxyObj)->AddInterface(*((const ajn::InterfaceDescription*)iface)); } QStatus AJ_CALL alljoyn_proxybusobject_addinterface_by_name(alljoyn_proxybusobject proxyObj, const char* name) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ProxyBusObjectC*)proxyObj)->AddInterface(name); } size_t AJ_CALL alljoyn_proxybusobject_getchildren(alljoyn_proxybusobject proxyObj, alljoyn_proxybusobject* children, size_t numChildren) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ProxyBusObjectC*)proxyObj)->GetChildren((ajn::ProxyBusObject**)children, numChildren); } alljoyn_proxybusobject AJ_CALL alljoyn_proxybusobject_getchild(alljoyn_proxybusobject proxyObj, const char* path) { QCC_DbgTrace(("%s", __FUNCTION__)); return (alljoyn_proxybusobject)((ProxyBusObjectC*)proxyObj)->GetChild(path); } QStatus AJ_CALL alljoyn_proxybusobject_addchild(alljoyn_proxybusobject proxyObj, const alljoyn_proxybusobject child) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ProxyBusObjectC*)proxyObj)->AddChild(*(ProxyBusObjectC*)child); } QStatus AJ_CALL alljoyn_proxybusobject_removechild(alljoyn_proxybusobject proxyObj, const char* path) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ProxyBusObjectC*)proxyObj)->RemoveChild(path); } QStatus AJ_CALL alljoyn_proxybusobject_introspectremoteobject(alljoyn_proxybusobject proxyObj) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ProxyBusObjectC*)proxyObj)->IntrospectRemoteObject(); } QStatus AJ_CALL alljoyn_proxybusobject_introspectremoteobjectasync(alljoyn_proxybusobject proxyObj, alljoyn_proxybusobject_listener_introspectcb_ptr callback, void* context) { QCC_DbgTrace(("%s", __FUNCTION__)); /* * The new ajn::IntrospectCallbackContext must be freed in inside the * ajn::ProxyBusObjectListenerC::IntrospectCB. */ return ((ProxyBusObjectC*)proxyObj)->IntrospectRemoteObjectAsync(&proxyObjListener, static_cast(&ajn::ProxyBusObjectListenerC::IntrospectCB), (void*) new ajn::IntrospectCallbackContext(callback, context)); } QStatus AJ_CALL alljoyn_proxybusobject_getproperty(alljoyn_proxybusobject proxyObj, const char* iface, const char* property, alljoyn_msgarg value) { QCC_DbgTrace(("%s", __FUNCTION__)); ajn::MsgArg* reply = (ajn::MsgArg*)&(*value); return ((ProxyBusObjectC*)proxyObj)->GetProperty(iface, property, *reply); } QStatus AJ_CALL alljoyn_proxybusobject_getpropertyasync(alljoyn_proxybusobject proxyObj, const char* iface, const char* property, alljoyn_proxybusobject_listener_getpropertycb_ptr callback, uint32_t timeout, void* context) { QCC_DbgTrace(("%s", __FUNCTION__)); /* * The new ajn::GetPropertyCallbackContext must be freed in inside the * ajn::ProxyBusObjectListenerC::GetPropertyCB. */ return ((ProxyBusObjectC*)proxyObj)->GetPropertyAsync(iface, property, &proxyObjListener, static_cast(&ajn::ProxyBusObjectListenerC::GetPropertyCB), (void*) new ajn::GetPropertyCallbackContext(callback, context), timeout); } QStatus AJ_CALL alljoyn_proxybusobject_getallproperties(alljoyn_proxybusobject proxyObj, const char* iface, alljoyn_msgarg values) { QCC_DbgTrace(("%s", __FUNCTION__)); ajn::MsgArg* reply = (ajn::MsgArg*)&(*values); return ((ProxyBusObjectC*)proxyObj)->GetAllProperties(iface, *reply); } QStatus AJ_CALL alljoyn_proxybusobject_getallpropertiesasync(alljoyn_proxybusobject proxyObj, const char* iface, alljoyn_proxybusobject_listener_getallpropertiescb_ptr callback, uint32_t timeout, void* context) { QCC_DbgTrace(("%s", __FUNCTION__)); /* * The new ajn::GetAllPropertiesCallbackContext must be freed in inside the * ajn::ProxyBusObjectListenerC::GetAllPropertiesCB. */ return ((ProxyBusObjectC*)proxyObj)->GetAllPropertiesAsync(iface, &proxyObjListener, static_cast(&ajn::ProxyBusObjectListenerC::GetAllPropertiesCB), (void*) new ajn::GetPropertyCallbackContext(callback, context), timeout); } QStatus AJ_CALL alljoyn_proxybusobject_setproperty(alljoyn_proxybusobject proxyObj, const char* iface, const char* property, alljoyn_msgarg value) { QCC_DbgTrace(("%s", __FUNCTION__)); ajn::MsgArg* reply = (ajn::MsgArg*)&(*value); return ((ProxyBusObjectC*)proxyObj)->SetProperty(iface, property, *reply); } QStatus AJ_CALL alljoyn_proxybusobject_setpropertyasync(alljoyn_proxybusobject proxyObj, const char* iface, const char* property, alljoyn_msgarg value, alljoyn_proxybusobject_listener_setpropertycb_ptr callback, uint32_t timeout, void* context) { QCC_DbgTrace(("%s", __FUNCTION__)); /* * The new ajn::GetPropertyCallbackContext must be freed in inside the * ajn::ProxyBusObjectListenerC::GetPropertyCB. */ return ((ProxyBusObjectC*)proxyObj)->SetPropertyAsync(iface, property, *(ajn::MsgArg*)value, &proxyObjListener, static_cast(&ajn::ProxyBusObjectListenerC::SetPropertyCB), (void*) new ajn::SetPropertyCallbackContext(callback, context), timeout); } QStatus AJ_CALL alljoyn_proxybusobject_registerpropertieschangedlistener(alljoyn_proxybusobject proxyObj, const char* iface, const char** properties, size_t propertiesSize, alljoyn_proxybusobject_listener_propertieschanged_ptr callback, void* context) { ajn::ProxyBusObjectPropertiesChangedListenerC* propChangeListener = ((ProxyBusObjectC*)proxyObj)->AddListener(iface, callback); return ((ProxyBusObjectC*)proxyObj)->RegisterPropertiesChangedListener(iface, properties, propertiesSize, *propChangeListener, context); } QStatus AJ_CALL alljoyn_proxybusobject_unregisterpropertieschangedlistener(alljoyn_proxybusobject proxyObj, const char* iface, alljoyn_proxybusobject_listener_propertieschanged_ptr callback) { QStatus status = ER_FAIL; ajn::ProxyBusObjectPropertiesChangedListenerC* propChangeListener = ((ProxyBusObjectC*)proxyObj)->RemoveListener(iface, callback); if (propChangeListener) { status = ((ProxyBusObjectC*)proxyObj)->UnregisterPropertiesChangedListener(iface, *propChangeListener); delete propChangeListener; } return status; } QStatus AJ_CALL alljoyn_proxybusobject_methodcall(alljoyn_proxybusobject obj, const char* ifaceName, const char* methodName, alljoyn_msgarg args, size_t numArgs, alljoyn_message replyMsg, uint32_t timeout, uint8_t flags) { QCC_DbgTrace(("%s", __FUNCTION__)); ajn::Message* reply = (ajn::Message*)&(*replyMsg); return ((ProxyBusObjectC*)obj)->MethodCall(ifaceName, methodName, (const ajn::MsgArg*)args, numArgs, *reply, timeout, flags); } QStatus AJ_CALL alljoyn_proxybusobject_methodcall_member(alljoyn_proxybusobject proxyObj, const alljoyn_interfacedescription_member method, const alljoyn_msgarg args, size_t numArgs, alljoyn_message replyMsg, uint32_t timeout, uint8_t flags) { QCC_DbgTrace(("%s", __FUNCTION__)); ajn::Message* reply = (ajn::Message*)&(*replyMsg); return ((ProxyBusObjectC*)proxyObj)->MethodCall(*(const ajn::InterfaceDescription::Member*)(method.internal_member), (const ajn::MsgArg*)args, numArgs, *reply, timeout, flags); } QStatus AJ_CALL alljoyn_proxybusobject_methodcall_noreply(alljoyn_proxybusobject proxyObj, const char* ifaceName, const char* methodName, const alljoyn_msgarg args, size_t numArgs, uint8_t flags) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ProxyBusObjectC*)proxyObj)->MethodCall(ifaceName, methodName, (const ajn::MsgArg*)args, numArgs, flags); } QStatus AJ_CALL alljoyn_proxybusobject_methodcall_member_noreply(alljoyn_proxybusobject proxyObj, const alljoyn_interfacedescription_member method, const alljoyn_msgarg args, size_t numArgs, uint8_t flags) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ProxyBusObjectC*)proxyObj)->MethodCall(*(const ajn::InterfaceDescription::Member*)(method.internal_member), (const ajn::MsgArg*)args, numArgs, flags); } QStatus AJ_CALL alljoyn_proxybusobject_methodcallasync(alljoyn_proxybusobject proxyObj, const char* ifaceName, const char* methodName, alljoyn_messagereceiver_replyhandler_ptr replyFunc, const alljoyn_msgarg args, size_t numArgs, void* context, uint32_t timeout, uint8_t flags) { QCC_DbgTrace(("%s", __FUNCTION__)); /* * the instance of the ajn::MessageReceiverReplyHandlerCallbackContext is * freed when the message ReplyHandler is called. */ return ((ProxyBusObjectC*)proxyObj)->MethodCallAsync(ifaceName, methodName, &msgReceverC, static_cast(&ajn::MessageReceiverC::ReplyHandler), (const ajn::MsgArg*)args, numArgs, new ajn::MessageReceiverReplyHandlerCallbackContext(replyFunc, context), timeout, flags); } QStatus AJ_CALL alljoyn_proxybusobject_methodcallasync_member(alljoyn_proxybusobject proxyObj, const alljoyn_interfacedescription_member method, /* MessageReceiver* receiver,*/ alljoyn_messagereceiver_replyhandler_ptr replyFunc, const alljoyn_msgarg args, size_t numArgs, void* context, uint32_t timeout, uint8_t flags) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ProxyBusObjectC*)proxyObj)->MethodCallAsync(*(const ajn::InterfaceDescription::Member*)(method.internal_member), &msgReceverC, static_cast(&ajn::MessageReceiverC::ReplyHandler), (const ajn::MsgArg*)args, numArgs, new ajn::MessageReceiverReplyHandlerCallbackContext(replyFunc, context), timeout, flags); } QStatus AJ_CALL alljoyn_proxybusobject_parsexml(alljoyn_proxybusobject proxyObj, const char* xml, const char* identifier) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ProxyBusObjectC*)proxyObj)->ParseXml(xml, identifier); } QStatus AJ_CALL alljoyn_proxybusobject_secureconnection(alljoyn_proxybusobject proxyObj, QCC_BOOL forceAuth) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ProxyBusObjectC*)proxyObj)->SecureConnection(forceAuth); } QStatus AJ_CALL alljoyn_proxybusobject_secureconnectionasync(alljoyn_proxybusobject proxyObj, QCC_BOOL forceAuth) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ProxyBusObjectC*)proxyObj)->SecureConnectionAsync(forceAuth); } const alljoyn_interfacedescription AJ_CALL alljoyn_proxybusobject_getinterface(alljoyn_proxybusobject proxyObj, const char* iface) { QCC_DbgTrace(("%s", __FUNCTION__)); return (const alljoyn_interfacedescription)((ProxyBusObjectC*)proxyObj)->GetInterface(iface); } size_t AJ_CALL alljoyn_proxybusobject_getinterfaces(alljoyn_proxybusobject proxyObj, const alljoyn_interfacedescription* ifaces, size_t numIfaces) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ProxyBusObjectC*)proxyObj)->GetInterfaces(((const ajn::InterfaceDescription**)ifaces), numIfaces); } const char* AJ_CALL alljoyn_proxybusobject_getpath(alljoyn_proxybusobject proxyObj) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ProxyBusObjectC*)proxyObj)->GetPath().c_str(); } const char* AJ_CALL alljoyn_proxybusobject_getservicename(alljoyn_proxybusobject proxyObj) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ProxyBusObjectC*)proxyObj)->GetServiceName().c_str(); } const char* AJ_CALL alljoyn_proxybusobject_getuniquename(alljoyn_proxybusobject proxyObj) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ProxyBusObjectC*)proxyObj)->GetUniqueName().c_str(); } alljoyn_sessionid AJ_CALL alljoyn_proxybusobject_getsessionid(alljoyn_proxybusobject proxyObj) { QCC_DbgTrace(("%s", __FUNCTION__)); return (alljoyn_sessionid)((ProxyBusObjectC*)proxyObj)->GetSessionId(); } QCC_BOOL AJ_CALL alljoyn_proxybusobject_implementsinterface(alljoyn_proxybusobject proxyObj, const char* iface) { QCC_DbgTrace(("%s", __FUNCTION__)); return (QCC_BOOL)((ProxyBusObjectC*)proxyObj)->ImplementsInterface(iface); } alljoyn_proxybusobject AJ_CALL alljoyn_proxybusobject_copy(const alljoyn_proxybusobject source) { QCC_DbgTrace(("%s", __FUNCTION__)); if (!source) { return NULL; } ProxyBusObjectC* ret = new ProxyBusObjectC; *ret = *(ProxyBusObjectC*)source; return (alljoyn_proxybusobject) ret; } QCC_BOOL AJ_CALL alljoyn_proxybusobject_isvalid(alljoyn_proxybusobject proxyObj) { QCC_DbgTrace(("%s", __FUNCTION__)); return (QCC_BOOL)((ProxyBusObjectC*)proxyObj)->IsValid(); } QCC_BOOL AJ_CALL alljoyn_proxybusobject_issecure(alljoyn_proxybusobject proxyObj) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((ProxyBusObjectC*)proxyObj)->IsSecure() == true ? QCC_TRUE : QCC_FALSE; } void AJ_CALL alljoyn_proxybusobject_enablepropertycaching(alljoyn_proxybusobject proxyObj) { QCC_DbgTrace(("%s", __FUNCTION__)); ((ProxyBusObjectC*)proxyObj)->EnablePropertyCaching(); } alljoyn-15.04b/alljoyn_c/src/ProxyBusObjectListenerC.h000066400000000000000000000134771255700255500230240ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_C_PROXYBUSOBJECTLISTENERC_H #define _ALLJOYN_C_PROXYBUSOBJECTLISTENERC_H #include namespace ajn { /* * When setting up a asynchronous Introspection call a callback handler for C * alljoyn_proxybusobject_listener_introspectcb_ptr function pointer will be * passed in as the callback handler. AllJoyn expects a * ProxyBusObject::Listener::IntrospectCB method handler. The function handler * will be passed as the part of the void* context that is passed to the internal * callback handler and will then be used to map the internal callback handler * to the user defined alljoyn_proxybusobject_listener_introspectcb_ptr callback * function pointer. */ class IntrospectCallbackContext { public: IntrospectCallbackContext(alljoyn_proxybusobject_listener_introspectcb_ptr replyhandler_ptr, void* context) : replyhandler_ptr(replyhandler_ptr), context(context) { } alljoyn_proxybusobject_listener_introspectcb_ptr replyhandler_ptr; void* context; }; class GetPropertyCallbackContext { public: GetPropertyCallbackContext(alljoyn_proxybusobject_listener_getpropertycb_ptr replyhandler_ptr, void* context) : replyhandler_ptr(replyhandler_ptr), context(context) { } alljoyn_proxybusobject_listener_getpropertycb_ptr replyhandler_ptr; void* context; }; class GetAllPropertiesCallbackContext { public: GetAllPropertiesCallbackContext(alljoyn_proxybusobject_listener_getallpropertiescb_ptr replyhandler_ptr, void* context) : replyhandler_ptr(replyhandler_ptr), context(context) { } alljoyn_proxybusobject_listener_getallpropertiescb_ptr replyhandler_ptr; void* context; }; class SetPropertyCallbackContext { public: SetPropertyCallbackContext(alljoyn_proxybusobject_listener_setpropertycb_ptr replyhandler_ptr, void* context) : replyhandler_ptr(replyhandler_ptr), context(context) { } alljoyn_proxybusobject_listener_setpropertycb_ptr replyhandler_ptr; void* context; }; class PropertieschangedCallbackContext { public: PropertieschangedCallbackContext(alljoyn_proxybusobject_listener_propertieschanged_ptr signalhandler_ptr, void* context) : signalhandler_ptr(signalhandler_ptr), context(context) { } alljoyn_proxybusobject_listener_propertieschanged_ptr signalhandler_ptr; void* context; }; class ProxyBusObjectListenerC : public ajn::ProxyBusObject::Listener { public: void IntrospectCB(QStatus status, ajn::ProxyBusObject* obj, void* context) { /* * The IntrospectCallbackContext that found in the context pointer is * allocated in when the user calls alljoyn_proxybusobject_introspectremoteobjectasync * as soon as the IntrospectCB is received this context pointer will not be * used again and must be freed. we don't call delete here the instance * of the IntrospectCallbackContext will cause a memory leak. */ IntrospectCallbackContext* in = (IntrospectCallbackContext*)context; in->replyhandler_ptr(status, (alljoyn_proxybusobject)obj, in->context); in->replyhandler_ptr = NULL; delete in; } void GetPropertyCB(QStatus status, ProxyBusObject* obj, const MsgArg& value, void* context) { GetPropertyCallbackContext* in = (GetPropertyCallbackContext*)context; in->replyhandler_ptr(status, (alljoyn_proxybusobject)obj, (alljoyn_msgarg)(&value), in->context); in->replyhandler_ptr = NULL; delete in; } void GetAllPropertiesCB(QStatus status, ProxyBusObject* obj, const MsgArg& value, void* context) { GetAllPropertiesCallbackContext* in = (GetAllPropertiesCallbackContext*)context; in->replyhandler_ptr(status, (alljoyn_proxybusobject)obj, (alljoyn_msgarg)(&value), in->context); in->replyhandler_ptr = NULL; delete in; } void SetPropertyCB(QStatus status, ProxyBusObject* obj, void* context) { SetPropertyCallbackContext* in = (SetPropertyCallbackContext*)context; in->replyhandler_ptr(status, (alljoyn_proxybusobject)obj, in->context); in->replyhandler_ptr = NULL; delete in; } }; class ProxyBusObjectPropertiesChangedListenerC : public ajn::ProxyBusObject::PropertiesChangedListener { public: ProxyBusObjectPropertiesChangedListenerC(alljoyn_proxybusobject_listener_propertieschanged_ptr signalhandler_ptr) : signalhandler_ptr(signalhandler_ptr) { } void PropertiesChanged(ProxyBusObject& obj, const char* ifaceName, const MsgArg& changed, const MsgArg& invalidated, void* context) { signalhandler_ptr((alljoyn_proxybusobject)(&obj), ifaceName, (alljoyn_msgarg)(&changed), (alljoyn_msgarg)(&invalidated), context); } const alljoyn_proxybusobject_listener_propertieschanged_ptr GetSignalHandler() const { return signalhandler_ptr; } private: alljoyn_proxybusobject_listener_propertieschanged_ptr signalhandler_ptr; }; } #endif alljoyn-15.04b/alljoyn_c/src/SConscript000066400000000000000000000036361255700255500201260ustar00rootroot00000000000000# Copyright AllSeen Alliance. All rights reserved. # # Permission to use, copy, modify, and/or distribute this software for any # purpose with or without fee is hereby granted, provided that the above # copyright notice and this permission notice appear in all copies. # # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. # Import('env') # AllJoyn Sources srcs = env.Glob('*.cc') objs = env.Object(srcs) objs_shared = env.SharedObject(srcs) # Add the export DEF file for Windows. if env['OS_GROUP'] == 'windows': objs_shared.append(env.Dir('.').abspath + '/${OS_GROUP}/alljoyn_c.def') # Windows produces two types of .lib files. # - static library used for statically linking # - import library used for linking with a shared library (i.e. a dll). # Depending on the build setup both file types may be needed. To distinguish # between the static library and the import library on windows the static # library will be called alljoyn_c_static.lib and the import library will be # called alljoyn_c.lib. # see http://msdn.microsoft.com/en-us/library/ba1z7822.aspx for more info. # For all other OSs there is no need to make this distinction. if env['OS_GROUP'] == 'windows': liballjoyn_c_static = env.StaticLibrary('alljoyn_c_static', objs) else: liballjoyn_c_static = env.StaticLibrary('alljoyn_c', objs) liballjoyn_c_shared = env.SharedLibrary('alljoyn_c', objs_shared) Return('liballjoyn_c_static', 'liballjoyn_c_shared', 'objs_shared') alljoyn-15.04b/alljoyn_c/src/SessionListener.cc000066400000000000000000000111031255700255500215400ustar00rootroot00000000000000/** * @file * This implements the C accessable version of the SessionListener class using * function pointers, and a pass-through implementation of SessionListener. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include "DeferredCallback.h" #include #define QCC_MODULE "ALLJOYN_C" namespace ajn { /** * Abstract base class implemented by AllJoyn users and called by AllJoyn to inform * users of session related events. */ class SessionListenerCallbackC : public SessionListener { public: SessionListenerCallbackC(const alljoyn_sessionlistener_callbacks* in_callbacks, const void* in_context) { QCC_DbgTrace(("%s", __FUNCTION__)); memcpy(&callbacks, in_callbacks, sizeof(alljoyn_sessionlistener_callbacks)); context = in_context; } virtual void SessionLost(SessionId sessionId, SessionLostReason reason) { QCC_DbgTrace(("%s", __FUNCTION__)); if (callbacks.session_lost != NULL) { if (!DeferredCallback::sMainThreadCallbacksOnly) { callbacks.session_lost(context, sessionId, static_cast(reason)); } else { DeferredCallback_3* dcb = new DeferredCallback_3(callbacks.session_lost, context, sessionId, static_cast(reason)); DEFERRED_CALLBACK_EXECUTE(dcb); } } } virtual void SessionMemberAdded(SessionId sessionId, const char* uniqueName) { QCC_DbgTrace(("%s", __FUNCTION__)); if (callbacks.session_member_added != NULL) { if (!DeferredCallback::sMainThreadCallbacksOnly) { callbacks.session_member_added(context, sessionId, uniqueName); } else { DeferredCallback_3* dcb = new DeferredCallback_3(callbacks.session_member_added, context, sessionId, uniqueName); DEFERRED_CALLBACK_EXECUTE(dcb); } } } virtual void SessionMemberRemoved(SessionId sessionId, const char* uniqueName) { QCC_DbgTrace(("%s", __FUNCTION__)); if (callbacks.session_member_removed != NULL) { if (!DeferredCallback::sMainThreadCallbacksOnly) { callbacks.session_member_removed(context, sessionId, uniqueName); } else { DeferredCallback_3* dcb = new DeferredCallback_3(callbacks.session_member_removed, context, sessionId, uniqueName); DEFERRED_CALLBACK_EXECUTE(dcb); } } } protected: alljoyn_sessionlistener_callbacks callbacks; const void* context; }; } struct _alljoyn_sessionlistener_handle { /* Empty by design, this is just to allow the type restrictions to save coders from themselves */ }; alljoyn_sessionlistener AJ_CALL alljoyn_sessionlistener_create(const alljoyn_sessionlistener_callbacks* callbacks, const void* context) { QCC_DbgTrace(("%s", __FUNCTION__)); return (alljoyn_sessionlistener) new ajn::SessionListenerCallbackC(callbacks, context); } void AJ_CALL alljoyn_sessionlistener_destroy(alljoyn_sessionlistener listener) { QCC_DbgTrace(("%s", __FUNCTION__)); assert(listener != NULL && "listener parameter must not be NULL"); delete (ajn::SessionListenerCallbackC*)listener; } alljoyn-15.04b/alljoyn_c/src/SessionOpts.cc000066400000000000000000000105261255700255500207100ustar00rootroot00000000000000/** * @file * Class for encapsulating Session option information. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #define QCC_MODULE "ALLJOYN_C" struct _alljoyn_sessionopts_handle { /* Empty by design, this is just to allow the type restrictions to save coders from themselves */ }; alljoyn_sessionopts AJ_CALL alljoyn_sessionopts_create(uint8_t traffic, QCC_BOOL isMultipoint, uint8_t proximity, alljoyn_transportmask transports) { QCC_DbgTrace(("%s", __FUNCTION__)); return (alljoyn_sessionopts) new ajn::SessionOpts((ajn::SessionOpts::TrafficType)traffic, isMultipoint == QCC_TRUE ? true : false, (ajn::SessionOpts::Proximity)proximity, (ajn::TransportMask)transports); } void AJ_CALL alljoyn_sessionopts_destroy(alljoyn_sessionopts opts) { QCC_DbgTrace(("%s", __FUNCTION__)); delete (ajn::SessionOpts*)opts; } uint8_t AJ_CALL alljoyn_sessionopts_get_traffic(const alljoyn_sessionopts opts) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((const ajn::SessionOpts*)opts)->traffic; } void AJ_CALL alljoyn_sessionopts_set_traffic(alljoyn_sessionopts opts, uint8_t traffic) { QCC_DbgTrace(("%s", __FUNCTION__)); ((ajn::SessionOpts*)opts)->traffic = (ajn::SessionOpts::TrafficType)traffic; } QCC_BOOL AJ_CALL alljoyn_sessionopts_get_multipoint(const alljoyn_sessionopts opts) { QCC_DbgTrace(("%s", __FUNCTION__)); return (((const ajn::SessionOpts*)opts)->isMultipoint ? QCC_TRUE : QCC_FALSE); } void AJ_CALL alljoyn_sessionopts_set_multipoint(alljoyn_sessionopts opts, QCC_BOOL isMultipoint) { QCC_DbgTrace(("%s", __FUNCTION__)); (isMultipoint == QCC_TRUE) ? ((ajn::SessionOpts*)opts)->isMultipoint = true : ((ajn::SessionOpts*)opts)->isMultipoint = false; } uint8_t AJ_CALL alljoyn_sessionopts_get_proximity(const alljoyn_sessionopts opts) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((const ajn::SessionOpts*)opts)->proximity; } void AJ_CALL alljoyn_sessionopts_set_proximity(alljoyn_sessionopts opts, uint8_t proximity) { QCC_DbgTrace(("%s", __FUNCTION__)); ((ajn::SessionOpts*)opts)->proximity = (ajn::SessionOpts::Proximity)proximity; } alljoyn_transportmask AJ_CALL alljoyn_sessionopts_get_transports(const alljoyn_sessionopts opts) { QCC_DbgTrace(("%s", __FUNCTION__)); return ((const ajn::SessionOpts*)opts)->transports; } void AJ_CALL alljoyn_sessionopts_set_transports(alljoyn_sessionopts opts, alljoyn_transportmask transports) { QCC_DbgTrace(("%s", __FUNCTION__)); ((ajn::SessionOpts*)opts)->transports = (ajn::TransportMask)transports; } QCC_BOOL AJ_CALL alljoyn_sessionopts_iscompatible(const alljoyn_sessionopts one, const alljoyn_sessionopts other) { QCC_DbgTrace(("%s", __FUNCTION__)); return (((const ajn::SessionOpts*)one)->IsCompatible(*((const ajn::SessionOpts*)other)) == true ? QCC_TRUE : QCC_FALSE); } int32_t AJ_CALL alljoyn_sessionopts_cmp(const alljoyn_sessionopts one, const alljoyn_sessionopts other) { QCC_DbgTrace(("%s", __FUNCTION__)); const ajn::SessionOpts& _one = *((const ajn::SessionOpts*)one); const ajn::SessionOpts& _other = *((const ajn::SessionOpts*)other); return (_one == _other ? 0 : (_other < _one ? 1 : -1)); } alljoyn-15.04b/alljoyn_c/src/SessionPortListener.cc000066400000000000000000000103761255700255500224200ustar00rootroot00000000000000/** * @file * This implements the C accessable version of the SessionPortListener class using * function pointers, and a pass-through implementation of SessionPortListener. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include "DeferredCallback.h" #include #define QCC_MODULE "ALLJOYN_C" namespace ajn { /** * Abstract base class implemented by AllJoyn users and called by AllJoyn to inform * users of session port related events. */ class SessionPortListenerCallbackC : public SessionPortListener { public: SessionPortListenerCallbackC(const alljoyn_sessionportlistener_callbacks* in_callbacks, const void* in_context) { QCC_DbgTrace(("%s", __FUNCTION__)); memcpy(&callbacks, in_callbacks, sizeof(alljoyn_sessionportlistener_callbacks)); context = in_context; } virtual bool AcceptSessionJoiner(SessionPort sessionPort, const char* joiner, const SessionOpts& opts) { QCC_DbgTrace(("%s", __FUNCTION__)); QCC_BOOL ret = SessionPortListener::AcceptSessionJoiner(sessionPort, joiner, opts) ? QCC_TRUE : QCC_FALSE; if (callbacks.accept_session_joiner != NULL) { if (!DeferredCallback::sMainThreadCallbacksOnly) { ret = callbacks.accept_session_joiner(context, sessionPort, joiner, (alljoyn_sessionopts)(&opts)); } else { DeferredCallback_4* dcb = new DeferredCallback_4(callbacks.accept_session_joiner, context, sessionPort, joiner, (alljoyn_sessionopts)(&opts)); ret = DEFERRED_CALLBACK_EXECUTE(dcb); } } return (ret == QCC_FALSE ? false : true); } virtual void SessionJoined(SessionPort sessionPort, SessionId id, const char* joiner) { QCC_DbgTrace(("%s", __FUNCTION__)); if (callbacks.session_joined != NULL) { if (!DeferredCallback::sMainThreadCallbacksOnly) { callbacks.session_joined(context, sessionPort, id, joiner); } else { DeferredCallback_4* dcb = new DeferredCallback_4(callbacks.session_joined, context, sessionPort, id, joiner); DEFERRED_CALLBACK_EXECUTE(dcb); } } } protected: alljoyn_sessionportlistener_callbacks callbacks; const void* context; }; } struct _alljoyn_sessionportlistener_handle { /* Empty by design, this is just to allow the type restrictions to save coders from themselves */ }; alljoyn_sessionportlistener AJ_CALL alljoyn_sessionportlistener_create(const alljoyn_sessionportlistener_callbacks* callbacks, const void* context) { QCC_DbgTrace(("%s", __FUNCTION__)); return (alljoyn_sessionportlistener) new ajn::SessionPortListenerCallbackC(callbacks, context); } void AJ_CALL alljoyn_sessionportlistener_destroy(alljoyn_sessionportlistener listener) { QCC_DbgTrace(("%s", __FUNCTION__)); assert(listener != NULL && "listener parameter must not be NULL"); delete (ajn::SessionPortListenerCallbackC*)listener; } alljoyn-15.04b/alljoyn_c/src/Windows/000077500000000000000000000000001255700255500175365ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_c/src/Windows/alljoyn_c.def000066400000000000000000000344731255700255500222030ustar00rootroot00000000000000EXPORTS QCC_StatusText alljoyn_aboutdata_create alljoyn_aboutdata_create_empty alljoyn_aboutdata_create_full alljoyn_aboutdata_createfrommsgarg alljoyn_aboutdata_destroy alljoyn_aboutdata_getaboutdata alljoyn_aboutdata_getajsoftwareversion alljoyn_aboutdata_getannouncedaboutdata alljoyn_aboutdata_getappid alljoyn_aboutdata_getappname alljoyn_aboutdata_getdateofmanufacture alljoyn_aboutdata_getdefaultlanguage alljoyn_aboutdata_getdescription alljoyn_aboutdata_getdeviceid alljoyn_aboutdata_getdevicename alljoyn_aboutdata_getfield alljoyn_aboutdata_getfields alljoyn_aboutdata_getfieldsignature alljoyn_aboutdata_gethardwareversion alljoyn_aboutdata_getmanufacturer alljoyn_aboutdata_getmodelnumber alljoyn_aboutdata_getsoftwareversion alljoyn_aboutdata_getsupportedlanguages alljoyn_aboutdata_getsupporturl alljoyn_aboutdata_isfieldannounced alljoyn_aboutdata_isfieldlocalized alljoyn_aboutdata_isfieldrequired alljoyn_aboutdata_isvalid alljoyn_aboutdata_setappid alljoyn_aboutdata_setappid_fromstring alljoyn_aboutdata_setappname alljoyn_aboutdata_setdateofmanufacture alljoyn_aboutdata_setdefaultlanguage alljoyn_aboutdata_setdescription alljoyn_aboutdata_setdeviceid alljoyn_aboutdata_setdevicename alljoyn_aboutdata_setfield alljoyn_aboutdata_sethardwareversion alljoyn_aboutdata_setmanufacturer alljoyn_aboutdata_setmodelnumber alljoyn_aboutdata_setsoftwareversion alljoyn_aboutdata_setsupportedlanguage alljoyn_aboutdata_setsupporturl alljoyn_aboutdatalistener_create alljoyn_aboutdatalistener_destroy alljoyn_abouticon_clear alljoyn_abouticon_create alljoyn_abouticon_destroy alljoyn_abouticon_setcontent alljoyn_abouticon_setcontent_frommsgarg alljoyn_abouticon_seturl alljoyn_abouticonobj_create alljoyn_abouticonobj_destroy alljoyn_abouticonproxy_create alljoyn_abouticonproxy_destroy alljoyn_abouticonproxy_geticon alljoyn_abouticonproxy_getversion alljoyn_aboutlistener_create alljoyn_aboutlistener_destroy alljoyn_aboutobj_announce alljoyn_aboutobj_create alljoyn_aboutobj_destroy alljoyn_aboutobj_unannounce alljoyn_aboutobjectdescription_clear alljoyn_aboutobjectdescription_create alljoyn_aboutobjectdescription_create_full alljoyn_aboutobjectdescription_createfrommsgarg alljoyn_aboutobjectdescription_destroy alljoyn_aboutobjectdescription_getinterfacepaths alljoyn_aboutobjectdescription_getinterfaces alljoyn_aboutobjectdescription_getmsgarg alljoyn_aboutobjectdescription_getpaths alljoyn_aboutobjectdescription_hasinterface alljoyn_aboutobjectdescription_hasinterfaceatpath alljoyn_aboutobjectdescription_haspath alljoyn_aboutproxy_create alljoyn_aboutproxy_destroy alljoyn_aboutproxy_getaboutdata alljoyn_aboutproxy_getobjectdescription alljoyn_aboutproxy_getversion alljoyn_aboutobj_announce_using_datalistener alljoyn_authlistener_create alljoyn_authlistener_destroy alljoyn_authlistener_requestcredentialsresponse alljoyn_authlistener_verifycredentialsresponse alljoyn_authlistenerasync_create alljoyn_authlistenerasync_destroy alljoyn_busattachment_addlogonentry alljoyn_busattachment_addmatch alljoyn_busattachment_advertisename alljoyn_busattachment_bindsessionport alljoyn_busattachment_canceladvertisename alljoyn_busattachment_cancelfindadvertisedname alljoyn_busattachment_cancelfindadvertisednamebytransport alljoyn_busattachment_cancelwhoimplements_interface alljoyn_busattachment_cancelwhoimplements_interfaces alljoyn_busattachment_clearkeys alljoyn_busattachment_clearkeystore alljoyn_busattachment_connect alljoyn_busattachment_create alljoyn_busattachment_create_concurrency alljoyn_busattachment_createinterface alljoyn_busattachment_createinterface_secure alljoyn_busattachment_createinterfacesfromxml alljoyn_busattachment_deleteinterface alljoyn_busattachment_destroy alljoyn_busattachment_disconnect alljoyn_busattachment_enableconcurrentcallbacks alljoyn_busattachment_enablepeersecurity alljoyn_busattachment_findadvertisedname alljoyn_busattachment_findadvertisednamebytransport alljoyn_busattachment_getalljoyndebugobj alljoyn_busattachment_getalljoynproxyobj alljoyn_busattachment_getconcurrency alljoyn_busattachment_getconnectspec alljoyn_busattachment_getdbusproxyobj alljoyn_busattachment_getglobalguidstring alljoyn_busattachment_getinterface alljoyn_busattachment_getinterfaces alljoyn_busattachment_getkeyexpiration alljoyn_busattachment_getpeerguid alljoyn_busattachment_gettimestamp alljoyn_busattachment_getuniquename alljoyn_busattachment_isconnected alljoyn_busattachment_ispeersecurityenabled alljoyn_busattachment_isstarted alljoyn_busattachment_isstopping alljoyn_busattachment_join alljoyn_busattachment_joinsession alljoyn_busattachment_joinsessionasync alljoyn_busattachment_leavesession alljoyn_busattachment_namehasowner alljoyn_busattachment_ping alljoyn_busattachment_registeraboutlistener alljoyn_busattachment_registerbuslistener alljoyn_busattachment_registerbusobject alljoyn_busattachment_registerbusobject_secure alljoyn_busattachment_registerkeystorelistener alljoyn_busattachment_registersignalhandler alljoyn_busattachment_registersignalhandlerwithrule alljoyn_busattachment_releasename alljoyn_busattachment_reloadkeystore alljoyn_busattachment_removematch alljoyn_busattachment_removesessionmember alljoyn_busattachment_requestname alljoyn_busattachment_setdaemondebug alljoyn_busattachment_setkeyexpiration alljoyn_busattachment_setlinktimeout alljoyn_busattachment_setlinktimeoutasync alljoyn_busattachment_setsessionlistener alljoyn_busattachment_start alljoyn_busattachment_stop alljoyn_busattachment_unbindsessionport alljoyn_busattachment_unregisteraboutlistener alljoyn_busattachment_unregisterallaboutlisteners alljoyn_busattachment_unregisterallhandlers alljoyn_busattachment_unregisterbuslistener alljoyn_busattachment_unregisterbusobject alljoyn_busattachment_unregistersignalhandler alljoyn_busattachment_unregistersignalhandlerwithrule alljoyn_busattachment_whoimplements_interface alljoyn_busattachment_whoimplements_interfaces alljoyn_buslistener_create alljoyn_buslistener_destroy alljoyn_busobject_addinterface alljoyn_busobject_addinterface_announced alljoyn_busobject_addmethodhandler alljoyn_busobject_addmethodhandlers alljoyn_busobject_cancelsessionlessmessage alljoyn_busobject_cancelsessionlessmessage_serial alljoyn_busobject_create alljoyn_busobject_destroy alljoyn_busobject_emitpropertieschanged alljoyn_busobject_emitpropertychanged alljoyn_busobject_getannouncedinterfacenames alljoyn_busobject_getbusattachment alljoyn_busobject_getname alljoyn_busobject_getpath alljoyn_busobject_issecure alljoyn_busobject_methodreply_args alljoyn_busobject_methodreply_err alljoyn_busobject_methodreply_status alljoyn_busobject_setannounceflag alljoyn_busobject_signal alljoyn_credentials_clear alljoyn_credentials_create alljoyn_credentials_destroy alljoyn_credentials_getcertchain alljoyn_credentials_getexpiration alljoyn_credentials_getlogonentry alljoyn_credentials_getpassword alljoyn_credentials_getprivateKey alljoyn_credentials_getusername alljoyn_credentials_isset alljoyn_credentials_setcertchain alljoyn_credentials_setexpiration alljoyn_credentials_setlogonentry alljoyn_credentials_setpassword alljoyn_credentials_setprivatekey alljoyn_credentials_setusername alljoyn_getbuildinfo alljoyn_getnumericversion alljoyn_getversion alljoyn_init alljoyn_interfacedescription_activate alljoyn_interfacedescription_addannotation alljoyn_interfacedescription_addmember alljoyn_interfacedescription_addmemberannotation alljoyn_interfacedescription_addmethod alljoyn_interfacedescription_addproperty alljoyn_interfacedescription_addpropertyannotation alljoyn_interfacedescription_addsignal alljoyn_interfacedescription_eql alljoyn_interfacedescription_getannotation alljoyn_interfacedescription_getannotationatindex alljoyn_interfacedescription_getannotationscount alljoyn_interfacedescription_getmember alljoyn_interfacedescription_getmemberannotation alljoyn_interfacedescription_getmembers alljoyn_interfacedescription_getmethod alljoyn_interfacedescription_getname alljoyn_interfacedescription_getproperties alljoyn_interfacedescription_getproperty alljoyn_interfacedescription_getpropertyannotation alljoyn_interfacedescription_getsecuritypolicy alljoyn_interfacedescription_getsignal alljoyn_interfacedescription_hasmember alljoyn_interfacedescription_hasproperties alljoyn_interfacedescription_hasproperty alljoyn_interfacedescription_introspect alljoyn_interfacedescription_issecure alljoyn_interfacedescription_member_eql alljoyn_interfacedescription_member_getannotation alljoyn_interfacedescription_member_getannotationatindex alljoyn_interfacedescription_member_getannotationscount alljoyn_interfacedescription_property_eql alljoyn_interfacedescription_property_getannotation alljoyn_interfacedescription_property_getannotationatindex alljoyn_interfacedescription_property_getannotationscount alljoyn_keystorelistener_create alljoyn_keystorelistener_destroy alljoyn_keystorelistener_getkeys alljoyn_keystorelistener_putkeys alljoyn_message_create alljoyn_message_description alljoyn_message_destroy alljoyn_message_eql alljoyn_message_getarg alljoyn_message_getargs alljoyn_message_getauthmechanism alljoyn_message_getcallserial alljoyn_message_getcompressiontoken alljoyn_message_getdestination alljoyn_message_geterrorname alljoyn_message_getflags alljoyn_message_getinterface alljoyn_message_getmembername alljoyn_message_getobjectpath alljoyn_message_getreceiveendpointname alljoyn_message_getreplyserial alljoyn_message_getsender alljoyn_message_getsessionid alljoyn_message_getsignature alljoyn_message_gettimestamp alljoyn_message_gettype alljoyn_message_isbroadcastsignal alljoyn_message_isencrypted alljoyn_message_isexpired alljoyn_message_isglobalbroadcast alljoyn_message_issessionless alljoyn_message_isunreliable alljoyn_message_parseargs alljoyn_message_setendianess alljoyn_message_tostring alljoyn_msgarg_array_create alljoyn_msgarg_array_element alljoyn_msgarg_array_get alljoyn_msgarg_array_set alljoyn_msgarg_array_set_offset alljoyn_msgarg_array_signature alljoyn_msgarg_array_tostring alljoyn_msgarg_clear alljoyn_msgarg_clone alljoyn_msgarg_copy alljoyn_msgarg_create alljoyn_msgarg_create_and_set alljoyn_msgarg_destroy alljoyn_msgarg_equal alljoyn_msgarg_get alljoyn_msgarg_get_array_element alljoyn_msgarg_get_array_elementsignature alljoyn_msgarg_get_array_numberofelements alljoyn_msgarg_get_bool alljoyn_msgarg_get_bool_array alljoyn_msgarg_get_double alljoyn_msgarg_get_double_array alljoyn_msgarg_get_int16 alljoyn_msgarg_get_int16_array alljoyn_msgarg_get_int32 alljoyn_msgarg_get_int32_array alljoyn_msgarg_get_int64 alljoyn_msgarg_get_int64_array alljoyn_msgarg_get_objectpath alljoyn_msgarg_get_signature alljoyn_msgarg_get_string alljoyn_msgarg_get_uint16 alljoyn_msgarg_get_uint16_array alljoyn_msgarg_get_uint32 alljoyn_msgarg_get_uint32_array alljoyn_msgarg_get_uint64 alljoyn_msgarg_get_uint64_array alljoyn_msgarg_get_uint8 alljoyn_msgarg_get_uint8_array alljoyn_msgarg_get_variant alljoyn_msgarg_get_variant_array alljoyn_msgarg_getdictelement alljoyn_msgarg_getkey alljoyn_msgarg_getmember alljoyn_msgarg_getnummembers alljoyn_msgarg_gettype alljoyn_msgarg_getvalue alljoyn_msgarg_hassignature alljoyn_msgarg_set alljoyn_msgarg_set_and_stabilize alljoyn_msgarg_set_bool alljoyn_msgarg_set_bool_array alljoyn_msgarg_set_double alljoyn_msgarg_set_double_array alljoyn_msgarg_set_int16 alljoyn_msgarg_set_int16_array alljoyn_msgarg_set_int32 alljoyn_msgarg_set_int32_array alljoyn_msgarg_set_int64 alljoyn_msgarg_set_int64_array alljoyn_msgarg_set_objectpath alljoyn_msgarg_set_objectpath_array alljoyn_msgarg_set_signature alljoyn_msgarg_set_signature_array alljoyn_msgarg_set_string alljoyn_msgarg_set_string_array alljoyn_msgarg_set_uint16 alljoyn_msgarg_set_uint16_array alljoyn_msgarg_set_uint32 alljoyn_msgarg_set_uint32_array alljoyn_msgarg_set_uint64 alljoyn_msgarg_set_uint64_array alljoyn_msgarg_set_uint8 alljoyn_msgarg_set_uint8_array alljoyn_msgarg_setdictentry alljoyn_msgarg_setstruct alljoyn_msgarg_signature alljoyn_msgarg_stabilize alljoyn_msgarg_tostring alljoyn_observer_create alljoyn_observer_destroy alljoyn_observer_get alljoyn_observer_getfirst alljoyn_observer_getnext alljoyn_observer_registerlistener alljoyn_observer_unregisteralllisteners alljoyn_observer_unregisterlistener alljoyn_observerlistener_create alljoyn_observerlistener_destroy alljoyn_passwordmanager_setcredentials alljoyn_proxybusobject_addchild alljoyn_proxybusobject_addinterface alljoyn_proxybusobject_addinterface_by_name alljoyn_proxybusobject_copy alljoyn_proxybusobject_create alljoyn_proxybusobject_create_secure alljoyn_proxybusobject_destroy alljoyn_proxybusobject_enablepropertycaching alljoyn_proxybusobject_getallproperties alljoyn_proxybusobject_getallpropertiesasync alljoyn_proxybusobject_getchild alljoyn_proxybusobject_getchildren alljoyn_proxybusobject_getinterface alljoyn_proxybusobject_getinterfaces alljoyn_proxybusobject_getpath alljoyn_proxybusobject_getproperty alljoyn_proxybusobject_getpropertyasync alljoyn_proxybusobject_getservicename alljoyn_proxybusobject_getsessionid alljoyn_proxybusobject_getuniquename alljoyn_proxybusobject_implementsinterface alljoyn_proxybusobject_introspectremoteobject alljoyn_proxybusobject_introspectremoteobjectasync alljoyn_proxybusobject_issecure alljoyn_proxybusobject_isvalid alljoyn_proxybusobject_methodcall alljoyn_proxybusobject_methodcall_member alljoyn_proxybusobject_methodcall_member_noreply alljoyn_proxybusobject_methodcall_noreply alljoyn_proxybusobject_methodcallasync alljoyn_proxybusobject_methodcallasync_member alljoyn_proxybusobject_parsexml alljoyn_proxybusobject_ref_create alljoyn_proxybusobject_ref_decref alljoyn_proxybusobject_ref_get alljoyn_proxybusobject_ref_incref alljoyn_proxybusobject_registerpropertieschangedlistener alljoyn_proxybusobject_removechild alljoyn_proxybusobject_secureconnection alljoyn_proxybusobject_secureconnectionasync alljoyn_proxybusobject_setproperty alljoyn_proxybusobject_setpropertyasync alljoyn_proxybusobject_unregisterpropertieschangedlistener alljoyn_sessionlistener_create alljoyn_sessionlistener_destroy alljoyn_sessionopts_cmp alljoyn_sessionopts_create alljoyn_sessionopts_destroy alljoyn_sessionopts_get_multipoint alljoyn_sessionopts_get_proximity alljoyn_sessionopts_get_traffic alljoyn_sessionopts_get_transports alljoyn_sessionopts_iscompatible alljoyn_sessionopts_set_multipoint alljoyn_sessionopts_set_proximity alljoyn_sessionopts_set_traffic alljoyn_sessionopts_set_transports alljoyn_sessionportlistener_create alljoyn_sessionportlistener_destroy alljoyn_shutdown alljoyn_unity_deferred_callbacks_process alljoyn_unity_set_deferred_callback_mainthread_only alljoyn-15.04b/alljoyn_c/src/Windows/alljoyn_c.rc000066400000000000000000000065051255700255500220440ustar00rootroot00000000000000/** * @file * Resource file script for Windows AllJoyn C API DLL */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #ifndef DEBUG #define VER_DEBUG 0 #else #define VER_DEBUG VS_FF_DEBUG #endif /****************************************************************************** * Version ******************************************************************************/ #define VER_FILEVERSION 15,4,0,98 #define VER_FILEVERSION_STR "15.04.00b\0" #define VER_PRODUCTVERSION 15,4,0,98 #define VER_PRODUCTVERSION_STR "15.04.00b\0" #define VER_PRIVATEBUILD 0 #define VER_PRERELEASE 0 #define VER_COMPANYNAME_STR "AllSeen Alliance.\0" #define VER_FILEDESCRIPTION_STR "AllJoyn C API Library\0" #define VER_LEGALCOPYRIGHT_STR "Copyright AllSeen Alliance.\0" #define VER_INTERNALNAME_STR "alljoyn_c.dll\0" #define VER_ORIGINALFILENAME_STR "alljoyn_c.dll\0" #define VER_PRODUCTNAME_STR "alljoyn_c.dll\0" VS_VERSION_INFO VERSIONINFO FILEVERSION VER_FILEVERSION PRODUCTVERSION VER_PRODUCTVERSION FILEFLAGSMASK VS_FFI_FILEFLAGSMASK FILEFLAGS (VER_PRIVATEBUILD|VER_PRERELEASE|VER_DEBUG) FILEOS VOS__WINDOWS32 FILETYPE VFT_DLL FILESUBTYPE VFT2_UNKNOWN BEGIN BLOCK "StringFileInfo" BEGIN BLOCK "040904E4" BEGIN VALUE "CompanyName", VER_COMPANYNAME_STR VALUE "FileDescription", VER_FILEDESCRIPTION_STR VALUE "FileVersion", VER_FILEVERSION_STR VALUE "InternalName", VER_INTERNALNAME_STR VALUE "LegalCopyright", VER_LEGALCOPYRIGHT_STR VALUE "OriginalFilename", VER_ORIGINALFILENAME_STR VALUE "ProductName", VER_PRODUCTNAME_STR VALUE "ProductVersion", VER_PRODUCTVERSION_STR END END BLOCK "VarFileInfo" BEGIN /* The following line should only be modified for localized versions. */ /* It consists of any number of WORD,WORD pairs, with each pair */ /* describing a language,codepage combination supported by the file. */ /* */ /* For example, a file might have values "0x409,1252" indicating that it */ /* supports English language (0x409) in the Windows ANSI codepage (1252). */ VALUE "Translation", 0x409, 1252 END END alljoyn-15.04b/alljoyn_c/src/version.cc000066400000000000000000000030171255700255500201010ustar00rootroot00000000000000/** * @file * This file provides access to Alljoyn library version and build information. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #define QCC_MODULE "ALLJOYN_C" const char* AJ_CALL alljoyn_getversion() { QCC_DbgTrace(("%s", __FUNCTION__)); return ajn::GetVersion(); } const char* AJ_CALL alljoyn_getbuildinfo() { QCC_DbgTrace(("%s", __FUNCTION__)); return ajn::GetBuildInfo(); } uint32_t AJ_CALL alljoyn_getnumericversion() { QCC_DbgTrace(("%s", __FUNCTION__)); return ajn::GetNumericVersion(); } alljoyn-15.04b/alljoyn_c/test/000077500000000000000000000000001255700255500162745ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_c/test/SConscript000066400000000000000000000024641255700255500203140ustar00rootroot00000000000000# Copyright AllSeen Alliance. All rights reserved. # # Permission to use, copy, modify, and/or distribute this software for any # purpose with or without fee is hereby granted, provided that the above # copyright notice and this permission notice appear in all copies. # # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. # Import('env') test_env = env.Clone() if test_env['BR'] == 'on': #Build apps with bundled daemon support test_env.Prepend(LIBS = [test_env['ajrlib']]) test_env.Prepend(LIBS = [test_env['ALLJOYN_C_LIB_STATIC']]) test_programs = ['bbcclient', 'bbcservice'] built_test_programs = [] for test_p in test_programs: test_obj = test_env.Object(test_p) built_test_programs.append(test_env.Program(test_p, [test_obj])) if test_env['OS_GROUP'] != 'windows': test_env.Install('$C_DISTDIR/bin', built_test_programs) alljoyn-15.04b/alljoyn_c/test/bbcclient.c000066400000000000000000000734351255700255500204010ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _WIN32 #define _BSD_SOURCE /* usleep */ #endif #include #include #include #include #include #include #ifndef _WIN32 #include #endif #include #include #include #include #include /*constants*/ static const char* INTERFACE_NAME = "org.alljoyn.alljoyn_test"; static const char* INTERFACE_VALUE_NAME = "org.alljoyn.alljoyn_test.values"; static const char* DEFAULT_WELLKNOWN_NAME = "org.alljoyn.alljoyn_test"; static const char* OBJECT_PATH = "/org/alljoyn/alljoyn_test"; static alljoyn_sessionport SESSION_PORT = 24; /* Static top level globals */ static alljoyn_busattachment g_msgBus = NULL; static alljoyn_sessionlistener g_sessionListener = NULL; static char* g_wellKnownName = NULL; //TODO - use ALLJOYN_TRANSPORT_ANY //static alljoyn_transportmask g_allowed_transport = (alljoyn_transport_mask)ALLJOYN_TRANSPORT_ANY; static alljoyn_transportmask g_allowed_transport = 65535; static uint32_t g_keyExpiration = 0xFFFFFFFF; static uint8_t g_maxAuth = 3; static QCC_BOOL g_stopDiscover = QCC_FALSE; static QCC_BOOL g_discovered = QCC_FALSE; static volatile sig_atomic_t g_interrupt = QCC_FALSE; static void CDECL_CALL SigIntHandler(int sig) { g_interrupt = QCC_TRUE; } void AJ_CALL found_advertised_name(const void* context, const char* name, alljoyn_transportmask transport, const char* namePrefix) { alljoyn_sessionopts session_opts; QStatus status = ER_OK; alljoyn_sessionid sessionid = 0; printf("FoundAdvertisedName(name=%s, transport=0x%x, prefix=%s)\n", name, transport, namePrefix); if (0 == (transport & g_allowed_transport)) { printf("Ignoring FoundAdvertised name from transport 0x%x\n", transport); return; } g_discovered = QCC_TRUE; /* Enable concurrent callbacks. */ alljoyn_busattachment_enableconcurrentcallbacks(g_msgBus); if (0 == strcmp(name, g_wellKnownName)) { /* We found a remote bus that is advertising bbservice's well-known name so connect to it */ session_opts = alljoyn_sessionopts_create(ALLJOYN_TRAFFIC_TYPE_MESSAGES, QCC_FALSE, ALLJOYN_PROXIMITY_ANY, transport); if (g_stopDiscover) { alljoyn_busattachment_canceladvertisename(g_msgBus, g_wellKnownName, transport); if (status != ER_OK) { printf("CancelAdvertiseName(%s) failed with %s", g_wellKnownName, QCC_StatusText(status)); } } status = alljoyn_busattachment_joinsession(g_msgBus, name, SESSION_PORT, g_sessionListener, &sessionid, session_opts); if (ER_OK != status) { printf("JoinSession(%s) failed because of %s", name, QCC_StatusText(status)); } else { /* set the session id in context. */ *((alljoyn_sessionid*)context) = sessionid; } //destroy session opts alljoyn_sessionopts_destroy(session_opts); } } void AJ_CALL lost_advertised_name(const void* context, const char* name, alljoyn_transportmask transport, const char* namePrefix) { printf("LostAdvertisedName(name=%s, transport=0x%x, prefix=%s)\n", name, transport, namePrefix); } void AJ_CALL name_owner_changed(const void* context, const char* name, const char* previousOwner, const char* newOwner) { printf("NameOwnerChanged(%s, %s, %s)\n", name, (previousOwner ? previousOwner : "null"), (newOwner ? newOwner : "null")); } void AJ_CALL session_lost(const void* context, alljoyn_sessionid sessionId, alljoyn_sessionlostreason reason) { printf("SessionLost(%u) was called\n", sessionId); _exit(1); } static void usage(void) { printf("Usage: bbcclient [-h] [-c ] [-i] [-e] [-r #] [-l | -la | -d[s]] [-n ] [-t[a] [] | -rt]\n\n"); printf("Options:\n"); printf(" -h = Print this help message\n"); printf(" -k = The key store file name\n"); printf(" -c = Number of pings to send to the server\n"); printf(" -i = Use introspection to discover remote interfaces\n"); printf(" -e[k] [SRP|LOGON] = Encrypt the test interface using specified auth mechanism, -ek means clear keys\n"); printf(" -a # = Max authentication attempts\n"); printf(" -kx # = Authentication key expiration (seconds)\n"); printf(" -r # = AllJoyn attachment restart count\n"); printf(" -l = launch bbservice if not already running\n"); printf(" -n = Well-known bus name advertised by bbservice\n"); printf(" -d = discover remote bus with test service\n"); printf(" -ds = discover remote bus with test service and cancel discover when found\n"); printf(" -t = Call delayed_ping with and repeat at if -c given\n"); printf(" -ta = Like -t except calls asynchronously\n"); printf(" -rt [run time] = Round trip timer (optional run time in ms)\n"); printf(" -w = Don't wait for service\n"); printf(" -s = Wait for SIGINT (Control-C) at the end of the tests\n"); printf(" -be = Send messages as big endian\n"); printf(" -le = Send messages as little endian\n"); printf(" -m = Transports allowed to connect to service\n"); printf("\n"); } QCC_BOOL AJ_CALL request_credentials(const void* context, const char* authMechanism, const char* authPeer, uint16_t authCount, const char* userId, uint16_t credMask, alljoyn_credentials credentials) { char guid[100]; size_t size_of_guid = 100; if (authCount > g_maxAuth) { return QCC_FALSE; } /* fetch the user id from the context. */ if (context) { userId = (char*)context; } printf("RequestCredentials for authenticating %s using mechanism %s\n", authPeer, authMechanism); alljoyn_busattachment_getpeerguid(g_msgBus, authPeer, guid, &size_of_guid); printf("Peer guid %s %zu\n", guid, size_of_guid); if (g_keyExpiration != 0xFFFFFFFF) { alljoyn_busattachment_setkeyexpiration(g_msgBus, guid, g_keyExpiration); } if (strcmp(authMechanism, "ALLJOYN_SRP_KEYX") == 0) { if (credMask & ALLJOYN_CRED_PASSWORD) { if (authCount == 3) { alljoyn_credentials_setpassword(credentials, "123456"); } else { alljoyn_credentials_setpassword(credentials, "yyyyyy"); } printf("AuthListener returning fixed pin \"%s\" for %s\n", alljoyn_credentials_getpassword(credentials), authMechanism); } return QCC_TRUE; } if (strcmp(authMechanism, "ALLJOYN_SRP_LOGON") == 0) { if (credMask & ALLJOYN_CRED_USER_NAME) { if (authCount == 1) { alljoyn_credentials_setusername(credentials, "Mr Bogus"); } else { alljoyn_credentials_setusername(credentials, userId); } } if (credMask & ALLJOYN_CRED_PASSWORD) { alljoyn_credentials_setpassword(credentials, "123456"); } return QCC_TRUE; } return QCC_FALSE; } QCC_BOOL AJ_CALL verify_credentials(const void*context, const char* authMechanism, const char* authPeer, const alljoyn_credentials credentials) { /* Not used with the SRP auth mechanisms. */ return QCC_FALSE; } void AJ_CALL authentication_complete(const void*context, const char* authMechanism, const char* authPeer, QCC_BOOL success) { printf("Authentication %s %s\n", authMechanism, success ? "succesful" : "failed"); } void AJ_CALL security_violation(const void*context, QStatus status, const alljoyn_message msg) { printf("Security violation %s\n", QCC_StatusText(status)); } void AJ_CALL ping_response_handler(alljoyn_message message, void* context) { alljoyn_messagetype msg_type; const char* ret_string; char* interface_name = (char*)context; msg_type = alljoyn_message_gettype(message); if (ALLJOYN_MESSAGE_METHOD_RET == msg_type) { alljoyn_msgarg msg_arg = alljoyn_message_getarg(message, 0); alljoyn_msgarg_get(msg_arg, "s", &ret_string); printf("%s.%s returned \"%s\"\n", g_wellKnownName, interface_name, ret_string); } else { //ERROR char errormessage[100]; size_t size = 100; ret_string = alljoyn_message_geterrorname(message, errormessage, &size); printf("%s.%s returned error %s: %s\n", g_wellKnownName, interface_name, (ret_string != NULL) ? ret_string : "NULL", errormessage); } } int CDECL_CALL main(int argc, char** argv) { QStatus status = ER_OK; QCC_BOOL useIntrospection = QCC_FALSE; QCC_BOOL encryptIfc = QCC_FALSE; QCC_BOOL clearKeys = QCC_FALSE; char authMechs[100] = ""; char*userId = NULL; const char* keyStore = NULL; unsigned long pingCount = 1; unsigned long repCount = 1; uint64_t runTime = 0; QCC_BOOL discoverRemote = QCC_FALSE; QCC_BOOL asyncPing = QCC_FALSE; uint32_t pingDelay = 0; uint32_t pingInterval = 0; QCC_BOOL waitForSigint = QCC_FALSE; QCC_BOOL roundtrip = QCC_FALSE; QCC_BOOL hasOwner = QCC_FALSE; alljoyn_sessionid sessionid = 0; alljoyn_interfacedescription intf = NULL; alljoyn_interfacedescription valIntf = NULL; alljoyn_buslistener busListener = NULL; alljoyn_authlistener authListener = NULL; alljoyn_proxybusobject remoteObj = NULL; int i = 0; unsigned long j = 0; QCC_BOOL ok = QCC_FALSE; alljoyn_buslistener_callbacks bl_cbs = { NULL, NULL, &found_advertised_name, &lost_advertised_name, &name_owner_changed, NULL, NULL, NULL }; alljoyn_sessionlistener_callbacks sl_cbs = { &session_lost, NULL, NULL }; /* Auth listener callbacks. */ alljoyn_authlistener_callbacks authcbs = { &request_credentials, &verify_credentials, &security_violation, &authentication_complete }; size_t cnt = 0; if (alljoyn_init() != ER_OK) { return 1; } #ifdef ROUTER if (alljoyn_routerinit() != ER_OK) { alljoyn_shutdown(); return 1; } #endif printf("AllJoyn Library version: %s\n", alljoyn_getversion()); printf("AllJoyn Library build info: %s\n", alljoyn_getbuildinfo()); /* Install SIGINT handler */ signal(SIGINT, SigIntHandler); g_wellKnownName = (char*)DEFAULT_WELLKNOWN_NAME; /* Parse command line args */ for (i = 1; i < argc; ++i) { if (0 == strcmp("-i", argv[i])) { useIntrospection = QCC_TRUE; } else if (0 == strcmp("-le", argv[i])) { alljoyn_message_setendianess(ALLJOYN_LITTLE_ENDIAN); } else if (0 == strcmp("-be", argv[i])) { alljoyn_message_setendianess(ALLJOYN_BIG_ENDIAN); } else if (0 == strcmp("-m", argv[i])) { ++i; g_allowed_transport = strtoul(argv[i], NULL, 10); if (g_allowed_transport == 0) { printf("Invalid value \"%s\" for option -m\n", argv[i]); usage(); exit(1); } } else if ((0 == strcmp("-e", argv[i])) || (0 == strcmp("-ek", argv[i]))) { if (strcmp(authMechs, "") != 0) { strcat(authMechs, " "); } encryptIfc = QCC_TRUE; clearKeys |= (argv[i][2] == 'k'); ++i; if (i != argc) { if (strcmp(argv[i], "SRP") == 0) { strcat(authMechs, "ALLJOYN_SRP_KEYX"); ok = QCC_TRUE; } else if (strcmp(argv[i], "LOGON") == 0) { if (++i == argc) { printf("option %s LOGON requires a user id\n", argv[i - 2]); usage(); exit(1); } strcat(authMechs, "ALLJOYN_SRP_LOGON"); userId = argv[i]; ok = QCC_TRUE; } } if (!ok) { printf("option %s requires an auth mechanism \n", argv[i - 1]); usage(); exit(1); } } else if (0 == strcmp("-k", argv[i])) { ++i; if (i == argc) { printf("option %s requires a parameter\n", argv[i - 1]); usage(); exit(1); } else { keyStore = argv[i]; } } else if (0 == strcmp("-kx", argv[i])) { ++i; if (i == argc) { printf("option %s requires a parameter\n", argv[i - 1]); usage(); exit(1); } else { g_keyExpiration = strtoul(argv[i], NULL, 10); } } else if (0 == strcmp("-a", argv[i])) { ++i; if (i == argc) { printf("option %s requires a parameter\n", argv[i - 1]); usage(); exit(1); } else { g_maxAuth = strtoul(argv[i], NULL, 10); } } else if (0 == strcmp("-c", argv[i])) { ++i; if (i == argc) { printf("option %s requires a parameter\n", argv[i - 1]); usage(); exit(1); } else { pingCount = strtoul(argv[i], NULL, 10); } } else if (0 == strcmp("-r", argv[i])) { ++i; if (i == argc) { printf("option %s requires a parameter\n", argv[i - 1]); usage(); exit(1); } else { repCount = strtoul(argv[i], NULL, 10); } } else if (0 == strcmp("-n", argv[i])) { ++i; if (i == argc) { printf("option %s requires a parameter\n", argv[i - 1]); usage(); exit(1); } else { g_wellKnownName = argv[i]; } } else if (0 == strcmp("-h", argv[i])) { usage(); exit(0); } else if (0 == strcmp("-d", argv[i])) { discoverRemote = QCC_TRUE; } else if (0 == strcmp("-ds", argv[i])) { discoverRemote = QCC_TRUE; g_stopDiscover = QCC_TRUE; } else if ((0 == strcmp("-t", argv[i])) || (0 == strcmp("-ta", argv[i]))) { if (argv[i][2] == 'a') { asyncPing = QCC_TRUE; } ++i; if (i == argc) { printf("option %s requires a parameter\n", argv[i - 1]); usage(); exit(1); } else { pingDelay = strtoul(argv[i], NULL, 10); ++i; if ((i == argc) || (argv[i][0] == '-')) { --i; } else { pingInterval = strtoul(argv[i], NULL, 10); } } } else if (0 == strcmp("-rt", argv[i])) { roundtrip = QCC_TRUE; if ((argc > (i + 1)) && argv[i + 1][0] != '-') { runTime = strtoul(argv[i], NULL, 10); pingCount = 1; ++i; } else if (pingCount == 1) { pingCount = 1000; } } else if (0 == strcmp("-s", argv[i])) { waitForSigint = QCC_TRUE; } else { status = ER_FAIL; printf("Unknown option %s\n", argv[i]); usage(); exit(1); } } for (j = 0; j < repCount && !g_interrupt; j++) { unsigned long pings; if (runTime > 0) { pings = 1; pingCount = 0; } else { pings = pingCount; } //Create bus attachment g_msgBus = alljoyn_busattachment_create("bbcclient", QCC_TRUE); //If not using introspection, add the interfaces manually to the bus. if (!useIntrospection) { /* Add org.alljoyn.alljoyn_test interface */ status = alljoyn_busattachment_createinterface_secure(g_msgBus, INTERFACE_NAME, &intf, (encryptIfc) ? AJ_IFC_SECURITY_REQUIRED : AJ_IFC_SECURITY_INHERIT); if (status != ER_OK) { printf("Could not create %s interface because of %s. \n", INTERFACE_NAME, QCC_StatusText(status)); return status; } status = alljoyn_busattachment_createinterface_secure(g_msgBus, INTERFACE_VALUE_NAME, &valIntf, (encryptIfc) ? AJ_IFC_SECURITY_REQUIRED : AJ_IFC_SECURITY_INHERIT); if (status != ER_OK) { printf("Could not create %s interface because of %s. \n", INTERFACE_VALUE_NAME, QCC_StatusText(status)); return status; } status = alljoyn_interfacedescription_addmethod(intf, "my_ping", "s", "s", "i,i", 0, NULL); if (status != ER_OK) { printf("Could not add method %s to interface %s because of %s. \n", "my_ping", INTERFACE_NAME, QCC_StatusText(status)); return status; } status = alljoyn_interfacedescription_addmember(intf, ALLJOYN_MESSAGE_SIGNAL, "my_signal", "a{ys}", NULL, "inStr", 0); if (status != ER_OK) { printf("Could not add signal %s to interface %s because of %s. \n", "my_signal", INTERFACE_NAME, QCC_StatusText(status)); return status; } status = alljoyn_interfacedescription_addmethod(intf, "delayed_ping", "su", "s", "ii,i", 0, NULL); if (status != ER_OK) { printf("Could not add method %s to interface %s because of %s. \n", "delayed_ping", INTERFACE_NAME, QCC_StatusText(status)); return status; } status = alljoyn_interfacedescription_addmethod(intf, "time_ping", "uq", "uq", "i,i", 0, NULL); if (status != ER_OK) { printf("Could not add method %s to interface %s because of %s. \n", "time_ping", INTERFACE_NAME, QCC_StatusText(status)); return status; } alljoyn_interfacedescription_activate(intf); /*Activate org.alljoyn.alljoyn_test.values */ status = alljoyn_interfacedescription_addproperty(valIntf, "int_val", "i", ALLJOYN_PROP_ACCESS_WRITE); if (status != ER_OK) { printf("Could not add property %s to interface %s because of %s. \n", "int_val", INTERFACE_VALUE_NAME, QCC_StatusText(status)); return status; } status = alljoyn_interfacedescription_addproperty(valIntf, "str_val", "s", ALLJOYN_PROP_ACCESS_RW); if (status != ER_OK) { printf("Could not add method %s to interface %s because of %s. \n", "str_val", INTERFACE_VALUE_NAME, QCC_StatusText(status)); return status; } status = alljoyn_interfacedescription_addproperty(valIntf, "ro_str", "s", ALLJOYN_PROP_ACCESS_READ); if (status != ER_OK) { printf("Could not add method %s to interface %s because of %s. \n", "ro_str", INTERFACE_VALUE_NAME, QCC_StatusText(status)); return status; } alljoyn_interfacedescription_activate(valIntf); } /* Register the bus listener. */ /* TODO - Add other callbacks. */ busListener = alljoyn_buslistener_create(&bl_cbs, &sessionid); alljoyn_busattachment_registerbuslistener(g_msgBus, busListener); g_sessionListener = alljoyn_sessionlistener_create(&sl_cbs, NULL); //Start the bus status = alljoyn_busattachment_start(g_msgBus); if (status != ER_OK) { printf("Could not start the bus because of %s. \n", QCC_StatusText(status)); return status; } //Connect to the bus TODO - change the connect spec status = alljoyn_busattachment_connect(g_msgBus, "null:"); if (status != ER_OK) { printf("Could not connect to the bus because of %s. \n", QCC_StatusText(status)); return status; } if (encryptIfc) { authListener = alljoyn_authlistener_create(&authcbs, userId); status = alljoyn_busattachment_enablepeersecurity(g_msgBus, authMechs, authListener, keyStore, keyStore != NULL); if (ER_OK != status) { printf("enablePeerSecurity failed (%s)\n", QCC_StatusText(status)); return status; } if (clearKeys) { alljoyn_busattachment_clearkeystore(g_msgBus); } } /* Discovery. */ if (discoverRemote) { status = alljoyn_busattachment_findadvertisedname(g_msgBus, g_wellKnownName); if (status != ER_OK) { printf("FindAdvertisedName (%s) failed due to %s", g_wellKnownName, QCC_StatusText(status)); return status; } } if (discoverRemote) { /* Wait till you discover something. */ while (!g_interrupt && !g_discovered) { #ifdef _WIN32 Sleep(100); #else usleep(100 * 1000); #endif } } /* Joinsession is called in FoundAdvertised Name. You need to block till the wkn of service appears on the bus. */ while (!g_interrupt && !hasOwner) { #ifdef _WIN32 Sleep(100); #else usleep(100 * 1000); #endif alljoyn_busattachment_namehasowner(g_msgBus, g_wellKnownName, &hasOwner); } /* Create ProxyBusObject. */ remoteObj = alljoyn_proxybusobject_create(g_msgBus, g_wellKnownName, OBJECT_PATH, sessionid); if (useIntrospection) { status = alljoyn_proxybusobject_introspectremoteobject(remoteObj); if (ER_OK != status) { printf("Introspection of %s (path=%s), (session=%u) failed due to %s. \n", g_wellKnownName, OBJECT_PATH, sessionid, QCC_StatusText(status)); } } else { /* Manually add the interfaces to the proxyBusObject.*/ alljoyn_interfacedescription intf = NULL; alljoyn_interfacedescription valintf = NULL; intf = alljoyn_busattachment_getinterface(g_msgBus, INTERFACE_NAME); valintf = alljoyn_busattachment_getinterface(g_msgBus, INTERFACE_VALUE_NAME); alljoyn_proxybusobject_addinterface(remoteObj, intf); alljoyn_proxybusobject_addinterface(remoteObj, valintf); } /* Call the remote method */ while ((ER_OK == status) && pings--) { alljoyn_message reply = alljoyn_message_create(g_msgBus); alljoyn_msgarg pingArgs = alljoyn_msgarg_array_create(2); size_t numArgs = 2; char buf[80]; if (roundtrip) { //TODO - Implement later. Get time of day. } else { snprintf(buf, 80, "Ping String %u", (unsigned int)(++cnt)); status = alljoyn_msgarg_array_set(pingArgs, &numArgs, "su", buf, pingDelay); if (status != ER_OK) { printf("Could not set arguments because of %s. \n", QCC_StatusText(status)); } } if (status == ER_OK) { /* Make a method call. */ if (!roundtrip && asyncPing) { printf("Sending \"%s\" to %s.%s asynchronously\n", buf, INTERFACE_NAME, ((pingDelay == 0) ? "my_ping" : "delayed_ping")); status = alljoyn_proxybusobject_methodcallasync(remoteObj, INTERFACE_NAME, ((pingDelay == 0) ? "my_ping" : "delayed_ping"), &ping_response_handler, pingArgs, (pingDelay > 0) ? 2 : 1, ((pingDelay == 0) ? "my_ping" : "delayed_ping"), pingDelay + 50000, 0); if (status != ER_OK) { printf("MethodCallAsync on %s.%s failed because of %s", INTERFACE_NAME, ((pingDelay == 0) ? "my_ping" : "delayed_ping"), QCC_StatusText(status)); } } else { if (!roundtrip) { printf("Sending \"%s\" to %s.%s synchronously\n", buf, INTERFACE_NAME, ((pingDelay == 0) ? "my_ping" : "delayed_ping")); } status = alljoyn_proxybusobject_methodcall(remoteObj, INTERFACE_NAME, ((pingDelay == 0) ? "my_ping" : "delayed_ping"), pingArgs, (pingDelay > 0) ? 2 : 1, reply, pingDelay + 5000, 0); if (ER_OK == status) { if (roundtrip) { printf("Round trip not implemented. \n"); } else { char*value = NULL; status = alljoyn_msgarg_get(alljoyn_message_getarg(reply, 0), "s", &value); if (pingDelay == 0) { printf("%s.%s ( path=%s ) returned \"%s\"\n", g_wellKnownName, ((pingDelay == 0) ? "my_ping" : "delayed_ping"), OBJECT_PATH, value); } else { printf("%s.%s ( path=%s ) returned \"%s\"\n", g_wellKnownName, "delayed_ping", OBJECT_PATH, value); } } } else if (status == ER_BUS_REPLY_IS_ERROR_MESSAGE) { char errorMessage[100]; size_t size = 100; const char* errName = alljoyn_message_geterrorname(reply, errorMessage, &size); printf("MethodCall on %s.%s reply was error %s %s\n", INTERFACE_NAME, ((pingDelay == 0) ? "my_ping" : "delayed_ping"), (errName != NULL) ? errName : "NULL", errorMessage); status = ER_OK; } else { printf("MethodCall on %s.%s failed due to %s. \n", INTERFACE_NAME, ((pingDelay == 0) ? "my_ping" : "delayed_ping"), QCC_StatusText(status)); } } if (pingInterval > 0) { //TODO - Add sleep } alljoyn_message_destroy(reply); alljoyn_msgarg_destroy(pingArgs); } else { alljoyn_message_destroy(reply); alljoyn_msgarg_destroy(pingArgs); break; } } if (roundtrip) { printf("No round trip data. To be implemented later. \n"); } /* Get the test property */ if (!roundtrip && (ER_OK == status)) { alljoyn_msgarg arg = alljoyn_msgarg_create(); status = alljoyn_proxybusobject_getproperty(remoteObj, INTERFACE_VALUE_NAME, "int_val", arg); if (ER_OK == status) { int iVal = 0; status = alljoyn_msgarg_get(arg, "i", &iVal); if (status != ER_OK) { printf("Could not get arg from getproperty because of %s. \n", QCC_StatusText(status)); } else { printf("%s.%s ( path=%s) returned \"%d\"\n", g_wellKnownName, "GetProperty", OBJECT_PATH, iVal); } } else { printf("GetProperty on %s failed because of %s. \n", g_wellKnownName, QCC_StatusText(status)); } //destroy msgarg alljoyn_msgarg_destroy(arg); } //Wait for Ctrl-C if (status == ER_OK && waitForSigint) { while (g_interrupt == QCC_FALSE) { #ifdef _WIN32 Sleep(100); #else usleep(100 * 1000); #endif } } alljoyn_busattachment_unregisterbuslistener(g_msgBus, busListener); /* Delete all the creations. Destroy busattachment at last.*/ if (remoteObj) { alljoyn_proxybusobject_destroy(remoteObj); } if (g_msgBus) { alljoyn_busattachment_destroy(g_msgBus); } if (busListener) { alljoyn_buslistener_destroy(busListener); } if (authListener) { alljoyn_authlistener_destroy(authListener); } if (g_sessionListener) { alljoyn_sessionlistener_destroy(g_sessionListener); } /* Break out of the inner for loop. */ if (status != ER_OK) { break; } } printf("bbcclient exiting with status %d (%s)\n", status, QCC_StatusText(status)); #ifdef ROUTER alljoyn_routershutdown(); #endif alljoyn_shutdown(); return (int) status; } alljoyn-15.04b/alljoyn_c/test/bbcservice.c000066400000000000000000000763421255700255500205630ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _WIN32 #define _BSD_SOURCE /* usleep */ #endif #include #include #include #include #include #include #include #include #include #include #include /*constants*/ static const char* INTERFACE_NAME = "org.alljoyn.alljoyn_test"; static const char* INTERFACE_VALUE_NAME = "org.alljoyn.alljoyn_test.values"; static const char* DEFAULT_WELLKNOWN_NAME = "org.alljoyn.alljoyn_test"; static const char* OBJECT_PATH = "/org/alljoyn/alljoyn_test"; static alljoyn_sessionport SESSION_PORT = 24; static char* g_prop_str_val = "hello world"; static const char* g_prop_ro_str = "I cannot be written"; static int g_prop_int_val = 100; /* Static top level globals */ static alljoyn_busattachment g_msgBus = NULL; static alljoyn_sessionlistener g_sessionListener = NULL; static alljoyn_sessionportlistener g_sessionPortListener = NULL; static alljoyn_busobject g_testObj = NULL; static alljoyn_sessionopts g_sessionOpts = NULL; static char* g_wellKnownName = NULL;; static QCC_BOOL g_echo_signal = QCC_FALSE; static uint32_t g_keyExpiration = 0xFFFFFFFF; static QCC_BOOL g_cancelAdvertise = QCC_FALSE; static QCC_BOOL g_ping_back = QCC_FALSE; static uint32_t g_reportInterval = 1000; static volatile sig_atomic_t g_interrupt = QCC_FALSE; static void CDECL_CALL SigIntHandler(int sig) { g_interrupt = QCC_TRUE; } QStatus AJ_CALL request_credentials_async(const void* context, alljoyn_authlistener listener, const char* authMechanism, const char* authPeer, uint16_t authCount, const char* userId, uint16_t credMask, void* authContext) { char guid[100]; size_t size_of_guid = 100; alljoyn_credentials creds; QStatus status = ER_OK; creds = alljoyn_credentials_create(); printf("RequestCredentials for authenticating %s using mechanism %s\n", authPeer, authMechanism); /* Random delay TODO*/ alljoyn_busattachment_getpeerguid(g_msgBus, authPeer, guid, &size_of_guid); printf("Peer guid %s %zu\n", guid, size_of_guid); if (g_keyExpiration != 0xFFFFFFFF) { alljoyn_busattachment_setkeyexpiration(g_msgBus, guid, g_keyExpiration); } if (strcmp(authMechanism, "ALLJOYN_SRP_KEYX") == 0) { if (credMask & ALLJOYN_CRED_PASSWORD) { if (authCount == 1) { alljoyn_credentials_setpassword(creds, "yyyyyy"); } else { alljoyn_credentials_setpassword(creds, "123456"); } printf("AuthListener returning fixed pin \"%s\" for %s\n", alljoyn_credentials_getpassword(creds), authMechanism); } status = alljoyn_authlistener_requestcredentialsresponse(listener, authContext, QCC_TRUE, creds); alljoyn_credentials_destroy(creds); return status; } if (strcmp(authMechanism, "ALLJOYN_SRP_LOGON") == 0) { if (!userId) { status = alljoyn_authlistener_requestcredentialsresponse(listener, authContext, QCC_FALSE, creds); alljoyn_credentials_destroy(creds); return status; } printf("Attempting to logon user %s\n", userId); if (strcmp(userId, "happy") == 0) { if (credMask & ALLJOYN_CRED_PASSWORD) { alljoyn_credentials_setpassword(creds, "123456"); status = alljoyn_authlistener_requestcredentialsresponse(listener, authContext, QCC_TRUE, creds); alljoyn_credentials_destroy(creds); return status; } } if (strcmp(userId, "sneezy") == 0) { if (credMask & ALLJOYN_CRED_PASSWORD) { alljoyn_credentials_setpassword(creds, "123456"); status = alljoyn_authlistener_requestcredentialsresponse(listener, authContext, QCC_TRUE, creds); alljoyn_credentials_destroy(creds); return status; } } /* * Allow 3 logon attempts. */ if (authCount <= 3) { status = alljoyn_authlistener_requestcredentialsresponse(listener, authContext, QCC_TRUE, creds); alljoyn_credentials_destroy(creds); return status; } } status = alljoyn_authlistener_requestcredentialsresponse(listener, authContext, QCC_FALSE, creds); alljoyn_credentials_destroy(creds); return status; } QStatus AJ_CALL verify_credentials_async(const void*context, alljoyn_authlistener listener, const char* authMechanism, const char* authPeer, const alljoyn_credentials creds, void*authContext) { QStatus status = ER_OK; status = alljoyn_authlistener_verifycredentialsresponse(listener, authContext, QCC_FALSE); return status; } void AJ_CALL authentication_complete(const void*context, const char* authMechanism, const char* authPeer, QCC_BOOL success) { printf("Authentication %s %s\n", authMechanism, success ? "succesful" : "failed"); } void AJ_CALL security_violation(const void*context, QStatus status, const alljoyn_message msg) { printf("Security violation %s\n", QCC_StatusText(status)); } QCC_BOOL AJ_CALL accept_session_joiner(const void* context, alljoyn_sessionport sessionPort, const char* joiner, const alljoyn_sessionopts opts) { if (sessionPort != SESSION_PORT) { printf("Received JoinSession request for non-bound port. \n"); return QCC_FALSE; } if (alljoyn_sessionopts_iscompatible(opts, g_sessionOpts)) { printf("Accepting JoinSession request from %s\n", joiner); return QCC_TRUE; } else { /* Reject incompatible transports */ printf("Rejecting joiner %s with incompatible session options\n", joiner); return QCC_TRUE; } } void AJ_CALL session_joined(const void* context, alljoyn_sessionport sessionPort, alljoyn_sessionid sessionId, const char* joiner) { uint32_t timeout = 10; QStatus status = ER_OK; printf("Session Established: joiner=%s, sessionId=%08x\n", joiner, sessionId); /* Enable concurrent callbacks since some of the calls below could block */ alljoyn_busattachment_enableconcurrentcallbacks(g_msgBus); status = alljoyn_busattachment_setsessionlistener(g_msgBus, sessionId, g_sessionListener); if (status != ER_OK) { printf("SetSessionListener failed with %s \n", QCC_StatusText(status)); return; } /* Set the link timeout */ status = alljoyn_busattachment_setlinktimeout(g_msgBus, sessionId, &timeout); if (status == ER_OK) { printf("Link timeout was successfully set to %d\n", timeout); } else { printf("SetLinkTimeout failed with %s \n", QCC_StatusText(status)); } /* cancel advertisment */ if (g_cancelAdvertise) { alljoyn_busattachment_canceladvertisename(g_msgBus, g_wellKnownName, alljoyn_sessionopts_get_transports(g_sessionOpts)); if (status != ER_OK) { printf("CancelAdvertiseName(%s) failed with %s", g_wellKnownName, QCC_StatusText(status)); } } } void AJ_CALL session_lost(const void* context, alljoyn_sessionid sessionId, alljoyn_sessionlostreason reason) { QStatus status = ER_OK; printf("SessionLost(%08x) was called\n", sessionId); /* Enable concurrent callbacks since some of the calls below could block */ alljoyn_busattachment_enableconcurrentcallbacks(g_msgBus); /* cancel advertisment */ if (g_cancelAdvertise) { alljoyn_busattachment_canceladvertisename(g_msgBus, g_wellKnownName, alljoyn_sessionopts_get_transports(g_sessionOpts)); if (status != ER_OK) { printf("CancelAdvertiseName(%s) failed with %s", g_wellKnownName, QCC_StatusText(status)); } } } void AJ_CALL ping(alljoyn_busobject busobject, const alljoyn_interfacedescription_member* member, alljoyn_message msg) { QStatus status = ER_OK; char*value = NULL; alljoyn_msgarg outArg; status = alljoyn_msgarg_get(alljoyn_message_getarg(msg, 0), "s", &value); if (ER_OK != status) { printf("Ping: Error reading alljoyn_message %s\n", QCC_StatusText(status)); } else { printf("Pinged with: %s\n", value); } if (alljoyn_message_isencrypted(msg) == QCC_TRUE) { printf("Authenticated using %s\n", alljoyn_message_getauthmechanism(msg)); } outArg = alljoyn_msgarg_create_and_set("s", value); status = alljoyn_busobject_methodreply_args(busobject, msg, outArg, 1); if (ER_OK != status) { printf("Ping: Error sending reply %s\n", QCC_StatusText(status)); } /* Destroy the msgarg */ alljoyn_msgarg_destroy(outArg); } void AJ_CALL delayed_ping(alljoyn_busobject busobject, const alljoyn_interfacedescription_member* member, alljoyn_message msg) { QStatus status = ER_OK; char*value = NULL; alljoyn_msgarg outArg; uint32_t delay = 0; /* Enable concurrent callbacks since some of the calls below could block */ alljoyn_busattachment_enableconcurrentcallbacks(g_msgBus); status = alljoyn_msgarg_get(alljoyn_message_getarg(msg, 0), "s", &value); status = alljoyn_msgarg_get(alljoyn_message_getarg(msg, 1), "u", &delay); printf("Pinged (response delayed %ums) with: \"%s\"\n", delay, value); if (alljoyn_message_isencrypted(msg) == QCC_TRUE) { printf("Authenticated using %s\n", alljoyn_message_getauthmechanism(msg)); } #ifdef _WIN32 Sleep(delay); #else usleep(100 * delay); #endif outArg = alljoyn_msgarg_create_and_set("s", value); status = alljoyn_busobject_methodreply_args(busobject, msg, outArg, 1); if (ER_OK != status) { printf("DelayedPing: Error sending reply %s\n", QCC_StatusText(status)); } /* Destroy the msgarg */ alljoyn_msgarg_destroy(outArg); } void AJ_CALL time_ping(alljoyn_busobject busobject, const alljoyn_interfacedescription_member* member, alljoyn_message msg) { QStatus status = ER_OK; size_t numArgs = 0; alljoyn_msgarg args[2]; /* Reply with same data that was sent to us */ alljoyn_message_getargs(msg, &numArgs, args); status = alljoyn_busobject_methodreply_args(busobject, msg, *args, numArgs); if (ER_OK != status) { printf("TimePing: Error sending reply %s\n", QCC_StatusText(status)); } } /* Signal handler. */ void AJ_CALL signal_handler(const alljoyn_interfacedescription_member* member, const char* srcPath, alljoyn_message msg) { static uint32_t rxCounts = 0; QStatus status = ER_OK; /* Enable concurrent callbacks since some of the calls below could block */ alljoyn_busattachment_enableconcurrentcallbacks(g_msgBus); if ((++rxCounts % g_reportInterval) == 0) { printf("RxSignal: %s - %u\n", srcPath, rxCounts); if (alljoyn_message_isencrypted(msg) == QCC_TRUE) { printf("Authenticated using %s\n", alljoyn_message_getauthmechanism(msg)); } } if (g_echo_signal) { alljoyn_msgarg arg; alljoyn_interfacedescription intf = NULL; alljoyn_interfacedescription_member my_signal_member; QCC_BOOL foundMember = QCC_FALSE; arg = alljoyn_msgarg_create_and_set("a{ys}", 0); intf = alljoyn_busattachment_getinterface(g_msgBus, alljoyn_message_getinterface(msg)); if (intf != NULL) { foundMember = alljoyn_interfacedescription_getmember(intf, "my_signal", &my_signal_member); } if (foundMember) { status = alljoyn_busobject_signal(g_testObj, alljoyn_message_getsender(msg), alljoyn_message_getsessionid(msg), my_signal_member, arg, 1, 0, 0, msg); if (status != ER_OK) { printf("Failed to send Signal because of %s. \n", QCC_StatusText(status)); } } else { printf("Not able to send signal as could not find signal member. \n"); } /* Destroy the msgarg */ alljoyn_msgarg_destroy(arg); } /* ping back means make a method call when you receive a signal. */ if (g_ping_back) { alljoyn_msgarg arg; alljoyn_interfacedescription intf = NULL; alljoyn_interfacedescription_member my_ping_member; QCC_BOOL foundMember = QCC_FALSE; arg = alljoyn_msgarg_create_and_set("s", "Ping back"); intf = alljoyn_busattachment_getinterface(g_msgBus, alljoyn_message_getinterface(msg)); if (intf != NULL) { foundMember = alljoyn_interfacedescription_getmember(intf, "my_ping", &my_ping_member); if (foundMember) { alljoyn_message reply = NULL; alljoyn_proxybusobject remoteObj = NULL; reply = alljoyn_message_create(g_msgBus); remoteObj = alljoyn_proxybusobject_create(g_msgBus, alljoyn_message_getsender(msg), OBJECT_PATH, alljoyn_message_getsessionid(msg)); alljoyn_proxybusobject_addinterface(remoteObj, intf); /* * Make a fire-and-forget method call. If the signal was encrypted encrypt the ping */ status = alljoyn_proxybusobject_methodcall(remoteObj, INTERFACE_NAME, "my_ping", arg, 1, reply, 5000, alljoyn_message_isencrypted(msg) ? ALLJOYN_MESSAGE_FLAG_ENCRYPTED : 0); if (status != ER_OK) { printf("MethodCall on %s.%s failed due to %s. \n", INTERFACE_NAME, "my_ping", QCC_StatusText(status)); } /* Destroy the message reply. */ alljoyn_message_destroy(reply); /* Destroy the proxy bus object. */ alljoyn_proxybusobject_destroy(remoteObj); } } /* Destroy the msgarg */ alljoyn_msgarg_destroy(arg); } } QStatus AJ_CALL property_get(const void* context, const char* ifcName, const char* propName, alljoyn_msgarg val) { QStatus status = ER_OK; if (0 == strcmp("int_val", propName)) { status = alljoyn_msgarg_set_int32(val, g_prop_int_val); } else if (0 == strcmp("str_val", propName)) { status = alljoyn_msgarg_set_string(val, g_prop_str_val); } else if (0 == strcmp("ro_str", propName)) { status = alljoyn_msgarg_set_string(val, g_prop_ro_str); } else { status = ER_BUS_NO_SUCH_PROPERTY; } return status; } QStatus AJ_CALL property_set(const void* context, const char* ifcName, const char* propName, alljoyn_msgarg val) { QStatus status = ER_OK; int set_i; char*set_string; if ((0 == strcmp("int_val", propName)) && (alljoyn_msgarg_gettype(val) == ALLJOYN_INT32)) { status = alljoyn_msgarg_get(val, "i", &set_i); if (ER_OK == status) { g_prop_int_val = set_i; } } else if ((0 == strcmp("str_val", propName)) && (alljoyn_msgarg_gettype(val) == ALLJOYN_STRING)) { status = alljoyn_msgarg_get(val, "s", &set_string); if (ER_OK == status) { strcpy(g_prop_str_val, set_string); } } else if (0 == strcmp("ro_str", propName)) { status = ER_BUS_PROPERTY_ACCESS_DENIED; } else { status = ER_BUS_NO_SUCH_PROPERTY; } return status; } void AJ_CALL busobject_object_unregistered(const void* context) { printf("Bus object unregistered. \n"); } /* ObjectRegistered callback */ void AJ_CALL busobject_object_registered(const void* context) { QStatus status = ER_OK; /* Enable concurrent callbacks since some of the calls below could block */ alljoyn_busattachment_enableconcurrentcallbacks(g_msgBus); status = alljoyn_busattachment_bindsessionport(g_msgBus, &SESSION_PORT, g_sessionOpts, g_sessionPortListener); if (status != ER_OK) { printf("BindSessionPort failed with %s. \n", QCC_StatusText(status)); } /* Add rule for receiving test signals */ status = alljoyn_busattachment_addmatch(g_msgBus, "type='signal',interface='org.alljoyn.alljoyn_test',member='my_signal'"); if (status != ER_OK) { printf("Failed to register Match rule for 'org.alljoyn.alljoyn_test.my_signal' with error %s. \n", QCC_StatusText(status)); } /* Request a well-known name */ status = alljoyn_busattachment_requestname(g_msgBus, g_wellKnownName, DBUS_NAME_FLAG_REPLACE_EXISTING | DBUS_NAME_FLAG_DO_NOT_QUEUE); if (status != ER_OK) { printf("RequestName(%s) failed with %s", g_wellKnownName, QCC_StatusText(status)); return; } /* Begin Advertising the well-known name */ /* transport mask change as per user input. */ status = alljoyn_busattachment_advertisename(g_msgBus, g_wellKnownName, alljoyn_sessionopts_get_transports(g_sessionOpts)); if (ER_OK != status) { printf("Advertise(%s) failed with %s", g_wellKnownName, QCC_StatusText(status)); return; } } /* This is similar to calling BusObject constructor. */ QStatus AJ_CALL bus_object_init() { QStatus status = ER_OK; QCC_BOOL foundMember = QCC_FALSE; alljoyn_interfacedescription_member my_ping_member, my_delayed_ping_member, my_time_ping_member, my_signal_member; alljoyn_interfacedescription intf = NULL; alljoyn_interfacedescription valuesintf = NULL; alljoyn_busobject_methodentry methodEntries[3]; intf = alljoyn_busattachment_getinterface(g_msgBus, INTERFACE_NAME); valuesintf = alljoyn_busattachment_getinterface(g_msgBus, INTERFACE_VALUE_NAME); if (!intf) { printf("ERROR - Could not fetch %s interface from the bus. \n", INTERFACE_NAME); return ER_FAIL; } if (!valuesintf) { printf("ERROR - Could not fetch %s interface from the bus. \n", INTERFACE_VALUE_NAME); return ER_FAIL; } /* Add interfaces to the bus object. */ alljoyn_busobject_addinterface(g_testObj, intf); alljoyn_busobject_addinterface(g_testObj, valuesintf); /*Get the members. */ foundMember = alljoyn_interfacedescription_getmember(intf, "my_signal", &my_signal_member); if (!foundMember) { printf("ERROR - Could not fetch %s member from %s interface. \n", "my_signal", INTERFACE_NAME); return ER_FAIL; } foundMember = QCC_FALSE; foundMember = alljoyn_interfacedescription_getmember(intf, "my_ping", &my_ping_member); if (!foundMember) { printf("ERROR - Could not fetch %s member from %s interface. \n", "my_ping", INTERFACE_NAME); return ER_FAIL; } foundMember = QCC_FALSE; foundMember = alljoyn_interfacedescription_getmember(intf, "delayed_ping", &my_delayed_ping_member); if (!foundMember) { printf("ERROR - Could not fetch %s member from %s interface. \n", "delayed_ping", INTERFACE_NAME); return ER_FAIL; } foundMember = QCC_FALSE; foundMember = alljoyn_interfacedescription_getmember(intf, "time_ping", &my_time_ping_member); if (!foundMember) { printf("ERROR - Could not fetch %s member from %s interface. \n", "time_ping", INTERFACE_NAME); return ER_FAIL; } /* Register a signal handler. */ status = alljoyn_busattachment_registersignalhandler(g_msgBus, &signal_handler, my_signal_member, NULL); if (ER_OK != status) { printf("Failed to register signal handler with %s", QCC_StatusText(status)); return status; } /* Register Method handlers. */ methodEntries[0].member = &my_ping_member; methodEntries[0].method_handler = ping; methodEntries[1].member = &my_delayed_ping_member; methodEntries[1].method_handler = delayed_ping; methodEntries[2].member = &my_time_ping_member; methodEntries[2].method_handler = time_ping; status = alljoyn_busobject_addmethodhandlers(g_testObj, methodEntries, sizeof(methodEntries) / sizeof(methodEntries[0])); if (ER_OK != status) { printf("Failed to register method handlers because of %s\n", QCC_StatusText(status)); return status; } return status; } void usage(void) { printf("Usage: bbcservice [-h ] [-m] [-e] [-i #] [-n ] [-b] [-t] [-r] [-l]\n\n"); printf("Options:\n"); printf(" -h = Print this help message\n"); printf(" -? = Print this help message\n"); printf(" -k = The key store file name\n"); printf(" -kx # = Authentication key expiration (seconds)\n"); printf(" -m = Session is a multi-point session\n"); printf(" -e = Echo received signals back to sender\n"); printf(" -i # = Signal report interval (number of signals rx per update; default = 1000)\n"); printf(" -n = Well-known name to advertise\n"); printf(" -t = Advertise over TCP (enables selective advertising)\n"); printf(" -u = Advertise over UDP (enables selective advertising)\n"); printf(" -l = Advertise locally (enables selective advertising)\n"); printf(" -r = Advertise using the Rendezvous Server (enables selective advertising)\n"); printf(" -a = Cancel advertising while servicing a single client (causes rediscovery between iterations)\n"); printf(" -p = Respond to an incoming signal by pinging back to the sender\n"); } int CDECL_CALL main(int argc, char** argv) { QStatus status = ER_OK; const char* keyStore = NULL; int i = 0; alljoyn_interfacedescription intf = NULL; alljoyn_interfacedescription intfvalue = NULL; /* SessionPort Listeners. */ alljoyn_sessionportlistener_callbacks spl_cbs = { &accept_session_joiner, &session_joined }; /* SessionPort Listeners. */ alljoyn_sessionlistener_callbacks sl_cbs = { &session_lost, //session lost callback NULL, //session member added callback NULL //session member lost callback }; /* Bus Object callbacks */ alljoyn_busobject_callbacks busObjCbs = { &property_get, &property_set, &busobject_object_registered, &busobject_object_unregistered }; /* Auth listener callbacks. */ alljoyn_authlistenerasync_callbacks authcbs = { request_credentials_async, verify_credentials_async, security_violation, authentication_complete }; alljoyn_authlistener authListener; if (alljoyn_init() != ER_OK) { return 1; } #ifdef ROUTER if (alljoyn_routerinit() != ER_OK) { alljoyn_shutdown(); return 1; } #endif printf("AllJoyn Library version: %s\n", alljoyn_getversion()); printf("AllJoyn Library build info: %s\n", alljoyn_getbuildinfo()); /* Install SIGINT handler */ signal(SIGINT, SigIntHandler); g_wellKnownName = (char*)DEFAULT_WELLKNOWN_NAME; g_sessionOpts = alljoyn_sessionopts_create(ALLJOYN_TRAFFIC_TYPE_MESSAGES, QCC_FALSE, ALLJOYN_PROXIMITY_ANY, ALLJOYN_TRANSPORT_ANY); /* Parse command line args */ for (i = 1; i < argc; ++i) { if (0 == strcmp("-h", argv[i]) || 0 == strcmp("-?", argv[i])) { usage(); exit(0); } else if (0 == strcmp("-p", argv[i])) { if (g_echo_signal) { printf("options -e and -p are mutually exclusive\n"); usage(); exit(1); } g_ping_back = QCC_TRUE; } else if (0 == strcmp("-e", argv[i])) { if (g_ping_back) { printf("options -p and -e are mutually exclusive\n"); usage(); exit(1); } g_echo_signal = QCC_TRUE;; } else if (0 == strcmp("-i", argv[i])) { ++i; if (i == argc) { printf("option %s requires a parameter\n", argv[i - 1]); usage(); exit(1); } else { g_reportInterval = strtoul(argv[i], NULL, 10); } } else if (0 == strcmp("-n", argv[i])) { ++i; if (i == argc) { printf("option %s requires a parameter\n", argv[i - 1]); usage(); exit(1); } else { g_wellKnownName = argv[i]; } } else if (0 == strcmp("-k", argv[i])) { ++i; if (i == argc) { printf("option %s requires a parameter\n", argv[i - 1]); usage(); exit(1); } else { keyStore = argv[i]; } } else if (0 == strcmp("-kx", argv[i])) { ++i; if (i == argc) { printf("option %s requires a parameter\n", argv[i - 1]); usage(); exit(1); } else { g_keyExpiration = strtoul(argv[i], NULL, 10); } } else if (0 == strcmp("-m", argv[i])) { alljoyn_sessionopts_set_multipoint(g_sessionOpts, QCC_TRUE); } else if (0 == strcmp("-t", argv[i])) { alljoyn_sessionopts_set_transports(g_sessionOpts, ALLJOYN_TRANSPORT_TCP); } else if (0 == strcmp("-u", argv[i])) { alljoyn_sessionopts_set_transports(g_sessionOpts, ALLJOYN_TRANSPORT_UDP); } else if (0 == strcmp("-l", argv[i])) { alljoyn_sessionopts_set_transports(g_sessionOpts, ALLJOYN_TRANSPORT_LOCAL); } else if (0 == strcmp("-a", argv[i])) { g_cancelAdvertise = QCC_TRUE; } else { status = ER_FAIL; printf("Unknown option %s\n", argv[i]); usage(); exit(1); } } //Create bus attachment g_msgBus = alljoyn_busattachment_create("bbcservice", QCC_TRUE); //Create and add interfaces to the bus status = alljoyn_busattachment_createinterface(g_msgBus, INTERFACE_NAME, &intf); if (status != ER_OK) { printf("Could not create %s interface because of %s. \n", INTERFACE_NAME, QCC_StatusText(status)); return status; } status = alljoyn_busattachment_createinterface(g_msgBus, INTERFACE_VALUE_NAME, &intfvalue); if (status != ER_OK) { printf("Could not create %s interface because of %s. \n", INTERFACE_VALUE_NAME, QCC_StatusText(status)); return status; } /* Activate org.alljoyn.alljoyn_test */ status = alljoyn_interfacedescription_addmethod(intf, "my_ping", "s", "s", "i,i", 0, NULL); if (status != ER_OK) { printf("Could not add method %s to interface %s because of %s. \n", "my_ping", INTERFACE_NAME, QCC_StatusText(status)); return status; } status = alljoyn_interfacedescription_addmethod(intf, "delayed_ping", "su", "s", "i,i", 0, NULL); if (status != ER_OK) { printf("Could not add method %s to interface %s because of %s. \n", "delayed_ping", INTERFACE_NAME, QCC_StatusText(status)); return status; } status = alljoyn_interfacedescription_addmethod(intf, "time_ping", "uq", "uq", "i,i", 0, NULL); if (status != ER_OK) { printf("Could not add method %s to interface %s because of %s. \n", "time_ping", INTERFACE_NAME, QCC_StatusText(status)); return status; } status = alljoyn_interfacedescription_addmember(intf, ALLJOYN_MESSAGE_SIGNAL, "my_signal", "a{ys}", NULL, "inStr", 0); if (status != ER_OK) { printf("Could not add signal %s to interface %s because of %s. \n", "my_signal", INTERFACE_NAME, QCC_StatusText(status)); return status; } alljoyn_interfacedescription_activate(intf); /*Activate org.alljoyn.alljoyn_test.values */ status = alljoyn_interfacedescription_addproperty(intfvalue, "int_val", "i", ALLJOYN_PROP_ACCESS_RW); if (status != ER_OK) { printf("Could not add property %s to interface %s because of %s. \n", "int_val", INTERFACE_VALUE_NAME, QCC_StatusText(status)); return status; } status = alljoyn_interfacedescription_addproperty(intfvalue, "str_val", "s", ALLJOYN_PROP_ACCESS_RW); if (status != ER_OK) { printf("Could not add method %s to interface %s because of %s. \n", "str_val", INTERFACE_VALUE_NAME, QCC_StatusText(status)); return status; } status = alljoyn_interfacedescription_addproperty(intfvalue, "ro_str", "s", ALLJOYN_PROP_ACCESS_READ); if (status != ER_OK) { printf("Could not add method %s to interface %s because of %s. \n", "ro_str", INTERFACE_VALUE_NAME, QCC_StatusText(status)); return status; } alljoyn_interfacedescription_activate(intfvalue); //Start the bus status = alljoyn_busattachment_start(g_msgBus); if (status != ER_OK) { printf("Could not start the bus because of %s. \n", QCC_StatusText(status)); return status; } //Connect to the bus TODO - change the connect spec status = alljoyn_busattachment_connect(g_msgBus, "null:"); if (status != ER_OK) { printf("Could not connect to the bus because of %s. \n", QCC_StatusText(status)); return status; } /* SessionPort Listeners. */ g_sessionPortListener = alljoyn_sessionportlistener_create(&spl_cbs, NULL); /* SessionPort Listeners. */ g_sessionListener = alljoyn_sessionlistener_create(&sl_cbs, NULL); /* Bus Object call backs. */ g_testObj = alljoyn_busobject_create(OBJECT_PATH, QCC_FALSE, &busObjCbs, NULL); status = bus_object_init(); if (status != ER_OK) { printf("Bus object init failed because of %s. \n", QCC_StatusText(status)); return status; } alljoyn_busattachment_registerbusobject(g_msgBus, g_testObj); /* Auth listener callbacks. */ authListener = alljoyn_authlistenerasync_create(&authcbs, NULL); status = alljoyn_busattachment_enablepeersecurity(g_msgBus, "ALLJOYN_SRP_KEYX ALLJOYN_SRP_LOGON", authListener, keyStore, keyStore != NULL); if (ER_OK != status) { printf("enablePeerSecurity failed (%s)\n", QCC_StatusText(status)); return status; } /* Add a logon entry. */ alljoyn_busattachment_addlogonentry(g_msgBus, "ALLJOYN_SRP_LOGON", "sleepy", "123456"); if (ER_OK == status) { printf("bbcservice %s ready to accept connections\n", g_wellKnownName); while (g_interrupt == QCC_FALSE) { #ifdef _WIN32 Sleep(100 * 10 * 300); #else usleep(100 * 1000 * 10 * 300); #endif } } /* Clean up. */ alljoyn_busattachment_unregisterbusobject(g_msgBus, g_testObj); alljoyn_sessionopts_destroy(g_sessionOpts); alljoyn_authlistenerasync_destroy(authListener); alljoyn_busobject_destroy(g_testObj); alljoyn_sessionportlistener_destroy(g_sessionPortListener); alljoyn_sessionlistener_destroy(g_sessionListener); alljoyn_busattachment_destroy(g_msgBus); #ifdef ROUTER alljoyn_routershutdown(); #endif alljoyn_shutdown(); return 0; } alljoyn-15.04b/alljoyn_c/unit_test/000077500000000000000000000000001255700255500173335ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_c/unit_test/AboutDataTest.cc000066400000000000000000002143661255700255500223620ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #include #include #include "ajTestCommon.h" using namespace ajn; TEST(AboutDataTest, constants) { EXPECT_STREQ("AppId", AboutData::APP_ID); EXPECT_STREQ("DefaultLanguage", AboutData::DEFAULT_LANGUAGE); EXPECT_STREQ("DeviceName", AboutData::DEVICE_NAME); EXPECT_STREQ("DeviceId", AboutData::DEVICE_ID); EXPECT_STREQ("AppName", AboutData::APP_NAME); EXPECT_STREQ("Manufacturer", AboutData::MANUFACTURER); EXPECT_STREQ("ModelNumber", AboutData::MODEL_NUMBER); EXPECT_STREQ("SupportedLanguages", AboutData::SUPPORTED_LANGUAGES); EXPECT_STREQ("Description", AboutData::DESCRIPTION); EXPECT_STREQ("DateOfManufacture", AboutData::DATE_OF_MANUFACTURE); EXPECT_STREQ("SoftwareVersion", AboutData::SOFTWARE_VERSION); EXPECT_STREQ("AJSoftwareVersion", AboutData::AJ_SOFTWARE_VERSION); EXPECT_STREQ("HardwareVersion", AboutData::HARDWARE_VERSION); EXPECT_STREQ("SupportUrl", AboutData::SUPPORT_URL); } TEST(AboutDataTest, VerifyFieldValues) { alljoyn_aboutdata aboutData = alljoyn_aboutdata_create("en"); EXPECT_TRUE(alljoyn_aboutdata_isfieldrequired(aboutData, AboutData::APP_ID)); EXPECT_TRUE(alljoyn_aboutdata_isfieldannounced(aboutData, AboutData::APP_ID)); EXPECT_FALSE(alljoyn_aboutdata_isfieldlocalized(aboutData, AboutData::APP_ID)); EXPECT_STREQ("ay", alljoyn_aboutdata_getfieldsignature(aboutData, AboutData::APP_ID)); EXPECT_TRUE(alljoyn_aboutdata_isfieldrequired(aboutData, AboutData::DEFAULT_LANGUAGE)); EXPECT_TRUE(alljoyn_aboutdata_isfieldannounced(aboutData, AboutData::DEFAULT_LANGUAGE)); EXPECT_FALSE(alljoyn_aboutdata_isfieldlocalized(aboutData, AboutData::DEFAULT_LANGUAGE)); EXPECT_STREQ("s", alljoyn_aboutdata_getfieldsignature(aboutData, AboutData::DEFAULT_LANGUAGE)); EXPECT_FALSE(alljoyn_aboutdata_isfieldrequired(aboutData, AboutData::DEVICE_NAME)); EXPECT_TRUE(alljoyn_aboutdata_isfieldannounced(aboutData, AboutData::DEVICE_NAME)); EXPECT_TRUE(alljoyn_aboutdata_isfieldlocalized(aboutData, AboutData::DEVICE_NAME)); EXPECT_STREQ("s", alljoyn_aboutdata_getfieldsignature(aboutData, AboutData::DEVICE_NAME)); EXPECT_TRUE(alljoyn_aboutdata_isfieldrequired(aboutData, AboutData::DEVICE_ID)); EXPECT_TRUE(alljoyn_aboutdata_isfieldannounced(aboutData, AboutData::DEVICE_ID)); EXPECT_FALSE(alljoyn_aboutdata_isfieldlocalized(aboutData, AboutData::DEVICE_ID)); EXPECT_STREQ("s", alljoyn_aboutdata_getfieldsignature(aboutData, AboutData::DEVICE_ID)); EXPECT_TRUE(alljoyn_aboutdata_isfieldrequired(aboutData, AboutData::APP_NAME)); EXPECT_TRUE(alljoyn_aboutdata_isfieldannounced(aboutData, AboutData::APP_NAME)); EXPECT_TRUE(alljoyn_aboutdata_isfieldlocalized(aboutData, AboutData::APP_NAME)); EXPECT_STREQ("s", alljoyn_aboutdata_getfieldsignature(aboutData, AboutData::APP_NAME)); EXPECT_TRUE(alljoyn_aboutdata_isfieldrequired(aboutData, AboutData::MANUFACTURER)); EXPECT_TRUE(alljoyn_aboutdata_isfieldannounced(aboutData, AboutData::MANUFACTURER)); EXPECT_TRUE(alljoyn_aboutdata_isfieldlocalized(aboutData, AboutData::MANUFACTURER)); EXPECT_STREQ("s", alljoyn_aboutdata_getfieldsignature(aboutData, AboutData::MANUFACTURER)); EXPECT_TRUE(alljoyn_aboutdata_isfieldrequired(aboutData, AboutData::MODEL_NUMBER)); EXPECT_TRUE(alljoyn_aboutdata_isfieldannounced(aboutData, AboutData::MODEL_NUMBER)); EXPECT_FALSE(alljoyn_aboutdata_isfieldlocalized(aboutData, AboutData::MODEL_NUMBER)); EXPECT_STREQ("s", alljoyn_aboutdata_getfieldsignature(aboutData, AboutData::MODEL_NUMBER)); EXPECT_TRUE(alljoyn_aboutdata_isfieldrequired(aboutData, AboutData::SUPPORTED_LANGUAGES)); EXPECT_FALSE(alljoyn_aboutdata_isfieldannounced(aboutData, AboutData::SUPPORTED_LANGUAGES)); EXPECT_FALSE(alljoyn_aboutdata_isfieldlocalized(aboutData, AboutData::SUPPORTED_LANGUAGES)); EXPECT_STREQ("as", alljoyn_aboutdata_getfieldsignature(aboutData, AboutData::SUPPORTED_LANGUAGES)); EXPECT_TRUE(alljoyn_aboutdata_isfieldrequired(aboutData, AboutData::DESCRIPTION)); EXPECT_FALSE(alljoyn_aboutdata_isfieldannounced(aboutData, AboutData::DESCRIPTION)); EXPECT_TRUE(alljoyn_aboutdata_isfieldlocalized(aboutData, AboutData::DESCRIPTION)); EXPECT_STREQ("s", alljoyn_aboutdata_getfieldsignature(aboutData, AboutData::DESCRIPTION)); EXPECT_FALSE(alljoyn_aboutdata_isfieldrequired(aboutData, AboutData::DATE_OF_MANUFACTURE)); EXPECT_FALSE(alljoyn_aboutdata_isfieldannounced(aboutData, AboutData::DATE_OF_MANUFACTURE)); EXPECT_FALSE(alljoyn_aboutdata_isfieldlocalized(aboutData, AboutData::DATE_OF_MANUFACTURE)); EXPECT_STREQ("s", alljoyn_aboutdata_getfieldsignature(aboutData, AboutData::DATE_OF_MANUFACTURE)); EXPECT_TRUE(alljoyn_aboutdata_isfieldrequired(aboutData, AboutData::SOFTWARE_VERSION)); EXPECT_FALSE(alljoyn_aboutdata_isfieldannounced(aboutData, AboutData::SOFTWARE_VERSION)); EXPECT_FALSE(alljoyn_aboutdata_isfieldlocalized(aboutData, AboutData::SOFTWARE_VERSION)); EXPECT_STREQ("s", alljoyn_aboutdata_getfieldsignature(aboutData, AboutData::SOFTWARE_VERSION)); EXPECT_TRUE(alljoyn_aboutdata_isfieldrequired(aboutData, AboutData::AJ_SOFTWARE_VERSION)); EXPECT_FALSE(alljoyn_aboutdata_isfieldannounced(aboutData, AboutData::AJ_SOFTWARE_VERSION)); EXPECT_FALSE(alljoyn_aboutdata_isfieldlocalized(aboutData, AboutData::AJ_SOFTWARE_VERSION)); EXPECT_STREQ("s", alljoyn_aboutdata_getfieldsignature(aboutData, AboutData::AJ_SOFTWARE_VERSION)); EXPECT_FALSE(alljoyn_aboutdata_isfieldrequired(aboutData, AboutData::HARDWARE_VERSION)); EXPECT_FALSE(alljoyn_aboutdata_isfieldannounced(aboutData, AboutData::HARDWARE_VERSION)); EXPECT_FALSE(alljoyn_aboutdata_isfieldlocalized(aboutData, AboutData::HARDWARE_VERSION)); EXPECT_STREQ("s", alljoyn_aboutdata_getfieldsignature(aboutData, AboutData::HARDWARE_VERSION)); EXPECT_FALSE(alljoyn_aboutdata_isfieldrequired(aboutData, AboutData::SUPPORT_URL)); EXPECT_FALSE(alljoyn_aboutdata_isfieldannounced(aboutData, AboutData::SUPPORT_URL)); EXPECT_FALSE(alljoyn_aboutdata_isfieldlocalized(aboutData, AboutData::SUPPORT_URL)); EXPECT_STREQ("s", alljoyn_aboutdata_getfieldsignature(aboutData, AboutData::SUPPORT_URL)); EXPECT_FALSE(alljoyn_aboutdata_isfieldrequired(aboutData, "Unknown")); EXPECT_FALSE(alljoyn_aboutdata_isfieldannounced(aboutData, "Unknown")); EXPECT_FALSE(alljoyn_aboutdata_isfieldlocalized(aboutData, "Unknown")); EXPECT_TRUE(NULL == alljoyn_aboutdata_getfieldsignature(aboutData, "Unknown")); alljoyn_aboutdata_destroy(aboutData); } TEST(AboutDataTest, DefaultLanguageNotSpecified) { QStatus status = ER_FAIL; alljoyn_aboutdata aboutData = alljoyn_aboutdata_create_empty(); status = alljoyn_aboutdata_setdevicename(aboutData, "Device Name", NULL); EXPECT_EQ(ER_ABOUT_DEFAULT_LANGUAGE_NOT_SPECIFIED, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setappname(aboutData, "Application Name", NULL); EXPECT_EQ(ER_ABOUT_DEFAULT_LANGUAGE_NOT_SPECIFIED, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setmanufacturer(aboutData, "Manufacturer Name", NULL); EXPECT_EQ(ER_ABOUT_DEFAULT_LANGUAGE_NOT_SPECIFIED, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setdescription(aboutData, "A description of the application.", NULL); EXPECT_EQ(ER_ABOUT_DEFAULT_LANGUAGE_NOT_SPECIFIED, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_aboutdata_destroy(aboutData); } TEST(AboutDataTest, Constructor) { QStatus status = ER_FAIL; alljoyn_aboutdata aboutData = alljoyn_aboutdata_create("en"); char* language; status = alljoyn_aboutdata_getdefaultlanguage(aboutData, &language); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("en", language); char* ajSoftwareVersion; status = alljoyn_aboutdata_getajsoftwareversion(aboutData, &ajSoftwareVersion); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ(ajn::GetVersion(), ajSoftwareVersion); alljoyn_aboutdata_destroy(aboutData); } TEST(AboutDataTest, SetAppId) { QStatus status = ER_FAIL; alljoyn_aboutdata aboutData = alljoyn_aboutdata_create("en"); uint8_t originalAppId[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 }; status = alljoyn_aboutdata_setappid(aboutData, originalAppId, 16u); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); uint8_t* appId; size_t num; status = alljoyn_aboutdata_getappid(aboutData, &appId, &num); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_EQ(16u, num); for (size_t i = 0; i < num; i++) { EXPECT_EQ(originalAppId[i], appId[i]); } alljoyn_aboutdata_destroy(aboutData); } TEST(AboutDataTest, SetAppId_using_uuid_string) { QStatus status = ER_FAIL; alljoyn_aboutdata aboutData = alljoyn_aboutdata_create("en"); /* Not a hex digit */ status = alljoyn_aboutdata_setappid_fromstring(aboutData, "g00102030405060708090a0b0c0d0e0f"); EXPECT_EQ(ER_ABOUT_INVALID_ABOUTDATA_FIELD_VALUE, status) << " Actual Status: " << QCC_StatusText(status); /* Odd number of characters parsing error */ status = alljoyn_aboutdata_setappid_fromstring(aboutData, "00102030405060708090a0b0c0d0e0f"); EXPECT_EQ(ER_ABOUT_INVALID_ABOUTDATA_FIELD_VALUE, status) << " Actual Status: " << QCC_StatusText(status); /* Too few characters */ status = alljoyn_aboutdata_setappid_fromstring(aboutData, "0102030405060708090a0b0c0d0e0f"); EXPECT_EQ(ER_ABOUT_INVALID_ABOUTDATA_FIELD_APPID_SIZE, status) << " Actual Status: " << QCC_StatusText(status); /* Too many characters */ status = alljoyn_aboutdata_setappid_fromstring(aboutData, "000102030405060708090a0b0c0d0e0f10"); EXPECT_EQ(ER_ABOUT_INVALID_ABOUTDATA_FIELD_APPID_SIZE, status) << " Actual Status: " << QCC_StatusText(status); /* Not valid uuid parsing error */ status = alljoyn_aboutdata_setappid_fromstring(aboutData, "000102030405-060708090A0B-0C0D0E0F10"); EXPECT_EQ(ER_ABOUT_INVALID_ABOUTDATA_FIELD_VALUE, status) << " Actual Status: " << QCC_StatusText(status); /* Not valid uuid parsing error */ status = alljoyn_aboutdata_setappid_fromstring(aboutData, "00010203-04050607-0809-0A0B-0C0D0E0F"); EXPECT_EQ(ER_ABOUT_INVALID_ABOUTDATA_FIELD_VALUE, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setappid_fromstring(aboutData, "000102030405060708090a0b0c0d0e0f"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); uint8_t* appId; size_t num; status = alljoyn_aboutdata_getappid(aboutData, &appId, &num); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_EQ(16u, num); for (size_t i = 0; i < num; i++) { EXPECT_EQ(i, appId[i]); } alljoyn_aboutdata aboutData2 = alljoyn_aboutdata_create("en"); /* Use capital hex digits */ status = alljoyn_aboutdata_setappid_fromstring(aboutData2, "000102030405060708090A0B0C0D0E0F"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_getappid(aboutData2, &appId, &num); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_EQ(16u, num); for (size_t i = 0; i < num; i++) { EXPECT_EQ(i, appId[i]); } alljoyn_aboutdata aboutData3 = alljoyn_aboutdata_create("en"); /* Use capital hex digits UUID as per RFC 4122 */ status = alljoyn_aboutdata_setappid_fromstring(aboutData3, "00010203-0405-0607-0809-0A0B0C0D0E0F"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_getappid(aboutData3, &appId, &num); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_EQ(16u, num); for (size_t i = 0; i < num; i++) { EXPECT_EQ(i, appId[i]); } alljoyn_aboutdata aboutData4 = alljoyn_aboutdata_create("en"); /* Use lowercase hex digits UUID as per RFC 4122 */ status = alljoyn_aboutdata_setappid_fromstring(aboutData4, "00010203-0405-0607-0809-0a0b0c0d0e0f"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_getappid(aboutData4, &appId, &num); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_EQ(16u, num); for (size_t i = 0; i < num; i++) { EXPECT_EQ(i, appId[i]); } alljoyn_aboutdata_destroy(aboutData); alljoyn_aboutdata_destroy(aboutData2); alljoyn_aboutdata_destroy(aboutData3); alljoyn_aboutdata_destroy(aboutData4); } TEST(AboutDataTest, SetDeviceName) { QStatus status = ER_FAIL; alljoyn_aboutdata aboutData = alljoyn_aboutdata_create("en"); char* language; status = alljoyn_aboutdata_getdefaultlanguage(aboutData, &language); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("en", language); char* ajSoftwareVersion; status = alljoyn_aboutdata_getajsoftwareversion(aboutData, &ajSoftwareVersion); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ(ajn::GetVersion(), ajSoftwareVersion); status = alljoyn_aboutdata_setdevicename(aboutData, "Device", "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); char* deviceName; status = alljoyn_aboutdata_getdevicename(aboutData, &deviceName, "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("Device", deviceName); status = alljoyn_aboutdata_setdevicename(aboutData, "dispositivo", "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_getdevicename(aboutData, &deviceName, "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("dispositivo", deviceName); alljoyn_aboutdata_destroy(aboutData); } TEST(AboutDataTest, SetDeviceId) { QStatus status = ER_FAIL; alljoyn_aboutdata aboutData = alljoyn_aboutdata_create("en"); status = alljoyn_aboutdata_setdeviceid(aboutData, "avec-awe1213-1234559xvc123"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); char* deviceId; status = alljoyn_aboutdata_getdeviceid(aboutData, &deviceId); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("avec-awe1213-1234559xvc123", deviceId); alljoyn_aboutdata_destroy(aboutData); } TEST(AboutDataTest, SetAppName) { QStatus status = ER_FAIL; alljoyn_aboutdata aboutData = alljoyn_aboutdata_create("en"); status = alljoyn_aboutdata_setappname(aboutData, "Application", "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); char* appName; status = alljoyn_aboutdata_getappname(aboutData, &appName, "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("Application", appName); status = alljoyn_aboutdata_setappname(aboutData, "aplicacion", "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_getappname(aboutData, &appName, "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("aplicacion", appName); alljoyn_aboutdata_destroy(aboutData); } TEST(AboutDataTest, SetManufacturer) { QStatus status = ER_FAIL; alljoyn_aboutdata aboutData = alljoyn_aboutdata_create("en"); status = alljoyn_aboutdata_setmanufacturer(aboutData, "Manufacturer", "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); char* manufacturer; status = alljoyn_aboutdata_getmanufacturer(aboutData, &manufacturer, "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("Manufacturer", manufacturer); status = alljoyn_aboutdata_setmanufacturer(aboutData, "manufactura", "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_getmanufacturer(aboutData, &manufacturer, "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("manufactura", manufacturer); alljoyn_aboutdata_destroy(aboutData); } TEST(AboutDataTest, SetModelNumber) { QStatus status = ER_FAIL; alljoyn_aboutdata aboutData = alljoyn_aboutdata_create("en"); status = alljoyn_aboutdata_setmodelnumber(aboutData, "xBnc345"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); char* modelNumber; status = alljoyn_aboutdata_getmodelnumber(aboutData, &modelNumber); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("xBnc345", modelNumber); alljoyn_aboutdata_destroy(aboutData); } TEST(AboutDataTest, SetSupportedLanguage) { QStatus status = ER_FAIL; alljoyn_aboutdata aboutData = alljoyn_aboutdata_create("en"); size_t numLanguages = alljoyn_aboutdata_getsupportedlanguages(aboutData, NULL, 0); const char** languages = new const char*[numLanguages]; size_t numRetLang = alljoyn_aboutdata_getsupportedlanguages(aboutData, languages, numLanguages); EXPECT_EQ(numLanguages, numRetLang); EXPECT_EQ(1u, numLanguages); EXPECT_STREQ("en", languages[0]); delete [] languages; languages = NULL; status = alljoyn_aboutdata_setsupportedlanguage(aboutData, "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); numLanguages = alljoyn_aboutdata_getsupportedlanguages(aboutData, NULL, 0); languages = new const char*[numLanguages]; numRetLang = alljoyn_aboutdata_getsupportedlanguages(aboutData, languages, numLanguages); EXPECT_EQ(numLanguages, numRetLang); EXPECT_EQ(2u, numLanguages); EXPECT_STREQ("en", languages[0]); EXPECT_STREQ("es", languages[1]); delete [] languages; languages = NULL; alljoyn_aboutdata_destroy(aboutData); } TEST(AboutDataTest, SetSupportedLanguage_Duplicate) { QStatus status = ER_FAIL; alljoyn_aboutdata aboutData = alljoyn_aboutdata_create("en"); status = alljoyn_aboutdata_setsupportedlanguage(aboutData, "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* Duplicate language already added from constructor */ status = alljoyn_aboutdata_setsupportedlanguage(aboutData, "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* Duplicate language already added, error status should be generated */ status = alljoyn_aboutdata_setsupportedlanguage(aboutData, "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* * Even though "en" and "es" languages have been added multiple times only * two languages should be reported in the list of SupportedLanguages. */ size_t numRetLang = alljoyn_aboutdata_getsupportedlanguages(aboutData, NULL, 0); EXPECT_EQ(2u, numRetLang); alljoyn_aboutdata_destroy(aboutData); } TEST(AboutDataTest, DISABLED_SetSupportedLanguage_Invalid_Tag) { QStatus status = ER_FAIL; alljoyn_aboutdata aboutData = alljoyn_aboutdata_create("en"); /* Invalid language tag not defined in RFC5646 */ status = alljoyn_aboutdata_setsupportedlanguage(aboutData, "abc"); EXPECT_NE(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setsupportedlanguage(aboutData, "232"); EXPECT_NE(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* Invalid subtag not defined in RFC5646 */ status = alljoyn_aboutdata_setsupportedlanguage(aboutData, "en-t324"); EXPECT_NE(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setsupportedlanguage(aboutData, "zh-gfjk"); EXPECT_NE(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); size_t numRetLang = alljoyn_aboutdata_getsupportedlanguages(aboutData, NULL, 0); EXPECT_EQ(1u, numRetLang); alljoyn_aboutdata_destroy(aboutData); } TEST(AboutDataTest, GetSupportedLanguages) { alljoyn_aboutdata aboutData = alljoyn_aboutdata_create("en"); size_t numLanguages; numLanguages = alljoyn_aboutdata_getsupportedlanguages(aboutData, NULL, 0); EXPECT_EQ(1u, numLanguages); alljoyn_aboutdata_destroy(aboutData); } TEST(AboutDataTest, SetDescription) { QStatus status = ER_FAIL; alljoyn_aboutdata aboutData = alljoyn_aboutdata_create("en"); status = alljoyn_aboutdata_setdescription(aboutData, "A poetic description of this application", "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); char* description; status = alljoyn_aboutdata_getdescription(aboutData, &description, "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("A poetic description of this application", description); status = alljoyn_aboutdata_setdescription(aboutData, "Una descripcion poetica de esta aplicacion", "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_getdescription(aboutData, &description, "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("Una descripcion poetica de esta aplicacion", description); alljoyn_aboutdata_destroy(aboutData); } TEST(AboutDataTest, SetDateOfManufacture) { QStatus status = ER_FAIL; alljoyn_aboutdata aboutData = alljoyn_aboutdata_create("en"); status = alljoyn_aboutdata_setdateofmanufacture(aboutData, "2014-01-20"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); char* dateOfManufacture; status = alljoyn_aboutdata_getdateofmanufacture(aboutData, &dateOfManufacture); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("2014-01-20", dateOfManufacture); alljoyn_aboutdata_destroy(aboutData); } TEST(AboutDataTest, DISABLED_SetDateOfManufacture_Negative) { QStatus status = ER_FAIL; alljoyn_aboutdata aboutData = alljoyn_aboutdata_create("en"); /* Invalid date should fail */ status = alljoyn_aboutdata_setdateofmanufacture(aboutData, "2014-41-20"); EXPECT_NE(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setdateofmanufacture(aboutData, "201a-02-20"); EXPECT_NE(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setdateofmanufacture(aboutData, "2013-02-29"); EXPECT_NE(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setdateofmanufacture(aboutData, "04/31/2014"); EXPECT_NE(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_aboutdata_destroy(aboutData); } TEST(AboutDataTest, SetSoftwareVersion) { QStatus status = ER_FAIL; alljoyn_aboutdata aboutData = alljoyn_aboutdata_create("en"); status = alljoyn_aboutdata_setsoftwareversion(aboutData, "0.1.2"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); char* softwareVersion; status = alljoyn_aboutdata_getsoftwareversion(aboutData, &softwareVersion); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("0.1.2", softwareVersion); alljoyn_aboutdata_destroy(aboutData); } TEST(AboutDataTest, SetHardwareVersion) { QStatus status = ER_FAIL; alljoyn_aboutdata aboutData = alljoyn_aboutdata_create("en"); status = alljoyn_aboutdata_sethardwareversion(aboutData, "3.2.1"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); char* hardwareVersion; status = alljoyn_aboutdata_gethardwareversion(aboutData, &hardwareVersion); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("3.2.1", hardwareVersion); alljoyn_aboutdata_destroy(aboutData); } TEST(AboutDataTest, SetSupportUrl) { QStatus status = ER_FAIL; alljoyn_aboutdata aboutData = alljoyn_aboutdata_create("en"); status = alljoyn_aboutdata_setsupporturl(aboutData, "www.example.com"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); char* supportUrl; status = alljoyn_aboutdata_getsupporturl(aboutData, &supportUrl); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("www.example.com", supportUrl); alljoyn_aboutdata_destroy(aboutData); } TEST(AboutDataTest, IsValid) { QStatus status = ER_FAIL; alljoyn_aboutdata aboutData = alljoyn_aboutdata_create("en"); EXPECT_FALSE(alljoyn_aboutdata_isvalid(aboutData, "en")); uint8_t appId[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 }; status = alljoyn_aboutdata_setappid(aboutData, appId, 16); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setdeviceid(aboutData, "fakeID"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setappname(aboutData, "Application", "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setmanufacturer(aboutData, "Manufacturer", "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setmodelnumber(aboutData, "123456"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setdescription(aboutData, "A poetic description of this application", "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setsoftwareversion(aboutData, "0.1.2"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_TRUE(alljoyn_aboutdata_isvalid(aboutData, "en")); EXPECT_FALSE(alljoyn_aboutdata_isvalid(aboutData, "es")); status = alljoyn_aboutdata_setsupportedlanguage(aboutData, "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setappname(aboutData, "aplicacion", "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setmanufacturer(aboutData, "manufactura", "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setdescription(aboutData, "Una descripcion poetica de esta aplicacion", "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_TRUE(alljoyn_aboutdata_isvalid(aboutData, "es")); alljoyn_aboutdata_destroy(aboutData); } TEST(AboutDataTest, IsValid_Negative) { QStatus status = ER_FAIL; alljoyn_aboutdata aboutData = alljoyn_aboutdata_create("en"); /* DefaultLanguage and other required fields are missing */ EXPECT_FALSE(alljoyn_aboutdata_isvalid(aboutData, "en")); status = alljoyn_aboutdata_setsupportedlanguage(aboutData, "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_FALSE(alljoyn_aboutdata_isvalid(aboutData, "en")); uint8_t appId[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 }; status = alljoyn_aboutdata_setappid(aboutData, appId, 16); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* DeviceId and other required fields are missing */ EXPECT_FALSE(alljoyn_aboutdata_isvalid(aboutData, "en")); status = alljoyn_aboutdata_setdeviceid(aboutData, "fakeID"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* AppName and other required fields are missing */ EXPECT_FALSE(alljoyn_aboutdata_isvalid(aboutData, "en")); status = alljoyn_aboutdata_setappname(aboutData, "Application", "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* Manufacturer and other required fields are missing */ EXPECT_FALSE(alljoyn_aboutdata_isvalid(aboutData, "en")); status = alljoyn_aboutdata_setmanufacturer(aboutData, "Manufacturer", "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* ModelNumber and other required fields are missing */ EXPECT_FALSE(alljoyn_aboutdata_isvalid(aboutData, "en")); status = alljoyn_aboutdata_setmodelnumber(aboutData, "123456"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /*Description and other required fields are missing */ EXPECT_FALSE(alljoyn_aboutdata_isvalid(aboutData, "en")); status = alljoyn_aboutdata_setdescription(aboutData, "A poetic description of this application", "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* SoftwareVersion missing */ EXPECT_FALSE(alljoyn_aboutdata_isvalid(aboutData, "en")); status = alljoyn_aboutdata_setsoftwareversion(aboutData, "0.1.2"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* Now all required fields are set for English */ EXPECT_TRUE(alljoyn_aboutdata_isvalid(aboutData, "en")); status = alljoyn_aboutdata_setsupportedlanguage(aboutData, "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* Missing AppName/Manufacture/Description */ EXPECT_FALSE(alljoyn_aboutdata_isvalid(aboutData, "es")); status = alljoyn_aboutdata_setappname(aboutData, "aplicacion", "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* Missing Manufacture/Description */ EXPECT_FALSE(alljoyn_aboutdata_isvalid(aboutData, "es")); status = alljoyn_aboutdata_setmanufacturer(aboutData, "manufactura", "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* Missing Description */ EXPECT_FALSE(alljoyn_aboutdata_isvalid(aboutData, "es")); status = alljoyn_aboutdata_setdescription(aboutData, "Una descripcion poetica de esta aplicacion", "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_TRUE(alljoyn_aboutdata_isvalid(aboutData, "es")); alljoyn_aboutdata_destroy(aboutData); } TEST(AboutDataTest, GetAboutData) { QStatus status = ER_FAIL; alljoyn_aboutdata aboutData = alljoyn_aboutdata_create("en"); uint8_t appId[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 }; status = alljoyn_aboutdata_setappid(aboutData, appId, 16); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setdeviceid(aboutData, "fakeID"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setappname(aboutData, "Application", "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setmanufacturer(aboutData, "Manufacturer", "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setmodelnumber(aboutData, "123456"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setdescription(aboutData, "A poetic description of this application", "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setsoftwareversion(aboutData, "0.1.2"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_TRUE(alljoyn_aboutdata_isvalid(aboutData, "en")); status = alljoyn_aboutdata_setsupportedlanguage(aboutData, "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setappname(aboutData, "aplicacion", "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setmanufacturer(aboutData, "manufactura", "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setdescription(aboutData, "Una descripcion poetica de esta aplicacion", "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_TRUE(alljoyn_aboutdata_isvalid(aboutData, "es")); alljoyn_msgarg aboutArg = alljoyn_msgarg_create(); status = alljoyn_aboutdata_getaboutdata(aboutData, aboutArg, "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg args; status = alljoyn_msgarg_getdictelement(aboutArg, "{sv}", AboutData::APP_ID, &args); int8_t* appIdOut; size_t appIdNum; alljoyn_msgarg_get(args, "ay", &appIdNum, &appIdOut); ASSERT_EQ(16u, appIdNum); for (size_t i = 0; i < appIdNum; ++i) { EXPECT_EQ(appId[i], appIdOut[i]); } alljoyn_msgarg_getdictelement(aboutArg, "{sv}", AboutData::DEFAULT_LANGUAGE, &args); char* defaultLanguage; alljoyn_msgarg_get(args, "s", &defaultLanguage); EXPECT_STREQ("en", defaultLanguage); alljoyn_msgarg_getdictelement(aboutArg, "{sv}", AboutData::DEVICE_ID, &args); char* deviceId; alljoyn_msgarg_get(args, "s", &deviceId); EXPECT_STREQ("fakeID", deviceId); alljoyn_msgarg_getdictelement(aboutArg, "{sv}", AboutData::APP_NAME, &args); char* appName; alljoyn_msgarg_get(args, "s", &appName); EXPECT_STREQ("Application", appName); alljoyn_msgarg_getdictelement(aboutArg, "{sv}", AboutData::MANUFACTURER, &args); char* manufacturer; alljoyn_msgarg_get(args, "s", &manufacturer); EXPECT_STREQ("Manufacturer", manufacturer); alljoyn_msgarg_getdictelement(aboutArg, "{sv}", AboutData::MODEL_NUMBER, &args); char* modelNumber; alljoyn_msgarg_get(args, "s", &modelNumber); EXPECT_STREQ("123456", modelNumber); alljoyn_msgarg_destroy(aboutArg); alljoyn_aboutdata_destroy(aboutData); } TEST(AboutDataTest, GetMsgArg_es_language) { QStatus status = ER_FAIL; alljoyn_aboutdata aboutData = alljoyn_aboutdata_create("en"); uint8_t appId[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 }; status = alljoyn_aboutdata_setappid(aboutData, appId, 16); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setdeviceid(aboutData, "fakeID"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setappname(aboutData, "Application", "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setmanufacturer(aboutData, "Manufacturer", "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setmodelnumber(aboutData, "123456"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setdescription(aboutData, "A poetic description of this application", "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setsoftwareversion(aboutData, "0.1.2"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_TRUE(alljoyn_aboutdata_isvalid(aboutData, "en")); status = alljoyn_aboutdata_setsupportedlanguage(aboutData, "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setappname(aboutData, "aplicacion", "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setmanufacturer(aboutData, "manufactura", "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setdescription(aboutData, "Una descripcion poetica de esta aplicacion", "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_TRUE(alljoyn_aboutdata_isvalid(aboutData, "es")); alljoyn_msgarg aboutArg = alljoyn_msgarg_create(); alljoyn_msgarg args; status = alljoyn_aboutdata_getaboutdata(aboutData, aboutArg, "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg_getdictelement(aboutArg, "{sv}", AboutData::APP_ID, &args); int8_t* appIdOut; size_t appIdNum; alljoyn_msgarg_get(args, "ay", &appIdNum, &appIdOut); ASSERT_EQ(16u, appIdNum); for (size_t i = 0; i < appIdNum; ++i) { EXPECT_EQ(appId[i], appIdOut[i]); } alljoyn_msgarg_getdictelement(aboutArg, "{sv}", AboutData::DEFAULT_LANGUAGE, &args); char* defaultLanguage; alljoyn_msgarg_get(args, "s", &defaultLanguage); EXPECT_STREQ("en", defaultLanguage); alljoyn_msgarg_getdictelement(aboutArg, "{sv}", AboutData::DEVICE_ID, &args); char* deviceId; alljoyn_msgarg_get(args, "s", &deviceId); EXPECT_STREQ("fakeID", deviceId); alljoyn_msgarg_getdictelement(aboutArg, "{sv}", AboutData::APP_NAME, &args); char* appName; alljoyn_msgarg_get(args, "s", &appName); EXPECT_STREQ("aplicacion", appName); alljoyn_msgarg_getdictelement(aboutArg, "{sv}", AboutData::MANUFACTURER, &args); char* manufacturer; alljoyn_msgarg_get(args, "s", &manufacturer); EXPECT_STREQ("manufactura", manufacturer); alljoyn_msgarg_getdictelement(aboutArg, "{sv}", AboutData::MODEL_NUMBER, &args); char* modelNumber; alljoyn_msgarg_get(args, "s", &modelNumber); EXPECT_STREQ("123456", modelNumber); alljoyn_msgarg_destroy(aboutArg); alljoyn_aboutdata_destroy(aboutData); } TEST(AboutDataTest, GetMsgArg_language_not_supported) { QStatus status = ER_FAIL; alljoyn_aboutdata aboutData = alljoyn_aboutdata_create("en"); uint8_t appId[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 }; status = alljoyn_aboutdata_setappid(aboutData, appId, 16); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setdeviceid(aboutData, "fakeID"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setappname(aboutData, "Application", "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setmanufacturer(aboutData, "Manufacturer", "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setmodelnumber(aboutData, "123456"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setdescription(aboutData, "A poetic description of this application", "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setsoftwareversion(aboutData, "0.1.2"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_TRUE(alljoyn_aboutdata_isvalid(aboutData, "en")); status = alljoyn_aboutdata_setsupportedlanguage(aboutData, "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setappname(aboutData, "aplicacion", "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setmanufacturer(aboutData, "manufactura", "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setdescription(aboutData, "Una descripcion poetica de esta aplicacion", "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_TRUE(alljoyn_aboutdata_isvalid(aboutData, "es")); alljoyn_msgarg aboutArg = alljoyn_msgarg_create(); status = alljoyn_aboutdata_getaboutdata(aboutData, aboutArg, "fr"); EXPECT_EQ(ER_LANGUAGE_NOT_SUPPORTED, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg_destroy(aboutArg); alljoyn_aboutdata_destroy(aboutData); } TEST(AboutDataTest, InitUsingMsgArgBadSignature) { QStatus status = ER_FAIL; alljoyn_aboutdata aboutData = alljoyn_aboutdata_create("en"); alljoyn_msgarg notADictionary = alljoyn_msgarg_create_and_set("s", "incorrect type."); status = alljoyn_aboutdata_createfrommsgarg(aboutData, notADictionary, "en"); EXPECT_EQ(ER_BUS_SIGNATURE_MISMATCH, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg_destroy(notADictionary); alljoyn_aboutdata_destroy(aboutData); } TEST(AboutDataTest, UTF8_test) { char str[] = "привет"; QStatus status = ER_FAIL; alljoyn_aboutdata aboutData = alljoyn_aboutdata_create("en"); status = alljoyn_aboutdata_setappname(aboutData, str, "ru"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); char* esOut; status = alljoyn_aboutdata_getappname(aboutData, &esOut, "ru"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ(str, esOut); alljoyn_aboutdata_destroy(aboutData); } TEST(AboutDataTest, GetAnnouncedAboutData) { QStatus status = ER_FAIL; alljoyn_aboutdata aboutData = alljoyn_aboutdata_create("en"); uint8_t appId[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 }; status = alljoyn_aboutdata_setappid(aboutData, appId, 16); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setdeviceid(aboutData, "fakeID"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setappname(aboutData, "Application", "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setmanufacturer(aboutData, "Manufacturer", "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setmodelnumber(aboutData, "123456"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setdescription(aboutData, "A poetic description of this application", "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setsoftwareversion(aboutData, "0.1.2"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_TRUE(alljoyn_aboutdata_isvalid(aboutData, "en")); alljoyn_msgarg announceArg = alljoyn_msgarg_create(); status = alljoyn_aboutdata_getannouncedaboutdata(aboutData, announceArg); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg args; status = alljoyn_msgarg_getdictelement(announceArg, "{sv}", AboutData::APP_ID, &args); int8_t* appIdOut; size_t appIdNum; alljoyn_msgarg_get(args, "ay", &appIdNum, &appIdOut); ASSERT_EQ(16u, appIdNum); for (size_t i = 0; i < appIdNum; ++i) { EXPECT_EQ(appId[i], appIdOut[i]); } status = alljoyn_msgarg_getdictelement(announceArg, "{sv}", AboutData::DEFAULT_LANGUAGE, &args); char* defaultLanguage; alljoyn_msgarg_get(args, "s", &defaultLanguage); EXPECT_STREQ("en", defaultLanguage); status = alljoyn_msgarg_getdictelement(announceArg, "{sv}", AboutData::DEVICE_ID, &args); char* deviceId; alljoyn_msgarg_get(args, "s", &deviceId); EXPECT_STREQ("fakeID", deviceId); status = alljoyn_msgarg_getdictelement(announceArg, "{sv}", AboutData::APP_NAME, &args); char* appName; alljoyn_msgarg_get(args, "s", &appName); EXPECT_STREQ("Application", appName); status = alljoyn_msgarg_getdictelement(announceArg, "{sv}", AboutData::MANUFACTURER, &args); char* manufacturer; alljoyn_msgarg_get(args, "s", &manufacturer); EXPECT_STREQ("Manufacturer", manufacturer); status = alljoyn_msgarg_getdictelement(announceArg, "{sv}", AboutData::MODEL_NUMBER, &args); char* modelNumber; alljoyn_msgarg_get(args, "s", &modelNumber); EXPECT_STREQ("123456", modelNumber); alljoyn_msgarg_destroy(announceArg); alljoyn_aboutdata_destroy(aboutData); } TEST(AboutDataTest, SetOEMSpecificField) { QStatus status = ER_FAIL; alljoyn_aboutdata aboutData = alljoyn_aboutdata_create("en"); alljoyn_msgarg arg = alljoyn_msgarg_create(); status = alljoyn_msgarg_set(arg, "s", "888-555-1234"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setfield(aboutData, "SupportNumber", arg, "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_msgarg_set(arg, "s", "800-555-4321"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setfield(aboutData, "SupportNumber", arg, "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg value; status = alljoyn_aboutdata_getfield(aboutData, "SupportNumber", &value, "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); char buf[2]; alljoyn_msgarg_signature(value, buf, 2); EXPECT_STREQ("s", buf); const char* supportNumber; status = alljoyn_msgarg_get(value, "s", &supportNumber); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("888-555-1234", supportNumber); status = alljoyn_aboutdata_getfield(aboutData, "SupportNumber", &value, "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg_signature(value, buf, 2); EXPECT_STREQ("s", buf); status = alljoyn_msgarg_get(value, "s", &supportNumber); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("800-555-4321", supportNumber); alljoyn_msgarg_destroy(arg); alljoyn_aboutdata_destroy(aboutData); } TEST(AboutDataTest, GetMsgArgWithOEMSpecificField) { QStatus status = ER_FAIL; alljoyn_aboutdata aboutData = alljoyn_aboutdata_create("en"); uint8_t appId[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 }; status = alljoyn_aboutdata_setappid(aboutData, appId, 16); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setdeviceid(aboutData, "fakeID"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setappname(aboutData, "Application", "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setmanufacturer(aboutData, "Manufacturer", "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setmodelnumber(aboutData, "123456"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setdescription(aboutData, "A poetic description of this application", "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setsoftwareversion(aboutData, "0.1.2"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_TRUE(alljoyn_aboutdata_isvalid(aboutData, "en")); status = alljoyn_aboutdata_setsupportedlanguage(aboutData, "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setappname(aboutData, "aplicacion", "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setmanufacturer(aboutData, "manufactura", "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setdescription(aboutData, "Una descripcion poetica de esta aplicacion", "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_TRUE(alljoyn_aboutdata_isvalid(aboutData, "es")); alljoyn_msgarg arg = alljoyn_msgarg_create(); status = alljoyn_msgarg_set(arg, "s", "888-555-1234"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setfield(aboutData, "SupportNumber", arg, "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_msgarg_set(arg, "s", "800-555-4321"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setfield(aboutData, "SupportNumber", arg, "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg aboutArg = alljoyn_msgarg_create(); status = alljoyn_aboutdata_getaboutdata(aboutData, aboutArg, "en"); alljoyn_msgarg args; status = alljoyn_msgarg_getdictelement(aboutArg, "{sv}", AboutData::APP_ID, &args); int8_t* appIdOut; size_t appIdNum; alljoyn_msgarg_get(args, "ay", &appIdNum, &appIdOut); ASSERT_EQ(16u, appIdNum); for (size_t i = 0; i < appIdNum; ++i) { EXPECT_EQ(appId[i], appIdOut[i]); } status = alljoyn_msgarg_getdictelement(aboutArg, "{sv}", AboutData::DEFAULT_LANGUAGE, &args); char* defaultLanguage; alljoyn_msgarg_get(args, "s", &defaultLanguage); EXPECT_STREQ("en", defaultLanguage); status = alljoyn_msgarg_getdictelement(aboutArg, "{sv}", AboutData::DEVICE_ID, &args); char* deviceId; alljoyn_msgarg_get(args, "s", &deviceId); EXPECT_STREQ("fakeID", deviceId); status = alljoyn_msgarg_getdictelement(aboutArg, "{sv}", AboutData::APP_NAME, &args); char* appName; alljoyn_msgarg_get(args, "s", &appName); EXPECT_STREQ("Application", appName); status = alljoyn_msgarg_getdictelement(aboutArg, "{sv}", AboutData::MANUFACTURER, &args); char* manufacturer; alljoyn_msgarg_get(args, "s", &manufacturer); EXPECT_STREQ("Manufacturer", manufacturer); status = alljoyn_msgarg_getdictelement(aboutArg, "{sv}", AboutData::MODEL_NUMBER, &args); char* modelNumber; alljoyn_msgarg_get(args, "s", &modelNumber); EXPECT_STREQ("123456", modelNumber); status = alljoyn_msgarg_getdictelement(aboutArg, "{sv}", "SupportNumber", &args); char* supportNumber; alljoyn_msgarg_get(args, "s", &supportNumber); EXPECT_STREQ("888-555-1234", supportNumber); alljoyn_msgarg_destroy(aboutArg); alljoyn_aboutdata_destroy(aboutData); } TEST(AboutDataTest, InitUsingMsgArg) { QStatus status = ER_FAIL; alljoyn_aboutdata aboutData = alljoyn_aboutdata_create("en"); uint8_t originalAppId[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 }; status = alljoyn_aboutdata_setappid(aboutData, originalAppId, 16); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setdeviceid(aboutData, "fakeID"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setappname(aboutData, "Application", "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setmanufacturer(aboutData, "Manufacturer", "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setmodelnumber(aboutData, "123456"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setdescription(aboutData, "A poetic description of this application", "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setsoftwareversion(aboutData, "0.1.2"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_TRUE(alljoyn_aboutdata_isvalid(aboutData, "en")); status = alljoyn_aboutdata_setsupportedlanguage(aboutData, "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setappname(aboutData, "aplicacion", "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setmanufacturer(aboutData, "manufactura", "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setdescription(aboutData, "Una descripcion poetica de esta aplicacion", "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_TRUE(alljoyn_aboutdata_isvalid(aboutData, "es")); alljoyn_msgarg arg = alljoyn_msgarg_create(); status = alljoyn_msgarg_set(arg, "s", "888-555-1234"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setfield(aboutData, "SupportNumber", arg, "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_msgarg_set(arg, "s", "800-555-4321"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setfield(aboutData, "SupportNumber", arg, "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg aboutArg = alljoyn_msgarg_create(); status = alljoyn_aboutdata_getaboutdata(aboutData, aboutArg, "en"); alljoyn_aboutdata aboutDataInit = alljoyn_aboutdata_create("en"); status = alljoyn_aboutdata_createfrommsgarg(aboutDataInit, aboutArg, "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); uint8_t* appId; size_t num; status = alljoyn_aboutdata_getappid(aboutDataInit, &appId, &num); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_EQ(16u, num); for (size_t i = 0; i < num; i++) { EXPECT_EQ(originalAppId[i], appId[i]); } char* deviceId; status = alljoyn_aboutdata_getdeviceid(aboutDataInit, &deviceId); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("fakeID", deviceId); char* appName; status = alljoyn_aboutdata_getappname(aboutDataInit, &appName, "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("Application", appName); char* manufacturer; status = alljoyn_aboutdata_getmanufacturer(aboutDataInit, &manufacturer, "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("Manufacturer", manufacturer); char* modelNumber; status = alljoyn_aboutdata_getmodelnumber(aboutDataInit, &modelNumber); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("123456", modelNumber); char* description; status = alljoyn_aboutdata_getdescription(aboutDataInit, &description, "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("A poetic description of this application", description); alljoyn_msgarg value; alljoyn_aboutdata_getfield(aboutDataInit, "SupportNumber", &value, "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); char buf[2]; alljoyn_msgarg_signature(value, buf, 2); EXPECT_STREQ("s", buf); const char* supportNumber; status = alljoyn_msgarg_get(value, "s", &supportNumber); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("888-555-1234", supportNumber); size_t number_languages = alljoyn_aboutdata_getsupportedlanguages(aboutDataInit, NULL, 0); EXPECT_EQ(2u, number_languages); /* TODO complete the test for language and other required */ alljoyn_msgarg_destroy(aboutArg); alljoyn_aboutdata_destroy(aboutData); alljoyn_aboutdata_destroy(aboutDataInit); } TEST(AboutDataTest, caseInsensitiveLanguageTag) { QStatus status = ER_FAIL; alljoyn_aboutdata aboutData = alljoyn_aboutdata_create("en"); char* language; status = alljoyn_aboutdata_getdefaultlanguage(aboutData, &language); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("en", language); status = alljoyn_aboutdata_setdevicename(aboutData, "Device", "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setdevicename(aboutData, "dispositivo", "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); size_t num_langs; num_langs = alljoyn_aboutdata_getsupportedlanguages(aboutData, NULL, 0); EXPECT_EQ(2u, num_langs); status = alljoyn_aboutdata_setdevicename(aboutData, "Device", "EN"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); num_langs = alljoyn_aboutdata_getsupportedlanguages(aboutData, NULL, 0); EXPECT_EQ(2u, num_langs); status = alljoyn_aboutdata_setdevicename(aboutData, "Device", "En"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); num_langs = alljoyn_aboutdata_getsupportedlanguages(aboutData, NULL, 0); EXPECT_EQ(2u, num_langs); status = alljoyn_aboutdata_setdevicename(aboutData, "Device", "eN"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); num_langs = alljoyn_aboutdata_getsupportedlanguages(aboutData, NULL, 0); EXPECT_EQ(2u, num_langs); status = alljoyn_aboutdata_setdevicename(aboutData, "dispositivo", "ES"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); num_langs = alljoyn_aboutdata_getsupportedlanguages(aboutData, NULL, 0); EXPECT_EQ(2u, num_langs); status = alljoyn_aboutdata_setdevicename(aboutData, "dispositivo", "Es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); num_langs = alljoyn_aboutdata_getsupportedlanguages(aboutData, NULL, 0); EXPECT_EQ(2u, num_langs); status = alljoyn_aboutdata_setdevicename(aboutData, "dispositivo", "eS"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); num_langs = alljoyn_aboutdata_getsupportedlanguages(aboutData, NULL, 0); EXPECT_EQ(2u, num_langs); char* deviceName; status = alljoyn_aboutdata_getdevicename(aboutData, &deviceName, "EN"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("Device", deviceName); deviceName = NULL; status = alljoyn_aboutdata_getdevicename(aboutData, &deviceName, "En"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("Device", deviceName); deviceName = NULL; status = alljoyn_aboutdata_getdevicename(aboutData, &deviceName, "eN"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("Device", deviceName); deviceName = NULL; status = alljoyn_aboutdata_getdevicename(aboutData, &deviceName, "ES"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("dispositivo", deviceName); deviceName = NULL; status = alljoyn_aboutdata_getdevicename(aboutData, &deviceName, "Es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("dispositivo", deviceName); deviceName = NULL; status = alljoyn_aboutdata_getdevicename(aboutData, &deviceName, "eS"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("dispositivo", deviceName); alljoyn_aboutdata_destroy(aboutData); } /* Needs fix in alljoyn_c/src/AboutData.cc */ TEST(AboutDataTest, CreateFromXml) { QStatus status = ER_FAIL; alljoyn_aboutdata aboutData = alljoyn_aboutdata_create("en"); char xml[] = "" " 000102030405060708090A0B0C0D0E0C" " en" " My Device Name" " Nombre de mi dispositivo" " baddeviceid" " My Application Name" " Mi Nombre de la aplicación" " Company" " Empresa" " Wxfy388i" " A detailed description provided by the application." " Una descripción detallada proporcionada por la aplicación." " 2014-01-08" " 1.0.0" " 1.0.0" " www.example.com" " Can only accept strings anything other than strings must be done using the AboutData Class SetField method" " Sólo se puede aceptar cadenas distintas de cadenas nada debe hacerse utilizando el método AboutData Clase SetField" ""; status = alljoyn_aboutdata_createfromxml(aboutData, xml); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* OriginalAppId is the string 000102030405060708090A0B0C0D0E0C converted to an array of bytes */ uint8_t originalAppId[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 12 }; uint8_t* appId; size_t num; status = alljoyn_aboutdata_getappid(aboutData, &appId, &num); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_EQ(16u, num); for (size_t i = 0; i < num; i++) { EXPECT_EQ(originalAppId[i], appId[i]) << i << ": " << originalAppId[i] << " = " << appId[i]; } char* defaultLanguage; status = alljoyn_aboutdata_getdefaultlanguage(aboutData, &defaultLanguage); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("en", defaultLanguage); char* deviceName; status = alljoyn_aboutdata_getdevicename(aboutData, &deviceName, "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("My Device Name", deviceName); status = alljoyn_aboutdata_getdevicename(aboutData, &deviceName, "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("Nombre de mi dispositivo", deviceName); char* deviceId; status = alljoyn_aboutdata_getdeviceid(aboutData, &deviceId); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("baddeviceid", deviceId); char* appName; status = alljoyn_aboutdata_getappname(aboutData, &appName, "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("My Application Name", appName); status = alljoyn_aboutdata_getappname(aboutData, &appName, "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("Mi Nombre de la aplicación", appName); char* manufacturer; status = alljoyn_aboutdata_getmanufacturer(aboutData, &manufacturer, "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("Company", manufacturer); status = alljoyn_aboutdata_getmanufacturer(aboutData, &manufacturer, "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("Empresa", manufacturer); size_t numLanguages = alljoyn_aboutdata_getsupportedlanguages(aboutData, NULL, 0); const char** languages = new const char*[numLanguages]; size_t numRetLang = alljoyn_aboutdata_getsupportedlanguages(aboutData, languages, numLanguages); EXPECT_EQ(numLanguages, numRetLang); EXPECT_EQ(2u, numLanguages); EXPECT_STREQ("en", languages[0]); EXPECT_STREQ("es", languages[1]); delete [] languages; languages = NULL; char* description; status = alljoyn_aboutdata_getdescription(aboutData, &description, "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("A detailed description provided by the application.", description); status = alljoyn_aboutdata_getdescription(aboutData, &description, "es"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("Una descripción detallada proporcionada por la aplicación.", description); char* modelNumber; status = alljoyn_aboutdata_getmodelnumber(aboutData, &modelNumber); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("Wxfy388i", modelNumber); char* dateOfManufacture; status = alljoyn_aboutdata_getdateofmanufacture(aboutData, &dateOfManufacture); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("2014-01-08", dateOfManufacture); char* softwareVersion; status = alljoyn_aboutdata_getsoftwareversion(aboutData, &softwareVersion); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("1.0.0", softwareVersion); char* ajSoftwareVersion; alljoyn_aboutdata_getajsoftwareversion(aboutData, &ajSoftwareVersion); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ(ajn::GetVersion(), ajSoftwareVersion); char* hardwareVersion; status = alljoyn_aboutdata_gethardwareversion(aboutData, &hardwareVersion); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("1.0.0", hardwareVersion); char* supportUrl; status = alljoyn_aboutdata_getsupporturl(aboutData, &supportUrl); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("www.example.com", supportUrl); alljoyn_aboutdata_destroy(aboutData); } alljoyn-15.04b/alljoyn_c/unit_test/AboutIconTest.cc000066400000000000000000000435361255700255500224000ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #include #include #include #include #include #include "ajTestCommon.h" #include #include #include using namespace ajn; static const size_t MAX_ICON_SIZE_IN_BYTES = ALLJOYN_MAX_ARRAY_LEN; static const uint8_t ICON_BYTE = 0x11; typedef struct large_icon_t { uint8_t* iconByteArrayPtr; size_t iconSize; } large_icon; static large_icon* create_large_icon(size_t iconsize) { large_icon* result = (large_icon*) malloc(sizeof(large_icon)); size_t iconByte = 0; result->iconSize = iconsize; result->iconByteArrayPtr = (uint8_t*) malloc(sizeof(uint8_t) * iconsize); if (!(result->iconByteArrayPtr)) { free(result); return NULL; } for (; iconByte < iconsize; iconByte++) { result->iconByteArrayPtr[iconByte] = ICON_BYTE; } return result; } static void destroy_large_icon(large_icon* icon) { if (!icon) { return; } if (icon->iconByteArrayPtr) { free(icon->iconByteArrayPtr); icon->iconByteArrayPtr = NULL; } free(icon); icon = NULL; } TEST(AboutIconTest, isAnnounced) { QStatus status = ER_FAIL; alljoyn_busattachment g_msgBus = alljoyn_busattachment_create("AboutIconTest", QCC_TRUE); status = alljoyn_busattachment_start(g_msgBus); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(g_msgBus, NULL); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_abouticon icon = alljoyn_abouticon_create(); status = alljoyn_abouticon_seturl(icon, "image/png", "http://www.example.com"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_abouticonobj aboutIcon = alljoyn_abouticonobj_create(g_msgBus, icon); alljoyn_msgarg aodArg = alljoyn_msgarg_create(); status = (*(ajn::BusAttachment*) g_msgBus).GetInternal().GetAnnouncedObjectDescription(*(ajn::MsgArg*)aodArg); alljoyn_aboutobjectdescription aod = alljoyn_aboutobjectdescription_create_full(aodArg); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_TRUE(alljoyn_aboutobjectdescription_haspath(aod, "/About/DeviceIcon")); alljoyn_abouticonobj_destroy(aboutIcon); status = alljoyn_busattachment_stop(g_msgBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(g_msgBus); alljoyn_busattachment_destroy(g_msgBus); } TEST(AboutIconTest, GetVersion) { QStatus status = ER_FAIL; alljoyn_busattachment serviceBus = alljoyn_busattachment_create("AboutIconTest service", QCC_TRUE); status = alljoyn_busattachment_start(serviceBus); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(serviceBus, NULL); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_abouticon icon = alljoyn_abouticon_create(); status = alljoyn_abouticon_seturl(icon, "image/png", "http://www.example.com"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_abouticonobj aboutIcon = alljoyn_abouticonobj_create(serviceBus, icon); alljoyn_busattachment clientBus = alljoyn_busattachment_create("AboutIconTest client", QCC_TRUE); status = alljoyn_busattachment_start(clientBus); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(clientBus, NULL); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); const char* serviceBusName = alljoyn_busattachment_getuniquename(serviceBus); alljoyn_abouticonproxy aiProxy = alljoyn_abouticonproxy_create(clientBus, serviceBusName, 0); uint16_t version; status = alljoyn_abouticonproxy_getversion(aiProxy, &version); EXPECT_EQ(((ajn::AboutIconObj*)aboutIcon)->VERSION, version); alljoyn_abouticon_destroy(icon); alljoyn_abouticonobj_destroy(aboutIcon); alljoyn_abouticonproxy_destroy(aiProxy); status = alljoyn_busattachment_stop(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(clientBus); alljoyn_busattachment_destroy(clientBus); status = alljoyn_busattachment_stop(serviceBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(serviceBus); alljoyn_busattachment_destroy(serviceBus); } TEST(AboutIconTest, GetUrl) { QStatus status = ER_FAIL; alljoyn_busattachment serviceBus = alljoyn_busattachment_create("AboutIconTest Service", QCC_TRUE); status = alljoyn_busattachment_start(serviceBus); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(serviceBus, NULL); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_abouticon icon = alljoyn_abouticon_create(); status = alljoyn_abouticon_seturl(icon, "image/png", "http://www.example.com"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_abouticonobj aboutIcon = alljoyn_abouticonobj_create(serviceBus, icon); alljoyn_busattachment clientBus = alljoyn_busattachment_create("AboutIconTest Client", QCC_TRUE); status = alljoyn_busattachment_start(clientBus); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(clientBus, NULL); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); const char* serviceBusName = alljoyn_busattachment_getuniquename(serviceBus); alljoyn_abouticonproxy aiProxy = alljoyn_abouticonproxy_create(clientBus, serviceBusName, 0); alljoyn_abouticon iconReceived = alljoyn_abouticon_create(); status = alljoyn_abouticonproxy_geticon(aiProxy, iconReceived); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); const char* url = ((ajn::AboutIcon*)iconReceived)->url.c_str(); EXPECT_STREQ("http://www.example.com", url); alljoyn_abouticon_destroy(icon); alljoyn_abouticon_destroy(iconReceived); alljoyn_abouticonobj_destroy(aboutIcon); alljoyn_abouticonproxy_destroy(aiProxy); status = alljoyn_busattachment_stop(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(clientBus); status = alljoyn_busattachment_stop(serviceBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(serviceBus); alljoyn_busattachment_destroy(clientBus); alljoyn_busattachment_destroy(serviceBus); } TEST(AboutIconTest, GetIcon) { QStatus status = ER_FAIL; alljoyn_busattachment serviceBus = alljoyn_busattachment_create("AboutIconTest Service", QCC_TRUE); status = alljoyn_busattachment_start(serviceBus); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(serviceBus, NULL); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); uint8_t aboutIconContent[] = { 0x89, 0x50, 0x4E, 0x47, 0x0D, 0x0A, 0x1A, 0x0A, 0x00, 0x00, 0x00, 0x0D, 0x49, 0x48, 0x44, 0x52, 0x00, 0x00, 0x00, 0x0A, 0x00, 0x00, 0x00, 0x0A, 0x08, 0x02, 0x00, 0x00, 0x00, 0x02, 0x50, 0x58, 0xEA, 0x00, 0x00, 0x00, 0x04, 0x67, 0x41, 0x4D, 0x41, 0x00, 0x00, 0xAF, 0xC8, 0x37, 0x05, 0x8A, 0xE9, 0x00, 0x00, 0x00, 0x19, 0x74, 0x45, 0x58, 0x74, 0x53, 0x6F, 0x66, 0x74, 0x77, 0x61, 0x72, 0x65, 0x00, 0x41, 0x64, 0x6F, 0x62, 0x65, 0x20, 0x49, 0x6D, 0x61, 0x67, 0x65, 0x52, 0x65, 0x61, 0x64, 0x79, 0x71, 0xC9, 0x65, 0x3C, 0x00, 0x00, 0x00, 0x18, 0x49, 0x44, 0x41, 0x54, 0x78, 0xDA, 0x62, 0xFC, 0x3F, 0x95, 0x9F, 0x01, 0x37, 0x60, 0x62, 0xC0, 0x0B, 0x46, 0xAA, 0x34, 0x40, 0x80, 0x01, 0x00, 0x06, 0x7C, 0x01, 0xB7, 0xED, 0x4B, 0x53, 0x2C, 0x00, 0x00, 0x00, 0x00, 0x49, 0x45, 0x4E, 0x44, 0xAE, 0x42, 0x60, 0x82 }; alljoyn_abouticon icon = alljoyn_abouticon_create(); status = alljoyn_abouticon_setcontent(icon, "image/png", aboutIconContent, sizeof(aboutIconContent) / sizeof(aboutIconContent[0]), false); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_abouticonobj aboutIcon = alljoyn_abouticonobj_create(serviceBus, icon); alljoyn_busattachment clientBus = alljoyn_busattachment_create("AboutIconTest Client", QCC_TRUE); status = alljoyn_busattachment_start(clientBus); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(clientBus, NULL); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); const char* serviceBusName = alljoyn_busattachment_getuniquename(serviceBus); alljoyn_abouticonproxy aiProxy = alljoyn_abouticonproxy_create(clientBus, serviceBusName, 0); alljoyn_abouticon iconReceived = alljoyn_abouticon_create(); status = alljoyn_abouticonproxy_geticon(aiProxy, iconReceived); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("image/png", ((ajn::AboutIcon*)iconReceived)->mimetype.c_str()); ASSERT_EQ(sizeof(aboutIconContent) / sizeof(aboutIconContent[0]), ((ajn::AboutIcon*)iconReceived)->contentSize); for (size_t i = 0; i < ((ajn::AboutIcon*)iconReceived)->contentSize; ++i) { EXPECT_EQ(aboutIconContent[i], ((ajn::AboutIcon*)iconReceived)->content[i]); } EXPECT_STREQ(((ajn::AboutIcon*)icon)->mimetype.c_str(), ((ajn::AboutIcon*)iconReceived)->mimetype.c_str()); alljoyn_abouticon_destroy(icon); alljoyn_abouticon_destroy(iconReceived); alljoyn_abouticonobj_destroy(aboutIcon); alljoyn_abouticonproxy_destroy(aiProxy); status = alljoyn_busattachment_stop(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(clientBus); alljoyn_busattachment_destroy(clientBus); status = alljoyn_busattachment_stop(serviceBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(serviceBus); alljoyn_busattachment_destroy(serviceBus); } TEST(AboutIconTest, GetLargeIcon) { QStatus status = ER_FAIL; large_icon* myIcon = create_large_icon(MAX_ICON_SIZE_IN_BYTES); ASSERT_TRUE(myIcon && NULL != myIcon->iconByteArrayPtr && myIcon->iconSize == MAX_ICON_SIZE_IN_BYTES); alljoyn_busattachment serviceBus = alljoyn_busattachment_create("AboutLargeIconTest Service", QCC_TRUE); status = alljoyn_busattachment_start(serviceBus); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(serviceBus, NULL); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); const char* mimeType = "image/png"; alljoyn_abouticon icon = alljoyn_abouticon_create(); alljoyn_abouticon_setcontent(icon, mimeType, myIcon->iconByteArrayPtr, myIcon->iconSize, QCC_FALSE); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_abouticonobj aboutIcon = alljoyn_abouticonobj_create(serviceBus, icon); alljoyn_busattachment clientBus = alljoyn_busattachment_create("AboutLargeIconTest Client", QCC_TRUE); status = alljoyn_busattachment_start(clientBus); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(clientBus, NULL); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); const char* serviceBusName = alljoyn_busattachment_getuniquename(serviceBus); alljoyn_abouticonproxy aiProxy = alljoyn_abouticonproxy_create(clientBus, serviceBusName, 0); alljoyn_abouticon iconOut = alljoyn_abouticon_create(); status = alljoyn_abouticonproxy_geticon(aiProxy, iconOut); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("image/png", ((ajn::AboutIcon*)iconOut)->mimetype.c_str()); ASSERT_EQ(MAX_ICON_SIZE_IN_BYTES, ((ajn::AboutIcon*)iconOut)->contentSize); for (size_t i = 0; i < ((ajn::AboutIcon*)iconOut)->contentSize; ++i) { EXPECT_EQ(myIcon->iconByteArrayPtr[i], ((ajn::AboutIcon*)iconOut)->content[i]); } EXPECT_EQ(MAX_ICON_SIZE_IN_BYTES, ((ajn::AboutIcon*)iconOut)->contentSize); EXPECT_STREQ(mimeType, ((ajn::AboutIcon*)iconOut)->mimetype.c_str()); destroy_large_icon(myIcon); alljoyn_abouticon_destroy(icon); alljoyn_abouticonobj_destroy(aboutIcon); alljoyn_abouticonproxy_destroy(aiProxy); alljoyn_abouticon_destroy(iconOut); status = alljoyn_busattachment_stop(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(clientBus); alljoyn_busattachment_destroy(clientBus); status = alljoyn_busattachment_stop(serviceBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(serviceBus); alljoyn_busattachment_destroy(serviceBus); } TEST(AboutIconTest, GetLargeIcon_Negative) { QStatus status = ER_FAIL; large_icon* myIcon = create_large_icon(MAX_ICON_SIZE_IN_BYTES + 1); ASSERT_TRUE(myIcon && NULL != myIcon->iconByteArrayPtr && myIcon->iconSize == MAX_ICON_SIZE_IN_BYTES + 1); alljoyn_busattachment serviceBus = alljoyn_busattachment_create("AboutLargeIconTest Service", QCC_TRUE); status = alljoyn_busattachment_start(serviceBus); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(serviceBus, NULL); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); const char* mimeType = "image/png"; alljoyn_abouticon iconIn = alljoyn_abouticon_create(); status = alljoyn_abouticon_setcontent(iconIn, mimeType, myIcon->iconByteArrayPtr, (MAX_ICON_SIZE_IN_BYTES + 1), QCC_FALSE); EXPECT_EQ(ER_BUS_BAD_VALUE, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_abouticonobj aboutIcon = alljoyn_abouticonobj_create(serviceBus, iconIn); alljoyn_busattachment clientBus = alljoyn_busattachment_create("AboutLargeIconTest Client", QCC_TRUE); status = alljoyn_busattachment_start(clientBus); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(clientBus, NULL); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); const char* serviceBusName = alljoyn_busattachment_getuniquename(serviceBus); alljoyn_abouticonproxy aiProxy = alljoyn_abouticonproxy_create(clientBus, serviceBusName, 0); alljoyn_abouticon iconOut = alljoyn_abouticon_create(); status = alljoyn_abouticonproxy_geticon(aiProxy, iconOut); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("", ((ajn::AboutIcon*)iconOut)->mimetype.c_str()); ASSERT_EQ(0u, ((ajn::AboutIcon*)iconOut)->contentSize); destroy_large_icon(myIcon); alljoyn_abouticon_destroy(iconIn); alljoyn_abouticonobj_destroy(aboutIcon); alljoyn_abouticonproxy_destroy(aiProxy); alljoyn_abouticon_destroy(iconOut); status = alljoyn_busattachment_stop(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(clientBus); alljoyn_busattachment_destroy(clientBus); status = alljoyn_busattachment_stop(serviceBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(serviceBus); alljoyn_busattachment_destroy(serviceBus); } alljoyn-15.04b/alljoyn_c/unit_test/AboutListenerTest.cc000066400000000000000000002303351255700255500232700ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #include #include #include #include "AboutListenerTestApi.h" #define WAIT_TIME 5 extern QCC_BOOL announceListenerFlags[]; static QCC_BOOL my_sessionportlistener_acceptsessionjoiner(const void* context, alljoyn_sessionport sessionPort, const char* joiner, const alljoyn_sessionopts opts) { QCC_UNUSED(context); QCC_UNUSED(sessionPort); QCC_UNUSED(joiner); QCC_UNUSED(opts); return QCC_TRUE; } class AboutListenerTest : public testing::Test { public: AboutListenerTest() { serviceBus = NULL; port = 25; aboutData = alljoyn_aboutdata_create("en"); } virtual void SetUp() { QStatus status; serviceBus = alljoyn_busattachment_create("AnnounceListenerTest", QCC_TRUE); status = alljoyn_busattachment_start(serviceBus); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(serviceBus, NULL); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* Setup the about data */ qcc::GUID128 appId; status = alljoyn_aboutdata_setappid(aboutData, appId.GetBytes(), qcc::GUID128::SIZE); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setdevicename(aboutData, "My Device Name", "en"); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); qcc::GUID128 deviceId; status = alljoyn_aboutdata_setdeviceid(aboutData, deviceId.ToString().c_str()); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setappname(aboutData, "Application", "en"); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setmanufacturer(aboutData, "Manufacturer", "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setmodelnumber(aboutData, "123456"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setdescription(aboutData, "A poetic description of this application", "en"); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setdateofmanufacture(aboutData, "2014-03-24"); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setsoftwareversion(aboutData, "0.1.2"); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_sethardwareversion(aboutData, "0.0.1"); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setsupporturl(aboutData, "http://www.alljoyn.org"); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_TRUE(alljoyn_aboutdata_isvalid(aboutData, "en")); alljoyn_sessionportlistener_callbacks callbacks = { &my_sessionportlistener_acceptsessionjoiner }; alljoyn_sessionopts opts = alljoyn_sessionopts_create(ALLJOYN_TRAFFIC_TYPE_MESSAGES, QCC_FALSE, ALLJOYN_PROXIMITY_ANY, ALLJOYN_TRANSPORT_ANY); alljoyn_sessionportlistener listener = alljoyn_sessionportlistener_create(&callbacks, NULL); status = alljoyn_busattachment_bindsessionport(serviceBus, &port, opts, listener); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); } virtual void TearDown() { if (serviceBus) { alljoyn_busattachment_stop(serviceBus); alljoyn_busattachment_join(serviceBus); alljoyn_busattachment_destroy(serviceBus); serviceBus = NULL; } if (aboutData) { alljoyn_aboutdata_destroy(aboutData); aboutData = NULL; } } alljoyn_busattachment serviceBus; alljoyn_aboutdata aboutData; alljoyn_sessionport port; }; TEST_F(AboutListenerTest, ReceiverAnnouncement) { QStatus status; qcc::GUID128 guid; qcc::String ifaceNameQcc = "org.test.a" + guid.ToString() + ".AnnounceHandlerTest"; zero_announceListenerFlags(); alljoyn_aboutobj aboutObj = alljoyn_aboutobj_create(serviceBus, UNANNOUNCED); const qcc::String interfaceQcc = "" "" " " " " "" ""; const char* interface = interfaceQcc.c_str(); const char* ifaceName = ifaceNameQcc.c_str(); status = alljoyn_busattachment_createinterfacesfromxml(serviceBus, interface); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busobject altObj = create_about_obj_test_bus_object(serviceBus, "/org/test/about", ifaceName); status = alljoyn_busattachment_registerbusobject(serviceBus, altObj); alljoyn_busattachment clientBus = alljoyn_busattachment_create("Receive Announcement client Test", QCC_TRUE); status = alljoyn_busattachment_start(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(clientBus, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); about_test_about_listener* aboutListener = create_about_test_about_listener(0); alljoyn_busattachment_registeraboutlistener(clientBus, aboutListener->listener); status = alljoyn_busattachment_whoimplements_interface(clientBus, ifaceName); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_aboutobj_announce(aboutObj, port, aboutData); /* Wait for a maximum of 10 sec for the Announce Signal */ for (int msec = 0; msec < 10000; msec += WAIT_TIME) { if (announceListenerFlags[0]) { break; } qcc::Sleep(WAIT_TIME); } ASSERT_TRUE(announceListenerFlags[0]); alljoyn_busattachment_cancelwhoimplements_interface(clientBus, ifaceName); alljoyn_busattachment_unregisteraboutlistener(clientBus, aboutListener->listener); status = alljoyn_busattachment_stop(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); destroy_about_test_about_listener(aboutListener); destroy_about_obj_test_bus_object(altObj); alljoyn_aboutobj_destroy(aboutObj); alljoyn_busattachment_destroy(clientBus); } TEST_F(AboutListenerTest, ReceiveAnnouncementNullWhoImplementsValue) { QStatus status; qcc::GUID128 guid; qcc::String ifaceNameQcc = "org.test.a" + guid.ToString() + ".AnnounceHandlerTest"; zero_announceListenerFlags(); alljoyn_aboutobj aboutObj = alljoyn_aboutobj_create(serviceBus, UNANNOUNCED); const qcc::String interfaceQcc = "" "" " " " " "" ""; const char* interface = interfaceQcc.c_str(); const char* ifaceName = ifaceNameQcc.c_str(); status = alljoyn_busattachment_createinterfacesfromxml(serviceBus, interface); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busobject altObj = create_about_obj_test_bus_object(serviceBus, "/org/test/about", ifaceName); status = alljoyn_busattachment_registerbusobject(serviceBus, altObj); alljoyn_busattachment clientBus = alljoyn_busattachment_create("Receive Announcement client Test", QCC_TRUE); status = alljoyn_busattachment_start(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(clientBus, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); about_test_about_listener* aboutListener = create_about_test_about_listener(0); alljoyn_busattachment_registeraboutlistener(clientBus, aboutListener->listener); status = alljoyn_busattachment_whoimplements_interface(clientBus, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_aboutobj_announce(aboutObj, port, aboutData); /* Wait for a maximum of 10 sec for the Announce Signal */ for (int msec = 0; msec < 10000; msec += WAIT_TIME) { if (announceListenerFlags[0]) { break; } qcc::Sleep(WAIT_TIME); } ASSERT_TRUE(announceListenerFlags[0]); alljoyn_busattachment_cancelwhoimplements_interface(clientBus, NULL); alljoyn_busattachment_unregisteraboutlistener(clientBus, aboutListener->listener); status = alljoyn_busattachment_stop(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); destroy_about_test_about_listener(aboutListener); destroy_about_obj_test_bus_object(altObj); alljoyn_aboutobj_destroy(aboutObj); alljoyn_busattachment_destroy(clientBus); } TEST_F(AboutListenerTest, ReAnnounceAnnouncement) { QStatus status; qcc::GUID128 guid; qcc::String ifaceNameQcc = "org.test.a" + guid.ToString() + ".AnnounceHandlerTest"; zero_announceListenerFlags(); alljoyn_aboutobj aboutObj = alljoyn_aboutobj_create(serviceBus, UNANNOUNCED); const qcc::String interfaceQcc = "" "" " " " " "" ""; const char* interface = interfaceQcc.c_str(); const char* ifaceName = ifaceNameQcc.c_str(); status = alljoyn_busattachment_createinterfacesfromxml(serviceBus, interface); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busobject altObj = create_about_obj_test_bus_object(serviceBus, "/org/test/about", ifaceName); status = alljoyn_busattachment_registerbusobject(serviceBus, altObj); alljoyn_busattachment clientBus = alljoyn_busattachment_create("Receive Announcement client Test", QCC_TRUE); status = alljoyn_busattachment_start(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(clientBus, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); about_test_about_listener* aboutListener = create_about_test_about_listener(0); alljoyn_busattachment_registeraboutlistener(clientBus, aboutListener->listener); status = alljoyn_busattachment_whoimplements_interface(clientBus, ifaceName); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_aboutobj_announce(aboutObj, port, aboutData); /* Wait for a maximum of 10 sec for the Announce Signal */ for (int msec = 0; msec < 10000; msec += WAIT_TIME) { if (announceListenerFlags[0]) { break; } qcc::Sleep(WAIT_TIME); } ASSERT_TRUE(announceListenerFlags[0]); announceListenerFlags[0] = QCC_FALSE; alljoyn_aboutobj_announce(aboutObj, port, aboutData); /* Wait for a maximum of 10 sec for the Announce Signal */ for (int msec = 0; msec < 10000; msec += WAIT_TIME) { if (announceListenerFlags[0]) { break; } qcc::Sleep(WAIT_TIME); } ASSERT_TRUE(announceListenerFlags[0]); alljoyn_busattachment_cancelwhoimplements_interface(clientBus, ifaceName); alljoyn_busattachment_unregisteraboutlistener(clientBus, aboutListener->listener); status = alljoyn_busattachment_stop(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); destroy_about_test_about_listener(aboutListener); destroy_about_obj_test_bus_object(altObj); alljoyn_aboutobj_destroy(aboutObj); alljoyn_busattachment_destroy(clientBus); } TEST_F(AboutListenerTest, ReceiveAnnouncementRegisterThenAddInterface) { QStatus status; qcc::GUID128 guid; qcc::String ifaceNameQcc = "org.test.a" + guid.ToString() + ".AnnounceHandlerTest"; zero_announceListenerFlags(); alljoyn_aboutobj aboutObj = alljoyn_aboutobj_create(serviceBus, UNANNOUNCED); const qcc::String interfaceQcc = "" "" " " " " "" ""; const char* interface = interfaceQcc.c_str(); const char* ifaceName = ifaceNameQcc.c_str(); status = alljoyn_busattachment_createinterfacesfromxml(serviceBus, interface); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busobject altObj = create_about_obj_test_bus_object(serviceBus, "/org/test/about", ifaceName); status = alljoyn_busattachment_registerbusobject(serviceBus, altObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment clientBus = alljoyn_busattachment_create("Receive Announcement client Test", QCC_TRUE); status = alljoyn_busattachment_start(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(clientBus, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); about_test_about_listener* aboutListener = create_about_test_about_listener(0); alljoyn_busattachment_registeraboutlistener(clientBus, aboutListener->listener); status = alljoyn_busattachment_whoimplements_interface(clientBus, ifaceName); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_aboutobj_announce(aboutObj, port, aboutData); /* Wait for a maximum of 10 sec for the Announce Signal */ for (int msec = 0; msec < 10000; msec += WAIT_TIME) { if (announceListenerFlags[0]) { break; } qcc::Sleep(WAIT_TIME); } ASSERT_TRUE(announceListenerFlags[0]); alljoyn_busattachment_cancelwhoimplements_interface(clientBus, ifaceName); alljoyn_busattachment_unregisteraboutlistener(clientBus, aboutListener->listener); status = alljoyn_busattachment_stop(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); destroy_about_test_about_listener(aboutListener); destroy_about_obj_test_bus_object(altObj); alljoyn_aboutobj_destroy(aboutObj); alljoyn_busattachment_destroy(clientBus); } TEST_F(AboutListenerTest, MultipleAnnounceListeners) { QStatus status; qcc::GUID128 guid; qcc::String ifaceNameQcc = "org.test.a" + guid.ToString() + ".AnnounceHandlerTest"; zero_announceListenerFlags(); alljoyn_aboutobj aboutObj = alljoyn_aboutobj_create(serviceBus, UNANNOUNCED); const qcc::String interfaceQcc = "" "" " " " " "" ""; const char* interface = interfaceQcc.c_str(); const char* ifaceName = ifaceNameQcc.c_str(); status = alljoyn_busattachment_createinterfacesfromxml(serviceBus, interface); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busobject altObj = create_about_obj_test_bus_object(serviceBus, "/org/test/about", ifaceName); status = alljoyn_busattachment_registerbusobject(serviceBus, altObj); alljoyn_busattachment clientBus = alljoyn_busattachment_create("Receive Announcement client Test", QCC_TRUE); status = alljoyn_busattachment_start(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(clientBus, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); about_test_about_listener* aboutListener1 = create_about_test_about_listener(1); alljoyn_busattachment_registeraboutlistener(clientBus, aboutListener1->listener); about_test_about_listener* aboutListener2 = create_about_test_about_listener(2); alljoyn_busattachment_registeraboutlistener(clientBus, aboutListener2->listener); status = alljoyn_busattachment_whoimplements_interface(clientBus, ifaceName); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_aboutobj_announce(aboutObj, port, aboutData); /* Wait for a maximum of 10 sec for the Announce Signal */ for (int msec = 0; msec < 10000; msec += WAIT_TIME) { if (announceListenerFlags[1]) { break; } qcc::Sleep(WAIT_TIME); } /* Wait for a maximum of 5 sec for the second Announce Signal */ for (int msec = 0; msec < 5000; msec += WAIT_TIME) { if (announceListenerFlags[2]) { break; } qcc::Sleep(WAIT_TIME); } ASSERT_TRUE(announceListenerFlags[1]); ASSERT_TRUE(announceListenerFlags[2]); alljoyn_busattachment_cancelwhoimplements_interface(clientBus, ifaceName); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_unregisteraboutlistener(clientBus, aboutListener1->listener); alljoyn_busattachment_unregisteraboutlistener(clientBus, aboutListener2->listener); status = alljoyn_busattachment_stop(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); destroy_about_test_about_listener(aboutListener1); destroy_about_test_about_listener(aboutListener2); destroy_about_obj_test_bus_object(altObj); alljoyn_aboutobj_destroy(aboutObj); alljoyn_busattachment_destroy(clientBus); } TEST_F(AboutListenerTest, MultipleAnnounceListenersUnregister) { QStatus status; qcc::GUID128 guid; qcc::String ifaceNameQcc = "org.test.a" + guid.ToString() + ".AnnounceHandlerTest"; zero_announceListenerFlags(); alljoyn_aboutobj aboutObj = alljoyn_aboutobj_create(serviceBus, UNANNOUNCED); const qcc::String interfaceQcc = "" "" " " " " "" ""; const char* interface = interfaceQcc.c_str(); const char* ifaceName = ifaceNameQcc.c_str(); status = alljoyn_busattachment_createinterfacesfromxml(serviceBus, interface); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busobject altObj = create_about_obj_test_bus_object(serviceBus, "/org/test/about", ifaceName); status = alljoyn_busattachment_registerbusobject(serviceBus, altObj); alljoyn_busattachment clientBus = alljoyn_busattachment_create("Receive Announcement client Test", QCC_TRUE); status = alljoyn_busattachment_start(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(clientBus, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); about_test_about_listener* aboutListener1 = create_about_test_about_listener(1); alljoyn_busattachment_registeraboutlistener(clientBus, aboutListener1->listener); about_test_about_listener* aboutListener2 = create_about_test_about_listener(2); alljoyn_busattachment_registeraboutlistener(clientBus, aboutListener2->listener); status = alljoyn_busattachment_whoimplements_interface(clientBus, ifaceName); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_aboutobj_announce(aboutObj, port, aboutData); /* Wait for a maximum of 10 sec for the Announce Signal */ for (int msec = 0; msec < 10000; msec += WAIT_TIME) { if (announceListenerFlags[1]) { break; } qcc::Sleep(WAIT_TIME); } /* Wait for a maximum of 5 sec for the second Announce Signal */ for (int msec = 0; msec < 5000; msec += WAIT_TIME) { if (announceListenerFlags[2]) { break; } qcc::Sleep(WAIT_TIME); } ASSERT_TRUE(announceListenerFlags[1]); ASSERT_TRUE(announceListenerFlags[2]); announceListenerFlags[1] = QCC_FALSE; announceListenerFlags[2] = QCC_FALSE; alljoyn_busattachment_unregisteraboutlistener(clientBus, aboutListener1->listener); alljoyn_aboutobj_announce(aboutObj, port, aboutData); /* Wait for a maximum of 5 sec for the second Announce Signal */ for (int msec = 0; msec < 5000; msec += WAIT_TIME) { if (announceListenerFlags[2]) { break; } qcc::Sleep(WAIT_TIME); } ASSERT_FALSE(announceListenerFlags[1]); ASSERT_TRUE(announceListenerFlags[2]); alljoyn_busattachment_cancelwhoimplements_interface(clientBus, ifaceName); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_unregisteraboutlistener(clientBus, aboutListener2->listener); status = alljoyn_busattachment_stop(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); destroy_about_test_about_listener(aboutListener1); destroy_about_test_about_listener(aboutListener2); destroy_about_obj_test_bus_object(altObj); alljoyn_aboutobj_destroy(aboutObj); alljoyn_busattachment_destroy(clientBus); } TEST_F(AboutListenerTest, MultipleAnnounceListenersUnregisterAll) { QStatus status; qcc::GUID128 guid; qcc::String ifaceNameQcc = "org.test.a" + guid.ToString() + ".AnnounceHandlerTest"; zero_announceListenerFlags(); alljoyn_aboutobj aboutObj = alljoyn_aboutobj_create(serviceBus, UNANNOUNCED); const qcc::String interfaceQcc = "" "" " " " " "" ""; const char* interface = interfaceQcc.c_str(); const char* ifaceName = ifaceNameQcc.c_str(); status = alljoyn_busattachment_createinterfacesfromxml(serviceBus, interface); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busobject altObj = create_about_obj_test_bus_object(serviceBus, "/org/test/about", ifaceName); status = alljoyn_busattachment_registerbusobject(serviceBus, altObj); alljoyn_busattachment clientBus = alljoyn_busattachment_create("Receive Announcement client Test", QCC_TRUE); status = alljoyn_busattachment_start(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(clientBus, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); about_test_about_listener* aboutListener1 = create_about_test_about_listener(1); alljoyn_busattachment_registeraboutlistener(clientBus, aboutListener1->listener); about_test_about_listener* aboutListener2 = create_about_test_about_listener(2); alljoyn_busattachment_registeraboutlistener(clientBus, aboutListener2->listener); about_test_about_listener* aboutListener3 = create_about_test_about_listener(3); alljoyn_busattachment_registeraboutlistener(clientBus, aboutListener3->listener); status = alljoyn_busattachment_whoimplements_interface(clientBus, ifaceName); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_aboutobj_announce(aboutObj, port, aboutData); /* Wait for a maximum of 10 sec for the Announce Signal */ for (int msec = 0; msec < 10000; msec += WAIT_TIME) { if (announceListenerFlags[1]) { break; } qcc::Sleep(WAIT_TIME); } /* Wait for a maximum of 5 sec for the second Announce Signal */ for (int msec = 0; msec < 5000; msec += WAIT_TIME) { if (announceListenerFlags[2]) { break; } qcc::Sleep(WAIT_TIME); } /* Wait for a maximum of 5 sec for the third Announce Signal */ for (int msec = 0; msec < 5000; msec += WAIT_TIME) { if (announceListenerFlags[3]) { break; } qcc::Sleep(WAIT_TIME); } ASSERT_TRUE(announceListenerFlags[1]); ASSERT_TRUE(announceListenerFlags[2]); ASSERT_TRUE(announceListenerFlags[3]); alljoyn_busattachment_cancelwhoimplements_interface(clientBus, ifaceName); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_unregisterallaboutlisteners(clientBus); announceListenerFlags[1] = QCC_FALSE; announceListenerFlags[2] = QCC_FALSE; announceListenerFlags[3] = QCC_FALSE; alljoyn_busattachment_registeraboutlistener(clientBus, aboutListener2->listener); status = alljoyn_busattachment_whoimplements_interface(clientBus, ifaceName); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* Wait for a maximum of 5 sec for the second Announce Signal */ for (int msec = 0; msec < 5000; msec += WAIT_TIME) { if (announceListenerFlags[2]) { break; } qcc::Sleep(WAIT_TIME); } ASSERT_FALSE(announceListenerFlags[1]); ASSERT_TRUE(announceListenerFlags[2]); ASSERT_FALSE(announceListenerFlags[3]); alljoyn_busattachment_cancelwhoimplements_interface(clientBus, ifaceName); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_unregisterallaboutlisteners(clientBus); status = alljoyn_busattachment_stop(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); destroy_about_test_about_listener(aboutListener1); destroy_about_test_about_listener(aboutListener2); destroy_about_obj_test_bus_object(altObj); alljoyn_aboutobj_destroy(aboutObj); alljoyn_busattachment_destroy(clientBus); } TEST_F(AboutListenerTest, MatchMultipleInterfaces) { QStatus status; zero_announceListenerFlags(); qcc::GUID128 guid; qcc::String ifaceNames[3]; ifaceNames[0] = "org.test.a" + guid.ToString() + ".AnnounceHandlerTest.a"; ifaceNames[1] = "org.test.a" + guid.ToString() + ".AnnounceHandlerTest.b"; ifaceNames[2] = "org.test.a" + guid.ToString() + ".AnnounceHandlerTest.c"; const char* ifaces[3]; ifaces[0] = ifaceNames[0].c_str(); ifaces[1] = ifaceNames[1].c_str(); ifaces[2] = ifaceNames[2].c_str(); const qcc::String interfaceQcc = "" "" " " " " "" "" " " " " "" "" " " " " "" ""; const char* interface = interfaceQcc.c_str(); status = alljoyn_busattachment_createinterfacesfromxml(serviceBus, interface); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busobject altObj = create_about_obj_test_bus_object_2(serviceBus, "/org/test/about", ifaces, 3); status = alljoyn_busattachment_registerbusobject(serviceBus, altObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_aboutobj aboutObj = alljoyn_aboutobj_create(serviceBus, UNANNOUNCED); alljoyn_busattachment clientBus = alljoyn_busattachment_create("Receive Announcement client Test", QCC_TRUE); status = alljoyn_busattachment_start(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(clientBus, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); about_test_about_listener* aboutListener = create_about_test_about_listener(0); alljoyn_busattachment_registeraboutlistener(clientBus, aboutListener->listener); alljoyn_busattachment_whoimplements_interfaces(clientBus, ifaces, 3); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_aboutobj_announce(aboutObj, port, aboutData); /* Wait for a maximum of 10 sec for the Announce Signal */ for (int msec = 0; msec < 10000; msec += WAIT_TIME) { if (announceListenerFlags[0]) { break; } qcc::Sleep(WAIT_TIME); } ASSERT_TRUE(announceListenerFlags[0]); alljoyn_busattachment_cancelwhoimplements_interfaces(clientBus, ifaces, 3); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_unregisteraboutlistener(clientBus, aboutListener->listener); status = alljoyn_busattachment_stop(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); destroy_about_test_about_listener(aboutListener); destroy_about_obj_test_bus_object(altObj); alljoyn_aboutobj_destroy(aboutObj); alljoyn_busattachment_destroy(clientBus); } TEST_F(AboutListenerTest, MatchMultipleInterfacesSubSet) { QStatus status; zero_announceListenerFlags(); qcc::GUID128 guid; qcc::String ifaceNames[6]; ifaceNames[0] = "org.test.a" + guid.ToString() + ".AnnounceHandlerTest.a"; ifaceNames[1] = "org.test.a" + guid.ToString() + ".AnnounceHandlerTest.b"; ifaceNames[2] = "org.test.a" + guid.ToString() + ".AnnounceHandlerTest.c"; ifaceNames[3] = "org.test.a" + guid.ToString() + ".AnnounceHandlerTest.d"; ifaceNames[4] = "org.test.a" + guid.ToString() + ".AnnounceHandlerTest.e"; ifaceNames[5] = "org.test.a" + guid.ToString() + ".AnnounceHandlerTest.f"; const char* ifaces[6]; ifaces[0] = ifaceNames[0].c_str(); ifaces[1] = ifaceNames[1].c_str(); ifaces[2] = ifaceNames[2].c_str(); ifaces[3] = ifaceNames[3].c_str(); ifaces[4] = ifaceNames[4].c_str(); ifaces[5] = ifaceNames[5].c_str(); const char* ifacesSubSet[2]; ifacesSubSet[0] = ifaceNames[1].c_str(); ifacesSubSet[1] = ifaceNames[2].c_str(); const qcc::String interfaceQcc = "" "" " " " " "" "" " " " " "" "" " " " " "" "" " " " " "" "" " " " " "" "" " " " " "" ""; const char* interface = interfaceQcc.c_str(); status = alljoyn_busattachment_createinterfacesfromxml(serviceBus, interface); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busobject altObj = create_about_obj_test_bus_object_2(serviceBus, "/org/test/about", ifaces, 6); status = alljoyn_busattachment_registerbusobject(serviceBus, altObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_aboutobj aboutObj = alljoyn_aboutobj_create(serviceBus, UNANNOUNCED); alljoyn_busattachment clientBus = alljoyn_busattachment_create("Receive Announcement client Test", QCC_TRUE); status = alljoyn_busattachment_start(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(clientBus, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); about_test_about_listener* aboutListener = create_about_test_about_listener(0); alljoyn_busattachment_registeraboutlistener(clientBus, aboutListener->listener); alljoyn_busattachment_whoimplements_interfaces(clientBus, ifacesSubSet, 2); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_aboutobj_announce(aboutObj, port, aboutData); /* Wait for a maximum of 10 sec for the Announce Signal */ for (int msec = 0; msec < 10000; msec += WAIT_TIME) { if (announceListenerFlags[0]) { break; } qcc::Sleep(WAIT_TIME); } ASSERT_TRUE(announceListenerFlags[0]); alljoyn_busattachment_cancelwhoimplements_interfaces(clientBus, ifacesSubSet, 2); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_unregisteraboutlistener(clientBus, aboutListener->listener); status = alljoyn_busattachment_stop(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); destroy_about_test_about_listener(aboutListener); destroy_about_obj_test_bus_object(altObj); alljoyn_aboutobj_destroy(aboutObj); alljoyn_busattachment_destroy(clientBus); } TEST_F(AboutListenerTest, MatchMultipleInterfacesRegisterInDifferentOrder) { QStatus status; zero_announceListenerFlags(); qcc::GUID128 guid; qcc::String ifaceNames[6]; ifaceNames[0] = "org.test.a" + guid.ToString() + ".AnnounceHandlerTest.a"; ifaceNames[1] = "org.test.a" + guid.ToString() + ".AnnounceHandlerTest.b"; ifaceNames[2] = "org.test.a" + guid.ToString() + ".AnnounceHandlerTest.c"; ifaceNames[3] = "org.test.a" + guid.ToString() + ".AnnounceHandlerTest.d"; ifaceNames[4] = "org.test.a" + guid.ToString() + ".AnnounceHandlerTest.e"; ifaceNames[5] = "org.test.a" + guid.ToString() + ".AnnounceHandlerTest.f"; const char* ifaces[6]; ifaces[0] = ifaceNames[0].c_str(); ifaces[1] = ifaceNames[1].c_str(); ifaces[2] = ifaceNames[2].c_str(); ifaces[3] = ifaceNames[3].c_str(); ifaces[4] = ifaceNames[4].c_str(); ifaces[5] = ifaceNames[5].c_str(); const qcc::String interfaceQcc = "" "" " " " " "" "" " " " " "" "" " " " " "" "" " " " " "" "" " " " " "" "" " " " " "" ""; const char* interface = interfaceQcc.c_str(); status = alljoyn_busattachment_createinterfacesfromxml(serviceBus, interface); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busobject altObj = create_about_obj_test_bus_object_2(serviceBus, "/org/test/about", ifaces, 6); status = alljoyn_busattachment_registerbusobject(serviceBus, altObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_aboutobj aboutObj = alljoyn_aboutobj_create(serviceBus, UNANNOUNCED); alljoyn_busattachment clientBus = alljoyn_busattachment_create("Receive Announcement client Test", QCC_TRUE); status = alljoyn_busattachment_start(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(clientBus, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); about_test_about_listener* aboutListener = create_about_test_about_listener(0); alljoyn_busattachment_registeraboutlistener(clientBus, aboutListener->listener); const char* ifaceslist[6]; ifaceslist[0] = ifaceNames[3].c_str(); ifaceslist[1] = ifaceNames[0].c_str(); ifaceslist[2] = ifaceNames[5].c_str(); ifaceslist[3] = ifaceNames[2].c_str(); ifaceslist[4] = ifaceNames[1].c_str(); ifaceslist[5] = ifaceNames[4].c_str(); alljoyn_busattachment_whoimplements_interfaces(clientBus, ifaceslist, 6); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_aboutobj_announce(aboutObj, port, aboutData); /* Wait for a maximum of 10 sec for the Announce Signal */ for (int msec = 0; msec < 10000; msec += WAIT_TIME) { if (announceListenerFlags[0]) { break; } qcc::Sleep(WAIT_TIME); } ASSERT_TRUE(announceListenerFlags[0]); alljoyn_busattachment_cancelwhoimplements_interfaces(clientBus, ifaceslist, 6); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_unregisteraboutlistener(clientBus, aboutListener->listener); status = alljoyn_busattachment_stop(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); destroy_about_test_about_listener(aboutListener); destroy_about_obj_test_bus_object(altObj); alljoyn_aboutobj_destroy(aboutObj); alljoyn_busattachment_destroy(clientBus); } TEST_F(AboutListenerTest, WildCardInterfaceMatching) { QStatus status; zero_announceListenerFlags(); qcc::GUID128 guid; qcc::String ifaceNames[3]; ifaceNames[0] = "org.test.a" + guid.ToString() + ".AnnounceHandlerTest.a"; ifaceNames[1] = "org.test.a" + guid.ToString() + ".AnnounceHandlerTest.b"; ifaceNames[2] = "org.test.a" + guid.ToString() + ".AnnounceHandlerTest.c"; const char* ifaces[3]; ifaces[0] = ifaceNames[0].c_str(); ifaces[1] = ifaceNames[1].c_str(); ifaces[2] = ifaceNames[2].c_str(); qcc::String wildCardQcc = "org.test.a" + guid.ToString() + ".*"; const char* wildCard = wildCardQcc.c_str(); const qcc::String interfaceQcc = "" "" " " " " "" "" " " " " "" "" " " " " "" ""; const char* interface = interfaceQcc.c_str(); status = alljoyn_busattachment_createinterfacesfromxml(serviceBus, interface); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busobject altObj = create_about_obj_test_bus_object_2(serviceBus, "/org/test/about", ifaces, 3); status = alljoyn_busattachment_registerbusobject(serviceBus, altObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_aboutobj aboutObj = alljoyn_aboutobj_create(serviceBus, UNANNOUNCED); alljoyn_busattachment clientBus = alljoyn_busattachment_create("Receive Announcement client Test", QCC_TRUE); status = alljoyn_busattachment_start(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(clientBus, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); about_test_wildcard_about_listener* aboutListener = create_about_test_wildcard_about_listener(); alljoyn_busattachment_registeraboutlistener(clientBus, aboutListener->listener); alljoyn_busattachment_whoimplements_interface(clientBus, wildCard); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_aboutobj_announce(aboutObj, port, aboutData); /* Wait for a maximum of 10 sec for the Announce Signal */ for (int msec = 0; msec < 10000; msec += WAIT_TIME) { if (aboutListener->announcelistenercount == 1) { break; } qcc::Sleep(WAIT_TIME); } ASSERT_EQ(aboutListener->announcelistenercount, 1u); alljoyn_busattachment_cancelwhoimplements_interface(clientBus, wildCard); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_unregisteraboutlistener(clientBus, aboutListener->listener); status = alljoyn_busattachment_stop(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); destroy_about_test_wildcard_about_listener(aboutListener); destroy_about_obj_test_bus_object(altObj); alljoyn_aboutobj_destroy(aboutObj); alljoyn_busattachment_destroy(clientBus); } TEST_F(AboutListenerTest, WildCardInterfaceMatching2) { QStatus status; zero_announceListenerFlags(); qcc::GUID128 guid; qcc::String ifaceNames[3]; ifaceNames[0] = "org.test.a" + guid.ToString() + ".a.AnnounceHandlerTest"; ifaceNames[1] = "org.test.a" + guid.ToString() + ".b.AnnounceHandlerTest"; ifaceNames[2] = "org.test.a" + guid.ToString() + ".c.AnnounceHandlerTest"; const char* ifaces[3]; ifaces[0] = ifaceNames[0].c_str(); ifaces[1] = ifaceNames[1].c_str(); ifaces[2] = ifaceNames[2].c_str(); qcc::String wildCardQcc = "org.test.a" + guid.ToString() + ".*.AnnounceHandlerTest"; const char* wildCard = wildCardQcc.c_str(); const qcc::String interfaceQcc = "" "" " " " " "" "" " " " " "" "" " " " " "" ""; const char* interface = interfaceQcc.c_str(); status = alljoyn_busattachment_createinterfacesfromxml(serviceBus, interface); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busobject altObj = create_about_obj_test_bus_object_2(serviceBus, "/org/test/about", ifaces, 3); status = alljoyn_busattachment_registerbusobject(serviceBus, altObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_aboutobj aboutObj = alljoyn_aboutobj_create(serviceBus, UNANNOUNCED); alljoyn_busattachment clientBus = alljoyn_busattachment_create("Receive Announcement client Test", QCC_TRUE); status = alljoyn_busattachment_start(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(clientBus, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); about_test_wildcard_about_listener* aboutListener = create_about_test_wildcard_about_listener(); alljoyn_busattachment_registeraboutlistener(clientBus, aboutListener->listener); alljoyn_busattachment_whoimplements_interface(clientBus, wildCard); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_aboutobj_announce(aboutObj, port, aboutData); /* Wait for a maximum of 10 sec for the Announce Signal */ for (int msec = 0; msec < 10000; msec += WAIT_TIME) { if (aboutListener->announcelistenercount == 1) { break; } qcc::Sleep(WAIT_TIME); } ASSERT_EQ(aboutListener->announcelistenercount, 1u); alljoyn_busattachment_cancelwhoimplements_interface(clientBus, wildCard); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_unregisteraboutlistener(clientBus, aboutListener->listener); status = alljoyn_busattachment_stop(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); destroy_about_test_wildcard_about_listener(aboutListener); destroy_about_obj_test_bus_object(altObj); alljoyn_aboutobj_destroy(aboutObj); alljoyn_busattachment_destroy(clientBus); } TEST_F(AboutListenerTest, MultipleWildCardInterfaceMatching) { QStatus status; zero_announceListenerFlags(); qcc::GUID128 guid; qcc::String ifaceNames[3]; ifaceNames[0] = "org.test.a" + guid.ToString() + ".AnnounceHandlerTest.a"; ifaceNames[1] = "org.test.foo.a" + guid.ToString() + ".AnnounceHandlerTest.b"; ifaceNames[2] = "org.test.foo.a" + guid.ToString() + ".AnnounceHandlerTest.c"; const char* ifaces[3]; ifaces[0] = ifaceNames[0].c_str(); ifaces[1] = ifaceNames[1].c_str(); ifaces[2] = ifaceNames[2].c_str(); qcc::String wildCard = "org.test.a" + guid.ToString() + ".*"; qcc::String wildCard2 = "org.test.foo.a" + guid.ToString() + ".*"; const char* interfacelist[2]; interfacelist[0] = wildCard.c_str(); interfacelist[1] = wildCard2.c_str(); const qcc::String interfaceQcc = "" "" " " " " "" "" " " " " "" "" " " " " "" ""; const char* interface = interfaceQcc.c_str(); status = alljoyn_busattachment_createinterfacesfromxml(serviceBus, interface); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busobject altObj = create_about_obj_test_bus_object_2(serviceBus, "/org/test/about", ifaces, 3); status = alljoyn_busattachment_registerbusobject(serviceBus, altObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_aboutobj aboutObj = alljoyn_aboutobj_create(serviceBus, UNANNOUNCED); alljoyn_busattachment clientBus = alljoyn_busattachment_create("Receive Announcement client Test", QCC_TRUE); status = alljoyn_busattachment_start(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(clientBus, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); about_test_wildcard_about_listener* aboutListener = create_about_test_wildcard_about_listener(); alljoyn_busattachment_registeraboutlistener(clientBus, aboutListener->listener); alljoyn_busattachment_whoimplements_interfaces(clientBus, interfacelist, 2); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_aboutobj_announce(aboutObj, port, aboutData); /* Wait for a maximum of 10 sec for the Announce Signal */ for (int msec = 0; msec < 10000; msec += WAIT_TIME) { if (aboutListener->announcelistenercount == 1) { break; } qcc::Sleep(WAIT_TIME); } ASSERT_EQ(aboutListener->announcelistenercount, 1u); alljoyn_busattachment_cancelwhoimplements_interfaces(clientBus, interfacelist, 2); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_unregisteraboutlistener(clientBus, aboutListener->listener); status = alljoyn_busattachment_stop(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); destroy_about_test_wildcard_about_listener(aboutListener); destroy_about_obj_test_bus_object(altObj); alljoyn_aboutobj_destroy(aboutObj); alljoyn_busattachment_destroy(clientBus); } TEST_F(AboutListenerTest, MixedWildCardNonWildCardInterfaceMatching) { QStatus status; zero_announceListenerFlags(); qcc::GUID128 guid; qcc::String ifaceNames[3]; ifaceNames[0] = "org.test.a" + guid.ToString() + ".AnnounceHandlerTest.a"; ifaceNames[1] = "org.test.foo.a" + guid.ToString() + ".AnnounceHandlerTest.b"; ifaceNames[2] = "org.test.foo.a" + guid.ToString() + ".AnnounceHandlerTest.c"; const char* ifaces[3]; ifaces[0] = ifaceNames[0].c_str(); ifaces[1] = ifaceNames[1].c_str(); ifaces[2] = ifaceNames[2].c_str(); qcc::String wildCard = "org.test.a" + guid.ToString() + ".*"; const char* interfacelist[2]; interfacelist[0] = ifaceNames[0].c_str(); interfacelist[1] = wildCard.c_str(); const qcc::String interfaceQcc = "" "" " " " " "" "" " " " " "" "" " " " " "" ""; const char* interface = interfaceQcc.c_str(); status = alljoyn_busattachment_createinterfacesfromxml(serviceBus, interface); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busobject altObj = create_about_obj_test_bus_object_2(serviceBus, "/org/test/about", ifaces, 3); status = alljoyn_busattachment_registerbusobject(serviceBus, altObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_aboutobj aboutObj = alljoyn_aboutobj_create(serviceBus, UNANNOUNCED); alljoyn_busattachment clientBus = alljoyn_busattachment_create("Receive Announcement client Test", QCC_TRUE); status = alljoyn_busattachment_start(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(clientBus, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); about_test_wildcard_about_listener* aboutListener = create_about_test_wildcard_about_listener(); alljoyn_busattachment_registeraboutlistener(clientBus, aboutListener->listener); alljoyn_busattachment_whoimplements_interfaces(clientBus, interfacelist, 2); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_aboutobj_announce(aboutObj, port, aboutData); /* Wait for a maximum of 10 sec for the Announce Signal */ for (int msec = 0; msec < 10000; msec += WAIT_TIME) { if (aboutListener->announcelistenercount == 1) { break; } qcc::Sleep(WAIT_TIME); } ASSERT_EQ(aboutListener->announcelistenercount, 1u); alljoyn_busattachment_cancelwhoimplements_interfaces(clientBus, interfacelist, 2); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_unregisteraboutlistener(clientBus, aboutListener->listener); status = alljoyn_busattachment_stop(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); destroy_about_test_wildcard_about_listener(aboutListener); destroy_about_obj_test_bus_object(altObj); alljoyn_aboutobj_destroy(aboutObj); alljoyn_busattachment_destroy(clientBus); } TEST_F(AboutListenerTest, RemoveObjectDescriptionAnnouncement) { QStatus status; zero_announceListenerFlags(); qcc::GUID128 guid; qcc::String ifaceNamesQcc[2]; ifaceNamesQcc[0] = "org.test.a" + guid.ToString() + ".AnnounceHandlerTest.a"; ifaceNamesQcc[1] = "org.test.a" + guid.ToString() + ".AnnounceHandlerTest.b"; const char* ifaceNames[2]; ifaceNames[0] = ifaceNamesQcc[0].c_str(); ifaceNames[1] = ifaceNamesQcc[1].c_str(); const qcc::String interfaceQcc0 = "" "" " " " " "" ""; const qcc::String interfaceQcc1 = "" "" " " " " "" ""; const char* interface0 = interfaceQcc0.c_str(); const char* interface1 = interfaceQcc1.c_str(); status = alljoyn_busattachment_createinterfacesfromxml(serviceBus, interface0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_createinterfacesfromxml(serviceBus, interface1); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busobject altObj0 = create_about_obj_test_bus_object(serviceBus, "/org/test/about/a", ifaceNames[0]); alljoyn_busobject altObj1 = create_about_obj_test_bus_object(serviceBus, "/org/test/about/b", ifaceNames[1]); status = alljoyn_busattachment_registerbusobject(serviceBus, altObj0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_registerbusobject(serviceBus, altObj1); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_aboutobj aboutObj = alljoyn_aboutobj_create(serviceBus, UNANNOUNCED); alljoyn_busattachment clientBus = alljoyn_busattachment_create("Receive Announcement client Test", QCC_TRUE); status = alljoyn_busattachment_start(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(clientBus, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); remove_object_description_about_listener* aboutListener = create_remove_object_description_about_listener(); alljoyn_busattachment_registeraboutlistener(clientBus, aboutListener->listener); alljoyn_busattachment_whoimplements_interface(clientBus, ifaceNames[0]); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_aboutobj_announce(aboutObj, port, aboutData); /* Wait for a maximum of 10 sec for the Announce Signal */ for (int msec = 0; msec < 10000; msec += WAIT_TIME) { if (aboutListener->announcelistenercount == 1) { break; } qcc::Sleep(WAIT_TIME); } ASSERT_EQ(aboutListener->announcelistenercount, 1u); alljoyn_busattachment_unregisterbusobject(serviceBus, altObj1); status = alljoyn_aboutobj_announce(aboutObj, port, aboutData); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (int msec = 0; msec < 10000; msec += WAIT_TIME) { if (aboutListener->announcelistenercount == 2) { break; } qcc::Sleep(WAIT_TIME); } ASSERT_EQ(2u, aboutListener->announcelistenercount); alljoyn_busattachment_cancelwhoimplements_interface(clientBus, ifaceNames[0]); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_unregisteraboutlistener(clientBus, aboutListener->listener); status = alljoyn_busattachment_stop(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); destroy_remove_object_description_about_listener(aboutListener); destroy_about_obj_test_bus_object(altObj0); destroy_about_obj_test_bus_object(altObj1); alljoyn_aboutobj_destroy(aboutObj); alljoyn_busattachment_destroy(clientBus); } TEST_F(AboutListenerTest, StressInterfaces) { QStatus status; zero_announceListenerFlags(); qcc::GUID128 guid; /* Use a randomly generated prefix to avoid unexpected conflicts */ const qcc::String INTERFACE_PREFIX = "a" + guid.ToString() + "."; /* Max interface name length is 255 chars */ const size_t MAX_INTERFACE_BODY_LEN = 255 - INTERFACE_PREFIX.length(); /* 100 interfaces. */ const size_t INTERFACE_COUNT = 100; qcc::String ifaceNamesQcc[INTERFACE_COUNT]; qcc::String interfaceXmlQcc = ""; /* * Test can't support more than 221 interfaces since max interface length is 255 * each test interface name has a prefix and variable body */ ASSERT_TRUE(INTERFACE_COUNT < MAX_INTERFACE_BODY_LEN) << " Too many interfaces"; char randChar = 'a'; for (size_t i = 0; i < INTERFACE_COUNT; i++) { /* Generate a pseudo-random char (loop from a-z). */ randChar = 'a' + (i % 26); /* Generate string with different length per loop like a/bb/ccc/dddd... */ qcc::String randStr((i + 1), (randChar)); ifaceNamesQcc[i] = INTERFACE_PREFIX + randStr; interfaceXmlQcc += "" " " " " ""; } interfaceXmlQcc += ""; const char* ifaceNames[INTERFACE_COUNT]; for (size_t i = 0; i < INTERFACE_COUNT; ++i) { ifaceNames[i] = ifaceNamesQcc[i].c_str(); } const char* interfaceXml = interfaceXmlQcc.c_str(); status = alljoyn_busattachment_createinterfacesfromxml(serviceBus, interfaceXml); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busobject altObj = create_about_obj_test_bus_object_2(serviceBus, "/org/test/stress", ifaceNames, INTERFACE_COUNT); status = alljoyn_busattachment_registerbusobject(serviceBus, altObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_aboutobj aboutObj = alljoyn_aboutobj_create(serviceBus, UNANNOUNCED); alljoyn_busattachment clientBus = alljoyn_busattachment_create("Receive Announcement client Test", QCC_TRUE); status = alljoyn_busattachment_start(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(clientBus, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); about_test_about_listener* aboutListener = create_about_test_about_listener(3); alljoyn_busattachment_registeraboutlistener(clientBus, aboutListener->listener); alljoyn_busattachment_whoimplements_interfaces(clientBus, ifaceNames, INTERFACE_COUNT); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_aboutobj_announce(aboutObj, port, aboutData); /* Wait for a maximum of 10 sec for the Announce Signal */ for (int msec = 0; msec < 10000; msec += WAIT_TIME) { if (announceListenerFlags[3]) { break; } qcc::Sleep(WAIT_TIME); } ASSERT_TRUE(announceListenerFlags[3]); alljoyn_busattachment_cancelwhoimplements_interfaces(clientBus, ifaceNames, INTERFACE_COUNT); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_unregisteraboutlistener(clientBus, aboutListener->listener); status = alljoyn_busattachment_stop(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); destroy_about_test_about_listener(aboutListener); destroy_about_obj_test_bus_object(altObj); alljoyn_aboutobj_destroy(aboutObj); alljoyn_busattachment_destroy(clientBus); } TEST_F(AboutListenerTest, CancelWhoImplementsMisMatch) { QStatus status; zero_announceListenerFlags(); qcc::GUID128 guid; qcc::String ifaceNameQcc = "org.test.a" + guid.ToString() + ".AnnounceHandlerTest.a"; const char* ifaceName = ifaceNameQcc.c_str(); alljoyn_busattachment clientBus = alljoyn_busattachment_create("Receive Announcement client Test", QCC_TRUE); status = alljoyn_busattachment_start(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(clientBus, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_cancelwhoimplements_interface(clientBus, ifaceName); EXPECT_EQ(ER_BUS_MATCH_RULE_NOT_FOUND, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_stop(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_destroy(clientBus); } TEST_F(AboutListenerTest, AnnounceAppIdWithNon128BitLength) { QStatus status; zero_announceListenerFlags(); qcc::GUID128 guid; qcc::String ifaceNameQcc = "org.test.a" + guid.ToString() + ".AnnounceHandlerTest"; alljoyn_aboutobj aboutObj = alljoyn_aboutobj_create(serviceBus, UNANNOUNCED); const qcc::String interfaceQcc = "" "" " " " " "" ""; const char* ifaceName = ifaceNameQcc.c_str(); const char* interface = interfaceQcc.c_str(); status = alljoyn_busattachment_createinterfacesfromxml(serviceBus, interface); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busobject altObj = create_about_obj_test_bus_object(serviceBus, "/org/test/about", ifaceName); status = alljoyn_busattachment_registerbusobject(serviceBus, altObj); alljoyn_busattachment clientBus = alljoyn_busattachment_create("Receive Announcement client Test", QCC_TRUE); status = alljoyn_busattachment_start(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(clientBus, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); announce_non_128_bit_app_id_about_listener* aboutListener = create_announce_non_128_bit_app_id_about_listener(); alljoyn_busattachment_registeraboutlistener(clientBus, aboutListener->listener); status = alljoyn_busattachment_whoimplements_interface(clientBus, ifaceName); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* 64-bit AppId */ uint8_t appid_64[] = { 0, 1, 2, 3, 4, 5, 6, 7 }; status = alljoyn_aboutdata_setappid(aboutData, appid_64, 8); EXPECT_EQ(ER_ABOUT_INVALID_ABOUTDATA_FIELD_APPID_SIZE, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutobj_announce(aboutObj, port, aboutData); EXPECT_EQ(ER_ABOUT_INVALID_ABOUTDATA_FIELD_APPID_SIZE, status) << " Actual Status: " << QCC_StatusText(status); /* * Wait for a maximum of 10 sec for the Announce Signal. Even if we get an * ER_ABOUT_INVALID_ABOUTDATA_FIELD_APPID_SIZE error we expect to get the * Announce signal */ for (int msec = 0; msec < 10000; msec += WAIT_TIME) { if (announceListenerFlags[0]) { break; } qcc::Sleep(WAIT_TIME); } ASSERT_TRUE(announceListenerFlags[0]); alljoyn_aboutdata listenerAboutData = alljoyn_aboutdata_create_empty(); alljoyn_aboutdata_createfrommsgarg(listenerAboutData, aboutListener->aboutData, "en"); uint8_t* appId; size_t num; status = alljoyn_aboutdata_getappid(listenerAboutData, &appId, &num); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_EQ(8u, num); for (size_t i = 0; i < num; i++) { EXPECT_EQ(appid_64[i], appId[i]); } zero_announceListenerFlags(); /* 192-bit AppId */ uint8_t appid_192[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23 }; status = alljoyn_aboutdata_setappid(aboutData, appid_192, 24); EXPECT_EQ(ER_ABOUT_INVALID_ABOUTDATA_FIELD_APPID_SIZE, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutobj_announce(aboutObj, port, aboutData); EXPECT_EQ(ER_ABOUT_INVALID_ABOUTDATA_FIELD_APPID_SIZE, status) << " Actual Status: " << QCC_StatusText(status); /* * Wait for a maximum of 10 sec for the Announce Signal. Even if we get an * ER_ABOUT_INVALID_ABOUTDATA_FIELD_APPID_SIZE error we expect to get the * Announce signal. */ for (int msec = 0; msec < 10000; msec += WAIT_TIME) { if (announceListenerFlags[0]) { break; } qcc::Sleep(WAIT_TIME); } ASSERT_TRUE(announceListenerFlags[0]); alljoyn_aboutdata_destroy(listenerAboutData); listenerAboutData = alljoyn_aboutdata_create_empty(); alljoyn_aboutdata_createfrommsgarg(listenerAboutData, aboutListener->aboutData, "en"); status = alljoyn_aboutdata_getappid(listenerAboutData, &appId, &num); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_EQ(24u, num); for (size_t i = 0; i < num; i++) { EXPECT_EQ(appid_192[i], appId[i]); } alljoyn_busattachment_cancelwhoimplements_interface(clientBus, ifaceName); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_unregisteraboutlistener(clientBus, aboutListener->listener); status = alljoyn_busattachment_stop(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_aboutdata_destroy(listenerAboutData); destroy_announce_non_128_bit_app_id_about_listener(aboutListener); destroy_about_obj_test_bus_object(altObj); alljoyn_aboutobj_destroy(aboutObj); alljoyn_busattachment_destroy(clientBus); } TEST_F(AboutListenerTest, WhoImplementsNull) { QStatus status; qcc::GUID128 guid; zero_announceListenerFlags(); alljoyn_aboutobj aboutObj = alljoyn_aboutobj_create(serviceBus, UNANNOUNCED); qcc::String ifaceNamesQcc[3]; ifaceNamesQcc[0] = "null.test.a" + guid.ToString() + ".AnnounceHandlerTest.a"; ifaceNamesQcc[1] = "null.test.a" + guid.ToString() + ".AnnounceHandlerTest.b"; ifaceNamesQcc[2] = "null.test.a" + guid.ToString() + ".AnnounceHandlerTest.c"; const qcc::String interfaceQcc = "" "" " " " " "" "" " " " " "" "" " " " " "" ""; const char* ifaceNames[3]; ifaceNames[0] = ifaceNamesQcc[0].c_str(); ifaceNames[1] = ifaceNamesQcc[1].c_str(); ifaceNames[2] = ifaceNamesQcc[2].c_str(); const char* interface = interfaceQcc.c_str(); const char path[] = "/org/test/null"; status = alljoyn_busattachment_createinterfacesfromxml(serviceBus, interface); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busobject altObj = create_about_obj_test_bus_object_2(serviceBus, path, ifaceNames, 3); status = alljoyn_busattachment_registerbusobject(serviceBus, altObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment clientBus = alljoyn_busattachment_create("Receive Announcement client Test", QCC_TRUE); status = alljoyn_busattachment_start(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(clientBus, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); filtered_about_listener* aboutListener = create_filtered_about_listener(); alljoyn_busattachment_registeraboutlistener(clientBus, aboutListener->listener); status = alljoyn_busattachment_whoimplements_interface(clientBus, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); setExpectInterfaces(aboutListener, path, ifaceNames, 3); status = alljoyn_aboutobj_announce(aboutObj, port, aboutData); /* Wait for a maximum of 10 sec for the Announce Signal */ for (int msec = 0; msec < 10000; msec += WAIT_TIME) { if (aboutListener->announcelistenercount == 1) { break; } qcc::Sleep(WAIT_TIME); } ASSERT_EQ(1u, aboutListener->announcelistenercount); alljoyn_busattachment_cancelwhoimplements_interface(clientBus, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_unregisteraboutlistener(clientBus, aboutListener->listener); status = alljoyn_busattachment_stop(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); destroy_filtered_about_listener(aboutListener); destroy_about_obj_test_bus_object(altObj); alljoyn_aboutobj_destroy(aboutObj); alljoyn_busattachment_destroy(clientBus); } alljoyn-15.04b/alljoyn_c/unit_test/AboutListenerTestApi.cc000066400000000000000000000361641255700255500237260ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include "AboutListenerTestApi.h" #include #include #include #include QCC_BOOL announceListenerFlags[] = { 0, 0, 0, 0 }; void zero_announceListenerFlags() { unsigned i = 0; for (; i < sizeof(announceListenerFlags) / sizeof(announceListenerFlags[0]); ++i) { announceListenerFlags[i] = 0; } } static void foo_cb(alljoyn_busobject object, const alljoyn_interfacedescription_member* member, alljoyn_message msg) { QCC_UNUSED(member); alljoyn_busobject_methodreply_args(object, msg, NULL, 0); } static void announced_cb(const void* context, const char* busName, uint16_t version, alljoyn_sessionport port, const alljoyn_msgarg objectDescriptionArg, const alljoyn_msgarg aboutDataArg) { QCC_UNUSED(busName); QCC_UNUSED(version); QCC_UNUSED(port); QCC_UNUSED(objectDescriptionArg); QCC_UNUSED(aboutDataArg); int* idx = (int*) context; announceListenerFlags[*idx] = QCC_TRUE; } static void about_test_wildcard_about_listener_announced_cb(const void* context, const char* busName, uint16_t version, alljoyn_sessionport port, const alljoyn_msgarg objectDescriptionArg, const alljoyn_msgarg aboutDataArg) { QCC_UNUSED(busName); QCC_UNUSED(version); QCC_UNUSED(port); QCC_UNUSED(objectDescriptionArg); QCC_UNUSED(aboutDataArg); about_test_wildcard_about_listener* listener = (about_test_wildcard_about_listener*)(context); listener->announcelistenercount++; } static void non_128_bit_app_id_about_listener_announced_cb(const void* context, const char* busName, uint16_t version, alljoyn_sessionport port, const alljoyn_msgarg objectDescriptionArg, const alljoyn_msgarg aboutDataArg) { QCC_UNUSED(busName); QCC_UNUSED(version); QCC_UNUSED(port); QCC_UNUSED(objectDescriptionArg); announce_non_128_bit_app_id_about_listener* listener = (announce_non_128_bit_app_id_about_listener*)(context); announceListenerFlags[0] = QCC_TRUE; listener->aboutData = alljoyn_msgarg_copy(aboutDataArg); alljoyn_msgarg_stabilize(listener->aboutData); } static void remove_object_description_about_listener_cb(const void* context, const char* busName, uint16_t version, alljoyn_sessionport port, const alljoyn_msgarg objectDescriptionArg, const alljoyn_msgarg aboutDataArg) { QCC_UNUSED(busName); QCC_UNUSED(version); QCC_UNUSED(port); QCC_UNUSED(objectDescriptionArg); QCC_UNUSED(aboutDataArg); QStatus status = ER_FAIL; alljoyn_aboutobjectdescription objectDescription = alljoyn_aboutobjectdescription_create(); status = alljoyn_aboutobjectdescription_createfrommsgarg(objectDescription, objectDescriptionArg); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); remove_object_description_about_listener* listener = (remove_object_description_about_listener*)(context); EXPECT_TRUE(alljoyn_aboutobjectdescription_haspath(objectDescription, "/org/test/about/a")); if (listener->announcelistenercount == 0) { EXPECT_TRUE(alljoyn_aboutobjectdescription_haspath(objectDescription, "/org/test/about/b")); } else { EXPECT_FALSE(alljoyn_aboutobjectdescription_haspath(objectDescription, "/org/test/about/b")); } listener->announcelistenercount++; alljoyn_aboutobjectdescription_destroy(objectDescription); } static void filtered_about_listener_cb(const void* context, const char* busName, uint16_t version, alljoyn_sessionport port, const alljoyn_msgarg objectDescriptionArg, const alljoyn_msgarg aboutDataArg) { QCC_UNUSED(busName); QCC_UNUSED(version); QCC_UNUSED(port); QCC_UNUSED(objectDescriptionArg); QCC_UNUSED(aboutDataArg); QStatus status = ER_OK; alljoyn_aboutobjectdescription aod = alljoyn_aboutobjectdescription_create(); status = alljoyn_aboutobjectdescription_createfrommsgarg(aod, objectDescriptionArg); EXPECT_EQ(ER_OK, status); filtered_about_listener* listener = (filtered_about_listener*)(context); size_t i = 0; size_t j = 0; size_t intersections = 0; if (listener->objpath) { if (alljoyn_aboutobjectdescription_haspath(aod, listener->objpath)) { size_t numInterfaces = alljoyn_aboutobjectdescription_getinterfaces(aod, listener->objpath, NULL, 0); EXPECT_EQ(listener->interfacecnt, numInterfaces); alljoyn_aboutobjectdescription_getinterfaces(aod, listener->objpath, listener->announcedinterfaceset, numInterfaces); for (i = 0; i < listener->interfacecnt; ++i) { const char* iface = listener->announcedinterfaceset[i]; for (j = 0; j < listener->interfacecnt; ++j) { if (!strcmp(iface, listener->expectedinterfaceset[j])) { intersections++; } } } if (listener->interfacecnt == intersections) { listener->announcelistenercount++; } } } } int setExpectInterfaces(filtered_about_listener* listener, const char* path, const char** interfaces, size_t infCount) { size_t i = 0; strcpy(listener->objpath, path); for (; i < infCount; ++i) { listener->expectedinterfaceset[i] = (char*) malloc(sizeof(char) * strlen(interfaces[i])); strcpy(listener->expectedinterfaceset[i], interfaces[i]); } listener->interfacecnt = infCount; return 0; } about_test_about_listener* create_about_test_about_listener(int i) { about_test_about_listener* result = (about_test_about_listener*) malloc(sizeof(about_test_about_listener)); result->i = i; alljoyn_aboutlistener_callback* callback = (alljoyn_aboutlistener_callback*) malloc(sizeof(alljoyn_aboutlistener_callback)); callback->about_listener_announced = announced_cb; result->listener = alljoyn_aboutlistener_create(callback, &(result->i)); return result; } alljoyn_busobject create_about_obj_test_bus_object(alljoyn_busattachment bus, const char* path, const char* interfaceName) { QStatus status = ER_FAIL; alljoyn_busobject result = NULL; result = alljoyn_busobject_create(path, QCC_FALSE, NULL, NULL); alljoyn_interfacedescription iface = alljoyn_busattachment_getinterface(bus, interfaceName); EXPECT_TRUE(iface != NULL) << "NULL InterfaceDescription* for " << interfaceName; if (iface == NULL) { printf("The interfaceDescription pointer for %s was NULL \ when it should not have been.", interfaceName); return NULL; } alljoyn_busobject_addinterface(result, iface); alljoyn_busobject_setannounceflag(result, iface, ANNOUNCED); alljoyn_interfacedescription_member foomember; alljoyn_interfacedescription_getmember(iface, "Foo", &foomember); const alljoyn_busobject_methodentry methodEntries[] = { { &foomember, foo_cb } }; status = alljoyn_busobject_addmethodhandlers(result, methodEntries, sizeof(methodEntries) / sizeof(methodEntries[0])); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); return result; } alljoyn_busobject create_about_obj_test_bus_object_2(alljoyn_busattachment bus, const char* path, const char** interfaceNames, size_t ifaceNameSize) { QStatus status = ER_FAIL; alljoyn_busobject result = NULL; result = alljoyn_busobject_create(path, QCC_FALSE, NULL, NULL); for (size_t i = 0; i < ifaceNameSize; ++i) { alljoyn_interfacedescription iface = alljoyn_busattachment_getinterface(bus, interfaceNames[i]); EXPECT_TRUE(iface != NULL) << "NULL InterfaceDescription* for " << interfaceNames[i]; if (iface == NULL) { printf("The interfaceDescription pointer for %s was NULL \ when it should not have been.", interfaceNames[i]); return NULL; } alljoyn_busobject_addinterface(result, iface); alljoyn_busobject_setannounceflag(result, iface, ANNOUNCED); alljoyn_interfacedescription_member foomember; alljoyn_interfacedescription_getmember(iface, "Foo", &foomember); const alljoyn_busobject_methodentry methodEntries[] = { { &foomember, foo_cb } }; status = alljoyn_busobject_addmethodhandlers(result, methodEntries, sizeof(methodEntries) / sizeof(methodEntries[0])); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); } return result; } about_test_wildcard_about_listener* create_about_test_wildcard_about_listener() { about_test_wildcard_about_listener* result = (about_test_wildcard_about_listener*) malloc(sizeof(about_test_wildcard_about_listener)); result->announcelistenercount = 0; alljoyn_aboutlistener_callback* callback = (alljoyn_aboutlistener_callback*) malloc(sizeof(alljoyn_aboutlistener_callback)); callback->about_listener_announced = about_test_wildcard_about_listener_announced_cb; result->listener = alljoyn_aboutlistener_create(callback, result); return result; } announce_non_128_bit_app_id_about_listener* create_announce_non_128_bit_app_id_about_listener() { announce_non_128_bit_app_id_about_listener* result = (announce_non_128_bit_app_id_about_listener*) malloc(sizeof(announce_non_128_bit_app_id_about_listener)); alljoyn_aboutlistener_callback* callback = (alljoyn_aboutlistener_callback*) malloc(sizeof(alljoyn_aboutlistener_callback)); callback->about_listener_announced = non_128_bit_app_id_about_listener_announced_cb; result->listener = alljoyn_aboutlistener_create(callback, result); result->aboutData = NULL; return result; } remove_object_description_about_listener* create_remove_object_description_about_listener() { remove_object_description_about_listener* result = (remove_object_description_about_listener*) malloc(sizeof(remove_object_description_about_listener)); result->announcelistenercount = 0; alljoyn_aboutlistener_callback* callback = (alljoyn_aboutlistener_callback*) malloc(sizeof(alljoyn_aboutlistener_callback)); callback->about_listener_announced = remove_object_description_about_listener_cb; result->listener = alljoyn_aboutlistener_create(callback, result); return result; } filtered_about_listener* create_filtered_about_listener() { filtered_about_listener* result = (filtered_about_listener*) malloc(sizeof(filtered_about_listener)); result->announcelistenercount = 0; result->interfacecnt = 0; alljoyn_aboutlistener_callback* callback = (alljoyn_aboutlistener_callback*) malloc(sizeof(alljoyn_aboutlistener_callback)); callback->about_listener_announced = filtered_about_listener_cb; result->listener = alljoyn_aboutlistener_create(callback, result); return result; } void destroy_about_test_about_listener(about_test_about_listener* aboutListener) { if (aboutListener) { if (aboutListener->listener) { alljoyn_aboutlistener_destroy(aboutListener->listener); aboutListener->listener = NULL; } free(aboutListener); aboutListener = NULL; } } void destroy_about_obj_test_bus_object(alljoyn_busobject obj) { if (obj) { alljoyn_busobject_destroy(obj); obj = NULL; } } void destroy_about_test_wildcard_about_listener(about_test_wildcard_about_listener* aboutListener) { if (aboutListener) { if (aboutListener->listener) { alljoyn_aboutlistener_destroy(aboutListener->listener); aboutListener->listener = NULL; } free(aboutListener); aboutListener = NULL; } } void destroy_announce_non_128_bit_app_id_about_listener(announce_non_128_bit_app_id_about_listener* aboutListener) { if (aboutListener) { if (aboutListener->listener) { alljoyn_aboutlistener_destroy(aboutListener->listener); aboutListener->listener = NULL; } if (aboutListener->aboutData) { alljoyn_msgarg_destroy(aboutListener->aboutData); aboutListener->aboutData = NULL; } free(aboutListener); aboutListener = NULL; } } void destroy_remove_object_description_about_listener(remove_object_description_about_listener* aboutListener) { destroy_about_test_wildcard_about_listener(aboutListener); } void destroy_filtered_about_listener(filtered_about_listener* aboutListener) { if (!aboutListener) { return; } if (aboutListener->listener) { alljoyn_aboutlistener_destroy(aboutListener->listener); aboutListener->listener = NULL; } } alljoyn-15.04b/alljoyn_c/unit_test/AboutListenerTestApi.h000066400000000000000000000075321255700255500235650ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ABOUT_LISTENER_API_H #define _ABOUT_LISTENER_API_H #include #include #include #include #include #include #include #include #ifdef __cplusplus extern "C" { #endif typedef struct about_test_about_listener_t { int i; alljoyn_aboutlistener listener; }about_test_about_listener; typedef struct about_test_wildcard_about_listener_t { uint32_t announcelistenercount; alljoyn_aboutlistener listener; }about_test_wildcard_about_listener; typedef struct announce_app_id_with_non_128_bit_length_about_listener_t { alljoyn_msgarg aboutData; alljoyn_aboutlistener listener; }announce_non_128_bit_app_id_about_listener; typedef about_test_wildcard_about_listener remove_object_description_about_listener; typedef struct filtered_about_listener_t { char* expectedinterfaceset[256]; const char* announcedinterfaceset[256]; uint32_t announcelistenercount; size_t interfacecnt; char objpath[256]; alljoyn_aboutlistener listener; } filtered_about_listener; void zero_announceListenerFlags(); int setExpectInterfaces(filtered_about_listener* listener, const char* path, const char** interfaces, size_t infCount); about_test_about_listener* create_about_test_about_listener(int i); alljoyn_busobject create_about_obj_test_bus_object(alljoyn_busattachment bus, const char* path, const char* interfaceName); alljoyn_busobject create_about_obj_test_bus_object_2(alljoyn_busattachment bus, const char* path, const char** interfaceNames, size_t ifaceNameSize); about_test_wildcard_about_listener*create_about_test_wildcard_about_listener(); announce_non_128_bit_app_id_about_listener*create_announce_non_128_bit_app_id_about_listener(); remove_object_description_about_listener*create_remove_object_description_about_listener(); filtered_about_listener* create_filtered_about_listener(); void destroy_about_test_about_listener(about_test_about_listener* aboutListener); void destroy_about_obj_test_bus_object(alljoyn_busobject obj); void destroy_about_test_wildcard_about_listener(about_test_wildcard_about_listener* aboutListener); void destroy_announce_non_128_bit_app_id_about_listener(announce_non_128_bit_app_id_about_listener* aboutListener); void destroy_remove_object_description_about_listener(remove_object_description_about_listener* aboutListener); void destroy_filtered_about_listener(filtered_about_listener* aboutListener); #ifdef __cplusplus } /* extern "C" */ #endif #endif /* _ABOUT_LISTENER_API_H */ alljoyn-15.04b/alljoyn_c/unit_test/AboutObjTest.cc000066400000000000000000001013761255700255500222170ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #include #include #include #include "ajTestCommon.h" #include "alljoyn/DBusStd.h" #include #include /* * This test uses the GUID128 in multiple places to generate a random string. * We are using random strings in many of the interface names to prevent multiple * tests interfering with one another. Some automated build systems could run this * same test on multiple platforms at one time. Since the names announced could * be seen across platforms we want to make the names unique so we know we are * responding to an advertisement we have made. */ /* * The unit test use many busy wait loops. The busy wait loops were chosen * over thread sleeps because of the ease of understanding the busy wait loops. * Also busy wait loops do not require any platform specific threading code. */ #define WAIT_TIME 5 using namespace ajn; static QCC_BOOL my_sessionportlistener_acceptsessionjoiner(const void* context, alljoyn_sessionport sessionPort, const char* joiner, const alljoyn_sessionopts opts) { QCC_UNUSED(context); QCC_UNUSED(sessionPort); QCC_UNUSED(joiner); QCC_UNUSED(opts); return QCC_TRUE; } static void echo_aboutobject(alljoyn_busobject object, const alljoyn_interfacedescription_member* member, alljoyn_message message) { QCC_UNUSED(member); alljoyn_msgarg arg = alljoyn_message_getarg(message, 0); QStatus status = alljoyn_busobject_methodreply_args(object, message, arg, 1); EXPECT_EQ(ER_OK, status) << "Echo: Error sending reply, Actual Status: " << QCC_StatusText(status); } static alljoyn_busobject create_about_obj_test_bus_object(alljoyn_busattachment bus, const char* path, const char* interfaceName) { QStatus status = ER_FAIL; alljoyn_busobject result = NULL; result = alljoyn_busobject_create(path, QCC_FALSE, NULL, NULL); alljoyn_interfacedescription iface = alljoyn_busattachment_getinterface(bus, interfaceName); EXPECT_TRUE(iface != NULL) << "NULL InterfaceDescription* for " << interfaceName; if (iface == NULL) { printf("The interfaceDescription pointer for %s was NULL when it should not have been.", interfaceName); return NULL; } alljoyn_busobject_addinterface(result, iface); alljoyn_busobject_setannounceflag(result, iface, ANNOUNCED); /* Register the method handlers with the object */ alljoyn_interfacedescription_member echomember; alljoyn_interfacedescription_getmember(iface, "Echo", &echomember); const alljoyn_busobject_methodentry methodEntries[] = { { &echomember, echo_aboutobject } }; status = alljoyn_busobject_addmethodhandlers(result, methodEntries, sizeof(methodEntries) / sizeof(methodEntries[0])); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); return result; } static void destroy_about_obj_test_bus_object(alljoyn_busobject obj) { if (obj) { alljoyn_busobject_destroy(obj); obj = NULL; } } typedef struct about_obj_test_about_listener_2_t { int announceListenerFlag; int aboutObjectPartOfAnnouncement; char* busName; alljoyn_sessionport port; alljoyn_aboutlistener listener; uint16_t version; }about_obj_test_about_listener_2; static void about_obj_test_about_listener_announced_cb(const void* context, const char* busName, uint16_t version, alljoyn_sessionport port, const alljoyn_msgarg objectDescriptionArg, const alljoyn_msgarg aboutDataArg) { QCC_UNUSED(aboutDataArg); about_obj_test_about_listener_2* listener = (about_obj_test_about_listener_2*)(context); EXPECT_FALSE(listener->announceListenerFlag == 1) << "We don't expect the flag to already be true when an AnnouceSignal is received."; size_t busNameLen = strlen(busName); if (listener->busName) { free(listener->busName); listener->busName = NULL; } listener->busName = (char*) malloc(sizeof(char) * (busNameLen + 1)); strncpy(listener->busName, busName, busNameLen); listener->busName[busNameLen] = '\0'; listener->port = port; listener->version = version; alljoyn_aboutobjectdescription aod = alljoyn_aboutobjectdescription_create(); QStatus status = alljoyn_aboutobjectdescription_createfrommsgarg(aod, objectDescriptionArg); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); listener->aboutObjectPartOfAnnouncement = alljoyn_aboutobjectdescription_hasinterface(aod, "org.alljoyn.About"); listener->announceListenerFlag = QCC_TRUE; alljoyn_aboutobjectdescription_destroy(aod); } static about_obj_test_about_listener_2* create_about_obj_test_about_listener_2() { about_obj_test_about_listener_2* result = (about_obj_test_about_listener_2*) malloc(sizeof(about_obj_test_about_listener_2)); alljoyn_aboutlistener_callback callbacks = { &about_obj_test_about_listener_announced_cb }; result->listener = alljoyn_aboutlistener_create(&callbacks, result); result->port = 0; result->busName = NULL; result->announceListenerFlag = 0; result->aboutObjectPartOfAnnouncement = 0; return result; } static void destroy_about_obj_test_about_listener_2(about_obj_test_about_listener_2* listener) { if (listener->busName) { free(listener->busName); listener->busName = NULL; } if (listener->listener) { alljoyn_aboutlistener_destroy(listener->listener); listener = NULL; } } class AboutObjTest : public testing::Test { public: AboutObjTest() { port = 25; aboutData = alljoyn_aboutdata_create("en"); serviceBus = NULL; } virtual void SetUp() { QStatus status = ER_FAIL; serviceBus = alljoyn_busattachment_create("AboutObjTestServiceBus", QCC_TRUE); status = alljoyn_busattachment_start(serviceBus); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(serviceBus, NULL); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* Setup the about data */ qcc::GUID128 appId; status = alljoyn_aboutdata_setappid(aboutData, appId.GetBytes(), qcc::GUID128::SIZE); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setdevicename(aboutData, "My Device Name", "en"); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); qcc::GUID128 deviceId; status = alljoyn_aboutdata_setdeviceid(aboutData, deviceId.ToString().c_str()); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setappname(aboutData, "Application", "en"); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setmanufacturer(aboutData, "Manufacturer", "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setmodelnumber(aboutData, "123456"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setdescription(aboutData, "A poetic description of this application", "en"); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setdateofmanufacture(aboutData, "2014-03-24"); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setsoftwareversion(aboutData, "0.1.2"); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_sethardwareversion(aboutData, "0.0.1"); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setsupporturl(aboutData, "http://www.example.com"); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_TRUE(alljoyn_aboutdata_isvalid(aboutData, "en")); alljoyn_sessionportlistener_callbacks callbacks = { &my_sessionportlistener_acceptsessionjoiner }; alljoyn_sessionopts opts = alljoyn_sessionopts_create(ALLJOYN_TRAFFIC_TYPE_MESSAGES, QCC_FALSE, ALLJOYN_PROXIMITY_ANY, ALLJOYN_TRANSPORT_ANY); listener = alljoyn_sessionportlistener_create(&callbacks, NULL); status = alljoyn_busattachment_bindsessionport(serviceBus, &port, opts, listener); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); } virtual void TearDown() { if (serviceBus) { alljoyn_busattachment_stop(serviceBus); alljoyn_busattachment_join(serviceBus); alljoyn_busattachment_destroy(serviceBus); serviceBus = NULL; } if (aboutData) { alljoyn_aboutdata_destroy(aboutData); aboutData = NULL; } if (listener) { alljoyn_sessionportlistener_destroy(listener); listener = NULL; } } alljoyn_sessionportlistener listener; alljoyn_busattachment serviceBus; alljoyn_aboutdata aboutData; alljoyn_sessionport port; }; TEST_F(AboutObjTest, AnnounceSessionPortNotBound) { QStatus status = ER_FAIL; alljoyn_aboutobj aboutObj = alljoyn_aboutobj_create(serviceBus, UNANNOUNCED); /* The SessionPort 5154 is not bound so should return ER_ABOUT_SESSIONPORT_NOT_BOUND error */ status = alljoyn_aboutobj_announce(aboutObj, (alljoyn_sessionport)(5154), aboutData); EXPECT_EQ(ER_ABOUT_SESSIONPORT_NOT_BOUND, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_aboutobj_destroy(aboutObj); } TEST_F(AboutObjTest, AnnounceMissingRequiredField) { QStatus status = ER_FAIL; alljoyn_aboutobj aboutObj = alljoyn_aboutobj_create(serviceBus, UNANNOUNCED); alljoyn_aboutdata badAboutData = alljoyn_aboutdata_create("en"); /* DefaultLanguage and other required fields are missing */ status = alljoyn_aboutobj_announce(aboutObj, port, badAboutData); EXPECT_EQ(ER_ABOUT_ABOUTDATA_MISSING_REQUIRED_FIELD, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setdefaultlanguage(badAboutData, "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutobj_announce(aboutObj, port, badAboutData); EXPECT_EQ(ER_ABOUT_ABOUTDATA_MISSING_REQUIRED_FIELD, status) << " Actual Status: " << QCC_StatusText(status); uint8_t originalAppId[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 }; status = alljoyn_aboutdata_setappid(badAboutData, originalAppId, 16); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* DeviceId and other required fields are missing */ status = alljoyn_aboutobj_announce(aboutObj, port, badAboutData); EXPECT_EQ(ER_ABOUT_ABOUTDATA_MISSING_REQUIRED_FIELD, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setdeviceid(badAboutData, "fakeID"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* AppName and other required fields are missing */ status = alljoyn_aboutobj_announce(aboutObj, port, badAboutData); EXPECT_EQ(ER_ABOUT_ABOUTDATA_MISSING_REQUIRED_FIELD, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setappname(badAboutData, "Application", "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* Manufacturer and other required fields are missing */ status = alljoyn_aboutobj_announce(aboutObj, port, badAboutData); EXPECT_EQ(ER_ABOUT_ABOUTDATA_MISSING_REQUIRED_FIELD, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setmanufacturer(badAboutData, "Manufacturer", "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* ModelNumber and other required fields are missing */ status = alljoyn_aboutobj_announce(aboutObj, port, badAboutData); EXPECT_EQ(ER_ABOUT_ABOUTDATA_MISSING_REQUIRED_FIELD, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setmodelnumber(badAboutData, "123456"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* Description and other required fields are missing */ status = alljoyn_aboutobj_announce(aboutObj, port, badAboutData); EXPECT_EQ(ER_ABOUT_ABOUTDATA_MISSING_REQUIRED_FIELD, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setdescription(badAboutData, "A poetic description of this application", "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* SoftwareVersion missing */ status = alljoyn_aboutobj_announce(aboutObj, port, badAboutData); EXPECT_EQ(ER_ABOUT_ABOUTDATA_MISSING_REQUIRED_FIELD, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setsoftwareversion(badAboutData, "0.1.2"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* Now all required fields are set for the default language */ status = alljoyn_aboutobj_announce(aboutObj, port, badAboutData); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_aboutdata_destroy(badAboutData); } TEST_F(AboutObjTest, SetAnnounceFlag) { QStatus status = ER_FAIL; char interfaceName[] = "org.alljoyn.About"; alljoyn_interfacedescription iface = alljoyn_busattachment_getinterface(serviceBus, interfaceName); EXPECT_TRUE(iface != NULL) << "NULL InterfaceDescription* for " << interfaceName; alljoyn_busobject busObj = alljoyn_busobject_create("/test/alljoyn/AboutObj", QCC_FALSE, NULL, NULL); status = alljoyn_busobject_addinterface_announced(busObj, iface); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busobject_setannounceflag(busObj, iface, UNANNOUNCED); size_t numIfaces = alljoyn_busobject_getannouncedinterfacenames(busObj, NULL, 0); ASSERT_EQ(static_cast(0), numIfaces); status = alljoyn_busobject_setannounceflag(busObj, iface, ANNOUNCED); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); numIfaces = alljoyn_busobject_getannouncedinterfacenames(busObj, NULL, 0); ASSERT_EQ(static_cast(1), numIfaces); const char* interfaces[1]; numIfaces = alljoyn_busobject_getannouncedinterfacenames(busObj, interfaces, numIfaces); EXPECT_STREQ("org.alljoyn.About", interfaces[0]); alljoyn_interfacedescription dbusIface = alljoyn_busattachment_getinterface(serviceBus, org::freedesktop::DBus::InterfaceName); status = alljoyn_busobject_setannounceflag(busObj, dbusIface, ANNOUNCED); EXPECT_EQ(ER_BUS_OBJECT_NO_SUCH_INTERFACE, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busobject_setannounceflag(busObj, iface, UNANNOUNCED); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); numIfaces = alljoyn_busobject_getannouncedinterfacenames(busObj, NULL, 0); ASSERT_EQ(static_cast(0), numIfaces); alljoyn_busobject_destroy(busObj); } TEST_F(AboutObjTest, CancelAnnouncement) { QStatus status = ER_FAIL; alljoyn_busattachment clientBus = alljoyn_busattachment_create("AboutObjTestClient", QCC_TRUE); status = alljoyn_busattachment_start(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(clientBus, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); about_obj_test_about_listener_2* listener = create_about_obj_test_about_listener_2(); alljoyn_busattachment_registeraboutlistener(clientBus, listener->listener); status = alljoyn_busattachment_whoimplements_interface(clientBus, "org.alljoyn.About"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_aboutobj aboutObj = alljoyn_aboutobj_create(serviceBus, ANNOUNCED); status = alljoyn_aboutobj_announce(aboutObj, port, aboutData); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (uint32_t msec = 0; msec < 5000; msec += WAIT_TIME) { if (listener->announceListenerFlag == QCC_TRUE) { break; } qcc::Sleep(WAIT_TIME); } EXPECT_TRUE(listener->announceListenerFlag) << "The announceListenerFlag must be true to continue this test."; EXPECT_TRUE(listener->aboutObjectPartOfAnnouncement) << "The org.alljoyn.About interface was not part of the announced object description."; const char* serviceBusUniqueName = alljoyn_busattachment_getuniquename(serviceBus); EXPECT_STREQ(serviceBusUniqueName, listener->busName); EXPECT_EQ(port, listener->port); status = alljoyn_aboutobj_unannounce(aboutObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_stop(clientBus); alljoyn_busattachment_join(clientBus); alljoyn_aboutobj_destroy(aboutObj); alljoyn_busattachment_destroy(clientBus); destroy_about_obj_test_about_listener_2(listener); } TEST_F(AboutObjTest, AnnounceTheAboutObj) { QStatus status = ER_FAIL; alljoyn_busattachment clientBus = alljoyn_busattachment_create("AboutObjTestClient", QCC_TRUE); status = alljoyn_busattachment_start(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(clientBus, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); about_obj_test_about_listener_2* listener = create_about_obj_test_about_listener_2(); alljoyn_busattachment_registeraboutlistener(clientBus, listener->listener); status = alljoyn_busattachment_whoimplements_interface(clientBus, "org.alljoyn.About"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_aboutobj aboutObj = alljoyn_aboutobj_create(serviceBus, ANNOUNCED); status = alljoyn_aboutobj_announce(aboutObj, port, aboutData); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (uint32_t msec = 0; msec < 5000; msec += WAIT_TIME) { if (listener->announceListenerFlag == QCC_TRUE) { break; } qcc::Sleep(WAIT_TIME); } EXPECT_TRUE(listener->announceListenerFlag) << "The announceListenerFlag must be true to continue this test."; EXPECT_TRUE(listener->aboutObjectPartOfAnnouncement) << "The org.alljoyn.About interface was not part of the announced object description."; const char* serviceBusUniqueName = alljoyn_busattachment_getuniquename(serviceBus); EXPECT_STREQ(serviceBusUniqueName, listener->busName); EXPECT_EQ(port, listener->port); alljoyn_busattachment_stop(clientBus); alljoyn_busattachment_join(clientBus); alljoyn_aboutobj_destroy(aboutObj); alljoyn_busattachment_destroy(clientBus); destroy_about_obj_test_about_listener_2(listener); } TEST_F(AboutObjTest, Announce) { QStatus status = ER_FAIL; qcc::GUID128 interface_rand_string; qcc::String ifaceNameQcc = "test.about.a" + interface_rand_string.ToString(); qcc::String interfaceQcc = "" "" " " " " " " " " "" ""; const char* ifaceName = ifaceNameQcc.c_str(); const char* interface = interfaceQcc.c_str(); status = alljoyn_busattachment_createinterfacesfromxml(serviceBus, interface); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busobject busObject = create_about_obj_test_bus_object(serviceBus, "/test/alljoyn/AboutObj", ifaceName); status = alljoyn_busattachment_registerbusobject(serviceBus, busObject); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment clientBus = alljoyn_busattachment_create("AboutObjTestClient", QCC_TRUE); status = alljoyn_busattachment_start(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(clientBus, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); about_obj_test_about_listener_2* aboutListener = create_about_obj_test_about_listener_2(); alljoyn_busattachment_registeraboutlistener(clientBus, aboutListener->listener); status = alljoyn_busattachment_whoimplements_interface(clientBus, ifaceName); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_aboutobj aboutObj = alljoyn_aboutobj_create(serviceBus, UNANNOUNCED); status = alljoyn_aboutobj_announce(aboutObj, port, aboutData); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (uint32_t msec = 0; msec < 5000; msec += WAIT_TIME) { if (aboutListener->announceListenerFlag == QCC_TRUE) { break; } qcc::Sleep(WAIT_TIME); } ASSERT_TRUE(aboutListener->announceListenerFlag) << "The announceListenerFlag must be true to continue this test."; EXPECT_STREQ(alljoyn_busattachment_getuniquename(serviceBus), aboutListener->busName); EXPECT_EQ(port, aboutListener->port); alljoyn_sessionid sessionId; alljoyn_sessionopts sessionOpts = alljoyn_sessionopts_create(ALLJOYN_TRAFFIC_TYPE_MESSAGES, QCC_FALSE, ALLJOYN_PROXIMITY_ANY, ALLJOYN_TRANSPORT_ANY); status = alljoyn_busattachment_joinsession(clientBus, aboutListener->busName, aboutListener->port, NULL, &sessionId, sessionOpts); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_proxybusobject proxy = alljoyn_proxybusobject_create(clientBus, aboutListener->busName, "/test/alljoyn/AboutObj", sessionId); status = alljoyn_proxybusobject_parsexml(proxy, interface, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status) << "\n" << interface; QCC_BOOL isImplementsIface = alljoyn_proxybusobject_implementsinterface(proxy, ifaceName); EXPECT_TRUE(isImplementsIface) << interface << "\n" << ifaceName; alljoyn_msgarg arg = alljoyn_msgarg_create_and_set("s", "String that should be Echoed back."); alljoyn_message replyMsg = alljoyn_message_create(clientBus); status = alljoyn_proxybusobject_methodcall(proxy, ifaceName, "Echo", arg, 1, replyMsg, 25000, 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status) << " " << "Invalid arg"; char* echoReply; alljoyn_msgarg arg0 = alljoyn_message_getarg(replyMsg, 0); status = alljoyn_msgarg_get(arg0, "s", &echoReply); EXPECT_STREQ("String that should be Echoed back.", echoReply); alljoyn_busattachment_stop(clientBus); alljoyn_busattachment_join(clientBus); destroy_about_obj_test_about_listener_2(aboutListener); destroy_about_obj_test_bus_object(busObject); alljoyn_proxybusobject_destroy(proxy); alljoyn_sessionopts_destroy(sessionOpts); alljoyn_msgarg_destroy(arg); alljoyn_message_destroy(replyMsg); alljoyn_aboutobj_destroy(aboutObj); alljoyn_busattachment_destroy(clientBus); } TEST_F(AboutObjTest, ProxyAccessToAboutObj) { QStatus status = ER_FAIL; qcc::GUID128 interface_rand_string; qcc::String ifaceNameQcc = "test.about.a" + interface_rand_string.ToString(); qcc::String interfaceQcc = "" "" " " " " " " " " "" ""; const char* ifaceName = ifaceNameQcc.c_str(); const char* interface = interfaceQcc.c_str(); status = alljoyn_busattachment_createinterfacesfromxml(serviceBus, interface); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busobject busObject = create_about_obj_test_bus_object(serviceBus, "/test/alljoyn/AboutObj", ifaceName); status = alljoyn_busattachment_registerbusobject(serviceBus, busObject); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment clientBus = alljoyn_busattachment_create("AboutObjTestClient", QCC_TRUE); status = alljoyn_busattachment_start(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(clientBus, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); about_obj_test_about_listener_2* aboutListener = create_about_obj_test_about_listener_2(); alljoyn_busattachment_registeraboutlistener(clientBus, aboutListener->listener); status = alljoyn_busattachment_whoimplements_interface(clientBus, ifaceName); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_aboutobj aboutObj = alljoyn_aboutobj_create(serviceBus, UNANNOUNCED); status = alljoyn_aboutobj_announce(aboutObj, port, aboutData); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (uint32_t msec = 0; msec < 5000; msec += WAIT_TIME) { if (aboutListener->announceListenerFlag == QCC_TRUE) { break; } qcc::Sleep(WAIT_TIME); } ASSERT_TRUE(aboutListener->announceListenerFlag) << "The announceListenerFlag must be true to continue this test."; EXPECT_STREQ(alljoyn_busattachment_getuniquename(serviceBus), aboutListener->busName); EXPECT_EQ(port, aboutListener->port); alljoyn_sessionid sessionId; alljoyn_sessionopts sessionOpts = alljoyn_sessionopts_create(ALLJOYN_TRAFFIC_TYPE_MESSAGES, QCC_FALSE, ALLJOYN_PROXIMITY_ANY, ALLJOYN_TRANSPORT_ANY); alljoyn_busattachment_enableconcurrentcallbacks(clientBus); status = alljoyn_busattachment_joinsession(clientBus, aboutListener->busName, aboutListener->port, NULL, &sessionId, sessionOpts); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_aboutproxy aProxy = alljoyn_aboutproxy_create(clientBus, aboutListener->busName, sessionId); /* * Call each of the proxy methods * GetObjDescription * GetAboutData * GetVersion */ uint16_t ver; status = alljoyn_aboutproxy_getversion(aProxy, &ver); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_EQ(aboutListener->version, ver); alljoyn_msgarg aboutArg = alljoyn_msgarg_create(); status = alljoyn_aboutproxy_getaboutdata(aProxy, "en", aboutArg); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_aboutdata aboutData = alljoyn_aboutdata_create_full(aboutArg, "en"); char* appName; status = alljoyn_aboutdata_getappname(aboutData, &appName, "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("Application", appName); char* manufacturer; status = alljoyn_aboutdata_getmanufacturer(aboutData, &manufacturer, "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("Manufacturer", manufacturer); char* modelNum; status = alljoyn_aboutdata_getmodelnumber(aboutData, &modelNum); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("123456", modelNum); char* desc; status = alljoyn_aboutdata_getdescription(aboutData, &desc, "en"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("A poetic description of this application", desc); char* dom; status = alljoyn_aboutdata_getdateofmanufacture(aboutData, &dom); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("2014-03-24", dom); char* softVer; status = alljoyn_aboutdata_getsoftwareversion(aboutData, &softVer); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("0.1.2", softVer); char* hwVer; status = alljoyn_aboutdata_gethardwareversion(aboutData, &hwVer); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("0.0.1", hwVer); char* support; status = alljoyn_aboutdata_getsupporturl(aboutData, &support); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("http://www.example.com", support); /* * French is specified language. * Expect an error. */ alljoyn_msgarg aboutArg_fr = alljoyn_msgarg_create(); status = alljoyn_aboutproxy_getaboutdata(aProxy, "fr", aboutArg_fr); EXPECT_EQ(ER_LANGUAGE_NOT_SUPPORTED, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg objDesc = alljoyn_msgarg_create(); alljoyn_aboutproxy_getobjectdescription(aProxy, objDesc); EXPECT_EQ(ER_LANGUAGE_NOT_SUPPORTED, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_aboutobjectdescription aObjDesc = alljoyn_aboutobjectdescription_create_full(objDesc); EXPECT_TRUE(alljoyn_aboutobjectdescription_haspath(aObjDesc, "/test/alljoyn/AboutObj")); EXPECT_TRUE(alljoyn_aboutobjectdescription_hasinterface(aObjDesc, ifaceName)); alljoyn_busattachment_stop(clientBus); alljoyn_busattachment_join(clientBus); alljoyn_aboutobjectdescription_destroy(aObjDesc); alljoyn_msgarg_destroy(objDesc); alljoyn_msgarg_destroy(aboutArg); alljoyn_msgarg_destroy(aboutArg_fr); alljoyn_aboutdata_destroy(aboutData); destroy_about_obj_test_about_listener_2(aboutListener); destroy_about_obj_test_bus_object(busObject); alljoyn_aboutproxy_destroy(aProxy); alljoyn_sessionopts_destroy(sessionOpts); alljoyn_aboutobj_destroy(aboutObj); alljoyn_busattachment_destroy(clientBus); } alljoyn-15.04b/alljoyn_c/unit_test/AboutObjectDescriptionTest.cc000066400000000000000000001300521255700255500251100ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include "ajTestCommon.h" #include "alljoyn/DBusStd.h" #include #include #include #include using namespace ajn; using namespace qcc; static alljoyn_busobject my_alljoyn_busobject_create(alljoyn_busattachment bus, const char* path) { alljoyn_busobject result = alljoyn_busobject_create(path, 0, NULL, NULL); QStatus status = ER_FAIL; const alljoyn_interfacedescription test_iface = alljoyn_busattachment_getinterface(bus, "org.alljoyn.test"); EXPECT_TRUE(test_iface != NULL) << "NULL InterfaceDescription* for org.alljoyn.test"; if (test_iface == NULL) { printf("The interfaceDescription pointer for org.alljoyn.test was NULL \ when it should not have been.\n"); return NULL; } status = alljoyn_busobject_addinterface_announced(result, test_iface); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); const alljoyn_interfacedescription game_iface = alljoyn_busattachment_getinterface(bus, "org.alljoyn.game"); EXPECT_TRUE(game_iface != NULL) << "NULL InterfaceDescription* for org.alljoyn.game"; if (game_iface == NULL) { printf("The interfaceDescription pointer for org.alljoyn.game was NULL \ when it should not have been.\n"); return NULL; } status = alljoyn_busobject_addinterface_announced(result, game_iface); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); const alljoyn_interfacedescription mediaplayer_iface = alljoyn_busattachment_getinterface(bus, "org.alljoyn.mediaplayer"); EXPECT_TRUE(mediaplayer_iface != NULL) << "NULL InterfaceDescription* for org.alljoyn.mediaplayer"; if (mediaplayer_iface == NULL) { printf("The interfaceDescription pointer for org.alljoyn.mediaplayer was NULL \ when it should not have been.\n"); return NULL; } status = alljoyn_busobject_addinterface_announced(result, mediaplayer_iface); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); return result; } static alljoyn_busobject my_alljoyn_busobject_create_1(alljoyn_busattachment bus, const char* path) { alljoyn_busobject result = alljoyn_busobject_create(path, 0, NULL, NULL); QStatus status = ER_FAIL; const alljoyn_interfacedescription iface = alljoyn_busattachment_getinterface(bus, "test.about.objectdescription.interface1"); EXPECT_TRUE(iface != NULL) << "NULL InterfaceDescription* for org.alljoyn.test"; if (iface == NULL) { printf("The interfaceDescription pointer for org.alljoyn.test was NULL \ when it should not have been.\n"); return NULL; } status = alljoyn_busobject_addinterface_announced(result, iface); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); return result; } static alljoyn_busobject my_alljoyn_busobject_create_2(alljoyn_busattachment bus, const char* path) { alljoyn_busobject result = alljoyn_busobject_create(path, 0, NULL, NULL); QStatus status = ER_FAIL; const alljoyn_interfacedescription iface = alljoyn_busattachment_getinterface(bus, "test.about.objectdescription.interface2"); EXPECT_TRUE(iface != NULL) << "NULL InterfaceDescription* for org.alljoyn.test"; if (iface == NULL) { printf("The interfaceDescription pointer for org.alljoyn.test was NULL \ when it should not have been.\n"); return NULL; } status = alljoyn_busobject_addinterface_announced(result, iface); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); return result; } TEST(AboutObjectDescriptionTest, Construct) { QStatus status = ER_FAIL; alljoyn_busattachment bus = alljoyn_busattachment_create("AlljoynObjectDescriptionTest", QCC_TRUE); alljoyn_abouticon aicon = alljoyn_abouticon_create(); status = alljoyn_abouticon_seturl(aicon, "image/png", "http://www.example.com"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_abouticonobj aboutIconObj = alljoyn_abouticonobj_create(bus, aicon); const qcc::String interfaceQcc = "" "" " " " " "" "" " " " " "" "" " " " " "" ""; const char* interface = interfaceQcc.c_str(); status = alljoyn_busattachment_createinterfacesfromxml(bus, interface); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busobject busObject = my_alljoyn_busobject_create(bus, "/org/alljoyn/test"); status = alljoyn_busattachment_registerbusobject(bus, busObject); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg arg = alljoyn_msgarg_create(); ((BusAttachment*)bus)->GetInternal().GetAnnouncedObjectDescription(*((MsgArg*)arg)); alljoyn_aboutobjectdescription aod = alljoyn_aboutobjectdescription_create_full(arg); EXPECT_TRUE(alljoyn_aboutobjectdescription_hasinterfaceatpath(aod, "/About/DeviceIcon", "org.alljoyn.Icon")); EXPECT_TRUE(alljoyn_aboutobjectdescription_hasinterfaceatpath(aod, "/org/alljoyn/test", "org.alljoyn.test")); EXPECT_TRUE(alljoyn_aboutobjectdescription_hasinterfaceatpath(aod, "/org/alljoyn/test", "org.alljoyn.game")); EXPECT_TRUE(alljoyn_aboutobjectdescription_hasinterfaceatpath(aod, "/org/alljoyn/test", "org.alljoyn.mediaplayer")); EXPECT_FALSE(alljoyn_aboutobjectdescription_hasinterfaceatpath(aod, "/org/alljoyn/test", "org.alljoyn.Icon")); EXPECT_FALSE(alljoyn_aboutobjectdescription_hasinterfaceatpath(aod, "/About/DeviceIcon", "org.alljoyn.test")); EXPECT_FALSE(alljoyn_aboutobjectdescription_hasinterfaceatpath(aod, "/About/DeviceIcon", "org.alljoyn.game")); EXPECT_FALSE(alljoyn_aboutobjectdescription_hasinterfaceatpath(aod, "/About/DeviceIcon", "org.alljoyn.mediaplayer")); EXPECT_TRUE(alljoyn_aboutobjectdescription_hasinterface(aod, "org.alljoyn.Icon")); EXPECT_TRUE(alljoyn_aboutobjectdescription_hasinterface(aod, "org.alljoyn.test")); EXPECT_TRUE(alljoyn_aboutobjectdescription_hasinterface(aod, "org.alljoyn.game")); EXPECT_TRUE(alljoyn_aboutobjectdescription_hasinterface(aod, "org.alljoyn.mediaplayer")); EXPECT_FALSE(alljoyn_aboutobjectdescription_hasinterface(aod, "org.alljoyn.IAmNotReal")); alljoyn_abouticonobj_destroy(aboutIconObj); alljoyn_busobject_destroy(busObject); alljoyn_msgarg_destroy(arg); alljoyn_aboutobjectdescription_destroy(aod); status = alljoyn_busattachment_stop(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_destroy(bus); } TEST(AboutObjectDescriptionTest, GetMsgArg) { QStatus status = ER_FAIL; alljoyn_busattachment bus = alljoyn_busattachment_create("AlljoynObjectDescriptionTest", QCC_TRUE); alljoyn_abouticon aicon = alljoyn_abouticon_create(); status = alljoyn_abouticon_seturl(aicon, "image/png", "http://www.example.com"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_abouticonobj aboutIconObj = alljoyn_abouticonobj_create(bus, aicon); const qcc::String interfaceQcc = "" "" " " " " "" "" " " " " "" "" " " " " "" ""; const char* interface = interfaceQcc.c_str(); status = alljoyn_busattachment_createinterfacesfromxml(bus, interface); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busobject busObject = my_alljoyn_busobject_create(bus, "/org/alljoyn/test"); status = alljoyn_busattachment_registerbusobject(bus, busObject); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg argObj = alljoyn_msgarg_create(); ((BusAttachment*)bus)->GetInternal().GetAnnouncedObjectDescription(*((MsgArg*)argObj)); alljoyn_aboutobjectdescription aod = alljoyn_aboutobjectdescription_create_full(argObj); alljoyn_msgarg arg = alljoyn_msgarg_create(); alljoyn_aboutobjectdescription_getmsgarg(aod, arg); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg structarg; size_t s_size; status = alljoyn_msgarg_get(arg, "a(oas)", &s_size, &structarg); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_EQ(2u, s_size); if (s_size > 0) { char** object_path = (char**) malloc(sizeof(char*) * s_size); size_t* number_itfs = (size_t*) malloc(sizeof(size_t) * s_size); alljoyn_msgarg* interfaces_arg = (alljoyn_msgarg*) malloc(sizeof(alljoyn_msgarg) * s_size); for (size_t i = 0; i < s_size; ++i) { status = alljoyn_msgarg_get(alljoyn_msgarg_array_element(structarg, i), "(oas)", &(object_path[i]), &(number_itfs[i]), &(interfaces_arg[i])); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); } EXPECT_STREQ("/About/DeviceIcon", object_path[0]); ASSERT_EQ(1u, number_itfs[0]); char* intf; alljoyn_msgarg_get(alljoyn_msgarg_array_element(interfaces_arg[0], 0), "s", &intf); EXPECT_STREQ("org.alljoyn.Icon", intf); EXPECT_STREQ("/org/alljoyn/test", object_path[1]); ASSERT_EQ(3u, number_itfs[1]); /* * This test makes some assumptions about order that may not always be true * if we see failures that is a result of right values in the wrong order * then this test should be modified to account for that. */ alljoyn_msgarg_get(alljoyn_msgarg_array_element(interfaces_arg[1], 0), "s", &intf); EXPECT_STREQ("org.alljoyn.game", intf); alljoyn_msgarg_get(alljoyn_msgarg_array_element(interfaces_arg[1], 1), "s", &intf); EXPECT_STREQ("org.alljoyn.mediaplayer", intf); alljoyn_msgarg_get(alljoyn_msgarg_array_element(interfaces_arg[1], 2), "s", &intf); EXPECT_STREQ("org.alljoyn.test", intf); free(object_path); free(number_itfs); free(interfaces_arg); } alljoyn_abouticon_destroy(aicon); alljoyn_abouticonobj_destroy(aboutIconObj); alljoyn_busobject_destroy(busObject); alljoyn_msgarg_destroy(arg); alljoyn_aboutobjectdescription_destroy(aod); status = alljoyn_busattachment_stop(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_destroy(bus); } TEST(AboutObjectDescriptionTest, GetPaths) { QStatus status = ER_FAIL; alljoyn_busattachment bus = alljoyn_busattachment_create("AlljoynObjectDescriptionTest", QCC_TRUE); alljoyn_abouticon aicon = alljoyn_abouticon_create(); status = alljoyn_abouticon_seturl(aicon, "image/png", "http://www.example.com"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_abouticonobj aboutIconObj = alljoyn_abouticonobj_create(bus, aicon); const qcc::String interfaceQcc = "" "" " " " " "" "" " " " " "" "" " " " " "" ""; const char* interface = interfaceQcc.c_str(); status = alljoyn_busattachment_createinterfacesfromxml(bus, interface); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busobject busObject = my_alljoyn_busobject_create(bus, "/org/alljoyn/test"); status = alljoyn_busattachment_registerbusobject(bus, busObject); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg argObj = alljoyn_msgarg_create(); ((BusAttachment*)bus)->GetInternal().GetAnnouncedObjectDescription(*((MsgArg*)argObj)); alljoyn_aboutobjectdescription aod = alljoyn_aboutobjectdescription_create_full(argObj); size_t numPaths = alljoyn_aboutobjectdescription_getpaths(aod, NULL, 0); ASSERT_EQ(2u, numPaths); const char** paths = (const char**) malloc(sizeof(const char*) * numPaths); alljoyn_aboutobjectdescription_getpaths(aod, paths, numPaths); EXPECT_TRUE(strcmp(paths[0], "/About/DeviceIcon") == 0 || strcmp(paths[0], "/org/alljoyn/test") == 0) << paths[0]; EXPECT_TRUE(strcmp(paths[1], "/About/DeviceIcon") == 0 || strcmp(paths[1], "/org/alljoyn/test") == 0) << paths[1]; free(paths); alljoyn_abouticon_destroy(aicon); alljoyn_abouticonobj_destroy(aboutIconObj); alljoyn_busobject_destroy(busObject); alljoyn_msgarg_destroy(argObj); alljoyn_aboutobjectdescription_destroy(aod); status = alljoyn_busattachment_stop(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_destroy(bus); } TEST(AboutObjectDescriptionTest, GetInterfaces) { QStatus status = ER_FAIL; alljoyn_busattachment bus = alljoyn_busattachment_create("AlljoynObjectDescriptionTest", QCC_TRUE); alljoyn_abouticon aicon = alljoyn_abouticon_create(); status = alljoyn_abouticon_seturl(aicon, "image/png", "http://www.example.com"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_abouticonobj aboutIconObj = alljoyn_abouticonobj_create(bus, aicon); const qcc::String interfaceQcc = "" "" " " " " "" "" " " " " "" "" " " " " "" ""; const char* interface = interfaceQcc.c_str(); status = alljoyn_busattachment_createinterfacesfromxml(bus, interface); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busobject busObject = my_alljoyn_busobject_create(bus, "/org/alljoyn/test"); status = alljoyn_busattachment_registerbusobject(bus, busObject); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg argObj = alljoyn_msgarg_create(); ((BusAttachment*)bus)->GetInternal().GetAnnouncedObjectDescription(*((MsgArg*)argObj)); alljoyn_aboutobjectdescription aod = alljoyn_aboutobjectdescription_create_full(argObj); size_t numPaths = alljoyn_aboutobjectdescription_getpaths(aod, NULL, 0); ASSERT_EQ(2u, numPaths); size_t numInterfaces = alljoyn_aboutobjectdescription_getinterfaces(aod, "/About/DeviceIcon", NULL, 0); ASSERT_EQ(1u, numInterfaces); const char** interfaces = (const char**) malloc(sizeof(const char*) * numInterfaces); alljoyn_aboutobjectdescription_getinterfaces(aod, "/About/DeviceIcon", interfaces, numInterfaces); EXPECT_STREQ("org.alljoyn.Icon", interfaces[0]); free(interfaces); numInterfaces = alljoyn_aboutobjectdescription_getinterfaces(aod, "/org/alljoyn/test", NULL, 0); ASSERT_EQ(3u, numInterfaces); interfaces = (const char**) malloc(sizeof(const char*) * numInterfaces); alljoyn_aboutobjectdescription_getinterfaces(aod, "/org/alljoyn/test", interfaces, numInterfaces); EXPECT_TRUE(strcmp(interfaces[0], "org.alljoyn.test") == 0 || strcmp(interfaces[0], "org.alljoyn.game") == 0 || strcmp(interfaces[0], "org.alljoyn.mediaplayer") == 0) << interfaces[0]; EXPECT_TRUE(strcmp(interfaces[1], "org.alljoyn.test") == 0 || strcmp(interfaces[1], "org.alljoyn.game") == 0 || strcmp(interfaces[1], "org.alljoyn.mediaplayer") == 0) << interfaces[1]; EXPECT_TRUE(strcmp(interfaces[2], "org.alljoyn.test") == 0 || strcmp(interfaces[2], "org.alljoyn.game") == 0 || strcmp(interfaces[2], "org.alljoyn.mediaplayer") == 0) << interfaces[2]; free(interfaces); alljoyn_abouticon_destroy(aicon); alljoyn_abouticonobj_destroy(aboutIconObj); alljoyn_busobject_destroy(busObject); alljoyn_msgarg_destroy(argObj); alljoyn_aboutobjectdescription_destroy(aod); status = alljoyn_busattachment_stop(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_destroy(bus); } TEST(AboutObjectDescriptionTest, Clear) { QStatus status = ER_FAIL; alljoyn_busattachment bus = alljoyn_busattachment_create("AlljoynObjectDescriptionTest", QCC_TRUE); alljoyn_abouticon aicon = alljoyn_abouticon_create(); status = alljoyn_abouticon_seturl(aicon, "image/png", "http://www.example.com"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_abouticonobj aboutIconObj = alljoyn_abouticonobj_create(bus, aicon); const qcc::String interfaceQcc = "" "" " " " " "" "" " " " " "" "" " " " " "" ""; const char* interface = interfaceQcc.c_str(); status = alljoyn_busattachment_createinterfacesfromxml(bus, interface); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busobject busObject = my_alljoyn_busobject_create(bus, "/org/alljoyn/test"); status = alljoyn_busattachment_registerbusobject(bus, busObject); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg argObj = alljoyn_msgarg_create(); ((BusAttachment*)bus)->GetInternal().GetAnnouncedObjectDescription(*((MsgArg*)argObj)); alljoyn_aboutobjectdescription aod = alljoyn_aboutobjectdescription_create_full(argObj); EXPECT_TRUE(alljoyn_aboutobjectdescription_hasinterfaceatpath(aod, "/About/DeviceIcon", "org.alljoyn.Icon")); EXPECT_TRUE(alljoyn_aboutobjectdescription_hasinterfaceatpath(aod, "/org/alljoyn/test", "org.alljoyn.test")); EXPECT_TRUE(alljoyn_aboutobjectdescription_hasinterfaceatpath(aod, "/org/alljoyn/test", "org.alljoyn.game")); EXPECT_TRUE(alljoyn_aboutobjectdescription_hasinterfaceatpath(aod, "/org/alljoyn/test", "org.alljoyn.mediaplayer")); alljoyn_aboutobjectdescription_clear(aod); EXPECT_FALSE(alljoyn_aboutobjectdescription_haspath(aod, "/About/DeviceIcon")); EXPECT_FALSE(alljoyn_aboutobjectdescription_haspath(aod, "/org/alljoyn/test")); EXPECT_FALSE(alljoyn_aboutobjectdescription_hasinterfaceatpath(aod, "/About/DeviceIcon", "org.alljoyn.Icon")); EXPECT_FALSE(alljoyn_aboutobjectdescription_hasinterfaceatpath(aod, "/org/alljoyn/test", "org.alljoyn.test")); EXPECT_FALSE(alljoyn_aboutobjectdescription_hasinterfaceatpath(aod, "/org/alljoyn/test", "org.alljoyn.game")); EXPECT_FALSE(alljoyn_aboutobjectdescription_hasinterfaceatpath(aod, "/org/alljoyn/test", "org.alljoyn.mediaplayer")); alljoyn_abouticon_destroy(aicon); alljoyn_abouticonobj_destroy(aboutIconObj); alljoyn_busobject_destroy(busObject); alljoyn_msgarg_destroy(argObj); alljoyn_aboutobjectdescription_destroy(aod); status = alljoyn_busattachment_stop(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_destroy(bus); } TEST(AboutObjectDescriptionTest, PopulateAutomaticallyFromBusObject) { QStatus status = ER_FAIL; static const char* interface = "" " " " " " " " " " " " " " " " " ""; alljoyn_busattachment bus = alljoyn_busattachment_create("AlljoynObjectDescriptionTest", QCC_TRUE); status = alljoyn_busattachment_createinterfacesfromxml(bus, interface); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busobject busObject1 = my_alljoyn_busobject_create_1(bus, "/test/path1"); status = alljoyn_busattachment_registerbusobject(bus, busObject1); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg aodArg = alljoyn_msgarg_create(); status = ((BusAttachment*)bus)->GetInternal().GetAnnouncedObjectDescription(*((MsgArg*)aodArg)); alljoyn_aboutobjectdescription aod = alljoyn_aboutobjectdescription_create_full(aodArg); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_TRUE(alljoyn_aboutobjectdescription_hasinterface(aod, "test.about.objectdescription.interface1")); EXPECT_TRUE(alljoyn_aboutobjectdescription_haspath(aod, "/test/path1")); EXPECT_TRUE(alljoyn_aboutobjectdescription_hasinterfaceatpath(aod, "/test/path1", "test.about.objectdescription.interface1")); alljoyn_msgarg_destroy(aodArg); alljoyn_aboutobjectdescription_destroy(aod); alljoyn_busobject_destroy(busObject1); status = alljoyn_busattachment_stop(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_destroy(bus); } TEST(AboutObjectDescriptionTest, PopulateAutomaticallyFromMultipleBusObjects) { QStatus status = ER_FAIL; static const char* interface1 = "" " " " " " " " " ""; static const char* interface2 = "" " " " " " " " " ""; alljoyn_busattachment bus = alljoyn_busattachment_create("AlljoynObjectDescriptionTest", QCC_TRUE); status = alljoyn_busattachment_createinterfacesfromxml(bus, interface1); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_createinterfacesfromxml(bus, interface2); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busobject busObject1 = my_alljoyn_busobject_create_1(bus, "/test/path1"); alljoyn_busobject busObject2 = my_alljoyn_busobject_create_2(bus, "/test/path2"); status = alljoyn_busattachment_registerbusobject(bus, busObject1); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_registerbusobject(bus, busObject2); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg aodArg = alljoyn_msgarg_create(); status = ((BusAttachment*)bus)->GetInternal().GetAnnouncedObjectDescription(*((MsgArg*)aodArg)); alljoyn_aboutobjectdescription aod = alljoyn_aboutobjectdescription_create_full(aodArg); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_TRUE(alljoyn_aboutobjectdescription_hasinterface(aod, "test.about.objectdescription.interface1")); EXPECT_TRUE(alljoyn_aboutobjectdescription_haspath(aod, "/test/path1")); EXPECT_TRUE(alljoyn_aboutobjectdescription_hasinterfaceatpath(aod, "/test/path1", "test.about.objectdescription.interface1")); EXPECT_TRUE(alljoyn_aboutobjectdescription_hasinterface(aod, "test.about.objectdescription.interface2")); EXPECT_TRUE(alljoyn_aboutobjectdescription_haspath(aod, "/test/path2")); EXPECT_TRUE(alljoyn_aboutobjectdescription_hasinterfaceatpath(aod, "/test/path2", "test.about.objectdescription.interface2")); alljoyn_busobject_destroy(busObject1); alljoyn_busobject_destroy(busObject2); alljoyn_msgarg_destroy(aodArg); alljoyn_aboutobjectdescription_destroy(aod); status = alljoyn_busattachment_stop(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_destroy(bus); } TEST(AboutObjectDescriptionTest, PopulateAutomaticallyRemoveBusObject) { QStatus status = ER_FAIL; static const char* interface1 = "" " " " " " " " " ""; static const char* interface2 = "" " " " " " " " " ""; alljoyn_busattachment bus = alljoyn_busattachment_create("AlljoynObjectDescriptionTest", QCC_TRUE); status = alljoyn_busattachment_createinterfacesfromxml(bus, interface1); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_createinterfacesfromxml(bus, interface2); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busobject busObject1 = my_alljoyn_busobject_create_1(bus, "/test/path1"); alljoyn_busobject busObject2 = my_alljoyn_busobject_create_2(bus, "/test/path2"); status = alljoyn_busattachment_registerbusobject(bus, busObject1); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_registerbusobject(bus, busObject2); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg aodArg = alljoyn_msgarg_create(); status = ((BusAttachment*)bus)->GetInternal().GetAnnouncedObjectDescription(*((MsgArg*)aodArg)); alljoyn_aboutobjectdescription aod = alljoyn_aboutobjectdescription_create_full(aodArg); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_TRUE(alljoyn_aboutobjectdescription_hasinterface(aod, "test.about.objectdescription.interface1")); EXPECT_TRUE(alljoyn_aboutobjectdescription_haspath(aod, "/test/path1")); EXPECT_TRUE(alljoyn_aboutobjectdescription_hasinterfaceatpath(aod, "/test/path1", "test.about.objectdescription.interface1")); EXPECT_TRUE(alljoyn_aboutobjectdescription_hasinterface(aod, "test.about.objectdescription.interface2")); EXPECT_TRUE(alljoyn_aboutobjectdescription_haspath(aod, "/test/path2")); EXPECT_TRUE(alljoyn_aboutobjectdescription_hasinterfaceatpath(aod, "/test/path2", "test.about.objectdescription.interface2")); alljoyn_busattachment_unregisterbusobject(bus, busObject1); status = ((BusAttachment*)bus)->GetInternal().GetAnnouncedObjectDescription(*((MsgArg*)aodArg)); alljoyn_aboutobjectdescription_clear(aod); alljoyn_aboutobjectdescription_createfrommsgarg(aod, aodArg); EXPECT_FALSE(alljoyn_aboutobjectdescription_hasinterface(aod, "test.about.objectdescription.interface1")); EXPECT_FALSE(alljoyn_aboutobjectdescription_haspath(aod, "/test/path1")); EXPECT_FALSE(alljoyn_aboutobjectdescription_hasinterfaceatpath(aod, "/test/path1", "test.about.objectdescription.interface1")); EXPECT_TRUE(alljoyn_aboutobjectdescription_hasinterface(aod, "test.about.objectdescription.interface2")); EXPECT_TRUE(alljoyn_aboutobjectdescription_haspath(aod, "/test/path2")); EXPECT_TRUE(alljoyn_aboutobjectdescription_hasinterfaceatpath(aod, "/test/path2", "test.about.objectdescription.interface2")); alljoyn_busobject_destroy(busObject1); alljoyn_busobject_destroy(busObject2); alljoyn_msgarg_destroy(aodArg); alljoyn_aboutobjectdescription_destroy(aod); status = alljoyn_busattachment_stop(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_destroy(bus); } TEST(AboutObjectDescriptionTest, GetInterfacePaths) { QStatus status = ER_FAIL; static const char* interface1 = "" " " " " " " " " ""; alljoyn_busattachment bus = alljoyn_busattachment_create("AlljoynObjectDescriptionTest", QCC_TRUE); status = alljoyn_busattachment_createinterfacesfromxml(bus, interface1); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busobject busObject1 = my_alljoyn_busobject_create_1(bus, "/test/path1"); alljoyn_busobject busObject2 = my_alljoyn_busobject_create_1(bus, "/test/path2"); alljoyn_busobject busObject3 = my_alljoyn_busobject_create_1(bus, "/test/path3"); alljoyn_busobject busObject4 = my_alljoyn_busobject_create_1(bus, "/test/path4"); alljoyn_busobject busObject5 = my_alljoyn_busobject_create_1(bus, "/test/path5"); alljoyn_busobject busObject6 = my_alljoyn_busobject_create_1(bus, "/test/path6"); status = alljoyn_busattachment_registerbusobject(bus, busObject1); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg aodArg = alljoyn_msgarg_create(); status = ((BusAttachment*)bus)->GetInternal().GetAnnouncedObjectDescription(*((MsgArg*)aodArg)); alljoyn_aboutobjectdescription aod = alljoyn_aboutobjectdescription_create_full(aodArg); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); size_t pathNum = alljoyn_aboutobjectdescription_getinterfacepaths(aod, "test.about.objectdescription.interface1", NULL, 0); EXPECT_EQ((size_t)1, pathNum); const char** paths = (const char**) malloc(sizeof(const char*) * pathNum); alljoyn_aboutobjectdescription_getinterfacepaths(aod, "test.about.objectdescription.interface1", paths, pathNum); EXPECT_STREQ("/test/path1", paths[0]); free(paths); paths = NULL; status = alljoyn_busattachment_registerbusobject(bus, busObject2); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_registerbusobject(bus, busObject3); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_registerbusobject(bus, busObject4); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_registerbusobject(bus, busObject5); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_registerbusobject(bus, busObject6); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = ((BusAttachment*)bus)->GetInternal().GetAnnouncedObjectDescription(*((MsgArg*)aodArg)); alljoyn_aboutobjectdescription_createfrommsgarg(aod, aodArg); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); pathNum = alljoyn_aboutobjectdescription_getinterfacepaths(aod, "test.about.objectdescription.interface1", NULL, 0); EXPECT_EQ((size_t)6, pathNum); paths = (const char**) malloc(sizeof(const char*) * pathNum); alljoyn_aboutobjectdescription_getinterfacepaths(aod, "test.about.objectdescription.interface1", paths, pathNum); EXPECT_STREQ("/test/path1", paths[0]); EXPECT_STREQ("/test/path2", paths[1]); EXPECT_STREQ("/test/path3", paths[2]); EXPECT_STREQ("/test/path4", paths[3]); EXPECT_STREQ("/test/path5", paths[4]); EXPECT_STREQ("/test/path6", paths[5]); free(paths); paths = NULL; alljoyn_busobject_destroy(busObject1); alljoyn_busobject_destroy(busObject2); alljoyn_busobject_destroy(busObject3); alljoyn_busobject_destroy(busObject4); alljoyn_busobject_destroy(busObject5); alljoyn_busobject_destroy(busObject6); alljoyn_msgarg_destroy(aodArg); alljoyn_aboutobjectdescription_destroy(aod); status = alljoyn_busattachment_stop(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_destroy(bus); } TEST(AboutObjectDescriptionTest, Empty_Negative) { QStatus status = ER_FAIL; alljoyn_busattachment bus = alljoyn_busattachment_create("AlljoynObjectDescriptionTest", QCC_TRUE); alljoyn_msgarg arg = alljoyn_msgarg_create(); status = ((BusAttachment*)bus)->GetInternal().GetAnnouncedObjectDescription(*((MsgArg*)arg)); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_aboutobjectdescription aod = alljoyn_aboutobjectdescription_create_full(arg); EXPECT_FALSE(alljoyn_aboutobjectdescription_hasinterface(aod, "org.alljoyn.Icon")); EXPECT_FALSE(alljoyn_aboutobjectdescription_hasinterface(aod, "org.alljoyn.About")); const qcc::String interface = "" "" " " " " "" "" " " " " "" "" " " " " "" ""; status = alljoyn_busattachment_createinterfacesfromxml(bus, interface.c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = ((BusAttachment*)bus)->GetInternal().GetAnnouncedObjectDescription(*((MsgArg*)arg)); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_aboutobjectdescription aod1 = alljoyn_aboutobjectdescription_create_full(arg); EXPECT_FALSE(alljoyn_aboutobjectdescription_hasinterface(aod1, "org.alljoyn.Icon")); EXPECT_FALSE(alljoyn_aboutobjectdescription_hasinterface(aod1, "org.alljoyn.About")); EXPECT_FALSE(alljoyn_aboutobjectdescription_hasinterfaceatpath(aod1, "/org/alljoyn/test", "org.alljoyn.test")); EXPECT_FALSE(alljoyn_aboutobjectdescription_hasinterfaceatpath(aod1, "/org/alljoyn/test", "org.alljoyn.game")); EXPECT_FALSE(alljoyn_aboutobjectdescription_hasinterfaceatpath(aod1, "/org/alljoyn/test", "org.alljoyn.mediaplayer")); EXPECT_FALSE(alljoyn_aboutobjectdescription_hasinterface(aod1, "org.alljoyn.test")); EXPECT_FALSE(alljoyn_aboutobjectdescription_hasinterface(aod1, "org.alljoyn.game")); EXPECT_FALSE(alljoyn_aboutobjectdescription_hasinterface(aod1, "org.alljoyn.mediaplayer")); alljoyn_msgarg_destroy(arg); alljoyn_aboutobjectdescription_destroy(aod); alljoyn_aboutobjectdescription_destroy(aod1); status = alljoyn_busattachment_stop(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_destroy(bus); } TEST(AboutObjectDescriptionTest, AboutInterface) { QStatus status = ER_FAIL; alljoyn_busattachment bus = alljoyn_busattachment_create("AlljoynObjectDescriptionTest", QCC_TRUE); alljoyn_aboutobj aboutObj = alljoyn_aboutobj_create(bus, ANNOUNCED); alljoyn_msgarg arg = alljoyn_msgarg_create(); status = ((BusAttachment*)bus)->GetInternal().GetAnnouncedObjectDescription(*((MsgArg*)arg)); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_aboutobjectdescription aod = alljoyn_aboutobjectdescription_create_full(arg); EXPECT_TRUE(alljoyn_aboutobjectdescription_hasinterfaceatpath(aod, "/About", "org.alljoyn.About")); EXPECT_TRUE(alljoyn_aboutobjectdescription_hasinterface(aod, "org.alljoyn.About")); alljoyn_aboutobj_destroy(aboutObj); alljoyn_msgarg_destroy(arg); alljoyn_aboutobjectdescription_destroy(aod); status = alljoyn_busattachment_stop(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_destroy(bus); } TEST(AboutObjectDescriptionTest, NoAboutInterface) { QStatus status = ER_FAIL; alljoyn_busattachment bus = alljoyn_busattachment_create("AlljoynObjectDescriptionTest", QCC_TRUE); alljoyn_aboutobj aboutObj = alljoyn_aboutobj_create(bus, UNANNOUNCED); alljoyn_msgarg arg = alljoyn_msgarg_create(); status = ((BusAttachment*)bus)->GetInternal().GetAnnouncedObjectDescription(*((MsgArg*)arg)); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_aboutobjectdescription aod = alljoyn_aboutobjectdescription_create_full(arg); EXPECT_FALSE(alljoyn_aboutobjectdescription_hasinterfaceatpath(aod, "/About", "org.alljoyn.About")); EXPECT_FALSE(alljoyn_aboutobjectdescription_hasinterface(aod, "org.alljoyn.About")); alljoyn_aboutobj_destroy(aboutObj); alljoyn_msgarg_destroy(arg); alljoyn_aboutobjectdescription_destroy(aod); status = alljoyn_busattachment_stop(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_destroy(bus); } alljoyn-15.04b/alljoyn_c/unit_test/AboutProxyTest.cc000066400000000000000000001132501255700255500226200ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #include #include #include "ajTestCommon.h" #include "alljoyn/DBusStd.h" #include #include #include #define WAIT_TIME 5 using namespace ajn; using namespace qcc; static const char* ENGLISH_TAG = "en"; static const char* SPANISH_TAG = "es"; static const char* FRENCH_TAG = "fr"; typedef struct about_proxy_test_bus_object_t { alljoyn_busobject aboutobject; int isannounce; }about_proxy_test_bus_object; typedef struct lang_data_t { char devicename[256]; char appname[256]; char manufacturer[256]; char description[256]; char modelnumber[64]; char dateofmanufacture[64]; char softwareversion[32]; }lang_data; typedef struct about_obj_test_about_listener_2_t { int announceListenerFlag; int aboutObjectPartOfAnnouncement; char* busName; alljoyn_sessionport port; alljoyn_aboutlistener listener; uint16_t version; }about_obj_test_about_listener_2; static about_proxy_test_bus_object* create_about_proxy_test_bus_object(alljoyn_busattachment bus, const char* path, const char* interfaceName, int announce) { about_proxy_test_bus_object* result = (about_proxy_test_bus_object*) malloc(sizeof(about_proxy_test_bus_object)); result->aboutobject = alljoyn_busobject_create(path, 0, NULL, NULL); alljoyn_interfacedescription iface = alljoyn_busattachment_getinterface(bus, interfaceName); EXPECT_TRUE(iface != NULL) << "NULL InterfaceDescription* for " << interfaceName; result->isannounce = announce; if (iface == NULL) { printf("The interfaceDescription pointer for %s was NULL \ when it should not have been.\n", interfaceName); return NULL; } if (result->isannounce) { alljoyn_busobject_addinterface(result->aboutobject, iface); alljoyn_busobject_setannounceflag(result->aboutobject, iface, ANNOUNCED); } else { alljoyn_busobject_addinterface(result->aboutobject, iface); alljoyn_busobject_setannounceflag(result->aboutobject, iface, UNANNOUNCED); } return result; } static void destroy_about_proxy_test_bus_object(about_proxy_test_bus_object* aboutobject) { if (aboutobject) { if (aboutobject->aboutobject) { alljoyn_busobject_destroy(aboutobject->aboutobject); aboutobject->aboutobject = NULL; } free(aboutobject); aboutobject = NULL; } } static lang_data* create_english_lang_data() { lang_data* data = (lang_data*) malloc(sizeof(lang_data)); static const char devicename[] = "Dish Washer"; static const char appname[] = "Controller"; static const char manufacturer[] = "Alliance"; static const char description[] = "Smart dish washer"; static const char modelnumber[] = "HDW-1111"; static const char dom[] = "2014-20-24"; static const char softver[] = "0.2.2"; snprintf(data->devicename, strlen(devicename) + 1, "%s", devicename); snprintf(data->appname, strlen(appname) + 1, "%s", appname); snprintf(data->manufacturer, strlen(manufacturer) + 1, "%s", manufacturer); snprintf(data->description, strlen(description) + 1, "%s", description); snprintf(data->modelnumber, strlen(modelnumber) + 1, "%s", modelnumber); snprintf(data->dateofmanufacture, strlen(dom) + 1, "%s", dom); snprintf(data->softwareversion, strlen(softver) + 1, "%s", softver); return data; } static lang_data* create_spanish_lang_data() { lang_data* data = (lang_data*) malloc(sizeof(lang_data)); static const char devicename[] = "dispositivo"; static const char appname[] = "aplicacion"; static const char manufacturer[] = "manufactura"; static const char description[] = "Una descripcion poetica de esta aplicacion"; static const char modelnumber[] = "HDW-1111"; static const char dom[] = "2014-20-24"; static const char softver[] = "0.2.2"; snprintf(data->devicename, strlen(devicename) + 1, "%s", devicename); snprintf(data->appname, strlen(appname) + 1, "%s", appname); snprintf(data->manufacturer, strlen(manufacturer) + 1, "%s", manufacturer); snprintf(data->description, strlen(description) + 1, "%s", description); snprintf(data->modelnumber, strlen(modelnumber) + 1, "%s", modelnumber); snprintf(data->dateofmanufacture, strlen(dom) + 1, "%s", dom); snprintf(data->softwareversion, strlen(softver) + 1, "%s", softver); return data; } static int destroy_lang_data(lang_data* data) { if (data) { free(data); data = NULL; } return 0; } static QCC_BOOL my_sessionportlistener_acceptsessionjoiner(const void* context, alljoyn_sessionport sessionPort, const char* joiner, const alljoyn_sessionopts opts) { QCC_UNUSED(context); QCC_UNUSED(sessionPort); QCC_UNUSED(joiner); QCC_UNUSED(opts); return QCC_TRUE; } static void about_obj_test_about_listener_announced_cb(const void* context, const char* busName, uint16_t version, alljoyn_sessionport port, const alljoyn_msgarg objectDescriptionArg, const alljoyn_msgarg aboutDataArg) { QCC_UNUSED(objectDescriptionArg); QCC_UNUSED(aboutDataArg); about_obj_test_about_listener_2* listener = (about_obj_test_about_listener_2*)(context); EXPECT_FALSE(listener->announceListenerFlag == 1) << "We don't expect the flag to already be \ true when an AnnouceSignal is received."; size_t busNameLen = strlen(busName); if (listener->busName) { free(listener->busName); listener->busName = NULL; } listener->busName = (char*) malloc(sizeof(char) * (busNameLen + 1)); strncpy(listener->busName, busName, busNameLen); listener->busName[busNameLen] = '\0'; listener->port = port; listener->announceListenerFlag = QCC_TRUE; listener->version = version; } static about_obj_test_about_listener_2* create_about_obj_test_about_listener_2() { about_obj_test_about_listener_2* result = (about_obj_test_about_listener_2*) malloc(sizeof(about_obj_test_about_listener_2)); alljoyn_aboutlistener_callback callbacks = { &about_obj_test_about_listener_announced_cb }; result->listener = alljoyn_aboutlistener_create(&callbacks, result); result->port = 0; result->busName = NULL; result->announceListenerFlag = 0; result->aboutObjectPartOfAnnouncement = 0; return result; } static void destroy_about_obj_test_about_listener_2(about_obj_test_about_listener_2* listener) { if (listener->busName) { free(listener->busName); listener->busName = NULL; } if (listener->listener) { alljoyn_aboutlistener_destroy(listener->listener); listener = NULL; } } class AboutProxyTest : public testing::Test { public: AboutProxyTest() { port = 25; aboutEnglishData = alljoyn_aboutdata_create(ENGLISH_TAG); aboutSpanishData = alljoyn_aboutdata_create(SPANISH_TAG); serviceBus = NULL; listener = NULL; } virtual void SetUp() { QStatus status = ER_FAIL; engLangData = create_english_lang_data(); spLangData = create_spanish_lang_data(); serviceBus = alljoyn_busattachment_create("AboutProxyTestServiceBus", QCC_TRUE); status = alljoyn_busattachment_start(serviceBus); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(serviceBus, NULL); /* Initialize English data */ setUpEnglishData(); status = alljoyn_aboutdata_setsupportedlanguage(aboutEnglishData, SPANISH_TAG); /* Initialize Spanish data */ setUpSpanishData(); status = alljoyn_aboutdata_setsupportedlanguage(aboutSpanishData, ENGLISH_TAG); alljoyn_sessionportlistener_callbacks callbacks = { &my_sessionportlistener_acceptsessionjoiner }; alljoyn_sessionopts opts = alljoyn_sessionopts_create(ALLJOYN_TRAFFIC_TYPE_MESSAGES, QCC_FALSE, ALLJOYN_PROXIMITY_ANY, ALLJOYN_TRANSPORT_ANY); listener = alljoyn_sessionportlistener_create(&callbacks, NULL); status = alljoyn_busattachment_bindsessionport(serviceBus, &port, opts, listener); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); } virtual void TearDown() { destroy_lang_data(engLangData); destroy_lang_data(spLangData); if (serviceBus) { alljoyn_busattachment_stop(serviceBus); alljoyn_busattachment_join(serviceBus); alljoyn_busattachment_destroy(serviceBus); serviceBus = NULL; } if (aboutEnglishData) { alljoyn_aboutdata_destroy(aboutEnglishData); aboutEnglishData = NULL; } if (aboutSpanishData) { alljoyn_aboutdata_destroy(aboutSpanishData); aboutSpanishData = NULL; } if (listener) { alljoyn_sessionportlistener_destroy(listener); listener = NULL; } } alljoyn_busattachment serviceBus; alljoyn_aboutdata aboutEnglishData; alljoyn_aboutdata aboutSpanishData; alljoyn_sessionportlistener listener; alljoyn_sessionport port; lang_data* engLangData; lang_data* spLangData; private: void setUpEnglishData() { QStatus status = ER_OK; qcc::GUID128 appId; status = alljoyn_aboutdata_setappid(aboutEnglishData, appId.GetBytes(), qcc::GUID128::SIZE); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); qcc::GUID128 deviceId; status = alljoyn_aboutdata_setdeviceid(aboutEnglishData, deviceId.ToString().c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setdevicename(aboutEnglishData, engLangData->devicename, ENGLISH_TAG); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setdateofmanufacture(aboutEnglishData, engLangData->dateofmanufacture); ASSERT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setappname(aboutEnglishData, engLangData->appname, ENGLISH_TAG); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setmanufacturer(aboutEnglishData, engLangData->manufacturer, ENGLISH_TAG); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setmodelnumber(aboutEnglishData, engLangData->modelnumber); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setdescription(aboutEnglishData, engLangData->description, ENGLISH_TAG); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setsoftwareversion(aboutEnglishData, engLangData->softwareversion); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_TRUE(alljoyn_aboutdata_isvalid(aboutEnglishData, ENGLISH_TAG)); } void setUpSpanishData() { QStatus status = ER_OK; uint8_t appId[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15 }; status = alljoyn_aboutdata_setappid(aboutSpanishData, appId, 16); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setdeviceid(aboutSpanishData, "fakeId"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_FALSE(alljoyn_aboutdata_isvalid(aboutSpanishData, SPANISH_TAG)); status = alljoyn_aboutdata_setdevicename(aboutSpanishData, spLangData->devicename, SPANISH_TAG); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setappname(aboutSpanishData, spLangData->appname, SPANISH_TAG); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setmanufacturer(aboutSpanishData, spLangData->manufacturer, SPANISH_TAG); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setdescription(aboutSpanishData, spLangData->description, SPANISH_TAG); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_FALSE(alljoyn_aboutdata_isvalid(aboutSpanishData, SPANISH_TAG)); status = alljoyn_aboutdata_setmodelnumber(aboutSpanishData, spLangData->modelnumber); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_aboutdata_setsoftwareversion(aboutSpanishData, spLangData->softwareversion); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_TRUE(alljoyn_aboutdata_isvalid(aboutSpanishData, SPANISH_TAG)); } }; TEST_F(AboutProxyTest, GetObjectDescription) { QStatus status = ER_FAIL; qcc::GUID128 interface_rand_string; qcc::String ifaceNameQcc = "test.about.a" + interface_rand_string.ToString(); qcc::String interfaceQcc = "" "" "" ""; const char* ifaceName = ifaceNameQcc.c_str(); const char* interface = interfaceQcc.c_str(); status = alljoyn_busattachment_createinterfacesfromxml(serviceBus, interface); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); about_proxy_test_bus_object* busObject = create_about_proxy_test_bus_object(serviceBus, "/test/alljoyn/AboutProxy", ifaceName, QCC_TRUE); status = alljoyn_busattachment_registerbusobject(serviceBus, busObject->aboutobject); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment clientBus = alljoyn_busattachment_create("AboutProxyTestClient", QCC_TRUE); status = alljoyn_busattachment_start(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(clientBus, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); about_obj_test_about_listener_2* aboutListener = create_about_obj_test_about_listener_2(); alljoyn_busattachment_registeraboutlistener(clientBus, aboutListener->listener); status = alljoyn_busattachment_whoimplements_interface(clientBus, ifaceName); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_aboutobj aboutObj = alljoyn_aboutobj_create(serviceBus, UNANNOUNCED); status = alljoyn_aboutobj_announce(aboutObj, port, aboutEnglishData); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (uint32_t msec = 0; msec < 5000; msec += WAIT_TIME) { if (aboutListener->announceListenerFlag == QCC_TRUE) { break; } qcc::Sleep(WAIT_TIME); } ASSERT_TRUE(aboutListener->announceListenerFlag) << "The announceListenerFlag must be true to continue this test."; EXPECT_STREQ(alljoyn_busattachment_getuniquename(serviceBus), aboutListener->busName); EXPECT_EQ(port, aboutListener->port); alljoyn_sessionid sessionId; alljoyn_sessionopts sessionOpts = alljoyn_sessionopts_create(ALLJOYN_TRAFFIC_TYPE_MESSAGES, QCC_FALSE, ALLJOYN_PROXIMITY_ANY, ALLJOYN_TRANSPORT_ANY); alljoyn_busattachment_enableconcurrentcallbacks(clientBus); status = alljoyn_busattachment_joinsession(clientBus, aboutListener->busName, aboutListener->port, NULL, &sessionId, sessionOpts); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_aboutproxy proxy = alljoyn_aboutproxy_create(clientBus, aboutListener->busName, sessionId); uint16_t aboutVersion; status = alljoyn_aboutproxy_getversion(proxy, &aboutVersion); EXPECT_EQ(ER_OK, status) << " GetVersion Status: " << QCC_StatusText(status); EXPECT_EQ(aboutListener->version, aboutVersion) << "Version mismatch!"; alljoyn_msgarg objDescriptionArg = alljoyn_msgarg_create(); status = alljoyn_aboutproxy_getobjectdescription(proxy, objDescriptionArg); EXPECT_EQ(ER_OK, status) << " GetObjectDescription Status: " << QCC_StatusText(status); alljoyn_aboutobjectdescription aod = alljoyn_aboutobjectdescription_create(); alljoyn_aboutobjectdescription_createfrommsgarg(aod, objDescriptionArg); size_t numPaths = 0; numPaths = alljoyn_aboutobjectdescription_getpaths(aod, NULL, 0); ASSERT_EQ(1u, numPaths); const char** paths = new const char*[numPaths]; alljoyn_aboutobjectdescription_getpaths(aod, paths, numPaths); /* Object path must match sender */ EXPECT_TRUE(strcmp(paths[0], "/test/alljoyn/AboutProxy") == 0) << paths[0]; size_t numInterfaces = alljoyn_aboutobjectdescription_getinterfaces(aod, paths[0], NULL, 0); ASSERT_EQ(1u, numInterfaces); const char** supportedInterfaces = new const char*[numInterfaces]; alljoyn_aboutobjectdescription_getinterfaces(aod, paths[0], supportedInterfaces, numInterfaces); EXPECT_STREQ(ifaceName, supportedInterfaces[0]) << "Interface mismatch!"; delete [] supportedInterfaces; delete [] paths; status = alljoyn_busattachment_cancelwhoimplements_interface(clientBus, ifaceName); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_unregisteraboutlistener(clientBus, aboutListener->listener); alljoyn_aboutproxy_destroy(proxy); alljoyn_msgarg_destroy(objDescriptionArg); alljoyn_aboutobjectdescription_destroy(aod); alljoyn_sessionopts_destroy(sessionOpts); destroy_about_proxy_test_bus_object(busObject); destroy_about_obj_test_about_listener_2(aboutListener); alljoyn_aboutobj_destroy(aboutObj); status = alljoyn_busattachment_stop(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_destroy(clientBus); } TEST_F(AboutProxyTest, GetAboutdata_English) { QStatus status = ER_FAIL; qcc::GUID128 interface_rand_string; qcc::String ifaceNameQcc = "test.about.b" + interface_rand_string.ToString(); qcc::String interfaceQcc = "" "" "" ""; const char* ifaceName = ifaceNameQcc.c_str(); const char* interface = interfaceQcc.c_str(); status = alljoyn_busattachment_createinterfacesfromxml(serviceBus, interface); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); about_proxy_test_bus_object* busObject = create_about_proxy_test_bus_object(serviceBus, "/test/alljoyn/English", ifaceName, QCC_TRUE); status = alljoyn_busattachment_registerbusobject(serviceBus, busObject->aboutobject); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment clientBus = alljoyn_busattachment_create("AboutProxyTestClient", QCC_TRUE); status = alljoyn_busattachment_start(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(clientBus, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); about_obj_test_about_listener_2* aboutListener = create_about_obj_test_about_listener_2(); alljoyn_busattachment_registeraboutlistener(clientBus, aboutListener->listener); status = alljoyn_busattachment_whoimplements_interface(clientBus, ifaceName); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_aboutobj aboutObj = alljoyn_aboutobj_create(serviceBus, UNANNOUNCED); status = alljoyn_aboutobj_announce(aboutObj, port, aboutEnglishData); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (uint32_t msec = 0; msec < 5000; msec += WAIT_TIME) { if (aboutListener->announceListenerFlag == QCC_TRUE) { break; } qcc::Sleep(WAIT_TIME); } ASSERT_TRUE(aboutListener->announceListenerFlag) << "The announceListenerFlag must be true to continue this test."; EXPECT_STREQ(alljoyn_busattachment_getuniquename(serviceBus), aboutListener->busName); EXPECT_EQ(port, aboutListener->port); alljoyn_sessionid sessionId; alljoyn_sessionopts sessionOpts = alljoyn_sessionopts_create(ALLJOYN_TRAFFIC_TYPE_MESSAGES, QCC_FALSE, ALLJOYN_PROXIMITY_ANY, ALLJOYN_TRANSPORT_ANY); alljoyn_busattachment_enableconcurrentcallbacks(clientBus); status = alljoyn_busattachment_joinsession(clientBus, aboutListener->busName, aboutListener->port, NULL, &sessionId, sessionOpts); alljoyn_aboutproxy proxy = alljoyn_aboutproxy_create(clientBus, aboutListener->busName, sessionId); uint16_t aboutVersion; status = alljoyn_aboutproxy_getversion(proxy, &aboutVersion); EXPECT_EQ(ER_OK, status) << " GetVersion Status: " << QCC_StatusText(status); EXPECT_EQ(aboutListener->version, aboutVersion) << "Version mismatch!"; /* AboutData for English */ alljoyn_msgarg dataArg = alljoyn_msgarg_create(); status = alljoyn_aboutproxy_getaboutdata(proxy, ENGLISH_TAG, dataArg); EXPECT_EQ(ER_OK, status) << " GetAboutData Status: " << QCC_StatusText(status); alljoyn_aboutdata aboutData = alljoyn_aboutdata_create_empty(); status = alljoyn_aboutdata_createfrommsgarg(aboutData, dataArg, ENGLISH_TAG); EXPECT_EQ(ER_OK, status) << " GetAboutData Status: " << QCC_StatusText(status); char* appName; status = alljoyn_aboutdata_getappname(aboutData, &appName, ENGLISH_TAG); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ(engLangData->appname, appName); char* deviceName; status = alljoyn_aboutdata_getdevicename(aboutData, &deviceName, ENGLISH_TAG); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ(engLangData->devicename, deviceName); char* dateOfManufacture; status = alljoyn_aboutdata_getdateofmanufacture(aboutData, &dateOfManufacture); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ(engLangData->dateofmanufacture, dateOfManufacture); char* manufacturer; status = alljoyn_aboutdata_getmanufacturer(aboutData, &manufacturer, ENGLISH_TAG); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ(engLangData->manufacturer, manufacturer); char* description; status = alljoyn_aboutdata_getdescription(aboutData, &description, ENGLISH_TAG); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ(engLangData->description, description); char* modelNumber; status = alljoyn_aboutdata_getmodelnumber(aboutData, &modelNumber); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ(engLangData->modelnumber, modelNumber); char* softwareVersion; status = alljoyn_aboutdata_getsoftwareversion(aboutData, &softwareVersion); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ(engLangData->softwareversion, softwareVersion); status = alljoyn_busattachment_cancelwhoimplements_interface(clientBus, ifaceName); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_unregisteraboutlistener(clientBus, aboutListener->listener); alljoyn_aboutproxy_destroy(proxy); alljoyn_msgarg_destroy(dataArg); alljoyn_aboutdata_destroy(aboutData); alljoyn_sessionopts_destroy(sessionOpts); destroy_about_proxy_test_bus_object(busObject); destroy_about_obj_test_about_listener_2(aboutListener); alljoyn_aboutobj_destroy(aboutObj); status = alljoyn_busattachment_stop(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_destroy(clientBus); } TEST_F(AboutProxyTest, GetAboutdata_Spanish) { QStatus status = ER_FAIL; qcc::GUID128 interface_rand_string; qcc::String ifaceNameQcc = "test.about.c" + interface_rand_string.ToString(); qcc::String interfaceQcc = "" "" "" ""; const char* ifaceName = ifaceNameQcc.c_str(); const char* interface = interfaceQcc.c_str(); status = alljoyn_busattachment_createinterfacesfromxml(serviceBus, interface); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); about_proxy_test_bus_object* busObject = create_about_proxy_test_bus_object(serviceBus, "/test/alljoyn/Spanish", ifaceName, QCC_TRUE); status = alljoyn_busattachment_registerbusobject(serviceBus, busObject->aboutobject); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment clientBus = alljoyn_busattachment_create("AboutProxyTestClient", QCC_TRUE); status = alljoyn_busattachment_start(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(clientBus, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); about_obj_test_about_listener_2* aboutListener = create_about_obj_test_about_listener_2(); alljoyn_busattachment_registeraboutlistener(clientBus, aboutListener->listener); status = alljoyn_busattachment_whoimplements_interface(clientBus, ifaceName); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_aboutobj aboutObj = alljoyn_aboutobj_create(serviceBus, UNANNOUNCED); status = alljoyn_aboutobj_announce(aboutObj, port, aboutSpanishData); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (uint32_t msec = 0; msec < 5000; msec += WAIT_TIME) { if (aboutListener->announceListenerFlag == QCC_TRUE) { break; } qcc::Sleep(WAIT_TIME); } ASSERT_TRUE(aboutListener->announceListenerFlag) << "The announceListenerFlag must be true to continue this test."; EXPECT_STREQ(alljoyn_busattachment_getuniquename(serviceBus), aboutListener->busName); EXPECT_EQ(port, aboutListener->port); alljoyn_sessionid sessionId; alljoyn_sessionopts sessionOpts = alljoyn_sessionopts_create(ALLJOYN_TRAFFIC_TYPE_MESSAGES, QCC_FALSE, ALLJOYN_PROXIMITY_ANY, ALLJOYN_TRANSPORT_ANY); alljoyn_busattachment_enableconcurrentcallbacks(clientBus); status = alljoyn_busattachment_joinsession(clientBus, aboutListener->busName, aboutListener->port, NULL, &sessionId, sessionOpts); alljoyn_aboutproxy proxy = alljoyn_aboutproxy_create(clientBus, aboutListener->busName, sessionId); uint16_t aboutVersion; status = alljoyn_aboutproxy_getversion(proxy, &aboutVersion); EXPECT_EQ(ER_OK, status) << " GetVersion Status: " << QCC_StatusText(status); EXPECT_EQ(aboutListener->version, aboutVersion) << "Version mismatch!"; /* AboutData for Spanish */ alljoyn_msgarg dataArg = alljoyn_msgarg_create(); status = alljoyn_aboutproxy_getaboutdata(proxy, SPANISH_TAG, dataArg); EXPECT_EQ(ER_OK, status) << " GetAboutData Status: " << QCC_StatusText(status); alljoyn_aboutdata aboutData = alljoyn_aboutdata_create_empty(); /* About data for Spanish */ status = alljoyn_aboutdata_createfrommsgarg(aboutData, dataArg, SPANISH_TAG); EXPECT_EQ(ER_OK, status) << " GetAboutData Status: " << QCC_StatusText(status); char* appName; status = alljoyn_aboutdata_getappname(aboutData, &appName, SPANISH_TAG); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ(spLangData->appname, appName); char* deviceName; status = alljoyn_aboutdata_getdevicename(aboutData, &deviceName, SPANISH_TAG); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ(spLangData->devicename, deviceName); char* manufacturer; status = alljoyn_aboutdata_getmanufacturer(aboutData, &manufacturer, SPANISH_TAG); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ(spLangData->manufacturer, manufacturer); char* description; status = alljoyn_aboutdata_getdescription(aboutData, &description, SPANISH_TAG); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ(spLangData->description, description); status = alljoyn_busattachment_cancelwhoimplements_interface(clientBus, ifaceName); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_unregisteraboutlistener(clientBus, aboutListener->listener); alljoyn_aboutproxy_destroy(proxy); alljoyn_msgarg_destroy(dataArg); alljoyn_aboutdata_destroy(aboutData); alljoyn_sessionopts_destroy(sessionOpts); destroy_about_proxy_test_bus_object(busObject); destroy_about_obj_test_about_listener_2(aboutListener); alljoyn_aboutobj_destroy(aboutObj); status = alljoyn_busattachment_stop(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_destroy(clientBus); } TEST_F(AboutProxyTest, GetAboutdata_Unsupported) { QStatus status = ER_FAIL; qcc::GUID128 interface_rand_string; qcc::String ifaceNameQcc = "test.about.d" + interface_rand_string.ToString(); qcc::String interfaceQcc = "" "" "" ""; const char* ifaceName = ifaceNameQcc.c_str(); const char* interface = interfaceQcc.c_str(); status = alljoyn_busattachment_createinterfacesfromxml(serviceBus, interface); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); about_proxy_test_bus_object* busObject = create_about_proxy_test_bus_object(serviceBus, "/test/alljoyn/Unsupported", ifaceName, QCC_TRUE); status = alljoyn_busattachment_registerbusobject(serviceBus, busObject->aboutobject); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment clientBus = alljoyn_busattachment_create("AboutProxyTestClient", QCC_TRUE); status = alljoyn_busattachment_start(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(clientBus, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); about_obj_test_about_listener_2* aboutListener = create_about_obj_test_about_listener_2(); alljoyn_busattachment_registeraboutlistener(clientBus, aboutListener->listener); status = alljoyn_busattachment_whoimplements_interface(clientBus, ifaceName); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_aboutobj aboutObj = alljoyn_aboutobj_create(serviceBus, UNANNOUNCED); status = alljoyn_aboutobj_announce(aboutObj, port, aboutEnglishData); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (uint32_t msec = 0; msec < 5000; msec += WAIT_TIME) { if (aboutListener->announceListenerFlag == QCC_TRUE) { break; } qcc::Sleep(WAIT_TIME); } ASSERT_TRUE(aboutListener->announceListenerFlag) << "The announceListenerFlag must be true to continue this test."; EXPECT_STREQ(alljoyn_busattachment_getuniquename(serviceBus), aboutListener->busName); EXPECT_EQ(port, aboutListener->port); alljoyn_sessionid sessionId; alljoyn_sessionopts sessionOpts = alljoyn_sessionopts_create(ALLJOYN_TRAFFIC_TYPE_MESSAGES, QCC_FALSE, ALLJOYN_PROXIMITY_ANY, ALLJOYN_TRANSPORT_ANY); alljoyn_busattachment_enableconcurrentcallbacks(clientBus); status = alljoyn_busattachment_joinsession(clientBus, aboutListener->busName, aboutListener->port, NULL, &sessionId, sessionOpts); alljoyn_aboutproxy proxy = alljoyn_aboutproxy_create(clientBus, aboutListener->busName, sessionId); uint16_t aboutVersion; status = alljoyn_aboutproxy_getversion(proxy, &aboutVersion); EXPECT_EQ(ER_OK, status) << " GetVersion Status: " << QCC_StatusText(status); EXPECT_EQ(aboutListener->version, aboutVersion) << "Version mismatch!"; /* AboutData for English */ alljoyn_msgarg dataArg = alljoyn_msgarg_create(); status = alljoyn_aboutproxy_getaboutdata(proxy, FRENCH_TAG, dataArg); EXPECT_EQ(ER_LANGUAGE_NOT_SUPPORTED, status) << " GetAboutData Status: " << QCC_StatusText(status); status = alljoyn_busattachment_cancelwhoimplements_interface(clientBus, ifaceName); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_unregisteraboutlistener(clientBus, aboutListener->listener); alljoyn_aboutproxy_destroy(proxy); alljoyn_msgarg_destroy(dataArg); alljoyn_sessionopts_destroy(sessionOpts); destroy_about_proxy_test_bus_object(busObject); destroy_about_obj_test_about_listener_2(aboutListener); alljoyn_aboutobj_destroy(aboutObj); status = alljoyn_busattachment_stop(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(clientBus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_destroy(clientBus); } alljoyn-15.04b/alljoyn_c/unit_test/AuthListenerAsyncTest.cc000066400000000000000000000734541255700255500241240ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include "ajTestCommon.h" #include #include #include #include #include #include static const char* INTERFACE_NAME = "org.alljoyn.test.c.authlistener.async"; static const char* OBJECT_NAME = "org.alljoyn.test.c.authlistener.async"; static const char* OBJECT_PATH = "/org/alljoyn/test"; static QCC_BOOL name_owner_changed_flag = QCC_FALSE; static QCC_BOOL requestcredentials_service_flag = QCC_FALSE; static QCC_BOOL authenticationcomplete_service_flag = QCC_FALSE; static QCC_BOOL verifycredentials_service_flag = QCC_FALSE; static QCC_BOOL securityviolation_service_flag = QCC_FALSE; static QCC_BOOL requestcredentials_client_flag = QCC_FALSE; static QCC_BOOL authenticationcomplete_client_flag = QCC_FALSE; static QCC_BOOL verifycredentials_client_flag = QCC_FALSE; static QCC_BOOL securityviolation_client_flag = QCC_TRUE; /* NameOwnerChanged callback */ static void AJ_CALL name_owner_changed(const void* context, const char* busName, const char* previousOwner, const char* newOwner) { QCC_UNUSED(context); QCC_UNUSED(previousOwner); QCC_UNUSED(newOwner); if (strcmp(busName, OBJECT_NAME) == 0) { name_owner_changed_flag = QCC_TRUE; } } /* Exposed methods */ static void AJ_CALL ping_method(alljoyn_busobject bus, const alljoyn_interfacedescription_member* member, alljoyn_message msg) { QCC_UNUSED(member); alljoyn_msgarg outArg = alljoyn_msgarg_create(); alljoyn_msgarg inArg = alljoyn_message_getarg(msg, 0); const char* str; alljoyn_msgarg_get(inArg, "s", &str); alljoyn_msgarg_set(outArg, "s", str); QStatus status = alljoyn_busobject_methodreply_args(bus, msg, outArg, 1); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg_destroy(outArg); } class AuthListenerAsyncTest : public testing::Test { public: virtual void SetUp() { /* initilize test fixture values to known start value */ status = ER_FAIL; servicebus = NULL; clientbus = NULL; testObj = NULL; buslistener = NULL; /* set up the service bus */ servicebus = alljoyn_busattachment_create("AuthListenerAsyncTestService", false); status = alljoyn_busattachment_start(servicebus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(servicebus, ajn::getConnectArg().c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription service_intf = NULL; status = alljoyn_busattachment_createinterface_secure(servicebus, INTERFACE_NAME, &service_intf, AJ_IFC_SECURITY_REQUIRED); ASSERT_TRUE(service_intf != NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_interfacedescription_addmember(service_intf, ALLJOYN_MESSAGE_METHOD_CALL, "ping", "s", "s", "in,out", 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription_activate(service_intf); clientbus = alljoyn_busattachment_create("AuthListenerAsyncTestClient", false); status = alljoyn_busattachment_start(clientbus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(clientbus, ajn::getConnectArg().c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); } virtual void TearDown() { alljoyn_busattachment_stop(servicebus); alljoyn_busattachment_join(servicebus); alljoyn_busattachment_stop(clientbus); alljoyn_busattachment_join(clientbus); alljoyn_busattachment_destroy(servicebus); alljoyn_busattachment_destroy(clientbus); alljoyn_buslistener_destroy(buslistener); alljoyn_busobject_destroy(testObj); } void SetUpAuthService() { /* register bus listener */ alljoyn_buslistener_callbacks buslistenerCbs = { NULL, NULL, NULL, NULL, &name_owner_changed, NULL, NULL, NULL }; buslistener = alljoyn_buslistener_create(&buslistenerCbs, NULL); alljoyn_busattachment_registerbuslistener(servicebus, buslistener); /* Set up bus object */ alljoyn_busobject_callbacks busObjCbs = { NULL, NULL, NULL, NULL }; testObj = alljoyn_busobject_create(OBJECT_PATH, QCC_FALSE, &busObjCbs, NULL); const alljoyn_interfacedescription exampleIntf = alljoyn_busattachment_getinterface(servicebus, INTERFACE_NAME); ASSERT_TRUE(exampleIntf); status = alljoyn_busobject_addinterface(testObj, exampleIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* register method handlers */ alljoyn_interfacedescription_member ping_member; QCC_BOOL foundMember = alljoyn_interfacedescription_getmember(exampleIntf, "ping", &ping_member); EXPECT_TRUE(foundMember); /* add methodhandlers */ alljoyn_busobject_methodentry methodEntries[] = { { &ping_member, ping_method }, }; status = alljoyn_busobject_addmethodhandlers(testObj, methodEntries, sizeof(methodEntries) / sizeof(methodEntries[0])); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_registerbusobject(servicebus, testObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); name_owner_changed_flag = QCC_FALSE; /* request name */ uint32_t flags = DBUS_NAME_FLAG_REPLACE_EXISTING | DBUS_NAME_FLAG_DO_NOT_QUEUE; status = alljoyn_busattachment_requestname(servicebus, OBJECT_NAME, flags); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 200; ++i) { if (name_owner_changed_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(name_owner_changed_flag); } void SetupAuthClient() { alljoyn_proxybusobject proxyObj = alljoyn_proxybusobject_create(clientbus, OBJECT_NAME, OBJECT_PATH, 0); EXPECT_TRUE(proxyObj); status = alljoyn_proxybusobject_introspectremoteobject(proxyObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_message reply = alljoyn_message_create(clientbus); alljoyn_msgarg input = alljoyn_msgarg_create_and_set("s", "AllJoyn"); status = alljoyn_proxybusobject_methodcall(proxyObj, INTERFACE_NAME, "ping", input, 1, reply, ALLJOYN_MESSAGE_DEFAULT_TIMEOUT, 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); const char* str; alljoyn_msgarg_get(alljoyn_message_getarg(reply, 0), "s", &str); EXPECT_STREQ("AllJoyn", str); alljoyn_message_destroy(reply); alljoyn_msgarg_destroy(input); alljoyn_proxybusobject_destroy(proxyObj); } void SetupAuthClientAuthFail() { alljoyn_proxybusobject proxyObj = alljoyn_proxybusobject_create(clientbus, OBJECT_NAME, OBJECT_PATH, 0); EXPECT_TRUE(proxyObj); status = alljoyn_proxybusobject_introspectremoteobject(proxyObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_message reply = alljoyn_message_create(clientbus); alljoyn_msgarg input = alljoyn_msgarg_create_and_set("s", "AllJoyn"); status = alljoyn_proxybusobject_methodcall(proxyObj, INTERFACE_NAME, "ping", input, 1, reply, 200, 0); EXPECT_EQ(ER_BUS_REPLY_IS_ERROR_MESSAGE, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_message_destroy(reply); alljoyn_msgarg_destroy(input); alljoyn_proxybusobject_destroy(proxyObj); } void ResetAuthFlags() { requestcredentials_service_flag = QCC_FALSE; authenticationcomplete_service_flag = QCC_FALSE; verifycredentials_service_flag = QCC_FALSE; securityviolation_service_flag = QCC_FALSE; requestcredentials_client_flag = QCC_FALSE; authenticationcomplete_client_flag = QCC_FALSE; verifycredentials_client_flag = QCC_FALSE; securityviolation_client_flag = QCC_FALSE; } QStatus status; alljoyn_busattachment servicebus; alljoyn_busattachment clientbus; alljoyn_busobject testObj; alljoyn_buslistener buslistener; }; /* AuthListener callback functions*/ static QStatus AJ_CALL authlistener_requestcredentialsasync_service_srp_keyx(const void* context, alljoyn_authlistener listener, const char* authMechanism, const char* peerName, uint16_t authCount, const char* userName, uint16_t credMask, void* authContext) { QCC_UNUSED(peerName); QCC_UNUSED(authCount); QCC_UNUSED(userName); alljoyn_credentials creds = alljoyn_credentials_create(); EXPECT_STREQ("context test string", (const char*)context); EXPECT_STREQ("ALLJOYN_SRP_KEYX", authMechanism); if (credMask & ALLJOYN_CRED_PASSWORD) { alljoyn_credentials_setpassword(creds, "ABCDEFGH"); } QStatus status = alljoyn_authlistener_requestcredentialsresponse(listener, authContext, QCC_TRUE, creds); alljoyn_credentials_destroy(creds); requestcredentials_service_flag = QCC_TRUE; return status; } static void AJ_CALL alljoyn_authlistener_authenticationcomplete_service_srp_keyx(const void* context, const char* authMechanism, const char* peerName, QCC_BOOL success) { QCC_UNUSED(authMechanism); QCC_UNUSED(peerName); EXPECT_STREQ("context test string", (const char*)context); EXPECT_TRUE(success); authenticationcomplete_service_flag = QCC_TRUE; } static QStatus AJ_CALL authlistener_requestcredentialsasync_client_srp_keyx(const void* context, alljoyn_authlistener listener, const char* authMechanism, const char* peerName, uint16_t authCount, const char* userName, uint16_t credMask, void* authContext) { QCC_UNUSED(peerName); QCC_UNUSED(authCount); QCC_UNUSED(userName); alljoyn_credentials creds = alljoyn_credentials_create(); EXPECT_STREQ("context test string", (const char*)context); EXPECT_STREQ("ALLJOYN_SRP_KEYX", authMechanism); if (credMask & ALLJOYN_CRED_PASSWORD) { alljoyn_credentials_setpassword(creds, "ABCDEFGH"); } QStatus status = alljoyn_authlistener_requestcredentialsresponse(listener, authContext, QCC_TRUE, creds); alljoyn_credentials_destroy(creds); requestcredentials_client_flag = QCC_TRUE; return status; } static void AJ_CALL alljoyn_authlistener_authenticationcomplete_client_srp_keyx(const void* context, const char* authMechanism, const char* peerName, QCC_BOOL success) { QCC_UNUSED(authMechanism); QCC_UNUSED(peerName); EXPECT_STREQ("context test string", (const char*)context); EXPECT_TRUE(success); authenticationcomplete_client_flag = QCC_TRUE; } TEST_F(AuthListenerAsyncTest, srp_keyx) { ResetAuthFlags(); alljoyn_busattachment_clearkeystore(clientbus); /* set up the service */ alljoyn_authlistenerasync_callbacks authlistener_cb_service = { authlistener_requestcredentialsasync_service_srp_keyx, //requestcredentialsasync NULL, //verifycredentialsasync NULL, //securityviolation alljoyn_authlistener_authenticationcomplete_service_srp_keyx //authenticationcomplete }; alljoyn_authlistener serviceauthlistener = alljoyn_authlistenerasync_create(&authlistener_cb_service, (void*)"context test string"); status = alljoyn_busattachment_enablepeersecurity(servicebus, "ALLJOYN_SRP_KEYX", serviceauthlistener, NULL, QCC_FALSE); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* Clear the Keystore between runs */ alljoyn_busattachment_clearkeystore(servicebus); SetUpAuthService(); /* set up the client */ alljoyn_authlistenerasync_callbacks authlistener_cb_client = { authlistener_requestcredentialsasync_client_srp_keyx, //requestcredentialsasync NULL, //verifycredentialsasync NULL, //securityviolation alljoyn_authlistener_authenticationcomplete_client_srp_keyx //authenticationcomplete }; alljoyn_authlistener clientauthlistener = alljoyn_authlistenerasync_create(&authlistener_cb_client, (void*)"context test string"); status = alljoyn_busattachment_enablepeersecurity(clientbus, "ALLJOYN_SRP_KEYX", clientauthlistener, NULL, QCC_FALSE); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* Clear the Keystore between runs */ alljoyn_busattachment_clearkeystore(clientbus); SetupAuthClient(); EXPECT_TRUE(requestcredentials_service_flag); EXPECT_TRUE(authenticationcomplete_service_flag); EXPECT_TRUE(requestcredentials_client_flag); EXPECT_TRUE(authenticationcomplete_client_flag); alljoyn_authlistenerasync_destroy(serviceauthlistener); alljoyn_authlistenerasync_destroy(clientauthlistener); } /* AuthListener callback functions*/ static QStatus AJ_CALL authlistener_requestcredentialsasync_service_srp_logon(const void* context, alljoyn_authlistener listener, const char* authMechanism, const char* peerName, uint16_t authCount, const char* userName, uint16_t credMask, void* authContext) { QCC_UNUSED(context); QCC_UNUSED(peerName); QCC_UNUSED(authCount); alljoyn_credentials creds = alljoyn_credentials_create(); QStatus status = ER_FAIL; EXPECT_STREQ("ALLJOYN_SRP_LOGON", authMechanism); if (!userName) { status = alljoyn_authlistener_requestcredentialsresponse(listener, authContext, QCC_FALSE, creds); } else if (credMask & ALLJOYN_CRED_PASSWORD) { EXPECT_STREQ("Mr. Cuddles", userName); if (strcmp(userName, "Mr. Cuddles") == 0) { alljoyn_credentials_setpassword(creds, "123456"); status = alljoyn_authlistener_requestcredentialsresponse(listener, authContext, QCC_TRUE, creds); } else { status = alljoyn_authlistener_requestcredentialsresponse(listener, authContext, QCC_FALSE, creds); } } else { status = alljoyn_authlistener_requestcredentialsresponse(listener, authContext, QCC_FALSE, creds); } alljoyn_credentials_destroy(creds); requestcredentials_service_flag = QCC_TRUE; return status; } static void AJ_CALL alljoyn_authlistener_authenticationcomplete_service_srp_logon(const void* context, const char* authMechanism, const char* peerName, QCC_BOOL success) { QCC_UNUSED(context); QCC_UNUSED(authMechanism); QCC_UNUSED(peerName); EXPECT_TRUE(success); authenticationcomplete_service_flag = QCC_TRUE; } static QStatus AJ_CALL authlistener_requestcredentialsasync_client_srp_logon(const void* context, alljoyn_authlistener listener, const char* authMechanism, const char* peerName, uint16_t authCount, const char* userName, uint16_t credMask, void* authContext) { QCC_UNUSED(context); QCC_UNUSED(peerName); QCC_UNUSED(authCount); QCC_UNUSED(userName); alljoyn_credentials creds = alljoyn_credentials_create(); EXPECT_STREQ("ALLJOYN_SRP_LOGON", authMechanism); if (credMask & ALLJOYN_CRED_USER_NAME) { alljoyn_credentials_setusername(creds, "Mr. Cuddles"); } if (credMask & ALLJOYN_CRED_PASSWORD) { alljoyn_credentials_setpassword(creds, "123456"); } QStatus status = alljoyn_authlistener_requestcredentialsresponse(listener, authContext, QCC_TRUE, creds); alljoyn_credentials_destroy(creds); requestcredentials_client_flag = QCC_TRUE; return status; } static void AJ_CALL alljoyn_authlistener_authenticationcomplete_client_srp_logon(const void* context, const char* authMechanism, const char* peerName, QCC_BOOL success) { QCC_UNUSED(context); QCC_UNUSED(authMechanism); QCC_UNUSED(peerName); EXPECT_TRUE(success); authenticationcomplete_client_flag = QCC_TRUE; } TEST_F(AuthListenerAsyncTest, srp_logon) { ResetAuthFlags(); alljoyn_busattachment_clearkeystore(clientbus); /* set up the service */ alljoyn_authlistenerasync_callbacks authlistener_cb_service = { authlistener_requestcredentialsasync_service_srp_logon, //requestcredentialsasync NULL, //verifycredentialsasync NULL, //securityviolation alljoyn_authlistener_authenticationcomplete_service_srp_logon //authenticationcomplete }; alljoyn_authlistener serviceauthlistener = alljoyn_authlistenerasync_create(&authlistener_cb_service, NULL); status = alljoyn_busattachment_enablepeersecurity(servicebus, "ALLJOYN_SRP_LOGON", serviceauthlistener, NULL, QCC_FALSE); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* Clear the Keystore between runs */ alljoyn_busattachment_clearkeystore(servicebus); SetUpAuthService(); /* set up the client */ alljoyn_authlistenerasync_callbacks authlistener_cb_client = { authlistener_requestcredentialsasync_client_srp_logon, //requestcredentialsasync NULL, //verifycredentialsasync NULL, //securityviolation alljoyn_authlistener_authenticationcomplete_client_srp_logon //authenticationcomplete }; alljoyn_authlistener clientauthlistener = alljoyn_authlistenerasync_create(&authlistener_cb_client, NULL); status = alljoyn_busattachment_enablepeersecurity(clientbus, "ALLJOYN_SRP_LOGON", clientauthlistener, NULL, QCC_FALSE); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* Clear the Keystore between runs */ alljoyn_busattachment_clearkeystore(clientbus); SetupAuthClient(); EXPECT_TRUE(requestcredentials_service_flag); EXPECT_TRUE(authenticationcomplete_service_flag); EXPECT_TRUE(requestcredentials_client_flag); EXPECT_TRUE(authenticationcomplete_client_flag); alljoyn_authlistenerasync_destroy(serviceauthlistener); alljoyn_authlistenerasync_destroy(clientauthlistener); } /* AuthListener callback functions*/ static QStatus AJ_CALL authlistener_requestcredentialsasync_service_srp_keyx2(const void* context, alljoyn_authlistener listener, const char* authMechanism, const char* peerName, uint16_t authCount, const char* userName, uint16_t credMask, void* authContext) { QCC_UNUSED(context); QCC_UNUSED(peerName); QCC_UNUSED(authCount); QCC_UNUSED(userName); QCC_UNUSED(credMask); EXPECT_STREQ("ALLJOYN_SRP_KEYX", authMechanism); alljoyn_credentials creds = alljoyn_credentials_create(); QStatus status = alljoyn_authlistener_requestcredentialsresponse(listener, authContext, QCC_FALSE, creds); alljoyn_credentials_destroy(creds); requestcredentials_service_flag = QCC_TRUE; return status; } static void AJ_CALL alljoyn_authlistener_authenticationcomplete_service_srp_keyx2(const void* context, const char* authMechanism, const char* peerName, QCC_BOOL success) { QCC_UNUSED(context); QCC_UNUSED(authMechanism); QCC_UNUSED(peerName); EXPECT_FALSE(success); authenticationcomplete_service_flag = QCC_TRUE; } static QStatus AJ_CALL authlistener_requestcredentialsasync_client_srp_keyx2(const void* context, alljoyn_authlistener listener, const char* authMechanism, const char* peerName, uint16_t authCount, const char* userName, uint16_t credMask, void* authContext) { QCC_UNUSED(context); QCC_UNUSED(peerName); QCC_UNUSED(authCount); QCC_UNUSED(userName); QCC_UNUSED(credMask); EXPECT_STREQ("ALLJOYN_SRP_KEYX", authMechanism); alljoyn_credentials creds = alljoyn_credentials_create(); QStatus status = alljoyn_authlistener_requestcredentialsresponse(listener, authContext, QCC_FALSE, creds); alljoyn_credentials_destroy(creds); requestcredentials_client_flag = QCC_TRUE; return status; } static void AJ_CALL authlistener_securityviolation_client_srp_keyx2(const void* context, QStatus status, const alljoyn_message msg) { QCC_UNUSED(context); QCC_UNUSED(status); QCC_UNUSED(msg); securityviolation_client_flag = QCC_TRUE; } /* * Run the SRP Key Exchange test again except this time fail the authentication * we expect to see an authlistener secutity violation. */ static void AJ_CALL alljoyn_authlistener_authenticationcomplete_client_srp_keyx2(const void* context, const char* authMechanism, const char* peerName, QCC_BOOL success) { QCC_UNUSED(context); QCC_UNUSED(authMechanism); QCC_UNUSED(peerName); EXPECT_FALSE(success); authenticationcomplete_client_flag = QCC_TRUE; } TEST_F(AuthListenerAsyncTest, srp_keyx2) { ResetAuthFlags(); alljoyn_busattachment_clearkeystore(clientbus); /* set up the service */ alljoyn_authlistenerasync_callbacks authlistener_cb_service = { authlistener_requestcredentialsasync_service_srp_keyx2, //requestcredentialsasync NULL, //verifycredentialsasync NULL, //securityviolation alljoyn_authlistener_authenticationcomplete_service_srp_keyx2 //authenticationcomplete }; alljoyn_authlistener serviceauthlistener = alljoyn_authlistenerasync_create(&authlistener_cb_service, NULL); status = alljoyn_busattachment_enablepeersecurity(servicebus, "ALLJOYN_SRP_KEYX", serviceauthlistener, NULL, QCC_FALSE); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* Clear the Keystore between runs */ alljoyn_busattachment_clearkeystore(servicebus); SetUpAuthService(); /* set up the client */ alljoyn_authlistenerasync_callbacks authlistener_cb_client = { authlistener_requestcredentialsasync_client_srp_keyx2, //requestcredentialsasync NULL, //verifycredentialsasync authlistener_securityviolation_client_srp_keyx2, //securityviolation alljoyn_authlistener_authenticationcomplete_client_srp_keyx2 //authenticationcomplete }; alljoyn_authlistener clientauthlistener = alljoyn_authlistenerasync_create(&authlistener_cb_client, NULL); status = alljoyn_busattachment_enablepeersecurity(clientbus, "ALLJOYN_SRP_KEYX", clientauthlistener, NULL, QCC_FALSE); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* Clear the Keystore between runs */ alljoyn_busattachment_clearkeystore(clientbus); SetupAuthClientAuthFail(); //Wait upto 2 seconds for the signal to complete. for (int i = 0; i < 200; ++i) { if (securityviolation_client_flag) { break; } qcc::Sleep(10); } EXPECT_TRUE(requestcredentials_service_flag); EXPECT_TRUE(authenticationcomplete_service_flag); EXPECT_TRUE(authenticationcomplete_client_flag); EXPECT_TRUE(securityviolation_client_flag); alljoyn_authlistenerasync_destroy(serviceauthlistener); alljoyn_authlistenerasync_destroy(clientauthlistener); } /* * This test re-uses the authlisteners used for the srp_keyx unit test. What * It is unimportant to know what authlistener is used, just that authentication * is being done when alljoyn_proxybusobject_secureconnectionasync is called. */ TEST_F(AuthListenerAsyncTest, secureconnectionasync) { ResetAuthFlags(); alljoyn_busattachment_clearkeystore(clientbus); /* set up the service */ alljoyn_authlistenerasync_callbacks authlistener_cb_service = { authlistener_requestcredentialsasync_service_srp_keyx, //requestcredentialsasync NULL, //verifycredentialsasync NULL, //securityviolation alljoyn_authlistener_authenticationcomplete_service_srp_keyx //authenticationcomplete }; alljoyn_authlistener serviceauthlistener = alljoyn_authlistenerasync_create(&authlistener_cb_service, (void*)"context test string"); status = alljoyn_busattachment_enablepeersecurity(servicebus, "ALLJOYN_SRP_KEYX", serviceauthlistener, NULL, QCC_FALSE); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* Clear the Keystore between runs */ alljoyn_busattachment_clearkeystore(servicebus); SetUpAuthService(); /* set up the client */ alljoyn_authlistenerasync_callbacks authlistener_cb_client = { authlistener_requestcredentialsasync_client_srp_keyx, //requestcredentialsasync NULL, //verifycredentialsasync NULL, //securityviolation alljoyn_authlistener_authenticationcomplete_client_srp_keyx //authenticationcomplete }; alljoyn_authlistener clientauthlistener = alljoyn_authlistenerasync_create(&authlistener_cb_client, (void*)"context test string"); status = alljoyn_busattachment_enablepeersecurity(clientbus, "ALLJOYN_SRP_KEYX", clientauthlistener, NULL, QCC_FALSE); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* Clear the Keystore between runs */ alljoyn_busattachment_clearkeystore(clientbus); alljoyn_proxybusobject proxyObj = alljoyn_proxybusobject_create(clientbus, OBJECT_NAME, OBJECT_PATH, 0); ASSERT_TRUE(proxyObj); status = alljoyn_proxybusobject_secureconnectionasync(proxyObj, QCC_FALSE); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); //Wait upto 2 seconds for authentication to complete. for (int i = 0; i < 200; ++i) { if (authenticationcomplete_service_flag && authenticationcomplete_client_flag) { break; } qcc::Sleep(10); } EXPECT_TRUE(requestcredentials_service_flag); EXPECT_TRUE(authenticationcomplete_service_flag); EXPECT_TRUE(requestcredentials_client_flag); EXPECT_TRUE(authenticationcomplete_client_flag); ResetAuthFlags(); /* * the peer-to-peer connection should have been authenticated with the last * call to alljoyn_proxybusobject_secureconnection this call should return * ER_OK with out calling any of the authlistener functions. */ status = alljoyn_proxybusobject_secureconnectionasync(proxyObj, QCC_FALSE); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); //We don't expect these values to change from there default values. EXPECT_FALSE(requestcredentials_service_flag); EXPECT_FALSE(authenticationcomplete_service_flag); EXPECT_FALSE(requestcredentials_client_flag); EXPECT_FALSE(authenticationcomplete_client_flag); ResetAuthFlags(); /* * Although the peer-to-peer connection has already been authenticated we * are forcing re-authentication so we expect the authlistener functions to * be called again. */ status = alljoyn_proxybusobject_secureconnection(proxyObj, QCC_TRUE); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); //Wait upto 2 seconds for authentication to complete. for (int i = 0; i < 200; ++i) { if (authenticationcomplete_service_flag && authenticationcomplete_client_flag) { break; } qcc::Sleep(10); } EXPECT_TRUE(requestcredentials_service_flag); EXPECT_TRUE(authenticationcomplete_service_flag); EXPECT_TRUE(requestcredentials_client_flag); EXPECT_TRUE(authenticationcomplete_client_flag); alljoyn_proxybusobject_destroy(proxyObj); alljoyn_authlistenerasync_destroy(serviceauthlistener); alljoyn_authlistenerasync_destroy(clientauthlistener); } alljoyn-15.04b/alljoyn_c/unit_test/AuthListenerTest.cc000066400000000000000000000665271255700255500231310ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include "ajTestCommon.h" #include #include #include #include #include #include static const char* INTERFACE_NAME = "org.alljoyn.test.c.authlistener"; static const char* OBJECT_NAME = "org.alljoyn.test.c.authlistener"; static const char* OBJECT_PATH = "/org/alljoyn/test"; static QCC_BOOL name_owner_changed_flag = QCC_FALSE; static QCC_BOOL requestcredentials_service_flag = QCC_FALSE; static QCC_BOOL authenticationcomplete_service_flag = QCC_FALSE; static QCC_BOOL verifycredentials_service_flag = QCC_FALSE; static QCC_BOOL securityviolation_service_flag = QCC_FALSE; static QCC_BOOL requestcredentials_client_flag = QCC_FALSE; static QCC_BOOL authenticationcomplete_client_flag = QCC_FALSE; static QCC_BOOL verifycredentials_client_flag = QCC_FALSE; static QCC_BOOL securityviolation_client_flag = QCC_TRUE; /* NameOwnerChanged callback */ static void AJ_CALL name_owner_changed(const void* context, const char* busName, const char* previousOwner, const char* newOwner) { QCC_UNUSED(context); QCC_UNUSED(previousOwner); QCC_UNUSED(newOwner); if (strcmp(busName, OBJECT_NAME) == 0) { name_owner_changed_flag = QCC_TRUE; } } /* Exposed methods */ static void AJ_CALL ping_method(alljoyn_busobject bus, const alljoyn_interfacedescription_member* member, alljoyn_message msg) { QCC_UNUSED(member); alljoyn_msgarg outArg = alljoyn_msgarg_create(); alljoyn_msgarg inArg = alljoyn_message_getarg(msg, 0); const char* str; alljoyn_msgarg_get(inArg, "s", &str); alljoyn_msgarg_set(outArg, "s", str); QStatus status = alljoyn_busobject_methodreply_args(bus, msg, outArg, 1); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg_destroy(outArg); } class AuthListenerTest : public testing::Test { public: virtual void SetUp() { /* initilize test fixture values to known start value */ status = ER_FAIL; servicebus = NULL; clientbus = NULL; testObj = NULL; buslistener = NULL; /* set up the service bus */ servicebus = alljoyn_busattachment_create("AuthListenerTestService", false); status = alljoyn_busattachment_start(servicebus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(servicebus, ajn::getConnectArg().c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription service_intf = NULL; status = alljoyn_busattachment_createinterface_secure(servicebus, INTERFACE_NAME, &service_intf, AJ_IFC_SECURITY_REQUIRED); ASSERT_TRUE(service_intf != NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_interfacedescription_addmember(service_intf, ALLJOYN_MESSAGE_METHOD_CALL, "ping", "s", "s", "in,out", 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription_activate(service_intf); clientbus = alljoyn_busattachment_create("AuthListenerTestClient", false); status = alljoyn_busattachment_start(clientbus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(clientbus, ajn::getConnectArg().c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); } virtual void TearDown() { alljoyn_busattachment_stop(servicebus); alljoyn_busattachment_join(servicebus); alljoyn_busattachment_stop(clientbus); alljoyn_busattachment_join(clientbus); alljoyn_busattachment_destroy(servicebus); alljoyn_busattachment_destroy(clientbus); alljoyn_buslistener_destroy(buslistener); alljoyn_busobject_destroy(testObj); } void SetUpAuthService() { /* register bus listener */ alljoyn_buslistener_callbacks buslistenerCbs = { NULL, NULL, NULL, NULL, &name_owner_changed, NULL, NULL, NULL }; buslistener = alljoyn_buslistener_create(&buslistenerCbs, NULL); alljoyn_busattachment_registerbuslistener(servicebus, buslistener); /* Set up bus object */ alljoyn_busobject_callbacks busObjCbs = { NULL, NULL, NULL, NULL }; testObj = alljoyn_busobject_create(OBJECT_PATH, QCC_FALSE, &busObjCbs, NULL); const alljoyn_interfacedescription exampleIntf = alljoyn_busattachment_getinterface(servicebus, INTERFACE_NAME); ASSERT_TRUE(exampleIntf); status = alljoyn_busobject_addinterface(testObj, exampleIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* register method handlers */ alljoyn_interfacedescription_member ping_member; QCC_BOOL foundMember = alljoyn_interfacedescription_getmember(exampleIntf, "ping", &ping_member); EXPECT_TRUE(foundMember); /* add methodhandlers */ alljoyn_busobject_methodentry methodEntries[] = { { &ping_member, ping_method }, }; status = alljoyn_busobject_addmethodhandlers(testObj, methodEntries, sizeof(methodEntries) / sizeof(methodEntries[0])); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_registerbusobject(servicebus, testObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); name_owner_changed_flag = QCC_FALSE; /* request name */ uint32_t flags = DBUS_NAME_FLAG_REPLACE_EXISTING | DBUS_NAME_FLAG_DO_NOT_QUEUE; status = alljoyn_busattachment_requestname(servicebus, OBJECT_NAME, flags); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 200; ++i) { if (name_owner_changed_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(name_owner_changed_flag); } void SetupAuthClient() { alljoyn_proxybusobject proxyObj = alljoyn_proxybusobject_create(clientbus, OBJECT_NAME, OBJECT_PATH, 0); EXPECT_TRUE(proxyObj); status = alljoyn_proxybusobject_introspectremoteobject(proxyObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_message reply = alljoyn_message_create(clientbus); alljoyn_msgarg input = alljoyn_msgarg_create_and_set("s", "AllJoyn"); status = alljoyn_proxybusobject_methodcall(proxyObj, INTERFACE_NAME, "ping", input, 1, reply, ALLJOYN_MESSAGE_DEFAULT_TIMEOUT, 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); const char* str; alljoyn_msgarg_get(alljoyn_message_getarg(reply, 0), "s", &str); EXPECT_STREQ("AllJoyn", str); alljoyn_message_destroy(reply); alljoyn_msgarg_destroy(input); alljoyn_proxybusobject_destroy(proxyObj); } void SetupAuthClientAuthFail() { alljoyn_proxybusobject proxyObj = alljoyn_proxybusobject_create(clientbus, OBJECT_NAME, OBJECT_PATH, 0); EXPECT_TRUE(proxyObj); status = alljoyn_proxybusobject_introspectremoteobject(proxyObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_message reply = alljoyn_message_create(clientbus); alljoyn_msgarg input = alljoyn_msgarg_create_and_set("s", "AllJoyn"); status = alljoyn_proxybusobject_methodcall(proxyObj, INTERFACE_NAME, "ping", input, 1, reply, 200, 0); EXPECT_EQ(ER_BUS_REPLY_IS_ERROR_MESSAGE, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_message_destroy(reply); alljoyn_msgarg_destroy(input); alljoyn_proxybusobject_destroy(proxyObj); } void ResetAuthFlags() { requestcredentials_service_flag = QCC_FALSE; authenticationcomplete_service_flag = QCC_FALSE; verifycredentials_service_flag = QCC_FALSE; securityviolation_service_flag = QCC_FALSE; requestcredentials_client_flag = QCC_FALSE; authenticationcomplete_client_flag = QCC_FALSE; verifycredentials_client_flag = QCC_FALSE; securityviolation_client_flag = QCC_FALSE; } QStatus status; alljoyn_busattachment servicebus; alljoyn_busattachment clientbus; alljoyn_busobject testObj; alljoyn_buslistener buslistener; }; /* AuthListener callback functions*/ static QCC_BOOL AJ_CALL authlistener_requestcredentials_service_srp_keyx(const void* context, const char* authMechanism, const char* peerName, uint16_t authCount, const char* userName, uint16_t credMask, alljoyn_credentials credentials) { QCC_UNUSED(peerName); QCC_UNUSED(authCount); QCC_UNUSED(userName); EXPECT_STREQ("context test string", (const char*)context); EXPECT_STREQ("ALLJOYN_SRP_KEYX", authMechanism); if (credMask & ALLJOYN_CRED_PASSWORD) { alljoyn_credentials_setpassword(credentials, "ABCDEFGH"); } requestcredentials_service_flag = QCC_TRUE; return QCC_TRUE; } static void AJ_CALL alljoyn_authlistener_authenticationcomplete_service_srp_keyx(const void* context, const char* authMechanism, const char* peerName, QCC_BOOL success) { QCC_UNUSED(authMechanism); QCC_UNUSED(peerName); EXPECT_STREQ("context test string", (const char*)context); EXPECT_TRUE(success); authenticationcomplete_service_flag = QCC_TRUE; } static QCC_BOOL AJ_CALL authlistener_requestcredentials_client_srp_keyx(const void* context, const char* authMechanism, const char* peerName, uint16_t authCount, const char* userName, uint16_t credMask, alljoyn_credentials credentials) { QCC_UNUSED(peerName); QCC_UNUSED(authCount); QCC_UNUSED(userName); EXPECT_STREQ("context test string", (const char*)context); EXPECT_STREQ("ALLJOYN_SRP_KEYX", authMechanism); if (credMask & ALLJOYN_CRED_PASSWORD) { alljoyn_credentials_setpassword(credentials, "ABCDEFGH"); } requestcredentials_client_flag = QCC_TRUE; return QCC_TRUE; } static void AJ_CALL alljoyn_authlistener_authenticationcomplete_client_srp_keyx(const void* context, const char* authMechanism, const char* peerName, QCC_BOOL success) { QCC_UNUSED(authMechanism); QCC_UNUSED(peerName); EXPECT_STREQ("context test string", (const char*)context); EXPECT_TRUE(success); authenticationcomplete_client_flag = QCC_TRUE; } TEST_F(AuthListenerTest, srp_keyx) { ResetAuthFlags(); alljoyn_busattachment_clearkeystore(clientbus); /* set up the service */ alljoyn_authlistener_callbacks authlistener_cb_service = { authlistener_requestcredentials_service_srp_keyx, //requestcredentials NULL, //verifycredentials NULL, //securityviolation alljoyn_authlistener_authenticationcomplete_service_srp_keyx //authenticationcomplete }; alljoyn_authlistener serviceauthlistener = alljoyn_authlistener_create(&authlistener_cb_service, (void*)"context test string"); status = alljoyn_busattachment_enablepeersecurity(servicebus, "ALLJOYN_SRP_KEYX", serviceauthlistener, NULL, QCC_FALSE); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* Clear the Keystore between runs */ alljoyn_busattachment_clearkeystore(servicebus); SetUpAuthService(); /* set up the client */ alljoyn_authlistener_callbacks authlistener_cb_client = { authlistener_requestcredentials_client_srp_keyx, //requestcredentials NULL, //verifycredentials NULL, //securityviolation alljoyn_authlistener_authenticationcomplete_client_srp_keyx //authenticationcomplete }; alljoyn_authlistener clientauthlistener = alljoyn_authlistener_create(&authlistener_cb_client, (void*)"context test string"); status = alljoyn_busattachment_enablepeersecurity(clientbus, "ALLJOYN_SRP_KEYX", clientauthlistener, NULL, QCC_FALSE); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* Clear the Keystore between runs */ alljoyn_busattachment_clearkeystore(clientbus); SetupAuthClient(); EXPECT_TRUE(requestcredentials_service_flag); EXPECT_TRUE(authenticationcomplete_service_flag); EXPECT_TRUE(requestcredentials_client_flag); EXPECT_TRUE(authenticationcomplete_client_flag); alljoyn_authlistener_destroy(serviceauthlistener); alljoyn_authlistener_destroy(clientauthlistener); } /* AuthListener callback functions*/ static QCC_BOOL AJ_CALL authlistener_requestcredentials_service_srp_logon(const void* context, const char* authMechanism, const char* peerName, uint16_t authCount, const char* userName, uint16_t credMask, alljoyn_credentials credentials) { QCC_UNUSED(context); QCC_UNUSED(peerName); QCC_UNUSED(authCount); EXPECT_STREQ("ALLJOYN_SRP_LOGON", authMechanism); if (!userName) { return QCC_FALSE; } else if (credMask & ALLJOYN_CRED_PASSWORD) { EXPECT_STREQ("Mr. Cuddles", userName); if (strcmp(userName, "Mr. Cuddles") == 0) { alljoyn_credentials_setpassword(credentials, "123456"); } else { return QCC_FALSE; } } else { return QCC_FALSE; } requestcredentials_service_flag = QCC_TRUE; return QCC_TRUE; } static void AJ_CALL alljoyn_authlistener_authenticationcomplete_service_srp_logon(const void* context, const char* authMechanism, const char* peerName, QCC_BOOL success) { QCC_UNUSED(context); QCC_UNUSED(authMechanism); QCC_UNUSED(peerName); EXPECT_TRUE(success); authenticationcomplete_service_flag = QCC_TRUE; } static QCC_BOOL AJ_CALL authlistener_requestcredentials_client_srp_logon(const void* context, const char* authMechanism, const char* peerName, uint16_t authCount, const char* userName, uint16_t credMask, alljoyn_credentials credentials) { QCC_UNUSED(context); QCC_UNUSED(peerName); QCC_UNUSED(authCount); QCC_UNUSED(userName); EXPECT_STREQ("ALLJOYN_SRP_LOGON", authMechanism); if (credMask & ALLJOYN_CRED_USER_NAME) { alljoyn_credentials_setusername(credentials, "Mr. Cuddles"); } if (credMask & ALLJOYN_CRED_PASSWORD) { alljoyn_credentials_setpassword(credentials, "123456"); } requestcredentials_client_flag = QCC_TRUE; return QCC_TRUE; } static void AJ_CALL alljoyn_authlistener_authenticationcomplete_client_srp_logon(const void* context, const char* authMechanism, const char* peerName, QCC_BOOL success) { QCC_UNUSED(context); QCC_UNUSED(authMechanism); QCC_UNUSED(peerName); EXPECT_TRUE(success); authenticationcomplete_client_flag = QCC_TRUE; } TEST_F(AuthListenerTest, srp_logon) { ResetAuthFlags(); alljoyn_busattachment_clearkeystore(clientbus); /* set up the service */ alljoyn_authlistener_callbacks authlistener_cb_service = { authlistener_requestcredentials_service_srp_logon, //requestcredentials NULL, //verifycredentials NULL, //securityviolation alljoyn_authlistener_authenticationcomplete_service_srp_logon //authenticationcomplete }; alljoyn_authlistener serviceauthlistener = alljoyn_authlistener_create(&authlistener_cb_service, NULL); status = alljoyn_busattachment_enablepeersecurity(servicebus, "ALLJOYN_SRP_LOGON", serviceauthlistener, NULL, QCC_FALSE); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* Clear the Keystore between runs */ alljoyn_busattachment_clearkeystore(servicebus); SetUpAuthService(); /* set up the client */ alljoyn_authlistener_callbacks authlistener_cb_client = { authlistener_requestcredentials_client_srp_logon, //requestcredentials NULL, //verifycredentials NULL, //securityviolation alljoyn_authlistener_authenticationcomplete_client_srp_logon //authenticationcomplete }; alljoyn_authlistener clientauthlistener = alljoyn_authlistener_create(&authlistener_cb_client, NULL); status = alljoyn_busattachment_enablepeersecurity(clientbus, "ALLJOYN_SRP_LOGON", clientauthlistener, NULL, QCC_FALSE); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* Clear the Keystore between runs */ alljoyn_busattachment_clearkeystore(clientbus); SetupAuthClient(); EXPECT_TRUE(requestcredentials_service_flag); EXPECT_TRUE(authenticationcomplete_service_flag); EXPECT_TRUE(requestcredentials_client_flag); EXPECT_TRUE(authenticationcomplete_client_flag); alljoyn_authlistener_destroy(serviceauthlistener); alljoyn_authlistener_destroy(clientauthlistener); } /* AuthListener callback functions*/ static QCC_BOOL AJ_CALL authlistener_requestcredentials_service_srp_keyx2(const void* context, const char* authMechanism, const char* peerName, uint16_t authCount, const char* userName, uint16_t credMask, alljoyn_credentials credentials) { QCC_UNUSED(context); QCC_UNUSED(peerName); QCC_UNUSED(authCount); QCC_UNUSED(userName); QCC_UNUSED(credMask); QCC_UNUSED(credentials); EXPECT_STREQ("ALLJOYN_SRP_KEYX", authMechanism); requestcredentials_service_flag = QCC_TRUE; return QCC_FALSE; } static void AJ_CALL alljoyn_authlistener_authenticationcomplete_service_srp_keyx2(const void* context, const char* authMechanism, const char* peerName, QCC_BOOL success) { QCC_UNUSED(context); QCC_UNUSED(authMechanism); QCC_UNUSED(peerName); EXPECT_FALSE(success); authenticationcomplete_service_flag = QCC_TRUE; } static QCC_BOOL AJ_CALL authlistener_requestcredentials_client_srp_keyx2(const void* context, const char* authMechanism, const char* peerName, uint16_t authCount, const char* userName, uint16_t credMask, alljoyn_credentials credentials) { QCC_UNUSED(context); QCC_UNUSED(peerName); QCC_UNUSED(authCount); QCC_UNUSED(userName); QCC_UNUSED(credMask); QCC_UNUSED(credentials); EXPECT_STREQ("ALLJOYN_SRP_KEYX", authMechanism); requestcredentials_client_flag = QCC_TRUE; return QCC_FALSE; } static void AJ_CALL authlistener_securityviolation_client_srp_keyx2(const void* context, QStatus status, const alljoyn_message msg) { QCC_UNUSED(context); QCC_UNUSED(status); QCC_UNUSED(msg); securityviolation_client_flag = QCC_TRUE; } /* * Run the SRP Key Exchange test again except this time fail the authentication * we expect to see an authlistener secutity violation. */ static void AJ_CALL alljoyn_authlistener_authenticationcomplete_client_srp_keyx2(const void* context, const char* authMechanism, const char* peerName, QCC_BOOL success) { QCC_UNUSED(context); QCC_UNUSED(authMechanism); QCC_UNUSED(peerName); EXPECT_FALSE(success); authenticationcomplete_client_flag = QCC_TRUE; } TEST_F(AuthListenerTest, srp_keyx2) { ResetAuthFlags(); alljoyn_busattachment_clearkeystore(clientbus); /* set up the service */ alljoyn_authlistener_callbacks authlistener_cb_service = { authlistener_requestcredentials_service_srp_keyx2, //requestcredentials NULL, //verifycredentials NULL, //securityviolation alljoyn_authlistener_authenticationcomplete_service_srp_keyx2 //authenticationcomplete }; alljoyn_authlistener serviceauthlistener = alljoyn_authlistener_create(&authlistener_cb_service, NULL); status = alljoyn_busattachment_enablepeersecurity(servicebus, "ALLJOYN_SRP_KEYX", serviceauthlistener, NULL, QCC_FALSE); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* Clear the Keystore between runs */ alljoyn_busattachment_clearkeystore(servicebus); SetUpAuthService(); /* set up the client */ alljoyn_authlistener_callbacks authlistener_cb_client = { authlistener_requestcredentials_client_srp_keyx2, //requestcredentials NULL, //verifycredentials authlistener_securityviolation_client_srp_keyx2, //securityviolation alljoyn_authlistener_authenticationcomplete_client_srp_keyx2 //authenticationcomplete }; alljoyn_authlistener clientauthlistener = alljoyn_authlistener_create(&authlistener_cb_client, NULL); status = alljoyn_busattachment_enablepeersecurity(clientbus, "ALLJOYN_SRP_KEYX", clientauthlistener, NULL, QCC_FALSE); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* Clear the Keystore between runs */ alljoyn_busattachment_clearkeystore(clientbus); SetupAuthClientAuthFail(); //Wait upto 2 seconds for the signal to complete. for (int i = 0; i < 200; ++i) { if (securityviolation_client_flag) { break; } qcc::Sleep(10); } EXPECT_TRUE(requestcredentials_service_flag); EXPECT_TRUE(authenticationcomplete_service_flag); EXPECT_TRUE(authenticationcomplete_client_flag); EXPECT_TRUE(securityviolation_client_flag); alljoyn_authlistener_destroy(serviceauthlistener); alljoyn_authlistener_destroy(clientauthlistener); } /* * This test re-uses the authlisteners used for the srp_keyx unit test. * It is unimportant to know what authlistener is used just that authentication * is being done when alljoyn_proxybusobject_secureconnection is called. */ TEST_F(AuthListenerTest, secureconnection) { ResetAuthFlags(); alljoyn_busattachment_clearkeystore(clientbus); /* set up the service */ alljoyn_authlistener_callbacks authlistener_cb_service = { authlistener_requestcredentials_service_srp_keyx, //requestcredentials NULL, //verifycredentials NULL, //securityviolation alljoyn_authlistener_authenticationcomplete_service_srp_keyx //authenticationcomplete }; alljoyn_authlistener serviceauthlistener = alljoyn_authlistener_create(&authlistener_cb_service, (void*)"context test string"); status = alljoyn_busattachment_enablepeersecurity(servicebus, "ALLJOYN_SRP_KEYX", serviceauthlistener, NULL, QCC_FALSE); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* Clear the Keystore between runs */ alljoyn_busattachment_clearkeystore(servicebus); SetUpAuthService(); /* set up the client */ alljoyn_authlistener_callbacks authlistener_cb_client = { authlistener_requestcredentials_client_srp_keyx, //requestcredentials NULL, //verifycredentials NULL, //securityviolation alljoyn_authlistener_authenticationcomplete_client_srp_keyx //authenticationcomplete }; alljoyn_authlistener clientauthlistener = alljoyn_authlistener_create(&authlistener_cb_client, (void*)"context test string"); status = alljoyn_busattachment_enablepeersecurity(clientbus, "ALLJOYN_SRP_KEYX", clientauthlistener, NULL, QCC_FALSE); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* Clear the Keystore between runs */ alljoyn_busattachment_clearkeystore(clientbus); alljoyn_proxybusobject proxyObj = alljoyn_proxybusobject_create(clientbus, OBJECT_NAME, OBJECT_PATH, 0); ASSERT_TRUE(proxyObj); status = alljoyn_proxybusobject_secureconnection(proxyObj, QCC_FALSE); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_TRUE(requestcredentials_service_flag); EXPECT_TRUE(authenticationcomplete_service_flag); EXPECT_TRUE(requestcredentials_client_flag); EXPECT_TRUE(authenticationcomplete_client_flag); ResetAuthFlags(); /* * the peer-to-peer connection should have been authenticated with the last * call to alljoyn_proxybusobject_secureconnection this call should return * ER_OK with out calling any of the authlistener functions. */ status = alljoyn_proxybusobject_secureconnection(proxyObj, QCC_FALSE); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_FALSE(requestcredentials_service_flag); EXPECT_FALSE(authenticationcomplete_service_flag); EXPECT_FALSE(requestcredentials_client_flag); EXPECT_FALSE(authenticationcomplete_client_flag); ResetAuthFlags(); /* * Although the peer-to-peer connection has already been authenticated we * are forcing re-authentication so we expect the authlistener functions to * be called again. */ status = alljoyn_proxybusobject_secureconnection(proxyObj, QCC_TRUE); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_TRUE(requestcredentials_service_flag); EXPECT_TRUE(authenticationcomplete_service_flag); EXPECT_TRUE(requestcredentials_client_flag); EXPECT_TRUE(authenticationcomplete_client_flag); alljoyn_proxybusobject_destroy(proxyObj); alljoyn_authlistener_destroy(serviceauthlistener); alljoyn_authlistener_destroy(clientauthlistener); } alljoyn-15.04b/alljoyn_c/unit_test/BusAttachmentTest.cc000066400000000000000000000335131255700255500232510ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #include #include "ajTestCommon.h" TEST(BusAttachmentTest, createinterface) { QStatus status = ER_OK; alljoyn_busattachment bus = NULL; bus = alljoyn_busattachment_create("BusAttachmentTest", QCC_FALSE); ASSERT_TRUE(bus != NULL); alljoyn_interfacedescription testIntf = NULL; status = alljoyn_busattachment_createinterface(bus, "org.alljoyn.test.BusAttachment", &testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_destroy(bus); } TEST(BusAttachmentTest, deleteinterface) { QStatus status = ER_OK; alljoyn_busattachment bus = NULL; bus = alljoyn_busattachment_create("BusAttachmentTest", QCC_FALSE); ASSERT_TRUE(bus != NULL); alljoyn_interfacedescription testIntf = NULL; status = alljoyn_busattachment_createinterface(bus, "org.alljoyn.test.BusAttachment", &testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_deleteinterface(bus, testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_destroy(bus); } TEST(BusAttachmentTest, start_stop_join) { QStatus status = ER_FAIL; alljoyn_busattachment bus = NULL; bus = alljoyn_busattachment_create("BusAttachmentTest", QCC_FALSE); status = alljoyn_busattachment_start(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_stop(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_destroy(bus); } TEST(BusAttachmentTest, isstarted_isstopping) { QStatus status = ER_FAIL; alljoyn_busattachment bus = NULL; bus = alljoyn_busattachment_create("BusAttachmentTest", QCC_FALSE); EXPECT_EQ(QCC_FALSE, alljoyn_busattachment_isstarted(bus)); status = alljoyn_busattachment_start(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_EQ(QCC_TRUE, alljoyn_busattachment_isstarted(bus)); status = alljoyn_busattachment_stop(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* * Assumption made that the isstopping function will be called before all of * the BusAttachement threads have completed so it will return QCC_TRUE it is * possible, but unlikely, that this could return QCC_FALSE. */ EXPECT_EQ(QCC_TRUE, alljoyn_busattachment_isstopping(bus)); status = alljoyn_busattachment_join(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_EQ(QCC_FALSE, alljoyn_busattachment_isstarted(bus)); alljoyn_busattachment_destroy(bus); } TEST(BusAttachmentTest, getconcurrency) { alljoyn_busattachment bus = NULL; unsigned int concurrency = (unsigned int)-1; bus = alljoyn_busattachment_create("BusAttachmentTest", QCC_TRUE); concurrency = alljoyn_busattachment_getconcurrency(bus); //The default value for getconcurrency is 4 EXPECT_EQ(4u, concurrency) << " Expected a concurrency of 4 got " << concurrency; alljoyn_busattachment_destroy(bus); bus = NULL; concurrency = (unsigned int)-1; bus = alljoyn_busattachment_create_concurrency("BusAttachmentTest", QCC_TRUE, 8); concurrency = alljoyn_busattachment_getconcurrency(bus); //The default value for getconcurrency is 8 EXPECT_EQ(8u, concurrency) << " Expected a concurrency of 8 got " << concurrency; alljoyn_busattachment_destroy(bus); } TEST(BusAttachmentTest, isconnected) { QStatus status; alljoyn_busattachment bus; size_t i; QCC_BOOL allow_remote[2] = { QCC_FALSE, QCC_TRUE }; for (i = 0; i < ArraySize(allow_remote); i++) { status = ER_FAIL; bus = NULL; bus = alljoyn_busattachment_create("BusAttachmentTest", allow_remote[i]); status = alljoyn_busattachment_start(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_FALSE(alljoyn_busattachment_isconnected(bus)); status = alljoyn_busattachment_connect(bus, ajn::getConnectArg().c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); if (ER_OK == status) { EXPECT_TRUE(alljoyn_busattachment_isconnected(bus)); } status = alljoyn_busattachment_disconnect(bus, ajn::getConnectArg().c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); if (ER_OK == status) { EXPECT_FALSE(alljoyn_busattachment_isconnected(bus)); } status = alljoyn_busattachment_stop(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_destroy(bus); } } TEST(BusAttachmentTest, disconnect) { QStatus status; alljoyn_busattachment bus; size_t i; QCC_BOOL allow_remote[2] = { QCC_FALSE, QCC_TRUE }; for (i = 0; i < ArraySize(allow_remote); i++) { status = ER_FAIL; bus = NULL; bus = alljoyn_busattachment_create("BusAttachmentTest", allow_remote[i]); status = alljoyn_busattachment_disconnect(bus, NULL); EXPECT_EQ(ER_BUS_BUS_NOT_STARTED, status); status = alljoyn_busattachment_start(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_FALSE(alljoyn_busattachment_isconnected(bus)); status = alljoyn_busattachment_disconnect(bus, NULL); EXPECT_EQ(ER_BUS_NOT_CONNECTED, status); status = alljoyn_busattachment_connect(bus, ajn::getConnectArg().c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); if (ER_OK == status) { EXPECT_TRUE(alljoyn_busattachment_isconnected(bus)); } status = alljoyn_busattachment_disconnect(bus, ajn::getConnectArg().c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); if (ER_OK == status) { EXPECT_FALSE(alljoyn_busattachment_isconnected(bus)); } status = alljoyn_busattachment_stop(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_destroy(bus); } } TEST(BusAttachmentTest, connect_null) { QStatus status = ER_OK; alljoyn_busattachment bus = NULL; bus = alljoyn_busattachment_create("BusAttachmentTest", QCC_TRUE); status = alljoyn_busattachment_start(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(bus, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_TRUE(alljoyn_busattachment_isconnected(bus)); const char* connectspec = alljoyn_busattachment_getconnectspec(bus); /* * The BusAttachment has joined either a separate daemon or it is using * the in process name service. If the internal name service is used * the connect spec will be 'null:' otherwise it will match the ConnectArg. */ EXPECT_TRUE(strcmp(ajn::getConnectArg().c_str(), connectspec) == 0 || strcmp("null:", connectspec) == 0); status = alljoyn_busattachment_stop(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_destroy(bus); } TEST(BusAttachmentTest, getconnectspec) { QStatus status = ER_OK; alljoyn_busattachment bus = NULL; bus = alljoyn_busattachment_create("BusAttachmentTest", QCC_TRUE); status = alljoyn_busattachment_start(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(bus, ajn::getConnectArg().c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); const char* connectspec = alljoyn_busattachment_getconnectspec(bus); /* * The BusAttachment has joined either a separate daemon or it is using * the in process name service. If the internal name service is used * the connect spec will be 'null:' otherwise it will match the ConnectArg. */ EXPECT_TRUE(strcmp(ajn::getConnectArg().c_str(), connectspec) == 0 || strcmp("null:", connectspec) == 0); status = alljoyn_busattachment_stop(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_destroy(bus); } TEST(BusAttachmentTest, getdbusobject) { QStatus status = ER_OK; alljoyn_busattachment bus = NULL; bus = alljoyn_busattachment_create("BusAttachmentTest", QCC_TRUE); status = alljoyn_busattachment_start(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(bus, ajn::getConnectArg().c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_proxybusobject dBusProxyObject = alljoyn_busattachment_getdbusproxyobj(bus); alljoyn_msgarg msgArgs = alljoyn_msgarg_array_create(2); status = alljoyn_msgarg_set(alljoyn_msgarg_array_element(msgArgs, 0), "s", "org.alljoyn.test.BusAttachment"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_msgarg_set(alljoyn_msgarg_array_element(msgArgs, 1), "u", 7u); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_message replyMsg = alljoyn_message_create(bus); status = alljoyn_proxybusobject_methodcall(dBusProxyObject, "org.freedesktop.DBus", "RequestName", msgArgs, 2, replyMsg, 25000, 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); unsigned int requestNameReply; alljoyn_msgarg reply = alljoyn_message_getarg(replyMsg, 0); alljoyn_msgarg_get(reply, "u", &requestNameReply); EXPECT_EQ(DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER, requestNameReply); alljoyn_msgarg_destroy(msgArgs); alljoyn_message_destroy(replyMsg); alljoyn_busattachment_destroy(bus); } TEST(BusAttachmentTest, ping_self) { QStatus status; alljoyn_busattachment bus = NULL; bus = alljoyn_busattachment_create("BusAttachmentTest", QCC_TRUE); status = alljoyn_busattachment_start(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(bus, ajn::getConnectArg().c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_EQ(ER_OK, alljoyn_busattachment_ping(bus, alljoyn_busattachment_getuniquename(bus), 1000)); alljoyn_busattachment_destroy(bus); } TEST(BusAttachmentTest, ping_other_on_same_bus) { QStatus status; alljoyn_busattachment bus = NULL; bus = alljoyn_busattachment_create("BusAttachmentTest", QCC_TRUE); status = alljoyn_busattachment_start(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(bus, ajn::getConnectArg().c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment otherbus = NULL; otherbus = alljoyn_busattachment_create("BusAttachment OtherBus", QCC_TRUE); status = alljoyn_busattachment_start(otherbus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(otherbus, ajn::getConnectArg().c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_EQ(ER_OK, alljoyn_busattachment_ping(bus, alljoyn_busattachment_getuniquename(otherbus), 1000)); status = alljoyn_busattachment_stop(otherbus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(otherbus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_destroy(otherbus); status = alljoyn_busattachment_stop(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_destroy(bus); } alljoyn-15.04b/alljoyn_c/unit_test/BusListenerMainThreadTest.cc000066400000000000000000000264231255700255500247050ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include "ajTestCommon.h" #include #include /*constants*/ //static const char* INTERFACE_NAME = "org.alljoyn.test.BusListenerMainThreadTest"; static const char* OBJECT_NAME = "org.alljoyn.test.BusListenerMainThreadTest"; //static const char* OBJECT_PATH = "/org/alljoyn/test/BusListenerMainThreadTest"; /* flags */ static QCC_BOOL listener_registered_flag = QCC_FALSE; static QCC_BOOL listener_unregistered_flag = QCC_FALSE; static QCC_BOOL found_advertised_name_flag = QCC_FALSE; static QCC_BOOL lost_advertised_name_flag = QCC_FALSE; static QCC_BOOL name_owner_changed_flag = QCC_FALSE; static QCC_BOOL bus_stopping_flag = QCC_FALSE; static QCC_BOOL bus_disconnected_flag = QCC_FALSE; /* bus listener functions */ static void AJ_CALL listener_registered(const void* context, alljoyn_busattachment bus) { QCC_UNUSED(context); QCC_UNUSED(bus); listener_registered_flag = QCC_TRUE; } static void AJ_CALL listener_unregistered(const void* context) { QCC_UNUSED(context); listener_unregistered_flag = QCC_TRUE; } static void AJ_CALL found_advertised_name(const void* context, const char* name, alljoyn_transportmask transport, const char* namePrefix) { QCC_UNUSED(context); QCC_UNUSED(name); QCC_UNUSED(transport); QCC_UNUSED(namePrefix); found_advertised_name_flag = QCC_TRUE; } static void AJ_CALL lost_advertised_name(const void* context, const char* name, alljoyn_transportmask transport, const char* namePrefix) { QCC_UNUSED(context); QCC_UNUSED(name); QCC_UNUSED(transport); QCC_UNUSED(namePrefix); lost_advertised_name_flag = QCC_TRUE; } static void AJ_CALL name_owner_changed(const void* context, const char* busName, const char* previousOwner, const char* newOwner) { QCC_UNUSED(context); QCC_UNUSED(busName); QCC_UNUSED(previousOwner); QCC_UNUSED(newOwner); name_owner_changed_flag = QCC_TRUE; } static void AJ_CALL bus_stopping(const void* context) { QCC_UNUSED(context); bus_stopping_flag = QCC_TRUE; } static void AJ_CALL bus_disconnected(const void* context) { QCC_UNUSED(context); bus_disconnected_flag = QCC_TRUE; } class BusListenerMainThreadTest : public testing::Test { public: virtual void SetUp() { alljoyn_unity_set_deferred_callback_mainthread_only(QCC_TRUE); resetFlags(); /* register bus listener */ alljoyn_buslistener_callbacks buslistenerCbs = { &listener_registered, &listener_unregistered, &found_advertised_name, &lost_advertised_name, &name_owner_changed, &bus_stopping, &bus_disconnected, NULL }; buslistener = alljoyn_buslistener_create(&buslistenerCbs, NULL); bus = alljoyn_busattachment_create("BusListenerMainThreadTest", QCC_FALSE); } virtual void TearDown() { EXPECT_NO_FATAL_FAILURE(alljoyn_buslistener_destroy(buslistener)); EXPECT_NO_FATAL_FAILURE(alljoyn_busattachment_destroy(bus)); alljoyn_unity_set_deferred_callback_mainthread_only(QCC_FALSE); //make sure the queued processes are cleared. alljoyn_unity_deferred_callbacks_process(); } void resetFlags() { listener_registered_flag = QCC_FALSE; listener_unregistered_flag = QCC_FALSE; found_advertised_name_flag = QCC_FALSE; lost_advertised_name_flag = QCC_FALSE; name_owner_changed_flag = QCC_FALSE; bus_stopping_flag = QCC_FALSE; bus_disconnected_flag = QCC_FALSE; } QStatus status; alljoyn_busattachment bus; alljoyn_buslistener buslistener; }; TEST_F(BusListenerMainThreadTest, listner_registered_unregistered) { alljoyn_busattachment_registerbuslistener(bus, buslistener); for (size_t i = 0; i < 200; ++i) { alljoyn_unity_deferred_callbacks_process(); if (listener_registered_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(listener_registered_flag); alljoyn_busattachment_unregisterbuslistener(bus, buslistener); for (size_t i = 0; i < 200; ++i) { alljoyn_unity_deferred_callbacks_process(); if (listener_unregistered_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(listener_unregistered_flag); } //ALLJOYN-1738 TEST_F(BusListenerMainThreadTest, DISABLED_bus_stopping_disconnected) { status = alljoyn_busattachment_start(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(bus, ajn::getConnectArg().c_str()); alljoyn_busattachment_registerbuslistener(bus, buslistener); for (size_t i = 0; i < 200; ++i) { alljoyn_unity_deferred_callbacks_process(); if (listener_registered_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(listener_registered_flag); alljoyn_busattachment_disconnect(bus, ajn::getConnectArg().c_str()); for (size_t i = 0; i < 200; ++i) { alljoyn_unity_deferred_callbacks_process(); if (bus_disconnected_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(bus_disconnected_flag); alljoyn_busattachment_stop(bus); for (size_t i = 0; i < 200; ++i) { alljoyn_unity_deferred_callbacks_process(); if (bus_stopping_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(bus_stopping_flag); alljoyn_busattachment_join(bus); alljoyn_busattachment_unregisterbuslistener(bus, buslistener); for (size_t i = 0; i < 200; ++i) { alljoyn_unity_deferred_callbacks_process(); if (listener_unregistered_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(listener_unregistered_flag); } // ALLJOYN-1738 TEST_F(BusListenerMainThreadTest, DISABLED_found_lost_advertised_name) { status = alljoyn_busattachment_start(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(bus, ajn::getConnectArg().c_str()); alljoyn_busattachment_registerbuslistener(bus, buslistener); for (size_t i = 0; i < 200; ++i) { alljoyn_unity_deferred_callbacks_process(); if (listener_registered_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(listener_registered_flag); alljoyn_sessionopts opts = alljoyn_sessionopts_create(ALLJOYN_TRAFFIC_TYPE_MESSAGES, QCC_FALSE, ALLJOYN_PROXIMITY_ANY, ALLJOYN_TRANSPORT_ANY); status = alljoyn_busattachment_findadvertisedname(bus, OBJECT_NAME); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_advertisename(bus, OBJECT_NAME, alljoyn_sessionopts_get_transports(opts)); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 200; ++i) { alljoyn_unity_deferred_callbacks_process(); if (found_advertised_name_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(found_advertised_name_flag); status = alljoyn_busattachment_canceladvertisename(bus, OBJECT_NAME, alljoyn_sessionopts_get_transports(opts)); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 200; ++i) { alljoyn_unity_deferred_callbacks_process(); if (lost_advertised_name_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(lost_advertised_name_flag); alljoyn_busattachment_stop(bus); for (size_t i = 0; i < 200; ++i) { alljoyn_unity_deferred_callbacks_process(); if (bus_stopping_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(bus_stopping_flag); alljoyn_busattachment_join(bus); /* the bus will automatically disconnect when it is stopped */ for (size_t i = 0; i < 200; ++i) { alljoyn_unity_deferred_callbacks_process(); if (bus_disconnected_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(bus_disconnected_flag); alljoyn_busattachment_unregisterbuslistener(bus, buslistener); for (size_t i = 0; i < 200; ++i) { alljoyn_unity_deferred_callbacks_process(); if (listener_unregistered_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(listener_unregistered_flag); status = alljoyn_busattachment_stop(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_sessionopts_destroy(opts); } // ALLJOYN-1738 TEST_F(BusListenerMainThreadTest, DISABLED_name_owner_changed) { status = alljoyn_busattachment_start(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(bus, ajn::getConnectArg().c_str()); alljoyn_busattachment_registerbuslistener(bus, buslistener); for (size_t i = 0; i < 200; ++i) { alljoyn_unity_deferred_callbacks_process(); if (listener_registered_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(listener_registered_flag); alljoyn_busattachment_requestname(bus, OBJECT_NAME, 0); for (size_t i = 0; i < 200; ++i) { alljoyn_unity_deferred_callbacks_process(); if (name_owner_changed_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(name_owner_changed_flag); alljoyn_busattachment_stop(bus); for (size_t i = 0; i < 200; ++i) { alljoyn_unity_deferred_callbacks_process(); if (bus_stopping_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(bus_stopping_flag); alljoyn_busattachment_join(bus); /* the bus will automatically disconnect when it is stopped */ for (size_t i = 0; i < 200; ++i) { alljoyn_unity_deferred_callbacks_process(); if (bus_disconnected_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(bus_disconnected_flag); alljoyn_busattachment_unregisterbuslistener(bus, buslistener); for (size_t i = 0; i < 200; ++i) { alljoyn_unity_deferred_callbacks_process(); if (listener_unregistered_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(listener_unregistered_flag); status = alljoyn_busattachment_stop(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); } alljoyn-15.04b/alljoyn_c/unit_test/BusListenerTest.cc000066400000000000000000000323641255700255500227510ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include "ajTestCommon.h" #include #include /* flags */ static QCC_BOOL listener_registered_flag = QCC_FALSE; static QCC_BOOL listener_unregistered_flag = QCC_FALSE; static QCC_BOOL found_advertised_name_flag = QCC_FALSE; static QCC_BOOL lost_advertised_name_flag = QCC_FALSE; static QCC_BOOL name_owner_changed_flag = QCC_FALSE; static QCC_BOOL bus_stopping_flag = QCC_FALSE; static QCC_BOOL bus_disconnected_flag = QCC_FALSE; static QCC_BOOL prop_changed_flag = QCC_FALSE; static alljoyn_transportmask transport_found = 0; /* bus listener functions */ static void AJ_CALL listener_registered(const void* context, alljoyn_busattachment bus) { QCC_UNUSED(context); QCC_UNUSED(bus); listener_registered_flag = QCC_TRUE; } static void AJ_CALL listener_unregistered(const void* context) { QCC_UNUSED(context); listener_unregistered_flag = QCC_TRUE; } static void AJ_CALL found_advertised_name(const void* context, const char* name, alljoyn_transportmask transport, const char* namePrefix) { QCC_UNUSED(context); QCC_UNUSED(name); QCC_UNUSED(namePrefix); transport_found |= transport; found_advertised_name_flag = QCC_TRUE; } static void AJ_CALL lost_advertised_name(const void* context, const char* name, alljoyn_transportmask transport, const char* namePrefix) { QCC_UNUSED(context); QCC_UNUSED(name); QCC_UNUSED(transport); QCC_UNUSED(namePrefix); lost_advertised_name_flag = QCC_TRUE; } static void AJ_CALL name_owner_changed(const void* context, const char* busName, const char* previousOwner, const char* newOwner) { QCC_UNUSED(context); QCC_UNUSED(busName); QCC_UNUSED(previousOwner); QCC_UNUSED(newOwner); name_owner_changed_flag = QCC_TRUE; } static void AJ_CALL bus_stopping(const void* context) { QCC_UNUSED(context); bus_stopping_flag = QCC_TRUE; } static void AJ_CALL bus_disconnected(const void* context) { QCC_UNUSED(context); bus_disconnected_flag = QCC_TRUE; } static void AJ_CALL bus_prop_changed(const void* context, const char* prop_name, alljoyn_msgarg prop_value) { QCC_UNUSED(context); QCC_UNUSED(prop_name); QCC_UNUSED(prop_value); prop_changed_flag = QCC_TRUE; } class BusListenerTest : public testing::Test { public: virtual void SetUp() { resetFlags(); /* register bus listener */ alljoyn_buslistener_callbacks buslistenerCbs = { &listener_registered, &listener_unregistered, &found_advertised_name, &lost_advertised_name, &name_owner_changed, &bus_stopping, &bus_disconnected, &bus_prop_changed }; buslistener = alljoyn_buslistener_create(&buslistenerCbs, NULL); bus = alljoyn_busattachment_create("BusListenerTest", QCC_FALSE); object_name = ajn::genUniqueName(bus); } virtual void TearDown() { EXPECT_NO_FATAL_FAILURE(alljoyn_buslistener_destroy(buslistener)); EXPECT_NO_FATAL_FAILURE(alljoyn_busattachment_destroy(bus)); } void resetFlags() { listener_registered_flag = QCC_FALSE; listener_unregistered_flag = QCC_FALSE; found_advertised_name_flag = QCC_FALSE; lost_advertised_name_flag = QCC_FALSE; name_owner_changed_flag = QCC_FALSE; bus_stopping_flag = QCC_FALSE; bus_disconnected_flag = QCC_FALSE; prop_changed_flag = QCC_FALSE; transport_found = 0; } QStatus status; alljoyn_busattachment bus; alljoyn_buslistener buslistener; qcc::String object_name; }; TEST_F(BusListenerTest, listner_registered_unregistered) { alljoyn_busattachment_registerbuslistener(bus, buslistener); for (size_t i = 0; i < 200; ++i) { if (listener_registered_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(listener_registered_flag); alljoyn_busattachment_unregisterbuslistener(bus, buslistener); for (size_t i = 0; i < 200; ++i) { if (listener_unregistered_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(listener_unregistered_flag); } TEST_F(BusListenerTest, bus_stopping_disconnected) { status = alljoyn_busattachment_start(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(bus, ajn::getConnectArg().c_str()); alljoyn_busattachment_registerbuslistener(bus, buslistener); for (size_t i = 0; i < 200; ++i) { if (listener_registered_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(listener_registered_flag); alljoyn_busattachment_disconnect(bus, ajn::getConnectArg().c_str()); for (size_t i = 0; i < 200; ++i) { if (bus_disconnected_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(bus_disconnected_flag); alljoyn_busattachment_stop(bus); for (size_t i = 0; i < 200; ++i) { if (bus_stopping_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(bus_stopping_flag); alljoyn_busattachment_join(bus); alljoyn_busattachment_unregisterbuslistener(bus, buslistener); for (size_t i = 0; i < 200; ++i) { if (listener_unregistered_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(listener_unregistered_flag); } TEST_F(BusListenerTest, found_lost_advertised_name) { status = alljoyn_busattachment_start(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(bus, ajn::getConnectArg().c_str()); alljoyn_busattachment_registerbuslistener(bus, buslistener); for (size_t i = 0; i < 200; ++i) { if (listener_registered_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(listener_registered_flag); alljoyn_sessionopts opts = alljoyn_sessionopts_create(ALLJOYN_TRAFFIC_TYPE_MESSAGES, QCC_FALSE, ALLJOYN_PROXIMITY_ANY, ALLJOYN_TRANSPORT_ANY); status = alljoyn_busattachment_findadvertisedname(bus, object_name.c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_advertisename(bus, object_name.c_str(), alljoyn_sessionopts_get_transports(opts)); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 200; ++i) { if (found_advertised_name_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(found_advertised_name_flag); status = alljoyn_busattachment_canceladvertisename(bus, object_name.c_str(), alljoyn_sessionopts_get_transports(opts)); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 200; ++i) { if (lost_advertised_name_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(lost_advertised_name_flag); alljoyn_busattachment_stop(bus); for (size_t i = 0; i < 200; ++i) { if (bus_stopping_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(bus_stopping_flag); alljoyn_busattachment_join(bus); /* the bus will automatically disconnect when it is stopped */ for (size_t i = 0; i < 200; ++i) { if (bus_disconnected_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(bus_disconnected_flag); alljoyn_busattachment_unregisterbuslistener(bus, buslistener); for (size_t i = 0; i < 200; ++i) { if (listener_unregistered_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(listener_unregistered_flag); status = alljoyn_busattachment_stop(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_sessionopts_destroy(opts); } TEST_F(BusListenerTest, found_name_by_transport) { status = alljoyn_busattachment_start(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(bus, ajn::getConnectArg().c_str()); alljoyn_busattachment_registerbuslistener(bus, buslistener); for (size_t i = 0; i < 200; ++i) { if (listener_registered_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(listener_registered_flag); alljoyn_sessionopts opts = alljoyn_sessionopts_create(ALLJOYN_TRAFFIC_TYPE_MESSAGES, QCC_FALSE, ALLJOYN_PROXIMITY_ANY, ALLJOYN_TRANSPORT_ANY); status = alljoyn_busattachment_findadvertisednamebytransport(bus, object_name.c_str(), ALLJOYN_TRANSPORT_LOCAL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_advertisename(bus, object_name.c_str(), alljoyn_sessionopts_get_transports(opts)); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 200; ++i) { if (found_advertised_name_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(found_advertised_name_flag); EXPECT_EQ(ALLJOYN_TRANSPORT_LOCAL, transport_found); status = alljoyn_busattachment_canceladvertisename(bus, object_name.c_str(), alljoyn_sessionopts_get_transports(opts)); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_cancelfindadvertisednamebytransport(bus, object_name.c_str(), ALLJOYN_TRANSPORT_LOCAL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); found_advertised_name_flag = QCC_FALSE; status = alljoyn_busattachment_advertisename(bus, object_name.c_str(), alljoyn_sessionopts_get_transports(opts)); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 50; ++i) { if (found_advertised_name_flag) { break; } qcc::Sleep(5); } EXPECT_FALSE(found_advertised_name_flag); alljoyn_busattachment_stop(bus); for (size_t i = 0; i < 200; ++i) { if (bus_stopping_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(bus_stopping_flag); alljoyn_busattachment_join(bus); /* the bus will automatically disconnect when it is stopped */ for (size_t i = 0; i < 200; ++i) { if (bus_disconnected_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(bus_disconnected_flag); alljoyn_busattachment_unregisterbuslistener(bus, buslistener); for (size_t i = 0; i < 200; ++i) { if (listener_unregistered_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(listener_unregistered_flag); status = alljoyn_busattachment_stop(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_sessionopts_destroy(opts); } TEST_F(BusListenerTest, name_owner_changed) { status = alljoyn_busattachment_start(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(bus, ajn::getConnectArg().c_str()); alljoyn_busattachment_registerbuslistener(bus, buslistener); for (size_t i = 0; i < 200; ++i) { if (listener_registered_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(listener_registered_flag); alljoyn_busattachment_requestname(bus, object_name.c_str(), 0); for (size_t i = 0; i < 200; ++i) { if (name_owner_changed_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(name_owner_changed_flag); alljoyn_busattachment_stop(bus); for (size_t i = 0; i < 200; ++i) { if (bus_stopping_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(bus_stopping_flag); alljoyn_busattachment_join(bus); /* the bus will automatically disconnect when it is stopped */ for (size_t i = 0; i < 200; ++i) { if (bus_disconnected_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(bus_disconnected_flag); alljoyn_busattachment_unregisterbuslistener(bus, buslistener); for (size_t i = 0; i < 200; ++i) { if (listener_unregistered_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(listener_unregistered_flag); status = alljoyn_busattachment_stop(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); } alljoyn-15.04b/alljoyn_c/unit_test/BusObjectTest.cc000066400000000000000000001334041255700255500223670ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #include #include "ajTestCommon.h" /*constants*/ static const char* INTERFACE_NAME = "org.alljoyn.test.BusObjectTest"; static const char* OBJECT_NAME = "org.alljoyn.test.BusObjectTest"; static const char* OBJECT_PATH = "/org/alljoyn/test/BusObjectTest"; /*********** BusObject callback functions **************/ static QCC_BOOL object_registered_flag = QCC_FALSE; static QCC_BOOL object_unregistered_flag = QCC_FALSE; static QCC_BOOL name_owner_changed_flag = QCC_FALSE; static QCC_BOOL prop_changed_flag = QCC_FALSE; static const char* prop1 = "AllJoyn BusObject Test"; //read only property static int32_t prop2; //write only property static uint32_t prop3; //RW property static QStatus AJ_CALL get_property(const void* context, const char* ifcName, const char* propName, alljoyn_msgarg val) { QCC_UNUSED(context); EXPECT_STREQ(INTERFACE_NAME, ifcName); QStatus status = ER_OK; if (0 == strcmp("prop1", propName)) { alljoyn_msgarg_set(val, "s", prop1); } else if (0 == strcmp("prop2", propName)) { alljoyn_msgarg_set(val, "i", prop2); } else if (0 == strcmp("prop3", propName)) { alljoyn_msgarg_set(val, "u", prop3); } else { status = ER_BUS_NO_SUCH_PROPERTY; } return status; } static QStatus AJ_CALL set_property(const void* context, const char* ifcName, const char* propName, alljoyn_msgarg val) { QCC_UNUSED(context); EXPECT_STREQ(INTERFACE_NAME, ifcName); QStatus status = ER_OK; if (0 == strcmp("prop1", propName)) { alljoyn_msgarg_get(val, "s", &prop1); } else if (0 == strcmp("prop2", propName)) { alljoyn_msgarg_get(val, "i", &prop2); } else if (0 == strcmp("prop3", propName)) { alljoyn_msgarg_get(val, "u", &prop3); } else { status = ER_BUS_NO_SUCH_PROPERTY; } return status; } static void AJ_CALL busobject_registered(const void* context) { QCC_UNUSED(context); object_registered_flag = QCC_TRUE; } static void AJ_CALL busobject_unregistered(const void* context) { QCC_UNUSED(context); object_unregistered_flag = QCC_TRUE; } /* NameOwnerChanged callback */ static void AJ_CALL name_owner_changed(const void* context, const char* busName, const char* previousOwner, const char* newOwner) { QCC_UNUSED(context); QCC_UNUSED(previousOwner); QCC_UNUSED(newOwner); if (strcmp(busName, OBJECT_NAME) == 0) { name_owner_changed_flag = QCC_TRUE; } } /* Property changed callback */ static void AJ_CALL obj_prop_changed(alljoyn_proxybusobject obj, const char* iface_name, alljoyn_msgarg changed, alljoyn_msgarg invalidated, void* context) { QCC_UNUSED(obj); QCC_UNUSED(iface_name); QCC_UNUSED(context); alljoyn_msgarg argList; size_t argListSize; QStatus status = ER_FAIL; //default state is failure ASSERT_TRUE(invalidated); // Invalidated properties status = alljoyn_msgarg_get(invalidated, "as", &argListSize, &argList); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); if (argListSize > 0) { EXPECT_EQ(1UL, argListSize); ASSERT_TRUE(argList); for (size_t index = 0; index < argListSize; index++) { char* propName; ASSERT_TRUE(alljoyn_msgarg_array_element(argList, index)); status = alljoyn_msgarg_get(alljoyn_msgarg_array_element(argList, index), "s", &propName); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(propName); EXPECT_STREQ("prop2", propName); } } ASSERT_TRUE(changed); // Changed properties status = alljoyn_msgarg_get(changed, "a{sv}", &argListSize, &argList); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); if (argListSize > 0) { EXPECT_EQ(1UL, argListSize); ASSERT_TRUE(argList); for (size_t index = 0; index < argListSize; index++) { char* propName; alljoyn_msgarg valueArg; uint32_t value; ASSERT_TRUE(alljoyn_msgarg_array_element(argList, index)); status = alljoyn_msgarg_get(alljoyn_msgarg_array_element(argList, index), "{sv}", &propName, &valueArg); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(propName); EXPECT_STREQ("prop3", propName); status = alljoyn_msgarg_get(valueArg, "u", &value); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_EQ(prop3, value); } } prop_changed_flag = QCC_TRUE; } /************* Method handlers *************/ static QCC_BOOL chirp_method_flag = QCC_FALSE; /* Exposed methods */ static void AJ_CALL ping_method(alljoyn_busobject bus, const alljoyn_interfacedescription_member* member, alljoyn_message msg) { QCC_UNUSED(member); alljoyn_msgarg outArg = alljoyn_msgarg_create(); alljoyn_msgarg inArg = alljoyn_message_getarg(msg, 0); const char* str; alljoyn_msgarg_get(inArg, "s", &str); alljoyn_msgarg_set(outArg, "s", str); QStatus status = alljoyn_busobject_methodreply_args(bus, msg, outArg, 1); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg_destroy(outArg); } static void AJ_CALL chirp_method(alljoyn_busobject bus, const alljoyn_interfacedescription_member* member, alljoyn_message msg) { QCC_UNUSED(member); alljoyn_msgarg outArg = alljoyn_msgarg_create(); alljoyn_msgarg inArg = alljoyn_message_getarg(msg, 0); const char* str; alljoyn_msgarg_get(inArg, "s", &str); alljoyn_msgarg_set(outArg, "s", str); QStatus status = alljoyn_busobject_methodreply_args(bus, msg, NULL, 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); chirp_method_flag = QCC_TRUE; alljoyn_msgarg_destroy(outArg); } class BusObjectTest : public testing::Test { public: virtual void SetUp() { object_registered_flag = QCC_FALSE; object_unregistered_flag = QCC_TRUE; bus = alljoyn_busattachment_create("ProxyBusObjectTest", false); status = alljoyn_busattachment_start(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(bus, ajn::getConnectArg().c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); } virtual void TearDown() { EXPECT_NO_FATAL_FAILURE(alljoyn_busattachment_destroy(bus)); } void SetUpBusObjectTestService() { /* create/start/connect alljoyn_busattachment */ servicebus = alljoyn_busattachment_create("ProxyBusObjectTestservice", false); status = alljoyn_busattachment_start(servicebus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(servicebus, ajn::getConnectArg().c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription testIntf = NULL; status = alljoyn_busattachment_createinterface(servicebus, INTERFACE_NAME, &testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(testIntf != NULL); status = alljoyn_interfacedescription_addproperty(testIntf, "prop1", "s", ALLJOYN_PROP_ACCESS_READ); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_interfacedescription_addproperty(testIntf, "prop2", "i", ALLJOYN_PROP_ACCESS_WRITE); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_interfacedescription_addproperty(testIntf, "prop3", "u", ALLJOYN_PROP_ACCESS_RW); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription_activate(testIntf); /* Initialize properties to a known value*/ prop2 = -32; prop3 = 42; /* register bus listener */ alljoyn_buslistener_callbacks buslistenerCbs = { NULL, NULL, NULL, NULL, &name_owner_changed, NULL, NULL, NULL }; buslistener = alljoyn_buslistener_create(&buslistenerCbs, NULL); alljoyn_busattachment_registerbuslistener(servicebus, buslistener); /* Set up bus object */ alljoyn_busobject_callbacks busObjCbs = { &get_property, &set_property, &busobject_registered, &busobject_unregistered }; testObj = alljoyn_busobject_create(OBJECT_PATH, QCC_FALSE, &busObjCbs, NULL); status = alljoyn_busobject_addinterface(testObj, testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_registerbusobject(servicebus, testObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 200; ++i) { if (object_registered_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(object_registered_flag); name_owner_changed_flag = QCC_FALSE; /* request name */ uint32_t flags = DBUS_NAME_FLAG_REPLACE_EXISTING | DBUS_NAME_FLAG_DO_NOT_QUEUE; status = alljoyn_busattachment_requestname(servicebus, OBJECT_NAME, flags); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 200; ++i) { if (name_owner_changed_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(name_owner_changed_flag); } void TearDownBusObjectTestService() { /* * must destroy the busattachment before destroying the buslistener or * the code will segfault when the code tries to call the bus_stopping * callback. */ alljoyn_busattachment_destroy(servicebus); alljoyn_buslistener_destroy(buslistener); alljoyn_busobject_destroy(testObj); } QStatus status; alljoyn_busattachment bus; alljoyn_busobject testObj; alljoyn_busattachment servicebus; alljoyn_buslistener buslistener; }; TEST_F(BusObjectTest, object_registered_unregistered) { /* Set up bus object */ alljoyn_busobject_callbacks busObjCbs = { &get_property, &set_property, &busobject_registered, &busobject_unregistered }; alljoyn_busobject testObj = alljoyn_busobject_create(OBJECT_PATH, QCC_FALSE, &busObjCbs, NULL); status = alljoyn_busattachment_registerbusobject(bus, testObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 200; ++i) { if (object_registered_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(object_registered_flag); alljoyn_busattachment_unregisterbusobject(bus, testObj); for (size_t i = 0; i < 200; ++i) { if (object_unregistered_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(object_unregistered_flag); alljoyn_busobject_destroy(testObj); alljoyn_busattachment_stop(bus); alljoyn_busattachment_join(bus); } TEST_F(BusObjectTest, get_property_handler) { SetUpBusObjectTestService(); alljoyn_proxybusobject proxyObj = alljoyn_proxybusobject_create(bus, OBJECT_NAME, OBJECT_PATH, 0); EXPECT_TRUE(proxyObj); status = alljoyn_proxybusobject_introspectremoteobject(proxyObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg value = alljoyn_msgarg_create(); status = alljoyn_proxybusobject_getproperty(proxyObj, INTERFACE_NAME, "prop1", value); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); const char*str; status = alljoyn_msgarg_get(value, "s", &str); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ(prop1, str); alljoyn_msgarg_destroy(value); /* should fail to read a write only property*/ value = alljoyn_msgarg_create(); status = alljoyn_proxybusobject_getproperty(proxyObj, INTERFACE_NAME, "prop2", value); EXPECT_EQ(ER_BUS_REPLY_IS_ERROR_MESSAGE, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg_destroy(value); value = alljoyn_msgarg_create(); status = alljoyn_proxybusobject_getproperty(proxyObj, INTERFACE_NAME, "prop3", value); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); uint32_t return_value; status = alljoyn_msgarg_get(value, "u", &return_value); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_EQ((uint32_t)42, return_value); alljoyn_msgarg_destroy(value); alljoyn_proxybusobject_destroy(proxyObj); TearDownBusObjectTestService(); } TEST_F(BusObjectTest, set_property_handler) { SetUpBusObjectTestService(); alljoyn_proxybusobject proxyObj = alljoyn_proxybusobject_create(bus, OBJECT_NAME, OBJECT_PATH, 0); EXPECT_TRUE(proxyObj); status = alljoyn_proxybusobject_introspectremoteobject(proxyObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* should fail to write a read only property*/ alljoyn_msgarg value = alljoyn_msgarg_create_and_set("s", "This should not work."); status = alljoyn_proxybusobject_setproperty(proxyObj, INTERFACE_NAME, "prop1", value); EXPECT_EQ(ER_BUS_PROPERTY_ACCESS_DENIED, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg_destroy(value); value = alljoyn_msgarg_create_and_set("i", -888); status = alljoyn_proxybusobject_setproperty(proxyObj, INTERFACE_NAME, "prop2", value); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_EQ(-888, prop2); alljoyn_msgarg_destroy(value); value = alljoyn_msgarg_create_and_set("u", 98); status = alljoyn_proxybusobject_setproperty(proxyObj, INTERFACE_NAME, "prop3", value); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_EQ((uint32_t)98, prop3); alljoyn_msgarg_destroy(value); alljoyn_proxybusobject_destroy(proxyObj); TearDownBusObjectTestService(); } TEST_F(BusObjectTest, getall_properties) { SetUpBusObjectTestService(); alljoyn_proxybusobject proxyObj = alljoyn_proxybusobject_create(bus, OBJECT_NAME, OBJECT_PATH, 0); EXPECT_TRUE(proxyObj); status = alljoyn_proxybusobject_introspectremoteobject(proxyObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg value = alljoyn_msgarg_create(); status = alljoyn_proxybusobject_getallproperties(proxyObj, INTERFACE_NAME, value); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg variant_arg; const char* str; status = alljoyn_msgarg_getdictelement(value, "{sv}", "prop1", &variant_arg); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_msgarg_get(variant_arg, "s", &str); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ(prop1, str); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); uint32_t num; status = alljoyn_msgarg_getdictelement(value, "{sv}", "prop3", &variant_arg); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_msgarg_get(variant_arg, "u", &num); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_EQ((uint32_t)42, num); alljoyn_msgarg_destroy(value); alljoyn_proxybusobject_destroy(proxyObj); TearDownBusObjectTestService(); } TEST_F(BusObjectTest, property_changed_signal) { /* create/start/connect alljoyn_busattachment */ servicebus = alljoyn_busattachment_create("ProxyBusObjectTestservice", false); status = alljoyn_busattachment_start(servicebus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(servicebus, ajn::getConnectArg().c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription testIntf = NULL; status = alljoyn_busattachment_createinterface(servicebus, INTERFACE_NAME, &testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(testIntf != NULL); status = alljoyn_interfacedescription_addproperty(testIntf, "prop2", "i", ALLJOYN_PROP_ACCESS_RW); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_interfacedescription_addpropertyannotation(testIntf, "prop2", "org.freedesktop.DBus.Property.EmitsChangedSignal", "invalidates"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_interfacedescription_addproperty(testIntf, "prop3", "u", ALLJOYN_PROP_ACCESS_RW); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_interfacedescription_addpropertyannotation(testIntf, "prop3", "org.freedesktop.DBus.Property.EmitsChangedSignal", "true"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription_activate(testIntf); /* Initialize properties to a known value*/ prop2 = -32; prop3 = 42; /* register bus listener */ alljoyn_buslistener_callbacks buslistenerCbs = { NULL, NULL, NULL, NULL, &name_owner_changed, NULL, NULL, NULL }; buslistener = alljoyn_buslistener_create(&buslistenerCbs, NULL); alljoyn_busattachment_registerbuslistener(servicebus, buslistener); /* Set up bus object */ alljoyn_busobject_callbacks busObjCbs = { &get_property, &set_property, &busobject_registered, &busobject_unregistered }; testObj = alljoyn_busobject_create(OBJECT_PATH, QCC_FALSE, &busObjCbs, NULL); status = alljoyn_busobject_addinterface(testObj, testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_registerbusobject(servicebus, testObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 200; ++i) { if (object_registered_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(object_registered_flag); name_owner_changed_flag = QCC_FALSE; /* request name */ uint32_t flags = DBUS_NAME_FLAG_REPLACE_EXISTING | DBUS_NAME_FLAG_DO_NOT_QUEUE; status = alljoyn_busattachment_requestname(servicebus, OBJECT_NAME, flags); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 200; ++i) { if (name_owner_changed_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(name_owner_changed_flag); prop_changed_flag = QCC_FALSE; const char* props[] = { "prop2", "prop3" }; alljoyn_proxybusobject proxyObj = alljoyn_proxybusobject_create(bus, OBJECT_NAME, OBJECT_PATH, 0); EXPECT_TRUE(proxyObj); status = alljoyn_proxybusobject_introspectremoteobject(proxyObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_proxybusobject_registerpropertieschangedlistener(proxyObj, INTERFACE_NAME, props, sizeof(props) / sizeof(props[0]), obj_prop_changed, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg value; prop_changed_flag = QCC_FALSE; value = alljoyn_msgarg_create_and_set("i", -888); status = alljoyn_proxybusobject_setproperty(proxyObj, INTERFACE_NAME, "prop2", value); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 200; ++i) { if (prop_changed_flag) { break; } qcc::Sleep(5); } EXPECT_FALSE(prop_changed_flag); EXPECT_EQ(-888, prop2); alljoyn_msgarg_destroy(value); prop_changed_flag = QCC_FALSE; value = alljoyn_msgarg_create_and_set("u", 98); status = alljoyn_proxybusobject_setproperty(proxyObj, INTERFACE_NAME, "prop3", value); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 200; ++i) { if (prop_changed_flag) { break; } qcc::Sleep(5); } EXPECT_EQ((uint32_t)98, prop3); EXPECT_FALSE(prop_changed_flag); alljoyn_msgarg_destroy(value); prop_changed_flag = QCC_FALSE; const char* propNames[] = { "prop2", "prop3" }; size_t numProps = sizeof(propNames) / sizeof(propNames[0]); alljoyn_busobject_emitpropertieschanged(testObj, INTERFACE_NAME, propNames, numProps, 0); for (size_t i = 0; i < 200; ++i) { if (prop_changed_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(prop_changed_flag); alljoyn_proxybusobject_destroy(proxyObj); TearDownBusObjectTestService(); } TEST_F(BusObjectTest, addmethodhandler) { /* create/start/connect alljoyn_busattachment */ servicebus = alljoyn_busattachment_create("ProxyBusObjectTestservice", false); status = alljoyn_busattachment_start(servicebus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(servicebus, ajn::getConnectArg().c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* create/activate alljoyn_interface */ alljoyn_interfacedescription testIntf = NULL; status = alljoyn_busattachment_createinterface(servicebus, INTERFACE_NAME, &testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(testIntf != NULL); status = alljoyn_interfacedescription_addmethod(testIntf, "ping", "s", "s", "in,out", 0, 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_interfacedescription_addmethod(testIntf, "chirp", "s", "", "chirp", 0, 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription_activate(testIntf); /* register bus listener */ alljoyn_buslistener_callbacks buslistenerCbs = { NULL, NULL, NULL, NULL, &name_owner_changed, NULL, NULL }; buslistener = alljoyn_buslistener_create(&buslistenerCbs, NULL); alljoyn_busattachment_registerbuslistener(servicebus, buslistener); /* Set up bus object */ alljoyn_busobject_callbacks busObjCbs = { NULL, NULL, NULL, NULL }; alljoyn_busobject testObj = alljoyn_busobject_create(OBJECT_PATH, QCC_FALSE, &busObjCbs, NULL); const alljoyn_interfacedescription exampleIntf = alljoyn_busattachment_getinterface(servicebus, INTERFACE_NAME); ASSERT_TRUE(exampleIntf); status = alljoyn_busobject_addinterface(testObj, exampleIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* register method handlers */ alljoyn_interfacedescription_member ping_member; QCC_BOOL foundMember = alljoyn_interfacedescription_getmember(exampleIntf, "ping", &ping_member); EXPECT_TRUE(foundMember); alljoyn_interfacedescription_member chirp_member; foundMember = alljoyn_interfacedescription_getmember(exampleIntf, "chirp", &chirp_member); EXPECT_TRUE(foundMember); status = alljoyn_busobject_addmethodhandler(testObj, ping_member, &ping_method, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busobject_addmethodhandler(testObj, chirp_member, &chirp_method, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_registerbusobject(servicebus, testObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); name_owner_changed_flag = QCC_FALSE; /* request name */ uint32_t flags = DBUS_NAME_FLAG_REPLACE_EXISTING | DBUS_NAME_FLAG_DO_NOT_QUEUE; status = alljoyn_busattachment_requestname(servicebus, OBJECT_NAME, flags); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 200; ++i) { if (name_owner_changed_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(name_owner_changed_flag); /* call methods */ alljoyn_proxybusobject proxyObj = alljoyn_proxybusobject_create(bus, OBJECT_NAME, OBJECT_PATH, 0); EXPECT_TRUE(proxyObj); status = alljoyn_proxybusobject_introspectremoteobject(proxyObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_message reply = alljoyn_message_create(bus); alljoyn_msgarg input = alljoyn_msgarg_create_and_set("s", "AllJoyn"); status = alljoyn_proxybusobject_methodcall(proxyObj, INTERFACE_NAME, "ping", input, 1, reply, ALLJOYN_MESSAGE_DEFAULT_TIMEOUT, 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); const char* str; alljoyn_msgarg_get(alljoyn_message_getarg(reply, 0), "s", &str); EXPECT_STREQ("AllJoyn", str); chirp_method_flag = QCC_FALSE; status = alljoyn_proxybusobject_methodcall(proxyObj, INTERFACE_NAME, "chirp", input, 1, reply, ALLJOYN_MESSAGE_DEFAULT_TIMEOUT, 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 200; ++i) { if (chirp_method_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(chirp_method_flag); alljoyn_message_destroy(reply); alljoyn_msgarg_destroy(input); alljoyn_proxybusobject_destroy(proxyObj); /* cleanup */ alljoyn_busattachment_destroy(servicebus); alljoyn_buslistener_destroy(buslistener); alljoyn_busobject_destroy(testObj); } TEST_F(BusObjectTest, addmethodhandlers) { /* create/start/connect alljoyn_busattachment */ servicebus = alljoyn_busattachment_create("ProxyBusObjectTestservice", false); status = alljoyn_busattachment_start(servicebus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(servicebus, ajn::getConnectArg().c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* create/activate alljoyn_interface */ alljoyn_interfacedescription testIntf = NULL; status = alljoyn_busattachment_createinterface(servicebus, INTERFACE_NAME, &testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(testIntf != NULL); status = alljoyn_interfacedescription_addmethod(testIntf, "ping", "s", "s", "in,out", 0, 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_interfacedescription_addmethod(testIntf, "chirp", "s", "", "chirp", 0, 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription_activate(testIntf); /* register bus listener */ alljoyn_buslistener_callbacks buslistenerCbs = { NULL, NULL, NULL, NULL, &name_owner_changed, NULL, NULL }; buslistener = alljoyn_buslistener_create(&buslistenerCbs, NULL); alljoyn_busattachment_registerbuslistener(servicebus, buslistener); /* Set up bus object */ alljoyn_busobject_callbacks busObjCbs = { NULL, NULL, NULL, NULL }; alljoyn_busobject testObj = alljoyn_busobject_create(OBJECT_PATH, QCC_FALSE, &busObjCbs, NULL); const alljoyn_interfacedescription exampleIntf = alljoyn_busattachment_getinterface(servicebus, INTERFACE_NAME); ASSERT_TRUE(exampleIntf); status = alljoyn_busobject_addinterface(testObj, exampleIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* register method handlers */ alljoyn_interfacedescription_member ping_member; QCC_BOOL foundMember = alljoyn_interfacedescription_getmember(exampleIntf, "ping", &ping_member); EXPECT_TRUE(foundMember); alljoyn_interfacedescription_member chirp_member; foundMember = alljoyn_interfacedescription_getmember(exampleIntf, "chirp", &chirp_member); EXPECT_TRUE(foundMember); /* add methodhandlers */ alljoyn_busobject_methodentry methodEntries[] = { { &chirp_member, chirp_method }, { &ping_member, ping_method }, }; status = alljoyn_busobject_addmethodhandlers(testObj, methodEntries, sizeof(methodEntries) / sizeof(methodEntries[0])); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_registerbusobject(servicebus, testObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); name_owner_changed_flag = QCC_FALSE; /* request name */ uint32_t flags = DBUS_NAME_FLAG_REPLACE_EXISTING | DBUS_NAME_FLAG_DO_NOT_QUEUE; status = alljoyn_busattachment_requestname(servicebus, OBJECT_NAME, flags); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 200; ++i) { if (name_owner_changed_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(name_owner_changed_flag); /* call methods */ alljoyn_proxybusobject proxyObj = alljoyn_proxybusobject_create(bus, OBJECT_NAME, OBJECT_PATH, 0); EXPECT_TRUE(proxyObj); status = alljoyn_proxybusobject_introspectremoteobject(proxyObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_message reply = alljoyn_message_create(bus); alljoyn_msgarg input = alljoyn_msgarg_create_and_set("s", "AllJoyn"); status = alljoyn_proxybusobject_methodcall(proxyObj, INTERFACE_NAME, "ping", input, 1, reply, ALLJOYN_MESSAGE_DEFAULT_TIMEOUT, 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); const char* str; alljoyn_msgarg_get(alljoyn_message_getarg(reply, 0), "s", &str); EXPECT_STREQ("AllJoyn", str); chirp_method_flag = QCC_FALSE; status = alljoyn_proxybusobject_methodcall(proxyObj, INTERFACE_NAME, "chirp", input, 1, reply, ALLJOYN_MESSAGE_DEFAULT_TIMEOUT, 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 200; ++i) { if (chirp_method_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(chirp_method_flag); alljoyn_message_destroy(reply); alljoyn_msgarg_destroy(input); alljoyn_proxybusobject_destroy(proxyObj); /* cleanup */ alljoyn_busattachment_destroy(servicebus); alljoyn_buslistener_destroy(buslistener); alljoyn_busobject_destroy(testObj); } TEST_F(BusObjectTest, addmethodhandler_addmethodhandlers_mix) { /* create/start/connect alljoyn_busattachment */ servicebus = alljoyn_busattachment_create("ProxyBusObjectTestservice", false); status = alljoyn_busattachment_start(servicebus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(servicebus, ajn::getConnectArg().c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* create/activate alljoyn_interface */ alljoyn_interfacedescription testIntf = NULL; status = alljoyn_busattachment_createinterface(servicebus, INTERFACE_NAME, &testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(testIntf != NULL); status = alljoyn_interfacedescription_addmethod(testIntf, "ping", "s", "s", "in,out", 0, 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_interfacedescription_addmethod(testIntf, "chirp", "s", "", "chirp", 0, 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription_activate(testIntf); /* register bus listener */ alljoyn_buslistener_callbacks buslistenerCbs = { NULL, NULL, NULL, NULL, &name_owner_changed, NULL, NULL }; buslistener = alljoyn_buslistener_create(&buslistenerCbs, NULL); alljoyn_busattachment_registerbuslistener(servicebus, buslistener); /* Set up bus object */ alljoyn_busobject_callbacks busObjCbs = { NULL, NULL, NULL, NULL }; alljoyn_busobject testObj = alljoyn_busobject_create(OBJECT_PATH, QCC_FALSE, &busObjCbs, NULL); const alljoyn_interfacedescription exampleIntf = alljoyn_busattachment_getinterface(servicebus, INTERFACE_NAME); ASSERT_TRUE(exampleIntf); status = alljoyn_busobject_addinterface(testObj, exampleIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* register method handlers */ alljoyn_interfacedescription_member ping_member; QCC_BOOL foundMember = alljoyn_interfacedescription_getmember(exampleIntf, "ping", &ping_member); EXPECT_TRUE(foundMember); alljoyn_interfacedescription_member chirp_member; foundMember = alljoyn_interfacedescription_getmember(exampleIntf, "chirp", &chirp_member); EXPECT_TRUE(foundMember); /* add methodhandlers */ alljoyn_busobject_methodentry methodEntries[] = { { &chirp_member, chirp_method }, }; status = alljoyn_busobject_addmethodhandlers(testObj, methodEntries, sizeof(methodEntries) / sizeof(methodEntries[0])); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busobject_addmethodhandler(testObj, ping_member, &ping_method, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_registerbusobject(servicebus, testObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); name_owner_changed_flag = QCC_FALSE; /* request name */ uint32_t flags = DBUS_NAME_FLAG_REPLACE_EXISTING | DBUS_NAME_FLAG_DO_NOT_QUEUE; status = alljoyn_busattachment_requestname(servicebus, OBJECT_NAME, flags); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 200; ++i) { if (name_owner_changed_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(name_owner_changed_flag); /* call methods */ alljoyn_proxybusobject proxyObj = alljoyn_proxybusobject_create(bus, OBJECT_NAME, OBJECT_PATH, 0); EXPECT_TRUE(proxyObj); status = alljoyn_proxybusobject_introspectremoteobject(proxyObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_message reply = alljoyn_message_create(bus); alljoyn_msgarg input = alljoyn_msgarg_create_and_set("s", "AllJoyn"); status = alljoyn_proxybusobject_methodcall(proxyObj, INTERFACE_NAME, "ping", input, 1, reply, ALLJOYN_MESSAGE_DEFAULT_TIMEOUT, 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); const char* str; alljoyn_msgarg_get(alljoyn_message_getarg(reply, 0), "s", &str); EXPECT_STREQ("AllJoyn", str); chirp_method_flag = QCC_FALSE; status = alljoyn_proxybusobject_methodcall(proxyObj, INTERFACE_NAME, "chirp", input, 1, reply, ALLJOYN_MESSAGE_DEFAULT_TIMEOUT, 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 200; ++i) { if (chirp_method_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(chirp_method_flag); alljoyn_message_destroy(reply); alljoyn_msgarg_destroy(input); alljoyn_proxybusobject_destroy(proxyObj); /* cleanup */ alljoyn_busattachment_destroy(servicebus); alljoyn_buslistener_destroy(buslistener); alljoyn_busobject_destroy(testObj); } static QCC_BOOL getpropertycb_flag = QCC_FALSE; static void AJ_CALL getpropertycb_prop1(QStatus status, alljoyn_proxybusobject obj, const alljoyn_msgarg value, void* context) { QCC_UNUSED(obj); const char*str; status = alljoyn_msgarg_get(value, "s", &str); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ(prop1, str); EXPECT_STREQ("AllJoyn Test String.", (char*)context); getpropertycb_flag = QCC_TRUE; } static void AJ_CALL getpropertycb_prop2(QStatus status, alljoyn_proxybusobject obj, const alljoyn_msgarg value, void* context) { QCC_UNUSED(obj); QCC_UNUSED(value); EXPECT_EQ(ER_BUS_PROPERTY_ACCESS_DENIED, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("AllJoyn Test String.", (char*)context); getpropertycb_flag = QCC_TRUE; } static void AJ_CALL getpropertycb_prop3(QStatus status, alljoyn_proxybusobject obj, const alljoyn_msgarg value, void* context) { QCC_UNUSED(obj); uint32_t return_value; status = alljoyn_msgarg_get(value, "u", &return_value); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_EQ((uint32_t)42, return_value); EXPECT_STREQ("AllJoyn Test String.", (char*)context); getpropertycb_flag = QCC_TRUE; } TEST_F(BusObjectTest, get_propertyasync_handler) { SetUpBusObjectTestService(); alljoyn_proxybusobject proxyObj = alljoyn_proxybusobject_create(bus, OBJECT_NAME, OBJECT_PATH, 0); EXPECT_TRUE(proxyObj); status = alljoyn_proxybusobject_introspectremoteobject(proxyObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); getpropertycb_flag = QCC_FALSE; //make sure the flag is in a known state. status = alljoyn_proxybusobject_getpropertyasync(proxyObj, INTERFACE_NAME, "prop1", &getpropertycb_prop1, ALLJOYN_MESSAGE_DEFAULT_TIMEOUT, (void*)"AllJoyn Test String."); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); //Wait up to 2 seconds for the getproperty call to complete. for (int i = 0; i < 200; ++i) { if (getpropertycb_flag) { break; } qcc::Sleep(10); } EXPECT_TRUE(getpropertycb_flag); /* should fail to read a write only property*/ getpropertycb_flag = QCC_FALSE; //make sure the flag is in a known state. status = alljoyn_proxybusobject_getpropertyasync(proxyObj, INTERFACE_NAME, "prop2", &getpropertycb_prop2, ALLJOYN_MESSAGE_DEFAULT_TIMEOUT, (void*)"AllJoyn Test String."); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); //Wait up to 2 seconds for the getproperty call to complete. for (int i = 0; i < 200; ++i) { if (getpropertycb_flag) { break; } qcc::Sleep(10); } EXPECT_TRUE(getpropertycb_flag); getpropertycb_flag = QCC_FALSE; //make sure the flag is in a known state. status = alljoyn_proxybusobject_getpropertyasync(proxyObj, INTERFACE_NAME, "prop3", &getpropertycb_prop3, ALLJOYN_MESSAGE_DEFAULT_TIMEOUT, (void*)"AllJoyn Test String."); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); //Wait up to 2 seconds for the getproperty call to complete. for (int i = 0; i < 200; ++i) { if (getpropertycb_flag) { break; } qcc::Sleep(10); } EXPECT_TRUE(getpropertycb_flag); alljoyn_proxybusobject_destroy(proxyObj); TearDownBusObjectTestService(); } static QCC_BOOL setpropertycb_flag = QCC_FALSE; static void AJ_CALL setpropertycb_prop1(QStatus status, alljoyn_proxybusobject obj, void* context) { QCC_UNUSED(obj); EXPECT_EQ(ER_BUS_PROPERTY_ACCESS_DENIED, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("AllJoyn Test String.", (char*)context); setpropertycb_flag = QCC_TRUE; } static void AJ_CALL setpropertycb_prop2(QStatus status, alljoyn_proxybusobject obj, void* context) { QCC_UNUSED(obj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("AllJoyn Test String.", (char*)context); setpropertycb_flag = QCC_TRUE; } TEST_F(BusObjectTest, set_propertyasync_handler) { SetUpBusObjectTestService(); alljoyn_proxybusobject proxyObj = alljoyn_proxybusobject_create(bus, OBJECT_NAME, OBJECT_PATH, 0); EXPECT_TRUE(proxyObj); status = alljoyn_proxybusobject_introspectremoteobject(proxyObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); setpropertycb_flag = QCC_FALSE; /* should fail to write a read only property*/ alljoyn_msgarg value = alljoyn_msgarg_create_and_set("s", "This should not work."); status = alljoyn_proxybusobject_setpropertyasync(proxyObj, INTERFACE_NAME, "prop1", value, &setpropertycb_prop1, ALLJOYN_MESSAGE_DEFAULT_TIMEOUT, (void*)"AllJoyn Test String."); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); //Wait up to 2 seconds for the getproperty call to complete. for (int i = 0; i < 200; ++i) { if (setpropertycb_flag) { break; } qcc::Sleep(10); } EXPECT_TRUE(setpropertycb_flag); alljoyn_msgarg_destroy(value); setpropertycb_flag = QCC_FALSE; value = alljoyn_msgarg_create_and_set("i", -888); status = alljoyn_proxybusobject_setpropertyasync(proxyObj, INTERFACE_NAME, "prop2", value, &setpropertycb_prop2, ALLJOYN_MESSAGE_DEFAULT_TIMEOUT, (void*)"AllJoyn Test String."); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); //Wait up to 2 seconds for the getproperty call to complete. for (int i = 0; i < 200; ++i) { if (setpropertycb_flag) { break; } qcc::Sleep(10); } EXPECT_TRUE(setpropertycb_flag); EXPECT_EQ(-888, prop2); alljoyn_msgarg_destroy(value); setpropertycb_flag = QCC_FALSE; value = alljoyn_msgarg_create_and_set("u", 98); //reusing the setpropertycb_prop2 we expect this callback to have the exact same results. status = alljoyn_proxybusobject_setpropertyasync(proxyObj, INTERFACE_NAME, "prop3", value, &setpropertycb_prop2, ALLJOYN_MESSAGE_DEFAULT_TIMEOUT, (void*)"AllJoyn Test String."); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); //Wait up to 2 seconds for the getproperty call to complete. for (int i = 0; i < 200; ++i) { if (setpropertycb_flag) { break; } qcc::Sleep(10); } EXPECT_TRUE(setpropertycb_flag); EXPECT_EQ((uint32_t)98, prop3); alljoyn_msgarg_destroy(value); alljoyn_proxybusobject_destroy(proxyObj); TearDownBusObjectTestService(); } static QCC_BOOL getallpropertiescb_flag = QCC_FALSE; static void AJ_CALL getallpropertiescb(QStatus status, alljoyn_proxybusobject obj, const alljoyn_msgarg values, void* context) { QCC_UNUSED(obj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg variant_arg; const char* str; status = alljoyn_msgarg_getdictelement(values, "{sv}", "prop1", &variant_arg); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_msgarg_get(variant_arg, "s", &str); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ(prop1, str); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); uint32_t num; status = alljoyn_msgarg_getdictelement(values, "{sv}", "prop3", &variant_arg); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_msgarg_get(variant_arg, "u", &num); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_EQ((uint32_t)42, num); EXPECT_STREQ("AllJoyn Test String.", (char*)context); getallpropertiescb_flag = QCC_TRUE; } TEST_F(BusObjectTest, getallpropertiesasync) { SetUpBusObjectTestService(); alljoyn_proxybusobject proxyObj = alljoyn_proxybusobject_create(bus, OBJECT_NAME, OBJECT_PATH, 0); EXPECT_TRUE(proxyObj); status = alljoyn_proxybusobject_introspectremoteobject(proxyObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); //alljoyn_msgarg value = alljoyn_msgarg_create(); getallpropertiescb_flag = QCC_FALSE; status = alljoyn_proxybusobject_getallpropertiesasync(proxyObj, INTERFACE_NAME, &getallpropertiescb, ALLJOYN_MESSAGE_DEFAULT_TIMEOUT, (void*)"AllJoyn Test String."); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); //Wait up to 2 seconds for the getproperty call to complete. for (int i = 0; i < 200; ++i) { if (getallpropertiescb_flag) { break; } qcc::Sleep(10); } EXPECT_TRUE(getallpropertiescb_flag); alljoyn_proxybusobject_destroy(proxyObj); TearDownBusObjectTestService(); } TEST_F(BusObjectTest, getbusattachment) { SetUpBusObjectTestService(); /* the testObj was registered with the servicebus. */ alljoyn_busattachment returnbus = alljoyn_busobject_getbusattachment(testObj); EXPECT_STREQ(alljoyn_busattachment_getglobalguidstring(servicebus), alljoyn_busattachment_getglobalguidstring(returnbus)); TearDownBusObjectTestService(); } alljoyn-15.04b/alljoyn_c/unit_test/ConcurrentCallbackTest.cc000066400000000000000000000152121255700255500242420ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include "ajTestCommon.h" #include #include #include #include #include static alljoyn_busattachment s_bus; static const char* OBJECT_NAME = "org.alljoyn.test.BusAttachmentTest"; static QCC_BOOL name_owner_changed_flag = QCC_FALSE; static QCC_BOOL listener_registered_flag = QCC_FALSE; static void AJ_CALL listener_registered(const void* context, alljoyn_busattachment s_bus) { QCC_UNUSED(context); QCC_UNUSED(s_bus); listener_registered_flag = QCC_TRUE; } static void AJ_CALL name_owner_changed_blocking_call(const void* context, const char* busName, const char* previousOwner, const char* newOwner) { QCC_UNUSED(context); QCC_UNUSED(busName); QCC_UNUSED(previousOwner); QCC_UNUSED(newOwner); QStatus status = ER_FAIL; alljoyn_proxybusobject proxyObj = alljoyn_proxybusobject_create(s_bus, "org.alljoyn.Bus", "/org/alljoyn/Bus", 0); EXPECT_TRUE(proxyObj); status = alljoyn_proxybusobject_introspectremoteobject(proxyObj); EXPECT_EQ(ER_BUS_BLOCKING_CALL_NOT_ALLOWED, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_NO_FATAL_FAILURE(alljoyn_proxybusobject_destroy(proxyObj)); name_owner_changed_flag = QCC_TRUE; } TEST(ConcurrentCallbackTest, enableconcurrentcallbacks_not_used) { QStatus status = ER_FAIL; name_owner_changed_flag = QCC_FALSE; listener_registered_flag = QCC_FALSE; /* register bus listener */ alljoyn_buslistener_callbacks buslistenerCbs = { &listener_registered, NULL, //listener_unregistered NULL, //found_advertised_name NULL, //lost_advertised_name &name_owner_changed_blocking_call, //name_owner_changed NULL, //bus_stopping NULL, //bus_disconnected NULL //prop_changed }; alljoyn_buslistener buslistener = alljoyn_buslistener_create(&buslistenerCbs, NULL); s_bus = alljoyn_busattachment_create("BusListenerTest", QCC_FALSE); status = alljoyn_busattachment_start(s_bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(s_bus, ajn::getConnectArg().c_str()); alljoyn_busattachment_registerbuslistener(s_bus, buslistener); for (size_t i = 0; i < 200; ++i) { if (listener_registered_flag) { break; } qcc::Sleep(50); } EXPECT_TRUE(listener_registered_flag); status = alljoyn_busattachment_requestname(s_bus, OBJECT_NAME, 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 200; ++i) { if (name_owner_changed_flag) { break; } qcc::Sleep(50); } EXPECT_TRUE(name_owner_changed_flag); status = alljoyn_busattachment_stop(s_bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(s_bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_destroy(s_bus); alljoyn_buslistener_destroy(buslistener); } static void AJ_CALL name_owner_changed_enableconcurrentcallbacks(const void* context, const char* busName, const char* previousOwner, const char* newOwner) { QCC_UNUSED(context); QCC_UNUSED(busName); QCC_UNUSED(previousOwner); QCC_UNUSED(newOwner); QStatus status = ER_FAIL; alljoyn_proxybusobject proxyObj = alljoyn_proxybusobject_create(s_bus, "org.alljoyn.Bus", "/org/alljoyn/Bus", 0); EXPECT_TRUE(proxyObj); alljoyn_busattachment_enableconcurrentcallbacks(s_bus); status = alljoyn_proxybusobject_introspectremoteobject(proxyObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_NO_FATAL_FAILURE(alljoyn_proxybusobject_destroy(proxyObj)); name_owner_changed_flag = QCC_TRUE; } TEST(ConcurrentCallbackTest, enableconcurrentcallbacks_used) { QStatus status = ER_FAIL; name_owner_changed_flag = QCC_FALSE; listener_registered_flag = QCC_FALSE; /* register bus listener */ alljoyn_buslistener_callbacks buslistenerCbs = { &listener_registered, NULL, //listener_unregistered NULL, //found_advertised_name NULL, //lost_advertised_name &name_owner_changed_enableconcurrentcallbacks, //name_owner_changed NULL, //bus_stopping NULL, //bus_disconnected NULL //prop_changed }; alljoyn_buslistener buslistener = alljoyn_buslistener_create(&buslistenerCbs, NULL); s_bus = alljoyn_busattachment_create("BusListenerTest", QCC_FALSE); status = alljoyn_busattachment_start(s_bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(s_bus, ajn::getConnectArg().c_str()); alljoyn_busattachment_registerbuslistener(s_bus, buslistener); for (size_t i = 0; i < 200; ++i) { if (listener_registered_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(listener_registered_flag); alljoyn_busattachment_requestname(s_bus, OBJECT_NAME, 0); for (size_t i = 0; i < 200; ++i) { if (name_owner_changed_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(name_owner_changed_flag); status = alljoyn_busattachment_stop(s_bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(s_bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_destroy(s_bus); alljoyn_buslistener_destroy(buslistener); } alljoyn-15.04b/alljoyn_c/unit_test/InterfaceDescriptionTest.cc000066400000000000000000002137611255700255500246200ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include /* Add canary values before and after output string buffers, to detect typical overruns/underruns */ #define CANARY_SIZE (sizeof(void*)) /* Using a macro rather than of a function allows EXPECT_EQ to print the correct source code line number of the VERIFY_CANARY_VALUES caller */ #define VERIFY_CANARY_VALUES(buffer, stringSize, canaryByte) \ { \ uint32_t byteIndex; \ char* localBuffer = (buffer); \ \ /* Check for underruns */ \ for (byteIndex = 0; byteIndex < CANARY_SIZE; byteIndex += 1) { \ EXPECT_EQ((canaryByte), *localBuffer); \ localBuffer += 1; \ } \ \ /* Check for overruns */ \ localBuffer += (stringSize); \ \ for (byteIndex = 0; byteIndex < CANARY_SIZE; byteIndex += 1) { \ EXPECT_EQ((canaryByte), *localBuffer); \ localBuffer += 1; \ } \ } TEST(InterfaceDescriptionTest, addmember) { QStatus status = ER_OK; alljoyn_busattachment bus = NULL; bus = alljoyn_busattachment_create("InterfaceDescriptionTest", QCC_FALSE); ASSERT_TRUE(bus != NULL); alljoyn_interfacedescription testIntf = NULL; status = alljoyn_busattachment_createinterface(bus, "org.alljoyn.test.InterfaceDescription", &testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(testIntf != NULL); status = alljoyn_interfacedescription_addmember(testIntf, ALLJOYN_MESSAGE_METHOD_CALL, "ping", "s", "s", "in,out", 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_interfacedescription_addmember(testIntf, ALLJOYN_MESSAGE_SIGNAL, "chirp", "", "s", "chirp", 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_destroy(bus); } TEST(InterfaceDescriptionTest, getmember) { QStatus status = ER_OK; alljoyn_busattachment bus = NULL; bus = alljoyn_busattachment_create("InterfaceDescriptionTest", QCC_FALSE); ASSERT_TRUE(bus != NULL); alljoyn_interfacedescription testIntf = NULL; status = alljoyn_busattachment_createinterface(bus, "org.alljoyn.test.InterfaceDescription", &testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(testIntf != NULL); status = alljoyn_interfacedescription_addmember(testIntf, ALLJOYN_MESSAGE_METHOD_CALL, "ping", "s", "s", "in,out", 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_interfacedescription_addmember(testIntf, ALLJOYN_MESSAGE_SIGNAL, "chirp", "s", NULL, "chirp", 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription_member member; EXPECT_TRUE(alljoyn_interfacedescription_getmember(testIntf, "ping", &member)); EXPECT_EQ(testIntf, member.iface); EXPECT_EQ(ALLJOYN_MESSAGE_METHOD_CALL, member.memberType); EXPECT_STREQ("ping", member.name); EXPECT_STREQ("s", member.signature); EXPECT_STREQ("s", member.returnSignature); EXPECT_STREQ("in,out", member.argNames); size_t annotation_count; annotation_count = alljoyn_interfacedescription_member_getannotationscount(member); EXPECT_EQ((size_t)0, annotation_count); alljoyn_interfacedescription_member member2; EXPECT_TRUE(alljoyn_interfacedescription_getmember(testIntf, "chirp", &member2)); EXPECT_EQ(testIntf, member2.iface); EXPECT_EQ(ALLJOYN_MESSAGE_SIGNAL, member2.memberType); EXPECT_STREQ("chirp", member2.name); EXPECT_STREQ("s", member2.signature); EXPECT_STREQ("", member2.returnSignature); EXPECT_STREQ("chirp", member2.argNames); annotation_count = alljoyn_interfacedescription_member_getannotationscount(member2); EXPECT_EQ((size_t)0, annotation_count); alljoyn_busattachment_destroy(bus); } TEST(InterfaceDescriptionTest, getmembers) { QStatus status = ER_OK; alljoyn_busattachment bus = NULL; bus = alljoyn_busattachment_create("InterfaceDescriptionTest", QCC_FALSE); ASSERT_TRUE(bus != NULL); alljoyn_interfacedescription testIntf = NULL; status = alljoyn_busattachment_createinterface(bus, "org.alljoyn.test.InterfaceDescription", &testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(testIntf != NULL); status = alljoyn_interfacedescription_addmember(testIntf, ALLJOYN_MESSAGE_METHOD_CALL, "ping", "s", "s", "in,out", 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_interfacedescription_addmember(testIntf, ALLJOYN_MESSAGE_SIGNAL, "chirp", "s", NULL, "chirp", 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription_member member[6]; size_t size; size = alljoyn_interfacedescription_getmembers(testIntf, NULL, 0); EXPECT_EQ((size_t)2, size); size = alljoyn_interfacedescription_getmembers(testIntf, member, 6); EXPECT_EQ((size_t)2, size); /* * NOTE there is nothing that specifies the order the members are organized * when they are added to the interface. As can be seen here even though * the 'chirp' signal was added to the interface after 'ping' it comes out * of the interface before 'ping'. This result is based on actual program * behaver. */ EXPECT_EQ(testIntf, member[0].iface); EXPECT_EQ(ALLJOYN_MESSAGE_SIGNAL, member[0].memberType); EXPECT_STREQ("chirp", member[0].name); EXPECT_STREQ("s", member[0].signature); EXPECT_STREQ("", member[0].returnSignature); EXPECT_STREQ("chirp", member[0].argNames); size_t annotation_count; annotation_count = alljoyn_interfacedescription_member_getannotationscount(member[0]); EXPECT_EQ((size_t)0, annotation_count); EXPECT_EQ(testIntf, member[1].iface); EXPECT_EQ(ALLJOYN_MESSAGE_METHOD_CALL, member[1].memberType); EXPECT_STREQ("ping", member[1].name); EXPECT_STREQ("s", member[1].signature); EXPECT_STREQ("s", member[1].returnSignature); EXPECT_STREQ("in,out", member[1].argNames); annotation_count = alljoyn_interfacedescription_member_getannotationscount(member[1]); EXPECT_EQ((size_t)0, annotation_count); alljoyn_busattachment_destroy(bus); } TEST(InterfaceDescriptionTest, hasmembers) { QStatus status = ER_OK; alljoyn_busattachment bus = NULL; bus = alljoyn_busattachment_create("InterfaceDescriptionTest", QCC_FALSE); ASSERT_TRUE(bus != NULL); alljoyn_interfacedescription testIntf = NULL; status = alljoyn_busattachment_createinterface(bus, "org.alljoyn.test.InterfaceDescription", &testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(testIntf != NULL); status = alljoyn_interfacedescription_addmember(testIntf, ALLJOYN_MESSAGE_METHOD_CALL, "ping", "s", "s", "in,out", 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_interfacedescription_addmember(testIntf, ALLJOYN_MESSAGE_SIGNAL, "chirp", "s", NULL, "chirp", 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_TRUE(alljoyn_interfacedescription_hasmember(testIntf, "ping", "s", "s")); EXPECT_TRUE(alljoyn_interfacedescription_hasmember(testIntf, "chirp", "s", NULL)); /* * expected to be false even though the members exist the signatures do not * match what is expected. */ EXPECT_FALSE(alljoyn_interfacedescription_hasmember(testIntf, "ping", "i", "s")); EXPECT_FALSE(alljoyn_interfacedescription_hasmember(testIntf, "chirp", "b", NULL)); EXPECT_FALSE(alljoyn_interfacedescription_hasmember(testIntf, "invalid", "s", NULL)); alljoyn_busattachment_destroy(bus); } TEST(InterfaceDescriptionTest, activate) { QStatus status = ER_OK; alljoyn_busattachment bus = NULL; bus = alljoyn_busattachment_create("InterfaceDescriptionTest", QCC_FALSE); alljoyn_interfacedescription testIntf = NULL; status = alljoyn_busattachment_createinterface(bus, "org.alljoyn.test.InterfaceDescription", &testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(testIntf != NULL); status = alljoyn_interfacedescription_addmember(testIntf, ALLJOYN_MESSAGE_METHOD_CALL, "ping", "s", "s", "in,out", 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_interfacedescription_addmember(testIntf, ALLJOYN_MESSAGE_SIGNAL, "chirp", "", "s", "chirp", 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription_activate(testIntf); /* once the interface has been activated we should not be able to add new members */ status = alljoyn_interfacedescription_addmember(testIntf, ALLJOYN_MESSAGE_METHOD_CALL, "pong", "s", "s", "in,out", 0); EXPECT_EQ(ER_BUS_INTERFACE_ACTIVATED, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment_destroy(bus); } TEST(InterfaceDescriptionTest, introspect) { QStatus status = ER_OK; alljoyn_busattachment bus = NULL; bus = alljoyn_busattachment_create("InterfaceDescriptionTest", QCC_FALSE); alljoyn_interfacedescription testIntf = NULL; status = alljoyn_busattachment_createinterface(bus, "org.alljoyn.test.InterfaceDescription", &testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(testIntf != NULL); status = alljoyn_interfacedescription_addmember(testIntf, ALLJOYN_MESSAGE_METHOD_CALL, "ping", "s", "s", "in,out", 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_interfacedescription_addmember(testIntf, ALLJOYN_MESSAGE_SIGNAL, "chirp", "", "s", "chirp", 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); char* introspect; size_t bufSize = alljoyn_interfacedescription_introspect(testIntf, NULL, 0, 0); introspect = (char*)malloc((sizeof(char) * bufSize) + (2 * CANARY_SIZE)); memset(introspect, 'A', bufSize + (2 * CANARY_SIZE)); size_t bufSize2 = alljoyn_interfacedescription_introspect(testIntf, introspect + CANARY_SIZE, bufSize, 0); EXPECT_EQ(bufSize, bufSize2); /* * NOTE there is nothing that specifies the order the members are organized * when they are added to the interface. As can be seen here even though * the 'chirp' signal was added to the interface after 'ping' it is listed * before 'ping'. This result is based on actual program behaver. */ const char* expectedIntrospect = "\n" " \n" " \n" " \n" " \n" " \n" " \n" " \n" "\n"; EXPECT_STREQ(expectedIntrospect, introspect + CANARY_SIZE); VERIFY_CANARY_VALUES(introspect, bufSize, 'A'); memset(introspect, 'B', bufSize + (2 * CANARY_SIZE)); size_t badBufSize = 0; bufSize2 = alljoyn_interfacedescription_introspect(testIntf, introspect + CANARY_SIZE, badBufSize, 0); EXPECT_EQ(bufSize, bufSize2); VERIFY_CANARY_VALUES(introspect, bufSize, 'B'); memset(introspect, 'C', bufSize + (2 * CANARY_SIZE)); size_t tooSmallSize = 1; bufSize2 = alljoyn_interfacedescription_introspect(testIntf, introspect + CANARY_SIZE, tooSmallSize, 0); EXPECT_EQ(bufSize, bufSize2); EXPECT_STREQ("", introspect + CANARY_SIZE); //empty string instead of expectedIntrospect VERIFY_CANARY_VALUES(introspect, bufSize, 'C'); memset(introspect, 'D', bufSize + (2 * CANARY_SIZE)); tooSmallSize = 2; bufSize2 = alljoyn_interfacedescription_introspect(testIntf, introspect + CANARY_SIZE, tooSmallSize, 0); EXPECT_EQ(bufSize, bufSize2); EXPECT_STREQ("<", introspect + CANARY_SIZE); //first character of expectedIntrospect VERIFY_CANARY_VALUES(introspect, bufSize, 'D'); free(introspect); alljoyn_busattachment_destroy(bus); } TEST(InterfaceDescriptionTest, issecure) { QStatus status = ER_OK; alljoyn_busattachment bus = NULL; bus = alljoyn_busattachment_create("InterfaceDescriptionTest", QCC_FALSE); alljoyn_interfacedescription testIntf = NULL; status = alljoyn_busattachment_createinterface_secure(bus, "org.alljoyn.test.InterfaceDescription", &testIntf, AJ_IFC_SECURITY_REQUIRED); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(testIntf != NULL); EXPECT_EQ(QCC_TRUE, alljoyn_interfacedescription_issecure(testIntf)); status = alljoyn_busattachment_deleteinterface(bus, testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_createinterface(bus, "org.alljoyn.test.InterfaceDescription", &testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(testIntf != NULL); EXPECT_EQ(QCC_FALSE, alljoyn_interfacedescription_issecure(testIntf)); alljoyn_busattachment_destroy(bus); } TEST(InterfaceDescriptionTest, addproperty) { QStatus status = ER_OK; alljoyn_busattachment bus = NULL; bus = alljoyn_busattachment_create("InterfaceDescriptionTest", QCC_FALSE); alljoyn_interfacedescription testIntf = NULL; status = alljoyn_busattachment_createinterface(bus, "org.alljoyn.test.InterfaceDescription", &testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(testIntf != NULL); status = alljoyn_interfacedescription_addproperty(testIntf, "prop1", "s", ALLJOYN_PROP_ACCESS_READ); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_interfacedescription_addproperty(testIntf, "prop2", "i", ALLJOYN_PROP_ACCESS_WRITE); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_interfacedescription_addproperty(testIntf, "prop3", "u", ALLJOYN_PROP_ACCESS_RW); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); char* introspect; size_t buf = alljoyn_interfacedescription_introspect(testIntf, NULL, 0, 0); buf++; introspect = (char*)malloc(sizeof(char) * buf); alljoyn_interfacedescription_introspect(testIntf, introspect, buf, 0); const char* expectedIntrospect = "\n" " \n" " \n" " \n" "\n"; EXPECT_STREQ(expectedIntrospect, introspect); free(introspect); alljoyn_busattachment_destroy(bus); } TEST(InterfaceDescriptionTest, hasproperty) { QStatus status = ER_OK; alljoyn_busattachment bus = NULL; bus = alljoyn_busattachment_create("InterfaceDescriptionTest", QCC_FALSE); alljoyn_interfacedescription testIntf = NULL; status = alljoyn_busattachment_createinterface(bus, "org.alljoyn.test.InterfaceDescription", &testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(testIntf != NULL); status = alljoyn_interfacedescription_addproperty(testIntf, "prop1", "s", ALLJOYN_PROP_ACCESS_READ); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_interfacedescription_addproperty(testIntf, "prop2", "i", ALLJOYN_PROP_ACCESS_WRITE); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_interfacedescription_addproperty(testIntf, "prop3", "u", ALLJOYN_PROP_ACCESS_RW); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_TRUE(alljoyn_interfacedescription_hasproperty(testIntf, "prop1")); EXPECT_TRUE(alljoyn_interfacedescription_hasproperty(testIntf, "prop2")); EXPECT_TRUE(alljoyn_interfacedescription_hasproperty(testIntf, "prop3")); EXPECT_FALSE(alljoyn_interfacedescription_hasproperty(testIntf, "invalid_prop")); alljoyn_busattachment_destroy(bus); } TEST(InterfaceDescriptionTest, hasproperties) { QStatus status = ER_OK; alljoyn_busattachment bus = NULL; bus = alljoyn_busattachment_create("InterfaceDescriptionTest", QCC_FALSE); alljoyn_interfacedescription testIntf = NULL; status = alljoyn_busattachment_createinterface(bus, "org.alljoyn.test.InterfaceDescription", &testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(testIntf != NULL); /* * At this point this is an empty interface the call to hasproperties should * return false. */ EXPECT_FALSE(alljoyn_interfacedescription_hasproperties(testIntf)); status = alljoyn_interfacedescription_addmember(testIntf, ALLJOYN_MESSAGE_METHOD_CALL, "ping", "s", "s", "in,out", 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* * At this point the interface only contains a method call the call to * hasproperties should return false. */ EXPECT_FALSE(alljoyn_interfacedescription_hasproperties(testIntf)); status = alljoyn_interfacedescription_addproperty(testIntf, "prop1", "s", ALLJOYN_PROP_ACCESS_READ); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* * At this point the interface only contains a property the call to * hasproperties should return true. */ EXPECT_TRUE(alljoyn_interfacedescription_hasproperties(testIntf)); status = alljoyn_interfacedescription_addproperty(testIntf, "prop2", "i", ALLJOYN_PROP_ACCESS_WRITE); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_interfacedescription_addproperty(testIntf, "prop3", "u", ALLJOYN_PROP_ACCESS_RW); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* * At this point the interface only contains multiple properties the call to * hasproperties should return true. */ EXPECT_TRUE(alljoyn_interfacedescription_hasproperties(testIntf)); alljoyn_busattachment_destroy(bus); } TEST(InterfaceDescriptionTest, getname) { QStatus status; alljoyn_busattachment bus = NULL; bus = alljoyn_busattachment_create("InterfaceDescriptionTest", QCC_FALSE); alljoyn_interfacedescription testIntf = NULL; status = alljoyn_busattachment_createinterface(bus, "org.alljoyn.test.InterfaceDescription", &testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("org.alljoyn.test.InterfaceDescription", alljoyn_interfacedescription_getname(testIntf)); alljoyn_busattachment_destroy(bus); } TEST(InterfaceDescriptionTest, addmethod) { QStatus status = ER_OK; alljoyn_busattachment bus = NULL; bus = alljoyn_busattachment_create("InterfaceDescriptionTest", QCC_FALSE); alljoyn_interfacedescription testIntf = NULL; status = alljoyn_busattachment_createinterface(bus, "org.alljoyn.test.InterfaceDescription", &testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(testIntf != NULL); status = alljoyn_interfacedescription_addmethod(testIntf, "method1", "ss", "b", "string1,string2,bool", 0, 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); char* introspect; size_t buf = alljoyn_interfacedescription_introspect(testIntf, NULL, 0, 0); buf++; introspect = (char*)malloc(sizeof(char) * buf); alljoyn_interfacedescription_introspect(testIntf, introspect, buf, 0); const char* expectedIntrospect = "\n" " \n" " \n" " \n" " \n" " \n" "\n"; EXPECT_STREQ(expectedIntrospect, introspect); free(introspect); alljoyn_busattachment_destroy(bus); } TEST(InterfaceDescriptionTest, getmethod) { QStatus status = ER_OK; alljoyn_busattachment bus = NULL; bus = alljoyn_busattachment_create("InterfaceDescriptionTest", QCC_FALSE); alljoyn_interfacedescription testIntf = NULL; status = alljoyn_busattachment_createinterface(bus, "org.alljoyn.test.InterfaceDescription", &testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(testIntf != NULL); status = alljoyn_interfacedescription_addmethod(testIntf, "method1", "ss", "b", "string1,string2,bool", 0, 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription_member member; EXPECT_TRUE(alljoyn_interfacedescription_getmethod(testIntf, "method1", &member)); EXPECT_EQ(testIntf, member.iface); EXPECT_EQ(ALLJOYN_MESSAGE_METHOD_CALL, member.memberType); EXPECT_STREQ("method1", member.name); EXPECT_STREQ("ss", member.signature); EXPECT_STREQ("b", member.returnSignature); EXPECT_STREQ("string1,string2,bool", member.argNames); size_t annotation_count; annotation_count = alljoyn_interfacedescription_member_getannotationscount(member); EXPECT_EQ((size_t)0, annotation_count); EXPECT_FALSE(alljoyn_interfacedescription_getmethod(testIntf, "invalid", &member)); /* * since we have not called alljoyn_interfacedescription_activate it is * possible to continue to add new members to the interface. */ status = alljoyn_interfacedescription_addsignal(testIntf, "signal1", "s", "string", 0, 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* * get method should return false when trying to get a signal */ EXPECT_FALSE(alljoyn_interfacedescription_getmethod(testIntf, "signal1", &member)); alljoyn_busattachment_destroy(bus); } TEST(InterfaceDescriptionTest, addsignal) { QStatus status = ER_OK; alljoyn_busattachment bus = NULL; bus = alljoyn_busattachment_create("InterfaceDescriptionTest", QCC_FALSE); alljoyn_interfacedescription testIntf = NULL; status = alljoyn_busattachment_createinterface(bus, "org.alljoyn.test.InterfaceDescription", &testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(testIntf != NULL); status = alljoyn_interfacedescription_addsignal(testIntf, "signal1", "s", "string", 0, 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); char* introspect; size_t buf = alljoyn_interfacedescription_introspect(testIntf, NULL, 0, 0); buf++; introspect = (char*)malloc(sizeof(char) * buf); alljoyn_interfacedescription_introspect(testIntf, introspect, buf, 0); const char* expectedIntrospect = "\n" " \n" " \n" " \n" "\n"; EXPECT_STREQ(expectedIntrospect, introspect); free(introspect); alljoyn_busattachment_destroy(bus); } TEST(InterfaceDescriptionTest, getsignal) { QStatus status = ER_OK; alljoyn_busattachment bus = NULL; bus = alljoyn_busattachment_create("InterfaceDescriptionTest", QCC_FALSE); alljoyn_interfacedescription testIntf = NULL; status = alljoyn_busattachment_createinterface(bus, "org.alljoyn.test.InterfaceDescription", &testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(testIntf != NULL); status = alljoyn_interfacedescription_addsignal(testIntf, "signal1", "s", "string", 0, 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription_member member; EXPECT_TRUE(alljoyn_interfacedescription_getsignal(testIntf, "signal1", &member)); EXPECT_EQ(testIntf, member.iface); EXPECT_EQ(ALLJOYN_MESSAGE_SIGNAL, member.memberType); EXPECT_STREQ("signal1", member.name); EXPECT_STREQ("s", member.signature); EXPECT_STREQ("", member.returnSignature); EXPECT_STREQ("string", member.argNames); size_t annotation_count; annotation_count = alljoyn_interfacedescription_member_getannotationscount(member); EXPECT_EQ((size_t)0, annotation_count); EXPECT_FALSE(alljoyn_interfacedescription_getsignal(testIntf, "invalid", &member)); /* * since we have not called alljoyn_interfacedescription_activate it is * possible to continue to add new members to the interface. */ status = alljoyn_interfacedescription_addmethod(testIntf, "method1", "ss", "b", "string1,string2,bool", 0, 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_FALSE(alljoyn_interfacedescription_getsignal(testIntf, "method1", &member)); alljoyn_busattachment_destroy(bus); } TEST(InterfaceDescriptionTest, getproperty) { QStatus status = ER_OK; alljoyn_busattachment bus = NULL; bus = alljoyn_busattachment_create("InterfaceDescriptionTest", QCC_FALSE); alljoyn_interfacedescription testIntf = NULL; status = alljoyn_busattachment_createinterface(bus, "org.alljoyn.test.InterfaceDescription", &testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(testIntf != NULL); status = alljoyn_interfacedescription_addproperty(testIntf, "prop1", "s", ALLJOYN_PROP_ACCESS_READ); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_interfacedescription_addproperty(testIntf, "prop2", "i", ALLJOYN_PROP_ACCESS_WRITE); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_interfacedescription_addproperty(testIntf, "prop3", "u", ALLJOYN_PROP_ACCESS_RW); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription_property propa; EXPECT_TRUE(alljoyn_interfacedescription_getproperty(testIntf, "prop1", &propa)); EXPECT_STREQ("prop1", propa.name); EXPECT_STREQ("s", propa.signature); EXPECT_EQ(ALLJOYN_PROP_ACCESS_READ, propa.access); alljoyn_interfacedescription_property propb; EXPECT_TRUE(alljoyn_interfacedescription_getproperty(testIntf, "prop2", &propb)); EXPECT_STREQ("prop2", propb.name); EXPECT_STREQ("i", propb.signature); EXPECT_EQ(ALLJOYN_PROP_ACCESS_WRITE, propb.access); alljoyn_interfacedescription_property propc; EXPECT_TRUE(alljoyn_interfacedescription_getproperty(testIntf, "prop3", &propc)); EXPECT_STREQ("prop3", propc.name); EXPECT_STREQ("u", propc.signature); EXPECT_EQ(ALLJOYN_PROP_ACCESS_RW, propc.access); alljoyn_busattachment_destroy(bus); } TEST(InterfaceDescriptionTest, getproperties) { QStatus status = ER_OK; alljoyn_busattachment bus = NULL; bus = alljoyn_busattachment_create("InterfaceDescriptionTest", QCC_FALSE); alljoyn_interfacedescription testIntf = NULL; status = alljoyn_busattachment_createinterface(bus, "org.alljoyn.test.InterfaceDescription", &testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(testIntf != NULL); status = alljoyn_interfacedescription_addproperty(testIntf, "prop1", "s", ALLJOYN_PROP_ACCESS_READ); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_interfacedescription_addproperty(testIntf, "prop2", "i", ALLJOYN_PROP_ACCESS_WRITE); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_interfacedescription_addproperty(testIntf, "prop3", "u", ALLJOYN_PROP_ACCESS_RW); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription_property prop[6]; size_t size = 0; size = alljoyn_interfacedescription_getproperties(testIntf, NULL, 0); EXPECT_EQ((size_t)3, size); size = alljoyn_interfacedescription_getproperties(testIntf, prop, 6); EXPECT_EQ((size_t)3, size); EXPECT_STREQ("prop1", prop[0].name); EXPECT_STREQ("s", prop[0].signature); EXPECT_EQ(ALLJOYN_PROP_ACCESS_READ, prop[0].access); EXPECT_STREQ("prop2", prop[1].name); EXPECT_STREQ("i", prop[1].signature); EXPECT_EQ(ALLJOYN_PROP_ACCESS_WRITE, prop[1].access); EXPECT_STREQ("prop3", prop[2].name); EXPECT_STREQ("u", prop[2].signature); EXPECT_EQ(ALLJOYN_PROP_ACCESS_RW, prop[2].access); /* * testing to see if it will not cause a problem if the array does not have * enough room for all of the properties. */ alljoyn_interfacedescription_property prop2[2]; size = alljoyn_interfacedescription_getproperties(testIntf, prop2, 2); EXPECT_EQ((size_t)2, size); EXPECT_STREQ("prop1", prop2[0].name); EXPECT_STREQ("s", prop2[0].signature); EXPECT_EQ(ALLJOYN_PROP_ACCESS_READ, prop2[0].access); EXPECT_STREQ("prop2", prop2[1].name); EXPECT_STREQ("i", prop2[1].signature); EXPECT_EQ(ALLJOYN_PROP_ACCESS_WRITE, prop2[1].access); alljoyn_busattachment_destroy(bus); } TEST(InterfaceDescriptionTest, alljoyn_interfacedescription_member_eql) { QStatus status = ER_OK; alljoyn_busattachment bus = NULL; bus = alljoyn_busattachment_create("InterfaceDescriptionTest", QCC_FALSE); ASSERT_TRUE(bus != NULL); alljoyn_interfacedescription testIntf = NULL; status = alljoyn_busattachment_createinterface(bus, "org.alljoyn.test.InterfaceDescription", &testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(testIntf != NULL); status = alljoyn_interfacedescription_addmember(testIntf, ALLJOYN_MESSAGE_METHOD_CALL, "ping", "s", "s", "in,out", 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_interfacedescription_addmember(testIntf, ALLJOYN_MESSAGE_SIGNAL, "chirp", "s", NULL, "chirp", 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription_member member; EXPECT_TRUE(alljoyn_interfacedescription_getmember(testIntf, "ping", &member)); alljoyn_interfacedescription_member other_member; EXPECT_TRUE(alljoyn_interfacedescription_getmember(testIntf, "ping", &other_member)); alljoyn_interfacedescription_member other_member2; EXPECT_TRUE(alljoyn_interfacedescription_getmember(testIntf, "chirp", &other_member2)); EXPECT_TRUE(alljoyn_interfacedescription_member_eql(member, other_member)); EXPECT_FALSE(alljoyn_interfacedescription_member_eql(member, other_member2)); alljoyn_busattachment_destroy(bus); } TEST(InterfaceDescriptionTest, alljoyn_interfacedescription_property_eql) { QStatus status = ER_OK; alljoyn_busattachment bus = NULL; bus = alljoyn_busattachment_create("InterfaceDescriptionTest", QCC_FALSE); alljoyn_interfacedescription testIntf = NULL; status = alljoyn_busattachment_createinterface(bus, "org.alljoyn.test.InterfaceDescription", &testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(testIntf != NULL); status = alljoyn_interfacedescription_addproperty(testIntf, "prop1", "s", ALLJOYN_PROP_ACCESS_READ); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_interfacedescription_addproperty(testIntf, "prop2", "i", ALLJOYN_PROP_ACCESS_WRITE); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription_property propa; EXPECT_TRUE(alljoyn_interfacedescription_getproperty(testIntf, "prop1", &propa)); alljoyn_interfacedescription_property propa2; EXPECT_TRUE(alljoyn_interfacedescription_getproperty(testIntf, "prop1", &propa2)); alljoyn_interfacedescription_property propb; EXPECT_TRUE(alljoyn_interfacedescription_getproperty(testIntf, "prop2", &propb)); EXPECT_TRUE(alljoyn_interfacedescription_property_eql(propa, propa2)); EXPECT_FALSE(alljoyn_interfacedescription_property_eql(propa, propb)); alljoyn_busattachment_destroy(bus); } TEST(InterfaceDescriptionTest, interface_annotations) { QStatus status = ER_OK; alljoyn_busattachment bus = NULL; bus = alljoyn_busattachment_create("InterfaceDescriptionTest", QCC_FALSE); ASSERT_TRUE(bus != NULL); alljoyn_interfacedescription testIntf = NULL; status = alljoyn_busattachment_createinterface(bus, "org.alljoyn.test.InterfaceDescription", &testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(testIntf != NULL); status = alljoyn_interfacedescription_addannotation(testIntf, "org.alljoyn.test.annotation", "foo"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription_activate(testIntf); size_t annotation_count = alljoyn_interfacedescription_getannotationscount(testIntf); EXPECT_EQ((size_t)1, annotation_count); size_t name_size; size_t value_size; alljoyn_interfacedescription_getannotationatindex(testIntf, 0, NULL, &name_size, NULL, &value_size); EXPECT_EQ((size_t)28, name_size); //the size of 'org.alljoyn.test.annotation' + nul EXPECT_EQ((size_t)4, value_size); //the size of 'foo' + nul {'f', 'o', 'o', '\0'} char* name = (char*)malloc((sizeof(char) * name_size) + (2 * CANARY_SIZE)); char* value = (char*)malloc((sizeof(char) * value_size) + (2 * CANARY_SIZE)); memset(name, '9', name_size + (2 * CANARY_SIZE)); memset(value, '8', value_size + (2 * CANARY_SIZE)); alljoyn_interfacedescription_getannotationatindex(testIntf, 0, name + CANARY_SIZE, &name_size, value + CANARY_SIZE, &value_size); EXPECT_EQ((size_t)28, name_size); //the size of 'org.alljoyn.test.annotation' + nul EXPECT_EQ((size_t)4, value_size); //the size of 'foo' + nul {'f', 'o', 'o', '\0'} EXPECT_STREQ("org.alljoyn.test.annotation", name + CANARY_SIZE); EXPECT_STREQ("foo", value + CANARY_SIZE); VERIFY_CANARY_VALUES(name, name_size, '9'); VERIFY_CANARY_VALUES(value, value_size, '8'); memset(name, '7', name_size + (2 * CANARY_SIZE)); memset(value, '6', value_size + (2 * CANARY_SIZE)); size_t badNameSize = 0; alljoyn_interfacedescription_getannotationatindex(testIntf, 0, name + CANARY_SIZE, &badNameSize, value + CANARY_SIZE, &value_size); EXPECT_EQ((size_t)28, badNameSize); //the size of 'org.alljoyn.test.annotation' + nul EXPECT_EQ((size_t)4, value_size); //the size of 'foo' + nul {'f', 'o', 'o', '\0'} VERIFY_CANARY_VALUES(name, name_size, '7'); VERIFY_CANARY_VALUES(value, value_size, '6'); memset(name, '5', name_size + (2 * CANARY_SIZE)); memset(value, '4', value_size + (2 * CANARY_SIZE)); size_t badValueSize = 0; alljoyn_interfacedescription_getannotationatindex(testIntf, 0, name + CANARY_SIZE, &name_size, value + CANARY_SIZE, &badValueSize); EXPECT_EQ((size_t)28, name_size); //the size of 'org.alljoyn.test.annotation' + nul EXPECT_EQ((size_t)4, badValueSize); //the size of 'foo' + nul {'f', 'o', 'o', '\0'} VERIFY_CANARY_VALUES(name, name_size, '5'); VERIFY_CANARY_VALUES(value, value_size, '4'); memset(name, '3', name_size + (2 * CANARY_SIZE)); memset(value, '2', value_size + (2 * CANARY_SIZE)); badNameSize = 0; badValueSize = 0; alljoyn_interfacedescription_getannotationatindex(testIntf, 0, name + CANARY_SIZE, &badNameSize, value + CANARY_SIZE, &badValueSize); EXPECT_EQ((size_t)28, badNameSize); //the size of 'org.alljoyn.test.annotation' + nul EXPECT_EQ((size_t)4, badValueSize); //the size of 'foo' + nul {'f', 'o', 'o', '\0'} VERIFY_CANARY_VALUES(name, name_size, '3'); VERIFY_CANARY_VALUES(value, value_size, '2'); memset(name, '1', name_size + (2 * CANARY_SIZE)); memset(value, '0', value_size + (2 * CANARY_SIZE)); size_t tooSmallSize = 1; alljoyn_interfacedescription_getannotationatindex(testIntf, 0, name + CANARY_SIZE, &tooSmallSize, value + CANARY_SIZE, &value_size); EXPECT_EQ((size_t)28, tooSmallSize); //the size of 'org.alljoyn.test.annotation' + nul EXPECT_EQ((size_t)4, value_size); //the size of 'foo' + nul {'f', 'o', 'o', '\0'} EXPECT_STREQ("", name + CANARY_SIZE); //empty string instead of 'org.alljoyn.test.annotation' EXPECT_STREQ("foo", value + CANARY_SIZE); VERIFY_CANARY_VALUES(name, name_size, '1'); VERIFY_CANARY_VALUES(value, value_size, '0'); memset(name, 'a', name_size + (2 * CANARY_SIZE)); memset(value, 'b', value_size + (2 * CANARY_SIZE)); tooSmallSize = 2; alljoyn_interfacedescription_getannotationatindex(testIntf, 0, name + CANARY_SIZE, &name_size, value + CANARY_SIZE, &tooSmallSize); EXPECT_EQ((size_t)28, name_size); //the size of 'org.alljoyn.test.annotation' + nul EXPECT_EQ((size_t)4, tooSmallSize); //the size of 'foo' + nul {'f', 'o', 'o', '\0'} EXPECT_STREQ("org.alljoyn.test.annotation", name + CANARY_SIZE); //empty string instead of 'org.alljoyn.test.annotation' EXPECT_STREQ("f", value + CANARY_SIZE); //first character of 'foo' VERIFY_CANARY_VALUES(name, name_size, 'a'); VERIFY_CANARY_VALUES(value, value_size, 'b'); free(name); free(value); QCC_BOOL success = alljoyn_interfacedescription_getannotation(testIntf, "org.alljoyn.test.annotation", NULL, &value_size); EXPECT_FALSE(success); EXPECT_EQ((size_t)4, value_size); //the size of 'foo' + nul {'f', 'o', 'o', '\0'} value = (char*)malloc((sizeof(char) * value_size) + (2 * CANARY_SIZE)); memset(value, 'c', value_size + (2 * CANARY_SIZE)); success = alljoyn_interfacedescription_getannotation(testIntf, "org.alljoyn.test.annotation", value + CANARY_SIZE, &value_size); EXPECT_TRUE(success); EXPECT_EQ((size_t)4, value_size); //the size of 'foo' + nul {'f', 'o', 'o', '\0'} EXPECT_STREQ("foo", value + CANARY_SIZE); VERIFY_CANARY_VALUES(value, value_size, 'c'); memset(value, 'd', value_size + (2 * CANARY_SIZE)); size_t badSize = 0; success = alljoyn_interfacedescription_getannotation(testIntf, "org.alljoyn.test.annotation", value + CANARY_SIZE, &badSize); EXPECT_FALSE(success); EXPECT_EQ((size_t)4, badSize); //the size of 'foo' + nul {'f', 'o', 'o', '\0'} VERIFY_CANARY_VALUES(value, value_size, 'd'); memset(value, 'e', value_size + (2 * CANARY_SIZE)); tooSmallSize = 1; success = alljoyn_interfacedescription_getannotation(testIntf, "org.alljoyn.test.annotation", value + CANARY_SIZE, &tooSmallSize); EXPECT_TRUE(success); EXPECT_EQ((size_t)4, tooSmallSize); //the size of 'foo' + nul {'f', 'o', 'o', '\0'} EXPECT_STREQ("", value + CANARY_SIZE); //empty string instead of 'foo' VERIFY_CANARY_VALUES(value, value_size, 'e'); memset(value, 'f', value_size + (2 * CANARY_SIZE)); tooSmallSize = 2; success = alljoyn_interfacedescription_getannotation(testIntf, "org.alljoyn.test.annotation", value + CANARY_SIZE, &tooSmallSize); EXPECT_TRUE(success); EXPECT_EQ((size_t)4, tooSmallSize); //the size of 'foo' + nul {'f', 'o', 'o', '\0'} EXPECT_STREQ("f", value + CANARY_SIZE); //first character of 'foo' VERIFY_CANARY_VALUES(value, value_size, 'f'); free(value); alljoyn_busattachment_destroy(bus); } TEST(InterfaceDescriptionTest, method_annotations) { QStatus status = ER_OK; alljoyn_busattachment bus = NULL; bus = alljoyn_busattachment_create("InterfaceDescriptionTest", QCC_FALSE); ASSERT_TRUE(bus != NULL); alljoyn_interfacedescription testIntf = NULL; status = alljoyn_busattachment_createinterface(bus, "org.alljoyn.test.InterfaceDescription", &testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(testIntf != NULL); status = alljoyn_interfacedescription_addmember(testIntf, ALLJOYN_MESSAGE_METHOD_CALL, "ping", "s", "s", "in,out", 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_interfacedescription_addmemberannotation(testIntf, "ping", "one", "black_cat"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription_activate(testIntf); alljoyn_interfacedescription_member method_member; EXPECT_TRUE(alljoyn_interfacedescription_getmember(testIntf, "ping", &method_member)); size_t annotation_count = alljoyn_interfacedescription_member_getannotationscount(method_member); EXPECT_EQ((size_t)1, annotation_count); size_t name_size; size_t value_size; alljoyn_interfacedescription_member_getannotationatindex(method_member, 0, NULL, &name_size, NULL, &value_size); EXPECT_EQ((size_t)4, name_size); //the size of 'one' {'o', 'n', 'e', '\0'} EXPECT_EQ((size_t)10, value_size); //the size of black_cat + nul char* name = (char*)malloc((sizeof(char) * name_size) + (2 * CANARY_SIZE)); char* value = (char*)malloc((sizeof(char) * value_size) + (2 * CANARY_SIZE)); memset(name, 'A', name_size + (2 * CANARY_SIZE)); memset(value, 'B', value_size + (2 * CANARY_SIZE)); alljoyn_interfacedescription_member_getannotationatindex(method_member, 0, name + CANARY_SIZE, &name_size, value + CANARY_SIZE, &value_size); EXPECT_EQ((size_t)4, name_size); //the size of 'one' {'o', 'n', 'e', '\0'} EXPECT_EQ((size_t)10, value_size); //the size of black_cat + nul EXPECT_STREQ("one", name + CANARY_SIZE); EXPECT_STREQ("black_cat", value + CANARY_SIZE); VERIFY_CANARY_VALUES(name, name_size, 'A'); VERIFY_CANARY_VALUES(value, value_size, 'B'); memset(name, 'C', name_size + (2 * CANARY_SIZE)); memset(value, 'D', value_size + (2 * CANARY_SIZE)); size_t badNameSize = 0; alljoyn_interfacedescription_member_getannotationatindex(method_member, 0, name + CANARY_SIZE, &badNameSize, value + CANARY_SIZE, &value_size); EXPECT_EQ((size_t)4, badNameSize); //the size of 'one' {'o', 'n', 'e', '\0'} EXPECT_EQ((size_t)10, value_size); //the size of black_cat + nul VERIFY_CANARY_VALUES(name, name_size, 'C'); VERIFY_CANARY_VALUES(value, value_size, 'D'); memset(name, 'E', name_size + (2 * CANARY_SIZE)); memset(value, 'F', value_size + (2 * CANARY_SIZE)); size_t badValueSize = 0; alljoyn_interfacedescription_member_getannotationatindex(method_member, 0, name + CANARY_SIZE, &name_size, value + CANARY_SIZE, &badValueSize); EXPECT_EQ((size_t)4, name_size); //the size of 'one' {'o', 'n', 'e', '\0'} EXPECT_EQ((size_t)10, badValueSize); //the size of black_cat + nul VERIFY_CANARY_VALUES(name, name_size, 'E'); VERIFY_CANARY_VALUES(value, value_size, 'F'); memset(name, 'G', name_size + (2 * CANARY_SIZE)); memset(value, 'H', value_size + (2 * CANARY_SIZE)); badNameSize = 0; badValueSize = 0; alljoyn_interfacedescription_member_getannotationatindex(method_member, 0, name + CANARY_SIZE, &badNameSize, value + CANARY_SIZE, &badValueSize); EXPECT_EQ((size_t)4, badNameSize); //the size of 'one' {'o', 'n', 'e', '\0'} EXPECT_EQ((size_t)10, badValueSize); //the size of black_cat + nul VERIFY_CANARY_VALUES(name, name_size, 'G'); VERIFY_CANARY_VALUES(value, value_size, 'H'); memset(name, 'I', name_size + (2 * CANARY_SIZE)); memset(value, 'J', value_size + (2 * CANARY_SIZE)); size_t tooSmallSize = 1; alljoyn_interfacedescription_member_getannotationatindex(method_member, 0, name + CANARY_SIZE, &tooSmallSize, value + CANARY_SIZE, &value_size); EXPECT_EQ((size_t)4, tooSmallSize); //the size of 'one' {'o', 'n', 'e', '\0'} EXPECT_EQ((size_t)10, value_size); //the size of black_cat + nul EXPECT_STREQ("", name + CANARY_SIZE); //empty string instead of 'one' EXPECT_STREQ("black_cat", value + CANARY_SIZE); VERIFY_CANARY_VALUES(name, name_size, 'I'); VERIFY_CANARY_VALUES(value, value_size, 'J'); memset(name, 'L', name_size + (2 * CANARY_SIZE)); memset(value, 'M', value_size + (2 * CANARY_SIZE)); tooSmallSize = 1; alljoyn_interfacedescription_member_getannotationatindex(method_member, 0, name + CANARY_SIZE, &name_size, value + CANARY_SIZE, &tooSmallSize); EXPECT_EQ((size_t)4, name_size); //the size of 'one' {'o', 'n', 'e', '\0'} EXPECT_EQ((size_t)10, tooSmallSize); //the size of black_cat + nul EXPECT_STREQ("one", name + CANARY_SIZE); EXPECT_STREQ("", value + CANARY_SIZE); //empty string instead of 'black_cat' VERIFY_CANARY_VALUES(name, name_size, 'L'); VERIFY_CANARY_VALUES(value, value_size, 'M'); memset(name, 'N', name_size + (2 * CANARY_SIZE)); memset(value, 'O', value_size + (2 * CANARY_SIZE)); tooSmallSize = 2; alljoyn_interfacedescription_member_getannotationatindex(method_member, 0, name + CANARY_SIZE, &tooSmallSize, value + CANARY_SIZE, &value_size); EXPECT_EQ((size_t)4, tooSmallSize); //the size of 'one' {'o', 'n', 'e', '\0'} EXPECT_EQ((size_t)10, value_size); //the size of black_cat + nul EXPECT_STREQ("o", name + CANARY_SIZE); //first character of 'one' EXPECT_STREQ("black_cat", value + CANARY_SIZE); VERIFY_CANARY_VALUES(name, name_size, 'N'); VERIFY_CANARY_VALUES(value, value_size, 'O'); memset(name, 'P', name_size + (2 * CANARY_SIZE)); memset(value, 'R', value_size + (2 * CANARY_SIZE)); tooSmallSize = 3; alljoyn_interfacedescription_member_getannotationatindex(method_member, 0, name + CANARY_SIZE, &name_size, value + CANARY_SIZE, &tooSmallSize); EXPECT_EQ((size_t)4, name_size); //the size of 'one' {'o', 'n', 'e', '\0'} EXPECT_EQ((size_t)10, tooSmallSize); //the size of black_cat + nul EXPECT_STREQ("one", name + CANARY_SIZE); EXPECT_STREQ("bl", value + CANARY_SIZE); //first two characters of 'black_cat' VERIFY_CANARY_VALUES(name, name_size, 'P'); VERIFY_CANARY_VALUES(value, value_size, 'R'); free(name); free(value); QCC_BOOL success = alljoyn_interfacedescription_member_getannotation(method_member, "one", NULL, &value_size); EXPECT_FALSE(success); EXPECT_EQ((size_t)10, value_size); //the size of black_cat + nul value = (char*)malloc((sizeof(char) * value_size) + (2 * CANARY_SIZE)); memset(value, 'K', value_size + (2 * CANARY_SIZE)); success = alljoyn_interfacedescription_member_getannotation(method_member, "one", value + CANARY_SIZE, &value_size); EXPECT_TRUE(success); EXPECT_EQ((size_t)10, value_size); //the size of black_cat + nul EXPECT_STREQ("black_cat", value + CANARY_SIZE); VERIFY_CANARY_VALUES(value, value_size, 'K'); memset(value, 'L', value_size + (2 * CANARY_SIZE)); badValueSize = 0; success = alljoyn_interfacedescription_member_getannotation(method_member, "one", value + CANARY_SIZE, &badValueSize); EXPECT_FALSE(success); EXPECT_EQ((size_t)10, badValueSize); //the size of black_cat + nul VERIFY_CANARY_VALUES(value, value_size, 'L'); memset(value, 'M', value_size + (2 * CANARY_SIZE)); tooSmallSize = 1; success = alljoyn_interfacedescription_member_getannotation(method_member, "one", value + CANARY_SIZE, &tooSmallSize); EXPECT_TRUE(success); EXPECT_EQ((size_t)10, tooSmallSize); //the size of black_cat + nul EXPECT_STREQ("", value + CANARY_SIZE); //empty string instead of black_cat VERIFY_CANARY_VALUES(value, value_size, 'M'); memset(value, 'N', value_size + (2 * CANARY_SIZE)); tooSmallSize = 2; success = alljoyn_interfacedescription_member_getannotation(method_member, "one", value + CANARY_SIZE, &tooSmallSize); EXPECT_TRUE(success); EXPECT_EQ((size_t)10, tooSmallSize); //the size of black_cat + nul EXPECT_STREQ("b", value + CANARY_SIZE); //first character of black_cat VERIFY_CANARY_VALUES(value, value_size, 'N'); free(value); success = alljoyn_interfacedescription_getmemberannotation(testIntf, "ping", "one", NULL, &value_size); EXPECT_FALSE(success); EXPECT_EQ((size_t)10, value_size); //the size of black_cat + nul value = (char*)malloc((sizeof(char) * value_size) + (2 * CANARY_SIZE)); memset(value, 'O', value_size + (2 * CANARY_SIZE)); success = alljoyn_interfacedescription_getmemberannotation(testIntf, "ping", "one", value + CANARY_SIZE, &value_size); EXPECT_TRUE(success); EXPECT_EQ((size_t)10, value_size); //the size of black_cat + nul EXPECT_STREQ("black_cat", value + CANARY_SIZE); VERIFY_CANARY_VALUES(value, value_size, 'O'); memset(value, 'P', value_size + (2 * CANARY_SIZE)); badValueSize = 0; success = alljoyn_interfacedescription_getmemberannotation(testIntf, "ping", "one", value + CANARY_SIZE, &badValueSize); EXPECT_FALSE(success); EXPECT_EQ((size_t)10, badValueSize); //the size of black_cat + nul VERIFY_CANARY_VALUES(value, value_size, 'P'); memset(value, 'Q', value_size + (2 * CANARY_SIZE)); tooSmallSize = 1; success = alljoyn_interfacedescription_getmemberannotation(testIntf, "ping", "one", value + CANARY_SIZE, &tooSmallSize); EXPECT_TRUE(success); EXPECT_EQ((size_t)10, tooSmallSize); //the size of black_cat + nul EXPECT_STREQ("", value + CANARY_SIZE); //empty string instead of black_cat VERIFY_CANARY_VALUES(value, value_size, 'Q'); memset(value, 'R', value_size + (2 * CANARY_SIZE)); tooSmallSize = 2; success = alljoyn_interfacedescription_getmemberannotation(testIntf, "ping", "one", value + CANARY_SIZE, &tooSmallSize); EXPECT_TRUE(success); EXPECT_EQ((size_t)10, tooSmallSize); //the size of black_cat + nul EXPECT_STREQ("b", value + CANARY_SIZE); //first character of black_cat VERIFY_CANARY_VALUES(value, value_size, 'R'); free(value); alljoyn_busattachment_destroy(bus); } TEST(InterfaceDescriptionTest, signal_annotations) { QStatus status = ER_OK; alljoyn_busattachment bus = NULL; bus = alljoyn_busattachment_create("InterfaceDescriptionTest", QCC_FALSE); ASSERT_TRUE(bus != NULL); alljoyn_interfacedescription testIntf = NULL; status = alljoyn_busattachment_createinterface(bus, "org.alljoyn.test.InterfaceDescription", &testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(testIntf != NULL); status = alljoyn_interfacedescription_addmember(testIntf, ALLJOYN_MESSAGE_SIGNAL, "chirp", "s", NULL, "chirp", 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_interfacedescription_addmemberannotation(testIntf, "chirp", "two", "apples"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription_activate(testIntf); alljoyn_interfacedescription_member signal_member; EXPECT_TRUE(alljoyn_interfacedescription_getmember(testIntf, "chirp", &signal_member)); size_t annotation_count = alljoyn_interfacedescription_member_getannotationscount(signal_member); EXPECT_EQ((size_t)1, annotation_count); size_t name_size; size_t value_size; alljoyn_interfacedescription_member_getannotationatindex(signal_member, 0, NULL, &name_size, NULL, &value_size); EXPECT_EQ((size_t)4, name_size); //the size of 'two' {'t', 'w', 'o', '\0'} EXPECT_EQ((size_t)7, value_size); //the size of 'apples' + nul char* name = (char*)malloc(sizeof(char) * name_size); char* value = (char*)malloc(sizeof(char) * value_size); alljoyn_interfacedescription_member_getannotationatindex(signal_member, 0, name, &name_size, value, &value_size); EXPECT_STREQ("two", name); EXPECT_STREQ("apples", value); free(name); free(value); alljoyn_interfacedescription_member_getannotation(signal_member, "two", NULL, &value_size); EXPECT_LT((size_t)0, value_size); value = (char*)malloc(sizeof(char) * value_size); QCC_BOOL success = alljoyn_interfacedescription_member_getannotation(signal_member, "two", value, &value_size); EXPECT_TRUE(success); EXPECT_STREQ("apples", value); free(value); alljoyn_interfacedescription_getmemberannotation(testIntf, "chirp", "two", NULL, &value_size); EXPECT_LT((size_t)0, value_size); value = (char*)malloc(sizeof(char) * value_size); success = alljoyn_interfacedescription_getmemberannotation(testIntf, "chirp", "two", value, &value_size); EXPECT_TRUE(success); EXPECT_STREQ("apples", value); free(value); alljoyn_busattachment_destroy(bus); } TEST(InterfaceDescriptionTest, property_annotations) { QStatus status = ER_OK; alljoyn_busattachment bus = NULL; bus = alljoyn_busattachment_create("InterfaceDescriptionTest", QCC_FALSE); ASSERT_TRUE(bus != NULL); alljoyn_interfacedescription testIntf = NULL; status = alljoyn_busattachment_createinterface(bus, "org.alljoyn.test.InterfaceDescription", &testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(testIntf != NULL); status = alljoyn_interfacedescription_addproperty(testIntf, "prop", "s", ALLJOYN_PROP_ACCESS_READ); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_interfacedescription_addpropertyannotation(testIntf, "prop", "three", "people"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription_activate(testIntf); alljoyn_interfacedescription_property property; EXPECT_TRUE(alljoyn_interfacedescription_getproperty(testIntf, "prop", &property)); size_t annotation_count = alljoyn_interfacedescription_property_getannotationscount(property); EXPECT_EQ((size_t)1, annotation_count); size_t name_size; size_t value_size; alljoyn_interfacedescription_property_getannotationatindex(property, 0, NULL, &name_size, NULL, &value_size); EXPECT_EQ((size_t)6, name_size); //the size of 'three' {'t', 'h', 'r', 'e', 'e', '\0'} EXPECT_EQ((size_t)7, value_size); //the size of 'people' + nul char* name = (char*)malloc((sizeof(char) * name_size) + (2 * CANARY_SIZE)); char* value = (char*)malloc((sizeof(char) * value_size) + (2 * CANARY_SIZE)); memset(name, 'a', name_size + (2 * CANARY_SIZE)); memset(value, 'b', value_size + (2 * CANARY_SIZE)); alljoyn_interfacedescription_property_getannotationatindex(property, 0, name + CANARY_SIZE, &name_size, value + CANARY_SIZE, &value_size); EXPECT_EQ((size_t)6, name_size); //the size of 'three' {'t', 'h', 'r', 'e', 'e', '\0'} EXPECT_EQ((size_t)7, value_size); //the size of 'people' + nul EXPECT_STREQ("three", name + CANARY_SIZE); EXPECT_STREQ("people", value + CANARY_SIZE); VERIFY_CANARY_VALUES(name, name_size, 'a'); VERIFY_CANARY_VALUES(value, value_size, 'b'); memset(name, 'c', name_size + (2 * CANARY_SIZE)); memset(value, 'd', value_size + (2 * CANARY_SIZE)); size_t badNameSize = 0; alljoyn_interfacedescription_property_getannotationatindex(property, 0, name + CANARY_SIZE, &badNameSize, value + CANARY_SIZE, &value_size); EXPECT_EQ((size_t)6, badNameSize); //the size of 'three' {'t', 'h', 'r', 'e', 'e', '\0'} EXPECT_EQ((size_t)7, value_size); //the size of 'people' + nul VERIFY_CANARY_VALUES(name, name_size, 'c'); VERIFY_CANARY_VALUES(value, value_size, 'd'); memset(name, 'e', name_size + (2 * CANARY_SIZE)); memset(value, 'f', value_size + (2 * CANARY_SIZE)); size_t badValueSize = 0; alljoyn_interfacedescription_property_getannotationatindex(property, 0, name + CANARY_SIZE, &name_size, value + CANARY_SIZE, &badValueSize); EXPECT_EQ((size_t)6, name_size); //the size of 'three' {'t', 'h', 'r', 'e', 'e', '\0'} EXPECT_EQ((size_t)7, badValueSize); //the size of 'people' + nul VERIFY_CANARY_VALUES(name, name_size, 'e'); VERIFY_CANARY_VALUES(value, value_size, 'f'); memset(name, 'g', name_size + (2 * CANARY_SIZE)); memset(value, 'h', value_size + (2 * CANARY_SIZE)); badNameSize = 0; badValueSize = 0; alljoyn_interfacedescription_property_getannotationatindex(property, 0, name + CANARY_SIZE, &badNameSize, value + CANARY_SIZE, &badValueSize); EXPECT_EQ((size_t)6, badNameSize); //the size of 'three' {'t', 'h', 'r', 'e', 'e', '\0'} EXPECT_EQ((size_t)7, badValueSize); //the size of 'people' + nul VERIFY_CANARY_VALUES(name, name_size, 'g'); VERIFY_CANARY_VALUES(value, value_size, 'h'); memset(name, 'i', name_size + (2 * CANARY_SIZE)); memset(value, 'j', value_size + (2 * CANARY_SIZE)); size_t tooSmallSize = 1; alljoyn_interfacedescription_property_getannotationatindex(property, 0, name + CANARY_SIZE, &tooSmallSize, value + CANARY_SIZE, &value_size); EXPECT_EQ((size_t)6, tooSmallSize); //the size of 'three' {'t', 'h', 'r', 'e', 'e', '\0'} EXPECT_EQ((size_t)7, value_size); //the size of 'people' + nul EXPECT_STREQ("", name + CANARY_SIZE); //empty string instead of 'three' EXPECT_STREQ("people", value + CANARY_SIZE); VERIFY_CANARY_VALUES(name, name_size, 'i'); VERIFY_CANARY_VALUES(value, value_size, 'j'); memset(name, 'k', name_size + (2 * CANARY_SIZE)); memset(value, 'l', value_size + (2 * CANARY_SIZE)); tooSmallSize = 1; alljoyn_interfacedescription_property_getannotationatindex(property, 0, name + CANARY_SIZE, &name_size, value + CANARY_SIZE, &tooSmallSize); EXPECT_EQ((size_t)6, name_size); //the size of 'three' {'t', 'h', 'r', 'e', 'e', '\0'} EXPECT_EQ((size_t)7, tooSmallSize); //the size of 'people' + nul EXPECT_STREQ("three", name + CANARY_SIZE); EXPECT_STREQ("", value + CANARY_SIZE); //empty string instead of 'people' VERIFY_CANARY_VALUES(name, name_size, 'k'); VERIFY_CANARY_VALUES(value, value_size, 'l'); memset(name, 'm', name_size + (2 * CANARY_SIZE)); memset(value, 'n', value_size + (2 * CANARY_SIZE)); tooSmallSize = 3; size_t tooSmallSize2 = 2; alljoyn_interfacedescription_property_getannotationatindex(property, 0, name + CANARY_SIZE, &tooSmallSize, value + CANARY_SIZE, &tooSmallSize2); EXPECT_EQ((size_t)6, tooSmallSize); //the size of 'three' {'t', 'h', 'r', 'e', 'e', '\0'} EXPECT_EQ((size_t)7, tooSmallSize2); //the size of 'people' + nul EXPECT_STREQ("th", name + CANARY_SIZE); //first two characters of 'three' EXPECT_STREQ("p", value + CANARY_SIZE); //first character of 'people' VERIFY_CANARY_VALUES(name, name_size, 'm'); VERIFY_CANARY_VALUES(value, value_size, 'n'); free(name); free(value); QCC_BOOL success = alljoyn_interfacedescription_property_getannotation(property, "three", NULL, &value_size); EXPECT_FALSE(success); EXPECT_EQ((size_t)7, value_size); //the size of 'people' + nul value = (char*)malloc((sizeof(char) * value_size) + (2 * CANARY_SIZE)); memset(value, 'o', value_size + (2 * CANARY_SIZE)); success = alljoyn_interfacedescription_property_getannotation(property, "three", value + CANARY_SIZE, &value_size); EXPECT_TRUE(success); EXPECT_EQ((size_t)7, value_size); //the size of 'people' + nul EXPECT_STREQ("people", value + CANARY_SIZE); VERIFY_CANARY_VALUES(value, value_size, 'o'); memset(value, 'p', value_size + (2 * CANARY_SIZE)); badValueSize = 0; success = alljoyn_interfacedescription_property_getannotation(property, "three", value + CANARY_SIZE, &badValueSize); EXPECT_FALSE(success); EXPECT_EQ((size_t)7, badValueSize); //the size of 'people' + nul VERIFY_CANARY_VALUES(value, value_size, 'p'); memset(value, 'q', value_size + (2 * CANARY_SIZE)); tooSmallSize = 1; success = alljoyn_interfacedescription_property_getannotation(property, "three", value + CANARY_SIZE, &tooSmallSize); EXPECT_TRUE(success); EXPECT_EQ((size_t)7, tooSmallSize); //the size of 'people' + nul EXPECT_STREQ("", value + CANARY_SIZE); //empty string instead of 'people' VERIFY_CANARY_VALUES(value, value_size, 'q'); memset(value, 'r', value_size + (2 * CANARY_SIZE)); tooSmallSize = 2; success = alljoyn_interfacedescription_property_getannotation(property, "three", value + CANARY_SIZE, &tooSmallSize); EXPECT_TRUE(success); EXPECT_EQ((size_t)7, tooSmallSize); //the size of 'people' + nul EXPECT_STREQ("p", value + CANARY_SIZE); //first character of 'people' VERIFY_CANARY_VALUES(value, value_size, 'r'); free(value); success = alljoyn_interfacedescription_getpropertyannotation(testIntf, "prop", "three", NULL, &value_size); EXPECT_FALSE(success); EXPECT_EQ((size_t)7, value_size); //the size of 'people' + nul value = (char*)malloc((sizeof(char) * value_size) + (2 * CANARY_SIZE)); memset(value, 's', value_size + (2 * CANARY_SIZE)); success = alljoyn_interfacedescription_getpropertyannotation(testIntf, "prop", "three", value + CANARY_SIZE, &value_size); EXPECT_TRUE(success); EXPECT_EQ((size_t)7, value_size); //the size of 'people' + nul EXPECT_STREQ("people", value + CANARY_SIZE); VERIFY_CANARY_VALUES(value, value_size, 's'); memset(value, 't', value_size + (2 * CANARY_SIZE)); badValueSize = 0; success = alljoyn_interfacedescription_getpropertyannotation(testIntf, "prop", "three", value + CANARY_SIZE, &badValueSize); EXPECT_FALSE(success); EXPECT_EQ((size_t)7, badValueSize); //the size of 'people' + nul VERIFY_CANARY_VALUES(value, value_size, 't'); memset(value, 'u', value_size + (2 * CANARY_SIZE)); tooSmallSize = 1; success = alljoyn_interfacedescription_getpropertyannotation(testIntf, "prop", "three", value + CANARY_SIZE, &tooSmallSize); EXPECT_TRUE(success); EXPECT_EQ((size_t)7, tooSmallSize); //the size of 'people' + nul EXPECT_STREQ("", value + CANARY_SIZE); //empty string instead of 'people' VERIFY_CANARY_VALUES(value, value_size, 'u'); memset(value, 'u', value_size + (2 * CANARY_SIZE)); tooSmallSize = 2; success = alljoyn_interfacedescription_getpropertyannotation(testIntf, "prop", "three", value + CANARY_SIZE, &tooSmallSize); EXPECT_TRUE(success); EXPECT_EQ((size_t)7, tooSmallSize); //the size of 'people' + nul EXPECT_STREQ("p", value + CANARY_SIZE); //first character of 'people' VERIFY_CANARY_VALUES(value, value_size, 'u'); free(value); alljoyn_busattachment_destroy(bus); } /* * check to see that we are still backward compatible with the annotation flags */ TEST(InterfaceDescriptionTest, annotation_flags) { QStatus status = ER_OK; alljoyn_busattachment bus = NULL; bus = alljoyn_busattachment_create("InterfaceDescriptionTest", QCC_FALSE); ASSERT_TRUE(bus != NULL); alljoyn_interfacedescription testIntf = NULL; status = alljoyn_busattachment_createinterface(bus, "org.alljoyn.test.InterfaceDescription", &testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(testIntf != NULL); status = alljoyn_interfacedescription_addmember(testIntf, ALLJOYN_MESSAGE_METHOD_CALL, "ping", "s", "s", "in,out", ALLJOYN_MEMBER_ANNOTATE_NO_REPLY); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_interfacedescription_addmember(testIntf, ALLJOYN_MESSAGE_SIGNAL, "chirp", "s", NULL, "chirp", ALLJOYN_MEMBER_ANNOTATE_DEPRECATED); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription_activate(testIntf); alljoyn_interfacedescription_member method_member; EXPECT_TRUE(alljoyn_interfacedescription_getmember(testIntf, "ping", &method_member)); size_t annotation_count = alljoyn_interfacedescription_member_getannotationscount(method_member); EXPECT_EQ((size_t)1, annotation_count); size_t name_size; size_t value_size; alljoyn_interfacedescription_member_getannotationatindex(method_member, 0, NULL, &name_size, NULL, &value_size); char* name = (char*)malloc(sizeof(char) * name_size); char* value = (char*)malloc(sizeof(char) * value_size); alljoyn_interfacedescription_member_getannotationatindex(method_member, 0, name, &name_size, value, &value_size); EXPECT_STREQ("org.freedesktop.DBus.Method.NoReply", name); EXPECT_STREQ("true", value); free(name); free(value); alljoyn_interfacedescription_member signal_member; EXPECT_TRUE(alljoyn_interfacedescription_getmember(testIntf, "chirp", &signal_member)); annotation_count = alljoyn_interfacedescription_member_getannotationscount(signal_member); EXPECT_EQ((size_t)1, annotation_count); alljoyn_interfacedescription_member_getannotationatindex(signal_member, 0, NULL, &name_size, NULL, &value_size); name = (char*)malloc(sizeof(char) * name_size); value = (char*)malloc(sizeof(char) * value_size); alljoyn_interfacedescription_member_getannotationatindex(signal_member, 0, name, &name_size, value, &value_size); EXPECT_STREQ("org.freedesktop.DBus.Deprecated", name); EXPECT_STREQ("true", value); free(name); free(value); alljoyn_busattachment_destroy(bus); } TEST(InterfaceDescriptionTest, multiple_annotations) { QStatus status = ER_OK; alljoyn_busattachment bus = NULL; bus = alljoyn_busattachment_create("InterfaceDescriptionTest", QCC_FALSE); ASSERT_TRUE(bus != NULL); alljoyn_interfacedescription testIntf = NULL; status = alljoyn_busattachment_createinterface(bus, "org.alljoyn.test.InterfaceDescription", &testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(testIntf != NULL); status = alljoyn_interfacedescription_addmember(testIntf, ALLJOYN_MESSAGE_METHOD_CALL, "ping", "s", "s", "in,out", ALLJOYN_MEMBER_ANNOTATE_NO_REPLY); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_interfacedescription_addmemberannotation(testIntf, "ping", "org.alljoyn.test.one", "black_cat"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_interfacedescription_addmemberannotation(testIntf, "ping", "org.alljoyn.test.two", "broken_mirror"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_interfacedescription_addmemberannotation(testIntf, "ping", "org.alljoyn.test.three", "latter"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_interfacedescription_addmemberannotation(testIntf, "ping", "org.alljoyn.test.four", "umbrella"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_interfacedescription_addmemberannotation(testIntf, "ping", "org.alljoyn.test.five", "luck"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_interfacedescription_addmemberannotation(testIntf, "ping", "org.alljoyn.test.six", "bad"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription_activate(testIntf); alljoyn_interfacedescription_member method_member; EXPECT_TRUE(alljoyn_interfacedescription_getmember(testIntf, "ping", &method_member)); size_t annotation_count = alljoyn_interfacedescription_member_getannotationscount(method_member); EXPECT_EQ((size_t)7, annotation_count); //six annotations added plus the NoReply annotation size_t name_size; size_t value_size; for (size_t i = 0; i < annotation_count; i++) { alljoyn_interfacedescription_member_getannotationatindex(method_member, i, NULL, &name_size, NULL, &value_size); char* name = (char*)malloc(sizeof(char) * name_size); char* value = (char*)malloc(sizeof(char) * value_size); ASSERT_TRUE(name != NULL); ASSERT_TRUE(value != NULL); alljoyn_interfacedescription_member_getannotationatindex(method_member, i, name, &name_size, value, &value_size); /* * order that the annotations are returned is not known we only know that * the key must match with the value. * for windows the order returned is (this order could differ by OS or compiler) * 0 : org.alljoyn.test.five = luck * 1 : org.alljoyn.test.four = umbrella * 2 : org.alljoyn.test.one = black_cat * 3 : org.alljoyn.test.six = bad * 4 : org.alljoyn.test.three = latter * 5 : org.alljoyn.test.two = broken_mirror * 6 : org.freedesktop.DBus.Method.NoReply = true */ EXPECT_TRUE((strcmp("org.alljoyn.test.one", name) == 0 && strcmp("black_cat", value) == 0) || (strcmp("org.alljoyn.test.two", name) == 0 && strcmp("broken_mirror", value) == 0) || (strcmp("org.alljoyn.test.three", name) == 0 && strcmp("latter", value) == 0) || (strcmp("org.alljoyn.test.four", name) == 0 && strcmp("umbrella", value) == 0) || (strcmp("org.alljoyn.test.five", name) == 0 && strcmp("luck", value) == 0) || (strcmp("org.alljoyn.test.six", name) == 0 && strcmp("bad", value) == 0) || (strcmp("org.freedesktop.DBus.Method.NoReply", name) == 0 && strcmp("true", value) == 0)) << "Expected annotation not found : " << name << " = " << value << "\n"; free(name); free(value); } alljoyn_busattachment_destroy(bus); } alljoyn-15.04b/alljoyn_c/unit_test/KeyStoreListenerTest.cc000066400000000000000000000372341255700255500237660ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include "ajTestCommon.h" #include #include #include #include #include #include static const char* INTERFACE_NAME = "org.alljoyn.test.c.keystorelistener"; static const char* OBJECT_NAME = "org.alljoyn.test.c.keystorelistener"; static const char* OBJECT_PATH = "/org/alljoyn/test"; static QCC_BOOL name_owner_changed_flag = QCC_FALSE; static QCC_BOOL requestcredentials_service_flag = QCC_FALSE; static QCC_BOOL authenticationcomplete_service_flag = QCC_FALSE; static QCC_BOOL requestcredentials_client_flag = QCC_FALSE; static QCC_BOOL authenticationcomplete_client_flag = QCC_FALSE; static QCC_BOOL keystorelistener_loadrequest_flag = QCC_FALSE; static QCC_BOOL keystorelistener_storerequest_flag = QCC_FALSE; /* NameOwnerChanged callback */ static void AJ_CALL name_owner_changed(const void* context, const char* busName, const char* previousOwner, const char* newOwner) { QCC_UNUSED(context); QCC_UNUSED(previousOwner); QCC_UNUSED(newOwner); if (strcmp(busName, OBJECT_NAME) == 0) { name_owner_changed_flag = QCC_TRUE; } } /* Exposed methods */ static void AJ_CALL ping_method(alljoyn_busobject bus, const alljoyn_interfacedescription_member* member, alljoyn_message msg) { QCC_UNUSED(member); alljoyn_msgarg outArg = alljoyn_msgarg_create(); alljoyn_msgarg inArg = alljoyn_message_getarg(msg, 0); const char* str; alljoyn_msgarg_get(inArg, "s", &str); alljoyn_msgarg_set(outArg, "s", str); QStatus status = alljoyn_busobject_methodreply_args(bus, msg, outArg, 1); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg_destroy(outArg); } /* Keystore listener callback functions */ static char* inMemoryKeystore = NULL; static QStatus AJ_CALL alljoyn_keystorelistener_loadrequest(const void* context, alljoyn_keystorelistener listener, alljoyn_keystore keyStore) { QCC_UNUSED(context); QStatus status = alljoyn_keystorelistener_putkeys(listener, keyStore, inMemoryKeystore, "password"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); keystorelistener_loadrequest_flag = QCC_TRUE; return status; } static QStatus AJ_CALL alljoyn_keystorelistener_storerequest(const void* context, alljoyn_keystorelistener listener, alljoyn_keystore keyStore) { QCC_UNUSED(context); QStatus status = ER_FAIL; // default state is a fail state if (inMemoryKeystore != NULL) { free(inMemoryKeystore); } size_t sink_sz = 0; status = alljoyn_keystorelistener_getkeys(listener, keyStore, NULL, &sink_sz); EXPECT_EQ(ER_BUFFER_TOO_SMALL, status) << " Actual Status: " << QCC_StatusText(status); inMemoryKeystore = (char*) malloc(sizeof(char) * sink_sz); status = alljoyn_keystorelistener_getkeys(listener, keyStore, inMemoryKeystore, &sink_sz); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); keystorelistener_storerequest_flag = QCC_TRUE; return status; } class KeyStoreListenerTest : public testing::Test { public: virtual void SetUp() { /* initilize test fixture values to known start value */ status = ER_FAIL; servicebus = NULL; clientbus = NULL; testObj = NULL; buslistener = NULL; /* set up the service bus */ servicebus = alljoyn_busattachment_create("AuthListenerAsyncTestService", false); status = alljoyn_busattachment_start(servicebus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(servicebus, ajn::getConnectArg().c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription service_intf = NULL; status = alljoyn_busattachment_createinterface_secure(servicebus, INTERFACE_NAME, &service_intf, AJ_IFC_SECURITY_REQUIRED); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(service_intf != NULL); status = alljoyn_interfacedescription_addmember(service_intf, ALLJOYN_MESSAGE_METHOD_CALL, "ping", "s", "s", "in,out", 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription_activate(service_intf); clientbus = alljoyn_busattachment_create("AuthListenerAsyncTestClient", false); status = alljoyn_busattachment_start(clientbus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(clientbus, ajn::getConnectArg().c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); } virtual void TearDown() { alljoyn_busattachment_stop(servicebus); alljoyn_busattachment_join(servicebus); alljoyn_busattachment_stop(clientbus); alljoyn_busattachment_join(clientbus); alljoyn_busattachment_destroy(servicebus); alljoyn_busattachment_destroy(clientbus); alljoyn_buslistener_destroy(buslistener); alljoyn_busobject_destroy(testObj); if (inMemoryKeystore != NULL) { free(inMemoryKeystore); inMemoryKeystore = NULL; } } void SetUpAuthService() { /* register bus listener */ alljoyn_buslistener_callbacks buslistenerCbs = { NULL, NULL, NULL, NULL, &name_owner_changed, NULL, NULL, NULL }; buslistener = alljoyn_buslistener_create(&buslistenerCbs, NULL); alljoyn_busattachment_registerbuslistener(servicebus, buslistener); /* Set up bus object */ alljoyn_busobject_callbacks busObjCbs = { NULL, NULL, NULL, NULL }; testObj = alljoyn_busobject_create(OBJECT_PATH, QCC_FALSE, &busObjCbs, NULL); const alljoyn_interfacedescription exampleIntf = alljoyn_busattachment_getinterface(servicebus, INTERFACE_NAME); ASSERT_TRUE(exampleIntf); status = alljoyn_busobject_addinterface(testObj, exampleIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* register method handlers */ alljoyn_interfacedescription_member ping_member; QCC_BOOL foundMember = alljoyn_interfacedescription_getmember(exampleIntf, "ping", &ping_member); EXPECT_TRUE(foundMember); /* add methodhandlers */ alljoyn_busobject_methodentry methodEntries[] = { { &ping_member, ping_method }, }; status = alljoyn_busobject_addmethodhandlers(testObj, methodEntries, sizeof(methodEntries) / sizeof(methodEntries[0])); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_registerbusobject(servicebus, testObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); name_owner_changed_flag = QCC_FALSE; /* request name */ uint32_t flags = DBUS_NAME_FLAG_REPLACE_EXISTING | DBUS_NAME_FLAG_DO_NOT_QUEUE; status = alljoyn_busattachment_requestname(servicebus, OBJECT_NAME, flags); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 200; ++i) { if (name_owner_changed_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(name_owner_changed_flag); } void SetupAuthClient() { alljoyn_proxybusobject proxyObj = alljoyn_proxybusobject_create(clientbus, OBJECT_NAME, OBJECT_PATH, 0); EXPECT_TRUE(proxyObj); status = alljoyn_proxybusobject_introspectremoteobject(proxyObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_message reply = alljoyn_message_create(clientbus); alljoyn_msgarg input = alljoyn_msgarg_create_and_set("s", "AllJoyn"); status = alljoyn_proxybusobject_methodcall(proxyObj, INTERFACE_NAME, "ping", input, 1, reply, ALLJOYN_MESSAGE_DEFAULT_TIMEOUT, 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); const char* str; alljoyn_msgarg_get(alljoyn_message_getarg(reply, 0), "s", &str); EXPECT_STREQ("AllJoyn", str); alljoyn_message_destroy(reply); alljoyn_msgarg_destroy(input); alljoyn_proxybusobject_destroy(proxyObj); } void ResetAuthFlags() { requestcredentials_service_flag = QCC_FALSE; authenticationcomplete_service_flag = QCC_FALSE; requestcredentials_client_flag = QCC_FALSE; authenticationcomplete_client_flag = QCC_FALSE; keystorelistener_loadrequest_flag = QCC_FALSE; keystorelistener_storerequest_flag = QCC_FALSE; } QStatus status; alljoyn_busattachment servicebus; alljoyn_busattachment clientbus; alljoyn_busobject testObj; alljoyn_buslistener buslistener; }; /* AuthListener callback functions*/ static QStatus AJ_CALL authlistener_requestcredentialsasync_service_srp_keyx(const void* context, alljoyn_authlistener listener, const char* authMechanism, const char* peerName, uint16_t authCount, const char* userName, uint16_t credMask, void* authContext) { QCC_UNUSED(peerName); QCC_UNUSED(authCount); QCC_UNUSED(userName); alljoyn_credentials creds = alljoyn_credentials_create(); EXPECT_STREQ("context test string", (const char*)context); EXPECT_STREQ("ALLJOYN_SRP_KEYX", authMechanism); if (credMask & ALLJOYN_CRED_PASSWORD) { alljoyn_credentials_setpassword(creds, "ABCDEFGH"); } QStatus status = alljoyn_authlistener_requestcredentialsresponse(listener, authContext, QCC_TRUE, creds); alljoyn_credentials_destroy(creds); requestcredentials_service_flag = QCC_TRUE; return status; } static void AJ_CALL alljoyn_authlistener_authenticationcomplete_service_srp_keyx(const void* context, const char* authMechanism, const char* peerName, QCC_BOOL success) { QCC_UNUSED(authMechanism); QCC_UNUSED(peerName); EXPECT_STREQ("context test string", (const char*)context); EXPECT_TRUE(success); authenticationcomplete_service_flag = QCC_TRUE; } static QStatus AJ_CALL authlistener_requestcredentialsasync_client_srp_keyx(const void* context, alljoyn_authlistener listener, const char* authMechanism, const char* peerName, uint16_t authCount, const char* userName, uint16_t credMask, void* authContext) { QCC_UNUSED(peerName); QCC_UNUSED(authCount); QCC_UNUSED(userName); alljoyn_credentials creds = alljoyn_credentials_create(); EXPECT_STREQ("context test string", (const char*)context); EXPECT_STREQ("ALLJOYN_SRP_KEYX", authMechanism); if (credMask & ALLJOYN_CRED_PASSWORD) { alljoyn_credentials_setpassword(creds, "ABCDEFGH"); } QStatus status = alljoyn_authlistener_requestcredentialsresponse(listener, authContext, QCC_TRUE, creds); alljoyn_credentials_destroy(creds); requestcredentials_client_flag = QCC_TRUE; return status; } static void AJ_CALL alljoyn_authlistener_authenticationcomplete_client_srp_keyx(const void* context, const char* authMechanism, const char* peerName, QCC_BOOL success) { QCC_UNUSED(authMechanism); QCC_UNUSED(peerName); EXPECT_STREQ("context test string", (const char*)context); EXPECT_TRUE(success); authenticationcomplete_client_flag = QCC_TRUE; } TEST_F(KeyStoreListenerTest, register_keystore) { ResetAuthFlags(); alljoyn_busattachment_clearkeystore(clientbus); /* set up the service */ alljoyn_keystorelistener_callbacks keystore_cb = { &alljoyn_keystorelistener_loadrequest, &alljoyn_keystorelistener_storerequest }; alljoyn_keystorelistener keystorelistener = alljoyn_keystorelistener_create(&keystore_cb, &keystorelistener); status = alljoyn_busattachment_registerkeystorelistener(servicebus, keystorelistener); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_authlistenerasync_callbacks authlistener_cb_service = { authlistener_requestcredentialsasync_service_srp_keyx, //requestcredentialsasync NULL, //verifycredentialsasync NULL, //securityviolation alljoyn_authlistener_authenticationcomplete_service_srp_keyx //authenticationcomplete }; alljoyn_authlistener serviceauthlistener = alljoyn_authlistenerasync_create(&authlistener_cb_service, (void*)"context test string"); status = alljoyn_busattachment_enablepeersecurity(servicebus, "ALLJOYN_SRP_KEYX", serviceauthlistener, NULL, QCC_FALSE); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* Clear the Keystore between runs */ alljoyn_busattachment_clearkeystore(servicebus); SetUpAuthService(); /* set up the client */ alljoyn_authlistenerasync_callbacks authlistener_cb_client = { authlistener_requestcredentialsasync_client_srp_keyx, //requestcredentialsasync NULL, //verifycredentialsasync NULL, //securityviolation alljoyn_authlistener_authenticationcomplete_client_srp_keyx //authenticationcomplete }; alljoyn_authlistener clientauthlistener = alljoyn_authlistenerasync_create(&authlistener_cb_client, (void*)"context test string"); status = alljoyn_busattachment_enablepeersecurity(clientbus, "ALLJOYN_SRP_KEYX", clientauthlistener, NULL, QCC_FALSE); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* Clear the Keystore between runs */ alljoyn_busattachment_clearkeystore(clientbus); SetupAuthClient(); EXPECT_TRUE(requestcredentials_service_flag); EXPECT_TRUE(authenticationcomplete_service_flag); EXPECT_TRUE(requestcredentials_client_flag); EXPECT_TRUE(authenticationcomplete_client_flag); EXPECT_TRUE(keystorelistener_loadrequest_flag); EXPECT_TRUE(keystorelistener_storerequest_flag); alljoyn_keystorelistener_destroy(keystorelistener); alljoyn_authlistenerasync_destroy(serviceauthlistener); alljoyn_authlistenerasync_destroy(clientauthlistener); } alljoyn-15.04b/alljoyn_c/unit_test/MessageTest.cc000066400000000000000000000310661255700255500220740ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include "ajTestCommon.h" #include #include #include #include #include #include /*constants*/ static const char* INTERFACE_NAME = "org.alljoyn.test.MessageTest"; static const char* OBJECT_NAME = "org.alljoyn.test.MessageTest"; static const char* OBJECT_PATH = "/org/alljoyn/test/MessageTest"; static QCC_BOOL name_owner_changed_flag = QCC_FALSE; /* Exposed methods */ static void AJ_CALL ping_method(alljoyn_busobject bus, const alljoyn_interfacedescription_member* member, alljoyn_message msg) { QCC_UNUSED(member); alljoyn_msgarg outArg = alljoyn_msgarg_create(); alljoyn_msgarg inArg = alljoyn_message_getarg(msg, 0); const char* str; alljoyn_msgarg_get(inArg, "s", &str); alljoyn_msgarg_set(outArg, "s", str); QStatus status = alljoyn_busobject_methodreply_args(bus, msg, outArg, 1); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg_destroy(outArg); } /* NameOwnerChanged callback */ static void AJ_CALL name_owner_changed(const void* context, const char* busName, const char* previousOwner, const char* newOwner) { QCC_UNUSED(context); QCC_UNUSED(previousOwner); QCC_UNUSED(newOwner); if (strcmp(busName, OBJECT_NAME) == 0) { name_owner_changed_flag = QCC_TRUE; } } class MessageTest : public testing::Test { public: virtual void SetUp() { bus = alljoyn_busattachment_create("ProxyBusObjectTest", false); status = alljoyn_busattachment_start(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(bus, ajn::getConnectArg().c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); } virtual void TearDown() { EXPECT_NO_FATAL_FAILURE(alljoyn_busattachment_destroy(bus)); } void SetUpMessageTestService() { /* create/start/connect alljoyn_busattachment */ servicebus = alljoyn_busattachment_create("MessageTestservice", false); status = alljoyn_busattachment_start(servicebus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(servicebus, ajn::getConnectArg().c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* create/activate alljoyn_interface */ alljoyn_interfacedescription testIntf = NULL; status = alljoyn_busattachment_createinterface(servicebus, INTERFACE_NAME, &testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(testIntf != NULL); status = alljoyn_interfacedescription_addmember(testIntf, ALLJOYN_MESSAGE_METHOD_CALL, "ping", "s", "s", "in,out", 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription_activate(testIntf); /* register bus listener */ alljoyn_buslistener_callbacks buslistenerCbs = { NULL, NULL, NULL, NULL, &name_owner_changed, NULL, NULL, NULL }; buslistener = alljoyn_buslistener_create(&buslistenerCbs, NULL); alljoyn_busattachment_registerbuslistener(servicebus, buslistener); /* Set up bus object */ alljoyn_busobject_callbacks busObjCbs = { NULL, NULL, NULL, NULL }; testObj = alljoyn_busobject_create(OBJECT_PATH, QCC_FALSE, &busObjCbs, NULL); const alljoyn_interfacedescription exampleIntf = alljoyn_busattachment_getinterface(servicebus, INTERFACE_NAME); ASSERT_TRUE(exampleIntf); status = alljoyn_busobject_addinterface(testObj, exampleIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* register method handlers */ alljoyn_interfacedescription_member ping_member; QCC_BOOL foundMember = alljoyn_interfacedescription_getmember(exampleIntf, "ping", &ping_member); EXPECT_TRUE(foundMember); /* add methodhandlers */ // alljoyn_busobject_methodentry methodEntries[] = {, // { &ping_member, ping_method }, // }; // status = alljoyn_busobject_addmethodhandlers(testObj, methodEntries, sizeof(methodEntries) / sizeof(methodEntries[0])); status = alljoyn_busobject_addmethodhandler(testObj, ping_member, &ping_method, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_registerbusobject(servicebus, testObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); name_owner_changed_flag = QCC_FALSE; /* request name */ uint32_t flags = DBUS_NAME_FLAG_REPLACE_EXISTING | DBUS_NAME_FLAG_DO_NOT_QUEUE; status = alljoyn_busattachment_requestname(servicebus, OBJECT_NAME, flags); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 200; ++i) { if (name_owner_changed_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(name_owner_changed_flag); } void TearDownMessageTestService() { alljoyn_busattachment_unregisterbuslistener(servicebus, buslistener); /* * must destroy the busattachment before destroying the buslistener or * the code will segfault when the code tries to call the bus_stopping * callback. */ alljoyn_busattachment_destroy(servicebus); alljoyn_buslistener_destroy(buslistener); alljoyn_busobject_destroy(testObj); } QStatus status; alljoyn_busattachment bus; alljoyn_busattachment servicebus; alljoyn_buslistener buslistener; alljoyn_busobject testObj; }; TEST_F(MessageTest, getarg__getargs_parseargs) { SetUpMessageTestService(); alljoyn_proxybusobject proxyObj = alljoyn_proxybusobject_create(bus, OBJECT_NAME, OBJECT_PATH, 0); EXPECT_TRUE(proxyObj); status = alljoyn_proxybusobject_introspectremoteobject(proxyObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_message reply = alljoyn_message_create(bus); alljoyn_msgarg input = alljoyn_msgarg_create_and_set("s", "AllJoyn"); status = alljoyn_proxybusobject_methodcall(proxyObj, INTERFACE_NAME, "ping", input, 1, reply, ALLJOYN_MESSAGE_DEFAULT_TIMEOUT, 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); const char* str; alljoyn_msgarg_get(alljoyn_message_getarg(reply, 0), "s", &str); EXPECT_STREQ("AllJoyn", str); str = NULL; alljoyn_msgarg output; size_t numArgs; alljoyn_message_getargs(reply, &numArgs, &output); EXPECT_EQ((size_t)1, numArgs); alljoyn_msgarg arg = alljoyn_msgarg_array_element(output, 0); size_t buf = alljoyn_msgarg_signature(arg, NULL, 0); char* val = (char*)malloc(sizeof(char) * buf); alljoyn_msgarg_signature(arg, val, buf); EXPECT_STREQ("s", val); free(val); status = alljoyn_msgarg_get(alljoyn_msgarg_array_element(output, 0), "s", &str); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("AllJoyn", str); str = NULL; status = alljoyn_message_parseargs(reply, "s", &str); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("AllJoyn", str); alljoyn_message_destroy(reply); alljoyn_msgarg_destroy(input); alljoyn_proxybusobject_destroy(proxyObj); TearDownMessageTestService(); } /* * The alljoyn_message_description and alljoyn_message_tostring function are some * of the few functions that behave differently with the release variant vs. * the debug variant. */ TEST_F(MessageTest, message_properties) { SetUpMessageTestService(); alljoyn_proxybusobject proxyObj = alljoyn_proxybusobject_create(bus, OBJECT_NAME, OBJECT_PATH, 0); EXPECT_TRUE(proxyObj); status = alljoyn_proxybusobject_introspectremoteobject(proxyObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_message reply = alljoyn_message_create(bus); alljoyn_msgarg input = alljoyn_msgarg_create_and_set("s", "AllJoyn"); status = alljoyn_proxybusobject_methodcall(proxyObj, INTERFACE_NAME, "ping", input, 1, reply, ALLJOYN_MESSAGE_DEFAULT_TIMEOUT, 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg_destroy(input); EXPECT_FALSE(alljoyn_message_isbroadcastsignal(reply)); EXPECT_FALSE(alljoyn_message_isglobalbroadcast(reply)); EXPECT_FALSE(alljoyn_message_issessionless(reply)); uint32_t timeLeft; EXPECT_FALSE(alljoyn_message_isexpired(reply, &timeLeft)); EXPECT_NE((uint32_t)0, timeLeft); EXPECT_FALSE(alljoyn_message_isunreliable(reply)); EXPECT_FALSE(alljoyn_message_isencrypted(reply)); /* we don't expect any of the flags to be set */ EXPECT_EQ(0, alljoyn_message_getflags(reply)); /* no security is being used so there should not be an auth mechanism specified */ EXPECT_STREQ("", alljoyn_message_getauthmechanism(reply)); EXPECT_EQ(ALLJOYN_MESSAGE_METHOD_RET, alljoyn_message_gettype(reply)); /* The serial is unknown but it should not be zero */ EXPECT_NE((uint32_t)0, alljoyn_message_getcallserial(reply)); EXPECT_NE((uint32_t)0, alljoyn_message_getreplyserial(reply)); EXPECT_STREQ("s", alljoyn_message_getsignature(reply)); /* in this instance we can not find objectpathm interface name , or member name from the message*/ EXPECT_STREQ("", alljoyn_message_getobjectpath(reply)); EXPECT_STREQ("", alljoyn_message_getinterface(reply)); EXPECT_STREQ("", alljoyn_message_getmembername(reply)); const char* destination_uniqueName; destination_uniqueName = alljoyn_busattachment_getuniquename(bus); EXPECT_STREQ(destination_uniqueName, alljoyn_message_getdestination(reply)); EXPECT_STREQ(destination_uniqueName, alljoyn_message_getreceiveendpointname(reply)); const char* sender_uniqueName; sender_uniqueName = alljoyn_busattachment_getuniquename(servicebus); EXPECT_STREQ(sender_uniqueName, alljoyn_message_getsender(reply)); EXPECT_EQ((alljoyn_sessionid)0, alljoyn_message_getsessionid(reply)); #if NDEBUG char* str; size_t buf; buf = alljoyn_message_tostring(reply, NULL, 0); str = (char*)malloc(sizeof(char) * buf); alljoyn_message_tostring(reply, str, buf); qcc::String strTest = str; free(str); buf = alljoyn_message_description(reply, NULL, 0); str = (char*)malloc(sizeof(char) * buf); alljoyn_message_description(reply, str, buf); EXPECT_STREQ("", str); free(str); #else char* str; size_t buf; buf = alljoyn_message_tostring(reply, NULL, 0); str = (char*)malloc(sizeof(char) * buf); alljoyn_message_tostring(reply, str, buf); qcc::String strTest = str; /* all messages should start by stating the endianness */ EXPECT_EQ((size_t)0, strTest.find_first_of(" #include #include #include #include #include "ajTestCommon.h" TEST(MsgArgTest, Basic) { /* BYTE */ static uint8_t y = 0; /* BOOLEAN */ static bool b = true; /* INT16 */ static int16_t n = 42; /* UINT16 */ static uint16_t q = 0xBEBE; /* DOUBLE */ static double d = 3.14159265L; /* UINT32 */ static int32_t i = -9999; /* UINT32 */ static uint32_t u = 0x32323232; /* INT64 */ static int64_t x = -1LL; /* UINT64 */ static uint64_t t = 0x6464646464646464ULL; /* STRING */ static const char*s = "this is a string"; /* OBJECT_PATH */ static const char*o = "/org/foo/bar"; /* SIGNATURE */ static const char*g = "a{is}d(siiux)"; /* Array of UINT64 */ static int64_t at[] = { -8, -88, 888, 8888 }; /* BYTE */ uint8_t yout; /* BOOLEAN */ bool bout; QCC_BOOL qccbout; /* INT16 */ int16_t nout; /* UINT16 */ uint16_t qout; /* DOUBLE */ double dout; /* INT32 */ int32_t iout; /* UINT32 */ uint32_t uout; /* INT64 */ int64_t xout; /* UINT64 */ uint64_t tout; /* STRING */ const char* sout; /* OBJECT_PATH */ const char* oout; /* SIGNATURE */ const char* gout; QStatus status = ER_OK; alljoyn_msgarg arg = NULL; status = alljoyn_msgarg_set(arg, "i", -9999); EXPECT_EQ(ER_BAD_ARG_1, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_msgarg_get(arg, "i", &iout); EXPECT_EQ(ER_BAD_ARG_1, status) << " Actual Status: " << QCC_StatusText(status); arg = alljoyn_msgarg_create(); EXPECT_TRUE(arg != NULL); status = alljoyn_msgarg_set(arg, "i", -9999); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_msgarg_get(arg, "i", &iout); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_EQ(iout, -9999); status = alljoyn_msgarg_set(arg, "s", "hello"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); char* str; status = alljoyn_msgarg_get(arg, "s", &str); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_STREQ("hello", str); status = alljoyn_msgarg_set(arg, "b", true); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_msgarg_get_bool(arg, &qccbout); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_EQ(QCC_TRUE, qccbout); status = alljoyn_msgarg_set(arg, "b", false); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_msgarg_get_bool(arg, &qccbout); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_EQ(QCC_FALSE, qccbout); alljoyn_msgarg_destroy(arg); alljoyn_msgarg argList = NULL; argList = alljoyn_msgarg_create(); EXPECT_TRUE(argList != NULL); status = alljoyn_msgarg_set(argList, "(ybnqdiuxtsoqg)", y, b, n, q, d, i, u, x, t, s, o, q, g); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_msgarg_get(argList, "(ybnqdiuxtsoqg)", &yout, &bout, &nout, &qout, &dout, &iout, &uout, &xout, &tout, &sout, &oout, &qout, &gout); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_EQ(yout, 0); EXPECT_EQ(bout, true); EXPECT_EQ(nout, 42); EXPECT_EQ(qout, 0xBEBE); EXPECT_EQ(iout, -9999); EXPECT_EQ(uout, 0x32323232u); EXPECT_EQ(xout, -1LL); EXPECT_EQ(tout, 0x6464646464646464ULL); ASSERT_STREQ(sout, "this is a string"); ASSERT_STREQ(oout, "/org/foo/bar"); EXPECT_EQ(qout, 0xBEBE); ASSERT_STREQ(gout, "a{is}d(siiux)"); alljoyn_msgarg_destroy(argList); argList = alljoyn_msgarg_create(); EXPECT_TRUE(argList != NULL); /* Structs */ EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_msgarg_set(argList, "((ydx)(its))", y, d, x, i, t, s); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_msgarg_get(argList, "((ydx)(its))", &yout, &dout, &xout, &iout, &tout, &sout); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_EQ(yout, 0); EXPECT_EQ(xout, -1LL); EXPECT_EQ(iout, -9999); EXPECT_EQ(tout, 0x6464646464646464ULL); EXPECT_STREQ(sout, "this is a string"); alljoyn_msgarg_destroy(argList); argList = alljoyn_msgarg_create(); EXPECT_TRUE(argList != NULL); status = alljoyn_msgarg_set(argList, "((iuiu)(yd)at)", i, u, i, u, y, d, sizeof(at) / sizeof(at[0]), at); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); int64_t*p64; size_t p64len; status = alljoyn_msgarg_get(argList, "((iuiu)(yd)at)", &iout, &uout, &iout, &uout, &yout, &dout, &p64len, &p64); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_EQ(iout, -9999); EXPECT_EQ(uout, 0x32323232u); EXPECT_EQ(yout, 0); EXPECT_EQ(p64len, sizeof(at) / sizeof(at[0])); for (size_t k = 0; k < p64len; ++k) { EXPECT_EQ(at[k], p64[k]) << "index " << k; } alljoyn_msgarg_destroy(argList); } TEST(MsgArgTest, Variants) { /* DOUBLE */ static double d = 3.14159265L; /* STRING */ static const char* s = "this is a string"; int32_t i; double dt; char* str; QStatus status = ER_OK; alljoyn_msgarg arg = NULL; alljoyn_msgarg arg2 = NULL; arg = alljoyn_msgarg_create(); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); arg2 = alljoyn_msgarg_create_and_set("i", 420); status = alljoyn_msgarg_set(arg, "v", arg2); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_msgarg_get(arg, "u", &i); EXPECT_EQ(ER_BUS_SIGNATURE_MISMATCH, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg_destroy(arg2); arg2 = alljoyn_msgarg_create_and_set("d", &d); status = alljoyn_msgarg_set(arg, "v", arg2); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_msgarg_get(arg, "i", &i); EXPECT_EQ(ER_BUS_SIGNATURE_MISMATCH, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_msgarg_get(arg, "s", &str); EXPECT_EQ(ER_BUS_SIGNATURE_MISMATCH, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_msgarg_get(arg, "d", &dt); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg_destroy(arg2); arg2 = alljoyn_msgarg_create_and_set("s", s); status = alljoyn_msgarg_set(arg, "v", arg2); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_msgarg_get(arg, "i", &i); EXPECT_EQ(ER_BUS_SIGNATURE_MISMATCH, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_msgarg_get(arg, "s", &str); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_STREQ(s, str); alljoyn_msgarg_destroy(arg2); alljoyn_msgarg_destroy(arg); } TEST(MsgArgTest, arrays_of_scalars) { QStatus status = ER_OK; /* Array of BYTE */ uint8_t ay[] = { 9, 19, 29, 39, 49 }; /* Array of QCC_BOOL */ static QCC_BOOL ab[] = { QCC_FALSE, QCC_FALSE, QCC_TRUE, QCC_TRUE, QCC_TRUE, QCC_FALSE }; /* Array of INT16 */ static int16_t an[] = { -9, -99, 999, 9999 }; /* Array of INT32 */ static int32_t ai[] = { -8, -88, 888, 8888 }; /* Array of INT64 */ static int64_t ax[] = { -8, -88, 888, 8888 }; /* Array of UINT64 */ static int64_t at[] = { -8, -88, 888, 8888 }; /* Array of DOUBLE */ static double ad[] = { 0.001, 0.01, 0.1, 1.0, 10.0, 100.0 }; /* * Arrays of scalars */ { alljoyn_msgarg arg = alljoyn_msgarg_create(); status = alljoyn_msgarg_set(arg, "ay", sizeof(ay) / sizeof(ay[0]), ay); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); uint8_t* pay; size_t lay; status = alljoyn_msgarg_get(arg, "ay", &lay, &pay); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_EQ(sizeof(ay) / sizeof(ay[0]), lay); for (size_t i = 0; i < lay; ++i) { EXPECT_EQ(ay[i], pay[i]); } alljoyn_msgarg_destroy(arg); } { alljoyn_msgarg arg = alljoyn_msgarg_create(); status = alljoyn_msgarg_set(arg, "ab", sizeof(ab) / sizeof(ab[0]), ab); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); QCC_BOOL* pab; size_t lab; status = alljoyn_msgarg_get(arg, "ab", &lab, &pab); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_EQ(sizeof(ab) / sizeof(ab[0]), lab); for (size_t i = 0; i < lab; ++i) { EXPECT_EQ(ab[i], pab[i]) << "i = " << i << " ab[i] = " << ((ab[i]) ? "true" : "false") << " pab[i] = " << ((pab[i]) ? "true" : "false"); } alljoyn_msgarg_destroy(arg); } { alljoyn_msgarg arg = alljoyn_msgarg_create(); status = alljoyn_msgarg_set(arg, "an", sizeof(an) / sizeof(an[0]), an); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); int16_t* pan; size_t lan; status = alljoyn_msgarg_get(arg, "an", &lan, &pan); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_EQ(sizeof(an) / sizeof(an[0]), lan); for (size_t i = 0; i < lan; ++i) { EXPECT_EQ(an[i], pan[i]); } alljoyn_msgarg_destroy(arg); } { alljoyn_msgarg arg = alljoyn_msgarg_create(); status = alljoyn_msgarg_set(arg, "ai", sizeof(ai) / sizeof(ai[0]), ai); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); int32_t* pai; size_t lai; status = alljoyn_msgarg_get(arg, "ai", &lai, &pai); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_EQ(sizeof(ai) / sizeof(ai[0]), lai); for (size_t i = 0; i < lai; ++i) { EXPECT_EQ(ai[i], pai[i]); } alljoyn_msgarg_destroy(arg); } { alljoyn_msgarg arg = alljoyn_msgarg_create(); status = alljoyn_msgarg_set(arg, "ax", sizeof(ax) / sizeof(ax[0]), ax); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); int64_t* pax; size_t lax; status = alljoyn_msgarg_get(arg, "ax", &lax, &pax); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_EQ(sizeof(ax) / sizeof(ax[0]), lax); for (size_t i = 0; i < lax; ++i) { EXPECT_EQ(ax[i], pax[i]); } alljoyn_msgarg_destroy(arg); } { alljoyn_msgarg arg = alljoyn_msgarg_create(); status = alljoyn_msgarg_set(arg, "at", sizeof(at) / sizeof(at[0]), at); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); int64_t* pat; size_t lat; status = alljoyn_msgarg_get(arg, "at", &lat, &pat); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_EQ(sizeof(at) / sizeof(at[0]), lat); for (size_t i = 0; i < lat; ++i) { EXPECT_EQ(at[i], pat[i]); } alljoyn_msgarg_destroy(arg); } { alljoyn_msgarg arg = alljoyn_msgarg_create(); status = alljoyn_msgarg_set(arg, "ad", sizeof(ad) / sizeof(ad[0]), ad); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); double* pad; size_t lad; status = alljoyn_msgarg_get(arg, "ad", &lad, &pad); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_EQ(sizeof(ad) / sizeof(ad[0]), lad); for (size_t i = 0; i < lad; ++i) { EXPECT_EQ(ad[i], pad[i]); } alljoyn_msgarg_destroy(arg); } } TEST(MsgArgTest, arrays_of_nonscalars) { QStatus status = ER_OK; /* Array of STRING */ static const char*as[] = { "one", "two", "three", "four" }; /* Array of OBJECT_PATH */ static const char*ao[] = { "/org/one", "/org/two", "/org/three", "/org/four" }; /* Array of SIGNATURE */ static const char*ag[] = { "s", "sss", "as", "a(iiiiuu)" }; alljoyn_msgarg arg; arg = alljoyn_msgarg_create(); ASSERT_TRUE(arg != NULL); status = alljoyn_msgarg_set(arg, "as", sizeof(as) / sizeof(as[0]), as); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg pas; char*str[4]; size_t las; status = alljoyn_msgarg_get(arg, "as", &las, &pas); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_EQ(sizeof(as) / sizeof(as[0]), las); ASSERT_TRUE(arg); ASSERT_TRUE(pas); for (size_t k = 0; k < las; k++) { ASSERT_TRUE(alljoyn_msgarg_array_element(pas, k)); status = alljoyn_msgarg_get(alljoyn_msgarg_array_element(pas, k), "s", &str[k]); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(str[k]); EXPECT_STREQ(as[k], str[k]); } status = alljoyn_msgarg_set(arg, "ag", sizeof(ag) / sizeof(ag[0]), ag); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg pag; char* str_ag[4]; size_t lag; status = alljoyn_msgarg_get(arg, "ag", &lag, &pag); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_EQ(sizeof(ag) / sizeof(ag[0]), lag); for (size_t k = 0; k < lag; k++) { status = alljoyn_msgarg_get(alljoyn_msgarg_array_element(pag, k), "g", &str_ag[k]); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(str_ag[k]); EXPECT_STREQ(ag[k], str_ag[k]); } status = alljoyn_msgarg_set(arg, "ao", sizeof(ao) / sizeof(ao[0]), ao); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg pao; char* str_ao[4]; size_t lao; status = alljoyn_msgarg_get(arg, "ao", &lao, &pao); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_EQ(sizeof(ao) / sizeof(ao[0]), lao); for (size_t k = 0; k < lao; k++) { status = alljoyn_msgarg_get(alljoyn_msgarg_array_element(pao, k), "o", &str_ao[k]); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(str_ao[k]); EXPECT_STREQ(ao[k], str_ao[k]); } alljoyn_msgarg_destroy(arg); } TEST(MsgArgTest, Dictionary) { QStatus status = ER_OK; const char*keys[] = { "red", "green", "blue", "yellow" }; //size_t numEntries = sizeof(keys) / sizeof(keys[0]); alljoyn_msgarg dictEntries = NULL; alljoyn_msgarg values = NULL; dictEntries = alljoyn_msgarg_array_create(sizeof(keys) / sizeof(keys[0])); values = alljoyn_msgarg_array_create(sizeof(keys) / sizeof(keys[0])); alljoyn_msgarg_set(alljoyn_msgarg_array_element(values, 0), "s", keys[0]); alljoyn_msgarg_set(alljoyn_msgarg_array_element(values, 1), "(ss)", keys[1], "bean"); alljoyn_msgarg_set(alljoyn_msgarg_array_element(values, 2), "s", keys[2]); alljoyn_msgarg_set(alljoyn_msgarg_array_element(values, 3), "(ss)", keys[3], "mellow"); status = alljoyn_msgarg_set(alljoyn_msgarg_array_element(dictEntries, 0), "{iv}", 1, alljoyn_msgarg_array_element(values, 0)); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_msgarg_set(alljoyn_msgarg_array_element(dictEntries, 1), "{iv}", 1, alljoyn_msgarg_array_element(values, 1)); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_msgarg_set(alljoyn_msgarg_array_element(dictEntries, 2), "{iv}", 1, alljoyn_msgarg_array_element(values, 2)); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_msgarg_set(alljoyn_msgarg_array_element(dictEntries, 3), "{iv}", 1, alljoyn_msgarg_array_element(values, 3)); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg dict = alljoyn_msgarg_create(); status = alljoyn_msgarg_set(dict, "a{iv}", sizeof(keys) / sizeof(keys[0]), dictEntries); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg entries; size_t num; status = alljoyn_msgarg_get(dict, "a{iv}", &num, &entries); EXPECT_EQ(num, sizeof(keys) / sizeof(keys[0])); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < num; ++i) { char* str1; char* str2; int32_t key; status = alljoyn_msgarg_get(alljoyn_msgarg_array_element(entries, i), "{is}", &key, &str1); if (status == ER_BUS_SIGNATURE_MISMATCH) { status = alljoyn_msgarg_get(alljoyn_msgarg_array_element(entries, i), "{i(ss)}", &key, &str1, &str2); EXPECT_EQ(1, key); EXPECT_STREQ(keys[i], str1); if (i == 1) { EXPECT_STREQ("bean", str2); } else if (i == 3) { EXPECT_STREQ("mellow", str2); } } else if (status == ER_OK) { EXPECT_EQ(1, key); EXPECT_STREQ(keys[i], str1); } EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); } alljoyn_msgarg_destroy(dictEntries); alljoyn_msgarg_destroy(values); alljoyn_msgarg_destroy(dict); } TEST(MsgArgTest, alljoyn_msgarg_array_set_get) { QStatus status = ER_OK; alljoyn_msgarg arg; arg = alljoyn_msgarg_array_create(4); size_t numArgs = 4; status = alljoyn_msgarg_array_set(arg, &numArgs, "issi", 1, "two", "three", 4); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); int32_t argvalue1; char* argvalue2; char* argvalue3; int32_t argvalue4; status = alljoyn_msgarg_get(alljoyn_msgarg_array_element(arg, 0), "i", &argvalue1); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_EQ(1, argvalue1); status = alljoyn_msgarg_get(alljoyn_msgarg_array_element(arg, 1), "s", &argvalue2); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("two", argvalue2); status = alljoyn_msgarg_get(alljoyn_msgarg_array_element(arg, 2), "s", &argvalue3); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("three", argvalue3); status = alljoyn_msgarg_get(alljoyn_msgarg_array_element(arg, 3), "i", &argvalue4); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_EQ(4, argvalue4); int32_t out1; char* out2; char* out3; int32_t out4; status = alljoyn_msgarg_array_get(arg, 4, "issi", &out1, &out2, &out3, &out4); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_EQ(1, out1); EXPECT_STREQ("two", out2); EXPECT_STREQ("three", out3); EXPECT_EQ(4, out4); alljoyn_msgarg_destroy(arg); } /* * the tostring method is one of a few functions that has different behaver in * release build vs. debug build. * in release build tostring function will always return an empty string. * in debug build the tostring function will return an xml representation of the msgarg */ TEST(MsgArgTest, tostring) { QStatus status = ER_OK; alljoyn_msgarg arg; arg = alljoyn_msgarg_array_create(4); size_t numArgs = 4; status = alljoyn_msgarg_array_set(arg, &numArgs, "issi", 1, "two", "three", 4); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_EQ((size_t)4, numArgs); #if NDEBUG size_t buf; char* str; buf = alljoyn_msgarg_tostring(alljoyn_msgarg_array_element(arg, 0), NULL, 0, 0); str = (char*)malloc(sizeof(char) * buf); alljoyn_msgarg_tostring(alljoyn_msgarg_array_element(arg, 0), str, buf, 0); EXPECT_STREQ("", str); free(str); buf = alljoyn_msgarg_tostring(alljoyn_msgarg_array_element(arg, 1), NULL, 0, 0); str = (char*)malloc(sizeof(char) * buf); alljoyn_msgarg_tostring(alljoyn_msgarg_array_element(arg, 1), str, buf, 0); EXPECT_STREQ("", str); free(str); buf = alljoyn_msgarg_tostring(alljoyn_msgarg_array_element(arg, 2), NULL, 0, 0); str = (char*)malloc(sizeof(char) * buf); alljoyn_msgarg_tostring(alljoyn_msgarg_array_element(arg, 2), str, buf, 0); EXPECT_STREQ("", str); free(str); buf = alljoyn_msgarg_tostring(alljoyn_msgarg_array_element(arg, 3), NULL, 0, 0); str = (char*)malloc(sizeof(char) * buf); alljoyn_msgarg_tostring(alljoyn_msgarg_array_element(arg, 3), str, buf, 0); EXPECT_STREQ("", str); free(str); buf = alljoyn_msgarg_array_tostring(arg, 4, NULL, 0, 0); char* val = (char*)malloc(sizeof(char) * buf); alljoyn_msgarg_array_tostring(arg, 4, val, buf, 0); EXPECT_STREQ("", val); free(val); #else size_t buf; char* str; buf = alljoyn_msgarg_tostring(alljoyn_msgarg_array_element(arg, 0), NULL, 0, 0); str = (char*)malloc(sizeof(char) * buf); alljoyn_msgarg_tostring(alljoyn_msgarg_array_element(arg, 0), str, buf, 0); EXPECT_STREQ("1", str); free(str); buf = alljoyn_msgarg_tostring(alljoyn_msgarg_array_element(arg, 1), NULL, 0, 0); str = (char*)malloc(sizeof(char) * buf); alljoyn_msgarg_tostring(alljoyn_msgarg_array_element(arg, 1), str, buf, 0); EXPECT_STREQ("two", str); free(str); buf = alljoyn_msgarg_tostring(alljoyn_msgarg_array_element(arg, 2), NULL, 0, 0); str = (char*)malloc(sizeof(char) * buf); alljoyn_msgarg_tostring(alljoyn_msgarg_array_element(arg, 2), str, buf, 0); EXPECT_STREQ("three", str); free(str); buf = alljoyn_msgarg_tostring(alljoyn_msgarg_array_element(arg, 3), NULL, 0, 0); str = (char*)malloc(sizeof(char) * buf); alljoyn_msgarg_tostring(alljoyn_msgarg_array_element(arg, 3), str, buf, 0); EXPECT_STREQ("4", str); free(str); buf = alljoyn_msgarg_array_tostring(arg, 4, NULL, 0, 0); char* val = (char*)malloc(sizeof(char) * buf); alljoyn_msgarg_array_tostring(arg, 4, val, buf, 0); EXPECT_STREQ("1\ntwo\nthree\n4\n", val); free(val); #endif alljoyn_msgarg_destroy(arg); } TEST(MsgArgTest, signature) { alljoyn_msgarg arg1 = alljoyn_msgarg_create_and_set("i", 42); size_t buf = alljoyn_msgarg_signature(arg1, NULL, 0); char* val = (char*)malloc(sizeof(char) * buf); alljoyn_msgarg_signature(arg1, val, buf); EXPECT_STREQ("i", val); free(val); QStatus status = ER_OK; alljoyn_msgarg arg2; arg2 = alljoyn_msgarg_array_create(4); size_t numArgs = 4; status = alljoyn_msgarg_array_set(arg2, &numArgs, "issi", 1, "two", "three", 4); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); buf = alljoyn_msgarg_array_signature(arg2, 4, NULL, 0); val = (char*)malloc(sizeof(char) * buf); alljoyn_msgarg_array_signature(arg2, 4, val, buf); EXPECT_STREQ("issi", val); free(val); alljoyn_msgarg_destroy(arg1); alljoyn_msgarg_destroy(arg2); } TEST(MsgArgTest, hassignature) { alljoyn_msgarg arg = alljoyn_msgarg_create_and_set("i", 42); EXPECT_TRUE(alljoyn_msgarg_hassignature(arg, "i")); alljoyn_msgarg_destroy(arg); arg = alljoyn_msgarg_create_and_set("s", "whats 6 times 7"); EXPECT_FALSE(alljoyn_msgarg_hassignature(arg, "i")); alljoyn_msgarg_destroy(arg); } TEST(MsgArgTest, equal) { alljoyn_msgarg arg1 = alljoyn_msgarg_create_and_set("i", 42); alljoyn_msgarg arg2 = alljoyn_msgarg_create_and_set("i", 42); // arg1 and arg2 should not have the same memory address. EXPECT_NE(arg1, arg2); EXPECT_TRUE(alljoyn_msgarg_equal(arg1, arg2)); alljoyn_msgarg_destroy(arg1); alljoyn_msgarg_destroy(arg2); } TEST(MsgArgTest, copy) { alljoyn_msgarg arg1 = alljoyn_msgarg_create_and_set("s", "meaning of life"); alljoyn_msgarg arg2 = alljoyn_msgarg_copy(arg1); // arg1 and arg2 should not have the same memory address. EXPECT_NE(arg1, arg2); EXPECT_TRUE(alljoyn_msgarg_equal(arg1, arg2)); alljoyn_msgarg_destroy(arg1); alljoyn_msgarg_destroy(arg2); } TEST(MsgArgTest, getdictelement) { QStatus status = ER_OK; alljoyn_msgarg dictEntries; dictEntries = alljoyn_msgarg_array_create(3); status = alljoyn_msgarg_set(alljoyn_msgarg_array_element(dictEntries, 0), "{s(yus)}", "amy", 21, 151, "somewhere"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_msgarg_set(alljoyn_msgarg_array_element(dictEntries, 1), "{s(yus)}", "fred", 29, 212, "anywhere"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_msgarg_set(alljoyn_msgarg_array_element(dictEntries, 2), "{s(yus)}", "john", 33, 190, "nowhere"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg dict = alljoyn_msgarg_create(); status = alljoyn_msgarg_set(dict, "a{s(yus)}", 3, dictEntries); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); uint8_t age; uint32_t height; const char* address; status = alljoyn_msgarg_getdictelement(dict, "{s(yus)}", "fred", &age, &height, &address); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_EQ(29, age); EXPECT_TRUE(212 == height); EXPECT_STREQ("anywhere", address); status = alljoyn_msgarg_getdictelement(dict, "{ss}", "fred", &age, &height, &address); EXPECT_EQ(ER_BUS_SIGNATURE_MISMATCH, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_msgarg_getdictelement(dict, "{s(yus)}", "phil", &age, &height, &address); EXPECT_EQ(ER_BUS_ELEMENT_NOT_FOUND, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg arg = alljoyn_msgarg_create_and_set("i", 42); status = alljoyn_msgarg_getdictelement(arg, "{s(yus)}", "fred", &age, &height, &address); EXPECT_EQ(ER_BUS_NOT_A_DICTIONARY, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg_destroy(arg); alljoyn_msgarg_destroy(dictEntries); alljoyn_msgarg_destroy(dict); } TEST(MsgArgTest, clear_and_gettype) { alljoyn_msgarg arg = alljoyn_msgarg_create_and_set("i", 42); EXPECT_EQ(ALLJOYN_INT32, alljoyn_msgarg_gettype(arg)); alljoyn_msgarg_clear(arg); EXPECT_EQ(ALLJOYN_INVALID, alljoyn_msgarg_gettype(arg)); alljoyn_msgarg_destroy(arg); } TEST(MsgArgTest, stabilize) { QStatus status = ER_OK; alljoyn_msgarg arg; arg = alljoyn_msgarg_create(); { char str_pointer[16] = "GoodBye"; status = alljoyn_msgarg_set(arg, "s", str_pointer); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg_stabilize(arg); snprintf(str_pointer, 16, "%s", "stabilize"); } /* * Since MsgArg::Stabilize was called on the MsgArg before the string * pointed to went out of scope the contents of str_pointer were copied * into MsgArg. Using the Stabilize method creates a copy of anything * MsgArg is pointing to when it was called. */ char* out_str; status = alljoyn_msgarg_get(arg, "s", &out_str); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_STREQ("GoodBye", out_str); alljoyn_msgarg_destroy(arg); } TEST(MsgArgTest, null_pointer_test) { alljoyn_msgarg arg = NULL; alljoyn_msgarg arg2 = NULL; alljoyn_msgarg arg_array = NULL; QStatus status = ER_OK; EXPECT_NO_FATAL_FAILURE(alljoyn_msgarg_destroy(arg)); EXPECT_NO_FATAL_FAILURE(alljoyn_msgarg_destroy(arg_array)); EXPECT_NO_FATAL_FAILURE(alljoyn_msgarg_array_element(arg_array, 1)); EXPECT_NO_FATAL_FAILURE(status = alljoyn_msgarg_set(arg, "i", 42)); EXPECT_EQ(ER_BAD_ARG_1, status) << " Actual Status: " << QCC_StatusText(status); int32_t i; EXPECT_NO_FATAL_FAILURE(status = alljoyn_msgarg_get(arg, "i", &i)); EXPECT_EQ(ER_BAD_ARG_1, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_TRUE(NULL == alljoyn_msgarg_copy(arg)); EXPECT_FALSE(alljoyn_msgarg_equal(arg, arg2)); size_t numArgs = 1; EXPECT_NO_FATAL_FAILURE(status = alljoyn_msgarg_array_set(arg_array, &numArgs, "i", 42)); EXPECT_EQ(ER_BAD_ARG_1, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_NO_FATAL_FAILURE(status = alljoyn_msgarg_array_get(arg_array, 1, "i", &i)); EXPECT_EQ(ER_BAD_ARG_1, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_EQ((size_t)0, alljoyn_msgarg_tostring(arg, NULL, 0, 0)); size_t buf = alljoyn_msgarg_signature(arg, NULL, 0); char* val = (char*)malloc(sizeof(char) * buf); alljoyn_msgarg_signature(arg, val, buf); EXPECT_TRUE(0 == buf); free(val); buf = alljoyn_msgarg_array_signature(arg_array, numArgs, NULL, 0); val = (char*)malloc(sizeof(char) * buf); alljoyn_msgarg_array_signature(arg_array, numArgs, val, buf); EXPECT_TRUE(0 == buf); free(val); EXPECT_FALSE(alljoyn_msgarg_hassignature(arg, "i")); EXPECT_NO_FATAL_FAILURE(status = alljoyn_msgarg_getdictelement(arg, "{ii}", 1, &i)); EXPECT_EQ(ER_BAD_ARG_1, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_NO_FATAL_FAILURE(alljoyn_msgarg_clear(arg)); EXPECT_EQ(ALLJOYN_INVALID, alljoyn_msgarg_gettype(arg)); EXPECT_NO_FATAL_FAILURE(alljoyn_msgarg_stabilize(arg)); } alljoyn-15.04b/alljoyn_c/unit_test/ObjectSecurityTest.cc000066400000000000000000000405611255700255500234460ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include "ajTestCommon.h" #include #include #include #include #include #include static const char* INTERFACE_NAME = "org.alljoyn.test.c.authlistener"; static const char* OBJECT_NAME = "org.alljoyn.test.c.authlistener"; static const char* OBJECT_PATH = "/org/alljoyn/test"; static QCC_BOOL name_owner_changed_flag = QCC_FALSE; /* NameOwnerChanged callback */ static void AJ_CALL name_owner_changed(const void* context, const char* busName, const char* previousOwner, const char* newOwner) { QCC_UNUSED(context); QCC_UNUSED(previousOwner); QCC_UNUSED(newOwner); if (strcmp(busName, OBJECT_NAME) == 0) { name_owner_changed_flag = QCC_TRUE; } } /* Exposed methods */ static void AJ_CALL ping_method(alljoyn_busobject bus, const alljoyn_interfacedescription_member* member, alljoyn_message msg) { QCC_UNUSED(member); alljoyn_msgarg outArg = alljoyn_msgarg_create(); alljoyn_msgarg inArg = alljoyn_message_getarg(msg, 0); const char* str; alljoyn_msgarg_get(inArg, "s", &str); alljoyn_msgarg_set(outArg, "s", str); QStatus status = alljoyn_busobject_methodreply_args(bus, msg, outArg, 1); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg_destroy(outArg); } static QCC_BOOL requestcredentials_service_flag = QCC_FALSE; static QCC_BOOL authenticationcomplete_service_flag = QCC_FALSE; static QCC_BOOL requestcredentials_client_flag = QCC_FALSE; static QCC_BOOL authenticationcomplete_client_flag = QCC_FALSE; class ObjectSecurityTest : public testing::Test { public: virtual void SetUp() { /* initilize test fixture values to known start value */ status = ER_FAIL; servicebus = NULL; clientbus = NULL; testObj = NULL; buslistener = NULL; /* set up the service bus */ servicebus = alljoyn_busattachment_create("AuthListenerTestService", false); status = alljoyn_busattachment_start(servicebus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(servicebus, ajn::getConnectArg().c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); clientbus = alljoyn_busattachment_create("AuthListenerTestClient", false); status = alljoyn_busattachment_start(clientbus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(clientbus, ajn::getConnectArg().c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); } virtual void TearDown() { alljoyn_busattachment_stop(servicebus); alljoyn_busattachment_join(servicebus); alljoyn_busattachment_stop(clientbus); alljoyn_busattachment_join(clientbus); alljoyn_busattachment_destroy(servicebus); alljoyn_busattachment_destroy(clientbus); alljoyn_buslistener_destroy(buslistener); alljoyn_busobject_destroy(testObj); } void SetUpAuthServiceWithSecureBusObject() { /* register bus listener */ alljoyn_buslistener_callbacks buslistenerCbs = { NULL, NULL, NULL, NULL, &name_owner_changed, NULL, NULL, NULL }; buslistener = alljoyn_buslistener_create(&buslistenerCbs, NULL); alljoyn_busattachment_registerbuslistener(servicebus, buslistener); /* Set up bus object */ alljoyn_busobject_callbacks busObjCbs = { NULL, NULL, NULL, NULL }; testObj = alljoyn_busobject_create(OBJECT_PATH, QCC_FALSE, &busObjCbs, NULL); const alljoyn_interfacedescription exampleIntf = alljoyn_busattachment_getinterface(servicebus, INTERFACE_NAME); ASSERT_TRUE(exampleIntf); status = alljoyn_busobject_addinterface(testObj, exampleIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* register method handlers */ alljoyn_interfacedescription_member ping_member; QCC_BOOL foundMember = alljoyn_interfacedescription_getmember(exampleIntf, "ping", &ping_member); EXPECT_TRUE(foundMember); /* add methodhandlers */ alljoyn_busobject_methodentry methodEntries[] = { { &ping_member, ping_method }, }; status = alljoyn_busobject_addmethodhandlers(testObj, methodEntries, sizeof(methodEntries) / sizeof(methodEntries[0])); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); // the bus object has been registered as a secure busobject status = alljoyn_busattachment_registerbusobject_secure(servicebus, testObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_TRUE(alljoyn_busobject_issecure(testObj)); name_owner_changed_flag = QCC_FALSE; /* request name */ uint32_t flags = DBUS_NAME_FLAG_REPLACE_EXISTING | DBUS_NAME_FLAG_DO_NOT_QUEUE; status = alljoyn_busattachment_requestname(servicebus, OBJECT_NAME, flags); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 200; ++i) { if (name_owner_changed_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(name_owner_changed_flag); } void SetupAuthClientWitSecureProxyBusObject() { // make a secure proxybusobject alljoyn_proxybusobject proxyObj = alljoyn_proxybusobject_create_secure(clientbus, OBJECT_NAME, OBJECT_PATH, 0); EXPECT_TRUE(proxyObj); EXPECT_TRUE(alljoyn_proxybusobject_issecure(proxyObj)); status = alljoyn_proxybusobject_introspectremoteobject(proxyObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_message reply = alljoyn_message_create(clientbus); alljoyn_msgarg input = alljoyn_msgarg_create_and_set("s", "AllJoyn"); status = alljoyn_proxybusobject_methodcall(proxyObj, INTERFACE_NAME, "ping", input, 1, reply, ALLJOYN_MESSAGE_DEFAULT_TIMEOUT, 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); const char* str; alljoyn_msgarg_get(alljoyn_message_getarg(reply, 0), "s", &str); EXPECT_STREQ("AllJoyn", str); alljoyn_message_destroy(reply); alljoyn_msgarg_destroy(input); alljoyn_proxybusobject_destroy(proxyObj); } void ResetAuthFlags() { requestcredentials_service_flag = QCC_FALSE; authenticationcomplete_service_flag = QCC_FALSE; requestcredentials_client_flag = QCC_FALSE; authenticationcomplete_client_flag = QCC_FALSE; } QStatus status; alljoyn_busattachment servicebus; alljoyn_busattachment clientbus; alljoyn_busobject testObj; alljoyn_buslistener buslistener; }; /* AuthListener callback functions*/ static QCC_BOOL AJ_CALL authlistener_requestcredentials_service_srp_keyx(const void* context, const char* authMechanism, const char* peerName, uint16_t authCount, const char* userName, uint16_t credMask, alljoyn_credentials credentials) { QCC_UNUSED(context); QCC_UNUSED(peerName); QCC_UNUSED(authCount); QCC_UNUSED(userName); EXPECT_STREQ("ALLJOYN_SRP_KEYX", authMechanism); if (credMask & ALLJOYN_CRED_PASSWORD) { alljoyn_credentials_setpassword(credentials, "ABCDEFGH"); } requestcredentials_service_flag = QCC_TRUE; return QCC_TRUE; } static void AJ_CALL alljoyn_authlistener_authenticationcomplete_service_srp_keyx(const void* context, const char* authMechanism, const char* peerName, QCC_BOOL success) { QCC_UNUSED(context); QCC_UNUSED(authMechanism); QCC_UNUSED(peerName); EXPECT_TRUE(success); authenticationcomplete_service_flag = QCC_TRUE; } static QCC_BOOL AJ_CALL authlistener_requestcredentials_client_srp_keyx(const void* context, const char* authMechanism, const char* peerName, uint16_t authCount, const char* userName, uint16_t credMask, alljoyn_credentials credentials) { QCC_UNUSED(context); QCC_UNUSED(peerName); QCC_UNUSED(authCount); QCC_UNUSED(userName); EXPECT_STREQ("ALLJOYN_SRP_KEYX", authMechanism); if (credMask & ALLJOYN_CRED_PASSWORD) { alljoyn_credentials_setpassword(credentials, "ABCDEFGH"); } requestcredentials_client_flag = QCC_TRUE; return QCC_TRUE; } static void AJ_CALL alljoyn_authlistener_authenticationcomplete_client_srp_keyx(const void* context, const char* authMechanism, const char* peerName, QCC_BOOL success) { QCC_UNUSED(context); QCC_UNUSED(authMechanism); QCC_UNUSED(peerName); EXPECT_TRUE(success); authenticationcomplete_client_flag = QCC_TRUE; } TEST_F(ObjectSecurityTest, insecure_interface_sercure_object) { //create an interface that is not marked with any security alljoyn_interfacedescription service_intf; status = alljoyn_busattachment_createinterface(servicebus, INTERFACE_NAME, &service_intf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(service_intf != NULL); status = alljoyn_interfacedescription_addmember(service_intf, ALLJOYN_MESSAGE_METHOD_CALL, "ping", "s", "s", "in,out", 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription_activate(service_intf); //make sure all the auth flags are in a known state ResetAuthFlags(); /* * if an interface is created without security is should default to an * inherit security policy. */ EXPECT_EQ(AJ_IFC_SECURITY_INHERIT, alljoyn_interfacedescription_getsecuritypolicy(service_intf)); /* * clear the busattachment keystore to make sure authentication is performed * if needed. */ alljoyn_busattachment_clearkeystore(clientbus); /* set up the service */ alljoyn_authlistener_callbacks authlistener_cb_service = { authlistener_requestcredentials_service_srp_keyx, //requestcredentials NULL, //verifycredentials NULL, //securityviolation alljoyn_authlistener_authenticationcomplete_service_srp_keyx //authenticationcomplete }; alljoyn_authlistener serviceauthlistener = alljoyn_authlistener_create(&authlistener_cb_service, NULL); status = alljoyn_busattachment_enablepeersecurity(servicebus, "ALLJOYN_SRP_KEYX", serviceauthlistener, NULL, QCC_FALSE); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* Clear the Keystore between runs */ alljoyn_busattachment_clearkeystore(servicebus); SetUpAuthServiceWithSecureBusObject(); /* set up the client */ alljoyn_authlistener_callbacks authlistener_cb_client = { authlistener_requestcredentials_client_srp_keyx, //requestcredentials NULL, //verifycredentials NULL, //securityviolation alljoyn_authlistener_authenticationcomplete_client_srp_keyx //authenticationcomplete }; alljoyn_authlistener clientauthlistener = alljoyn_authlistener_create(&authlistener_cb_client, NULL); status = alljoyn_busattachment_enablepeersecurity(clientbus, "ALLJOYN_SRP_KEYX", clientauthlistener, NULL, QCC_FALSE); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* Clear the Keystore between runs */ alljoyn_busattachment_clearkeystore(clientbus); SetupAuthClientWitSecureProxyBusObject(); EXPECT_TRUE(requestcredentials_service_flag); EXPECT_TRUE(authenticationcomplete_service_flag); EXPECT_TRUE(requestcredentials_client_flag); EXPECT_TRUE(authenticationcomplete_client_flag); alljoyn_authlistener_destroy(serviceauthlistener); alljoyn_authlistener_destroy(clientauthlistener); } TEST_F(ObjectSecurityTest, interface_security_off_sercure_object) { //create an interface that is not marked with any security alljoyn_interfacedescription service_intf; status = alljoyn_busattachment_createinterface_secure(servicebus, INTERFACE_NAME, &service_intf, AJ_IFC_SECURITY_OFF); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(service_intf != NULL); status = alljoyn_interfacedescription_addmember(service_intf, ALLJOYN_MESSAGE_METHOD_CALL, "ping", "s", "s", "in,out", 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription_activate(service_intf); //make sure all the auth flags are in a known state ResetAuthFlags(); /* * if an interface is created with off security policy. */ EXPECT_EQ(AJ_IFC_SECURITY_OFF, alljoyn_interfacedescription_getsecuritypolicy(service_intf)); /* * clear the busattachment keystore to make sure authentication is performed * if needed. */ alljoyn_busattachment_clearkeystore(clientbus); /* set up the service */ alljoyn_authlistener_callbacks authlistener_cb_service = { authlistener_requestcredentials_service_srp_keyx, //requestcredentials NULL, //verifycredentials NULL, //securityviolation alljoyn_authlistener_authenticationcomplete_service_srp_keyx //authenticationcomplete }; alljoyn_authlistener serviceauthlistener = alljoyn_authlistener_create(&authlistener_cb_service, NULL); status = alljoyn_busattachment_enablepeersecurity(servicebus, "ALLJOYN_SRP_KEYX", serviceauthlistener, NULL, QCC_FALSE); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* Clear the Keystore between runs */ alljoyn_busattachment_clearkeystore(servicebus); SetUpAuthServiceWithSecureBusObject(); /* set up the client */ alljoyn_authlistener_callbacks authlistener_cb_client = { authlistener_requestcredentials_client_srp_keyx, //requestcredentials NULL, //verifycredentials NULL, //securityviolation alljoyn_authlistener_authenticationcomplete_client_srp_keyx //authenticationcomplete }; alljoyn_authlistener clientauthlistener = alljoyn_authlistener_create(&authlistener_cb_client, NULL); status = alljoyn_busattachment_enablepeersecurity(clientbus, "ALLJOYN_SRP_KEYX", clientauthlistener, NULL, QCC_FALSE); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* Clear the Keystore between runs */ alljoyn_busattachment_clearkeystore(clientbus); SetupAuthClientWitSecureProxyBusObject(); EXPECT_FALSE(requestcredentials_service_flag); EXPECT_FALSE(authenticationcomplete_service_flag); EXPECT_FALSE(requestcredentials_client_flag); EXPECT_FALSE(authenticationcomplete_client_flag); alljoyn_authlistener_destroy(serviceauthlistener); alljoyn_authlistener_destroy(clientauthlistener); } alljoyn-15.04b/alljoyn_c/unit_test/ObserverTest.cc000066400000000000000000001114741255700255500223010ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include /* Header files included for Google Test Framework */ #include #include "ajTestCommon.h" namespace test_unit_observerC { /* * This test suite is a straight-up port of the C++ Observer test suite. * Observer is a consumer-only concept, so only the consumer-related bits have * been converted to the C API to save some effort. */ using namespace std; using namespace qcc; using namespace ajn; #define INTF_A "org.test.a" #define INTF_B "org.test.b" #define METHOD "Identify" #define PATH_PREFIX "/test/" #define MAX_WAIT_MS 3000 #define STRESS_FACTOR 5 class TestObject : public BusObject { public: TestObject(BusAttachment& bus, qcc::String path, const vector& _interfaces) : BusObject(path.c_str()), bus(bus), path(path), interfaces(_interfaces) { busname = bus.GetUniqueName(); vector::iterator it; for (it = interfaces.begin(); it != interfaces.end(); ++it) { const InterfaceDescription* intf = bus.GetInterface(it->c_str()); EXPECT_TRUE(intf != NULL) << "failed to get interface " << it->c_str(); if (intf == NULL) { continue; } AddInterface(*intf, ANNOUNCED); QStatus status = AddMethodHandler(intf->GetMember(METHOD), static_cast(&TestObject::HandleIdentify)); EXPECT_EQ(ER_OK, status) << "Method handler registration failed"; } } virtual ~TestObject() { } void HandleIdentify(const InterfaceDescription::Member* member, Message& message) { QCC_UNUSED(member); MsgArg args[2] = { MsgArg("s", busname.c_str()), MsgArg("s", path.c_str()) }; EXPECT_EQ(ER_OK, MethodReply(message, args, 2)) << "Method reply failed"; } BusAttachment& bus; qcc::String busname; qcc::String path; vector interfaces; }; class Participant : public SessionPortListener, public SessionListener { public: alljoyn_busattachment cbus; BusAttachment& bus; String uniqueBusName; typedef std::pair ObjectState; typedef std::map ObjectMap; ObjectMap objects; SessionOpts opts; typedef std::map SessionMap; SessionMap hostedSessionMap; qcc::Mutex hsmLock; SessionPort port; bool acceptSessions; AboutData aboutData; AboutObj* aboutObj; Participant() : cbus(alljoyn_busattachment_create("Participant", QCC_TRUE)), bus(*(BusAttachment*)cbus), opts(SessionOpts::TRAFFIC_MESSAGES, false, SessionOpts::PROXIMITY_ANY, TRANSPORT_ANY), port(42), acceptSessions(true), aboutData("en"), aboutObj(new AboutObj(bus)) { Init(); } void Init() { QStatus status; ASSERT_EQ(ER_OK, bus.Start()); ASSERT_EQ(ER_OK, bus.Connect(getConnectArg().c_str())); ASSERT_EQ(ER_OK, bus.BindSessionPort(port, opts, *this)); uniqueBusName = bus.GetUniqueName(); /* create interfaces */ InterfaceDescription* intf = NULL; status = bus.CreateInterface(INTF_A, intf); ASSERT_EQ(ER_OK, status); ASSERT_TRUE(intf != NULL); status = intf->AddMethod(METHOD, "", "ss", "busname,path"); ASSERT_EQ(ER_OK, status); intf->Activate(); intf = NULL; status = bus.CreateInterface(INTF_B, intf); ASSERT_EQ(ER_OK, status); ASSERT_TRUE(intf != NULL); status = intf->AddMethod(METHOD, "", "ss", "busname,path"); ASSERT_EQ(ER_OK, status); intf->Activate(); /* set up totally uninteresting about data */ //AppId is a 128bit uuid uint8_t appId[] = { 0x01, 0xB3, 0xBA, 0x14, 0x1E, 0x82, 0x11, 0xE4, 0x86, 0x51, 0xD1, 0x56, 0x1D, 0x5D, 0x46, 0xB0 }; aboutData.SetAppId(appId, 16); aboutData.SetDeviceName("My Device Name"); //DeviceId is a string encoded 128bit UUID aboutData.SetDeviceId("93c06771-c725-48c2-b1ff-6a2a59d445b8"); aboutData.SetAppName("Application"); aboutData.SetManufacturer("Manufacturer"); aboutData.SetModelNumber("123456"); aboutData.SetDescription("A poetic description of this application"); aboutData.SetDateOfManufacture("2014-03-24"); aboutData.SetSoftwareVersion("0.1.2"); aboutData.SetHardwareVersion("0.0.1"); aboutData.SetSupportUrl("http://www.example.org"); ASSERT_EQ(ER_OK, aboutObj->Announce(port, aboutData)); } ~Participant() { Fini(); } void Fini() { ObjectMap::iterator it; for (it = objects.begin(); it != objects.end(); ++it) { if (it->second.second) { bus.UnregisterBusObject(*(it->second.first)); delete it->second.first; } } delete aboutObj; ASSERT_EQ(ER_OK, bus.Disconnect()); ASSERT_EQ(ER_OK, bus.Stop()); ASSERT_EQ(ER_OK, bus.Join()); alljoyn_busattachment_destroy(cbus); } void CreateObject(qcc::String name, vector interfaces) { qcc::String path = qcc::String(PATH_PREFIX) + name; TestObject* obj = new TestObject(bus, path, interfaces); ObjectState os(obj, false); objects.insert(make_pair(name, os)); } void RegisterObject(qcc::String name) { ObjectMap::iterator it = objects.find(name); ASSERT_NE(objects.end(), it) << "No such object."; ASSERT_FALSE(it->second.second) << "Object already on bus."; ASSERT_EQ(ER_OK, bus.RegisterBusObject(*(it->second.first))); it->second.second = true; ASSERT_EQ(ER_OK, aboutObj->Announce(port, aboutData)); } void UnregisterObject(qcc::String name) { ObjectMap::iterator it = objects.find(name); ASSERT_NE(objects.end(), it) << "No such object."; ASSERT_TRUE(it->second.second) << "Object not on bus."; bus.UnregisterBusObject(*(it->second.first)); it->second.second = false; ASSERT_EQ(ER_OK, aboutObj->Announce(port, aboutData)); } virtual bool AcceptSessionJoiner(SessionPort sessionPort, const char* joiner, const SessionOpts& opts) { QCC_UNUSED(sessionPort); QCC_UNUSED(joiner); QCC_UNUSED(opts); return acceptSessions; } virtual void SessionJoined(SessionPort sessionPort, SessionId id, const char* joiner) { QCC_UNUSED(sessionPort); hsmLock.Lock(MUTEX_CONTEXT); hostedSessionMap[joiner] = id; bus.SetHostedSessionListener(id, this); hsmLock.Unlock(MUTEX_CONTEXT); } virtual void SessionLost(SessionId sessionId, SessionLostReason reason) { QCC_UNUSED(reason); /* we only set a session listener on the hosted sessions */ hsmLock.Lock(MUTEX_CONTEXT); SessionMap::iterator iter = hostedSessionMap.begin(); while (iter != hostedSessionMap.end()) { if (iter->second == sessionId) { hostedSessionMap.erase(iter); iter = hostedSessionMap.begin(); } else { ++iter; } } hsmLock.Unlock(MUTEX_CONTEXT); } void CloseSession(Participant& joiner) { hsmLock.Lock(MUTEX_CONTEXT); SessionMap::iterator iter = hostedSessionMap.find(joiner.uniqueBusName); bool foundOngoingSession = (hostedSessionMap.end() != iter); if (!foundOngoingSession) { hsmLock.Unlock(MUTEX_CONTEXT); ASSERT_TRUE(foundOngoingSession) << "Could not find ongoing session."; } bus.LeaveHostedSession(iter->second); hostedSessionMap.erase(iter); hsmLock.Unlock(MUTEX_CONTEXT); } private: //Private copy constructor to prevent copying the class and double freeing of memory Participant(const Participant& rhs); //Private assignment operator to prevent copying the class and double freeing of memory Participant& operator=(const Participant& rhs); }; class ObserverTest : public testing::Test { public: vector intfA; vector intfB; vector intfAB; const char* cintfAB[2]; const char** cintfA; const char** cintfB; virtual void SetUp() { intfA.push_back(INTF_A); intfB.push_back(INTF_B); intfAB.push_back(INTF_A); intfAB.push_back(INTF_B); cintfAB[0] = INTF_A; cintfAB[1] = INTF_B; cintfA = &(cintfAB[0]); cintfB = &(cintfAB[1]); } virtual void TearDown() { } void SimpleScenario(Participant& provider, Participant& consumer); }; static void object_discovered(const void* ctx, alljoyn_proxybusobject_ref proxyref); static void object_lost(const void* ctx, alljoyn_proxybusobject_ref proxyref); static alljoyn_observerlistener_callback listener_cbs = { object_discovered, object_lost }; struct ObserverListener { alljoyn_busattachment bus; typedef vector ProxyVector; ProxyVector proxies; int counter; Event event; bool tolerateAlreadyDiscoveredObjects; alljoyn_observerlistener listener; ObserverListener(alljoyn_busattachment bus) : bus(bus), counter(0), tolerateAlreadyDiscoveredObjects(false) { listener = alljoyn_observerlistener_create(&listener_cbs, this); } virtual ~ObserverListener() { alljoyn_observerlistener_destroy(listener); } void ExpectInvocations(int newCounter) { /* first, check whether the counter was really 0 from last invocation */ EXPECT_EQ(0, counter) << "In the previous test case, the listener was triggered an invalid number of times"; event.ResetEvent(); counter = newCounter; } ProxyVector::iterator FindProxy(alljoyn_proxybusobject_ref proxyref) { ProxyVector::iterator it; for (it = proxies.begin(); it != proxies.end(); ++it) { if (*it == proxyref) { break; } } return it; } void CheckReentrancy(alljoyn_proxybusobject_ref proxyref) { alljoyn_proxybusobject proxy = alljoyn_proxybusobject_ref_get(proxyref); alljoyn_message reply = alljoyn_message_create(bus); QStatus status; /* proxy object must implement at least one of A or B */ const char* intfname = INTF_A; if (!alljoyn_proxybusobject_implementsinterface(proxy, INTF_A)) { intfname = INTF_B; EXPECT_TRUE(alljoyn_proxybusobject_implementsinterface(proxy, INTF_B)); } status = alljoyn_proxybusobject_methodcall(proxy, intfname, METHOD, NULL, 0, reply, MAX_WAIT_MS, 0); EXPECT_TRUE((status == ER_OK) || (status == ER_BUS_BLOCKING_CALL_NOT_ALLOWED)); alljoyn_busattachment_enableconcurrentcallbacks(bus); status = alljoyn_proxybusobject_methodcall(proxy, intfname, METHOD, NULL, 0, reply, MAX_WAIT_MS, 0); EXPECT_EQ(ER_OK, status); if (ER_OK == status) { const char* ubn = NULL; const char* path = NULL; alljoyn_message_parseargs(reply, "ss", &ubn, &path); EXPECT_STREQ(alljoyn_proxybusobject_getuniquename(proxy), ubn); EXPECT_STREQ(alljoyn_proxybusobject_getpath(proxy), path); } alljoyn_message_destroy(reply); } virtual void ObjectDiscovered(alljoyn_proxybusobject_ref proxyref) { ProxyVector::iterator it = FindProxy(proxyref); if (!tolerateAlreadyDiscoveredObjects) { EXPECT_EQ(it, proxies.end()) << "Discovering an already-discovered object"; } proxies.push_back(proxyref); alljoyn_proxybusobject_ref_incref(proxyref); CheckReentrancy(proxyref); if (--counter == 0) { event.SetEvent(); } } virtual void ObjectLost(alljoyn_proxybusobject_ref proxyref) { ProxyVector::iterator it = FindProxy(proxyref); EXPECT_NE(it, proxies.end()) << "Lost a not-discovered object"; proxies.erase(it); alljoyn_proxybusobject_ref_decref(proxyref); if (--counter == 0) { event.SetEvent(); } } private: /* private copy constructor and assign operator to prevent double freeing of memory */ ObserverListener(const ObserverListener&); ObserverListener& operator=(const ObserverListener&); }; static void object_discovered(const void* ctx, alljoyn_proxybusobject_ref proxyref) { EXPECT_TRUE(ctx != NULL); ObserverListener* listener = (ObserverListener*) ctx; listener->ObjectDiscovered(proxyref); } static void object_lost(const void* ctx, alljoyn_proxybusobject_ref proxyref) { EXPECT_TRUE(ctx != NULL); ObserverListener* listener = (ObserverListener*) ctx; listener->ObjectLost(proxyref); } static bool WaitForAll(vector& events, uint32_t wait_ms = MAX_WAIT_MS) { uint32_t final = qcc::GetTimestamp() + wait_ms; vector remaining = events; while (remaining.size() > 0) { vector triggered; uint32_t now = qcc::GetTimestamp(); if (now >= final) { return false; } QStatus status = Event::Wait(remaining, triggered, final - now); if (status != ER_OK && status != ER_TIMEOUT) { return false; } vector::iterator trigit, remit; for (trigit = triggered.begin(); trigit != triggered.end(); ++trigit) { for (remit = remaining.begin(); remit != remaining.end(); ++remit) { if (*remit == *trigit) { remaining.erase(remit); break; } } } } return true; } static int CountProxies(alljoyn_observer observer) { int count; alljoyn_proxybusobject_ref iter; for (count = 0, iter = alljoyn_observer_getfirst(observer); iter != NULL; iter = alljoyn_observer_getnext(observer, iter)) { ++count; } return count; } void ObserverTest::SimpleScenario(Participant& provider, Participant& consumer) { vector interfaces; provider.CreateObject("justA", intfA); provider.CreateObject("justB", intfB); provider.CreateObject("both", intfAB); ObserverListener listenerA(consumer.cbus), listenerB(consumer.cbus), listenerAB(consumer.cbus); alljoyn_observer obsA = alljoyn_observer_create(consumer.cbus, cintfA, 1); alljoyn_observer_registerlistener(obsA, listenerA.listener, QCC_TRUE); alljoyn_observer obsB = alljoyn_observer_create(consumer.cbus, cintfB, 1); alljoyn_observer_registerlistener(obsB, listenerB.listener, QCC_TRUE); alljoyn_observer obsAB = alljoyn_observer_create(consumer.cbus, cintfAB, 2); alljoyn_observer_registerlistener(obsAB, listenerAB.listener, QCC_TRUE); vector events; vector allEvents; allEvents.push_back(&(listenerA.event)); allEvents.push_back(&(listenerB.event)); allEvents.push_back(&(listenerAB.event)); /* let provider publish objects on the bus */ listenerA.ExpectInvocations(2); listenerB.ExpectInvocations(2); listenerAB.ExpectInvocations(1); provider.RegisterObject("justA"); provider.RegisterObject("justB"); provider.RegisterObject("both"); EXPECT_TRUE(WaitForAll(allEvents)); /* remove justA from the bus */ listenerA.ExpectInvocations(1); listenerB.ExpectInvocations(0); listenerAB.ExpectInvocations(0); provider.UnregisterObject("justA"); events.clear(); events.push_back(&(listenerA.event)); EXPECT_TRUE(WaitForAll(events)); /* remove "both" from the bus */ listenerA.ExpectInvocations(1); listenerB.ExpectInvocations(1); listenerAB.ExpectInvocations(1); provider.UnregisterObject("both"); EXPECT_TRUE(WaitForAll(allEvents)); /* count the number of proxies left in the Observers. * There should be 0 in A, 1 in B, 0 in AB */ EXPECT_EQ(0, CountProxies(obsA)); EXPECT_EQ(1, CountProxies(obsB)); EXPECT_EQ(0, CountProxies(obsAB)); /* remove all listeners */ alljoyn_observer_unregisteralllisteners(obsA); alljoyn_observer_unregisteralllisteners(obsB); alljoyn_observer_unregisterlistener(obsAB, listenerAB.listener); /* remove "justB" and reinstate the other objects */ listenerA.ExpectInvocations(0); listenerB.ExpectInvocations(0); listenerAB.ExpectInvocations(0); provider.UnregisterObject("justB"); provider.RegisterObject("justA"); provider.RegisterObject("both"); /* busy-wait for a second at most */ for (int i = 0; i < 50; ++i) { if (CountProxies(obsA) == 2 && CountProxies(obsB) == 1 && CountProxies(obsAB) == 1) { break; } qcc::Sleep(20); } EXPECT_EQ(2, CountProxies(obsA)); EXPECT_EQ(1, CountProxies(obsB)); EXPECT_EQ(1, CountProxies(obsAB)); /* reinstate listeners & test triggerOnExisting functionality */ listenerA.ExpectInvocations(2); listenerB.ExpectInvocations(1); listenerAB.ExpectInvocations(1); alljoyn_observer_registerlistener(obsA, listenerA.listener, QCC_TRUE); alljoyn_observer_registerlistener(obsB, listenerB.listener, QCC_TRUE); alljoyn_observer_registerlistener(obsAB, listenerAB.listener, QCC_TRUE); EXPECT_TRUE(WaitForAll(allEvents)); /* test multiple listeners for same observer */ ObserverListener listenerB2(consumer.cbus); listenerB2.ExpectInvocations(0); alljoyn_observer_registerlistener(obsB, listenerB2.listener, QCC_FALSE); listenerA.ExpectInvocations(0); listenerB.ExpectInvocations(1); listenerB2.ExpectInvocations(1); listenerAB.ExpectInvocations(0); provider.RegisterObject("justB"); events.clear(); events.push_back(&(listenerB.event)); events.push_back(&(listenerB2.event)); EXPECT_TRUE(WaitForAll(events)); /* are all objects back where they belong? */ EXPECT_EQ(2, CountProxies(obsA)); EXPECT_EQ(2, CountProxies(obsB)); EXPECT_EQ(1, CountProxies(obsAB)); /* test multiple observers for the same set of interfaces */ alljoyn_observer obsB2 = alljoyn_observer_create(consumer.cbus, cintfB, 1); alljoyn_observer_unregisterlistener(obsB, listenerB2.listener); /* unregister listenerB2 from obsB so we can reuse it here */ listenerA.ExpectInvocations(0); listenerB.ExpectInvocations(0); listenerB2.ExpectInvocations(2); listenerAB.ExpectInvocations(0); alljoyn_observer_registerlistener(obsB2, listenerB2.listener, QCC_TRUE); events.clear(); events.push_back(&(listenerB2.event)); EXPECT_TRUE(WaitForAll(events)); alljoyn_observer_unregisterlistener(obsB2, listenerB2.listener); alljoyn_observer_destroy(obsB2); /* test Observer::Get() and the proxy creation functionality */ alljoyn_proxybusobject_ref proxyref = alljoyn_observer_get(obsA, provider.uniqueBusName.c_str(), PATH_PREFIX "justA"); ASSERT_TRUE(proxyref != NULL); alljoyn_proxybusobject proxy = alljoyn_proxybusobject_ref_get(proxyref); ASSERT_TRUE(proxy != NULL); EXPECT_EQ((size_t)2, alljoyn_proxybusobject_getinterfaces(proxy, NULL, 0)); // always one more than expected because of org.freedesktop.DBus.Peer alljoyn_proxybusobject_ref_decref(proxyref); proxyref = alljoyn_observer_get(obsA, provider.uniqueBusName.c_str(), PATH_PREFIX "both"); ASSERT_TRUE(proxyref != NULL); proxy = alljoyn_proxybusobject_ref_get(proxyref); ASSERT_TRUE(proxy != NULL); EXPECT_EQ((size_t)3, alljoyn_proxybusobject_getinterfaces(proxy, NULL, 0)); /* verify that we can indeed perform method calls */ alljoyn_message reply = alljoyn_message_create(consumer.cbus); EXPECT_EQ(ER_OK, alljoyn_proxybusobject_methodcall(proxy, INTF_A, METHOD, NULL, 0, reply, MAX_WAIT_MS, 0)); const char* ubn; const char* path; EXPECT_EQ(ER_OK, alljoyn_message_parseargs(reply, "ss", &ubn, &path)); EXPECT_STREQ(provider.uniqueBusName.c_str(), ubn); EXPECT_STREQ(PATH_PREFIX "both", path); alljoyn_message_destroy(reply); alljoyn_proxybusobject_ref_decref(proxyref); alljoyn_observer_destroy(obsA); alljoyn_observer_destroy(obsB); alljoyn_observer_destroy(obsAB); } TEST_F(ObserverTest, Simple) { Participant provider; Participant consumer; SimpleScenario(provider, consumer); } TEST_F(ObserverTest, SimpleSelf) { Participant provcons; SimpleScenario(provcons, provcons); } TEST_F(ObserverTest, Rejection) { Participant willing, doubtful, unwilling, consumer; willing.CreateObject("a", intfA); doubtful.CreateObject("a", intfAB); unwilling.CreateObject("a", intfAB); unwilling.acceptSessions = false; ObserverListener listener(consumer.cbus); alljoyn_observer obs = alljoyn_observer_create(consumer.cbus, cintfA, 1); alljoyn_observer_registerlistener(obs, listener.listener, QCC_TRUE); vector events; events.push_back(&(listener.event)); listener.ExpectInvocations(2); willing.RegisterObject("a"); doubtful.RegisterObject("a"); unwilling.RegisterObject("a"); EXPECT_TRUE(WaitForAll(events)); /* now let doubtful kill the connection */ qcc::Sleep(100); // This sleep is necessary to make sure the provider // knows it has a session. Otherwise, CloseSession // sporadically fails. listener.ExpectInvocations(1); doubtful.CloseSession(consumer); EXPECT_TRUE(WaitForAll(events)); /* there should only be one object left */ EXPECT_EQ(1, CountProxies(obs)); /* unannounce and reannounce, connection should be restored */ listener.ExpectInvocations(1); doubtful.UnregisterObject("a"); doubtful.RegisterObject("a"); EXPECT_TRUE(WaitForAll(events)); /* now there should only be two objects */ EXPECT_EQ(2, CountProxies(obs)); alljoyn_observer_destroy(obs); } TEST_F(ObserverTest, CreateDelete) { Participant provider, consumer; provider.CreateObject("a", intfA); provider.CreateObject("ab", intfAB); provider.CreateObject("ab2", intfAB); ObserverListener listener(consumer.cbus); alljoyn_observer obs = alljoyn_observer_create(consumer.cbus, cintfA, 1); alljoyn_observer_registerlistener(obs, listener.listener, QCC_TRUE); vector events; events.push_back(&(listener.event)); listener.ExpectInvocations(3); provider.RegisterObject("a"); provider.RegisterObject("ab"); provider.RegisterObject("ab2"); EXPECT_TRUE(WaitForAll(events)); /* now create and destroy some observers */ alljoyn_observer spark; alljoyn_observer flame; ObserverListener dummy(consumer.cbus); spark = alljoyn_observer_create(consumer.cbus, cintfA, 1); alljoyn_observer_destroy(spark);; flame = alljoyn_observer_create(consumer.cbus, cintfA, 1); alljoyn_observer_registerlistener(flame, dummy.listener, QCC_TRUE);; alljoyn_observer_destroy(flame);; spark = alljoyn_observer_create(consumer.cbus, cintfA, 1); flame = alljoyn_observer_create(consumer.cbus, cintfA, 1); alljoyn_observer_registerlistener(flame, dummy.listener, QCC_TRUE);; alljoyn_observer_destroy(flame);; alljoyn_observer_destroy(spark);; flame = alljoyn_observer_create(consumer.cbus, cintfA, 1); spark = alljoyn_observer_create(consumer.cbus, cintfA, 1); alljoyn_observer_registerlistener(flame, dummy.listener, QCC_TRUE);; alljoyn_observer_destroy(flame);; alljoyn_observer_destroy(spark);; /* create some movement on the bus to see if there are any lingering * traces of spark and flame that create problems */ listener.ExpectInvocations(3); provider.UnregisterObject("a"); provider.UnregisterObject("ab"); provider.UnregisterObject("ab2"); EXPECT_TRUE(WaitForAll(events)); alljoyn_observer_destroy(obs); } TEST_F(ObserverTest, ListenTwice) { /* reuse the same listener for two observers */ Participant provider, consumer; provider.CreateObject("a", intfA); provider.CreateObject("ab", intfAB); provider.CreateObject("ab2", intfAB); ObserverListener listener(consumer.cbus); alljoyn_observer obs = alljoyn_observer_create(consumer.cbus, cintfA, 1); alljoyn_observer_registerlistener(obs, listener.listener, QCC_TRUE); vector events; events.push_back(&(listener.event)); { /* use listener for 2 observers, so we expect to * see all events twice */ alljoyn_observer obs2 = alljoyn_observer_create(consumer.cbus, cintfA, 1); alljoyn_observer_registerlistener(obs2, listener.listener, QCC_TRUE); listener.ExpectInvocations(6); provider.RegisterObject("a"); provider.RegisterObject("ab"); provider.RegisterObject("ab2"); EXPECT_TRUE(WaitForAll(events)); alljoyn_observer_destroy(obs2); } /* one observer is gone, so we expect to see * every event just once. */ listener.ExpectInvocations(3); provider.UnregisterObject("a"); provider.UnregisterObject("ab"); provider.UnregisterObject("ab2"); EXPECT_TRUE(WaitForAll(events)); alljoyn_observer_destroy(obs); } TEST_F(ObserverTest, Multi) { /* multiple providers, multiple consumers */ Participant one, two; one.CreateObject("a", intfA); one.CreateObject("b", intfB); one.CreateObject("ab", intfAB); two.CreateObject("a", intfA); two.CreateObject("b", intfB); two.CreateObject("ab", intfAB); vector events; alljoyn_observer obsAone = alljoyn_observer_create(one.cbus, cintfA, 1); ObserverListener lisAone(one.cbus); alljoyn_observer_registerlistener(obsAone, lisAone.listener, QCC_TRUE); events.push_back(&(lisAone.event)); alljoyn_observer obsBone = alljoyn_observer_create(one.cbus, cintfB, 1); ObserverListener lisBone(one.cbus); alljoyn_observer_registerlistener(obsBone, lisBone.listener, QCC_TRUE); events.push_back(&(lisBone.event)); alljoyn_observer obsABone = alljoyn_observer_create(one.cbus, cintfAB, 2); ObserverListener lisABone(one.cbus); alljoyn_observer_registerlistener(obsABone, lisABone.listener, QCC_TRUE); events.push_back(&(lisABone.event)); alljoyn_observer obsAtwo = alljoyn_observer_create(two.cbus, cintfA, 1); ObserverListener lisAtwo(two.cbus); alljoyn_observer_registerlistener(obsAtwo, lisAtwo.listener, QCC_TRUE); events.push_back(&(lisAtwo.event)); alljoyn_observer obsBtwo = alljoyn_observer_create(two.cbus, cintfB, 1); ObserverListener lisBtwo(two.cbus); alljoyn_observer_registerlistener(obsBtwo, lisBtwo.listener, QCC_TRUE); events.push_back(&(lisBtwo.event)); alljoyn_observer obsABtwo = alljoyn_observer_create(two.cbus, cintfAB, 2); ObserverListener lisABtwo(two.cbus); alljoyn_observer_registerlistener(obsABtwo, lisABtwo.listener, QCC_TRUE); events.push_back(&(lisABtwo.event)); /* put objects on the bus */ lisAone.ExpectInvocations(4); lisBone.ExpectInvocations(4); lisABone.ExpectInvocations(2); lisAtwo.ExpectInvocations(4); lisBtwo.ExpectInvocations(4); lisABtwo.ExpectInvocations(2); one.RegisterObject("a"); one.RegisterObject("b"); one.RegisterObject("ab"); two.RegisterObject("a"); two.RegisterObject("b"); two.RegisterObject("ab"); EXPECT_TRUE(WaitForAll(events)); EXPECT_EQ(4, CountProxies(obsAone)); EXPECT_EQ(4, CountProxies(obsBone)); EXPECT_EQ(2, CountProxies(obsABone)); EXPECT_EQ(4, CountProxies(obsAtwo)); EXPECT_EQ(4, CountProxies(obsBtwo)); EXPECT_EQ(2, CountProxies(obsABtwo)); /* now drop all objects */ lisAone.ExpectInvocations(4); lisBone.ExpectInvocations(4); lisABone.ExpectInvocations(2); lisAtwo.ExpectInvocations(4); lisBtwo.ExpectInvocations(4); lisABtwo.ExpectInvocations(2); one.UnregisterObject("a"); one.UnregisterObject("b"); one.UnregisterObject("ab"); two.UnregisterObject("a"); two.UnregisterObject("b"); two.UnregisterObject("ab"); EXPECT_TRUE(WaitForAll(events)); EXPECT_EQ(0, CountProxies(obsAone)); EXPECT_EQ(0, CountProxies(obsBone)); EXPECT_EQ(0, CountProxies(obsABone)); EXPECT_EQ(0, CountProxies(obsAtwo)); EXPECT_EQ(0, CountProxies(obsBtwo)); EXPECT_EQ(0, CountProxies(obsABtwo)); alljoyn_observer_destroy(obsAone); alljoyn_observer_destroy(obsBone); alljoyn_observer_destroy(obsABone); alljoyn_observer_destroy(obsAtwo); alljoyn_observer_destroy(obsBtwo); alljoyn_observer_destroy(obsABtwo); } TEST_F(ObserverTest, ObserverSanity) { /* Test basic construction with NULLs of the Observer. * If the number of interfaces is not matching the actual number of interfaces in the array, * then it's inevitable not to segfault.*/ Participant one; const char* mandIntf[1] = { NULL }; const char* mandIntf2[10] = { NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL }; // The following should not crash although the resulting observers are not useful EXPECT_EQ(NULL, alljoyn_observer_create(one.cbus, mandIntf, 1)); EXPECT_EQ(NULL, alljoyn_observer_create(one.cbus, mandIntf2, 10)); EXPECT_EQ(NULL, alljoyn_observer_create(one.cbus, NULL, 0)); EXPECT_EQ(NULL, alljoyn_observer_create(one.cbus, mandIntf, 0)); /* Test using same interface name twice */ const char*doubleIntfA[] = { intfA[0].c_str(), intfA[0].c_str() }; ObserverListener listener(one.cbus); alljoyn_observer obs5 = alljoyn_observer_create(one.cbus, doubleIntfA, 2); alljoyn_observer_registerlistener(obs5, listener.listener, QCC_TRUE); vector oneIntfA; oneIntfA.push_back(intfA[0]); one.CreateObject("doubleIntfA", oneIntfA); vector events; events.push_back(&(listener.event)); listener.ExpectInvocations(1); // Should be triggered only once on object registration although we have duplicate interfaces one.RegisterObject("doubleIntfA"); EXPECT_TRUE(WaitForAll(events)); EXPECT_EQ(1, CountProxies(obs5)); // Make sure we have only one proxy for the remote object implementing duplicate interfaces listener.ExpectInvocations(1); // Should be triggered only once on object un-registration although we have duplicate interfaces one.UnregisterObject("doubleIntfA"); EXPECT_TRUE(WaitForAll(events)); alljoyn_observer_unregisterlistener(obs5, listener.listener); alljoyn_observer_destroy(obs5); } TEST_F(ObserverTest, RegisterListenerTwice) { /* Reuse the same listener for the same observer */ Participant provider, consumer; provider.CreateObject("a", intfA); ObserverListener listener(consumer.cbus); listener.tolerateAlreadyDiscoveredObjects = true; alljoyn_observer obs = alljoyn_observer_create(consumer.cbus, cintfA, 1); alljoyn_observer_registerlistener(obs, listener.listener, QCC_TRUE); alljoyn_observer_registerlistener(obs, listener.listener, QCC_TRUE); // Intentional vector events; events.push_back(&(listener.event)); listener.ExpectInvocations(2); // Should be triggered twice on object registration as we registered the listener twice provider.RegisterObject("a"); EXPECT_TRUE(WaitForAll(events)); listener.ExpectInvocations(2); // Should be triggered twice on object un-registration as we registered the listener twice provider.UnregisterObject("a"); EXPECT_TRUE(WaitForAll(events)); alljoyn_observer_unregisterlistener(obs, listener.listener); listener.ExpectInvocations(1); // Should be triggered once on object registration as we removed one listener provider.RegisterObject("a"); EXPECT_TRUE(WaitForAll(events)); alljoyn_observer_unregisterlistener(obs, listener.listener); alljoyn_observer_destroy(obs); } TEST_F(ObserverTest, AnnounceLogicSanity) { Participant provider, consumer; ObserverListener listenerA(consumer.cbus); ObserverListener listenerB(consumer.cbus); provider.CreateObject("a", intfA); provider.CreateObject("b", intfB); provider.RegisterObject("a"); provider.RegisterObject("b"); vector events; { alljoyn_observer obsA = alljoyn_observer_create(consumer.cbus, cintfA, 1); events.push_back(&(listenerA.event)); listenerA.ExpectInvocations(1); // Object with intfA was at least discovered alljoyn_observer_registerlistener(obsA, listenerA.listener, QCC_TRUE); EXPECT_TRUE(WaitForAll(events)); events.clear(); events.push_back(&(listenerB.event)); alljoyn_observer obsB = alljoyn_observer_create(consumer.cbus, cintfB, 1); listenerB.ExpectInvocations(1); // Object with intfB was at least discovered alljoyn_observer_registerlistener(obsB, listenerB.listener, QCC_TRUE); EXPECT_TRUE(WaitForAll(events)); alljoyn_observer_destroy(obsA); alljoyn_observer_destroy(obsB); } events.clear(); // Try creating Observer on IntfB after destroying Observer on InftA { alljoyn_observer obsA = alljoyn_observer_create(consumer.cbus, cintfA, 1); events.push_back(&(listenerA.event)); listenerA.ExpectInvocations(1); // Object with intfA was at least discovered alljoyn_observer_registerlistener(obsA, listenerA.listener, QCC_TRUE); EXPECT_TRUE(WaitForAll(events)); alljoyn_observer_unregisterlistener(obsA, listenerA.listener); alljoyn_observer_destroy(obsA); } events.clear(); alljoyn_observer obsB = alljoyn_observer_create(consumer.cbus, cintfB, 1); events.push_back(&(listenerB.event)); listenerB.ExpectInvocations(1); // Object with intfB was at least discovered alljoyn_observer_registerlistener(obsB, listenerB.listener, QCC_TRUE); EXPECT_TRUE(WaitForAll(events)); alljoyn_observer_unregisterlistener(obsB, listenerB.listener); provider.UnregisterObject("a"); provider.UnregisterObject("b"); alljoyn_observer_destroy(obsB); } TEST_F(ObserverTest, StressNumPartObjects) { // Stress the number of participants, observers and consumers vector providers(STRESS_FACTOR); vector consumers(STRESS_FACTOR); vector listeners(STRESS_FACTOR); vector observers(STRESS_FACTOR); vector events; for (int i = 0; i < STRESS_FACTOR; i++) { providers.push_back(NULL); providers[i] = new Participant(); EXPECT_TRUE(NULL != providers[i]); consumers.push_back(NULL); consumers[i] = new Participant(); EXPECT_TRUE(NULL != consumers[i]); if (consumers[i] == NULL || providers[i] == NULL) { break; //clean up } providers[i]->CreateObject("a", intfAB); providers[i]->CreateObject("b", intfAB); providers[i]->RegisterObject("a"); providers[i]->RegisterObject("b"); listeners[i] = new ObserverListener(consumers[i]->cbus); events.push_back(&(listeners[i]->event)); listeners[i]->ExpectInvocations(2 * STRESS_FACTOR); if (listeners[i] == NULL) { break; //clean up; } observers.push_back(NULL); observers[i] = alljoyn_observer_create(consumers[i]->cbus, cintfAB, 2); if (observers[i] == NULL) { break; //clean up; } alljoyn_observer_registerlistener(observers[i], listeners[i]->listener, QCC_TRUE); } EXPECT_TRUE(WaitForAll(events)); //clean up for (int i = 0; i < STRESS_FACTOR; i++) { alljoyn_observer_unregisterlistener(observers[i], listeners[i]->listener); alljoyn_observerlistener_destroy(listeners[i]->listener); alljoyn_observer_destroy(observers[i]); providers[i]->UnregisterObject("a"); providers[i]->UnregisterObject("b"); delete consumers[i]; delete providers[i]; } } } alljoyn-15.04b/alljoyn_c/unit_test/ProxyBusObjectTest.cc000066400000000000000000001121341255700255500234260ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include "ajTestCommon.h" #include #include #include #include #include /*constants*/ static const char* INTERFACE_NAME = "org.alljoyn.test.ProxyBusObjectTest"; static const char* OBJECT_NAME = "org.alljoyn.test.ProxyBusObjectTest"; static const char* OBJECT_PATH = "/org/alljoyn/test/ProxyObjectTest"; static QCC_BOOL chirp_method_flag = QCC_FALSE; static QCC_BOOL name_owner_changed_flag = QCC_FALSE; /* Exposed methods */ static void AJ_CALL ping_method(alljoyn_busobject bus, const alljoyn_interfacedescription_member* member, alljoyn_message msg) { QCC_UNUSED(member); alljoyn_msgarg outArg = alljoyn_msgarg_create(); alljoyn_msgarg inArg = alljoyn_message_getarg(msg, 0); const char* str; alljoyn_msgarg_get(inArg, "s", &str); alljoyn_msgarg_set(outArg, "s", str); QStatus status = alljoyn_busobject_methodreply_args(bus, msg, outArg, 1); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg_destroy(outArg); } static void AJ_CALL chirp_method(alljoyn_busobject bus, const alljoyn_interfacedescription_member* member, alljoyn_message msg) { QCC_UNUSED(member); chirp_method_flag = QCC_TRUE; alljoyn_msgarg outArg = alljoyn_msgarg_create(); alljoyn_msgarg inArg = alljoyn_message_getarg(msg, 0); const char* str; alljoyn_msgarg_get(inArg, "s", &str); alljoyn_msgarg_set(outArg, "s", str); QStatus status = alljoyn_busobject_methodreply_args(bus, msg, NULL, 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg_destroy(outArg); } /* NameOwnerChanged callback */ static void AJ_CALL name_owner_changed(const void* context, const char* busName, const char* previousOwner, const char* newOwner) { QCC_UNUSED(context); QCC_UNUSED(previousOwner); QCC_UNUSED(newOwner); if (strcmp(busName, OBJECT_NAME) == 0) { name_owner_changed_flag = QCC_TRUE; } } class ProxyBusObjectTest : public testing::Test { public: virtual void SetUp() { bus = alljoyn_busattachment_create("ProxyBusObjectTest", false); status = alljoyn_busattachment_start(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(bus, ajn::getConnectArg().c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); } virtual void TearDown() { EXPECT_NO_FATAL_FAILURE(alljoyn_busattachment_destroy(bus)); } void SetUpProxyBusObjectTestService() { /* create/start/connect alljoyn_busattachment */ servicebus = alljoyn_busattachment_create("ProxyBusObjectTestservice", false); status = alljoyn_busattachment_start(servicebus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(servicebus, ajn::getConnectArg().c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* create/activate alljoyn_interface */ alljoyn_interfacedescription testIntf = NULL; status = alljoyn_busattachment_createinterface(servicebus, INTERFACE_NAME, &testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_TRUE(testIntf != NULL); if (testIntf != NULL) { status = alljoyn_interfacedescription_addmember(testIntf, ALLJOYN_MESSAGE_METHOD_CALL, "ping", "s", "s", "in,out", 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_interfacedescription_addmember(testIntf, ALLJOYN_MESSAGE_METHOD_CALL, "chirp", "s", "", "chirp", 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription_activate(testIntf); /* register bus listener */ alljoyn_buslistener_callbacks buslistenerCbs = { NULL, NULL, NULL, NULL, &name_owner_changed, NULL, NULL, NULL }; buslistener = alljoyn_buslistener_create(&buslistenerCbs, NULL); alljoyn_busattachment_registerbuslistener(servicebus, buslistener); /* Set up bus object */ alljoyn_busobject_callbacks busObjCbs = { NULL, NULL, NULL, NULL }; testObj = alljoyn_busobject_create(OBJECT_PATH, QCC_FALSE, &busObjCbs, NULL); const alljoyn_interfacedescription exampleIntf = alljoyn_busattachment_getinterface(servicebus, INTERFACE_NAME); ASSERT_TRUE(exampleIntf); status = alljoyn_busobject_addinterface(testObj, exampleIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* register method handlers */ alljoyn_interfacedescription_member ping_member; QCC_BOOL foundMember = alljoyn_interfacedescription_getmember(exampleIntf, "ping", &ping_member); EXPECT_TRUE(foundMember); alljoyn_interfacedescription_member chirp_member; foundMember = alljoyn_interfacedescription_getmember(exampleIntf, "chirp", &chirp_member); EXPECT_TRUE(foundMember); /* add methodhandlers */ alljoyn_busobject_methodentry methodEntries[] = { { &chirp_member, chirp_method }, { &ping_member, ping_method }, }; status = alljoyn_busobject_addmethodhandlers(testObj, methodEntries, sizeof(methodEntries) / sizeof(methodEntries[0])); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_registerbusobject(servicebus, testObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); name_owner_changed_flag = QCC_FALSE; /* request name */ uint32_t flags = DBUS_NAME_FLAG_REPLACE_EXISTING | DBUS_NAME_FLAG_DO_NOT_QUEUE; status = alljoyn_busattachment_requestname(servicebus, OBJECT_NAME, flags); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 200; ++i) { if (name_owner_changed_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(name_owner_changed_flag); } } void TearDownProxyBusObjectTestService() { alljoyn_busattachment_unregisterbuslistener(servicebus, buslistener); /* * must destroy the busattachment before destroying the buslistener or * the code will segfault when the code tries to call the bus_stopping * callback. */ alljoyn_busattachment_destroy(servicebus); alljoyn_buslistener_destroy(buslistener); alljoyn_busobject_destroy(testObj); } QStatus status; alljoyn_busattachment bus; alljoyn_busobject testObj; alljoyn_busattachment servicebus; alljoyn_buslistener buslistener; }; TEST_F(ProxyBusObjectTest, create_destroy) { alljoyn_proxybusobject proxyObj = alljoyn_proxybusobject_create(bus, "org.alljoyn.Bus", "/org/alljoyn/Bus", 0); EXPECT_TRUE(proxyObj); EXPECT_NO_FATAL_FAILURE(alljoyn_proxybusobject_destroy(proxyObj)); } TEST_F(ProxyBusObjectTest, introspectremoteobject) { alljoyn_proxybusobject proxyObj = alljoyn_proxybusobject_create(bus, "org.alljoyn.Bus", "/org/alljoyn/Bus", 0); EXPECT_TRUE(proxyObj); status = alljoyn_proxybusobject_introspectremoteobject(proxyObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription intf = alljoyn_proxybusobject_getinterface(proxyObj, "org.freedesktop.DBus.Introspectable"); size_t buf; char* str; buf = alljoyn_interfacedescription_introspect(intf, NULL, 0, 0); buf++; str = (char*)malloc(sizeof(char) * buf); alljoyn_interfacedescription_introspect(intf, str, buf, 0); EXPECT_STREQ( "\n" " \n" " \n" " \n" "\n", str); free(str); EXPECT_NO_FATAL_FAILURE(alljoyn_proxybusobject_destroy(proxyObj)); } QCC_BOOL introspect_callback_flag = QCC_FALSE; void AJ_CALL introspect_callback(QStatus status, alljoyn_proxybusobject obj, void* context) { QCC_UNUSED(context); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription intf = alljoyn_proxybusobject_getinterface(obj, "org.freedesktop.DBus.Introspectable"); size_t buf; char* str; buf = alljoyn_interfacedescription_introspect(intf, NULL, 0, 0); buf++; str = (char*)malloc(sizeof(char) * buf); alljoyn_interfacedescription_introspect(intf, str, buf, 0); EXPECT_STREQ( "\n" " \n" " \n" " \n" "\n", str); free(str); introspect_callback_flag = QCC_TRUE; } TEST_F(ProxyBusObjectTest, introspectremoteobjectasync) { alljoyn_proxybusobject proxyObj = alljoyn_proxybusobject_create(bus, "org.alljoyn.Bus", "/org/alljoyn/Bus", 0); EXPECT_TRUE(proxyObj); introspect_callback_flag = QCC_FALSE; status = alljoyn_proxybusobject_introspectremoteobjectasync(proxyObj, &introspect_callback, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 200; ++i) { if (introspect_callback_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(introspect_callback_flag); alljoyn_interfacedescription intf = alljoyn_proxybusobject_getinterface(proxyObj, "org.freedesktop.DBus.Introspectable"); size_t buf; char* str; buf = alljoyn_interfacedescription_introspect(intf, NULL, 0, 0); buf++; str = (char*)malloc(sizeof(char) * buf); alljoyn_interfacedescription_introspect(intf, str, buf, 0); EXPECT_STREQ( "\n" " \n" " \n" " \n" "\n", str); free(str); EXPECT_NO_FATAL_FAILURE(alljoyn_proxybusobject_destroy(proxyObj)); } TEST_F(ProxyBusObjectTest, getinterface_getinterfaces) { alljoyn_proxybusobject proxyObj = alljoyn_proxybusobject_create(bus, "org.alljoyn.Bus", "/org/alljoyn/Bus", 0); EXPECT_TRUE(proxyObj); status = alljoyn_proxybusobject_introspectremoteobject(proxyObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription intf = alljoyn_proxybusobject_getinterface(proxyObj, "org.freedesktop.DBus.Introspectable"); char* intf_introspect; size_t buf = alljoyn_interfacedescription_introspect(intf, NULL, 0, 0); buf++; intf_introspect = (char*)malloc(sizeof(char) * buf); alljoyn_interfacedescription_introspect(intf, intf_introspect, buf, 0); EXPECT_STREQ( "\n" " \n" " \n" " \n" "\n", intf_introspect); free(intf_introspect); alljoyn_interfacedescription intf_array[6]; size_t count = alljoyn_proxybusobject_getinterfaces(proxyObj, intf_array, 6); /* * the org.alljoyn.Bus object should contain 5 interfaces * org.alljoyn.Bus * org.alljoyn.Deamon * org.freedesktop.DBus.Introspectable * org.allseen.Introspectable * org.freedesktop.DBus.Peer */ ASSERT_EQ((size_t)5, count); EXPECT_STREQ("org.alljoyn.Bus", alljoyn_interfacedescription_getname(intf_array[0])); EXPECT_STREQ("org.alljoyn.Daemon", alljoyn_interfacedescription_getname(intf_array[1])); EXPECT_STREQ("org.allseen.Introspectable", alljoyn_interfacedescription_getname(intf_array[2])); EXPECT_STREQ("org.freedesktop.DBus.Introspectable", alljoyn_interfacedescription_getname(intf_array[3])); EXPECT_STREQ("org.freedesktop.DBus.Peer", alljoyn_interfacedescription_getname(intf_array[4])); EXPECT_NO_FATAL_FAILURE(alljoyn_proxybusobject_destroy(proxyObj)); } TEST_F(ProxyBusObjectTest, getpath) { alljoyn_proxybusobject proxyObj = alljoyn_proxybusobject_create(bus, "org.alljoyn.Bus", "/org/alljoyn/Bus", 0); EXPECT_TRUE(proxyObj); EXPECT_STREQ("/org/alljoyn/Bus", alljoyn_proxybusobject_getpath(proxyObj)); EXPECT_NO_FATAL_FAILURE(alljoyn_proxybusobject_destroy(proxyObj)); } TEST_F(ProxyBusObjectTest, getservicename) { alljoyn_proxybusobject proxyObj = alljoyn_proxybusobject_create(bus, "org.alljoyn.Bus", "/org/alljoyn/Bus", 0); EXPECT_TRUE(proxyObj); EXPECT_STREQ("org.alljoyn.Bus", alljoyn_proxybusobject_getservicename(proxyObj)); EXPECT_NO_FATAL_FAILURE(alljoyn_proxybusobject_destroy(proxyObj)); } TEST_F(ProxyBusObjectTest, getsessionid) { alljoyn_proxybusobject proxyObj = alljoyn_proxybusobject_create(bus, "org.alljoyn.Bus", "/org/alljoyn/Bus", 0); EXPECT_TRUE(proxyObj); EXPECT_EQ((alljoyn_sessionid)0, alljoyn_proxybusobject_getsessionid(proxyObj)); EXPECT_NO_FATAL_FAILURE(alljoyn_proxybusobject_destroy(proxyObj)); /* * TODO set up a session with a real session and make sure that proxyObj has * will return the proper sessionid. */ } TEST_F(ProxyBusObjectTest, implementsinterface) { alljoyn_proxybusobject proxyObj = alljoyn_proxybusobject_create(bus, "org.alljoyn.Bus", "/org/alljoyn/Bus", 0); EXPECT_TRUE(proxyObj); status = alljoyn_proxybusobject_introspectremoteobject(proxyObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_TRUE(alljoyn_proxybusobject_implementsinterface(proxyObj, "org.alljoyn.Bus")); EXPECT_TRUE(alljoyn_proxybusobject_implementsinterface(proxyObj, "org.alljoyn.Daemon")); EXPECT_FALSE(alljoyn_proxybusobject_implementsinterface(proxyObj, "org.alljoyn.Invalid")); EXPECT_NO_FATAL_FAILURE(alljoyn_proxybusobject_destroy(proxyObj)); } TEST_F(ProxyBusObjectTest, addinterface_by_name) { alljoyn_proxybusobject proxyObj = alljoyn_proxybusobject_create(bus, "org.alljoyn.Bus", "/org/alljoyn/Bus", 0); EXPECT_TRUE(proxyObj); status = alljoyn_proxybusobject_addinterface_by_name(proxyObj, "org.freedesktop.DBus.Introspectable"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription intf = alljoyn_proxybusobject_getinterface(proxyObj, "org.freedesktop.DBus.Introspectable"); char* intf_introspect; size_t buf = alljoyn_interfacedescription_introspect(intf, NULL, 0, 0); buf++; intf_introspect = (char*)malloc(sizeof(char) * buf); alljoyn_interfacedescription_introspect(intf, intf_introspect, buf, 0); EXPECT_STREQ( "\n" " \n" " \n" " \n" "\n", intf_introspect); free(intf_introspect); EXPECT_FALSE(alljoyn_proxybusobject_implementsinterface(proxyObj, "org.alljoyn.Bus")); EXPECT_TRUE(alljoyn_proxybusobject_implementsinterface(proxyObj, "org.freedesktop.DBus.Introspectable")); EXPECT_NO_FATAL_FAILURE(alljoyn_proxybusobject_destroy(proxyObj)); } TEST_F(ProxyBusObjectTest, addinterface) { alljoyn_interfacedescription testIntf = NULL; status = alljoyn_busattachment_createinterface(bus, "org.alljoyn.test.ProxyBusObjectTest", &testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(testIntf != NULL); status = alljoyn_interfacedescription_addmember(testIntf, ALLJOYN_MESSAGE_METHOD_CALL, "ping", "s", "s", "in,out", 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_interfacedescription_addmember(testIntf, ALLJOYN_MESSAGE_SIGNAL, "chirp", "", "s", "chirp", 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_proxybusobject proxyObj = alljoyn_proxybusobject_create(bus, "org.alljoyn.test.ProxyBusObjectTest", "/org/alljoyn/test/ProxyObjectTest", 0); EXPECT_TRUE(proxyObj); status = alljoyn_proxybusobject_addinterface(proxyObj, testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_TRUE(alljoyn_proxybusobject_implementsinterface(proxyObj, "org.alljoyn.test.ProxyBusObjectTest")); char* introspect; size_t buf = alljoyn_interfacedescription_introspect(testIntf, NULL, 0, 0); buf++; introspect = (char*)malloc(sizeof(char) * buf); alljoyn_interfacedescription_introspect(testIntf, introspect, buf, 0); const char* expectedIntrospect = "\n" " \n" " \n" " \n" " \n" " \n" " \n" " \n" "\n"; EXPECT_STREQ(expectedIntrospect, introspect); free(introspect); alljoyn_proxybusobject_destroy(proxyObj); } TEST_F(ProxyBusObjectTest, methodcall) { SetUpProxyBusObjectTestService(); alljoyn_proxybusobject proxyObj = alljoyn_proxybusobject_create(bus, OBJECT_NAME, OBJECT_PATH, 0); EXPECT_TRUE(proxyObj); status = alljoyn_proxybusobject_introspectremoteobject(proxyObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_message reply = alljoyn_message_create(bus); alljoyn_msgarg input = alljoyn_msgarg_create_and_set("s", "AllJoyn"); status = alljoyn_proxybusobject_methodcall(proxyObj, INTERFACE_NAME, "ping", input, 1, reply, ALLJOYN_MESSAGE_DEFAULT_TIMEOUT, 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); const char* str; alljoyn_msgarg_get(alljoyn_message_getarg(reply, 0), "s", &str); EXPECT_STREQ("AllJoyn", str); alljoyn_message_destroy(reply); alljoyn_msgarg_destroy(input); alljoyn_proxybusobject_destroy(proxyObj); TearDownProxyBusObjectTestService(); } TEST_F(ProxyBusObjectTest, methodcall_member) { SetUpProxyBusObjectTestService(); alljoyn_proxybusobject proxyObj = alljoyn_proxybusobject_create(bus, OBJECT_NAME, OBJECT_PATH, 0); EXPECT_TRUE(proxyObj); status = alljoyn_proxybusobject_introspectremoteobject(proxyObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_message reply = alljoyn_message_create(bus); alljoyn_msgarg input = alljoyn_msgarg_create_and_set("s", "AllJoyn"); /* register method handlers */ alljoyn_interfacedescription_member ping_member_from_proxy; QCC_BOOL foundMember = alljoyn_interfacedescription_getmember(alljoyn_proxybusobject_getinterface(proxyObj, INTERFACE_NAME), "ping", &ping_member_from_proxy); EXPECT_TRUE(foundMember); status = alljoyn_proxybusobject_methodcall_member(proxyObj, ping_member_from_proxy, input, 1, reply, ALLJOYN_MESSAGE_DEFAULT_TIMEOUT, 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); const char* str; alljoyn_msgarg_get(alljoyn_message_getarg(reply, 0), "s", &str); EXPECT_STREQ("AllJoyn", str); alljoyn_message_destroy(reply); alljoyn_msgarg_destroy(input); alljoyn_proxybusobject_destroy(proxyObj); TearDownProxyBusObjectTestService(); } TEST_F(ProxyBusObjectTest, methodcall_noreply) { SetUpProxyBusObjectTestService(); alljoyn_proxybusobject proxyObj = alljoyn_proxybusobject_create(bus, OBJECT_NAME, OBJECT_PATH, 0); EXPECT_TRUE(proxyObj); status = alljoyn_proxybusobject_introspectremoteobject(proxyObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); chirp_method_flag = QCC_FALSE; alljoyn_message reply = alljoyn_message_create(bus); alljoyn_msgarg input = alljoyn_msgarg_create_and_set("s", "AllJoyn"); status = alljoyn_proxybusobject_methodcall_noreply(proxyObj, INTERFACE_NAME, "chirp", input, 1, 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 200; ++i) { if (chirp_method_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(chirp_method_flag); alljoyn_message_destroy(reply); alljoyn_msgarg_destroy(input); alljoyn_proxybusobject_destroy(proxyObj); TearDownProxyBusObjectTestService(); } TEST_F(ProxyBusObjectTest, methodcall_member_noreply) { SetUpProxyBusObjectTestService(); alljoyn_proxybusobject proxyObj = alljoyn_proxybusobject_create(bus, OBJECT_NAME, OBJECT_PATH, 0); EXPECT_TRUE(proxyObj); status = alljoyn_proxybusobject_introspectremoteobject(proxyObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_message reply = alljoyn_message_create(bus); alljoyn_msgarg input = alljoyn_msgarg_create_and_set("s", "AllJoyn"); /* register method handlers */ alljoyn_interfacedescription_member chirp_member_from_proxy; QCC_BOOL foundMember = alljoyn_interfacedescription_getmember(alljoyn_proxybusobject_getinterface(proxyObj, INTERFACE_NAME), "chirp", &chirp_member_from_proxy); EXPECT_TRUE(foundMember); chirp_method_flag = QCC_FALSE; status = alljoyn_proxybusobject_methodcall_member_noreply(proxyObj, chirp_member_from_proxy, input, 1, 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 200; ++i) { if (chirp_method_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(chirp_method_flag); alljoyn_message_destroy(reply); alljoyn_msgarg_destroy(input); alljoyn_proxybusobject_destroy(proxyObj); TearDownProxyBusObjectTestService(); } QCC_BOOL ping_methodcall_reply_handler_flag = QCC_FALSE; QCC_BOOL chirp_methodcall_reply_handler_flag = QCC_FALSE; void AJ_CALL ping_methodcall_reply_handler(alljoyn_message message, void* context) { // TODO add alljoyn_message_gettype() EXPECT_EQ(ALLJOYN_MESSAGE_METHOD_RET, alljoyn_message_gettype(message)); EXPECT_STREQ("Input String to test context", (char*)context); const char* str; alljoyn_msgarg_get(alljoyn_message_getarg(message, 0), "s", &str); EXPECT_STREQ("AllJoyn", str); alljoyn_message_parseargs(message, "s", &str); EXPECT_STREQ("AllJoyn", str); ping_methodcall_reply_handler_flag = QCC_TRUE; } void chirp_methodcall_reply_handler(alljoyn_message message, void* context) { QCC_UNUSED(message); QCC_UNUSED(context); //not yet used in any tests } TEST_F(ProxyBusObjectTest, methodcallasync) { SetUpProxyBusObjectTestService(); alljoyn_proxybusobject proxyObj = alljoyn_proxybusobject_create(bus, OBJECT_NAME, OBJECT_PATH, 0); EXPECT_TRUE(proxyObj); status = alljoyn_proxybusobject_introspectremoteobject(proxyObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg input = alljoyn_msgarg_create_and_set("s", "AllJoyn"); ping_methodcall_reply_handler_flag = QCC_FALSE; char context_str[64] = "Input String to test context"; status = alljoyn_proxybusobject_methodcallasync(proxyObj, INTERFACE_NAME, "ping", &ping_methodcall_reply_handler, input, 1, context_str, ALLJOYN_MESSAGE_DEFAULT_TIMEOUT, 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg_destroy(input); alljoyn_proxybusobject_destroy(proxyObj); for (size_t i = 0; i < 200; ++i) { if (ping_methodcall_reply_handler_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(ping_methodcall_reply_handler_flag); TearDownProxyBusObjectTestService(); } TEST_F(ProxyBusObjectTest, methodcallasync_member) { SetUpProxyBusObjectTestService(); alljoyn_proxybusobject proxyObj = alljoyn_proxybusobject_create(bus, OBJECT_NAME, OBJECT_PATH, 0); EXPECT_TRUE(proxyObj); status = alljoyn_proxybusobject_introspectremoteobject(proxyObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg input = alljoyn_msgarg_create_and_set("s", "AllJoyn"); ping_methodcall_reply_handler_flag = QCC_FALSE; /* register method handlers */ alljoyn_interfacedescription_member ping_member_from_proxy; QCC_BOOL foundMember = alljoyn_interfacedescription_getmember(alljoyn_proxybusobject_getinterface(proxyObj, INTERFACE_NAME), "ping", &ping_member_from_proxy); EXPECT_TRUE(foundMember); char context_str[64] = "Input String to test context"; status = alljoyn_proxybusobject_methodcallasync_member(proxyObj, ping_member_from_proxy, &ping_methodcall_reply_handler, input, 1, context_str, ALLJOYN_MESSAGE_DEFAULT_TIMEOUT, 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg_destroy(input); alljoyn_proxybusobject_destroy(proxyObj); for (size_t i = 0; i < 200; ++i) { if (ping_methodcall_reply_handler_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(ping_methodcall_reply_handler_flag); TearDownProxyBusObjectTestService(); } TEST_F(ProxyBusObjectTest, parsexml) { const char* busObjectXML = "" " \n" " \n" " \n" " \n" " \n" " \n" " \n" " \n" " \n" " \n" " \n" " \n" "\n"; QStatus status; alljoyn_proxybusobject proxyObj = alljoyn_proxybusobject_create(bus, NULL, NULL, 0); EXPECT_TRUE(proxyObj); status = alljoyn_proxybusobject_parsexml(proxyObj, busObjectXML, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_TRUE(alljoyn_proxybusobject_implementsinterface(proxyObj, "org.alljoyn.test.ProxyBusObjectTest")); alljoyn_interfacedescription testIntf = alljoyn_proxybusobject_getinterface(proxyObj, "org.alljoyn.test.ProxyBusObjectTest"); char* introspect; size_t buf = alljoyn_interfacedescription_introspect(testIntf, NULL, 0, 0); buf++; introspect = (char*)malloc(sizeof(char) * buf); alljoyn_interfacedescription_introspect(testIntf, introspect, buf, 0); const char* expectedIntrospect = "\n" " \n" " \n" " \n" " \n" " \n" " \n" " \n" " \n" " \n" " \n" "\n"; EXPECT_STREQ(expectedIntrospect, introspect); free(introspect); alljoyn_proxybusobject_destroy(proxyObj); } TEST_F(ProxyBusObjectTest, Add_Get_Remove_Child) { QStatus status; alljoyn_interfacedescription testIntf = NULL; status = alljoyn_busattachment_createinterface(bus, "org.alljoyn.test.ProxyBusObjectTest", &testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(testIntf != NULL); status = alljoyn_interfacedescription_addmember(testIntf, ALLJOYN_MESSAGE_METHOD_CALL, "ping", "s", "s", "in,out", 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_proxybusobject proxyObjChildOne = alljoyn_proxybusobject_create(bus, "org.alljoyn.test.ProxyBusObjectTest", "/org/alljoyn/test/ProxyObjectTest/ChildOne", 0); EXPECT_TRUE(proxyObjChildOne); status = alljoyn_proxybusobject_addinterface(proxyObjChildOne, testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_proxybusobject proxyObjChildTwo = alljoyn_proxybusobject_create(bus, "org.alljoyn.test.ProxyBusObjectTest", "/org/alljoyn/test/ProxyObjectTest/ChildTwo", 0); EXPECT_TRUE(proxyObjChildOne); status = alljoyn_proxybusobject_addinterface(proxyObjChildTwo, testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_proxybusobject proxyObj = alljoyn_proxybusobject_create(bus, NULL, NULL, 0); EXPECT_TRUE(proxyObj); status = alljoyn_proxybusobject_addchild(proxyObj, proxyObjChildOne); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_proxybusobject_addchild(proxyObj, proxyObjChildTwo); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(alljoyn_proxybusobject_isvalid(proxyObj)); alljoyn_proxybusobject proxyObjChild1 = alljoyn_proxybusobject_getchild(proxyObj, "/org/alljoyn/test/ProxyObjectTest/ChildOne"); ASSERT_TRUE(proxyObjChild1); ASSERT_TRUE(alljoyn_proxybusobject_isvalid(proxyObjChild1)); EXPECT_TRUE(alljoyn_proxybusobject_implementsinterface(proxyObjChild1, "org.alljoyn.test.ProxyBusObjectTest")); alljoyn_interfacedescription testIntfChild1 = alljoyn_proxybusobject_getinterface(proxyObjChild1, "org.alljoyn.test.ProxyBusObjectTest"); char* introspect; size_t buf = alljoyn_interfacedescription_introspect(testIntfChild1, NULL, 0, 0); buf++; introspect = (char*)malloc(sizeof(char) * buf); alljoyn_interfacedescription_introspect(testIntfChild1, introspect, buf, 0); const char* expectedIntrospect = "\n" " \n" " \n" " \n" " \n" "\n"; EXPECT_STREQ(expectedIntrospect, introspect); free(introspect); alljoyn_proxybusobject proxyObjChild2 = alljoyn_proxybusobject_getchild(proxyObj, "/org/alljoyn/test/ProxyObjectTest/ChildTwo"); ASSERT_TRUE(proxyObjChild2 != NULL); EXPECT_TRUE(alljoyn_proxybusobject_implementsinterface(proxyObjChild2, "org.alljoyn.test.ProxyBusObjectTest")); alljoyn_interfacedescription testIntfChild2 = alljoyn_proxybusobject_getinterface(proxyObjChild2, "org.alljoyn.test.ProxyBusObjectTest"); buf = alljoyn_interfacedescription_introspect(testIntfChild2, NULL, 0, 0); buf++; introspect = (char*)malloc(sizeof(char) * buf); alljoyn_interfacedescription_introspect(testIntfChild2, introspect, buf, 0); EXPECT_STREQ(expectedIntrospect, introspect); free(introspect); status = alljoyn_proxybusobject_removechild(proxyObj, "/org/alljoyn/test/ProxyObjectTest/ChildOne"); alljoyn_proxybusobject proxyObjChildRemoved = alljoyn_proxybusobject_getchild(proxyObj, "/org/alljoyn/test/ProxyObjectTest/ChildOne"); EXPECT_FALSE(proxyObjChildRemoved); alljoyn_proxybusobject_destroy(proxyObjChildOne); alljoyn_proxybusobject_destroy(proxyObjChildTwo); alljoyn_proxybusobject_destroy(proxyObj); } TEST_F(ProxyBusObjectTest, getchildren) { QStatus status; alljoyn_interfacedescription testIntf = NULL; status = alljoyn_busattachment_createinterface(bus, "org.alljoyn.test.ProxyBusObjectTest", &testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(testIntf != NULL); status = alljoyn_interfacedescription_addmember(testIntf, ALLJOYN_MESSAGE_METHOD_CALL, "ping", "s", "s", "in,out", 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_proxybusobject proxyObjChildOne = alljoyn_proxybusobject_create(bus, "org.alljoyn.test.ProxyBusObjectTest", "/org/alljoyn/test/ProxyObjectTest/ChildOne", 0); EXPECT_TRUE(proxyObjChildOne); status = alljoyn_proxybusobject_addinterface(proxyObjChildOne, testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_proxybusobject proxyObjChildTwo = alljoyn_proxybusobject_create(bus, "org.alljoyn.test.ProxyBusObjectTest", "/org/alljoyn/test/ProxyObjectTest/ChildTwo", 0); EXPECT_TRUE(proxyObjChildOne); status = alljoyn_proxybusobject_addinterface(proxyObjChildTwo, testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_proxybusobject proxyObj = alljoyn_proxybusobject_create(bus, NULL, NULL, 0); EXPECT_TRUE(proxyObj); status = alljoyn_proxybusobject_addchild(proxyObj, proxyObjChildOne); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_proxybusobject_addchild(proxyObj, proxyObjChildTwo); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(alljoyn_proxybusobject_isvalid(proxyObj)); alljoyn_proxybusobject proxyObjSub = alljoyn_proxybusobject_getchild(proxyObj, "/org/alljoyn/test/ProxyObjectTest"); ASSERT_TRUE(proxyObjSub != NULL); size_t numChildren; alljoyn_proxybusobject* children; numChildren = alljoyn_proxybusobject_getchildren(proxyObjSub, NULL, 0); EXPECT_EQ((size_t)2, numChildren); children = (alljoyn_proxybusobject*) malloc(sizeof(alljoyn_proxybusobject) * numChildren); alljoyn_proxybusobject_getchildren(proxyObjSub, children, numChildren); for (size_t i = 0; i < numChildren; ++i) { ASSERT_TRUE(children[i]) << "Test interface for child " << i << " should not be NULL"; ASSERT_TRUE(alljoyn_proxybusobject_isvalid(children[i])) << "Test interface for child " << i << " should be a valid alljoyn_proxybusobject."; EXPECT_TRUE(alljoyn_proxybusobject_implementsinterface(children[i], "org.alljoyn.test.ProxyBusObjectTest")) << "Test interface for child " << i << " should implement the org.alljoyn.test.ProxyBusObjectTest interface."; alljoyn_interfacedescription testIntfChild = alljoyn_proxybusobject_getinterface(children[i], "org.alljoyn.test.ProxyBusObjectTest"); char* introspect; size_t buf = alljoyn_interfacedescription_introspect(testIntfChild, NULL, 0, 0); buf++; introspect = (char*)malloc(sizeof(char) * buf); alljoyn_interfacedescription_introspect(testIntfChild, introspect, buf, 0); const char* expectedIntrospect = "\n" " \n" " \n" " \n" " \n" "\n"; EXPECT_STREQ(expectedIntrospect, introspect) << "Test interface for child " << i << " did not have expected introspection."; free(introspect); } free(children); alljoyn_proxybusobject_destroy(proxyObjChildOne); alljoyn_proxybusobject_destroy(proxyObjChildTwo); alljoyn_proxybusobject_destroy(proxyObj); } alljoyn-15.04b/alljoyn_c/unit_test/SConscript000066400000000000000000000116471255700255500213560ustar00rootroot00000000000000# Copyright AllSeen Alliance. All rights reserved. # # Permission to use, copy, modify, and/or distribute this software for any # purpose with or without fee is hereby granted, provided that the above # copyright notice and this permission notice appear in all copies. # # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. # import os Import('env') if not env.has_key('GTEST_DIR'): print('GTEST_DIR not specified skipping alljoyn_c unit test build') else: gtest_env = env.Clone(); gtest_dir = gtest_env['GTEST_DIR'] vars = Variables(); vars.AddVariables(('GTEST_HOME', '', gtest_dir)) vars.Update(gtest_env) if gtest_env['CXX'].startswith('clang'): # Suppress a clang warning in google-test code. gtest_env.Append(CPPFLAGS = ['-Wno-unused-private-field']) if gtest_dir == '/usr': gtest_src_base = os.path.join(gtest_dir, 'src', 'gtest') else: gtest_src_base = gtest_dir if gtest_env['OS_GROUP'] == 'windows': # gTest does not require the same CPPDEFINES as AllJoyn core. gtest_env.Append(CPPDEFINES = ['WIN32', '_LIB']) # don't use the _DEBUG define unless the /MDd compiler flag is specified #gtest_env.Append(CPPDEFINES = ['WIN32', '_DEBUG', '_LIB']) gtest_env.Append(CXXFLAGS = ['/EHsc']) if gtest_env['OS_CONF'] == 'android': # used by gtest to prevent use of wcscasecmp and set GTEST_HAS_STD_WSTRING=0 gtest_env.Append(CPPDEFINES = ['ANDROID']) # tr1::tuple is not avalible for android or darwin if gtest_env['OS_CONF'] in [ 'android', 'darwin' ]: gtest_env.Append(CPPDEFINES = ['GTEST_HAS_TR1_TUPLE=0']) # clone() library function is NOT available on android-x86 if gtest_env['OS_CONF'] == 'android' and gtest_env['CPU'] == 'x86': gtest_env.Append(CPPDEFINES = ['GTEST_HAS_CLONE=0']) # Microsoft Visual Studio 2012 has a different _VARIADIC_MAX default value. # See: http://blogs.msdn.com/b/vcblog/archive/2011/09/12/10209291.aspx if gtest_env['OS_CONF'] == 'windows' and (gtest_env['MSVC_VERSION'] == '11.0' or gtest_env['MSVC_VERSION'] == '11.0Exp'): gtest_env.Append(CPPDEFINES = ['_VARIADIC_MAX=10']) #we compile with no rtti and we are not using exceptions. gtest_env.Append(CPPDEFINES = ['GTEST_HAS_RTTI=0']) # we replace AllJoyn's include CPPPATH options. AllJoyn includes stlport that will cause the # gTest code to not compile as expected at this time gtest_env.Append(CPPPATH = [ gtest_src_base ]) if gtest_dir != '/usr': gtest_env.Append(CPPPATH = [ gtest_env.Dir('$GTEST_DIR/include') ]) gtest_obj = gtest_env.StaticObject(target = 'gtest-all', source = [ '%s/src/gtest-all.cc' % gtest_src_base ]) gtest_env.StaticLibrary(target = 'gtest', source = gtest_obj) test_src = gtest_env.Glob('*.cc') unittest_env = env.Clone() if unittest_env['BR'] == 'on': # Build apps with bundled daemon support unittest_env.Prepend(LIBS = [unittest_env['ajrlib']]) unittest_env.Prepend(LIBS = unittest_env['ALLJOYN_C_LIB_STATIC']) gtest_dir = unittest_env['GTEST_DIR'] if gtest_dir != '/usr': unittest_env.Append(CPPPATH = [gtest_dir + '/include']) if unittest_env['OS_GROUP'] == 'windows': unittest_env.Append(CXXFLAGS = ['/EHsc']) #we compile with no rtti and we are not using exceptions. unittest_env.Append(CPPDEFINES = ['GTEST_HAS_RTTI=0']) if unittest_env['OS_CONF'] == 'android': # used by gtest to prevent use of wcscasecmp and set GTEST_HAS_STD_WSTRING=0 unittest_env.Append(CPPDEFINES = ['ANDROID']) # tr1::tuple is not avalible for android or darwin if unittest_env['OS_CONF'] in [ 'android', 'darwin' ]: unittest_env.Append(CPPDEFINES = ['GTEST_HAS_TR1_TUPLE=0']) if unittest_env['OS_CONF'] == 'android' and unittest_env['CPU'] == 'x86': unittest_env.Append(CPPDEFINES = ['GTEST_HAS_CLONE=0']) if unittest_env['OS_CONF'] == 'windows' and unittest_env['MSVC_VERSION'] == '11.0': unittest_env.Append(CPPDEFINES = ['_VARIADIC_MAX=10']) #gtest library file is placed on folder above the the object files. unittest_env.Append(LIBPATH = ['./']) unittest_env.Prepend(LIBS = ['gtest']) objs = [ unittest_env.Object(test_src) ] unittest_prog = unittest_env.Program('ajctest', objs) unittest_env.Install('$C_TESTDIR/bin', unittest_prog) #install gtest utilities unittest_env.Install('$C_TESTDIR/bin', Dir('test_report').srcnode()) alljoyn-15.04b/alljoyn_c/unit_test/SessionListenerTest.cc000066400000000000000000000636661255700255500236540ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include "ajTestCommon.h" #include #include #include #include /*constants*/ static const char* INTERFACE_NAME = "org.alljoyn.test.SessionListenerTest"; static const char* OBJECT_PATH = "/org/alljoyn/test/SessionListenerTest"; static const alljoyn_sessionport SESSION_PORT = 42; /* session listener flags */ static QCC_BOOL session_lost_flag = QCC_FALSE; static QCC_BOOL session_lost_reason_flag = QCC_FALSE; static QCC_BOOL session_member_added_flag = QCC_FALSE; static QCC_BOOL session_member_removed_flag = QCC_FALSE; static alljoyn_sessionlostreason sessionlostreason = ALLJOYN_SESSIONLOST_INVALID; /* session port listener flags */ static QCC_BOOL accept_session_joiner_flag = QCC_FALSE; static QCC_BOOL session_joined_flag = QCC_FALSE; static alljoyn_sessionid joinsessionid; /* bus listener flags */ static QCC_BOOL listener_registered_flag = QCC_FALSE; static QCC_BOOL listener_unregistered_flag = QCC_FALSE; static QCC_BOOL found_advertised_name_flag = QCC_FALSE; static QCC_BOOL lost_advertised_name_flag = QCC_FALSE; static QCC_BOOL name_owner_changed_flag = QCC_FALSE; static QCC_BOOL bus_stopping_flag = QCC_FALSE; static QCC_BOOL bus_disconnected_flag = QCC_FALSE; static QCC_BOOL prop_changed_flag = QCC_FALSE; static alljoyn_transportmask transport_found = 0; static char* member_added_uniquename = NULL; static char* member_removed_uniquename = NULL; /* session listener functions */ static void AJ_CALL session_lost(const void* context, alljoyn_sessionid sessionId, alljoyn_sessionlostreason reason) { QCC_UNUSED(context); QCC_UNUSED(sessionId); sessionlostreason = reason; session_lost_flag = QCC_TRUE; } static void AJ_CALL session_member_added(const void* context, alljoyn_sessionid sessionid, const char* uniqueName) { QCC_UNUSED(context); QCC_UNUSED(sessionid); int uniqueNameSize = strlen(uniqueName); if (member_added_uniquename != NULL) { free(member_added_uniquename); member_added_uniquename = NULL; } member_added_uniquename = (char*) malloc(uniqueNameSize * sizeof(char) + sizeof(char)); strncpy(member_added_uniquename, uniqueName, uniqueNameSize); member_added_uniquename[uniqueNameSize] = '\0'; session_member_added_flag = QCC_TRUE; } static void AJ_CALL session_member_removed(const void* context, alljoyn_sessionid sessionId, const char* uniqueName) { QCC_UNUSED(context); QCC_UNUSED(sessionId); int uniqueNameSize = strlen(uniqueName); if (member_removed_uniquename != NULL) { free(member_removed_uniquename); member_removed_uniquename = NULL; } member_removed_uniquename = (char*) malloc(uniqueNameSize * sizeof(char) + sizeof(char)); strncpy(member_removed_uniquename, uniqueName, uniqueNameSize); member_removed_uniquename[uniqueNameSize] = '\0'; session_member_removed_flag = QCC_TRUE; } /* session port listener */ static QCC_BOOL AJ_CALL accept_session_joiner(const void* context, alljoyn_sessionport sessionPort, const char* joiner, const alljoyn_sessionopts opts) { QCC_UNUSED(context); QCC_UNUSED(joiner); QCC_UNUSED(opts); QCC_BOOL ret = QCC_FALSE; if (sessionPort == SESSION_PORT) { ret = QCC_TRUE; } accept_session_joiner_flag = QCC_TRUE; return ret; } static void AJ_CALL session_joined(const void* context, alljoyn_sessionport sessionPort, alljoyn_sessionid id, const char* joiner) { QCC_UNUSED(context); QCC_UNUSED(joiner); EXPECT_EQ(SESSION_PORT, sessionPort); joinsessionid = id; session_joined_flag = QCC_TRUE; } /* bus listener functions */ static void AJ_CALL found_advertised_name(const void* context, const char* name, alljoyn_transportmask transport, const char* namePrefix) { QCC_UNUSED(context); QCC_UNUSED(name); QCC_UNUSED(namePrefix); transport_found |= transport; found_advertised_name_flag = QCC_TRUE; } static void AJ_CALL lost_advertised_name(const void* context, const char* name, alljoyn_transportmask transport, const char* namePrefix) { QCC_UNUSED(context); QCC_UNUSED(name); QCC_UNUSED(transport); QCC_UNUSED(namePrefix); lost_advertised_name_flag = QCC_TRUE; } /* Exposed methods */ static void AJ_CALL ping_method(alljoyn_busobject bus, const alljoyn_interfacedescription_member* member, alljoyn_message msg) { QCC_UNUSED(member); alljoyn_msgarg outArg = alljoyn_msgarg_create(); outArg = alljoyn_message_getarg(msg, 0); const char* str; alljoyn_msgarg_get(outArg, "s", &str); QStatus status = alljoyn_busobject_methodreply_args(bus, msg, outArg, 1); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); } class SessionListenerTest : public testing::Test { public: virtual void SetUp() { resetFlags(); servicebus = alljoyn_busattachment_create("SessionListenerTestService", QCC_FALSE); objectName = ajn::genUniqueName(servicebus); EXPECT_EQ(ER_OK, alljoyn_busattachment_start(servicebus)); EXPECT_EQ(ER_OK, alljoyn_busattachment_connect(servicebus, ajn::getConnectArg().c_str())); alljoyn_interfacedescription testIntf = NULL; status = alljoyn_busattachment_createinterface(servicebus, INTERFACE_NAME, &testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_TRUE(testIntf != NULL); if (testIntf != NULL) { status = alljoyn_interfacedescription_addmethod(testIntf, "ping", "s", "s", "in,out", 0, 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription_activate(testIntf); testObj = alljoyn_busobject_create(OBJECT_PATH, QCC_FALSE, NULL, NULL); status = alljoyn_busobject_addinterface(testObj, testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* register method handlers */ alljoyn_interfacedescription_member ping_member; EXPECT_TRUE(alljoyn_interfacedescription_getmember(testIntf, "ping", &ping_member)); status = alljoyn_busobject_addmethodhandler(testObj, ping_member, &ping_method, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* register the bus object */ status = alljoyn_busattachment_registerbusobject(servicebus, testObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* Create session port listener */ alljoyn_sessionportlistener_callbacks spl_cbs = { &accept_session_joiner, /* accept session joiner CB */ &session_joined /* session joined CB */ }; sessionPortListener = alljoyn_sessionportlistener_create(&spl_cbs, NULL); /* Bind SessionPort session opts specify this is a multipoint session */ opts = alljoyn_sessionopts_create(ALLJOYN_TRAFFIC_TYPE_MESSAGES, QCC_TRUE, ALLJOYN_PROXIMITY_ANY, ALLJOYN_TRANSPORT_ANY); alljoyn_sessionport sp = SESSION_PORT; status = alljoyn_busattachment_bindsessionport(servicebus, &sp, opts, sessionPortListener); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* request name from the bus */ int flag = DBUS_NAME_FLAG_REPLACE_EXISTING | DBUS_NAME_FLAG_DO_NOT_QUEUE; EXPECT_EQ(ER_OK, alljoyn_busattachment_requestname(servicebus, objectName.c_str(), flag)); EXPECT_EQ(ER_OK, alljoyn_busattachment_advertisename(servicebus, objectName.c_str(), alljoyn_sessionopts_get_transports(opts))); clientbus = alljoyn_busattachment_create("SessionListenerTestClient", QCC_FALSE); EXPECT_EQ(ER_OK, alljoyn_busattachment_start(clientbus)); EXPECT_EQ(ER_OK, alljoyn_busattachment_connect(clientbus, ajn::getConnectArg().c_str())); /* register bus listener */ alljoyn_buslistener_callbacks buslistenerCbs = { NULL, //&listener_registered, NULL, //&listener_unregistered, &found_advertised_name, &lost_advertised_name, NULL, //&name_owner_changed, NULL, //&bus_stopping, NULL, //&bus_disconnected, NULL, //&bus_prop_changed }; buslistener = alljoyn_buslistener_create(&buslistenerCbs, NULL); alljoyn_busattachment_registerbuslistener(clientbus, buslistener); alljoyn_sessionlistener_callbacks sessionlisternerCbs = { &session_lost, &session_member_added, &session_member_removed }; sessionListener = alljoyn_sessionlistener_create(&sessionlisternerCbs, NULL); } } virtual void TearDown() { resetFlags(); alljoyn_sessionopts_destroy(opts); alljoyn_sessionportlistener_destroy(sessionPortListener); alljoyn_busattachment_unregisterbuslistener(clientbus, buslistener); EXPECT_NO_FATAL_FAILURE(alljoyn_sessionlistener_destroy(sessionListener)); EXPECT_NO_FATAL_FAILURE(alljoyn_buslistener_destroy(buslistener)); alljoyn_busattachment_stop(clientbus); alljoyn_busattachment_join(clientbus); alljoyn_busattachment_destroy(clientbus); alljoyn_busattachment_stop(servicebus); alljoyn_busattachment_join(servicebus); EXPECT_NO_FATAL_FAILURE(alljoyn_busattachment_destroy(servicebus)); alljoyn_busobject_destroy(testObj); } void resetFlags() { /* session listener flags */ session_lost_flag = false; session_lost_reason_flag = false; session_member_added_flag = false; session_member_removed_flag = false; sessionlostreason = ALLJOYN_SESSIONLOST_INVALID; /* session port listener flags */ accept_session_joiner_flag = QCC_FALSE; session_joined_flag = QCC_FALSE; /* bus listener flags */ listener_registered_flag = QCC_FALSE; listener_unregistered_flag = QCC_FALSE; found_advertised_name_flag = QCC_FALSE; lost_advertised_name_flag = QCC_FALSE; name_owner_changed_flag = QCC_FALSE; bus_stopping_flag = QCC_FALSE; bus_disconnected_flag = QCC_FALSE; prop_changed_flag = QCC_FALSE; transport_found = 0; if (member_added_uniquename != NULL) { free(member_added_uniquename); member_added_uniquename = NULL; } if (member_removed_uniquename != NULL) { free(member_removed_uniquename); member_removed_uniquename = NULL; } } QStatus status; alljoyn_busattachment servicebus; alljoyn_busattachment clientbus; alljoyn_busobject testObj; alljoyn_buslistener buslistener; alljoyn_sessionportlistener sessionPortListener; alljoyn_sessionlistener sessionListener; qcc::String objectName; alljoyn_sessionopts opts; }; TEST_F(SessionListenerTest, sessionlosttest_remote_end_left_session) { resetFlags(); /* Begin discover of the well-known name */ status = alljoyn_busattachment_findadvertisedname(clientbus, objectName.c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 1000; ++i) { if (found_advertised_name_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(found_advertised_name_flag); alljoyn_sessionid sid; joinsessionid = 0; status = alljoyn_busattachment_joinsession(clientbus, objectName.c_str(), SESSION_PORT, sessionListener, &sid, opts); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 1000; ++i) { if (session_joined_flag && session_member_added_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(session_joined_flag); EXPECT_EQ(sid, joinsessionid); EXPECT_TRUE(session_member_added_flag); EXPECT_STREQ(alljoyn_busattachment_getuniquename(servicebus), member_added_uniquename); status = alljoyn_busattachment_leavesession(servicebus, sid); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 1000; ++i) { if (session_lost_flag && session_member_removed_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(session_lost_flag); EXPECT_EQ(ALLJOYN_SESSIONLOST_REMOTE_END_LEFT_SESSION, sessionlostreason); EXPECT_TRUE(session_member_removed_flag); EXPECT_STREQ(alljoyn_busattachment_getuniquename(servicebus), member_removed_uniquename); } TEST_F(SessionListenerTest, sessionlosttest_closed_abruptly) { resetFlags(); /* Begin discover of the well-known name */ status = alljoyn_busattachment_findadvertisedname(clientbus, objectName.c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 1000; ++i) { if (found_advertised_name_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(found_advertised_name_flag); alljoyn_sessionid sid; joinsessionid = 0; status = alljoyn_busattachment_joinsession(clientbus, objectName.c_str(), SESSION_PORT, sessionListener, &sid, opts); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 1000; ++i) { if (session_joined_flag && session_member_added_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(session_joined_flag); EXPECT_EQ(sid, joinsessionid); EXPECT_TRUE(session_member_added_flag); EXPECT_STREQ(alljoyn_busattachment_getuniquename(servicebus), member_added_uniquename); status = alljoyn_busattachment_disconnect(servicebus, ajn::getConnectArg().c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 1000; ++i) { if (session_lost_flag && session_member_removed_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(session_lost_flag); EXPECT_TRUE(session_member_removed_flag); EXPECT_EQ(ALLJOYN_SESSIONLOST_REMOTE_END_CLOSED_ABRUPTLY, sessionlostreason); /* * the servicebus has been disconnected so we can not use the getuniquename * function on the servicebus. If the check done above passes then this * should also pass. */ EXPECT_STREQ(member_added_uniquename, member_removed_uniquename); } TEST_F(SessionListenerTest, sessionmember_added_removed) { resetFlags(); /* Begin discover of the well-known name */ status = alljoyn_busattachment_findadvertisedname(clientbus, objectName.c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 1000; ++i) { if (found_advertised_name_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(found_advertised_name_flag); alljoyn_sessionid sid; joinsessionid = 0; status = alljoyn_busattachment_joinsession(clientbus, objectName.c_str(), SESSION_PORT, NULL, &sid, opts); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 1000; ++i) { if (session_joined_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(session_joined_flag); EXPECT_EQ(sid, joinsessionid); /* we now have a session id we can use to set the session listener for the service */ status = alljoyn_busattachment_setsessionlistener(servicebus, sid, sessionListener); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment clientbus2 = alljoyn_busattachment_create("SessionListenerTestClient", QCC_FALSE); EXPECT_EQ(ER_OK, alljoyn_busattachment_start(clientbus2)); EXPECT_EQ(ER_OK, alljoyn_busattachment_connect(clientbus2, ajn::getConnectArg().c_str())); /* we are only interested in the sessionListener used by the service not any of the clients */ resetFlags(); status = alljoyn_busattachment_joinsession(clientbus2, objectName.c_str(), SESSION_PORT, NULL, &sid, opts); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 1000; ++i) { if (session_joined_flag && session_member_added_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(session_joined_flag); EXPECT_EQ(sid, joinsessionid); EXPECT_TRUE(session_member_added_flag); EXPECT_STREQ(alljoyn_busattachment_getuniquename(clientbus2), member_added_uniquename) << "clientbus UID = " << alljoyn_busattachment_getuniquename(clientbus) << "\nservicebus UID = " << alljoyn_busattachment_getuniquename(servicebus); status = alljoyn_busattachment_leavesession(clientbus, sid); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 1000; ++i) { if (session_member_removed_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(session_member_removed_flag); EXPECT_STREQ(alljoyn_busattachment_getuniquename(clientbus), member_removed_uniquename); resetFlags(); status = alljoyn_busattachment_leavesession(clientbus2, sid); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 1000; ++i) { if (session_lost_flag && session_member_removed_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(session_lost_flag); EXPECT_EQ(ALLJOYN_SESSIONLOST_REMOTE_END_LEFT_SESSION, sessionlostreason); EXPECT_TRUE(session_member_removed_flag); EXPECT_STREQ(alljoyn_busattachment_getuniquename(clientbus2), member_removed_uniquename); alljoyn_busattachment_destroy(clientbus2); } /* session listener flags */ static QCC_BOOL service_session_lost_flag = QCC_FALSE; static QCC_BOOL service_session_lost_reason_flag = QCC_FALSE; static QCC_BOOL service_session_member_added_flag = QCC_FALSE; static QCC_BOOL service_session_member_removed_flag = QCC_FALSE; static alljoyn_sessionlostreason service_sessionlostreason = ALLJOYN_SESSIONLOST_INVALID; static char* service_member_added_uniquename = NULL; static char* service_member_removed_uniquename = NULL; void resetServicSessionListenerFlags() { service_session_lost_flag = QCC_FALSE; service_session_lost_reason_flag = QCC_FALSE; service_session_member_added_flag = QCC_FALSE; service_session_member_removed_flag = QCC_FALSE; sessionlostreason = ALLJOYN_SESSIONLOST_INVALID; if (service_member_added_uniquename != NULL) { free(service_member_added_uniquename); service_member_added_uniquename = NULL; } if (service_member_removed_uniquename != NULL) { free(service_member_removed_uniquename); service_member_removed_uniquename = NULL; } } /* service session listener functions */ static void AJ_CALL service_session_lost(const void* context, alljoyn_sessionid sessionId, alljoyn_sessionlostreason reason) { QCC_UNUSED(context); QCC_UNUSED(sessionId); service_sessionlostreason = reason; service_session_lost_flag = QCC_TRUE; } static void AJ_CALL service_session_member_added(const void* context, alljoyn_sessionid sessionid, const char* uniqueName) { QCC_UNUSED(context); QCC_UNUSED(sessionid); int uniqueNameSize = strlen(uniqueName); if (service_member_added_uniquename != NULL) { free(service_member_added_uniquename); service_member_added_uniquename = NULL; } service_member_added_uniquename = (char*) malloc(uniqueNameSize * sizeof(char) + sizeof(char)); strncpy(service_member_added_uniquename, uniqueName, uniqueNameSize); service_member_added_uniquename[uniqueNameSize] = '\0'; service_session_member_added_flag = QCC_TRUE; } static void AJ_CALL service_session_member_removed(const void* context, alljoyn_sessionid sessionId, const char* uniqueName) { QCC_UNUSED(context); QCC_UNUSED(sessionId); int uniqueNameSize = strlen(uniqueName); if (service_member_removed_uniquename != NULL) { free(service_member_removed_uniquename); service_member_removed_uniquename = NULL; } service_member_removed_uniquename = (char*) malloc(uniqueNameSize * sizeof(char) + sizeof(char)); strncpy(service_member_removed_uniquename, uniqueName, uniqueNameSize); service_member_removed_uniquename[uniqueNameSize] = '\0'; service_session_member_removed_flag = QCC_TRUE; } TEST_F(SessionListenerTest, removesessionmember) { alljoyn_sessionlistener_callbacks service_sessionlisternerCbs = { &service_session_lost, &service_session_member_added, &service_session_member_removed }; alljoyn_sessionlistener service_sessionListener = alljoyn_sessionlistener_create(&service_sessionlisternerCbs, NULL); resetFlags(); resetServicSessionListenerFlags(); /* Begin discover of the well-known name */ status = alljoyn_busattachment_findadvertisedname(clientbus, objectName.c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 1000; ++i) { if (found_advertised_name_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(found_advertised_name_flag); alljoyn_sessionid sid; joinsessionid = 0; status = alljoyn_busattachment_joinsession(clientbus, objectName.c_str(), SESSION_PORT, sessionListener, &sid, opts); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 1000; ++i) { if (session_joined_flag && session_member_added_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(session_joined_flag); EXPECT_EQ(sid, joinsessionid); EXPECT_TRUE(session_member_added_flag); EXPECT_STREQ(alljoyn_busattachment_getuniquename(servicebus), member_added_uniquename); /* we now have a session id we can use to set the session listener for the service */ status = alljoyn_busattachment_setsessionlistener(servicebus, sid, service_sessionListener); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_busattachment clientbus2 = alljoyn_busattachment_create("SessionListenerTestClient", QCC_FALSE); EXPECT_EQ(ER_OK, alljoyn_busattachment_start(clientbus2)); EXPECT_EQ(ER_OK, alljoyn_busattachment_connect(clientbus2, ajn::getConnectArg().c_str())); /* we are only interested in the sessionListener used by the service not any of the clients */ resetFlags(); resetServicSessionListenerFlags(); status = alljoyn_busattachment_joinsession(clientbus2, objectName.c_str(), SESSION_PORT, sessionListener, &sid, opts); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 1000; ++i) { if (session_joined_flag && service_session_member_added_flag && session_member_added_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(session_joined_flag); EXPECT_EQ(sid, joinsessionid); EXPECT_TRUE(session_member_added_flag); EXPECT_TRUE(service_session_member_added_flag); EXPECT_STREQ(alljoyn_busattachment_getuniquename(clientbus2), service_member_added_uniquename) << "clientbus UID = " << alljoyn_busattachment_getuniquename(clientbus) << "\nservicebus UID = " << alljoyn_busattachment_getuniquename(servicebus); resetFlags(); resetServicSessionListenerFlags(); status = alljoyn_busattachment_removesessionmember(servicebus, sid, alljoyn_busattachment_getuniquename(clientbus)); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 1000; ++i) { if (service_session_member_removed_flag && session_lost_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(service_session_member_removed_flag); EXPECT_STREQ(alljoyn_busattachment_getuniquename(clientbus), service_member_removed_uniquename); EXPECT_TRUE(session_lost_flag); EXPECT_EQ(ALLJOYN_SESSIONLOST_REMOVED_BY_BINDER, sessionlostreason); resetFlags(); resetServicSessionListenerFlags(); status = alljoyn_busattachment_removesessionmember(servicebus, sid, alljoyn_busattachment_getuniquename(clientbus2)); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 1000; ++i) { if (service_session_lost_flag && service_session_member_removed_flag && session_lost_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(service_session_lost_flag); EXPECT_EQ(ALLJOYN_SESSIONLOST_REMOTE_END_LEFT_SESSION, service_sessionlostreason); EXPECT_TRUE(service_session_member_removed_flag); EXPECT_STREQ(alljoyn_busattachment_getuniquename(clientbus2), service_member_removed_uniquename); EXPECT_TRUE(session_lost_flag); EXPECT_EQ(ALLJOYN_SESSIONLOST_REMOVED_BY_BINDER, sessionlostreason); alljoyn_sessionlistener_destroy(service_sessionListener); resetServicSessionListenerFlags(); alljoyn_busattachment_destroy(clientbus2); } alljoyn-15.04b/alljoyn_c/unit_test/SessionOptsTest.cc000066400000000000000000000045251255700255500230010ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include TEST(SessionOptsTest, accessor_functions) { alljoyn_sessionopts opts = alljoyn_sessionopts_create(ALLJOYN_TRAFFIC_TYPE_MESSAGES, QCC_FALSE, ALLJOYN_PROXIMITY_ANY, ALLJOYN_TRANSPORT_ANY); EXPECT_EQ(ALLJOYN_TRAFFIC_TYPE_MESSAGES, alljoyn_sessionopts_get_traffic(opts)); EXPECT_EQ(QCC_FALSE, alljoyn_sessionopts_get_multipoint(opts)); EXPECT_EQ(ALLJOYN_PROXIMITY_ANY, alljoyn_sessionopts_get_proximity(opts)); EXPECT_EQ(ALLJOYN_TRANSPORT_ANY, alljoyn_sessionopts_get_transports(opts)); alljoyn_sessionopts_set_traffic(opts, ALLJOYN_TRAFFIC_TYPE_RAW_RELIABLE); EXPECT_EQ(ALLJOYN_TRAFFIC_TYPE_RAW_RELIABLE, alljoyn_sessionopts_get_traffic(opts)); alljoyn_sessionopts_set_multipoint(opts, QCC_TRUE); EXPECT_EQ(QCC_TRUE, alljoyn_sessionopts_get_multipoint(opts)); alljoyn_sessionopts_set_proximity(opts, ALLJOYN_PROXIMITY_PHYSICAL); EXPECT_EQ(ALLJOYN_PROXIMITY_PHYSICAL, alljoyn_sessionopts_get_proximity(opts)); alljoyn_sessionopts_set_transports(opts, ALLJOYN_TRANSPORT_TCP); EXPECT_EQ(ALLJOYN_TRANSPORT_TCP, alljoyn_sessionopts_get_transports(opts)); alljoyn_sessionopts_destroy(opts); } alljoyn-15.04b/alljoyn_c/unit_test/SessionTest.cc000066400000000000000000000451671255700255500221420ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include "ajTestCommon.h" #include #include #include /*constants*/ static const char* INTERFACE_NAME = "org.alljoyn.test.SessionTest"; static qcc::String objectName; static const char* OBJECT_PATH = "/org/alljoyn/test/SessionTest"; static const alljoyn_sessionport SESSION_PORT = 42; static QCC_BOOL joinsessionhandler_flag; static QCC_BOOL foundadvertisedname_flag; static QCC_BOOL sessionjoined_flag; static alljoyn_sessionid joinsessionid; static alljoyn_sessionid joinsessionid_alt; /* AcceptSessionJoiner callback */ static QCC_BOOL AJ_CALL accept_session_joiner(const void* context, alljoyn_sessionport sessionPort, const char* joiner, const alljoyn_sessionopts opts) { QCC_UNUSED(context); QCC_UNUSED(joiner); QCC_UNUSED(opts); QCC_BOOL ret = QCC_FALSE; if (sessionPort == SESSION_PORT) { ret = QCC_TRUE; } return ret; } static void AJ_CALL session_joined(const void* context, alljoyn_sessionport sessionPort, alljoyn_sessionid id, const char* joiner) { QCC_UNUSED(context); QCC_UNUSED(joiner); //printf("session_joined\n"); EXPECT_EQ(SESSION_PORT, sessionPort); joinsessionid = id; sessionjoined_flag = true; } static void AJ_CALL joinsessionhandler(QStatus status, alljoyn_sessionid sessionId, const alljoyn_sessionopts opts, void* context) { QCC_UNUSED(status); QCC_UNUSED(opts); EXPECT_STREQ("A test string to send as the context void*", (char*)context); joinsessionid_alt = sessionId; joinsessionhandler_flag = QCC_TRUE; } /* FoundAdvertisedName callback */ void AJ_CALL found_advertised_name(const void* context, const char* name, alljoyn_transportmask transport, const char* namePrefix) { QCC_UNUSED(context); QCC_UNUSED(transport); QCC_UNUSED(namePrefix); //printf("FoundAdvertisedName(name=%s, prefix=%s)\n", name, namePrefix); EXPECT_STREQ(objectName.c_str(), name); if (0 == strcmp(name, objectName.c_str())) { foundadvertisedname_flag = QCC_TRUE; } } /* Exposed methods */ static void AJ_CALL ping_method(alljoyn_busobject bus, const alljoyn_interfacedescription_member* member, alljoyn_message msg) { QCC_UNUSED(member); alljoyn_msgarg outArg = alljoyn_msgarg_create(); outArg = alljoyn_message_getarg(msg, 0); const char* str; alljoyn_msgarg_get(outArg, "s", &str); QStatus status = alljoyn_busobject_methodreply_args(bus, msg, outArg, 1); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); } class SessionTest : public testing::Test { public: virtual void SetUp() { bus = alljoyn_busattachment_create("SessionTest", false); status = alljoyn_busattachment_start(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(bus, ajn::getConnectArg().c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); } virtual void TearDown() { alljoyn_busattachment_stop(bus); alljoyn_busattachment_join(bus); EXPECT_NO_FATAL_FAILURE(alljoyn_busattachment_destroy(bus)); } void SetUpSessionTestService() { /* create/start/connect alljoyn_busattachment */ servicebus = alljoyn_busattachment_create("SessionTestservice", false); objectName = ajn::genUniqueName(servicebus); status = alljoyn_busattachment_start(servicebus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(servicebus, ajn::getConnectArg().c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription testIntf = NULL; status = alljoyn_busattachment_createinterface(servicebus, INTERFACE_NAME, &testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_TRUE(testIntf != NULL); if (testIntf != NULL) { status = alljoyn_interfacedescription_addmethod(testIntf, "ping", "s", "s", "in,out", 0, 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription_activate(testIntf); // /* register bus listener */ // alljoyn_buslistener_callbacks buslistenerCbs = { // NULL, /* bus listener registered CB */ // NULL, /* bus listener unregistered CB */ // NULL, /* found advertised name CB */ // NULL, /* lost advertised name CB */ // NULL, /* name owner changed CB */ // NULL, /* Bus Stopping CB */ // NULL, /* Bus Disconnected CB */ // NULL /* Property Changed CB */ // }; // buslistener = alljoyn_buslistener_create(&buslistenerCbs, NULL); // alljoyn_busattachment_registerbuslistener(servicebus, buslistener); /* Set up bus object */ alljoyn_busobject_callbacks busObjCbs = { NULL, /* Get alljoyn property CB */ NULL, /* Set alljoyn property CB */ NULL, /* BusObject Registered CB */ NULL /* BusObject Unregistered CB */ }; testObj = alljoyn_busobject_create(OBJECT_PATH, QCC_FALSE, &busObjCbs, NULL); status = alljoyn_busobject_addinterface(testObj, testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* register method handlers */ alljoyn_interfacedescription_member ping_member; EXPECT_TRUE(alljoyn_interfacedescription_getmember(testIntf, "ping", &ping_member)); status = alljoyn_busobject_addmethodhandler(testObj, ping_member, &ping_method, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_registerbusobject(servicebus, testObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* request name */ uint32_t flags = DBUS_NAME_FLAG_REPLACE_EXISTING | DBUS_NAME_FLAG_DO_NOT_QUEUE; status = alljoyn_busattachment_requestname(servicebus, objectName.c_str(), flags); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* Create session port listener */ alljoyn_sessionportlistener_callbacks spl_cbs = { &accept_session_joiner, /* accept session joiner CB */ &session_joined /* session joined CB */ }; sessionPortListener = alljoyn_sessionportlistener_create(&spl_cbs, NULL); /* Bind SessionPort */ alljoyn_sessionopts opts = alljoyn_sessionopts_create(ALLJOYN_TRAFFIC_TYPE_MESSAGES, QCC_FALSE, ALLJOYN_PROXIMITY_ANY, ALLJOYN_TRANSPORT_ANY); alljoyn_sessionport sp = SESSION_PORT; status = alljoyn_busattachment_bindsessionport(servicebus, &sp, opts, sessionPortListener); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* Advertise Name */ status = alljoyn_busattachment_advertisename(servicebus, objectName.c_str(), alljoyn_sessionopts_get_transports(opts)); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_sessionopts_destroy(opts); } } void TearDownSessionTestService() { alljoyn_busattachment_stop(servicebus); alljoyn_busattachment_join(servicebus); alljoyn_busattachment_destroy(servicebus); alljoyn_sessionportlistener_destroy(sessionPortListener); alljoyn_busobject_destroy(testObj); } QStatus status; alljoyn_busattachment bus; alljoyn_busobject testObj; alljoyn_busattachment servicebus; alljoyn_buslistener buslistener; alljoyn_sessionportlistener sessionPortListener; }; TEST_F(SessionTest, joinsession) { SetUpSessionTestService(); /* Create a bus listener */ alljoyn_buslistener_callbacks callbacks = { NULL, /* listener registered CB */ NULL, /* listener unregistered CB */ &found_advertised_name, /* found advertised name CB */ NULL, /* lost advertised name CB */ NULL, /* name owner changed CB */ NULL, /* bus stopping CB*/ NULL /* bus disconnected CB */ }; buslistener = alljoyn_buslistener_create(&callbacks, NULL); alljoyn_busattachment_registerbuslistener(bus, buslistener); foundadvertisedname_flag = QCC_FALSE; sessionjoined_flag = QCC_FALSE; /* Begin discover of the well-known name */ status = alljoyn_busattachment_findadvertisedname(bus, objectName.c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 1000; ++i) { if (foundadvertisedname_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(foundadvertisedname_flag); /* We found a remote bus that is advertising basic service's well-known name so connect to it */ alljoyn_sessionopts opts = alljoyn_sessionopts_create(ALLJOYN_TRAFFIC_TYPE_MESSAGES, QCC_FALSE, ALLJOYN_PROXIMITY_ANY, ALLJOYN_TRANSPORT_ANY); alljoyn_sessionid sid; status = alljoyn_busattachment_joinsession(bus, objectName.c_str(), SESSION_PORT, NULL, &sid, opts); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 1000; ++i) { if (sessionjoined_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(sessionjoined_flag); EXPECT_EQ(sid, joinsessionid); alljoyn_sessionopts_destroy(opts); //joincompleted_flag = QCC_TRUE; alljoyn_busattachment_unregisterbuslistener(bus, buslistener); alljoyn_buslistener_destroy(buslistener); TearDownSessionTestService(); } TEST_F(SessionTest, joinsessionasync) { SetUpSessionTestService(); /* Create a bus listener */ alljoyn_buslistener_callbacks callbacks = { NULL, /* listener registered CB */ NULL, /* listener unregistered CB */ &found_advertised_name, /* found advertised name CB */ NULL, /* lost advertised name CB */ NULL, /* name owner changed CB */ NULL, /* bus stopping CB*/ NULL /* bus disconnected CB */ }; buslistener = alljoyn_buslistener_create(&callbacks, NULL); alljoyn_busattachment_registerbuslistener(bus, buslistener); foundadvertisedname_flag = QCC_FALSE; sessionjoined_flag = QCC_FALSE; joinsessionhandler_flag = QCC_FALSE; joinsessionid = 0; joinsessionid_alt = 0; /* Begin discover of the well-known name */ status = alljoyn_busattachment_findadvertisedname(bus, objectName.c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 1000; ++i) { if (foundadvertisedname_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(foundadvertisedname_flag); /* We found a remote bus that is advertising basic service's well-known name so connect to it */ alljoyn_sessionopts opts = alljoyn_sessionopts_create(ALLJOYN_TRAFFIC_TYPE_MESSAGES, QCC_FALSE, ALLJOYN_PROXIMITY_ANY, ALLJOYN_TRANSPORT_ANY); char dave[64] = "A test string to send as the context void*"; status = alljoyn_busattachment_joinsessionasync(bus, objectName.c_str(), SESSION_PORT, NULL, opts, &joinsessionhandler, (void*)dave); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 1000; ++i) { // we can not break till both session flags have been set or we have a // race condition that one of the two values have not been set. if (sessionjoined_flag && joinsessionhandler_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(sessionjoined_flag); EXPECT_TRUE(joinsessionhandler_flag); EXPECT_EQ(joinsessionid_alt, joinsessionid); alljoyn_sessionopts_destroy(opts); alljoyn_busattachment_unregisterbuslistener(bus, buslistener); alljoyn_buslistener_destroy(buslistener); TearDownSessionTestService(); } TEST_F(SessionTest, setLinkTimeout) { SetUpSessionTestService(); /* Create a bus listener */ alljoyn_buslistener_callbacks callbacks = { NULL, /* listener registered CB */ NULL, /* listener unregistered CB */ &found_advertised_name, /* found advertised name CB */ NULL, /* lost advertised name CB */ NULL, /* name owner changed CB */ NULL, /* bus stopping CB*/ NULL /* bus disconnected CB */ }; buslistener = alljoyn_buslistener_create(&callbacks, NULL); alljoyn_busattachment_registerbuslistener(bus, buslistener); foundadvertisedname_flag = QCC_FALSE; sessionjoined_flag = QCC_FALSE; /* Begin discover of the well-known name */ status = alljoyn_busattachment_findadvertisedname(bus, objectName.c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 200; ++i) { if (foundadvertisedname_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(foundadvertisedname_flag); /* We found a remote bus that is advertising basic service's well-known name so connect to it */ alljoyn_sessionopts opts = alljoyn_sessionopts_create(ALLJOYN_TRAFFIC_TYPE_MESSAGES, QCC_FALSE, ALLJOYN_PROXIMITY_ANY, ALLJOYN_TRANSPORT_ANY); alljoyn_sessionid sid; status = alljoyn_busattachment_joinsession(bus, objectName.c_str(), SESSION_PORT, NULL, &sid, opts); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 200; ++i) { if (sessionjoined_flag) { break; } qcc::Sleep(5); } EXPECT_EQ(sid, joinsessionid); EXPECT_TRUE(sessionjoined_flag); // setting the linkTimeout to 2 min. This value is high enough that the // it should not be changed by the underlying transport. uint32_t linkTimeout = 120; status = alljoyn_busattachment_setlinktimeout(bus, sid, &linkTimeout); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_EQ(120u, linkTimeout); alljoyn_sessionopts_destroy(opts); alljoyn_busattachment_unregisterbuslistener(bus, buslistener); alljoyn_buslistener_destroy(buslistener); TearDownSessionTestService(); } QCC_BOOL setlinktimeout_flag = QCC_FALSE; void AJ_CALL alljoyn_busattachment_setlinktimeoutcb(QStatus status, uint32_t timeout, void* context) { EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); EXPECT_EQ(120u, timeout); EXPECT_STREQ("String passed as context.", (const char*)context); setlinktimeout_flag = QCC_TRUE; } TEST_F(SessionTest, setLinkTimeoutasync) { SetUpSessionTestService(); /* Create a bus listener */ alljoyn_buslistener_callbacks callbacks = { NULL, /* listener registered CB */ NULL, /* listener unregistered CB */ &found_advertised_name, /* found advertised name CB */ NULL, /* lost advertised name CB */ NULL, /* name owner changed CB */ NULL, /* bus stopping CB*/ NULL /* bus disconnected CB */ }; buslistener = alljoyn_buslistener_create(&callbacks, NULL); alljoyn_busattachment_registerbuslistener(bus, buslistener); foundadvertisedname_flag = QCC_FALSE; sessionjoined_flag = QCC_FALSE; /* Begin discover of the well-known name */ status = alljoyn_busattachment_findadvertisedname(bus, objectName.c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 200; ++i) { if (foundadvertisedname_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(foundadvertisedname_flag); /* We found a remote bus that is advertising basic service's well-known name so connect to it */ alljoyn_sessionopts opts = alljoyn_sessionopts_create(ALLJOYN_TRAFFIC_TYPE_MESSAGES, QCC_FALSE, ALLJOYN_PROXIMITY_ANY, ALLJOYN_TRANSPORT_ANY); alljoyn_sessionid sid; status = alljoyn_busattachment_joinsession(bus, objectName.c_str(), SESSION_PORT, NULL, &sid, opts); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); for (size_t i = 0; i < 200; ++i) { if (sessionjoined_flag) { break; } qcc::Sleep(5); } EXPECT_EQ(sid, joinsessionid); EXPECT_TRUE(sessionjoined_flag); // setting the linkTimeout to 2 min. This value is high enough that the // it should not be changed by the underlying transport. setlinktimeout_flag = QCC_FALSE; uint32_t linkTimeout = 120; status = alljoyn_busattachment_setlinktimeoutasync(bus, sid, linkTimeout, alljoyn_busattachment_setlinktimeoutcb, (void*)"String passed as context."); for (size_t i = 0; i < 200; ++i) { if (setlinktimeout_flag) { break; } qcc::Sleep(5); } EXPECT_TRUE(setlinktimeout_flag); alljoyn_sessionopts_destroy(opts); alljoyn_busattachment_unregisterbuslistener(bus, buslistener); alljoyn_buslistener_destroy(buslistener); TearDownSessionTestService(); } alljoyn-15.04b/alljoyn_c/unit_test/SignalsTest.cc000066400000000000000000001351241255700255500221100ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #include "ajTestCommon.h" #define SESSION_PORT 666 /* * values used for the registersignalhandler test */ bool registersignalhandler_flag; bool registersignalhandler_flag2; bool registersignalhandler_flag3; char sourcePath1[256]; char sourcePath2[256]; char sourcePath3[256]; void AJ_CALL registersignalHandler_Handler(const alljoyn_interfacedescription_member* member, const char* srcPath, alljoyn_message message) { QCC_UNUSED(member); QStatus status = ER_FAIL; EXPECT_STREQ(sourcePath1, srcPath); char* str; status = alljoyn_msgarg_get(alljoyn_message_getarg(message, 0), "s", &str); EXPECT_EQ(ER_OK, status); EXPECT_STREQ("AllJoyn", str); registersignalhandler_flag = true; } void AJ_CALL registersignalHandler_Handler2(const alljoyn_interfacedescription_member* member, const char* srcPath, alljoyn_message message) { QCC_UNUSED(member); QStatus status = ER_FAIL; EXPECT_STREQ(sourcePath2, srcPath); char* str; status = alljoyn_msgarg_get(alljoyn_message_getarg(message, 0), "s", &str); EXPECT_EQ(ER_OK, status); EXPECT_STREQ("AllJoyn", str); registersignalhandler_flag2 = true; } void AJ_CALL registersignalHandler_Handler3(const alljoyn_interfacedescription_member* member, const char* srcPath, alljoyn_message message) { QCC_UNUSED(member); QStatus status = ER_FAIL; EXPECT_STREQ(sourcePath3, srcPath); char* str; status = alljoyn_msgarg_get(alljoyn_message_getarg(message, 0), "s", &str); EXPECT_EQ(ER_OK, status); EXPECT_STREQ("AllJoyn", str); registersignalhandler_flag3 = true; } static QCC_BOOL AJ_CALL accept_session_joiner(const void* context, alljoyn_sessionport sessionPort, const char* joiner, const alljoyn_sessionopts opts) { QCC_UNUSED(context); QCC_UNUSED(sessionPort); QCC_UNUSED(joiner); QCC_UNUSED(opts); return QCC_TRUE; } static void AJ_CALL session_joined(const void* context, alljoyn_sessionport sessionPort, alljoyn_sessionid id, const char* joiner) { QCC_UNUSED(context); QCC_UNUSED(sessionPort); QCC_UNUSED(id); QCC_UNUSED(joiner); //printf("session_joined\n"); } TEST(SignalsTest, registersignalhandler_basic) { QStatus status = ER_OK; registersignalhandler_flag = false; registersignalhandler_flag2 = false; snprintf(sourcePath1, 256, "/org/alljoyn/test/signal"); alljoyn_busattachment bus = NULL; bus = alljoyn_busattachment_create("SignalsTest", QCC_TRUE); status = alljoyn_busattachment_start(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(bus, ajn::getConnectArg().c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription testIntf = NULL; status = alljoyn_busattachment_createinterface(bus, "org.alljoyn.test.signalstest", &testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(testIntf != NULL); if (status == ER_OK) { //alljoyn_interfacedescription_addmember(testIntf, ALLJOYN_MESSAGE_SIGNAL, "my_signal", "a{ys}", NULL, NULL, 0); status = alljoyn_interfacedescription_addmember(testIntf, ALLJOYN_MESSAGE_SIGNAL, "testSignal", "s", NULL, "newName", 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription_activate(testIntf); } /* Set up bus object */ alljoyn_busobject_callbacks busObjCbs = { NULL, NULL, NULL, NULL }; alljoyn_busobject testObj = alljoyn_busobject_create("/org/alljoyn/test/signal", QCC_FALSE, &busObjCbs, NULL); status = alljoyn_busobject_addinterface(testObj, testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_registerbusobject(bus, testObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription_member my_signal_member; QCC_BOOL foundMember = alljoyn_interfacedescription_getmember(testIntf, "testSignal", &my_signal_member); EXPECT_EQ(QCC_TRUE, foundMember); status = alljoyn_busattachment_addmatch(bus, "type='signal',interface='org.alljoyn.test.signalstest',member='testSignal'"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_registersignalhandler(bus, ®istersignalHandler_Handler, my_signal_member, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg arg = alljoyn_msgarg_array_create(1); size_t numArgs = 1; status = alljoyn_msgarg_array_set(arg, &numArgs, "s", "AllJoyn"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busobject_signal(testObj, NULL, 0, my_signal_member, arg, 1, 0, 0, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg_destroy(arg); //Wait upto 2 seconds for the signal to complete. for (int i = 0; i < 200; ++i) { if (registersignalhandler_flag) { break; } qcc::Sleep(10); } EXPECT_TRUE(registersignalhandler_flag); status = alljoyn_busattachment_stop(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(bus); alljoyn_busattachment_destroy(bus); alljoyn_busobject_destroy(testObj); } TEST(SignalsTest, registersignalhandler_multiple_signals) { QStatus status = ER_OK; registersignalhandler_flag = false; snprintf(sourcePath1, 256, "/org/alljoyn/test/signal"); snprintf(sourcePath2, 256, "/org/alljoyn/test/signal"); alljoyn_busattachment bus = NULL; bus = alljoyn_busattachment_create("SignalsTest", QCC_TRUE); status = alljoyn_busattachment_start(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(bus, ajn::getConnectArg().c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription testIntf = NULL; status = alljoyn_busattachment_createinterface(bus, "org.alljoyn.test.signalstest", &testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(testIntf != NULL); if (status == ER_OK) { //alljoyn_interfacedescription_addmember(testIntf, ALLJOYN_MESSAGE_SIGNAL, "my_signal", "a{ys}", NULL, NULL, 0); status = alljoyn_interfacedescription_addmember(testIntf, ALLJOYN_MESSAGE_SIGNAL, "testSignal", "s", NULL, "newName", 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription_activate(testIntf); } /* Set up bus object */ alljoyn_busobject_callbacks busObjCbs = { NULL, NULL, NULL, NULL }; alljoyn_busobject testObj = alljoyn_busobject_create(sourcePath1, QCC_FALSE, &busObjCbs, NULL); status = alljoyn_busobject_addinterface(testObj, testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_registerbusobject(bus, testObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription_member my_signal_member; QCC_BOOL foundMember = alljoyn_interfacedescription_getmember(testIntf, "testSignal", &my_signal_member); EXPECT_EQ(QCC_TRUE, foundMember); status = alljoyn_busattachment_addmatch(bus, "type='signal',interface='org.alljoyn.test.signalstest',member='testSignal'"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_registersignalhandler(bus, ®istersignalHandler_Handler, my_signal_member, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_registersignalhandler(bus, ®istersignalHandler_Handler2, my_signal_member, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg arg = alljoyn_msgarg_array_create(1); size_t numArgs = 1; status = alljoyn_msgarg_array_set(arg, &numArgs, "s", "AllJoyn"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busobject_signal(testObj, NULL, 0, my_signal_member, arg, 1, 0, 0, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg_destroy(arg); //Wait upto 2 seconds for the signal to complete. for (int i = 0; i < 200; ++i) { if (registersignalhandler_flag && registersignalhandler_flag2) { break; } qcc::Sleep(10); } EXPECT_TRUE(registersignalhandler_flag); EXPECT_TRUE(registersignalhandler_flag2); status = alljoyn_busattachment_stop(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(bus); alljoyn_busattachment_destroy(bus); alljoyn_busobject_destroy(testObj); } TEST(SignalsTest, unregistersignalhandler) { QStatus status = ER_OK; registersignalhandler_flag = false; registersignalhandler_flag2 = false; snprintf(sourcePath1, 256, "/org/alljoyn/test/signal"); snprintf(sourcePath2, 256, "/org/alljoyn/test/signal"); alljoyn_busattachment bus = NULL; bus = alljoyn_busattachment_create("SignalsTest", QCC_TRUE); status = alljoyn_busattachment_start(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(bus, ajn::getConnectArg().c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription testIntf = NULL; status = alljoyn_busattachment_createinterface(bus, "org.alljoyn.test.signalstest", &testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(testIntf != NULL); if (status == ER_OK) { //alljoyn_interfacedescription_addmember(testIntf, ALLJOYN_MESSAGE_SIGNAL, "my_signal", "a{ys}", NULL, NULL, 0); status = alljoyn_interfacedescription_addmember(testIntf, ALLJOYN_MESSAGE_SIGNAL, "testSignal", "s", NULL, "newName", 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription_activate(testIntf); } /* Set up bus object */ alljoyn_busobject_callbacks busObjCbs = { NULL, NULL, NULL, NULL }; alljoyn_busobject testObj = alljoyn_busobject_create(sourcePath1, QCC_FALSE, &busObjCbs, NULL); status = alljoyn_busobject_addinterface(testObj, testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_registerbusobject(bus, testObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription_member my_signal_member; QCC_BOOL foundMember = alljoyn_interfacedescription_getmember(testIntf, "testSignal", &my_signal_member); ASSERT_EQ(QCC_TRUE, foundMember); status = alljoyn_busattachment_addmatch(bus, "type='signal',interface='org.alljoyn.test.signalstest',member='testSignal'"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_registersignalhandler(bus, ®istersignalHandler_Handler, my_signal_member, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_registersignalhandler(bus, ®istersignalHandler_Handler2, my_signal_member, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg arg = alljoyn_msgarg_array_create(1); size_t numArgs = 1; status = alljoyn_msgarg_array_set(arg, &numArgs, "s", "AllJoyn"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busobject_signal(testObj, NULL, 0, my_signal_member, arg, 1, 0, 0, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); //Wait upto 2 seconds for the signal to complete. for (int i = 0; i < 200; ++i) { if (registersignalhandler_flag && registersignalhandler_flag2) { break; } qcc::Sleep(10); } EXPECT_TRUE(registersignalhandler_flag); EXPECT_TRUE(registersignalhandler_flag2); registersignalhandler_flag = false; registersignalhandler_flag2 = false; status = alljoyn_busattachment_unregistersignalhandler(bus, ®istersignalHandler_Handler2, my_signal_member, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busobject_signal(testObj, NULL, 0, my_signal_member, arg, 1, 0, 0, NULL); //Wait upto 2 seconds for the signal to complete. for (int i = 0; i < 200; ++i) { if (registersignalhandler_flag) { break; } qcc::Sleep(10); } alljoyn_msgarg_destroy(arg); //wait a little longer to make sure the signal still did not come through qcc::Sleep(50); EXPECT_TRUE(registersignalhandler_flag); EXPECT_FALSE(registersignalhandler_flag2); status = alljoyn_busattachment_stop(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(bus); alljoyn_busattachment_destroy(bus); alljoyn_busobject_destroy(testObj); } TEST(SignalsTest, register_unregister_signalhandler_with_sourcePath) { QStatus status = ER_OK; registersignalhandler_flag = false; registersignalhandler_flag2 = false; snprintf(sourcePath1, 256, "/org/alljoyn/test/signal/A"); snprintf(sourcePath2, 256, "/org/alljoyn/test/signal/B"); alljoyn_busattachment bus = NULL; bus = alljoyn_busattachment_create("SignalsTest", QCC_TRUE); status = alljoyn_busattachment_start(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(bus, ajn::getConnectArg().c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription testIntf = NULL; status = alljoyn_busattachment_createinterface(bus, "org.alljoyn.test.signalstest", &testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(testIntf != NULL); if (status == ER_OK) { //alljoyn_interfacedescription_addmember(testIntf, ALLJOYN_MESSAGE_SIGNAL, "my_signal", "a{ys}", NULL, NULL, 0); status = alljoyn_interfacedescription_addmember(testIntf, ALLJOYN_MESSAGE_SIGNAL, "testSignal", "s", NULL, "newName", 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription_activate(testIntf); } /* Set up bus object */ alljoyn_busobject_callbacks busObjCbs = { NULL, NULL, NULL, NULL }; alljoyn_busobject testObjA = alljoyn_busobject_create(sourcePath1, QCC_FALSE, &busObjCbs, NULL); alljoyn_busobject testObjB = alljoyn_busobject_create(sourcePath2, QCC_FALSE, &busObjCbs, NULL); status = alljoyn_busobject_addinterface(testObjA, testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busobject_addinterface(testObjB, testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_registerbusobject(bus, testObjA); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_registerbusobject(bus, testObjB); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription_member my_signal_member; QCC_BOOL foundMember = alljoyn_interfacedescription_getmember(testIntf, "testSignal", &my_signal_member); ASSERT_EQ(QCC_TRUE, foundMember); status = alljoyn_busattachment_addmatch(bus, "type='signal',interface='org.alljoyn.test.signalstest',member='testSignal'"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); //register signal handler with corresponding sourcePath status = alljoyn_busattachment_registersignalhandler(bus, ®istersignalHandler_Handler, my_signal_member, sourcePath1); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_registersignalhandler(bus, ®istersignalHandler_Handler2, my_signal_member, sourcePath2); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg arg = alljoyn_msgarg_array_create(1); size_t numArgs = 1; status = alljoyn_msgarg_array_set(arg, &numArgs, "s", "AllJoyn"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); //send Two signals one for each path status = alljoyn_busobject_signal(testObjA, NULL, 0, my_signal_member, arg, 1, 0, 0, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busobject_signal(testObjB, NULL, 0, my_signal_member, arg, 1, 0, 0, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); //Wait upto 2 seconds for the signal to complete. for (int i = 0; i < 200; ++i) { if (registersignalhandler_flag && registersignalhandler_flag2) { break; } qcc::Sleep(10); } EXPECT_TRUE(registersignalhandler_flag); EXPECT_TRUE(registersignalhandler_flag2); //Test sending only the signal with the first sourcePath registersignalhandler_flag = false; registersignalhandler_flag2 = false; //send only one signal for sourcePath1 status = alljoyn_busobject_signal(testObjA, NULL, 0, my_signal_member, arg, 1, 0, 0, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); //Wait upto 2 seconds for the signal to complete. for (int i = 0; i < 200; ++i) { if (registersignalhandler_flag) { break; } qcc::Sleep(10); } //wait a little longer to make sure the signal still did not come through qcc::Sleep(50); EXPECT_TRUE(registersignalhandler_flag); EXPECT_FALSE(registersignalhandler_flag2); //test sending only the signal with the second sourcePath registersignalhandler_flag = false; registersignalhandler_flag2 = false; //send only one signal for sourcePath2 status = alljoyn_busobject_signal(testObjB, NULL, 0, my_signal_member, arg, 1, 0, 0, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); //Wait upto 2 seconds for the signal to complete. for (int i = 0; i < 200; ++i) { if (registersignalhandler_flag2) { break; } qcc::Sleep(10); } //wait a little longer to make sure the signal still did not come through qcc::Sleep(50); EXPECT_FALSE(registersignalhandler_flag); EXPECT_TRUE(registersignalhandler_flag2); //unregister signal using sourcePath registersignalhandler_flag = false; registersignalhandler_flag2 = false; //unregistersignalhandler using wronge sourcePath status = alljoyn_busattachment_unregistersignalhandler(bus, ®istersignalHandler_Handler2, my_signal_member, sourcePath1); EXPECT_EQ(ER_FAIL, status) << " Actual Status: " << QCC_StatusText(status); //unregistersignalhandler using right sourcePath status = alljoyn_busattachment_unregistersignalhandler(bus, ®istersignalHandler_Handler2, my_signal_member, sourcePath2); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busobject_signal(testObjA, NULL, 0, my_signal_member, arg, 1, 0, 0, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busobject_signal(testObjB, NULL, 0, my_signal_member, arg, 1, 0, 0, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg_destroy(arg); //Wait upto 2 seconds for the signal to complete. for (int i = 0; i < 200; ++i) { if (registersignalhandler_flag) { break; } qcc::Sleep(10); } //wait a little longer to make sure the signal still did not come through qcc::Sleep(50); EXPECT_TRUE(registersignalhandler_flag); EXPECT_FALSE(registersignalhandler_flag2); //unregistersignalhandler that has already been unregistered using sourcePath status = alljoyn_busattachment_unregistersignalhandler(bus, ®istersignalHandler_Handler2, my_signal_member, sourcePath2); EXPECT_EQ(ER_FAIL, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_stop(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(bus); alljoyn_busattachment_destroy(bus); alljoyn_busobject_destroy(testObjA); alljoyn_busobject_destroy(testObjB); } TEST(SignalsTest, register_unregister_signalhandler_with_rule) { QStatus status = ER_OK; registersignalhandler_flag = false; registersignalhandler_flag2 = false; snprintf(sourcePath1, 256, "/org/alljoyn/test/signal/A"); snprintf(sourcePath2, 256, "/org/alljoyn/test/signal/B"); snprintf(sourcePath3, 256, "/org/alljoyn/test/signal/C"); char rule1[256], rule2[265], rule3[256], altrule3[256]; snprintf(rule1, sizeof(rule1), "type='signal',member='testSignal',interface='org.alljoyn.test.signalstest',path='%s'", sourcePath1); snprintf(rule2, sizeof(rule2), "type='signal',member='testSignal',interface='org.alljoyn.test.signalstest',path='%s'", sourcePath2); snprintf(rule3, sizeof(rule3), "type='signal',member='testSignal',interface='org.alljoyn.test.signalstest',path='%s'", sourcePath3); snprintf(altrule3, sizeof(altrule3), "member='testSignal',interface='org.alljoyn.test.signalstest',type='signal',path='%s'", sourcePath3); alljoyn_busattachment bus = NULL; bus = alljoyn_busattachment_create("SignalsTest", QCC_TRUE); status = alljoyn_busattachment_start(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(bus, ajn::getConnectArg().c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription testIntf = NULL; status = alljoyn_busattachment_createinterface(bus, "org.alljoyn.test.signalstest", &testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(testIntf != NULL); if (status == ER_OK) { //alljoyn_interfacedescription_addmember(testIntf, ALLJOYN_MESSAGE_SIGNAL, "my_signal", "a{ys}", NULL, NULL, 0); status = alljoyn_interfacedescription_addmember(testIntf, ALLJOYN_MESSAGE_SIGNAL, "testSignal", "s", NULL, "newName", 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription_activate(testIntf); } /* Set up bus object */ alljoyn_busobject_callbacks busObjCbs = { NULL, NULL, NULL, NULL }; alljoyn_busobject testObjA = alljoyn_busobject_create(sourcePath1, QCC_FALSE, &busObjCbs, NULL); alljoyn_busobject testObjB = alljoyn_busobject_create(sourcePath2, QCC_FALSE, &busObjCbs, NULL); status = alljoyn_busobject_addinterface(testObjA, testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busobject_addinterface(testObjB, testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_registerbusobject(bus, testObjA); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_registerbusobject(bus, testObjB); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription_member my_signal_member; QCC_BOOL foundMember = alljoyn_interfacedescription_getmember(testIntf, "testSignal", &my_signal_member); ASSERT_EQ(QCC_TRUE, foundMember); status = alljoyn_busattachment_addmatch(bus, "type='signal',interface='org.alljoyn.test.signalstest',member='testSignal'"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); //register signal handler with corresponding rule status = alljoyn_busattachment_registersignalhandlerwithrule(bus, ®istersignalHandler_Handler, my_signal_member, rule1); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_registersignalhandlerwithrule(bus, ®istersignalHandler_Handler2, my_signal_member, rule2); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_registersignalhandlerwithrule(bus, ®istersignalHandler_Handler3, my_signal_member, rule3); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg arg = alljoyn_msgarg_array_create(1); size_t numArgs = 1; status = alljoyn_msgarg_array_set(arg, &numArgs, "s", "AllJoyn"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); //send two signals: for signal handlers 1 and 2, but not for 3 status = alljoyn_busobject_signal(testObjA, NULL, 0, my_signal_member, arg, 1, 0, 0, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busobject_signal(testObjB, NULL, 0, my_signal_member, arg, 1, 0, 0, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); //Wait upto 2 seconds for the signal to complete. for (int i = 0; i < 200; ++i) { if (registersignalhandler_flag && registersignalhandler_flag2) { break; } qcc::Sleep(10); } EXPECT_TRUE(registersignalhandler_flag); EXPECT_TRUE(registersignalhandler_flag2); EXPECT_FALSE(registersignalhandler_flag3); //Test sending only the signal with the first sourcePath registersignalhandler_flag = false; registersignalhandler_flag2 = false; registersignalhandler_flag3 = false; //send only one signal for sourcePath1 status = alljoyn_busobject_signal(testObjA, NULL, 0, my_signal_member, arg, 1, 0, 0, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); //Wait upto 2 seconds for the signal to complete. for (int i = 0; i < 200; ++i) { if (registersignalhandler_flag) { break; } qcc::Sleep(10); } //wait a little longer to make sure the signal still did not come through qcc::Sleep(50); EXPECT_TRUE(registersignalhandler_flag); EXPECT_FALSE(registersignalhandler_flag2); EXPECT_FALSE(registersignalhandler_flag3); //test sending only the signal with the second sourcePath registersignalhandler_flag = false; registersignalhandler_flag2 = false; registersignalhandler_flag3 = false; //send only one signal for sourcePath2 status = alljoyn_busobject_signal(testObjB, NULL, 0, my_signal_member, arg, 1, 0, 0, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); //Wait upto 2 seconds for the signal to complete. for (int i = 0; i < 200; ++i) { if (registersignalhandler_flag2) { break; } qcc::Sleep(10); } //wait a little longer to make sure the signal still did not come through qcc::Sleep(50); EXPECT_FALSE(registersignalhandler_flag); EXPECT_TRUE(registersignalhandler_flag2); EXPECT_FALSE(registersignalhandler_flag3); //unregister signal using sourcePath registersignalhandler_flag = false; registersignalhandler_flag2 = false; registersignalhandler_flag3 = false; //unregistersignalhandler using wrong rule status = alljoyn_busattachment_unregistersignalhandlerwithrule(bus, ®istersignalHandler_Handler2, my_signal_member, rule1); EXPECT_EQ(ER_FAIL, status) << " Actual Status: " << QCC_StatusText(status); //unregistersignalhandler using right rule status = alljoyn_busattachment_unregistersignalhandlerwithrule(bus, ®istersignalHandler_Handler2, my_signal_member, rule2); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); //unregistersignalhandler using right rule with alternate formulation status = alljoyn_busattachment_unregistersignalhandlerwithrule(bus, ®istersignalHandler_Handler3, my_signal_member, altrule3); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busobject_signal(testObjA, NULL, 0, my_signal_member, arg, 1, 0, 0, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busobject_signal(testObjB, NULL, 0, my_signal_member, arg, 1, 0, 0, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg_destroy(arg); //Wait upto 2 seconds for the signal to complete. for (int i = 0; i < 200; ++i) { if (registersignalhandler_flag) { break; } qcc::Sleep(10); } //wait a little longer to make sure the signal still did not come through qcc::Sleep(50); EXPECT_TRUE(registersignalhandler_flag); EXPECT_FALSE(registersignalhandler_flag2); //unregistersignalhandler that has already been unregistered using sourcePath status = alljoyn_busattachment_unregistersignalhandlerwithrule(bus, ®istersignalHandler_Handler2, my_signal_member, rule2); EXPECT_EQ(ER_FAIL, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_stop(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(bus); alljoyn_busattachment_destroy(bus); alljoyn_busobject_destroy(testObjA); alljoyn_busobject_destroy(testObjB); } TEST(SignalsTest, unregisterallhandlers) { QStatus status = ER_OK; registersignalhandler_flag = false; registersignalhandler_flag2 = false; snprintf(sourcePath1, 256, "/org/alljoyn/test/signal"); snprintf(sourcePath2, 256, "/org/alljoyn/test/signal"); alljoyn_busattachment bus = NULL; bus = alljoyn_busattachment_create("SignalsTest", QCC_TRUE); status = alljoyn_busattachment_start(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(bus, ajn::getConnectArg().c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription testIntf = NULL; status = alljoyn_busattachment_createinterface(bus, "org.alljoyn.test.signalstest", &testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(testIntf != NULL); if (status == ER_OK) { //alljoyn_interfacedescription_addmember(testIntf, ALLJOYN_MESSAGE_SIGNAL, "my_signal", "a{ys}", NULL, NULL, 0); status = alljoyn_interfacedescription_addmember(testIntf, ALLJOYN_MESSAGE_SIGNAL, "testSignal", "s", NULL, "newName", 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription_activate(testIntf); } /* Set up bus object */ alljoyn_busobject_callbacks busObjCbs = { NULL, NULL, NULL, NULL }; alljoyn_busobject testObj = alljoyn_busobject_create(sourcePath1, QCC_FALSE, &busObjCbs, NULL); status = alljoyn_busobject_addinterface(testObj, testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_registerbusobject(bus, testObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription_member my_signal_member; QCC_BOOL foundMember = alljoyn_interfacedescription_getmember(testIntf, "testSignal", &my_signal_member); ASSERT_EQ(QCC_TRUE, foundMember); status = alljoyn_busattachment_addmatch(bus, "type='signal',interface='org.alljoyn.test.signalstest',member='testSignal'"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_registersignalhandler(bus, ®istersignalHandler_Handler, my_signal_member, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_registersignalhandler(bus, ®istersignalHandler_Handler2, my_signal_member, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg arg = alljoyn_msgarg_array_create(1); size_t numArgs = 1; status = alljoyn_msgarg_array_set(arg, &numArgs, "s", "AllJoyn"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busobject_signal(testObj, NULL, 0, my_signal_member, arg, 1, 0, 0, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); //Wait upto 2 seconds for the signal to complete. for (int i = 0; i < 200; ++i) { if (registersignalhandler_flag && registersignalhandler_flag2) { break; } qcc::Sleep(10); } EXPECT_TRUE(registersignalhandler_flag); EXPECT_TRUE(registersignalhandler_flag2); registersignalhandler_flag = false; registersignalhandler_flag2 = false; status = alljoyn_busattachment_unregisterallhandlers(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busobject_signal(testObj, NULL, 0, my_signal_member, arg, 1, 0, 0, NULL); alljoyn_msgarg_destroy(arg); //wait a little while to make sure the signal still did not come through qcc::Sleep(100); EXPECT_FALSE(registersignalhandler_flag); EXPECT_FALSE(registersignalhandler_flag2); status = alljoyn_busattachment_stop(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(bus); alljoyn_busattachment_destroy(bus); alljoyn_busobject_destroy(testObj); } TEST(SignalsTest, register_unregister_sessionlesssignals) { QStatus status = ER_OK; registersignalhandler_flag = false; registersignalhandler_flag2 = false; snprintf(sourcePath1, 256, "/org/alljoyn/test/signal"); alljoyn_busattachment bus = NULL; bus = alljoyn_busattachment_create("SignalsTest", QCC_TRUE); status = alljoyn_busattachment_start(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(bus, ajn::getConnectArg().c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription testIntf = NULL; status = alljoyn_busattachment_createinterface(bus, "org.alljoyn.test.signalstest", &testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(testIntf != NULL); if (status == ER_OK) { status = alljoyn_interfacedescription_addmember(testIntf, ALLJOYN_MESSAGE_SIGNAL, "testSignal", "s", NULL, "newName", 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription_activate(testIntf); } /* Set up bus object */ alljoyn_busobject_callbacks busObjCbs = { NULL, NULL, NULL, NULL }; alljoyn_busobject testObj = alljoyn_busobject_create(sourcePath1, QCC_FALSE, &busObjCbs, NULL); status = alljoyn_busobject_addinterface(testObj, testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_registerbusobject(bus, testObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription_member my_signal_member; QCC_BOOL foundMember = alljoyn_interfacedescription_getmember(testIntf, "testSignal", &my_signal_member); ASSERT_EQ(QCC_TRUE, foundMember); status = alljoyn_busattachment_addmatch(bus, "type='signal',sessionless='t',interface='org.alljoyn.test.signalstest',member='testSignal'"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_message msg = alljoyn_message_create(bus); alljoyn_msgarg arg = alljoyn_msgarg_array_create(1); size_t numArgs = 1; status = alljoyn_msgarg_array_set(arg, &numArgs, "s", "AllJoyn"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busobject_signal(testObj, NULL, 0, my_signal_member, arg, 1, 0, ALLJOYN_MESSAGE_FLAG_SESSIONLESS, msg); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* * Short sleep to allow the router to process the sessionless signal */ qcc::Sleep(50); status = alljoyn_busobject_cancelsessionlessmessage_serial(testObj, alljoyn_message_getcallserial(msg)); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busobject_signal(testObj, NULL, 0, my_signal_member, arg, 1, 0, ALLJOYN_MESSAGE_FLAG_SESSIONLESS, msg); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* * Short sleep to allow the router to process the sessionless signal */ qcc::Sleep(50); status = alljoyn_busobject_cancelsessionlessmessage(testObj, msg); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* * short pause to allow the background cancelsessionless call to complete. * This is not required it just keeps the daemon from printing errors because * its trying to do things the same time it is being shut down. */ qcc::Sleep(10); alljoyn_msgarg_destroy(arg); alljoyn_message_destroy(msg); status = alljoyn_busattachment_stop(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_join(bus); alljoyn_busattachment_destroy(bus); alljoyn_busobject_destroy(testObj); } class Participant { public: Participant(alljoyn_messagereceiver_signalhandler_ptr handler) { SetUp(handler); } ~Participant() { TearDown(); } void SetUp(alljoyn_messagereceiver_signalhandler_ptr handler) { bus = alljoyn_busattachment_create("SessionTest", false); busname = ajn::genUniqueName(bus); status = alljoyn_busattachment_start(bus); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_connect(bus, ajn::getConnectArg().c_str()); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription testIntf = NULL; status = alljoyn_busattachment_createinterface(bus, "org.alljoyn.test.signalstest", &testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); ASSERT_TRUE(testIntf != NULL); if (status == ER_OK) { //alljoyn_interfacedescription_addmember(testIntf, ALLJOYN_MESSAGE_SIGNAL, "my_signal", "a{ys}", NULL, NULL, 0); status = alljoyn_interfacedescription_addmember(testIntf, ALLJOYN_MESSAGE_SIGNAL, "testSignal", "s", NULL, "newName", 0); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_interfacedescription_activate(testIntf); } /* Set up bus object */ alljoyn_busobject_callbacks busObjCbs = { NULL, NULL, NULL, NULL }; testObj = alljoyn_busobject_create("/org/alljoyn/test/signal", QCC_FALSE, &busObjCbs, NULL); status = alljoyn_busobject_addinterface(testObj, testIntf); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_registerbusobject(bus, testObj); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); QCC_BOOL foundMember = alljoyn_interfacedescription_getmember(testIntf, "testSignal", &my_signal_member); EXPECT_EQ(QCC_TRUE, foundMember); status = alljoyn_busattachment_registersignalhandler(bus, handler, my_signal_member, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* request name */ uint32_t flags = DBUS_NAME_FLAG_REPLACE_EXISTING | DBUS_NAME_FLAG_DO_NOT_QUEUE; status = alljoyn_busattachment_requestname(bus, busname.c_str(), flags); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* Create session port listener */ alljoyn_sessionportlistener_callbacks spl_cbs = { &accept_session_joiner, /* accept session joiner CB */ &session_joined /* session joined CB */ }; sessionPortListener = alljoyn_sessionportlistener_create(&spl_cbs, NULL); /* Bind SessionPort */ alljoyn_sessionopts opts = alljoyn_sessionopts_create(ALLJOYN_TRAFFIC_TYPE_MESSAGES, QCC_FALSE, ALLJOYN_PROXIMITY_ANY, ALLJOYN_TRANSPORT_ANY); alljoyn_sessionport sp = SESSION_PORT; status = alljoyn_busattachment_bindsessionport(bus, &sp, opts, sessionPortListener); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); /* Advertise Name */ status = alljoyn_busattachment_advertisename(bus, busname.c_str(), alljoyn_sessionopts_get_transports(opts)); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_sessionopts_destroy(opts); } void TearDown() { alljoyn_busattachment_stop(bus); alljoyn_busattachment_join(bus); EXPECT_NO_FATAL_FAILURE(alljoyn_busattachment_destroy(bus)); alljoyn_sessionportlistener_destroy(sessionPortListener); alljoyn_busobject_destroy(testObj); } void Emit() { alljoyn_msgarg arg = alljoyn_msgarg_array_create(1); size_t numArgs = 1; status = alljoyn_msgarg_array_set(arg, &numArgs, "s", "AllJoyn"); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busobject_signal(testObj, NULL, ALLJOYN_SESSION_ID_ALL_HOSTED, my_signal_member, arg, 1, 0, 0, NULL); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_msgarg_destroy(arg); } QStatus status; alljoyn_busattachment bus; alljoyn_busobject testObj; alljoyn_buslistener buslistener; alljoyn_sessionportlistener sessionPortListener; alljoyn_interfacedescription_member my_signal_member; qcc::String busname; }; TEST(SignalsTest, registersignalhandler_sessioncast) { QStatus status = ER_OK; registersignalhandler_flag = registersignalhandler_flag2 = registersignalhandler_flag3 = false; Participant one(®istersignalHandler_Handler); Participant two(®istersignalHandler_Handler2); Participant three(®istersignalHandler_Handler3); snprintf(sourcePath1, 256, "/org/alljoyn/test/signal"); snprintf(sourcePath2, 256, "/org/alljoyn/test/signal"); snprintf(sourcePath3, 256, "/org/alljoyn/test/signal"); /* no sessions set up yet */ one.Emit(); two.Emit(); three.Emit(); //Wait upto 2 seconds for the signal to complete. for (int i = 0; i < 200; ++i) { if (registersignalhandler_flag || registersignalhandler_flag2 || registersignalhandler_flag3) { break; } qcc::Sleep(10); } EXPECT_FALSE(registersignalhandler_flag); EXPECT_FALSE(registersignalhandler_flag2); EXPECT_FALSE(registersignalhandler_flag3); registersignalhandler_flag = registersignalhandler_flag2 = registersignalhandler_flag3 = false; /* set up some sessions */ alljoyn_sessionopts opts = alljoyn_sessionopts_create(ALLJOYN_TRAFFIC_TYPE_MESSAGES, QCC_FALSE, ALLJOYN_PROXIMITY_ANY, ALLJOYN_TRANSPORT_ANY); alljoyn_sessionid sid; status = alljoyn_busattachment_joinsession(two.bus, one.busname.c_str(), SESSION_PORT, NULL, &sid, opts); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); status = alljoyn_busattachment_joinsession(three.bus, one.busname.c_str(), SESSION_PORT, NULL, &sid, opts); EXPECT_EQ(ER_OK, status) << " Actual Status: " << QCC_StatusText(status); alljoyn_sessionopts_destroy(opts); /* give the host bus attachment some time to catch up on all this */ qcc::Sleep(500); /* now we should see some signals */ one.Emit(); //Wait upto 2 seconds for the signal to complete. for (int i = 0; i < 200; ++i) { if (registersignalhandler_flag || (registersignalhandler_flag2 && registersignalhandler_flag3)) { break; } qcc::Sleep(10); } EXPECT_FALSE(registersignalhandler_flag); EXPECT_TRUE(registersignalhandler_flag2); EXPECT_TRUE(registersignalhandler_flag3); registersignalhandler_flag = registersignalhandler_flag2 = registersignalhandler_flag3 = false; /* we expect nothing if we emit from the joiners... */ two.Emit(); three.Emit(); //Wait upto 2 seconds for the signal to complete. for (int i = 0; i < 200; ++i) { if (registersignalhandler_flag || registersignalhandler_flag2 || registersignalhandler_flag3) { break; } qcc::Sleep(10); } EXPECT_FALSE(registersignalhandler_flag); EXPECT_FALSE(registersignalhandler_flag2); EXPECT_FALSE(registersignalhandler_flag3); registersignalhandler_flag = registersignalhandler_flag2 = registersignalhandler_flag3 = false; } alljoyn-15.04b/alljoyn_c/unit_test/ajTestCommon.cc000066400000000000000000000035271255700255500222540ustar00rootroot00000000000000/****************************************************************************** * * * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include "ajTestCommon.h" #include #include qcc::String ajn::getConnectArg() { qcc::Environ* env = qcc::Environ::GetAppEnviron(); #if defined(QCC_OS_GROUP_WINDOWS) /* * The test default is to prefer Named Pipe and fall back to bundled router (if Named Pipe is not supported by the OS). * Note that test execution can still override the preferred transport by setting BUS_ADDRESS. * For example, you can issue a "set BUS_ADDRESS=tcp:addr=127.0.0.1,port=9955" before running the test. */ return env->Find("BUS_ADDRESS", "npipe:"); #else return env->Find("BUS_ADDRESS", "unix:abstract=alljoyn"); #endif } qcc::String ajn::genUniqueName(alljoyn_busattachment bus) { static uint32_t uniquifier = 0; return qcc::String("test.x") + alljoyn_busattachment_getglobalguidstring(bus) + ".x" + qcc::U32ToString(uniquifier++); } alljoyn-15.04b/alljoyn_c/unit_test/ajTestCommon.h000066400000000000000000000033621255700255500221130ustar00rootroot00000000000000/****************************************************************************** * * * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef AJTESTCOMMON_H #define AJTESTCOMMON_H #include #include /* * this header file contains a functions that can be used to replace common * actions in the test code. */ namespace ajn { /** * Obtain the default connection arg for the OS the test is run on. * * The environment variable BUS_ADDRESS is specified it will be used in place * of the default address * * @return a qcc::String containing the default connection arg */ qcc::String getConnectArg(); /** * Generate a globally unique name for use in advertising. * * Advertised names should be unique to avoid multiple running instances * of the test suite from interferring with each other. */ qcc::String genUniqueName(alljoyn_busattachment bus); } #endif //AJTESTCOMMON_H alljoyn-15.04b/alljoyn_c/unit_test/ajcTest.cc000066400000000000000000000032421255700255500212400ustar00rootroot00000000000000/****************************************************************************** * * * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include /** Main entry point */ int CDECL_CALL main(int argc, char**argv, char**) { int status = 0; if (alljoyn_init() != ER_OK) { return 1; } #ifdef ROUTER if (alljoyn_routerinit() != ER_OK) { alljoyn_shutdown(); return 1; } #endif setvbuf(stdout, NULL, _IONBF, 0); setvbuf(stderr, NULL, _IONBF, 0); printf("\n Running alljoyn_c unit test\n"); testing::InitGoogleTest(&argc, argv); status = RUN_ALL_TESTS(); printf("%s exiting with status %d \n", argv[0], status); #ifdef ROUTER alljoyn_routershutdown(); #endif alljoyn_shutdown(); return (int) status; } alljoyn-15.04b/alljoyn_c/unit_test/test_report/000077500000000000000000000000001255700255500217055ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_c/unit_test/test_report/.gitignore000066400000000000000000000000461255700255500236750ustar00rootroot00000000000000*.xml *.log /alljoynTestDir/ /report/ alljoyn-15.04b/alljoyn_c/unit_test/test_report/ajctest-buildbot-android.conf000066400000000000000000000016201255700255500274300ustar00rootroot00000000000000# # This is buildbot's test_harness configuration for ajctest when it runs on Android # [Environment] # variable=value ER_DEBUG_ALL=0 # GTest supports the following options, shown with their default value # GTEST_OUTPUT= # None # GTEST_ALSO_RUN_DISABLED_TESTS=0 # No # GTEST_REPEAT=0 # No # GTEST_SHUFFLE=0 # No # GTEST_RANDOM_SEED=0 # default pseudo-random seed # GTEST_BREAK_ON_FAILURE=0 # no break on failures # GTEST_CATCH_EXCEPTIONS=1 # gtest catches exceptions itself GTEST_OUTPUT=xml:/data/alljoyn/ajctest.xml HOME=/data/alljoyn [GTestFile] # ajtest or cmtest, or ... ajctest [TestCases] # Can select individual tests as well as groups. # That is, TestCase selection can look like Foo.Bar=YES, not just Foo=YES. # You can also used negative selection, like *=YES followed by Foo.Bar=NO. *=Yes alljoyn-15.04b/alljoyn_c/unit_test/test_report/ajctest-buildbot.conf000066400000000000000000000015221255700255500260130ustar00rootroot00000000000000# # This is buildbot's test_harness configuration for ajctest # [Environment] # variable=value ER_DEBUG_ALL=0 # GTest supports the following options, shown with their default value # GTEST_OUTPUT= # None # GTEST_ALSO_RUN_DISABLED_TESTS=0 # No # GTEST_REPEAT=0 # No # GTEST_SHUFFLE=0 # No # GTEST_RANDOM_SEED=0 # default pseudo-random seed # GTEST_BREAK_ON_FAILURE=0 # no break on failures # GTEST_CATCH_EXCEPTIONS=1 # gtest catches exceptions itself GTEST_OUTPUT=xml:ajctest.xml [GTestFile] # ajtest or cmtest, or ... ajctest [TestCases] # Can select individual tests as well as groups. # That is, TestCase selection can look like Foo.Bar=YES, not just Foo=YES. # You can also used negative selection, like *=YES followed by Foo.Bar=NO. *=Yes alljoyn-15.04b/alljoyn_c/unit_test/test_report/runall-android.sh000077500000000000000000000140371255700255500251640ustar00rootroot00000000000000#!/bin/bash # Copyright AllSeen Alliance. All rights reserved. # # Permission to use, copy, modify, and/or distribute this software for any # purpose with or without fee is hereby granted, provided that the above # copyright notice and this permission notice appear in all copies. # # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. # function Usage() { set +ex echo >&2 " Runs GTest executables created by scons in alljoyn_c, on an Android device using adb. Usage: $(basename -- "$0") [ -s -d alljoyn_dist ] [ -t alljoyn_test ] [-c configfile ] -- \"adb device\" [ ajctest ] where -s # start and stop our own AllJoyn-Daemon (default internal transport address, --no-bt) -d alljoyn_dist # path to the build/.../dist tree, used to find cpp/bin/alljoyn-daemon exe, if used # Note: do not include the 'cpp/bin' subdirectory in alljoyn_dist -t alljoyn_test # path to the build/.../test tree, used to find c/bin/ajctest exe # Note: do not include the 'c/bin' subdirectory in alljoyn_test -c configfile # name of config file(s) (an embedded wildcard is replaced by the gtest test name) # default '*.conf' \"adb device\" # string needed by adb to contact the device, like \"-s XXXXXXX\" (use quotes if necessary) ajctest # simple file name(s) of the gtest exe(s) to be run (gtest exe files expected in -t path/c/bin) # default runs ajctest " exit 2 } : read commandline options set -e start_daemon=false alljoyn_dist='' alljoyn_test='' configfile='*.conf' while getopts sSc:d:t: option do case "$option" in ( c ) configfile="$OPTARG" ;; ( d ) alljoyn_dist="$OPTARG" ;; ( t ) alljoyn_test=$OPTARG ;; ( s ) start_daemon=true ;; ( S ) start_daemon=false ;; ( \? ) Usage ;; esac done device='' gtests='' if test "$OPTIND" -gt 0 -a "$OPTIND" -le $# then shift ` expr $OPTIND - 1 ` while test $# -ge 1 do case "$device" in ( '' ) case "$1" in ( *[!\ a-zA-Z0-9_-]* | '' ) echo >&2 "error, $1: allowed characters are [\ a-zA-Z0-9_-]" Usage ;; ( * ) device="$1" ;; esac ;; ( * ) case "$1" in ( *[!a-zA-Z0-9_-]* | '' ) echo >&2 "error, $1: allowed characters are [a-zA-Z0-9_-]" Usage ;; ( * ) gtests="$gtests $1" ;; esac ;; esac shift done fi if test -z "$device" then echo >&2 'error, "adb device" argument is required' ; Usage fi if test -z "$gtests" then gtests="ajctest" fi : check commandline options # alljoyn_dist, alljoyn_test paths if test -z "$alljoyn_dist" -a -z "$alljoyn_test" then echo >&2 "error, -d and/or -t path is required" Usage elif test -z "$alljoyn_dist" then alljoyn_dist="$alljoyn_test/../dist" elif test -z "$alljoyn_test" then alljoyn_test="$alljoyn_dist/../test" fi ckbin() { ckvar=$1 binvar=$2 cpp_or_c=$3 eval ckval="\$$1" binval=` cd "$ckval/$cpp_or_c/bin" > /dev/null && pwd ` || : ok if test -z "$binval" then echo >&2 "error, could not find '$cpp_or_c/bin' subdirectory in $ckvar=$ckval" exit 2 fi eval $binvar="'$binval'" } ckbin alljoyn_dist daemon_bin cpp ckbin alljoyn_test gtest_bin c options='--internal --no-bt --verbosity=5' echo "# runall test plan:" if $start_daemon then ls >/dev/null -ld "$daemon_bin/alljoyn-daemon" || ls >/dev/null -ld "$daemon_bin/alljoyn-daemon.exe" || { echo >&2 "error, alljoyn-daemon exe not found" exit 2 } echo "# $daemon_bin/alljoyn-daemon $options > alljoyn-daemon.log &" fi for i in $gtests do ls >/dev/null -ld "$gtest_bin/$i" || ls >/dev/null -ld "$gtest_bin/$i.exe" || { echo >&2 "error, $i exe not found" exit 2 } c="$( echo "$configfile" | sed -e 's,\*,'$i',g' )" ls >/dev/null -ld "$c" || { echo >&2 "error, configfile $c not found" exit 2 } echo "# python test_harness.py -c $c -t $i -p $gtest_bin > $i.log" done kill-alljoyn() { : kill any alljoyn processes running on device p=$( adb < /dev/null $device shell ps | awk '$NF ~ /alljoyn/ { print $2; exit; }' ) while test -n "$p" do adb < /dev/null $device shell kill -9 $p sleep 5 p=$( adb < /dev/null $device shell ps | awk '$NF ~ /alljoyn/ { print $2; exit; }' ) done } : begin kill-alljoyn || : ok if $start_daemon then : start alljoyn-daemon rm -f alljoyn-daemon.log adb < /dev/null $device shell mkdir /data/alljoyn || : ok adb < /dev/null $device shell rm /data/alljoyn/alljoyn-daemon || : ok adb < /dev/null $device push "$daemon_bin/alljoyn-daemon" /data/alljoyn ( date adb < /dev/null $device shell /data/alljoyn/alljoyn-daemon $options date ) > alljoyn-daemon.log 2>&1 $i.log 2>&1 date tail -10 $i.log | grep "exiting with status 0" || xit=1 case "$xit" in 0 ) echo $i PASSED ;; * ) echo $i FAILED, see $i.log for info ;; esac : get xml file, maybe adb < /dev/null $device pull /data/alljoyn/$i.xml || : ok sleep 5 done kill-alljoyn || : ok echo exit status $xit exit $xit alljoyn-15.04b/alljoyn_c/unit_test/test_report/runall.sh000077500000000000000000000130501255700255500235400ustar00rootroot00000000000000#!/bin/bash # Copyright AllSeen Alliance. All rights reserved. # # Permission to use, copy, modify, and/or distribute this software for any # purpose with or without fee is hereby granted, provided that the above # copyright notice and this permission notice appear in all copies. # # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. # function Usage() { set +ex echo >&2 " Runs GTest executables created by scons in alljoyn_c. Usage: $(basename -- "$0") [ -s -d alljoyn_dist ] [ -t alljoyn_test ] [-c configfile ] [ ajctest ] where -s # start and stop our own AllJoyn-Daemon (default internal transport address, --no-bt) -d alljoyn_dist # path to the build/.../dist tree, used to find cpp/bin/alljoyn-daemon exe, if used # Note: do not include the 'cpp/bin' subdirectory in alljoyn_dist -t alljoyn_test # path to the build/.../test tree, used to find c/bin/ajctest exe # Note: do not include the 'c/bin' subdirectory in alljoyn_test -c configfile # name of config file(s) (an embedded wildcard is replaced by the gtest test name) # default '*.conf' ajctest # simple file name(s) of the gtest exe(s) to be run (found in -t path/c/bin) # default runs ajctest " exit 2 } : read commandline options set -e start_daemon=false alljoyn_dist='' alljoyn_test='' configfile='*.conf' while getopts sSc:d:t: option do case "$option" in ( c ) configfile="$OPTARG" ;; ( d ) alljoyn_dist="$OPTARG" ;; ( t ) alljoyn_test=$OPTARG ;; ( s ) start_daemon=true ;; ( S ) start_daemon=false ;; ( \? ) Usage ;; esac done gtests='' if test "$OPTIND" -gt 0 -a "$OPTIND" -le $# then shift ` expr $OPTIND - 1 ` while test $# -ge 1 do case "$1" in ( *[!a-zA-Z0-9_-]* | '' ) echo >&2 "error, $1: allowed characters are [a-zA-Z0-9_-]" ; Usage ;; ( * ) gtests="$gtests $1" ;; esac shift done fi if test -z "$gtests" then gtests="ajctest" fi : check commandline options # alljoyn_dist, alljoyn_test paths if test -z "$alljoyn_dist" -a -z "$alljoyn_test" then echo >&2 "error, -d and/or -t path is required" Usage elif test -z "$alljoyn_dist" then alljoyn_dist="$alljoyn_test/../dist" elif test -z "$alljoyn_test" then alljoyn_test="$alljoyn_dist/../test" fi ckbin() { ckvar=$1 binvar=$2 cpp_or_c=$3 eval ckval="\$$1" binval=` cd "$ckval/$cpp_or_c/bin" > /dev/null && pwd ` || : ok if test -z "$binval" then echo >&2 "error, could not find '$cpp_or_c/bin' subdirectory in $ckvar=$ckval" exit 2 fi eval $binvar="'$binval'" } ckbin alljoyn_dist daemon_bin cpp ckbin alljoyn_test gtest_bin c if cygpath -wa . > /dev/null 2>&1 then # found Cygwin, which means Windows if $start_daemon; then echo >&2 "error, start_daemon=true but this is Windows and daemon is not supported" exit 2 fi # gtest_bin needs to be Windows-style because we use pure Windows Python, not Cygwin Python gtest_bin_p="$( cygpath -wa "$gtest_bin" )" # sometimes Windows "home" does not work for keystore tests export USERPROFILE="$( cygpath -wa . )" export LOCALAPPDATA="$USERPROFILE" elif pwd -W > /dev/null 2>&1 then # found MSysGit, which also means Windows if $start_daemon; then echo >&2 "error, start_daemon=true but this is Windows and daemon is not supported" exit 2 fi # MSysGit will handle the *nix path gtest_bin_p=$gtest_bin # sometimes Windows "home" does not work for keystore tests export USERPROFILE="$( pwd -W )" export LOCALAPPDATA="$USERPROFILE" else options='--internal --no-bt --verbosity=5' gtest_bin_p="$gtest_bin" # MBUS-1589: remove .alljoyn_keystore, if any export HOME="$PWD" fi # MBUS-1589: remove .alljoyn_keystore, if any rm -rf .alljoyn_keystore echo "# runall test plan:" if $start_daemon then ls >/dev/null -ld "$daemon_bin/alljoyn-daemon" || ls >/dev/null -ld "$daemon_bin/alljoyn-daemon.exe" || { echo >&2 "error, alljoyn-daemon exe not found" exit 2 } echo "# $daemon_bin/alljoyn-daemon $options > alljoyn-daemon.log &" fi for i in $gtests do ls >/dev/null -ld "$gtest_bin/$i" || ls >/dev/null -ld "$gtest_bin/$i.exe" || { echo >&2 "error, $i exe not found" exit 2 } c="$( echo "$configfile" | sed -e 's,\*,'$i',g' )" ls >/dev/null -ld "$c" || { echo >&2 "error, configfile $c not found" exit 2 } echo "# python test_harness.py -c $c -t $i -p $gtest_bin_p > $i.log" done : begin export ER_DEBUG_ALL=0 if $start_daemon then : start alljoyn-daemon rm -f alljoyn-daemon.log killall -9 -v alljoyn-daemon || : ok ( set -ex cd "$daemon_bin" pwd date ./alljoyn-daemon $options; xit=$? date set +x echo exit status $xit ) > alljoyn-daemon.log 2>&1 "$i.log" 2>&1 < /dev/null || : exit status is $? / IGNORE IT date set +x tail -10 "$i.log" | grep "exiting with status 0" || xit=1 case "$xit" in 0 ) echo $i PASSED ;; * ) echo $i FAILED, see $i.log for info ;; esac sleep 5 done if $start_daemon then sleep 5 killall -9 -v alljoyn-daemon || : ok sleep 5 fi echo exit status $xit exit $xit alljoyn-15.04b/alljoyn_c/unit_test/test_report/sample.conf000066400000000000000000000014551255700255500240420ustar00rootroot00000000000000# # This is an example test_harness configuration for ajtest # [TestCases] # Can select individual tests as well as groups. # That is, TestCase selection can look like Foo.Bar=YES, not just Foo=YES. # You can also used negative selection, like *=YES followed by Foo.Bar=NO. *=Yes [Environment] # variable=value ER_DEBUG_ALL=0 # GTest supports the following options, shown with their default value # GTEST_OUTPUT= # None # GTEST_ALSO_RUN_DISABLED_TESTS=0 # No # GTEST_REPEAT=0 # No # GTEST_SHUFFLE=0 # No # GTEST_RANDOM_SEED=0 # default pseudo-random seed # GTEST_BREAK_ON_FAILURE=0 # no break on failures # GTEST_CATCH_EXCEPTIONS=1 # gtest catches exceptions itself [GTestFile] # ajtest or cmtest, or ... ajtest alljoyn-15.04b/alljoyn_c/unit_test/test_report/test_harness-android.py000077500000000000000000000161131255700255500264040ustar00rootroot00000000000000 # Copyright AllSeen Alliance. All rights reserved. # # Permission to use, copy, modify, and/or distribute this software for any # purpose with or without fee is hereby granted, provided that the above # copyright notice and this permission notice appear in all copies. # # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. # import getopt import os import re import sys def usage(): print >> sys.stderr, """ Usage: python test_harness-script.py [ -c config_file ] [ -o scriptfile ] [ -t gtestfile ] [ -p path_to_gtestfile ] where: config_file: test_harness config file; default: test_harness.conf scriptfile: script file to write; default: gtest.sh gtestfile: name of gtest executable file; default: ajtest path_to_gtestfile: optional path to directory containing gtestfile (when scriptfile runs) """ def main(argv=None): # get commandline options conffile='test_harness.conf' scriptfile='gtest.sh' gtestfileopt='' testpath='' if argv is None: argv=[] if len(argv) > 0: try: opts, junk = getopt.getopt(argv, 'c:o:p:t:') if junk: print >> sys.stderr, 'error, unrecognized arguments ' + str(junk) usage() return 2 for opt, val in opts: if opt == '-c': conffile = val elif opt == '-o': scriptfile = val elif opt == '-p': testpath = val elif opt == '-t': gtestfileopt = val except getopt.GetoptError, err: print >> sys.stderr, 'error, ' + str(err) usage() return 2 # initialize dict = [] filter = '' negfilter = '' gtestfile = '' part = '' text = '' re_comment = re.compile( r'\s*#.*$' ) re_equals = re.compile( r'\s*=\s*' ) re_lastcolon = re.compile( r':$' ) re_TestCases = re.compile( r'^\[\s*Test\s*Cases\s*\]', re.I ) re_Environment = re.compile( r'^\[\s*Environment\s*\]', re.I ) re_GTestFile = re.compile( r'^\[\s*GTest\s*File\s*\]', re.I ) # read config file one line at a time try: with open( conffile, 'r' ) as fileptr: for line in fileptr: # strip leading and trailing whitespace line = line.strip() line = line.strip('\n') # strip trailing comment (and preceding whitespace), if any line = re_comment.sub( '', line ) # search line for part header if re_TestCases.search( line ): # line ~= [ TestCases ] part = 'TestCases' continue elif re_Environment.search( line ): # line ~= [ Environment ] part = 'Environment' print '[Environment]' continue elif re_GTestFile.search( line ): # line ~= [ GTestFile ] part = 'GTestFile' continue else: # line is none of the above # split line around equals sign (and surrounding whitespace), if any dict = re_equals.split( line, 1 ) if (len(dict) > 1): # line ~= something = something if part == 'TestCases': # Can select individual tests as well as groups. # That is, TestCase selection can look like Foo.Bar=YES, not just Foo=YES. # You can also used negative selection, like *=YES followed by Foo.Bar=NO. d0 = dict[0].split('.',1) if (dict[1].upper() == 'YES' or dict[1].upper() == 'Y'): if (len(d0) > 1): filter = filter + dict[0] + ':' else: filter = filter + dict[0] + '.*' + ':' elif (dict[1].upper() == 'NO' or dict[1].upper() == 'N'): if (len(d0) > 1): negfilter = negfilter + dict[0] + ':' else: negfilter = negfilter + dict[0] + '.*' + ':' elif part == 'Environment': print '\t%s="%s"' % ( dict[0], dict[1] ) text = text + '\n%s="%s"' % ( dict[0], dict[1] ) text = text + '\nexport %s\n' % ( dict[0] ) elif part == 'GTestFile': # the file name might contain = character gtestfile = line elif part == 'GTestFile' and line != '': gtestfile = line else: # line is unusable continue except IOError: print >> sys.stderr, 'error opening config file "%s"' % conffile return 2 # assemble the path to gtestfile to execute command = gtestfile if gtestfileopt != '': command = gtestfileopt if command == '': command = 'ajtest' if testpath != '': text = text + '\ncd "%s" || exit 2\n' % testpath command = os.path.join( testpath, command ) else: command = os.path.join( '.', command ) print '[GTestFile]\n\t%s' % command text = text + '\nls "%s" || exit 2\n' % command # assemble the gtest filter, if any if filter == '' and negfilter == '': pass elif filter != '' and negfilter == '': filter = re_lastcolon.sub( '', filter ) elif filter == '' and negfilter != '': filter = '*' + '-' + re_lastcolon.sub( '', negfilter ) else: filter = re_lastcolon.sub( '', filter ) + '-' + re_lastcolon.sub( '', negfilter) if filter != '': print '[TestCases]\n\t%s' % filter command = command + ' --gtest_filter="' + filter + '"' # script ends by executing the gtestfile with filter argument, if any text = text + '\n' + command + ' || exit 1' # write the scriptfile try: with open( scriptfile, 'w' ) as fileptr: print >> fileptr, text except IOError: print >> sys.stderr, 'error opening script file "%s"' % scriptfile return 2 return 0 if __name__ == '__main__': if len(sys.argv) > 1: sys.exit(main(sys.argv[1:])) else: sys.exit(main()) alljoyn-15.04b/alljoyn_c/unit_test/test_report/test_harness.py000077500000000000000000000151541255700255500247720ustar00rootroot00000000000000 # Copyright AllSeen Alliance. All rights reserved. # # Permission to use, copy, modify, and/or distribute this software for any # purpose with or without fee is hereby granted, provided that the above # copyright notice and this permission notice appear in all copies. # # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. # import getopt import os import re import sys import subprocess def usage(): print >> sys.stderr, """ Usage: python test_harness.py [ -c config_file ] [ -t gtestfile ] [ -p path_to_gtestfile ] where: config_file: test_harness config file; default: test_harness.conf gtestfile: name of gtest executable file; default: ajtest path_to_gtestfile: optional path to directory containing gtestfile """ def main(argv=None): # get commandline options conffile='test_harness.conf' testpath='' gtestfileopt='' if argv is None: argv=[] if len(argv) > 0: try: opts, junk = getopt.getopt(argv, 'c:p:t:') if junk: print >> sys.stderr, 'error, unrecognized arguments ' + str(junk) usage() return 2 for opt, val in opts: if opt == '-c': conffile = val elif opt == '-p': testpath = val elif opt == '-t': gtestfileopt= val except getopt.GetoptError, err: print >> sys.stderr, 'error, ' + str(err) usage() return 2 # initialize dict = [] filter = '' negfilter = '' gtestfile = '' part = '' re_comment = re.compile( r'\s*#.*$' ) re_equals = re.compile( r'\s*=\s*' ) re_lastcolon = re.compile( r':$' ) re_TestCases = re.compile( r'^\[\s*Test\s*Cases\s*\]', re.I ) re_Environment = re.compile( r'^\[\s*Environment\s*\]', re.I ) re_GTestFile = re.compile( r'^\[\s*GTest\s*File\s*\]', re.I ) # read config file one line at a time try: with open( conffile, 'r' ) as fileptr: for line in fileptr: # strip leading and trailing whitespace line = line.strip() line = line.strip('\n') # strip trailing comment (and preceding whitespace), if any line = re_comment.sub( '', line ) # search line for part header if re_TestCases.search( line ): # line ~= [ TestCases ] part = 'TestCases' continue elif re_Environment.search( line ): # line ~= [ Environment ] part = 'Environment' print '[Environment]' continue elif re_GTestFile.search( line ): # line ~= [ GTestFile ] part = 'GTestFile' continue else: # line is none of the above # split line around equals sign (and surrounding whitespace), if any dict = re_equals.split( line, 1 ) if (len(dict) > 1): # line ~= something = something if part == 'TestCases': # Can select individual tests as well as groups. # That is, TestCase selection can look like Foo.Bar=YES, not just Foo=YES. # You can also used negative selection, like *=YES followed by Foo.Bar=NO. d0 = dict[0].split('.',1) if (dict[1].upper() == 'YES' or dict[1].upper() == 'Y'): if (len(d0) > 1): filter = filter + dict[0] + ':' else: filter = filter + dict[0] + '.*' + ':' elif (dict[1].upper() == 'NO' or dict[1].upper() == 'N'): if (len(d0) > 1): negfilter = negfilter + dict[0] + ':' else: negfilter = negfilter + dict[0] + '.*' + ':' elif part == 'Environment': os.putenv(dict[0],dict[1]) print '\t%s="%s"' % ( dict[0], dict[1] ) elif part == 'GTestFile': # the file name might contain = character gtestfile = line elif part == 'GTestFile' and line != '': gtestfile = line else: # line is unusable continue except IOError: print >> sys.stderr, 'error opening config file "%s"' % conffile return 2 # assemble the path to gtestfile to execute command = gtestfile if gtestfileopt != '': command = gtestfileopt if command == '': command = 'ajtest' if testpath != '': command = os.path.join( testpath, command ) print '[GTestFile]\n\t%s' % command if not ( os.path.exists( command ) or os.path.exists( command + '.exe' ) ): print >> sys.stderr, 'error, GTestFile="%s" not found' % command return 2 command=[command] # assemble the gtest filter, if any if filter == '' and negfilter == '': pass elif filter != '' and negfilter == '': filter = re_lastcolon.sub( '', filter ) elif filter == '' and negfilter != '': filter = '*' + '-' + re_lastcolon.sub( '', negfilter ) else: filter = re_lastcolon.sub( '', filter ) + '-' + re_lastcolon.sub( '', negfilter) if filter != '': print '[TestCases]\n\t%s' % filter command.append('--gtest_filter=' + filter) # execute the gtestfile with filter argument, if any # exit status 0 if no errors, 1 if any tests failed, 2 if system error if subprocess.call(command) == 0: return 0 else: return 1 if __name__ == '__main__': if len(sys.argv) > 1: sys.exit(main(sys.argv[1:])) else: sys.exit(main()) alljoyn-15.04b/alljoyn_core/000077500000000000000000000000001255700255500160235ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/.gitignore000066400000000000000000000004331255700255500200130ustar00rootroot00000000000000TAGS LinuxTAGS build *build .sconsign.dblite *.pdb .*.swp .cproject .project *.ncb *.log *.suo *.aps *.user *.winmd *.mdf *.ldf bin obj gen libs xcuserdata/*.xcuserdatad/* /daemon/bt_windowsKernel/objchk_win7_amd64/ /daemon/bt_windowsKernel/objchk_win7_x86/ whitespace.db cscope.out alljoyn-15.04b/alljoyn_core/Install/000077500000000000000000000000001255700255500174315ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/Install/Win7/000077500000000000000000000000001255700255500202555ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/Install/Win7/.gitignore000066400000000000000000000002101255700255500222360ustar00rootroot00000000000000*.cab *.db *.ddf *.msi *.sdf *.opensdf ExpandCab.exe setup.inf setup.rpt Debug/* ExpandCab/Debug/* ExpandCab/Release/* ipch/* Release/* alljoyn-15.04b/alljoyn_core/Install/Win7/AllJoynLogo.jpg000066400000000000000000000540751255700255500231630ustar00rootroot00000000000000JFIF``hExifMM*>F(1N``Paint.NET v3.5.10C      C  " }!1AQa"q2#BR$3br %&'()*456789:CDEFGHIJSTUVWXYZcdefghijstuvwxyz w!1AQaq"2B #3Rbr $4%&'()*56789:CDEFGHIJSTUVWXYZcdefghijstuvwxyz ?((((((((((((((((((((((((((((((((((((((((((((ڗ +AX|[h$֑w&wN#e(ֵBYrRo=,'fx22Q'.˩W/xOišWU/S;0A(ϱz|K#ŗbkKCl!;_K,]EzCßE)EU̪SEot}?#oş )'6W{t|)7߆hタY?%82HHrX}iÃ)ު߫?M21i?^d!,>)9Y~BL{xO5o v-*IևWx;R[#R4</єSS!or&>2ަ'}(I[o_)xVs]ݞ{߽2jq|/זs.~GF/ʢaaT~$~Q?I_'ƿ |xZCxJ>u#u#WQ_=(/Jb0peF\gfi٧aETQ@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@s2c'|OjB4̷7/OdEgsT'5~_߄?c>+e $R|dE̱G$~mxZ /Fs=23GHF7H~fP{6EW.wn/C |8ƷjKiTkxOwOH_WO϶x'ĘS]_P^ }ld|{{6y-\NI%NKy$梯?!O_ڻJƐkSuni{;PF텾PkZXj8 ;tQY%WTVKR};tVS ( }GQ.ˆJ:,0 lt'%~;'~1 )P,er[j ۅaVHwTῆ|9u 1+]+u8w"?ߵi] z_aUQsxnv0 ª fO fxN!/%t>s/83Q N+]~mor_(w?>1y[7 1޻'&đ["% \d<#x:~\z:ZZ[yn%sU$G?'/?m~7L[ǤY\y\JXB\9l_'ǁ@|,VRDo^VYVF|Ȓ)s Ǜ_ _K#J)d<;eV. BT8Σ|Uyb仟!oYo:zkVi<_ Q뚧%.6d1c VH Asg¯.bk^lk CKY IzGg?xIN܉6P~ѿo/ j_Ug?!K2ih{FϏxcQ_o4^L4 K)SƿX>~c5{M:W>qRPEAcĿT/+[xKKm9l/YeTs]F#3 ?OF}υ,pj>Y'ѥ̞W|qx>!Լ;ŀe 2!H#ڿX\q4+ Kԟ X% ːEzQUѭqd<[pirKݫ)Ƕj?ݕk=OMX: #-~5-+;?nuO[{ VRe;*n=9dw*6few,OH*ÆR 5gT䩳c|׃ EyvQz4v(Oς((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((_;7|&|gghd#IF?GbG5W?xO=@e%S?l\,7~_|(g+ƌ=] zGg~ڟ?m*etriVƾx.7"ɭ?<_{6J3EU,I~!j.OҞRF2T0[vr5]\nVV$53|(Pi8VMoh-ݖۻ>SFϵ~5ڻ2đ$qZ0dQ.ˁW (X~& q"k˝5navMBB0,~-gJ/boXHTd A;*`," A-VHChX2U;0͕F\>'k-GCKqokWOFS_o!I[2jv?v+O,)ch$Iˈ1kÙ|GvJi9ai4_Vid^LY{ayO!k.q޾/U9:~xAÅ>[[JUwEmGN/C4~*Ǿ#O3@$}[w`m1r?v.kϊ[>&Ҭ,(߻(UN/sN>HՍaVrTڽuOi:\Oy"-E!T#x0G#mHo[iךi)sZާiPrÞ5Ks ⌣Gt<ͥ%T};߷[?Ė7zm喫[i3]@-Uel0GCȷvYNȥ]Nُz?>4#07RolA,I g:k3JMJ$k[X à$n9 cݡ?}źp!Wh&%mWoM|=I4~Q5)q{V[z{_A~]FK\13+(3Ε\} 29ķ3*.1 U@wŇT*jp^d> MkEɷ)([iyiKQ^y߱G7!ҞJֶN~YHB:\uCڿ/~*lM:+?RxRhC# .,_G[o^_m6kVe`h+N8Vg'ҫ#[CGߤ:p # (??((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((Ϳ4KBAq3DR Z X ~%#+4aV_ +JPaݤzFqpKz&~-j_>%xŚ&zƥ6NpJW#FZX8euPWIcLR%-; `7Z`x#'gy!`!Ѯ!-]VŲu+1Eust\ZQc גhAw=6˕*^i"G3ڢ]'o%Y*d7[ZGkMVEJ$w?v_V1^b,p3HW;ߛ; TEjy8*-Ury;ZOïc\]!"i,U\+ .J]1ӌF06h`WǭgPmuw}sl3a Y'q?T۵\^6 AIs]jusĿczO?kv4ĩ`9C08;f'1Z׀u[I4K+*bMF?x* U]1; 2p |3OfOoi>L`l#!0$0 Aҿ%౿?kE]{7mb ӼK:nj|Xɏ2hoq$$^%_gF:%%Zy2+SۚRWxQEjz!_}?9e+i?~ĉD-{(›r]M'8ȺV#WPUuiZ_|'`zSkQ\ɢn(d((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((++E[~>5E7;nO1Ok/FZݬ&ǰS_⸗/rӑ?-<  Y%y'ec>QStɆ|uT;65BJ]Z|w= OѮVHۧt$`Y}k|YkKH{ƆU.[*y%Ҷ YfN&b%`S%ƒDM? W⿎NybR͎U݉Q;GC)sU:KNך)NmC~~'<"yd7W)0yESÌ~5|pԼ!RDvWϖ' 7\Ld˱O5ci+3 SF>g|If%W;koX/uKgm q <]<9gxB8x$|̀Dį$_F yub" /S[4t;8Y-7NEyri<QYSÍMX5&͂ 7P|{Yl.㸂VxI>WMSXx5C*c'=W8,{\AbJFϾ_c䟋2xgƘɧl|#xNj[ydxIW`G 85^4>d˷g~*15a֨RQfk|BroJ%FbMBm6ot6)=7/&tƻaS9Uey`NTt >4> ms>c_Z4KFQ kI#vH_K0, }-||`XNjʔ45wӚ4K?zvk/oqo: "7YOH$z_wE il[Lwgg Zܪ ~~Vw3Z|LаӴ/2Bq\%w߲GN_YW3V]sےwY+P: +r ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( 6yu0O$+v/%Q_Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@Q@~Cmb;_-x_ŗ֢~];Poj@i7d+>$|:~.xUψ 4Mno-eYQ>#@ G+%-Vw_kǘΡ\߻R6;/}%Pwo(G?ؿ5j4W>LÀ h:z X*Xjtw gyW5:U4iBkBqω;T~uo,~uTǍᚉ{x*׊>S*`VuAğD2ʍeKj7麧%$q'#F k>" cQצc pE}>]-J˩f'9eػNI'&ӌ} <(ǖ((*K;9 yqqƥF'@O SKt77-8*qm*9\8T5ft]Z%>'/oK)>Ė:wO`8~_Au%i5%Uoۇ~|cERNz⋋o\)5{+G?#Tj+e*H :_ԙW^5XhqG&~]TQ#+Mk~OREm7D z/?cO_eE>RI:M:>2 Lm/qOTIRKF*Qk/~ oAf_/ d.oE_U O:gsV]Z65}=Xw~a#>][wO~,.{ o\5k=?Z5X}൵aQ@ =Q^w՟rQE ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( ( +J|M_Ě>,[]<1jWs-`^-55gI}trFn2OJ3nNiӵ׮ ߵw w E V>*AXYI6%1T ZI[<(W?3ͱO 96M-X++??h&w޹m5%× HF< -$I?\WK n vwW (FQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQER؛,DiflH'aڽ޿_>3nֵFZ1l=c;|C2Auk/E߷̙+?G7| ^x7-˒j<#uTv$?Zh_|#㤆 j5K2 I5&rF143Ѱ{W?'}UƍJ)j#Mw pg@Zc?cmx{TY\"O#=7ye+t1Yli8[53V1x[5ƝWQ_izWw12 tu=)}j~v7/غ_j^w~ζn{V,8(kNrqu0.ޫ3;7RWƻ%oZx򒿍5u+?MB[Kx2u+$3G =AR"ˈ2\*x8c%k?=JWql_4㞕j&KyշEUWtHaO* r|SwRCu{ TN/(% =W/(~%Yd_F.%W6s-rgZω2 ,&kFMǚ=koKl o9O~њ!֟5~PZ-8y- ">d$gҿ_ػߊM$lv0Kٽ7(3ƿOڗ~~Þ1^=eִ~K ֘y ?ޯ?rPR F-6[k*?m8?㧇mOzNO kS~UV̳He>iB#`$hߴ^~w_*x_M^jJKfYՙI*b'~_k"IZd@g I??*?fUԴ:E!r3zq^dbYn 2VvW}Pl?o=m ~F[9,Q'@pC&Pc;sּ%ཿdp 94ٱW߄i(xFWӯb*$Cèi7mlTdCp~ vb3vKV `7dobb-n~ hOZzHq.Ll7!~>g|Fek1kyΌRX$aA?ٛ?_xwJ*\mk%wpUfRzOj߉.ocoxm=ǩ>q6Y2xf*^ͶZhݶZhڗ+?O袊((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((2|U>|''ϣx_MT~3rՎ0r@_ɧW~7xzռYϩĬFG,#_p;*_se?ً_ 4dE]j.XYo'ֿ5_O; ZJ+údڮry2I8!Y0vJdRcG< s|N1->HƣGp_'o@k+E&q$$cڻW'?T,LS>5~ռ-=ݖ׎"=@P+Ikf/ٌy<1ORvmn" k|SS7M,9Ҭj*Z>)=ki,5|1:))mq ȓJp>:⚳OIuةp _ )A8Z zLj=꭬Y]iSF.lxXrVB"F8 c=#X|:sv1p,к}\Rs|& ƹX,zɳ"?em_6WDwie_4Q 7K־*O ^DtA$U\O#~`o;[Y|\XͶ2ks_F8bT|*ʄdl&`Aރ#&3^L.*Oa01c´uA65Rve?:Fc?1}gihN1_'rҴ6Rc󆿡xI+?+oۑl~r Zң^ɪL?*:NC_WTk?5_5^7H/-3>3چ{il|XhI^\u-kHo."ʱ>~Gxt&Hn!TޭoG${1ɋpuV<>˔efx*у׺y6QErQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEQEG M}'L񔚮xvY%ҵ}1nmxF΁e~;OD#@NI¨$޵襉XP^aS #k+d+ֳ4+媢F9 *enσ^[J[[SFSHyS_+ŲXNrk#3ץ 7|+$Oo_uާoL-n2gK`Nv!;n{{x]b->wnދyn4h澜qAWדk}{ĢV=K-tWɼK 뜌Ђ 0TA[W8(4QK |ky<+gguk'#a|$?f@E ۻ\Hl7aH+(q3rv4c Kw~|Au!ռ=uo'mmKvUdȮ1|4^ vVͨkV6 HGfO)o'įAд_厱o1e"o- s@w _" and * deleting all the files and subdirectories during the uninstall. */ /****************************************************************************** * * * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include "stdafx.h" /** * Display the proper usage of this program to stdout. */ void Usage(void) { fputs("Usage: ExpandCab <[/commit] || [/uninstall]> Directory.\n", stdout); } /** * Implement the commit phase of the installation. * This means "expand AJN.CAB -F:* destination" for the commit phase. * Outputs a user friendly message upon completion. * * @param destination The destination directory to expand the .CAB file * into. * * @return - EXIT_SUCCESS if successful. */ int DoCommit(const char* destination); /** * Implements, in essence, "rm /S /Q directory" for the uninstall phase. * Outputs a user friendly message if there was an error. * * @param directory The destination directory to remove. * @param deleteCWD If deleteCWD is true then none of the files in * the current directory are deleted and 'directory' * is not deleted. The subdirectories ARE traversed * and removed. * * @return - EXIT_SUCCESS if successful. */ int DeleteFilesAndDirectory(const char* directory, bool deleteCWD); /** * Get the complete path for the expand.exe program which is in * the Windows System32 directory. * * @return - The complete path to expand.exe if successful. * Returns an empty string if not found. */ const char* GetExpandExe(void); /** * From arg0 make the destination path. * arg0 is in the form of "c:\AllJoyn\SDK\ExpandCab.exe". * The .MSI always puts this program into the destination directory. * This enables us to determine the destination directory for other * purposes. * * @param destination The string buffer to put the destination * directory in. * @param destSizeInBytes The size of the buffer. * @param arg0 arg[0] from the command line to this program. * * @return - EXIT_SUCCESS if successful or EXIT_FAILURE if not. */ int MakeDestination(char* destination, size_t destSizeInBytes, const char* arg0); /** * Entry point for the program. * Implements "expand AJN.CAB -F:* destination" for the commit phase. * Implements "rm /S /Q directory" for the uninstall phase. * @param argc The number of arguments passed to the program. * @param argv The arguments passed to the program. * * @return - EXIT_SUCCESS if successful. */ int CDECL_CALL main(int argc, char* argv[]) { int returnValue = EXIT_FAILURE; if (argc >= 2) { const static char commit[] = "/Commit"; const static char uninstall[] = "/Uninstall"; char destination[_MAX_PATH]; returnValue = MakeDestination(destination, sizeof(destination), argv[0]); if (0 == returnValue) { if (0 == _strcmpi(argv[1], commit)) { returnValue = DoCommit(destination); } else { if (0 == _strcmpi(argv[1], uninstall)) { returnValue = DeleteFilesAndDirectory(destination, false); } else { Usage(); } } } } else { Usage(); } fputs("Press any key to continue...", stdout); int c = _getch(); // If an function or arrow key get the second char as well. if (0 == c || 0xE0 == c) { _getch(); } return returnValue; } int DoCommit(const char* destination) { int returnValue = _chdir(destination); if (0 == returnValue) { const char* expand = GetExpandExe(); if (expand[0] == '\0') { fputs("Unable to find Windows expand.exe.\n", stdout); } else { returnValue = _spawnl(_P_WAIT, expand, expand, "AJN.CAB", "-F:*", ".", NULL); if (-1 == returnValue) { perror("_spawnl() returned -1"); } else { fputs("Files were extracted successfully.\n", stdout); } } } else { fputs("Unable to make '", stdout); fputs(destination, stdout); fputs("' the current working directory.\n", stdout); } return returnValue; } /** * Given a path and a file name make a complete path and put it in the * destination buffer. It is assumed that the destination buffer is at * least _MAX_PATH characters long. * * @param destination The destination buffer for the complete path. * @param path The path to the file. * @param file The file at the end of the path. */ void MakeCompletePath(char* destination, const char* path, const char* file) { strcpy_s(destination, _MAX_PATH, path); strcat_s(destination, _MAX_PATH, "\\"); strcat_s(destination, _MAX_PATH, file); } int DeleteFilesAndDirectory(const char* directory, bool deleteCWD) { int returnValue = EXIT_SUCCESS; char fileSpec[_MAX_PATH]; MakeCompletePath(fileSpec, directory, "*.*"); struct _finddata_t fileInfo = {0}; intptr_t handle = _findfirst(fileSpec, &fileInfo); if (-1 != handle) { do { MakeCompletePath(fileSpec, directory, fileInfo.name); // If the bit is set indicating a subdirectory then recurse. if (_A_SUBDIR & fileInfo.attrib) { // Ignore the current and parent directories. if (0 != strcmp(".", fileInfo.name) && 0 != strcmp("..", fileInfo.name)) { returnValue = DeleteFilesAndDirectory(fileSpec, true); if (EXIT_SUCCESS == returnValue) { fputs("Successfully deleted directory '", stdout); } else { fputs("Unable to delete directory '", stdout); } fputs(fileInfo.name, stdout); fputs("'.\n", stdout); } } else { if (deleteCWD) { returnValue = remove(fileSpec); if (EXIT_SUCCESS != returnValue) { fputs("Unable to delete file '", stdout); fputs(fileInfo.name, stdout); fputs("'.\n", stdout); } } } } while (EXIT_SUCCESS == returnValue && -1 != _findnext(handle, &fileInfo)); _findclose(handle); } if (deleteCWD) { returnValue = _rmdir(directory); } return returnValue; } const char* GetExpandExe(void) { static char returnValue[_MAX_PATH + 1]; if (returnValue[0] == '\0') { char* systemRoot; int status = _dupenv_s(&systemRoot, NULL, "SystemRoot"); if (systemRoot) { strcpy_s(returnValue, sizeof(returnValue) / sizeof(returnValue[0]), systemRoot); strcat_s(returnValue, sizeof(returnValue) / sizeof(returnValue[0]), "\\system32\\expand.exe"); // Make sure the file actually exists. int access = _access(returnValue, 0); if (0 != access) { returnValue[0] = '\0'; } free(systemRoot); } } return returnValue; } int MakeDestination(char* destination, size_t destSizeInBytes, const char* arg0) { int returnValue = EXIT_FAILURE; if (arg0 && destination && destSizeInBytes > 0) { const char* pathEnd = strrchr(arg0, '\\'); if (!pathEnd) { pathEnd = strrchr(arg0, '/'); } if (!pathEnd) { pathEnd = arg0; } if (pathEnd - arg0 < (int)(destSizeInBytes / sizeof(destination[0]))) { while (arg0 < pathEnd) { *destination++ = *arg0++; } returnValue = EXIT_SUCCESS; } *destination = '\0'; } return returnValue; } alljoyn-15.04b/alljoyn_core/Install/Win7/ExpandCab/ExpandCab.vcxproj000066400000000000000000000105011255700255500253410ustar00rootroot00000000000000 Debug Win32 Release Win32 {EF347273-73D0-49C5-AD46-BEFCE94056A9} Win32Proj ExpandCab Application true Unicode Application false true Unicode true false Use Level3 Disabled WIN32;_DEBUG;_CONSOLE;%(PreprocessorDefinitions) Console true copy ..\debug\ExpandCab.exe .. Level3 Use MaxSpeed true true WIN32;NDEBUG;_CONSOLE;%(PreprocessorDefinitions) Console true true true copy ..\release\ExpandCab.exe .. Create Create alljoyn-15.04b/alljoyn_core/Install/Win7/ExpandCab/ExpandCab.vcxproj.filters000066400000000000000000000023231255700255500270130ustar00rootroot00000000000000 {4FC737F1-C7A5-4376-A066-2A32D752A2FF} cpp;c;cc;cxx;def;odl;idl;hpj;bat;asm;asmx {93995380-89BD-4b04-88EB-625FBE52EBFB} h;hpp;hxx;hm;inl;inc;xsd {67DA6AB6-F800-4c08-8B7A-83BB121AAD01} rc;ico;cur;bmp;dlg;rc2;rct;bin;rgs;gif;jpg;jpeg;jpe;resx;tiff;tif;png;wav;mfcribbon-ms Header Files Header Files Source Files Source Files alljoyn-15.04b/alljoyn_core/Install/Win7/ExpandCab/stdafx.cpp000066400000000000000000000025361255700255500241050ustar00rootroot00000000000000/** * @file * @brief Source file that includes just the standard includes * ExpandCab.pch will be the pre-compiled header * stdafx.obj will contain the pre-compiled type information */ /****************************************************************************** * * * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ // stdafx.cpp : source file that includes just the standard includes // ExpandCab.pch will be the pre-compiled header // stdafx.obj will contain the pre-compiled type information #include "stdafx.h" alljoyn-15.04b/alljoyn_core/Install/Win7/ExpandCab/stdafx.h000066400000000000000000000025021255700255500235430ustar00rootroot00000000000000/** * @file * @brief include file for standard system include files, * or project specific include files that are used frequently, but * are changed infrequently */ /****************************************************************************** * * * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #pragma once #include "targetver.h" #include #include #include #include #include #include #include #include alljoyn-15.04b/alljoyn_core/Install/Win7/ExpandCab/targetver.h000066400000000000000000000026001255700255500242540ustar00rootroot00000000000000/** * @file * @brief Auto generated by Visual Studio to handle different versions of * the target environment. */ /****************************************************************************** * * * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #pragma once // Including SDKDDKVer.h defines the highest available Windows platform. // If you wish to build your application for a previous Windows platform, include WinSDKVer.h and // set the _WIN32_WINNT macro to the platform you wish to support before including SDKDDKVer.h. #include alljoyn-15.04b/alljoyn_core/Install/Win7/MakeAjSdkMsi.cmd000066400000000000000000000115711255700255500232120ustar00rootroot00000000000000@Echo OFF Rem @file Rem @brief Make the .cab file for Win7 installation. Rem **************************************************************************** Rem Copyright AllSeen Alliance. All rights reserved. Rem Rem Permission to use, copy, modify, and/or distribute this software for any Rem purpose with or without fee is hereby granted, provided that the above Rem copyright notice and this permission notice appear in all copies. Rem Rem THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES Rem WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF Rem MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR Rem ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES Rem WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN Rem ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF Rem OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. Rem **************************************************************************** setlocal ENABLEDELAYEDEXPANSION Rem The first argument to this script is the directory to work out of. cd %1 if '%2'=='' goto NoMsDevEnv set DDF_FILE=ajn.ddf Rem Overwrite any existing DDF_FILE with the configuration/constant Rem portion of the file. Echo ; Configuration file for building AJN.CAB.> %DDF_FILE% Echo .OPTION EXPLICIT ; Generate errors on variable typos>> %DDF_FILE% Echo .Set MaxDiskSize=0 ; All files go in a single cabinet>> %DDF_FILE% Echo .Set CabinetNameTemplate=AJN.CAB>> %DDF_FILE% Echo .set DiskDirectoryTemplate=. ; All cabinets go in a single directory>> %DDF_FILE% Echo .Set CompressionType=MSZIP>> %DDF_FILE% Echo .Set Cabinet=on>> %DDF_FILE% Echo .Set Compress=on>> %DDF_FILE% Echo .Set UniqueFiles=on>> %DDF_FILE% set BUILD_SRC=..\..\..\build\win7 if not exist %BUILD_SRC% goto NoBuild @Echo OFF Echo Adding x86 files. for /R %BUILD_SRC%\x86 %%f in (*) do ( for /F "usebackq tokens=3,4,5,6,7,8,9,10* delims=\" %%h in ('%%f') do ( call :AddFile %%f %%h %%i %%j %%k %%l %%m %%n %%o %%p ) ) Echo Adding x86_64 files. for /R %BUILD_SRC%\x86_64 %%f in (*) do ( for /F "usebackq tokens=3,4,5,6,7,8,9,10* delims=\" %%h in ('%%f') do ( call :AddFile %%f %%h %%i %%j %%k %%l %%m %%n %%o %%p ) ) makecab /f %DDF_FILE% if ERRORLEVEL 1 goto MakeCabFail Rem ****************************************************** Rem We now have the cab file. Build ExpandCab.exe and AllJoynWinInstaller.msi. Rem ****************************************************** Echo %2 AllJoynWinInstaller.sln /build "Release|Win32" %2 AllJoynWinInstaller.sln /build "Release|Win32" if ERRORLEVEL 1 goto MakeMsiFail goto End :NoMsDevEnv Echo The second argument must be the full path to Visual Studio "devenv.exe". endlocal Exit /B 1 :NoProgFiles Echo The environment does not include either of the expected variables 'ProgramFiles' or 'ProgramFiles(x86)'. endlocal Exit /B 1 :MakeMsiFail Echo Creation of AllJoynWinInstaller.msi failed. endlocal Exit /B 1 :MakeCabFail Echo MakeCab failed. endlocal Exit /B 1 :NoBuild Echo Build '%BUILD_SRC%' directory not found. endlocal Exit /B 1 :End endlocal Exit /B 0 Rem ****************************************************** Rem This is a "subroutine" called from above. Rem ****************************************************** :AddFile setlocal ENABLEDELAYEDEXPANSION set SRC_FILE=%1 shift if /I "%1"=="x86_64" goto FoundProc if /I "%1"=="x86" goto FoundProc shift if /I "%1"=="x86_64" goto FoundProc if /I "%1"=="x86" goto FoundProc shift if /I "%1"=="x86_64" goto FoundProc if /I "%1"=="x86" goto FoundProc shift if /I "%1"=="x86_64" goto FoundProc if /I "%1"=="x86" goto FoundProc shift if /I "%1"=="x86_64" goto FoundProc if /I "%1"=="x86" goto FoundProc shift if /I "%1"=="x86_64" goto FoundProc if /I "%1"=="x86" goto FoundProc shift if /I "%1"=="x86_64" goto FoundProc if /I "%1"=="x86" goto FoundProc Echo Unable to find processor directory in Echo %1 pause Exit /B 1 :FoundProc Rem At this point: Rem %1 is x86 or x86_64, Rem %2 is debug or release, Rem %3 is dist. Rem %4... is the rest of the path and file name. Rem Ignore all contents not in the 'dist' directory. if /I "%3" NEQ "dist" Exit /B 0 Rem Remove "dist" while creating the destination file path and name. set DEST_FILE=%1\%2\%4 Rem Move %5 into the %1 position. shift shift shift shift Rem Check to see if there were any further path and/or filenames that Rem need to be added to the destination. if "%1" NEQ "" set DEST_FILE=%DEST_FILE%\%1 shift if "%1" NEQ "" set DEST_FILE=%DEST_FILE%\%1 shift if "%1" NEQ "" set DEST_FILE=%DEST_FILE%\%1 shift if "%1" NEQ "" set DEST_FILE=%DEST_FILE%\%1 shift if "%1" NEQ "" set DEST_FILE=%DEST_FILE%\%1 shift if "%1" NEQ "" set DEST_FILE=%DEST_FILE%\%1 shift Rem echo "%SRC_FILE%" "%DEST_FILE%" echo "%SRC_FILE%" "%DEST_FILE%">> %DDF_FILE% Exit /B 0 alljoyn-15.04b/alljoyn_core/Install/Win7/SConscript000066400000000000000000000033641255700255500222750ustar00rootroot00000000000000# Copyright AllSeen Alliance. All rights reserved. # # Permission to use, copy, modify, and/or distribute this software for any # purpose with or without fee is hereby granted, provided that the above # copyright notice and this permission notice appear in all copies. # # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. # import os Import('env') cwd = os.getcwd() msiDestination = '../../build/Win7' msiSource='./release/AllJoynWinInstaller.msi' # Always rebuild the MSI so that multiple builds of debug, release, CPU can be made and # a new MSI is made after each one. if os.path.exists(msiSource): os.remove(msiSource) programFiles='' if os.environ.has_key('ProgramFiles(x86)'): programFiles=os.environ['ProgramFiles(x86)'] elif os.environ.has_key('ProgramFiles'): programFiles=os.environ['ProgramFiles'] else: print 'Program files directory not found.' Exit(1) if env.has_key('MSVC_VERSION'): msvcVer = env['MSVC_VERSION'] else: print 'Visual Studio version not found.' Exit(1) devEnv = '"' + programFiles + '\Microsoft Visual Studio ' + msvcVer + '\Common7\IDE\devenv.exe"' cmd = cwd + '\MakeAjSdkMsi.cmd ' + cwd + ' ' + devEnv Msi = env.Command(msiSource, Dir('$DISTDIR'), cmd) installedMsi = env.Install(msiDestination, Msi) Return ('installedMsi') alljoyn-15.04b/alljoyn_core/SConscript000066400000000000000000000127251255700255500200440ustar00rootroot00000000000000# Copyright AllSeen Alliance. All rights reserved. # # Permission to use, copy, modify, and/or distribute this software for any # purpose with or without fee is hereby granted, provided that the above # copyright notice and this permission notice appear in all copies. # # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. # import os Import('env') # Indicate that this SConscript file has been loaded already env['_ALLJOYNCORE_'] = True # Header files in common require "dist/cpp/inc/alljoyn" in the include path to find Status.h env.Append(CPPPATH = ['$DISTDIR/cpp/inc/alljoyn']) # Dependent Projects common_hdrs, common_static_objs, common_shared_objs = env.SConscript(['../common/SConscript']) # Make alljoyn C++ dist a sub-directory of the alljoyn dist. env['CPP_DISTDIR'] = env['DISTDIR'] + '/cpp' env['CPP_TESTDIR'] = env['TESTDIR'] + '/cpp' env['OBJDIR_ALLJOYN_CORE'] = env['OBJDIR'] + '/alljoyn_core' ajenv = env.Clone() # Bullseye code coverage for 'debug' builds. if ajenv['VARIANT'] == 'debug': if(not(ajenv.has_key('BULLSEYE_BIN'))): print('BULLSEYE_BIN not specified') else: ajenv.PrependENVPath('PATH', ajenv.get('BULLSEYE_BIN')) if (not(os.environ.has_key('COVFILE'))): print('Error: COVFILE environment variable must be set') if not GetOption('help'): Exit(1) else: ajenv.PrependENVPath('COVFILE', os.environ['COVFILE']) # manually add dependencies for xml to h, and for files included in the xml ajenv.Depends('$OBJDIR_ALLJOYN_CORE/Status.h', 'src/Status.xml') ajenv.Depends('$OBJDIR_ALLJOYN_CORE/Status.h', '../common/src/Status.xml') ajenv.Depends('$OBJDIR_ALLJOYN_CORE/Status.h', '../build_core/tools/bin/make_status.py') ajenv.Append(STATUS_FLAGS=['--base=%s' % os.getcwd()]) # Add support for multiple build targets in the same workset ajenv.VariantDir('$OBJDIR_ALLJOYN_CORE', 'src', duplicate = 0) ajenv.VariantDir('$OBJDIR_ALLJOYN_CORE/test', 'test', duplicate = 0) ajenv.VariantDir('$OBJDIR_ALLJOYN_CORE/router', 'router', duplicate = 0) ajenv.VariantDir('$OBJDIR_ALLJOYN_CORE/samples', 'samples', duplicate = 0) # AllJoyn Install ajenv.Install('$OBJDIR_ALLJOYN_CORE', ajenv.File('src/Status.xml')) ajenv.Status('$OBJDIR_ALLJOYN_CORE/Status') core_headers = ajenv.Install('$CPP_DISTDIR/inc/alljoyn', '$OBJDIR_ALLJOYN_CORE/Status.h') core_headers += ajenv.Install('$CPP_DISTDIR/inc/alljoyn', [ h for h in ajenv.Glob('inc/alljoyn/*.h') if h not in ajenv.Glob('inc/alljoyn/Status*.h') ]) for d, h in common_hdrs.items(): core_headers += ajenv.Install('$CPP_DISTDIR/inc/%s' % d, h) # Header file includes #ajenv.Append(CPPPATH = [ajenv.Dir('$CPP_DISTDIR/inc'), ajenv.Dir('$CPP_DISTDIR/inc/alljoyn')]) # Make private headers available ajenv.Append(CPPPATH = [ajenv.Dir('src')]) # AllJoyn Libraries libs, static_objs, shared_objs = ajenv.SConscript('$OBJDIR_ALLJOYN_CORE/SConscript', exports = ['ajenv', 'common_static_objs', 'common_shared_objs']) ajenv.Install('$CPP_DISTDIR/lib', libs) env.Prepend(LIBS = 'alljoyn') daemon_progs, ajrlib, srobj, router_objs = ajenv.SConscript('$OBJDIR_ALLJOYN_CORE/router/SConscript') ajenv.Install('$CPP_DISTDIR/bin', daemon_progs) ajenv.Install('$CPP_DISTDIR/lib', ajrlib) router_lib = 'ajrouter' # The global env needs the 'ajrlib' for the Java binding env['ajrlib'] = router_lib env['srobj'] = srobj env['router_objs'] = router_objs # Always build C++ version of AboutService # ajrlib must be set before calling the SConscripts responsible for # building the AboutService. about_env = env.Clone() about_env['OBJDIR_ABOUT'] = env['OBJDIR'] + '/about' about_env.VariantDir('$OBJDIR_ABOUT/cpp', '../services/about/cpp', duplicate = 0) about_env.SConscript('$OBJDIR_ABOUT/cpp/SConscript', exports = ['about_env']) # only include command line samples, unit test, test programs if we are not # building for iOS. No support on iOS for command line applications. if env['OS'] == 'darwin' and env['CPU'] in ['arm', 'armv7', 'armv7s', 'arm64',]: progs = [] else: # Test programs progs = env.SConscript('$OBJDIR_ALLJOYN_CORE/test/SConscript') ajenv.Install('$CPP_DISTDIR/bin', progs) # Build unit Tests env.SConscript('unit_test/SConscript', variant_dir='$OBJDIR_ALLJOYN_CORE/unittest', duplicate = 0) # Sample programs env.SConscript('$OBJDIR_ALLJOYN_CORE/samples/SConscript') # Release notes and misc. legals if ajenv['OS_CONF'] == 'darwin': if ajenv['CPU'] == 'x86': ajenv.InstallAs('$DISTDIR/README.txt', 'docs/README.darwin.txt') elif ajenv['OS_CONF'] == 'windows': ajenv.InstallAs('$DISTDIR/README.txt', 'docs/README.windows.txt') elif ajenv['OS_CONF'] == 'android': ajenv.InstallAs('$DISTDIR/README.txt', 'docs/README.android.txt') else: # linux based platforms ajenv.InstallAs('$DISTDIR/README.txt', 'docs/README.linux.txt') if not (ajenv['OS'] == 'darwin' and ajenv['CPU'] in ['arm', 'armv7', 'armv7s', 'arm64',]): ajenv.Install('$DISTDIR', 'docs/ReleaseNotes.txt') # Build docs installDocs = ajenv.SConscript('docs/SConscript', exports = ['ajenv', 'core_headers']) alljoyn-15.04b/alljoyn_core/docs/000077500000000000000000000000001255700255500167535ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/docs/.gitignore000066400000000000000000000000441255700255500207410ustar00rootroot00000000000000html/ latex/ android_release_latex/ alljoyn-15.04b/alljoyn_core/docs/Doxygen_dev000066400000000000000000001746101255700255500211620ustar00rootroot00000000000000# Doxyfile 1.6.1 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project # # All text after a hash (#) is considered a comment and will be ignored # The format is: # TAG = value [value, ...] # For lists items can also be appended using: # TAG += value [value, ...] # Values that contain spaces should be placed between quotes (" ") #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- # This tag specifies the encoding used for all characters in the config file # that follow. The default is UTF-8 which is also the encoding used for all # text before the first occurrence of this tag. Doxygen uses libiconv (or the # iconv built into libc) for the transcoding. See # http://www.gnu.org/software/libiconv for the list of possible encodings. DOXYFILE_ENCODING = UTF-8 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded # by quotes) that should identify the project. PROJECT_NAME = "AllJoyn™ C++ API Reference Manual" # The PROJECT_NUMBER tag can be used to enter a project or revision number. # This could be handy for archiving the generated documentation or # if some version control system is used. PROJECT_NUMBER = "Version 15.04.00b" # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) # base path where the generated documentation will be put. # If a relative path is entered, it will be relative to the location # where doxygen was started. If left blank the current directory will be used. OUTPUT_DIRECTORY = $(CPP_DISTDIR)/docs # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create # 4096 sub-directories (in 2 levels) under the output directory of each output # format and will distribute the generated files over these directories. # Enabling this option can be useful when feeding doxygen a huge amount of # source files, where putting all generated files in the same directory would # otherwise cause performance problems for the file system. CREATE_SUBDIRS = NO # The OUTPUT_LANGUAGE tag is used to specify the language in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all constant output in the proper language. # The default language is English, other supported languages are: # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. OUTPUT_LANGUAGE = English # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will # include brief member descriptions after the members that are listed in # the file and class documentation (similar to JavaDoc). # Set to NO to disable this. BRIEF_MEMBER_DESC = YES # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend # the brief description of a member or function before the detailed description. # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. REPEAT_BRIEF = YES # This tag implements a quasi-intelligent brief description abbreviator # that is used to form the text in various listings. Each string # in this list, if found as the leading text of the brief description, will be # stripped from the text and the result after processing the whole list, is # used as the annotated text. Otherwise, the brief description is used as-is. # If left blank, the following values are used ("$name" is automatically # replaced with the name of the entity): "The $name class" "The $name widget" # "The $name file" "is" "provides" "specifies" "contains" # "represents" "a" "an" "the" ABBREVIATE_BRIEF = # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then # Doxygen will generate a detailed section even if there is only a brief # description. ALWAYS_DETAILED_SEC = NO # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all # inherited members of a class in the documentation of that class as if those # members were ordinary class members. Constructors, destructors and assignment # operators of the base classes will not be shown. INLINE_INHERITED_MEMB = NO # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full # path before files name in the file list and in the header files. If set # to NO the shortest path that makes the file name unique will be used. FULL_PATH_NAMES = NO # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag # can be used to strip a user-defined part of the path. Stripping is # only done if one of the specified strings matches the left-hand part of # the path. The tag can be used to show relative paths in the file list. # If left blank the directory from which doxygen is run is used as the # path to strip. STRIP_FROM_PATH = # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of # the path mentioned in the documentation of a class, which tells # the reader which header file to include in order to use a class. # If left blank only the name of the header file containing the class # definition is used. Otherwise one should specify the include paths that # are normally passed to the compiler using the -I flag. STRIP_FROM_INC_PATH = # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter # (but less readable) file names. This can be useful is your file systems # doesn't support long names like on DOS, Mac, or CD-ROM. SHORT_NAMES = NO # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen # will interpret the first line (until the first dot) of a JavaDoc-style # comment as the brief description. If set to NO, the JavaDoc # comments will behave just like regular Qt-style comments # (thus requiring an explicit @brief command for a brief description.) JAVADOC_AUTOBRIEF = YES # If the QT_AUTOBRIEF tag is set to YES then Doxygen will # interpret the first line (until the first dot) of a Qt-style # comment as the brief description. If set to NO, the comments # will behave just like regular Qt-style comments (thus requiring # an explicit \brief command for a brief description.) QT_AUTOBRIEF = NO # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen # treat a multi-line C++ special comment block (i.e. a block of //! or /// # comments) as a brief description. This used to be the default behaviour. # The new default is to treat a multi-line C++ comment block as a detailed # description. Set this tag to YES if you prefer the old behaviour instead. MULTILINE_CPP_IS_BRIEF = NO # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented # member inherits the documentation from any documented member that it # re-implements. INHERIT_DOCS = YES # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce # a new page for each member. If set to NO, the documentation of a member will # be part of the file/class/namespace that contains it. SEPARATE_MEMBER_PAGES = NO # The TAB_SIZE tag can be used to set the number of spaces in a tab. # Doxygen uses this value to replace tabs by spaces in code fragments. TAB_SIZE = 4 # This tag can be used to specify a number of aliases that acts # as commands in the documentation. An alias has the form "name=value". # For example adding "sideeffect=\par Side Effects:\n" will allow you to # put the command \sideeffect (or @sideeffect) in the documentation, which # will result in a user-defined paragraph with heading "Side Effects:". # You can put \n's in the value part of an alias to insert newlines. ALIASES = # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C # sources only. Doxygen will then generate output that is more tailored for C. # For instance, some of the names that are used will be different. The list # of all members will be omitted, etc. OPTIMIZE_OUTPUT_FOR_C = NO # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java # sources only. Doxygen will then generate output that is more tailored for # Java. For instance, namespaces will be presented as packages, qualified # scopes will look different, etc. OPTIMIZE_OUTPUT_JAVA = NO # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran # sources only. Doxygen will then generate output that is more tailored for # Fortran. OPTIMIZE_FOR_FORTRAN = NO # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL # sources. Doxygen will then generate output that is tailored for # VHDL. OPTIMIZE_OUTPUT_VHDL = NO # Doxygen selects the parser to use depending on the extension of the files it parses. # With this tag you can assign which parser to use for a given extension. # Doxygen has a built-in mapping, but you can override or extend it using this tag. # The format is ext=language, where ext is a file extension, and language is one of # the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP, # Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat # .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran), # use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. EXTENSION_MAPPING = # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want # to include (a tag file for) the STL sources as input, then you should # set this tag to YES in order to let doxygen match functions declarations and # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. # func(std::string) {}). This also make the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. BUILTIN_STL_SUPPORT = YES # If you use Microsoft's C++/CLI language, you should set this option to YES to # enable parsing support. CPP_CLI_SUPPORT = NO # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. # Doxygen will parse them like normal C++ but will assume all classes use public # instead of private inheritance when no explicit protection keyword is present. SIP_SUPPORT = NO # For Microsoft's IDL there are propget and propput attributes to indicate getter # and setter methods for a property. Setting this option to YES (the default) # will make doxygen to replace the get and set methods by a property in the # documentation. This will only work if the methods are indeed getting or # setting a simple type. If this is not the case, or you want to show the # methods anyway, you should set this option to NO. IDL_PROPERTY_SUPPORT = YES # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC # tag is set to YES, then doxygen will reuse the documentation of the first # member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. DISTRIBUTE_GROUP_DOC = NO # Set the SUBGROUPING tag to YES (the default) to allow class member groups of # the same type (for instance a group of public functions) to be put as a # subgroup of that type (e.g. under the Public Functions section). Set it to # NO to prevent subgrouping. Alternatively, this can be done per class using # the \nosubgrouping command. SUBGROUPING = YES # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum # is documented as struct, union, or enum with the name of the typedef. So # typedef struct TypeS {} TypeT, will appear in the documentation as a struct # with name TypeT. When disabled the typedef will appear as a member of a file, # namespace, or class. And the struct will be named TypeS. This can typically # be useful for C code in case the coding convention dictates that all compound # types are typedef'ed and only the typedef is referenced, never the tag name. TYPEDEF_HIDES_STRUCT = NO # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to # determine which symbols to keep in memory and which to flush to disk. # When the cache is full, less often used symbols will be written to disk. # For small to medium size projects (<1000 input files) the default value is # probably good enough. For larger projects a too small cache size can cause # doxygen to be busy swapping symbols to and from disk most of the time # causing a significant performance penality. # If the system has enough physical memory increasing the cache will improve the # performance by keeping more symbols in memory. Note that the value works on # a logarithmic scale so increasing the size by one will rougly double the # memory usage. The cache size is given by this formula: # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, # corresponding to a cache size of 2^16 = 65536 symbols #SYMBOL_CACHE_SIZE = 0 #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in # documentation are documented, even if no documentation was available. # Private class members and static file members will be hidden unless # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES EXTRACT_ALL = NO # If the EXTRACT_PRIVATE tag is set to YES all private members of a class # will be included in the documentation. EXTRACT_PRIVATE = YES # If the EXTRACT_STATIC tag is set to YES all static members of a file # will be included in the documentation. EXTRACT_STATIC = YES # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) # defined locally in source files will be included in the documentation. # If set to NO only classes defined in header files are included. EXTRACT_LOCAL_CLASSES = NO # This flag is only useful for Objective-C code. When set to YES local # methods, which are defined in the implementation section but not in # the interface are included in the documentation. # If set to NO (the default) only methods in the interface are included. EXTRACT_LOCAL_METHODS = NO # If this flag is set to YES, the members of anonymous namespaces will be # extracted and appear in the documentation as a namespace called # 'anonymous_namespace{file}', where file will be replaced with the base # name of the file that contains the anonymous namespace. By default # anonymous namespace are hidden. EXTRACT_ANON_NSPACES = NO # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all # undocumented members of documented classes, files or namespaces. # If set to NO (the default) these members will be included in the # various overviews, but no documentation section is generated. # This option has no effect if EXTRACT_ALL is enabled. HIDE_UNDOC_MEMBERS = NO # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. # If set to NO (the default) these classes will be included in the various # overviews. This option has no effect if EXTRACT_ALL is enabled. HIDE_UNDOC_CLASSES = NO # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all # friend (class|struct|union) declarations. # If set to NO (the default) these declarations will be included in the # documentation. HIDE_FRIEND_COMPOUNDS = NO # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any # documentation blocks found inside the body of a function. # If set to NO (the default) these blocks will be appended to the # function's detailed documentation block. HIDE_IN_BODY_DOCS = NO # The INTERNAL_DOCS tag determines if documentation # that is typed after a \internal command is included. If the tag is set # to NO (the default) then the documentation will be excluded. # Set it to YES to include the internal documentation. INTERNAL_DOCS = YES # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate # file names in lower-case letters. If set to YES upper-case letters are also # allowed. This is useful if you have classes or files whose names only differ # in case and if your file system supports case sensitive file names. Windows # and Mac users are advised to set this option to NO. CASE_SENSE_NAMES = NO # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen # will show members with their full class and namespace scopes in the # documentation. If set to YES the scope will be hidden. HIDE_SCOPE_NAMES = NO # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen # will put a list of the files that are included by a file in the documentation # of that file. SHOW_INCLUDE_FILES = YES # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] # is inserted in the documentation for inline members. INLINE_INFO = YES # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen # will sort the (detailed) documentation of file and class members # alphabetically by member name. If set to NO the members will appear in # declaration order. SORT_MEMBER_DOCS = YES # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the # brief documentation of file, namespace and class members alphabetically # by member name. If set to NO (the default) the members will appear in # declaration order. SORT_BRIEF_DOCS = NO # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. SORT_MEMBERS_CTORS_1ST = YES # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the # hierarchy of group names into alphabetical order. If set to NO (the default) # the group names will appear in their defined order. SORT_GROUP_NAMES = NO # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be # sorted by fully-qualified names, including namespaces. If set to # NO (the default), the class list will be sorted only by class name, # not including the namespace part. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. # Note: This option applies only to the class list, not to the # alphabetical list. SORT_BY_SCOPE_NAME = NO # The GENERATE_TODOLIST tag can be used to enable (YES) or # disable (NO) the todo list. This list is created by putting \todo # commands in the documentation. GENERATE_TODOLIST = YES # The GENERATE_TESTLIST tag can be used to enable (YES) or # disable (NO) the test list. This list is created by putting \test # commands in the documentation. GENERATE_TESTLIST = YES # The GENERATE_BUGLIST tag can be used to enable (YES) or # disable (NO) the bug list. This list is created by putting \bug # commands in the documentation. GENERATE_BUGLIST = YES # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or # disable (NO) the deprecated list. This list is created by putting # \deprecated commands in the documentation. GENERATE_DEPRECATEDLIST= YES # The ENABLED_SECTIONS tag can be used to enable conditional # documentation sections, marked by \if sectionname ... \endif. ENABLED_SECTIONS = ALLJOYN_DEV # The MAX_INITIALIZER_LINES tag determines the maximum number of lines # the initial value of a variable or define consists of for it to appear in # the documentation. If the initializer consists of more lines than specified # here it will be hidden. Use a value of 0 to hide initializers completely. # The appearance of the initializer of individual variables and defines in the # documentation can be controlled using \showinitializer or \hideinitializer # command in the documentation regardless of this setting. MAX_INITIALIZER_LINES = 30 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated # at the bottom of the documentation of classes and structs. If set to YES the # list will mention the files that were used to generate the documentation. SHOW_USED_FILES = YES # If the sources in your project are distributed over multiple directories # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy # in the documentation. The default is NO. #SHOW_DIRECTORIES = NO # Set the SHOW_FILES tag to NO to disable the generation of the Files page. # This will remove the Files entry from the Quick Index and from the # Folder Tree View (if specified). The default is YES. SHOW_FILES = YES # Set the SHOW_NAMESPACES tag to NO to disable the generation of the # Namespaces page. # This will remove the Namespaces entry from the Quick Index # and from the Folder Tree View (if specified). The default is YES. SHOW_NAMESPACES = YES # The FILE_VERSION_FILTER tag can be used to specify a program or script that # doxygen should invoke to get the current version for each file (typically from # the version control system). Doxygen will invoke the program by executing (via # popen()) the command , where is the value of # the FILE_VERSION_FILTER tag, and is the name of an input file # provided by doxygen. Whatever the program writes to standard output # is used as the file version. See the manual for examples. FILE_VERSION_FILTER = # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by # doxygen. The layout file controls the global structure of the generated output files # in an output format independent way. The create the layout file that represents # doxygen's defaults, run doxygen with the -l option. You can optionally specify a # file name after the option, if omitted DoxygenLayout.xml will be used as the name # of the layout file. LAYOUT_FILE = #--------------------------------------------------------------------------- # configuration options related to warning and progress messages #--------------------------------------------------------------------------- # The QUIET tag can be used to turn on/off the messages that are generated # by doxygen. Possible values are YES and NO. If left blank NO is used. QUIET = YES # The WARNINGS tag can be used to turn on/off the warning messages that are # generated by doxygen. Possible values are YES and NO. If left blank # NO is used. WARNINGS = YES # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings # for undocumented members. If EXTRACT_ALL is set to YES then this flag will # automatically be disabled. WARN_IF_UNDOCUMENTED = YES # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for # potential errors in the documentation, such as not documenting some # parameters in a documented function, or documenting parameters that # don't exist or using markup commands wrongly. WARN_IF_DOC_ERROR = YES # This WARN_NO_PARAMDOC option can be abled to get warnings for # functions that are documented, but have no documentation for their parameters # or return value. If set to NO (the default) doxygen will only warn about # wrong or incomplete parameter documentation, but not about the absence of # documentation. WARN_NO_PARAMDOC = YES # The WARN_FORMAT tag determines the format of the warning messages that # doxygen can produce. The string should contain the $file, $line, and $text # tags, which will be replaced by the file and line number from which the # warning originated and the warning text. Optionally the format may contain # $version, which will be replaced by the version of the file (if it could # be obtained via FILE_VERSION_FILTER) WARN_FORMAT = "$file:$line: $text" # The WARN_LOGFILE tag can be used to specify a file to which warning # and error messages should be written. If left blank the output is written # to stderr. WARN_LOGFILE = #--------------------------------------------------------------------------- # configuration options related to the input files #--------------------------------------------------------------------------- # The INPUT tag can be used to specify the files and/or directories that contain # documented source files. You may enter file names like "myfile.cpp" or # directories like "/usr/src/myproject". Separate the files or directories # with spaces. INPUT = $(CPP_DISTDIR)/inc/alljoyn/Status.h \ ../inc/alljoyn/ \ allJoynDocumentation \ ../src/ \ ../router/ \ ../../common/inc/qcc/ \ ../../common/os/ \ ../../services/about/cpp/inc/alljoyn/ # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is # also the default input encoding. Doxygen uses libiconv (or the iconv built # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for # the list of possible encodings. INPUT_ENCODING = UTF-8 # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp # and *.h) to filter out the source-files in the directories. If left # blank the following patterns are tested: # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 # currently we expect all the documentation to be limited to header files. FILE_PATTERNS = *.h # The RECURSIVE tag can be used to turn specify whether or not subdirectories # should be searched for input files as well. Possible values are YES and NO. # If left blank NO is used. RECURSIVE = YES # The EXCLUDE tag can be used to specify files and/or directories that should # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. EXCLUDE = # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded # from the input. EXCLUDE_SYMLINKS = NO # If the value of the INPUT tag contains directories, you can use the # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude # certain files from those directories. Note that the wildcards are matched # against the file with absolute path, so to exclude all test directories # for example use the pattern */test/* EXCLUDE_PATTERNS = # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the # output. The symbol name can be a fully qualified name, a word, or if the # wildcard * is used, a substring. Examples: ANamespace, AClass, # AClass::ANamespace, ANamespace::*Test EXCLUDE_SYMBOLS = # The EXAMPLE_PATH tag can be used to specify one or more files or # directories that contain example code fragments that are included (see # the \include command). EXAMPLE_PATH = # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp # and *.h) to filter out the source-files in the directories. If left # blank all files are included. EXAMPLE_PATTERNS = # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be # searched for input files to be used with the \include or \dontinclude # commands irrespective of the value of the RECURSIVE tag. # Possible values are YES and NO. If left blank NO is used. EXAMPLE_RECURSIVE = NO # The IMAGE_PATH tag can be used to specify one or more files or # directories that contain image that are included in the documentation (see # the \image command). IMAGE_PATH = # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program # by executing (via popen()) the command , where # is the value of the INPUT_FILTER tag, and is the name of an # input file. Doxygen will then use the output that the filter program writes # to standard output. # If FILTER_PATTERNS is specified, this tag will be # ignored. INPUT_FILTER = # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern # basis. # Doxygen will compare the file name with each pattern and apply the # filter if there is a match. # The filters are a list of the form: # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER # is applied to all files. FILTER_PATTERNS = # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using # INPUT_FILTER) will be used to filter the input files when producing source # files to browse (i.e. when SOURCE_BROWSER is set to YES). FILTER_SOURCE_FILES = NO #--------------------------------------------------------------------------- # configuration options related to source browsing #--------------------------------------------------------------------------- # If the SOURCE_BROWSER tag is set to YES then a list of source files will # be generated. Documented entities will be cross-referenced with these sources. # Note: To get rid of all source code in the generated output, make sure also # VERBATIM_HEADERS is set to NO. SOURCE_BROWSER = NO # Setting the INLINE_SOURCES tag to YES will include the body # of functions and classes directly in the documentation. INLINE_SOURCES = NO # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct # doxygen to hide any special comment blocks from generated source code # fragments. Normal C and C++ comments will always remain visible. STRIP_CODE_COMMENTS = YES # If the REFERENCED_BY_RELATION tag is set to YES # then for each documented function all documented # functions referencing it will be listed. REFERENCED_BY_RELATION = NO # If the REFERENCES_RELATION tag is set to YES # then for each documented function all documented entities # called/used by that function will be listed. REFERENCES_RELATION = NO # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will # link to the source code. # Otherwise they will link to the documentation. REFERENCES_LINK_SOURCE = YES # If the USE_HTAGS tag is set to YES then the references to source code # will point to the HTML generated by the htags(1) tool instead of doxygen # built-in source browser. The htags tool is part of GNU's global source # tagging system (see http://www.gnu.org/software/global/global.html). You # will need version 4.8.6 or higher. USE_HTAGS = NO # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen # will generate a verbatim copy of the header file for each class for # which an include is specified. Set to NO to disable this. VERBATIM_HEADERS = YES #--------------------------------------------------------------------------- # configuration options related to the alphabetical class index #--------------------------------------------------------------------------- # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index # of all compounds will be generated. Enable this if the project # contains a lot of classes, structs, unions or interfaces. ALPHABETICAL_INDEX = NO # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns # in which this list will be split (can be a number in the range [1..20]) COLS_IN_ALPHA_INDEX = 5 # In case all classes in a project start with a common prefix, all # classes will be put under the same header in the alphabetical index. # The IGNORE_PREFIX tag can be used to specify one or more prefixes that # should be ignored while generating the index headers. IGNORE_PREFIX = #--------------------------------------------------------------------------- # configuration options related to the HTML output #--------------------------------------------------------------------------- # If the GENERATE_HTML tag is set to YES (the default) Doxygen will # generate HTML output. GENERATE_HTML = YES # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `html' will be used as the default path. HTML_OUTPUT = html_dev # The HTML_FILE_EXTENSION tag can be used to specify the file extension for # each generated HTML page (for example: .htm,.php,.asp). If it is left blank # doxygen will generate files with .html extension. HTML_FILE_EXTENSION = .html # The HTML_HEADER tag can be used to specify a personal HTML header for # each generated HTML page. If it is left blank doxygen will generate a # standard header. HTML_HEADER = # The HTML_FOOTER tag can be used to specify a personal HTML footer for # each generated HTML page. If it is left blank doxygen will generate a # standard footer. HTML_FOOTER = footer.html # The HTML_STYLESHEET tag can be used to specify a user-defined cascading # style sheet that is used by each HTML page. It can be used to # fine-tune the look of the HTML output. If the tag is left blank doxygen # will generate a default style sheet. Note that doxygen will try to copy # the style sheet file to the HTML output directory, so don't put your own # stylesheet in the HTML output directory as well, or it will be erased! HTML_STYLESHEET = # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, # files or namespaces will be aligned in HTML using tables. If set to # NO a bullet list will be used. #HTML_ALIGN_MEMBERS = YES # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # documentation will contain sections that can be hidden and shown after the # page has loaded. For this to work a browser that supports # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). HTML_DYNAMIC_SECTIONS = NO # If the GENERATE_DOCSET tag is set to YES, additional index files # will be generated that can be used as input for Apple's Xcode 3 # integrated development environment, introduced with OSX 10.5 (Leopard). # To create a documentation set, doxygen will generate a Makefile in the # HTML output directory. Running make will produce the docset in that # directory and running "make install" will install the docset in # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find # it at startup. # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information. GENERATE_DOCSET = NO # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the # feed. A documentation feed provides an umbrella under which multiple # documentation sets from a single provider (such as a company or product suite) # can be grouped. DOCSET_FEEDNAME = "Doxygen generated docs" # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that # should uniquely identify the documentation set bundle. This should be a # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen # will append .docset to the name. DOCSET_BUNDLE_ID = org.doxygen.Project # If the GENERATE_HTMLHELP tag is set to YES, additional index files # will be generated that can be used as input for tools like the # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) # of the generated HTML documentation. GENERATE_HTMLHELP = NO # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can # be used to specify the file name of the resulting .chm file. You # can add a path in front of the file if the result should not be # written to the html output directory. CHM_FILE = # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can # be used to specify the location (absolute path including file name) of # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run # the HTML help compiler on the generated index.hhp. HHC_LOCATION = # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag # controls if a separate .chi index file is generated (YES) or that # it should be included in the master .chm file (NO). GENERATE_CHI = NO # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING # is used to encode HtmlHelp index (hhk), content (hhc) and project file # content. CHM_INDEX_ENCODING = # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag # controls whether a binary table of contents is generated (YES) or a # normal table of contents (NO) in the .chm file. BINARY_TOC = NO # The TOC_EXPAND flag can be set to YES to add extra items for group members # to the contents of the HTML help documentation and to the tree view. TOC_EXPAND = NO # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER # are set, an additional index file will be generated that can be used as input for # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated # HTML documentation. GENERATE_QHP = NO # If the QHG_LOCATION tag is specified, the QCH_FILE tag can # be used to specify the file name of the resulting .qch file. # The path specified is relative to the HTML output folder. QCH_FILE = # The QHP_NAMESPACE tag specifies the namespace to use when generating # Qt Help Project output. For more information please see # http://doc.trolltech.com/qthelpproject.html#namespace QHP_NAMESPACE = # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating # Qt Help Project output. For more information please see # http://doc.trolltech.com/qthelpproject.html#virtual-folders QHP_VIRTUAL_FOLDER = doc # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. # For more information please see # http://doc.trolltech.com/qthelpproject.html#custom-filters QHP_CUST_FILTER_NAME = # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see # Qt Help Project / Custom Filters. QHP_CUST_FILTER_ATTRS = # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's # filter section matches. # Qt Help Project / Filter Attributes. QHP_SECT_FILTER_ATTRS = # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can # be used to specify the location of Qt's qhelpgenerator. # If non-empty doxygen will try to run qhelpgenerator on the generated # .qhp file. QHG_LOCATION = # The DISABLE_INDEX tag can be used to turn on/off the condensed index at # top of each HTML page. The value NO (the default) enables the index and # the value YES disables it. DISABLE_INDEX = NO # This tag can be used to set the number of enum values (range [1..20]) # that doxygen will group on one line in the generated HTML documentation. ENUM_VALUES_PER_LINE = 4 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index # structure should be generated to display hierarchical information. # If the tag value is set to YES, a side panel will be generated # containing a tree-like index structure (just like the one that # is generated for HTML Help). For this to work a browser that supports # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). # Windows users are probably better off using the HTML help feature. GENERATE_TREEVIEW = YES # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, # and Class Hierarchy pages using a tree view instead of an ordered list. #USE_INLINE_TREES = YES # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be # used to set the initial width (in pixels) of the frame in which the tree # is shown. TREEVIEW_WIDTH = 250 # Use this tag to change the font size of Latex formulas included # as images in the HTML documentation. The default is 10. Note that # when you change the font size after a successful doxygen run you need # to manually remove any form_*.png images from the HTML output directory # to force them to be regenerated. FORMULA_FONTSIZE = 10 # When the SEARCHENGINE tag is enable doxygen will generate a search box for the HTML output. The underlying search engine uses javascript # and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP) or Qt help (GENERATE_QHP) # there is already a search function so this one should typically # be disabled. SEARCHENGINE = YES #--------------------------------------------------------------------------- # configuration options related to the LaTeX output #--------------------------------------------------------------------------- # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will # generate Latex output. GENERATE_LATEX = NO # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `latex' will be used as the default path. LATEX_OUTPUT = latex # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be # invoked. If left blank `latex' will be used as the default command name. LATEX_CMD_NAME = latex # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to # generate index for LaTeX. If left blank `makeindex' will be used as the # default command name. MAKEINDEX_CMD_NAME = makeindex # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact # LaTeX documents. This may be useful for small projects and may help to # save some trees in general. COMPACT_LATEX = NO # The PAPER_TYPE tag can be used to set the paper type that is used # by the printer. Possible values are: a4, a4wide, letter, legal and # executive. If left blank a4wide will be used. PAPER_TYPE = a4wide # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX # packages that should be included in the LaTeX output. EXTRA_PACKAGES = # The LATEX_HEADER tag can be used to specify a personal LaTeX header for # the generated latex document. The header should contain everything until # the first chapter. If it is left blank doxygen will generate a # standard header. Notice: only use this tag if you know what you are doing! LATEX_HEADER = # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated # is prepared for conversion to pdf (using ps2pdf). The pdf file will # contain links (just like the HTML output) instead of page references # This makes the output suitable for online browsing using a pdf viewer. PDF_HYPERLINKS = YES # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of # plain latex in the generated Makefile. Set this option to YES to get a # higher quality PDF documentation. USE_PDFLATEX = YES # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. # command to the generated LaTeX files. This will instruct LaTeX to keep # running if errors occur, instead of asking the user for help. # This option is also used when generating formulas in HTML. LATEX_BATCHMODE = NO # If LATEX_HIDE_INDICES is set to YES then doxygen will not # include the index chapters (such as File Index, Compound Index, etc.) # in the output. LATEX_HIDE_INDICES = NO # If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER. LATEX_SOURCE_CODE = NO #--------------------------------------------------------------------------- # configuration options related to the RTF output #--------------------------------------------------------------------------- # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output # The RTF output is optimized for Word 97 and may not look very pretty with # other RTF readers or editors. GENERATE_RTF = NO # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `rtf' will be used as the default path. RTF_OUTPUT = rtf # If the COMPACT_RTF tag is set to YES Doxygen generates more compact # RTF documents. This may be useful for small projects and may help to # save some trees in general. COMPACT_RTF = NO # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated # will contain hyperlink fields. The RTF file will # contain links (just like the HTML output) instead of page references. # This makes the output suitable for online browsing using WORD or other # programs which support those fields. # Note: wordpad (write) and others do not support links. RTF_HYPERLINKS = NO # Load stylesheet definitions from file. Syntax is similar to doxygen's # config file, i.e. a series of assignments. You only have to provide # replacements, missing definitions are set to their default value. RTF_STYLESHEET_FILE = # Set optional variables used in the generation of an rtf document. # Syntax is similar to doxygen's config file. RTF_EXTENSIONS_FILE = #--------------------------------------------------------------------------- # configuration options related to the man page output #--------------------------------------------------------------------------- # If the GENERATE_MAN tag is set to YES (the default) Doxygen will # generate man pages GENERATE_MAN = NO # The MAN_OUTPUT tag is used to specify where the man pages will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `man' will be used as the default path. MAN_OUTPUT = man # The MAN_EXTENSION tag determines the extension that is added to # the generated man pages (default is the subroutine's section .3) MAN_EXTENSION = .3 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, # then it will generate one additional man file for each entity # documented in the real man page(s). These additional files # only source the real man page, but without them the man command # would be unable to find the correct page. The default is NO. MAN_LINKS = NO #--------------------------------------------------------------------------- # configuration options related to the XML output #--------------------------------------------------------------------------- # If the GENERATE_XML tag is set to YES Doxygen will # generate an XML file that captures the structure of # the code including all documentation. GENERATE_XML = NO # The XML_OUTPUT tag is used to specify where the XML pages will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `xml' will be used as the default path. XML_OUTPUT = xml # The XML_SCHEMA tag can be used to specify an XML schema, # which can be used by a validating XML parser to check the # syntax of the XML files. XML_SCHEMA = # The XML_DTD tag can be used to specify an XML DTD, # which can be used by a validating XML parser to check the # syntax of the XML files. XML_DTD = # If the XML_PROGRAMLISTING tag is set to YES Doxygen will # dump the program listings (including syntax highlighting # and cross-referencing information) to the XML output. Note that # enabling this will significantly increase the size of the XML output. XML_PROGRAMLISTING = YES #--------------------------------------------------------------------------- # configuration options for the AutoGen Definitions output #--------------------------------------------------------------------------- # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will # generate an AutoGen Definitions (see autogen.sf.net) file # that captures the structure of the code including all # documentation. Note that this feature is still experimental # and incomplete at the moment. GENERATE_AUTOGEN_DEF = NO #--------------------------------------------------------------------------- # configuration options related to the Perl module output #--------------------------------------------------------------------------- # If the GENERATE_PERLMOD tag is set to YES Doxygen will # generate a Perl module file that captures the structure of # the code including all documentation. Note that this # feature is still experimental and incomplete at the # moment. GENERATE_PERLMOD = NO # If the PERLMOD_LATEX tag is set to YES Doxygen will generate # the necessary Makefile rules, Perl scripts and LaTeX code to be able # to generate PDF and DVI output from the Perl module output. PERLMOD_LATEX = NO # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be # nicely formatted so it can be parsed by a human reader. # This is useful # if you want to understand what is going on. # On the other hand, if this # tag is set to NO the size of the Perl module output will be much smaller # and Perl will parse it just the same. PERLMOD_PRETTY = YES # The names of the make variables in the generated doxyrules.make file # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. # This is useful so different doxyrules.make files included by the same # Makefile don't overwrite each other's variables. PERLMOD_MAKEVAR_PREFIX = #--------------------------------------------------------------------------- # Configuration options related to the preprocessor #--------------------------------------------------------------------------- # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will # evaluate all C-preprocessor directives found in the sources and include # files. ENABLE_PREPROCESSING = YES # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro # names in the source code. If set to NO (the default) only conditional # compilation will be performed. Macro expansion can be done in a controlled # way by setting EXPAND_ONLY_PREDEF to YES. MACRO_EXPANSION = YES # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES # then the macro expansion is limited to the macros specified with the # PREDEFINED and EXPAND_AS_DEFINED tags. EXPAND_ONLY_PREDEF = YES # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files # in the INCLUDE_PATH (see below) will be search if a #include is found. SEARCH_INCLUDES = YES # The INCLUDE_PATH tag can be used to specify one or more directories that # contain include files that are not input files but should be processed by # the preprocessor. INCLUDE_PATH = # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard # patterns (like *.h and *.hpp) to filter out the header-files in the # directories. If left blank, the patterns specified with FILE_PATTERNS will # be used. INCLUDE_FILE_PATTERNS = # The PREDEFINED tag can be used to specify one or more macro names that # are defined before the preprocessor is started (similar to the -D option of # gcc). The argument of the tag is a list of macros of the form: name # or name=definition (no spaces). If the definition and the = are # omitted =1 is assumed. To prevent a macro definition from being # undefined via #undef or recursively expanded use the := operator # instead of the = operator. PREDEFINED = "QCC_DEPRECATED(func)=func" # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then # this tag can be used to specify a list of macro names that should be expanded. # The macro definition that is found in the sources will be used. # Use the PREDEFINED tag if you want to use a different macro definition. EXPAND_AS_DEFINED = # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then # doxygen's preprocessor will remove all function-like macros that are alone # on a line, have an all uppercase name, and do not end with a semicolon. Such # function macros are typically used for boiler-plate code, and will confuse # the parser if not removed. SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- # Configuration::additions related to external references #--------------------------------------------------------------------------- # The TAGFILES option can be used to specify one or more tagfiles. # Optionally an initial location of the external documentation # can be added for each tagfile. The format of a tag file without # this location is as follows: # # TAGFILES = file1 file2 ... # Adding location for the tag files is done as follows: # # TAGFILES = file1=loc1 "file2 = loc2" ... # where "loc1" and "loc2" can be relative or absolute paths or # URLs. If a location is present for each tag, the installdox tool # does not have to be run to correct the links. # Note that each tag file must have a unique name # (where the name does NOT include the path) # If a tag file is not located in the directory in which doxygen # is run, you must also specify the path to the tagfile here. TAGFILES = # When a file name is specified after GENERATE_TAGFILE, doxygen will create # a tag file that is based on the input files it reads. GENERATE_TAGFILE = # If the ALLEXTERNALS tag is set to YES all external classes will be listed # in the class index. If set to NO only the inherited external classes # will be listed. ALLEXTERNALS = NO # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed # in the modules index. If set to NO, only the current project's groups will # be listed. EXTERNAL_GROUPS = YES # The PERL_PATH should be the absolute path and name of the perl script # interpreter (i.e. the result of `which perl'). PERL_PATH = /usr/bin/perl #--------------------------------------------------------------------------- # Configuration options related to the dot tool #--------------------------------------------------------------------------- # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base # or super classes. Setting the tag to NO turns the diagrams off. Note that # this option is superseded by the HAVE_DOT option below. This is only a # fallback. It is recommended to install and use dot, since it yields more # powerful graphs. CLASS_DIAGRAMS = YES # You can define message sequence charts within doxygen comments using the \msc # command. Doxygen will then run the mscgen tool (see # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the # documentation. The MSCGEN_PATH tag allows you to specify the directory where # the mscgen tool resides. If left empty the tool is assumed to be found in the # default search path. MSCGEN_PATH = # If set to YES, the inheritance and collaboration graphs will hide # inheritance and usage relations if the target is undocumented # or is not a class. HIDE_UNDOC_RELATIONS = YES # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is # available from the path. This tool is part of Graphviz, a graph visualization # toolkit from AT&T and Lucent Bell Labs. The other options in this section # have no effect if this option is set to NO (the default) HAVE_DOT = YES # By default doxygen will write a font called FreeSans.ttf to the output # directory and reference it in all dot files that doxygen generates. This # font does not include all possible unicode characters however, so when you need # these (or just want a differently looking font) you can specify the font name # using DOT_FONTNAME. You need need to make sure dot is able to find the font, # which can be done by putting it in a standard location or by setting the # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory # containing the font. #DOT_FONTNAME = FreeSans # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. # The default size is 10pt. DOT_FONTSIZE = 10 # By default doxygen will tell dot to use the output directory to look for the # FreeSans.ttf font (which doxygen will put there itself). If you specify a # different font using DOT_FONTNAME you can set the path where dot # can find it using this tag. DOT_FONTPATH = # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen # will generate a graph for each documented class showing the direct and # indirect inheritance relations. Setting this tag to YES will force the # the CLASS_DIAGRAMS tag to NO. CLASS_GRAPH = YES # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen # will generate a graph for each documented class showing the direct and # indirect implementation dependencies (inheritance, containment, and # class references variables) of the class with other documented classes. COLLABORATION_GRAPH = YES # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen # will generate a graph for groups, showing the direct groups dependencies GROUP_GRAPHS = YES # If the UML_LOOK tag is set to YES doxygen will generate inheritance and # collaboration diagrams in a style similar to the OMG's Unified Modeling # Language. UML_LOOK = NO # If set to YES, the inheritance and collaboration graphs will show the # relations between templates and their instances. TEMPLATE_RELATIONS = NO # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT # tags are set to YES then doxygen will generate a graph for each documented # file showing the direct and indirect include dependencies of the file with # other documented files. INCLUDE_GRAPH = YES # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and # HAVE_DOT tags are set to YES then doxygen will generate a graph for each # documented header file showing the documented files that directly or # indirectly include this file. INCLUDED_BY_GRAPH = YES # If the CALL_GRAPH and HAVE_DOT options are set to YES then # doxygen will generate a call dependency graph for every global function # or class method. Note that enabling this option will significantly increase # the time of a run. So in most cases it will be better to enable call graphs # for selected functions only using the \callgraph command. CALL_GRAPH = NO # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then # doxygen will generate a caller dependency graph for every global function # or class method. Note that enabling this option will significantly increase # the time of a run. So in most cases it will be better to enable caller # graphs for selected functions only using the \callergraph command. CALLER_GRAPH = NO # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen # will graphical hierarchy of all classes instead of a textual one. GRAPHICAL_HIERARCHY = YES # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES # then doxygen will show the dependencies a directory has on other directories # in a graphical way. The dependency relations are determined by the #include # relations between the files in the directories. DIRECTORY_GRAPH = YES # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images # generated by dot. Possible values are png, jpg, or gif # If left blank png will be used. DOT_IMAGE_FORMAT = png # The tag DOT_PATH can be used to specify the path where the dot tool can be # found. If left blank, it is assumed the dot tool can be found in the path. DOT_PATH = # The DOTFILE_DIRS tag can be used to specify one or more directories that # contain dot files that are included in the documentation (see the # \dotfile command). DOTFILE_DIRS = # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of # nodes that will be shown in the graph. If the number of nodes in a graph # becomes larger than this value, doxygen will truncate the graph, which is # visualized by representing a node as a red box. Note that doxygen if the # number of direct children of the root node in a graph is already larger than # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. DOT_GRAPH_MAX_NODES = 50 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the # graphs generated by dot. A depth value of 3 means that only nodes reachable # from the root by following a path via at most 3 edges will be shown. Nodes # that lay further from the root node will be omitted. Note that setting this # option to 1 or 2 may greatly reduce the computation time needed for large # code bases. Also note that the size of a graph can be further restricted by # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. MAX_DOT_GRAPH_DEPTH = 3 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent # background. This is disabled by default, because dot on Windows does not # seem to support this out of the box. Warning: Depending on the platform used, # enabling this option may lead to badly anti-aliased labels on the edges of # a graph (i.e. they become hard to read). DOT_TRANSPARENT = NO # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output # files in one run (i.e. multiple -o and -T options on the command line). This # makes dot run faster, but since only newer versions of dot (>1.8.10) # support this, this feature is disabled by default. DOT_MULTI_TARGETS = YES # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will # generate a legend page explaining the meaning of the various boxes and # arrows in the dot generated graphs. GENERATE_LEGEND = YES # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will # remove the intermediate dot files that are used to generate # the various graphs. DOT_CLEANUP = YES alljoyn-15.04b/alljoyn_core/docs/Doxygen_html000066400000000000000000001741761255700255500213570ustar00rootroot00000000000000# Doxyfile 1.6.1 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project # # All text after a hash (#) is considered a comment and will be ignored # The format is: # TAG = value [value, ...] # For lists items can also be appended using: # TAG += value [value, ...] # Values that contain spaces should be placed between quotes (" ") #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- # This tag specifies the encoding used for all characters in the config file # that follow. The default is UTF-8 which is also the encoding used for all # text before the first occurrence of this tag. Doxygen uses libiconv (or the # iconv built into libc) for the transcoding. See # http://www.gnu.org/software/libiconv for the list of possible encodings. DOXYFILE_ENCODING = UTF-8 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded # by quotes) that should identify the project. PROJECT_NAME = "AllJoyn™ C++ API Reference Manual" # The PROJECT_NUMBER tag can be used to enter a project or revision number. # This could be handy for archiving the generated documentation or # if some version control system is used. PROJECT_NUMBER = "Version 15.04.00b" # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) # base path where the generated documentation will be put. # If a relative path is entered, it will be relative to the location # where doxygen was started. If left blank the current directory will be used. OUTPUT_DIRECTORY = $(CPP_DISTDIR)/docs # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create # 4096 sub-directories (in 2 levels) under the output directory of each output # format and will distribute the generated files over these directories. # Enabling this option can be useful when feeding doxygen a huge amount of # source files, where putting all generated files in the same directory would # otherwise cause performance problems for the file system. CREATE_SUBDIRS = NO # The OUTPUT_LANGUAGE tag is used to specify the language in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all constant output in the proper language. # The default language is English, other supported languages are: # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. OUTPUT_LANGUAGE = English # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will # include brief member descriptions after the members that are listed in # the file and class documentation (similar to JavaDoc). # Set to NO to disable this. BRIEF_MEMBER_DESC = YES # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend # the brief description of a member or function before the detailed description. # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. REPEAT_BRIEF = YES # This tag implements a quasi-intelligent brief description abbreviator # that is used to form the text in various listings. Each string # in this list, if found as the leading text of the brief description, will be # stripped from the text and the result after processing the whole list, is # used as the annotated text. Otherwise, the brief description is used as-is. # If left blank, the following values are used ("$name" is automatically # replaced with the name of the entity): "The $name class" "The $name widget" # "The $name file" "is" "provides" "specifies" "contains" # "represents" "a" "an" "the" ABBREVIATE_BRIEF = # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then # Doxygen will generate a detailed section even if there is only a brief # description. ALWAYS_DETAILED_SEC = NO # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all # inherited members of a class in the documentation of that class as if those # members were ordinary class members. Constructors, destructors and assignment # operators of the base classes will not be shown. INLINE_INHERITED_MEMB = NO # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full # path before files name in the file list and in the header files. If set # to NO the shortest path that makes the file name unique will be used. FULL_PATH_NAMES = NO # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag # can be used to strip a user-defined part of the path. Stripping is # only done if one of the specified strings matches the left-hand part of # the path. The tag can be used to show relative paths in the file list. # If left blank the directory from which doxygen is run is used as the # path to strip. STRIP_FROM_PATH = # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of # the path mentioned in the documentation of a class, which tells # the reader which header file to include in order to use a class. # If left blank only the name of the header file containing the class # definition is used. Otherwise one should specify the include paths that # are normally passed to the compiler using the -I flag. STRIP_FROM_INC_PATH = # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter # (but less readable) file names. This can be useful is your file systems # doesn't support long names like on DOS, Mac, or CD-ROM. SHORT_NAMES = NO # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen # will interpret the first line (until the first dot) of a JavaDoc-style # comment as the brief description. If set to NO, the JavaDoc # comments will behave just like regular Qt-style comments # (thus requiring an explicit @brief command for a brief description.) JAVADOC_AUTOBRIEF = YES # If the QT_AUTOBRIEF tag is set to YES then Doxygen will # interpret the first line (until the first dot) of a Qt-style # comment as the brief description. If set to NO, the comments # will behave just like regular Qt-style comments (thus requiring # an explicit \brief command for a brief description.) QT_AUTOBRIEF = NO # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen # treat a multi-line C++ special comment block (i.e. a block of //! or /// # comments) as a brief description. This used to be the default behaviour. # The new default is to treat a multi-line C++ comment block as a detailed # description. Set this tag to YES if you prefer the old behaviour instead. MULTILINE_CPP_IS_BRIEF = NO # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented # member inherits the documentation from any documented member that it # re-implements. INHERIT_DOCS = YES # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce # a new page for each member. If set to NO, the documentation of a member will # be part of the file/class/namespace that contains it. SEPARATE_MEMBER_PAGES = NO # The TAB_SIZE tag can be used to set the number of spaces in a tab. # Doxygen uses this value to replace tabs by spaces in code fragments. TAB_SIZE = 4 # This tag can be used to specify a number of aliases that acts # as commands in the documentation. An alias has the form "name=value". # For example adding "sideeffect=\par Side Effects:\n" will allow you to # put the command \sideeffect (or @sideeffect) in the documentation, which # will result in a user-defined paragraph with heading "Side Effects:". # You can put \n's in the value part of an alias to insert newlines. ALIASES = # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C # sources only. Doxygen will then generate output that is more tailored for C. # For instance, some of the names that are used will be different. The list # of all members will be omitted, etc. OPTIMIZE_OUTPUT_FOR_C = NO # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java # sources only. Doxygen will then generate output that is more tailored for # Java. For instance, namespaces will be presented as packages, qualified # scopes will look different, etc. OPTIMIZE_OUTPUT_JAVA = NO # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran # sources only. Doxygen will then generate output that is more tailored for # Fortran. OPTIMIZE_FOR_FORTRAN = NO # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL # sources. Doxygen will then generate output that is tailored for # VHDL. OPTIMIZE_OUTPUT_VHDL = NO # Doxygen selects the parser to use depending on the extension of the files it parses. # With this tag you can assign which parser to use for a given extension. # Doxygen has a built-in mapping, but you can override or extend it using this tag. # The format is ext=language, where ext is a file extension, and language is one of # the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP, # Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat # .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran), # use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. EXTENSION_MAPPING = # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want # to include (a tag file for) the STL sources as input, then you should # set this tag to YES in order to let doxygen match functions declarations and # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. # func(std::string) {}). This also make the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. BUILTIN_STL_SUPPORT = YES # If you use Microsoft's C++/CLI language, you should set this option to YES to # enable parsing support. CPP_CLI_SUPPORT = NO # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. # Doxygen will parse them like normal C++ but will assume all classes use public # instead of private inheritance when no explicit protection keyword is present. SIP_SUPPORT = NO # For Microsoft's IDL there are propget and propput attributes to indicate getter # and setter methods for a property. Setting this option to YES (the default) # will make doxygen to replace the get and set methods by a property in the # documentation. This will only work if the methods are indeed getting or # setting a simple type. If this is not the case, or you want to show the # methods anyway, you should set this option to NO. IDL_PROPERTY_SUPPORT = YES # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC # tag is set to YES, then doxygen will reuse the documentation of the first # member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. DISTRIBUTE_GROUP_DOC = NO # Set the SUBGROUPING tag to YES (the default) to allow class member groups of # the same type (for instance a group of public functions) to be put as a # subgroup of that type (e.g. under the Public Functions section). Set it to # NO to prevent subgrouping. Alternatively, this can be done per class using # the \nosubgrouping command. SUBGROUPING = YES # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum # is documented as struct, union, or enum with the name of the typedef. So # typedef struct TypeS {} TypeT, will appear in the documentation as a struct # with name TypeT. When disabled the typedef will appear as a member of a file, # namespace, or class. And the struct will be named TypeS. This can typically # be useful for C code in case the coding convention dictates that all compound # types are typedef'ed and only the typedef is referenced, never the tag name. TYPEDEF_HIDES_STRUCT = NO # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to # determine which symbols to keep in memory and which to flush to disk. # When the cache is full, less often used symbols will be written to disk. # For small to medium size projects (<1000 input files) the default value is # probably good enough. For larger projects a too small cache size can cause # doxygen to be busy swapping symbols to and from disk most of the time # causing a significant performance penality. # If the system has enough physical memory increasing the cache will improve the # performance by keeping more symbols in memory. Note that the value works on # a logarithmic scale so increasing the size by one will rougly double the # memory usage. The cache size is given by this formula: # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, # corresponding to a cache size of 2^16 = 65536 symbols #SYMBOL_CACHE_SIZE = 0 #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in # documentation are documented, even if no documentation was available. # Private class members and static file members will be hidden unless # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES EXTRACT_ALL = NO # If the EXTRACT_PRIVATE tag is set to YES all private members of a class # will be included in the documentation. EXTRACT_PRIVATE = NO # If the EXTRACT_STATIC tag is set to YES all static members of a file # will be included in the documentation. EXTRACT_STATIC = YES # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) # defined locally in source files will be included in the documentation. # If set to NO only classes defined in header files are included. EXTRACT_LOCAL_CLASSES = NO # This flag is only useful for Objective-C code. When set to YES local # methods, which are defined in the implementation section but not in # the interface are included in the documentation. # If set to NO (the default) only methods in the interface are included. EXTRACT_LOCAL_METHODS = NO # If this flag is set to YES, the members of anonymous namespaces will be # extracted and appear in the documentation as a namespace called # 'anonymous_namespace{file}', where file will be replaced with the base # name of the file that contains the anonymous namespace. By default # anonymous namespace are hidden. EXTRACT_ANON_NSPACES = NO # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all # undocumented members of documented classes, files or namespaces. # If set to NO (the default) these members will be included in the # various overviews, but no documentation section is generated. # This option has no effect if EXTRACT_ALL is enabled. HIDE_UNDOC_MEMBERS = NO # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. # If set to NO (the default) these classes will be included in the various # overviews. This option has no effect if EXTRACT_ALL is enabled. HIDE_UNDOC_CLASSES = NO # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all # friend (class|struct|union) declarations. # If set to NO (the default) these declarations will be included in the # documentation. HIDE_FRIEND_COMPOUNDS = NO # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any # documentation blocks found inside the body of a function. # If set to NO (the default) these blocks will be appended to the # function's detailed documentation block. HIDE_IN_BODY_DOCS = NO # The INTERNAL_DOCS tag determines if documentation # that is typed after a \internal command is included. If the tag is set # to NO (the default) then the documentation will be excluded. # Set it to YES to include the internal documentation. INTERNAL_DOCS = NO # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate # file names in lower-case letters. If set to YES upper-case letters are also # allowed. This is useful if you have classes or files whose names only differ # in case and if your file system supports case sensitive file names. Windows # and Mac users are advised to set this option to NO. CASE_SENSE_NAMES = NO # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen # will show members with their full class and namespace scopes in the # documentation. If set to YES the scope will be hidden. HIDE_SCOPE_NAMES = NO # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen # will put a list of the files that are included by a file in the documentation # of that file. SHOW_INCLUDE_FILES = YES # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] # is inserted in the documentation for inline members. INLINE_INFO = YES # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen # will sort the (detailed) documentation of file and class members # alphabetically by member name. If set to NO the members will appear in # declaration order. SORT_MEMBER_DOCS = YES # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the # brief documentation of file, namespace and class members alphabetically # by member name. If set to NO (the default) the members will appear in # declaration order. SORT_BRIEF_DOCS = NO # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. SORT_MEMBERS_CTORS_1ST = YES # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the # hierarchy of group names into alphabetical order. If set to NO (the default) # the group names will appear in their defined order. SORT_GROUP_NAMES = NO # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be # sorted by fully-qualified names, including namespaces. If set to # NO (the default), the class list will be sorted only by class name, # not including the namespace part. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. # Note: This option applies only to the class list, not to the # alphabetical list. SORT_BY_SCOPE_NAME = NO # The GENERATE_TODOLIST tag can be used to enable (YES) or # disable (NO) the todo list. This list is created by putting \todo # commands in the documentation. GENERATE_TODOLIST = YES # The GENERATE_TESTLIST tag can be used to enable (YES) or # disable (NO) the test list. This list is created by putting \test # commands in the documentation. GENERATE_TESTLIST = YES # The GENERATE_BUGLIST tag can be used to enable (YES) or # disable (NO) the bug list. This list is created by putting \bug # commands in the documentation. GENERATE_BUGLIST = YES # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or # disable (NO) the deprecated list. This list is created by putting # \deprecated commands in the documentation. GENERATE_DEPRECATEDLIST= YES # The ENABLED_SECTIONS tag can be used to enable conditional # documentation sections, marked by \if sectionname ... \endif. ENABLED_SECTIONS = # The MAX_INITIALIZER_LINES tag determines the maximum number of lines # the initial value of a variable or define consists of for it to appear in # the documentation. If the initializer consists of more lines than specified # here it will be hidden. Use a value of 0 to hide initializers completely. # The appearance of the initializer of individual variables and defines in the # documentation can be controlled using \showinitializer or \hideinitializer # command in the documentation regardless of this setting. MAX_INITIALIZER_LINES = 30 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated # at the bottom of the documentation of classes and structs. If set to YES the # list will mention the files that were used to generate the documentation. SHOW_USED_FILES = YES # If the sources in your project are distributed over multiple directories # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy # in the documentation. The default is NO. #SHOW_DIRECTORIES = NO # Set the SHOW_FILES tag to NO to disable the generation of the Files page. # This will remove the Files entry from the Quick Index and from the # Folder Tree View (if specified). The default is YES. SHOW_FILES = YES # Set the SHOW_NAMESPACES tag to NO to disable the generation of the # Namespaces page. # This will remove the Namespaces entry from the Quick Index # and from the Folder Tree View (if specified). The default is YES. SHOW_NAMESPACES = YES # The FILE_VERSION_FILTER tag can be used to specify a program or script that # doxygen should invoke to get the current version for each file (typically from # the version control system). Doxygen will invoke the program by executing (via # popen()) the command , where is the value of # the FILE_VERSION_FILTER tag, and is the name of an input file # provided by doxygen. Whatever the program writes to standard output # is used as the file version. See the manual for examples. FILE_VERSION_FILTER = # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by # doxygen. The layout file controls the global structure of the generated output files # in an output format independent way. The create the layout file that represents # doxygen's defaults, run doxygen with the -l option. You can optionally specify a # file name after the option, if omitted DoxygenLayout.xml will be used as the name # of the layout file. LAYOUT_FILE = #--------------------------------------------------------------------------- # configuration options related to warning and progress messages #--------------------------------------------------------------------------- # The QUIET tag can be used to turn on/off the messages that are generated # by doxygen. Possible values are YES and NO. If left blank NO is used. QUIET = YES # The WARNINGS tag can be used to turn on/off the warning messages that are # generated by doxygen. Possible values are YES and NO. If left blank # NO is used. WARNINGS = YES # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings # for undocumented members. If EXTRACT_ALL is set to YES then this flag will # automatically be disabled. WARN_IF_UNDOCUMENTED = YES # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for # potential errors in the documentation, such as not documenting some # parameters in a documented function, or documenting parameters that # don't exist or using markup commands wrongly. WARN_IF_DOC_ERROR = YES # This WARN_NO_PARAMDOC option can be abled to get warnings for # functions that are documented, but have no documentation for their parameters # or return value. If set to NO (the default) doxygen will only warn about # wrong or incomplete parameter documentation, but not about the absence of # documentation. WARN_NO_PARAMDOC = YES # The WARN_FORMAT tag determines the format of the warning messages that # doxygen can produce. The string should contain the $file, $line, and $text # tags, which will be replaced by the file and line number from which the # warning originated and the warning text. Optionally the format may contain # $version, which will be replaced by the version of the file (if it could # be obtained via FILE_VERSION_FILTER) WARN_FORMAT = "$file:$line: $text" # The WARN_LOGFILE tag can be used to specify a file to which warning # and error messages should be written. If left blank the output is written # to stderr. WARN_LOGFILE = #--------------------------------------------------------------------------- # configuration options related to the input files #--------------------------------------------------------------------------- # The INPUT tag can be used to specify the files and/or directories that contain # documented source files. You may enter file names like "myfile.cpp" or # directories like "/usr/src/myproject". Separate the files or directories # with spaces. INPUT = $(CPP_DISTDIR)/inc/alljoyn \ $(CPP_DISTDIR)/inc/qcc \ ../../services/about/cpp/inc/alljoyn/ \ allJoynDocumentation # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is # also the default input encoding. Doxygen uses libiconv (or the iconv built # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for # the list of possible encodings. INPUT_ENCODING = UTF-8 # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp # and *.h) to filter out the source-files in the directories. If left # blank the following patterns are tested: # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 FILE_PATTERNS = # The RECURSIVE tag can be used to turn specify whether or not subdirectories # should be searched for input files as well. Possible values are YES and NO. # If left blank NO is used. RECURSIVE = YES # The EXCLUDE tag can be used to specify files and/or directories that should # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. EXCLUDE = # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded # from the input. EXCLUDE_SYMLINKS = NO # If the value of the INPUT tag contains directories, you can use the # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude # certain files from those directories. Note that the wildcards are matched # against the file with absolute path, so to exclude all test directories # for example use the pattern */test/* EXCLUDE_PATTERNS = # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the # output. The symbol name can be a fully qualified name, a word, or if the # wildcard * is used, a substring. Examples: ANamespace, AClass, # AClass::ANamespace, ANamespace::*Test EXCLUDE_SYMBOLS = # The EXAMPLE_PATH tag can be used to specify one or more files or # directories that contain example code fragments that are included (see # the \include command). EXAMPLE_PATH = # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp # and *.h) to filter out the source-files in the directories. If left # blank all files are included. EXAMPLE_PATTERNS = # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be # searched for input files to be used with the \include or \dontinclude # commands irrespective of the value of the RECURSIVE tag. # Possible values are YES and NO. If left blank NO is used. EXAMPLE_RECURSIVE = NO # The IMAGE_PATH tag can be used to specify one or more files or # directories that contain image that are included in the documentation (see # the \image command). IMAGE_PATH = # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program # by executing (via popen()) the command , where # is the value of the INPUT_FILTER tag, and is the name of an # input file. Doxygen will then use the output that the filter program writes # to standard output. # If FILTER_PATTERNS is specified, this tag will be # ignored. INPUT_FILTER = # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern # basis. # Doxygen will compare the file name with each pattern and apply the # filter if there is a match. # The filters are a list of the form: # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER # is applied to all files. FILTER_PATTERNS = # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using # INPUT_FILTER) will be used to filter the input files when producing source # files to browse (i.e. when SOURCE_BROWSER is set to YES). FILTER_SOURCE_FILES = NO #--------------------------------------------------------------------------- # configuration options related to source browsing #--------------------------------------------------------------------------- # If the SOURCE_BROWSER tag is set to YES then a list of source files will # be generated. Documented entities will be cross-referenced with these sources. # Note: To get rid of all source code in the generated output, make sure also # VERBATIM_HEADERS is set to NO. SOURCE_BROWSER = NO # Setting the INLINE_SOURCES tag to YES will include the body # of functions and classes directly in the documentation. INLINE_SOURCES = NO # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct # doxygen to hide any special comment blocks from generated source code # fragments. Normal C and C++ comments will always remain visible. STRIP_CODE_COMMENTS = YES # If the REFERENCED_BY_RELATION tag is set to YES # then for each documented function all documented # functions referencing it will be listed. REFERENCED_BY_RELATION = NO # If the REFERENCES_RELATION tag is set to YES # then for each documented function all documented entities # called/used by that function will be listed. REFERENCES_RELATION = NO # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will # link to the source code. # Otherwise they will link to the documentation. REFERENCES_LINK_SOURCE = YES # If the USE_HTAGS tag is set to YES then the references to source code # will point to the HTML generated by the htags(1) tool instead of doxygen # built-in source browser. The htags tool is part of GNU's global source # tagging system (see http://www.gnu.org/software/global/global.html). You # will need version 4.8.6 or higher. USE_HTAGS = NO # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen # will generate a verbatim copy of the header file for each class for # which an include is specified. Set to NO to disable this. VERBATIM_HEADERS = YES #--------------------------------------------------------------------------- # configuration options related to the alphabetical class index #--------------------------------------------------------------------------- # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index # of all compounds will be generated. Enable this if the project # contains a lot of classes, structs, unions or interfaces. ALPHABETICAL_INDEX = NO # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns # in which this list will be split (can be a number in the range [1..20]) COLS_IN_ALPHA_INDEX = 5 # In case all classes in a project start with a common prefix, all # classes will be put under the same header in the alphabetical index. # The IGNORE_PREFIX tag can be used to specify one or more prefixes that # should be ignored while generating the index headers. IGNORE_PREFIX = #--------------------------------------------------------------------------- # configuration options related to the HTML output #--------------------------------------------------------------------------- # If the GENERATE_HTML tag is set to YES (the default) Doxygen will # generate HTML output. GENERATE_HTML = YES # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `html' will be used as the default path. HTML_OUTPUT = html # The HTML_FILE_EXTENSION tag can be used to specify the file extension for # each generated HTML page (for example: .htm,.php,.asp). If it is left blank # doxygen will generate files with .html extension. HTML_FILE_EXTENSION = .html # The HTML_HEADER tag can be used to specify a personal HTML header for # each generated HTML page. If it is left blank doxygen will generate a # standard header. HTML_HEADER = # The HTML_FOOTER tag can be used to specify a personal HTML footer for # each generated HTML page. If it is left blank doxygen will generate a # standard footer. HTML_FOOTER = footer.html # The HTML_STYLESHEET tag can be used to specify a user-defined cascading # style sheet that is used by each HTML page. It can be used to # fine-tune the look of the HTML output. If the tag is left blank doxygen # will generate a default style sheet. Note that doxygen will try to copy # the style sheet file to the HTML output directory, so don't put your own # stylesheet in the HTML output directory as well, or it will be erased! HTML_STYLESHEET = # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, # files or namespaces will be aligned in HTML using tables. If set to # NO a bullet list will be used. #HTML_ALIGN_MEMBERS = YES # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # documentation will contain sections that can be hidden and shown after the # page has loaded. For this to work a browser that supports # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). HTML_DYNAMIC_SECTIONS = NO # If the GENERATE_DOCSET tag is set to YES, additional index files # will be generated that can be used as input for Apple's Xcode 3 # integrated development environment, introduced with OSX 10.5 (Leopard). # To create a documentation set, doxygen will generate a Makefile in the # HTML output directory. Running make will produce the docset in that # directory and running "make install" will install the docset in # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find # it at startup. # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information. GENERATE_DOCSET = NO # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the # feed. A documentation feed provides an umbrella under which multiple # documentation sets from a single provider (such as a company or product suite) # can be grouped. DOCSET_FEEDNAME = "Doxygen generated docs" # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that # should uniquely identify the documentation set bundle. This should be a # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen # will append .docset to the name. DOCSET_BUNDLE_ID = org.doxygen.Project # If the GENERATE_HTMLHELP tag is set to YES, additional index files # will be generated that can be used as input for tools like the # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) # of the generated HTML documentation. GENERATE_HTMLHELP = NO # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can # be used to specify the file name of the resulting .chm file. You # can add a path in front of the file if the result should not be # written to the html output directory. CHM_FILE = # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can # be used to specify the location (absolute path including file name) of # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run # the HTML help compiler on the generated index.hhp. HHC_LOCATION = # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag # controls if a separate .chi index file is generated (YES) or that # it should be included in the master .chm file (NO). GENERATE_CHI = NO # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING # is used to encode HtmlHelp index (hhk), content (hhc) and project file # content. CHM_INDEX_ENCODING = # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag # controls whether a binary table of contents is generated (YES) or a # normal table of contents (NO) in the .chm file. BINARY_TOC = NO # The TOC_EXPAND flag can be set to YES to add extra items for group members # to the contents of the HTML help documentation and to the tree view. TOC_EXPAND = NO # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER # are set, an additional index file will be generated that can be used as input for # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated # HTML documentation. GENERATE_QHP = NO # If the QHG_LOCATION tag is specified, the QCH_FILE tag can # be used to specify the file name of the resulting .qch file. # The path specified is relative to the HTML output folder. QCH_FILE = # The QHP_NAMESPACE tag specifies the namespace to use when generating # Qt Help Project output. For more information please see # http://doc.trolltech.com/qthelpproject.html#namespace QHP_NAMESPACE = # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating # Qt Help Project output. For more information please see # http://doc.trolltech.com/qthelpproject.html#virtual-folders QHP_VIRTUAL_FOLDER = doc # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. # For more information please see # http://doc.trolltech.com/qthelpproject.html#custom-filters QHP_CUST_FILTER_NAME = # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see # Qt Help Project / Custom Filters. QHP_CUST_FILTER_ATTRS = # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's # filter section matches. # Qt Help Project / Filter Attributes. QHP_SECT_FILTER_ATTRS = # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can # be used to specify the location of Qt's qhelpgenerator. # If non-empty doxygen will try to run qhelpgenerator on the generated # .qhp file. QHG_LOCATION = # The DISABLE_INDEX tag can be used to turn on/off the condensed index at # top of each HTML page. The value NO (the default) enables the index and # the value YES disables it. DISABLE_INDEX = NO # This tag can be used to set the number of enum values (range [1..20]) # that doxygen will group on one line in the generated HTML documentation. ENUM_VALUES_PER_LINE = 4 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index # structure should be generated to display hierarchical information. # If the tag value is set to YES, a side panel will be generated # containing a tree-like index structure (just like the one that # is generated for HTML Help). For this to work a browser that supports # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). # Windows users are probably better off using the HTML help feature. GENERATE_TREEVIEW = NO # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, # and Class Hierarchy pages using a tree view instead of an ordered list. #USE_INLINE_TREES = YES # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be # used to set the initial width (in pixels) of the frame in which the tree # is shown. TREEVIEW_WIDTH = 250 # Use this tag to change the font size of Latex formulas included # as images in the HTML documentation. The default is 10. Note that # when you change the font size after a successful doxygen run you need # to manually remove any form_*.png images from the HTML output directory # to force them to be regenerated. FORMULA_FONTSIZE = 10 # When the SEARCHENGINE tag is enable doxygen will generate a search box for the HTML output. The underlying search engine uses javascript # and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP) or Qt help (GENERATE_QHP) # there is already a search function so this one should typically # be disabled. SEARCHENGINE = YES #--------------------------------------------------------------------------- # configuration options related to the LaTeX output #--------------------------------------------------------------------------- # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will # generate Latex output. GENERATE_LATEX = NO # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `latex' will be used as the default path. LATEX_OUTPUT = latex # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be # invoked. If left blank `latex' will be used as the default command name. LATEX_CMD_NAME = latex # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to # generate index for LaTeX. If left blank `makeindex' will be used as the # default command name. MAKEINDEX_CMD_NAME = makeindex # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact # LaTeX documents. This may be useful for small projects and may help to # save some trees in general. COMPACT_LATEX = NO # The PAPER_TYPE tag can be used to set the paper type that is used # by the printer. Possible values are: a4, a4wide, letter, legal and # executive. If left blank a4wide will be used. PAPER_TYPE = a4wide # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX # packages that should be included in the LaTeX output. EXTRA_PACKAGES = # The LATEX_HEADER tag can be used to specify a personal LaTeX header for # the generated latex document. The header should contain everything until # the first chapter. If it is left blank doxygen will generate a # standard header. Notice: only use this tag if you know what you are doing! LATEX_HEADER = # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated # is prepared for conversion to pdf (using ps2pdf). The pdf file will # contain links (just like the HTML output) instead of page references # This makes the output suitable for online browsing using a pdf viewer. PDF_HYPERLINKS = YES # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of # plain latex in the generated Makefile. Set this option to YES to get a # higher quality PDF documentation. USE_PDFLATEX = YES # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. # command to the generated LaTeX files. This will instruct LaTeX to keep # running if errors occur, instead of asking the user for help. # This option is also used when generating formulas in HTML. LATEX_BATCHMODE = NO # If LATEX_HIDE_INDICES is set to YES then doxygen will not # include the index chapters (such as File Index, Compound Index, etc.) # in the output. LATEX_HIDE_INDICES = NO # If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER. LATEX_SOURCE_CODE = NO #--------------------------------------------------------------------------- # configuration options related to the RTF output #--------------------------------------------------------------------------- # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output # The RTF output is optimized for Word 97 and may not look very pretty with # other RTF readers or editors. GENERATE_RTF = NO # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `rtf' will be used as the default path. RTF_OUTPUT = rtf # If the COMPACT_RTF tag is set to YES Doxygen generates more compact # RTF documents. This may be useful for small projects and may help to # save some trees in general. COMPACT_RTF = NO # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated # will contain hyperlink fields. The RTF file will # contain links (just like the HTML output) instead of page references. # This makes the output suitable for online browsing using WORD or other # programs which support those fields. # Note: wordpad (write) and others do not support links. RTF_HYPERLINKS = NO # Load stylesheet definitions from file. Syntax is similar to doxygen's # config file, i.e. a series of assignments. You only have to provide # replacements, missing definitions are set to their default value. RTF_STYLESHEET_FILE = # Set optional variables used in the generation of an rtf document. # Syntax is similar to doxygen's config file. RTF_EXTENSIONS_FILE = #--------------------------------------------------------------------------- # configuration options related to the man page output #--------------------------------------------------------------------------- # If the GENERATE_MAN tag is set to YES (the default) Doxygen will # generate man pages GENERATE_MAN = NO # The MAN_OUTPUT tag is used to specify where the man pages will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `man' will be used as the default path. MAN_OUTPUT = man # The MAN_EXTENSION tag determines the extension that is added to # the generated man pages (default is the subroutine's section .3) MAN_EXTENSION = .3 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, # then it will generate one additional man file for each entity # documented in the real man page(s). These additional files # only source the real man page, but without them the man command # would be unable to find the correct page. The default is NO. MAN_LINKS = NO #--------------------------------------------------------------------------- # configuration options related to the XML output #--------------------------------------------------------------------------- # If the GENERATE_XML tag is set to YES Doxygen will # generate an XML file that captures the structure of # the code including all documentation. GENERATE_XML = NO # The XML_OUTPUT tag is used to specify where the XML pages will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `xml' will be used as the default path. XML_OUTPUT = xml # The XML_SCHEMA tag can be used to specify an XML schema, # which can be used by a validating XML parser to check the # syntax of the XML files. XML_SCHEMA = # The XML_DTD tag can be used to specify an XML DTD, # which can be used by a validating XML parser to check the # syntax of the XML files. XML_DTD = # If the XML_PROGRAMLISTING tag is set to YES Doxygen will # dump the program listings (including syntax highlighting # and cross-referencing information) to the XML output. Note that # enabling this will significantly increase the size of the XML output. XML_PROGRAMLISTING = YES #--------------------------------------------------------------------------- # configuration options for the AutoGen Definitions output #--------------------------------------------------------------------------- # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will # generate an AutoGen Definitions (see autogen.sf.net) file # that captures the structure of the code including all # documentation. Note that this feature is still experimental # and incomplete at the moment. GENERATE_AUTOGEN_DEF = NO #--------------------------------------------------------------------------- # configuration options related to the Perl module output #--------------------------------------------------------------------------- # If the GENERATE_PERLMOD tag is set to YES Doxygen will # generate a Perl module file that captures the structure of # the code including all documentation. Note that this # feature is still experimental and incomplete at the # moment. GENERATE_PERLMOD = NO # If the PERLMOD_LATEX tag is set to YES Doxygen will generate # the necessary Makefile rules, Perl scripts and LaTeX code to be able # to generate PDF and DVI output from the Perl module output. PERLMOD_LATEX = NO # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be # nicely formatted so it can be parsed by a human reader. # This is useful # if you want to understand what is going on. # On the other hand, if this # tag is set to NO the size of the Perl module output will be much smaller # and Perl will parse it just the same. PERLMOD_PRETTY = YES # The names of the make variables in the generated doxyrules.make file # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. # This is useful so different doxyrules.make files included by the same # Makefile don't overwrite each other's variables. PERLMOD_MAKEVAR_PREFIX = #--------------------------------------------------------------------------- # Configuration options related to the preprocessor #--------------------------------------------------------------------------- # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will # evaluate all C-preprocessor directives found in the sources and include # files. ENABLE_PREPROCESSING = YES # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro # names in the source code. If set to NO (the default) only conditional # compilation will be performed. Macro expansion can be done in a controlled # way by setting EXPAND_ONLY_PREDEF to YES. MACRO_EXPANSION = YES # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES # then the macro expansion is limited to the macros specified with the # PREDEFINED and EXPAND_AS_DEFINED tags. EXPAND_ONLY_PREDEF = YES # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files # in the INCLUDE_PATH (see below) will be search if a #include is found. SEARCH_INCLUDES = YES # The INCLUDE_PATH tag can be used to specify one or more directories that # contain include files that are not input files but should be processed by # the preprocessor. INCLUDE_PATH = # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard # patterns (like *.h and *.hpp) to filter out the header-files in the # directories. If left blank, the patterns specified with FILE_PATTERNS will # be used. INCLUDE_FILE_PATTERNS = # The PREDEFINED tag can be used to specify one or more macro names that # are defined before the preprocessor is started (similar to the -D option of # gcc). The argument of the tag is a list of macros of the form: name # or name=definition (no spaces). If the definition and the = are # omitted =1 is assumed. To prevent a macro definition from being # undefined via #undef or recursively expanded use the := operator # instead of the = operator. PREDEFINED = "QCC_DEPRECATED(func)=func" # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then # this tag can be used to specify a list of macro names that should be expanded. # The macro definition that is found in the sources will be used. # Use the PREDEFINED tag if you want to use a different macro definition. EXPAND_AS_DEFINED = # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then # doxygen's preprocessor will remove all function-like macros that are alone # on a line, have an all uppercase name, and do not end with a semicolon. Such # function macros are typically used for boiler-plate code, and will confuse # the parser if not removed. SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- # Configuration::additions related to external references #--------------------------------------------------------------------------- # The TAGFILES option can be used to specify one or more tagfiles. # Optionally an initial location of the external documentation # can be added for each tagfile. The format of a tag file without # this location is as follows: # # TAGFILES = file1 file2 ... # Adding location for the tag files is done as follows: # # TAGFILES = file1=loc1 "file2 = loc2" ... # where "loc1" and "loc2" can be relative or absolute paths or # URLs. If a location is present for each tag, the installdox tool # does not have to be run to correct the links. # Note that each tag file must have a unique name # (where the name does NOT include the path) # If a tag file is not located in the directory in which doxygen # is run, you must also specify the path to the tagfile here. TAGFILES = # When a file name is specified after GENERATE_TAGFILE, doxygen will create # a tag file that is based on the input files it reads. GENERATE_TAGFILE = # If the ALLEXTERNALS tag is set to YES all external classes will be listed # in the class index. If set to NO only the inherited external classes # will be listed. ALLEXTERNALS = NO # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed # in the modules index. If set to NO, only the current project's groups will # be listed. EXTERNAL_GROUPS = YES # The PERL_PATH should be the absolute path and name of the perl script # interpreter (i.e. the result of `which perl'). PERL_PATH = /usr/bin/perl #--------------------------------------------------------------------------- # Configuration options related to the dot tool #--------------------------------------------------------------------------- # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base # or super classes. Setting the tag to NO turns the diagrams off. Note that # this option is superseded by the HAVE_DOT option below. This is only a # fallback. It is recommended to install and use dot, since it yields more # powerful graphs. CLASS_DIAGRAMS = YES # You can define message sequence charts within doxygen comments using the \msc # command. Doxygen will then run the mscgen tool (see # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the # documentation. The MSCGEN_PATH tag allows you to specify the directory where # the mscgen tool resides. If left empty the tool is assumed to be found in the # default search path. MSCGEN_PATH = # If set to YES, the inheritance and collaboration graphs will hide # inheritance and usage relations if the target is undocumented # or is not a class. HIDE_UNDOC_RELATIONS = YES # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is # available from the path. This tool is part of Graphviz, a graph visualization # toolkit from AT&T and Lucent Bell Labs. The other options in this section # have no effect if this option is set to NO (the default) HAVE_DOT = YES # By default doxygen will write a font called FreeSans.ttf to the output # directory and reference it in all dot files that doxygen generates. This # font does not include all possible unicode characters however, so when you need # these (or just want a differently looking font) you can specify the font name # using DOT_FONTNAME. You need need to make sure dot is able to find the font, # which can be done by putting it in a standard location or by setting the # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory # containing the font. #DOT_FONTNAME = FreeSans # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. # The default size is 10pt. DOT_FONTSIZE = 10 # By default doxygen will tell dot to use the output directory to look for the # FreeSans.ttf font (which doxygen will put there itself). If you specify a # different font using DOT_FONTNAME you can set the path where dot # can find it using this tag. DOT_FONTPATH = # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen # will generate a graph for each documented class showing the direct and # indirect inheritance relations. Setting this tag to YES will force the # the CLASS_DIAGRAMS tag to NO. CLASS_GRAPH = YES # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen # will generate a graph for each documented class showing the direct and # indirect implementation dependencies (inheritance, containment, and # class references variables) of the class with other documented classes. COLLABORATION_GRAPH = YES # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen # will generate a graph for groups, showing the direct groups dependencies GROUP_GRAPHS = YES # If the UML_LOOK tag is set to YES doxygen will generate inheritance and # collaboration diagrams in a style similar to the OMG's Unified Modeling # Language. UML_LOOK = NO # If set to YES, the inheritance and collaboration graphs will show the # relations between templates and their instances. TEMPLATE_RELATIONS = NO # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT # tags are set to YES then doxygen will generate a graph for each documented # file showing the direct and indirect include dependencies of the file with # other documented files. INCLUDE_GRAPH = YES # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and # HAVE_DOT tags are set to YES then doxygen will generate a graph for each # documented header file showing the documented files that directly or # indirectly include this file. INCLUDED_BY_GRAPH = YES # If the CALL_GRAPH and HAVE_DOT options are set to YES then # doxygen will generate a call dependency graph for every global function # or class method. Note that enabling this option will significantly increase # the time of a run. So in most cases it will be better to enable call graphs # for selected functions only using the \callgraph command. CALL_GRAPH = NO # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then # doxygen will generate a caller dependency graph for every global function # or class method. Note that enabling this option will significantly increase # the time of a run. So in most cases it will be better to enable caller # graphs for selected functions only using the \callergraph command. CALLER_GRAPH = NO # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen # will graphical hierarchy of all classes instead of a textual one. GRAPHICAL_HIERARCHY = YES # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES # then doxygen will show the dependencies a directory has on other directories # in a graphical way. The dependency relations are determined by the #include # relations between the files in the directories. DIRECTORY_GRAPH = YES # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images # generated by dot. Possible values are png, jpg, or gif # If left blank png will be used. DOT_IMAGE_FORMAT = png # The tag DOT_PATH can be used to specify the path where the dot tool can be # found. If left blank, it is assumed the dot tool can be found in the path. DOT_PATH = # The DOTFILE_DIRS tag can be used to specify one or more directories that # contain dot files that are included in the documentation (see the # \dotfile command). DOTFILE_DIRS = # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of # nodes that will be shown in the graph. If the number of nodes in a graph # becomes larger than this value, doxygen will truncate the graph, which is # visualized by representing a node as a red box. Note that doxygen if the # number of direct children of the root node in a graph is already larger than # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. DOT_GRAPH_MAX_NODES = 50 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the # graphs generated by dot. A depth value of 3 means that only nodes reachable # from the root by following a path via at most 3 edges will be shown. Nodes # that lay further from the root node will be omitted. Note that setting this # option to 1 or 2 may greatly reduce the computation time needed for large # code bases. Also note that the size of a graph can be further restricted by # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. MAX_DOT_GRAPH_DEPTH = 3 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent # background. This is disabled by default, because dot on Windows does not # seem to support this out of the box. Warning: Depending on the platform used, # enabling this option may lead to badly anti-aliased labels on the edges of # a graph (i.e. they become hard to read). DOT_TRANSPARENT = NO # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output # files in one run (i.e. multiple -o and -T options on the command line). This # makes dot run faster, but since only newer versions of dot (>1.8.10) # support this, this feature is disabled by default. DOT_MULTI_TARGETS = YES # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will # generate a legend page explaining the meaning of the various boxes and # arrows in the dot generated graphs. GENERATE_LEGEND = YES # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will # remove the intermediate dot files that are used to generate # the various graphs. DOT_CLEANUP = YES alljoyn-15.04b/alljoyn_core/docs/Doxygen_pdf000066400000000000000000001755021255700255500211560ustar00rootroot00000000000000# Doxyfile 1.6.1 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project # # All text after a hash (#) is considered a comment and will be ignored # The format is: # TAG = value [value, ...] # For lists items can also be appended using: # TAG += value [value, ...] # Values that contain spaces should be placed between quotes (" ") #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- # This tag specifies the encoding used for all characters in the config file # that follow. The default is UTF-8 which is also the encoding used for all # text before the first occurrence of this tag. Doxygen uses libiconv (or the # iconv built into libc) for the transcoding. See # http://www.gnu.org/software/libiconv for the list of possible encodings. DOXYFILE_ENCODING = UTF-8 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded # by quotes) that should identify the project. PROJECT_NAME = "AllJoyn™ C++ API Reference Manual" # The PROJECT_NUMBER tag can be used to enter a project or revision number. # This could be handy for archiving the generated documentation or # if some version control system is used. PROJECT_NUMBER = "Version 15.04.00b" # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) # base path where the generated documentation will be put. # If a relative path is entered, it will be relative to the location # where doxygen was started. If left blank the current directory will be used. OUTPUT_DIRECTORY = # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create # 4096 sub-directories (in 2 levels) under the output directory of each output # format and will distribute the generated files over these directories. # Enabling this option can be useful when feeding doxygen a huge amount of # source files, where putting all generated files in the same directory would # otherwise cause performance problems for the file system. CREATE_SUBDIRS = NO # The OUTPUT_LANGUAGE tag is used to specify the language in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all constant output in the proper language. # The default language is English, other supported languages are: # Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, # Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, # Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English # messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, # Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrilic, Slovak, # Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. OUTPUT_LANGUAGE = English # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will # include brief member descriptions after the members that are listed in # the file and class documentation (similar to JavaDoc). # Set to NO to disable this. BRIEF_MEMBER_DESC = YES # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend # the brief description of a member or function before the detailed description. # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. REPEAT_BRIEF = YES # This tag implements a quasi-intelligent brief description abbreviator # that is used to form the text in various listings. Each string # in this list, if found as the leading text of the brief description, will be # stripped from the text and the result after processing the whole list, is # used as the annotated text. Otherwise, the brief description is used as-is. # If left blank, the following values are used ("$name" is automatically # replaced with the name of the entity): "The $name class" "The $name widget" # "The $name file" "is" "provides" "specifies" "contains" # "represents" "a" "an" "the" ABBREVIATE_BRIEF = # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then # Doxygen will generate a detailed section even if there is only a brief # description. ALWAYS_DETAILED_SEC = NO # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all # inherited members of a class in the documentation of that class as if those # members were ordinary class members. Constructors, destructors and assignment # operators of the base classes will not be shown. INLINE_INHERITED_MEMB = NO # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full # path before files name in the file list and in the header files. If set # to NO the shortest path that makes the file name unique will be used. FULL_PATH_NAMES = NO # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag # can be used to strip a user-defined part of the path. Stripping is # only done if one of the specified strings matches the left-hand part of # the path. The tag can be used to show relative paths in the file list. # If left blank the directory from which doxygen is run is used as the # path to strip. STRIP_FROM_PATH = # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of # the path mentioned in the documentation of a class, which tells # the reader which header file to include in order to use a class. # If left blank only the name of the header file containing the class # definition is used. Otherwise one should specify the include paths that # are normally passed to the compiler using the -I flag. STRIP_FROM_INC_PATH = # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter # (but less readable) file names. This can be useful is your file systems # doesn't support long names like on DOS, Mac, or CD-ROM. SHORT_NAMES = NO # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen # will interpret the first line (until the first dot) of a JavaDoc-style # comment as the brief description. If set to NO, the JavaDoc # comments will behave just like regular Qt-style comments # (thus requiring an explicit @brief command for a brief description.) JAVADOC_AUTOBRIEF = YES # If the QT_AUTOBRIEF tag is set to YES then Doxygen will # interpret the first line (until the first dot) of a Qt-style # comment as the brief description. If set to NO, the comments # will behave just like regular Qt-style comments (thus requiring # an explicit \brief command for a brief description.) QT_AUTOBRIEF = NO # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen # treat a multi-line C++ special comment block (i.e. a block of //! or /// # comments) as a brief description. This used to be the default behaviour. # The new default is to treat a multi-line C++ comment block as a detailed # description. Set this tag to YES if you prefer the old behaviour instead. MULTILINE_CPP_IS_BRIEF = NO # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented # member inherits the documentation from any documented member that it # re-implements. INHERIT_DOCS = YES # If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce # a new page for each member. If set to NO, the documentation of a member will # be part of the file/class/namespace that contains it. SEPARATE_MEMBER_PAGES = NO # The TAB_SIZE tag can be used to set the number of spaces in a tab. # Doxygen uses this value to replace tabs by spaces in code fragments. TAB_SIZE = 4 # This tag can be used to specify a number of aliases that acts # as commands in the documentation. An alias has the form "name=value". # For example adding "sideeffect=\par Side Effects:\n" will allow you to # put the command \sideeffect (or @sideeffect) in the documentation, which # will result in a user-defined paragraph with heading "Side Effects:". # You can put \n's in the value part of an alias to insert newlines. ALIASES = # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C # sources only. Doxygen will then generate output that is more tailored for C. # For instance, some of the names that are used will be different. The list # of all members will be omitted, etc. OPTIMIZE_OUTPUT_FOR_C = NO # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java # sources only. Doxygen will then generate output that is more tailored for # Java. For instance, namespaces will be presented as packages, qualified # scopes will look different, etc. OPTIMIZE_OUTPUT_JAVA = NO # Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran # sources only. Doxygen will then generate output that is more tailored for # Fortran. OPTIMIZE_FOR_FORTRAN = NO # Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL # sources. Doxygen will then generate output that is tailored for # VHDL. OPTIMIZE_OUTPUT_VHDL = NO # Doxygen selects the parser to use depending on the extension of the files it parses. # With this tag you can assign which parser to use for a given extension. # Doxygen has a built-in mapping, but you can override or extend it using this tag. # The format is ext=language, where ext is a file extension, and language is one of # the parsers supported by doxygen: IDL, Java, Javascript, C#, C, C++, D, PHP, # Objective-C, Python, Fortran, VHDL, C, C++. For instance to make doxygen treat # .inc files as Fortran files (default is PHP), and .f files as C (default is Fortran), # use: inc=Fortran f=C. Note that for custom extensions you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. EXTENSION_MAPPING = # If you use STL classes (i.e. std::string, std::vector, etc.) but do not want # to include (a tag file for) the STL sources as input, then you should # set this tag to YES in order to let doxygen match functions declarations and # definitions whose arguments contain STL classes (e.g. func(std::string); v.s. # func(std::string) {}). This also make the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. BUILTIN_STL_SUPPORT = YES # If you use Microsoft's C++/CLI language, you should set this option to YES to # enable parsing support. CPP_CLI_SUPPORT = NO # Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. # Doxygen will parse them like normal C++ but will assume all classes use public # instead of private inheritance when no explicit protection keyword is present. SIP_SUPPORT = NO # For Microsoft's IDL there are propget and propput attributes to indicate getter # and setter methods for a property. Setting this option to YES (the default) # will make doxygen to replace the get and set methods by a property in the # documentation. This will only work if the methods are indeed getting or # setting a simple type. If this is not the case, or you want to show the # methods anyway, you should set this option to NO. IDL_PROPERTY_SUPPORT = YES # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC # tag is set to YES, then doxygen will reuse the documentation of the first # member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. DISTRIBUTE_GROUP_DOC = NO # Set the SUBGROUPING tag to YES (the default) to allow class member groups of # the same type (for instance a group of public functions) to be put as a # subgroup of that type (e.g. under the Public Functions section). Set it to # NO to prevent subgrouping. Alternatively, this can be done per class using # the \nosubgrouping command. SUBGROUPING = YES # When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum # is documented as struct, union, or enum with the name of the typedef. So # typedef struct TypeS {} TypeT, will appear in the documentation as a struct # with name TypeT. When disabled the typedef will appear as a member of a file, # namespace, or class. And the struct will be named TypeS. This can typically # be useful for C code in case the coding convention dictates that all compound # types are typedef'ed and only the typedef is referenced, never the tag name. TYPEDEF_HIDES_STRUCT = NO # The SYMBOL_CACHE_SIZE determines the size of the internal cache use to # determine which symbols to keep in memory and which to flush to disk. # When the cache is full, less often used symbols will be written to disk. # For small to medium size projects (<1000 input files) the default value is # probably good enough. For larger projects a too small cache size can cause # doxygen to be busy swapping symbols to and from disk most of the time # causing a significant performance penality. # If the system has enough physical memory increasing the cache will improve the # performance by keeping more symbols in memory. Note that the value works on # a logarithmic scale so increasing the size by one will rougly double the # memory usage. The cache size is given by this formula: # 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, # corresponding to a cache size of 2^16 = 65536 symbols #SYMBOL_CACHE_SIZE = 0 #--------------------------------------------------------------------------- # Build related configuration options #--------------------------------------------------------------------------- # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in # documentation are documented, even if no documentation was available. # Private class members and static file members will be hidden unless # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES EXTRACT_ALL = NO # If the EXTRACT_PRIVATE tag is set to YES all private members of a class # will be included in the documentation. EXTRACT_PRIVATE = NO # If the EXTRACT_STATIC tag is set to YES all static members of a file # will be included in the documentation. EXTRACT_STATIC = YES # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) # defined locally in source files will be included in the documentation. # If set to NO only classes defined in header files are included. EXTRACT_LOCAL_CLASSES = NO # This flag is only useful for Objective-C code. When set to YES local # methods, which are defined in the implementation section but not in # the interface are included in the documentation. # If set to NO (the default) only methods in the interface are included. EXTRACT_LOCAL_METHODS = NO # If this flag is set to YES, the members of anonymous namespaces will be # extracted and appear in the documentation as a namespace called # 'anonymous_namespace{file}', where file will be replaced with the base # name of the file that contains the anonymous namespace. By default # anonymous namespace are hidden. EXTRACT_ANON_NSPACES = NO # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all # undocumented members of documented classes, files or namespaces. # If set to NO (the default) these members will be included in the # various overviews, but no documentation section is generated. # This option has no effect if EXTRACT_ALL is enabled. HIDE_UNDOC_MEMBERS = NO # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. # If set to NO (the default) these classes will be included in the various # overviews. This option has no effect if EXTRACT_ALL is enabled. HIDE_UNDOC_CLASSES = NO # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all # friend (class|struct|union) declarations. # If set to NO (the default) these declarations will be included in the # documentation. HIDE_FRIEND_COMPOUNDS = NO # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any # documentation blocks found inside the body of a function. # If set to NO (the default) these blocks will be appended to the # function's detailed documentation block. HIDE_IN_BODY_DOCS = NO # The INTERNAL_DOCS tag determines if documentation # that is typed after a \internal command is included. If the tag is set # to NO (the default) then the documentation will be excluded. # Set it to YES to include the internal documentation. INTERNAL_DOCS = NO # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate # file names in lower-case letters. If set to YES upper-case letters are also # allowed. This is useful if you have classes or files whose names only differ # in case and if your file system supports case sensitive file names. Windows # and Mac users are advised to set this option to NO. CASE_SENSE_NAMES = NO # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen # will show members with their full class and namespace scopes in the # documentation. If set to YES the scope will be hidden. HIDE_SCOPE_NAMES = NO # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen # will put a list of the files that are included by a file in the documentation # of that file. SHOW_INCLUDE_FILES = YES # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] # is inserted in the documentation for inline members. INLINE_INFO = YES # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen # will sort the (detailed) documentation of file and class members # alphabetically by member name. If set to NO the members will appear in # declaration order. SORT_MEMBER_DOCS = YES # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the # brief documentation of file, namespace and class members alphabetically # by member name. If set to NO (the default) the members will appear in # declaration order. SORT_BRIEF_DOCS = NO # If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the (brief and detailed) documentation of class members so that constructors and destructors are listed first. If set to NO (the default) the constructors will appear in the respective orders defined by SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. SORT_MEMBERS_CTORS_1ST = YES # If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the # hierarchy of group names into alphabetical order. If set to NO (the default) # the group names will appear in their defined order. SORT_GROUP_NAMES = NO # If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be # sorted by fully-qualified names, including namespaces. If set to # NO (the default), the class list will be sorted only by class name, # not including the namespace part. # Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. # Note: This option applies only to the class list, not to the # alphabetical list. SORT_BY_SCOPE_NAME = NO # The GENERATE_TODOLIST tag can be used to enable (YES) or # disable (NO) the todo list. This list is created by putting \todo # commands in the documentation. GENERATE_TODOLIST = YES # The GENERATE_TESTLIST tag can be used to enable (YES) or # disable (NO) the test list. This list is created by putting \test # commands in the documentation. GENERATE_TESTLIST = YES # The GENERATE_BUGLIST tag can be used to enable (YES) or # disable (NO) the bug list. This list is created by putting \bug # commands in the documentation. GENERATE_BUGLIST = YES # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or # disable (NO) the deprecated list. This list is created by putting # \deprecated commands in the documentation. GENERATE_DEPRECATEDLIST= YES # The ENABLED_SECTIONS tag can be used to enable conditional # documentation sections, marked by \if sectionname ... \endif. ENABLED_SECTIONS = # The MAX_INITIALIZER_LINES tag determines the maximum number of lines # the initial value of a variable or define consists of for it to appear in # the documentation. If the initializer consists of more lines than specified # here it will be hidden. Use a value of 0 to hide initializers completely. # The appearance of the initializer of individual variables and defines in the # documentation can be controlled using \showinitializer or \hideinitializer # command in the documentation regardless of this setting. MAX_INITIALIZER_LINES = 30 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated # at the bottom of the documentation of classes and structs. If set to YES the # list will mention the files that were used to generate the documentation. SHOW_USED_FILES = YES # If the sources in your project are distributed over multiple directories # then setting the SHOW_DIRECTORIES tag to YES will show the directory hierarchy # in the documentation. The default is NO. #SHOW_DIRECTORIES = NO # Set the SHOW_FILES tag to NO to disable the generation of the Files page. # This will remove the Files entry from the Quick Index and from the # Folder Tree View (if specified). The default is YES. SHOW_FILES = YES # Set the SHOW_NAMESPACES tag to NO to disable the generation of the # Namespaces page. # This will remove the Namespaces entry from the Quick Index # and from the Folder Tree View (if specified). The default is YES. SHOW_NAMESPACES = YES # The FILE_VERSION_FILTER tag can be used to specify a program or script that # doxygen should invoke to get the current version for each file (typically from # the version control system). Doxygen will invoke the program by executing (via # popen()) the command , where is the value of # the FILE_VERSION_FILTER tag, and is the name of an input file # provided by doxygen. Whatever the program writes to standard output # is used as the file version. See the manual for examples. FILE_VERSION_FILTER = # The LAYOUT_FILE tag can be used to specify a layout file which will be parsed by # doxygen. The layout file controls the global structure of the generated output files # in an output format independent way. The create the layout file that represents # doxygen's defaults, run doxygen with the -l option. You can optionally specify a # file name after the option, if omitted DoxygenLayout.xml will be used as the name # of the layout file. LAYOUT_FILE = #--------------------------------------------------------------------------- # configuration options related to warning and progress messages #--------------------------------------------------------------------------- # The QUIET tag can be used to turn on/off the messages that are generated # by doxygen. Possible values are YES and NO. If left blank NO is used. QUIET = YES # The WARNINGS tag can be used to turn on/off the warning messages that are # generated by doxygen. Possible values are YES and NO. If left blank # NO is used. WARNINGS = YES # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings # for undocumented members. If EXTRACT_ALL is set to YES then this flag will # automatically be disabled. WARN_IF_UNDOCUMENTED = YES # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for # potential errors in the documentation, such as not documenting some # parameters in a documented function, or documenting parameters that # don't exist or using markup commands wrongly. WARN_IF_DOC_ERROR = YES # This WARN_NO_PARAMDOC option can be abled to get warnings for # functions that are documented, but have no documentation for their parameters # or return value. If set to NO (the default) doxygen will only warn about # wrong or incomplete parameter documentation, but not about the absence of # documentation. WARN_NO_PARAMDOC = YES # The WARN_FORMAT tag determines the format of the warning messages that # doxygen can produce. The string should contain the $file, $line, and $text # tags, which will be replaced by the file and line number from which the # warning originated and the warning text. Optionally the format may contain # $version, which will be replaced by the version of the file (if it could # be obtained via FILE_VERSION_FILTER) WARN_FORMAT = "$file:$line: $text" # The WARN_LOGFILE tag can be used to specify a file to which warning # and error messages should be written. If left blank the output is written # to stderr. WARN_LOGFILE = #--------------------------------------------------------------------------- # configuration options related to the input files #--------------------------------------------------------------------------- # The INPUT tag can be used to specify the files and/or directories that contain # documented source files. You may enter file names like "myfile.cpp" or # directories like "/usr/src/myproject". Separate the files or directories # with spaces. INPUT = $(CPP_DISTDIR)/inc/alljoyn \ $(CPP_DISTDIR)/inc/qcc \ allJoynDocumentation # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is # also the default input encoding. Doxygen uses libiconv (or the iconv built # into libc) for the transcoding. See http://www.gnu.org/software/libiconv for # the list of possible encodings. INPUT_ENCODING = UTF-8 # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp # and *.h) to filter out the source-files in the directories. If left # blank the following patterns are tested: # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90 FILE_PATTERNS = # The RECURSIVE tag can be used to turn specify whether or not subdirectories # should be searched for input files as well. Possible values are YES and NO. # If left blank NO is used. RECURSIVE = YES # The EXCLUDE tag can be used to specify files and/or directories that should # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. EXCLUDE = # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix filesystem feature) are excluded # from the input. EXCLUDE_SYMLINKS = NO # If the value of the INPUT tag contains directories, you can use the # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude # certain files from those directories. Note that the wildcards are matched # against the file with absolute path, so to exclude all test directories # for example use the pattern */test/* EXCLUDE_PATTERNS = # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the # output. The symbol name can be a fully qualified name, a word, or if the # wildcard * is used, a substring. Examples: ANamespace, AClass, # AClass::ANamespace, ANamespace::*Test EXCLUDE_SYMBOLS = # The EXAMPLE_PATH tag can be used to specify one or more files or # directories that contain example code fragments that are included (see # the \include command). EXAMPLE_PATH = # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp # and *.h) to filter out the source-files in the directories. If left # blank all files are included. EXAMPLE_PATTERNS = # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be # searched for input files to be used with the \include or \dontinclude # commands irrespective of the value of the RECURSIVE tag. # Possible values are YES and NO. If left blank NO is used. EXAMPLE_RECURSIVE = NO # The IMAGE_PATH tag can be used to specify one or more files or # directories that contain image that are included in the documentation (see # the \image command). IMAGE_PATH = # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program # by executing (via popen()) the command , where # is the value of the INPUT_FILTER tag, and is the name of an # input file. Doxygen will then use the output that the filter program writes # to standard output. # If FILTER_PATTERNS is specified, this tag will be # ignored. INPUT_FILTER = # The FILTER_PATTERNS tag can be used to specify filters on a per file pattern # basis. # Doxygen will compare the file name with each pattern and apply the # filter if there is a match. # The filters are a list of the form: # pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further # info on how filters are used. If FILTER_PATTERNS is empty, INPUT_FILTER # is applied to all files. FILTER_PATTERNS = # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using # INPUT_FILTER) will be used to filter the input files when producing source # files to browse (i.e. when SOURCE_BROWSER is set to YES). FILTER_SOURCE_FILES = NO #--------------------------------------------------------------------------- # configuration options related to source browsing #--------------------------------------------------------------------------- # If the SOURCE_BROWSER tag is set to YES then a list of source files will # be generated. Documented entities will be cross-referenced with these sources. # Note: To get rid of all source code in the generated output, make sure also # VERBATIM_HEADERS is set to NO. SOURCE_BROWSER = NO # Setting the INLINE_SOURCES tag to YES will include the body # of functions and classes directly in the documentation. INLINE_SOURCES = NO # Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct # doxygen to hide any special comment blocks from generated source code # fragments. Normal C and C++ comments will always remain visible. STRIP_CODE_COMMENTS = YES # If the REFERENCED_BY_RELATION tag is set to YES # then for each documented function all documented # functions referencing it will be listed. REFERENCED_BY_RELATION = NO # If the REFERENCES_RELATION tag is set to YES # then for each documented function all documented entities # called/used by that function will be listed. REFERENCES_RELATION = NO # If the REFERENCES_LINK_SOURCE tag is set to YES (the default) # and SOURCE_BROWSER tag is set to YES, then the hyperlinks from # functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will # link to the source code. # Otherwise they will link to the documentation. REFERENCES_LINK_SOURCE = YES # If the USE_HTAGS tag is set to YES then the references to source code # will point to the HTML generated by the htags(1) tool instead of doxygen # built-in source browser. The htags tool is part of GNU's global source # tagging system (see http://www.gnu.org/software/global/global.html). You # will need version 4.8.6 or higher. USE_HTAGS = NO # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen # will generate a verbatim copy of the header file for each class for # which an include is specified. Set to NO to disable this. VERBATIM_HEADERS = YES #--------------------------------------------------------------------------- # configuration options related to the alphabetical class index #--------------------------------------------------------------------------- # If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index # of all compounds will be generated. Enable this if the project # contains a lot of classes, structs, unions or interfaces. ALPHABETICAL_INDEX = NO # If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then # the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns # in which this list will be split (can be a number in the range [1..20]) COLS_IN_ALPHA_INDEX = 5 # In case all classes in a project start with a common prefix, all # classes will be put under the same header in the alphabetical index. # The IGNORE_PREFIX tag can be used to specify one or more prefixes that # should be ignored while generating the index headers. IGNORE_PREFIX = #--------------------------------------------------------------------------- # configuration options related to the HTML output #--------------------------------------------------------------------------- # If the GENERATE_HTML tag is set to YES (the default) Doxygen will # generate HTML output. GENERATE_HTML = NO # The HTML_OUTPUT tag is used to specify where the HTML docs will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `html' will be used as the default path. HTML_OUTPUT = html # The HTML_FILE_EXTENSION tag can be used to specify the file extension for # each generated HTML page (for example: .htm,.php,.asp). If it is left blank # doxygen will generate files with .html extension. HTML_FILE_EXTENSION = .html # The HTML_HEADER tag can be used to specify a personal HTML header for # each generated HTML page. If it is left blank doxygen will generate a # standard header. HTML_HEADER = # The HTML_FOOTER tag can be used to specify a personal HTML footer for # each generated HTML page. If it is left blank doxygen will generate a # standard footer. HTML_FOOTER = footer.html # The HTML_STYLESHEET tag can be used to specify a user-defined cascading # style sheet that is used by each HTML page. It can be used to # fine-tune the look of the HTML output. If the tag is left blank doxygen # will generate a default style sheet. Note that doxygen will try to copy # the style sheet file to the HTML output directory, so don't put your own # stylesheet in the HTML output directory as well, or it will be erased! HTML_STYLESHEET = # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, # files or namespaces will be aligned in HTML using tables. If set to # NO a bullet list will be used. #HTML_ALIGN_MEMBERS = YES # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # documentation will contain sections that can be hidden and shown after the # page has loaded. For this to work a browser that supports # JavaScript and DHTML is required (for instance Mozilla 1.0+, Firefox # Netscape 6.0+, Internet explorer 5.0+, Konqueror, or Safari). HTML_DYNAMIC_SECTIONS = NO # If the GENERATE_DOCSET tag is set to YES, additional index files # will be generated that can be used as input for Apple's Xcode 3 # integrated development environment, introduced with OSX 10.5 (Leopard). # To create a documentation set, doxygen will generate a Makefile in the # HTML output directory. Running make will produce the docset in that # directory and running "make install" will install the docset in # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find # it at startup. # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information. GENERATE_DOCSET = NO # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the # feed. A documentation feed provides an umbrella under which multiple # documentation sets from a single provider (such as a company or product suite) # can be grouped. DOCSET_FEEDNAME = "Doxygen generated docs" # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that # should uniquely identify the documentation set bundle. This should be a # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen # will append .docset to the name. DOCSET_BUNDLE_ID = org.doxygen.Project # If the GENERATE_HTMLHELP tag is set to YES, additional index files # will be generated that can be used as input for tools like the # Microsoft HTML help workshop to generate a compiled HTML help file (.chm) # of the generated HTML documentation. GENERATE_HTMLHELP = NO # If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can # be used to specify the file name of the resulting .chm file. You # can add a path in front of the file if the result should not be # written to the html output directory. CHM_FILE = # If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can # be used to specify the location (absolute path including file name) of # the HTML help compiler (hhc.exe). If non-empty doxygen will try to run # the HTML help compiler on the generated index.hhp. HHC_LOCATION = # If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag # controls if a separate .chi index file is generated (YES) or that # it should be included in the master .chm file (NO). GENERATE_CHI = NO # If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING # is used to encode HtmlHelp index (hhk), content (hhc) and project file # content. CHM_INDEX_ENCODING = # If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag # controls whether a binary table of contents is generated (YES) or a # normal table of contents (NO) in the .chm file. BINARY_TOC = NO # The TOC_EXPAND flag can be set to YES to add extra items for group members # to the contents of the HTML help documentation and to the tree view. TOC_EXPAND = NO # If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and QHP_VIRTUAL_FOLDER # are set, an additional index file will be generated that can be used as input for # Qt's qhelpgenerator to generate a Qt Compressed Help (.qch) of the generated # HTML documentation. GENERATE_QHP = NO # If the QHG_LOCATION tag is specified, the QCH_FILE tag can # be used to specify the file name of the resulting .qch file. # The path specified is relative to the HTML output folder. QCH_FILE = # The QHP_NAMESPACE tag specifies the namespace to use when generating # Qt Help Project output. For more information please see # http://doc.trolltech.com/qthelpproject.html#namespace QHP_NAMESPACE = # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating # Qt Help Project output. For more information please see # http://doc.trolltech.com/qthelpproject.html#virtual-folders QHP_VIRTUAL_FOLDER = doc # If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to add. # For more information please see # http://doc.trolltech.com/qthelpproject.html#custom-filters QHP_CUST_FILTER_NAME = # The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the custom filter to add.For more information please see # Qt Help Project / Custom Filters. QHP_CUST_FILTER_ATTRS = # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this project's # filter section matches. # Qt Help Project / Filter Attributes. QHP_SECT_FILTER_ATTRS = # If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can # be used to specify the location of Qt's qhelpgenerator. # If non-empty doxygen will try to run qhelpgenerator on the generated # .qhp file. QHG_LOCATION = # The DISABLE_INDEX tag can be used to turn on/off the condensed index at # top of each HTML page. The value NO (the default) enables the index and # the value YES disables it. DISABLE_INDEX = NO # This tag can be used to set the number of enum values (range [1..20]) # that doxygen will group on one line in the generated HTML documentation. ENUM_VALUES_PER_LINE = 4 # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index # structure should be generated to display hierarchical information. # If the tag value is set to YES, a side panel will be generated # containing a tree-like index structure (just like the one that # is generated for HTML Help). For this to work a browser that supports # JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). # Windows users are probably better off using the HTML help feature. GENERATE_TREEVIEW = YES # By enabling USE_INLINE_TREES, doxygen will generate the Groups, Directories, # and Class Hierarchy pages using a tree view instead of an ordered list. #USE_INLINE_TREES = YES # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be # used to set the initial width (in pixels) of the frame in which the tree # is shown. TREEVIEW_WIDTH = 250 # Use this tag to change the font size of Latex formulas included # as images in the HTML documentation. The default is 10. Note that # when you change the font size after a successful doxygen run you need # to manually remove any form_*.png images from the HTML output directory # to force them to be regenerated. FORMULA_FONTSIZE = 10 # When the SEARCHENGINE tag is enable doxygen will generate a search box for the HTML output. The underlying search engine uses javascript # and DHTML and should work on any modern browser. Note that when using HTML help (GENERATE_HTMLHELP) or Qt help (GENERATE_QHP) # there is already a search function so this one should typically # be disabled. SEARCHENGINE = YES #--------------------------------------------------------------------------- # configuration options related to the LaTeX output #--------------------------------------------------------------------------- # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will # generate Latex output. GENERATE_LATEX = YES # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `latex' will be used as the default path. LATEX_OUTPUT = latex # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be # invoked. If left blank `latex' will be used as the default command name. LATEX_CMD_NAME = latex # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to # generate index for LaTeX. If left blank `makeindex' will be used as the # default command name. MAKEINDEX_CMD_NAME = makeindex # If the COMPACT_LATEX tag is set to YES Doxygen generates more compact # LaTeX documents. This may be useful for small projects and may help to # save some trees in general. COMPACT_LATEX = NO # The PAPER_TYPE tag can be used to set the paper type that is used # by the printer. Possible values are: a4, a4wide, letter, legal and # executive. If left blank a4wide will be used. PAPER_TYPE = a4wide # The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX # packages that should be included in the LaTeX output. EXTRA_PACKAGES = extra # The LATEX_HEADER tag can be used to specify a personal LaTeX header for # the generated latex document. The header should contain everything until # the first chapter. If it is left blank doxygen will generate a # standard header. Notice: only use this tag if you know what you are doing! LATEX_HEADER = # The LATEX_FOOTER tag can be used to specify a personal $\mbox{\LaTeX}$ footer # for the generated $\mbox{\LaTeX}$ document. The footer should contain # everything after the last chapter. If it is left blank doxygen will generate a # standard footer. # Note: Only use a user-defined footer if you know what you are doing! # This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_FOOTER = # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the LATEX_OUTPUT output # directory. Note that the files will be copied as-is; there are no commands # or markers available. # This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_EXTRA_FILES = extra.sty # If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated # is prepared for conversion to pdf (using ps2pdf). The pdf file will # contain links (just like the HTML output) instead of page references # This makes the output suitable for online browsing using a pdf viewer. PDF_HYPERLINKS = YES # If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of # plain latex in the generated Makefile. Set this option to YES to get a # higher quality PDF documentation. USE_PDFLATEX = YES # If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. # command to the generated LaTeX files. This will instruct LaTeX to keep # running if errors occur, instead of asking the user for help. # This option is also used when generating formulas in HTML. LATEX_BATCHMODE = NO # If LATEX_HIDE_INDICES is set to YES then doxygen will not # include the index chapters (such as File Index, Compound Index, etc.) # in the output. LATEX_HIDE_INDICES = NO # If LATEX_SOURCE_CODE is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output. Note that which sources are shown also depends on other settings such as SOURCE_BROWSER. LATEX_SOURCE_CODE = NO #--------------------------------------------------------------------------- # configuration options related to the RTF output #--------------------------------------------------------------------------- # If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output # The RTF output is optimized for Word 97 and may not look very pretty with # other RTF readers or editors. GENERATE_RTF = NO # The RTF_OUTPUT tag is used to specify where the RTF docs will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `rtf' will be used as the default path. RTF_OUTPUT = rtf # If the COMPACT_RTF tag is set to YES Doxygen generates more compact # RTF documents. This may be useful for small projects and may help to # save some trees in general. COMPACT_RTF = NO # If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated # will contain hyperlink fields. The RTF file will # contain links (just like the HTML output) instead of page references. # This makes the output suitable for online browsing using WORD or other # programs which support those fields. # Note: wordpad (write) and others do not support links. RTF_HYPERLINKS = NO # Load stylesheet definitions from file. Syntax is similar to doxygen's # config file, i.e. a series of assignments. You only have to provide # replacements, missing definitions are set to their default value. RTF_STYLESHEET_FILE = # Set optional variables used in the generation of an rtf document. # Syntax is similar to doxygen's config file. RTF_EXTENSIONS_FILE = #--------------------------------------------------------------------------- # configuration options related to the man page output #--------------------------------------------------------------------------- # If the GENERATE_MAN tag is set to YES (the default) Doxygen will # generate man pages GENERATE_MAN = NO # The MAN_OUTPUT tag is used to specify where the man pages will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `man' will be used as the default path. MAN_OUTPUT = man # The MAN_EXTENSION tag determines the extension that is added to # the generated man pages (default is the subroutine's section .3) MAN_EXTENSION = .3 # If the MAN_LINKS tag is set to YES and Doxygen generates man output, # then it will generate one additional man file for each entity # documented in the real man page(s). These additional files # only source the real man page, but without them the man command # would be unable to find the correct page. The default is NO. MAN_LINKS = NO #--------------------------------------------------------------------------- # configuration options related to the XML output #--------------------------------------------------------------------------- # If the GENERATE_XML tag is set to YES Doxygen will # generate an XML file that captures the structure of # the code including all documentation. GENERATE_XML = NO # The XML_OUTPUT tag is used to specify where the XML pages will be put. # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `xml' will be used as the default path. XML_OUTPUT = xml # The XML_SCHEMA tag can be used to specify an XML schema, # which can be used by a validating XML parser to check the # syntax of the XML files. XML_SCHEMA = # The XML_DTD tag can be used to specify an XML DTD, # which can be used by a validating XML parser to check the # syntax of the XML files. XML_DTD = # If the XML_PROGRAMLISTING tag is set to YES Doxygen will # dump the program listings (including syntax highlighting # and cross-referencing information) to the XML output. Note that # enabling this will significantly increase the size of the XML output. XML_PROGRAMLISTING = YES #--------------------------------------------------------------------------- # configuration options for the AutoGen Definitions output #--------------------------------------------------------------------------- # If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will # generate an AutoGen Definitions (see autogen.sf.net) file # that captures the structure of the code including all # documentation. Note that this feature is still experimental # and incomplete at the moment. GENERATE_AUTOGEN_DEF = NO #--------------------------------------------------------------------------- # configuration options related to the Perl module output #--------------------------------------------------------------------------- # If the GENERATE_PERLMOD tag is set to YES Doxygen will # generate a Perl module file that captures the structure of # the code including all documentation. Note that this # feature is still experimental and incomplete at the # moment. GENERATE_PERLMOD = NO # If the PERLMOD_LATEX tag is set to YES Doxygen will generate # the necessary Makefile rules, Perl scripts and LaTeX code to be able # to generate PDF and DVI output from the Perl module output. PERLMOD_LATEX = NO # If the PERLMOD_PRETTY tag is set to YES the Perl module output will be # nicely formatted so it can be parsed by a human reader. # This is useful # if you want to understand what is going on. # On the other hand, if this # tag is set to NO the size of the Perl module output will be much smaller # and Perl will parse it just the same. PERLMOD_PRETTY = YES # The names of the make variables in the generated doxyrules.make file # are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. # This is useful so different doxyrules.make files included by the same # Makefile don't overwrite each other's variables. PERLMOD_MAKEVAR_PREFIX = #--------------------------------------------------------------------------- # Configuration options related to the preprocessor #--------------------------------------------------------------------------- # If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will # evaluate all C-preprocessor directives found in the sources and include # files. ENABLE_PREPROCESSING = YES # If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro # names in the source code. If set to NO (the default) only conditional # compilation will be performed. Macro expansion can be done in a controlled # way by setting EXPAND_ONLY_PREDEF to YES. MACRO_EXPANSION = YES # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES # then the macro expansion is limited to the macros specified with the # PREDEFINED and EXPAND_AS_DEFINED tags. EXPAND_ONLY_PREDEF = YES # If the SEARCH_INCLUDES tag is set to YES (the default) the includes files # in the INCLUDE_PATH (see below) will be search if a #include is found. SEARCH_INCLUDES = YES # The INCLUDE_PATH tag can be used to specify one or more directories that # contain include files that are not input files but should be processed by # the preprocessor. INCLUDE_PATH = # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard # patterns (like *.h and *.hpp) to filter out the header-files in the # directories. If left blank, the patterns specified with FILE_PATTERNS will # be used. INCLUDE_FILE_PATTERNS = # The PREDEFINED tag can be used to specify one or more macro names that # are defined before the preprocessor is started (similar to the -D option of # gcc). The argument of the tag is a list of macros of the form: name # or name=definition (no spaces). If the definition and the = are # omitted =1 is assumed. To prevent a macro definition from being # undefined via #undef or recursively expanded use the := operator # instead of the = operator. PREDEFINED = "QCC_DEPRECATED(func)=func" # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then # this tag can be used to specify a list of macro names that should be expanded. # The macro definition that is found in the sources will be used. # Use the PREDEFINED tag if you want to use a different macro definition. EXPAND_AS_DEFINED = # If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then # doxygen's preprocessor will remove all function-like macros that are alone # on a line, have an all uppercase name, and do not end with a semicolon. Such # function macros are typically used for boiler-plate code, and will confuse # the parser if not removed. SKIP_FUNCTION_MACROS = YES #--------------------------------------------------------------------------- # Configuration::additions related to external references #--------------------------------------------------------------------------- # The TAGFILES option can be used to specify one or more tagfiles. # Optionally an initial location of the external documentation # can be added for each tagfile. The format of a tag file without # this location is as follows: # # TAGFILES = file1 file2 ... # Adding location for the tag files is done as follows: # # TAGFILES = file1=loc1 "file2 = loc2" ... # where "loc1" and "loc2" can be relative or absolute paths or # URLs. If a location is present for each tag, the installdox tool # does not have to be run to correct the links. # Note that each tag file must have a unique name # (where the name does NOT include the path) # If a tag file is not located in the directory in which doxygen # is run, you must also specify the path to the tagfile here. TAGFILES = # When a file name is specified after GENERATE_TAGFILE, doxygen will create # a tag file that is based on the input files it reads. GENERATE_TAGFILE = # If the ALLEXTERNALS tag is set to YES all external classes will be listed # in the class index. If set to NO only the inherited external classes # will be listed. ALLEXTERNALS = NO # If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed # in the modules index. If set to NO, only the current project's groups will # be listed. EXTERNAL_GROUPS = YES # The PERL_PATH should be the absolute path and name of the perl script # interpreter (i.e. the result of `which perl'). PERL_PATH = /usr/bin/perl #--------------------------------------------------------------------------- # Configuration options related to the dot tool #--------------------------------------------------------------------------- # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base # or super classes. Setting the tag to NO turns the diagrams off. Note that # this option is superseded by the HAVE_DOT option below. This is only a # fallback. It is recommended to install and use dot, since it yields more # powerful graphs. CLASS_DIAGRAMS = YES # You can define message sequence charts within doxygen comments using the \msc # command. Doxygen will then run the mscgen tool (see # http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the # documentation. The MSCGEN_PATH tag allows you to specify the directory where # the mscgen tool resides. If left empty the tool is assumed to be found in the # default search path. MSCGEN_PATH = # If set to YES, the inheritance and collaboration graphs will hide # inheritance and usage relations if the target is undocumented # or is not a class. HIDE_UNDOC_RELATIONS = YES # If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is # available from the path. This tool is part of Graphviz, a graph visualization # toolkit from AT&T and Lucent Bell Labs. The other options in this section # have no effect if this option is set to NO (the default) HAVE_DOT = YES # By default doxygen will write a font called FreeSans.ttf to the output # directory and reference it in all dot files that doxygen generates. This # font does not include all possible unicode characters however, so when you need # these (or just want a differently looking font) you can specify the font name # using DOT_FONTNAME. You need need to make sure dot is able to find the font, # which can be done by putting it in a standard location or by setting the # DOTFONTPATH environment variable or by setting DOT_FONTPATH to the directory # containing the font. #DOT_FONTNAME = FreeSans # The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. # The default size is 10pt. DOT_FONTSIZE = 10 # By default doxygen will tell dot to use the output directory to look for the # FreeSans.ttf font (which doxygen will put there itself). If you specify a # different font using DOT_FONTNAME you can set the path where dot # can find it using this tag. DOT_FONTPATH = # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen # will generate a graph for each documented class showing the direct and # indirect inheritance relations. Setting this tag to YES will force the # the CLASS_DIAGRAMS tag to NO. CLASS_GRAPH = YES # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen # will generate a graph for each documented class showing the direct and # indirect implementation dependencies (inheritance, containment, and # class references variables) of the class with other documented classes. COLLABORATION_GRAPH = YES # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen # will generate a graph for groups, showing the direct groups dependencies GROUP_GRAPHS = YES # If the UML_LOOK tag is set to YES doxygen will generate inheritance and # collaboration diagrams in a style similar to the OMG's Unified Modeling # Language. UML_LOOK = NO # If set to YES, the inheritance and collaboration graphs will show the # relations between templates and their instances. TEMPLATE_RELATIONS = NO # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT # tags are set to YES then doxygen will generate a graph for each documented # file showing the direct and indirect include dependencies of the file with # other documented files. INCLUDE_GRAPH = YES # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and # HAVE_DOT tags are set to YES then doxygen will generate a graph for each # documented header file showing the documented files that directly or # indirectly include this file. INCLUDED_BY_GRAPH = YES # If the CALL_GRAPH and HAVE_DOT options are set to YES then # doxygen will generate a call dependency graph for every global function # or class method. Note that enabling this option will significantly increase # the time of a run. So in most cases it will be better to enable call graphs # for selected functions only using the \callgraph command. CALL_GRAPH = NO # If the CALLER_GRAPH and HAVE_DOT tags are set to YES then # doxygen will generate a caller dependency graph for every global function # or class method. Note that enabling this option will significantly increase # the time of a run. So in most cases it will be better to enable caller # graphs for selected functions only using the \callergraph command. CALLER_GRAPH = NO # If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen # will graphical hierarchy of all classes instead of a textual one. GRAPHICAL_HIERARCHY = YES # If the DIRECTORY_GRAPH, SHOW_DIRECTORIES and HAVE_DOT tags are set to YES # then doxygen will show the dependencies a directory has on other directories # in a graphical way. The dependency relations are determined by the #include # relations between the files in the directories. DIRECTORY_GRAPH = YES # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images # generated by dot. Possible values are png, jpg, or gif # If left blank png will be used. DOT_IMAGE_FORMAT = png # The tag DOT_PATH can be used to specify the path where the dot tool can be # found. If left blank, it is assumed the dot tool can be found in the path. DOT_PATH = # The DOTFILE_DIRS tag can be used to specify one or more directories that # contain dot files that are included in the documentation (see the # \dotfile command). DOTFILE_DIRS = # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of # nodes that will be shown in the graph. If the number of nodes in a graph # becomes larger than this value, doxygen will truncate the graph, which is # visualized by representing a node as a red box. Note that doxygen if the # number of direct children of the root node in a graph is already larger than # DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note # that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. DOT_GRAPH_MAX_NODES = 50 # The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the # graphs generated by dot. A depth value of 3 means that only nodes reachable # from the root by following a path via at most 3 edges will be shown. Nodes # that lay further from the root node will be omitted. Note that setting this # option to 1 or 2 may greatly reduce the computation time needed for large # code bases. Also note that the size of a graph can be further restricted by # DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. MAX_DOT_GRAPH_DEPTH = 3 # Set the DOT_TRANSPARENT tag to YES to generate images with a transparent # background. This is disabled by default, because dot on Windows does not # seem to support this out of the box. Warning: Depending on the platform used, # enabling this option may lead to badly anti-aliased labels on the edges of # a graph (i.e. they become hard to read). DOT_TRANSPARENT = NO # Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output # files in one run (i.e. multiple -o and -T options on the command line). This # makes dot run faster, but since only newer versions of dot (>1.8.10) # support this, this feature is disabled by default. DOT_MULTI_TARGETS = YES # If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will # generate a legend page explaining the meaning of the various boxes and # arrows in the dot generated graphs. GENERATE_LEGEND = YES # If the DOT_CLEANUP tag is set to YES (the default) Doxygen will # remove the intermediate dot files that are used to generate # the various graphs. DOT_CLEANUP = YES alljoyn-15.04b/alljoyn_core/docs/README.android.txt000066400000000000000000000055601255700255500220760ustar00rootroot00000000000000 AllJoyn SDK for Android ----------------------- This subtree contains one complete copy of the AllJoyn SDK for Android, built for a single CPU (either x86 or arm) and VARIANT (either debug or release). The CPU and VARIANT are normally incorporated into the name of the package or folder containing this SDK. Please see ReleaseNotes.txt for the applicable AllJoyn release version and related information on new features and known issues. Summary of file and directory structure: ---------------------------------------- The contents of this SDK are arranged into the following top level folders: cpp/ core AllJoyn functionality, implemented in C++ - built from alljoyn.git source subtrees alljoyn_core and common - required for all AllJoyn applications java/ optional Java language binding (built from alljoyn_java) - required for Android apps c/ optional ANSI C language binding (built from alljoyn_c) about/ implements AllJoyn About Feature. (built from services/about/(cpp and java)) The contents of each top level folder are further arranged into sub-folders: ---------------------------------------------- cpp/ core AllJoyn functionality, implemented in C++ ---------------------------------------------- bin/ executable binaries - as of 3.4.0, several test programs are intentionally removed from published SDK's alljoyn-daemon installable AllJoyn daemon, for OEMs - or devices with super-user access docs/html/ AllJoyn Core API documentation inc/alljoyn/ AllJoyn Core (C++) headers inc/qcc/ lib/ AllJoyn Core (C++) client libraries liballjoyn.a implements core API libajrouter.a implements bundled-router liballjoyn-daemon.a libbbdaemon-lib.a samples/ C++ sample apps for Android (see README) --------------------- java/ Java language binding --------------------- docs/html/ API documentation jar/ client library, misc jar files alljoyn.jar AllJoyn Java API lib/liballjoyn_java.so client library samples/ sample apps for Android (see README) ----------------------- c/ ANSI C language binding ----------------------- docs/html/ API documentation inc/alljoyn_c/ ANSI C headers inc/qcc/ lib/ client libraries --------------------- about/ AllJoyn About Feature --------------------- jar/ alljoyn_about.jar AllJoyn About Java API alljoyn-15.04b/alljoyn_core/docs/README.darwin.txt000066400000000000000000000036431255700255500217420ustar00rootroot00000000000000 AllJoyn SDK for OS X and iOS ---------------------------- This subtree contains one complete copy of the AllJoyn SDK for OS X and iOS. This SDK includes all supported combinations of target type (OS X, iphone OS, iphone OS simulator) CPU (x86, arm, armv7, armv7s, arm64) VARIANT (Debug or Release) Please see alljoyn_objc/README-INSTALLING.txt for instructions on how to install this SDK and use it with Xcode. Please see ReleaseNotes.txt for the applicable AllJoyn release version and related information on new features and known issues. OS X, iPhone, and Xcode are trademarks or registered trademarks of Apple Inc. IOS is a trademark or registered trademark of Cisco in the U.S. and other countries. Summary of file and directory structure: ---------------------------------------- build/ core AllJoyn functionality, implemented in C++ - built from alljoyn.git subtrees alljoyn_core, common, alljoyn_objc - required for all AllJoyn applications darwin/.../dist/cpp/inc/ headers and client libraries, darwin/.../dist/cpp/lib/ in sub-folders by target platform. docs/html/ AllJoyn Core API documentation alljoyn_objc/ Objective-C language binding for core AllJoyn functionality - a direct copy of alljoyn.git subtree alljoyn_objc AllJoynFramework/ OBJC language binding AllJoynFramework_iOS/ alljoyn_darwin.xcodeproj/ Xcode support AllJoynCodeGenerator/ Development aid samples/OSX/ sample apps samples/iOS/ services/about/ AllJoyn "About" Service - a direct copy of alljoyn.git subtree services/about cpp CPP implementation ios OBJC binding alljoyn-15.04b/alljoyn_core/docs/README.linux.txt000066400000000000000000000066601255700255500216170ustar00rootroot00000000000000 AllJoyn SDK for Linux --------------------- This subtree contains one complete copy of the AllJoyn SDK for Linux, built for a single CPU type (either x86 or x86_64) and VARIANT (either debug or release). The CPU and VARIANT are normally incorporated into the name of the package or folder containing this SDK. Please see ReleaseNotes.txt for the applicable AllJoyn release version and related information on new features and known issues. Summary of file and directory structure: ---------------------------------------- The contents of this SDK are arranged into the following top level folders: cpp/ core AllJoyn functionality, implemented in C++ - built from alljoyn.git source subtrees alljoyn_core and common - required for all AllJoyn applications java/ optional Java language binding (built from alljoyn_java) js/ optional Javascript binding (built from alljoyn_js) c/ optional ANSI C language binding (built from alljoyn_c) about/ implements AllJoyn About Feature. (built from services/about/(cpp and java)) The contents of each top level folder are further arranged into sub-folders: ---------------------------------------------- cpp/ core AllJoyn functionality, implemented in C++ ---------------------------------------------- bin/ executable binaries alljoyn-daemon installable AllJoyn daemon bin/samples/ pre-built sample programs SampleDaemon Easy-to-use daemon for use with AllJoyn Thin Client docs/html/ AllJoyn Core API documentation inc/alljoyn/ AllJoyn Core (C++) headers inc/qcc/ lib/ AllJoyn Core (C++) client libraries liballjoyn.a implements core API liballjoyn.so requires LD_LIBRARY_PATH=/path/to/lib/folder libajrouter.a implements bundled-router samples/ C++ sample programs (see README) --------------------- java/ Java language binding --------------------- docs/html/ API documentation jar/ client library, misc jar files alljoyn.jar AllJoyn Java API lib/liballjoyn_java.so client library samples/ sample programs (see README) --------------------------- js/ Javascript language binding --------------------------- docs/html/ API documentation lib/libnpalljoyn.so Installable Netscape plugin for AllJoyn samples/ sample Javascript apps ----------------------- c/ ANSI C language binding ----------------------- docs/html/ API documentation inc/alljoyn_c/ ANSI C headers inc/qcc/ lib/ client libraries --------------------- about/ AllJoyn About Feature --------------------- bin/ pre-built sample apps jar/ client library, misc jar files alljoyn_about.jar About Java API inc/alljoyn/about About C++ headers lib/ About C++ client libraries liballjoyn_about.a liballjoyn_about.so alljoyn-15.04b/alljoyn_core/docs/README.windows.txt000066400000000000000000000065501255700255500221500ustar00rootroot00000000000000 AllJoyn SDK for Windows 7 ------------------------- This subtree contains one complete copy of the AllJoyn SDK for Windows 7, built for a single CPU type (x86 or x86_64), VARIANT (either debug or release), and for a single version of Microsoft Visual Studio (Visual Studio 2012, or Visual Studio 2013 depending on the version of the AllSeen SDK that you downloaded). The CPU, VARIANT, and MSVS version is normally incorporated into the name of the package or folder containing this SDK. NOTE: This SDK works with the Microsoft Win32 architecture, used in traditional Microsoft Windows desktops and servers with x86 or x86_64 CPUs. This SDK does NOT work with the Microsoft Windows 10 UWP (Universal Windows Platform) architecture. Please download the Windows 10 SDK in order to develop UWP applications for Windows 10. Windows, Win32, UWP, and Visual Studio are registered trademarks or trademarks of Microsoft. Please see ReleaseNotes.txt for the applicable AllJoyn release version and related information on new features and known issues. Summary of file and directory structure: ---------------------------------------- The contents of this SDK are arranged into the following top level folders: cpp/ core AllJoyn functionality, implemented in C++ - built from alljoyn.git source subtrees alljoyn_core and common - required for all AllJoyn applications java/ optional Java language binding (built from alljoyn_java) c/ optional ANSI C language binding (built from alljoyn_c) The contents of each top level folder are further arranged into sub-folders: ---------------------------------------------- cpp/ core AllJoyn functionality, implemented in C++ ---------------------------------------------- bin/ executable binaries bin/samples/ pre-built sample programs docs/html/ AllJoyn Core API documentation inc/alljoyn/ AllJoyn Core (C++) headers inc/qcc/ lib/ AllJoyn Core (C++) client libraries alljoyn.lib Implements core API alljoyn_about.lib Implements About interface ajrouter.lib Implements bundled-router daemonlib.lib AllJoyn router node library samples/ C++ sample programs (see README) --------------------- java/ Java language binding --------------------- docs/html/ API documentation jar/ client library, misc jar files lib/alljoyn_java.dll client libraries lib/alljoyn_java.exp lib/alljoyn_java.lib samples/ sample programs (see README) ----------------------- c/ ANSI C language binding ----------------------- docs/html/ API documentation inc/alljoyn_c/ ANSI C headers inc/qcc/ lib/ client libraries Windows 10 AllJoyn resources ---------------------------- Preliminary Windows 10 AllJoyn documentation: https://msdn.microsoft.com/en-us/library/windows/apps/windows.devices.alljoyn.aspx Windows 10 AllJoyn secure samples: http://go.microsoft.com/fwlink/p/?LinkID=534021 http://go.microsoft.com/fwlink/p/?LinkId=534025 Building Windows 10 AllJoyn Apps step-by-step: bit.ly/1zkgrvUalljoyn-15.04b/alljoyn_core/docs/ReleaseNotes.txt000066400000000000000000000321121255700255500221040ustar00rootroot00000000000000AllJoyn Version 15.04b Release Notes ===================================== Fully Validated Platforms ------------------------- 1) Linux Ubuntu 14.04 LTS (64 bit) 2) Android JellyBean 4.1 (ARM7) 3) Windows 7/8.1 (64 bit) 4) Windows 10 Insider Preview (64 bit) 5) iOS 8.1 6) OSX 10.9 Lion 7) OpenWRT Barrier Breaker and Chaos Calmer branches See the release review page for other platforms that have not been fully verified, but may work: https://wiki.allseenalliance.org/core/core_15.04_release_review?&#regression_test Features added in Version 15.04b -------------------------------- * Property cache feature which adds a simple, optional cache to ProxyBusObject that keeps track of property values as received in GetProperty, GetAllProperties calls and PropertiesChanged signals. (ASACORE-1569) * Support for X.509 ECDSA digital certificates, which replace the X.509 RSA certificates. (ASACORE-1561) * Remove excessive name transfer for all sessions. This limits the names exchanged to just the routing node and host/joiners as a part of an effort to reduce network traffic. (ASACORE-1392) * Observer Functionality: this feature simplifies interface based discovery of bus objects by filtering such that listeners only trigger if something relevant has changed in an About Announcement. It also enables automatic session setup and takes care of proxy bus object creation and life-cycle management. (ASACORE-1383) * It is now possible to build for Android without requiring OpenSSL from the platform, this greatly simplifies making Android builds. (ASACORE-1248) * Add to About C API: a second announce_using_datalistener method was added that takes as argument an AboutDataListener instead of AboutData. (ASACORE-1363) * Add support for detecting idle RNs allowing the RN to shut down automatically if no LNs have used its services for a while. (ASACORE-1186) * Support for iOS 8.1 (ASACORE-936) Issues Addressed in Version 15.04b ---------------------------------- ASACORE-370 AllJoyn does not build with Android 4.4 (KitKat) sources ASACORE-732 Duplicate About announcements received while running large number of About based applications ASACORE-1046 iOS: 14.12 app coming into foreground after suspension causes 1 thread with 100% CPU usage ASACORE-1253 C++ sample apps discover and join session twice, print errors upon exit. ASACORE-1300 After performing wireless interface up/down outstanding advertisement and discovery queries are sent out on IPv6 only ASACORE-1391 C-style exports in C++ API headers needs AJ_CALL annotation ASACORE-1396 Crash if WSARecvMsg returns an error ASACORE-1557 A routing node should not respond to a Thin Client if it doesn't have any available TCP slots. ASACORE-1603 Invoking AboutData::CreateFromXml() results in a seg fault when a required About field is missing in the XML data that is passed in ASACORE-1853 NGNS query responses for openly advertised names are sent as multicast ASACORE-1917 Objective-C AJNObserver may deadlock upon dealloc ASACORE-1920 Potential Buffer Overflow error in windows Event::Wait code ASACORE-1921 NGNS sends duplicate mDNS packets ASACORE-1929 ASN.1 parsing error cause core dump ASACORE-1934 Race condition in Thread::Join can cause use-after-free ASACORE-1946 Windows Readme is inaccurate. ASACORE-1954 alljoyn_aboutdata_setappid_fromstring missing from Windows C API DLL exports ASACORE-1959 Memory leak with EnablePeerSecurity ASACORE-1960 Secure samples are missing from 15.04 SDKs ASACORE-1961 About samples for C Binding are broken (need alljoyn_init) ASACORE-1975 Unable to send message from chat sample ASACORE-1977 assertion error in IpNameServiceImpl::ComputeDynamicScore ASACORE-1978 AllJoyn returns the incorrect error if connecting to the named pipe fails ASACORE-2000 Windows Daemon and SCL are using reserved TCP port 9956 ASACORE-2018 NGNS unicast responses to ephemeral ports is problematic for firewall settings ASACORE-2032 Reduce error traces in "happy" path ASACORE-2035 Fix memory leaks in AboutData and AboutObjectDescription ASACORE-2048 SessionLost callback cannot be used reliably for destroying SessionListener object ASACORE-2247 Allow little-endian CTR block counter to go past 511 (Android) For a complete list of fixed issues: https://jira.allseenalliance.org/issues/?jql=project%20%3D%20ASACORE%20AND%20fixVersion%20in%20(%2215.04%22%2C%20%2215.04a%22%2C%20%2215.04b%22)%20AND%20component%20%3D%20%22Router%2FSCL%22%20ORDER%20BY%20key%20ASC Known Issues in Version 15.04b ------------------------------ ASACORE-49 Multipoint session lost on joiner side and not binder side prevents joiner from rejoining ASACORE-181 Memory leak on repeated registration/unregistration of the same BusObject: note this is an unusual use case ASACORE-367 Router AJ objects that don't call BusController::ObjectRegister() due to a failure will cause the program to lockup in a fast spinning while/sleep loop ASACORE-1244 Legacy About service truncates the AppID to 16 bytes ASACORE-1286 FindAdvertisedName does not work with certain config options ASACORE-1394 AllJoyn Signal sent on an non-existent session id should not return ER_OK ASACORE-1493 Ping in AboutListener::Announced fails ASACORE-1600 iOS AboutService sample can not inter-operate with Java AboutClient sample ASACORE-1714 ECDSA Certificate generation APIs should be implemented for language bindings. ASACORE-1715 Private key protection support for using pass-phrase not applicable for ECDHE_ECDSA mechanism. ASACORE-1827 GetTimestamp() function on Darwin is not monotonic ASACORE-1865 Lost advertisement packets for quietly advertised names are sent out actively. ASACORE-1867 TRANSPORT_LOCAL SessionOpts does not work ASACORE-1886 Deadlock in UDPTransport shutdown ASACORE-1892 'iface' parameters in config file can't use Interface GUID from Windows command line ASACORE-1893 Interface org.allseen.Introspectable cannot be marked as ANNOUNCED until RegisterBusObject is called ASACORE-1894 Race condition between alljoyn_busobject_signal and alljoyn_busobject_cancelsessionlessmessage ASACORE-1904 javascript NPAPI plug-in crashes Firefox. ASACORE-1907 Permission Functionality in Android does not work correctly For a complete list of open issues: https://jira.allseenalliance.org/issues/?jql=project%3D%22Core%20SW%22%20AND%20status%20not%20in%20(closed%2C%20resolved)%20AND%20type%20not%20in%20(task%2C%20%22New%20Feature%22)%20%20AND%20component%20%3D%20%22Router%2FSCL%22%20ORDER%20BY%20priority%20DESC%2C%20id%20ASC Compatibility ------------- Version 15.04: * The AllJoyn Protocol Version changed from 11 to 12. While routers will support applications using older versions, the reverse is not true; i.e. applications requiring version 12 router features of will not work with older routers. * Uncrustify (white space checker) was migrated from v0.57 to v0.61; not updating the tool chain will cause the builds to break (ASACORE-1026) * Applications are now required to call AllJoynInit() before any other AllJoyn calls,and AllJoynShutdown() after all other AllJoyn calls are complete (ASACORE-1342); as such, it is a change to the developer APIs, not to the wire protocol and will not impact inter-version inter-operability. * The names that are exchanged between Routers have changed (ASACORE-1392); specifically the number of names exchanged between 15.04 nodes has been greatly reduced, but is not expected to create inter-version compatibility issues as the original behavior is executed when interacting with older routers. The change also has some API changes that *may* have an impact on developers. * The handling of ProxyBusObjects has changed to make them more sharable. Public APIs were deprecated and new calls were added. PropertyChangedListener callbacks get passed a new instance of ProxyBusObject that references the state information of the ProxyBusObject the listener was registered with. If a derived class was registered instead, the PropertyChangedListener cannot cast the returned ProxyBusObject instance back into the derived class. If information from the derived class needs to be delivered to the callback, then it must be passed in as a context pointer. More details can be found in ASACORE-1522. * Header compression support was removed (ASACORE-1534). This will only be an issue in the case where some applications are enabling header compression. This is unlikely as the feature was added to support sending small signals over BT carriers, and BT hasn't been a supported transport since pre-AllSeen AllJoyn releases. * The removal of PIN_KEYX from Standard Core Library (ASACORE-1641) will introduce inter-version inter-operability issues in the following scenarios: 1) Pre-14.06 TC applications will not be able to connect to secured 15.04 Routing Nodes. 2) Any pre-15.04 applications that expose or use secure interfaces and only support PIN_KEYX will no longer work with their 15.04 or later peers. * Support for DBUS_COOKIE_SHA1 authentication was removed (ASACORE-1713) - this means that as of 15.04 it will not be possible to use the Standard Core Library with the D-Bus Daemon if that authentication method is required. * Support for RSA authentication has been removed (ASACORE-1716); X.509-based certificate authentication is instead supported with ECDSA (ASACORE-1561). * Support for SPKI certificates for ECDHE_ECDSA was removed; as there were no public APIs exposing this functionality the impact of this change is expected to be minimal. * Multipoint session member attach does not work in some backward compatibility scenarios (ASACORE-1738) * The default configuration of the Windows Routing Node (daemonlib.dll) has changed to accept connections on TCP port 9955 instead of TCP port 9956 (ASACORE-2000); the default bus connect spec on Windows has been changed accordingly. Older Windows apps (using the older default bus connect spec) will no longer be able to connect to a 15.04 routing node. These apps should be recompiled using the new default connect spec. They may also require changes to your firewall settings. * Another impact of ASACORE-2000 is 15.04 Bundled Routers now only accept connections on ephemeral TCP and UDP ports and don’t accept any connections using other transports. This means that applications using the default bus connect spec can no longer connect to a 15.04 Bundled Router on the local machine that is using the default bundledConfig settings. * The SessionListener::SessionLost(SessionId sessionId) callback (which has been deprecated since before 14.02) has been removed (ASACORE-2048). Applications should instead use: SessionListener::SessionLost(SessionId sessionId, SessionLostReason reason) By example the following sample source code has been updated with this change: * alljoyn_core/samples/eventaction/SimpleRulesEngine/Rule.cc * services/about/cpp/samples/AboutClientSample/AboutClientSessionListener.cc Existing applications recompiled with this release will notice that their SessionLost(SessionId sessionId) callback will no longer be called. More details on these changes can be found on the release plan page: https://wiki.allseenalliance.org/core/core_15.04_release_plan#compatibility_with_previous_releases For details of previous releases/release families please see the release notes: 14.12: https://git.allseenalliance.org/cgit/core/alljoyn.git/plain/alljoyn_core/docs/ReleaseNotes.txt?h=RB14.12 14.06: https://git.allseenalliance.org/cgit/core/alljoyn.git/plain/alljoyn_core/docs/ReleaseNotes.txt?h=RB14.06 14.02: https://git.allseenalliance.org/cgit/core/alljoyn.git/tree/alljoyn_core/docs/ReleaseNotes.txt?id=v14.02 Change history ------------- 15.04b - Bug fixes: ASACORE-2247, ASACORE-2270 15.04a - Bug fixes: ASACORE-1917, ASACORE-1920, ASACORE-1921, ASACORE-1929, ASACORE-1934, ASACORE-1946, ASACORE-1954, ASACORE-1959, ASACORE-1960, ASACORE-1961, ASACORE-1975, ASACORE-1977, ASACORE-1978, ASACORE-2000, ASACORE-2018, ASACORE-2032, ASACORE-2035, ASACORE-2048 15.04 - Bug fixes, further improvements to scalability and performance, new features. 14.12b - Bug fixes: ASACORE-780, ASACORE-1143, ASACORE-1504, ASACORE-1549, ASACORE-1576, ASACORE-1596 14.12a - Bug fixes: ASACORE-1324, ASACORE-1325, ASACORE-1333, ASACORE-1334, ASACORE-1336, ASACORE-1337, ASACORE-1355, ASACORE-1366, ASACORE-1368, ASACORE-1369, ASACORE-1390, ASACORE-1402, ASACORE-1417 14.12 - Bug fixes, major improvements to address scalability and stability, new features. 14.06a - Bug fixes: ASACORE-713, ASACORE-747, ASACORE-760, ASACORE-779, ASACORE-788, ASACORE-808, ASACORE-809, ASACORE-814, ASACORE-858, ASACORE-863, ASACORE-909 and ASACORE-921. 14.06 - Stability Bug fixes. Removed support for ICE. Added a number of features listed above. 14.02 - Bug fixes. Removed support for Windows RT. 3.4.6 - Bug fixes. Improve CPU and memory usage when using sessionless signals. alljoyn-15.04b/alljoyn_core/docs/SConscript000066400000000000000000000063301255700255500207670ustar00rootroot00000000000000# Copyright AllSeen Alliance. All rights reserved. # # Permission to use, copy, modify, and/or distribute this software for any # purpose with or without fee is hereby granted, provided that the above # copyright notice and this permission notice appear in all copies. # # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. # import os Import('ajenv') Import('core_headers') docenv = ajenv.Clone() docenv['ENV']['CPP_DISTDIR'] = str(docenv.Dir('$CPP_DISTDIR')) installedDocs = None # Build docs if docenv['DOCS'] == 'html': installedDocs = docenv.Doxygen(source='Doxygen_html') elif docenv['DOCS'] == 'dev': installedDocs = docenv.Doxygen(source='Doxygen_dev') elif docenv['DOCS'] == 'pdf': docenv.Doxygen(source='Doxygen_pdf', target=['./latex/refman.tex']) # copy the custom style to the latex folder generated by doxygen. # this command is not needed if we are using doxygen 1.8 or newer. Command('./latex/extra.sty','./extra.sty',Copy("$TARGET", "$SOURCE")) # override the default pdflatex command line command. This is identical to # built in command for pdflatex except the '-' character has been added to # the start of the command. Since doxygen is producing the *.tex source # files we have no control on the output. We do not modify the produced # *.tex files. If there is an error the '-' will prevent this command # halting the build for something we have no control over. docenv['PDFLATEXCOM'] = '-cd ${TARGET.dir} && $PDFLATEX $PDFLATEXFLAGS ${SOURCE.file}' # Increase the default LATEXRETRIES from 3 to 5. This will improve the cross # reference links in the produced documentation. docenv['LATEXRETRIES'] = 5 # since creation of the pdf produces many files other than the final pdf # we build the pdf in the docs folder then copy the final file into the # distribution folder. This way we don't get meaningless output in the # distribution folder. output = docenv.PDF('./pdf/alljoyn_api_manual.pdf', './latex/refman.tex') installedDocs = docenv.Install('$CPP_DISTDIR/docs/pdf', output) docenv.Clean('Doxygen_pdf', Dir('pdf')) docenv.Depends(installedDocs, output) elif docenv['DOCS'] == 'sandcastle': if not os.environ.has_key('SHFBROOT'): print 'Missing required environment build variable SHFBROOT' if not GetOption('help'): Exit(1) chm_env = docenv.Clone(); # import the envrionment variable from the system shfbroot = chm_env.Dir(os.environ['SHFBROOT']) if installedDocs: docenv.Depends(installedDocs, core_headers); # Build Alias to make cleaning, building and rebuilding the documentation when # working only on the documentation simpler. This can be run by using # `scons core_docs` docenv.Alias('core_docs', installedDocs) alljoyn-15.04b/alljoyn_core/docs/allJoynDocumentation000066400000000000000000000115371255700255500230470ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ /*This file will contain documentation for AllJoyn that does not fit in the source code. * This is also a location to document things that don't have a clear place where they * should be documented in the code. (i.e. namespace ajn). * * This file will be parsed by doxygen. Only text within the doxygen tags will show up in * the final documentation. */ /* * the namespace 'alljoyn' is used in so many locations that there is no single location that * it makes since to document that namespace so it has been documented here. */ /** * @namespace ajn * namespace used for the AllJoyn API */ /** * @namespace services * namespace used by AllJoyn services */ /** * *@mainpage AllJoyn Documentation * *AllJoyn C++ API Reference Manual @section subsection1 Overview AllJoyn is a device-to-device communication protocol which enables mobile devices to support peer-to-peer applications such as multi-player gaming and social networking. AllJoyn is designed as a backwards-compatible extension of DBus, a standard protocol for inter-application communication in the Linux desktop environment. It offers the following features: - Cross platform/OS/device - Peer-to-peer communication - Simplified service discovery - Flexible security framework and trust models - Transport agnostic / multi-protocol support - Multi-language support for the AllJoyn API This document describes the C++ language binding for the AllJoyn API. It covers the following topics: - @ref section2 "Type Signatures" - @ref section3 "Messages" - @ref section4 "Signals" @section section2 Type Signatures AllJoyn uses the same type signatures that are used by the Dbus protocol. The type signature is made up of type codes . Type code is an ASCII character that represents a standard data type. The following table summarizes the AllJoyn types.
Conventional NameCodeDescription
INVALID0 (ASCII NUL)Not a valid type code, used to terminate signatures
BYTE121 (ASCII 'y')8-bit unsigned integer
BOOLEAN98 (ASCII 'b')Boolean value, 0 is FALSE and 1 is TRUE. Everything else is invalid.
INT16110 (ASCII 'n')16-bit signed integer
UINT16113 (ASCII 'q')16-bit unsigned integer
INT32105 (ASCII 'i')32-bit signed integer
UINT32117 (ASCII 'u')32-bit unsigned integer
INT64120 (ASCII 'x')64-bit signed integer
UINT64116 (ASCII 't')64-bit unsigned integer
DOUBLE100 (ASCII 'd')IEEE 754 double
STRING115 (ASCII 's')UTF-8 string (must be valid UTF-8). Must be nul terminated and contain no other nul bytes.
OBJECT_PATH111 (ASCII 'o')Name of an object instance
SIGNATURE103 (ASCII 'g')A type signature
ARRAY97 (ASCII 'a')Array
STRUCT114 (ASCII 'r'), 40 (ASCII '('), 41 (ASCII ')')Struct
VARIANT118 (ASCII 'v') Variant type (the type of the value is part of the value itself)
DICT_ENTRY101 (ASCII 'e'), 123 (ASCII '{'), 125 (ASCII '}') Entry in a dict or map (array of key-value pairs)
For of the types are container types. STRUCT, ARRAY, VARIANT, and DICT_ENTRY . All other types are a common basic data type. @section section3 Message A message is a unit of communication via the AllJoyn protocol. A message can send an receive any number of values. @section section4 Signals A signal is an outbound value that is transmitted on the bus. */alljoyn-15.04b/alljoyn_core/docs/extra.sty000066400000000000000000000014261255700255500206420ustar00rootroot00000000000000\NeedsTeXFormat{LaTeX2e} \ProvidesPackage{extra} % Packages used by this style file \RequirePackage{fancyhdr} % Setup fancy headings \pagestyle{fancy} %override the plain style so that it has head rule and foot rule (horizontal line) \fancypagestyle{plain}{ \renewcommand{\headrulewidth}{0.4pt} \renewcommand{\footrulewidth}{0.4pt}} \footskip = 40pt %header from right to left \rhead{\bfseries\leftmark}% \lhead{\bfseries AllJoyn\texttrademark{} C++ API Reference Manual}% %footer from right to left \rfoot{ \begin{tabular}{l p{5in}} Version 15.04.00b & \footnotesize{Copyright AllSeen Alliance.} \\ \multicolumn{2}{c}{\thepage} \\ \multicolumn{2}{c}{\scriptsize\textbf{ MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATION}} \\ \end{tabular} } \cfoot{} \lfoot{} alljoyn-15.04b/alljoyn_core/docs/footer.html000066400000000000000000000024321255700255500211400ustar00rootroot00000000000000
$projectname $projectnumber ($datetime)
Copyright AllSeen Alliance, Inc. All Rights Reserved.

AllSeen, AllSeen Alliance, and AllJoyn are trademarks of the AllSeen Alliance, Inc in the United States and other jurisdictions.

THIS DOCUMENT AND ALL INFORMATION CONTAIN HEREIN ARE PROVIDED ON AN "AS-IS" BASIS WITHOUT WARRANTY OF ANY KIND.
MAY CONTAIN U.S. AND INTERNATIONAL EXPORT CONTROLLED INFORMATION
 alljoyn-15.04b/alljoyn_core/docs/introspect.xsd000066400000000000000000000131671255700255500216750ustar00rootroot00000000000000 alljoyn-15.04b/alljoyn_core/docs/legal/000077500000000000000000000000001255700255500200375ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/docs/legal/legal_notice.html000066400000000000000000000004641255700255500233560ustar00rootroot00000000000000 Legal Notice © AllSeen Alliance.
alljoyn-15.04b/alljoyn_core/inc/000077500000000000000000000000001255700255500165745ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/inc/.gitignore000066400000000000000000000000111255700255500205540ustar00rootroot00000000000000Status.h alljoyn-15.04b/alljoyn_core/inc/alljoyn/000077500000000000000000000000001255700255500202445ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/inc/alljoyn/AboutData.h000066400000000000000000001006201255700255500222600ustar00rootroot00000000000000/** * @file * This contains the AboutData class responsible for holding the org.alljoyn.About * interface data fields. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_ABOUTDATA_H #define _ALLJOYN_ABOUTDATA_H #include #include #include #include #include namespace ajn { /** * AboutData is responsible for holding the org.alljoyn.about interface Data fields */ class AboutData : public AboutDataListener, public AboutKeys { public: /** * Create an AboutData class. The default language will will not be set. * Use the constructor that takes a default language tag; or set the * language using the SetDefaultLanguage member function, CreateFromMsgArg * member function or the CreateFromXml member function. * * The default language should be specified before any tag that requires * localization. These tags are. * - DeviceName * - AppName * - Manufacturer * - Description */ AboutData(); /** * constructor * * @param defaultLanguage the default language for the AboutData fields */ AboutData(const char* defaultLanguage); /** * constructor * * Fill in the fields of the AboutData class using a MsgArg. The provided * MsgArg must contain a dictionary with signature a{sv} with AboutData fields. * * If the passed in MsgArg is an ill formed AboutData MsgArg this constructor * will fail silently. If the MsgArg does not come from About Announce signal * it is best to create an empty AboutData class and use the CreatFromMsgArg * member function to fill in the AboutData class. * * @param arg MsgArg with signature a{sv}containing AboutData fields. * @param language the language of the arg MsgArg. Use NULL for default language */ AboutData(const MsgArg arg, const char* language = NULL); /** * Copy constructor * * @param src The AboutData instance to be copied */ AboutData(const AboutData& src); /** * Assignment operator * * @param src The AboutDate instance to be assigned * * @return copy of the AboutData src */ AboutData& operator=(const AboutData& src); /** * Destructor */ ~AboutData(); /** * use an xml representation of AboutData to set the about data. @code "" " 000102030405060708090A0B0C0D0E0C" " en" " My Device Name" " Nombre de mi dispositivo" " 93c06771-c725-48c2-b1ff-6a2a59d445b8" " My Application Name" " Mi Nombre de la aplicacion" " Company" " Empresa" " Wxfy388i" " A detailed description provided by the application." " Una descripcion detallada proporcionada por la aplicacion." " 2014-01-08" " 1.0.0" " 1.0.0" " www.example.com" "" @endcode * * The CreateFromXml function will attempt to process the entire xml passed * in. If an error is encountered it will continue to try and process the * xml. If multiple errors are encountered the last error is returned. * * Note: AJSoftwareVersion is automatically set to the version of Alljoyn that * is being used. The SupportedLanguages tag is automatically implied from * the DefaultLanguage tag and the lang annotation from tags that are * localizable. * * @param[in] aboutDataXml a string that contains an XML representation of * the AboutData fields. * @return * - ER_OK on success * - ER_ABOUT_ABOUTDATA_MISSING_REQUIRED_FIELD if the XML representation * did not include all required AboutData fields. * - ER_ABOUT_DEFAULT_LANGUAGE_NOT_SPECIFIED if a localizable value was * was found with out the `lang` attribute and the DefaultLanguage * field is missing. */ QStatus CreateFromXml(const qcc::String& aboutDataXml); /** * use an xml representation of AboutData to set the about data. @code "" " 000102030405060708090A0B0C0D0E0C" " en" " My Device Name" " Nombre de mi dispositivo" " 93c06771-c725-48c2-b1ff-6a2a59d445b8" " My Application Name" " Mi Nombre de la aplicacion" " Company" " Empresa" " Wxfy388i" " A detailed description provided by the application." " Una descripcion detallada proporcionada por la aplicacion." " 2014-01-08" " 1.0.0" " 1.0.0" " www.example.com" "" @endcode * * The CreateFromXml function will attempt to process the entire xml passed * in. If an error is encountered it will continue to try and process the * xml. If multiple errors are encountered the last error is returned. * * Note: AJSoftwareVersion is automatically set to the version of Alljoyn that * is being used. The SupportedLanguages tag is automatically implied from * the DefaultLanguage tag and the lang annotation from tags that are * localizable. * * @param[in] aboutDataXml a string that contains an XML representation of * the AboutData fields. * @return * - ER_OK on success * - ER_ABOUT_ABOUTDATA_MISSING_REQUIRED_FIELD if the XML representation * did not include all required AboutData fields. * - ER_ABOUT_DEFAULT_LANGUAGE_NOT_SPECIFIED if a localizable value was * was found with out the `lang` attribute and the DefaultLanguage * field is missing. */ QStatus CreateFromXml(const char* aboutDataXml); /** * The AboutData has all of the required fields * * If a language field is given this will return if all required fields are * listed for the given language. * * If no language is given default language will be checked * * @param[in] language IETF language tags specified by RFC 5646 * * @return true if all required field are listed for the given language */ bool IsValid(const char* language = NULL); /** * Fill in the AboutData fields using a MsgArg * * The MsgArg must contain a dictionary of type a{sv} The expected use of this * class is to fill in the AboutData using a MsgArg obtain from the Announce * signal or the GetAboutData method from org.alljoyn.about interface. * * @param arg MsgArg contain AboutData dictionary * @param language the language for the MsgArg AboutData. * If NULL the default language will be used * * @return ER_OK on success */ QStatus CreatefromMsgArg(const MsgArg& arg, const char* language = NULL); /** * Set the AppId for the AboutData * * AppId Should be a 128-bit UUID as specified in by RFC 4122. * * Passing in non-128-bit byte arrays will still Set the AppId but the * SetAppId member function will always return * ER_ABOUT_INVALID_ABOUTDATA_FIELD_VALUE and the application will fail * certification and compliance testing. * * AppId IS required * AppId IS part of the Announce signal * AppId CAN NOT be localized for other languages * * @param[in] appId the a globally unique array of bytes used as an ID for the application * @param[in] num the number of bites in the appId array * * @return * - #ER_OK on success * - #ER_ABOUT_INVALID_ABOUTDATA_FIELD_APPID_SIZE if the AppId is not a 128-bits (16 bytes) */ QStatus SetAppId(const uint8_t* appId, const size_t num = 16); /** * Get the AppId from the AboutData * * AppId IS required * AppId IS part of the Announce signal * AppId CAN NOT be localized for other languages * * @param[out] appId a pointer to an array of bites used as a globally unique ID for an application * @param[out] num the size of the appId array * * @return ER_OK on success */ QStatus GetAppId(uint8_t** appId, size_t* num); /** * Set the AppId for the AboutData using a string. * * The string must be a ether a 32-character hex digit string * (i.e. 4a354637564945188a48323c158bc02d). * or a UUID string as specified in RFC 4122 * (i.e. 4a354637-5649-4518-8a48-323c158bc02d) * AppId should be a 128-bit UUID as specified in by RFC 4122 * * Unlike SetAppId(const uint8_t*, const size_t) this member function will * only set the AppId if the string is 32-character hex digit string or a * UUID as specified by RFC 4122. * * AppId IS required * AppId IS part of the Announce signal * AppId CAN NOT be localized for other languages * * * @see #SetAppId(const uint8_t*, const size_t) * * @param[in] appId String representing a globally unique array of bytes * used as an ID for the application. * * @return * - #ER_OK on success * - #ER_ABOUT_INVALID_ABOUTDATA_FIELD_APPID_SIZE if the AppId is not a 128-bits (16 bytes) * - #ER_ABOUT_INVALID_ABOUTDATA_FIELD_VALUE if unable to parse the appId string. */ QStatus SetAppId(const char* appId); /** * This language is automatically added to the SupportedLanguage list. The * language tag should be an IETF language tag specified by RFC 5646 * * DefaultLanguage is Required * DefaultLanguage is part of the Announce signal * * @param[in] defaultLanguage the IETF language tag * * @return ER_OK on success */ QStatus SetDefaultLanguage(const char* defaultLanguage); /** * Get the DefaultLanguage from the AboutData * * @param[out] defaultLanguage a pointer to the default language tag * * @return ER_OK on success */ QStatus GetDefaultLanguage(char** defaultLanguage); /** * Set the DeviceName to the AboutData * * DeviceName is not required * DeviceName is part of the Announce signal * DeviceName can be localized for other languages * * @param[in] deviceName the deviceName (UTF8 encoded string) * @param[in] language the IETF language tag specified by RFC 5646 * if language is NULL the DeviceName will be set for the default language. * * @return * - #ER_OK on success * - #ER_ABOUT_DEFAULT_LANGUAGE_NOT_SPECIFIED if language tag was not specified * and the default language is also * not found. */ QStatus SetDeviceName(const char* deviceName, const char* language = NULL); /** * Get the DeviceName from the About data * * DeviceName is not required * DeviceName is part of the Announce signal * DeviceName can be localized for other languages * * @param[out] deviceName the deviceName found in the AboutData (UTF8 encoded string) * @param[in] language the IETF language tag specified by RFC 5646 * if language is NULL the DeviceName for the default language will be returned. * * @return ER_OK on success */ QStatus GetDeviceName(char** deviceName, const char* language = NULL); /** * Set the DeviceId from the AboutData * * DeviceId IS required * DeviceId IS part of the announce signal * DeviceId CAN NOT be localized for other languages * * @param[in] deviceId is a string with a value generated using platform specific means * * @return ER_OK on success */ QStatus SetDeviceId(const char* deviceId); /** * Get the DeviceId from the AboutData * * DeviceId IS required * DeviceId IS part of the announce signal * DeviceId CAN NOT be localized for other languages * * @param[out] deviceId is a string with a value generated using platform specific means * * @return ER_OK on success */ QStatus GetDeviceId(char** deviceId); /** * Set the AppName to the AboutData * * AppName is required * AppName is part of the announce signal * AppName can be localized for other languages * * @param[in] appName the AppName (UTF8 encoded string) * @param[in] language the IETF language tag specified by RFC 5646 * if language is NULL the AppName will be set for the default language. * * @return * - #ER_OK on success * - #ER_ABOUT_DEFAULT_LANGUAGE_NOT_SPECIFIED if language tag was not specified * and the default language is also * not found. */ QStatus SetAppName(const char* appName, const char* language = NULL); /** * Get the AppName from the About data * * AppName is required * AppName is part of the announce signal * AppName can be localized for other languages * * @param[out] appName the AppName found in the AboutData (UTF8 encoded string) * @param[in] language the IETF language tag specified by RFC 5646 * if language is NULL the AppName for the default language will be returned. * * @return ER_OK on success */ QStatus GetAppName(char** appName, const char* language = NULL); /** * Set the Manufacture to the AboutData * * Manufacture is required * Manufacture is part of the announce signal * Manufacture can be localized for other languages * * @param[in] manufacturer the Manufacturer (UTF8 encoded string) * @param[in] language the IETF language tag specified by RFC 5646 * if language is NULL the Manufacture will be set for the default language. * * @return * - #ER_OK on success * - #ER_ABOUT_DEFAULT_LANGUAGE_NOT_SPECIFIED if language tag was not specified * and the default language is also * not found. */ QStatus SetManufacturer(const char* manufacturer, const char* language = NULL); /** * Get the Manufacturer from the About data * * Manufacture is required * Manufacture is part of the announce signal * Manufacture can be localized for other languages * * @param[out] manufacturer the Manufacturer found in the AboutData (UTF8 encoded string) * @param[in] language the IETF language tag specified by RFC 5646 * if language is NULL the Manufacturer for the default language will be returned. * * @return ER_OK on success */ QStatus GetManufacturer(char** manufacturer, const char* language = NULL); /** * Set the ModelNumber to the AboutData * * ModelNumber is required * ModelNumber is part of the announce signal * ModelNumber can not be localized for other languages * * @param[in] modelNumber the application model number * * @return ER_OK on success */ QStatus SetModelNumber(const char* modelNumber); /** * Get the ModelNumber from the AboutData * * ModelNumber IS required * ModelNumber IS part of the announce signal * ModelNumber CAN NOT be localized for other languages * * @param[out] modelNumber the application model number * * @return ER_OK on success */ QStatus GetModelNumber(char** modelNumber); /** * Set a supported language. * * This is a string representing the a single language. The language is * specified using IETF language tags specified by the RFC 5646. * * If the language tag has already been added ER_OK will be returned with no * additional changes being made. * * @param[in] language the IETF language tag * * @return ER_OK on success */ QStatus SetSupportedLanguage(const char* language); /** * Get and array of supported languages * * @param languageTags A pointer to a languageTags array to receive the * language tags. Can be NULL in which case no * language tags are returned and the return value gives * the number of language tags available. * @param num the size of the languageTags array. * * @return The number of languageTags returned or the total number of * language tags if languageTags is NULL. */ size_t GetSupportedLanguages(const char** languageTags = NULL, size_t num = 0); /** * Set the Description to the AboutData * * Description IS required * Description IS NOT part of the announce signal * Description CAN BE localized for other languages * * @param[in] description the Description (UTF8 encoded string) * @param[in] language the IETF language tag specified by RFC 5646 * if language is NULL the Description will be set for the default language. * * @return * - #ER_OK on success * - #ER_ABOUT_DEFAULT_LANGUAGE_NOT_SPECIFIED if language tag was not specified * and the default language is also * not found. */ QStatus SetDescription(const char* description, const char* language = NULL); /** * Get the Description from the About data * * Description IS required * Description IS NOT part of the announce signal * Description CAN BE localized for other languages * * @param[out] description the Description found in the AboutData (UTF8 encoded string) * @param[in] language the IETF language tag specified by RFC 5646 * if language is NULL the Description for the default language will be returned. * * @return ER_OK on success */ QStatus GetDescription(char** description, const char* language = NULL); /** * Set the DatOfManufacture to the AboutData * * The date of manufacture using the format YYYY-MM-DD. Known as XML * DateTime format. * * ModelNumber IS NOT required * ModelNumber IS NOT part of the announce signal * ModelNumber CAN NOT be localized for other languages * * @param[in] dateOfManufacture the date of manufacture using YYYY-MM-DD format * * @return ER_OK on success */ QStatus SetDateOfManufacture(const char* dateOfManufacture); /** * Get the DatOfManufacture from the AboutData * * The date of manufacture using the format YYYY-MM-DD. Known as XML * DateTime format. * * ModelNumber IS NOT required * ModelNumber IS NOT part of the announce signal * ModelNumber CAN NOT be localized for other languages * * @param[out] dateOfManufacture the date of manufacture using YYYY-MM-DD format * * @return ER_OK on success */ QStatus GetDateOfManufacture(char** dateOfManufacture); /** * Set the SoftwareVersion to the AboutData * * SoftwareVersion IS required * SoftwareVersion IS NOT part of the announce signal * SoftwareVersion CAN NOT be localized for other languages * * @param[in] softwareVersion the software version for the OEM software * * @return ER_OK on success */ QStatus SetSoftwareVersion(const char* softwareVersion); /** * Get the SoftwareVersion from the AboutData * * SoftwareVersion IS required * SoftwareVersion IS NOT part of the announce signal * SoftwareVersion CAN NOT be localized for other languages * * @param[out] softwareVersion the software version for the OEM software * * @return ER_OK on success */ QStatus GetSoftwareVersion(char** softwareVersion); /** * Get the AJSoftwareVersion from the AboutData * * The AJSoftwareVersion is automatically set when the AboutData is created * or when it is read from remote device. * * ModelNumber IS required * ModelNumber IS NOT part of the announce signal * ModelNumber CAN NOT be localized for other languages * * @param[out] ajSoftwareVersion the current version of AllJoyn SDK utilized * by the application * * @return ER_OK on success */ QStatus GetAJSoftwareVersion(char** ajSoftwareVersion); /** * Set the HardwareVersion to the AboutData * * HardwareVersion IS NOT required * HardwareVersion IS NOT part of the announce signal * HardwareVersion CAN NOT be localized for other languages * * @param[in] hardwareVersion the device hardware version * * @return ER_OK on success */ QStatus SetHardwareVersion(const char* hardwareVersion); /** * Get the HardwareVersion from the AboutData * * HardwareVersion IS NOT required * HardwareVersion IS NOT part of the announce signal * HardwareVersion CAN NOT be localized for other languages * * @param[out] hardwareVersion the device hardware version * * @return ER_OK on success */ QStatus GetHardwareVersion(char** hardwareVersion); /** * Set the SupportUrl to the AboutData * * SupportUrl IS NOT required * SupportUrl IS NOT part of the announce signal * SupportUrl CAN NOT be localized for other languages * * @param[in] supportUrl the support URL to be populated by OEM * * @return ER_OK on success */ QStatus SetSupportUrl(const char* supportUrl); /** * Get the SupportUrl from the AboutData * * SupportUrl IS NOT required * SupportUrl IS NOT part of the announce signal * SupportUrl CAN NOT be localized for other languages * * @param[out] supportUrl the support URL * * @return ER_OK on success */ QStatus GetSupportUrl(char** supportUrl); /** * generic way to Set new field. Everything could be done this way. * * Unless the generic field is one of the pre-defined fields when they are * set they will have the following specifications * NOT required * NOT part of the announce signal * CAN be localized * * Since every field can be localized even if the field is not localized it * must be set for every language. * * @param[in] name the name of the field to set * @param[in] value a MsgArg that contains the value that is set for the field * @param[in] language the IETF language tag specified by RFC 5646 * if language is NULL the default language will be used. Only * used for fields that are marked as localizable. * * @return * - #ER_OK on success * - #ER_ABOUT_DEFAULT_LANGUAGE_NOT_SPECIFIED if language tag was not specified * and the default language is also * not found. */ QStatus SetField(const char* name, MsgArg value, const char* language = NULL); /** * generic way to get field. * * @param[in] name the name of the field to get * @param[out] value MsgArg holding a variant value that represents the field * @param[in] language the IETF language tag specified by RFC 5646 * if language is NULL the field for the default language will be * returned. * * @return ER_OK on success */ QStatus GetField(const char* name, MsgArg*& value, const char* language = NULL); /** * Get a list of the fields contained in this AboutData class. This may be * required if a the AboutData comes from a remote source. User defined * fields are permitted. Use the GetFields method to get a list of all fields * currently found known by the AboutData. * * @param[out] fields an array of const char* that will contain all the strings * @param[in] num_fields the size of the array * * @return * The number of fields returned or the total number of fields if the fields parameter is NULL */ size_t GetFields(const char** fields = NULL, size_t num_fields = 0) const; /** * @param[out] msgArg a the dictionary containing all of the AboutData fields for * the specified language. If language is not specified the default * language will be returned * @param[in] language IETF language tags specified by RFC 5646 if the string * is NULL or an empty string the MsgArg for the default * language will be returned * * @return * - ER_OK on successful * - ER_LANGUAGE_NOT_SUPPORTED if language is not supported * - ER_ABOUT_ABOUTDATA_MISSING_REQUIRED_FIELD if a required field is missing * - other error indicating failure */ QStatus GetAboutData(MsgArg* msgArg, const char* language = NULL); /** * Return a MsgArg pointer containing dictionary containing the AboutData that * is announced with the org.alljoyn.About.announce signal. * This will always be the default language and will only contain the fields * that are announced. * * The fields that will be part of the announced MsgArg are: * - AppId * - DefaultLanguage * - DeviceName * - DeviceId * - AppName * - Manufacture * - ModelNumber * * If you require other fields or need the localized AboutData * The org.alljoyn.About.GetAboutData method can be used. * * @param[out] msgArg a MsgArg dictionary with the a{sv} that contains the Announce * data. * @return ER_OK if successful */ QStatus GetAnnouncedAboutData(MsgArg* msgArg); /** * Is the given field name required to make an About announcement * * @param[in] fieldName the name of the field * * @return * - true if the field is required to make an About announcement * - false otherwise. If the fieldName is unknown false will be returned */ bool IsFieldRequired(const char* fieldName); /** * Is the given field part of the announce signal * * @param[in] fieldName the name of the field * * @return * - true if the field is part of the announce signal * - false otherwise. If the fieldName is unknown false will be returned */ bool IsFieldAnnounced(const char* fieldName); /** * Is the given field a localized field. * * Localized fields should be provided for every supported language * * @param[in] fieldName the name of the field * * @return * - true if the field is a localizable value * - false otherwise. If the fieldName is unknown false will be returned. */ bool IsFieldLocalized(const char* fieldName); /** * Get the signature for the given field. * * @param[in] fieldName the name of the field * * @return * - the signature of the field * - NULL is field is unknown */ const char* GetFieldSignature(const char* fieldName); /* * we should add a way to generate a UUID based on RFC-4122. This should probably * be a in common since generation of the RFC-4122 id is not really core to alljoyn * its self. */ protected: /** * typedef for byte mask used to specify properties of an AboutData field * entry */ typedef uint8_t AboutFieldMask; /** * The AboutData field is not required, announced, or localized. */ static const AboutFieldMask EMPTY_MASK = 0; /** * The AboutData field is required. */ static const AboutFieldMask REQUIRED = 1; /** * The AboutData field is announced. */ static const AboutFieldMask ANNOUNCED = 2; /** * The AboutData field is localized. */ static const AboutFieldMask LOCALIZED = 4; /** * Derived classes have the ability to fully specify their own AboutData * including requirements that can not be changed using the base class. The * derived class can specify if a value is required or optional, the value * is part of the announce signal or must be read using the GetAboutData * method. Specify if the value is a localizable value or not. * * @param[in] fieldName the Field Name being set * @param[in] fieldMask byte mask indicating if this field is required to * send the announce signal, if this field is part of * the `Announce` signal, and if this field contains a * string that should be localized. * @param[in] signature the data type held by the field this is a MsgArg * signature * @return * - #ER_OK on success * - #ER_ABOUT_FIELD_ALREADY_SPECIFIED if that field has already been specified */ QStatus SetNewFieldDetails(const char* fieldName, AboutFieldMask fieldMask, const char* signature); /** * Holds information for each AboutData field. * * Each AboutData field must specify four pieces of information * - required This is a boolean field if this is `true` then the field is * required for the AboutData to be a Valid. * - announced If this field is marked as `true` then the field will be part * of the Announce signal * - localized This field contains a value that can be localized into * multiple languages/regions * - signature The signature of the underlying MsgArg dictionary value. * */ typedef struct FieldDetails { /** * Create an uninitialized FieldDetails struct */ FieldDetails() : fieldMask(EMPTY_MASK) { } /** * Create an initialized FieldDetails struct * @param[in] fieldMask a bitmask value indicating the properties of the field * @param[in] s the value for the signature field */ FieldDetails(AboutFieldMask fieldMask, const char* s) : fieldMask(fieldMask), signature(s) { } /** * Mask indicating if the field is required, announced, or localized */ AboutFieldMask fieldMask; /** * The signature of the underlying MsgArg dictionary value. */ qcc::String signature; } FieldDetails; private: /** * Initialize the Field Details with the values specified in the About Feature * specification. This is called by each constructor. */ void InitializeFieldDetails(); /// @cond ALLJOYN_DEV /** * @internal * Class for internal state for AboutData. */ class Internal; Internal* aboutDataInternal; /**< Internal state information */ /// @endcond ALLJOYN_DEV }; } #endif alljoyn-15.04b/alljoyn_core/inc/alljoyn/AboutDataListener.h000066400000000000000000000204311255700255500237670ustar00rootroot00000000000000/* * @file * Pure Virtual class that contains the interface needed by anyone one wanting * to use */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_ABOUTDATALISTENER_H #define _ALLJOYN_ABOUTDATALISTENER_H #include #include namespace ajn { /** * Listener implemented by AllJoyn apps and called by AllJoyn. * * The Listener is responsible for providing a well formed MsgArg dictionary of * type a{sv} that contain the fields specified in the About Interface. */ class AboutDataListener { public: /** * Constructor */ AboutDataListener() { }; /** * Destructor */ virtual ~AboutDataListener() { }; /** * Creating the MsgArg that is returned when a user calls * org.alljoyn.About.GetAboutData. The returned MsgArg must contain the * AboutData dictionary for the Language specified. * * The MsgArg will contain the signature `a{sv}`. * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
Field NameRequiredAnnouncedLocalizedData typeDescription
AppIdyesyesnoayThe globally unique id for the application.
DefaultLanguageyesyesnosThe default language supported by the device. IETF langauge tags * specified by RFC 5646.
DeviceNamenoyesyessIf Config service exist on the device, About instance populates * the value as DeviceName in Config; If there is not Config, it can * be set by the app. Device Name is optional for a third party * apps but required for system apps. Versions of AllJoyn older than * 14.12 this field was required. If working with older applications * this field may be required.
DeviceIdyesyesnosA string with value generated using platform specific means.
AppNameyesyesyessThe application name assigned by the app manufacturer
ManufactureryesyesyessThe manufacturer's name.
ModelNumberyesyesnosThe app model number
SupportedLanguagesyesnonoasA list of supported languages by the application
DescriptionyesnoyessDetailed description provided by the application.
DateOfManufacturenononosThe date of manufacture. using format YYYY-MM-DD. * (Known as XML DateTime Format)
SoftwareVersionyesnonosThe software version of the manufacturer's software
SoftwareVersionyesnonosThe current version of the AllJoyn SDK utilized by the * application.
HardwareVersionnononosThe device hardware version.
SupportUrlnononosThe support URL.
* * Custom fields are allowed. Since the proxy object only receives the field * name and the MsgArg containing the contents for that field the default * assumption is that user defined fields are: * - are not required * - are not announced * - are localized if the MsgArg contains a String (not localized otherwise) * * Important: All implementations of GetAboutData should handle language * specified as an empty string or NULL. In the case that the language is * an empty string or NULL the GetAboutData is expected to return the * default language. * * If the language tag given is not supported return the QStatus * #ER_LANGUAGE_NOT_SUPPORTED. If the user has not provided ALL of the * required fields return the QStatus * #ER_ABOUT_ABOUTDATA_MISSING_REQUIRED_FIELD * * @param[out] msgArg a the dictionary containing all of the AboutData fields for * the specified language. If language is not specified the default * language will be returned * @param[in] language IETF language tags specified by RFC 5646 if the string * is NULL or an empty string the MsgArg for the default * language will be returned * * @return * - #ER_OK on successful * - #ER_LANGUAGE_NOT_SUPPORTED if language is not supported * - #ER_ABOUT_ABOUTDATA_MISSING_REQUIRED_FIELD if a required field is missing * - other error indicating failure */ virtual QStatus GetAboutData(MsgArg* msgArg, const char* language) = 0; /** * Return a MsgArg pointer containing dictionary containing the Announce * portion of the AboutData. * * The Announced values will always use the default language and will only * contain the fields that are announced. * * The fields required to be part of the announced MsgArg are: * - AppId * - DefaultLanguage * - DeviceName (Optional since v14.12) * - DeviceId * - AppName * - Manufacture * - ModelNumber * * To read other fields or get the localized value of a field use the * org.alljoyn.About.GetAboutData method. This method is available using the * AboutProxy class. * * @param[out] msgArg a MsgArg dictionary with the a{sv} that contains the Announce * data. * @return ER_OK if successful */ virtual QStatus GetAnnouncedAboutData(MsgArg* msgArg) = 0; }; } #endif /* _ALLJOYN_ABOUTDATALISTENER_H */ alljoyn-15.04b/alljoyn_core/inc/alljoyn/AboutIcon.h000066400000000000000000000101401255700255500222740ustar00rootroot00000000000000/** * @file * Container class to hold the information about an icon for the About Icon * Object. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_ABOUTICON_H #define _ALLJOYN_ABOUTICON_H #include #include namespace ajn { /** * container to hold information about the Icon */ class AboutIcon { public: /** * Initialize an empty Icon */ AboutIcon(); /** * Set the content for an icon. The content must fit into a MsgArg so the * largest size for the icon data is ALLJOYN_MAX_ARRAY_LEN bytes. * * Note as long as the MIME type matches it is possible to set both icon content * and icon URL * * If an error is returned the icon content will remain unchanged. * * @param[in] mimetype a MIME type indicating the icon image type. Typical * value will be `image/jpeg` or `image/png` * @param[in] data pointer to an array of bytes that represent an icon * @param[in] csize The number of bytes in data * @param[in] ownsData If true the AboutIcon contain gains ownership of the * data that data points to. AboutIcon class will be * responsible for freeing the memory. If false user is * is responsible for freeing memory pointed to by data. * @return * - #ER_OK on success * - #ER_BUS_BAD_VALUE if the data is to large to be marshaled * - other status indicating failure */ QStatus SetContent(const char* mimetype, uint8_t* data, size_t csize, bool ownsData = false); /** * Set a url that contain the icon for the application. * * Note as long as the MIME type matches it is possible to set both icon content * and icon URL * * @param[in] mimetype a MIME type indicating the icon image type. Typical * value will be `image/jpeg` or `image/png` * @param[in] url A URL that contain the location of the icon hosted in * the cloud. * @return * - #ER_OK on success * - other status indicating failure otherwise */ QStatus SetUrl(const char* mimetype, const char* url); /** * Clear the AboutIcon. This will change all strings to empty strings * set the content to NULL and the contentSize to zero. */ void Clear(); /** * Add the IconContent from a MsgArg. This will make a local copy of the * MsgArg passed in and expose the contents as the member variables content * and contentSize. * * @param arg the MsgArg containing the Icon * * @return * - #ER_OK on success * - status indicating failure otherwise */ QStatus SetContent(const MsgArg& arg); /** * an array of bytes containing the image */ uint8_t* content; /** * the number of bytes in the content array */ size_t contentSize; /** * the mimetype of the image */ qcc::String mimetype; /** * The url for the Icon */ qcc::String url; private: /** * MsgArg containing the Icon image */ MsgArg m_arg; }; } #endif //_ALLJOYN_ABOUTICON_H alljoyn-15.04b/alljoyn_core/inc/alljoyn/AboutIconObj.h000066400000000000000000000056401255700255500227400ustar00rootroot00000000000000/** * @file * An Alljoyn BusObject that implements the org.alljoyn.Icon interface */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_ABOUTICONOBJ_H #define _ALLJOYN_ABOUTICONOBJ_H #include #include namespace ajn { /** * AboutIconObj is an AllJoyn BusObject that implements the org.alljoyn.Icon standard interface. * Applications that provide AllJoyn IoE services to receive info about the Icon of the service. */ class AboutIconObj : public BusObject { public: /** * version of the org.alljoyn.Icon interface */ static const uint16_t VERSION; /** * Construct an About Icon BusObject. * * @param[in] bus BusAttachment instance associated with this BusObject * @param[in] icon instance of an AboutIcon which holds the icon image */ AboutIconObj(BusAttachment& bus, AboutIcon& icon); /** * Destructor of the About Icon BusObject */ virtual ~AboutIconObj(); private: /** * Handles GetUrl method call for the org.alljoyn.Icon interface * * @param[in] member * @param[in] msg reference of AllJoyn Message */ void GetUrl(const InterfaceDescription::Member* member, Message& msg); /** * Handles GetContent method call for the org.alljoyn.Icon interface * * @param[in] member * @param[in] msg reference of AllJoyn Message */ void GetContent(const InterfaceDescription::Member* member, Message& msg); /** * Handles the GetPropery request for the org.alljoyn.Icon interface * * @param[in] ifcName interface name * @param[in] propName the name of the properly * @param[in] val reference of MsgArg out parameter. * @return */ QStatus Get(const char* ifcName, const char* propName, MsgArg& val); /** * pointer to BusAttachment */ BusAttachment* m_busAttachment; /** * pointer to AboutIcon */ AboutIcon* m_icon; }; } #endif /* _ALLJOYN_ABOUTICONOBJ_H */ alljoyn-15.04b/alljoyn_core/inc/alljoyn/AboutIconProxy.h000066400000000000000000000052111255700255500233410ustar00rootroot00000000000000/** * @file * Implementation of a ProxyBusObject used to interact with a org.alljoyn.Icon * interface */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_ABOUTICONPROXY_H #define _ALLJOYN_ABOUTICONPROXY_H #include #include namespace ajn { /** * AboutIconProxy enables the user of the class to interact with the remote * AboutIcon BusObject. */ class AboutIconProxy : public ProxyBusObject { public: /** * Construct an AboutIconProxy Object. * * @param bus reference to BusAttachment * @param[in] busName Unique or well-known name of an AllJoyn bus you have joined * @param[in] sessionId the session received after joining an AllJoyn session */ AboutIconProxy(BusAttachment& bus, const char* busName, SessionId sessionId = 0); /** * Destruct the AboutIconProxy Object. */ virtual ~AboutIconProxy() { } /** * This method makes multiple ProxyBusObject method calls to fill in the * content of the AboutIcon. Its possible for any of the method calls to * fail causing this member function to return an error status. * * @param[out] icon AboutIcon class that holds icon content * @return * - #ER_OK if successful * - an error status indicating failure to get the icon content */ QStatus GetIcon(AboutIcon& icon); /** * @param[out] version the version of the remote AboutIcon BusObject * * @return * - #ER_OK if successful * - an error status indicating failure */ QStatus GetVersion(uint16_t& version); private: /** * pointer to BusAttachment */ BusAttachment* m_BusAttachment; }; } #endif /* _ALLJOYN_ABOUTICONPROXY_H */ alljoyn-15.04b/alljoyn_core/inc/alljoyn/AboutKeys.h000066400000000000000000000054631255700255500223330ustar00rootroot00000000000000/** * @file * This contains the AboutData class responsible for holding the org.alljoyn.About * interface data fields. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_ABOUTKEYS_H #define _ALLJOYN_ABOUTKEYS_H #include #include #include #include namespace ajn { /** * AboutKeys */ class AboutKeys { public: /** * @anchor AboutFields * @name Known AboutFields * * The known fields in the About interface * TODO put in a table listing the properties for all of the about fields */ // @{ static const char* APP_ID; ///< The globally unique id for the application static const char* DEFAULT_LANGUAGE; ///< The default language supported by the device. IETF language tags specified by RFC 5646. static const char* DEVICE_NAME; ///< The name of the device static const char* DEVICE_ID; ///< A unique string with a value generated using platform specific means static const char* APP_NAME; ///< The application name assigned by the manufacture static const char* MANUFACTURER; ///< The manufacture's name static const char* MODEL_NUMBER; ///< The application model number static const char* SUPPORTED_LANGUAGES; ///< List of supported languages static const char* DESCRIPTION; ///< Detailed description provided by the application static const char* DATE_OF_MANUFACTURE; ///< The date of manufacture using format YYYY-MM-DD static const char* SOFTWARE_VERSION; ///< The software version for the OEM software static const char* AJ_SOFTWARE_VERSION; ///< The current version of the AllJoyn SDK utilized by the application static const char* HARDWARE_VERSION; ///< The device hardware version static const char* SUPPORT_URL; ///< The support URL provided by the OEM or software developer // @} }; } #endif //_ALLJOYN_ABOUTKEYS_H alljoyn-15.04b/alljoyn_core/inc/alljoyn/AboutListener.h000066400000000000000000000062121255700255500231760ustar00rootroot00000000000000/** * @file * This contains the AboutListener class */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_ABOUTLISTENER_H #define _ALLJOYN_ABOUTLISTENER_H #include #include #include #include #include #include namespace ajn { /** * Abstract base class implemented by AllJoyn users and called by AllJoyn to inform * users of About interface related events. */ class AboutListener { public: /** * AboutListener constructor */ AboutListener() { } /** * AboutListener destructor */ virtual ~AboutListener() { } /** * handler for the org.alljoyn.About.Anounce sessionless signal * * The objectDescriptionArg contains an array with a signature of `a(oas)` * this is an array object paths with a list of interfaces found at those paths * * The aboutDataArg contains a dictionary with with AboutData fields that have * been announced. * * These fields are * - AppId * - DefaultLanguage * - DeviceName * - DeviceId * - AppName * - Manufacturer * - ModelNumber * * The DeviceName is optional an may not be included in the aboutDataArg. * DeviceName is required for System Apps. * * DeviceName, AppName, Manufacturer are localizable values. The localization * for these values in the aboutDataArg will always be for the language specified * in the DefaultLanguage field. * * @param[in] busName well know name of the remote BusAttachment * @param[in] version version of the Announce signal from the remote About Object * @param[in] port SessionPort used by the announcer * @param[in] objectDescriptionArg MsgArg the list of object paths and interfaces in the announcement * @param[in] aboutDataArg MsgArg containing a dictionary of Key/Value pairs of the AboutData */ virtual void Announced(const char* busName, uint16_t version, SessionPort port, const MsgArg& objectDescriptionArg, const MsgArg& aboutDataArg) = 0; }; } #endif //_ALLJOYN_ABOUTLISTENER_H alljoyn-15.04b/alljoyn_core/inc/alljoyn/AboutObj.h000066400000000000000000000162151255700255500221270ustar00rootroot00000000000000/** * @file * This contains the About class */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_ABOUT_H #define _ALLJOYN_ABOUT_H #include #include #include #include namespace ajn { /** * An AllJoyn BusObject that implements the org.alljoyn.About interface. * * This BusObject is used to announce the capabilities and other identifying details * of the application or device. */ class AboutObj : public BusObject { public: /** * version of the org.alljoyn.About interface */ static const uint16_t VERSION; /** * create a new About class * * This will also register the About BusObject on the passed in BusAttachment * * The AboutObj class is responsible for transmitting information about the * interfaces that are available for other applications to use. It also * provides application specific information that is contained in the * AboutDataListener class * * It also provides means for applications to respond to certain requests * concerning the interfaces. * * By default the org.alljoyn.About interface is excluded from the list of * announced interfaces. Since simply receiving the announce signal tells * the client that the service implements the org.alljoyn.About interface. * There are some legacy applications that expect the org.alljoyn.About * interface to be part of the announcement. Changing the isAnnounced flag * from UNANNOUNCED, its default, to ANNOUNCED will cause the org.alljoyn.About * interface to be part of the announce signal. Unless your application is * talking with a legacy application that expects the org.alljoyn.About * interface to be part of the announce signal it is best to leave the * isAnnounced to use its default value. * * @param[in] bus the BusAttachment that will contain the about information * @param[in] isAboutIntfAnnounced will the org.alljoyn.About interface be * part of the announced interfaces. */ AboutObj(BusAttachment& bus, AnnounceFlag isAboutIntfAnnounced = UNANNOUNCED); virtual ~AboutObj(); /** * This is used to send the Announce signal. It announces the list of all * interfaces available at given object paths as well as the announced * fields from the AboutData. * * This method will automatically obtain the Announced ObjectDescription from the * BusAttachment that was used to create the AboutObj. Only BusObjects that have * marked their interfaces as announced and are registered with the * BusAttachment will be announced. * * @see BusAttachment::RegisterBusObject * @see BusObject::AddInterface * * @param sessionPort the session port the interfaces can be connected with * @param aboutData the AboutDataListener that contains the AboutData for * this announce signal. * * @return * - ER_OK on success * - ER_ABOUT_SESSIONPORT_NOT_BOUND if the SessionPort given is not bound */ QStatus Announce(SessionPort sessionPort, AboutDataListener& aboutData); /** * Cancel the last announce signal sent. If no signals have been sent this * method call will return. * * @return * - ER_OK on success * - another status indicating failure. */ QStatus Unannounce(); private: /** * Handles GetAboutData method * @param[in] member * @param[in] msg reference of AllJoyn Message */ void GetAboutData(const InterfaceDescription::Member* member, Message& msg); /** * Handles GetObjectDescription method * @param[in] member * @param[in] msg reference of AllJoyn Message */ void GetObjectDescription(const InterfaceDescription::Member* member, Message& msg); /** * Handles the GetPropery request * @param[in] ifcName interface name * @param[in] propName the name of the properly * @param[in] val reference of MsgArg out parameter. * @return ER_OK if successful. */ QStatus Get(const char* ifcName, const char* propName, MsgArg& val); /** * check that the MsgArg returned from AboutDataListener.GetAboutData * contains all the required fields * Fields are: * - AppId * - DefaultLanguage * - DeviceId * - AppName * - Manufacture * - ModelNumber * - SupportedLanguages * - Description * - SoftwareVersion * - AJSoftwareVersion * * @param aboutDataArg MsgArg containing the AboutData fields. * * return true if it contains all the required fields */ bool HasAllRequiredFields(MsgArg& aboutDataArg); /** * * check that the MsgArg returned from AboutDataListener.GetAnnouncedAboutData * contains all the required fields * Fields are: * - AppId * - DefaultLanguage * - DeviceId * - AppName * - Manufacture * - ModelNumber * * @param announcedDataArg MsgArg containging the announced AboutData fields. * * return true if it contains all the required fields */ bool HasAllAnnouncedFields(MsgArg& announcedDataArg); /** * Check that the values in the Announced Fields and the Requried Fields * agree. * * @param aboutDataArg MsgArg containing the AboutData fields. * @param announcedDataArg MsgArg containging the announced AboutData fields. * * @return true if the announced AboutData and the AboutData fields match */ bool AnnouncedDataAgreesWithAboutData(MsgArg& aboutDataArg, MsgArg& announcedDataArg); /** * Validate individual AboutData fields to make sure they meet requirements. * * @param aboutDataArg MsgArg containing the AboutData fields. * * @return * - #ER_OK if all checked fields are good * - Error status indicating otherwise */ QStatus ValidateAboutDataFields(MsgArg& aboutDataArg); /** * pointer to BusAttachment */ BusAttachment* m_busAttachment; MsgArg m_objectDescription; AboutDataListener* m_aboutDataListener; uint32_t m_announceSerialNumber; }; } #endif alljoyn-15.04b/alljoyn_core/inc/alljoyn/AboutObjectDescription.h000066400000000000000000000177611255700255500250360ustar00rootroot00000000000000/** * @file * This contains the AboutObjectDescription class responsible holding a list of * all BusObject interfaces and their paths. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_ABOUTOBJECTDESCRIPTION_H #define _ALLJOYN_ABOUTOBJECTDESCRIPTION_H #include #include #include namespace ajn { /** * AboutObjectDescription Class is a helper class for accessing the * ObjectDescription MsgArg that is sent as part of an announce signal. * It contains helper functions for quickly determining an About ObjectDescrption * contains a specified path or interface. */ class AboutObjectDescription { public: /** * constructor to create an empty AboutObjectDescrption. * use the CreateFromMsgArg method to fill in the AboutObjectDescription * class. */ AboutObjectDescription(); /** * Fill in the ObjectDescription fields using a MsgArg * * The MsgArg must contain an array of type a(oas) The expected use of this * class is to fill in the ObjectDescription using a MsgArg obtain from the * Announce signal or the GetObjectDescription method from org.alljoyn.About * interface. * * If the arg came from the org.alljoyn.About.Announce signal or the * org.alljoyn.AboutGetObjectDescrption method then it can be used to create * the AboutObjectDescription. If the arg came from any other source its best * to create an empty AboutObjectDescrption class and use the CreateFromMsgArg * class to access the MsgArg. Since it can be checked for errors while parsing * the MsgArg. * * @param arg MsgArg contain About ObjectDescription */ AboutObjectDescription(const MsgArg& arg); /** * Copy constructor * * @param src The AboutObjectDescription instance to be copied */ AboutObjectDescription(const AboutObjectDescription& src); /** * Assignment operator * * @param src The AboutObjectDescription instance to be assigned * * @return copy of the AboutObjectDescription src */ AboutObjectDescription& operator=(const AboutObjectDescription& src); /** * Destructor */ ~AboutObjectDescription(); /** * Fill in the ObjectDescription fields using a MsgArg * * The MsgArg must contain an array of type a(oas) The expected use of this * class is to fill in the ObjectDescription using a MsgArg obtain from the * Announce signal or the GetObjectDescription method from org.alljoyn.about * interface. * * @param arg MsgArg contain AboutData dictionary * * @return ER_OK on success */ QStatus CreateFromMsgArg(const MsgArg& arg); /** * Get a list of the paths that are added to this AboutObjectDescription. * * usage example * @code * size_t numPaths = aboutObjectDescription.GetPaths(NULL, 0); * const char** paths = new const char*[numPaths]; * aboutObjectDescription.GetPaths(paths, numPaths); * @endcode * * @param[out] paths an char* array pointer * @param[in] numPaths the size of the char* array * * @return * The total number of paths found in the AboutObjectDescription. If this * number is larger than `numPaths` then only `numPaths` of paths will be * returned in the `paths` array. * */ size_t GetPaths(const char** paths, size_t numPaths) const; /** * Get a list of interfaces advertised at the given path that are part of * this AboutObjectDescription. * * usage example * @code * size_t numInterfaces = aboutObjectDescription.GetInterfaces(NULL, 0); * const char** interfaces = new const char*[numInterfaces]; * aboutObjectDescription.GetInterfaces("/example", interfaces, numInterfaces); * @endcode * * @param[in] path the path we want to get a list of interfaces for * @param[out] interfaces a char* array pointer * @param[in] numInterfaces the size of the char* array * * @return * The total number of interfaces found in the AboutObjectDescription for * the specified path. If this number is larger than `numInterfaces` * then only `numInterfaces` of interfaces will be returned in the * `interfaces` array. */ size_t GetInterfaces(const char* path, const char** interfaces, size_t numInterfaces) const; /** * Get a list of the paths for a given interface. Its possible to have the * same interface listed under multiple paths. * * Usage example * @code * size_t numPaths = GetInterfacePaths("com.example.interface", NULL, 0); * const char** paths = new const char*[numPaths]; * GetInterfacePaths("com.example.interface", paths, numPaths); * @endcode * * @param[in] iface the interface we want to get a list of paths for * @param[out] paths a char* array pointer * @param[in] numPaths the size of the char* array * * @return * The total number of paths found in the AboutObjectDescription for * the specified path. If this number it larger than the `numPaths` * then only `numPaths` of interfaces will be returned in the `paths` * array * */ size_t GetInterfacePaths(const char* iface, const char** paths, size_t numPaths) const; /** * Clear all the contents of this AboutObjectDescription * * @return ER_OK */ void Clear(); /** * Returns true if the given path is found * * @param[in] path BusObject path * * @return true if the path is found */ bool HasPath(const char* path) const; /** * Returns true if the given interface name is found in any path * * @param[in] interfaceName the name of the interface you are looking for * * @return true if the interface is found */ bool HasInterface(const char* interfaceName) const; /** * Returns true if the given interface name is found at the given path * @param[in] path of the interface * @param[in] interfaceName the name of the interface you are looking for * * @return true if the interface is found at the given path */ bool HasInterface(const char* path, const char* interfaceName) const; /** * @param[out] msgArg containing a signature a(oas) * an array of object paths and an array of interfaces * found on that object path * * @return ER_OK if successful */ QStatus GetMsgArg(MsgArg* msgArg); private: /** * Add an interface to the ObjectDescription. This can be called multiple * times. * * @param[in] path of the interface * @param[in] interfaceName name of the interface * * @return ER_OK is successful */ QStatus Add(const char* path, const char* interfaceName); /// @cond ALLJOYN_DEV /** * @internal * Class for internal state for AboutObjectDescription. */ class Internal; Internal* aodInternal; /**< Internal state information */ /// @endcond ALLJOYN_DEV }; } #endif alljoyn-15.04b/alljoyn_core/inc/alljoyn/AboutProxy.h000066400000000000000000000060351255700255500225350ustar00rootroot00000000000000/** * @file * This contains the AboutProxy class */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_ABOUTPROXY_H_ #define _ALLJOYN_ABOUTPROXY_H_ #include #include #include namespace ajn { /** * AboutProxy give proxy access to the org.alljoyn.About interface AboutProxy * class enables the user to interact with the remote About BusObject instance * exposing the following methods: * - GetObjectDescriptions * - GetAboutData * - GetVersion * */ class AboutProxy : public ProxyBusObject { public: /** * AboutProxy Constructor * * @param bus reference to BusAttachment * @param[in] busName Unique or well-known name of remote AllJoyn bus * @param[in] sessionId the session received after joining AllJoyn session */ AboutProxy(BusAttachment& bus, const char* busName, SessionId sessionId = 0); /** * Destruct AboutProxy */ virtual ~AboutProxy(); /** * Get the ObjectDescription array for specified bus name. * * @param[out] objectDesc Description of busName's remote objects. * * @return * - ER_OK if successful. * - ER_BUS_REPLY_IS_ERROR_MESSAGE on unknown failure. */ QStatus GetObjectDescription(MsgArg& objectDesc); /** * Get the AboutData for specified bus name. * * @param[in] languageTag is the language used to request the AboutData. * @param[out] data is reference of AboutData that is filled by the function * * @return * - ER_OK if successful. * - ER_LANGUAGE_NOT_SUPPORTED if the language specified is not supported * - ER_BUS_REPLY_IS_ERROR_MESSAGE on unknown failure */ QStatus GetAboutData(const char* languageTag, MsgArg& data); /** * GetVersion get the About version * * @param[out] version of the service. * * @return ER_OK on success */ QStatus GetVersion(uint16_t& version); private: /** * pointer to BusAttachment */ ajn::BusAttachment* m_BusAttachment; }; } #endif /* _ALLJOYN_ABOUTPROXY_H_ */ alljoyn-15.04b/alljoyn_core/inc/alljoyn/AllJoynStd.h000066400000000000000000000534311255700255500224460ustar00rootroot00000000000000#ifndef _ALLJOYN_ALLJOYNSTD_H #define _ALLJOYN_ALLJOYNSTD_H /** * @file * This file provides definitions for AllJoyn interfaces */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include /** * @def QCC_MODULE * Internal usage */ #define QCC_MODULE "ALLJOYN" /** Router-to-router protocol version number */ #define ALLJOYN_PROTOCOL_VERSION 12 namespace ajn { namespace org { namespace alljoyn { /** Interface definitions for org.alljoyn.About */ namespace About { extern const char* ObjectPath; /**< Object path */ extern const char* InterfaceName; /**< Interface name */ extern const char* WellKnownName; /**< Well-known bus name */ } /** Interface definitions for org.alljoyn.Icon */ namespace Icon { extern const char* ObjectPath; /**< Object path */ extern const char* InterfaceName; /**< Interface name */ extern const char* WellKnownName; /**< Well known bus name */ } /** Interface definitions for org.alljoyn.Bus */ namespace Bus { extern const char* ErrorName; /**< Standard AllJoyn error name */ extern const char* ObjectPath; /**< Object path */ extern const char* InterfaceName; /**< Interface name */ extern const char* WellKnownName; /**< Well known bus name */ extern const char* Secure; /**< Secure interface annotation */ /** Interface definitions for org.alljoyn.Bus.Peer.* */ namespace Peer { extern const char* ObjectPath; /**< Object path */ namespace HeaderCompression { extern const char* InterfaceName; /** #include #include #include namespace ajn { /** * Class to allow authentication mechanisms to interact with the user or application. */ class AuthListener { public: /** * Virtual destructor for derivable class. */ virtual ~AuthListener() { } /** * @name Credential indication Bitmasks * Bitmasks used to indicated what type of credentials are being used. */ // @{ static const uint16_t CRED_PASSWORD = 0x0001; /**< Bit 0 indicates credentials include a password, pincode, or passphrase */ static const uint16_t CRED_USER_NAME = 0x0002; /**< Bit 1 indicates credentials include a user name */ static const uint16_t CRED_CERT_CHAIN = 0x0004; /**< Bit 2 indicates credentials include a chain of PEM-encoded X509 certificates */ static const uint16_t CRED_PRIVATE_KEY = 0x0008; /**< Bit 3 indicates credentials include a PEM-encoded private key */ static const uint16_t CRED_LOGON_ENTRY = 0x0010; /**< Bit 4 indicates credentials include a logon entry that can be used to logon a remote user */ static const uint16_t CRED_EXPIRATION = 0x0020; /**< Bit 5 indicates credentials include an expiration time */ // @} /** * @name Credential request values * These values are only used in a credential request */ // @{ static const uint16_t CRED_NEW_PASSWORD = 0x1001; /**< Indicates the credential request is for a newly created password */ static const uint16_t CRED_ONE_TIME_PWD = 0x2001; /**< Indicates the credential request is for a one time use password */ // @} /** * Generic class for describing different authentication credentials. */ class Credentials { public: Credentials() : mask(0) { } /** * Copy constructor * * @param other Credentials to copy */ Credentials(const Credentials& other) { this->mask = other.mask; this->expiration = other.expiration; this->pwd = other.pwd; this->userName = other.userName; this->certChain = other.certChain; this->pk = other.pk; this->logonEntry = other.logonEntry; } /** * Tests if one or more credentials are set. * * @param creds A logical or of the credential bit values. * @return true if the credentials are set. */ bool IsSet(uint16_t creds) const { return ((creds & mask) == creds); } /** * Sets a requested password, pincode, or passphrase. * * @param pwd The password to set. */ void SetPassword(const qcc::String& pwd) { this->pwd = pwd; mask |= CRED_PASSWORD; } /** * Sets a requested user name. * * @param userName The user name to set. */ void SetUserName(const qcc::String& userName) { this->userName = userName; mask |= CRED_USER_NAME; } /** * Sets a requested public key certificate chain. The certificates must be PEM encoded. * * @param certChain The certificate chain to set. */ void SetCertChain(const qcc::String& certChain) { this->certChain = certChain; mask |= CRED_CERT_CHAIN; } /** * Sets a requested private key. The private key must be PEM encoded and may be encrypted. If * the private key is encrypted the passphrase required to decrypt it must also be supplied. * * @param pk The private key to set. */ void SetPrivateKey(const qcc::String& pk) { this->pk = pk; mask |= CRED_PRIVATE_KEY; } /** * Sets a logon entry. For example for the Secure Remote Password protocol in RFC 5054, a * logon entry encodes the N,g, s and v parameters. An SRP logon entry string has the form * N:g:s:v where N,g,s, and v are ASCII encoded hexadecimal strings and are separated by * colons. * * @param logonEntry The logon entry to set. */ void SetLogonEntry(const qcc::String& logonEntry) { this->logonEntry = logonEntry; mask |= CRED_LOGON_ENTRY; } /** * Sets an expiration time in seconds relative to the current time for the credentials. This value is optional and * can be set on any response to a credentials request. After the specified expiration time has elapsed any secret * keys based on the provided credentials are invalidated and a new authentication exchange will be required. If an * expiration is not set the default expiration time for the requested authentication mechanism is used. * * @param expiration The expiration time in seconds. */ void SetExpiration(uint32_t expiration) { this->expiration = expiration; mask |= CRED_EXPIRATION; } /** * Gets the password, pincode, or passphrase from this credentials instance. * * @return A password or an empty string. */ const qcc::String& GetPassword() const { return pwd; } /** * Gets the user name from this credentials instance. * * @return A user name or an empty string. */ const qcc::String& GetUserName() const { return userName; } /** * Gets the PEM encoded X509 certificate chain from this credentials instance. * * @return An X509 certificate chain or an empty string. */ const qcc::String& GetCertChain() const { return certChain; } /** * Gets the PEM encode private key from this credentials instance. * * @return An PEM encode private key or an empty string. */ const qcc::String& GetPrivateKey() const { return pk; } /** * Gets a logon entry. * * @return An encoded logon entry or an empty string. */ const qcc::String& GetLogonEntry() const { return logonEntry; } /** * Get the expiration time in seconds if it is set. * * @return The expiration or the max 32 bit unsigned value if it was not set. */ uint32_t GetExpiration() { return (mask & CRED_EXPIRATION) ? expiration : 0xFFFFFFFF; } /** * Clear the credentials. */ void Clear() { pwd.clear(); userName.clear(); certChain.clear(); pk.clear(); logonEntry.clear(); mask = 0; } private: uint16_t mask; uint32_t expiration; qcc::String pwd; qcc::String userName; qcc::String certChain; qcc::String pk; qcc::String logonEntry; }; /** * Authentication mechanism requests user credentials. If the user name is not an empty string * the request is for credentials for that specific user. A count allows the listener to decide * whether to allow or reject multiple authentication attempts to the same peer. * * An implementation must provide RequestCredentials or RequestCredentialsAsync but not both. * * @param authMechanism The name of the authentication mechanism issuing the request. * @param peerName The name of the remote peer being authenticated. On the initiating * side this will be a well-known-name for the remote peer. On the * accepting side this will be the unique bus name for the remote peer. * @param authCount Count (starting at 1) of the number of authentication request attempts made. * @param userName The user name for the credentials being requested. * @param credMask A bit mask identifying the credentials being requested. The application * may return none, some or all of the requested credentials. * @param[out] credentials The credentials returned. * * @return The caller should return true if the request is being accepted or false if the * requests is being rejected. If the request is rejected the authentication is * complete. */ virtual bool RequestCredentials(const char* authMechanism, const char* peerName, uint16_t authCount, const char* userName, uint16_t credMask, Credentials& credentials) { QCC_UNUSED(authMechanism); QCC_UNUSED(peerName); QCC_UNUSED(authCount); QCC_UNUSED(userName); QCC_UNUSED(credMask); QCC_UNUSED(credentials); return false; } /** * Authentication mechanism asynchronous request for credentials. If the user name is not an empty string * the request is for credentials for that specific user. A count allows the listener to decide * whether to allow or reject multiple authentication attempts to the same peer. * * An implementation must provide RequestCredentials or RequestCredentialsAsync but not both. * * @param authMechanism The name of the authentication mechanism issuing the request. * @param peerName The name of the remote peer being authenticated. On the initiating * side this will be a well-known-name for the remote peer. On the * accepting side this will be the unique bus name for the remote peer. * @param authCount Count (starting at 1) of the number of authentication request attempts made. * @param userName The user name for the credentials being requested. * @param credMask A bit mask identifying the credentials being requested. * @param authContext Callback context for associating the request with the returned credentials. * * @return Return ER_OK if the request is handled. */ virtual QStatus RequestCredentialsAsync(const char* authMechanism, const char* peerName, uint16_t authCount, const char* userName, uint16_t credMask, void* authContext) { QCC_UNUSED(authMechanism); QCC_UNUSED(peerName); QCC_UNUSED(authCount); QCC_UNUSED(userName); QCC_UNUSED(credMask); QCC_UNUSED(authContext); return ER_NOT_IMPLEMENTED; } /** * Respond to a call to RequestCredentialsAsync. * * @param authContext Context that was passed in the call out to RequestCredentialsAsync. * @param accept Returns true to accept the credentials request or false to reject it. * @param credentials The credentials being returned if accept is true. * * @return Returns ER_OK if the credential verification response was expected. Returns an error status if * the credentials verification response was not expected. */ static QStatus AJ_CALL RequestCredentialsResponse(void* authContext, bool accept, Credentials& credentials); /** * Authentication mechanism requests verification of credentials from a remote peer. * * @param authMechanism The name of the authentication mechanism issuing the request. * @param peerName The name of the remote peer being authenticated. On the initiating * side this will be a well-known-name for the remote peer. On the * accepting side this will be the unique bus name for the remote peer. * @param credentials The credentials to be verified. * * @return The listener should return true if the credentials are acceptable or false if the * credentials are being rejected. */ virtual bool VerifyCredentials(const char* authMechanism, const char* peerName, const Credentials& credentials) { QCC_UNUSED(authMechanism); QCC_UNUSED(peerName); QCC_UNUSED(credentials); return true; } /** * Authentication mechanism asynchronous request for verification of credentials from a remote peer. * * @param authMechanism The name of the authentication mechanism issuing the request. * @param peerName The name of the remote peer being authenticated. On the initiating * side this will be a well-known-name for the remote peer. On the * accepting side this will be the unique bus name for the remote peer. * @param credentials The credentials to be verified. * @param authContext Callback context for associating the request with the verification response. * * @return Return ER_OK if the request is handled. */ virtual QStatus VerifyCredentialsAsync(const char* authMechanism, const char* peerName, const Credentials& credentials, void* authContext) { QCC_UNUSED(authMechanism); QCC_UNUSED(peerName); QCC_UNUSED(credentials); QCC_UNUSED(authContext); return ER_NOT_IMPLEMENTED; } /** * Respond to a call to VerifyCredentialsAsync. * * @param authContext Context that was passed in the call out to RequestCredentialsAsync. * @param accept Returns true to accept the credentials or false to reject it. * * @return Returns ER_OK if the credential verification response was expected. Returns an error status if * the credentials verification response was not expected. */ static QStatus AJ_CALL VerifyCredentialsResponse(void* authContext, bool accept); /** * Optional method that if implemented allows an application to monitor security violations. This * function is called when an attempt to decrypt an encrypted messages failed or when an unencrypted * message was received on an interface that requires encryption. The message contains only * header information. * * @param status A status code indicating the type of security violation. * @param msg The message that cause the security violation. */ virtual void SecurityViolation(QStatus status, const Message& msg) { QCC_UNUSED(status); QCC_UNUSED(msg); } /** * Reports successful or unsuccessful completion of authentication. * * @param authMechanism The name of the authentication mechanism that was used or an empty * string if the authentication failed. * @param peerName The name of the remote peer being authenticated. On the initiating * side this will be a well-known-name for the remote peer. On the * accepting side this will be the unique bus name for the remote peer. * @param success true if the authentication was successful, otherwise false. */ virtual void AuthenticationComplete(const char* authMechanism, const char* peerName, bool success) = 0; }; } #endif alljoyn-15.04b/alljoyn_core/inc/alljoyn/AutoPinger.h000066400000000000000000000102121255700255500224660ustar00rootroot00000000000000/** * @file * * AutoPinger */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_AUTOPINGER_H_ #define _ALLJOYN_AUTOPINGER_H_ #ifndef __cplusplus #error Only include AutoPinger.h in C++ code. #endif #include #include #include #include #include namespace ajn { /// @cond ALLJOYN_DEV /** @internal Forward references */ class AutoPingerInternal; class BusAttachment; /// @endcond /** * AutoPinger class */ class AutoPinger { public: /** * Create instance of autopinger * * @param busAttachment reference to the BusAttachment associated with this * autopinger. * */ AutoPinger(BusAttachment& busAttachment); /** * Destructor. * * Do not destroy an AutoPinger instance from within a PingListener * callback. This will cause a deadlock. */ ~AutoPinger(); /** * Pause all ping actions */ void Pause(); /** * Resume ping actions */ void Resume(); /** * Define new ping group * * @param group Ping group name * @param listener Listener called when a change was detected in the reachability of a destination * @param pingInterval Ping interval in seconds */ void AddPingGroup(const qcc::String& group, PingListener& listener, uint32_t pingInterval = 5); /** * Remove complete ping group, including all destinations * * Do not invoke this method from within a PingListener callback. This will * cause a deadlock. * * @param group Ping group name */ void RemovePingGroup(const qcc::String& group); /** * Set ping interval of the specified group * * @param group Ping group name * @param pingInterval Ping interval in seconds * @return * - #ER_OK: Interval updated * - #ER_BUS_PING_GROUP_NOT_FOUND: group did not exist */ QStatus SetPingInterval(const qcc::String& group, uint32_t pingInterval); /** * Add a destination to the specified ping group * Destinations are refcounted and must be removed N times if they were added N times * * @param group Ping group name * @param destination Destination name to be pinged * @return * - #ER_OK: destination added * - #ER_BUS_PING_GROUP_NOT_FOUND: group did not exist */ QStatus AddDestination(const qcc::String& group, const qcc::String& destination); /** * Remove a destination from the specified ping group * This will lower the refcount by one and only remove the destination when the refcount reaches zero * * @param group Ping group name * @param destination Destination name to be removed * @param removeAll Rather than decrementing the refcount by one, set refcount to zero and remove * @return * - #ER_OK: destination removed or was not present * - #ER_BUS_PING_GROUP_NOT_FOUND: group did not exist */ QStatus RemoveDestination(const qcc::String& group, const qcc::String& destination, bool removeAll = false); private: AutoPinger(const AutoPinger&); void operator=(const AutoPinger&); AutoPingerInternal* internal; }; } #endif /* AUTOPINGER_H_ */ alljoyn-15.04b/alljoyn_core/inc/alljoyn/BusAttachment.h000066400000000000000000002472101255700255500231650ustar00rootroot00000000000000/** * @file BusAttachment.h is the top-level object responsible for connecting to a * message bus. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_BUSATTACHMENT_H #define _ALLJOYN_BUSATTACHMENT_H #ifndef __cplusplus #error Only include BusAttachment.h in C++ code. #endif #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include namespace ajn { /** * %BusAttachment is the top-level object responsible for connecting to and optionally managing a message bus. */ class BusAttachment : public MessageReceiver { public: /** * Pure virtual base class implemented by classes that wish to call JoinSessionAsync(). */ class JoinSessionAsyncCB { public: /** Destructor */ virtual ~JoinSessionAsyncCB() { } /** * Called when JoinSessionAsync() completes. * * @param status ER_OK if successful * @param sessionId Unique identifier for session. * @param opts Session options. * @param context User defined context which will be passed as-is to callback. */ virtual void JoinSessionCB(QStatus status, SessionId sessionId, const SessionOpts& opts, void* context) = 0; }; /** * Pure virtual base class implemented by classes that wish to call LeaveSessionAsync() or any of its variants. */ class LeaveSessionAsyncCB { public: /** Destructor */ virtual ~LeaveSessionAsyncCB() { } /** * Called when LeaveSessionAsync() or any of its variants completes. * * @param status ER_OK if successful * @param context User defined context which will be passed as-is to callback. */ virtual void LeaveSessionCB(QStatus status, void* context) = 0; }; /** * Pure virtual base class implemented by classes that wish to call SetLinkTimeoutAsync(). */ class SetLinkTimeoutAsyncCB { public: /** Destructor */ virtual ~SetLinkTimeoutAsyncCB() { } /** * Called when SetLinkTimeoutAsync() completes. * * @param status ER_OK if successful * @param timeout Timeout value (possibly adjusted from original request). * @param context User defined context which will be passed as-is to callback. */ virtual void SetLinkTimeoutCB(QStatus status, uint32_t timeout, void* context) = 0; }; /** * Pure virtual base class implemented by classes that wish to call PingAsync(). */ class PingAsyncCB { public: /** Destructor */ virtual ~PingAsyncCB() { } /** * Called when PingAsync() completes. * * @param status * - #ER_OK the name is present and responding * - #ER_ALLJOYN_PING_REPLY_UNREACHABLE the name is no longer present *
* The following status values indicate that the router cannot determine if the * remote name is present and responding: * - #ER_ALLJOYN_PING_REPLY_TIMEOUT Ping call timed out * - #ER_ALLJOYN_PING_REPLY_UNKNOWN_NAME name not found currently or not part of any known session * - #ER_ALLJOYN_PING_REPLY_INCOMPATIBLE_REMOTE_ROUTING_NODE the remote routing node does not implement Ping *
* The following status values indicate an error with the ping call itself: * - #ER_ALLJOYN_PING_FAILED Ping failed * - #ER_BUS_UNEXPECTED_DISPOSITION An unexpected disposition was returned and has been treated as an error * @param context User defined context which will be passed as-is to callback. */ virtual void PingCB(QStatus status, void* context) = 0; }; /** * Pure virtual base class implemented by classes that wish to call GetNameOwnerAsync(). */ class GetNameOwnerAsyncCB { public: /** Destructor */ virtual ~GetNameOwnerAsyncCB() { } /** * Called when GetNameOwnerAsync() completes. * * @param status ER_OK if successful * @param uniqueName Unique name that owns the requested alias. * @param context User defined context which will be passed as-is to callback. */ virtual void GetNameOwnerCB(QStatus status, const char* uniqueName, void* context) = 0; }; /** * Construct a BusAttachment. * * @param applicationName Name of the application. * @param allowRemoteMessages True if this attachment is allowed to receive messages from remote devices. * @param concurrency The maximum number of concurrent method and signal handlers locally executing. */ BusAttachment(const char* applicationName, bool allowRemoteMessages = false, uint32_t concurrency = 4); /** Destructor */ virtual ~BusAttachment(); /** * Get the concurrent method and signal handler limit. * * @return The maximum number of concurrent method and signal handlers. */ uint32_t GetConcurrency(); /** * Get the connect spec used by the BusAttachment * * @return The string representing the connect spec used by the BusAttachment */ qcc::String GetConnectSpec(); /** * Allow the currently executing method/signal handler to enable concurrent callbacks * during the scope of the handler's execution. */ void EnableConcurrentCallbacks(); /** * Create an interface description with a given name. * * Typically, interfaces that are implemented by BusObjects are created here. * Interfaces that are implemented by remote objects are added automatically by * the bus if they are not already present via ProxyBusObject::IntrospectRemoteObject(). * * Because interfaces are added both explicitly (via this method) and implicitly * (via @c ProxyBusObject::IntrospectRemoteObject), there is the possibility that creating * an interface here will fail because the interface already exists. If this happens, the * ER_BUS_IFACE_ALREADY_EXISTS will be returned and NULL will be returned in the iface [OUT] * parameter. * * Interfaces created with this method need to be activated using InterfaceDescription::Activate() * once all of the methods, signals, etc have been added to the interface. The interface will * be unaccessible (via BusAttachment::GetInterfaces() or BusAttachment::GetInterface()) until * it is activated. * * @param name The requested interface name. * @param[out] iface * - Interface description * - NULL if cannot be created. * @param secPolicy The security policy for this interface * * @return * - #ER_OK if creation was successful. * - #ER_BUS_IFACE_ALREADY_EXISTS if requested interface already exists * * @see ProxyBusObject::IntrospectRemoteObject, InterfaceDescription::Activate, BusAttachment::GetInterface */ QStatus CreateInterface(const char* name, InterfaceDescription*& iface, InterfaceSecurityPolicy secPolicy); /** * Deprecated API for creating an interface description with a given name. * * @param name The requested interface name. * @param[out] iface * - Interface description * - NULL if cannot be created. * @param secure If true the interface is secure and method calls and signals will be encrypted. * * @return * - #ER_OK if creation was successful. * - #ER_BUS_IFACE_ALREADY_EXISTS if requested interface already exists */ QStatus CreateInterface(const char* name, InterfaceDescription*& iface, bool secure = false) { return CreateInterface(name, iface, secure ? AJ_IFC_SECURITY_REQUIRED : AJ_IFC_SECURITY_INHERIT); } /** * Initialize one more interface descriptions from an XML string in DBus introspection format. * The root tag of the XML can be a \ or a stand alone \ tag. To initialize more * than one interface the interfaces need to be nested in a \ tag. * * Note that when this method fails during parsing, the return code will be set accordingly. * However, any interfaces which were successfully parsed prior to the failure may be registered * with the bus. * * @param xml An XML string in DBus introspection format. * * @return * - #ER_OK if parsing is completely successful. * - An error status otherwise. */ QStatus CreateInterfacesFromXml(const char* xml); /** * Returns the existing activated InterfaceDescriptions. * * @param ifaces A pointer to an InterfaceDescription array to receive the interfaces. Can be NULL in * which case no interfaces are returned and the return value gives the number * of interface available. * @param numIfaces The size of the InterfaceDescription array. If this value is smaller than the total * number of interfaces only numIfaces will be returned. * * @return The number of interfaces returned or the total number of interfaces if ifaces is NULL. */ size_t GetInterfaces(const InterfaceDescription** ifaces = NULL, size_t numIfaces = 0) const; /** * Retrieve an existing activated InterfaceDescription. * * @param name Interface name * * @return * - A pointer to the registered interface * - NULL if interface doesn't exist */ const InterfaceDescription* GetInterface(const char* name) const; /** * Delete an interface description with a given name. * * Deleting an interface is only allowed if that interface has never been activated. * * @param iface The un-activated interface to be deleted. * * @return * - #ER_OK if deletion was successful * - #ER_BUS_NO_SUCH_INTERFACE if interface was not found */ QStatus DeleteInterface(InterfaceDescription& iface); /** * @brief Start the process of spinning up the independent threads used in * the bus attachment, preparing it for action. * * This method only begins the process of starting the bus. Sending and * receiving messages cannot begin until the bus is Connect()ed. * * In most cases, it is not required to understand the threading model of * the bus attachment, with one important exception: The bus attachment may * send callbacks to registered listeners using its own internal threads. * This means that any time a listener of any kind is used in a program, the * implication is that a the overall program is multithreaded, irrespective * of whether or not threads are explicitly used. This, in turn, means that * any time shared state is accessed in listener methods, that state must be * protected. * * As soon as Start() is called, clients of a bus attachment with listeners * must be prepared to receive callbacks on those listeners in the context * of a thread that will be different from the thread running the main * program or any other thread in the client. * * Although intimate knowledge of the details of the threading model are not * required to use a bus attachment (beyond the caveat above) we do provide * methods on the bus attachment that help users reason about more complex * threading situations. This will apply to situations where clients of the * bus attachment are multithreaded and need to interact with the * multithreaded bus attachment. These methods can be especially useful * during shutdown, when the two separate threading systems need to be * gracefully brought down together. * * The BusAttachment methods Start(), Stop() and Join() all work together to * manage the autonomous activities that can happen in a BusAttachment. * These activities are carried out by so-called hardware threads. POSIX * defines functions used to control hardware threads, which it calls * pthreads. Many threading packages use similar constructs. * * In a threading package, a start method asks the underlying system to * arrange for the start of thread execution. Threads are not necessarily * running when the start method returns, but they are being *started*. Some time later, * a thread of execution appears in a thread run function, at which point the * thread is considered *running*. At some later time, executing a stop method asks the * underlying system to arrange for a thread to end its execution. The system * typically sends a message to the thread to ask it to stop doing what it is doing. * The thread is running until it responds to the stop message, at which time the * run method exits and the thread is considered *stopping*. * * Note that neither of Start() nor Stop() are synchronous in the sense that * one has actually accomplished the desired effect upon the return from a * call. Of particular interest is the fact that after a call to Stop(), * threads will still be *running* for some non-deterministic time. * * In order to wait until all of the threads have actually stopped, a * blocking call is required. In threading packages this is typically * called join, and our corresponding method is called Join(). * * A Start() method call should be thought of as mapping to a threading * package start function. it causes the activity threads in the * BusAttachment to be spun up and gets the attachment ready to do its main * job. As soon as Start() is called, the user should be prepared for one * or more of these threads of execution to pop out of the bus attachment * and into a listener callback. * * The Stop() method call should be thought of as mapping to a threading * package stop function. It asks the BusAttachment to begin shutting down * its various threads of execution, but does not wait for any threads to exit. * * A call to the Join() method should be thought of as mapping to a * threading package join function call. It blocks and waits until all of * the threads in the BusAttachment have in fact exited their Run functions, * gone through the stopping state and have returned their status. When * the Join() method returns, one may be assured that no threads are running * in the bus attachment, and therefore there will be no callbacks in * progress and no further callbacks will ever come out of a particular * instance of a bus attachment. * * It is important to understand that since Start(), Stop() and Join() map * to threads concepts and functions, one should not expect them to clean up * any bus attachment state when they are called. These functions are only * present to help in orderly termination of complex threading systems. * * @see Stop() * @see Join() * * @return * - #ER_OK if successful. * - #ER_BUS_BUS_ALREADY_STARTED if already started * - Other error status codes indicating a failure */ QStatus Start(); /** * @brief Ask the threading subsystem in the bus attachment to begin the * process of ending the execution of its threads. * * The Stop() method call on a bus attachment should be thought of as * mapping to a threading package stop function. It asks the BusAttachment * to begin shutting down its various threads of execution, but does not * wait for any threads to exit. * * A call to Stop() is implied as one of the first steps in the destruction * of a bus attachment. * * @warning There is no guarantee that a listener callback may begin executing * after a call to Stop(). To achieve that effect, the Stop() must be followed * by a Join(). * * @see Start() * @see Join() * * @return * - #ER_OK if successful. * - An error QStatus if unable to begin the process of stopping the * message bus threads. */ QStatus Stop(); /** * @brief Wait for all of the threads spawned by the bus attachment to be * completely exited. * * A call to the Join() method should be thought of as mapping to a * threading package join function call. It blocks and waits until all of * the threads in the BusAttachment have, in fact, exited their Run functions, * gone through the stopping state and have returned their status. When * the Join() method returns, one may be assured that no threads are running * in the bus attachment, and therefore there will be no callbacks in * progress and no further callbacks will ever come out of the instance of a * bus attachment on which Join() was called. * * A call to Join() is implied as one of the first steps in the destruction * of a bus attachment. Thus, when a bus attachment is destroyed, it is * guaranteed that before it completes its destruction process, there will be * no callbacks in process. * * @warning If Join() is called without a previous Stop() it will result in * blocking "forever." * * @see Start() * @see Stop() * * @return * - #ER_OK if successful. * - #ER_BUS_BUS_ALREADY_STARTED if already started * - Other error status codes indicating a failure */ QStatus Join(); /** * @brief Determine if the bus attachment has been Start()ed. * * @see Start() * @see Stop() * @see Join() * * @return true if the message bus has been Start()ed. */ bool IsStarted() { return isStarted; } /** * @brief Determine if the bus attachment has been Stop()ed. * * @see Start() * @see Stop() * @see Join() * * @return true if the message bus has been Start()ed. */ bool IsStopping() { return isStopping; } /** * Connect to an AllJoyn router at a specific connectSpec destination. * * If there is no router present at the given connectSpec or if the router * at the connectSpec has an incompatible AllJoyn version, this method will * attempt to use a bundled router if one exists. * * @param connectSpec A transport connection spec string of the form: * @c ":=,=...[;]" * * @return * - #ER_OK if successful. * - An error status otherwise */ QStatus Connect(const char* connectSpec); /** * Connect to a local AllJoyn router. * * Locate a local AllJoyn router that is compatible with this * AllJoyn client's version and connect to the router. * * @return * - #ER_OK if successful. * - An error status otherwise */ QStatus Connect(); /** * Disconnect a remote bus address connection. * * @deprecated When bundled router is enabled and in-use, the connectSpec * will be ignored and the bundled router connectSpec will be used. Use * Disconnect() instead which will use correct connectSpec. * * @param connectSpec The transport connection spec used to connect. * * @return * - #ER_OK if successful * - #ER_BUS_BUS_NOT_STARTED if the bus is not started * - #ER_BUS_NOT_CONNECTED if the %BusAttachment is not connected to the bus * - Other error status codes indicating a failure */ QCC_DEPRECATED(QStatus Disconnect(const char* connectSpec)); /** * %Disconnect the %BusAttachment from the remote bus. * * @return * - #ER_OK if successful * - #ER_BUS_BUS_NOT_STARTED if the bus is not started * - #ER_BUS_NOT_CONNECTED if the %BusAttachment is not connected to the bus * - Other error status codes indicating a failure */ QStatus Disconnect(); /** * Indicate whether bus is currently connected. * * Messages can only be sent or received when the bus is connected. * * @return true if the bus is connected. */ bool IsConnected() const; /** * Register a BusObject * * @param obj BusObject to register. * @param secure true if authentication is required to access this object. * * @return * - #ER_OK if successful. * - #ER_BUS_BAD_OBJ_PATH for a bad object path * - #ER_BUS_OBJ_ALREADY_EXISTS if an object is already registered at this path */ QStatus RegisterBusObject(BusObject& obj, bool secure = false); /** * Unregister a BusObject * * @param object Object to be unregistered. */ void UnregisterBusObject(BusObject& object); /** * Get the org.freedesktop.DBus proxy object. * * @return org.freedesktop.DBus proxy object */ const ProxyBusObject& GetDBusProxyObj(); /** * Get the org.alljoyn.Bus proxy object. * * @return org.alljoyn.Bus proxy object */ const ProxyBusObject& GetAllJoynProxyObj(); /** * Get the org.alljoyn.Debug proxy object. * * @return org.alljoyn.Debug proxy object */ const ProxyBusObject& GetAllJoynDebugObj(); /** * Get the unique name of this BusAttachment. Returns an empty string if the bus attachment * is not connected. * * @return The unique name of this BusAttachment. */ const qcc::String GetUniqueName() const; /** * Get the unique name of specified alias. * * @param alias Alias name to lookup. * * @return The unique name of the alias. */ qcc::String GetNameOwner(const char* alias); /** * Get the unique name of specified alias. * * @param alias Alias name to lookup. * * @return The unique name of the alias. */ qcc::String GetNameOwner(const qcc::String& alias) { return GetNameOwner(alias.c_str()); } /** * Get the unique name of specified alias asyncronously * * @param[in] alias Alias name to lookup. * @param[in] callback pointer to function that is called with the results * of the `GetNameOwner` method call. * @param[in] context User defined context which will be passed as-is to * the callback. * * @return status code from sending the message to the local routing node. */ QStatus GetNameOwnerAsync(const char* alias, GetNameOwnerAsyncCB* callback, void* context); /** * Get the unique name of specified alias asyncronously * * @param[in] alias Alias name to lookup. * @param[in] callback pointer to function that is called with the results * of the `GetNameOwner` method call. * @param[in] context User defined context which will be passed as-is to the * callback. * * @return status code from sending the message to the local routing node. */ QStatus GetNameOwnerAsync(const qcc::String& alias, GetNameOwnerAsyncCB* callback, void* context) { return GetNameOwnerAsync(alias.c_str(), callback, context); } /** * Get the GUID of this BusAttachment as a 32 character hex string. * * The returned value may be appended to an advertised well-known name in order to guarantee * that the resulting name is globally unique. * * @return GUID of this BusAttachment as a string. */ const qcc::String& GetGlobalGUIDString() const; /** * Get the GUID of this BusAttachment as an 8 character string. * * The returned value may be appended to an advertised well-known name in * order to guarantee that the resulting name is globally unique. Note: * This version of the string is not quite as unique as the version that * returns 32 hex characters, but it is sufficient since the returned * string is identical to the base portion of the unique name. Also, the * returned string may begin with a digit and so the application would * need to accomodate that if used immediately after a "." in a d-bus * compliant bus name. * * @return GUID of this BusAttachment as a string. */ const qcc::String& GetGlobalGUIDShortString() const; /** * Register a signal handler. * * Signals are forwarded to the signalHandler if sender, interface, member and path * qualifiers are ALL met. * * @param receiver The object receiving the signal. * @param signalHandler The signal handler method. * @param member The interface/member of the signal. * @param srcPath The object path of the emitter of the signal or NULL for all paths. * @return #ER_OK */ QStatus RegisterSignalHandler(MessageReceiver* receiver, MessageReceiver::SignalHandler signalHandler, const InterfaceDescription::Member* member, const char* srcPath); /** * Register a signal handler. * * Signals are forwarded to the signalHandler if sender, interface, member and rule * qualifiers are ALL met. * * @param receiver The object receiving the signal. * @param signalHandler The signal handler method. * @param member The interface/member of the signal. * @param matchRule A filter rule. * @return #ER_OK */ QStatus RegisterSignalHandlerWithRule(MessageReceiver* receiver, MessageReceiver::SignalHandler signalHandler, const InterfaceDescription::Member* member, const char* matchRule); /** * Unregister a signal handler. * * Remove the signal handler that was registered with the given parameters. * * @param receiver The object receiving the signal. * @param signalHandler The signal handler method. * @param member The interface/member of the signal. * @param srcPath The object path of the emitter of the signal or NULL for all paths. * @return #ER_OK */ QStatus UnregisterSignalHandler(MessageReceiver* receiver, MessageReceiver::SignalHandler signalHandler, const InterfaceDescription::Member* member, const char* srcPath); /** * Unregister a signal handler. * * Remove the signal handler that was registered with the given parameters. * * @param receiver The object receiving the signal. * @param signalHandler The signal handler method. * @param member The interface/member of the signal. * @param matchRule A filter rule. * @return #ER_OK */ QStatus UnregisterSignalHandlerWithRule(MessageReceiver* receiver, MessageReceiver::SignalHandler signalHandler, const InterfaceDescription::Member* member, const char* matchRule); /** * Unregister all signal and reply handlers for the specified message receiver. This function is * intended to be called from within the destructor of a MessageReceiver class instance. It * prevents any pending signals or replies from accessing the MessageReceiver after the message * receiver has been freed. * * @param receiver The message receiver that is being unregistered. * @return ER_OK if successful. */ QStatus UnregisterAllHandlers(MessageReceiver* receiver); /** * Enable peer-to-peer security. This function must be called by applications that want to use * authentication and encryption. The bus must have been started by calling * BusAttachment::Start() before this function is called. If the application is providing its * own key store implementation it must have already called RegisterKeyStoreListener() before * calling this function. * * Once peer security has been enabled it is not possible to change the authMechanism set without * clearing it first (setting authMechanism to NULL). This is true regardless of whether the BusAttachment * has been disconnected or not. * * @param authMechanisms The authentication mechanism(s) to use for peer-to-peer authentication. * If this parameter is NULL peer-to-peer authentication is disabled. This is a * space separated list of any of the following values: * ALLJOYN_SRP_LOGON, ALLJOYN_SRP_KEYX, ALLJOYN_ECDHE_NULL, ALLJOYN_ECDHE_PSK, * ALLJOYN_ECDHE_ECDSA, GSSAPI. * * @param listener Passes password and other authentication related requests to the application. * * @param keyStoreFileName Optional parameter to specify the filename of the default key store. The * default value is the applicationName parameter of BusAttachment(). * Note that this parameter is only meaningful when using the default * key store implementation. * * @param isShared optional parameter that indicates if the key store is shared between multiple * applications. It is generally harmless to set this to true even when the * key store is not shared but it adds some unnecessary calls to the key store * listener to load and store the key store in this case. * * @return * - #ER_OK if peer security was enabled. * - #ER_BUS_BUS_NOT_STARTED BusAttachment::Start has not be called */ QStatus EnablePeerSecurity(const char* authMechanisms, AuthListener* listener, const char* keyStoreFileName = NULL, bool isShared = false); /** * Check is peer security has been enabled for this bus attachment. * * @return Returns true if peer security has been enabled, false otherwise. */ bool IsPeerSecurityEnabled(); /** * Register an object that will receive bus event notifications. * * @param listener Object instance that will receive bus event notifications. */ virtual void RegisterBusListener(BusListener& listener); /** * Unregister an object that was previously registered with RegisterBusListener. * * @param listener Object instance to un-register as a listener. */ virtual void UnregisterBusListener(BusListener& listener); /** * Set a key store listener to listen for key store load and store requests. * This overrides the internal key store listener. * * @param listener The key store listener to set. * * @return * - #ER_OK if the key store listener was set * - #ER_BUS_LISTENER_ALREADY_SET if a listener has been set by this function or because * EnablePeerSecurity has been called. */ QStatus RegisterKeyStoreListener(KeyStoreListener& listener); /** * Unregister a previously registered KeyStore. This will return control for * load and store requests to the default internal keystore listener. * * @return * - #ER_OK if the key store Unregistered */ QStatus UnregisterKeyStoreListener(); /** * Reloads the key store for this bus attachment. This function would normally only be called in * the case where a single key store is shared between multiple bus attachments, possibly by different * applications. It is up to the applications to coordinate how and when the shared key store is * modified. * * @return - ER_OK if the key store was successfully reloaded * - An error status indicating that the key store reload failed. */ QStatus ReloadKeyStore(); /** * Clears all stored keys from the key store. All store keys and authentication information is * deleted and cannot be recovered. Any passwords or other credentials will need to be reentered * when establishing secure peer connections. */ void ClearKeyStore(); /** * Clear the keys associated with a specific remote peer as identified by its peer GUID. The * peer GUID associated with a bus name can be obtained by calling GetPeerGUID(). * * @param guid The guid of a remote authenticated peer. * * @return - ER_OK if the keys were cleared * - ER_UNKNOWN_GUID if there is no peer with the specified GUID * - Other errors */ QStatus ClearKeys(const qcc::String& guid); /** * Set the expiration time on keys associated with a specific remote peer as identified by its * peer GUID. The peer GUID associated with a bus name can be obtained by calling GetPeerGUID(). * If the timeout is 0 this is equivalent to calling ClearKeys(). * * @param guid The GUID of a remote authenticated peer. * @param timeout The time in seconds relative to the current time to expire the keys. * * @return - ER_OK if the expiration time was successfully set. * - ER_UNKNOWN_GUID if there is no authenticated peer with the specified GUID * - Other errors */ QStatus SetKeyExpiration(const qcc::String& guid, uint32_t timeout); /** * Get the expiration time on keys associated with a specific authenticated remote peer as * identified by its peer GUID. The peer GUID associated with a bus name can be obtained by * calling GetPeerGUID(). * * @param guid The GUID of a remote authenticated peer. * @param timeout The time in seconds relative to the current time when the keys will expire. * * @return - ER_OK if the expiration time was successfully set. * - ER_UNKNOWN_GUID if there is no authenticated peer with the specified GUID * - Other errors */ QStatus GetKeyExpiration(const qcc::String& guid, uint32_t& timeout); /** * Adds a logon entry string for the requested authentication mechanism to the key store. This * allows an authenticating server to generate offline authentication credentials for securely * logging on a remote peer using a user-name and password credentials pair. This only applies * to authentication mechanisms that support a user name + password logon functionality. * * @param authMechanism The authentication mechanism. * @param userName The user name to use for generating the logon entry. * @param password The password to use for generating the logon entry. If the password is * NULL the logon entry is deleted from the key store. * * @return * - #ER_OK if the logon entry was generated. * - #ER_BUS_INVALID_AUTH_MECHANISM if the authentication mechanism does not support * logon functionality. * - #ER_BAD_ARG_2 indicates a null string was used as the user name. * - #ER_BAD_ARG_3 indicates a null string was used as the password. * - Other error status codes indicating a failure */ QStatus AddLogonEntry(const char* authMechanism, const char* userName, const char* password); /** * Request a well-known name. * This method is a shortcut/helper that issues an org.freedesktop.DBus.RequestName method call to the local router * and interprets the response. * * @param[in] requestedName Well-known name being requested. * @param[in] flags Bitmask of DBUS_NAME_FLAG_* defines (see DBusStdDefines.h) * * @return * - #ER_OK iff router response was received and request was successful. * - #ER_BUS_NOT_CONNECTED if a connection has not been made with a local bus. * - Other error status codes indicating a failure. */ QStatus RequestName(const char* requestedName, uint32_t flags); /** * Release a previously requested well-known name. * * This method is a shortcut/helper that issues an org.freedesktop.DBus.ReleaseName method call to the local router * and interprets the response. * * @param[in] name Well-known name being released. * * @return * - #ER_OK iff router response was received amd the name was successfully released. * - #ER_BUS_NOT_CONNECTED if a connection has not been made with a local bus. * - Other error status codes indicating a failure. */ QStatus ReleaseName(const char* name); /** * Add a DBus match rule. * * This method is a shortcut/helper that issues an org.freedesktop.DBus.AddMatch method call to the local router. * * @param[in] rule Match rule to be added (see DBus specification for format of this string). * * @return * - #ER_OK if the AddMatch request was successful. * - #ER_BUS_NOT_CONNECTED if a connection has not been made with a local bus. * - Other error status codes indicating a failure. */ QStatus AddMatch(const char* rule); /** * Remove a DBus match rule. * This method is a shortcut/helper that issues an org.freedesktop.DBus.RemoveMatch method call to the local router. * * @param[in] rule Match rule to be removed (see DBus specification for format of this string). * * @return * - #ER_OK if the RemoveMatch request was successful. * - #ER_BUS_NOT_CONNECTED if a connection has not been made with a local bus. * - Other error status codes indicating a failure. */ QStatus RemoveMatch(const char* rule); /** * Add a DBus match rule. * * This method is a shortcut/helper that issues an org.freedesktop.DBus.AddMatch method call to the local router. * In contrast with the regular AddMatch, this method does not wait for a reply from the local router. That makes * the call non-blocking, and hence useful in cases where deadlocks might occur otherwise. * * @param[in] rule Match rule to be added (see DBus specification for format of this string). * * @return * - #ER_OK if the AddMatch request was successful. * - #ER_BUS_NOT_CONNECTED if a connection has not been made with a local bus. * - Other error status codes indicating a failure. */ QStatus AddMatchNonBlocking(const char* rule); /** * Remove a DBus match rule. * * This method is a shortcut/helper that issues an org.freedesktop.DBus.RemoveMatch method call to the local router. * In contrast with the regular RemoveMatch, this method does not wait for a reply from the local router. That makes * the call non-blocking, and hence useful in cases where deadlocks might occur otherwise. * * @param[in] rule Match rule to be removed (see DBus specification for format of this string). * * @return * - #ER_OK if the RemoveMatch request was successful. * - #ER_BUS_NOT_CONNECTED if a connection has not been made with a local bus. * - Other error status codes indicating a failure. */ QStatus RemoveMatchNonBlocking(const char* rule); /** * Advertise the existence of a well-known name to other (possibly disconnected) AllJoyn routers. * * This method is a shortcut/helper that issues an org.alljoyn.Bus.AdvertisedName method call to the local router * and interprets the response. * * @param[in] name the well-known name to advertise. (Must be owned by the caller via RequestName). * @param[in] transports Set of transports to use for sending advertisement. * * @return * - #ER_OK iff router response was received and advertise was successful. * - #ER_BUS_NOT_CONNECTED if a connection has not been made with a local bus. * - Other error status codes indicating a failure. */ QStatus AdvertiseName(const char* name, TransportMask transports); /** * Stop advertising the existence of a well-known name to other AllJoyn routers. * * This method is a shortcut/helper that issues an org.alljoyn.Bus.CancelAdvertiseName method call to the local router * and interprets the response. * * @param[in] name A well-known name that was previously advertised via AdvertiseName. * @param[in] transports Set of transports whose name advertisement will be canceled. * * @return * - #ER_OK iff router response was received and advertisements were successfully stopped. * - #ER_BUS_NOT_CONNECTED if a connection has not been made with a local bus. * - Other error status codes indicating a failure. */ QStatus CancelAdvertiseName(const char* name, TransportMask transports); /** * Register interest in a well-known name prefix for the purpose of discovery over transports included in TRANSPORT_ANY * * This method is a shortcut/helper that issues an org.alljoyn.Bus.FindAdvertisedName method call to the local router * and interprets the response. * * @param[in] namePrefix Well-known name prefix that application is interested in receiving * BusListener::FoundAdvertisedName notifications about. * * @return * - #ER_OK iff router response was received and discovery was successfully started. * - #ER_BUS_NOT_CONNECTED if a connection has not been made with a local bus. * - Other error status codes indicating a failure. */ QStatus FindAdvertisedName(const char* namePrefix); /** * Register interest in a well-known name prefix for the purpose of discovery over specified transports * * * This method is a shortcut/helper that issues an org.alljoyn.Bus.FindAdvertisedName method call to the local router * and interprets the response. * * @param[in] namePrefix Well-known name prefix that application is interested in receiving * BusListener::FoundAdvertisedName notifications about. * @param[in] transports Transports over which to do well-known name discovery * * @return * - #ER_OK iff router response was received and discovery was successfully started. * - #ER_BUS_NOT_CONNECTED if a connection has not been made with a local bus. * - Other error status codes indicating a failure. */ QStatus FindAdvertisedNameByTransport(const char* namePrefix, TransportMask transports); /** * Cancel interest in a well-known name prefix that was previously * registered with FindAdvertisedName. This cancels well-known name discovery over transports * included in TRANSPORT_ANY. This method is a shortcut/helper * that issues an org.alljoyn.Bus.CancelFindAdvertisedName method * call to the local router and interprets the response. * * @param[in] namePrefix Well-known name prefix that application is no longer interested in receiving * BusListener::FoundAdvertisedName notifications about. * * @return * - #ER_OK iff router response was received and cancel was successfully completed. * - #ER_BUS_NOT_CONNECTED if a connection has not been made with a local bus. * - Other error status codes indicating a failure. */ QStatus CancelFindAdvertisedName(const char* namePrefix); /** * Cancel interest in a well-known name prefix that was previously * registered with FindAdvertisedName. This cancels well-known name discovery over * the specified transports. This method is a shortcut/helper * that issues an org.alljoyn.Bus.CancelFindAdvertisedName method * call to the local router and interprets the response. * * @param[in] namePrefix Well-known name prefix that application is no longer interested in receiving * BusListener::FoundAdvertisedName notifications about. * @param[in] transports Transports over which to cancel well-known name discovery * * @return * - #ER_OK iff router response was received and cancel was successfully completed. * - #ER_BUS_NOT_CONNECTED if a connection has not been made with a local bus. * - Other error status codes indicating a failure. */ QStatus CancelFindAdvertisedNameByTransport(const char* namePrefix, TransportMask transports); /** * Make a SessionPort available for external BusAttachments to join. * * Each BusAttachment binds its own set of SessionPorts. Session joiners use the bound session * port along with the name of the attachment to create a persistent logical connection (called * a Session) with the original BusAttachment. * * A SessionPort and bus name form a unique identifier that BusAttachments use when joining a * session. * * SessionPort values can be pre-arranged between AllJoyn services and their clients (well-known * SessionPorts). * * Once a session is joined using one of the service's well-known SessionPorts, the service may * bind additional SessionPorts (dynamically) and share these SessionPorts with the joiner over * the original session. The joiner can then create additional sessions with the service by * calling JoinSession with these dynamic SessionPort ids. * * @param[in,out] sessionPort SessionPort value to bind or SESSION_PORT_ANY to allow this method * to choose an available port. On successful return, this value * contains the chosen SessionPort. * * @param[in] opts Session options that joiners must agree to in order to * successfully join the session. * * @param[in] listener Called by the bus when session related events occur. * * @return * - #ER_OK iff router response was received and the bind operation was successful. * - #ER_BUS_NOT_CONNECTED if a connection has not been made with a local bus. * - Other error status codes indicating a failure. */ QStatus BindSessionPort(SessionPort& sessionPort, const SessionOpts& opts, SessionPortListener& listener); /** * Cancel an existing port binding. * * @param[in] sessionPort Existing session port to be un-bound. * * @return * - #ER_OK iff router response was received and the bind operation was successful. * - #ER_BUS_NOT_CONNECTED if a connection has not been made with a local bus. * - Other error status codes indicating a failure. */ QStatus UnbindSessionPort(SessionPort sessionPort); /** * Join a session. * * This method is a shortcut/helper that issues an org.alljoyn.Bus.JoinSession method call to the local router * and interprets the response. * * All transports specified in opts will be tried. If the join fails over one of the transports, the join will * be tried over subsequent ones until all are tried until the join succeeds or they all fail. * * @param[in] sessionHost Bus name of attachment that is hosting the session to be joined. * @param[in] sessionPort SessionPort of sessionHost to be joined. * @param[in] listener Optional listener called when session related events occur. May be NULL. * @param[out] sessionId Unique identifier for session. * @param[in,out] opts Session options. * * @return * - #ER_OK iff router response was received and the session was successfully joined. * - #ER_BUS_NOT_CONNECTED if a connection has not been made with a local bus. * - Other error status codes indicating a failure. */ QStatus JoinSession(const char* sessionHost, SessionPort sessionPort, SessionListener* listener, SessionId& sessionId, SessionOpts& opts); /** * Join a session. * * This method is a shortcut/helper that issues an org.alljoyn.Bus.JoinSession method call to the local router * and interprets the response. * * All transports specified in opts will be tried. If the join fails over one of the transports, the join will * be tried over subsequent ones until all are tried until the join succeeds or they all fail. * * This call executes asynchronously. When the JoinSession response is received, the callback will be called. * * @param[in] sessionHost Bus name of attachment that is hosting the session to be joined. * @param[in] sessionPort SessionPort of sessionHost to be joined. * @param[in] listener Optional listener called when session related events occur. May be NULL. * @param[in] opts Session options. * @param[in] callback Called when JoinSession response is received. * @param[in] context User defined context which will be passed as-is to callback. * * @return * - #ER_OK iff method call to local router response was was successful. * - #ER_BUS_NOT_CONNECTED if a connection has not been made with a local bus. * - Other error status codes indicating a failure. */ QStatus JoinSessionAsync(const char* sessionHost, SessionPort sessionPort, SessionListener* listener, const SessionOpts& opts, BusAttachment::JoinSessionAsyncCB* callback, void* context = NULL); /** * Set the SessionListener for an existing sessionId. * This method cannot be called on a self-joined session. * * Calling this method will override the listener set by a previous call to SetSessionListener, * SetHostedSessionListener, SetJoinedSessionListener or any listener specified in JoinSession. * * @param sessionId The session id of an existing session. * @param listener The SessionListener to associate with the session. May be NULL to clear previous listener. * @return * - #ER_OK if successful. * - #ER_BUS_NO_SESSION if session did not exist */ QStatus SetSessionListener(SessionId sessionId, SessionListener* listener); /** * Set the SessionListener for an existing sessionId on the joiner side. * * Calling this method will override the listener set by a previous call to SetSessionListener, SetJoinedSessionListener * or any listener specified in JoinSession. * * @param sessionId The session id of an existing session. * @param listener The SessionListener to associate with the session. May be NULL to clear previous listener. * @return * - #ER_OK if successful. * - #ER_BUS_NO_SESSION if session did not exist or if not joiner side of the session */ QStatus SetJoinedSessionListener(SessionId sessionId, SessionListener* listener); /** * Set the SessionListener for an existing sessionId on the host side. * * Calling this method will override the listener set by a previous call to SetSessionListener or SetHostedSessionListener. * * @param sessionId The session id of an existing session. * @param listener The SessionListener to associate with the session. May be NULL to clear previous listener. * @return * - #ER_OK if successful. * - #ER_BUS_NO_SESSION if session did not exist or if not host side of the session */ QStatus SetHostedSessionListener(SessionId sessionId, SessionListener* listener); /** * Leave an existing session. * This method is a shortcut/helper that issues an org.alljoyn.Bus.LeaveSession method call to the local router * and interprets the response. * This method cannot be called on self-joined session. * * @param[in] sessionId Session id. * * @return * - #ER_OK if router response was received and the leave operation was successfully completed. * - #ER_BUS_NOT_CONNECTED if a connection has not been made with a local bus. * - #ER_BUS_NO_SESSION if session did not exist. * - Other error status codes indicating a failure. */ QStatus LeaveSession(const SessionId& sessionId); /** * Leave an existing session as host. This function will fail if you were not the host. * This method is a shortcut/helper that issues an org.alljoyn.Bus.LeaveHostedSession method call to the local router * and interprets the response. * * @param[in] sessionId Session id. * * @return * - #ER_OK if router response was received and the leave operation was successfully completed. * - #ER_BUS_NOT_CONNECTED if a connection has not been made with a local bus. * - #ER_BUS_NO_SESSION if session did not exist or if not host of the session. * - Other error status codes indicating a failure. */ QStatus LeaveHostedSession(const SessionId& sessionId); /** * Leave an existing session as joiner. This function will fail if you were not the joiner. * This method is a shortcut/helper that issues an org.alljoyn.Bus.LeaveJoinedSession method call to the local router * and interprets the response. * * @param[in] sessionId Session id. * * @return * - #ER_OK if router response was received and the leave operation was successfully completed. * - #ER_BUS_NOT_CONNECTED if a connection has not been made with a local bus. * - #ER_BUS_NO_SESSION if session did not exist or if not joiner of the session. * - Other error status codes indicating a failure. */ QStatus LeaveJoinedSession(const SessionId& sessionId); /** * Leave an existing session. * This method is a shortcut/helper that issues an org.alljoyn.Bus.LeaveSession method call to the local router * and interprets the response. * This method cannot be called on self-joined session. * * This call executes asynchronously. When the LeaveSession response is received, the callback will be called. * * @param[in] sessionId Session id. * @param[in] callback Called when LeaveSession response is received. * @param[in] context User defined context which will be passed as-is to callback. * * @return * - #ER_OK iff method call to local router response was successful. * - #ER_BUS_NOT_CONNECTED if a connection has not been made with a local bus. * - Other error status codes indicating a failure. */ QStatus LeaveSessionAsync(const SessionId& sessionId, BusAttachment::LeaveSessionAsyncCB* callback, void* context = NULL); /** * Leave an existing session as host. This function will fail if you were not the host. * This method is a shortcut/helper that issues an org.alljoyn.Bus.LeaveHostedSession method call to the local router * and interprets the response. * * This call executes asynchronously. When the LeaveHostedSession response is received, the callback will be called. * * @param[in] sessionId Session id. * @param[in] callback Called when LeaveHostedSession response is received. * @param[in] context User defined context which will be passed as-is to callback. * * @return * - #ER_OK iff method call to local router response was successful. * - #ER_BUS_NOT_CONNECTED if a connection has not been made with a local bus. * - Other error status codes indicating a failure. */ QStatus LeaveHostedSessionAsync(const SessionId& sessionId, BusAttachment::LeaveSessionAsyncCB* callback, void* context = NULL); /** * Leave an existing session as joiner. This function will fail if you were not the joiner. * This method is a shortcut/helper that issues an org.alljoyn.Bus.LeaveJoinedSession method call to the local router * and interprets the response. * * This call executes asynchronously. When the LeaveJoinedSession response is received, the callback will be called. * * @param[in] sessionId Session id. * @param[in] callback Called when LeaveJoinedSession response is received. * @param[in] context User defined context which will be passed as-is to callback. * * @return * - #ER_OK iff method call to local router response was successful. * - #ER_BUS_NOT_CONNECTED if a connection has not been made with a local bus. * - Other error status codes indicating a failure. */ QStatus LeaveJoinedSessionAsync(const SessionId& sessionId, BusAttachment::LeaveSessionAsyncCB* callback, void* context = NULL); /** * Remove a member from an existing multipoint session. * This function may be called by the binder of the session to forcefully remove a member from a session. * * This method is a shortcut/helper that issues an org.alljoyn.Bus.RemoveSessionMember method call to the local router * and interprets the response. * * @param[in] sessionId Session id. * @param[in] memberName Member to remove. * * @return * - #ER_OK iff router response was received and the remove member operation was successfully completed. * - #ER_BUS_NOT_CONNECTED if a connection has not been made with a local bus. * - Other error status codes indicating a failure. */ QStatus RemoveSessionMember(SessionId sessionId, qcc::String memberName); /** * Get the file descriptor for a raw (non-message based) session. * * @param sessionId Id of an existing streaming session. * @param sockFd [OUT] Socket file descriptor for session. * * @return ER_OK if successful. */ QStatus GetSessionFd(SessionId sessionId, qcc::SocketFd& sockFd); /** * Set the link timeout for a session. * * Link timeout is the maximum number of seconds that an unresponsive router-to-router connection * will be monitored before declaring the session lost (via SessionLost callback). Link timeout * defaults to 0 which indicates that AllJoyn link monitoring is disabled. * * Each transport type defines a lower bound on link timeout to avoid defeating transport * specific power management algorithms. * * @param sessionid Id of session whose link timeout will be modified. * @param linkTimeout [IN/OUT] Max number of seconds that a link can be unresponsive before being * declared lost. 0 indicates that AllJoyn link monitoring will be disabled. On * return, this value will be the resulting (possibly upward) adjusted linkTimeout * value that acceptable to the underlying transport. * * @return * - #ER_OK if successful * - #ER_ALLJOYN_SETLINKTIMEOUT_REPLY_NOT_SUPPORTED if local router does not support SetLinkTimeout * - #ER_ALLJOYN_SETLINKTIMEOUT_REPLY_NO_DEST_SUPPORT if SetLinkTimeout not supported by destination * - #ER_BUS_NO_SESSION if the Session id is not valid * - #ER_ALLJOYN_SETLINKTIMEOUT_REPLY_FAILED if SetLinkTimeout failed * - #ER_BUS_NOT_CONNECTED if the BusAttachment is not connected to the router */ QStatus SetLinkTimeout(SessionId sessionid, uint32_t& linkTimeout); /** * Set the link timeout for a session. * * Link timeout is the maximum number of seconds that an unresponsive router-to-router connection * will be monitored before declaring the session lost (via SessionLost callback). Link timeout * defaults to 0 which indicates that AllJoyn link monitoring is disabled. * * Each transport type defines a lower bound on link timeout to avoid defeating transport * specific power management algorithms. * * This call executes asynchronously. When the SetLinkTimeout response is received, the callback will be called. * * @param[in] sessionid Id of session whose link timeout will be modified. * @param[in] linkTimeout Max number of seconds that a link can be unresponsive before being * declared lost. 0 indicates that AllJoyn link monitoring will be disabled. On * return, this value will be the resulting (possibly upward) adjusted linkTimeout * value that acceptable to the underlying transport. * @param[in] callback Called when SetLinkTimeout response is received. * @param[in] context User defined context which will be passed as-is to callback. * * @return * - #ER_OK iff method call to local router response was was successful. * - #ER_BUS_NOT_CONNECTED if a connection has not been made with a local bus. * - Other error status codes indicating a failure. */ QStatus SetLinkTimeoutAsync(SessionId sessionid, uint32_t linkTimeout, BusAttachment::SetLinkTimeoutAsyncCB* callback, void* context = NULL); /** * Determine whether a given well-known name exists on the bus. * This method is a shortcut/helper that issues an org.freedesktop.DBus.NameHasOwner method call to the router * and interprets the response. * * @param[in] name The well known name that the caller is inquiring about. * @param[out] hasOwner If return is ER_OK, indicates whether name exists on the bus. * If return is not ER_OK, hasOwner parameter is not modified. * @return * - #ER_OK if name ownership was able to be determined. * - An error status otherwise */ QStatus NameHasOwner(const char* name, bool& hasOwner); /** * Get the peer GUID for this peer of the local peer or an authenticated remote peer. The bus * names of a remote peer can change over time, specifically the unique name is different each * time the peer connects to the bus and a peer may use different well-known-names at different * times. The peer GUID is the only persistent identity for a peer. Peer GUIDs are used by the * authentication mechanisms to uniquely and identify a remote application instance. The peer * GUID for a remote peer is only available if the remote peer has been authenticated. * * @param name Name of a remote peer or NULL to get the local (this application's) peer GUID. * @param guid Returns the guid for the local or remote peer depending on the value of name. * * @return * - #ER_OK if the requested GUID was obtained. * - An error status otherwise. */ QStatus GetPeerGUID(const char* name, qcc::String& guid); /** * This sets the debug level of the local AllJoyn router if that router * was built in debug mode. * * The debug level can be set for individual subsystems or for "ALL" * subsystems. Common subsystems are "ALLJOYN" for core AllJoyn code, * "ALLJOYN_OBJ" for the sessions management code and "ALLJOYN_NS" for the * TCP name services. Debug levels for specific subsystems override the * setting for "ALL" subsystems. For example if "ALL" is set to 7, but * "ALLJOYN_OBJ" is set to 1, then detailed debug output will be generated * for all subsystems except for "ALLJOYN_OBJ" which will only generate high * level debug output. "ALL" defaults to 0 which is off, or no debug * output. * * The debug output levels are actually a bit field that controls what * output is generated. Those bit fields are described below: * * - 0x1: High level debug prints (these debug printfs are not common) * - 0x2: Normal debug prints (these debug printfs are common) * - 0x4: Function call tracing (these debug printfs are used * sporadically) * - 0x8: Data dump (really only used in the "SOCKET" module - can * generate a *lot* of output) * * Typically, when enabling debug for a subsystem, the level would be set * to 7 which enables High level debug, normal debug, and function call * tracing. Setting the level 0, forces debug output to be off for the * specified subsystem. * * @param module name of the module to generate debug output * @param level debug level to set for the module * * @return * - #ER_OK if debug request was successfully sent to the AllJoyn * router. * - #ER_BUS_NO_SUCH_OBJECT if router was not built in debug mode. */ QStatus SetDaemonDebug(const char* module, uint32_t level); /** * Returns the current non-absolute real-time clock used internally by AllJoyn. This value can be * compared with the timestamps on messages to calculate the time since a timestamped message * was sent. * * @return The current timestamp in milliseconds. */ static uint32_t AJ_CALL GetTimestamp(); /** * Determine if you are able to find a remote connection based on its BusName. * The BusName can be the Unique or well-known name. * * @param name The unique or well-known name to ping * @param timeout Timeout specified in milliseconds to wait for reply * * @return * - #ER_OK the name is present and responding * - #ER_ALLJOYN_PING_REPLY_UNREACHABLE the name is no longer present *
* The following return values indicate that the router cannot determine if the * remote name is present and responding: * - #ER_ALLJOYN_PING_REPLY_TIMEOUT Ping call timed out * - #ER_ALLJOYN_PING_REPLY_UNKNOWN_NAME name not found currently or not part of any known session * - #ER_ALLJOYN_PING_REPLY_INCOMPATIBLE_REMOTE_ROUTING_NODE the remote routing node does not implement Ping *
* The following return values indicate an error with the ping call itself: * - #ER_ALLJOYN_PING_FAILED Ping failed * - #ER_BUS_UNEXPECTED_DISPOSITION An unexpected disposition was returned and has been treated as an error * - #ER_BUS_NOT_CONNECTED the BusAttachment is not connected to the bus * - #ER_BUS_BAD_BUS_NAME the name parameter is not a valid bus name * - An error status otherwise */ QStatus Ping(const char* name, uint32_t timeout); /** * Determine if you are able to find a remote connection based on its BusName. * The BusName can be the Unique or well-known name. * * This call executes asynchronously. When the PingAsync response is received, * the callback will be called. * * @param[in] name The unique or well-known name to ping * @param[in] timeout Timeout specified in milliseconds to wait for reply * @param[in] callback Called when PingAsync response is received. * @param[in] context User defined context which will be passed as-is to callback. * * @see PingAsyncCB * * @return * - #ER_OK iff method call to local router response was successful. * - #ER_BUS_NOT_CONNECTED the BusAttachment is not connected to the bus * - #ER_BUS_BAD_BUS_NAME the name parameter is not a valid bus name * - Other error status codes indicating a failure. */ QStatus PingAsync(const char* name, uint32_t timeout, BusAttachment::PingAsyncCB* callback, void* context); /** * Set a Translator for all BusObjects and InterfaceDescriptions. This Translator is used for * descriptions appearing in introspection. Note that any Translators set on a specific * InterfaceDescription or BusObject will be used for those specific elements - this Translator * is used only for BusObjects and InterfaceDescriptions that do not have Translators set for them. * * @param[in] translator The Translator instance */ void SetDescriptionTranslator(Translator* translator); /** * Get this BusAttachment's Translator * * @return This BusAttachment's Translator */ Translator* GetDescriptionTranslator(); /** * Registers a handler to receive the org.alljoyn.about Announce signal. * * The handler is only called if a call to WhoImplements has been has been * called. * * Important: the AboutListener should be registered before calling WhoImplements * * @param[in] aboutListener reference to AboutListener */ void RegisterAboutListener(AboutListener& aboutListener); /** * Unregisters the AnnounceHandler from receiving the org.alljoyn.about Announce signal. * * @param[in] aboutListener reference to AboutListener to unregister */ void UnregisterAboutListener(AboutListener& aboutListener); /** * Unregisters all AboutListeners from receiving any org.alljoyn.about Announce signal */ void UnregisterAllAboutListeners(); /** * List the interfaces your application is interested in. If a remote device * is announcing that interface then all Registered AboutListeners will * be called. * * For example, if you need both "com.example.Audio" and * "com.example.Video" interfaces then do the following. * RegisterAboutListener once: * @code * const char* interfaces[] = {"com.example.Audio", "com.example.Video"}; * RegisterAboutListener(aboutListener); * WhoImplements(interfaces, sizeof(interfaces) / sizeof(interfaces[0])); * @endcode * * If the AboutListener should be called if "com.example.Audio" * or "com.example.Video" interfaces are implemented then call * WhoImplements multiple times: * @code * * RegisterAboutListener(aboutListener); * const char* audioInterface[] = {"com.example.Audio"}; * WhoImplements(audioInterface, sizeof(audioInterface) / sizeof(audioInterface[0])); * const char* videoInterface[] = {"com.example.Video"}; * WhoImplements(videoInterface, sizeof(videoInterface) / sizeof(videoInterface[0])); * @endcode * * The interface name may be a prefix followed by a `*`. Using * this, the example where we are interested in "com.example.Audio" or * "com.example.Video" interfaces could be written as: * @code * const char* exampleInterface[] = {"com.example.*"}; * RegisterAboutListener(aboutListener); * WhoImplements(exampleInterface, sizeof(exampleInterface) / sizeof(exampleInterface[0])); * @endcode * * The AboutListener will receive any announcement that implements an interface * beginning with the "com.example." name. * * It is the AboutListeners responsibility to parse through the reported * interfaces to figure out what should be done in response to the Announce * signal. * * WhoImplements is ref counted. If WhoImplements is called with the same * list of interfaces multiple times then CancelWhoImplements must also be * called multiple times with the same list of interfaces. * * Note: specifying NULL for the implementsInterfaces parameter could have * significant impact on network performance and should be avoided unless * all announcements are needed. * * @param[in] implementsInterfaces a list of interfaces that the Announce * signal reports as implemented. NULL to receive all Announce * signals regardless of interfaces * @param[in] numberInterfaces the number of interfaces in the * implementsInterfaces list * @return status */ QStatus WhoImplements(const char** implementsInterfaces, size_t numberInterfaces); /** * Non-blocking variant of WhoImplements * @see WhoImplements(const char**, size_t) * * @param[in] implementsInterfaces a list of interfaces that the Announce * signal reports as implemented. NULL to receive all Announce * signals regardless of interfaces * @param[in] numberInterfaces the number of interfaces in the * implementsInterfaces list * @return * - #ER_OK on success * - An error status otherwise */ QStatus WhoImplementsNonBlocking(const char** implementsInterfaces, size_t numberInterfaces); /** * List an interface your application is interested in. If a remote device * is announcing that interface then the all Registered AnnounceListeners will * be called. * * This is identical to WhoImplements(const char**, size_t) * except this is specialized for a single interface not several interfaces. * * Note: specifying NULL for the interface parameter could have significant * impact on network performance and should be avoided unless all * announcements are needed. * * @see WhoImplements(const char**, size_t) * @param[in] iface interface that the remote user must implement to * receive the announce signal. * * @return * - #ER_OK on success * - An error status otherwise */ QStatus WhoImplements(const char* iface); /** * Non-blocking variant of WhoImplements * @see WhoImplements(const char**, size_t) * * @param[in] iface interface that the remote user must implement to * receive the announce signal. * @return * - #ER_OK on success * - An error status otherwise */ QStatus WhoImplementsNonBlocking(const char* iface); /** * Stop showing interest in the listed interfaces. Stop receiving announce * signals from the devices with the listed interfaces. * * Note if WhoImplements has been called multiple times the announce signal * will still be received for any interfaces that still remain. * * @param[in] implementsInterfaces a list of interfaces. The list must match the * list previously passed to the WhoImplements * member function * @param[in] numberInterfaces the number of interfaces in the * implementsInterfaces list * @return * - #ER_OK on success * - #ER_BUS_MATCH_RULE_NOT_FOUND if interfaces added using the WhoImplements * member function were not found. * - An error status otherwise */ QStatus CancelWhoImplements(const char** implementsInterfaces, size_t numberInterfaces); /** * Non-blocking variant of CancelWhoImplements. * * @see CancelWhoImplements(const char**, size_t) * @param[in] implementsInterfaces a list of interfaces. The list must match the * list previously passed to the WhoImplements * member function * @param[in] numberInterfaces the number of interfaces in the * implementsInterfaces list * @return * - #ER_OK on success * - An error status otherwise */ QStatus CancelWhoImplementsNonBlocking(const char** implementsInterfaces, size_t numberInterfaces); /** * Stop showing interest in the listed interfaces. Stop receiving announce * signals from the devices with the listed interfaces. * * This is identical to CancelWhoImplements(const char**, size_t) * except this is specialized for a single interface not several interfaces. * * @see CancelWhoImplements(const char**, size_t) * @param[in] iface interface that the remove user must implement to * receive the announce signal. * * @return * - #ER_OK on success * - #ER_BUS_MATCH_RULE_NOT_FOUND if interface added using the WhoImplements * member function were not found. * - An error status otherwise */ QStatus CancelWhoImplements(const char* iface); /** * Non-blocking variant of CancelWhoImplements. * * @see CancelWhoImplements(const char**, size_t) * @param[in] iface interface that the remove user must implement to * receive the announce signal. * @return * - #ER_OK on success * - An error status otherwise */ QStatus CancelWhoImplementsNonBlocking(const char* iface); /// @cond ALLJOYN_DEV /** * @internal * Class for internal state for bus attachment. */ class Internal; /** * @internal * Get a pointer to the internal BusAttachment state. * * @return A pointer to the internal state. */ Internal& GetInternal() { return *busInternal; } /** * @internal * Get a pointer to the internal BusAttachment state. * * @return A pointer to the internal state. */ const Internal& GetInternal() const { return *busInternal; } /// @endcond protected: /// @cond ALLJOYN_DEV /** * @internal * Construct a BusAttachment. * * @param internal Internal state. * @param concurrency The maximum number of concurrent method and signal * handlers locally executing. */ BusAttachment(Internal* internal, uint32_t concurrency); /// @endcond /// @cond ALLJOYN_DEV /** * @internal * Notify AllJoyn that the application is suspending. Exclusively-held * resource should be released so that other applications will not be * prevented from acquiring the resource. * * @return * - #ER_OK on success * - #ER_BUS_NOT_CONNECTED if BusAttachment is not connected * - #ER_ALLJOYN_ONAPPSUSPEND_REPLY_FAILED if the app suspend request failed * - #ER_ALLJOYN_ONAPPSUSPEND_REPLY_UNSUPPORTED if app suspend is not supported * - #ER_BUS_UNEXPECTED_DISPOSITION if OnAppSuspend enters an unexpected state */ QStatus OnAppSuspend(); /// @endcond /// @cond ALLJOYN_DEV /** * @internal * Notify AllJoyn that the application is resuming so that it can re-acquire * the resource that has been released when the application was suspended. * * @return * - #ER_OK on success * - #ER_BUS_NOT_CONNECTED if BusAttachment is not connected * - #ER_ALLJOYN_ONAPPRESUME_REPLY_FAILED if the app resume request failed * - #ER_ALLJOYN_ONAPPRESUME_REPLY_UNSUPPORTED if app resume is not supported * - #ER_BUS_UNEXPECTED_DISPOSITION if OnAppResume enters an unexpected state */ QStatus OnAppResume(); /// @endcond private: typedef uint16_t SessionSideMask; typedef enum { SESSION_SIDE_HOST = 0, SESSION_SIDE_JOINER = 1, SESSION_SIDE_NUM } SessionSide; static const uint8_t SESSION_SIDE_MASK_HOST = (1 << SESSION_SIDE_HOST); static const uint8_t SESSION_SIDE_MASK_JOINER = (1 << SESSION_SIDE_JOINER); static const uint8_t SESSION_SIDE_MASK_BOTH = (SESSION_SIDE_MASK_HOST | SESSION_SIDE_MASK_JOINER); /** * Assignment operator is private. */ BusAttachment& operator=(const BusAttachment&); /** * Copy constructor is private. */ BusAttachment(const BusAttachment&); /** * Stop the bus, optionally blocking until all of the threads join */ QStatus StopInternal(bool blockUntilStopped = true); /** * Wait until all of the threads have stopped (join). */ void WaitStopInternal(); /** * Validate the response to SetLinkTimeout */ QStatus GetLinkTimeoutResponse(Message& reply, uint32_t& timeout); /** * Validate the response to JoinSession */ QStatus GetJoinSessionResponse(Message& reply, SessionId& sessionId, SessionOpts& opts); /** * Leave the session as host and/or joiner, asynchronous version */ QStatus LeaveSessionAsync(const SessionId& sessionId, const char* method, SessionSideMask bitset, BusAttachment::LeaveSessionAsyncCB* callback, void* context); /** * Leave the session as host and/or joiner */ QStatus LeaveSession(const SessionId& sessionId, const char*method, SessionSideMask bitset); /** * Clear session listeners for a particular session */ void ClearSessionListener(SessionId sessionId, SessionSideMask bitset); /** * Remove references to session */ void ClearSessionSet(SessionId sessionId, SessionSideMask bitset); /** * Register signal handlers for BusListener */ QStatus RegisterSignalHandlers(); /** * Unregister signal handlers for BusListener */ void UnregisterSignalHandlers(); qcc::String connectSpec; /**< The connect spec used to connect to the bus */ bool isStarted; /**< Indicates if the bus has been started */ bool isStopping; /**< Indicates Stop has been called */ uint32_t concurrency; /**< The maximum number of concurrent method and signal handlers locally executing */ Internal* busInternal; /**< Internal state information */ /** * Internal Class used to insure that the BusAttachment is the last object * destroyed. */ class JoinObj { public: /** * Construct a JoinObj. * * @param bus the `this` pointer that the internal JoinObj is a member of */ JoinObj(BusAttachment* bus) : bus(bus) { } /** * Destroy a JoinObj. */ ~JoinObj() { bus->WaitStopInternal(); } private: /** * private copy constructor to ensure the JoinObj is never copied * * @param other a JoinObj */ JoinObj(const JoinObj& other); /** * private assignment operator to ensure the JoinObj is never copied * * @param other a JoinObj * @return nothing is returned this is here to prevent the auto * generation of an assignment operator by the compiler. */ JoinObj& operator =(const JoinObj& other); /** * pointer to the BusAttachment containing the JoinObj */ BusAttachment* bus; }; Translator* translator; /**< Global translator for descriptions */ JoinObj joinObj; /**< MUST BE LAST MEMBER. Ensure all threads are joined before BusAttachment destruction */ }; } #endif alljoyn-15.04b/alljoyn_core/inc/alljoyn/BusListener.h000066400000000000000000000115311255700255500226550ustar00rootroot00000000000000/** * @file * BusListener is an abstract base class (interface) implemented by users of the * AllJoyn API in order to asynchronously receive bus related event information. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_BUSLISTENER_H #define _ALLJOYN_BUSLISTENER_H #ifndef __cplusplus #error Only include BusListener.h in C++ code. #endif #include namespace ajn { /** * Foward declaration. */ class BusAttachment; class MsgArg; /** * Abstract base class implemented by AllJoyn users and called by AllJoyn to inform * users of bus related events. */ class BusListener { public: /** * Virtual destructor for derivable class. */ virtual ~BusListener() { } /** * Called by the bus when the listener is registered. This gives the listener implementation the * opportunity to save a reference to the bus. * * @param bus The bus the listener is registered with. */ virtual void ListenerRegistered(BusAttachment* bus) { QCC_UNUSED(bus); } /** * Called by the bus when the listener is unregistered. */ virtual void ListenerUnregistered() { } /** * Called by the bus when an external bus is discovered that is advertising a well-known name * that this attachment has registered interest in via a DBus call to org.alljoyn.Bus.FindAdvertisedName * * @param name A well known name that the remote bus is advertising. * @param transport Transport that received the advertisement. * @param namePrefix The well-known name prefix used in call to FindAdvertisedName that triggered this callback. */ virtual void FoundAdvertisedName(const char* name, TransportMask transport, const char* namePrefix) { QCC_UNUSED(name); QCC_UNUSED(transport); QCC_UNUSED(namePrefix); } /** * Called by the bus when an advertisement previously reported through FoundName has become unavailable. * * @param name A well known name that the remote bus is advertising that is of interest to this attachment. * @param transport Transport that stopped receiving the given advertised name. * @param namePrefix The well-known name prefix that was used in a call to FindAdvertisedName that triggered this callback. */ virtual void LostAdvertisedName(const char* name, TransportMask transport, const char* namePrefix) { QCC_UNUSED(name); QCC_UNUSED(transport); QCC_UNUSED(namePrefix); } /** * Called by the bus when the ownership of any well-known name changes. * * @param busName The well-known name that has changed. * @param previousOwner The unique name that previously owned the name or NULL if there was no previous owner. * @param newOwner The unique name that now owns the name or NULL if there is no new owner. */ virtual void NameOwnerChanged(const char* busName, const char* previousOwner, const char* newOwner) { QCC_UNUSED(busName); QCC_UNUSED(previousOwner); QCC_UNUSED(newOwner); } /** * This has been deprecated. It will not be called any more. Use the ProxyBusObject property change handling mechanism instead. * Called by the bus when the value of a property changes if that property has annotation. * * @param propName The well-known name that has changed. * @param propValue The new value of the property; NULL if not present */ QCC_DEPRECATED(virtual void PropertyChanged(const char* propName, const MsgArg * propValue)) { QCC_UNUSED(propName); QCC_UNUSED(propValue); } /** * Called when a BusAttachment this listener is registered with is stopping. */ virtual void BusStopping() { } /** * Called when a BusAttachment this listener is registered with has become disconnected from * the bus. */ virtual void BusDisconnected() { } }; } #endif alljoyn-15.04b/alljoyn_core/inc/alljoyn/BusObject.h000066400000000000000000000647471255700255500223170ustar00rootroot00000000000000#ifndef _ALLJOYN_LOCALBUSOBJECT_H #define _ALLJOYN_LOCALBUSOBJECT_H /** * @file * * This file defines the base class for message bus objects that * are implemented and registered locally. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #include #include #include namespace ajn { /// @cond ALLJOYN_DEV /** @internal Forward references */ class BusAttachment; class MethodTable; /// @endcond /** * Message Bus Object base class */ class BusObject : public MessageReceiver { friend class MethodTable; friend class _LocalEndpoint; public: /** * flag used to specify if an interface is announced or not here * @see AddInterface */ typedef enum { UNANNOUNCED, ///< The interface is not announced ANNOUNCED ///< The interface is announced } AnnounceFlag; /** * Return the path for the object * * @return Object path */ const char* GetPath() { return path.c_str(); } /** * Get the name of this object. * The name is the last component of the path. * * @return Last component of object path. */ qcc::String GetName(); /** * %BusObject constructor. * * @param path Object path for object. * @param isPlaceholder Place-holder objects are created by the bus itself and serve only * as parent objects (in the object path sense) to other objects. */ BusObject(const char* path, bool isPlaceholder = false); /** * %BusObject constructor (Deprecated). * * @param bus Bus that this object exists on. * @param path Object path for object. * @param isPlaceholder Place-holder objects are created by the bus itself and serve only * as parent objects (in the object path sense) to other objects. */ QCC_DEPRECATED(BusObject(BusAttachment& bus, const char* path, bool isPlaceholder = false)); /** * %BusObject destructor. */ virtual ~BusObject(); /** * Emit PropertiesChanged to signal the bus that this property has been updated * * This is protected because JNI needs to be able to call it. * BusObject must be registered before calling this method. * * @param ifcName The name of the interface * @param propName The name of the property being changed * @param val The new value of the property * @param id ID of the session we broadcast the signal to (0 for all) * @param flags Flags to be added to the signal. */ void EmitPropChanged(const char* ifcName, const char* propName, MsgArg& val, SessionId id, uint8_t flags = 0); /** * Emit PropertiesChanged to signal the bus that these properties have been updated * * BusObject must be registered before calling this method. * * @param ifcName The name of the interface * @param propNames An array with the names of the properties being changed * @param numProps The size of the propNames array * @param id ID of the session we broadcast the signal to (0 for all) * @param flags Flags to be added to the signal. * * @return ER_OK if successful. */ QStatus EmitPropChanged(const char* ifcName, const char** propNames, size_t numProps, SessionId id, uint8_t flags = 0); /** * Get a reference to the underlying BusAttachment * * @return a reference to the BusAttachment */ const BusAttachment& GetBusAttachment() const { assert(bus); return *bus; } /** * Send a signal. * * @param destination The unique or well-known bus name or the signal recipient (NULL for broadcast signals) * @param sessionId A unique SessionId for this AllJoyn session instance. The session this message is for. * Use SESSION_ID_ALL_HOSTED to emit on all sessions hosted by this BusObject's BusAttachment. * For broadcast or sessionless signals, the sessionId must be 0. * @param signal Interface member of signal being emitted. * @param args The arguments for the signal (can be NULL) * @param numArgs The number of arguments * @param timeToLive If non-zero this specifies the useful lifetime for this signal. * For sessionless signals the units are seconds. * For all other signals the units are milliseconds. * If delivery of the signal is delayed beyond the timeToLive due to * network congestion or other factors the signal may be discarded. There is * no guarantee that expired signals will not still be delivered. * @param flags Logical OR of the message flags for this signals. The following flags apply to signals: * - If ::ALLJOYN_FLAG_GLOBAL_BROADCAST is set broadcast signal (null destination) will be * forwarded to all Routing Nodes in the system. * - If ::ALLJOYN_FLAG_ENCRYPTED is set the message is authenticated and the payload if any is * encrypted. * - If ::ALLJOYN_FLAG_SESSIONLESS is set the signal will be sent as a Sessionless Signal. NOTE: * if this flag and the GLOBAL_BROADCAST flags are set it could result in the same signal * being received twice. * * @param msg [OUT] If non-null, the sent signal message is returned to the caller. * @return * - #ER_OK if successful * - #ER_BUS_OBJECT_NOT_REGISTERED if bus object has not yet been registered * - An error status otherwise */ QStatus Signal(const char* destination, SessionId sessionId, const InterfaceDescription::Member& signal, const MsgArg* args = NULL, size_t numArgs = 0, uint16_t timeToLive = 0, uint8_t flags = 0, Message* msg = NULL); /** * Remove sessionless message sent from this object from local router's * store/forward cache. * * @param serialNumber Serial number of previously sent sessionless signal. * @return ER_OK if successful. */ QStatus CancelSessionlessMessage(uint32_t serialNumber); /** * Remove sessionless message sent from this object from local router's * store/forward cache. * * @param msg Message to be removed. * @return ER_OK if successful. */ QStatus CancelSessionlessMessage(const Message& msg) { return CancelSessionlessMessage(msg->GetCallSerial()); } /** * Indicates if this object is secure. * * @return Return true if authentication is required to emit signals or call methods on this object. */ bool IsSecure() const { return isSecure; } /** * Set the introspection description for this BusObject. * * Note that when SetDescriptoinTranslator is used the text in this method may * actually be a "lookup key". When generating the introspection the "text" is first * passed to the Translator where the key should be used to lookup the actual * description. In such a case, language should be set to "". * * @param language A language tag describing the language of the description * @param text The description */ void SetDescription(const char* language, const char* text); /** * Set the Translator that provides this BusObject's introspection description * in multiple languages. * * @param translator The Translator instance. */ void SetDescriptionTranslator(Translator* translator); /** * Get a list of the interfaces that are added to this BusObject that will * be announced. * * usage example * @code * size_t numInterfaces = busObject.GetAnnouncedInterfaces(NULL, 0); * const char** interfaces = new const char*[numInterfaces]; * busObject.GetAnnouncedInterfaces(interfaces, numInterfaces); * @endcode * * @param[in] interfaces an char* array pointer * @param[in] numInterfaces the size of the char* array * * @return * The total number of interfaces found that are announced. If this number * is larger than `numInterfaces` then only `numInterfaces` will be returned. * */ size_t GetAnnouncedInterfaceNames(const char** interfaces = NULL, size_t numInterfaces = 0); /** * Change the announce flag for an already added interface. Changes in the * announce flag are not visible to other devices till Announce is called. * * @see AboutObj::Announce() * * @param[in] iface InterfaceDescription for the interface you wish to set * the the announce flag. * @param[in] isAnnounced This interface should be part of the Announce signal * UNANNOUNCED - this interface will not be part of the Announce * signal * ANNOUNCED - this interface will be part of the Announce * signal. * @return * - #ER_OK if successful * - #ER_BUS_OBJECT_NO_SUCH_INTERFACE if the interface is not part of the * bus object. */ QStatus SetAnnounceFlag(const InterfaceDescription* iface, AnnounceFlag isAnnounced = ANNOUNCED); protected: /** * Type used to add multiple methods at one time. * @see AddMethodHandlers() */ //Pack option to resolve "alignment of a member was sensitive to packing" warning #pragma pack(push, MethodEntry, 4) typedef struct { const InterfaceDescription::Member* member; /**< Pointer to method's member */ MessageReceiver::MethodHandler handler; /**< Method implementation */ } MethodEntry; #pragma pack(pop, MethodEntry) /** Bus associated with object */ BusAttachment* bus; /** * Reply to a method call. * * @param msg The method call message * @param args The reply arguments (can be NULL) * @param numArgs The number of arguments * @return * - #ER_OK if successful * - #ER_BUS_OBJECT_NOT_REGISTERED if bus object has not yet been registered * - An error status otherwise */ QStatus MethodReply(const Message& msg, const MsgArg* args = NULL, size_t numArgs = 0); /** * Reply to a method call with an error message. * * @param msg The method call message * @param error The name of the error * @param errorMessage An error message string * @return * - #ER_OK if successful * - #ER_BUS_OBJECT_NOT_REGISTERED if bus object has not yet been registered * - An error status otherwise */ QStatus MethodReply(const Message& msg, const char* error, const char* errorMessage = NULL); /** * Reply to a method call with an error message. * * @param msg The method call message * @param status The status code for the error * @return * - #ER_OK if successful * - #ER_BUS_OBJECT_NOT_REGISTERED if bus object has not yet been registered * - An error status otherwise */ QStatus MethodReply(const Message& msg, QStatus status); /** * Add an interface to this object. If the interface has properties this will also add the * standard property access interface. An interface must be added before its method handlers can be * added. Note that the Peer interface (org.freedesktop.DBus.peer) is implicit on all objects and * cannot be explicitly added, and the Properties interface (org.freedesktop,DBus.Properties) is * automatically added when needed and cannot be explicitly added. * * Once an object is registered, it should not add any additional interfaces. Doing so would * confuse remote objects that may have already introspected this object. * * @param iface The interface to add * @param isAnnounced This interface should be part of the Announce signal * UNANNOUNCED - this interface will not be part of the Announce * signal * ANNOUNCED - this interface will be part of the Announce * signal. * * @return * - #ER_OK if the interface was successfully added. * - #ER_BUS_IFACE_ALREADY_EXISTS if the interface already exists. * - An error status otherwise */ QStatus AddInterface(const InterfaceDescription& iface, AnnounceFlag isAnnounced = UNANNOUNCED); /** * Add a method handler to this object. The interface for the method handler must have already * been added by calling AddInterface(). * * @param member Interface member implemented by handler. * @param handler Method handler. * @param context An optional context. This is mainly intended for implementing language * bindings and should normally be NULL. * * @return * - #ER_OK if the method handler was added. * - An error status otherwise */ QStatus AddMethodHandler(const InterfaceDescription::Member* member, MessageReceiver::MethodHandler handler, void* context = NULL); /** * Convenience method used to add a set of method handers at once. * * @param entries Array of MehtodEntry * @param numEntries Number of entries in array. * * @return * - #ER_OK if all the methods were added * - #ER_BUS_NO_SUCH_INTERFACE is method can not be added because interface does not exist. */ QStatus AddMethodHandlers(const MethodEntry* entries, size_t numEntries); /** * Handle a bus request to read a property from this object. * BusObjects that implement properties should override this method. * The default version simply returns ER_BUS_NO_SUCH_PROPERTY. * * @param ifcName Identifies the interface that the property is defined on * @param propName Identifies the property to get * @param[out] val Returns the property value. The type of this value is the actual value * type. * @return #ER_BUS_NO_SUCH_PROPERTY (Should be changed by user implementation of BusObject) */ virtual QStatus Get(const char* ifcName, const char* propName, MsgArg& val) { QCC_UNUSED(ifcName); QCC_UNUSED(propName); QCC_UNUSED(val); return ER_BUS_NO_SUCH_PROPERTY; } /** * Handle a bus attempt to write a property value to this object. * BusObjects that implement properties should override this method. * This default version just replies with ER_BUS_NO_SUCH_PROPERTY * * @param ifcName Identifies the interface that the property is defined on * @param propName Identifies the property to set * @param val The property value to set. The type of this value is the actual value * type. * @return #ER_BUS_NO_SUCH_PROPERTY (Should be changed by user implementation of BusObject) */ virtual QStatus Set(const char* ifcName, const char* propName, MsgArg& val) { QCC_UNUSED(ifcName); QCC_UNUSED(propName); QCC_UNUSED(val); return ER_BUS_NO_SUCH_PROPERTY; } /** * Returns a description of the object in the D-Bus introspection XML format. * This method can be overridden by derived classes in order to customize the * introspection XML presented to remote nodes. Note that to DTD description and * the root element are not generated. * * @param deep Include XML for all descendants rather than stopping at direct children. * @param indent Number of characters to indent the XML * @return Description of the object in AllJoyn introspection XML format */ virtual qcc::String GenerateIntrospection(bool deep = false, size_t indent = 0) const; /** * Returns a description of the object in the AllJoyn introspection XML format. * This is the same as the D-Bus format but includes elements. * This method can be overridden by derived classes in order to customize the * introspection XML presented to remote nodes. Note that to DTD description and * the root element are not generated. * * @param languageTag language reguested for 's. NULL for no descriptions. * @param deep Include XML for all descendants rather than stopping at direct children. * @param indent Number of characters to indent the XML * @return Description of the object in AllJoyn introspection XML format */ virtual qcc::String GenerateIntrospection(const char* languageTag, bool deep = false, size_t indent = 0) const; /** * Called by the message bus when the object has been successfully registered. The object can * perform any initialization such as adding match rules at this time. */ virtual void ObjectRegistered(void) { } /** * Called by the message bus when the object has been successfully unregistered * @remark * This base class implementation @b must be called explicitly by any overriding derived class. */ virtual void ObjectUnregistered(void) { isRegistered = false; } /** * Default handler for a bus attempt to read a property value. * @remark * A derived class can override this function to provide a custom handler for the GetProp method * call. If overridden the custom handler must compose an appropriate reply message to return the * requested property value. * * @param member Identifies the org.freedesktop.DBus.Properties.Get method. * @param msg The Properties.Get request. */ virtual void GetProp(const InterfaceDescription::Member* member, Message& msg); /** * Default handler for a bus attempt to write a property value. * @remark * A derived class can override this function to provide a custom handler for the SetProp method * call. If overridden the custom handler must compose an appropriate reply message. * * @param member Identifies the org.freedesktop.DBus.Properties.Set method. * @param msg The Properties.Set request. */ virtual void SetProp(const InterfaceDescription::Member* member, Message& msg); /** * Default handler for a bus attempt to read all properties on an interface. * @remark * A derived class can override this function to provide a custom handler for the GetAllProps * method call. If overridden the custom handler must compose an appropriate reply message * listing all properties on this object. * * @param member Identifies the org.freedesktop.DBus.Properties.GetAll method. * @param msg The Properties.GetAll request. */ virtual void GetAllProps(const InterfaceDescription::Member* member, Message& msg); /** * Default handler for a bus attempt to read the object's introspection data. * @remark * A derived class can override this function to provide a custom handler for the Introspect method * call. If overridden the custom handler must compose an appropriate reply message. * * @param member Identifies the @c org.freedesktop.DBus.Introspectable.Introspect method. * @param msg The Introspectable.Introspect request. */ virtual void Introspect(const InterfaceDescription::Member* member, Message& msg); /** * Default handler for a bus attempt to read the object's introspection data with descriptions. * @remark * A derived class can override this function to provide a custom handler for the IntrospectWithDescription method * call. If overridden the custom handler must compose an appropriate reply message. * * @param member Identifies the @c org.allseen.Introspectable.IntrospectWithDescription method. * @param msg The Introspectable.IntrospectWithDescription request. */ virtual void IntrospectWithDescription(const InterfaceDescription::Member* member, Message& msg); /** * Default handler for a bus attempt to read the languages available for IntrospectWithDescription * @remark * A derived class can override this function to provide a custom handler for the GetDescriptionLanguages method * call. If overridden the custom handler must compose an appropriate reply message. * * @param member Identifies the @c org.allseen.Introspectable.GetDescriptionLanguages method. * @param msg The Introspectable.GetDescriptionLanguages request. */ virtual void GetDescriptionLanguages(const InterfaceDescription::Member* member, Message& msg); /** * This method can be overridden to provide access to the context registered in the AddMethodHandler() call. * * @param member The method being called. * @param handler The handler to call. * @param message The message containing the method call arguments. * @param context NULL or a private context passed in when the method handler was registered. */ virtual void CallMethodHandler(MessageReceiver::MethodHandler handler, const InterfaceDescription::Member* member, Message& message, void* context) { QCC_UNUSED(context); (this->*handler)(member, message); } private: /** * Assignment operator is private. */ BusObject& operator=(const BusObject&) { return *this; } /** * Copy constructor is private. */ BusObject(const BusObject& other) : bus(other.bus) { } /** * Add the registered methods for this object to a method table. * * @param methodTable The method table to which this objects methods are added. */ void InstallMethods(MethodTable& methodTable); /** * This utility method is called by the bus during object registration. * Do not call this object explicitly. * * @param bus BusAttachement to associate with BusObject. * @return * - #ER_OK if all the methods were added * - #ER_BUS_NO_SUCH_INTERFACE is method can not be added because interface does not exist. */ QStatus DoRegistration(BusAttachment& bus); /** * Returns true if this object implements the given interface. * * @param iface The name of the interface to look for. * * @return true iff object implements interface. */ bool ImplementsInterface(const char* iface); /** * Replace this object by another one. This may require unlinking the existing object from its * parent and children and linking in the new one. * * @param object The object that is replacing this object. */ void Replace(BusObject& object); /** * Add an object as a child of this object. * * @param child The object to add as a child of this object. */ void AddChild(BusObject& child); /** * Remove a child from this object returning the removed child. * * @return Returns the removed child or NULL if the object has no children. */ BusObject* RemoveChild(); /** * Remove a specific child from this object. * * @param obj Pointer to the child to be removed. * @return * - #ER_OK if successful. * - #ER_BUS_NO_SUCH_OBJECT otherwise. */ QStatus RemoveChild(BusObject& obj); /** * Indicate that this BusObject is being used by an alternate thread. * This BusObject should not be deleted till the remote thread has completed * using this object. * This will increment a counter for each thread that calls this method */ void InUseIncrement(); /** * Indicate that this BusObject is no longer being used by an alternate thread. * It is safe to delete the object when the inUse counter has reached zero. */ void InUseDecrement(); /** * Get the introspection description for the provided language or NULL if not * defined. * * @param toLanguage The language tag for which the description is being requested. * @param buffer used by the Translator so that we can free its memory * @return The description or NULL if not found */ const char* GetDescription(const char* toLanguage, qcc::String& buffer) const; struct Components; Components* components; /**< Internal components of this object */ /** Object path of this object */ const qcc::String path; /** Parent object of this object (NULL if this is the root object) */ BusObject* parent; /** true if object's ObjectRegistered callback has been called */ bool isRegistered; /** true if object is a placeholder (i.e. only exists to be the parent of a more meaningful object instance) */ bool isPlaceholder; /** true if this object is secure */ bool isSecure; /** Language tag of the default description for this BusObject */ qcc::String languageTag; /** Default Description */ qcc::String description; /** Provides descriptions in other languages */ Translator* translator; }; } #endif alljoyn-15.04b/alljoyn_core/inc/alljoyn/DBusStd.h000066400000000000000000000052351255700255500217320ustar00rootroot00000000000000#ifndef _ALLJOYN_DBUSSTD_H #define _ALLJOYN_DBUSSTD_H /** * @file * This file provides definitions for standard DBus interfaces * */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifdef __cplusplus #include #include #include namespace ajn { class BusAttachment; namespace org { namespace freedesktop { /** Interface Definitions for org.freedesktop.DBus */ namespace DBus { extern const char* ObjectPath; /**< Object path */ extern const char* InterfaceName; /**< Name of the interface */ extern const char* WellKnownName; /**< The well known name */ extern const char* AnnotateNoReply; /**< Annotation for reply to a method call */ extern const char* AnnotateDeprecated; /**< Annotation for marking entry as depreciated */ extern const char* AnnotateEmitsChanged; /**< Annotation for when a property is modified {true,false,invalidates} */ /** Definitions for org.freedesktop.DBus.Properties */ namespace Properties { extern const char* InterfaceName; /**< Name of the interface */ } /** Definitions for org.freedesktop.DBus.Peer */ namespace Peer { extern const char* InterfaceName; /**< Name of the interface */ } /** Definitions for org.freedesktop.DBus.Introspectable */ namespace Introspectable { extern const char* InterfaceName; /**< Name of the interface */ extern const char* IntrospectDocType; /**< Type of introspection document */ } /** Create the org.freedesktop.DBus interfaces and sub-interfaces */ QStatus AJ_CALL CreateInterfaces(BusAttachment& bus); } } } } #endif #endif alljoyn-15.04b/alljoyn_core/inc/alljoyn/DBusStdDefines.h000066400000000000000000000061401255700255500232240ustar00rootroot00000000000000#ifndef _ALLJOYN_DBUSSTD_DEFINES_H #define _ALLJOYN_DBUSSTD_DEFINES_H /** * @file * This file provides \#define constant definitions for parameters of standard DBus methods. * */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ /** * @name DBus RequestName input params * org.freedesktop.DBus.RequestName input params (see DBus spec) */ // @{ #define DBUS_NAME_FLAG_ALLOW_REPLACEMENT 0x01u /**< RequestName input flag: Allow others to take ownership of this name */ #define DBUS_NAME_FLAG_REPLACE_EXISTING 0x02u /**< RequestName input flag: Attempt to take ownership of name if already taken */ #define DBUS_NAME_FLAG_DO_NOT_QUEUE 0x04u /**< RequestName input flag: Fail if name cannot be immediately obtained */ // @} /** * @name DBus RequestName return values * org.freedesktop.DBUs.RequestName return values (see DBus spec) */ // @{ #define DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER 1u /**< RequestName reply: Name was successfully obtained */ #define DBUS_REQUEST_NAME_REPLY_IN_QUEUE 2u /**< RequestName reply: Name is already owned, request for name has been queued */ #define DBUS_REQUEST_NAME_REPLY_EXISTS 3u /**< RequestName reply: Name is already owned and DO_NOT_QUEUE was specified in request */ #define DBUS_REQUEST_NAME_REPLY_ALREADY_OWNER 4u /**< RequestName reply: Name is already owned by this endpoint */ // @} /** * @name DBus ReleaaseName return values * org.freedesktop.DBus.ReleaseName return values (see DBus spec) */ // @{ #define DBUS_RELEASE_NAME_REPLY_RELEASED 1u /**< ReleaseName reply: Name was released */ #define DBUS_RELEASE_NAME_REPLY_NON_EXISTENT 2u /**< ReleaseName reply: Name does not exist */ #define DBUS_RELEASE_NAME_REPLY_NOT_OWNER 3u /**< ReleaseName reply: Request to release name that is not owned by this endpoint */ // @} /** * @name DBus StartServiceByName return values * org.freedesktop.DBus.StartService return values (see DBus spec) */ // @{ #define DBUS_START_REPLY_SUCCESS 1u /**< StartServiceByName reply: Service is started */ #define DBUS_START_REPLY_ALREADY_RUNNING 2u /**< StartServiceByName reply: Service is already running */ // @} #endif // _ALLJOYN_DBUSSTD_DEFINES_H alljoyn-15.04b/alljoyn_core/inc/alljoyn/Init.h000066400000000000000000000057301255700255500213250ustar00rootroot00000000000000/** * @file * Functions required to startup and cleanup AllJoyn. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_INIT_H #define _ALLJOYN_INIT_H #include #include #ifdef __cplusplus extern "C" { #endif /** * This must be called prior to instantiating or using any AllJoyn * functionality. * * AllJoynShutdown must be called for each invocation of AllJoynInit. * * @return * - #ER_OK on success * - error code indicating failure otherwise */ extern AJ_API QStatus AJ_CALL AllJoynInit(void); /** * Call this to release any resources acquired in AllJoynInit(). No AllJoyn * functionality may be used after calling this. * * AllJoynShutdown must be called for each invocation of AllJoynInit. * AllJoynShutdown must not be called without a prior AllJoynInit call. * * @return * - #ER_OK on success * - error code indicating failure otherwise */ extern AJ_API QStatus AJ_CALL AllJoynShutdown(void); /** * This must be called before using any AllJoyn router functionality. * * For an application that is a routing node (either standalone or bundled), the * complete initialization sequence is: * @code * AllJoynInit(); * AllJoynRouterInit(); * @endcode * * AllJoynRouterShutdown must be called for each invocation of AllJoynRouterInit. * * @return * - #ER_OK on success * - error code indicating failure otherwise */ extern AJ_API QStatus AJ_CALL AllJoynRouterInit(void); /** * Call this to release any resources acquired in AllJoynRouterInit(). * * For an application that is a routing node (either standalone or bundled), the * complete shutdown sequence is: * @code * AllJoynRouterShutdown(); * AllJoynShutdown(); * @endcode * * AllJoynRouterShutdown must be called for each invocation of AllJoynRouterInit. * AllJoynRouterShutdown must not be called without a prior AllJoynRouterInit call. * * @return * - #ER_OK on success * - error code indicating failure otherwise */ extern AJ_API QStatus AJ_CALL AllJoynRouterShutdown(void); #ifdef __cplusplus } /* extern "C" */ #endif #endif alljoyn-15.04b/alljoyn_core/inc/alljoyn/InterfaceDescription.h000066400000000000000000000662621255700255500245350ustar00rootroot00000000000000#ifndef _ALLJOYN_INTERFACEDESCRIPTION_H #define _ALLJOYN_INTERFACEDESCRIPTION_H /** * @file * This file defines types for statically describing a message bus interface */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include /// @cond ALLJOYN_DEV /*! \def QCC_MODULE Internal usage */ #define QCC_MODULE "ALLJOYN" /// @endcond namespace ajn { /** @name Property Access type */ // @{ static const uint8_t PROP_ACCESS_READ = 1; /**< Read Access type */ static const uint8_t PROP_ACCESS_WRITE = 2; /**< Write Access type */ static const uint8_t PROP_ACCESS_RW = 3; /**< Read-Write Access type */ // @} /** @name Property Annotation flags */ // @{ static const uint8_t PROP_ANNOTATE_EMIT_CHANGED_SIGNAL = 1; /**< EmitChangedSignal annotate flag. */ static const uint8_t PROP_ANNOTATE_EMIT_CHANGED_SIGNAL_INVALIDATES = 2; /**< EmitChangedSignal annotate flag (for notifying invalidation of property instead of value. */ // @} /** @name Method/Signal Annotation flags */ // @{ static const uint8_t MEMBER_ANNOTATE_NO_REPLY = 1; /**< No reply annotate flag */ static const uint8_t MEMBER_ANNOTATE_DEPRECATED = 2; /**< Deprecated annotate flag */ // @} /** * The interface security policy can be inherit, required, or off. If security is * required on an interface, methods on that interface can only be called by an authenticated peer * and signals emitted from that interfaces can only be received by an authenticated peer. If * security is not specified for an interface the interface inherits the security of the objects * that implement it. If security is not applicable to an interface authentication is never * required even when the implemented by a secure object. For example, security does not apply to * the Introspection interface otherwise secure objects would not be introspectable. */ typedef enum { AJ_IFC_SECURITY_INHERIT = 0, /**< Inherit the security of the object that implements the interface */ AJ_IFC_SECURITY_REQUIRED = 1, /**< Security is required for an interface */ AJ_IFC_SECURITY_OFF = 2 /**< Security does not apply to this interface */ } InterfaceSecurityPolicy; /** * @class InterfaceDescription * Class for describing message bus interfaces. %InterfaceDescription objects describe the methods, * signals and properties of a BusObject or ProxyBusObject. * * Calling ProxyBusObject::AddInterface(const char*) adds the AllJoyn interface described by an * %InterfaceDescription to a ProxyBusObject instance. After an %InterfaceDescription has been * added, the methods described in the interface can be called. Similarly calling * BusObject::AddInterface adds the interface and its methods, properties, and signal to a * BusObject. After an interface has been added method handlers for the methods described in the * interface can be added by calling BusObject::AddMethodHandler or BusObject::AddMethodHandlers. * * An %InterfaceDescription can be constructed piecemeal by calling InterfaceDescription::AddMethod, * InterfaceDescription::AddMember(), and InterfaceDescription::AddProperty(). Alternatively, * calling ProxyBusObject::ParseXml will create the %InterfaceDescription instances for that proxy * object directly from an XML string. Calling ProxyBusObject::IntrospectRemoteObject or * ProxyBusObject::IntrospectRemoteObjectAsync also creates the %InterfaceDescription * instances from XML but in this case the XML is obtained by making a remote Introspect method * call on a bus object. */ class InterfaceDescription { friend class BusAttachment; friend class XmlHelper; /** map containing description tables per argument name */ class ArgumentDescriptions; public: class AnnotationsMap; /**< A map to store string annotations */ /** * Structure representing the member to be added to the Interface */ struct Member { const InterfaceDescription* iface; /**< Interface that this member belongs to */ AllJoynMessageType memberType; /**< %Member type */ qcc::String name; /**< %Member name */ qcc::String signature; /**< Method call IN arguments (NULL for signals) */ qcc::String returnSignature; /**< Signal or method call OUT arguments */ qcc::String argNames; /**< Comma separated list of argument names - can be NULL */ AnnotationsMap* annotations; /**< Map of annotations */ qcc::String accessPerms; /**< Required permissions to invoke this call */ qcc::String description; /**< Introspection description for this member */ ArgumentDescriptions* argumentDescriptions; /**< Introspection descriptions for arguments to this member */ bool isSessionlessSignal; /**< True if this is described as a sessionless signal */ /** * %Member constructor. * * @param iface The interface this member is added to. * @param type The message type. * @param name The name of this member. * @param signature The signature of this member. May be NULL. * @param returnSignature The return signature of this member. May be NULL. * @param argNames The name of the arguments. May be NULL. * @param annotation Ignored. * @param accessPerms The permissions of this member. */ Member(const InterfaceDescription* iface, AllJoynMessageType type, const char* name, const char* signature, const char* returnSignature, const char* argNames, uint8_t annotation, const char* accessPerms); /** * %Member copy constructor * @param other The %Member being copied to this one. */ Member(const Member& other); /** * %Member assignment operator * @param other The %Member being copied to this one. * * @return * a reference to the %Member that was just copied */ Member& operator=(const Member& other); /** %Member destructor */ ~Member(); /** * Get the names and values of all annotations * * @param[out] names Annotation names * @param[out] values Annotation values * @param size Number of annotations to get * @return The number of annotations returned or the total number of annotations if props is NULL. */ size_t GetAnnotations(qcc::String* names = NULL, qcc::String* values = NULL, size_t size = 0) const; /** * Get this member's annotation value * * @param name name of the annotation to look for * @param[out] value The value of the annotation, if found * @return true iff annotations[name] == value */ bool GetAnnotation(const qcc::String& name, qcc::String& value) const; /** * Equality. Two members are defined to be equal if their members are * equal except for iface which is ignored for equality. * * @param o Member to compare against this member. * * @return true iff o == this member. */ bool operator==(const Member& o) const; }; /** * Structure representing properties of the Interface */ struct Property { qcc::String name; /**< %Property name */ qcc::String signature; /**< %Property type */ uint8_t access; /**< Access is #PROP_ACCESS_READ, #PROP_ACCESS_WRITE, or #PROP_ACCESS_RW */ AnnotationsMap* annotations; /**< Map of annotations */ qcc::String description; /**< Introspection description for this property */ bool cacheable; /**< Is this property cacheable? */ /** %Property constructor. * @param name The name of the property. * @param signature The signature of the property. May be NULL. * @param access The access type, may be #PROP_ACCESS_READ, #PROP_ACCESS_WRITE, or #PROP_ACCESS_RW. */ Property(const char* name, const char* signature, uint8_t access); /** %Property constructor */ Property(const char* name, const char* signature, uint8_t access, uint8_t annotation); /** * %Property copy constructor * @param other The %Property being copied to this one. */ Property(const Property& other); /** * %Property assignment operator * @param other The %Property being copied to this one. * @return A reference to the %Property that was just copied */ Property& operator=(const Property& other); /** %Property destructor */ ~Property(); /** * Get the names and values of all annotations * * @param[out] names Annotation names * @param[out] values Annotation values * @param size Number of annotations to get * @return The number of annotations returned or the total number of annotations if props is NULL. */ size_t GetAnnotations(qcc::String* names = NULL, qcc::String* values = NULL, size_t size = 0) const; /** * Get this property's annotation value * @param name name of the annotation to look for * @param[out] value The value of the annotation, if found * @return true iff annotations[name] == value */ bool GetAnnotation(const qcc::String& name, qcc::String& value) const; /** Equality */ bool operator==(const Property& o) const; }; /** * Add a member to the interface. * * @param type Message type. * @param name Name of member. * @param inputSig Signature of input parameters or NULL for none. * @param outSig Signature of output parameters or NULL for none. * @param argNames Comma separated list of input and then output arg names used in annotation XML. * @param annotation Annotation flags. * @param accessPerms Required permissions to invoke this call * * @return * - #ER_OK if successful * - #ER_BUS_MEMBER_ALREADY_EXISTS if member already exists */ QStatus AddMember(AllJoynMessageType type, const char* name, const char* inputSig, const char* outSig, const char* argNames, uint8_t annotation = 0, const char* accessPerms = 0); /** * Lookup a member description by name * * @param name Name of the member to lookup * @return * - Pointer to member. * - NULL if does not exist. */ const Member* GetMember(const char* name) const; /** * Get all the members. * * @param members A pointer to a Member array to receive the members. Can be NULL in * which case no members are returned and the return value gives the number * of members available. * @param numMembers The size of the Member array. If this value is smaller than the total * number of members only numMembers will be returned. * * @return The number of members returned or the total number of members if members is NULL. */ size_t GetMembers(const Member** members = NULL, size_t numMembers = 0) const; /** * Check for existence of a member. Optionally check the signature also. * @remark * if the a signature is not provided this method will only check to see if * a member with the given @c name exists. If a signature is provided a * member with the given @c name and @c signature must exist for this to return true. * * @param name Name of the member to lookup * @param inSig Input parameter signature of the member to lookup * @param outSig Output parameter signature of the member to lookup (leave NULL for signals) * @return true if the member name exists. */ bool HasMember(const char* name, const char* inSig = NULL, const char* outSig = NULL); /** * Add a method call member to the interface. * * @param name Name of method call member. * @param inputSig Signature of input parameters or NULL for none. * @param outSig Signature of output parameters or NULL for none. * @param argNames Comma separated list of input and then output arg names used in annotation XML. * @param annotation Annotation flags. * @param accessPerms Access permission requirements on this call * * @return * - #ER_OK if successful * - #ER_BUS_MEMBER_ALREADY_EXISTS if member already exists */ QStatus AddMethod(const char* name, const char* inputSig, const char* outSig, const char* argNames, uint8_t annotation = 0, const char* accessPerms = 0) { return AddMember(MESSAGE_METHOD_CALL, name, inputSig, outSig, argNames, annotation, accessPerms); } /** * Add an annotation to an existing member (signal or method). * * @param member Name of member * @param name Name of annotation * @param value Value for the annotation * * @return * - #ER_OK if successful * - #ER_BUS_MEMBER_ALREADY_EXISTS if member already exists */ QStatus AddMemberAnnotation(const char* member, const qcc::String& name, const qcc::String& value); /** * Get annotation to an existing member (signal or method). * * @param member Name of member * @param name Name of annotation * @param value Output value for the annotation * * @return * - true if found * - false if property not found */ bool GetMemberAnnotation(const char* member, const qcc::String& name, qcc::String& value) const; /** * Lookup a member method description by name * * @param name Name of the method to lookup * @return * - Pointer to member. * - NULL if does not exist. */ const Member* GetMethod(const char* name) const { const Member* method = GetMember(name); return (method && method->memberType == MESSAGE_METHOD_CALL) ? method : NULL; } /** * Add a signal member to the interface. * * @param name Name of method call member. * @param sig Signature of parameters or NULL for none. * @param argNames Comma separated list of arg names used in annotation XML. * @param annotation Annotation flags. * @param accessPerms Access permission requirements on this call * * @return * - #ER_OK if successful * - #ER_BUS_MEMBER_ALREADY_EXISTS if member already exists */ QStatus AddSignal(const char* name, const char* sig, const char* argNames, uint8_t annotation = 0, const char* accessPerms = 0) { return AddMember(MESSAGE_SIGNAL, name, sig, NULL, argNames, annotation, accessPerms); } /** * Lookup a member signal description by name * * @param name Name of the signal to lookup * @return * - Pointer to member. * - NULL if does not exist. */ const Member* GetSignal(const char* name) const { const Member* method = GetMember(name); return (method && method->memberType == MESSAGE_SIGNAL) ? method : NULL; } /** * Lookup a property description by name * * @param name Name of the property to lookup * @return a structure representing the properties of the interface */ const Property* GetProperty(const char* name) const; /** * Get all the properties. * * @param props A pointer to a Property array to receive the properties. Can be NULL in * which case no properties are returned and the return value gives the number * of properties available. * @param numProps The size of the Property array. If this value is smaller than the total * number of properties only numProperties will be returned. * * * @return The number of properties returned or the total number of properties if props is NULL. */ size_t GetProperties(const Property** props = NULL, size_t numProps = 0) const; /** * Add a property to the interface. * * @param name Name of property. * @param signature Property type. * @param access #PROP_ACCESS_READ, #PROP_ACCESS_WRITE or #PROP_ACCESS_RW * @return * - #ER_OK if successful. * - #ER_BUS_PROPERTY_ALREADY_EXISTS if the property can not be added * because it already exists. */ QStatus AddProperty(const char* name, const char* signature, uint8_t access); /** * Add an annotation to an existing property * @param p_name Name of the property * @param name Name of annotation * @param value Value for the annotation * @return * - #ER_OK if successful. * - #ER_BUS_PROPERTY_ALREADY_EXISTS if the annotation can not be added to the property because it already exists. */ QStatus AddPropertyAnnotation(const qcc::String& p_name, const qcc::String& name, const qcc::String& value); /** * Get the annotation value for a property * @param p_name Name of the property * @param name Name of annotation * @param value Value for the annotation * @return true if found, false if not found */ bool GetPropertyAnnotation(const qcc::String& p_name, const qcc::String& name, qcc::String& value) const; /** * Check for existence of a property. * * @param name Name of the property to lookup * @return true if the property exists. */ bool HasProperty(const char* name) const { return GetProperty(name) != NULL; } /** * Check for existence of any properties * * @return true if interface has any properties. */ bool HasProperties() const { return GetProperties() != 0; } /** * Check for the existence of any cacheable properties. * * @return true if the interface has any cacheable properties. */ bool HasCacheableProperties() const; /** * Returns the name of the interface * * @return the interface name. */ const char* GetName() const { return name.c_str(); } /** * Add an annotation to the interface. * * @param name Name of annotation. * @param value Value of the annotation * @return * - #ER_OK if successful. * - #ER_BUS_PROPERTY_ALREADY_EXISTS if the property can not be added * because it already exists. */ QStatus AddAnnotation(const qcc::String& name, const qcc::String& value); /** * Get the value of an annotation * * @param name Name of annotation. * @param value Returned value of the annotation * @return * - true if annotation found. * - false if annotation not found */ bool GetAnnotation(const qcc::String& name, qcc::String& value) const; /** * Get the names and values of all annotations * * @param[out] names Annotation names * @param[out] values Annotation values * @param[out] size Number of annotations * @return The number of annotations returned or the total number of annotations if props is NULL. */ size_t GetAnnotations(qcc::String* names = NULL, qcc::String* values = NULL, size_t size = 0) const; /** * Returns a description of the interface in introspection XML format * @return The interface description in introspection XML format. * * @param indent Number of space chars to use in XML indentation. * @param languageTag Specifies the description language or NULL to omit descriptions * @param translator Translator instance to use for introspection descriptions * @return The XML introspection data. */ qcc::String Introspect(size_t indent = 0, const char* languageTag = NULL, Translator* translator = NULL) const; /** * Activate this interface. An interface must be activated before it can be used. Activating an * interface locks the interface so that is can no longer be modified. */ void Activate() { isActivated = true; } /** * Indicates if this interface is required to be secure. Secure interfaces require end-to-end * authentication. The arguments for methods calls made to secure interfaces and signals * emitted by secure interfaces are encrypted. * * @return true if the interface is required to be secure. */ bool IsSecure() const { return secPolicy == AJ_IFC_SECURITY_REQUIRED; } /** * Get the security policy that applies to this interface. * * @return Returns the security policy for this interface. */ InterfaceSecurityPolicy GetSecurityPolicy() const { return secPolicy; } /** * Equality operation. */ bool operator==(const InterfaceDescription& other) const; /** * Destructor */ ~InterfaceDescription(); /** * Copy constructor * * @param other The InterfaceDescription being copied to this one. */ InterfaceDescription(const InterfaceDescription& other); /** * Set the language tag for the introspection descriptions of this InterfaceDescription * * @param language The language tag */ void SetDescriptionLanguage(const char* language); /** * Get the language tag for the instrospection descriptions of this InterfaceDescription * * @return The langauge tag */ const char* GetDescriptionLanguage() const; /** * Set the introspection description for this InterfaceDescription * * Note that when SetDescriptionTranslator is used the text in this method may * actually be a "lookup key". When generating the introspection the "text" is first * passed to the Translator where the key should be used to lookup the actual * description. In such a case, the language tag should be set to "". * * @param description The introspection description */ void SetDescription(const char* description); /** * Set the introspection description for "member" of this InterfaceDescription * * @param member The name of the member * @param description The introspection description * @param isSessionlessSignal True to document this member as a sessionless signal * @return * - #ER_OK if successful. * - #ER_BUS_INTERFACE_ACTIVATED If the interface has already been activated * - #ER_BUS_INTERFACE_NO_SUCH_MEMBER If the member was not found */ QStatus SetMemberDescription(const char* member, const char* description, bool isSessionlessSignal = false); /** * Set the introspection description for the argument "arg of "member" of this InterfaceDescription * * @param member The name of the member * @param arg The name of the argument * @param description The introspection description * @return * - #ER_OK if successful. * - #ER_BUS_INTERFACE_ACTIVATED If the interface has already been activated * - #ER_BUS_INTERFACE_NO_SUCH_MEMBER If the member was not found */ QStatus SetArgDescription(const char* member, const char* arg, const char* description); /** * Set the introspection description for "property" of this InterfaceDescription * * @param name The name of the property * @param description The introspection description * @return * - #ER_OK if successful. * - #ER_BUS_INTERFACE_ACTIVATED If the interface has already been activated * - #ER_BUS_NO_SUCH_PROPERTY If the property was not found */ QStatus SetPropertyDescription(const char* name, const char* description); /** * Set the Translator that provides this InterfaceDescription's * introspection description in multiple languages. * * @param translator The Translator instance. */ void SetDescriptionTranslator(Translator* translator); /** * Get the Translator that provides this InterfaceDescription's * introspection description in multiple languages. * * @return The Translator instance. */ Translator* GetDescriptionTranslator() const; /** * Does this interface have at least one description on an element * * @return True if this InterfaceDescription has at least one description */ bool HasDescription() const; private: /** * Default constructor is private */ InterfaceDescription() { } /** * Construct an interface with no methods or properties * This constructor cannot be used by any class other than the factory class (Bus). * * @param name Fully qualified interface name. * @param secPolicy The security policy for this interface */ InterfaceDescription(const char* name, InterfaceSecurityPolicy secPolicy); /** * Assignment operator * * @param other The InterfaceDescription being copied to this one. * * @return The assigned InterfaceDescription */ InterfaceDescription& operator=(const InterfaceDescription& other); void AppendDescriptionXml(qcc::String& xml, const char* language, const char* localDescription, Translator* translator, qcc::String const& indent) const; qcc::String NextArg(const char*& signature, qcc::String& argNames, bool inOut, size_t indent, Member const& member, bool withDescriptions, const char* langTag, Translator* translator) const; const char* Translate(const char* toLanguage, const char* text, qcc::String& buffer, Translator* translator) const; struct Definitions; Definitions* defs; /**< The definitions for this interface */ qcc::String name; /**< Name of interface */ bool isActivated; /**< Set to true when interface is activated */ InterfaceSecurityPolicy secPolicy; /**< The security policy for this interface */ }; } #undef QCC_MODULE #endif alljoyn-15.04b/alljoyn_core/inc/alljoyn/KeyStoreListener.h000066400000000000000000000067401255700255500236770ustar00rootroot00000000000000/** * @file * The KeyStoreListener class handled requests to load or store the key store. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_KEYSTORE_LISTENER_H #define _ALLJOYN_KEYSTORE_LISTENER_H #ifndef __cplusplus #error Only include KeyStoreListener.h in C++ code. #endif #include #include #include namespace ajn { /** * Forward declaration. */ class KeyStore; /** * An application can provide a key store listener to override the default key store Load and Store * behavior. This will override the default key store behavior. */ class KeyStoreListener { public: /** * Virtual destructor for derivable class. */ virtual ~KeyStoreListener() { } /** * This method is called when a key store needs to be loaded. * @remark The application must call #PutKeys to put the new key store data into the * internal key store. * * @param keyStore Reference to the KeyStore to be loaded. * * @return * - #ER_OK if the load request was satisfied * - An error status otherwise * */ virtual QStatus LoadRequest(KeyStore& keyStore) = 0; /** * Put keys into the key store from an encrypted byte string. * * @param keyStore The keyStore to put to. This is the keystore indicated in the LoadRequest call. * @param source The byte string containing the encrypted key store contents. * @param password The password required to decrypt the key data * * @return * - #ER_OK if successful * - An error status otherwise * */ QStatus PutKeys(KeyStore& keyStore, const qcc::String& source, const qcc::String& password); /** * This method is called when a key store needs to be stored. * @remark The application must call #GetKeys to obtain the key data to be stored. * * @param keyStore Reference to the KeyStore to be stored. * * @return * - #ER_OK if the store request was satisfied * - An error status otherwise */ virtual QStatus StoreRequest(KeyStore& keyStore) = 0; /** * Get the current keys from the key store as an encrypted byte string. * * @param keyStore The keyStore to get from. This is the keystore indicated in the StoreRequest call. * @param sink The byte string to write the keys to. * @return * - #ER_OK if successful * - An error status otherwise */ QStatus GetKeys(KeyStore& keyStore, qcc::String& sink); }; } #endif alljoyn-15.04b/alljoyn_core/inc/alljoyn/Message.h000066400000000000000000001452631255700255500220140ustar00rootroot00000000000000#ifndef _ALLJOYN_MESSAGE_H #define _ALLJOYN_MESSAGE_H /** * @file * This file defines a class for parsing and generating message bus messages */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef __cplusplus #error Only include Message.h in C++ code. #endif #include #include #include #include #include #include namespace ajn { static const size_t ALLJOYN_MAX_NAME_LEN = 255; /*!< The maximum length of certain bus names */ static const size_t ALLJOYN_MAX_ARRAY_LEN = 131072; /*!< DBus limits array length to 2^26. AllJoyn limits it to 2^17 */ static const size_t ALLJOYN_MAX_PACKET_LEN = (ALLJOYN_MAX_ARRAY_LEN + 4096); /*!< DBus limits packet length to 2^27. AllJoyn limits it further to 2^17 + 4096 to allow for 2^17 payload */ /** @name Endianness indicators */ // @{ /** indicates the bus is little endian */ static const uint8_t ALLJOYN_LITTLE_ENDIAN = 'l'; /** indicates the bus is big endian */ static const uint8_t ALLJOYN_BIG_ENDIAN = 'B'; // @} /** @name Flag types */ // @{ /** No reply is expected*/ static const uint8_t ALLJOYN_FLAG_NO_REPLY_EXPECTED = 0x01; /** Auto start the service */ static const uint8_t ALLJOYN_FLAG_AUTO_START = 0x02; /** Allow messages from remote hosts (valid only in Hello message) */ static const uint8_t ALLJOYN_FLAG_ALLOW_REMOTE_MSG = 0x04; /** Sessionless message */ static const uint8_t ALLJOYN_FLAG_SESSIONLESS = 0x10; /** Global (bus-to-bus) broadcast */ static const uint8_t ALLJOYN_FLAG_GLOBAL_BROADCAST = 0x20; /** * Header is compressed * * @deprecated March 2015 for 15.04 release */ QCC_DEPRECATED(static const uint8_t ALLJOYN_FLAG_COMPRESSED) = 0x40; /** Body is encrypted */ static const uint8_t ALLJOYN_FLAG_ENCRYPTED = 0x80; // @} /** ALLJOYN protocol version */ static const uint8_t ALLJOYN_MAJOR_PROTOCOL_VERSION = 1; /** Message types */ typedef enum { MESSAGE_INVALID = 0, ///< an invalid message type MESSAGE_METHOD_CALL = 1, ///< a method call message type MESSAGE_METHOD_RET = 2, ///< a method return message type MESSAGE_ERROR = 3, ///< an error message type MESSAGE_SIGNAL = 4 ///< a signal message type } AllJoynMessageType; /** AllJoyn Header field types */ typedef enum { /* Wire-protocol defined header field types */ ALLJOYN_HDR_FIELD_INVALID = 0, ///< an invalid header field type ALLJOYN_HDR_FIELD_PATH, ///< an object path header field type ALLJOYN_HDR_FIELD_INTERFACE, ///< a message interface header field type ALLJOYN_HDR_FIELD_MEMBER, ///< a member (message/signal) name header field type ALLJOYN_HDR_FIELD_ERROR_NAME, ///< an error name header field type ALLJOYN_HDR_FIELD_REPLY_SERIAL, ///< a reply serial number header field type ALLJOYN_HDR_FIELD_DESTINATION, ///< message destination header field type ALLJOYN_HDR_FIELD_SENDER, ///< senders well-known name header field type ALLJOYN_HDR_FIELD_SIGNATURE, ///< message signature header field type ALLJOYN_HDR_FIELD_HANDLES, ///< number of file/socket handles that accompany the message /* AllJoyn defined header field types */ ALLJOYN_HDR_FIELD_TIMESTAMP, ///< time stamp header field type ALLJOYN_HDR_FIELD_TIME_TO_LIVE, ///< messages time-to-live header field type ALLJOYN_HDR_FIELD_COMPRESSION_TOKEN, ///< message compression token header field type @deprecated ALLJOYN_HDR_FIELD_SESSION_ID, ///< Session id field type ALLJOYN_HDR_FIELD_UNKNOWN ///< unknown header field type also used as maximum number of header field types. } AllJoynFieldType; /** Message states */ typedef enum { MESSAGE_NEW, MESSAGE_HEADERFIELDS, MESSAGE_HEADER_BODY, MESSAGE_COMPLETE }AllJoynMessageState; /** AllJoyn header fields */ class HeaderFields { public: /** * The header field values. */ MsgArg field[ALLJOYN_HDR_FIELD_UNKNOWN]; /** * Table to identify which header fields can be compressed. * * @deprecated March 2015 for 15.04 release */ static const bool Compressible[ALLJOYN_HDR_FIELD_UNKNOWN + 1]; /** * Table to map the header field to a AllJoynTypeId */ static const AllJoynTypeId FieldType[ALLJOYN_HDR_FIELD_UNKNOWN + 1]; /** * Returns a string representation of the header fields. * * @param indent Indentation level. * * @return The string representation of the header fields. */ qcc::String ToString(size_t indent = 0) const; /** Default constructor */ HeaderFields() { } /** Copy constructor */ HeaderFields(const HeaderFields& other); /** Assignment */ HeaderFields& operator=(const HeaderFields& other); }; /** * Forward definition */ class _Message; class _RemoteEndpoint; class BusAttachment; class PeerStateTable; /** * @cond ALLJOYN_DEV * @internal */ typedef qcc::ManagedObj<_RemoteEndpoint> RemoteEndpoint; /// @endcond /** * Message is a reference counted (managed) version of _Message */ typedef qcc::ManagedObj<_Message> Message; /** * This class implements the functionality underlying the #Message class. Instances * of #_Message should not be declared directly by applications. Rather applications * create instances of the class #Message which handles reference counting for the * underlying #_Message instance. The members of #_Message are always accessed * indirectly via #Message. */ class _Message { friend class BusObject; friend class ProxyBusObject; friend class EndpointAuth; friend class _RemoteEndpoint; friend class _LocalEndpoint; friend class _NullEndpoint; friend class _UDPEndpoint; friend class UDPTransport; friend class DaemonRouter; friend class AllJoynObj; friend class DeferredMsg; friend class AllJoynPeerObj; friend class Crypto; friend struct Rule; public: /** * Constructor for a message * * @param bus The bus that this message is sent or received on. */ _Message(BusAttachment& bus); /** * Determine if message is a broadcast signal. * * @return Return true if this is a broadcast signal. */ bool IsBroadcastSignal() const { return (GetType() == MESSAGE_SIGNAL) && (hdrFields.field[ALLJOYN_HDR_FIELD_DESTINATION].typeId == ALLJOYN_INVALID); } /** * Messages broadcast to all devices are global broadcast messages. * * @return Return true if this is a global broadcast message. */ bool IsGlobalBroadcast() const { return IsBroadcastSignal() && (msgHeader.flags & ALLJOYN_FLAG_GLOBAL_BROADCAST); } /** * Determin if message is sessionless. * * @return Return true if this message was sent sessionless */ bool IsSessionless() const { return (msgHeader.flags & ALLJOYN_FLAG_SESSIONLESS) != 0; } /** * Returns the flags for the message. * @return flags for the message * * @see flag types in Message.h file */ uint8_t GetFlags() const { return msgHeader.flags; } /** * Return true if message's TTL header indicates that it is expired * * @param[out] tillExpireMS Written with number of milliseconds before message expires if non-null * If message never expires value is set to the maximum uint32_t value. * * @return Returns true if the message's TTL header indicates that is has expired. */ bool IsExpired(uint32_t* tillExpireMS = NULL) const; /** * Determine if the message is marked as unreliable. Unreliable messages have a non-zero * time-to-live and may be silently discarded. * * @return Returns true if the message is unreliable, that is, has a non-zero time-to-live. */ bool IsUnreliable() const { return ttl != 0; } /** * Determine if the message was encrypted. * * @return Returns true if the message was encrypted. */ bool IsEncrypted() const { return (msgHeader.flags & ALLJOYN_FLAG_ENCRYPTED) != 0; } /** * Get the name of the authentication mechanism that was used to generate the encryption key if * the message is encrypted. * * @return the name of an authentication mechanism or an empty string. */ const qcc::String& GetAuthMechanism() const { return authMechanism; } /** * Return the type of the message * * @return The type of message which can be one of MESSAGE_INVALID, MESSAGE_METHOD_CALL, MESSAGE_METHOD_RET, * MESSAGE_ERROR, or MESSAGE_SIGNAL. */ AllJoynMessageType GetType() const { return (AllJoynMessageType)msgHeader.msgType; } /** * Return the arguments for this message. * * @param[out] args Returns the arguments * @param[out] numArgs The number of arguments */ void GetArgs(size_t& numArgs, const MsgArg*& args) { args = msgArgs; numArgs = numMsgArgs; } /** * Return a specific argument. * * @param argN The index of the argument to get. * * @return * - The argument * - NULL if unmarshal failed or there is not such argument. */ const MsgArg* GetArg(size_t argN = 0) { return (argN < numMsgArgs) ? &msgArgs[argN] : NULL; } /** * Unpack and return the arguments for this message. This method uses the functionality from * MsgArg::Get() see MsgArg.h for documentation. * * @param signature The signature to match against the message arguments. * @param ... Pointers to return references to the unpacked values. * @return ER_OK if successful. */ QStatus GetArgs(const char* signature, ...); /** * Accessor function to get serial number for the message. Usually only important for * #MESSAGE_METHOD_CALL for matching up the reply to the call. * * @return the serial number of the %Message */ uint32_t GetCallSerial() const { return msgHeader.serialNum; } /** * Get a reference to all of the header fields for this message. * * @return A const reference to the header fields for this message. */ const HeaderFields& GetHeaderFields() const { return hdrFields; } /** * Accessor function to get the signature for this message * @return * - The AllJoyn SIGNATURE string stored in the AllJoyn header field * - An empty string if unable to find the AllJoyn signature */ const char* GetSignature() const { if (hdrFields.field[ALLJOYN_HDR_FIELD_SIGNATURE].typeId == ALLJOYN_SIGNATURE && hdrFields.field[ALLJOYN_HDR_FIELD_SIGNATURE].v_signature.sig) { return hdrFields.field[ALLJOYN_HDR_FIELD_SIGNATURE].v_signature.sig; } else { return ""; } } /** * Accessor function to get the object path for this message * * @return * - The AllJoyn object path string stored in the AllJoyn header field * - An empty string if unable to find the AllJoyn object path */ const char* GetObjectPath() const { if (hdrFields.field[ALLJOYN_HDR_FIELD_PATH].typeId == ALLJOYN_OBJECT_PATH && hdrFields.field[ALLJOYN_HDR_FIELD_PATH].v_objPath.str) { return hdrFields.field[ALLJOYN_HDR_FIELD_PATH].v_objPath.str; } else { return ""; } } /** * Accessor function to get the interface for this message * * @return * - The AllJoyn interface string stored in the AllJoyn header field * - An empty string if unable to find the interface */ const char* GetInterface() const { if (hdrFields.field[ALLJOYN_HDR_FIELD_INTERFACE].typeId == ALLJOYN_STRING && hdrFields.field[ALLJOYN_HDR_FIELD_INTERFACE].v_string.str) { return hdrFields.field[ALLJOYN_HDR_FIELD_INTERFACE].v_string.str; } else { return ""; } } /** * Accessor function to get the member (method/signal) name for this message * @return * - The AllJoyn member (method/signal) name string stored in the AllJoyn header field * - An empty string if unable to find the member name */ const char* GetMemberName() const { if (hdrFields.field[ALLJOYN_HDR_FIELD_MEMBER].typeId == ALLJOYN_STRING && hdrFields.field[ALLJOYN_HDR_FIELD_MEMBER].v_string.str) { return hdrFields.field[ALLJOYN_HDR_FIELD_MEMBER].v_string.str; } else { return ""; } } /** * Accessor function to get the reply serial number for the message. Only meaningful for #MESSAGE_METHOD_RET * @return * - The serial number for the message stored in the AllJoyn header field * - Zero if unable to find the serial number. Note that 0 is an invalid serial number. */ uint32_t GetReplySerial() const { if (hdrFields.field[ALLJOYN_HDR_FIELD_REPLY_SERIAL].typeId == ALLJOYN_UINT32) { return hdrFields.field[ALLJOYN_HDR_FIELD_REPLY_SERIAL].v_uint32; } else { return 0; } } /** * Accessor function to get the sender for this message. * * @return * - The senders well-known name string stored in the AllJoyn header field. * - An empty string if the message did not specify a sender. */ const char* GetSender() const { if (hdrFields.field[ALLJOYN_HDR_FIELD_SENDER].typeId == ALLJOYN_STRING && hdrFields.field[ALLJOYN_HDR_FIELD_SENDER].v_string.str) { return hdrFields.field[ALLJOYN_HDR_FIELD_SENDER].v_string.str; } else { return ""; } } /** * Get the unique name of the endpoint that the message was received on. * * @return * - The unique name of the endpoint that the message was received on. */ const char* GetRcvEndpointName() const { return rcvEndpointName.c_str(); } /** * Accessor function to get the destination for this message * @return * - The message destination string stored in the AllJoyn header field. * - An empty string if unable to find the message destination. */ const char* GetDestination() const { if (hdrFields.field[ALLJOYN_HDR_FIELD_DESTINATION].typeId == ALLJOYN_STRING && hdrFields.field[ALLJOYN_HDR_FIELD_DESTINATION].v_string.str) { return hdrFields.field[ALLJOYN_HDR_FIELD_DESTINATION].v_string.str; } else { return ""; } } /** * Accessor function to determine if a non empty destination has been set. * * @return * - True if and only if a non empty destination has been set for this message. * */ bool HasDestination() const { return ((hdrFields.field[ALLJOYN_HDR_FIELD_DESTINATION].typeId == ALLJOYN_STRING) && (NULL != hdrFields.field[ALLJOYN_HDR_FIELD_DESTINATION].v_string.str) && (0 != hdrFields.field[ALLJOYN_HDR_FIELD_DESTINATION].v_string.len)); } /** * Accessor function to get the compression token for the message. * * @return * - 0 'zero' if there is no compression token. * * @deprecated Header compression was deprecated in March 2015 for 15.04 * release */ uint32_t GetCompressionToken() const { return 0; } /** * Accessor function to get the session id for the message. * * @return * - Session id for the message * - 0 'zero' if sender did not specify a session */ uint32_t GetSessionId() const { if (hdrFields.field[ALLJOYN_HDR_FIELD_SESSION_ID].typeId == ALLJOYN_UINT32) { return hdrFields.field[ALLJOYN_HDR_FIELD_SESSION_ID].v_uint32; } else { return 0; } } /** * If the message is an error message returns the error name and optionally the error message string * @param[out] errorMessage * - Return the error message string stored * - leave errorMessage unchanged if error message string not found * @return * - If the message is an error message return the error name from the AllJoyn header * - NULL if the message type is not MESSAGE_ERROR. */ const char* GetErrorName(qcc::String* errorMessage = NULL) const; /** * Returns a complete description of an error by concatenating the error name and the error * message together. * * @return * - If the message is an error message return the error description * - An empty string if the message type is not MESSAGE_ERROR. */ qcc::String GetErrorDescription() const; /** * Destructor for the %_Message class. */ ~_Message(); /** * In debug builds returns an XML string representation of the message. In release builds * returns an empty string. * * @return an XML string representation of the message or an empty string. */ qcc::String ToString() const; /** * In debug builds returns a string that provides a brief description of the message. In release * builds returns and empty string. * @return a brief description of the message or an empty string. */ qcc::String Description() const; /** * Returns the timestamp (in milliseconds) for this message. If the message header contained a * timestamp this is the estimated timestamp for when the message was sent by the remote device, * otherwise it is the timestamp for when the message was unmarshaled. Note that the timestamp * is always relative to local time. * * @return The timestamp for this message. */ uint32_t GetTimeStamp() { return timestamp; }; /** * Equality operator for messages. Messages are equivalent iff they are the same message. * * @param other The other message to compare. * * @return Returns true if this message is the same message as the other message. */ bool operator==(const _Message& other) { return this == &other; } /** * Set the endianess for outgoing messages. This is mainly for testing purposes. * * @param endian Either ALLJOYN_LITTLE_ENDIAN or ALLJOYN_BIG_ENDIAN. Any other value * sets the endianess to the native endianess for this platform. * * */ static void SetEndianess(const char endian) { if ((endian == ALLJOYN_LITTLE_ENDIAN) || (endian == ALLJOYN_BIG_ENDIAN)) { outEndian = endian; } else { outEndian = myEndian; } } /** * Get the Authentication Version of the message. * * @return * - If the Authentication Version has been set, the value is returned. * - Otherwise -1. */ int32_t GetAuthVersion() const { return authVersion; } /** * Copy constructor. * * @param other The other message to copy. */ _Message(const _Message& other); protected: /* * These methods and members are protected rather than private to facilitate unit testing. */ /// @cond ALLJOYN_DEV /** * Constructor for a message * * @param bus The bus that this message is sent or received on. * @param hdrFields The header fields for this message. */ _Message(BusAttachment& bus, const HeaderFields& hdrFields); /** * @internal * Generate a method reply message from a method call. * * @param call The call message - can be this message. * @param args The arguments for the reply (can be NULL) * @param numArgs The number of arguments * @return * - #ER_OK if successful * - An error status otherwise */ QStatus ReplyMsg(const Message& call, const MsgArg* args, size_t numArgs); /** * @internal * Generate a method reply message from a method call. * * @param call The call message - can be this message. * @param sender The sender of the message * @param args The arguments for the reply (can be NULL) * @param numArgs The number of arguments * @return * - #ER_OK if successful * - An error status otherwise */ QStatus ReplyMsg(const Message& call, const qcc::String& sender, const MsgArg* args, size_t numArgs); /** * @internal * Generate an error message from a method call. * * @param call The call message - can be this message. * @param errorName The name of this error * @param description Informational string describing details of the error * @return * - #ER_OK if successful * - An error status otherwise */ QStatus ErrorMsg(const Message& call, const char* errorName, const char* description); /** * @internal * Generate an error message from a method call. * * @param call The call message - can be this message. * @param sender The sender of the message * @param errorName The name of this error * @param description Informational string describing details of the error * @return * - #ER_OK if successful * - An error status otherwise */ QStatus ErrorMsg(const Message& call, const qcc::String& sender, const char* errorName, const char* description); /** * @internal * Generate an error message from a method call. * * @param call The call message - can be this message. * @param status The status code for this error * @return * - #ER_OK if successful * - An error status otherwise */ QStatus ErrorMsg(const Message& call, QStatus status); /** * @internal * Generate an error message from a method call. * * @param call The call message - can be this message. * @param sender The sender of the message * @param status The status code for this error * @return * - #ER_OK if successful * - An error status otherwise */ QStatus ErrorMsg(const Message& call, const qcc::String& sender, QStatus status); /** * @internal * Compose a new internally generated error message. * * @param errorName The name of this error * @param replySerial The serial number the method call this message is replying to. */ void ErrorMsg(const char* errorName, uint32_t replySerial); /** * @internal * Compose a new internally generated error message. * * @param sender The sender of this error message. * @param errorName The name of this error * @param replySerial The serial number the method call this message is replying to. * @return * - #ER_OK if successful * - An error status otherwise */ QStatus ErrorMsg(const qcc::String& sender, const char* errorName, uint32_t replySerial); /** * @internal * Compose a new internally generated error message from a status code * * @param status The status code for this error * @param replySerial The serial number the method call this message is replying to. */ void ErrorMsg(QStatus status, uint32_t replySerial); /** * @internal * Compose a new internally generated error message from a status code * * @param sender The sender of this error message. * @param status The status code for this error * @param replySerial The serial number the method call this message is replying to. * @return * - #ER_OK if successful * - An error status otherwise */ QStatus ErrorMsg(const qcc::String& sender, QStatus status, uint32_t replySerial); /** * @internal * Compose a method call message * * @param signature The signature (checked against the args) * @param destination The destination for this message * @param sessionId The sessionId to use for this method call or 0 for any * @param objPath The object the method call is being sent to * @param iface The interface for the method (can be NULL) * @param methodName The name of the method to call * @param args The method call argument list (can be NULL) * @param numArgs The number of arguments * @param flags A logical OR of the AllJoyn flags * @return * - #ER_OK if successful * - An error status otherwise */ QStatus CallMsg(const qcc::String& signature, const qcc::String& destination, SessionId sessionId, const qcc::String& objPath, const qcc::String& iface, const qcc::String& methodName, const MsgArg* args, size_t numArgs, uint8_t flags); /** * @internal * Compose a method call message * * @param signature The signature (checked against the args) * @param sender sender of the message * @param destination The destination for this message * @param sessionId The sessionId to use for this method call or 0 for any * @param objPath The object the method call is being sent to * @param iface The interface for the method (can be NULL) * @param methodName The name of the method to call * @param args The method call argument list (can be NULL) * @param numArgs The number of arguments * @param flags A logical OR of the AllJoyn flags * * @return * - #ER_OK if successful * - An error status otherwise */ QStatus CallMsg(const qcc::String& signature, const qcc::String& sender, const qcc::String& destination, SessionId sessionId, const qcc::String& objPath, const qcc::String& iface, const qcc::String& methodName, const MsgArg* args, size_t numArgs, uint8_t flags); /** * @internal * Compose a signal message * * @param signature The signature (checked against the args) * @param destination The destination for this message * @param sessionId The sessionId to use for this signal msg or 0 for any * @param objPath The object sending the signal * @param iface The interface for the method (can be NULL) * @param signalName The name of the signal being sent * @param args The signal argument list (can be NULL) * @param numArgs The number of arguments * @param flags A logical OR of the AllJoyn flags. * @param timeToLive Time-to-live. Units are seconds for sessionless signals. Milliseconds for non-sessionless signals. * Signals that cannot be sent within this time limit are discarded. Zero indicates reliable delivery. * @return * - #ER_OK if successful * - An error status otherwise */ QStatus SignalMsg(const qcc::String& signature, const char* destination, SessionId sessionId, const qcc::String& objPath, const qcc::String& iface, const qcc::String& signalName, const MsgArg* args, size_t numArgs, uint8_t flags, uint16_t timeToLive); /** * @internal * Compose a signal message * * @param signature The signature (checked against the args) * @param sender sender of the message * @param destination The destination for this message * @param sessionId The sessionId to use for this signal msg or 0 for any * @param objPath The object sending the signal * @param iface The interface for the method (can be NULL) * @param signalName The name of the signal being sent * @param args The signal argument list (can be NULL) * @param numArgs The number of arguments * @param flags A logical OR of the AllJoyn flags. * @param timeToLive Time-to-live. Units are seconds for sessionless signals. Milliseconds for non-sessionless signals. * Signals that cannot be sent within this time limit are discarded. Zero indicates reliable delivery. * * @return * - #ER_OK if successful * - An error status otherwise */ QStatus SignalMsg(const qcc::String& signature, const qcc::String& sender, const char* destination, SessionId sessionId, const qcc::String& objPath, const qcc::String& iface, const qcc::String& signalName, const MsgArg* args, size_t numArgs, uint8_t flags, uint16_t timeToLive); /** * @internal * Unmarshal the message arguments. * * @param expectedSignature The expected signature for this message. * @param expectedReplySignature The expected reply signature for this message if it is a * method call message or NULL otherwise. * * @return * - #ER_OK if the message was unmarshaled * - Error status indicating why the unmarshal failed. */ QStatus UnmarshalArgs(const qcc::String& expectedSignature, const char* expectedReplySignature = NULL); /** * @internal * Unmarshal the message arguments. * * @param peerStateTable The peer state table used when unmarshalling encrypted arguments. * @param expectedSignature The expected signature for this message. * @param expectedReplySignature The expected reply signature for this message if it is a * method call message or NULL otherwise. * * @return * - #ER_OK if the message was unmarshaled * - Error status indicating why the unmarshal failed. */ QStatus UnmarshalArgs(PeerStateTable* peerStateTable, const qcc::String& expectedSignature, const char* expectedReplySignature = NULL); /** * @internal * Reads a message from a remote endpoint. * * @param endpoint The endpoint to marshal the message data from. * @param checkSender True if message's sender field should be validated against the endpoint's unique name. * @param pedantic Perform detailed checks on the header fields. * @param timeout If non-zero, a timeout in milliseconds to wait for a message to unmarshal. * @return * - #ER_OK if successful * - An error status otherwise */ QStatus Read(RemoteEndpoint& endpoint, bool checkSender, bool pedantic = true, uint32_t timeout = 0); /** * @internal * Reads a message from a remote endpoint. If data is not available it returns immediately * * @param endpoint The endpoint to marshal the message data from. * @param checkSender True if message's sender field should be validated against the endpoint's unique name. * @param pedantic Perform detailed checks on the header fields. * @return * - #ER_OK if successful i.e. message is complete * - #ER_END_OF_DATA if message is incomplete * - An error status otherwise */ QStatus ReadNonBlocking(RemoteEndpoint& endpoint, bool checkSender, bool pedantic = true); /** * @internal * Unmarshals a message from a remote endpoint. Only the message header is unmarshaled at this * time. * * @param endpoint The endpoint to marshal the message data from. * @param checkSender True if message's sender field should be validated against the endpoint's unique name. * @param pedantic Perform detailed checks on the header fields. * @param timeout If non-zero, a timeout in milliseconds to wait for a message to unmarshal. * @return * - #ER_OK if successful * - An error status otherwise */ QStatus Unmarshal(RemoteEndpoint& endpoint, bool checkSender, bool pedantic = true, uint32_t timeout = 0); /** * @internal * Unmarshals a message. Only the message header is unmarshaled at this * time. * * @param endpointName The uinique name of the endpoint that this message came from. * @param handlePassing True if handle passing is allowed. * @param checkSender True if message's sender field should be validated against the endpoint's unique name. * @param pedantic Perform detailed checks on the header fields. * @param timeout If non-zero, a timeout in milliseconds to wait for a message to unmarshal. * @return * - #ER_OK if successful * - An error status otherwise */ QStatus Unmarshal(qcc::String& endpointName, bool handlePassing, bool checkSender, bool pedantic = true, uint32_t timeout = 0); /** * @internal * Deliver a marshaled message to a remote endpoint. * * @param endpoint Endpoint to receive marshaled message. * @return * - #ER_OK if successful * - An error status otherwise */ QStatus Deliver(RemoteEndpoint& endpoint); /** * @internal * Deliver a marshaled message to a remote endpoint. Non-blocking * * @param endpoint Endpoint to receive marshaled message. * @return * - #ER_OK if successful * - An error status otherwise */ QStatus DeliverNonBlocking(RemoteEndpoint& endpoint); /** * @internal * Marshal the message again with the new sender name if one was provided. * * @param senderName Option sender name to replace the current sender name in the message. * @return * - #ER_OK if successful * - An error status otherwise */ QStatus ReMarshal(const char* senderName = NULL); /** * @internal * Sets the serial number to the next available value for the bus attachment for this message. */ void SetSerialNumber(); /// @endcond private: /** * Common initialization called by constructor. Calling constructors from other constructors is * not supported in some compilers. */ void Init(BusAttachment& bus); /** * Message assignment is disallowed. */ _Message operator=(const _Message& other); /** * Compose the special hello method call required to establish a connection * * @param isBusToBus true iff connection attempt is between two AllJoyn instances (bus joining). * @param allowRemote true iff connection allows messages from remote devices. * @param nametype specify what names are transfered * * @return * - #ER_OK if hello method call was sent successfully. * - An error status otherwise */ QStatus HelloMessage(bool isBusToBus, bool allowRemote, int nametype); /** * Compose the special hello method call required to establish a connection * * @param isBusToBus true iff connection attempt is between two AllJoyn instances (bus joining). * @param sender sender of the message * @param allowRemote true iff connection allows messages from remote devices. * @param guid GUID of sender of message * @param nametype specify what names are transfered * * @return * - #ER_OK if hello method call was sent successfully. * - An error status otherwise */ QStatus HelloMessage(bool isBusToBus, const qcc::String& sender, bool allowRemote, const qcc::String& guid, int nameType); /** * Compose the reply to the hello method call * * @param isBusToBus true iff connection attempt is between two AllJoyn instances (bus joining). * @param uniqueName The new unique name for the sender. * @return * - #ER_OK if reply to the hello method call was successful * - An error status otherwise */ QStatus HelloReply(bool isBusToBus, const qcc::String& uniqueName, int nametype); /** * Compose the reply to the hello method call * * @param isBusToBus true iff connection attempt is between two AllJoyn instances (bus joining). * @param sender sender of the message * @param uniqueName The new unique name for the sender. * @param guid GUID of sender of message * @return * - #ER_OK if reply to the hello method call was successful * - An error status otherwise */ QStatus HelloReply(bool isBusToBus, const qcc::String& sender, const qcc::String& uniqueName, const qcc::String& guid, int nameType); /** * Get a pointer to the current backing buffer for the message. * * @return pointer to the message backing buffer */ uint8_t const* const GetBuffer() const { return const_cast(reinterpret_cast(msgBuf)); } /** * Get the number of bytes of data currently in the message backing buffer. * * @return pointer to the message backing buffer */ size_t GetBufferSize() const { return bufEOD - reinterpret_cast(msgBuf); } /** * Struct representing the header for the AllJoyn Message */ typedef struct MessageHeader { char endian; ///< The endianness of this message uint8_t msgType; ///< Indicates if the message is method call, signal, etc. uint8_t flags; ///< Flag bits uint8_t majorVersion; ///< Major version of this message uint32_t bodyLen; ///< Length of the body data uint32_t serialNum; ///< serial of this message uint32_t headerLen; ///< Length of the header fields MessageHeader() : endian(0), msgType(MESSAGE_INVALID), flags(0), majorVersion(0), bodyLen(0), serialNum(0), headerLen(0) { } } MessageHeader; #if (QCC_TARGET_ENDIAN == QCC_LITTLE_ENDIAN) static const char myEndian = ALLJOYN_LITTLE_ENDIAN; ///< Native endianness of host system we are running on: little endian. #else static const char myEndian = ALLJOYN_BIG_ENDIAN; ///< Native endianness of host system we are running on: big endian. #endif static char outEndian; ///< Endianess for outgoing messages BusAttachment* bus; ///< The bus this message was received or will be sent on. bool endianSwap; ///< true if endianness will be swapped. MessageHeader msgHeader; ///< Current message header. uint8_t* _msgBuf; ///< Pointer to the current msg buffer. uint64_t* msgBuf; ///< Pointer to the current msg buffer (8 byte aligned pointer into _msgBuf). MsgArg* msgArgs; ///< Pointer to the unmarshaled arguments. uint8_t numMsgArgs; ///< Number of message args (signature cannot be longer than 255 chars). size_t bufSize; ///< The current allocated size of the msg buffer. uint8_t* bufEOD; ///< End of data currently in buffer. uint8_t* bufPos; ///< Pointer to the position in buffer. uint8_t* bodyPtr; ///< Pointer to start of message body. uint16_t ttl; ///< Time to live (units of seconds for sessionless. MS for everything else) uint32_t timestamp; ///< Timestamp (local time) for messages with a ttl (time to live). qcc::String replySignature; ///< Expected reply signature for a method call qcc::String authMechanism; ///< For secure messages indicates the authentication mechanism that was used qcc::String rcvEndpointName; ///< Name of Endpoint that received this message. qcc::SocketFd* handles; ///< Array of file/socket descriptors. size_t numHandles; ///< Number of handles in the handles array bool encrypt; ///< True if the message is to be encrypted int32_t authVersion; ///< signed int representing the authVersion of this message. -1 indicates not yet set. AllJoynMessageState readState; ///< The current state of the message during read. size_t pktSize; ///< Packet size for this message. size_t countRead; ///< Number of bytes remaining to read for completion of the message. size_t maxFds; ///< Store the number of max FDs for the endpoint, so it doesnt need to be calculated each time. AllJoynMessageState writeState; ///< The current state of the message during write. uint8_t* writePtr; ///< Pointer to the current write position in the buffer. size_t countWrite; ///< Number of bytes remaining to write for completion of the message. /** * The header fields for this message. Which header fields are present depends on the message * type defined in the message header. */ HeaderFields hdrFields; /** * @defgroup internal_methods_message_unmarshal Internal methods unmarshal side * * Methods used to unmarshal and AllJoyn header * * @see Unmarshal * @see UnmarshalArgs * * @{ */ /** * Clear the header fields * * This also frees any data allocated to the header fields. */ void ClearHeader(); /** * Parse the MsgArg value from the AllJoyn Message * * @param[out] arg MsgArg that will hold the value from the AllJoyn Message * @param[in] sigPtr the signature of the MsgArg * @param[in] arrayElem true if the value being parsed is an array element * * @see Unmarshal * @see UnmarshalArgs * * @return * - #ER_OK if successful * - #ER_BUS_BAD_LENGTH if the length of a sting object is too long * - #ER_BUS_NOT_NUL_TERMINATED if a string object is not nul terminated * - #ER_BUS_BAD_SIGNATURE signature does not match value type * - An error status otherwise */ QStatus ParseValue(MsgArg* arg, const char*& sigPtr, bool arrayElem = false); /** * Parse a Struct from the AllJoyn Message * * @param[out] arg MsgArg that will hold the value from the AllJoyn Message * @param[in] sigPtr the signature of the MsgArg * * @see Unmarshal * @see UnmarshalArgs * * @return * - #ER_OK if successful * - #ER_BUS_BAD_SIGNATURE signature does not match value type * - An error status otherwise */ QStatus ParseStruct(MsgArg* arg, const char*& sigPtr); /** * Parse a single dictionary entry from the AllJoyn Message * * @param[out] arg MsgArg that will hold the value from the AllJoyn Message * @param[in] sigPtr the signature of the MsgArg * * @see Unmarshal * @see UnmarshalArgs * * @return * - #ER_OK if successful * - #ER_BUS_BAD_SIGNATURE signature does not match value type * - An error status otherwise */ QStatus ParseDictEntry(MsgArg* arg, const char*& sigPtr); /** * Parse an array from the AllJoyn Message * * @param[out] arg MsgArg that will hold the value from the AllJoyn Message * @param[in] sigPtr the signature of the MsgArg * * @see Unmarshal * @see UnmarshalArgs * * @return * - #ER_OK if successful * - #ER_BUS_BAD_SIGNATURE signature does not match value type * - An error status otherwise */ QStatus ParseArray(MsgArg* arg, const char*& sigPtr); /** * Parse the MsgArg signature from the AllJoyn Message * * @param[out] arg assign the message arg signature to this MsgArg * * @return * - #ER_OK if successful * - An error status otherwise */ QStatus ParseSignature(MsgArg* arg); /** * Parse a variant MsgArg from an AllJoyn Message * * @param[out] arg assign the variant to this MsgArg * * @see Unmarshal * @see UnmarshalArgs * * @return * - #ER_OK if successful * - An error status otherwise */ QStatus ParseVariant(MsgArg* arg); /** * Check that the header fields are valid. This check is automatically performed when a header * is successfully unmarshaled. * * @param pedantic Perform more detailed checks on the header fields. * * @return * - #ER_OK if the header fields are valid * - An error status otherwise */ QStatus HeaderChecks(bool pedantic); /// @} // end internal_methods_message_unmarshal defgroup /** * @defgroup internal_methods_message_marshal Internal methods marshal side * * Methods used when marshaling the AllJoyn Message * * @see Deliver * @see DeliverNonBlocking * @{ */ /** * If the Message should be encrypted this will encrypt the message * * If authentication has not been done this will request authentications * * @return * - #ER_OK if the header fields are valid * - #ER_BUS_NOT_AUTHORIZED not authorized to send encrypted messages * - #ER_BUS_AUTHENTICATION_PENDING authentication is in progress must * retry once authentication is complete * - An error status otherwise * */ QStatus EncryptMessage(); /** * Marshal (serialize) the Message so it is in the wire format * * @param signature message signature * @param sender sender of the message * @param destination destination of the message * @param msgType what type of message this is * @param args pointer to an array of MsgArgs contained in the message * @param numArgs number of MsgArg * @param flags A logical OR of the AllJoyn flags * @param sessionId The session id that the Message will be sent to * * @return * - #ER_OK if successful * - An error status otherwise */ QStatus MarshalMessage(const qcc::String& signature, const qcc::String& sender, const qcc::String& destination, AllJoynMessageType msgType, const MsgArg* args, uint8_t numArgs, uint8_t flags, SessionId sessionId); /** * Marshal the MsgArg arguments into the message * * This will Marshal an array of MsgArgs into the Message adding any padding * and formating needed for the Message wire format. * * @param[in] arg pointer to an array of MsgArgs to be marshaled * @param[in] numArgs the number of MsgArgs in arg * * @return * - #ER_OK if successful * - An error status otherwise */ QStatus MarshalArgs(const MsgArg* arg, size_t numArgs); /** * Marshal the header fields * * @note We relocate the string pointers in the fields to point to the * marshaled versions to so the lifetime of the message is not bound * to the lifetime of values passed in. */ void MarshalHeaderFields(); /** * Calculate space required for the header fields * * @return the space required for the header fields */ size_t ComputeHeaderLen(); /// @} // end internal_methods_message_marshal defgroup /** * Get string representation of the message * * In debug builds return a string representation of the message * An empty string is returned otherwise. * * @see ToString() * * @param[in] args the MsgArgs contained in the message * @param[in] numArgs the number of MsgArgs contained in the message * * @return string representation of the message */ qcc::String ToString(const MsgArg* args, size_t numArgs) const; /* @defgroup internal_methods_message_read "Internal methods for read" * @{ */ /** * Read a header and check it is a valid header * check for things like endianness, header length, and body length * * If the endianness is incorrect this will perform an endian swap. * * @return * - #ER_OK if successful * - #ER_BUS_BAD_HEADER_FIELD if the Message header has invalid endian flag * - #ER_BUS_BAD_HEADER_LEN if the Message header length is invalid * - #ER_BUS_BAD_BODY_LEN if the Message body length is invalid */ inline QStatus InterpretHeader(); /** * Read a Message from a RemoteEndpoint * * @param endpoint The endpoint the message will be read from * @param checkSender True if message's sender field should be validated * against the endpoint's unique name. * @param pedantic Perform detailed checks on the header fields. * @param timeout If non-zero, a timeout in milliseconds to wait for * the bytes to be pulled. * * @see Read * @see ReadNonBlocking * * @return * - #ER_OK if successful * - An error status otherwise */ QStatus PullBytes(RemoteEndpoint& endpoint, bool checkSender, bool pedantic = true, uint32_t timeout = 0); /** * Load a Message from a Buffer * * @param buf The buffer to read the message from * @param buflen The length of the message data in the buffer. * * @return * - #ER_OK if successful * - An error status otherwise */ QStatus LoadBytes(uint8_t* buf, size_t buflen); /// @} // end internal_methods_message_read /* * This is the authentication version that we will fall back to, * if we are unable to determine the auth version of the destination * of the message (in the case of broadcast and multicast.) */ static const uint32_t AUTH_FALLBACK_VERSION; }; } #endif alljoyn-15.04b/alljoyn_core/inc/alljoyn/MessageReceiver.h000066400000000000000000000055041255700255500234720ustar00rootroot00000000000000#ifndef _ALLJOYN_MESSAGERECEIVER_H #define _ALLJOYN_MESSAGERECEIVER_H #include #include /** * @file * MessageReceiver is a base class implemented by any class * which wishes to receive AllJoyn messages */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ namespace ajn { /** * %MessageReceiver is a pure-virtual base class that is implemented by any * class that wishes to receive AllJoyn messages from the AllJoyn library. * * Received messages can be either signals, method_replies or errors. */ class MessageReceiver { public: /** Destructor */ virtual ~MessageReceiver() { } /** * MethodHandlers are %MessageReceiver methods which are called by AllJoyn library * to forward AllJoyn method_calls to AllJoyn library users. * * @param member Method interface member entry. * @param message The received method call message. */ typedef void (MessageReceiver::* MethodHandler)(const InterfaceDescription::Member* member, Message& message); /** * ReplyHandlers are %MessageReceiver methods which are called by AllJoyn library * to forward AllJoyn method_reply and error responses to AllJoyn library users. * * @param message The received message. * @param context User-defined context passed to MethodCall and returned upon reply. */ typedef void (MessageReceiver::* ReplyHandler)(Message& message, void* context); /** * SignalHandlers are %MessageReceiver methods which are called by AllJoyn library * to forward AllJoyn received signals to AllJoyn library users. * * @param member Method or signal interface member entry. * @param srcPath Object path of signal emitter. * @param message The received message. */ typedef void (MessageReceiver::* SignalHandler)(const InterfaceDescription::Member* member, const char* srcPath, Message& message); }; } #endif alljoyn-15.04b/alljoyn_core/inc/alljoyn/MessageSink.h000066400000000000000000000033341255700255500226310ustar00rootroot00000000000000/** * @file * Abstract interface implemented by objects that wish to consume Message Bus * messages. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_MESSAGESINK_H #define _ALLJOYN_MESSAGESINK_H #ifndef __cplusplus #error Only include MessageSink.h in C++ code. #endif #include #include #include namespace ajn { /** * Abstract interface implemented by objects that wish to consume Message Bus * messages. */ class MessageSink { public: /** * Virtual destructor for derivable class. */ virtual ~MessageSink() { } /** * Consume a message bus message. * * @param msg Message to be consumed. * @return #ER_OK if successful. */ virtual QStatus PushMessage(Message& msg) = 0; }; } #endif alljoyn-15.04b/alljoyn_core/inc/alljoyn/MsgArg.h000066400000000000000000000750131255700255500216030ustar00rootroot00000000000000#ifndef _ALLJOYN_MSGARG_H #define _ALLJOYN_MSGARG_H /** * @file * This file defines a class for message bus data types and values */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef __cplusplus #error Only include MsgArg.h in C++ code. #endif #include #include #include #include namespace ajn { /** * Forward definitions */ class MsgArg; /** * Enumeration of the various message arg types. * @remark Most of these map directly to the values used in the * DBus wire protocol but some are specific to the AllJoyn implementation. */ typedef enum { ALLJOYN_INVALID = 0, ///< AllJoyn INVALID typeId ALLJOYN_ARRAY = 'a', ///< AllJoyn array container type ALLJOYN_BOOLEAN = 'b', ///< AllJoyn boolean basic type, @c 0 is @c FALSE and @c 1 is @c TRUE - Everything else is invalid ALLJOYN_DOUBLE = 'd', ///< AllJoyn IEEE 754 double basic type ALLJOYN_DICT_ENTRY = 'e', ///< AllJoyn dictionary or map container type - an array of key-value pairs ALLJOYN_SIGNATURE = 'g', ///< AllJoyn signature basic type ALLJOYN_HANDLE = 'h', ///< AllJoyn socket handle basic type ALLJOYN_INT32 = 'i', ///< AllJoyn 32-bit signed integer basic type ALLJOYN_INT16 = 'n', ///< AllJoyn 16-bit signed integer basic type ALLJOYN_OBJECT_PATH = 'o', ///< AllJoyn Name of an AllJoyn object instance basic type ALLJOYN_UINT16 = 'q', ///< AllJoyn 16-bit unsigned integer basic type ALLJOYN_STRUCT = 'r', ///< AllJoyn struct container type ALLJOYN_STRING = 's', ///< AllJoyn UTF-8 NULL terminated string basic type ALLJOYN_UINT64 = 't', ///< AllJoyn 64-bit unsigned integer basic type ALLJOYN_UINT32 = 'u', ///< AllJoyn 32-bit unsigned integer basic type ALLJOYN_VARIANT = 'v', ///< AllJoyn variant container type ALLJOYN_INT64 = 'x', ///< AllJoyn 64-bit signed integer basic type ALLJOYN_BYTE = 'y', ///< AllJoyn 8-bit unsigned integer basic type ALLJOYN_STRUCT_OPEN = '(', /**< Never actually used as a typeId: specified as ALLJOYN_STRUCT */ ALLJOYN_STRUCT_CLOSE = ')', /**< Never actually used as a typeId: specified as ALLJOYN_STRUCT */ ALLJOYN_DICT_ENTRY_OPEN = '{', /**< Never actually used as a typeId: specified as ALLJOYN_DICT_ENTRY */ ALLJOYN_DICT_ENTRY_CLOSE = '}', /**< Never actually used as a typeId: specified as ALLJOYN_DICT_ENTRY */ ALLJOYN_BOOLEAN_ARRAY = ('b' << 8) | 'a', ///< AllJoyn array of booleans ALLJOYN_DOUBLE_ARRAY = ('d' << 8) | 'a', ///< AllJoyn array of IEEE 754 doubles ALLJOYN_INT32_ARRAY = ('i' << 8) | 'a', ///< AllJoyn array of 32-bit signed integers ALLJOYN_INT16_ARRAY = ('n' << 8) | 'a', ///< AllJoyn array of 16-bit signed integers ALLJOYN_UINT16_ARRAY = ('q' << 8) | 'a', ///< AllJoyn array of 16-bit unsigned integers ALLJOYN_UINT64_ARRAY = ('t' << 8) | 'a', ///< AllJoyn array of 64-bit unsigned integers ALLJOYN_UINT32_ARRAY = ('u' << 8) | 'a', ///< AllJoyn array of 32-bit unsigned integers ALLJOYN_INT64_ARRAY = ('x' << 8) | 'a', ///< AllJoyn array of 64-bit signed integers ALLJOYN_BYTE_ARRAY = ('y' << 8) | 'a', ///< AllJoyn array of 8-bit unsigned integers ALLJOYN_WILDCARD = '*' ///< This never appears in a signature but is used for matching arbitrary message args } AllJoynTypeId; /** * Type for initializing an invalid MsgArg */ typedef struct { void* unused[3]; /**< Fields for zero-initializing an invalid MsgArg */ } AllJoynInvalid; /** * Type for the various string types */ typedef struct { uint32_t len; /**< Length of AllJoynString */ const char* str; /**< The actual string */ } AllJoynString; /** * Type for a signature * The same as AllJoynString except the length is a single byte (thus signatures have a maximum length of 255). * The content must be a valid signature. */ typedef struct { uint8_t len; /**< Length of AllJoyn signature */ const char* sig; /**< The signature */ } AllJoynSignature; /** * Type for an array */ class AllJoynArray { friend class MsgArg; friend class SignatureUtils; friend class _Message; public: /** * Set the array value. Note that arrays must be initialized using this function otherwise they * cannot be marshaled. * * @param elemSig The signature for the array element type. * @param numElements The size of the array. * @param elements Pointer to an array of MsgArgs for the elements. Must be NULL if numElements * is zero. This array must be dynamically allocated because it will be * deleted when the MsgArg destructor is called. * * @return ER_OK if the array was successfully initialized. */ QStatus SetElements(const char* elemSig, size_t numElements, MsgArg* elements); /** * Accessor function to return the number of array elements * * @return The number of array elements */ size_t GetNumElements() const { return numElements; } /** * Accessor function to return the number of array elements * * @return The array elements */ const MsgArg* GetElements() const { return elements; } /** * Accessor function to return the array element signature. * * @return The array element signature or an empty string. */ const char* GetElemSig() const { return elemSig ? elemSig : ""; } private: char* elemSig; /**< Element signature */ size_t numElements; /**< Number of elements in the AllJoyn array */ MsgArg* elements; /**< Pointer to array */ }; /** * Type for a variant */ typedef struct { MsgArg* val; /**< Pointer to value of type MsgArg*/ } AllJoynVariant; /** * Type for a struct */ typedef struct { size_t numMembers; /**< Number of members in structure */ MsgArg* members; /**< Pointer to members of the structure */ } AllJoynStruct; /** * Type for a handle. A handle is an abstraction of a platform-specific socket or file descriptor. * * @note Handles associated with in a message received by the application will be closed when the * message destructor is called or when a method call is converted into a method reply. If the * application code needs to continue using the handle the handle must be duplicated by calling * qcc:SocketDup() or the appropriate platform-specific APIs. Handles that are passed in when * creating a message to be sent are duplicated internally and can be closed by the caller after the * message has been created. Handles that have been duplicated using qcc::SocketDup() must be closed * by calling qcc::Close(). Handles duplicated by calling a native platform "dup" API must be closed * using the native "close" API. */ typedef struct { qcc::SocketFd fd; /**< A platform-specific socket file descriptor */ } AllJoynHandle; /** * Type for a dictionary entry */ typedef struct { MsgArg* key; /**< Key in the dictionary entry */ MsgArg* val; /**< Value in the dictionary entry */ } AllJoynDictEntry; /** * Type for arrays of scalars */ typedef struct { size_t numElements; /**< Number of elements in the AllJoynScalar Array */ union { const uint8_t* v_byte; const int16_t* v_int16; const uint16_t* v_uint16; const bool* v_bool; const uint32_t* v_uint32; const int32_t* v_int32; const int64_t* v_int64; const uint64_t* v_uint64; const double* v_double; }; } AllJoynScalarArray; /** * Class definition for a message arg. * This class deals with the message bus types and the operations on them * * MsgArgs are designed to be light-weight. A MsgArg will normally hold references to the data * (strings etc.) it wraps and will only copy that data if the MsgArg is assigned. For example no * additional memory is allocated for an #ALLJOYN_STRING that references an existing const char*. * If a MsgArg is assigned the destination receives a copy of the contents of the source. The * Stabilize() methods can also be called to explicitly force contents of the MsgArg to be copied. */ class MsgArg { friend class _Message; friend class MsgArgUtils; public: /** * The flag value that indicates that the MsgArg owns the data it references so is responsible * for freeing that data in the destructor. This applies to any MsgArg that has a pointer to a * string or other data. * @return value that indicates the MsgArg owns the data. */ static const uint8_t OwnsData = 1; /** * The flag value that indicates that the MsgArg owns the nested MsgArgs it references so is responsible * for freeing those MsgArgs in the destructor. This applies to MsgArgs of type #ALLJOYN_ARRAY, * #ALLJOYN_STRUCT, #ALLJOYN_DICT_ENTRY, and #ALLJOYN_VARIANT. * @return value that indicates the MsgArg owns the nested MsgArgs it references. */ static const uint8_t OwnsArgs = 2; /** * The type of this arg */ AllJoynTypeId typeId; /** * Union of the various argument values */ union { uint8_t v_byte; int16_t v_int16; uint16_t v_uint16; bool v_bool; uint32_t v_uint32; int32_t v_int32; int64_t v_int64; uint64_t v_uint64; double v_double; AllJoynString v_string; AllJoynString v_objPath; AllJoynSignature v_signature; AllJoynHandle v_handle; AllJoynArray v_array; AllJoynStruct v_struct; AllJoynDictEntry v_dictEntry; AllJoynVariant v_variant; AllJoynScalarArray v_scalarArray; AllJoynInvalid v_invalid; }; /** * Returns a string for the signature of this value * * @return The signature string for this MsgArg */ qcc::String Signature() const { return Signature(this, 1); } /** * Returns a string representation of the signature of an array of message args. * * @param values A pointer to an array of message arg values * @param numValues Length of the array * * @return The signature string for the message args. */ static qcc::String AJ_CALL Signature(const MsgArg* values, size_t numValues); /** * Returns an XML string representation of this type * * @param indent Number of spaces to indent the generated xml * * @return The XML string */ qcc::String ToString(size_t indent = 0) const; /** * Returns an XML string representation for an array of message args. * * @param args The message arg array. * @param numArgs The size of the message arg array. * @param indent Number of spaces to indent the generated xml * * @return The XML string representation of the message args. */ static qcc::String AJ_CALL ToString(const MsgArg* args, size_t numArgs, size_t indent = 0); /** * Checks the signature of this arg. * * @param signature The signature to check * * @return true if this arg has the specified signature, otherwise returns false. */ bool HasSignature(const char* signature) const; /** * Assignment operator * * @param other The source MsgArg for the assignment * * @return The assigned MsgArg */ MsgArg& operator=(const MsgArg& other) { if (this != &other) { Clone(*this, other); } return *this; } /** * Copy constructor * * @param other The source MsgArg for the copy */ MsgArg(const MsgArg& other) : typeId(ALLJOYN_INVALID) { Clone(*this, other); } /** * Destructor */ virtual ~MsgArg() { Clear(); } /** * Constructor * * @param typeId The type for the MsgArg */ MsgArg(AllJoynTypeId typeId) : typeId(typeId), flags(0) { v_invalid.unused[0] = v_invalid.unused[1] = v_invalid.unused[2] = NULL; } /** * Constructor to build a message arg. If the constructor fails for any reason the type will be * set to #ALLJOYN_INVALID. See the description of the #Set() method for information about the * signature and parameters. For initializing complex values it is recommended to use the * default constructor and the #Set() method so the success of setting the value can be * explicitly checked. * * @param signature The signature for MsgArg value. * @param ... One or more values to initialize the MsgArg. */ MsgArg(const char* signature, ...); /** * Set value of a message arg from a signature and a list of values. Note that any values or * MsgArg pointers passed in must remain valid until this MsgArg is freed. * * - @c 'a' The array length followed by: * - If the element type is a basic type a pointer to an array of values of that type. * - If the element type is string a pointer to array of const char*, * - If the element type is an @ref ALLJOYN_ARRAY "ARRAY", @ref ALLJOYN_STRUCT "STRUCT", * @ref ALLJOYN_DICT_ENTRY "DICT_ENTRY" or @ref ALLJOYN_VARIANT "VARIANT" a pointer to an * array of MsgArgs where each MsgArg has the signature specified by the element type. * - If the element type is specified using the wildcard character '*', a pointer to * an array of MsgArgs. The array element type is determined from the type of the * first MsgArg in the array, all the elements must have the same type. * - If the element type is specified using a '$' character, a pointer to an array of * qcc::String. This is a convenience case for initializing a string array, actual * signature "as" from a qcc::String array. * - @c 'b' A bool value * - @c 'd' A double (64 bits) * - @c 'g' A pointer to a NUL terminated string (pointer must remain valid for lifetime of the MsgArg) * - @c 'h' A qcc::SocketFd * - @c 'i' An int (32 bits) * - @c 'n' An int (16 bits) * - @c 'o' A pointer to a NUL terminated string (pointer must remain valid for lifetime of the MsgArg) * - @c 'q' A uint (16 bits) * - @c 's' A pointer to a NUL terminated string (pointer must remain valid for lifetime of the MsgArg) * - @c 't' A uint (64 bits) * - @c 'u' A uint (32 bits) * - @c 'v' Not allowed, the actual type must be provided. * - @c 'x' An int (64 bits) * - @c 'y' A byte (8 bits) * * - @c '(' and @c ')' The list of values that appear between the parentheses using the notation above * - @c '{' and @c '}' A pair values using the notation above. * * - @c '*' A pointer to a MsgArg. * * Examples: * * An array of strings * * @code * char* fruits[3] = { "apple", "banana", "orange" }; * MsgArg bowl; * bowl.Set("as", 3, fruits); * @endcode * * A struct with a uint and two string elements. * * @code arg.Set("(uss)", 1024, "hello", "world"); @endcode * * An array of 3 dictionary entries where each entry has an integer key and string value. * * @code * MsgArg dict[3]; * dict[0].Set("{is}", 1, "red"); * dict[1].Set("{is}", 2, "green"); * dict[2].Set("{is}", 3, "blue"); * arg.Set("a{is}", 3, dict); * @endcode * * An array of uint_16's * * @code * uint16_t aq[] = { 1, 2, 3, 5, 6, 7 }; * arg.Set("aq", sizeof(aq) / sizeof(uint16_t), aq); * @endcode * * @param signature The signature for MsgArg value * @param ... One or more values to initialize the MsgArg. * * @return * - #ER_OK if the MsgArg was successfully set * - An error status otherwise */ QStatus Set(const char* signature, ...); /** * Set an array of MsgArgs by applying the Set() method to each MsgArg in turn. * * @param args An array of MsgArgs to set. * @param numArgs [in,out] On input the size of the args array. On output the number of MsgArgs * that were set. There must be at least enough MsgArgs to completely * initialize the signature. * * @param signature The signature for MsgArg values * @param ... One or more values to initialize the MsgArg list. * * @return * - #ER_OK if the MsgArgs were successfully set. * - #ER_BUS_TRUNCATED if the signature was longer than expected. * - Other error status codes indicating a failure. */ static QStatus AJ_CALL Set(MsgArg* args, size_t& numArgs, const char* signature, ...); /** * Matches a signature to the MsArg and if the signature matches unpacks the component values of a MsgArg. Note that the values * returned are references into the MsgArg itself so unless copied will become invalid if the MsgArg is freed or goes out of scope. * This function resolved through variants, so if the MsgArg is a variant that references a 32 bit integer is can be unpacked * directly into a 32 bit integer pointer. * * - @c 'a' A pointer to a length of type size_t that returns the number of elements in the array followed by: * - If the element type is a scalar type a pointer to a pointer of the correct type for the values. * - Otherwise a pointer to a pointer to a MsgArg. * * - @c 'b' A pointer to a bool * - @c 'd' A pointer to a double (64 bits) * - @c 'g' A pointer to a char* (character string is valid for the lifetime of the MsgArg) * - @c 'h' A pointer to a qcc::SocketFd * - @c 'i' A pointer to an int32_t * - @c 'n' A pointer to an int16_t * - @c 'o' A pointer to a char* (character string is valid for the lifetime of the MsgArg) * - @c 'q' A pointer to a uint16_t * - @c 's' A pointer to a char* (character string is valid for the lifetime of the MsgArg) * - @c 't' A pointer to a uint64_t * - @c 'u' A pointer to a uint32_t * - @c 'v' A pointer to a pointer to a MsgArg, matches to a variant but returns a pointer to * the MsgArg of the underlying real type. * - @c 'x' A pointer to an int64_t * - @c 'y' A pointer to a uint8_t * * - @c '(' and @c ')' A list of pointers as required for each of the struct members. * - @c '{' and @c '}' Pointers as required for the key and value members. * * - @c '*' A pointer to a pointer to a MsgArg. This matches any value type. * * Examples: * * A struct with and uint32 and two string elements. * * @code * struct { * uint32_t i; * char *hello; * char *world; * } myStruct; * arg.Get("(uss)", &myStruct.i, &myStruct.hello, &myStruct.world); * @endcode * * A variant where it is known that the value is a uint32, a string, or double. Note that the * variant is resolved away. * * @code * uint32_t i; * double d; * char *str; * QStatus status = arg.Get("i", &i); * if (status == ER_BUS_SIGNATURE_MISMATCH) { * status = arg.Get("s", &str); * if (status == ER_BUS_SIGNATURE_MISMATCH) { * status = arg.Get("d", &d); * } * } * @endcode * * An array of dictionary entries where each entry has an integer key and variant. Find the * entries where the variant value is a string or a struct of 2 strings. * * @code * MsgArg *entries; * size_t num; * arg.Get("a{iv}", &num, &entries); * for (size_t i = 0; i > num; ++i) { * char *str1; * char *str2; * uint32_t key; * status = entries[i].Get("{is}", &key, &str1); * if (status == ER_BUS_SIGNATURE_MISMATCH) { * status = entries[i].Get("{i(ss)}", &key, &str1, &str2); * } * } * @endcode * * An array of uint_16's * * @code * uint16_t *vals; * size_t numVals; * arg.Get("aq", &numVals, &vals); * @endcode * * @param signature The signature for MsgArg value * @param ... Pointers to return the unpacked values. * * @return * - #ER_OK if the signature matched and MsgArg was successfully unpacked. * - #ER_BUS_SIGNATURE_MISMATCH if the signature did not match. * - An error status otherwise */ QStatus Get(const char* signature, ...) const; /** * Unpack an array of MsgArgs by applying the Get() method to each MsgArg in turn. * * @param args An array of MsgArgs to unpack. * @param numArgs The size of the MsgArgs array. * @param signature The signature to match against the MsgArg values * @param ... Pointers to return references to the unpacked values. * * @return * - #ER_OK if the MsgArgs were successfully set. * - #ER_BUS_SIGNATURE_MISMATCH if the signature did not match. * - Other error status codes indicating a failure. */ static QStatus AJ_CALL Get(const MsgArg* args, size_t numArgs, const char* signature, ...); /** * Helper function for accessing dictionary elements. The MsgArg must be an array of dictionary * elements. The second parameter is the key value, this is expressed according to the rules for * MsgArg::Set so is either a scalar, a pointer to a string, or for 64 bit values a pointer to * the value. This value is matched against the dictionary array to locate the matching element. * The third and subsequent parameters are unpacked according to the rules of MsgArg::Get. * * For example, where the key is a string and the values are structs: * * @code * uint8_t age; * uint32_t height; * const char* address; * QStatus status = arg.GetElement("{s(yus)}", "fred", &age, &height, &address); * @endcode * * This function is particularly useful for extracting specific properties from the array of property * values returned by ProxyBusObject::GetAllProperties. * * @param elemSig The expected signature for the dictionary element, e.g. "{su}" * @param ... Pointers to return unpacked key values. * * @return * - #ER_OK if the dictionary signature matched and MsgArg was successfully unpacked. * - #ER_BUS_NOT_A_DICTIONARY if this method is called on a MsgArg that is not a dictionary. * - #ER_BUS_SIGNATURE_MISMATCH if the signature did not match. * - #ER_BUS_ELEMENT_NOT_FOUND if the key was not found in the dictionary. * - An error status otherwise */ QStatus GetElement(const char* elemSig, ...) const; /** * Equality operator. * * @param other The other MsgArg to compare. * * @return Returns true if the two message args have the same signatures and values. */ bool operator==(const MsgArg& other); /** * Inequality operator. * * @param other The other MsgArg to compare. * * @return Returns true if the two message args do not have the same signatures and values. */ bool operator!=(const MsgArg& other) { return !(*this == other); } /** * Clear the MsgArg setting the type to ALLJOYN_INVALID and freeing any memory allocated for the * MsgArg value. */ void Clear(); /** * Makes a MsgArg stable by completely copying the contents into locally * managed memory. After a MsgArg has been stabilized any values used to * initialize or set the message arg can be freed. */ void Stabilize(); /** * This method sets the ownership flags on this MsgArg, and optionally all * MsgArgs subordinate to this MsgArg. By setting the ownership flags the * caller can transfer responsibility for freeing nested data referenced * by this MsgArg to the MsgArg's destructor. The #OwnsArgs flag is * particularly useful for managing complex data structures such as arrays * of structs, nested structs, and variants where the inner MsgArgs are * dynamically allocated. The #OwnsData flag is useful for freeing * dynamically allocated strings, byte arrays, etc,. * * @param flags A logical or of the applicable ownership flags (OwnsArgs and OwnsData). * @param deep If true recursively sets the ownership flags on all MsgArgs owned by this MsgArg. */ void SetOwnershipFlags(uint8_t flags, bool deep = false) { this->flags |= (flags & (OwnsData | OwnsArgs)); if (deep) { SetOwnershipDeep(); } } /** * Default constructor - arg instances start out invalid */ MsgArg() : typeId(ALLJOYN_INVALID), flags(0) { v_invalid.unused[0] = v_invalid.unused[1] = v_invalid.unused[2] = NULL; } protected: /** * Build up a MsgArg from a variable set of parameters. * * @param signature The signature for MsgArg values * @param sigLen Length of the specified signature * @param arg MsgArg to initialize * @param maxArgs Maximum number of arguments to parse in parameter list, argp * @param argp List of parameters constructed from var args * @param count Out parameter that contains the number of actual parsed var args * * @return * - #ER_OK if the MsgArg was successfully created. * - #ER_BUS_SIGNATURE_MISMATCH if the signature did not match. * - Other error status codes indicating a failure. */ static QStatus VBuildArgs(const char*& signature, size_t sigLen, MsgArg* arg, size_t maxArgs, va_list* argp, size_t* count = NULL); /** * Parse a MsgArg into a variable set of receiving parameters. * * @param signature The signature for MsgArg values * @param sigLen Length of the specified signature * @param argList MsgArg to parse * @param numArgs Maximum number of arguments to parse in parameter list, argp * @param argp List of parameters to receive values constructed from var args * * @return * - #ER_OK if the MsgArg was successfully parsed. * - #ER_BUS_SIGNATURE_MISMATCH if the signature did not match. * - Other error status codes indicating a failure. */ static QStatus VParseArgs(const char*& signature, size_t sigLen, const MsgArg* argList, size_t numArgs, va_list* argp); private: /** * flags indicating owner ship * * @see OwnsData * @see OwnsArg */ uint8_t flags; /** * Recursively sets the ownership flags on the entire MsgArg tree. * @see SetOwnershipFlags */ void SetOwnershipDeep(); /** * Clone one MsgArg into Another MsgArg * * On 32bit Windows the export convention for Scons and Visual Studio builds is __stdcall * while for Visual Studio alone is __cdecl. This requires the explicit __stdcall (via * the AJ_CALL macro) applied to the public C++ API methods. This method is not public, * but it is invoked from two public methods which are inline (the copy constructor * and the assignment operator of this class) thus it also needs the decoration. * * @see operator= * @see MsgArg(const MsgArg&) * * @param dest the MsgArg that will hold the clone * @param src the MsgArg that will be cloned * */ static void AJ_CALL Clone(MsgArg& dest, const MsgArg& src); /** * Used to help build an alljoyn array * * AllJoyn arrays are any MsgArgs with the letter `a` in the signature * * Note that `arry` is not a typo - Some editors tag `array` as a reserved word. * * @param arry the MsgArg that will hold the array * @param elemSig The signature for MsgArg array element * @param argp List of parameters to receive values constructed from var args * * @see Set * @see VBuildArgs * * * @return * - #ER_OK if the MsgArg was successfully created. * - #ER_BUS_BAD_SIGNATURE invalid value in the array signature * - #ER_BUS_BAD_VALUE array element does not have an expected value * - Other error status codes indicating a failure. */ static QStatus BuildArray(MsgArg* arry, const qcc::String& elemSig, va_list* argp); /** * Used to help parse an alljoyn array * * AllJoyn arrays are any MsgArgs with the letter `a` in the signature * * Note that `arry` is not a typo - Some editors tag `array` as a reserved word. * * @see Get * @see VParseArgs * * @param arry the MsgArg that will hold the array * @param elemSig The signature for MsgArg array element * @param elemSigLen Length of the array element signature * @param argp List of parameters to receive values constructed from var args * * @return * - #ER_OK if the MsgArg was successfully created. * - #ER_BUS_BAD_SIGNATURE invalid value in the array signature * - #ER_BUS_BAD_VALUE array element does not have an expected value * - #ER_INVALID_ADDRESS the argp value is invalid * - Other error status codes indicating a failure */ static QStatus ParseArray(const MsgArg* arry, const char* elemSig, size_t elemSigLen, va_list* argp); }; } #endif alljoyn-15.04b/alljoyn_core/inc/alljoyn/Observer.h000066400000000000000000000234721255700255500222140ustar00rootroot00000000000000#ifndef _ALLJOYN_OBSERVER_H #define _ALLJOYN_OBSERVER_H /** * @file * This file defines the class Observer. * An Observer takes care of discovery, session management and ProxyBusObject * creation for bus objects that implement a specific set of interfaces. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include namespace ajn { /** * ObjectId is a simple encapsulation of a bus object's unique name and object path. * * It represents the unique identity of any object on the AllJoyn bus. */ struct ObjectId { /** * Unique bus name (never a well-known name!) of the peer hosting this object. */ qcc::String uniqueBusName; /** * Path of the object. */ qcc::String objectPath; /** * Default constructor. * * Creates an invalid object id. */ ObjectId(); /** * Constructor. * * @param busname Unique(!) bus name of the peer hosting the object. * @param path Object path */ ObjectId(const qcc::String& busname, const qcc::String& path); /** * Constructor. * * @param ppbo ProxyBusObject* for which to construct an object id */ ObjectId(const ProxyBusObject* ppbo); /** * Constructor. * * @param pbo ProxyBusObject for which to construct an object id */ ObjectId(const ProxyBusObject& pbo); /** * Copy Constructor. * * @param other the ObjectId to copy */ ObjectId(const ObjectId& other); /** * The assign operator for ObjectId * * @param other the ObjectId to assign to this ObjectId * * @return a reference to this ObjectId. */ ObjectId& operator=(const ObjectId& other); /** * Equals operator for the ObjectId * * @param other the ObjectId to check for equality * * @return true it the two objects are equal */ bool operator==(const ObjectId& other) const; /** * less than operator for the ObjectId * * @param other the ObjectId to check it this object is less than * * @returns true if this object is less than other */ bool operator<(const ObjectId& other) const; /** * Check validity of the object path */ bool IsValid() const; }; /** * An Observer takes care of discovery, session management and ProxyBusObject * creation for bus objects that implement a specific set of interfaces. * * The Observer monitors About announcements, and automatically sets up sessions * with all peers that offer objects of interest (i.e. objects that implement at * least the set of mandatory interfaces for this Observer). The Observer creates * a proxy bus object for each discovered object. The Observer::Listener class * is used to inform the application about the discovery of new objects, and about * the disappearance of objects from the bus. * * Objects are considered lost in the following cases: * - they are un-announced via About * - the hosting peer has closed the session * - the hosting peer stopped responding to Ping requests */ class Observer { public: /** * Constructor. * * @param bus Bus attachment to which the Observer is attached. * @param mandatoryInterfaces Set of interface names that a bus object * MUST implement to be discoverable by this Observer. * @param numMandatoryInterfaces number of elements in the mandatoryInterfaces array. * * Some things to take into account: * - the Observer will only discover objects that are announced through About. * - the interface names in mandatoryInterfaces must correspond with * InterfaceDescriptions that have been registered with the bus * attachment before creation of the Observer. * - mandatoryInterfaces must not be empty or NULL */ Observer(BusAttachment& bus, const char* mandatoryInterfaces[], size_t numMandatoryInterfaces); /** * Destructor. */ ~Observer(); /** * Abstract base class implemented by the application and called by the * Observer to inform the application about Observer-related events. */ class Listener { public: virtual ~Listener() { } /** * A new object has been discovered. * * @param object a proxy bus object supporting announced in the About signal */ virtual void ObjectDiscovered(ProxyBusObject& object) { QCC_UNUSED(object); }; /** * A previously discovered object has been lost. * * @param object the proxy bus object representing the object that * has been lost. * * Note that it is no longer possible to perform method calls (RPCs) on * this proxy object. If the object reappears, a new proxy object will * be created. */ virtual void ObjectLost(ProxyBusObject& object) { QCC_UNUSED(object); }; }; /** * Register a listener. * * @param listener the listener to register * @param triggerOnExisting trigger ObjectDiscovered callbacks for * already-discovered objects */ void RegisterListener(Listener& listener, bool triggerOnExisting = true); /** * Unregister a listener. * * @param listener the listener to unregister */ void UnregisterListener(Listener& listener); /** * Unregister all listeners. * * There is no real need to unregister all listeners before the Observer * is destroyed, but it is considered good style to do so. */ void UnregisterAllListeners(); /* * All methods below that return ProxyBusObjects will return an * invalid object if appropriate (if there is no object with this ObjectId * or when the iteration is finished). This can be checked with the * ProxyBusObject::IsValid() method */ /** * Get a proxy object. * * @param oid The object id of the object you want to retrieve. * * @return the proxy object with the requested ObjectId * * This call will always return a ProxyBusObject, even if the Observer * has not discovered the object you're looking for. In that case, an invalid * ProxyBusObject will be returned. You can check this condition with * the ProxyBusObject::IsValid() method. */ ProxyBusObject Get(const ObjectId& oid); /** * Get a proxy object. * * @param uniqueBusName The unique bus name of the peer hosting the object * you want to retrieve. * @param objectPath The path of the object you want to retrieve. * * @return The discovered proxy object. * * This call will always return a ProxyBusObject, even if the Observer * has not discovered the object you're looking for. In that case, an invalid * ProxyBusObject will be returned. You can check this condition with * the ProxyBusObject::IsValid() method. */ ProxyBusObject Get(const qcc::String& uniqueBusName, const qcc::String& objectPath) { return Get(ObjectId(uniqueBusName, objectPath)); } /** * Get the first proxy object. * * The GetFirst/GetNext pair of methods is useful for iterating over all discovered * objects. The iteration is over when the proxy object returned by either call is * not valid (see ProxyBusObject::IsValid). * * @return the first proxy object found in the observer */ ProxyBusObject GetFirst(); /** * Get the next proxy object. * * The GetFirst/GetNext pair of methods is useful for iterating over all discovered * objects. The iteration is over when the proxy object returned by either call is * not valid (see ProxyBusObject::IsValid). * * @param oid This method will return the proxy object immediately following the one * with this object id. * @return the proxy object immediately following the one identified by the oid object id */ ProxyBusObject GetNext(const ObjectId& oid); /** * Get the next proxy object. * * The GetFirst/GetNext pair of methods is useful for iterating over all discovered * objects. The iteration is over when the proxy object returned by either call is * not valid (see ProxyBusObject::IsValid). * * @param mpbo This method will return the proxy object immediately following this one * * @return the proxy object immediately following the mpbo proxy object */ ProxyBusObject GetNext(const ProxyBusObject& mpbo) { return GetNext(ObjectId(mpbo)); } class Internal; private: Internal* internal; /* no copy constructors or assignment */ Observer(const Observer& other); Observer& operator=(const Observer& other); }; } #endif alljoyn-15.04b/alljoyn_core/inc/alljoyn/PasswordManager.h000066400000000000000000000062451255700255500235210ustar00rootroot00000000000000#ifndef _ALLJOYN_PASSWORDMANAGER_H #define _ALLJOYN_PASSWORDMANAGER_H /** * @file * This file defines the PasswordManager class that provides the interface to * set credentials used for the authentication of thin clients. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef __cplusplus #error Only include PasswordManager.h in C++ code. #endif #include #include #include namespace ajn { /** * Class to allow the user or application to set credentials used for the authentication * of thin clients. * Before invoking Connect() to BusAttachment, the application should call SetCredentials * if it expects to be able to communicate to/from thin clients. * The bundled router will start advertising the name as soon as it is started and MUST have * the credentials set to be able to authenticate any thin clients that may try to use the * bundled router to communicate with the app. */ class PasswordManager { public: /** * @brief Set credentials used for the authentication of thin clients. * * @param authMechanism Mechanism to use for authentication. * @param password Password to use for authentication. * * @return Returns ER_OK if the credentials was successfully set. */ static QStatus AJ_CALL SetCredentials(qcc::String authMechanism, qcc::String password) { *PasswordManager::authMechanism = authMechanism; *PasswordManager::password = password; return ER_OK; } /// @cond ALLJOYN_DEV /** * @internal * Get the password set by the user/app * * @return Returns the password set by the user/app. */ static qcc::String AJ_CALL GetPassword() { return *password; } /** * @internal * Get the authMechanism set by the user/app * * @return Returns the authMechanism set by the user/app. */ static qcc::String AJ_CALL GetAuthMechanism() { return *authMechanism; } /// @endcond private: static void Init(); static void Shutdown(); friend class StaticGlobals; static qcc::String* authMechanism; /**< The auth mechanism selected by the user/app */ static qcc::String* password; /**< The password selected by the user/app */ }; } #endif alljoyn-15.04b/alljoyn_core/inc/alljoyn/PingListener.h000066400000000000000000000041231255700255500230200ustar00rootroot00000000000000/** * @file * * PingListener */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_PINGLISTENER_H_ #define _ALLJOYN_PINGLISTENER_H_ #ifndef __cplusplus #error Only include PingListener.h in C++ code. #endif #include #include namespace ajn { /** * PingListener base class */ class PingListener { public: /** * Destructor */ virtual ~PingListener() { } /** * Destination Lost: called when the destination becomes unreachable. * Called once. * * @param group Pinging group name * @param destination Destination that was pinged */ virtual void DestinationLost(const qcc::String& group, const qcc::String& destination) { QCC_UNUSED(group); QCC_UNUSED(destination); } /** * Destination Found: called when the destination becomes reachable. * Called once. * * @param group Pinging group name * @param destination Destination that was pinged */ virtual void DestinationFound(const qcc::String& group, const qcc::String& destination) { QCC_UNUSED(group); QCC_UNUSED(destination); } }; } #endif /* PINGLISTENER_H_ */ alljoyn-15.04b/alljoyn_core/inc/alljoyn/ProxyBusObject.h000066400000000000000000001356651255700255500233570ustar00rootroot00000000000000#ifndef _ALLJOYN_REMOTEBUSOBJECT_H #define _ALLJOYN_REMOTEBUSOBJECT_H /** * @file * This file defines the class ProxyBusObject. * The ProxyBusObject represents a single object registered registered on the bus. * ProxyBusObjects are used to make method calls on these remotely located DBus objects. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #include #include #include namespace qcc { /** @internal Forward references */ class Mutex; class Condition; class Thread; } namespace ajn { /** @internal Forward references */ class BusAttachment; /** * Each %ProxyBusObject instance represents a single DBus/AllJoyn object registered * somewhere on the bus. ProxyBusObjects are used to make method calls on these * remotely located DBus objects. */ class ProxyBusObject : public MessageReceiver { friend class XmlHelper; friend class AllJoynObj; friend class MatchRuleTracker; public: /** * The default timeout for method calls (25 seconds) */ static const uint32_t DefaultCallTimeout = 25000; /** * Base class used as a container for callback typedefs * * @internal Do not use this pattern for creating new public Async versions of the APIs. See * the PropertiesChangedListener class below for an example of how to add new async APIs. */ class Listener { public: /** * Callback registered with IntrospectRemoteObjectAsync() * * @param status ER_OK if successful or an error status indicating the reason for the failure. * @param obj Remote bus object that was introspected * @param context Context passed in IntrospectRemoteObjectAsync() */ typedef void (ProxyBusObject::Listener::* IntrospectCB)(QStatus status, ProxyBusObject* obj, void* context); /** * Callback registered with GetPropertyAsync() * * @param status - ER_OK if the property get request was successfull or: * - #ER_BUS_OBJECT_NO_SUCH_INTERFACE if the specified interfaces does not exist on the remote object. * - #ER_BUS_NO_SUCH_PROPERTY if the property does not exist * - Other error status codes indicating the reason the get request failed. * @param obj Remote bus object that was introspected * @param value If status is ER_OK a MsgArg containing the returned property value * @param context Caller provided context passed in to GetPropertyAsync() */ typedef void (ProxyBusObject::Listener::* GetPropertyCB)(QStatus status, ProxyBusObject* obj, const MsgArg& value, void* context); /** * Callback registered with GetAllPropertiesAsync() * * @param status - ER_OK if the get all properties request was successfull or: * - #ER_BUS_OBJECT_NO_SUCH_INTERFACE if the specified interfaces does not exist on the remote object. * - Other error status codes indicating the reason the get request failed. * @param obj Remote bus object that was introspected * @param[out] values If status is ER_OK an array of dictionary entries, signature "a{sv}" listing the properties. * @param context Caller provided context passed in to GetPropertyAsync() */ typedef void (ProxyBusObject::Listener::* GetAllPropertiesCB)(QStatus status, ProxyBusObject* obj, const MsgArg& values, void* context); /** * Callback registered with SetPropertyAsync() * * @param status - ER_OK if the property was successfully set or: * - #ER_BUS_OBJECT_NO_SUCH_INTERFACE if the specified interfaces does not exist on the remote object. * - #ER_BUS_NO_SUCH_PROPERTY if the property does not exist * - Other error status codes indicating the reason the set request failed. * @param obj Remote bus object that was introspected * @param context Caller provided context passed in to SetPropertyAsync() */ typedef void (ProxyBusObject::Listener::* SetPropertyCB)(QStatus status, ProxyBusObject* obj, void* context); }; /** * Pure virtual base class for the Properties Changed listener. */ class PropertiesChangedListener { public: virtual ~PropertiesChangedListener() { } /** * Callback to receive property changed events. * * @param obj Remote bus object that owns the property that changed. * @param ifaceName Name of the interface that defines the property. * @param changed Property values that changed as an array of dictionary entries, signature "a{sv}". * @param invalidated Properties whose values have been invalidated, signature "as". * @param context Caller provided context passed in to RegisterPropertiesChangedListener */ virtual void PropertiesChanged(ProxyBusObject& obj, const char* ifaceName, const MsgArg& changed, const MsgArg& invalidated, void* context) = 0; }; /** * Create a default (unusable) %ProxyBusObject. * * This constructor exist only to support assignment. */ ProxyBusObject(); /** * Create an empty proxy object that refers to an object at given remote service name. Note * that the created proxy object does not contain information about the interfaces that the * actual remote object implements with the exception that org.freedesktop.DBus.Peer * interface is special-cased (per the DBus spec) and can always be called on any object. Nor * does it contain information about the child objects that the actual remote object might * contain. The security mode can be specified if known or can be derived from the XML * description. * * To fill in this object with the interfaces and child object names that the actual remote * object describes in its introspection data, call IntrospectRemoteObject() or * IntrospectRemoteObjectAsync(). * * If the remote service name is set to a unique name, then both * GetServiceName() and GetUniqueName() will return the unique name. * * @param bus The bus. * @param service The remote service name (well-known or unique). * @param path The absolute (non-relative) object path for the remote object. * @param sessionId The session id the be used for communicating with remote object. * @param secure The security mode for the remote object. */ ProxyBusObject(BusAttachment& bus, const char* service, const char* path, SessionId sessionId, bool secure = false); /** * Create an empty proxy object that refers to an object at given remote service name. Note * that the created proxy object does not contain information about the interfaces that the * actual remote object implements with the exception that org.freedesktop.DBus.Peer * interface is special-cased (per the DBus spec) and can always be called on any object. Nor * does it contain information about the child objects that the actual remote object might * contain. The security mode can be specified if known or can be derived from the XML * description. * * To fill in this object with the interfaces and child object names that the actual remote * object describes in its introspection data, call IntrospectRemoteObject() or * IntrospectRemoteObjectAsync(). * * This version is primarily used during introspection where the * unique name is known. If, when creating the ProxyBusObject, * both an alias is known and the unique name is known, then use * this constructor. Note, that the only the service name is used * when generating messages. * * @param bus The bus. * @param service The remote service name (well-known or unique). * @param uniqueName The remote service's unique name. * @param path The absolute (non-relative) object path for the remote object. * @param sessionId The session id the be used for communicating with remote object. * @param secure The security mode for the remote object. */ ProxyBusObject(BusAttachment& bus, const char* service, const char* uniqueName, const char* path, SessionId sessionId, bool secure = false); /** * %ProxyBusObject destructor. */ virtual ~ProxyBusObject(); /** * Return the absolute object path for the remote object. * * @return Object path */ const qcc::String& GetPath(void) const; /** * Return the remote service name for this object. * * @return Service name (typically a well-known service name but may be a unique name) */ const qcc::String& GetServiceName(void) const; /** * Return the remote unique name for this object. * * @return Service name (typically a well-known service name but may be a unique name) */ const qcc::String& GetUniqueName(void) const; /** * Return the session Id for this object. * * @return Session Id */ SessionId GetSessionId(void) const; /** * Query the remote object on the bus to determine the interfaces and * children that exist. Use this information to populate this proxy's * interfaces and children. * * @param timeout Timeout specified in milliseconds to wait for a reply * * @return * - #ER_OK if successful * - An error status otherwise */ QStatus IntrospectRemoteObject(uint32_t timeout = DefaultCallTimeout); /** * Query the remote object on the bus to determine the interfaces and * children that exist. Use this information to populate this object's * interfaces and children. * * This call executes asynchronously. When the introspection response * is received from the actual remote object, this ProxyBusObject will * be updated and the callback will be called. * * This call exists primarily to allow introspection of remote objects * to be done inside AllJoyn method/signal/reply handlers and ObjectRegistered * callbacks. * * @param listener Pointer to the object that will receive the callback. * @param callback Method on listener that will be called. * @param context User defined context which will be passed as-is to callback. * @param timeout Timeout specified in milliseconds to wait for a reply * @return * - #ER_OK if successful. * - An error status otherwise */ QStatus IntrospectRemoteObjectAsync(ProxyBusObject::Listener* listener, ProxyBusObject::Listener::IntrospectCB callback, void* context, uint32_t timeout = DefaultCallTimeout); /** * Get a property from an interface on the remote object. * * @param iface Name of interface to retrieve property from. * @param property The name of the property to get. * @param[out] value Property value. * @param timeout Timeout specified in milliseconds to wait for a reply * * @return * - #ER_OK if the property was obtained. * - #ER_BUS_OBJECT_NO_SUCH_INTERFACE if the no such interface on this remote object. * - #ER_BUS_NO_SUCH_PROPERTY if the property does not exist */ QStatus GetProperty(const char* iface, const char* property, MsgArg& value, uint32_t timeout = DefaultCallTimeout) const; /** * Make an asynchronous request to get a property from an interface on the remote object. * The property value is passed to the callback function. * * @param iface Name of interface to retrieve property from. * @param property The name of the property to get. * @param listener Pointer to the object that will receive the callback. * @param callback Method on listener that will be called. * @param context User defined context which will be passed as-is to callback. * @param timeout Timeout specified in milliseconds to wait for a reply * @return * - #ER_OK if the request to get the property was successfully issued . * - #ER_BUS_OBJECT_NO_SUCH_INTERFACE if the no such interface on this remote object. * - An error status otherwise */ QStatus GetPropertyAsync(const char* iface, const char* property, ProxyBusObject::Listener* listener, ProxyBusObject::Listener::GetPropertyCB callback, void* context, uint32_t timeout = DefaultCallTimeout); /** * Get all properties from an interface on the remote object. * * @param iface Name of interface to retrieve all properties from. * @param[out] values Property values returned as an array of dictionary entries, signature "a{sv}". * @param timeout Timeout specified in milliseconds to wait for a reply * * @return * - #ER_OK if the property was obtained. * - #ER_BUS_OBJECT_NO_SUCH_INTERFACE if the no such interface on this remote object. * - #ER_BUS_NO_SUCH_PROPERTY if the property does not exist */ QStatus GetAllProperties(const char* iface, MsgArg& values, uint32_t timeout = DefaultCallTimeout) const; /** * Make an asynchronous request to get all properties from an interface on the remote object. * * @param iface Name of interface to retrieve property from. * @param listener Pointer to the object that will receive the callback. * @param callback Method on listener that will be called. * @param context User defined context which will be passed as-is to callback. * @param timeout Timeout specified in milliseconds to wait for a reply * @return * - #ER_OK if the request to get all properties was successfully issued . * - #ER_BUS_OBJECT_NO_SUCH_INTERFACE if the no such interface on this remote object. * - An error status otherwise */ QStatus GetAllPropertiesAsync(const char* iface, ProxyBusObject::Listener* listener, ProxyBusObject::Listener::GetPropertyCB callback, void* context, uint32_t timeout = DefaultCallTimeout); /** * Set a property on an interface on the remote object. * * @param iface Remote object's interface on which the property is defined. * @param property The name of the property to set * @param value The value to set * @param timeout Timeout specified in milliseconds to wait for a reply * * @return * - #ER_OK if the property was set * - #ER_BUS_OBJECT_NO_SUCH_INTERFACE if the specified interfaces does not exist on the remote object. * - #ER_BUS_NO_SUCH_PROPERTY if the property does not exist */ QStatus SetProperty(const char* iface, const char* property, MsgArg& value, uint32_t timeout = DefaultCallTimeout) const; /** * Make an asynchronous request to set a property on an interface on the remote object. * A callback function reports the success or failure of ther operation. * * @param iface Remote object's interface on which the property is defined. * @param property The name of the property to set. * @param value The value to set * @param listener Pointer to the object that will receive the callback. * @param callback Method on listener that will be called. * @param context User defined context which will be passed as-is to callback. * @param timeout Timeout specified in milliseconds to wait for a reply * @return * - #ER_OK if the request to set the property was successfully issued . * - #ER_BUS_OBJECT_NO_SUCH_INTERFACE if the specified interfaces does not exist on the remote object. * - An error status otherwise */ QStatus SetPropertyAsync(const char* iface, const char* property, MsgArg& value, ProxyBusObject::Listener* listener, ProxyBusObject::Listener::SetPropertyCB callback, void* context, uint32_t timeout = DefaultCallTimeout); /** * Helper function to sychronously set a uint32 property on the remote object. * * @param iface Remote object's interface on which the property is defined. * @param property The name of the property to set * @param u The uint32 value to set * @param timeout Timeout specified in milliseconds to wait for a reply * * @return * - #ER_OK if the property was set * - #ER_BUS_OBJECT_NO_SUCH_INTERFACE if the specified interfaces does not exist on the remote object. * - #ER_BUS_NO_SUCH_PROPERTY if the property does not exist */ QStatus SetProperty(const char* iface, const char* property, uint32_t u, uint32_t timeout = DefaultCallTimeout) const { MsgArg arg("u", u); return SetProperty(iface, property, arg, timeout); } /** * Helper function to sychronously set an int32 property on the remote object. * * @param iface Remote object's interface on which the property is defined. * @param property The name of the property to set * @param i The int32 value to set * @param timeout Timeout specified in milliseconds to wait for a reply * * @return * - #ER_OK if the property was set * - #ER_BUS_OBJECT_NO_SUCH_INTERFACE if the specified interfaces does not exist on the remote object. * - #ER_BUS_NO_SUCH_PROPERTY if the property does not exist */ QStatus SetProperty(const char* iface, const char* property, int32_t i, uint32_t timeout = DefaultCallTimeout) const { MsgArg arg("i", i); return SetProperty(iface, property, arg, timeout); } /** * Helper function to sychronously set string property on the remote object from a C string. * * @param iface Remote object's interface on which the property is defined. * @param property The name of the property to set * @param s The string value to set * @param timeout Timeout specified in milliseconds to wait for a reply * * @return * - #ER_OK if the property was set * - #ER_BUS_OBJECT_NO_SUCH_INTERFACE if the specified interfaces does not exist on the remote object. * - #ER_BUS_NO_SUCH_PROPERTY if the property does not exist */ QStatus SetProperty(const char* iface, const char* property, const char* s, uint32_t timeout = DefaultCallTimeout) const { MsgArg arg("s", s); return SetProperty(iface, property, arg, timeout); } /** * Helper function to sychronously set string property on the remote object from a qcc::String. * * @param iface Remote object's interface on which the property is defined. * @param property The name of the property to set * @param s The string value to set * @param timeout Timeout specified in milliseconds to wait for a reply * * @return * - #ER_OK if the property was set * - #ER_BUS_OBJECT_NO_SUCH_INTERFACE if the specified interfaces does not exist on the remote object. * - #ER_BUS_NO_SUCH_PROPERTY if the property does not exist */ QStatus SetProperty(const char* iface, const char* property, const qcc::String& s, uint32_t timeout = DefaultCallTimeout) const { MsgArg arg("s", s.c_str()); return SetProperty(iface, property, arg, timeout); } /** * Function to register a handler for property change events. * Note that registering the same handler callback for the same * interface will overwrite the previous registration. The same * handler callback may be registered for several different * interfaces simultaneously. * * Note that this makes method calls under the hood. If this is * called from a message handler or other AllJoyn callback, you * must call BusAttachment::EnableConcurrentCallbacks(). * * @param iface Remote object's interface on which the property is defined. * @param properties The name of the properties to monitor (NULL for all). * @param propertiesSize Number of properties to monitor. * @param listener Reference to the object that will receive the callback. * @param context User defined context which will be passed as-is to callback. * * @return * - #ER_OK if the handler was registered successfully * - #ER_BUS_OBJECT_NO_SUCH_INTERFACE if the specified interfaces does not exist on the remote object. * - #ER_BUS_NO_SUCH_PROPERTY if the property does not exist */ QStatus RegisterPropertiesChangedListener(const char* iface, const char** properties, size_t propertiesSize, ProxyBusObject::PropertiesChangedListener& listener, void* context); /** * Function to unregister a handler for property change events. * * @param iface Remote object's interface on which the property is defined. * @param listener Reference to the object that used to receive the callback. * * @return * - #ER_OK if the handler was registered successfully * - #ER_BUS_OBJECT_NO_SUCH_INTERFACE if the specified interfaces does not exist on the remote object. */ QStatus UnregisterPropertiesChangedListener(const char* iface, ProxyBusObject::PropertiesChangedListener& listener); /** * Returns the interfaces implemented by this object. Note that all proxy bus objects * automatically inherit the "org.freedesktop.DBus.Peer" which provides the built-in "ping" * method, so this method always returns at least that one interface. * * @param ifaces A pointer to an InterfaceDescription array to receive the interfaces. Can be NULL in * which case no interfaces are returned and the return value gives the number * of interface available. * @param numIfaces The size of the InterfaceDescription array. If this value is smaller than the total * number of interfaces only numIfaces will be returned. * * @return The number of interfaces returned or the total number of interfaces if ifaces is NULL. */ size_t GetInterfaces(const InterfaceDescription** ifaces = NULL, size_t numIfaces = 0) const; /** * Returns a pointer to an interface description. Returns NULL if the object does not implement * the requested interface. * * @param iface The name of interface to get. * * @return * - A pointer to the requested interface description. * - NULL if requested interface is not implemented or not found */ const InterfaceDescription* GetInterface(const char* iface) const; /** * Tests if this object implements the requested interface. * * @param iface The interface to check * * @return true if the object implements the requested interface */ bool ImplementsInterface(const char* iface) const { return GetInterface(iface) != NULL; } /** * Add an interface to this ProxyBusObject. * * Occasionally, AllJoyn library user may wish to call a method on * a %ProxyBusObject that was not reported during introspection of the remote object. * When this happens, the InterfaceDescription will have to be registered with the * Bus manually and the interface will have to be added to the %ProxyBusObject using this method. * @remark * The interface added via this call must have been previously registered with the * Bus. (i.e. it must have come from a call to Bus::GetInterface()). * * @param iface The interface to add to this object. Must come from Bus::GetInterface(). * @return * - #ER_OK if successful. * - An error status otherwise */ QStatus AddInterface(const InterfaceDescription& iface); /** * Add an existing interface to this object using the interface's name. * * @param name Name of existing interface to add to this object. * @return * - #ER_OK if successful. * - An error status otherwise. */ QStatus AddInterface(const char* name); /** * Returns an array of ProxyBusObject pointers for the children of this * %ProxyBusObject. * * @param children An array to %ProxyBusObject pointers to receive the * children. Can be NULL in which case no children are * returned and the return value gives the number of * children available. Note that the lifetime of the * pointers is limited to the lifetime of the parent. * @param numChildren The size of the %ProxyBusObject array. If this value * is smaller than the total number of children only * numChildren will be returned. * * @return The number of children returned or the total number of children * if children is NULL. */ size_t GetChildren(ProxyBusObject** children = NULL, size_t numChildren = 0); /** * Returns an array of _ProxyBusObjects for the children of this %ProxyBusObject. * Unlike the unmanaged version of GetChildren, it is expected the caller will call * delete on each _ProxyBusObject in the array returned. * * @param children A pointer to a %_ProxyBusObject array to receive the children. Can be NULL in * which case no children are returned and the return value gives the number * of children available. * @param numChildren The size of the %_ProxyBusObject array. If this value is smaller than the total * number of children only numChildren will be returned. * * @return The number of children returned or the total number of children if children is NULL. */ QCC_DEPRECATED(size_t GetManagedChildren(void* children = NULL, size_t numChildren = 0)); /** * Get a path descendant ProxyBusObject (child) by its absolute or relative path name. * * For example, if this ProxyBusObject's path is @c "/foo/bar", then you * can retrieve the ProxyBusObject for @c "/foo/bar/bat/baz" by calling * @c GetChild("/foo/bar/bat/baz") or @c GetChild("/bat/baz"). The pointer * that is returned is owned by the parent instance of ProxyBusObject and * will be deleted when the parent is destroyed. * * @param path the absolute or relative path for the child. * * @return * - The (potentially deep) descendant ProxyBusObject * - NULL if not found. */ ProxyBusObject* GetChild(const char* path); /** * Get a path descendant _ProxyBusObject (child) by its absolute or relative path name. * * For example, if this _ProxyBusObject's path is @c "/foo/bar", then you can retrieve the * _ProxyBusObject for @c "/foo/bar/bat/baz" by calling @c GetChild("/foo/bar/bat/baz") or * @c GetChild("bat/baz"). Unlike the unmanaged version of GetChild, it is expected the * caller will call delete on the _ProxyBusObject returned. * * @param inPath the absolute or relative path for the child. * * @return * - The (potentially deep) descendant _ProxyBusObject * - NULL if not found. */ QCC_DEPRECATED(void* GetManagedChild(const char* inPath)); /** * Add a child object (direct or deep object path descendant) to this object. * If you add a deep path descendant, this method will create intermediate * ProxyBusObject children as needed. * * @remark * - It is an error to try to add a child that already exists. * - It is an error to try to add a child that has an object path that is not a descendant of this object's path. * * @param child Child ProxyBusObject * @return * - #ER_OK if successful. * - #ER_BUS_BAD_CHILD_PATH if the path is a bad path * - #ER_BUS_OBJ_ALREADY_EXISTS if the object already exists on the ProxyBusObject */ QStatus AddChild(const ProxyBusObject& child); /** * Remove a child object and any descendants it may have. * * @param path Absolute or relative (to this ProxyBusObject) object path. * @return * - #ER_OK if successful. * - #ER_BUS_BAD_CHILD_PATH if the path given was not a valid path * - #ER_BUS_OBJ_NOT_FOUND if the Child object was not found * - #ER_FAIL any other unexpected error. */ QStatus RemoveChild(const char* path); /** * Make a synchronous method call from this object * * @param method Method being invoked. * @param args The arguments for the method call (can be NULL) * @param numArgs The number of arguments * @param replyMsg The reply message received for the method call * @param timeout Timeout specified in milliseconds to wait for a reply * @param flags Logical OR of the message flags for this method call. The following flags apply to method calls: * - If #ALLJOYN_FLAG_ENCRYPTED is set the message is authenticated and the payload if any is encrypted. * - If #ALLJOYN_FLAG_AUTO_START is set the bus will attempt to start a service if it is not running. * * * @return * - #ER_OK if the method call succeeded and the reply message type is #MESSAGE_METHOD_RET * - #ER_BUS_REPLY_IS_ERROR_MESSAGE if the reply message type is #MESSAGE_ERROR */ QStatus MethodCall(const InterfaceDescription::Member& method, const MsgArg* args, size_t numArgs, Message& replyMsg, uint32_t timeout = DefaultCallTimeout, uint8_t flags = 0) const; /** * Make a synchronous method call from this object * * @param ifaceName Name of interface. * @param methodName Name of method. * @param args The arguments for the method call (can be NULL) * @param numArgs The number of arguments * @param replyMsg The reply message received for the method call * @param timeout Timeout specified in milliseconds to wait for a reply * @param flags Logical OR of the message flags for this method call. The following flags apply to method calls: * - If #ALLJOYN_FLAG_ENCRYPTED is set the message is authenticated and the payload if any is encrypted. * - If #ALLJOYN_FLAG_AUTO_START is set the bus will attempt to start a service if it is not running. * * @return * - #ER_OK if the method call succeeded and the reply message type is #MESSAGE_METHOD_RET * - #ER_BUS_REPLY_IS_ERROR_MESSAGE if the reply message type is #MESSAGE_ERROR */ virtual QStatus MethodCall(const char* ifaceName, const char* methodName, const MsgArg* args, size_t numArgs, Message& replyMsg, uint32_t timeout = DefaultCallTimeout, uint8_t flags = 0) const; /** * Make a fire-and-forget method call from this object. The caller will not be able to tell if * the method call was successful or not. This is equivalent to calling MethodCall() with * flags == ALLJOYN_FLAG_NO_REPLY_EXPECTED. Because this call doesn't block it can be made from * within a signal handler. * * @param ifaceName Name of interface. * @param methodName Name of method. * @param args The arguments for the method call (can be NULL) * @param numArgs The number of arguments * @param flags Logical OR of the message flags for this method call. The following flags apply to method calls: * - If #ALLJOYN_FLAG_ENCRYPTED is set the message is authenticated and the payload if any is encrypted. * - If #ALLJOYN_FLAG_AUTO_START is set the bus will attempt to start a service if it is not running. * * @return * - #ER_OK if the method call succeeded */ QStatus MethodCall(const char* ifaceName, const char* methodName, const MsgArg* args, size_t numArgs, uint8_t flags = 0) const { return MethodCallAsync(ifaceName, methodName, NULL, NULL, args, numArgs, NULL, 0, flags |= ALLJOYN_FLAG_NO_REPLY_EXPECTED); } /** * Make a fire-and-forget method call from this object. The caller will not be able to tell if * the method call was successful or not. This is equivalent to calling MethodCall() with * flags == ALLJOYN_FLAG_NO_REPLY_EXPECTED. Because this call doesn't block it can be made from * within a signal handler. * * @param method Method being invoked. * @param args The arguments for the method call (can be NULL) * @param numArgs The number of arguments * @param flags Logical OR of the message flags for this method call. The following flags apply to method calls: * - If #ALLJOYN_FLAG_ENCRYPTED is set the message is authenticated and the payload if any is encrypted. * - If #ALLJOYN_FLAG_AUTO_START is set the bus will attempt to start a service if it is not running. * * @return * - #ER_OK if the method call succeeded and the reply message type is #MESSAGE_METHOD_RET */ QStatus MethodCall(const InterfaceDescription::Member& method, const MsgArg* args, size_t numArgs, uint8_t flags = 0) const { return MethodCallAsync(method, NULL, NULL, args, numArgs, NULL, 0, flags |= ALLJOYN_FLAG_NO_REPLY_EXPECTED); } /** * Make an asynchronous method call from this object * * @param method Method being invoked. * @param receiver The object to be called when the asych method call completes. * @param replyFunc The function that is called to deliver the reply * @param args The arguments for the method call (can be NULL) * @param numArgs The number of arguments * @param receiver The object to be called when the asych method call completes. * @param context User-defined context that will be returned to the reply handler * @param timeout Timeout specified in milliseconds to wait for a reply * @param flags Logical OR of the message flags for this method call. The following flags apply to method calls: * - If #ALLJOYN_FLAG_ENCRYPTED is set the message is authenticated and the payload if any is encrypted. * - If #ALLJOYN_FLAG_AUTO_START is set the bus will attempt to start a service if it is not running. * @return * - ER_OK if successful * - An error status otherwise */ QStatus MethodCallAsync(const InterfaceDescription::Member& method, MessageReceiver* receiver, MessageReceiver::ReplyHandler replyFunc, const MsgArg* args = NULL, size_t numArgs = 0, void* context = NULL, uint32_t timeout = DefaultCallTimeout, uint8_t flags = 0) const; /** * Make an asynchronous method call from this object * * @param ifaceName Name of interface for method. * @param methodName Name of method. * @param receiver The object to be called when the asynchronous method call completes. * @param replyFunc The function that is called to deliver the reply * @param args The arguments for the method call (can be NULL) * @param numArgs The number of arguments * @param context User-defined context that will be returned to the reply handler * @param timeout Timeout specified in milliseconds to wait for a reply * @param flags Logical OR of the message flags for this method call. The following flags apply to method calls: * - If #ALLJOYN_FLAG_ENCRYPTED is set the message is authenticated and the payload if any is encrypted. * - If #ALLJOYN_FLAG_AUTO_START is set the bus will attempt to start a service if it is not running. * @return * - ER_OK if successful * - An error status otherwise */ QStatus MethodCallAsync(const char* ifaceName, const char* methodName, MessageReceiver* receiver, MessageReceiver::ReplyHandler replyFunc, const MsgArg* args = NULL, size_t numArgs = 0, void* context = NULL, uint32_t timeout = DefaultCallTimeout, uint8_t flags = 0) const; /** * Initialize this proxy object from an XML string. Calling this method does several things: * * -# Create and register any new InterfaceDescription(s) that are mentioned in the XML. * (Interfaces that are already registered with the bus are left "as-is".) * -# Add all the interfaces mentioned in the introspection data to this ProxyBusObject. * -# Recursively create any child ProxyBusObject(s) and create/add their associated @n * interfaces as mentioned in the XML. Then add the descendant object(s) to the appropriate * descendant of this ProxyBusObject (in the children collection). If the named child object * already exists as a child of the appropriate ProxyBusObject, then it is updated * to include any new interfaces or children mentioned in the XML. * * Note that when this method fails during parsing, the return code will be set accordingly. * However, any interfaces which were successfully parsed prior to the failure * may be registered with the bus. Similarly, any objects that were successfully created * before the failure will exist in this object's set of children. * * @param xml An XML string in DBus introspection format. * @param identifier An optional identifying string to include in error logging messages. * * @return * - #ER_OK if parsing is completely successful. * - An error status otherwise. */ QStatus ParseXml(const char* xml, const char* identifier = NULL); /** * Explicitly secure the connection to the remote peer for this proxy object. Peer-to-peer * connections can only be secured if EnablePeerSecurity() was previously called on the bus * attachment for this proxy object. If the peer-to-peer connection is already secure this * function does nothing. Note that peer-to-peer connections are automatically secured when a * method call requiring encryption is sent. * * This call causes messages to be send on the bus, therefore it cannot be called within AllJoyn * callbacks (method/signal/reply handlers or ObjectRegistered callbacks, etc.) * * @param forceAuth If true, forces an re-authentication even if the peer connection is already * authenticated. * * @return * - #ER_OK if the connection was secured or an error status indicating that the * connection could not be secured. * - #ER_BUS_NO_AUTHENTICATION_MECHANISM if BusAttachment::EnablePeerSecurity() has not been called. * - #ER_AUTH_FAIL if the attempt(s) to authenticate the peer failed. * - Other error status codes indicating a failure. */ QStatus SecureConnection(bool forceAuth = false); /** * Asynchronously secure the connection to the remote peer for this proxy object. Peer-to-peer * connections can only be secured if EnablePeerSecurity() was previously called on the bus * attachment for this proxy object. If the peer-to-peer connection is already secure this * function does nothing. Note that peer-to-peer connections are automatically secured when a * method call requiring encryption is sent. * * Notification of success or failure is via the AuthListener passed to EnablePeerSecurity(). * * @param forceAuth If true, forces an re-authentication even if the peer connection is already * authenticated. * * @return * - #ER_OK if securing could begin. * - #ER_BUS_NO_AUTHENTICATION_MECHANISM if BusAttachment::EnablePeerSecurity() has not been called. * - Other error status codes indicating a failure. */ QStatus SecureConnectionAsync(bool forceAuth = false); /** * Checks if other refers to the same internal instance has this. * * @param other The object being compared * @return true iff this has identical internals to other */ bool iden(const ProxyBusObject& other) const { return internal.iden(other.internal); } /** * Equivalence operator. * * @param other The object being compared * @return true iff this is the same as other */ bool operator==(const ProxyBusObject& other) const; /** * Less than operator. * * @param other The object being compared * @return true iff this is less than other */ bool operator<(const ProxyBusObject& other) const; /** * Assignment operator. * * @param other The object being assigned from * @return a copy of the ProxyBusObject */ ProxyBusObject& operator=(const ProxyBusObject& other); /** * Copy constructor * * @param other The object being copied from. */ ProxyBusObject(const ProxyBusObject& other); /** * Indicates if this is a valid (usable) proxy bus object. * * @return true if a valid proxy bus object, false otherwise. */ bool IsValid() const; /** * Indicates if the remote object for this proxy bus object is secure. * * @return true if the object is secure */ bool IsSecure() const; /** * Enable property caching for this proxy bus object. */ void EnablePropertyCaching(); private: class Internal; qcc::ManagedObj internal; /**< Internal ProxyBusObject state */ bool isExiting; /**< true iff ProxyBusObject is in the process of being destroyed */ ProxyBusObject(qcc::ManagedObj internal); /** * @internal * Called by XmlHelper to set the secure flag when introspecting. * * @param isSecure indicates if node is secure or not */ void SetSecure(bool isSecure); /** * @internal * Method return handler used to process synchronous method calls. * * @param msg Method return message * @param context Opaque context passed from method_call to method_return */ void SyncReplyHandler(Message& msg, void* context); /** * @internal * Introspection method_reply handler. (Internal use only) * * @param message Method return Message * @param context Opaque context passed from method_call to method_return */ void IntrospectMethodCB(Message& message, void* context); /** * @internal * GetProperty method_reply handler. (Internal use only) * * @param message Method return Message * @param context Opaque context passed from method_call to method_return */ void GetPropMethodCB(Message& message, void* context); /** * @internal * GetAllProperties method_reply handler. (Internal use only) * * @param message Method return Message * @param context Opaque context passed from method_call to method_return */ void GetAllPropsMethodCB(Message& message, void* context); /** * @internal * SetProperty method_reply handler. (Internal use only) * * @param message Method return Message * @param context Opaque context passed from method_call to method_return */ void SetPropMethodCB(Message& message, void* context); /** * @internal * Set the B2B endpoint to use for all communication with remote object. * This method is for internal use only. * * @param b2bEp the RemoteEndpoint for Bus to Bus communication */ void SetB2BEndpoint(RemoteEndpoint& b2bEp); /** * @internal * Internal introspection xml parse tree type. */ struct IntrospectionXml; /** * @internal * Parse a single introspection @ element. * * @param node XML element (must be a @). * * @return * - #ER_OK if completely successful. * - An error status otherwise */ static QStatus ParseNode(const IntrospectionXml& node); /** * @internal * Parse a single introspection @ element. * * @param ifc XML element (must be an @). * * @return * - #ER_OK if completely successful. * - An error status otherwise */ static QStatus ParseInterface(const IntrospectionXml& ifc); }; /** * _ProxyBusObject is a reference counted (managed) version of ProxyBusObject */ QCC_DEPRECATED(typedef qcc::ManagedObj _ProxyBusObject); } #endif alljoyn-15.04b/alljoyn_core/inc/alljoyn/Session.h000066400000000000000000000244531255700255500220500ustar00rootroot00000000000000#ifndef _ALLJOYN_SESSION_H #define _ALLJOYN_SESSION_H /** * @file * AllJoyn session related data types. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include namespace ajn { /** * SessionPort identifies a per-BusAttachment receiver for incoming JoinSession requests. * SessionPort values are bound to a BusAttachment when the attachment calls * BindSessionPort. * * NOTE: Valid SessionPort values range from 1 to 0xFFFF. */ typedef uint16_t SessionPort; /** Invalid SessionPort value used to indicate that BindSessionPort should choose any available port */ const SessionPort SESSION_PORT_ANY = 0; /** SessionId uniquely identifies an AllJoyn session instance */ typedef uint32_t SessionId; /** Invalid session id value used to indicate that a signal should be emitted on all hosted sessions */ const SessionId SESSION_ID_ALL_HOSTED = ((SessionId) - 1); /* Forward declaration */ class MsgArg; /** * SessionOpts contains a set of parameters that define a Session's characteristics. */ class SessionOpts { public: /** Traffic type */ typedef enum { TRAFFIC_MESSAGES = 0x01, /**< Session carries message traffic */ TRAFFIC_RAW_UNRELIABLE = 0x02, /**< Session carries an unreliable (lossy) byte stream */ TRAFFIC_RAW_RELIABLE = 0x04, /**< Session carries a reliable byte stream */ } TrafficType; TrafficType traffic; /**< holds the Traffic type for this SessionOpt*/ /** * Multi-point session capable. * A session is multi-point if it can be joined multiple times to form a single * session with multi (greater than 2) endpoints. When false, each join attempt * creates a new point-to-point session. */ bool isMultipoint; /**@name Proximity */ // {@ typedef uint8_t Proximity; static const Proximity PROXIMITY_ANY = 0xFF; static const Proximity PROXIMITY_PHYSICAL = 0x01; static const Proximity PROXIMITY_NETWORK = 0x02; Proximity proximity; // @} /** Allowed Transports */ TransportMask transports; /** * Construct a SessionOpts with specific parameters. * * @param traffic Type of traffic. * @param isMultipoint true iff session supports multipoint (greater than two endpoints). * @param proximity Proximity constraint bitmask. * @param transports Allowed transport types bitmask. * @param exchangeAllNames true if all names need to be exchanged. * false if only session related names need to be exchanged. * (Default, used for optimal performance) * */ SessionOpts(SessionOpts::TrafficType traffic, bool isMultipoint, SessionOpts::Proximity proximity, TransportMask transports, bool exchangeAllNames = false) : traffic(traffic), isMultipoint(isMultipoint), proximity(proximity), transports(transports), nameTransfer(exchangeAllNames ? ALL_NAMES : (isMultipoint ? MP_NAMES : P2P_NAMES)) { } /** * Construct a default SessionOpts */ SessionOpts() : traffic(TRAFFIC_MESSAGES), isMultipoint(false), proximity(PROXIMITY_ANY), transports(TRANSPORT_ANY), nameTransfer(P2P_NAMES) { } /** * Destructor */ virtual ~SessionOpts() { } /** * Determine whether this SessionOpts is compatible with the SessionOpts offered by other * * Compatibility means that the SessionOpts share at least one of each * - transport type * - traffic type * - proximity type * * Note that multipoint support is not a condition of compatibility * * @param other Options to be compared against this one. * @return true iff this SessionOpts can use the option set offered by other. */ bool IsCompatible(const SessionOpts& other) const; /** * Create a human readable representation of a SessionOpts * * @return string with human readable SessionOpts */ qcc::String ToString() const; /** * Compare SessionOpts * * @param other the SessionOpts being compared against * @return true if all of the SessionOpts parameters are the same * */ bool operator==(const SessionOpts& other) const { return (traffic == other.traffic) && (isMultipoint == other.isMultipoint) && (proximity == other.proximity) && (transports == other.transports); } /** * Rather arbitrary less-than operator to allow containers holding SessionOpts * to be sorted. * Traffic takes precedence when sorting SessionOpts. * * #TRAFFIC_MESSAGES \< #TRAFFIC_RAW_UNRELIABLE \< #TRAFFIC_RAW_RELIABLE * * If traffic is equal then Proximity takes next level of precedence. * * PROXIMITY_PHYSICAL \< PROXIMITY_NETWORK \< PROXIMITY_ANY * * last transports. * * #TRANSPORT_LOCAL \< #TRANSPORT_WLAN \< #TRANSPORT_WWAN \< #TRANSPORT_ANY * * * @param other the SessionOpts being compared against * @return true if this SessionOpts is designated as less than the SessionOpts * being compared against. */ bool operator<(const SessionOpts& other) const { if ((traffic < other.traffic) || ((traffic == other.traffic) && !isMultipoint && other.isMultipoint) || ((traffic == other.traffic) && (isMultipoint == other.isMultipoint) && (proximity < other.proximity)) || ((traffic == other.traffic) && (isMultipoint == other.isMultipoint) && (proximity == other.proximity) && (transports < other.transports))) { return true; } return false; } /** * Set up this session to exchange all names not just session related names. * */ void SetAllNames(); /** * Set up this session to exchange only session related names not all names. * */ void SetSessionNames(); /** * Is this session set up to exchange all names * @return true if session is set up to exchange all names. */ bool IsAllNames() const; /** * Is this session set up to exchange only session related names * @return true if session is set up to exchange only session related names. */ bool IsSessionNames() const; /** Internal * * NameTransferType when a session is established list of names are exchanged. * The NameTransferType specifies what information is exchanged. */ typedef enum { ALL_NAMES = 0x00, /**< ExchangeNames and NameChanged to be forwarded to this session, AttachSessionWithNames to be converted into an ExchangeNames and sent over this session, all NameChanged to be sent, all names to be sent as a part of initial AttachSessionWithNames */ SLS_NAMES = 0x01, /**< No ExchangeNames and NameChanged forwarding, no NameChanged to be sent, only router names and sessionless emitter names(if host routing node) to be sent as a part of initial AttachSessionWithNames */ MP_NAMES = 0x02, /**< ExchangeNames and NameChanged to be forwarded only over endpoints that match the session id of the endpoint that it was received on, NameChanged to be sent to routing nodes if a session to this leaf existed, only routing node and joiner or host and existing session member names to be sent as a part of initial AttachSessionWithNames */ P2P_NAMES = 0x03, /**< No ExchangeNames and NameChanged forwarding, NameChanged to be sent only if a session to this leaf existed, only routing node and joiner/host names to be sent as a part of initial AttachSessionWithNames */ } NameTransferType; protected: /** * Construct a SessionOpts with specific parameters. * * @param traffic Type of traffic. * @param isMultipoint true iff session supports multipoint (greater than two endpoints). * @param proximity Proximity constraint bitmask. * @param transports Allowed transport types bitmask. * @param nameType The NameTransferType specifies what information is exchanged * values #ALL_NAMES, #SLS_NAMES */ SessionOpts(SessionOpts::TrafficType traffic, bool isMultipoint, SessionOpts::Proximity proximity, TransportMask transports, NameTransferType nameType) : traffic(traffic), isMultipoint(isMultipoint), proximity(proximity), transports(transports), nameTransfer(nameType) { } private: friend class SessionlessObj; friend class AllJoynObj; friend class TCPTransport; friend class UDPTransport; friend class Features; friend void SetSessionOpts(const SessionOpts& opts, MsgArg& msgArg); friend QStatus GetSessionOpts(const MsgArg& msgArg, SessionOpts& opts); /** * NameTransferType used for specifying the name propagation during initial * ExchangeNames */ NameTransferType nameTransfer; }; } #endif alljoyn-15.04b/alljoyn_core/inc/alljoyn/SessionListener.h000066400000000000000000000070531255700255500235530ustar00rootroot00000000000000/** * @file * SessionListener is an abstract base class (interface) implemented by users of the * AllJoyn API in order to receive sessions related event information. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_SESSIONLISTENER_H #define _ALLJOYN_SESSIONLISTENER_H #ifndef __cplusplus #error Only include SessionListener.h in C++ code. #endif #include namespace ajn { /** * Abstract base class implemented by AllJoyn users and called by AllJoyn to inform * users of session related events. */ class SessionListener { public: /** Reason for the session being lost */ typedef enum { ALLJOYN_SESSIONLOST_INVALID = 0x00, /**< Invalid */ ALLJOYN_SESSIONLOST_REMOTE_END_LEFT_SESSION = 0x01, /**< Remote end called LeaveSession */ ALLJOYN_SESSIONLOST_REMOTE_END_CLOSED_ABRUPTLY = 0x02, /**< Remote end closed abruptly */ ALLJOYN_SESSIONLOST_REMOVED_BY_BINDER = 0x03, /**< Session binder removed this endpoint by calling RemoveSessionMember */ ALLJOYN_SESSIONLOST_LINK_TIMEOUT = 0x04, /**< Link was timed-out */ ALLJOYN_SESSIONLOST_REASON_OTHER = 0x05, /**< Unspecified reason for session loss */ ALLJOYN_SESSIONLOST_REMOVED_BY_BINDER_SELF = 0x06, /**< Session binder removed its joiner part by calling RemoveSessionMember (selfjoin only) */ } SessionLostReason; /** * Virtual destructor for derivable class. */ virtual ~SessionListener() { } /** * Called by the bus when an existing session becomes disconnected. * * @param sessionId Id of session that was lost. * @param reason The reason for the session being lost */ virtual void SessionLost(SessionId sessionId, SessionLostReason reason) { QCC_UNUSED(sessionId); QCC_UNUSED(reason); } /** * Called by the bus when a member of a multipoint session is added. * * @param sessionId Id of session whose member(s) changed. * @param uniqueName Unique name of member who was added. */ virtual void SessionMemberAdded(SessionId sessionId, const char* uniqueName) { QCC_UNUSED(sessionId); QCC_UNUSED(uniqueName); } /** * Called by the bus when a member of a multipoint session is removed. * * @param sessionId Id of session whose member(s) changed. * @param uniqueName Unique name of member who was removed. */ virtual void SessionMemberRemoved(SessionId sessionId, const char* uniqueName) { QCC_UNUSED(sessionId); QCC_UNUSED(uniqueName); } }; } #endif alljoyn-15.04b/alljoyn_core/inc/alljoyn/SessionPortListener.h000066400000000000000000000060441255700255500244170ustar00rootroot00000000000000/** * @file * SessionPortListener is an abstract base class (interface) implemented by users of the * AllJoyn API in order to receive session port related event information. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_SESSIONPORTLISTENER_H #define _ALLJOYN_SESSIONPORTLISTENER_H #ifndef __cplusplus #error Only include SessionPortListener.h in C++ code. #endif #include #include namespace ajn { /** * Abstract base class implemented by AllJoyn users and called by AllJoyn to inform * users of session related events. */ class SessionPortListener { public: /** * Virtual destructor for derivable class. */ virtual ~SessionPortListener() { } /** * Accept or reject an incoming JoinSession request. The session does not exist until this * after this function returns. * * This callback is only used by session creators. Therefore it is only called on listeners * passed to BusAttachment::BindSessionPort. * * @param sessionPort Session port that was joined. * @param joiner Unique name of potential joiner. * @param opts Session options requested by the joiner. * @return Return true if JoinSession request is accepted. false if rejected. */ virtual bool AcceptSessionJoiner(SessionPort sessionPort, const char* joiner, const SessionOpts& opts) { QCC_UNUSED(sessionPort); QCC_UNUSED(joiner); QCC_UNUSED(opts); return false; } /** * Called by the bus when a session has been successfully joined. The session is now fully up. * * This callback is only used by session creators. Therefore it is only called on listeners * passed to BusAttachment::BindSessionPort. * * @param sessionPort Session port that was joined. * @param id Id of session. * @param joiner Unique name of the joiner. */ virtual void SessionJoined(SessionPort sessionPort, SessionId id, const char* joiner) { QCC_UNUSED(sessionPort); QCC_UNUSED(id); QCC_UNUSED(joiner); } }; } #endif alljoyn-15.04b/alljoyn_core/inc/alljoyn/SimpleBusListener.h000066400000000000000000000146301255700255500240320ustar00rootroot00000000000000/** * @file * SimpleBusListener is a synchronous bus listener that fits the need of applications that can * handled all bus events from the main thread. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_SIMPLEBUSLISTENER_H #define _ALLJOYN_SIMPLEBUSLISTENER_H #ifndef __cplusplus #error Only include SimpleBusListener.h in C++ code. #endif #include #include namespace ajn { /** * @name Bus Events * The various bus events. */ // @{ /** Event indicating an advertised name was found */ static const uint32_t BUS_EVENT_FOUND_ADVERTISED_NAME = 0x0001; /** Event indicating a previously found name has been lost*/ static const uint32_t BUS_EVENT_LOST_ADVERTISED_NAME = 0x0002; /** Event indicating that the ownership of a bus name has changed. */ static const uint32_t BUS_EVENT_NAME_OWNER_CHANGED = 0x0004; /** Bit mask that can be used filter Bus Events */ static const uint32_t BUS_EVENT_ALL = 0x00FF; /** Bit mask that can be used filter Bus Events */ static const uint32_t BUS_EVENT_NONE = 0x0000; // @} /** * Helper class that provides a blocking API that allows application threads to wait for bus events. */ class SimpleBusListener : public BusListener { public: /** * Indicator used when calling the #WaitForEvent method to indicate that the * listener should wait forever for the specified BusEvent. */ static const uint32_t FOREVER = (uint32_t)-1; /** * Constructor that initializes a bus listener with specific events enabled. * * @param enabled A logical OR of the bus events to be enabled for this listener. */ SimpleBusListener(uint32_t enabled = 0); /** * Set an event filter. This overrides the events enabled by the constructor. Any queued events * that are not enabled are discarded. * * @param enabled A logical OR of the bus events to be enabled for this listener. */ void SetFilter(uint32_t enabled); /** * This union is used to return busEvent information for the bus events. */ class BusEvent { friend class SimpleBusListener; public: uint32_t eventType; ///< The busEvent type identifies which variant from the union applies. union { struct { const char* name; ///< well known name that the remote bus is advertising that is of interest to this attachment. TransportMask transport; ///< Transport that received the advertisement. const char* namePrefix; ///< The well-known name prefix used in call to FindAdvertisedName that triggered the busEvent. } foundAdvertisedName; struct { const char* name; ///< A well known name that the remote bus is advertising that is of interest to this attachment. TransportMask transport; ///< Transport that received the advertisement. const char* namePrefix; ///< The well-known name prefix that was used in a call to FindAdvertisedName that triggered this callback. } lostAdvertisedName; struct { const char* busName; ///< The well-known name that has changed. const char* previousOwner; ///< The unique name that previously owned the name or NULL if there was no previous owner. const char* newOwner; ///< The unique name that now owns the name or NULL if there is no new owner. } nameOwnerChanged; }; /** * Constructor */ BusEvent() : eventType(0) { } /** * Copy constructor. */ BusEvent(const BusEvent& other) { *this = other; } /** * Assignment operator. */ BusEvent& operator=(const BusEvent& other); private: /** * @internal Storage for the BusEvent strings. */ qcc::String strings[3]; }; /** * Wait for a bus event. * * @param busEvent Returns the busEvent type and related information. * @param timeout A timeout in milliseconds to wait for the busEvent, 0 means don't wait just * check for an busEvent and return, FOREVER (-1) means wait forever. * * @return * - #ER_OK if an even was received. * - #ER_TIMEOUT if the wait timed out. * - #ER_ALERTED_THREAD if the wait unblocked due to a signal */ QStatus WaitForEvent(BusEvent& busEvent, uint32_t timeout = FOREVER); /** * Destructor. */ ~SimpleBusListener(); private: /** * Copy constructor. * @param other Object to copy from. */ SimpleBusListener(const SimpleBusListener& other); /** * Assignment operator. * @param other RHS of assignment. */ SimpleBusListener& operator=(const SimpleBusListener& other); /** * Bit mask of events enabled for this listener. */ uint32_t enabled; void ListenerRegistered(BusAttachment* bus); void ListenerUnregistered(); void BusStopping(); void FoundAdvertisedName(const char* name, TransportMask transport, const char* namePrefix); void LostAdvertisedName(const char* name, TransportMask transport, const char* namePrefix); void NameOwnerChanged(const char* busName, const char* previousOwner, const char* newOwner); /** * @internal * Internal storage for this class. */ class Internal; Internal& internal; }; } #endif alljoyn-15.04b/alljoyn_core/inc/alljoyn/Translator.h000066400000000000000000000072551255700255500225570ustar00rootroot00000000000000/** * @file * Translator is an abstract base class (interface) implemented by users of the * AllJoyn API in order to provide org.allseen.Introspectable descriptions in more than just one language */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_DESCRIPTIONTRANSLATOR_H #define _ALLJOYN_DESCRIPTIONTRANSLATOR_H #ifndef __cplusplus #error Only include Translator.h in C++ code. #endif #include namespace ajn { /** * Abstract base class that provides translations of descriptions returned from * org.allseen.Introspectable.IntrospectWithDescription. */ class Translator { public: virtual ~Translator() { } /** * Retrieve the number of target language tags this Translator * can translate into. * @return size_t The number of target language tags */ virtual size_t NumTargetLanguages() = 0; /** * Retrieve the n'th target language tag * @param index The index of the language tag to retrieve * @param ret The returned value */ virtual void GetTargetLanguage(size_t index, qcc::String& ret) = 0; /** * Translate source from sourceLanguage into targetLanguage. * If this Translator does not have a translation for the given * parameters it should return NULL. * * @param sourceLanguage The language tag of the text in source * @param targetLanguage The language tag to translate into * @param source The source text to translate * @return The translated text or NULL */ virtual const char* Translate(const char* sourceLanguage, const char* targetLanguage, const char* source) { QCC_UNUSED(sourceLanguage); QCC_UNUSED(targetLanguage); QCC_UNUSED(source); return NULL; } /** * Translate source from sourceLanguage into targetLanguage. * If this Translator does not have a translation for the given * parameters it should return NULL. This version of the * function is designed for imeplementations that return dynamically allocated strings. * The string should be copied into buffer and buffer.c_str() must be returned. When alljoyn * finishes using the string buffer will be free'ed * * @param sourceLanguage The language tag of the text in source * @param targetLanguage The language tag to translate into * @param source The source text to translate * @param buffer A buffer to hold the dynamically allocated string returned by this function * @return The translated text or NULL */ virtual const char* Translate(const char* sourceLanguage, const char* targetLanguage, const char* source, qcc::String& buffer) { QCC_UNUSED(buffer); return Translate(sourceLanguage, targetLanguage, source); } }; } #endif alljoyn-15.04b/alljoyn_core/inc/alljoyn/TransportMask.h000066400000000000000000000074051255700255500232330ustar00rootroot00000000000000#ifndef _ALLJOYN_TRANPORTMASK_H #define _ALLJOYN_TRANPORTMASK_H /** * @file * Transport type definitions */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include namespace ajn { /** Bitmask of all transport types */ typedef uint16_t TransportMask; const TransportMask TRANSPORT_NONE = 0x0000; /**< no transports */ const TransportMask TRANSPORT_LOCAL = 0x0001; /**< Local (same device) transport */ const TransportMask TRANSPORT_TCP = 0x0004; /**< Transport using TCP as the underlying mechanism */ const TransportMask TRANSPORT_UDP = 0x0100; /**< Transport using UDP as the underlying mechanism */ /** * A placeholder for an experimental transport that has not yet reached the * performance, stability or testing requirements of a commercialized transport. * * It is expected that each experimental Transport will alias this bit if * included in an AllJoyn release and then allocate one of the reserved mask * bits upon attaining commercialized status. * * For example, * const TransportMask TRANSPORT_CAN_AND_STRING = TRANSPORT_EXPERIMENTAL */ const TransportMask TRANSPORT_EXPERIMENTAL = 0x8000; /** * A constant indicating that any IP-based transport is acceptable. It is left * up to the system to decide which of the available transports is "best." */ const TransportMask TRANSPORT_IP = (TRANSPORT_TCP | TRANSPORT_UDP); /** * A constant indicating that any commericalized transport is acceptable. As * more transports are introduced and reach commercial quality, we expect the * corresponding mask bits to be added here. */ const TransportMask TRANSPORT_ANY = (TRANSPORT_LOCAL | TRANSPORT_IP); /** * Obsolete mask indicating that any transport as long as it is running over the * local wireless local area network is acceptable. * * @deprecated February 2015 for 15.04 release */ QCC_DEPRECATED(const TransportMask TRANSPORT_WLAN) = 0x0004; /**< Wireless local-area network transport (same as TRANSPORT_TCP) */ /** * Obsolete mask indicating that any transport as long as it is running over the * local wireless wide area network is acceptable. * * @deprecated February 2015 for 15.04 release */ QCC_DEPRECATED(const TransportMask TRANSPORT_WWAN) = 0x0008; /**< Wireless wide-area network transport */ /** * Obsolete mask indicating that any transport as long as it is running over the * (non-wireless) local area network -- Ethernet -- is acceptable. * * @deprecated February 2015 for 15.04 release */ QCC_DEPRECATED(const TransportMask TRANSPORT_LAN) = 0x0010; /**< Wired local-area network transport */ /** * Obsolete mask indicating that the Wi-Fi Direct Transport is acceptable. * * @deprecated February 2015 for 15.04 release */ QCC_DEPRECATED(const TransportMask TRANSPORT_WFD) = 0x0080; /**< Transport using Wi-Fi Direct transport (currently unused) */ } #endif alljoyn-15.04b/alljoyn_core/inc/alljoyn/version.h000066400000000000000000000055401255700255500221060ustar00rootroot00000000000000/** * @file * This file provides access to AllJoyn library version and build information. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_VERSION_H #define _ALLJOYN_VERSION_H #include /** Macro to compute the version number into a single value. */ #define GenerateNumericVersionValue(_year, _month, _feature, _bugfix) (((_year) << 24) | ((_month) << 16) | ((_feature) << 8) | (_bugfix)) /** Macro to extract the year from unified version value. */ #define GetVersionYear(_ver) (((_ver) >> 24) & 0xff) /** Macro to extract the month from unified version value. */ #define GetVersionMonth(_ver) (((_ver) >> 16) & 0xff) /** Macro to extract the feature from unified version value. */ #define GetVersionFeature(_ver) (((_ver) >> 8) & 0xff) /** Macro to extract the bugfix from unified version value. */ #define GetVersionBugfix(_ver) (((_ver) >> 0) & 0xff) /** * Macro to compute the version number into a single value. * * @deprecated * * @see GenerateNumericVersionValue() */ #define GenerateVersionValue(_arch, _api, _rel) (((_arch) << 24) | ((_api) << 16) | (_rel)) /** * Macro to extract the architecture level from unified version value. * * @deprecated * * @see GetVersionYear() */ #define GetVersionArch(_ver) (((_ver) >> 24) & 0xff) /** * Macro to extract the API level from unified version value. * * @deprecated * * @see GetVersionMonth() */ #define GetVersionAPILevel(_ver) (((_ver) >> 16) & 0xff) /** * Macro to extract the release from unified version value. * * @deprecated * * @see GetVersionFeature() * @see GetVersionBugfix() */ #define GetVersionRelease(_ver) ((_ver) & 0xffff) namespace ajn { const char* AJ_CALL GetVersion(); /**< Gives the version of AllJoyn Library */ const char* AJ_CALL GetBuildInfo(); /**< Gives build information of AllJoyn Library */ uint32_t AJ_CALL GetNumericVersion(); /**< Gives the version of AllJoyn Library as a single number */ } #endif alljoyn-15.04b/alljoyn_core/router/000077500000000000000000000000001255700255500173435ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/router/.gitignore000066400000000000000000000000101255700255500213220ustar00rootroot00000000000000*.o *.a alljoyn-15.04b/alljoyn_core/router/AllJoynDebugObj.cc000066400000000000000000000172201255700255500226260ustar00rootroot00000000000000/** * @file * BusObject responsible for implementing the AllJoyn methods (org.alljoyn.Debug) * for messages controlling debug output. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ // Include contents in debug builds only. #ifndef NDEBUG #include #include #include #include #include #include #include "AllJoynDebugObj.h" #include "Bus.h" #include "BusController.h" using namespace ajn; using namespace debug; /* * Singleton */ AllJoynDebugObj* AllJoynDebugObj::self = NULL; AllJoynDebugObj* AllJoynDebugObj::GetAllJoynDebugObj() { assert(self && "Invalid access to AllJoynDebugObj; read the comments"); return self; } QStatus AllJoynDebugObj::Init() { QStatus status; /* Make this object implement org.alljoyn.Debug */ const InterfaceDescription* alljoynDbgIntf = busController->GetBus().GetInterface(org::alljoyn::Daemon::Debug::InterfaceName); if (!alljoynDbgIntf) { status = ER_BUS_NO_SUCH_INTERFACE; return status; } status = AddInterface(*alljoynDbgIntf); if (status == ER_OK) { /* Hook up the methods to their handlers */ const MethodEntry methodEntries[] = { { alljoynDbgIntf->GetMember("SetDebugLevel"), static_cast(&AllJoynDebugObj::SetDebugLevel) }, }; status = AddMethodHandlers(methodEntries, ArraySize(methodEntries)); if (status == ER_OK) { status = busController->GetBus().RegisterBusObject(*this); } } return status; } QStatus AllJoynDebugObj::AddDebugInterface(AllJoynDebugObjAddon* addon, const char* ifaceName, const MethodInfo* methodInfo, size_t methodInfoSize, Properties& ifaceProperties) { assert(addon); assert(ifaceName); InterfaceDescription* ifc; MethodEntry* methodEntries = methodInfoSize ? new MethodEntry[methodInfoSize] : NULL; qcc::String ifaceNameStr = ifaceName; busController->GetBus().UnregisterBusObject(*this); QStatus status = busController->GetBus().CreateInterface(ifaceName, ifc); if (status != ER_OK) { goto exit; } for (size_t i = 0; i < methodInfoSize; ++i) { ifc->AddMember(MESSAGE_METHOD_CALL, methodInfo[i].name, methodInfo[i].inputSig, methodInfo[i].outSig, methodInfo[i].argNames, 0); const InterfaceDescription::Member* member = ifc->GetMember(methodInfo[i].name); methodEntries[i].member = member; methodEntries[i].handler = static_cast(&AllJoynDebugObj::GenericMethodHandler); methodHandlerMap[member] = AddonMethodHandler(addon, methodInfo[i].handler); } const AllJoynDebugObj::Properties::Info* propInfo; size_t propInfoSize; ifaceProperties.GetProperyInfo(propInfo, propInfoSize); for (size_t i = 0; i < propInfoSize; ++i) { ifc->AddProperty(propInfo[i].name, propInfo[i].signature, propInfo[i].access); } ifc->Activate(); status = AddInterface(*ifc); if (status != ER_OK) { goto exit; } if (methodEntries) { status = AddMethodHandlers(methodEntries, methodInfoSize); if (status != ER_OK) { goto exit; } } properties.insert(std::pair(ifaceNameStr, &ifaceProperties)); exit: if (methodEntries) { delete[] methodEntries; } return status; } QStatus AllJoynDebugObj::Get(const char* ifcName, const char* propName, MsgArg& val) { PropertyStore::const_iterator it = properties.find(ifcName); if (it == properties.end()) { return ER_BUS_NO_SUCH_PROPERTY; } return it->second->Get(propName, val); } QStatus AllJoynDebugObj::Set(const char* ifcName, const char* propName, MsgArg& val) { QCC_UNUSED(ifcName); PropertyStore::const_iterator it = properties.find(propName); if (it == properties.end()) { return ER_BUS_NO_SUCH_PROPERTY; } return it->second->Set(propName, val); } void AllJoynDebugObj::GetProp(const InterfaceDescription::Member* member, Message& msg) { const qcc::String guid(busController->GetBus().GetInternal().GetGlobalGUID().ToShortString()); qcc::String sender(msg->GetSender()); // Only allow local connections to get properties if (sender.substr(1, guid.size()) == guid) { BusObject::GetProp(member, msg); } // else someone off-device is trying to set our debug output, punish them by not responding. } AllJoynDebugObj::AllJoynDebugObj(BusController* busController) : BusObject(org::alljoyn::Daemon::Debug::ObjectPath), busController(busController) { self = this; } AllJoynDebugObj::~AllJoynDebugObj() { self = NULL; } /** * Need to let the bus contoller know when the registration is complete */ void AllJoynDebugObj::ObjectRegistered() { /* * Must call the base class first. */ BusObject::ObjectRegistered(); busController->ObjectRegistered(this); } /** * Handles the SetDebugLevel method call. * * @param member Member * @param msg The incoming message */ void AllJoynDebugObj::SetDebugLevel(const InterfaceDescription::Member* member, Message& msg) { QCC_UNUSED(member); const qcc::String guid(busController->GetBus().GetInternal().GetGlobalGUID().ToShortString()); qcc::String sender(msg->GetSender()); // Only allow local connections to set the debug level if (sender.substr(1, guid.size()) == guid) { const char* module; uint32_t level; QStatus status = msg->GetArgs("su", &module, &level); if (status == ER_OK) { QCC_SetDebugLevel(module, level); MethodReply(msg, (MsgArg*)NULL, 0); } else { MethodReply(msg, "org.alljoyn.Debug.InternalError", QCC_StatusText(status)); } } // else someone off-device is trying to set our debug output, punish them by not responding. } void AllJoynDebugObj::GenericMethodHandler(const InterfaceDescription::Member* member, Message& msg) { AddonMethodHandlerMap::iterator it = methodHandlerMap.find(member); if (it != methodHandlerMap.end()) { // Call the addon's method handler std::vector replyArgs; QStatus status = (it->second.first->*it->second.second)(msg, replyArgs); if (status == ER_OK) { MethodReply(msg, replyArgs.empty() ? NULL : &replyArgs.front(), replyArgs.size()); } else { MethodReply(msg, "org.alljoyn.Debug.InternalError", "Failure processing method call"); } } else { MethodReply(msg, "org.alljoyn.Debug.InternalError", "Unknown method"); } } #endif //NDEBUG alljoyn-15.04b/alljoyn_core/router/AllJoynDebugObj.h000066400000000000000000000117701255700255500224740ustar00rootroot00000000000000/** * @file * BusObject responsible for implementing the AllJoyn methods (org.alljoyn.Debug) * for messages controlling debug output. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_ALLJOYNDEBUGOBJ_H #define _ALLJOYN_ALLJOYNDEBUGOBJ_H // Include contents in debug builds only. #ifndef NDEBUG #include #include #include #include #include #include #include #include "Bus.h" namespace ajn { class BusController; namespace debug { class AllJoynDebugObjAddon { public: virtual ~AllJoynDebugObjAddon() { } typedef QStatus (AllJoynDebugObjAddon::* MethodHandler)(Message& message, std::vector& replyArgs); }; /** * BusObject responsible for implementing the AllJoyn methods at org.alljoyn.Debug * for messages controlling debug output. */ class AllJoynDebugObj : public BusObject { friend class ajn::BusController; // Only the bus controller can instantiate us. public: class Properties { public: struct Info { const char* name; const char* signature; uint8_t access; }; Properties() { } virtual ~Properties() { } virtual QStatus Get(const char* propName, MsgArg& val) const { QCC_UNUSED(propName); QCC_UNUSED(val); return ER_BUS_NO_SUCH_PROPERTY; } virtual QStatus Set(const char* propName, MsgArg& val) { QCC_UNUSED(propName); QCC_UNUSED(val); return ER_BUS_NO_SUCH_PROPERTY; } virtual void GetProperyInfo(const Info*& info, size_t& infoSize) = 0; }; struct MethodInfo { const char* name; const char* inputSig; const char* outSig; const char* argNames; AllJoynDebugObjAddon::MethodHandler handler; }; private: typedef std::map PropertyStore; typedef std::pair AddonMethodHandler; typedef std::map AddonMethodHandlerMap; public: /* * This object is a quasi-singleton. It gets instantiated and * destroyed by the BusController object. Attempts to get a pointer * when there is no BusController is invalid. */ static AllJoynDebugObj* GetAllJoynDebugObj(); /** * Initialize and register this AllJoynDebugObj instance. * * @return ER_OK if successful. */ QStatus Init(); /** * Stop AlljoynDebugObj. * * @return ER_OK if successful. */ QStatus Stop() { return ER_OK; } /** * Join AlljoynDebugObj. * * @return ER_OK if successful. */ QStatus Join() { return ER_OK; } QStatus AddDebugInterface(AllJoynDebugObjAddon* addon, const char* ifaceName, const MethodInfo* methodInfo, size_t methodInfoSize, Properties& ifaceProperties); QStatus Get(const char* ifcName, const char* propName, MsgArg& val); QStatus Set(const char* ifcName, const char* propName, MsgArg& val); void GetProp(const InterfaceDescription::Member* member, Message& msg); private: /** * Constructor */ AllJoynDebugObj(BusController* busController); /** * Destructor */ ~AllJoynDebugObj(); /** * Need to let the bus contoller know when the registration is complete */ void ObjectRegistered(); /** * Handles the SetDebugLevel method call. * * @param member Member * @param msg The incoming message */ void SetDebugLevel(const InterfaceDescription::Member* member, Message& msg); void GenericMethodHandler(const InterfaceDescription::Member* member, Message& msg); BusController* busController; PropertyStore properties; AddonMethodHandlerMap methodHandlerMap; static AllJoynDebugObj* self; }; } // namespace debug } // namespace ajn #endif #endif alljoyn-15.04b/alljoyn_core/router/AllJoynObj.cc000066400000000000000000007554771255700255500217060ustar00rootroot00000000000000/** * @file * * This file implements the org.alljoyn.Bus and org.alljoyn.Daemon interfaces */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include "DaemonRouter.h" #include "AllJoynObj.h" #include "TransportList.h" #include "SessionInternal.h" #include "BusController.h" #include "VirtualEndpoint.h" #include "EndpointHelper.h" #include "ns/IpNameService.h" #include "AllJoynPeerObj.h" #include "ConfigDB.h" #include "NameTable.h" #define QCC_MODULE "ALLJOYN_OBJ" using namespace std; using namespace qcc; namespace ajn { void* AllJoynObj::NameMapEntry::truthiness = reinterpret_cast(true); int AllJoynObj::JoinSessionThread::jstCount = 0; struct AllJoynObj::PingAlarmContext { enum Type { TRANSPORT_CONTEXT, REPLY_CONTEXT }; Type type; String name; String sender; PingAlarmContext(Type type, String name, String sender = "") : type(type), name(name), sender(sender) { }; }; void AllJoynObj::AcquireLocks() { /* * Locks must be acquired in the following order since tha caller of * this method may already have the name table lock */ router.LockNameTable(); } void AllJoynObj::ReleaseLocks() { router.UnlockNameTable(); } AllJoynObj::AllJoynObj(Bus& bus, BusController* busController, DaemonRouter& router) : BusObject(org::alljoyn::Bus::ObjectPath, false), bus(bus), router(router), foundNameSignal(NULL), lostAdvNameSignal(NULL), sessionLostSignal(NULL), mpSessionChangedSignal(NULL), mpSessionChangedWithReason(NULL), mpSessionJoinedSignal(NULL), guid(bus.GetInternal().GetGlobalGUID()), detachSessionSignal(NULL), timer("NameReaper"), isStopping(false), busController(busController) { } AllJoynObj::~AllJoynObj() { IpNameService::Instance().UnregisterListener(*this); bus.UnregisterBusObject(*this); router.RemoveBusNameListener(this); Stop(); Join(); outgoingPingMap.clear(); incomingPingMap.clear(); } QStatus AllJoynObj::Init() { QStatus status; /* Make this object implement org.alljoyn.Bus */ const InterfaceDescription* alljoynIntf = bus.GetInterface(org::alljoyn::Bus::InterfaceName); if (!alljoynIntf) { status = ER_BUS_NO_SUCH_INTERFACE; QCC_LogError(status, ("Failed to get %s interface", org::alljoyn::Bus::InterfaceName)); return status; } foundNameSignal = alljoynIntf->GetMember("FoundAdvertisedName"); lostAdvNameSignal = alljoynIntf->GetMember("LostAdvertisedName"); sessionLostSignal = alljoynIntf->GetMember("SessionLost"); sessionLostWithReasonSignal = alljoynIntf->GetMember("SessionLostWithReason"); sessionLostWithReasonAndDispositionSignal = alljoynIntf->GetMember("SessionLostWithReasonAndDisposition"); mpSessionChangedSignal = alljoynIntf->GetMember("MPSessionChanged"); mpSessionChangedWithReason = alljoynIntf->GetMember("MPSessionChangedWithReason"); /* Hook up the methods to their handlers */ const MethodEntry methodEntries[] = { { alljoynIntf->GetMember("AdvertiseName"), static_cast(&AllJoynObj::AdvertiseName) }, { alljoynIntf->GetMember("CancelAdvertiseName"), static_cast(&AllJoynObj::CancelAdvertiseName) }, { alljoynIntf->GetMember("FindAdvertisedName"), static_cast(&AllJoynObj::FindAdvertisedName) }, { alljoynIntf->GetMember("FindAdvertisedNameByTransport"), static_cast(&AllJoynObj::FindAdvertisedNameByTransport) }, { alljoynIntf->GetMember("CancelFindAdvertisedName"), static_cast(&AllJoynObj::CancelFindAdvertisedName) }, { alljoynIntf->GetMember("CancelFindAdvertisedNameByTransport"), static_cast(&AllJoynObj::CancelFindAdvertisedNameByTransport) }, { alljoynIntf->GetMember("BindSessionPort"), static_cast(&AllJoynObj::BindSessionPort) }, { alljoynIntf->GetMember("UnbindSessionPort"), static_cast(&AllJoynObj::UnbindSessionPort) }, { alljoynIntf->GetMember("JoinSession"), static_cast(&AllJoynObj::JoinSession) }, { alljoynIntf->GetMember("LeaveSession"), static_cast(&AllJoynObj::LeaveSession) }, { alljoynIntf->GetMember("LeaveHostedSession"), static_cast(&AllJoynObj::LeaveHostedSession) }, { alljoynIntf->GetMember("LeaveJoinedSession"), static_cast(&AllJoynObj::LeaveJoinedSession) }, { alljoynIntf->GetMember("GetSessionFd"), static_cast(&AllJoynObj::GetSessionFd) }, { alljoynIntf->GetMember("SetLinkTimeout"), static_cast(&AllJoynObj::SetLinkTimeout) }, { alljoynIntf->GetMember("AliasUnixUser"), static_cast(&AllJoynObj::AliasUnixUser) }, { alljoynIntf->GetMember("OnAppSuspend"), static_cast(&AllJoynObj::OnAppSuspend) }, { alljoynIntf->GetMember("OnAppResume"), static_cast(&AllJoynObj::OnAppResume) }, { alljoynIntf->GetMember("CancelSessionlessMessage"), static_cast(&AllJoynObj::CancelSessionlessMessage) }, { alljoynIntf->GetMember("RemoveSessionMember"), static_cast(&AllJoynObj::RemoveSessionMember) }, { alljoynIntf->GetMember("GetHostInfo"), static_cast(&AllJoynObj::GetHostInfo) }, { alljoynIntf->GetMember("ReloadConfig"), static_cast(&AllJoynObj::ReloadConfig) }, { alljoynIntf->GetMember("Ping"), static_cast(&AllJoynObj::Ping) }, { alljoynIntf->GetMember("FindAdvertisementByTransport"), static_cast(&AllJoynObj::FindAdvertisementByTransport) }, { alljoynIntf->GetMember("CancelFindAdvertisementByTransport"), static_cast(&AllJoynObj::CancelFindAdvertisementByTransport) }, { alljoynIntf->GetMember("SetIdleTimeouts"), static_cast(&AllJoynObj::SetIdleTimeouts) } }; AddInterface(*alljoynIntf); status = AddMethodHandlers(methodEntries, ArraySize(methodEntries)); if (ER_OK != status) { QCC_LogError(status, ("AddMethods for %s failed", org::alljoyn::Bus::InterfaceName)); } const InterfaceDescription* busSessionIntf = bus.GetInterface(org::alljoyn::Bus::Peer::Session::InterfaceName); if (!busSessionIntf) { status = ER_BUS_NO_SUCH_INTERFACE; QCC_LogError(status, ("Failed to get %s interface", org::alljoyn::Bus::Peer::Session::InterfaceName)); return status; } mpSessionJoinedSignal = busSessionIntf->GetMember("SessionJoined"); /* Make this object implement org.alljoyn.Daemon */ daemonIface = bus.GetInterface(org::alljoyn::Daemon::InterfaceName); if (!daemonIface) { status = ER_BUS_NO_SUCH_INTERFACE; QCC_LogError(status, ("Failed to get %s interface", org::alljoyn::Daemon::InterfaceName)); return status; } detachSessionSignal = daemonIface->GetMember("DetachSession"); assert(detachSessionSignal); /* Hook up the methods to their handlers */ const MethodEntry daemonMethodEntries[] = { { daemonIface->GetMember("AttachSession"), static_cast(&AllJoynObj::AttachSession) }, { daemonIface->GetMember("AttachSessionWithNames"), static_cast(&AllJoynObj::AttachSession) }, { daemonIface->GetMember("GetSessionInfo"), static_cast(&AllJoynObj::GetSessionInfo) } }; AddInterface(*daemonIface); status = AddMethodHandlers(daemonMethodEntries, ArraySize(daemonMethodEntries)); if (ER_OK != status) { QCC_LogError(status, ("AddMethods for %s failed", org::alljoyn::Daemon::InterfaceName)); } /* Register a signal handler for ExchangeNames */ if (ER_OK == status) { status = bus.RegisterSignalHandler(this, static_cast(&AllJoynObj::ExchangeNamesSignalHandler), daemonIface->GetMember("ExchangeNames"), NULL); if (status != ER_OK) { QCC_LogError(status, ("Failed to register ExchangeNamesSignalHandler")); } } /* Register a signal handler for NameChanged bus-to-bus signal */ if (ER_OK == status) { status = bus.RegisterSignalHandler(this, static_cast(&AllJoynObj::NameChangedSignalHandler), daemonIface->GetMember("NameChanged"), NULL); if (status != ER_OK) { QCC_LogError(status, ("Failed to register NameChangedSignalHandler")); } } /* Register a signal handler for DetachSession bus-to-bus signal */ if (ER_OK == status) { status = bus.RegisterSignalHandler(this, static_cast(&AllJoynObj::DetachSessionSignalHandler), daemonIface->GetMember("DetachSession"), NULL); if (status != ER_OK) { QCC_LogError(status, ("Failed to register DetachSessionSignalHandler")); } } /* Register a name table listener */ router.AddBusNameListener(this); /* Register as a listener for all the remote transports */ if (ER_OK == status) { TransportList& transList = bus.GetInternal().GetTransportList(); status = transList.RegisterListener(this); } /* Start the name reaper */ if (ER_OK == status) { status = timer.Start(); } if (ER_OK == status) { status = bus.RegisterBusObject(*this); } IpNameService::Instance().RegisterListener(*this); return status; } QStatus AllJoynObj::Stop() { /* Stop any outstanding JoinSessionThreads */ joinSessionThreadsLock.Lock(MUTEX_CONTEXT); isStopping = true; vector::iterator it = joinSessionThreads.begin(); while (it != joinSessionThreads.end()) { (*it)->Stop(); ++it; } joinSessionThreadsLock.Unlock(MUTEX_CONTEXT); return ER_OK; } QStatus AllJoynObj::Join() { /* Wait for any outstanding JoinSessionThreads */ joinSessionThreadsLock.Lock(MUTEX_CONTEXT); while (!joinSessionThreads.empty()) { joinSessionThreadsLock.Unlock(MUTEX_CONTEXT); qcc::Sleep(50); joinSessionThreadsLock.Lock(MUTEX_CONTEXT); } joinSessionThreadsLock.Unlock(MUTEX_CONTEXT); return ER_OK; } void AllJoynObj::ObjectRegistered(void) { QStatus status; LocalEndpoint localEndpoint = bus.GetInternal().GetLocalEndpoint(); /* Acquire org.alljoyn.Bus name */ uint32_t disposition = DBUS_REQUEST_NAME_REPLY_EXISTS; status = router.AddAlias(org::alljoyn::Bus::WellKnownName, localEndpoint->GetUniqueName(), DBUS_NAME_FLAG_DO_NOT_QUEUE, disposition, NULL, NULL); if ((ER_OK != status) || (DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER != disposition)) { status = (ER_OK == status) ? ER_FAIL : status; QCC_LogError(status, ("Failed to register well-known name \"%s\" (disposition=%d)", org::alljoyn::Bus::WellKnownName, disposition)); } /* Acquire org.alljoyn.Daemon name */ disposition = DBUS_REQUEST_NAME_REPLY_EXISTS; status = router.AddAlias(org::alljoyn::Daemon::WellKnownName, localEndpoint->GetUniqueName(), DBUS_NAME_FLAG_DO_NOT_QUEUE, disposition, NULL, NULL); if ((ER_OK != status) || (DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER != disposition)) { status = (ER_OK == status) ? ER_FAIL : status; QCC_LogError(status, ("Failed to register well-known name \"%s\" (disposition=%d)", org::alljoyn::Daemon::WellKnownName, disposition)); } /* Add a broadcast Rule rule to receive org.alljoyn.Daemon signals */ if (status == ER_OK) { status = bus.AddMatch("type='signal',interface='org.alljoyn.Daemon'"); if (status != ER_OK) { QCC_LogError(status, ("Failed to add match rule for org.alljoyn.Daemon")); } } if (status == ER_OK) { /* Must call base class */ BusObject::ObjectRegistered(); /* Notify parent */ busController->ObjectRegistered(this); } } void AllJoynObj::BindSessionPort(const InterfaceDescription::Member* member, Message& msg) { QCC_UNUSED(member); uint32_t replyCode = ALLJOYN_BINDSESSIONPORT_REPLY_SUCCESS; size_t numArgs; const MsgArg* args; SessionOpts opts; msg->GetArgs(numArgs, args); SessionPort sessionPort = args[0].v_uint16; QStatus status = GetSessionOpts(args[1], opts); /* Get the sender */ String sender = msg->GetSender(); if (status == ER_OK) { BusEndpoint srcEp = FindEndpoint(sender); if (srcEp->IsValid()) { status = TransportPermission::FilterTransports(srcEp, sender, opts.transports, "BindSessionPort"); if (status == ER_OK) { if (PermissionMgr::GetDaemonBusCallPolicy(srcEp) == PermissionMgr::STDBUSCALL_SHOULD_REJECT) { QCC_DbgPrintf(("The sender endpoint is not allowed to call BindSessionPort()")); status = ER_BUS_NOT_ALLOWED; } else if (PermissionMgr::GetDaemonBusCallPolicy(srcEp) == PermissionMgr::STDBUSCALL_ALLOW_ACCESS_SERVICE_LOCAL) { opts.transports &= TRANSPORT_LOCAL; QCC_DbgPrintf(("The sender endpoint is only allowed to use local transport")); } } } else { status = ER_BUS_NO_ENDPOINT; } } if (status != ER_OK) { QCC_DbgTrace(("AllJoynObj::BindSessionPort() from %s", sender.c_str())); replyCode = ALLJOYN_BINDSESSIONPORT_REPLY_FAILED; } else { QCC_DbgTrace(("AllJoynObj::BindSession(%s, %d, %s)", sender.c_str(), sessionPort, opts.ToString().c_str())); /* Validate some Session options */ if ((opts.traffic == SessionOpts::TRAFFIC_RAW_UNRELIABLE) || ((opts.traffic == SessionOpts::TRAFFIC_RAW_RELIABLE) && opts.isMultipoint)) { replyCode = ALLJOYN_BINDSESSIONPORT_REPLY_INVALID_OPTS; } } /* If Binding for a multipoint session, the nameTransfer must be ALL_NAMES or MP_NAMES. * If nameTransfer P2P_NAMES or SLS_NAMES is passed in, change it to MP_NAMES */ if (opts.isMultipoint && ((opts.nameTransfer == SessionOpts::P2P_NAMES) || (opts.nameTransfer == SessionOpts::SLS_NAMES))) { opts.nameTransfer = SessionOpts::MP_NAMES; } /* If Binding for a point-to-point session, the nameTransfer must be ALL_NAMES, P2P_NAMES or SLS_NAMES. * If nameTransfer MP_NAMES is passed in, change it to P2P_NAMES */ if (!opts.isMultipoint && opts.nameTransfer == SessionOpts::MP_NAMES) { opts.nameTransfer = SessionOpts::P2P_NAMES; } /* At least one existing transport must also be capable of doing what is being asked */ if (replyCode == ALLJOYN_BINDSESSIONPORT_REPLY_SUCCESS) { bool supports = false; TransportList& transList = bus.GetInternal().GetTransportList(); for (size_t i = 0; i < transList.GetNumTransports(); ++i) { Transport* trans = transList.GetTransport(i); if (trans && trans->SupportsOptions(opts)) { supports = true; break; } } if (supports == false) { replyCode = ALLJOYN_BINDSESSIONPORT_REPLY_INVALID_OPTS; } } if (replyCode == ALLJOYN_BINDSESSIONPORT_REPLY_SUCCESS) { /* Assign or check uniqueness of sessionPort */ AcquireLocks(); if (sessionPort == SESSION_PORT_ANY) { sessionPort = 9999; while (++sessionPort) { SessionMapType::iterator it = SessionMapLowerBound(sender, 0); while ((it != sessionMap.end()) && (it->first.first == sender)) { if (it->second.sessionPort == sessionPort) { break; } ++it; } /* If no existing sessionMapEntry for sessionPort, then we are done */ if ((it == sessionMap.end()) || (it->first.first != sender)) { break; } } if (sessionPort == 0) { replyCode = ALLJOYN_BINDSESSIONPORT_REPLY_FAILED; } } else { SessionMapType::iterator it = SessionMapLowerBound(sender, 0); while ((it != sessionMap.end()) && (it->first.first == sender) && (it->first.second == 0)) { if (it->second.sessionPort == sessionPort) { replyCode = ALLJOYN_BINDSESSIONPORT_REPLY_ALREADY_EXISTS; break; } ++it; } } if (replyCode == ALLJOYN_BINDSESSIONPORT_REPLY_SUCCESS) { /* Assign a session id and store the session information */ SessionMapEntry entry; entry.sessionHost = sender; entry.sessionPort = sessionPort; entry.endpointName = sender; entry.fd = qcc::INVALID_SOCKET_FD; entry.opts = opts; entry.id = 0; SessionMapInsert(entry); } ReleaseLocks(); } /* Reply to request */ MsgArg replyArgs[2]; replyArgs[0].Set("u", replyCode); replyArgs[1].Set("q", sessionPort); status = MethodReply(msg, replyArgs, ArraySize(replyArgs)); QCC_DbgPrintf(("AllJoynObj::BindSessionPort(%s, %d) returned %d (status=%s)", sender.c_str(), sessionPort, replyCode, QCC_StatusText(status))); /* Log error if reply could not be sent */ if (ER_OK != status) { QCC_LogError(status, ("Failed to respond to org.alljoyn.Bus.BindSessionPort")); } } void AllJoynObj::UnbindSessionPort(const InterfaceDescription::Member* member, Message& msg) { QCC_UNUSED(member); uint32_t replyCode = ALLJOYN_UNBINDSESSIONPORT_REPLY_FAILED; size_t numArgs; const MsgArg* args; SessionOpts opts; msg->GetArgs(numArgs, args); SessionPort sessionPort = args[0].v_uint16; QCC_DbgTrace(("AllJoynObj::UnbindSession(%d)", sessionPort)); /* Remove session map entry */ String sender = msg->GetSender(); AcquireLocks(); SessionMapType::iterator it = SessionMapLowerBound(sender, 0); while ((it != sessionMap.end()) && (it->first.first == sender) && (it->first.second == 0)) { if (it->second.sessionPort == sessionPort) { sessionMap.erase(it); replyCode = ALLJOYN_UNBINDSESSIONPORT_REPLY_SUCCESS; break; } ++it; } ReleaseLocks(); /* Reply to request */ MsgArg replyArgs[1]; replyArgs[0].Set("u", replyCode); QStatus status = MethodReply(msg, replyArgs, ArraySize(replyArgs)); QCC_DbgPrintf(("AllJoynObj::UnbindSessionPort(%s, %d) returned %d (status=%s)", sender.c_str(), sessionPort, replyCode, QCC_StatusText(status))); /* Log error if reply could not be sent */ if (ER_OK != status) { QCC_LogError(status, ("Failed to respond to org.alljoyn.Bus.UnbindSessionPort")); } } ThreadReturn STDCALL AllJoynObj::JoinSessionThread::Run(void* arg) { QCC_UNUSED(arg); if (isJoin) { QCC_DbgTrace(("JoinSessionThread::RunJoin()")); return RunJoin(); } else { QCC_DbgTrace(("JoinSessionThread::RunAttach()")); return RunAttach(); } } bool AllJoynObj::IsSelfJoinSupported(BusEndpoint& joinerEp) const { if (joinerEp->GetEndpointType() == ENDPOINT_TYPE_NULL) { return true; } if (joinerEp->GetEndpointType() == ENDPOINT_TYPE_REMOTE) { RemoteEndpoint rep = RemoteEndpoint::cast(joinerEp); /* self-join is only supported from protocol version 11 and higher */ if (rep->GetRemoteProtocolVersion() >= 11) { return true; } } return false; } QStatus AllJoynObj::JoinSessionThread::Reply(uint32_t replyCode, SessionId id, SessionOpts optsOut) { /* Reply to request */ MsgArg replyArgs[3]; replyArgs[0].Set("u", replyCode); replyArgs[1].Set("u", id); SetSessionOpts(optsOut, replyArgs[2]); QStatus status = ajObj.MethodReply(msg, replyArgs, ArraySize(replyArgs)); QCC_DbgPrintf(("JoinSessionThread::RunJoin(): JoinSession returned (%d,%u) (status=%s)", replyCode, id, QCC_StatusText(status))); return status; } ThreadReturn STDCALL AllJoynObj::JoinSessionThread::RunJoin() { QCC_DbgTrace(("JoinSessionThread::RunJoin()")); uint32_t replyCode = ALLJOYN_JOINSESSION_REPLY_SUCCESS; SessionId id = 0; SessionOpts optsOut(SessionOpts::TRAFFIC_MESSAGES, false, SessionOpts::PROXIMITY_ANY, 0); size_t numArgs; const MsgArg* args; SessionMapEntry sme; String sender = msg->GetSender(); RemoteEndpoint b2bEp; BusEndpoint joinerEp = ajObj.FindEndpoint(sender); QCC_DbgPrintf(("JoinSessionThread::RunJoin(): joinerEp=\"%s\"", joinerEp->GetUniqueName().c_str())); /* Parse the message args */ msg->GetArgs(numArgs, args); const char* sessionHost = NULL; SessionPort sessionPort; SessionOpts optsIn; QStatus status = MsgArg::Get(args, 2, "sq", &sessionHost, &sessionPort); BusEndpoint rSessionEp; bool isSelfJoin = false; if (status == ER_OK) { status = GetSessionOpts(args[2], optsIn); QCC_DbgPrintf(("JoinSessionThread::RunJoin(): optsIn=\"%s\"", optsIn.ToString().c_str())); } if (status == ER_OK) { BusEndpoint srcEp = ajObj.FindEndpoint(sender); QCC_DbgPrintf(("JoinSessionThread::RunJoin(): srcEp=\"%s\"", srcEp->GetUniqueName().c_str())); if (srcEp->IsValid()) { status = TransportPermission::FilterTransports(srcEp, sender, optsIn.transports, "JoinSessionThread.Run"); } } if (status == ER_OK) { PermissionMgr::DaemonBusCallPolicy policy = PermissionMgr::GetDaemonBusCallPolicy(joinerEp); bool rejectCall = false; if (policy == PermissionMgr::STDBUSCALL_SHOULD_REJECT) { rejectCall = true; } else if (policy == PermissionMgr::STDBUSCALL_ALLOW_ACCESS_SERVICE_LOCAL) { optsIn.transports &= TRANSPORT_LOCAL; QCC_DbgPrintf(("JoinSessionThread::RunJoin(): The sender endpoint is only allowed to use local transport.")); } if (rejectCall) { QCC_DbgPrintf(("JoinSessionThread::RunJoin(): The sender endpoint is not allowed to call JoinSession()")); replyCode = ALLJOYN_JOINSESSION_REPLY_REJECTED; /* Reply to request */ status = Reply(replyCode, id, optsOut); return 0; } } ajObj.AcquireLocks(); BusEndpoint hostEp = ajObj.FindEndpoint(sessionHost); if (hostEp->IsValid()) { SessionMapType::iterator it = ajObj.SessionMapLowerBound(sender, 0); while ((it != ajObj.sessionMap.end()) && (it->first.first == sender) && (it->first.second == 0)) { if (ajObj.FindEndpoint(it->second.sessionHost) == hostEp) { QCC_DbgPrintf(("JoinSessionThread::RunJoin(): self-join!")); isSelfJoin = true; break; } ++it; } } if (ajObj.IsSelfJoinSupported(joinerEp) == false && isSelfJoin == true) { /* Do not let a session creator join itself */ replyCode = ALLJOYN_JOINSESSION_REPLY_ALREADY_JOINED; } if (status != ER_OK) { if (replyCode == ALLJOYN_JOINSESSION_REPLY_SUCCESS) { replyCode = ALLJOYN_JOINSESSION_REPLY_FAILED; QCC_DbgPrintf(("JoinSessionThread::RunJoin(): bad args")); } } else if (replyCode == ALLJOYN_JOINSESSION_REPLY_SUCCESS) { QCC_DbgPrintf(("JoinSessionThread::RunJoin() sessionPort=%d, opts=<%u, 0x%x, 0x%x>)", sessionPort, optsIn.traffic, optsIn.proximity, optsIn.transports)); /* Decide how to proceed based on the session endpoint existence/type */ VirtualEndpoint vSessionEp; assert(sessionHost); QCC_DbgPrintf(("JoinSessionThread::RunJoin(): sessionHost=\"%s\"", sessionHost)); BusEndpoint ep = ajObj.FindEndpoint(sessionHost); if (ep->GetEndpointType() == ENDPOINT_TYPE_VIRTUAL) { vSessionEp = VirtualEndpoint::cast(ep); QCC_DbgPrintf(("JoinSessionThread::RunJoin(): vSessionEp=\"%s\"", sessionHost)); } else if ((ep->GetEndpointType() == ENDPOINT_TYPE_REMOTE) || (ep->GetEndpointType() == ENDPOINT_TYPE_NULL) || (ep->GetEndpointType() == ENDPOINT_TYPE_LOCAL)) { rSessionEp = ep; QCC_DbgPrintf(("JoinSessionThread::RunJoin(): rSessionEp=\"%s\"", rSessionEp->GetUniqueName().c_str())); } if (rSessionEp->IsValid()) { QCC_DbgPrintf(("JoinSessionThread::RunJoin(): session is with another locally connected attachment")); /* Find creator in session map */ String creatorName = rSessionEp->GetUniqueName(); QCC_DbgPrintf(("JoinSessionThread::RunJoin(): creatorName=\"%s\"", creatorName.c_str())); bool foundSessionMapEntry = false; SessionMapType::iterator sit = ajObj.SessionMapLowerBound(creatorName, 0); while ((sit != ajObj.sessionMap.end()) && (creatorName == sit->first.first)) { if ((sit->second.sessionHost == creatorName) && (sit->second.sessionPort == sessionPort)) { QCC_DbgPrintf(("JoinSessionThread::RunJoin(): found \"%s\" in sessionMap with expected port %d.", creatorName.c_str(), sessionPort)); if (sit->first.second == 0) { sme = sit->second; foundSessionMapEntry = true; if (!sme.opts.isMultipoint) { break; } } else { /* Check if this joiner has already joined and reject in that case */ vector::iterator mit = sit->second.memberNames.begin(); while (mit != sit->second.memberNames.end()) { if (*mit == sender) { QCC_DbgPrintf(("JoinSessionThread::RunJoin(): joiner already joined")); foundSessionMapEntry = false; replyCode = ALLJOYN_JOINSESSION_REPLY_ALREADY_JOINED; break; } ++mit; } sme = sit->second; } } ++sit; } if (joinerEp->IsValid() && foundSessionMapEntry) { bool isAccepted = false; SessionId newSessionId = sme.id; if (!sme.opts.IsCompatible(optsIn)) { replyCode = ALLJOYN_JOINSESSION_REPLY_BAD_SESSION_OPTS; } else { /* Create a new sessionId if needed */ while (newSessionId == 0) { newSessionId = qcc::Rand32(); } QCC_DbgPrintf(("JoinSessionThread::RunJoin(): newsessinoId=%d.", newSessionId)); /* Add an entry to sessionMap here (before sending accept session) since accept session * may trigger a call to GetSessionFd or LeaveSession which must be aware of the new session's * existence in order to complete successfully. */ bool hasSessionMapPlaceholder = false; sme.id = newSessionId; if (!ajObj.SessionMapFind(sme.endpointName, sme.id)) { /* Set isInitializing to true, to ensure that this entry is not deleted * while the join session is in progress */ sme.isInitializing = true; ajObj.SessionMapInsert(sme); hasSessionMapPlaceholder = true; } /* Ask creator to accept session */ ajObj.ReleaseLocks(); QCC_DbgPrintf(("JoinSessionThread::RunJoin(): SendAcceptSession()")); status = ajObj.SendAcceptSession(sme.sessionPort, newSessionId, sessionHost, sender.c_str(), optsIn, isAccepted); if (status != ER_OK) { QCC_LogError(status, ("SendAcceptSession failed")); replyCode = ALLJOYN_JOINSESSION_REPLY_FAILED; } ajObj.AcquireLocks(); /* Check the session didn't go away during the join attempt */ if (!joinerEp->IsValid()) { replyCode = ALLJOYN_JOINSESSION_REPLY_FAILED; QCC_LogError(ER_FAIL, ("Joiner %s disappeared while joining", sender.c_str())); } /* Cleanup failed raw session entry in sessionMap */ if (hasSessionMapPlaceholder && ((status != ER_OK) || !isAccepted)) { ajObj.SessionMapErase(sme); } } if (replyCode == ALLJOYN_JOINSESSION_REPLY_SUCCESS) { if (!isAccepted) { QCC_DbgPrintf(("JoinSessionThread::RunJoin(): Join session request rejected")); replyCode = ALLJOYN_JOINSESSION_REPLY_REJECTED; } else if (sme.opts.traffic == SessionOpts::TRAFFIC_MESSAGES) { QCC_DbgPrintf(("JoinSessionThread::RunJoin(): Join session request accepted")); /* setup the forward and reverse routes through the local daemon */ RemoteEndpoint tEp; status = ajObj.AddSessionRoute(newSessionId, joinerEp, NULL, rSessionEp, tEp); if (status != ER_OK) { replyCode = ALLJOYN_JOINSESSION_REPLY_FAILED; QCC_LogError(status, ("AddSessionRoute(%u, %s, NULL, %s, tEp) failed", newSessionId, sender.c_str(), rSessionEp->GetUniqueName().c_str())); } if (status == ER_OK) { QCC_DbgPrintf(("JoinSessionThread::RunJoin(): Add local joiner to member list")); /* Add (local) joiner to list of session members since no AttachSession will be sent */ SessionMapEntry* smEntry = ajObj.SessionMapFind(sme.endpointName, newSessionId); if (smEntry) { smEntry->memberNames.push_back(sender); smEntry->isInitializing = false; sme = *smEntry; } else { replyCode = ALLJOYN_JOINSESSION_REPLY_FAILED; status = ER_FAIL; QCC_LogError(status, ("Failed to find sessionMap entry")); } /* Create a joiner side entry in sessionMap */ if (!isSelfJoin) { SessionMapEntry joinerSme = sme; joinerSme.endpointName = sender; joinerSme.id = newSessionId; ajObj.SessionMapInsert(joinerSme); id = joinerSme.id; } else { id = newSessionId; } optsOut = sme.opts; optsOut.transports &= optsIn.transports; sme.id = newSessionId; } } else if ((sme.opts.traffic != SessionOpts::TRAFFIC_MESSAGES) && !sme.opts.isMultipoint) { QCC_DbgPrintf(("JoinSessionThread::RunJoin(): Raw socket")); /* Create a raw socket pair for the two local session participants */ SocketFd fds[2]; status = SocketPair(fds); if (status == ER_OK) { /* Update the creator-side entry in sessionMap */ SessionMapEntry* smEntry = ajObj.SessionMapFind(sme.endpointName, sme.id); if (smEntry) { smEntry->fd = fds[0]; smEntry->memberNames.push_back(sender); /* Create a joiner side entry in sessionMap */ if (!isSelfJoin) { SessionMapEntry sme2 = sme; sme2.memberNames.push_back(sender); sme2.endpointName = sender; sme2.fd = fds[1]; ajObj.SessionMapInsert(sme2); id = sme2.id; } else { id = sme.id; } optsOut = sme.opts; optsOut.transports &= optsIn.transports; } else { qcc::Close(fds[0]); qcc::Close(fds[1]); status = ER_FAIL; QCC_LogError(status, ("Failed to find sessionMap entry")); replyCode = ALLJOYN_JOINSESSION_REPLY_FAILED; } } else { QCC_LogError(status, ("SocketPair failed")); replyCode = ALLJOYN_JOINSESSION_REPLY_FAILED; } } else { /* QosInfo::TRAFFIC_RAW_UNRELIABLE is not currently supported */ replyCode = ALLJOYN_JOINSESSION_REPLY_BAD_SESSION_OPTS; } } } else { if (replyCode == ALLJOYN_JOINSESSION_REPLY_SUCCESS) { replyCode = ALLJOYN_JOINSESSION_REPLY_NO_SESSION; } } } else { QCC_DbgPrintf(("JoinSessionThread::RunJoin(): session is with a remote attachment")); /* Session is with a connected or unconnected remote device */ /* * Step 1: get a b2bEp to the session host. */ /* Check for an existing multipoint session. */ if (vSessionEp->IsValid()) { QCC_DbgPrintf(("JoinSessionThread::RunJoin(): Existing virtual endpoint IsValid() and isMultipoint")); SessionMapType::iterator it = ajObj.sessionMap.begin(); while (it != ajObj.sessionMap.end()) { if ((it->second.sessionHost == vSessionEp->GetUniqueName()) && (it->second.sessionPort == sessionPort)) { if (it->second.opts.IsCompatible(optsIn)) { if (it->second.opts.isMultipoint) { b2bEp = vSessionEp->GetBusToBusEndpoint(it->second.id); if (b2bEp->IsValid()) { QCC_DbgPrintf(("JoinSessionThread::RunJoin(): IncrementRef() on existing mp session")); b2bEp->IncrementRef(); replyCode = ALLJOYN_JOINSESSION_REPLY_SUCCESS; } } } else { QCC_DbgPrintf(("JoinSessionThread::RunJoin(): Blocked multiple connections to same dest with same session ID")); /* Cannot support more than one connection to the same destination with the same sessionId */ replyCode = ALLJOYN_JOINSESSION_REPLY_BAD_SESSION_OPTS; } break; } ++it; } } /* * Collect busAddrs of session host if there is no existing * multipoint session. */ vector busAddrs; if (!b2bEp->IsValid()) { GetBusAddrsFromAdvertisements(sessionHost, optsIn, busAddrs); if (busAddrs.empty()) { /* * If still no busAddrs and we are connected to the session * host, then ask it directly for the busAddr. */ ajObj.ReleaseLocks(); GetBusAddrsFromSession(sessionHost, sessionPort, optsIn, busAddrs); ajObj.AcquireLocks(); } if (busAddrs.empty()) { QCC_DbgPrintf(("JoinSessionThread::RunJoin(): No advertisement. No existing route. Nothing we can do.")); /* No advertisment or existing route to session creator */ replyCode = ALLJOYN_JOINSESSION_REPLY_NO_SESSION; } else { QCC_DbgPrintf(("JoinSessionThread::RunJoin(): Have busaddrs to try.")); } } vector::const_iterator bit = busAddrs.begin(); do { /* * Use the b2bEp to the session host or try the busAddrs in priority * order until a connect succeeds. */ String busAddr; TransportMask transport = optsIn.transports; if (bit != busAddrs.end()) { ajObj.ReleaseLocks(); QCC_DbgPrintf(("JoinSessionThread::RunJoin(): Trying busaddr=\"%s\"", bit->c_str())); b2bEp = ConnectBusToBusEndpoint(*bit, optsIn, transport, replyCode); if (replyCode == ALLJOYN_JOINSESSION_REPLY_SUCCESS) { busAddr = *bit; } ajObj.AcquireLocks(); ++bit; } if (!b2bEp->IsValid()) { replyCode = ALLJOYN_JOINSESSION_REPLY_FAILED; } else if (b2bEp->GetRemoteProtocolVersion() < 12) { /* * Step 2: Wait for the new b2b endpoint to have a virtual ep for nextController * only while interacting with a remote routing node with protocol version < 12. */ QCC_DbgPrintf(("JoinSessionThread::RunJoin(): Wait for virtual endpoint.")); uint64_t startTime = GetTimestamp64(); while (replyCode == ALLJOYN_JOINSESSION_REPLY_SUCCESS) { /* Do we route through b2bEp? If so, we're done */ if (!b2bEp->IsValid()) { QCC_LogError(ER_FAIL, ("B2B endpoint %s disappeared during JoinSession", b2bEp->GetUniqueName().c_str())); replyCode = ALLJOYN_JOINSESSION_REPLY_FAILED; break; } QCC_DbgPrintf(("JoinSessionThread::RunJoin(): Remote name of new b2b endpoint is \"%s\"", b2bEp->GetRemoteName().c_str())); VirtualEndpoint vep; if (ajObj.FindEndpoint(b2bEp->GetRemoteName(), vep) && vep->CanUseRoute(b2bEp)) { QCC_DbgPrintf(("JoinSessionThread::RunJoin(): Found virtual endpoint for route")); /* Got a virtual endpoint we can route through */ break; } /* Otherwise wait */ uint64_t now = GetTimestamp64(); if (now > (startTime + 30000LL)) { replyCode = ALLJOYN_JOINSESSION_REPLY_FAILED; QCC_DbgPrintf(("JoinSession timed out waiting for %s to appear on %s", sessionHost, b2bEp->GetUniqueName().c_str())); break; } /* Give up the locks while waiting */ ajObj.ReleaseLocks(); QCC_DbgPrintf(("JoinSessionThread::RunJoin(): Sleep")); qcc::Sleep(10); ajObj.AcquireLocks(); } } /* * Step 3: Send a session attach. */ MsgArg membersArg; if (replyCode == ALLJOYN_JOINSESSION_REPLY_SUCCESS) { const String nextControllerName = b2bEp->GetRemoteName(); QCC_DbgPrintf(("JoinSessionThread::RunJoin(): SendAttachSession()")); ajObj.ReleaseLocks(); SessionOpts opts = optsIn; opts.transports = transport; status = ajObj.SendAttachSession(sessionPort, sender.c_str(), sessionHost, sessionHost, b2bEp, nextControllerName.c_str(), 0, busAddr.c_str(), optsIn.nameTransfer, JOINER, opts, replyCode, id, optsOut, membersArg); if (status != ER_OK) { QCC_LogError(status, ("AttachSession to %s failed", nextControllerName.c_str())); replyCode = ALLJOYN_JOINSESSION_REPLY_FAILED; } /* Re-acquire locks */ ajObj.AcquireLocks(); QCC_DbgPrintf(("JoinSessionThread::RunJoin(): FindEndpoint(\"%s\")", sessionHost)); ajObj.FindEndpoint(sessionHost, vSessionEp); if (!vSessionEp->IsValid()) { replyCode = ALLJOYN_JOINSESSION_REPLY_FAILED; QCC_LogError(ER_BUS_NO_ENDPOINT, ("SessionHost endpoint (%s) not found", sessionHost)); } } /* If session was successful, Add two-way session routes to the table */ if (replyCode == ALLJOYN_JOINSESSION_REPLY_SUCCESS) { QCC_DbgPrintf(("JoinSessionThread::RunJoin(): Attach session success(\"%s\")", sessionHost)); if (joinerEp->IsValid() && b2bEp->IsValid()) { BusEndpoint busEndpoint = BusEndpoint::cast(vSessionEp); QCC_DbgPrintf(("JoinSessionThread::RunJoin(): AddSessionRoute() for session ID %d.", id)); status = ajObj.AddSessionRoute(id, joinerEp, NULL, busEndpoint, b2bEp); if (status != ER_OK) { replyCode = ALLJOYN_JOINSESSION_REPLY_FAILED; QCC_LogError(status, ("AddSessionRoute(%u, %s, NULL, %s, %s) failed", id, sender.c_str(), vSessionEp->GetUniqueName().c_str(), b2bEp->GetUniqueName().c_str())); } } else { replyCode = ALLJOYN_JOINSESSION_REPLY_FAILED; QCC_LogError(ER_BUS_NO_ENDPOINT, ("Cannot find joiner endpoint %s", sender.c_str())); } } /* Create session map entry */ bool sessionMapEntryCreated = false; if (replyCode == ALLJOYN_JOINSESSION_REPLY_SUCCESS) { QCC_DbgPrintf(("JoinSessionThread::RunJoin(): Add session map entry for sender=\"%s\", id=%d., sessionHost=\"%s\", sessionPort=%d.", sender.c_str(), id, vSessionEp->GetUniqueName().c_str(), sessionPort)); const MsgArg* sessionMembers; size_t numSessionMembers = 0; membersArg.Get("as", &numSessionMembers, &sessionMembers); sme.endpointName = sender; sme.id = id; sme.sessionHost = vSessionEp->GetUniqueName(); sme.sessionPort = sessionPort; sme.opts = optsOut; for (size_t i = 0; i < numSessionMembers; ++i) { sme.memberNames.push_back(sessionMembers[i].v_string.str); } ajObj.SessionMapInsert(sme); sessionMapEntryCreated = true; } /* If a raw sesssion was requested, then teardown the new b2bEp to use it for a raw stream */ if ((replyCode == ALLJOYN_JOINSESSION_REPLY_SUCCESS) && (optsOut.traffic != SessionOpts::TRAFFIC_MESSAGES)) { QCC_DbgPrintf(("JoinSessionThread::RunJoin(): Raw session. Tear down new endpoint")); SessionMapEntry* smEntry = ajObj.SessionMapFind(sender, id); if (smEntry) { ajObj.ReleaseLocks(); status = ajObj.ShutdownEndpoint(b2bEp, smEntry->fd); ajObj.AcquireLocks(); smEntry = ajObj.SessionMapFind(sender, id); if (smEntry) { smEntry->isRawReady = true; } else { status = ER_FAIL; QCC_LogError(status, ("Failed to find SessionMapEntry")); } if (status != ER_OK) { QCC_LogError(status, ("Failed to shutdown remote endpoint for raw usage")); replyCode = ALLJOYN_JOINSESSION_REPLY_FAILED; } } else { QCC_LogError(ER_FAIL, ("Failed to find session id=%u for %s, %d", id, sender.c_str(), id)); replyCode = ALLJOYN_JOINSESSION_REPLY_FAILED; } } /* If session was unsuccessful, cleanup sessionMap */ if (sessionMapEntryCreated && (replyCode != ALLJOYN_JOINSESSION_REPLY_SUCCESS)) { ajObj.SessionMapErase(sme); } /* Cleanup b2bEp if its ref hasn't been incremented */ if (b2bEp->IsValid()) { b2bEp->DecrementRef(); } } while ((replyCode != ALLJOYN_JOINSESSION_REPLY_SUCCESS) && (bit != busAddrs.end())); } } /* Send AttachSession to all other members of the multicast session */ if ((replyCode == ALLJOYN_JOINSESSION_REPLY_SUCCESS) && sme.opts.isMultipoint && sme.sessionHost != sender /* test if we now just selfjoined */) { QCC_DbgPrintf(("JoinSessionThread::RunJoin(): Multicast session joined.")); for (size_t i = 0; i < sme.memberNames.size(); ++i) { const String& member = sme.memberNames[i]; /* Skip this joiner since it is attached already */ if (member == sender || member == sme.sessionHost) { continue; } QCC_DbgPrintf(("JoinSessionThread::RunJoin(): Member \"%s\"", sme.memberNames[i].c_str())); BusEndpoint memberEp = ajObj.FindEndpoint(member); RemoteEndpoint memberB2BEp; if (memberEp->GetEndpointType() == ENDPOINT_TYPE_VIRTUAL) { QCC_DbgPrintf(("JoinSessionThread::RunJoin(): Member \"%s\" is virtual", sme.memberNames[i].c_str())); /* Endpoint is not served directly by this daemon so forward the attach using existing b2bEp connection with session creator */ if (!b2bEp->IsValid()) { VirtualEndpoint vMemberEp = VirtualEndpoint::cast(memberEp); /* Local session creator */ memberB2BEp = vMemberEp->GetBusToBusEndpoint(id); } else { /* Remote session creator */ memberB2BEp = b2bEp; } if (memberB2BEp->IsValid()) { MsgArg tMembersArg; SessionId tId; SessionOpts tOpts; const String nextControllerName = memberB2BEp->GetRemoteName(); uint32_t tReplyCode; ajObj.ReleaseLocks(); /* * This is a joiner-to-joiner attach. We presume that any * joiners must have already negotiated transport mask with * the session host. TRANSPORT_ANY is appropriate here * since it really means join ANY transport previously * okayed by the session host. This enables multipoint * sessions with heterogeneous transports explicity set at * the joiner -- i.e., one joiner can use TRANSPORT_TCP and * another can use TRANSPORT_UDP if the host binds with * TRANSPORT_TCP | TRANSPORT_UDP. */ sme.opts.transports = TRANSPORT_ANY; QCC_DbgPrintf(("JoinSessionThread::RunJoin(): SendAttachSession()")); status = ajObj.SendAttachSession(sessionPort, sender.c_str(), sessionHost, member.c_str(), memberB2BEp, nextControllerName.c_str(), id, "", sme.opts.nameTransfer, JOINER, sme.opts, tReplyCode, tId, tOpts, tMembersArg); ajObj.AcquireLocks(); if (status != ER_OK) { QCC_LogError(status, ("Failed to attach session %u to %s", id, member.c_str())); } else if (tReplyCode != ALLJOYN_JOINSESSION_REPLY_SUCCESS) { status = ER_FAIL; QCC_LogError(status, ("Failed to attach session %u to %s (reply=%d)", id, member.c_str(), tReplyCode)); } else if (id != tId) { status = ER_FAIL; QCC_LogError(status, ("Session id mismatch (expected=%u, actual=%u)", id, tId)); } else if (!joinerEp->IsValid() || !memberB2BEp->IsValid() || !memberB2BEp->IsValid()) { status = ER_FAIL; QCC_LogError(status, ("joiner, memberEp or memberB2BEp disappeared during join")); } } else { status = ER_BUS_BAD_SESSION_OPTS; QCC_LogError(status, ("Unable to add existing member %s to session %u", memberEp->GetUniqueName().c_str(), id)); } } else if (memberEp->IsValid()) { QCC_DbgPrintf(("JoinSessionThread::RunJoin(): Local (non-virtual) endpoint")); /* Add joiner to any local member's sessionMap entry since no AttachSession is sent */ SessionMapEntry* smEntry = ajObj.SessionMapFind(member, id); if (smEntry) { smEntry->memberNames.push_back(sender); } /* Multipoint session member is local to this daemon. Send MPSessionChanged */ if (optsOut.isMultipoint) { QCC_DbgPrintf(("JoinSessionThread::RunJoin(): Local (non-virtual) MPSessionChanged")); ajObj.ReleaseLocks(); ajObj.SendMPSessionChanged(id, sender.c_str(), true, member.c_str(), ALLJOYN_MPSESSIONCHANGED_REMOTE_MEMBER_ADDED); ajObj.AcquireLocks(); } } /* Add session routing */ if (memberEp->IsValid() && joinerEp->IsValid() && (status == ER_OK)) { QCC_DbgPrintf(("JoinSessionThread::RunJoin(): AddSessionRoute()")); status = ajObj.AddSessionRoute(id, joinerEp, NULL, memberEp, memberB2BEp); if (status != ER_OK) { QCC_LogError(status, ("AddSessionRoute(%u, %s, NULL, %s, %s) failed", id, sender.c_str(), memberEp->GetUniqueName().c_str(), memberB2BEp->GetUniqueName().c_str())); } } } } /* Set the name transfer for the bus-to-bus endpoint */ if (b2bEp->IsValid()) { b2bEp->GetFeatures().nameTransfer = optsOut.nameTransfer; } ajObj.ReleaseLocks(); QCC_DbgPrintf(("JoinSessionThread::RunJoin(): Reply to request")); /* Reply to request */ status = Reply(replyCode, id, optsOut); /* Log error if reply could not be sent */ if (ER_OK != status) { QCC_LogError(status, ("Failed to respond to org.alljoyn.Bus.JoinSession")); } /* Send SessionJoined to creator if creator is local since RunAttach does not run in this case */ if ((status == ER_OK) && (replyCode == ALLJOYN_JOINSESSION_REPLY_SUCCESS) && rSessionEp->IsValid()) { QCC_DbgPrintf(("JoinSessionThread::RunJoin(): SendSessionJoined() to local endpoint")); ajObj.SendSessionJoined(sme.sessionPort, sme.id, sender.c_str(), sme.endpointName.c_str()); /* If session is multipoint, send MPSessionChanged to sessionHost */ if (sme.opts.isMultipoint) { ajObj.SendMPSessionChanged(sme.id, sender.c_str(), true, sme.endpointName.c_str(), ALLJOYN_MPSESSIONCHANGED_REMOTE_MEMBER_ADDED); } } /* Send a series of MPSessionChanged to "catch up" the new joiner */ if ((replyCode == ALLJOYN_JOINSESSION_REPLY_SUCCESS) && optsOut.isMultipoint) { QCC_DbgPrintf(("JoinSessionThread::RunJoin(): SendMPSessionChanged() series to local endpoint")); ajObj.AcquireLocks(); SessionMapEntry* smEntry = ajObj.SessionMapFind(sender, id); if (smEntry) { String sessionHost = smEntry->sessionHost; vector memberVector = smEntry->memberNames; ajObj.ReleaseLocks(); /* Already sent MPSessionChanged to session creator, so skip it here if sessionHost (aka session creator) is equal to the sender. */ if (!isSelfJoin) { ajObj.SendMPSessionChanged(id, sessionHost.c_str(), true, sender.c_str(), ALLJOYN_MPSESSIONCHANGED_LOCAL_MEMBER_ADDED); } vector::const_iterator mit = memberVector.begin(); while (mit != memberVector.end()) { if (sender != *mit && sessionHost != *mit) { ajObj.SendMPSessionChanged(id, mit->c_str(), true, sender.c_str(), ALLJOYN_MPSESSIONCHANGED_LOCAL_MEMBER_ADDED); } mit++; } } else { ajObj.ReleaseLocks(); } } return 0; } void AllJoynObj::JoinSessionThread::GetBusAddrsFromAdvertisements(const char* sessionHost, const SessionOpts& optsIn, std::vector& busAddrs) { /* Look for busAddr from advertisements first */ QCC_DbgPrintf(("JoinSessionThread::RunJoin(): Look for busaddr corresponding to sessionHost")); set advertisements; multimap::iterator nmit = ajObj.nameMap.lower_bound(sessionHost); while (nmit != ajObj.nameMap.end() && (nmit->first == sessionHost)) { if (nmit->second.transport & optsIn.transports) { QCC_DbgPrintf(("JoinSessionThread::RunJoin(): Found busaddr in name map: \"%s\"", nmit->second.busAddr.c_str())); JoinSessionEntry joinSessionEntry(nmit->first, nmit->second.transport, nmit->second.busAddr); advertisements.insert(joinSessionEntry); } ++nmit; } set::iterator sit = advertisements.begin(); while (sit != advertisements.end()) { busAddrs.push_back((*sit).busAddr); sit++; } /* If no busAddrs, see if any exist in the adv alias map */ if (busAddrs.empty() && (sessionHost[0] == ':')) { QCC_DbgPrintf(("JoinSessionThread::RunJoin(): look for busaddr in adv alias map")); String rguidStr = String(sessionHost).substr(1, GUID128::SIZE_SHORT); map >::iterator ait = ajObj.advAliasMap.find(rguidStr); if (ait != ajObj.advAliasMap.end()) { set::iterator bit = ait->second.begin(); while ((bit != ait->second.end())) { if (((*bit).transport & optsIn.transports) != 0) { multimap::iterator nmit2 = ajObj.nameMap.lower_bound((*bit).name); while (nmit2 != ajObj.nameMap.end() && (nmit2->first == (*bit).name)) { if ((nmit2->second.transport & (*bit).transport & optsIn.transports) != 0) { QCC_DbgPrintf(("JoinSessionThread::RunJoin(): Found busaddr in adv alias map: \"%s\"", nmit2->second.busAddr.c_str())); busAddrs.push_back(nmit2->second.busAddr); } ++nmit2; } } ++bit; } } } } void AllJoynObj::JoinSessionThread::GetBusAddrsFromSession(const char* sessionHost, SessionPort sessionPort, const SessionOpts& optsIn, std::vector& busAddrs) { QCC_DbgPrintf(("JoinSessionThread::RunJoin(): no busaddr. SendGetSessionInfo() directly.")); QStatus status = ER_BUS_NO_ENDPOINT; BusEndpoint hostEp = ajObj.FindEndpoint(sessionHost); if (hostEp->IsValid()) { /* Send GetSessionInfo to session host */ Message reply(ajObj.bus); MsgArg sendArgs[3]; sendArgs[0].Set("s", sessionHost); sendArgs[1].Set("q", sessionPort); SetSessionOpts(optsIn, sendArgs[2]); String controllerName = hostEp->GetControllerUniqueName(); ProxyBusObject rObj(ajObj.bus, controllerName.c_str(), org::alljoyn::Daemon::ObjectPath, 0); const InterfaceDescription* intf = ajObj.bus.GetInterface(org::alljoyn::Daemon::InterfaceName); assert(intf); rObj.AddInterface(*intf); QCC_DbgPrintf(("Calling GetSessionInfo(%s, %u, <%x, %x, %x>) on %s", sendArgs[0].v_string.str, sendArgs[1].v_uint16, optsIn.proximity, optsIn.traffic, optsIn.transports, controllerName.c_str())); status = rObj.MethodCall(org::alljoyn::Daemon::InterfaceName, "GetSessionInfo", sendArgs, ArraySize(sendArgs), reply); if (status == ER_OK) { size_t na; const MsgArg* replyArgs; const MsgArg* busAddrArgs; size_t numBusAddrs; reply->GetArgs(na, replyArgs); replyArgs[0].Get("as", &numBusAddrs, &busAddrArgs); for (size_t i = numBusAddrs; i > 0; --i) { busAddrs.push_back(busAddrArgs[i - 1].v_string.str); } } else { QCC_LogError(status, ("GetSessionInfo failed")); } } } RemoteEndpoint AllJoynObj::JoinSessionThread::ConnectBusToBusEndpoint(const qcc::String& busAddr, const SessionOpts& optsIn, TransportMask& transport, uint32_t& replyCode) { RemoteEndpoint b2bEp; replyCode = ALLJOYN_JOINSESSION_REPLY_UNREACHABLE; /* Ask the transport that provided the advertisement for an endpoint */ Transport* trans = ajObj.GetTransport(busAddr); if (trans != NULL) { QCC_DbgPrintf(("JoinSessionThread::RunJoin(): Connect(\"%s\")", busAddr.c_str())); BusEndpoint newEp; QStatus status = trans->Connect(busAddr.c_str(), optsIn, newEp); if (status == ER_OK) { b2bEp = RemoteEndpoint::cast(newEp); if (b2bEp->IsValid()) { b2bEp->IncrementRef(); } replyCode = ALLJOYN_JOINSESSION_REPLY_SUCCESS; transport = trans->GetTransportMask(); } else { QCC_LogError(status, ("trans->Connect(%s) failed", busAddr.c_str())); } } else { QCC_DbgPrintf(("JoinSessionThread::RunJoin(): No available transport for %s", busAddr.c_str())); } return b2bEp; } void AllJoynObj::JoinSessionThread::ThreadExit(Thread* thread) { ajObj.joinSessionThreadsLock.Lock(MUTEX_CONTEXT); vector::iterator it = ajObj.joinSessionThreads.begin(); JoinSessionThread* deleteMe = NULL; while (it != ajObj.joinSessionThreads.end()) { if (*it == thread) { deleteMe = *it; ajObj.joinSessionThreads.erase(it); break; } ++it; } ajObj.joinSessionThreadsLock.Unlock(MUTEX_CONTEXT); if (deleteMe) { deleteMe->Join(); delete deleteMe; } else { QCC_LogError(ER_FAIL, ("Internal error: JoinSessionThread not found on list")); } } void AllJoynObj::JoinSession(const InterfaceDescription::Member* member, Message& msg) { QCC_UNUSED(member); /* Handle JoinSession on another thread since JoinThread can block waiting for NameOwnerChanged */ joinSessionThreadsLock.Lock(MUTEX_CONTEXT); if (!isStopping) { JoinSessionThread* jst = new JoinSessionThread(*this, msg, true); QStatus status = jst->Start(NULL, jst); if (status == ER_OK) { joinSessionThreads.push_back(jst); } else { QCC_LogError(status, ("Join: Failed to start JoinSessionThread")); delete jst; } } joinSessionThreadsLock.Unlock(MUTEX_CONTEXT); } void AllJoynObj::AttachSession(const InterfaceDescription::Member* member, Message& msg) { QCC_UNUSED(member); /* Handle AttachSession on another thread since AttachSession can block when connecting through an intermediate node */ joinSessionThreadsLock.Lock(MUTEX_CONTEXT); if (!isStopping) { JoinSessionThread* jst = new JoinSessionThread(*this, msg, false); QStatus status = jst->Start(NULL, jst); if (status == ER_OK) { joinSessionThreads.push_back(jst); } else { QCC_LogError(status, ("Attach: Failed to start JoinSessionThread")); delete jst; } } joinSessionThreadsLock.Unlock(MUTEX_CONTEXT); } void AllJoynObj::LeaveHostedSession(const InterfaceDescription::Member* member, Message& msg) { LeaveSessionCommon(member, msg, LEAVE_HOSTED_SESSION); } void AllJoynObj::LeaveJoinedSession(const InterfaceDescription::Member* member, Message& msg) { LeaveSessionCommon(member, msg, LEAVE_JOINED_SESSION); } void AllJoynObj::LeaveSession(const InterfaceDescription::Member* member, Message& msg) { LeaveSessionCommon(member, msg, LEAVE_SESSION); } uint32_t AllJoynObj::CheckLeaveSession(const SessionMapEntry*smEntry, const char*sender, SessionId id, LeaveSessionType lst, bool& senderWasSelfJoined) const { if (!smEntry || (id == 0)) { return ALLJOYN_LEAVESESSION_REPLY_NO_SESSION; } String senderstr(sender); senderWasSelfJoined = false; switch (lst) { case LEAVE_HOSTED_SESSION: if (smEntry->sessionHost != sender) { QCC_DbgPrintf(("Sender was not the host\n")); return ALLJOYN_LEAVESESSION_REPLY_NO_SESSION; } senderWasSelfJoined = smEntry->IsSelfJoin(); break; case LEAVE_JOINED_SESSION: if (find(smEntry->memberNames.begin(), smEntry->memberNames.end(), senderstr) == smEntry->memberNames.end()) { QCC_DbgPrintf(("Sender was not a joiner\n")); return ALLJOYN_LEAVESESSION_REPLY_NO_SESSION; } if (smEntry->sessionHost == sender) { senderWasSelfJoined = true; assert(smEntry->IsSelfJoin()); } break; case LEAVE_SESSION: { if (smEntry->IsSelfJoin() == true && (smEntry->sessionHost == sender)) { QCC_DbgPrintf(("Cannot use LeaveSession() on self-join session: ambiguous\n")); return ALLJOYN_LEAVESESSION_REPLY_NO_SESSION; } } break; } return ALLJOYN_LEAVESESSION_REPLY_SUCCESS; } void AllJoynObj::LeaveSessionCommon(const InterfaceDescription::Member* member, Message& msg, LeaveSessionType lst) { QCC_UNUSED(member); uint32_t replyCode = ALLJOYN_LEAVESESSION_REPLY_SUCCESS; size_t numArgs; const MsgArg* args; bool senderWasSelfJoined; /* Parse the message args */ msg->GetArgs(numArgs, args); assert(numArgs == 1); SessionId id = static_cast(args[0].v_uint32); QCC_DbgTrace(("AllJoynObj::LeaveSession(%u)", id)); /* Find the session with that id */ AcquireLocks(); SessionMapEntry* smEntry = SessionMapFind(msg->GetSender(), id); if ((replyCode = CheckLeaveSession(smEntry, msg->GetSender(), id, lst, senderWasSelfJoined)) != ALLJOYN_LEAVESESSION_REPLY_SUCCESS) { ReleaseLocks(); } else { /* Send DetachSession signal to daemons of all session participants */ if (senderWasSelfJoined == false) { MsgArg detachSessionArgs[2]; detachSessionArgs[0].Set("u", id); detachSessionArgs[1].Set("s", msg->GetSender()); QStatus status = Signal(NULL, 0, *detachSessionSignal, detachSessionArgs, ArraySize(detachSessionArgs), 0, ALLJOYN_FLAG_GLOBAL_BROADCAST); if (status != ER_OK) { QCC_LogError(status, ("Error sending org.alljoyn.Daemon.DetachSession signal")); } /* Close any open fd for this session */ if (smEntry->fd != qcc::INVALID_SOCKET_FD) { qcc::Shutdown(smEntry->fd); qcc::Close(smEntry->fd); } } /* Locks must be released before calling RemoveSessionRefs since that method calls out to user (SessionLost) */ ReleaseLocks(); /* Remove entries from sessionMap, but dont send a SessionLost back to the caller of this method */ if (RemoveSessionRefs(msg->GetSender(), id, false, lst) == false) { /* Remove session routes */ router.RemoveSessionRoutes(msg->GetSender(), id); } else { router.RemoveSelfJoinSessionRoute(msg->GetSender(), id); } } /* Reply to request */ MsgArg replyArgs[1]; replyArgs[0].Set("u", replyCode); QStatus status = MethodReply(msg, replyArgs, ArraySize(replyArgs)); /* Log error if reply could not be sent */ if (ER_OK != status) { QCC_LogError(status, ("Failed to respond to org.alljoyn.Bus.LeaveSession")); } } void AllJoynObj::RemoveSessionMember(const InterfaceDescription::Member* member, Message& msg) { QCC_UNUSED(member); uint32_t replyCode = ALLJOYN_REMOVESESSIONMEMBER_REPLY_SUCCESS; size_t numArgs; const MsgArg* args; /* Parse the message args */ msg->GetArgs(numArgs, args); assert(numArgs == 2); SessionId id; const char* sessionMemberName; bool sessionMemberSelfJoined = false; QStatus status = MsgArg::Get(args, numArgs, "us", &id, &sessionMemberName); if (status != ER_OK) { replyCode = ALLJOYN_REMOVESESSIONMEMBER_REPLY_FAILED; } QCC_DbgPrintf(("AllJoynObj::RemoveSessionMember(%u, %s)", id, sessionMemberName)); AcquireLocks(); if (replyCode == ALLJOYN_REMOVESESSIONMEMBER_REPLY_SUCCESS) { /* Find the session with the sender and specified session id */ SessionMapEntry* smEntry = SessionMapFind(msg->GetSender(), id); if (!smEntry || (id == 0)) { replyCode = ALLJOYN_REMOVESESSIONMEMBER_REPLY_NO_SESSION; } else if (!smEntry->opts.isMultipoint) { replyCode = ALLJOYN_REMOVESESSIONMEMBER_REPLY_NOT_MULTIPOINT; } else if (smEntry->sessionHost != msg->GetSender()) { replyCode = ALLJOYN_REMOVESESSIONMEMBER_REPLY_NOT_BINDER; } else { /* Search for this member in the member names. */ vector::iterator mit = smEntry->memberNames.begin(); bool found = false; String srcStr = sessionMemberName; while (mit != smEntry->memberNames.end()) { if (*mit == srcStr) { found = true; break; } mit++; } if (!found) { replyCode = ALLJOYN_REMOVESESSIONMEMBER_REPLY_NOT_FOUND; } else { if (smEntry->sessionHost == srcStr) { sessionMemberSelfJoined = true; } /* Find the virtual endpoint associated with the remote daemon * for the session member we want to remove. * If a virtual endpoint was not found, the destination is local * to this daemon. */ VirtualEndpoint vep; FindEndpoint(sessionMemberName, vep); if (vep->IsValid()) { RemoteEndpoint rep = vep->GetBusToBusEndpoint(id); /* Check the Remote daemon version */ if (rep->GetRemoteProtocolVersion() < 7) { /* Lower versions of the daemon do not support the RemoveSessionMember * feature. So, if the remote daemon is older, then do not allow this * method call. */ replyCode = ALLJOYN_REMOVESESSIONMEMBER_REPLY_INCOMPATIBLE_REMOTE_DAEMON; } } } } } if (replyCode == ALLJOYN_REMOVESESSIONMEMBER_REPLY_SUCCESS) { /* Send DetachSession signal to daemons of all session participants. * Send a detachSessionSignal to be sent with the * member name we want to remove and the session ID to remove from. */ if (sessionMemberSelfJoined == false) { MsgArg detachSessionArgs[2]; detachSessionArgs[0].Set("u", id); detachSessionArgs[1].Set("s", sessionMemberName); QStatus status = Signal(NULL, 0, *detachSessionSignal, detachSessionArgs, ArraySize(detachSessionArgs), 0, ALLJOYN_FLAG_GLOBAL_BROADCAST); if (status != ER_OK) { QCC_LogError(status, ("Error sending org.alljoyn.Daemon.DetachSession signal")); } } /* Locks must be released before calling RemoveSessionRefs since that method calls out to user (SessionLost) */ ReleaseLocks(); /* Remove entries from sessionMap, send a SessionLost to the session member being removed. */ if (RemoveSessionRefs(sessionMemberName, id, true) == false) { /* Remove session routes */ router.RemoveSessionRoutes(sessionMemberName, id); } else { router.RemoveSelfJoinSessionRoute(sessionMemberName, id); } } else { ReleaseLocks(); } /* Reply to request */ MsgArg replyArgs[1]; replyArgs[0].Set("u", replyCode); status = MethodReply(msg, replyArgs, ArraySize(replyArgs)); /* Log error if reply could not be sent */ if (ER_OK != status) { QCC_LogError(status, ("Failed to respond to org.alljoyn.Bus.RemoveSessionMember")); } } void AllJoynObj::GetHostInfo(const InterfaceDescription::Member* member, Message& msg) { QCC_UNUSED(member); uint32_t replyCode = ALLJOYN_GETHOSTINFO_REPLY_SUCCESS; size_t numArgs; const MsgArg* args; /* Parse the message args */ msg->GetArgs(numArgs, args); assert(numArgs == 1); SessionId id = static_cast(args[0].v_uint32); QCC_DbgPrintf(("AllJoynObj::GetHostInfo(%u)", id)); String remoteIpAddrStr = ""; String localIpAddrStr = ""; /* Find the session with that id */ AcquireLocks(); SessionMapEntry* smEntry = SessionMapFind(msg->GetSender(), id); if (!smEntry || (id == 0)) { replyCode = ALLJOYN_GETHOSTINFO_REPLY_NO_SESSION; ReleaseLocks(); } else if (smEntry->sessionHost == msg->GetSender()) { replyCode = ALLJOYN_GETHOSTINFO_REPLY_IS_BINDER; ReleaseLocks(); } else { /* get the vep to the sessionhost. */ VirtualEndpoint vep; FindEndpoint(smEntry->sessionHost, vep); if (vep->IsValid()) { RemoteEndpoint rep = vep->GetBusToBusEndpoint(id); QStatus status = rep->GetRemoteIp(remoteIpAddrStr); if (status != ER_OK) { replyCode = ALLJOYN_GETHOSTINFO_REPLY_NOT_SUPPORTED_ON_TRANSPORT; } status = rep->GetLocalIp(localIpAddrStr); if (status != ER_OK) { replyCode = ALLJOYN_GETHOSTINFO_REPLY_NOT_SUPPORTED_ON_TRANSPORT; } } else { replyCode = ALLJOYN_GETHOSTINFO_REPLY_FAILED; } ReleaseLocks(); } const char* remoteIpAddr = remoteIpAddrStr.c_str(); const char* localIpAddr = localIpAddrStr.c_str(); /* Reply to request */ MsgArg replyArgs[3]; replyArgs[0].Set("u", replyCode); replyArgs[1].Set("s", localIpAddr); replyArgs[2].Set("s", remoteIpAddr); QStatus status = MethodReply(msg, replyArgs, ArraySize(replyArgs)); /* Log error if reply could not be sent */ if (ER_OK != status) { QCC_LogError(status, ("Failed to respond to org.alljoyn.Bus.GetHostInfo")); } } void AllJoynObj::ReloadConfig(const InterfaceDescription::Member* member, Message& msg) { QCC_UNUSED(member); ConfigDB* config = ConfigDB::GetConfigDB(); bool loaded = config->LoadConfig(&bus); MsgArg replyArg; replyArg.Set("b", loaded); QStatus status = MethodReply(msg, &replyArg, 1); /* Log error if reply could not be sent */ if (status != ER_OK) { QCC_LogError(status, ("Failed to respond to org.alljoyn.Bus.ReloadConfig")); } } bool AllJoynObj::NamesHandler(Message msg, MsgArg arg) { assert(ALLJOYN_ARRAY == arg.typeId); const MsgArg* items = arg.v_array.GetElements(); const String& shortGuidStr = guid.ToShortString(); /* Create a virtual endpoint for each unique name in args */ AcquireLocks(); map::iterator bit = b2bEndpoints.find(msg->GetRcvEndpointName()); if (bit == b2bEndpoints.end()) { QCC_LogError(ER_BUS_NO_ENDPOINT, ("Cannot find b2b endpoint %s", msg->GetRcvEndpointName())); ReleaseLocks(); return false; } bool madeChanges = false; GUID128 senderGuid = bit->second->GetRemoteGUID(); const size_t numItems = arg.v_array.GetNumElements(); QCC_DbgTrace(("AllJoynObj::NamesHandler processing %d unique names", numItems)); const String& shortOtherGuidStr = senderGuid.ToShortString(); StringMapKey key = bit->first; for (size_t i = 0; i < numItems; ++i) { if (bit == b2bEndpoints.end()) { QCC_DbgPrintf(("b2bEp %s disappeared during NamesHandler", key.c_str())); break; } assert(items[i].typeId == ALLJOYN_STRUCT); qcc::String uniqueName = items[i].v_struct.members[0].v_string.str; if (!IsLegalUniqueName(uniqueName.c_str())) { QCC_LogError(ER_FAIL, ("Invalid unique name \"%s\" in AttachSessionWithArgs/ExchangeNames message", uniqueName.c_str())); continue; } else if (0 == ::strncmp(uniqueName.c_str() + 1, shortGuidStr.c_str(), shortGuidStr.size())) { /* Cant accept a request to change a local name */ continue; } else if ((bit->second->GetFeatures().nameTransfer == SessionOpts::SLS_NAMES) && (0 != ::strncmp(uniqueName.c_str() + 1, shortOtherGuidStr.c_str(), shortOtherGuidStr.size()))) { /* Filter out names from routers that predate the DAEMON_NAMES(now SLS_NAMES) flag */ continue; } /* Add a virtual endpoint */ bool madeChange; String b2bName = bit->second->GetUniqueName(); ReleaseLocks(); AddVirtualEndpoint(uniqueName, b2bName, &madeChange); if (madeChange) { madeChanges = true; } /* Relock and reacquire */ AcquireLocks(); BusEndpoint tempEp = FindEndpoint(uniqueName); VirtualEndpoint vep = VirtualEndpoint::cast(tempEp); bit = b2bEndpoints.find(key); if (bit == b2bEndpoints.end()) { QCC_DbgPrintf(("b2bEp %s disappeared during NamesHandler", key.c_str())); break; } /* Add virtual aliases (remote well-known names) */ const MsgArg* aliasItems = items[i].v_struct.members[1].v_array.GetElements(); const size_t numAliases = items[i].v_struct.members[1].v_array.GetNumElements(); for (size_t j = 0; j < numAliases; ++j) { assert(ALLJOYN_STRING == aliasItems[j].typeId); if (vep->IsValid()) { ReleaseLocks(); bool madeChange = router.SetVirtualAlias(aliasItems[j].v_string.str, &vep, vep); AcquireLocks(); bit = b2bEndpoints.find(key); if (bit == b2bEndpoints.end()) { QCC_DbgPrintf(("b2bEp %s disappeared during NamesSignalHandler", key.c_str())); break; } if (madeChange) { madeChanges = true; } } } } ReleaseLocks(); const char* methodType = msg->GetMemberName(); /* * ExchangeNames: * If there were changes, forward the message to all nodes with nameTransfer ALL_NAMES * except the one that sent us this ExchangeNames. * * AttachSessionWithNames: * If there were changes, generate an ExchangeNames and send to all nodes with nameTransfer * ALL_NAMES except the one that sent us this AttachSessionWithNames. */ if (madeChanges) { AcquireLocks(); Message exchangeMsg(bus); if (strncmp(methodType, "ExchangeNames", 13) == 0) { exchangeMsg = msg; } else { exchangeMsg->SignalMsg("a(sas)", org::alljoyn::Daemon::WellKnownName, 0, org::alljoyn::Daemon::ObjectPath, org::alljoyn::Daemon::InterfaceName, "ExchangeNames", &arg, 1, 0, 0); } map::iterator it = b2bEndpoints.begin(); while (it != b2bEndpoints.end()) { if ((it->second->GetFeatures().nameTransfer == SessionOpts::ALL_NAMES) && (senderGuid != it->second->GetRemoteGUID())) { QCC_DbgPrintf(("Sending ExchangeName signal to %s", it->second->GetUniqueName().c_str())); StringMapKey key = it->first; RemoteEndpoint ep = it->second; ReleaseLocks(); QStatus status = ep->PushMessage(exchangeMsg); if (ER_OK != status) { QCC_LogError(status, ("Failed to forward ExchangeNames to %s", ep->GetUniqueName().c_str())); } AcquireLocks(); it = b2bEndpoints.upper_bound(key); } else { ++it; } } ReleaseLocks(); } return madeChanges; } qcc::ThreadReturn STDCALL AllJoynObj::JoinSessionThread::RunAttach() { QCC_DbgTrace(("JoinSessionThread::RunAttach()")); SessionId id = 0; String creatorName; MsgArg replyArgs[5]; SessionOpts optsOut; uint32_t replyCode = ALLJOYN_JOINSESSION_REPLY_FAILED; bool destIsLocal = false; /* Default member list to empty */ replyArgs[3].Set("as", 0, NULL); /* Received a daemon request to establish a session route */ /* Parse message args */ SessionPort sessionPort; const char* src; const char* sessionHost; const char* dest; const char* srcB2B; const char* busAddr; SessionOpts optsIn; RemoteEndpoint srcB2BEp; RemoteEndpoint b2bEp; String srcStr; String destStr; bool newSME = false; SessionMapEntry sme; size_t na; const MsgArg* args; msg->GetArgs(na, args); CallerType type = HOST; QStatus status = MsgArg::Get(args, 6, "qsssss", &sessionPort, &src, &sessionHost, &dest, &srcB2B, &busAddr); const String srcB2BStr = srcB2B; QCC_DbgPrintf(("JoinSessionThread::RunAttach(): sessionPort=%d, src=\"%s\", sessionHost=\"%s\", dest=\"%s\", srcB2B=\"%s\", busAddr=\"%s\"", sessionPort, src, sessionHost, dest, srcB2B, busAddr)); bool sendSessionJoined = false; srcStr = src; bool attachSessionWithNames = false; if (status == ER_OK) { status = GetSessionOpts(args[6], optsIn); const char* methodType = msg->GetMemberName(); QCC_DbgPrintf(("AllJoynObj::RunAttach(): optsIn=%s methodType=%s", optsIn.ToString().c_str(), methodType)); if (strncmp(methodType, "AttachSessionWithNames", 22) == 0) { attachSessionWithNames = true; } ajObj.AcquireLocks(); BusEndpoint tempEp = ajObj.FindEndpoint(srcB2BStr); srcB2BEp = RemoteEndpoint::cast(tempEp); /* Set the endpoint's nameTransfer based on the value in optsIn. * This determines which names need to be sent out to applications. */ if (attachSessionWithNames && srcB2BEp->IsValid()) { srcB2BEp->GetFeatures().nameTransfer = optsIn.nameTransfer; } ajObj.ReleaseLocks(); if (attachSessionWithNames) { ajObj.NamesHandler(msg, args[7]); } } String destUniqueName; if (status != ER_OK) { QCC_DbgPrintf(("AllJoynObj::RunAttach(): Bad args")); replyCode = ALLJOYN_JOINSESSION_REPLY_FAILED; ajObj.AcquireLocks(); } else { QCC_DbgPrintf(("AllJoynObj::RunAttach(): Good request. Starting.")); destStr = dest; ajObj.AcquireLocks(); /* * If there is an outstanding join involving (sessionHost,port), then destEp may not be valid yet. * Essentially, someone else might know we are a multipoint session member before we do. */ BusEndpoint destEp = ajObj.FindEndpoint(destStr); if ((destEp->GetEndpointType() != ENDPOINT_TYPE_REMOTE) && (destEp->GetEndpointType() != ENDPOINT_TYPE_NULL) && (destEp->GetEndpointType() != ENDPOINT_TYPE_LOCAL)) { /* Release locks while waiting */ ajObj.ReleaseLocks(); QCC_DbgPrintf(("AllJoynObj::RunAttach(): Endpoint for destStr=\"%s\" exists but is invalid. Sleeping.", destStr.c_str())); qcc::Sleep(500); ajObj.AcquireLocks(); destEp = ajObj.FindEndpoint(destStr); } /* Determine if the dest is local to this daemon */ if ((destEp->GetEndpointType() == ENDPOINT_TYPE_REMOTE) || (destEp->GetEndpointType() == ENDPOINT_TYPE_NULL) || (destEp->GetEndpointType() == ENDPOINT_TYPE_LOCAL)) { QCC_DbgPrintf(("AllJoynObj::RunAttach(): destStr=\"%s\" served directly.", destStr.c_str())); /* This daemon serves dest directly */ /* Check for a session in the session map */ bool foundSessionMapEntry = false; destUniqueName = destEp->GetUniqueName(); BusEndpoint sessionHostEp = ajObj.FindEndpoint(sessionHost); SessionMapType::iterator sit = ajObj.SessionMapLowerBound(destUniqueName, 0); replyCode = ALLJOYN_JOINSESSION_REPLY_SUCCESS; while ((sit != ajObj.sessionMap.end()) && (sit->first.first == destUniqueName)) { QCC_DbgPrintf(("AllJoynObj::RunAttach(): Found destUniqueName=\"%s\" in session map.", destUniqueName.c_str())); BusEndpoint creatorEp = ajObj.FindEndpoint(sit->second.sessionHost); sme = sit->second; if ((sme.sessionPort == sessionPort) && sessionHostEp->IsValid() && (creatorEp == sessionHostEp)) { QCC_DbgPrintf(("AllJoynObj::RunAttach(): Valid session map entry for sessionPort=%d", sessionPort)); if (sit->second.opts.isMultipoint && (sit->first.second == 0)) { QCC_DbgPrintf(("AllJoynObj::RunAttach(): Session is multipoint")); /* Session is multipoint. Look for an existing (already joined) session */ while ((sit != ajObj.sessionMap.end()) && (sit->first.first == destUniqueName)) { creatorEp = ajObj.FindEndpoint(sit->second.sessionHost); if ((sit->first.second != 0) && (sit->second.sessionPort == sessionPort) && (creatorEp == sessionHostEp)) { sme = sit->second; foundSessionMapEntry = true; QCC_DbgPrintf(("AllJoynObj::RunAttach(): Found session map entry")); /* make sure session is not already joined by this joiner */ vector::const_iterator mit = sit->second.memberNames.begin(); while (mit != sit->second.memberNames.end()) { if (*mit++ == srcStr) { replyCode = ALLJOYN_JOINSESSION_REPLY_ALREADY_JOINED; foundSessionMapEntry = false; QCC_DbgPrintf(("AllJoynObj::RunAttach(): Already joined")); break; } } break; } ++sit; } } else if (sme.opts.isMultipoint && (sit->first.second == msg->GetSessionId())) { /* joiner to joiner multipoint attach message */ QCC_DbgPrintf(("AllJoynObj::RunAttach(): Joiner to Joiner multipoint attach message")); type = MEMBER; foundSessionMapEntry = true; } else if (!sme.opts.isMultipoint && (sit->first.second != 0)) { /* Cannot join a non-multipoint session more than once */ QCC_DbgPrintf(("AllJoynObj::RunAttach(): Multiple joins to non-multipoint session detected")); replyCode = ALLJOYN_JOINSESSION_REPLY_FAILED; } if ((replyCode == ALLJOYN_JOINSESSION_REPLY_SUCCESS) && !foundSessionMapEntry) { /* Assign a session id and insert entry */ while (sme.id == 0) { sme.id = qcc::Rand32(); } sme.isInitializing = true; foundSessionMapEntry = true; ajObj.SessionMapInsert(sme); newSME = true; QCC_DbgPrintf(("AllJoynObj::RunAttach(): Allocate new session id: %d", sme.id)); } break; } ++sit; } if (!foundSessionMapEntry) { QCC_DbgPrintf(("AllJoynObj::RunAttach(): Unable to find a session map entry")); if (replyCode == ALLJOYN_JOINSESSION_REPLY_SUCCESS) { replyCode = ALLJOYN_JOINSESSION_REPLY_NO_SESSION; } } else if (!sme.opts.IsCompatible(optsIn)) { QCC_DbgPrintf(("AllJoynObj::RunAttach(): Incompatible options")); replyCode = ALLJOYN_JOINSESSION_REPLY_BAD_SESSION_OPTS; optsOut = sme.opts; } else { QCC_DbgPrintf(("AllJoynObj::RunAttach(): Valid session map entry")); optsOut = sme.opts; optsOut.transports &= optsIn.transports; if ((optsIn.nameTransfer == SessionOpts::ALL_NAMES) && ((optsOut.nameTransfer == SessionOpts::P2P_NAMES) || (optsOut.nameTransfer == SessionOpts::MP_NAMES))) { optsOut.nameTransfer = SessionOpts::ALL_NAMES; } BusEndpoint tempEp = ajObj.FindEndpoint(srcStr); VirtualEndpoint srcEp = VirtualEndpoint::cast(tempEp); tempEp = ajObj.FindEndpoint(srcB2BStr); srcB2BEp = RemoteEndpoint::cast(tempEp); if (srcB2BEp->IsValid() && srcEp->IsValid()) { QCC_DbgPrintf(("AllJoynObj::RunAttach(): srcB2BEp IsValid(), srcEp IsValid()")); uint32_t protoVer = srcB2BEp->GetFeatures().protocolVersion; QCC_DbgPrintf(("AllJoynObj::RunAttach(): protoVer=%d.", protoVer)); if (protoVer < 9 || attachSessionWithNames) { srcB2BEp->GetFeatures().nameTransfer = sme.opts.nameTransfer; } /* Store ep for raw sessions (for future close and fd extract) */ if (optsOut.traffic != SessionOpts::TRAFFIC_MESSAGES) { QCC_DbgPrintf(("AllJoynObj::RunAttach(): traffic != TRAFFIC_MESSAGES")); SessionMapEntry* smEntry = ajObj.SessionMapFind(sme.endpointName, sme.id); if (smEntry) { smEntry->streamingEp = srcB2BEp; } } /* If this node is the session creator, give it a chance to accept or reject the new member */ bool isAccepted = true; BusEndpoint creatorEp = ajObj.FindEndpoint(sme.sessionHost); if (creatorEp->IsValid() && (destEp == creatorEp)) { QCC_DbgPrintf(("AllJoynObj::RunAttach(): SendAcceptSession()")); ajObj.ReleaseLocks(); status = ajObj.SendAcceptSession(sme.sessionPort, sme.id, dest, src, optsIn, isAccepted); if (ER_OK != status) { replyCode = ALLJOYN_JOINSESSION_REPLY_FAILED; QCC_LogError(status, ("SendAcceptSession failed")); } /* Re-lock and re-acquire */ ajObj.AcquireLocks(); if (!destEp->IsValid() || !srcEp->IsValid()) { QCC_LogError(ER_FAIL, ("%s (%s) disappeared during JoinSession", !destEp->IsValid() ? "destEp" : "srcB2BEp", !destEp->IsValid() ? destStr.c_str() : srcB2BStr.c_str())); replyCode = ALLJOYN_JOINSESSION_REPLY_FAILED; } } /* Add new joiner to members */ if (isAccepted && creatorEp->IsValid() && (replyCode == ALLJOYN_JOINSESSION_REPLY_SUCCESS)) { QCC_DbgPrintf(("AllJoynObj::RunAttach(): Joinee accepted. Adding joiner")); SessionMapEntry* smEntry = ajObj.SessionMapFind(sme.endpointName, sme.id); /* Update sessionMap */ if (smEntry) { QCC_DbgPrintf(("AllJoynObj::RunAttach(): Adding srcStr=\"%s\" to session map entry", srcStr.c_str())); smEntry->memberNames.push_back(srcStr); id = smEntry->id; destIsLocal = true; creatorName = creatorEp->GetUniqueName(); /* create the list of members for the AttachSession reply. * Include every member from this session map entry, apart from a self-joined host. * We can't include that one because it would confuse legacy routers. They'd end up * creating double session routes and corrupting their session cast set */ vector replyMembers; for (vector::const_iterator mit = smEntry->memberNames.begin(); mit != smEntry->memberNames.end(); ++mit) { if (*mit != smEntry->sessionHost) { replyMembers.push_back(*mit); } } replyArgs[3].Set("a$", replyMembers.size(), &replyMembers.front()); } else { replyCode = ALLJOYN_JOINSESSION_REPLY_FAILED; } /* Add routes for new session */ if (replyCode == ALLJOYN_JOINSESSION_REPLY_SUCCESS) { if (optsOut.traffic == SessionOpts::TRAFFIC_MESSAGES) { BusEndpoint busEndpoint = BusEndpoint::cast(srcEp); QCC_DbgPrintf(("AllJoynObj::RunAttach(): AddSessionRoute() for id=%d.", id)); status = ajObj.AddSessionRoute(id, destEp, NULL, busEndpoint, srcB2BEp); if (ER_OK != status) { QCC_LogError(status, ("AddSessionRoute(%u, %s, NULL, %s, %s) failed", id, dest, srcEp->GetUniqueName().c_str(), srcB2BEp->GetUniqueName().c_str())); } } /* Send SessionJoined to creator */ if (ER_OK == status && creatorEp->IsValid() && (destEp == creatorEp)) { sendSessionJoined = true; } } } else { replyCode = ALLJOYN_JOINSESSION_REPLY_REJECTED; } } else { status = ER_FAIL; replyCode = ALLJOYN_JOINSESSION_REPLY_FAILED; if (!srcB2BEp->IsValid()) { QCC_LogError(status, ("Cannot locate srcB2BEp(%s)", srcB2BStr.c_str())); } if (!srcEp->IsValid()) { QCC_LogError(status, ("Cannot locate srcEp(%s)", srcStr.c_str())); } } } } else { QCC_DbgPrintf(("AllJoynObj::RunAttach(): destStr=\"%s\" routes indirectly", destStr.c_str())); /* This daemon will attempt to route indirectly to dest */ if ((busAddr[0] == '\0') && (msg->GetSessionId() != 0) && (destEp->GetEndpointType() == ENDPOINT_TYPE_VIRTUAL)) { QCC_DbgPrintf(("AllJoynObj::RunAttach(): Secondary (multipoint) attach. Increment reference")); /* This is a secondary (multipoint) attach. * Forward the attach to the dest over the existing session id's B2BEp */ VirtualEndpoint vep = VirtualEndpoint::cast(destEp); b2bEp = vep->GetBusToBusEndpoint(msg->GetSessionId()); if (b2bEp->IsValid()) { b2bEp->IncrementRef(); } } if (!b2bEp->IsValid()) { replyCode = ALLJOYN_JOINSESSION_REPLY_NO_SESSION; } else { /* Forward AttachSession to next hop */ SessionId tempId; SessionOpts tempOpts; const String nextControllerName = b2bEp->GetRemoteName(); QCC_DbgPrintf(("AllJoynObj::RunAttach(): Forward AttachSession to busAddr=\"%s\" at nextControllerName=\"%s\" tempOpts.nt %d", busAddr, nextControllerName.c_str(), tempOpts.nameTransfer)); type = HOST_FORWARD_REPLY; /* Send AttachSession */ ajObj.ReleaseLocks(); status = ajObj.SendAttachSession(sessionPort, src, sessionHost, dest, b2bEp, nextControllerName.c_str(), msg->GetSessionId(), busAddr, SessionOpts::MP_NAMES, HOST_FORWARD, optsIn, replyCode, tempId, tempOpts, replyArgs[3]); ajObj.AcquireLocks(); /* If successful, add bi-directional session routes */ if ((status == ER_OK) && (replyCode == ALLJOYN_JOINSESSION_REPLY_SUCCESS)) { QCC_DbgPrintf(("AllJoynObj::RunAttach(): SendAttachSession() success")); BusEndpoint tempEp = ajObj.FindEndpoint(srcStr); VirtualEndpoint srcEp = VirtualEndpoint::cast(tempEp); tempEp = ajObj.FindEndpoint(srcB2BStr); srcB2BEp = RemoteEndpoint::cast(tempEp); /* Add bi-directional session routes */ if (srcB2BEp->IsValid() && srcEp->IsValid() && destEp->IsValid() && b2bEp->IsValid()) { id = tempId; optsOut = tempOpts; BusEndpoint busEndpointSrc = BusEndpoint::cast(srcEp); status = ajObj.AddSessionRoute(id, destEp, &b2bEp, busEndpointSrc, srcB2BEp); if (status != ER_OK) { QCC_LogError(status, ("AddSessionRoute(%u, %s, %s, %s) failed", id, dest, b2bEp->GetUniqueName().c_str(), srcEp->GetUniqueName().c_str(), srcB2BEp->GetUniqueName().c_str())); } } else { replyCode = ALLJOYN_JOINSESSION_REPLY_FAILED; } } else { QCC_LogError(status, ("AttachSession failed (reply=%d)", replyCode)); if (status == ER_OK) { status = ER_BUS_REPLY_IS_ERROR_MESSAGE; } if (replyCode == ALLJOYN_JOINSESSION_REPLY_SUCCESS) { replyCode = ALLJOYN_JOINSESSION_REPLY_FAILED; } } } if (b2bEp->IsValid()) { b2bEp->DecrementRef(); } } } /* Reply to request */ QCC_DbgPrintf(("AllJoynObj::RunAttach(): Reply to request")); replyArgs[0].Set("u", replyCode); replyArgs[1].Set("u", id); SetSessionOpts(optsOut, replyArgs[2]); if (attachSessionWithNames) { /* Set the endpoint's nameTransfer based on the value in optsOut. * This determines which names need to be sent out to applications. */ if (srcB2BEp->IsValid()) { srcB2BEp->GetFeatures().nameTransfer = optsOut.nameTransfer; } if (replyCode == ALLJOYN_JOINSESSION_REPLY_SUCCESS) { ajObj.GetNames(replyArgs[4], srcB2BEp, optsOut.nameTransfer, type, destUniqueName, id, sessionHost); } else { replyArgs[4].Set("a(sas)", 0, NULL); } } /* * On success, ensure that reply goes over the new b2b connection. Otherwise a race condition * related to shutting down endpoints that are to become raw will occur. */ /* Obtain the srcB2BEp */ BusEndpoint tempEp = ajObj.FindEndpoint(srcB2BStr); srcB2BEp = RemoteEndpoint::cast(tempEp); if (srcB2BEp->IsValid()) { ajObj.ReleaseLocks(); if (attachSessionWithNames) { status = msg->ReplyMsg(msg, replyArgs, ArraySize(replyArgs)); } else { status = msg->ReplyMsg(msg, replyArgs, 4); } if (status == ER_OK) { status = srcB2BEp->PushMessage(msg); } } else { ajObj.ReleaseLocks(); if (attachSessionWithNames) { status = ajObj.MethodReply(msg, replyArgs, ArraySize(replyArgs)); } else { status = ajObj.MethodReply(msg, replyArgs, 4); } } /* Send SessionJoined to creator */ if (sendSessionJoined) { QCC_DbgPrintf(("AllJoynObj::RunAttach(): SendSessionJoined(port=%d., id=%d, source=\"%s\", endpoint=\"%s\")", sme.sessionPort, sme.id, srcStr.c_str(), sme.endpointName.c_str())); ajObj.SendSessionJoined(sme.sessionPort, sme.id, srcStr.c_str(), sme.endpointName.c_str()); } ajObj.AcquireLocks(); /* Log error if reply could not be sent */ if (ER_OK != status) { QCC_LogError(status, ("Failed to respond to org.alljoyn.Daemon.AttachSession.")); } /* Special handling for successful raw session creation. (Must occur after reply is sent) */ if (srcB2BEp->IsValid() && (optsOut.traffic != SessionOpts::TRAFFIC_MESSAGES)) { QCC_DbgPrintf(("AllJoynObj::RunAttach(): Direct raw session handling")); if (!b2bEp->IsValid()) { if (!creatorName.empty()) { /* Destination for raw session. Shutdown endpoint and preserve the fd for future call to GetSessionFd */ SessionMapEntry* smEntry = ajObj.SessionMapFind(creatorName, id); if (smEntry) { if (smEntry->streamingEp->IsValid()) { ajObj.ReleaseLocks(); QCC_DbgPrintf(("AllJoynObj::RunAttach(): Direct raw session handling. ShutdownEndpoint()")); status = ajObj.ShutdownEndpoint(smEntry->streamingEp, smEntry->fd); ajObj.AcquireLocks(); smEntry = ajObj.SessionMapFind(creatorName, id); if (smEntry) { if (status != ER_OK) { QCC_LogError(status, ("Failed to shutdown raw endpoint")); } smEntry->streamingEp->Invalidate(); smEntry->isRawReady = true; } } } if (!smEntry) { QCC_LogError(ER_FAIL, ("Failed to find SessionMapEntry \"%s\",%08x", creatorName.c_str(), id)); } } } else { QCC_DbgPrintf(("AllJoynObj::RunAttach(): indirect raw session handling")); /* Indirect raw route (middle-man). Create a pump to copy raw data between endpoints */ QStatus tStatus; SocketFd srcB2bFd, b2bFd; ajObj.ReleaseLocks(); status = ajObj.ShutdownEndpoint(srcB2BEp, srcB2bFd); tStatus = ajObj.ShutdownEndpoint(b2bEp, b2bFd); ajObj.AcquireLocks(); status = (status == ER_OK) ? tStatus : status; if (status == ER_OK) { QCC_DbgPrintf(("AllJoynObj::RunAttach(): indirect raw session handling. Create message pump.")); SocketStream* ss1 = new SocketStream(srcB2bFd); SocketStream* ss2 = new SocketStream(b2bFd); size_t chunkSize = 4096; String threadNameStr = id; threadNameStr.append("-pump"); const char* threadName = threadNameStr.c_str(); bool isManaged = true; ManagedObj pump(ss1, ss2, chunkSize, threadName, isManaged); status = pump->Start(); } if (status != ER_OK) { QCC_LogError(status, ("Raw relay creation failed")); } } } /* Clear the initializing state (or cleanup) any initializing sessionMap entry */ if (newSME) { QCC_DbgPrintf(("AllJoynObj::RunAttach(): Cleanup")); SessionMapEntry* smEntry = ajObj.SessionMapFind(sme.endpointName, sme.id); if (smEntry) { if (replyCode == ALLJOYN_JOINSESSION_REPLY_SUCCESS) { smEntry->isInitializing = false; } else { ajObj.SessionMapErase(sme); } } else { QCC_LogError(ER_BUS_NO_SESSION, ("Error clearing initializing entry in sessionMap")); } } ajObj.ReleaseLocks(); /* Send SessionChanged if multipoint */ if ((replyCode == ALLJOYN_JOINSESSION_REPLY_SUCCESS) && optsOut.isMultipoint && (id != 0) && destIsLocal) { QCC_DbgPrintf(("AllJoynObj::RunAttach(): SendMPSessionChanged(id=%d, source=\"%s, true, dest)", id, srcStr.c_str(), destStr.c_str())); ajObj.SendMPSessionChanged(id, srcStr.c_str(), true, destStr.c_str(), ALLJOYN_MPSESSIONCHANGED_REMOTE_MEMBER_ADDED); } QCC_DbgPrintf(("AllJoynObj::RunAttach(%d) returned (%d,%u) (status=%s)", sessionPort, replyCode, id, QCC_StatusText(status))); return 0; } void AllJoynObj::AddAdvNameAlias(const String& guid, const TransportMask mask, const String& advName) { QCC_DbgTrace(("AllJoynObj::AddAdvNameAlias(%s, 0x%x, %s)", guid.c_str(), mask, advName.c_str())); AcquireLocks(); std::map >::iterator it = advAliasMap.find(guid); if (it == advAliasMap.end()) { set temp; AdvAliasEntry entry(advName, mask); temp.insert(entry); advAliasMap.insert(pair >(guid, temp)); } else { AdvAliasEntry entry(advName, mask); it->second.insert(entry); } ReleaseLocks(); } bool AllJoynObj::RemoveSessionRefs(const char* epName, SessionId id, bool sendSessionLost, LeaveSessionType lst) { QCC_DbgTrace(("AllJoynObj::RemoveSessionRefs(%s, %u, %u)", epName, id, sendSessionLost)); AcquireLocks(); BusEndpoint endpoint = FindEndpoint(epName); if (!endpoint->IsValid()) { ReleaseLocks(); return false; } String epNameStr = endpoint->GetUniqueName(); vector > changedSessionMembers; vector sessionsLost; vector epChangedSessionMembers; SessionMapEntry smeRemoved; bool foundSME = false; bool epPresentInAnyEntry = false; QStatus sessionLostReason = ER_FAIL; SessionMapType::iterator it = sessionMap.begin(); /* Look through sessionMap for entries matching id */ while (it != sessionMap.end()) { bool toRemove = false; if (it->first.second == id) { if (it->first.first == epNameStr) { bool selfJoinEntry = false; /* Exact key matches are removed */ /* special logic in the case this exact match entry was about self-join * This logic is largely the same as in non exact match branch */ if (it->second.IsSelfJoin() && it->second.sessionHost == epNameStr) { selfJoinEntry = true; bool endPointIsMember = false; if ((lst == LEAVE_SESSION) || (lst == LEAVE_JOINED_SESSION)) { /* Remove matching session members */ vector::iterator mit = it->second.memberNames.begin(); while (mit != it->second.memberNames.end()) { if (epNameStr == *mit) { endPointIsMember = true; mit = it->second.memberNames.erase(mit); if (it->second.opts.isMultipoint) { changedSessionMembers.push_back(it->first); } } else { ++mit; } } } if (((lst == LEAVE_SESSION && endPointIsMember == false) || lst == LEAVE_HOSTED_SESSION)) { if (endpoint == FindEndpoint(it->second.sessionHost)) { /* Modify entry to remove matching sessionHost */ it->second.sessionHost.clear(); if (it->second.opts.isMultipoint) { changedSessionMembers.push_back(it->first); } } } /* Session is lost when members + sessionHost together contain only one entry */ if ((it->second.fd == qcc::INVALID_SOCKET_FD) && (it->second.memberNames.empty() || ((it->second.memberNames.size() == 1) && it->second.sessionHost.empty()))) { SessionMapEntry tsme = it->second; sessionsLost.push_back(tsme); toRemove = true; } } else { toRemove = true; } if (sendSessionLost) { smeRemoved = it->second; epChangedSessionMembers.push_back(smeRemoved.sessionHost); vector::iterator mit = smeRemoved.memberNames.begin(); while (mit != smeRemoved.memberNames.end()) { if (epNameStr != *mit) { epChangedSessionMembers.push_back(*mit++); } else { ++mit; } } } if (selfJoinEntry == true) { sessionLostReason = ER_BUS_REMOVED_BY_BINDER_SELF; } else { sessionLostReason = ER_BUS_REMOVED_BY_BINDER; } foundSME = true; } else { bool endPointIsMember = false; if ((lst == LEAVE_SESSION) || (lst == LEAVE_JOINED_SESSION)) { /* Remove matching session members */ vector::iterator mit = it->second.memberNames.begin(); while (mit != it->second.memberNames.end()) { if (epNameStr == *mit) { endPointIsMember = true; mit = it->second.memberNames.erase(mit); if (it->second.opts.isMultipoint) { changedSessionMembers.push_back(it->first); } } else { ++mit; } } } if ((lst == LEAVE_SESSION && endPointIsMember == false) || lst == LEAVE_HOSTED_SESSION) { if (endpoint == FindEndpoint(it->second.sessionHost)) { /* Modify entry to remove matching sessionHost */ it->second.sessionHost.clear(); if (it->second.opts.isMultipoint) { changedSessionMembers.push_back(it->first); } } } /* Session is lost when members + sessionHost together contain only one entry */ if ((it->second.fd == qcc::INVALID_SOCKET_FD) && (it->second.memberNames.empty() || ((it->second.memberNames.size() == 1) && it->second.sessionHost.empty()))) { SessionMapEntry tsme = it->second; if (!it->second.isInitializing) { toRemove = true; } sessionsLost.push_back(tsme); } } if (!toRemove && !epPresentInAnyEntry && ((endpoint == FindEndpoint(it->second.sessionHost)) || (find(it->second.memberNames.begin(), it->second.memberNames.end(), epNameStr) != it->second.memberNames.end()))) { epPresentInAnyEntry = true; } } if (toRemove) { sessionMap.erase(it++); } else { ++it; } } ReleaseLocks(); /* Send MPSessionChanged for each changed session involving alias */ vector >::const_iterator csit = changedSessionMembers.begin(); while (csit != changedSessionMembers.end()) { /* We should not send the MPSessionChanged if this member was still present (selfjoin case), with the exception of its own leaf */ if (epPresentInAnyEntry == false || epNameStr == csit->first) { SendMPSessionChanged(csit->second, epNameStr.c_str(), false, csit->first.c_str(), ALLJOYN_MPSESSIONCHANGED_REMOTE_MEMBER_REMOVED); } csit++; } /* Send MPSessionChanged to the member being removed by the binder */ vector::const_iterator csitEp = epChangedSessionMembers.begin(); while (csitEp != epChangedSessionMembers.end()) { SendMPSessionChanged(id, (*csitEp).c_str(), false, epNameStr.c_str(), ALLJOYN_MPSESSIONCHANGED_LOCAL_MEMBER_REMOVED); csitEp++; } /* Send session lost signals */ vector::iterator slit = sessionsLost.begin(); while (slit != sessionsLost.end()) { if (slit->memberNames.size() == 1) { SendSessionLost(*slit++, ER_OK, ALLJOYN_SESSIONLOST_DISPOSITION_MEMBER); } else { SendSessionLost(*slit++, ER_OK, ALLJOYN_SESSIONLOST_DISPOSITION_HOST); } } if (foundSME && sendSessionLost) { SendSessionLost(smeRemoved, sessionLostReason, ALLJOYN_SESSIONLOST_DISPOSITION_MEMBER); } return epPresentInAnyEntry; } void AllJoynObj::RemoveSessionRefs(const String& vepName, const String& b2bEpName) { QCC_DbgTrace(("AllJoynObj::RemoveSessionRefs(%s, %s)", vepName.c_str(), b2bEpName.c_str())); VirtualEndpoint vep; RemoteEndpoint b2bEp; AcquireLocks(); if (!FindEndpoint(vepName, vep)) { QCC_LogError(ER_FAIL, ("Virtual endpoint %s disappeared during RemoveSessionRefs", vepName.c_str())); ReleaseLocks(); return; } if (!FindEndpoint(b2bEpName, b2bEp)) { QCC_LogError(ER_FAIL, ("B2B endpoint %s disappeared during RemoveSessionRefs", b2bEpName.c_str())); ReleaseLocks(); return; } QStatus disconnectReason = b2bEp->GetDisconnectStatus(); vector > changedSessionMembers; vector sessionsLost; SessionMapType::iterator it = sessionMap.begin(); while (it != sessionMap.end()) { int count; /* Skip binding reservations */ if (it->first.second == 0) { ++it; continue; } /* Examine sessions with ids that are affected by removal of vep through b2bep */ /* Only sessions that route through a single (matching) b2bEp are affected */ if ((vep->GetBusToBusEndpoint(it->first.second, &count) == b2bEp) && (count == 1)) { if (it->first.first == vepName) { /* Key matches can be removed from sessionMap */ sessionMap.erase(it++); } else { if (BusEndpoint::cast(vep) == FindEndpoint(it->second.sessionHost)) { /* If the session's sessionHost is vep, then clear it out of the session */ it->second.sessionHost.clear(); if (it->second.opts.isMultipoint) { changedSessionMembers.push_back(it->first); } } else { /* Clear vep from any session members */ vector::iterator mit = it->second.memberNames.begin(); while (mit != it->second.memberNames.end()) { if (vepName == *mit) { mit = it->second.memberNames.erase(mit); if (it->second.opts.isMultipoint) { changedSessionMembers.push_back(it->first); } } else { ++mit; } } } /* A session with only one member and no sessionHost or only a sessionHost are "lost" */ if ((it->second.fd == qcc::INVALID_SOCKET_FD) && (it->second.memberNames.empty() || ((it->second.memberNames.size() == 1) && it->second.sessionHost.empty()))) { SessionMapEntry tsme = it->second; pair key = it->first; if (!it->second.isInitializing) { sessionMap.erase(it++); } else { ++it; } sessionsLost.push_back(tsme); } else { ++it; } } } else { ++it; } } ReleaseLocks(); /* Send MPSessionChanged for each changed session involving alias */ vector >::const_iterator csit = changedSessionMembers.begin(); while (csit != changedSessionMembers.end()) { SendMPSessionChanged(csit->second, vepName.c_str(), false, csit->first.c_str(), ALLJOYN_MPSESSIONCHANGED_REMOTE_MEMBER_REMOVED); csit++; } /* Send session lost signals */ vector::iterator slit = sessionsLost.begin(); while (slit != sessionsLost.end()) { if (slit->memberNames.size() == 1) { SendSessionLost(*slit++, disconnectReason, ALLJOYN_SESSIONLOST_DISPOSITION_MEMBER); } else { SendSessionLost(*slit++, disconnectReason, ALLJOYN_SESSIONLOST_DISPOSITION_HOST); } } } void AllJoynObj::GetSessionInfo(const InterfaceDescription::Member* member, Message& msg) { QCC_UNUSED(member); /* Received a daemon request for session info */ /* Parse message args */ const char* creatorName; SessionPort sessionPort; SessionOpts optsIn; vector busAddrs; size_t na; const MsgArg* args; msg->GetArgs(na, args); QStatus status = MsgArg::Get(args, 2, "sq", &creatorName, &sessionPort); if (status == ER_OK) { status = GetSessionOpts(args[2], optsIn); } if (status == ER_OK) { QCC_DbgTrace(("AllJoynObj::GetSessionInfo(%s, %u, <%x, %x, %x>)", creatorName, sessionPort, optsIn.traffic, optsIn.proximity, optsIn.transports)); /* Ask the appropriate transport for the listening busAddr */ TransportList& transList = bus.GetInternal().GetTransportList(); for (size_t i = 0; i < transList.GetNumTransports(); ++i) { Transport* trans = transList.GetTransport(i); if (trans && (trans->GetTransportMask() & optsIn.transports)) { trans->GetListenAddresses(optsIn, busAddrs); } else if (!trans) { QCC_LogError(ER_BUS_TRANSPORT_NOT_AVAILABLE, ("NULL transport pointer found in transportList")); } } } else { QCC_LogError(status, ("AllJoynObj::GetSessionInfo cannot parse args")); } if (busAddrs.empty()) { status = MethodReply(msg, ER_BUS_NO_SESSION); } else { MsgArg replyArg("a$", busAddrs.size(), &busAddrs[0]); status = MethodReply(msg, &replyArg, 1); } if (status != ER_OK) { QCC_LogError(status, ("GetSessionInfo failed")); } } QStatus AllJoynObj::SendAttachSession(SessionPort sessionPort, const char* src, const char* sessionHost, const char* dest, RemoteEndpoint& b2bEp, const char* remoteControllerName, SessionId outgoingSessionId, const char* busAddr, SessionOpts::NameTransferType nameTransfer, CallerType type, const SessionOpts& optsIn, uint32_t& replyCode, SessionId& id, SessionOpts& optsOut, MsgArg& members) { QStatus status = ER_OK; Message reply(bus); MsgArg attachArgs[8]; attachArgs[0].Set("q", sessionPort); attachArgs[1].Set("s", src); attachArgs[2].Set("s", sessionHost); attachArgs[3].Set("s", dest); attachArgs[4].Set("s", b2bEp->GetUniqueName().c_str()); attachArgs[5].Set("s", busAddr); SetSessionOpts(optsIn, attachArgs[6]); ProxyBusObject controllerObj(bus, remoteControllerName, org::alljoyn::Daemon::ObjectPath, outgoingSessionId); controllerObj.AddInterface(*daemonIface); /* If the new session is raw, then arm the endpoint's RX thread to stop after reading one more message */ if ((status == ER_OK) && (optsIn.traffic != SessionOpts::TRAFFIC_MESSAGES)) { status = b2bEp->PauseAfterRxReply(); } if (status == ER_OK) { if (b2bEp->GetRemoteProtocolVersion() >= 12) { /* Make the AttachSessionWithNames method call */ GetNames(attachArgs[7], b2bEp, nameTransfer, type, src, outgoingSessionId, sessionHost); QCC_DbgPrintf(("Sending AttachSessionWithNames(%u, %s, %s, %s, %s, %s, <%x, %x, %x>) to %s", attachArgs[0].v_uint16, attachArgs[1].v_string.str, attachArgs[2].v_string.str, attachArgs[3].v_string.str, attachArgs[4].v_string.str, attachArgs[5].v_string.str, optsIn.proximity, optsIn.traffic, optsIn.transports, remoteControllerName)); controllerObj.SetB2BEndpoint(b2bEp); status = controllerObj.MethodCall(org::alljoyn::Daemon::InterfaceName, "AttachSessionWithNames", attachArgs, ArraySize(attachArgs), reply, 30000); } else { /* Make the AttachSession method call */ QCC_DbgPrintf(("Sending AttachSession(%u, %s, %s, %s, %s, %s, <%x, %x, %x>) to %s", attachArgs[0].v_uint16, attachArgs[1].v_string.str, attachArgs[2].v_string.str, attachArgs[3].v_string.str, attachArgs[4].v_string.str, attachArgs[5].v_string.str, optsIn.proximity, optsIn.traffic, optsIn.transports, remoteControllerName)); controllerObj.SetB2BEndpoint(b2bEp); status = controllerObj.MethodCall(org::alljoyn::Daemon::InterfaceName, "AttachSession", attachArgs, 7, reply, 30000); } } if (status != ER_OK) { replyCode = ALLJOYN_JOINSESSION_REPLY_FAILED; QCC_LogError(status, ("SendAttachSession failed")); } else { const MsgArg* replyArgs; size_t numReplyArgs; reply->GetArgs(numReplyArgs, replyArgs); replyCode = replyArgs[0].v_uint32; id = replyArgs[1].v_uint32; status = GetSessionOpts(replyArgs[2], optsOut); if (b2bEp->GetRemoteProtocolVersion() >= 12) { bool madeChanges = NamesHandler(reply, replyArgs[4]); QCC_UNUSED(madeChanges); } if (status == ER_OK) { members = *reply->GetArg(3); QCC_DbgPrintf(("Received AttachSession response: replyCode=%d, sessionId=%u, opts=<%x, %x, %x>", replyCode, id, optsOut.proximity, optsOut.traffic, optsOut.transports)); } else { QCC_DbgPrintf(("Received AttachSession response: ")); } } return status; } QStatus AllJoynObj::SendSessionJoined(SessionPort sessionPort, SessionId sessionId, const char* joinerName, const char* creatorName) { MsgArg args[3]; args[0].Set("q", sessionPort); args[1].Set("u", sessionId); args[2].Set("s", joinerName); QCC_DbgPrintf(("SendSessionJoined(%u, %u, %s) to %s", args[0].v_uint16, args[1].v_uint32, args[2].v_string.str, creatorName)); AllJoynPeerObj* peerObj = bus.GetInternal().GetLocalEndpoint()->GetPeerObj(); QStatus status = peerObj->Signal(creatorName, sessionId, *mpSessionJoinedSignal, args, ArraySize(args)); if (status != ER_OK) { QCC_LogError(status, ("Failed to send SessionJoined to %s", creatorName)); } return status; } QStatus AllJoynObj::SendAcceptSession(SessionPort sessionPort, SessionId sessionId, const char* creatorName, const char* joinerName, const SessionOpts& inOpts, bool& isAccepted) { /* Give the receiver a chance to accept or reject the new member */ Message reply(bus); MsgArg acceptArgs[4]; acceptArgs[0].Set("q", sessionPort); acceptArgs[1].Set("u", sessionId); acceptArgs[2].Set("s", joinerName); SetSessionOpts(inOpts, acceptArgs[3]); ProxyBusObject peerObj(bus, creatorName, org::alljoyn::Bus::Peer::ObjectPath, 0); const InterfaceDescription* sessionIntf = bus.GetInterface(org::alljoyn::Bus::Peer::Session::InterfaceName); assert(sessionIntf); peerObj.AddInterface(*sessionIntf); QCC_DbgPrintf(("Calling AcceptSession(%d, %u, %s, <%x, %x, %x> to %s", acceptArgs[0].v_uint16, acceptArgs[1].v_uint32, acceptArgs[2].v_string.str, inOpts.proximity, inOpts.traffic, inOpts.transports, creatorName)); QStatus status = peerObj.MethodCall(org::alljoyn::Bus::Peer::Session::InterfaceName, "AcceptSession", acceptArgs, ArraySize(acceptArgs), reply); if (status == ER_OK) { size_t na; const MsgArg* replyArgs; reply->GetArgs(na, replyArgs); replyArgs[0].Get("b", &isAccepted); } else { isAccepted = false; } return status; } SessionListener::SessionLostReason AllJoynObj::ConvertReasonToSessionLostReason(QStatus reason) const { SessionListener::SessionLostReason replyCode; switch (reason) { case ER_OK: replyCode = SessionListener::ALLJOYN_SESSIONLOST_REMOTE_END_LEFT_SESSION; break; case ER_SOCK_OTHER_END_CLOSED: case ER_BUS_ENDPOINT_CLOSING: replyCode = SessionListener::ALLJOYN_SESSIONLOST_REMOTE_END_CLOSED_ABRUPTLY; break; case ER_BUS_REMOVED_BY_BINDER: replyCode = SessionListener::ALLJOYN_SESSIONLOST_REMOVED_BY_BINDER; break; case ER_BUS_REMOVED_BY_BINDER_SELF: replyCode = SessionListener::ALLJOYN_SESSIONLOST_REMOVED_BY_BINDER_SELF; break; case ER_TIMEOUT: replyCode = SessionListener::ALLJOYN_SESSIONLOST_LINK_TIMEOUT; break; default: replyCode = SessionListener::ALLJOYN_SESSIONLOST_REASON_OTHER; break; } return replyCode; } void AllJoynObj::SendSessionLost(const SessionMapEntry& sme, QStatus reason, unsigned int disposition) { /* Send SessionLost to the endpoint mentioned in sme */ Message sigMsg(bus); AcquireLocks(); BusEndpoint ep = FindEndpoint(sme.endpointName); if (ep->GetEndpointType() == ENDPOINT_TYPE_REMOTE && RemoteEndpoint::cast(ep)->GetRemoteProtocolVersion() < 7) { ReleaseLocks(); /* For older clients i.e. protocol version < 7, emit SessionLost(u) signal */ MsgArg args[1]; args[0].Set("u", sme.id); QCC_DbgPrintf(("Sending SessionLost(%u) to %s", sme.id, sme.endpointName.c_str())); QStatus status = Signal(sme.endpointName.c_str(), sme.id, *sessionLostSignal, args, ArraySize(args)); if (ER_OK != status) { QCC_LogError(status, ("Failed to send SessionLost(%d) to %s", sme.id, sme.endpointName.c_str())); } } else if (ep->GetEndpointType() == ENDPOINT_TYPE_REMOTE && RemoteEndpoint::cast(ep)->GetRemoteProtocolVersion() < 11) { ReleaseLocks(); /* For newer clients i.e. protocol version [8:10], emit SessionLostWithReason(uu) signal */ MsgArg args[2]; args[0].Set("u", sme.id); args[1].Set("u", ConvertReasonToSessionLostReason(reason)); QCC_DbgPrintf(("Sending sessionLostWithReason(%u, %s) to %s", sme.id, QCC_StatusText(reason), sme.endpointName.c_str())); QStatus status = Signal(sme.endpointName.c_str(), sme.id, *sessionLostWithReasonSignal, args, ArraySize(args)); if (ER_OK != status) { QCC_LogError(status, ("Failed to send sessionLostWithReason(%u, %s) to %s", sme.id, QCC_StatusText(reason), sme.endpointName.c_str())); } } else { ReleaseLocks(); /* For newer clients i.e. protocol version >= 11, emit SessionLostWithReason(uub) signal */ MsgArg args[3]; args[0].Set("u", sme.id); args[1].Set("u", ConvertReasonToSessionLostReason(reason)); args[2].Set("u", disposition); QCC_DbgPrintf(("Sending sessionLostWithReasonAndDisposition(%u, %s, %d) to %s", sme.id, QCC_StatusText(reason), disposition, sme.endpointName.c_str())); QStatus status = Signal(sme.endpointName.c_str(), sme.id, *sessionLostWithReasonAndDispositionSignal, args, ArraySize(args)); if (ER_OK != status) { QCC_LogError(status, ("Failed to send sessionLostWithReason(%u, %s) to %s", sme.id, QCC_StatusText(reason), sme.endpointName.c_str())); } } } void AllJoynObj::SendMPSessionChanged(SessionId sessionId, const char* name, bool isAdd, const char* dest, unsigned int reason) { Message msg(bus); AcquireLocks(); BusEndpoint ep = FindEndpoint(dest); if (ep->GetEndpointType() == ENDPOINT_TYPE_REMOTE && RemoteEndpoint::cast(ep)->GetRemoteProtocolVersion() <= 10) { ReleaseLocks(); MsgArg args[3]; args[0].Set("u", sessionId); args[1].Set("s", name); args[2].Set("b", isAdd); QCC_DbgPrintf(("Sending MPSessionChanged(%u, %s, %s) to %s", sessionId, name, isAdd ? "true" : "false", dest)); QStatus status = Signal(dest, sessionId, *mpSessionChangedSignal, args, ArraySize(args)); if (status != ER_OK) { QCC_LogError(status, ("Failed to send MPSessionChanged to %s", dest)); } } else { ReleaseLocks(); MsgArg args[4]; args[0].Set("u", sessionId); args[1].Set("s", name); args[2].Set("b", isAdd); args[3].Set("u", reason); QCC_DbgPrintf(("Sending MPSessionChanged(%u, %s, %s, %u) to %s", sessionId, name, isAdd ? "true" : "false", reason, dest)); QStatus status = Signal(dest, sessionId, *mpSessionChangedWithReason, args, ArraySize(args)); if (status != ER_OK) { QCC_LogError(status, ("Failed to send MPSessionChangedWithReason to %s", dest)); } } } QStatus AllJoynObj::ShutdownEndpoint(RemoteEndpoint& b2bEp, SocketFd& sockFd) { SocketStream& ss = static_cast(b2bEp->GetStream()); /* Grab the file descriptor for the B2B endpoint and close the endpoint */ ss.DetachSocketFd(); SocketFd epSockFd = ss.GetSocketFd(); if (!epSockFd) { return ER_BUS_NOT_CONNECTED; } QStatus status = SocketDup(epSockFd, sockFd); if (status == ER_OK) { status = b2bEp->StopAfterTxEmpty(); if (status == ER_OK) { status = b2bEp->Join(); if (status != ER_OK) { QCC_LogError(status, ("Failed to join RemoteEndpoint used for streaming")); sockFd = qcc::INVALID_SOCKET_FD; } } else { QCC_LogError(status, ("Failed to stop RemoteEndpoint used for streaming")); sockFd = qcc::INVALID_SOCKET_FD; } } else { QCC_LogError(status, ("Failed to dup remote endpoint's socket")); sockFd = qcc::INVALID_SOCKET_FD; } return status; } void AllJoynObj::DetachSessionSignalHandler(const InterfaceDescription::Member* member, const char* sourcePath, Message& msg) { QCC_UNUSED(member); QCC_UNUSED(sourcePath); size_t numArgs; const MsgArg* args; /* Parse message args */ msg->GetArgs(numArgs, args); assert(numArgs == 2); SessionId id = args[0].v_uint32; const char* src = args[1].v_string.str; QCC_DbgTrace(("AllJoynObj::DetachSessionSignalHandler(src=%s, id=%u)", src, id)); /* Do not process our own detach message signals */ if (::strncmp(guid.ToShortString().c_str(), msg->GetSender() + 1, qcc::GUID128::SIZE_SHORT) == 0) { return; } /* Remove session info from sessionmapentry, send a SessionLost to the member being removed. */ if (RemoveSessionRefs(src, id, true) == false) { /* Remove session info from router */ router.RemoveSessionRoutes(src, id); } } void AllJoynObj::GetSessionFd(const InterfaceDescription::Member* member, Message& msg) { QCC_UNUSED(member); /* Parse args */ size_t numArgs; const MsgArg* args; msg->GetArgs(numArgs, args); SessionId id = args[0].v_uint32; QStatus status; SocketFd sockFd = qcc::INVALID_SOCKET_FD; QCC_DbgTrace(("AllJoynObj::GetSessionFd(%u)", id)); /* Wait for any join related operations to complete before returning fd */ AcquireLocks(); SessionMapEntry* smEntry = SessionMapFind(msg->GetSender(), id); if (smEntry && (smEntry->opts.traffic != SessionOpts::TRAFFIC_MESSAGES)) { uint64_t ts = GetTimestamp64(); while (smEntry && !smEntry->isRawReady && ((ts + 5000LL) > GetTimestamp64())) { ReleaseLocks(); qcc::Sleep(5); AcquireLocks(); smEntry = SessionMapFind(msg->GetSender(), id); } /* sessionMap entry removal was delayed waiting for sockFd to become available. Delete it now. */ if (smEntry) { sockFd = smEntry->fd; SessionMapErase(*smEntry); } } ReleaseLocks(); if (sockFd != qcc::INVALID_SOCKET_FD) { /* Send the fd and transfer ownership */ MsgArg replyArg; replyArg.Set("h", sockFd); status = MethodReply(msg, &replyArg, 1); qcc::Close(sockFd); } else { /* Send an error */ status = MethodReply(msg, ER_BUS_NO_SESSION); } if (status != ER_OK) { QCC_LogError(status, ("Failed to respond to org.alljoyn.Bus.GetSessionFd")); } } AllJoynObj::SessionMapEntry* AllJoynObj::SessionMapFind(const qcc::String& name, SessionId session) { pair key(name, session); AllJoynObj::SessionMapType::iterator it = sessionMap.find(key); if (it == sessionMap.end()) { return NULL; } else { return &(it->second); } } AllJoynObj::SessionMapType::iterator AllJoynObj::SessionMapLowerBound(const qcc::String& name, SessionId session) { pair key(name, session); return sessionMap.lower_bound(key); } AllJoynObj::SessionMapType::iterator AllJoynObj::SessionMapUpperBound(const qcc::String& name, SessionId session) { pair key(name, session); return sessionMap.upper_bound(key); } void AllJoynObj::SessionMapInsert(SessionMapEntry& sme) { pair key(sme.endpointName, sme.id); sessionMap.insert(pair, SessionMapEntry>(key, sme)); } void AllJoynObj::SessionMapErase(SessionMapEntry& sme) { pair key(sme.endpointName, sme.id); sessionMap.erase(key); } void AllJoynObj::SetLinkTimeout(const InterfaceDescription::Member* member, Message& msg) { QCC_UNUSED(member); /* Parse args */ size_t numArgs; const MsgArg* args; msg->GetArgs(numArgs, args); SessionId id = args[0].v_uint32; uint32_t reqLinkTimeout = args[1].v_uint32; uint32_t actLinkTimeout = reqLinkTimeout; bool foundEp = false; uint32_t disposition; QStatus status = ER_OK; /* Set the link timeout on all endpoints that are involved in this session */ AcquireLocks(); SessionMapType::iterator it = SessionMapLowerBound(msg->GetSender(), id); while ((it != sessionMap.end()) && (it->first.first == msg->GetSender()) && (it->first.second == id)) { SessionMapEntry& entry = it->second; if (entry.opts.traffic == SessionOpts::TRAFFIC_MESSAGES) { vector memberNames = entry.memberNames; memberNames.push_back(entry.sessionHost); for (size_t i = 0; i < memberNames.size(); ++i) { BusEndpoint memberEp = FindEndpoint(memberNames[i]); if (memberEp->IsValid() && (memberEp->GetEndpointType() == ENDPOINT_TYPE_VIRTUAL)) { VirtualEndpoint vMemberEp = VirtualEndpoint::cast(memberEp); RemoteEndpoint b2bEp = vMemberEp->GetBusToBusEndpoint(id); if (b2bEp->IsValid()) { uint32_t tTimeout = reqLinkTimeout; QStatus tStatus = b2bEp->SetLinkTimeout(tTimeout); status = (status == ER_OK) ? tStatus : status; actLinkTimeout = ((tTimeout == 0) || (actLinkTimeout == 0)) ? 0 : max(actLinkTimeout, tTimeout); foundEp = true; } } else if ((memberEp->GetEndpointType() == ENDPOINT_TYPE_REMOTE) || (memberEp->GetEndpointType() == ENDPOINT_TYPE_NULL)) { /* * This is a locally connected client. These clients do not have per-session connecions * therefore we silently allow this as if we had granted the user's request */ foundEp = true; } } } ++it; } ReleaseLocks(); /* Set disposition */ if (status == ER_ALLJOYN_SETLINKTIMEOUT_REPLY_NO_DEST_SUPPORT) { disposition = ALLJOYN_SETLINKTIMEOUT_REPLY_NO_DEST_SUPPORT; } else if (!foundEp) { disposition = ALLJOYN_SETLINKTIMEOUT_REPLY_NO_SESSION; actLinkTimeout = 0; } else if (status != ER_OK) { disposition = ALLJOYN_SETLINKTIMEOUT_REPLY_FAILED; actLinkTimeout = 0; } else { disposition = ALLJOYN_SETLINKTIMEOUT_REPLY_SUCCESS; } /* Send response */ MsgArg replyArgs[2]; replyArgs[0].Set("u", disposition); replyArgs[1].Set("u", actLinkTimeout); status = MethodReply(msg, replyArgs, ArraySize(replyArgs)); if (status != ER_OK) { QCC_LogError(status, ("Failed to respond to org.alljoyn.Bus.SetLinkTimeout")); } QCC_DbgTrace(("AllJoynObj::SetLinkTimeout(%u, %d) (status=%s, disp=%d, lto=%d)", id, reqLinkTimeout, QCC_StatusText(status), disposition, actLinkTimeout)); } void AllJoynObj::SetIdleTimeouts(const InterfaceDescription::Member* member, Message& msg) { QCC_UNUSED(member); /* Parse args */ uint32_t disposition = ALLJOYN_SETIDLETIMEOUTS_REPLY_FAILED; size_t numArgs; const MsgArg* args; msg->GetArgs(numArgs, args); uint32_t actIdleTimeout = 0; uint32_t actProbeTimeout = 0; uint32_t reqIdleTimeout = 0; uint32_t reqProbeTimeout = 0; if (numArgs == 2) { reqIdleTimeout = args[0].v_uint32; reqProbeTimeout = args[1].v_uint32; actIdleTimeout = reqIdleTimeout; actProbeTimeout = reqProbeTimeout; AcquireLocks(); BusEndpoint senderEp = FindEndpoint(msg->GetSender()); if (senderEp->IsValid()) { if (senderEp->GetEndpointType() == ENDPOINT_TYPE_REMOTE) { RemoteEndpoint rep = RemoteEndpoint::cast(senderEp); rep->SetIdleTimeouts(actIdleTimeout, actProbeTimeout); disposition = ALLJOYN_SETIDLETIMEOUTS_REPLY_SUCCESS; } else { disposition = ALLJOYN_SETIDLETIMEOUTS_REPLY_NOT_ALLOWED; } } ReleaseLocks(); } /* Send response */ MsgArg replyArgs[3]; replyArgs[0].Set("u", disposition); replyArgs[1].Set("u", actIdleTimeout); replyArgs[2].Set("u", actProbeTimeout); QStatus status = MethodReply(msg, replyArgs, ArraySize(replyArgs)); if (status != ER_OK) { QCC_LogError(status, ("Failed to respond to org.alljoyn.Bus.SetIdleTimeouts")); } QCC_DbgPrintf(("SetIdleTimeouts(%u,%u) (disposition=%u, actIdleTo=%u, actProbeTo=%u)", reqIdleTimeout, reqProbeTimeout, disposition, actIdleTimeout, actProbeTimeout)); } void AllJoynObj::AliasUnixUser(const InterfaceDescription::Member* member, Message& msg) { QCC_UNUSED(member); uint32_t replyCode = ALLJOYN_ALIASUNIXUSER_REPLY_SUCCESS; /* Parse args */ size_t numArgs; const MsgArg* args; msg->GetArgs(numArgs, args); uint32_t aliasUID = args[0].v_uint32; uint32_t origUID = 0; qcc::String sender = msg->GetSender(); BusEndpoint srcEp = FindEndpoint(sender); replyCode = PermissionMgr::AddAliasUnixUser(srcEp, sender, origUID, aliasUID); /* Send response */ MsgArg replyArg; replyArg.Set("u", replyCode); MethodReply(msg, &replyArg, 1); QCC_DbgPrintf(("AllJoynObj::AliasUnixUser(%d) returned %d", aliasUID, replyCode)); } void AllJoynObj::OnAppSuspend(const InterfaceDescription::Member* member, Message& msg) { QCC_UNUSED(member); uint32_t replyCode = ALLJOYN_ONAPPSUSPEND_REPLY_SUCCESS; qcc::String sender = msg->GetSender(); BusEndpoint srcEp = FindEndpoint(sender); if (srcEp->IsValid()) { // Only allow NullEndpoint to make this call if (srcEp->GetEndpointType() == ENDPOINT_TYPE_NULL) { if (ER_OK != IpNameService::Instance().OnProcSuspend()) { replyCode = ALLJOYN_ONAPPSUSPEND_REPLY_FAILED; } } else { QCC_DbgPrintf(("OnAppSuspend() is only supported for bundled daemon")); replyCode = ALLJOYN_ONAPPSUSPEND_REPLY_NO_SUPPORT; } } else { QCC_LogError(ER_BUS_NO_ENDPOINT, ("AllJoynObj::OnAppSuspend() sender endpoint is invalid")); replyCode = ALLJOYN_ONAPPSUSPEND_REPLY_FAILED; } /* Reply to request */ MsgArg replyArg; replyArg.Set("u", replyCode); QStatus status = MethodReply(msg, &replyArg, 1); if (ER_OK != status) { QCC_LogError(status, ("AllJoynObj::OnAppSuspend() failed to send reply message")); } } void AllJoynObj::OnAppResume(const InterfaceDescription::Member* member, Message& msg) { QCC_UNUSED(member); uint32_t replyCode = ALLJOYN_ONAPPRESUME_REPLY_SUCCESS; qcc::String sender = msg->GetSender(); BusEndpoint srcEp = FindEndpoint(sender); if (srcEp->IsValid()) { // Only allow NullEndpoint to make this call if (srcEp->GetEndpointType() == ENDPOINT_TYPE_NULL) { if (ER_OK != IpNameService::Instance().OnProcResume()) { replyCode = ALLJOYN_ONAPPRESUME_REPLY_FAILED; } } else { QCC_DbgPrintf(("OnAppResume() is only supported for bundled daemon")); replyCode = ALLJOYN_ONAPPRESUME_REPLY_NO_SUPPORT; } } else { QCC_LogError(ER_BUS_NO_ENDPOINT, ("AllJoynObj::OnAppResume() sender endpoint is invalid")); replyCode = ALLJOYN_ONAPPRESUME_REPLY_FAILED; } /* Reply to request */ MsgArg replyArg; replyArg.Set("u", replyCode); QStatus status = MethodReply(msg, &replyArg, 1); if (ER_OK != status) { QCC_LogError(status, ("AllJoynObj::OnAppResume() failed to send reply message")); } } TransportMask AllJoynObj::GetCompleteTransportMaskFilter() { Transport* tcpTransport = GetTransport("tcp:"); Transport* udpTransport = GetTransport("udp:"); TransportMask filterComplete = (tcpTransport && tcpTransport->IsRunning()) ? TRANSPORT_TCP : 0; filterComplete |= (udpTransport && udpTransport->IsRunning()) ? TRANSPORT_UDP : 0; return filterComplete; } void AllJoynObj::AdvertiseName(const InterfaceDescription::Member* member, Message& msg) { QCC_UNUSED(member); uint32_t replyCode = ALLJOYN_ADVERTISENAME_REPLY_SUCCESS; size_t numArgs; const MsgArg* args; MsgArg replyArg; const char* advertiseName; TransportMask transports = 0; bool quietly = false; /* Get AdvertiseName args */ msg->GetArgs(numArgs, args); QStatus status = MsgArg::Get(args, numArgs, "sq", &advertiseName, &transports); QCC_DbgTrace(("AllJoynObj::AdvertiseName(%s, %x)", (status == ER_OK) ? advertiseName : "", transports)); if (ER_OK != status) { QCC_LogError(status, ("Fail to parse msg parameters")); replyCode = ALLJOYN_ADVERTISENAME_REPLY_FAILED; } /* Get the sender name */ qcc::String sender = msg->GetSender(); BusEndpoint srcEp = FindEndpoint(sender); if (ALLJOYN_ADVERTISENAME_REPLY_SUCCESS == replyCode) { if (PermissionMgr::GetDaemonBusCallPolicy(srcEp) == PermissionMgr::STDBUSCALL_SHOULD_REJECT) { QCC_DbgPrintf(("The sender endpoint is not allowed to call AdvertiseName()")); replyCode = ALLJOYN_ADVERTISENAME_REPLY_FAILED; } else if (PermissionMgr::GetDaemonBusCallPolicy(srcEp) == PermissionMgr::STDBUSCALL_ALLOW_ACCESS_SERVICE_LOCAL) { transports &= TRANSPORT_LOCAL; QCC_DbgPrintf(("The sender endpoint is only allowed to use local transport")); } } if (ALLJOYN_ADVERTISENAME_REPLY_SUCCESS == replyCode) { status = TransportPermission::FilterTransports(srcEp, sender, transports, "AdvertiseName"); if (ER_OK != status) { QCC_LogError(status, ("Filter transports failed")); } } if (ALLJOYN_ADVERTISENAME_REPLY_SUCCESS == replyCode) { qcc::String adNameStr = advertiseName; // If this is a quiet advertisement, the name has a prefix of "quiet@". size_t pos = adNameStr.find_first_of('@'); if (pos != qcc::String::npos && (0 == adNameStr.compare(0, pos, "quiet"))) { quietly = true; advertiseName += (pos + 1); } /* Check to see if the advertise name is valid and well formed */ if (IsLegalBusName(advertiseName)) { /* Check to see if advertiseName is already being advertised */ AcquireLocks(); String advertiseNameStr = advertiseName; multimap >::iterator it = advertiseMap.lower_bound(advertiseNameStr); bool foundEntry = false; while ((it != advertiseMap.end()) && (it->first == advertiseNameStr)) { if (it->second.second == sender) { if ((it->second.first & transports) != 0) { replyCode = ALLJOYN_ADVERTISENAME_REPLY_ALREADY_ADVERTISING; } foundEntry = true; break; } ++it; } if (ALLJOYN_ADVERTISENAME_REPLY_SUCCESS == replyCode) { bool transportsProcessed = false; TransportList& transList = bus.GetInternal().GetTransportList(); for (size_t i = 0; i < transList.GetNumTransports(); ++i) { Transport* trans = transList.GetTransport(i); if (trans && trans->IsBusToBus() && (trans->GetTransportMask() & transports)) { transportsProcessed = true; } else if (!trans) { QCC_LogError(ER_BUS_TRANSPORT_NOT_AVAILABLE, ("NULL transport pointer found in transportList")); } } /* Add to advertise map */ if (transportsProcessed || (transports & TRANSPORT_LOCAL)) { if (!foundEntry) { advertiseMap.insert(pair >(advertiseNameStr, pair(transports, sender))); } else { it->second.first |= transports; } } else { replyCode = ALLJOYN_ADVERTISENAME_REPLY_TRANSPORT_NOT_AVAILABLE; } ReleaseLocks(); /* Advertise on transports specified */ if (transportsProcessed) { status = ER_BUS_BAD_SESSION_OPTS; for (size_t i = 0; i < transList.GetNumTransports(); ++i) { Transport* trans = transList.GetTransport(i); if (trans && trans->IsBusToBus() && (trans->GetTransportMask() & transports)) { status = trans->EnableAdvertisement(advertiseNameStr, quietly, transports & GetCompleteTransportMaskFilter()); if ((status != ER_OK) && (status != ER_NOT_IMPLEMENTED)) { QCC_LogError(status, ("EnableAdvertisment failed for transport %s - mask=0x%x", trans->GetTransportName(), transports)); } } else if (!trans) { QCC_LogError(ER_BUS_TRANSPORT_NOT_AVAILABLE, ("NULL transport pointer found in transportList")); } } } } else { ReleaseLocks(); } } else { replyCode = ALLJOYN_ADVERTISENAME_REPLY_FAILED; } } /* Reply to request */ String advNameStr = advertiseName; /* Needed since advertiseName will be corrupt after MethodReply */ replyArg.Set("u", replyCode); status = MethodReply(msg, &replyArg, 1); QCC_DbgPrintf(("AllJoynObj::Advertise(%s) returned %d (status=%s)", advNameStr.c_str(), replyCode, QCC_StatusText(status))); /* Add advertisement to local nameMap so local discoverers can see this advertisement even if the advertisement is not enabled on the local transport. Note however that discoverers might see this advertisement as being advertised on the local transport even though it is not enabled on the local transport. */ if (replyCode == ALLJOYN_ADVERTISENAME_REPLY_SUCCESS) { vector names; names.push_back(advNameStr); FoundNames("local:", bus.GetGlobalGUIDString(), TRANSPORT_LOCAL, &names, numeric_limits::max()); } /* Log error if reply could not be sent */ if (ER_OK != status) { QCC_LogError(status, ("Failed to respond to org.alljoyn.Bus.Advertise")); } } void AllJoynObj::CancelAdvertiseName(const InterfaceDescription::Member* member, Message& msg) { QCC_UNUSED(member); const MsgArg* args; size_t numArgs; /* Get the name being advertised */ msg->GetArgs(numArgs, args); const char* advertiseName; TransportMask transports = 0; QStatus status = MsgArg::Get(args, numArgs, "sq", &advertiseName, &transports); if (status != ER_OK) { QCC_LogError(status, ("CancelAdvertiseName: bad arg types")); return; } // Strip off name prefix "quiet@" if exists qcc::String adNameStr = advertiseName; size_t pos = adNameStr.find_first_of('@'); if (pos != qcc::String::npos && (0 == adNameStr.compare(0, pos, "quiet"))) { advertiseName += (pos + 1); } QCC_DbgTrace(("AllJoynObj::CancelAdvertiseName(%s, 0x%x)", advertiseName, transports)); /* Cancel advertisement */ status = ProcCancelAdvertise(msg->GetSender(), advertiseName, transports); uint32_t replyCode = (ER_OK == status) ? ALLJOYN_CANCELADVERTISENAME_REPLY_SUCCESS : ALLJOYN_CANCELADVERTISENAME_REPLY_FAILED; /* Reply to request */ String advNameStr = advertiseName; /* Needed since advertiseName will be corrupt after MethodReply */ MsgArg replyArg("u", replyCode); status = MethodReply(msg, &replyArg, 1); /* Log error if reply could not be sent */ if (ER_OK != status) { QCC_LogError(status, ("Failed to respond to org.alljoyn.Bus.CancelAdvertise")); } } QStatus AllJoynObj::ProcCancelAdvertise(const qcc::String& sender, const qcc::String& advertiseName, TransportMask transports) { QCC_DbgTrace(("AllJoynObj::ProcCancelAdvertise(%s, %s, %x)", sender.c_str(), advertiseName.c_str(), transports)); QStatus status = ER_OK; /* Check to see if this advertised name exists and delete it */ bool foundAdvert = false; TransportMask refMask = 0; TransportMask cancelMask = 0; TransportMask origMask = 0; AcquireLocks(); multimap >::iterator it = advertiseMap.find(advertiseName); while ((it != advertiseMap.end()) && (it->first == advertiseName)) { if (it->second.second == sender) { foundAdvert = true; origMask = it->second.first; it->second.first &= ~transports; if (it->second.first == 0) { advertiseMap.erase(it++); continue; } } refMask |= it->second.first; ++it; } cancelMask = transports & ~refMask; if (foundAdvert) { cancelMask &= origMask; } ReleaseLocks(); /* Cancel transport advertisement if no other refs exist */ if (foundAdvert && cancelMask) { TransportList& transList = bus.GetInternal().GetTransportList(); for (size_t i = 0; i < transList.GetNumTransports(); ++i) { Transport* trans = transList.GetTransport(i); if (trans && (trans->GetTransportMask() & cancelMask)) { trans->DisableAdvertisement(advertiseName, cancelMask & GetCompleteTransportMaskFilter()); } else if (!trans) { QCC_LogError(ER_BUS_TRANSPORT_NOT_AVAILABLE, ("NULL transport pointer found in transportList")); } } } else if (!foundAdvert) { status = ER_FAIL; } /* Remove advertisement from local nameMap so local discoverers are notified of advertisement going away */ if ((status == ER_OK) && (transports & TRANSPORT_LOCAL)) { vector names; names.push_back(advertiseName); FoundNames("local:", bus.GetGlobalGUIDString(), TRANSPORT_LOCAL, &names, 0); } return status; } void AllJoynObj::FindAdvertisedName(const InterfaceDescription::Member* member, Message& msg) { QCC_UNUSED(member); size_t numArgs; const MsgArg* args; msg->GetArgs(numArgs, args); qcc::String matchingStr; const char* str; QStatus status = MsgArg::Get(args, numArgs, "s", &str); if (status == ER_OK) { /* * When a bus name is advertised, the source may append a string that * identifies a specific instance of advertised name. For example, one * might advertise something like * * com.mycompany.myproduct.0123456789ABCDEF * * as a specific instance of the bus name, * * com.mycompany.myproduct * * Clients of the system will want to be able to discover all specific * instances, so they need to do a wildcard search for bus name strings * that match the non-specific name, for example, * * com.mycompany.myproduct* * * We automatically append the name service wildcard character to the end * of the provided string (which we call the namePrefix) before sending it * to the name service which forwards the request out over the net. */ matchingStr = String("name='") + str + "*'"; } ProcFindAdvertisement(status, msg, matchingStr, TRANSPORT_ANY); } void AllJoynObj::FindAdvertisedNameByTransport(const InterfaceDescription::Member* member, Message& msg) { QCC_UNUSED(member); size_t numArgs; const MsgArg* args; msg->GetArgs(numArgs, args); qcc::String matchingStr; const char* str; TransportMask transports; QStatus status = MsgArg::Get(args, numArgs, "sq", &str, &transports); if (status == ER_OK) { matchingStr = String("name='") + str + "*'"; } ProcFindAdvertisement(status, msg, matchingStr, transports); } void AllJoynObj::FindAdvertisementByTransport(const InterfaceDescription::Member* member, Message& msg) { QCC_UNUSED(member); size_t numArgs; const MsgArg* args; msg->GetArgs(numArgs, args); qcc::String matchingStr; const char* str; TransportMask transports; QStatus status = MsgArg::Get(args, numArgs, "sq", &str, &transports); if (status == ER_OK) { matchingStr = str; } ProcFindAdvertisement(status, msg, matchingStr, transports); } void AllJoynObj::ProcFindAdvertisement(QStatus status, Message& msg, const qcc::String& matchingStr, TransportMask transports) { uint32_t replyCode = ALLJOYN_FINDADVERTISEDNAME_REPLY_SUCCESS; TransportMask enableMask = 0; TransportMask origMask = 0; QCC_DbgTrace(("AllJoynObj::FindAdvertiseNameProc(%s)", matchingStr.c_str())); if (ER_OK != status) { QCC_LogError(status, ("Fail to parse msg parameters")); replyCode = ALLJOYN_FINDADVERTISEDNAME_REPLY_FAILED; } MatchMap matching; if (ALLJOYN_FINDADVERTISEDNAME_REPLY_SUCCESS == replyCode) { status = ParseMatchRule(matchingStr, matching); if (ER_OK != status) { QCC_LogError(status, ("Fail to parse matching paramter")); replyCode = ALLJOYN_FINDADVERTISEDNAME_REPLY_FAILED; } } qcc::String sender = msg->GetSender(); AcquireLocks(); BusEndpoint srcEp = FindEndpoint(sender); if (ALLJOYN_FINDADVERTISEDNAME_REPLY_SUCCESS == replyCode) { if (PermissionMgr::GetDaemonBusCallPolicy(srcEp) == PermissionMgr::STDBUSCALL_SHOULD_REJECT) { QCC_DbgPrintf(("The sender endpoint is not allowed to call FindAdvertisedName()")); replyCode = ER_ALLJOYN_FINDADVERTISEDNAME_REPLY_FAILED; } else if (PermissionMgr::GetDaemonBusCallPolicy(srcEp) == PermissionMgr::STDBUSCALL_ALLOW_ACCESS_SERVICE_LOCAL) { QCC_DbgPrintf(("The sender endpoint is only allowed to use local transport.")); transports &= TRANSPORT_LOCAL; } } if (ALLJOYN_FINDADVERTISEDNAME_REPLY_SUCCESS == replyCode) { status = TransportPermission::FilterTransports(srcEp, sender, transports, "AllJoynObj::FindAdvertisedName"); } MatchMap::const_iterator namePrefix = matching.find("name"); if (ALLJOYN_FINDADVERTISEDNAME_REPLY_SUCCESS == replyCode) { bool transportsProcessed = false; TransportList& transList = bus.GetInternal().GetTransportList(); for (size_t i = 0; i < transList.GetNumTransports(); ++i) { Transport* trans = transList.GetTransport(i); if (trans && trans->IsBusToBus() && (trans->GetTransportMask() & transports)) { transportsProcessed = true; } else if (!trans) { QCC_LogError(ER_BUS_TRANSPORT_NOT_AVAILABLE, ("NULL transport pointer found in transportList")); } } /* Check to see if this endpoint is already discovering this prefix */ bool foundEntry = false; DiscoverMapType::iterator it = discoverMap.lower_bound(matchingStr); while ((it != discoverMap.end()) && (it->first == matchingStr)) { /* This is the transportMask of the transports that this name was being discovered prior to this FindAdvertisedName call. */ origMask |= it->second.transportMask; if (it->second.sender == sender) { if ((it->second.transportMask & transports) != 0) { replyCode = ALLJOYN_FINDADVERTISEDNAME_REPLY_ALREADY_DISCOVERING; } else { it->second.transportMask = it->second.transportMask | transports; } foundEntry = true; } ++it; } if (transportsProcessed || (transports & TRANSPORT_LOCAL)) { if (!foundEntry) { /* This is the fix for multiple found names issue. * If this is a name-based query, set initComplete to false and set it to true after * the calls to the transports are complete. */ discoverMap.insert(std::make_pair(matchingStr, DiscoverMapEntry(transports, sender, matching, namePrefix == matching.end()))); } } else { replyCode = ALLJOYN_FINDADVERTISEDNAME_REPLY_TRANSPORT_NOT_AVAILABLE; } } /* Find out the transports on which discovery needs to be enabled for this name. * i.e. The ones that are set in the requested transport mask and not set in the origMask. */ ReleaseLocks(); enableMask = transports & ~origMask; if (ALLJOYN_FINDADVERTISEDNAME_REPLY_SUCCESS == replyCode) { /* Find name on all remote transports */ TransportList& transList = bus.GetInternal().GetTransportList(); for (size_t i = 0; i < transList.GetNumTransports(); ++i) { Transport* trans = transList.GetTransport(i); if (trans && (trans->GetTransportMask() & enableMask)) { trans->EnableDiscovery(matchingStr.c_str(), enableMask & GetCompleteTransportMaskFilter()); } else if (!trans) { QCC_LogError(ER_BUS_TRANSPORT_NOT_AVAILABLE, ("NULL transport pointer found in transportList")); } } } /* Reply to request */ MsgArg replyArg("u", replyCode); status = MethodReply(msg, &replyArg, 1); QCC_DbgPrintf(("AllJoynObj::FindAdvertisedName(%s) returned %d (status=%s)", matchingStr.c_str(), replyCode, QCC_StatusText(status))); /* Log error if reply could not be sent */ if (ER_OK != status) { QCC_LogError(status, ("Failed to respond to org.alljoyn.Bus.Discover")); } /* Send FoundAdvertisedName signals if there are existing matches for matching */ if ((ALLJOYN_FINDADVERTISEDNAME_REPLY_SUCCESS == replyCode) && (namePrefix != matching.end())) { AcquireLocks(); String prefix = namePrefix->second.substr(0, namePrefix->second.find_last_of('*')); multimap::iterator it = nameMap.lower_bound(prefix); set sentSet; while ((it != nameMap.end()) && !WildcardMatch(it->first, namePrefix->second)) { if ((it->second.transport & transports) == 0) { ++it; continue; } SentSetEntry sentSetEntry(it->first, it->second.transport); if (sentSet.find(sentSetEntry) == sentSet.end()) { String foundName = it->first; NameMapEntry nme = it->second; it = nameMap.lower_bound(prefix); sentSet.insert(sentSetEntry); } else { ++it; } } //Set initComplete to true DiscoverMapType::iterator dit = discoverMap.lower_bound(matchingStr); while ((dit != discoverMap.end()) && (dit->first == matchingStr)) { if (dit->second.sender == sender) { dit->second.initComplete = true; break; } ++dit; } ReleaseLocks(); set::iterator sit = sentSet.begin(); while (sit != sentSet.end()) { status = SendFoundAdvertisedName(sender, (*sit).name, (*sit).transport, namePrefix->second); if (ER_OK != status) { QCC_LogError(status, ("Cannot send FoundAdvertisedName to %s for name=%s", sender.c_str(), (*sit).name.c_str())); } sit++; } } } void AllJoynObj::CancelFindAdvertisedName(const InterfaceDescription::Member* member, Message& msg) { QCC_UNUSED(member); size_t numArgs; const MsgArg* args; msg->GetArgs(numArgs, args); qcc::String matchingStr; const char* str; QStatus status = MsgArg::Get(args, numArgs, "s", &str); if (status == ER_OK) { matchingStr = String("name='") + str + "*'"; } HandleCancelFindAdvertisement(status, msg, matchingStr, TRANSPORT_ANY); } void AllJoynObj::CancelFindAdvertisedNameByTransport(const InterfaceDescription::Member* member, Message& msg) { QCC_UNUSED(member); size_t numArgs; const MsgArg* args; msg->GetArgs(numArgs, args); qcc::String matchingStr; const char* str; TransportMask transports; QStatus status = MsgArg::Get(args, numArgs, "sq", &str, &transports); if (status == ER_OK) { matchingStr = String("name='") + str + "*'"; } HandleCancelFindAdvertisement(status, msg, matchingStr, transports); } void AllJoynObj::CancelFindAdvertisementByTransport(const InterfaceDescription::Member* member, Message& msg) { QCC_UNUSED(member); size_t numArgs; const MsgArg* args; msg->GetArgs(numArgs, args); qcc::String matchingStr; const char* str; TransportMask transports; QStatus status = MsgArg::Get(args, numArgs, "sq", &str, &transports); if (status == ER_OK) { matchingStr = str; } HandleCancelFindAdvertisement(status, msg, matchingStr, transports); } void AllJoynObj::HandleCancelFindAdvertisement(QStatus status, Message& msg, const qcc::String& matchingStr, TransportMask transports) { uint32_t replyCode = ALLJOYN_CANCELFINDADVERTISEDNAME_REPLY_SUCCESS; /* Cancel advertisement */ QCC_DbgPrintf(("Calling ProcCancelFindAdvertisement from HandleCancelFindAdvertisedment [%s]", Thread::GetThread()->GetName())); if (ER_OK == status) { status = ProcCancelFindAdvertisement(msg->GetSender(), matchingStr, transports); replyCode = (ER_OK == status) ? ALLJOYN_CANCELFINDADVERTISEDNAME_REPLY_SUCCESS : ALLJOYN_CANCELFINDADVERTISEDNAME_REPLY_FAILED; } else { QCC_LogError(status, ("HandleCancelFindAdvertisement() parse message arguments error")); replyCode = ALLJOYN_CANCELFINDADVERTISEDNAME_REPLY_FAILED; } /* Reply to request */ MsgArg replyArg("u", replyCode); status = MethodReply(msg, &replyArg, 1); QCC_DbgPrintf(("AllJoynObj::CancelFindAdvertisement(%s) returned %d (status=%s)", matchingStr.c_str(), replyCode, QCC_StatusText(status))); /* Log error if reply could not be sent */ if (ER_OK != status) { QCC_LogError(status, ("Failed to respond to org.alljoyn.Bus.CancelFindAdvertisement")); } } QStatus AllJoynObj::ProcCancelFindAdvertisement(const qcc::String& sender, const qcc::String& matchingStr, TransportMask transports) { QCC_DbgTrace(("AllJoynObj::ProcCancelFindAdvertisement(sender = %s, matching = %s, transports = %d)", sender.c_str(), matchingStr.c_str(), transports)); QStatus status = ER_OK; AcquireLocks(); bool foundFinder = false; TransportMask refMask = 0; TransportMask origMask = 0; TransportMask cancelMask = 0; DiscoverMapType::iterator it = discoverMap.lower_bound(matchingStr); while ((it != discoverMap.end()) && (it->first == matchingStr)) { if (it->second.sender == sender) { foundFinder = true; origMask = it->second.transportMask; it->second.transportMask &= ~transports; if (it->second.transportMask == 0) { discoverMap.erase(it++); continue; } } refMask |= it->second.transportMask; ++it; } cancelMask = transports & ~refMask; if (foundFinder) { cancelMask &= origMask; } ReleaseLocks(); /* Disable discovery if certain transports are no longer referenced for the name prefix */ if (foundFinder && cancelMask) { TransportList& transList = bus.GetInternal().GetTransportList(); for (size_t i = 0; i < transList.GetNumTransports(); ++i) { Transport* trans = transList.GetTransport(i); if (trans && (trans->GetTransportMask() & cancelMask)) { trans->DisableDiscovery(matchingStr.c_str(), refMask & GetCompleteTransportMaskFilter()); } } } else if (!foundFinder) { status = ER_FAIL; } return status; } QStatus AllJoynObj::AddBusToBusEndpoint(RemoteEndpoint& endpoint) { QCC_DbgTrace(("AllJoynObj::AddBusToBusEndpoint(%s)", endpoint->GetUniqueName().c_str())); const qcc::String& shortGuidStr = endpoint->GetRemoteGUID().ToShortString(); /* Add b2b endpoint */ AcquireLocks(); b2bEndpoints[endpoint->GetUniqueName()] = endpoint; ReleaseLocks(); /* Create a virtual endpoint for talking to the remote bus control object */ /* This endpoint will also carry broadcast messages for the remote bus */ String remoteControllerName(":", 1, 16); remoteControllerName.append(shortGuidStr); remoteControllerName.append(".1"); AddVirtualEndpoint(remoteControllerName, endpoint->GetUniqueName()); /* Exchange existing bus names if connected to another daemon */ /* Protocol version 12 and above use new call flow using AttachSessionWithNames. Do not send ExchangeNames signal. */ if (endpoint->GetRemoteProtocolVersion() >= 12) { return ER_OK; } else { return ExchangeNames(endpoint); } } void AllJoynObj::RemoveBusToBusEndpoint(RemoteEndpoint& endpoint) { QCC_DbgTrace(("AllJoynObj::RemoveBusToBusEndpoint(%s)", endpoint->GetUniqueName().c_str())); qcc::String guidToBeChecked; /* Be careful to lock the name table before locking the virtual endpoints since both locks are needed * and doing it in the opposite order invites deadlock */ AcquireLocks(); String b2bEpName = endpoint->GetUniqueName(); /* Remove the B2B endpoint before removing virtual endpoints to ensure * that another thread does not try to re-add the B2B endpoint to a * virtual endpoint while this function is in progress. */ b2bEndpoints.erase(endpoint->GetUniqueName()); /* Remove any virtual endpoints associated with a removed bus-to-bus endpoint */ map::iterator it = virtualEndpoints.begin(); while (it != virtualEndpoints.end()) { String vepName = it->first; /* Check if this virtual endpoint has a route through this bus-to-bus endpoint. * If not, no cleanup is required for this virtual endpoint. */ if (!it->second->CanUseRoute(endpoint)) { it = virtualEndpoints.upper_bound(vepName); continue; } /* Clean sessionMap and report lost sessions */ /* * Remove the sessionMap entries involving endpoint * This call must be made without holding locks since it can trigger LostSession callback */ ReleaseLocks(); RemoveSessionRefs(vepName, b2bEpName); AcquireLocks(); it = virtualEndpoints.find(vepName); if (it == virtualEndpoints.end()) { /* If the virtual endpoint was lost, continue to the next virtual endpoint */ it = virtualEndpoints.upper_bound(vepName); continue; } /* Remove endpoint (b2b) reference from this vep. * Note: If IsStopping() is true, then there is another thread that is in the process * of deleting this virtual endpoint. In this case, skip this virtual endpoint. */ if (!it->second->IsStopping()) { if (it->second->RemoveBusToBusEndpoint(endpoint)) { /* The last b2b endpoint was removed from this vep. */ String exitingEpName = it->second->GetUniqueName(); /* Let directly connected daemons know that this virtual endpoint is gone. */ map::iterator it2 = b2bEndpoints.begin(); const qcc::GUID128& otherSideGuid = endpoint->GetRemoteGUID(); guidToBeChecked = otherSideGuid.ToString(); while ((it2 != b2bEndpoints.end()) && (it != virtualEndpoints.end())) { bool sendInfo = ((it2->second->GetFeatures().nameTransfer == SessionOpts::ALL_NAMES) || ((it2->second->GetFeatures().nameTransfer == SessionOpts::MP_NAMES) && endpoint->GetSessionId() == it2->second->GetSessionId())); if ((it2->second != endpoint) && (it2->second->GetRemoteGUID() != otherSideGuid) && sendInfo) { Message sigMsg(bus); MsgArg args[3]; args[0].Set("s", exitingEpName.c_str()); args[1].Set("s", exitingEpName.c_str()); args[2].Set("s", ""); QStatus status = sigMsg->SignalMsg("sss", org::alljoyn::Daemon::WellKnownName, 0, org::alljoyn::Daemon::ObjectPath, org::alljoyn::Daemon::InterfaceName, "NameChanged", args, ArraySize(args), 0, 0); if (ER_OK == status) { String key = it->first; String key2 = it2->first.c_str(); RemoteEndpoint ep = it2->second; ReleaseLocks(); status = ep->PushMessage(sigMsg); if (ER_OK != status) { QCC_LogError(status, ("Failed to send NameChanged to %s", ep->GetUniqueName().c_str())); } AcquireLocks(); it2 = b2bEndpoints.lower_bound(key2); if ((it2 != b2bEndpoints.end()) && (it2->first == key2)) { ++it2; } it = virtualEndpoints.find(key); } else { ++it2;; } } else { ++it2; } } /* Remove virtual endpoint with no more b2b eps */ if (it != virtualEndpoints.end()) { String vepName = it->first; ReleaseLocks(); RemoveVirtualEndpoint(vepName); AcquireLocks(); it = virtualEndpoints.upper_bound(vepName); } } else { /* Need to hit NameTable here since name ownership of a vep alias may have changed */ ReleaseLocks(); router.UpdateVirtualAliases(vepName); AcquireLocks(); it = virtualEndpoints.upper_bound(vepName); } } } ReleaseLocks(); // // Check if guid for this name is eligible for removal from PeerInfoMap in NameService // if (!IsGuidLongStringAdvertising(guidToBeChecked)) { IpNameService::Instance().RemoveFromPeerInfoMap(guidToBeChecked); } } bool AllJoynObj::IsMemberOfSession(BusEndpoint endpoint, uint32_t sessionId) { AcquireLocks(); bool ret = false; if (endpoint->GetEndpointType() == ENDPOINT_TYPE_VIRTUAL) { ret = VirtualEndpoint::cast(endpoint)->HasSession(sessionId); } else { ret = SessionMapFind(endpoint->GetUniqueName(), sessionId) != NULL; } ReleaseLocks(); return ret; } QStatus AllJoynObj::GetNames(MsgArg& argArray, RemoteEndpoint& endpoint, SessionOpts::NameTransferType nameTransfer, CallerType type, String joinerName, uint32_t sessionId, String sessionHost) { QCC_DbgTrace(("AllJoynObj::GetNames(endpoint = %s joinerName %s endpoint->GetFeatures().nameTransfer %d type %d sessionId %u endpoint->GetRemoteGUID() %s)", endpoint->GetUniqueName().c_str(), joinerName.c_str(), nameTransfer, type, sessionId, endpoint->GetRemoteGUID().ToShortString().c_str())); /* Validate nameTransfer and type */ if ((((nameTransfer == SessionOpts::SLS_NAMES) || (nameTransfer == SessionOpts::P2P_NAMES)) && (type != JOINER) && (type != HOST)) || ((nameTransfer == SessionOpts::MP_NAMES) && (type != JOINER) && (type != HOST) && (type != HOST_FORWARD))) { argArray.Set("a(sas)", 0, NULL); return ER_OK; } vector > > names; QStatus status; /* Send local name table info to remote bus controller */ AcquireLocks(); router.GetUniqueNamesAndAliases(names); MsgArg* entries = new MsgArg[names.size()]; size_t numEntries = 0; vector > >::const_iterator it = names.begin(); LocalEndpoint localEndpoint = bus.GetInternal().GetLocalEndpoint(); size_t guidLen = joinerName.find_first_of('.'); String joinerRN = joinerName.substr(0, guidLen) + ".1"; BusEndpoint hostEp = FindEndpoint(sessionHost); /* Send all endpoint info except for endpoints related to destination */ while (it != names.end()) { BusEndpoint ep = FindEndpoint(it->first); bool isLocalRNInfo = (it->first == localEndpoint->GetUniqueName()); if (ep->IsValid()) { bool sendInfo = false; switch (nameTransfer) { case SessionOpts::ALL_NAMES: /* All NameChanged need to be sent out for ALL_NAMES sessions. */ sendInfo = true; break; case SessionOpts::SLS_NAMES: /* The name of the local routing node and locally connected sessionless * signal emitters need to be sent out in the case of an incoming connection i.e. * another routing node is trying to fetch sessionless signals from this routing node. * Note: The check (it->first == joinerName) or (it->first == hostEp->GetUniqueName()) * is applied only so that test programs testing sessionless sessions work. * In the normal case, i.e. when SessionlessObj joins the session, * the joinerName/hostEp->GetUniqueName() will be same as the local routing node name, * so the check is redundant. */ if (type == JOINER) { sendInfo = isLocalRNInfo || (it->first == joinerName); } else if (type == HOST) { sendInfo = isLocalRNInfo || (it->first == hostEp->GetUniqueName()) || busController->GetSessionlessObj().IsSessionlessEmitter(it->first); } break; case SessionOpts::P2P_NAMES: if (type == JOINER) { /* The name of the local routing node and session joiner need to * be sent out by the Joiner RN. */ sendInfo = isLocalRNInfo || (it->first == joinerName); } else if (type == HOST) { /* The name of the local routing node and session host need to be * sent out by the Host RN */ sendInfo = isLocalRNInfo || (it->first == hostEp->GetUniqueName()); } break; case SessionOpts::MP_NAMES: if (type == JOINER) { /* The name of the local routing node and session joiner need to * be sent out by the Joiner RN. */ sendInfo = isLocalRNInfo || (it->first == joinerName); } else if (type == HOST) { /* The name of the local routing node, session host and existing * session members need to be sent out by the Host RN. * Do not send the joiner names back to the joiner. */ sendInfo = isLocalRNInfo || (it->first == hostEp->GetUniqueName()) || ((it->first != joinerName) && (it->first != joinerRN) && IsMemberOfSession(ep, sessionId)); } else if (type == HOST_FORWARD) { /* The names of new joiner and its routing node need to be sent * out by the Host RN to the existing session member RN. */ sendInfo = (it->first == joinerName) || (it->first == joinerRN); } /* No names required for HOST_FORWARD_REPLY or MEMBER */ break; } sendInfo = sendInfo && ((ep->GetEndpointType() != ENDPOINT_TYPE_VIRTUAL) || VirtualEndpoint::cast(ep)->CanRouteWithout(endpoint->GetRemoteGUID())); if (sendInfo) { MsgArg* aliasNames = new MsgArg[it->second.size()]; vector::const_iterator ait = it->second.begin(); size_t numAliases = 0; while (ait != it->second.end()) { /* Send exportable endpoints */ aliasNames[numAliases++].Set("s", ait->c_str()); ++ait; } if (0 < numAliases) { entries[numEntries].Set("(sa*)", it->first.c_str(), numAliases, aliasNames); /* * Set ownwership flag so entries array destructor will free inner message args. */ entries[numEntries].SetOwnershipFlags(MsgArg::OwnsArgs, true); } else { entries[numEntries].Set("(sas)", it->first.c_str(), 0, NULL); delete[] aliasNames; } ++numEntries; } } ++it; } status = argArray.Set("a(sas)", numEntries, entries); argArray.Stabilize(); ReleaseLocks(); /* * This will also free the inner MsgArgs. */ delete [] entries; return status; } QStatus AllJoynObj::ExchangeNames(RemoteEndpoint& endpoint) { QCC_DbgTrace(("AllJoynObj::ExchangeNames(endpoint = %s) NT %d", endpoint->GetUniqueName().c_str(), endpoint->GetFeatures().nameTransfer)); MsgArg argArray(ALLJOYN_ARRAY); QStatus status = GetNames(argArray, endpoint, endpoint->GetFeatures().nameTransfer, endpoint->IsIncomingConnection() ? HOST : JOINER); if (ER_OK == status) { Message exchangeMsg(bus); status = exchangeMsg->SignalMsg("a(sas)", org::alljoyn::Daemon::WellKnownName, 0, org::alljoyn::Daemon::ObjectPath, org::alljoyn::Daemon::InterfaceName, "ExchangeNames", &argArray, 1, 0, 0); if (ER_OK == status) { status = endpoint->PushMessage(exchangeMsg); } } if (status != ER_OK) { QCC_LogError(status, ("Failed to send ExchangeName signal")); } return status; } void AllJoynObj::ExchangeNamesSignalHandler(const InterfaceDescription::Member* member, const char* sourcePath, Message& msg) { QCC_UNUSED(member); QCC_UNUSED(sourcePath); QCC_DbgTrace(("AllJoynObj::ExchangeNamesSignalHandler(msg sender = \"%s\")", msg->GetSender())); size_t numArgs; const MsgArg* args; msg->GetArgs(numArgs, args); assert((1 == numArgs) && (ALLJOYN_ARRAY == args[0].typeId)); NamesHandler(msg, args[0]); } void AllJoynObj::NameChangedSignalHandler(const InterfaceDescription::Member* member, const char* sourcePath, Message& msg) { QCC_UNUSED(member); QCC_UNUSED(sourcePath); size_t numArgs; const MsgArg* args; msg->GetArgs(numArgs, args); assert(daemonIface); const qcc::String alias = args[0].v_string.str; const qcc::String oldOwner = args[1].v_string.str; const qcc::String newOwner = args[2].v_string.str; const String& shortGuidStr = guid.ToShortString(); bool madeChanges = false; QCC_DbgPrintf(("AllJoynObj::NameChangedSignalHandler: alias = \"%s\" oldOwner = \"%s\" newOwner = \"%s\" sent from \"%s\"", alias.c_str(), oldOwner.c_str(), newOwner.c_str(), msg->GetSender())); /* Don't allow a NameChange that attempts to change a local name */ if ((!oldOwner.empty() && (0 == ::strncmp(oldOwner.c_str() + 1, shortGuidStr.c_str(), shortGuidStr.size()))) || (!newOwner.empty() && (0 == ::strncmp(newOwner.c_str() + 1, shortGuidStr.c_str(), shortGuidStr.size())))) { return; } /* Ignore a NameChange for non-local names from routers that predate the DAEMON_NAMES(now SLS_NAMES) flag */ AcquireLocks(); map::iterator bit = b2bEndpoints.find(msg->GetRcvEndpointName()); if (bit != b2bEndpoints.end() && (bit->second->GetFeatures().nameTransfer == SessionOpts::SLS_NAMES)) { qcc::GUID128 otherGuid = bit->second->GetRemoteGUID(); const String& shortOtherGuidStr = otherGuid.ToShortString(); if ((!oldOwner.empty() && (0 != ::strncmp(oldOwner.c_str() + 1, shortOtherGuidStr.c_str(), shortOtherGuidStr.size()))) || (!newOwner.empty() && (0 != ::strncmp(newOwner.c_str() + 1, shortOtherGuidStr.c_str(), shortOtherGuidStr.size())))) { ReleaseLocks(); return; } } SessionId sessionId = (bit != b2bEndpoints.end()) ? bit->second->GetSessionId() : 0; ReleaseLocks(); if (alias[0] == ':') { AcquireLocks(); map::iterator bit = b2bEndpoints.find(msg->GetRcvEndpointName()); if (bit != b2bEndpoints.end()) { /* Change affects a remote unique name (i.e. a VirtualEndpoint) */ if (newOwner.empty()) { VirtualEndpoint vep = FindVirtualEndpoint(oldOwner.c_str()); if (vep->IsValid()) { madeChanges = vep->CanUseRoute(bit->second); /* Note: If IsStopping() is true, then there is another thread that is in the process * of deleting this virtual endpoint. In this case, skip this virtual endpoint. */ if (madeChanges && !vep->IsStopping()) { if (vep->RemoveBusToBusEndpoint(bit->second)) { /* The last b2b endpoint was removed from this vep. */ String vepName = vep->GetUniqueName(); ReleaseLocks(); RemoveVirtualEndpoint(vepName); } else { /* Need to hit NameTable here since name ownership of a vep alias may have changed */ String vepName = vep->GetUniqueName(); ReleaseLocks(); router.UpdateVirtualAliases(vepName); } } else { ReleaseLocks(); } } else { ReleaseLocks(); } } else { /* Add a new virtual endpoint */ if (bit != b2bEndpoints.end()) { String b2bEpName = bit->second->GetUniqueName(); ReleaseLocks(); AddVirtualEndpoint(alias, b2bEpName, &madeChanges); } else { ReleaseLocks(); } } } else { ReleaseLocks(); QCC_LogError(ER_BUS_NO_ENDPOINT, ("Cannot find bus-to-bus endpoint %s", msg->GetRcvEndpointName())); } } else { AcquireLocks(); /* Change affects a well-known name (name table only) */ VirtualEndpoint remoteController = FindVirtualEndpoint(msg->GetSender()); if (remoteController->IsValid()) { ReleaseLocks(); if (newOwner.empty()) { madeChanges = router.SetVirtualAlias(alias, NULL, remoteController); } else { VirtualEndpoint newOwnerEp = FindVirtualEndpoint(newOwner.c_str()); madeChanges = router.SetVirtualAlias(alias, &newOwnerEp, remoteController); } AcquireLocks(); } else { QCC_LogError(ER_BUS_NO_ENDPOINT, ("Cannot find virtual endpoint %s", msg->GetSender())); } ReleaseLocks(); } if (madeChanges) { /* Forward message to all directly connected controllers except the one that sent us this NameChanged */ AcquireLocks(); map::const_iterator bit = b2bEndpoints.find(msg->GetRcvEndpointName()); map::iterator it = b2bEndpoints.begin(); while (it != b2bEndpoints.end()) { bool sendInfo = ((it->second->GetFeatures().nameTransfer == SessionOpts::ALL_NAMES) || ((it->second->GetFeatures().nameTransfer == SessionOpts::MP_NAMES) && it->second->GetSessionId() == sessionId)); if (sendInfo && ((bit == b2bEndpoints.end()) || (bit->second->GetRemoteGUID() != it->second->GetRemoteGUID()))) { String key = it->first.c_str(); RemoteEndpoint ep = it->second; ReleaseLocks(); QStatus status = ep->PushMessage(msg); if (ER_OK != status) { QCC_LogError(status, ("Failed to forward NameChanged to %s", ep->GetUniqueName().c_str())); } AcquireLocks(); bit = b2bEndpoints.find(msg->GetRcvEndpointName()); it = b2bEndpoints.upper_bound(key); } else { ++it; } } ReleaseLocks(); } } void AllJoynObj::AddVirtualEndpoint(const qcc::String& uniqueName, const String& b2bEpName, bool* wasAdded) { QCC_DbgTrace(("AllJoynObj::AddVirtualEndpoint(name=%s, b2b=%s)", uniqueName.c_str(), b2bEpName.c_str())); bool added = false; AcquireLocks(); BusEndpoint tempEp = FindEndpoint(b2bEpName); RemoteEndpoint busToBusEndpoint = RemoteEndpoint::cast(tempEp); map::iterator it = virtualEndpoints.find(uniqueName); /* If there is a VirtualEndpoint with the desired unique name in the virtualEndpoints map * and its state is EP_STOPPING, it means that another thread is trying to remove this * VirtualEndpoint (As a part of cleanup in AllJoynObj::RemoveBusToBusEndpoint or * AllJoynObj::NameChangedSignalHandler.) * In that case, wait for that thread to finish removing this virtual endpoint. * Also, if the busToBusEndpoint becomes invalid, we just return. */ while (busToBusEndpoint->IsValid() && it != virtualEndpoints.end() && it->second->IsStopping()) { ReleaseLocks(); qcc::Sleep(10); AcquireLocks(); it = virtualEndpoints.find(uniqueName); } if (busToBusEndpoint->IsValid()) { VirtualEndpoint vep; if (it == virtualEndpoints.end()) { vep = VirtualEndpoint(uniqueName, busToBusEndpoint); /* Add new virtual endpoint */ virtualEndpoints.insert(pair(uniqueName, vep)); added = true; /* Register the endpoint with the router */ ReleaseLocks(); BusEndpoint busEndpoint = BusEndpoint::cast(vep); router.RegisterEndpoint(busEndpoint); } else { /* Add the busToBus endpoint to the existing virtual endpoint */ vep = it->second; added = vep->AddBusToBusEndpoint(busToBusEndpoint); ReleaseLocks(); } } else { ReleaseLocks(); } if (wasAdded) { *wasAdded = added; } } void AllJoynObj::RemoveVirtualEndpoint(const String& vepName) { QCC_DbgTrace(("RemoveVirtualEndpoint: %s", vepName.c_str())); /* Remove virtual endpoint along with any aliases that exist for this uniqueName */ router.RemoveVirtualAliases(vepName); router.UnregisterEndpoint(vepName, ENDPOINT_TYPE_VIRTUAL); AcquireLocks(); map::iterator it = virtualEndpoints.find(vepName); if (it != virtualEndpoints.end()) { VirtualEndpoint vep = it->second; virtualEndpoints.erase(it); ReleaseLocks(); } else { ReleaseLocks(); } } VirtualEndpoint AllJoynObj::FindVirtualEndpoint(const qcc::String& uniqueName) { VirtualEndpoint ret; AcquireLocks(); map::iterator it = virtualEndpoints.find(uniqueName); if (it != virtualEndpoints.end()) { ret = it->second; } ReleaseLocks(); return ret; } void AllJoynObj::NameOwnerChanged(const qcc::String& alias, const qcc::String* oldOwner, SessionOpts::NameTransferType oldOwnerNameTransfer, const qcc::String* newOwner, SessionOpts::NameTransferType newOwnerNameTransfer) { QCC_UNUSED(oldOwnerNameTransfer); QCC_UNUSED(newOwnerNameTransfer); QStatus status; const String& shortGuidStr = guid.ToShortString(); /* When newOwner and oldOwner are the same, only the name transfer changed. */ if (newOwner == oldOwner) { return; } /* Validate that there is either a new owner or an old owner */ const qcc::String* un = oldOwner ? oldOwner : newOwner; if (NULL == un) { QCC_LogError(ER_BUS_NO_ENDPOINT, ("Invalid NameOwnerChanged without oldOwner or newOwner")); return; } /* Validate format of unique name */ size_t guidLen = un->find_first_of('.'); if ((qcc::String::npos == guidLen) || (guidLen < 3)) { QCC_LogError(ER_FAIL, ("Invalid unique name \"%s\"", un->c_str())); } set sessionsChanged; /* Remove unique names from sessionMap entries */ if (!newOwner && (alias[0] == ':')) { AcquireLocks(); vector > changedSessionMembers; vector sessionsLost; SessionMapType::iterator it = sessionMap.begin(); while (it != sessionMap.end()) { if (it->first.first == alias) { /* If endpoint has gone then just delete the session map entry */ sessionsChanged.insert(it->first.second); sessionMap.erase(it++); } else if (it->first.second != 0) { /* Remove member entries from existing sessions */ if (it->second.sessionHost == alias) { if (it->second.opts.isMultipoint) { changedSessionMembers.push_back(it->first); } it->second.sessionHost.clear(); /* Check for self-joined member */ vector::iterator mit = it->second.memberNames.begin(); while (mit != it->second.memberNames.end()) { if (*mit == alias) { it->second.memberNames.erase(mit); break; } ++mit; } } else { vector::iterator mit = it->second.memberNames.begin(); while (mit != it->second.memberNames.end()) { if (*mit == alias) { it->second.memberNames.erase(mit); if (it->second.opts.isMultipoint) { changedSessionMembers.push_back(it->first); } break; } ++mit; } } /* * Remove empty session entry. * Preserve raw sessions until GetSessionFd is called. */ /* * If the session is point-to-point and the memberNames are empty. * if the sessionHost is not empty (implied) and there are no member names send * the sessionLost signal as long as the session is not a raw session */ bool noMemberSingleHost = it->second.memberNames.empty(); /* * If the session is a Multipoint session it will list its own unique * name in the list of memberNames. If There is only one name in the * memberNames list and there is no session host it is safe to send * the session lost signal as long as the session does not contain a * raw session. */ bool singleMemberNoHost = ((it->second.memberNames.size() == 1) && it->second.sessionHost.empty()); /* * as long as the file descriptor is -1 this is not a raw session */ bool noRawSession = (it->second.fd == qcc::INVALID_SOCKET_FD); if ((noMemberSingleHost || singleMemberNoHost) && noRawSession) { SessionMapEntry tsme = it->second; pair key = it->first; if (!it->second.isInitializing) { sessionMap.erase(it++); } else { ++it; } sessionsLost.push_back(tsme); } else { ++it; } } else { ++it; } } ReleaseLocks(); /* Send MPSessionChanged for each changed session involving alias */ vector >::const_iterator csit = changedSessionMembers.begin(); while (csit != changedSessionMembers.end()) { SendMPSessionChanged(csit->second, alias.c_str(), false, csit->first.c_str(), ALLJOYN_MPSESSIONCHANGED_REMOTE_MEMBER_REMOVED); csit++; } /* Send session lost signals */ vector::iterator slit = sessionsLost.begin(); while (slit != sessionsLost.end()) { if (slit->memberNames.size() == 1) { SendSessionLost(*slit++, ER_BUS_ENDPOINT_CLOSING, ALLJOYN_SESSIONLOST_DISPOSITION_MEMBER); } else { SendSessionLost(*slit++, ER_BUS_ENDPOINT_CLOSING, ALLJOYN_SESSIONLOST_DISPOSITION_HOST); } } } /* Only if local name */ if ((oldOwner && (0 == ::strncmp(shortGuidStr.c_str(), oldOwner->c_str() + 1, shortGuidStr.size()))) || (newOwner && (0 == ::strncmp(shortGuidStr.c_str(), newOwner->c_str() + 1, shortGuidStr.size())))) { /* Send NameChanged to all directly connected controllers */ AcquireLocks(); map::iterator it = b2bEndpoints.begin(); while (it != b2bEndpoints.end()) { bool sendInfo = false; LocalEndpoint localEndpoint = bus.GetInternal().GetLocalEndpoint(); switch (it->second->GetFeatures().nameTransfer) { case SessionOpts::ALL_NAMES: /* All NameChanged need to be sent out for ALL_NAMES sessions. */ sendInfo = true; break; case SessionOpts::SLS_NAMES: /* NameChanged need to be sent out if the old or new owner is the routing node * or a sessionless signal emitter in the case of an incoming connection i.e. * another routing node is trying to fetch sessionless signals from this routing node. */ if (oldOwner && (0 == ::strncmp(shortGuidStr.c_str(), oldOwner->c_str() + 1, shortGuidStr.size()))) { sendInfo = (*oldOwner == localEndpoint->GetUniqueName()); if (it->second->IsIncomingConnection()) { sendInfo = sendInfo || busController->GetSessionlessObj().IsSessionlessEmitter(*oldOwner); } } if (newOwner && (0 == ::strncmp(shortGuidStr.c_str(), newOwner->c_str() + 1, shortGuidStr.size()))) { sendInfo = sendInfo || (*newOwner == localEndpoint->GetUniqueName()); if (it->second->IsIncomingConnection()) { sendInfo = sendInfo || busController->GetSessionlessObj().IsSessionlessEmitter(*newOwner); } } break; case SessionOpts::P2P_NAMES: if (alias[0] == ':') { /* NameChanged for unique names need to be sent out if it gets rid of * the session that this bus-to-bus endpoint is set up for or this is * the unique name of the routing node. */ sendInfo = (alias == localEndpoint->GetUniqueName()) || sessionsChanged.find(it->second->GetSessionId()) != sessionsChanged.end(); } else { /* NameChanged for well known names need to be sent out if the old or * new owner of the name is in the session that this bus-to-bus endpoint * is set up for or if this is routing node info. */ if (oldOwner && (0 == ::strncmp(shortGuidStr.c_str(), oldOwner->c_str() + 1, shortGuidStr.size()))) { sendInfo = (*oldOwner == localEndpoint->GetUniqueName()) || SessionMapFind(*oldOwner, it->second->GetSessionId()) != NULL; } if (newOwner && (0 == ::strncmp(shortGuidStr.c_str(), newOwner->c_str() + 1, shortGuidStr.size()))) { sendInfo = sendInfo || (*newOwner == localEndpoint->GetUniqueName()); sendInfo = sendInfo || SessionMapFind(*newOwner, it->second->GetSessionId()) != NULL; } } break; case SessionOpts::MP_NAMES: if (alias[0] == ':') { if (oldOwner) { /* In case of MP_NAMES, we send out all unique names with an old owner. * This is to take care of the case where two or more members or a * host and one or more members share a routing node, and one of the * leaf nodes leaves the session. Now, if the leaf leaves the network, * the NameChanged must be sent out or else the remote routing nodes * will cache this name and its endpoint forever. */ sendInfo = true; } else { /* NameChanged for unique names need to be sent out if it affects * the session that this bus-to-bus endpoint is set up for or this is * the unique name of the routing node. */ sendInfo = (alias == localEndpoint->GetUniqueName()) || sessionsChanged.find(it->second->GetSessionId()) != sessionsChanged.end(); } } else { /* NameChanged for well known names need to be sent out if the old or * new owner of the name is in the session that this bus-to-bus endpoint * is set up for or if this is routing node info. */ if (oldOwner && (0 == ::strncmp(shortGuidStr.c_str(), oldOwner->c_str() + 1, shortGuidStr.size()))) { sendInfo = (*oldOwner == localEndpoint->GetUniqueName()) || SessionMapFind(*oldOwner, it->second->GetSessionId()) != NULL; } if (newOwner && (0 == ::strncmp(shortGuidStr.c_str(), newOwner->c_str() + 1, shortGuidStr.size()))) { sendInfo = sendInfo || (*newOwner == localEndpoint->GetUniqueName()); sendInfo = sendInfo || SessionMapFind(*newOwner, it->second->GetSessionId()) != NULL; } } break; } if (sendInfo) { Message sigMsg(bus); MsgArg args[3]; args[0].Set("s", alias.c_str()); args[1].Set("s", oldOwner ? oldOwner->c_str() : ""); args[2].Set("s", newOwner ? newOwner->c_str() : ""); status = sigMsg->SignalMsg("sss", org::alljoyn::Daemon::WellKnownName, 0, org::alljoyn::Daemon::ObjectPath, org::alljoyn::Daemon::InterfaceName, "NameChanged", args, ArraySize(args), 0, 0); if (ER_OK == status) { StringMapKey key = it->first; RemoteEndpoint ep = it->second; ReleaseLocks(); status = ep->PushMessage(sigMsg); AcquireLocks(); it = b2bEndpoints.upper_bound(key); } else { ++it; } // if the endpoint is closing we don't don't expect the NameChanged signal to send if (ER_OK != status && ER_BUS_ENDPOINT_CLOSING != status) { QCC_LogError(status, ("Failed to send NameChanged")); } } else { ++it; } } ReleaseLocks(); /* If a local unique name dropped, then remove any refs it had in the connnect, advertise and discover maps */ if ((NULL == newOwner) && (alias[0] == ':')) { /* Remove endpoint refs from connect map */ AcquireLocks(); /* Remove endpoint refs from advertise map */ multimap >::const_iterator ait = advertiseMap.begin(); while (ait != advertiseMap.end()) { if (ait->second.second == *oldOwner) { String name = ait->first; TransportMask mask = ait->second.first; ReleaseLocks(); QStatus status = ProcCancelAdvertise(*oldOwner, name, mask); AcquireLocks(); ait = advertiseMap.upper_bound(name); if (ER_OK != status) { QCC_LogError(status, ("Failed to cancel advertise for name \"%s\"", name.c_str())); } } else { ++ait; } } /* Remove endpoint refs from discover map */ DiscoverMapType::const_iterator dit = discoverMap.begin(); while (dit != discoverMap.end()) { if (dit->second.sender == *oldOwner) { qcc::String last = dit->first; TransportMask mask = dit->second.transportMask; QCC_DbgPrintf(("Calling ProcCancelFindAdvertisement from NameOwnerChanged [%s]", Thread::GetThread()->GetName())); ReleaseLocks(); QStatus status = ProcCancelFindAdvertisement(*oldOwner, last, mask); AcquireLocks(); dit = discoverMap.upper_bound(last); if (ER_OK != status) { QCC_LogError(status, ("Failed to cancel discover for name \"%s\"", last.c_str())); } } else { ++dit; } } ReleaseLocks(); } } } struct FoundNameEntry { public: String name; String prefix; String dest; FoundNameEntry(const String& name, const String& prefix, const String& dest) : name(name), prefix(prefix), dest(dest) { } bool operator<(const FoundNameEntry& other) const { return (name < other.name) || ((name == other.name) && ((prefix < other.prefix) || ((prefix == other.prefix) && (dest < other.dest)))); } }; void AllJoynObj::FoundNames(const qcc::String& busAddr, const qcc::String& guid, TransportMask transport, const vector* names, uint32_t ttl) { QCC_DbgTrace(("AllJoynObj::FoundNames(busAddr = \"%s\", guid = \"%s\", names = %s, ttl = %d)", busAddr.c_str(), guid.c_str(), StringVectorToString(names, ",").c_str(), ttl)); set foundNameSet; set lostNameSet; AcquireLocks(); if (names == NULL) { /* If name is NULL expire all names for the given bus address. */ if (ttl == 0) { multimap::iterator it = nameMap.begin(); while (it != nameMap.end()) { NameMapEntry& nme = it->second; if ((nme.guid == guid) && (nme.busAddr == busAddr)) { lostNameSet.insert(it->first); timer.RemoveAlarm(nme.alarm, false); nameMap.erase(it++); } else { it++; } } } } else { /* Generate a list of name deltas */ vector::const_iterator nit = names->begin(); while (nit != names->end()) { multimap::iterator it = nameMap.find(*nit); bool sendSignal = true; bool isNew = true; /* Send a FoundAdvertisedName signal if this is the first namemap entry of this transport for this name. */ /* Send a LostAdvertisedName signal if this is the last namemap entry of this transport for this name. */ while ((it != nameMap.end()) && (*nit == it->first)) { if ((it->second.guid == guid) && (it->second.transport & transport) && (busAddr != it->second.busAddr)) { sendSignal = false; break; } it++; } it = nameMap.find(*nit); while ((it != nameMap.end()) && (*nit == it->first)) { if ((it->second.guid == guid) && (it->second.transport & transport) && (busAddr == it->second.busAddr)) { isNew = false; break; } ++it; } if (0 < ttl) { if (isNew) { QCC_DbgPrintf(("Adding new entry %d %d", (1000LL * ttl), (1000LL * ttl * 80 / 100))); /* Add new name to map */ NameMapType::iterator it = nameMap.insert(NameMapType::value_type(*nit, NameMapEntry(busAddr, guid, transport, (ttl == numeric_limits::max()) ? numeric_limits::max() : (1000LL * ttl), this))); QCC_DbgPrintf(("TTL set to %ld", it->second.ttl)); /* Don't schedule an alarm which will never expire or multiple timers for the same set */ if (ttl != numeric_limits::max()) { NameMapEntry& nme = it->second; // We need the alarm to be triggered off at 80% time to enable cache refresh const uint32_t timeout = ttl * 1000 * 80 / 100; AllJoynObj* pObj = this; Alarm newAlarm(timeout, pObj, NameMapEntry::truthiness); nme.alarm = newAlarm; QStatus status = timer.AddAlarm(nme.alarm); if (ER_OK != status && ER_TIMER_EXITING != status) { QCC_LogError(status, ("Failed to add alarm")); } } /* Send FoundAdvertisedName to anyone who is discovering *nit */ if (sendSignal) { if (0 < discoverMap.size()) { for (DiscoverMapType::const_iterator dit = discoverMap.begin(); dit != discoverMap.end(); ++dit) { MatchMap::const_iterator namePrefix = dit->second.matching.find("name"); if (namePrefix == dit->second.matching.end()) { continue; } if (!dit->second.initComplete) { continue; } if (!WildcardMatch(*nit, namePrefix->second) && (transport & dit->second.transportMask)) { foundNameSet.insert(FoundNameEntry(*nit, namePrefix->second, dit->second.sender)); } } } } } else { /* * If the busAddr doesn't match, then this is actually a new but redundant advertisement. * Don't track it. Don't updated the TTL for the existing advertisement with the same name * and don't tell clients about this alternate way to connect to the name * since it will look like a duplicate to the client (that doesn't receive busAddr). */ if (busAddr == it->second.busAddr) { NameMapEntry& nme = it->second; nme.timestamp = GetTimestamp64(); /* need to move the alarm ttl seconds into the future. */ const uint32_t timeout = ttl * 1000 * 80 / 100; AllJoynObj* pObj = this; Alarm newAlarm(timeout, pObj, NameMapEntry::truthiness); QStatus status = timer.ReplaceAlarm(nme.alarm, newAlarm, false); nme.alarm = newAlarm; QCC_DbgPrintf(("Resetting alarm for name %s to %d", it->first.c_str(), timeout)); if (ER_OK != status) { /* This is expected if a prior name set changed in any way (order, removed entry, etc) */ status = timer.AddAlarm(nme.alarm); if (ER_OK != status && ER_TIMER_EXITING != status) { QCC_LogError(status, ("Failed to update alarm")); } } } } } else { /* 0 == ttl means flush the record */ if (!isNew) { NameMapEntry& nme = it->second; qcc::String guidToBeChecked = it->second.guid; if (sendSignal) { lostNameSet.insert(it->first); } timer.RemoveAlarm(nme.alarm, false); nameMap.erase(it); // // Check if guid for this name is eligible for removal from PeerInfoMap in Name service // if (!IsGuidLongStringAdvertising(guidToBeChecked)) { QCC_DbgPrintf(("TTl=0. Removing GUID %s", guidToBeChecked.c_str())); IpNameService::Instance().RemoveFromPeerInfoMap(guidToBeChecked); } } } ++nit; } } ReleaseLocks(); /* Send FoundAdvertisedName signals without holding locks */ set::const_iterator fit = foundNameSet.begin(); while (fit != foundNameSet.end()) { QStatus status = SendFoundAdvertisedName(fit->dest, fit->name, transport, fit->prefix); if (ER_OK != status) { QCC_LogError(status, ("Failed to send FoundAdvertisedName to %s (name=%s)", fit->dest.c_str(), fit->name.c_str())); } ++fit; } set::const_iterator lit = lostNameSet.begin(); while (lit != lostNameSet.end()) { /* Send LostAdvetisedName signals */ SendLostAdvertisedName(*lit, transport); /* Clean advAliasMap */ CleanAdvAliasMap(*lit, transport); lit++; } } bool AllJoynObj::IsGuidShortStringAdvertising(qcc::String& guid) { // //Check if there any other name in the NameMap from this guid // AcquireLocks(); std::multimap::iterator it = nameMap.begin(); while (it != nameMap.end()) { if (qcc::GUID128(it->second.guid).ToShortString() == guid) { ReleaseLocks(); return true; } ++it; } ReleaseLocks(); return false; } bool AllJoynObj::IsGuidLongStringAdvertising(qcc::String& guid) { // //Check if there any other name in the NameMap from this guid // AcquireLocks(); std::multimap::iterator it = nameMap.begin(); while (it != nameMap.end()) { if (it->second.guid == guid) { ReleaseLocks(); return true; } ++it; } ReleaseLocks(); return false; } void AllJoynObj::CleanAdvAliasMap(const String& name, const TransportMask mask) { QCC_DbgTrace(("AllJoynObj::CleanAdvAliasMap(%s, 0x%x): size=%d", name.c_str(), mask, advAliasMap.size())); /* Clean advAliasMap */ AcquireLocks(); map >::iterator ait = advAliasMap.begin(); while (ait != advAliasMap.end()) { set::iterator bit = ait->second.begin(); while (bit != ait->second.end()) { if (((*bit).name == name) && (((*bit).transport & mask) != 0)) { ait->second.erase(bit++); } else { ++bit; } } if (ait->second.size() == 0) { advAliasMap.erase(ait++); } else { ++ait; } } ReleaseLocks(); } QStatus AllJoynObj::SendFoundAdvertisedName(const String& dest, const String& name, TransportMask transport, const String& namePrefix) { QCC_DbgTrace(("AllJoynObj::SendFoundAdvertisedName(%s, %s, 0x%x, %s)", dest.c_str(), name.c_str(), transport, namePrefix.c_str())); MsgArg args[3]; args[0].Set("s", name.c_str()); args[1].Set("q", transport); String prefix = namePrefix.substr(0, namePrefix.find_last_of('*')); args[2].Set("s", prefix.c_str()); return Signal(dest.c_str(), 0, *foundNameSignal, args, ArraySize(args)); } QStatus AllJoynObj::SendLostAdvertisedName(const String& name, TransportMask transport) { QCC_DbgTrace(("AllJoynObj::SendLostAdvertisdName(%s, 0x%x)", name.c_str(), transport)); QStatus status = ER_OK; /* Send LostAdvertisedName to anyone who is discovering name */ AcquireLocks(); vector > sigVec; if (0 < discoverMap.size()) { for (DiscoverMapType::const_iterator dit = discoverMap.begin(); dit != discoverMap.end(); ++dit) { MatchMap::const_iterator namePrefix = dit->second.matching.find("name"); if (namePrefix == dit->second.matching.end()) { continue; } if (!WildcardMatch(name, namePrefix->second) && (dit->second.transportMask & transport)) { sigVec.push_back(pair(namePrefix->second, dit->second.sender)); } } } ReleaseLocks(); /* Send the signals now that we aren't holding the lock */ vector >::const_iterator it = sigVec.begin(); while (it != sigVec.end()) { MsgArg args[3]; args[0].Set("s", name.c_str()); args[1].Set("q", transport); String prefix = it->first.substr(0, it->first.find_last_of('*')); args[2].Set("s", prefix.c_str()); QCC_DbgPrintf(("Sending LostAdvertisedName(%s, 0x%x, %s) to %s", name.c_str(), transport, prefix.c_str(), it->second.c_str())); QStatus tStatus = Signal(it->second.c_str(), 0, *lostAdvNameSignal, args, ArraySize(args)); if (ER_OK != tStatus) { status = (ER_OK == status) ? tStatus : status; if (status != ER_BUS_NO_ROUTE) { QCC_LogError(tStatus, ("Failed to send LostAdvertisedName to %s (name=%s)", it->second.c_str(), name.c_str())); } } ++it; } return status; } void AllJoynObj::SendIPNSResponse(String name, uint32_t replyCode) { AcquireLocks(); multimap::iterator it = incomingPingMap.lower_bound(name); list temp; while (it != incomingPingMap.end() && it->first == name) { temp.push_back(it->second); incomingPingMap.erase(it++); } ReleaseLocks(); list::iterator it1 = temp.begin(); while (it1 != temp.end()) { PingResponse((*it1).transport, (*it1).dst, name, replyCode); it1++; } } void AllJoynObj::AlarmTriggered(const Alarm& alarm, QStatus reason) { QCC_DbgPrintf(("AlarmTriggered")); if (alarm->GetContext() != NameMapEntry::truthiness) { assert(alarm->GetContext()); PingAlarmContext* ctx = static_cast(alarm->GetContext()); if (ctx->type == PingAlarmContext::TRANSPORT_CONTEXT) { if (ctx->name[0] == ':' && !router.IsValidLocalUniqueName(ctx->name)) { SendIPNSResponse(ctx->name, ALLJOYN_PING_REPLY_UNKNOWN_NAME); delete ctx; return; } ProxyBusObject peerObj(bus, ctx->name.c_str(), "/", 0); const InterfaceDescription* intf = bus.GetInterface(org::freedesktop::DBus::Peer::InterfaceName); assert(intf); peerObj.AddInterface(*intf); QStatus status = peerObj.MethodCallAsync(org::freedesktop::DBus::Peer::InterfaceName, "Ping", this, static_cast(&AllJoynObj::PingReplyTransportHandler), NULL, 0, ctx); if (status != ER_OK) { /* * UNREACHABLE may not be the correct reply code here, a failure * status indicates only that setting up the async method call * failed. */ SendIPNSResponse(ctx->name, ALLJOYN_PING_REPLY_UNREACHABLE); delete ctx; } } else { //REPLY_CONTEXT AcquireLocks(); multimap, OutgoingPingInfo>::iterator it = outgoingPingMap.find(pair(ctx->name, ctx->sender)); if (it != outgoingPingMap.end()) { OutgoingPingInfo opi = it->second; outgoingPingMap.erase(it); ReleaseLocks(); PingReplyMethodHandlerUsingCode(opi.message, ALLJOYN_PING_REPLY_TIMEOUT); } else { ReleaseLocks(); } delete ctx; } return; } // // Check if TTL is 80% of time or 90% of time // If 80% // Initiate a search query for "*" // Set the alarm to 90% of time // If 90% // Initiate a search query for "*" // Set the alarm for full TTL time out AcquireLocks(); uint64_t now = GetTimestamp64(); uint64_t timePassed; uint64_t ttl; multimap::iterator it = nameMap.begin(); set guidSet; while (it != nameMap.end()) { NameMapEntry& nme = it->second; timePassed = now - nme.timestamp; ttl = nme.ttl; QCC_DbgPrintf(("Time Passed %ld ttl-80 : %ld ttl-90 : %ld", timePassed, (uint64_t)(ttl * 80 / 100), (uint64_t)(ttl * 90 / 100))); if ((timePassed >= (ttl * 80 / 100)) && (timePassed < ttl)) { if (discoverMap.size() > 0) { // // Send Unicast search query only if there are discoverers // QCC_DbgPrintf(("AlarmTriggered sending query \"*\" Name : %s GUID : %s nme.transport %x", it->first.c_str(), it->second.guid.c_str(), nme.transport)); guidSet.insert(nme.guid); } } if ((timePassed >= (ttl * 80 / 100)) && (timePassed < (ttl * 90 / 100))) { // // Set the next alarm of this entry to 90% of ttl // const uint32_t timeout = (ttl * 90 / 100) - timePassed; QCC_DbgPrintf(("AlarmTriggered for 80 time for Name : %s GUID : %s Next alarm in %d", it->first.c_str(), it->second.guid.c_str(), timeout)); AllJoynObj* pObj = this; Alarm newAlarm(timeout, pObj, NameMapEntry::truthiness); QStatus status = timer.ReplaceAlarm(nme.alarm, newAlarm, false); nme.alarm = newAlarm; QCC_DbgPrintf(("Resetting alarm for name %s", it->first.c_str())); if (ER_OK != status) { /* This is expected if a prior name set changed in any way (order, removed entry, etc) */ status = timer.AddAlarm(nme.alarm); if (ER_OK != status && ER_TIMER_EXITING != status) { QCC_LogError(status, ("Failed to update alarm")); } } } if ((timePassed >= (ttl * 90 / 100)) && (timePassed < ttl)) { // // Set the next alarm to TTL - timePassed // const uint32_t timeout = (ttl) - timePassed; QCC_DbgPrintf(("AlarmTriggered for 90 time for Name : %s GUID : %s Next alarm in %ld", it->first.c_str(), it->second.guid.c_str(), timeout)); AllJoynObj* pObj = this; Alarm newAlarm(timeout, pObj, NameMapEntry::truthiness); QStatus status = timer.ReplaceAlarm(nme.alarm, newAlarm, false); nme.alarm = newAlarm; QCC_DbgPrintf(("Resetting alarm for name %s", it->first.c_str())); if (ER_OK != status) { /* This is expected if a prior name set changed in any way (order, removed entry, etc) */ status = timer.AddAlarm(nme.alarm); if (ER_OK != status && ER_TIMER_EXITING != status) { QCC_LogError(status, ("Failed to update alarm")); } } } ++it; } ReleaseLocks(); set::const_iterator git = guidSet.begin(); while (git != guidSet.end()) { QStatus status = IpNameService::Instance().RefreshCache(TRANSPORT_TCP | TRANSPORT_UDP, *git, "name='*'"); if (ER_OK != status) { QCC_LogError(status, ("Error while sending query for Cache refresh")); } git++; } // if 100* of time // do all the things below // AND if not in a session // Remove from PeerInfoMap // if (ER_OK == reason) { set > lostNameSet; AcquireLocks(); if ((bool)alarm->GetContext()) { multimap::iterator it = nameMap.begin(); uint64_t now = GetTimestamp64(); while (it != nameMap.end()) { NameMapEntry& nme = it->second; qcc::String guidToBeChecked = it->second.guid; if ((now - nme.timestamp) >= nme.ttl) { bool sendSignal = true; multimap::iterator it1 = nameMap.find(it->first); /* Send a LostAdvertisedName signal if this is the last namemap entry of this transport for this name. */ while ((it1 != nameMap.end()) && (it->first == it1->first)) { if ((nme.guid == it1->second.guid) && (nme.transport & it1->second.transport) && (nme.busAddr != it1->second.busAddr)) { sendSignal = false; break; } it1++; } if (sendSignal) { QCC_DbgPrintf(("Expiring discovered name %s for guid %s", it->first.c_str(), nme.guid.c_str())); lostNameSet.insert(pair(it->first, nme.transport)); } /* Remove alarm */ timer.RemoveAlarm(nme.alarm, false); nme.alarm->SetContext((void*)false); nameMap.erase(it++); // // Check if guid for this name is eligible for removal from PeerInfoMap in Name service // if (!IsGuidLongStringAdvertising(guidToBeChecked)) { IpNameService::Instance().RemoveFromPeerInfoMap(guidToBeChecked); } } else { ++it; } } } ReleaseLocks(); set >::const_iterator lit = lostNameSet.begin(); while (lit != lostNameSet.end()) { /* Send LostAdvetisedName signals */ SendLostAdvertisedName(lit->first, lit->second); /* Clean advAliasMap */ CleanAdvAliasMap(lit->first, lit->second); lit++; } } } void AllJoynObj::CancelSessionlessMessage(const InterfaceDescription::Member* member, Message& msg) { QCC_UNUSED(member); busController->GetSessionlessObj().CancelMessage(msg); } void AllJoynObj::CancelSessionlessMessageReply(Message& msg, QStatus status) { /* Form response and send it */ MsgArg replyArg; uint32_t replyCode; switch (status) { case ER_OK: replyCode = ALLJOYN_CANCELSESSIONLESS_REPLY_SUCCESS; break; case ER_BUS_NO_SUCH_MESSAGE: replyCode = ALLJOYN_CANCELSESSIONLESS_REPLY_NO_SUCH_MSG; break; case ER_BUS_NOT_ALLOWED: replyCode = ALLJOYN_CANCELSESSIONLESS_REPLY_NOT_ALLOWED; break; default: replyCode = ALLJOYN_CANCELSESSIONLESS_REPLY_FAILED; break; } replyArg.Set("u", replyCode); status = MethodReply(msg, &replyArg, 1); if (ER_OK != status) { QCC_LogError(status, ("AllJoynObj::CancelSessionlessMessage() failed to send reply message")); } } void AllJoynObj::Ping(const InterfaceDescription::Member* member, Message& msg) { QCC_UNUSED(member); QCC_DbgTrace(("AllJoynObj::Ping()")); uint32_t replyCode = ALLJOYN_PING_REPLY_SUCCESS; TransportMask transports = TRANSPORT_ANY; size_t numArgs; const MsgArg* args; String sender = msg->GetSender(); BusEndpoint senderEp = FindEndpoint(sender); /* Parse the message args */ msg->GetArgs(numArgs, args); const char* name = NULL; uint32_t timeout; QStatus status = MsgArg::Get(args, numArgs, "su", &name, &timeout); if (status == ER_OK && senderEp->IsValid()) { status = TransportPermission::FilterTransports(senderEp, sender, transports, "AllJoynObj::Ping"); } if (status == ER_OK) { PermissionMgr::DaemonBusCallPolicy policy = PermissionMgr::GetDaemonBusCallPolicy(senderEp); bool rejectCall = false; if (policy == PermissionMgr::STDBUSCALL_SHOULD_REJECT) { rejectCall = true; } else if (policy == PermissionMgr::STDBUSCALL_ALLOW_ACCESS_SERVICE_LOCAL) { transports &= TRANSPORT_LOCAL; QCC_DbgPrintf(("The sender endpoint is only allowed to use local transport.")); } if (rejectCall) { QCC_DbgPrintf(("The sender endpoint is not allowed to call Ping()")); replyCode = ALLJOYN_PING_REPLY_FAILED; /* Reply to request */ MsgArg replyArg("u", replyCode); status = MethodReply(msg, &replyArg, 1); QCC_DbgPrintf(("AllJoynObj::Ping(%s) returned %d (status=%s)", name, replyCode, QCC_StatusText(status))); return; } } if (status != ER_OK) { replyCode = ALLJOYN_PING_REPLY_FAILED; QCC_DbgTrace(("Ping(")); } else { assert(name); QCC_DbgTrace(("Ping(%s)", name)); /* Decide how to proceed based on the endpoint existence/type */ BusEndpoint ep = FindEndpoint(name); if ((ep->GetEndpointType() == ENDPOINT_TYPE_REMOTE) || (ep->GetEndpointType() == ENDPOINT_TYPE_NULL) || (ep->GetEndpointType() == ENDPOINT_TYPE_LOCAL) || (ep->GetEndpointType() == ENDPOINT_TYPE_VIRTUAL)) { AcquireLocks(); if (dbusPingsInProgress.find(pair(msg->GetSender(), name)) != dbusPingsInProgress.end()) { replyCode = ALLJOYN_PING_REPLY_IN_PROGRESS; ReleaseLocks(); } else { dbusPingsInProgress.insert(pair(msg->GetSender(), name)); ReleaseLocks(); /* Ping is to a locally connected or remote in session attachment */ ProxyBusObject peerObj(bus, name, "/", 0); const InterfaceDescription* intf = bus.GetInterface(org::freedesktop::DBus::Peer::InterfaceName); assert(intf); peerObj.AddInterface(*intf); Message* ctx = new Message(msg); status = peerObj.MethodCallAsync(org::freedesktop::DBus::Peer::InterfaceName, "Ping", this, static_cast(&AllJoynObj::PingReplyMethodHandler), NULL, 0, ctx); if (status != ER_OK) { QCC_LogError(status, ("Send Ping failed")); delete ctx; replyCode = ALLJOYN_PING_REPLY_UNREACHABLE; AcquireLocks(); dbusPingsInProgress.erase(pair(msg->GetSender(), name)); ReleaseLocks(); } } } else { /* * First order of business is to locate a guid corresponding to the name. * The logic below follows the same logic as joining a session. */ // Check if the name is advertised TransportMask transport = TRANSPORT_TCP | TRANSPORT_UDP | TRANSPORT_LOCAL; // TODO transport hard-coded String guid; AcquireLocks(); for (multimap::iterator nmit = nameMap.lower_bound(name); nmit != nameMap.end() && (nmit->first == name); ++nmit) { if (nmit->second.transport & transport) { guid = qcc::GUID128(nmit->second.guid).ToShortString(); break; } } if (!ep->IsValid()) { if (name[0] != ':') { // Well known name if (guid.empty()) { // No guid found for well known name replyCode = ALLJOYN_PING_REPLY_UNKNOWN_NAME; } else if (guid == bus.GetInternal().GetGlobalGUID().ToShortString()) { // Locally advertised not requested replyCode = ALLJOYN_PING_REPLY_UNREACHABLE; } } else { // Unique name String nameStr(name); String guidStr = nameStr.substr(1, GUID128::SIZE_SHORT); if (guidStr == bus.GetInternal().GetGlobalGUID().ToShortString()) { // Guid matches our guid but endpoint is invalid. // Check NameTable to find out if this is a name that has been assigned. if (!router.IsValidLocalUniqueName(nameStr)) { replyCode = ALLJOYN_PING_REPLY_UNKNOWN_NAME; } else { replyCode = ALLJOYN_PING_REPLY_UNREACHABLE; } } else if (IsGuidShortStringAdvertising(guidStr)) { guid = guidStr; } else { replyCode = ALLJOYN_PING_REPLY_UNKNOWN_NAME; } } } if (!guid.empty() && replyCode == ALLJOYN_PING_REPLY_SUCCESS) { QCC_DbgPrintf(("Pinging GUID %s", guid.c_str())); if (outgoingPingMap.find(pair(name, msg->GetSender())) != outgoingPingMap.end()) { replyCode = ALLJOYN_PING_REPLY_IN_PROGRESS; ReleaseLocks(); } else { PingAlarmContext* ctx = new PingAlarmContext(PingAlarmContext::REPLY_CONTEXT, name, msg->GetSender()); AllJoynObj* pObj = this; Alarm alarm(timeout, pObj, ctx); OutgoingPingInfo ogi(alarm, msg); pair key(name, msg->GetSender()); outgoingPingMap.insert(pair, OutgoingPingInfo>(key, ogi)); timer.AddAlarm(alarm); ReleaseLocks(); status = IpNameService::Instance().Ping(transport, guid, name); if (status != ER_OK) { QCC_DbgPrintf(("Query failed status %s", QCC_StatusText(status))); AcquireLocks(); multimap, OutgoingPingInfo>::iterator it = outgoingPingMap.find(key); if (it != outgoingPingMap.end()) { replyCode = (status == ER_ALLJOYN_PING_REPLY_INCOMPATIBLE_REMOTE_ROUTING_NODE) ? ALLJOYN_PING_REPLY_INCOMPATIBLE_REMOTE_ROUTING_NODE : ALLJOYN_PING_REPLY_FAILED; outgoingPingMap.erase(it); } if (timer.RemoveAlarm(alarm, false)) { //Delete ctx if alarm was successfully removed. delete ctx; } ReleaseLocks(); } } } else { if (replyCode != ALLJOYN_PING_REPLY_UNREACHABLE) { replyCode = ALLJOYN_PING_REPLY_UNKNOWN_NAME; } ReleaseLocks(); } } } /* Reply to request if something went wrong. The success case is handled asynchronously. */ if (replyCode != ALLJOYN_PING_REPLY_SUCCESS) { MsgArg replyArg("u", replyCode); status = MethodReply(msg, &replyArg, 1); QCC_DbgPrintf(("AllJoynObj::Ping(%s) returned %d (status=%s)", name, replyCode, QCC_StatusText(status))); /* Log error if reply could not be sent */ if (ER_OK != status) { QCC_LogError(status, ("Failed to respond to org.alljoyn.Bus.Ping")); } } return; } void AllJoynObj::PingReplyMethodHandler(Message& reply, void* context) { QCC_DbgTrace(("AllJoynObj::PingReplyMethodHandler()")); Message* msg = static_cast(context); uint32_t replyCode = (ajn::MESSAGE_ERROR == reply->GetType()) ? ALLJOYN_PING_REPLY_UNREACHABLE : ALLJOYN_PING_REPLY_SUCCESS; /* Parse the message args */ size_t numArgs; const MsgArg* args; (*msg)->GetArgs(numArgs, args); const char* name = NULL; uint32_t timeout; MsgArg::Get(args, numArgs, "su", &name, &timeout); AcquireLocks(); dbusPingsInProgress.erase(pair((*msg)->GetSender(), name)); ReleaseLocks(); PingReplyMethodHandlerUsingCode(*msg, replyCode); delete msg; } /* From IpNameServiceListener */ bool AllJoynObj::ResponseHandler(TransportMask transport, MDNSPacket response, uint16_t recvPort) { QCC_UNUSED(transport); /* * Note that we always return false here so that other name service * listeners can process other records in the response. */ MDNSResourceRecord* pingReplyRecord; if ((recvPort == IpNameService::MULTICAST_MDNS_PORT) || !response->GetAdditionalRecord("ping-reply.*", MDNSResourceRecord::TXT, &pingReplyRecord)) { return false; } MDNSPingReplyRData* pingRData = static_cast(pingReplyRecord->GetRData()); if (!pingRData) { QCC_DbgPrintf(("Ignoring response with invalid ping info")); return false; } QCC_DbgPrintf(("Recieved a ping response for name %s", pingRData->GetWellKnownName().c_str())); const String& name = pingRData->GetWellKnownName(); uint32_t replyCode; if (pingRData->GetReplyCode() == "ALLJOYN_PING_REPLY_SUCCESS") { replyCode = ALLJOYN_PING_REPLY_SUCCESS; } else if (pingRData->GetReplyCode() == "ALLJOYN_PING_REPLY_UNREACHABLE") { replyCode = ALLJOYN_PING_REPLY_UNREACHABLE; } else { replyCode = ALLJOYN_PING_REPLY_UNKNOWN_NAME; } AcquireLocks(); std::multimap, OutgoingPingInfo>::iterator it = outgoingPingMap.lower_bound(pair(name, "")); list replyMsgs; while (it != outgoingPingMap.end() && it->first.first == name) { // TODO May need to filter on transport OutgoingPingInfo opi = it->second; outgoingPingMap.erase(it++); replyMsgs.push_back(opi.message); PingAlarmContext* ctx = static_cast(opi.alarm->GetContext()); if (timer.RemoveAlarm(opi.alarm, false)) { //Delete context if alarm was successfully removed. delete ctx; } } ReleaseLocks(); for (list::iterator it = replyMsgs.begin(); it != replyMsgs.end(); it++) { PingReplyMethodHandlerUsingCode(*it, replyCode); } return false; } void AllJoynObj::PingReplyMethodHandlerUsingCode(Message& msg, uint32_t replyCode) { QCC_DbgTrace(("AllJoynObj::PingReplyMethodHandlerUsingCode()")); const char* name = NULL; msg->GetArgs("s", &name); QCC_DbgPrintf(("AllJoynObj::Ping(%s) returned %d", name, replyCode)); MsgArg replyArg("u", replyCode); MethodReply(msg, &replyArg, 1); } /* From IpNameServiceListener */ bool AllJoynObj::QueryHandler(TransportMask transport, MDNSPacket query, const qcc::IPEndpoint& src, const qcc::IPEndpoint& dst) { MDNSResourceRecord* pingRecord; if ((src.port == IpNameService::MULTICAST_MDNS_PORT) || !query->GetAdditionalRecord("ping.*", MDNSResourceRecord::TXT, &pingRecord)) { return false; } MDNSPingRData* pingRData = static_cast(pingRecord->GetRData()); if (!pingRData) { QCC_DbgPrintf(("Ignoring query with invalid ping info")); return true; } const String& name = pingRData->GetWellKnownName(); //If incomingPingMap does not have this key, then add an alarm //in any case add it to incomingPingMap. AcquireLocks(); bool alarmFound = (incomingPingMap.find(name) != incomingPingMap.end()); IncomingPingInfo ipi(transport, dst); incomingPingMap.insert(pair(name, ipi)); if (!alarmFound) { uint32_t timeout = 0; PingAlarmContext* ctx = new PingAlarmContext(PingAlarmContext::TRANSPORT_CONTEXT, name); AllJoynObj* pObj = this; Alarm alarm(timeout, pObj, ctx); timer.AddAlarm(alarm); } ReleaseLocks(); return true; } void AllJoynObj::PingReplyTransportHandler(Message& reply, void* context) { PingAlarmContext* ctx = static_cast(context); if (ajn::MESSAGE_ERROR == reply->GetType()) { const char* errorName = reply->GetErrorName(); if (errorName && (0 == strcmp(errorName, "org.alljoyn.Bus.Timeout"))) { /* * There may be multiple ping callers with different timeouts being * serviced by a single DBus Ping, so don't send a response here, * let the caller timeout on their own schedule. */ } else { /* Likely error name is "org.freedesktop.DBus.Error.ServiceUnknown */ SendIPNSResponse(ctx->name, ALLJOYN_PING_REPLY_UNREACHABLE); } } else { SendIPNSResponse(ctx->name, ALLJOYN_PING_REPLY_SUCCESS); } delete ctx; } void AllJoynObj::PingResponse(TransportMask transport, const qcc::IPEndpoint& dst, const qcc::String& name, uint32_t replyCode) { MDNSPacket response; response->SetDestination(dst); // Similar to advertise record with only one name MDNSPingReplyRData* pingReplyRData = new MDNSPingReplyRData(); pingReplyRData->SetWellKnownName(name); String replyCodeText; if (replyCode == ALLJOYN_PING_REPLY_SUCCESS) { replyCodeText = "ALLJOYN_PING_REPLY_SUCCESS"; } else if (replyCode == ALLJOYN_PING_REPLY_UNREACHABLE) { replyCodeText = "ALLJOYN_PING_REPLY_UNREACHABLE"; } else { replyCodeText = "ALLJOYN_PING_REPLY_UNKNOWN_NAME"; } pingReplyRData->SetReplyCode(replyCodeText); MDNSResourceRecord pingReplyRecord("ping-reply." + guid.ToString() + ".local.", MDNSResourceRecord::TXT, MDNSResourceRecord::INTERNET, 120, pingReplyRData); response->AddAdditionalRecord(pingReplyRecord); delete pingReplyRData; QStatus status = IpNameService::Instance().Response(transport, 120, response); if (ER_OK != status) { QCC_LogError(status, ("Response failed")); } } } alljoyn-15.04b/alljoyn_core/router/AllJoynObj.h000066400000000000000000001553441255700255500215330ustar00rootroot00000000000000/** * @file * BusObject responsible for implementing the AllJoyn methods (org.alljoyn.Bus) * for messages directed to the bus. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_ALLJOYNOBJ_H #define _ALLJOYN_ALLJOYNOBJ_H #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include "Bus.h" #include "BusUtil.h" #include "NameTable.h" #include "RemoteEndpoint.h" #include "Transport.h" #include "VirtualEndpoint.h" #include "PermissionMgr.h" #include "ns/IpNameService.h" namespace ajn { /** Forward Declaration */ class BusController; /** * BusObject responsible for implementing the standard AllJoyn methods at org.alljoyn.Bus * for messages directed to the bus. */ class AllJoynObj : public BusObject, public NameListener, public TransportListener, public qcc::AlarmListener, public IpNameServiceListener { friend class _RemoteEndpoint; struct PingAlarmContext; struct SessionMapEntry; class OutgoingPingInfo { public: qcc::Alarm alarm; Message message; OutgoingPingInfo(qcc::Alarm alarm, Message message) : alarm(alarm), message(message) { }; private: OutgoingPingInfo(); }; class IncomingPingInfo { public: TransportMask transport; qcc::IPEndpoint dst; IncomingPingInfo(TransportMask transport, qcc::IPEndpoint dst) : transport(transport), dst(dst) { }; private: IncomingPingInfo(); }; public: typedef enum { LEAVE_HOSTED_SESSION, LEAVE_JOINED_SESSION, LEAVE_SESSION, } LeaveSessionType; /** * Constructor * * @param bus Bus to associate with org.freedesktop.DBus message handler. * @param router The DaemonRouter associated with the bus. * @param busController Controller that created this object. */ AllJoynObj(Bus& bus, BusController* busController, DaemonRouter& router); /** * Destructor */ virtual ~AllJoynObj(); /** * Initialize and register this DBusObj instance. * * @return ER_OK if successful. */ QStatus Init(); /** * Stop AlljoynObj. * * @return ER_OK if successful. */ QStatus Stop(); /** * Join AlljoynObj. * * @return ER_OK if successful. */ QStatus Join(); /** * Called when object is successfully registered. */ void ObjectRegistered(void); /** * Respond to a bus request to bind a SessionPort. * * The input Message (METHOD_CALL) is expected to contain the following parameters: * sessionPort sessionPort SessionPort identifier. * opts SessionOpts SessionOpts that must be agreeable to any joiner. * * The output Message (METHOD_REPLY) contains the following parameters: * resultCode uint32 An ALLJOYN_BINDSESSIONPORT_* reply code (see AllJoynStd.h). * sessionPort uint16 SessionPort (same as input sessionPort unless SESSION_PORT_ANY was specified) * * @param member Member. * @param msg The incoming message. */ void BindSessionPort(const InterfaceDescription::Member* member, Message& msg); /** * Respond to a bus request to unbind a SessionPort. * * The input Message (METHOD_CALL) is expected to contain the following parameters: * sessionPort sessionPort SessionPort to be unbound. * * The output Message (METHOD_REPLY) contains the following parameters: * resultCode uint32 An ALLJOYN_UNBINDSESSIONPORT_* reply code (see AllJoynStd.h). * * @param member Member. * @param msg The incoming message. */ void UnbindSessionPort(const InterfaceDescription::Member* member, Message& msg); /** * Respond to a bus request to join an existing session. * * The input Message (METHOD_CALL) is expected to contain the following parameters: * creatorName string Name of session creator. * sessionPort SessionPort SessionPort targeted for join request. * opts SessionOpts Session options requested by the joiner. * * The output Message (METHOD_REPLY) contains the following parameters: * resultCode uint32 A ALLJOYN_JOINSESSION_* reply code (see AllJoynStd.h). * sessionId uint32 Session identifier. * opts SessionOpts Final (negociated) session options. * * @param member Member. * @param msg The incoming message. */ void JoinSession(const InterfaceDescription::Member* member, Message& msg); /** * Respond to a bus request to leave a previously joined or created session. * Note this function will produce an error if called on a self-joined session by * a self-joined member (host or joiner) * * @param member Member. * @param msg The incoming message. */ void LeaveSession(const InterfaceDescription::Member* member, Message& msg); /** * Respond to a bus request to leave a created session. * * * @param member Member. * @param msg The incoming message. */ void LeaveHostedSession(const InterfaceDescription::Member* member, Message& msg); /** * Respond to a bus request to leave a joined session. * * @param member Member. * @param msg The incoming message. */ void LeaveJoinedSession(const InterfaceDescription::Member* member, Message& msg); /** * Checks whether the LeaveSession/LeaveHostedSession/LeaveJoinedSession * request is valid * * @param smEntry Relevant sessionMapEntry * @param sender Sender of the request * @param id sessionid * @param lst type of leavesession request * @param senderWasSelfJoined indicates whether sender was involved in self-joined session * * @return Returns an ALLJOYN_LEAVESESSION_REPLY_* * */ uint32_t CheckLeaveSession(const SessionMapEntry* smEntry, const char* sender, SessionId id, LeaveSessionType lst, bool& senderWasSelfJoined) const; /** * Common logic for all LeaveSession requests * * The input Message (METHOD_CALL) is expected to contain the following parameters: * sessionId uint32 Session identifier. * * The output Message (METHOD_REPLY) contains the following parameters: * resultCode uint32 A ALLJOYN_LEAVESESSION_* reply code (see AllJoynStd.h). * * @param member Member. * @param msg The incoming message. * @param lst type of leavesession request */ void LeaveSessionCommon(const InterfaceDescription::Member* member, Message& msg, LeaveSessionType lst); /** * Respond to a bus request to advertise the existence of a remote AllJoyn instance. * * The input Message (METHOD_CALL) is expected to contain the following parameters: * advertisedName string A locally obtained well-known name that should be advertised to external AllJoyn instances. * * The output Message (METHOD_REPLY) contains the following parameters: * resultCode uint32 A ALLJOYN_ADVERTISE_* reply code (see AllJoynStd.h) * * @param member Member. * @param msg The incoming message. */ void AdvertiseName(const InterfaceDescription::Member* member, Message& msg); /** * Respond to a bus request to cancel a previous advertisement. * * The input Message (METHOD_CALL) is expected to contain the following parameters: * advertisedName string A previously advertised well-known name that no longer needs to be advertised. * * The output Message (METHOD_REPLY) contains the following parameters: * resultCode uint32 A ALLJOYN_ADVERTISE_* reply code (see AllJoynStd.h) * * @param member Member. * @param msg The incoming message. */ void CancelAdvertiseName(const InterfaceDescription::Member* member, Message& msg); /** * Respond to a bus request to look for advertisements from remote AllJoyn instances. * * The input Message (METHOD_CALL) is expected to contain the following parameters: * namePrefix string A well-known name prefix that the caller wants to be notified of (via signal) * when a remote Bus instance is found that advertises a name that matches the prefix. * * The output Message (METHOD_REPLY) contains the following parameters: * resultCode uint32 A ALLJOYN_FINDNAME_* reply code (see AllJoynStd.h) * * @param member Member. * @param msg The incoming message. */ void FindAdvertisedName(const InterfaceDescription::Member* member, Message& msg); /** * Respond to a bus request to look for advertisements from remote AllJoyn instances over a set of specified transports. * * The input Message (METHOD_CALL) is expected to contain the following parameters: * namePrefix string A well-known name prefix that the caller wants to be notified of (via signal) * when a remote Bus instance is found that advertises a name that matches the prefix. * transports uint16 Transport bit mask * * The output Message (METHOD_REPLY) contains the following parameters: * resultCode uint32 A ALLJOYN_FINDNAME_* reply code (see AllJoynStd.h) * * @param member Member. * @param msg The incoming message. */ void FindAdvertisedNameByTransport(const InterfaceDescription::Member* member, Message& msg); /** * Respond to a bus request to look for advertisements from remote AllJoyn instances over a set of specified transports. * * The input Message (METHOD_CALL) is expected to contain the following parameters: * matching string Key, value match criteria that the caller wants to be notified of (via signal) * when a remote Bus instance is found with an advertisement that matches the criteria. * transports uint16 Transport bit mask * * The output Message (METHOD_REPLY) contains the following parameters: * resultCode uint32 A ALLJOYN_FINDNAME_* reply code (see AllJoynStd.h) * * @param member Member. * @param msg The incoming message. */ void FindAdvertisementByTransport(const InterfaceDescription::Member* member, Message& msg); /** * Respond to a bus request to cancel a previous (successful) FindName request. * * The input Message (METHOD_CALL) is expected to contain the following parameters: * namePrefix string The well-known name prefix that was used in a successful call to FindName. * * The output Message (METHOD_REPLY) contains the following parameters: * resultCode uint32 A ALLJOYN_CANCELFINDNAME_* reply code (see AllJoynStd.h) * * @param member Member. * @param msg The incoming message. */ void CancelFindAdvertisedName(const InterfaceDescription::Member* member, Message& msg); /** * Respond to a bus request to cancel a previous (successful) FindName request over a set of specified transports. * * The input Message (METHOD_CALL) is expected to contain the following parameters: * namePrefix string The well-known name prefix that was used in a successful call to FindName. * transports uint16 Transport bit mask * * The output Message (METHOD_REPLY) contains the following parameters: * resultCode uint32 A ALLJOYN_CANCELFINDNAME_* reply code (see AllJoynStd.h) * * @param member Member. * @param msg The incoming message. */ void CancelFindAdvertisedNameByTransport(const InterfaceDescription::Member* member, Message& msg); /** * Respond to a bus request to cancel a previous (successful) FindAdvertisement request over a set of specified transports. * * The input Message (METHOD_CALL) is expected to contain the following parameters: * matching string The key, value match criteria that was used in a successful call to FindAdvertisement. * transports uint16 Transport bit mask * * The output Message (METHOD_REPLY) contains the following parameters: * resultCode uint32 A ALLJOYN_CANCELFINDNAME_* reply code (see AllJoynStd.h) * * @param member Member. * @param msg The incoming message. */ void CancelFindAdvertisementByTransport(const InterfaceDescription::Member* member, Message& msg); /** * Respond to a bus request to get a (streaming) file descritor for an existing session. * * The input Message (METHOD_CALL) is expected to contain the following parameters: * sessionId uint32 A session id that identifies an existing streaming session. * * The output Message (METHOD_REPLY) contains the following parameters: * sessionFd handle The socket file descriptor for session. * * @param member Member. * @param msg The incoming message. */ void GetSessionFd(const InterfaceDescription::Member* member, Message& msg); /** * Respond to a bus request to set the link timeout for a given session. * * The input Message (METHOD_CALL) is expected to contain the following parameters: * sessionId uint32 A session id that identifies an existing streaming session. * reqLinkTimeout uint32 Requested max number of seconds that an unresponsive comm link * will be monitored before delcaring the link dead via SessionLost. * * The output Message (METHOD_REPLY) contains the following parameters: * resultCode uint32 ALLJOYN_SETLINKTIMEOUT_REPLY_* value. * actLinkTimeout uint32 Actual link timeout value. * * @param member Member. * @param msg The incoming message. */ void SetLinkTimeout(const InterfaceDescription::Member* member, Message& msg); /** * Respond to a bus request to set the idle timeouts for a leaf node. * * The input Message (METHOD_CALL) is expected to contain the following parameters: * reqIdleTO uint32 Requested Idle Timeout for the link. i.e. time after which the Routing node must * must send a DBus ping to Leaf node in case of inactivity. * Use 0 to leave unchanged. * reqProbeTO uint32 Requested Probe timeout. The time from the Routing node sending the DBus * ping to the expected response. * Use 0 to leave unchanged. * * Output params: * The output Message (METHOD_REPLY) contains the following parameters: * disposition uint32 ALLJOYN_SETIDLETIMEOUTS_* value * actIdleTO uint32 Actual Idle Timeout. i.e. time after which the Routing node will * send a DBus ping to Leaf node in case of inactivity. * actProbeTO uint32 Actual Probe Timeout. The time from the Routing node sending the DBus ping * to the expected response from the leaf node. * * @param member Member. * @param msg The incoming message. */ void SetIdleTimeouts(const InterfaceDescription::Member* member, Message& msg); /** * Add an alias to a Unix User ID * The input Message (METHOD_CALL) is expected to contain the following parameter * aliasUID uint32 The alias ID * * The output Message (METHOD_REPLY) contains the following parameters: * resultCode uint32 ALLJOYN_ALIASUNIXUSER_REPLY_* value. * * @param member Member. * @param msg The incoming message. */ void AliasUnixUser(const InterfaceDescription::Member* member, Message& msg); /** * Add an advertised name alias for remote daemon guid. * * This method is used by SessionlessObj to tell AllJoynObj that JoinSession requests * for unique names containing the given GUID / transport mask should be aliased with the * given well-known name for the purpose of estabilishing a transport connection. * * @param guid Short GUID string of remote daemon that advertised the name. * @param mask Transport used by remote daemon to advertise advName. * @param advName Well-known name advertised by remote daemon. */ void AddAdvNameAlias(const qcc::String& guid, const TransportMask mask, const qcc::String& advName); /** * Handle event that the application/process is suspending on OS like WinRT. * On Windows RT, an application is suspended when it becomes invisible after about * 10 seconds and resumed when users bring it back to the foreground if not terminated. * Upon the suspending event the daemon bundled with the Windows Store applcation has to release * exclusive resources (eg., socket file descriptor and port); the bundled daemon re-aquires the * resource when the application resumes. * * The input Message (METHOD_CALL) is expected to contain no parameters. * * The output Message (METHOD_REPLY) contains the following parameters: * resultCode uint32 A ALLJOYN_ONAPPSUSPEND_* reply code (see AllJoynStd.h) * * @param member Member. * @param msg The incoming message. * */ void OnAppSuspend(const InterfaceDescription::Member* member, Message& msg); /** * Handle event that the application/process is suspending on OS like WinRT. * On Windows RT, an application is suspended when it becomes invisible after about * 10 seconds and resumed when users bring it back to the foreground if not terminated. * Upon the suspending event the daemon bundled with the Windows Store applcation has to release * exclusive resources (eg., socket file descriptor and port); the bundled daemon re-aquires the * resource when the application resumes. * * The input Message (METHOD_CALL) is expected to contain no parameters. * * The output Message (METHOD_REPLY) contains the following parameters: * resultCode uint32 A ALLJOYN_ONAPPRESUME_* reply code (see AllJoynStd.h) * * @param member Member. * @param msg The incoming message. * */ void OnAppResume(const InterfaceDescription::Member* member, Message& msg); /** * Method handler for org.alljoyn.Bus.CancelSessionlessMessage * * @param member Interface member. * @param msg The incoming method call message. * */ void CancelSessionlessMessage(const InterfaceDescription::Member* member, Message& msg); /** * Sends a method reply to org.alljoyn.Bus.CancelSessionlessMessage. * * @param msg The org.alljoyn.Bus.CancelSessionlessMessage method call message. * @param status The result of CancelSessionlessMessage. */ void CancelSessionlessMessageReply(Message& msg, QStatus status); /** * Method handler for org.alljoyn.Bus.RemoveSessionMember * * @param member Interface member. * @param msg The incoming method call message. * */ void RemoveSessionMember(const InterfaceDescription::Member* member, Message& msg); /** * Method handler for org.alljoyn.Bus.GetHostInfo * * @param member Interface member. * @param msg The incoming method call message. * */ void GetHostInfo(const InterfaceDescription::Member* member, Message& msg); /** * Method handler for org.alljoyn.Bus.ReloadConfig * * @param member Interface member. * @param msg The incoming method call message. * */ void ReloadConfig(const InterfaceDescription::Member* member, Message& msg); /** * Method handler for org.alljoyn.Bus.Ping * * @param member Interface member. * @param msg The incoming method call message. * */ void Ping(const InterfaceDescription::Member* member, Message& msg); /** * Add a new Bus-to-bus endpoint. * * @param endpoint Bus-to-bus endpoint to add. * @param ER_OK if successful */ QStatus AddBusToBusEndpoint(RemoteEndpoint& endpoint); /** * Remove an existing Bus-to-bus endpoint. * * @param endpoint Bus-to-bus endpoint to add. */ void RemoveBusToBusEndpoint(RemoteEndpoint& endpoint); /** * Respond to a remote daemon request to attach a session through this daemon. * * The input Message (METHOD_CALL) is expected to contain the following parameters: * sessionPort SessionPort The session port. * joiner string The unique name of the session joiner. * creator string The name of the session creator. * optsIn SesionOpts The session options requested by the joiner. * * The output Message (METHOD_REPLY) contains the following parameters: * resultCode uint32 A ALLJOYN_JOINSESSION_* reply code (see AllJoynStd.h). * sessionId uint32 The session id (valid if resultCode indicates success). * opts SessionOpts The actual (final) session options. * * @param member Member. * @param msg The incoming message. */ void AttachSession(const InterfaceDescription::Member* member, Message& msg); /** * Respond to a remote daemon request to attach a session through this daemon. * * The input Message (METHOD_CALL) is expected to contain the following parameters: * sessionPort SessionPort The session port. * joiner string The unique name of the session joiner. * creator string The name of the session creator. * optsIn SesionOpts The session options requested by the joiner. * namesIn Array of unique names with their aliases. * * The output Message (METHOD_REPLY) contains the following parameters: * resultCode uint32 A ALLJOYN_JOINSESSION_* reply code (see AllJoynStd.h). * sessionId uint32 The session id (valid if resultCode indicates success). * opts SessionOpts The actual (final) session options. * namesOut Array of unique names with their aliases. * @param member Member. * @param msg The incoming message. */ void AttachSessionWithNames(const InterfaceDescription::Member* member, Message& msg); /** * Respond to a remote daemon request to get session info from this daemon. * * The input Message (METHOD_CALL) is expected to contain the following parameters: * creator string Name of attachment that bound the session port. * sessionPort SessionPort The sessionPort whose info is being requested. * opts SesionOpts The session options requested by the joiner. * * The output Message (METHOD_REPLY) contains the following parameters: * busAddr string The bus address to use when attempting to create * a connection for the purpose of joining the given session. * * @param member Member. * @param msg The incoming message. */ void GetSessionInfo(const InterfaceDescription::Member* member, Message& msg); /** * Process incoming ExchangeNames signals from remote daemons. * * @param member Interface member for signal * @param sourcePath object path sending the signal. * @param msg The signal message. */ void ExchangeNamesSignalHandler(const InterfaceDescription::Member* member, const char* sourcePath, Message& msg); /** * Process incoming NameChanged signals from remote daemons. * * @param member Interface member for signal * @param sourcePath object path sending the signal. * @param msg The signal message. */ void NameChangedSignalHandler(const InterfaceDescription::Member* member, const char* sourcePath, Message& msg); /** * Process incoming SessionDetach signals from remote daemons. * * @param member Interface member for signal * @param sourcePath object path sending the signal. * @param msg The signal message. */ void DetachSessionSignalHandler(const InterfaceDescription::Member* member, const char* sourcePath, Message& msg); void NameOwnerChanged(const qcc::String& alias, const qcc::String* oldOwner, SessionOpts::NameTransferType oldOwnerNameTransfer, const qcc::String* newOwner, SessionOpts::NameTransferType newOwnerNameTransfer); /** * Receive notification of a new bus instance via TransportListener. * Internal use only. * * @param busAddr Address of discovered bus. * @param guid GUID of daemon that sent the advertisement. * @param transport Transport that received the advertisement. * @param names Vector of bus names advertised by the discovered bus. * @param ttl Number of seconds before this advertisement expires * (0 means expire immediately, numeric_limits::max() means never expire) */ void FoundNames(const qcc::String& busAddr, const qcc::String& guid, TransportMask transport, const std::vector* names, uint32_t ttl); /** * Get reference to the daemon router object */ DaemonRouter& GetDaemonRouter() { return router; } protected: /* * These methods and members are protected rather than private to facilitate unit testing. */ /// @cond ALLJOYN_DEV /** JoinSessionThread handles a JoinSession request from a local client on a separate thread */ class JoinSessionThread : public qcc::Thread, public qcc::ThreadListener { public: JoinSessionThread(AllJoynObj& ajObj, const Message& msg, bool isJoin) : qcc::Thread(qcc::String("JoinS-") + qcc::U32ToString(qcc::IncrementAndFetch(&jstCount))), ajObj(ajObj), msg(msg), isJoin(isJoin) { } qcc::ThreadReturn STDCALL RunJoin(); virtual QStatus Reply(uint32_t replyCode, SessionId id, SessionOpts optsOut); void ThreadExit(Thread* thread); protected: qcc::ThreadReturn STDCALL Run(void* arg); private: static int jstCount; qcc::ThreadReturn STDCALL RunAttach(); /* * This must be called with the locks as it looks through the various advertisement maps. */ void GetBusAddrsFromAdvertisements(const char* sessionHost, const SessionOpts& optsIn, std::vector& busAddrs); /* * This must be called without the locks as it makes a blocking method call (GetSessionInfo). */ void GetBusAddrsFromSession(const char* sessionHost, SessionPort sessionPort, const SessionOpts& optsIn, std::vector& busAddrs); RemoteEndpoint ConnectBusToBusEndpoint(const qcc::String& busAddr, const SessionOpts& optsIn, TransportMask& transport, uint32_t& replyCode); AllJoynObj& ajObj; Message msg; bool isJoin; }; typedef enum { JOINER, /* AttachSession from new session joiner to Host */ HOST, /* AttachSession response from session host to new joiner */ HOST_FORWARD, /* MP member AttachSession forwarded by host to existing session member */ MEMBER, /* Response from existing session member to MP member AttachSession. */ HOST_FORWARD_REPLY /* Reply from host to new joiner for MP AttachSession member attach */ }CallerType; /** * Get a Transport instance for a specified transport specification. * Transport specifications have the form: * <transportName>:<param1>=<value1>,<param2>=<value2>[;] * * @param transportSpec Either a connectSpec or a listenSpec. Must be a string that starts with one * of the known transport types: @c tcp, @c unix or or @c ice. * @return A transport instance or NULL if no such transport exists */ virtual Transport* GetTransport(const qcc::String& transportSpec) { return bus.GetInternal().GetTransportList().GetTransport(transportSpec); } /** * Find the endpoint that owns the given unique or well-known name. * * @param busName Unique or well-known bus name * * @return Returns the requested endpoint or an invalid endpoint if the * endpoint was not found. */ virtual BusEndpoint FindEndpoint(const qcc::String& busName) { return router.FindEndpoint(busName); } /** * Find the remote or bus-to-bus endpoint that owns the given unique or well-known name. * * @param busName Unique or well-known bus name * @param endpoint Returns the bus endpoint * * @return Returns true if the endpoint was found, false if it was not found. */ virtual bool FindEndpoint(const qcc::String& busName, RemoteEndpoint& endpoint) { return router.FindEndpoint(busName, endpoint); } /** * Find the virtual endpoint that owns the given unique or well-known name. * * @param busName Unique or well-known bus name * @param endpoint Returns the bus endpoint * * @return Returns true if the endpoint was found, false if it was not found. */ virtual bool FindEndpoint(const qcc::String& busName, VirtualEndpoint& endpoint) { return router.FindEndpoint(busName, endpoint); } /** * Utility method used to invoke SessionAttach remote method. * * @param sessionPort SessionPort used in join request. * @param src Unique name of session joiner. * @param sessionHost Unique name of sessionHost. * @param dest Unique name of session creator. * @param b2bEp Directly connected (next hop) B2B endpoint. * @param remoteControllerName Unique name of bus controller at next hop. * @param outgoingSessionId SessionId to use for outgoing AttachSession message. Should * be 0 for newly created (non-multipoint) sessions. * @param busAddr Destination bus address from advertisement or GetSessionInfo. * @param nameTransfer The Nametransfer for this session. One of ALL_NAMES, SLS_NAMES, P2P_NAMES and MP_NAMES. * @param type The type of caller of this function: JOINER, HOST, HOST_FORWARD, MEMBER and HOST_FORWARD_REPLY. * @param optsIn Session options requested by joiner. * @param replyCode [OUT] SessionAttach response code * @param sessionId [OUT] session id if reply code indicates success. * @param optsOut [OUT] Actual (final) session options. * @param members [OUT] Array or session members (strings) formatted as MsgArg. */ virtual QStatus SendAttachSession(SessionPort sessionPort, const char* src, const char* sessionHost, const char* dest, RemoteEndpoint& b2bEp, const char* remoteControllerName, SessionId outgoingSessionId, const char* busAddr, SessionOpts::NameTransferType nameTransfer, CallerType type, const SessionOpts& optsIn, uint32_t& replyCode, SessionId& sessionId, SessionOpts& optsOut, MsgArg& members); /** * Add a session route. * * @param id Session Id. * @param srcEp Route source endpoint. * @param srcB2bEp Source B2B endpoint. (NULL if srcEp is not virtual). * @param destEp BusEndpoint of route destination. * @param destB2bEp [IN/OUT] If passed in as invalid endpoint type, attempt to use optsHint to choose destB2bEp and return selected ep. * @param optsHint Optional session options constraint for selection of destB2bEp if not explicitly specified. * @return ER_OK if successful. */ virtual QStatus AddSessionRoute(SessionId id, BusEndpoint& srcEp, RemoteEndpoint* srcB2bEp, BusEndpoint& destEp, RemoteEndpoint& destB2bEp) { return router.AddSessionRoute(id, srcEp, srcB2bEp, destEp, destB2bEp); } /// @endcond private: Bus& bus; /**< The bus */ DaemonRouter& router; /**< The router */ qcc::Mutex stateLock; /**< Lock that protects AlljoynObj state */ const InterfaceDescription* daemonIface; /**< org.alljoyn.Daemon interface */ const InterfaceDescription::Member* foundNameSignal; /**< org.alljoyn.Bus.FoundName signal */ const InterfaceDescription::Member* lostAdvNameSignal; /**< org.alljoyn.Bus.LostAdvertisdName signal */ const InterfaceDescription::Member* sessionLostSignal; /**< org.alljoyn.Bus.SessionLost signal */ const InterfaceDescription::Member* sessionLostWithReasonSignal; /**< org.alljoyn.Bus.SessionLostWithReason signal */ const InterfaceDescription::Member* sessionLostWithReasonAndDispositionSignal; /**< org.alljoyn.Bus.SessionLostWithReasonAndDisposition signal */ const InterfaceDescription::Member* mpSessionChangedSignal; /**< org.alljoyn.Bus.MPSessionChanged signal */ const InterfaceDescription::Member* mpSessionChangedWithReason; /**< org.alljoyn.Bus.MPSessionChangedWithReason signal */ const InterfaceDescription::Member* mpSessionJoinedSignal; /**< org.alljoyn.Bus.JoinSession signal */ /** Map of active advertised names to requesting local endpoint's permitted transport mask(s) and name(s) */ std::multimap > advertiseMap; /** Map of active discovery names to requesting local endpoint's permitted transport mask(s) and name(s) */ struct DiscoverMapEntry { TransportMask transportMask; qcc::String sender; MatchMap matching; bool initComplete; DiscoverMapEntry(TransportMask transportMask, const qcc::String& sender, const MatchMap& matching, bool initComplete = false) : transportMask(transportMask), sender(sender), matching(matching), initComplete(initComplete) { } }; typedef std::multimap DiscoverMapType; DiscoverMapType discoverMap; /** Map of discovered bus names (protected by discoverMapLock) */ struct NameMapEntry { qcc::String busAddr; qcc::String guid; TransportMask transport; uint64_t timestamp; uint64_t ttl; qcc::Alarm alarm; static void* truthiness; NameMapEntry(const qcc::String& busAddr, const qcc::String& guid, TransportMask transport, uint64_t ttl, qcc::AlarmListener* listener) : busAddr(busAddr), guid(guid), transport(transport), timestamp(qcc::GetTimestamp64()), ttl(ttl), alarm(ttl, listener, truthiness) { } }; typedef std::multimap NameMapType; NameMapType nameMap; /* Session map */ struct SessionMapEntry { qcc::String endpointName; SessionId id; qcc::String sessionHost; SessionPort sessionPort; SessionOpts opts; qcc::SocketFd fd; RemoteEndpoint streamingEp; std::vector memberNames; bool isInitializing; bool isRawReady; bool IsSelfJoin() const { return find(memberNames.begin(), memberNames.end(), sessionHost) != memberNames.end(); } qcc::String ToString() const { char idbuf[16]; qcc::String str; str.append("endpoint: "); str.append(endpointName); str.append(", id: "); snprintf(idbuf, sizeof(idbuf), "%u", id); str.append(idbuf); str.append(", host: "); str.append(sessionHost); str.append(", members: "); for (std::vector::const_iterator it = memberNames.begin(); it != memberNames.end(); ++it) { str.append(*it); str.append(","); } str.append(" selfjoin: "); str.append(IsSelfJoin() ? "yes" : "no"); return str; } SessionMapEntry() : id(0), sessionPort(0), opts(), fd(qcc::INVALID_SOCKET_FD), isInitializing(false), isRawReady(false) { } }; typedef std::multimap, SessionMapEntry> SessionMapType; SessionMapType sessionMap; /**< Map (endpointName,sessionId) to session info */ /** * Helper function to convert a QStatus into a SessionLost reason */ SessionListener::SessionLostReason ConvertReasonToSessionLostReason(QStatus reason) const; /* * Helper function to get session map interator */ SessionMapEntry* SessionMapFind(const qcc::String& name, SessionId session); /* * Helper function to get session map range interator */ SessionMapType::iterator SessionMapLowerBound(const qcc::String& name, SessionId session); /* * Helper function to get session map range interator */ SessionMapType::iterator SessionMapUpperBound(const qcc::String& name, SessionId session); /** * Helper function to insert a sesssion map */ void SessionMapInsert(SessionMapEntry& sme); /** * Helper function to erase a sesssion map */ void SessionMapErase(SessionMapEntry& sme); const qcc::GUID128& guid; /**< Global GUID of this daemon */ const InterfaceDescription::Member* detachSessionSignal; /**< org.alljoyn.Daemon.DetachSession signal member */ std::map virtualEndpoints; /**< Map of endpoints that reside behind a connected AllJoyn daemon */ std::map b2bEndpoints; /**< Map of bus-to-bus endpoints that are connected to external daemons */ struct AdvAliasEntry { qcc::String name; TransportMask transport; AdvAliasEntry(qcc::String name, TransportMask transport) : name(name), transport(transport) { } bool operator<(const AdvAliasEntry& other) const { return (name < other.name) || ((name == other.name) && (transport < other.transport)); } bool operator==(const AdvAliasEntry& other) const { return name == other.name && transport == other.transport; } }; std::map > advAliasMap; /**< Map remote daemon guid/transport to advertised name alias */ struct SentSetEntry { qcc::String name; TransportMask transport; SentSetEntry(qcc::String name, TransportMask transport) : name(name), transport(transport) { } bool operator<(const SentSetEntry& other) const { // Order in descending order of transport so that UDP transport is sent first. return (name < other.name) || ((name == other.name) && (transport > other.transport)); } bool operator==(const SentSetEntry& other) const { return name == other.name && transport == other.transport; } }; struct JoinSessionEntry { qcc::String name; TransportMask transport; qcc::String busAddr; JoinSessionEntry(qcc::String name, TransportMask transport, qcc::String busAddr) : name(name), transport(transport), busAddr(busAddr) { } bool operator<(const JoinSessionEntry& other) const { // Order in descending order of transport so that UDP transport is sent first. return (name < other.name) || ((name == other.name) && (transport > other.transport)) || ((name == other.name) && (transport == other.transport) && (busAddr < other.busAddr)); } bool operator==(const JoinSessionEntry& other) const { return name == other.name && transport == other.transport && busAddr == other.busAddr; } }; qcc::Timer timer; /**< Timer object for reaping expired names */ /** * Name reaper timeout alarm handler. * * @param alarm The alarm object for the timeout that expired. */ void AlarmTriggered(const qcc::Alarm& alarm, QStatus reason); std::vector joinSessionThreads; /**< List of outstanding join session requests */ qcc::Mutex joinSessionThreadsLock; /**< Lock that protects joinSessionThreads */ bool isStopping; /**< True while waiting for threads to exit */ BusController* busController; /**< BusController that created this BusObject */ /** * Acquire AllJoynObj locks. */ void AcquireLocks(); /** * Release AllJoynObj locks. */ void ReleaseLocks(); /** * Utility function used to send a single FoundName signal. * * @param dest Unique name of destination. * @param name Well-known name that was found. * @param transport The transport that received the advertisment. * @param namePrefix Well-known name prefix used in call to FindName() that triggered this notification. * @return ER_OK if succssful. */ QStatus SendFoundAdvertisedName(const qcc::String& dest, const qcc::String& name, TransportMask transport, const qcc::String& namePrefix); /** * Utility function used to send LostAdvertisedName signals to each "interested" local endpoint. * * @param name Well-known name whose advertisment was lost. * @param transport Transport whose advertisment for name has gone away. * @return ER_OK if succssful. */ QStatus SendLostAdvertisedName(const qcc::String& name, TransportMask transport); /** * Utility method used to invoke AcceptSession on device local endpoint. * * @param sessionPort SessionPort that received the join request. * @param sessionId Id for new session (if accepted). * @param creatorName Session creator unique name. * @param joinerName Session joiner unique name. * @param opts Session options requsted by joiner * @param isAccepted [OUT] true iff creator accepts session. (valid if return is ER_OK). */ QStatus SendAcceptSession(SessionPort sessionPort, SessionId sessionId, const char* creatorName, const char* joinerName, const SessionOpts& opts, bool& isAccepted); /** * Utility method used to send SessionJoined. * * @param sessionPort SessionPort that received the join request. * @param sessionId Id for new session (if accepted). * @param creatorName Session creator unique name. * @param joinerName Session joiner unique name. */ QStatus SendSessionJoined(SessionPort sessionPort, SessionId sessionId, const char* joinerName, const char* creatorName); /** * Utility method used to send SessionLost signal to locally attached endpoint. * * @param entry SessionMapEntry that was lost. * @param reason Reason for the SessionLost. */ void SendSessionLost(const SessionMapEntry& entry, QStatus reason, unsigned int disposition = 0); /** * Utility method used to send MPSessionChanged signal to locally attached endpoint. * * @param sessionId The sessionId. * @param name Unique name of session member that changed. * @param isAdd true if member added. * @param dest Local destination for MPSessionChanged. * @param reason Specifies the reason why the session changed */ void SendMPSessionChanged(SessionId sessionId, const char* name, bool isAdd, const char* dest, unsigned int reason); /** * Add a virtual endpoint with a given unique name. * * @param uniqueName The uniqueName of the virtual endpoint. * @param b2bEpName Unique name of bus-to-bus endpoint that "owns" the virtual endpoint. * @param changesMade [OUT] Written to true of virtual endpoint was created (as opposed to already existing). */ void AddVirtualEndpoint(const qcc::String& uniqueName, const qcc::String& b2bEpName, bool* changesMade = NULL); /** * Remove a virtual endpoint. * * @param uniqueName The unique name of the virtualEndpoint to be removed. */ void RemoveVirtualEndpoint(const qcc::String& uniqueName); /** * Find a virtual endpoint by its name. * * @param uniqueName The name of the endpoint to find. * @return The requested virtual endpoint or NULL if not found. */ VirtualEndpoint FindVirtualEndpoint(const qcc::String& uniqueName); /** * Internal bus-to-bus remote endpoint listener. * Called when any virtual endpoint's remote endpoint exits. * * @param ep RemoteEndpoint that is exiting. */ void EndpointExit(RemoteEndpoint& ep); /** * Send signal that informs remote bus of names available on local daemon. * This signal is used only in bus-to-bus connections. * * @param endpoint Remote endpoint to exchange names with. * @return ER_OK if successful. */ QStatus ExchangeNames(RemoteEndpoint& endpoint); /** * Process a request to cancel advertising a name from a given (locally-connected) endpoint. * * @param uniqueName Name of endpoint requesting end of advertising * @param advertiseName Well-known name whose advertising is to be canceled. * @param transports Set of transports that should cancel the advertisment. * @return ER_OK if successful. */ QStatus ProcCancelAdvertise(const qcc::String& uniqueName, const qcc::String& advertiseName, TransportMask transports); /** * Process a request to cancel discovery of a name prefix from a given (locally-connected) endpoint. * * @param endpointName Name of endpoint requesting end of discovery * @param matching Key, value match criteria to be removed from discovery list * @param transports Set of transports that should cancel the discovery. * @return ER_OK if successful. */ QStatus ProcCancelFindAdvertisement(const qcc::String& endpointName, const qcc::String& matching, TransportMask transports); /** * Process a request to discover a matching advertisement by a set of transports * * @param status The result of parsing one of FindAdvertisedName, FindAdvertisedNameByTransport, or * FindAdvertisementByTransport. * @param msg The incoming message * @param matching Key, value match criteria that the caller wants to be notified of (via signal) * when a remote Bus instance is found with an advertisement that matches the criteria. * @param transports Transport bit mask */ void ProcFindAdvertisement(QStatus status, Message& msg, const qcc::String& matching, TransportMask transports); /** * Handle a request to cancel the discovery a name prefix by a set of transports * * @param status The result of parsing one of CancelFindAdvertisedName, CancelFindAdvertisedNameByTransport, or * CancelFindAdvertisementByTransport. * @param msg The incoming message * @param matching Key, value match criteria to be removed from discovery list * @param transports Transport bit mask */ void HandleCancelFindAdvertisement(QStatus status, Message& msg, const qcc::String& matching, TransportMask transports); /** * Validate and normalize a transport specification string. Given a * transport specification, convert it into a form which is guaranteed to * have a one-to-one relationship with a transport. (This is just a * convenient inline wrapper for internal use). * * @param inSpec Input transport connect spec. * @param outSpec [OUT] Normalized transport connect spec. * @param argMap [OUT] Normalized parameter map. * @return ER_OK if successful. */ QStatus NormalizeTransportSpec(const char* inSpec, qcc::String& outSpec, std::map& argMap) { return bus.GetInternal().GetTransportList().NormalizeTransportSpec(inSpec, outSpec, argMap); } /** * Helper method used to shutdown a remote endpoint while preserving it's open file descriptor. * This is used for converting a RemoteEndpoint into a raw streaming socket. * * @param b2bEp Bus to bus endpoint being shutdown. * @param sockFd [OUT] b2bEp's socket descriptor. * @return ER_OK if successful. */ QStatus ShutdownEndpoint(RemoteEndpoint& b2bEp, qcc::SocketFd& sockFd); /** * Utility function used to clean up the session map when a session participant. * leaves a session. * * @param endpoint Endpoint (virtual or remote) that has left(or is being removed from) the session. * @param id Session id. * @param sendSessionLost Whether to send a SessionLost to this endpoint. * Set to true if this endpoint is being forcefully removed from the session by the binder. * @return returns true if epName is still being used */ bool RemoveSessionRefs(const char* epName, SessionId id, bool sendSessionLost = false, LeaveSessionType lst = LEAVE_SESSION); /** * Utility function used to clean up the session map when a virtual endpoint with a * given b2b endpoint leaves a session. * * This utility is used when the given B2B ep has closed for some reason and we * need to clean any virtual endpoints that might have been using that b2b ep * from the sessionMap * * @param vepName Virtual that should be cleaned from sessionMap if it routes * through b2bEp for a given session. * @param b2bEpName B2B endpoint that vep must route through in order to be cleaned. */ void RemoveSessionRefs(const qcc::String& vepName, const qcc::String& b2bEpName); /** * Remove entry from advertise alias map. * * @param name Name to remove from advAliasMap. * @param mask Set of transports whose advertisement for name will be removed from alias map. */ void CleanAdvAliasMap(const qcc::String& name, TransportMask mask); /** * Check if this guid has advertised names * @param guid Long Guid string which needs to be checked * @return true if there are names in namemap from this guid */ bool IsGuidLongStringAdvertising(qcc::String& guid); /** * Check if this guid has advertised names * @param guid Short Guid string which needs to be checked * @return true if there are names in namemap from this guid */ bool IsGuidShortStringAdvertising(qcc::String& guid); /* TODO document */ void PingReplyMethodHandler(Message& reply, void* context); void PingReplyMethodHandlerUsingCode(Message& msg, uint32_t replyCode); void PingReplyTransportHandler(Message& reply, void* context); bool QueryHandler(TransportMask transport, MDNSPacket query, const qcc::IPEndpoint& src, const qcc::IPEndpoint& dst); bool ResponseHandler(TransportMask transport, MDNSPacket response, uint16_t recvPort); void PingResponse(TransportMask transport, const qcc::IPEndpoint& dst, const qcc::String& name, uint32_t replyCode); std::multimap, OutgoingPingInfo> outgoingPingMap; std::multimap incomingPingMap; std::set > dbusPingsInProgress; //contains the caller of ping and destination of ping TransportMask GetCompleteTransportMaskFilter(); void SendIPNSResponse(qcc::String name, uint32_t replyCode); bool IsSelfJoinSupported(BusEndpoint& joinerEp) const; /** * Get all the names to be sent for this session. */ QStatus GetNames(MsgArg& argArray, RemoteEndpoint& endpoint, SessionOpts::NameTransferType nameTransfer, CallerType type, qcc::String joinerName = "", uint32_t sessionId = 0, qcc::String sessionHost = ""); /** * Add all the names in arg to the NameTable and forward this message to the required routing nodes. */ bool NamesHandler(Message msg, MsgArg arg); /** * Check if this endpoint is a member of the session or is a remote routing node that has a leaf that is a member in this session. * @param endpoint Endpoint to check * @param sessionId ID of the session * @return true if name is a member of the sessionId hosted by hostName. */ bool IsMemberOfSession(BusEndpoint endpoint, uint32_t sessionId); }; } #endif alljoyn-15.04b/alljoyn_core/router/ArdpProtocol.cc000066400000000000000000004050231255700255500222660ustar00rootroot00000000000000/** * @file ArdpProtocol is an implementation of the Reliable Datagram Protocol * (RDP) adapted to AllJoyn. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #include #include "ScatterGatherList.h" #include "ArdpProtocol.h" #define QCC_MODULE "ARDP_PROTOCOL" namespace ajn { #define UDP_MTU 1472 #define ARDP_VERSION_BITS 0xC0 /* Bits 6-7 of FLAGS byte in ARDP segment header*/ #define ARDP_DISCONNECT_RETRY 1 /* Not configurable */ #define ARDP_DISCONNECT_RETRY_TIMEOUT 1000 /* Not configurable */ /**< Reserved TTL value to indicate that data associated with the message has expired */ #define ARDP_TTL_EXPIRED 0xffffffff /**< Maximum allowed TTL value */ #define ARDP_TTL_MAX (ARDP_TTL_EXPIRED - 1) /**< Reserved TTL value to indicate that data associated with the message never expires */ #define ARDP_TTL_INFINITE 0 /**< Flag indicating that the RCV buffer is occupied */ #define ARDP_BUFFER_IN_USE 0x01 /**< Flag indicating that the RCV buffer is delivered to the upper layer */ #define ARDP_BUFFER_DELIVERED 0x02 /* Minimum Roundtrip Time */ #define ARDP_MIN_RTO 100 /* Maximum Roundtrip Time */ #define ARDP_MAX_RTO 64000 /* Minimum Delayed ACK Timeout */ #define ARDP_MIN_DELAYED_ACK_TIMEOUT 10 #define MIN(a, b) ((a) < (b) ? (a) : (b)) #define MAX(a, b) ((a) > (b) ? (a) : (b)) #define ABS(a) ((a) >= 0 ? (a) : -(a)) #define UDP_HEADER_SIZE 8 /* Marshal/Unmarshal ARDP header offsets */ #define FLAGS_OFFSET 0 #define HLEN_OFFSET 1 #define SRC_OFFSET 2 #define DST_OFFSET 4 #define DLEN_OFFSET 6 #define SEQ_OFFSET 8 #define ACK_OFFSET 12 #define TTL_OFFSET 16 #define LCS_OFFSET 20 #define ACKNXT_OFFSET 24 #define SOM_OFFSET 28 #define FCNT_OFFSET 32 #define RSRV_OFFSET 34 /* Additional Marshal/Unmarshal ARDP SYN header offsets */ #define SEGMAX_OFFSET 16 #define SEGBMAX_OFFSET 18 #define DACKT_OFFSET 20 #define OPTIONS_OFFSET 24 #define SYN_RSRV_OFFSET 26 #define ARDP_SYN_HEADER_SIZE 28 /* A simple circularly linked list node suitable for use in thin core library implementations */ typedef struct LISTNODE { struct LISTNODE* fwd; struct LISTNODE* bwd; uint8_t* buf; uint32_t len; } ListNode; /* Callback for timeout handler */ typedef void (*ArdpTimeoutHandler)(ArdpHandle* handle, ArdpConnRecord* conn, void* context); /* Structure encapsulating timer to to handle timeouts */ typedef struct ARDP_TIMER { ListNode list; ArdpConnRecord* conn; ArdpTimeoutHandler handler; void* context; uint32_t delta; uint32_t when; uint32_t retry; } ArdpTimer; /* Structure encapsulating the information about segments on SEND side */ typedef struct ARDP_SEND_BUF { uint8_t* data; uint32_t datalen; uint8_t* hdr; uint32_t ttl; uint32_t tStart; ARDP_SEND_BUF* next; ArdpTimer timer; uint16_t fastRT; uint16_t retransmits; bool inUse; } ArdpSndBuf; /** * Structure encapsulating the send-related quantities. The stuff we manage on * the local side of the connection and which we may send to THEM. */ typedef struct { uint32_t NXT; /* The sequence number of the next segment that is to be sent (or buffered for sending) */ uint32_t UNA; /* The sequence number of the oldest unacknowledged segment */ uint32_t ISS; /* The initial send sequence number. The number that was sent in the SYN segment */ uint32_t LCS; /* Sequence number of last consumed segment (we get this from them) */ uint32_t DACKT; /* Delayed ACK timeout from the other side */ ArdpSndBuf* buf; /* Dynamically allocated array of unacked sent buffers */ #if ARDP_TC_SUPPORT uint32_t thinNXT; /* The sequence number of the next outbound segment in simple mode */ #endif uint16_t SEGMAX; /* The maximum number of unacknowledged segments that can be sent */ uint16_t SEGBMAX; /* The largest possible segment that THEY can receive (our send buffer, specified by the other side during connection) */ #if ARDP_TC_SUPPORT uint16_t thinSEGMAX; /* The maximum number of unacknowledged segments that can be sent in thin mode */ uint16_t thinWindow; /* Receiver's window in simple mode */ #endif uint16_t maxDlen; /* Maximum data payload size that can be sent without partitioning */ uint16_t pending; /* Number of unacknowledged sent buffers */ } ArdpSnd; /** * Structure for tracking of received out-of-order segments. * Contains EACK bitmask to be sent to the remote side. */ typedef struct { uint32_t mask[ARDP_MAX_WINDOW_SIZE >> 5]; /* mask in host order */ uint32_t htnMask[ARDP_MAX_WINDOW_SIZE >> 5]; /* mask in network order */ uint16_t sz; uint16_t fixedSz; } ArdpEack; /** * Structure encapsulating the receive-related quantities. The stuff managed on * the remote/foreign side, copies of which we may get from THEM. */ typedef struct { uint32_t CUR; /* The sequence number of the last segment received correctly and in sequence */ uint32_t IRS; /* The initial receive sequence number. The sequence number of the SYN that established the connection */ uint32_t LCS; /* The sequence number of last consumed segment */ ArdpRcvBuf* buf; /* Array holding received buffers not consumed by the app */ ArdpEack eack; /* Tracking of received out-of-order segments */ uint16_t SEGMAX; /* The maximum number of segments that can be buffered for this connection */ uint16_t SEGBMAX; /* The largest possible segment that WE can receive (our receive buffer, specified by our user on an open) */ } ArdpRcv; /** * Information encapsulating the various interesting tidbits we get from the * other side when we receive a datagram. Some of the names are chosen so that they * are similar to the quantities found in RFC-908 when used. */ typedef struct { uint32_t SEQ; /* The sequence number in the segment currently being processed. */ uint32_t ACK; /* The acknowledgement number in the segment currently being processed. */ uint32_t LCS; /* The last "in-sequence" consumed segment */ uint32_t ACKNXT; /* The first valid SND segment, TTL accounting */ uint32_t SOM; /* Start sequence number for fragmented message */ uint32_t TTL; /* Time-to-live */ uint16_t FCNT; /* Number of fragments comprising a message */ uint16_t DLEN; /* The length of the data that came in with the current segment. */ uint16_t WINDOW; /* Receive window */ uint8_t FLG; /* The flags in the header of the segment currently being processed. */ uint8_t HLEN; /* The header length */ } ArdpSeg; /** * The states through which our main state machine transitions. */ enum ArdpState { CLOSED = 1, /* No connection exists and no connection record available */ CLOSE_WAIT, /* Entered if local close or remote RST received. Delay for connection activity to subside. */ LISTEN, /* Entered upon a passive open request. Connection record is allocated and ARDP waits for a connection from remote */ SYN_SENT, /* Entered after processing an active open request. SYN is sent and ARDP waits here for ACK of open request. */ SYN_RCVD, /* Reached from either LISTEN or SYN_SENT. Generate ISN and ACK. */ OPEN /* Successful echange of state information happened,. Data may be sent and received. */ }; /** * The format of a SYN segment on the wire. */ #pragma pack(push, 1) typedef struct { uint8_t flags; /* See Control flag definitions above */ uint8_t hlen; /* Length of the header in units of two octets (number of uint16_t) */ uint16_t src; /* Used to distinguish between multiple connections on the local side. */ uint16_t dst; /* Used to distinguish between multiple connections on the foreign side. */ uint16_t dlen; /* The length of the data in the current segment. Does not include the header size. */ uint32_t seq; /* The sequence number of the current segment. */ uint32_t ack; /* The number of the segment that the sender of this segment last received correctly and in sequence. */ uint16_t segmax; /* The maximum number of outstanding segments the other side can send without acknowledgement. */ uint16_t segbmax; /* The maximum segment size we are willing to receive. (the RBUF.MAX specified by the user calling open). */ uint32_t dackt; /* Receiver's delayed ACK timeout. Used in TTL estimate prior to sending a message. */ uint16_t options; /* Options for the connection. Always Sequenced Delivery Mode (SDM). */ uint16_t reserve; /* Reserved for future use. */ } ArdpSynHeader; #pragma pack(pop) typedef struct { uint8_t* buf; /* Place to hold connection handshake data (SASL, HELLO, etc) */ uint32_t len; /* Length of connection handshake data */ } ArdpSynData; /** * A connection record describing each "connection." This acts as a containter * to hold all of the interesting information about a reliable link between * hosts. */ struct ARDP_CONN_RECORD { ListNode list; /* Doubly linked list node on which this connection might be */ uint32_t id; /* Randomly chosen connection identifier */ ArdpState state; /* The current sate of the connection */ bool passive; /* If true, this is a passive open (we've been connected to); if false, we did the connecting */ ArdpSnd snd; /* Send-side related state information */ ArdpRcv rcv; /* Receive-side related state information */ uint16_t local; /* ARDP local port for this connection */ uint16_t foreign; /* ARDP foreign port for this connection */ qcc::SocketFd sock; /* A convenient copy of socket we use to communicate. */ qcc::IPAddress ipAddr; /* A convenient copy of the IP address of the foreign side of the connection. */ uint16_t ipPort; /* A convenient copy of the IP port of the foreign side of the connection. */ uint16_t window; /* Current send window, dynamic setting */ uint16_t remoteMskSz; /* Size of of EACK bitmask present in received segment */ uint32_t lastSeen; /* Last time we received communication on this connection. */ ArdpSynData synData; /* Connection establishment data */ bool rttInit; /* Flag indicating that the first RTT was measured and SRTT calculation applies */ uint32_t rttMean; /* Smoothed RTT value */ uint32_t rttMeanVar; /* RTT variance */ uint32_t backoff; /* Backoff factor accounting for retransmits on connection, resets to 1 when receive "good ack" */ uint32_t rttMeanUnit; /* Smoothed RTT value per UDP MTU */ ArdpTimer connectTimer; /* Connect/Disconnect timer */ ArdpTimer probeTimer; /* Probe (link timeout) timer */ ArdpTimer ackTimer; /* Delayed ACK timer */ ArdpTimer persistTimer; /* Persist (frozen window) timer */ uint32_t ackPending; /* Number of received segments pending acknowledgement */ #if ARDP_TC_SUPPORT bool modeSimple; /* Simple mode connection. No EACKs. */ #endif void* context; /* A client-defined context pointer */ qcc::SendMsgFlags sndFlags; /* SendMsgFlags to underlying sockets call */ }; struct ARDP_HANDLE { ArdpGlobalConfig config; /* The configurable items that affect this instance of ARDP as a whole */ ArdpCallbacks cb; /* The callbacks to allow the protocol to talk back to the client */ #if ARDP_TESTHOOKS ArdpTesthooks th; /* Test hooks allowing test programs to examime or change data or behaviors */ #endif #if ARDP_STATS ArdpStats stats; /* Protocol statistics gathering */ #endif bool accepting; /* If true the ArdpProtocol is accepting inbound connections */ ListNode conns; /* List of currently active connections */ qcc::Timespec tbase; /* Baseline time */ ListNode dataTimers; /* List of currently scheduled retransmit timers */ uint32_t msnext; /* To inform upper layer when to call into the protocol next time */ bool trafficJam; /* "Socket Write Block" indicator */ void* context; /* A client-defined context pointer */ }; /* * Important!!! All our numbers are within window size, the calculation below will hold. * If necessary, can add check that delta between the numbers does not exceed half-range. */ #define SEQ32_LT(a, b) ((int32_t)((uint32_t)(a) - (uint32_t)(b)) < 0) #define SEQ32_LET(a, b) (((int32_t)((uint32_t)(a) - (uint32_t)(b)) < 0) || ((a) == (b))) /** * Inside window calculation. * Returns true if p is in range [beg, beg+sz) * This function properly accounts for possible wrap-around in [beg, beg+sz) region. */ #define IN_RANGE(tp, beg, sz, p) (((static_cast((beg) + (sz)) > (beg)) && ((p) >= (beg)) && ((p) < static_cast((beg) + (sz)))) || \ ((static_cast((beg) + (sz)) < (beg)) && !(((p) < (beg)) && (p) >= static_cast((beg) + (sz))))) static ArdpConnRecord* FindConn(ArdpHandle* handle, uint16_t local, uint16_t foreign); static QStatus DoSendSyn(ArdpHandle* handle, ArdpConnRecord* conn, uint8_t* buf, uint16_t len); /************** * End of definitions */ static void SetEmpty(ListNode* node) { QCC_DbgTrace(("SetEmpty(node=%p)", node)); node->fwd = node->bwd = node; } static bool IsEmpty(ListNode* node) { return (node->fwd == node); } static void EnList(ListNode* after, ListNode* node) { QCC_DbgTrace(("EnList(after=%p, node=%p)", after, node)); node->fwd = after->fwd; node->bwd = after; node->fwd->bwd = node; after->fwd = node; } static void DeList(ListNode* node) { QCC_DbgTrace(("DeList(node=%p)", node)); if (IsEmpty(node)) { return; } node->bwd->fwd = node->fwd; node->fwd->bwd = node->bwd; node->fwd = node->bwd = node; } #ifndef NDEBUG static void DumpBitMask(ArdpConnRecord* conn, uint32_t* msk, uint16_t sz, bool convert) { QCC_DbgHLPrintf(("DumpBitMask(conn=%p, msk=%p, sz=%d, convert=%s)", conn, msk, sz, convert ? "true" : "false")); for (uint16_t i = 0; i < sz; i++) { uint32_t mask32; if (convert) { mask32 = ntohl(msk[i]); } else { mask32 = msk[i]; } QCC_DbgHLPrintf(("\t %d: %2x %2x %2x %2x %2x %2x %2x %2x %2x %2x %2x %2x %2x %2x %2x %2x %2x %2x %2x %2x %2x %2x %2x %2x %2x %2x %2x %2x %2x %2x %2x %2x", i, (mask32 >> 31) & 1, (mask32 >> 30) & 1, (mask32 >> 29) & 1, (mask32 >> 28) & 1, (mask32 >> 27) & 1, (mask32 >> 26) & 1, (mask32 >> 25) & 1, (mask32 >> 24) & 1, (mask32 >> 23) & 1, (mask32 >> 22) & 1, (mask32 >> 21) & 1, (mask32 >> 20) & 1, (mask32 >> 19) & 1, (mask32 >> 18) & 1, (mask32 >> 17) & 1, (mask32 >> 16) & 1, (mask32 >> 15) & 1, (mask32 >> 14) & 1, (mask32 >> 13) & 1, (mask32 >> 12) & 1, (mask32 >> 11) & 1, (mask32 >> 10) & 1, (mask32 >> 9) & 1, (mask32 >> 8) & 1, (mask32 >> 7) & 1, (mask32 >> 6) & 1, (mask32 >> 5) & 1, (mask32 >> 4) & 1, (mask32 >> 3) & 1, (mask32 >> 2) & 1, (mask32 >> 1) & 1, mask32 & 1)); } } #endif // NDEBUG /** * The Windows AllJoyn code uses tracing even in release builds to enable retail * debugging, so State2Text needs to be defined in release builds as well as * debug builds. However, this tracing code is internal to Microsoft so a compiler * warning is triggered in Windows release builds due to the unreferenced function. * Suppressing warning 4505 prevents this error. */ #if defined(QCC_OS_GROUP_WINDOWS) #pragma warning( disable: 4505 ) #endif #if !defined(NDEBUG) || defined(QCC_OS_GROUP_WINDOWS) static const char* State2Text(ArdpState state) { switch (state) { case CLOSED: return "CLOSED"; case LISTEN: return "LISTEN"; case SYN_SENT: return "SYN_SENT"; case SYN_RCVD: return "SYN_RCVD"; case OPEN: return "OPEN"; case CLOSE_WAIT: return "CLOSE_WAIT"; default: return "UNDEFINED"; } } #endif static inline void SetState(ArdpConnRecord* conn, ArdpState state) { QCC_DbgTrace(("SetState: conn=%p %s=>%s", conn, State2Text(conn->state), State2Text(state))); conn->state = state; } static uint32_t TimeNow(qcc::Timespec base) { qcc::Timespec now; qcc::GetTimeNow(&now); return 1000 * (now.seconds - base.seconds) + (now.mseconds - base.mseconds); } static bool IsConnValid(ArdpHandle* handle, ArdpConnRecord* conn) { if (conn == NULL) { return false; } if (IsEmpty(&handle->conns)) { return false; } for (ListNode* ln = &handle->conns; (ln = ln->fwd) != &handle->conns;) { if (conn == (ArdpConnRecord*)ln) { return true; } } return false; } static void moveAhead(ArdpHandle* handle, ArdpConnRecord* conn) { ListNode* head = &handle->conns; ListNode* ln = (ListNode* ) conn; if (head->fwd != ln) { DeList(ln); EnList(head, ln); } } static void InitTimer(ArdpHandle* handle, ArdpConnRecord* conn, ArdpTimer* timer, ArdpTimeoutHandler handler, void*context, uint32_t timeout, uint16_t retry) { QCC_DbgTrace(("InitTimer: conn=%p timer=%p handler=%p context=%p timeout=%u retry=%u", conn, timer, handler, context, timeout, retry)); timer->conn = conn; timer->handler = handler; timer->context = context; timer->delta = timeout; timer->when = TimeNow(handle->tbase) + timeout; timer->retry = retry; /* Update "call-me-back" value */ if ((retry != 0) && (timeout < handle->msnext)) { moveAhead(handle, conn); handle->msnext = timeout; } } static void UpdateTimer(ArdpHandle* handle, ArdpConnRecord* conn, ArdpTimer* timer, uint32_t timeout, uint16_t retry) { QCC_DbgTrace(("UpdateTimer: conn=%p timer=%p timeout=%u retry=%u", conn, timer, timeout, retry)); timer->delta = timeout; timer->when = TimeNow(handle->tbase) + timeout; timer->retry = retry; if ((retry != 0) && (timeout < handle->msnext)) { moveAhead(handle, conn); handle->msnext = timeout; } } static uint32_t CheckConnTimers(ArdpHandle* handle, ArdpConnRecord* conn, uint32_t next, uint32_t now) { /* * Check connect/disconnect timer. This timer is alive only when the connection is being established or going away. * No other timers should be active on the connection. */ if (conn->connectTimer.retry != 0) { if (conn->connectTimer.when <= now) { QCC_DbgPrintf(("CheckConnTimers: Fire connection( %p ) timer %p at %u (now=%u)", conn, conn->connectTimer, conn->connectTimer.when, now)); (conn->connectTimer.handler)(handle, conn, conn->connectTimer.context); if (IsConnValid(handle, conn)) { conn->connectTimer.when = now + conn->connectTimer.delta; if (conn->connectTimer.when < next && conn->connectTimer.retry != 0) { /* Update "call-me-next-ms" value */ next = conn->connectTimer.when; moveAhead(handle, conn); } } } return next; } /* If connection is not in OPEN state, return */ if (conn->state != OPEN) { return next; } /* Check probe timer, it's always turned on */ if (conn->probeTimer.when <= now) { QCC_DbgPrintf(("CheckConnTimers: Fire probe( %p ) timer %p at %u (now=%u)", conn, conn->probeTimer, conn->probeTimer.when, now)); (conn->probeTimer.handler)(handle, conn, &now); conn->probeTimer.when = now + conn->probeTimer.delta; } if (conn->probeTimer.when < next) { /* Update "call-me-next-ms" value */ next = conn->probeTimer.when; moveAhead(handle, conn); } /* Check delayed ACK timer */ if (conn->ackTimer.retry != 0 && conn->ackTimer.when <= now) { QCC_DbgPrintf(("CheckConnTimers (conn %p): Fire ACK timer %p at %u (now=%u)", conn, conn->ackTimer, conn->ackTimer.when, now)); (conn->ackTimer.handler)(handle, conn, conn->ackTimer.context); } if (conn->ackTimer.when < next && conn->ackTimer.retry != 0) { /* Update "call-me-next-ms" value */ next = conn->ackTimer.when; } /* Check persist timer */ if (conn->persistTimer.retry != 0 && conn->persistTimer.when <= now) { QCC_DbgHLPrintf(("CheckConnTimers: Fire persist timer: handle=%p, conn=%p, id=%u (%d)", handle, conn, conn->id, conn->id)); (conn->persistTimer.handler)(handle, conn, conn->persistTimer.context); conn->persistTimer.when = now + conn->persistTimer.delta; } if (conn->persistTimer.when < next && conn->persistTimer.retry != 0) { /* Update "call-me-next-ms" value */ next = conn->persistTimer.when; moveAhead(handle, conn); } return next; } #if ARDP_TC_SUPPORT static bool IsValidRetransmit(ArdpConnRecord* conn, ArdpSndBuf* sBuf) { uint32_t seq; if (!conn->modeSimple) { return true; } seq = ntohl(((ArdpHeader*)sBuf->hdr)->seq); if ((conn->snd.thinWindow == 0) && SEQ32_LET(conn->snd.thinNXT, seq)) { return false; } else { return true; } } #endif /* * Fire expired ones and return the next one */ static uint32_t CheckTimers(ArdpHandle* handle) { uint32_t nextTime = ARDP_NO_TIMEOUT; uint32_t now = TimeNow(handle->tbase); ListNode* ln = &handle->conns; if (IsEmpty(ln)) { return nextTime; } for (; (ln = ln->fwd) != &handle->conns;) { ListNode* temp = ln->bwd; nextTime = CheckConnTimers(handle, (ArdpConnRecord* ) ln, nextTime, now); /* Check if connection record has been removed due to expiring connect/disconnect timers */ if (IsEmpty(&handle->conns)) { break; } else if (!IsConnValid(handle, (ArdpConnRecord*) ln)) { ln = temp; } } ln = &handle->dataTimers; if (!handle->trafficJam && !IsEmpty(ln)) { for (; (ln = ln->fwd) != &handle->dataTimers;) { ArdpTimer* timer = (ArdpTimer*)ln; if ((timer->when <= now) && (timer->retry > 0)) { QCC_DbgPrintf(("CheckTimers: conn %p, fire retransmit timer %p at %u (now=%u)", timer->conn, timer, timer->when, now)); (timer->handler)(handle, timer->conn, timer->context); timer->when = now + timer->delta; } if (timer->retry == 0) { /* We either hit the retransmit limit or the message's TTL has expired. */ ln = ln->bwd; DeList((ListNode*)timer); break; } else if (timer->when < nextTime #if ARDP_TC_SUPPORT && IsValidRetransmit(timer->conn, (ArdpSndBuf*) timer->context)) { #else ) { #endif /* Update "call-me-next-ms" value */ nextTime = timer->when; } if (handle->trafficJam) { break; } } } return (nextTime != ARDP_NO_TIMEOUT) ? nextTime - now : ARDP_NO_TIMEOUT; } static void DelConnRecord(ArdpHandle* handle, ArdpConnRecord* conn, bool forced) { QCC_UNUSED(handle); QCC_DbgTrace(("DelConnRecord(handle=%p conn=%p forced=%s state=%s)", handle, conn, forced ? "true" : "false", State2Text(conn->state))); if (!forced && conn->state != CLOSED && conn->state != CLOSE_WAIT) { QCC_LogError(ER_ARDP_INVALID_STATE, ("DelConnRecord(): Delete while not CLOSED or CLOSE-WAIT conn %p state %s", conn, State2Text(conn->state))); assert((conn->state == CLOSED || conn->state == CLOSE_WAIT) && "DelConnRecord(): Delete while not CLOSED or CLOSE-WAIT"); } /* Safe to check together as these buffers are always allocated together */ if (conn->snd.buf != NULL && conn->snd.buf[0].hdr != NULL) { free(conn->snd.buf[0].hdr); free(conn->snd.buf); } if (conn->rcv.buf != NULL) { for (uint32_t i = 0; i < conn->rcv.SEGMAX; i++) { if (conn->rcv.buf[i].data != NULL) { free(conn->rcv.buf[i].data); } } free(conn->rcv.buf); } DeList((ListNode*)conn); if (conn->synData.buf != NULL) { free(conn->synData.buf); } delete conn; } static void FlushMessage(ArdpHandle* handle, ArdpConnRecord* conn, ArdpSndBuf* sBuf, QStatus status) { ArdpHeader* h = (ArdpHeader*) sBuf->hdr; uint16_t fcnt = ntohs(h->fcnt); uint32_t len = 0; /* Original sent data buffer */ uint8_t* buf = sBuf->data; /* Mark all SND buffers associated with the message as available */ do { if (sBuf->timer.retry != 0) { assert(conn->state != OPEN); DeList((ListNode*) (&sBuf->timer)); } sBuf->inUse = false; sBuf->fastRT = 0; sBuf->retransmits = 0; len += ntohs(h->dlen); sBuf = sBuf->next; conn->snd.pending--; QCC_DbgPrintf(("FlushMessage(fcnt = %d): pending = %d", fcnt, conn->snd.pending)); assert((conn->snd.pending < conn->snd.SEGMAX) && "Invalid number of pending segments in send queue!"); h = (ArdpHeader*) sBuf->hdr; fcnt--; } while (fcnt > 0); QCC_DbgPrintf(("FlushMessage(): SendCb(handle=%p, conn=%p, buf=%p, len=%d, status=%d", handle, conn, buf, len, status)); #if ARDP_STATS ++handle->stats.sendCbs; #endif handle->cb.SendCb(handle, conn, buf, len, status); } static void FlushSendQueue(ArdpHandle* handle, ArdpConnRecord* conn, QStatus status) { /* * SendCb() for all pending messages so that the upper layer knows * to release the corresponding buffers */ ArdpSndBuf* sBuf = &conn->snd.buf[(conn->snd.LCS + 1) % conn->snd.SEGMAX]; for (uint32_t i = 0; i < conn->snd.SEGMAX; i++) { ArdpHeader* h = (ArdpHeader* ) sBuf->hdr; if (sBuf->inUse && (h->seq == h->som)) { FlushMessage(handle, conn, sBuf, status); } sBuf = sBuf->next; } } static bool IsRcvQueueEmpty(ArdpHandle* handle, ArdpConnRecord* conn) { QCC_UNUSED(handle); for (uint32_t i = 0; i < conn->rcv.SEGMAX; i++) { if (conn->rcv.buf[i].flags & ARDP_BUFFER_DELIVERED) { return false; } } return true; } static void MarshalHeader(uint32_t* buf32, ArdpHeader* h) { uint8_t* txbuf = reinterpret_cast(buf32); *(txbuf + FLAGS_OFFSET) = h->flags; *(txbuf + HLEN_OFFSET) = h->hlen; *reinterpret_cast(txbuf + SRC_OFFSET) = h->src; *reinterpret_cast(txbuf + DST_OFFSET) = h->dst; *reinterpret_cast(txbuf + DLEN_OFFSET) = h->dlen; *reinterpret_cast(txbuf + SEQ_OFFSET) = h->seq; *reinterpret_cast(txbuf + ACK_OFFSET) = h->ack; *reinterpret_cast(txbuf + TTL_OFFSET) = h->ttl; *reinterpret_cast(txbuf + LCS_OFFSET) = h->lcs; *reinterpret_cast(txbuf + ACKNXT_OFFSET) = h->acknxt; *reinterpret_cast(txbuf + SOM_OFFSET) = h->som; *reinterpret_cast(txbuf + FCNT_OFFSET) = h->fcnt; *reinterpret_cast(txbuf + RSRV_OFFSET) = 0; } static void MarshalSynHeader(uint32_t* buf32, ArdpSynHeader* h) { uint8_t* txbuf = reinterpret_cast(buf32); *(txbuf + FLAGS_OFFSET) = h->flags; *(txbuf + HLEN_OFFSET) = h->hlen; *reinterpret_cast(txbuf + SRC_OFFSET) = h->src; *reinterpret_cast(txbuf + DST_OFFSET) = h->dst; *reinterpret_cast(txbuf + DLEN_OFFSET) = h->dlen; *reinterpret_cast(txbuf + SEQ_OFFSET) = h->seq; *reinterpret_cast(txbuf + ACK_OFFSET) = h->ack; *reinterpret_cast(txbuf + SEGMAX_OFFSET) = h->segmax; *reinterpret_cast(txbuf + SEGBMAX_OFFSET) = h->segbmax; *reinterpret_cast(txbuf + DACKT_OFFSET) = h->dackt; *reinterpret_cast(txbuf + OPTIONS_OFFSET) = h->options; *reinterpret_cast(txbuf + SYN_RSRV_OFFSET) = 0; } static QStatus SendMsgHeader(ArdpHandle* handle, ArdpConnRecord* conn, ArdpHeader* h) { qcc::ScatterGatherList msgSG; size_t sent; QStatus status; uint32_t buf32[ARDP_FIXED_HEADER_LEN >> 2]; uint32_t len; QCC_DbgTrace(("SendMsgHeader(): handle=0x%p, conn=0x%p, hdr=0x%p", handle, conn, h)); msgSG.AddBuffer(&buf32[0], ARDP_FIXED_HEADER_LEN); if (conn->rcv.eack.sz != 0) { QCC_DbgPrintf(("SendMsgHeader: have EACKs")); h->flags |= ARDP_FLAG_EACK; len = ARDP_FIXED_HEADER_LEN + conn->rcv.eack.fixedSz; msgSG.AddBuffer(conn->rcv.eack.htnMask, conn->rcv.eack.fixedSz); } else { len = ARDP_FIXED_HEADER_LEN; } /* Safe to type cast since len < 512 */ h->hlen = (uint8_t)(len >> 1); /* Marshal the header structure into a byte buffer */ MarshalHeader(buf32, h); #if ARDP_TESTHOOKS /* * Call the outbound testhook in case the test team needs to munge the * outbound data. */ if (handle->th.SendToSG) { handle->th.SendToSG(handle, conn, SEND_MSG_HEADER, msgSG); } #endif status = SendToSG(conn->sock, conn->ipAddr, conn->ipPort, msgSG, sent, conn->sndFlags); if (status == ER_WOULDBLOCK) { QCC_DbgHLPrintf(("SendMsgHeader: ER_WOULDBLOCK")); handle->trafficJam = true; } else { /* Cancel ACK timer */ conn->ackTimer.retry = 0; conn->ackPending = 0; } conn->sndFlags = qcc::QCC_MSG_NONE; return status; } static QStatus Send(ArdpHandle* handle, ArdpConnRecord* conn, uint8_t flags, uint32_t seq, uint32_t ack) { ArdpHeader h; memset(&h, 0, sizeof (h)); QCC_DbgTrace(("Send(handle=%p, conn=%p, flags=0x%02x, seq=%u, ack=%u)", handle, conn, flags, seq, ack)); h.flags = flags; h.src = htons(conn->local); h.dst = htons(conn->foreign);; h.seq = htonl(seq); h.ack = htonl(ack); h.lcs = htonl(conn->rcv.LCS); h.acknxt = htonl(conn->snd.UNA); if (h.dst == 0) { QCC_DbgPrintf(("Send(): destination = 0")); } return SendMsgHeader(handle, conn, &h); } static void UnmarshalSynSegment(ArdpConnRecord* conn, uint8_t* buf, ArdpSeg* seg) { #if ARDP_TC_SUPPORT uint16_t options = ntohs(*reinterpret_cast(buf + OPTIONS_OFFSET)); conn->modeSimple = (options & ARDP_FLAG_SIMPLE_MODE); #endif conn->foreign = ntohs(*reinterpret_cast(buf + SRC_OFFSET)); /* The source ARDP port */ conn->snd.SEGMAX = ntohs(*reinterpret_cast(buf + SEGMAX_OFFSET)); /* Max number of unacknowledged packets other side can buffer */ conn->snd.SEGBMAX = ntohs(*reinterpret_cast(buf + SEGBMAX_OFFSET)); /* Max size segment the other side can handle */ conn->snd.DACKT = ntohl(*reinterpret_cast(buf + DACKT_OFFSET)); /* Delayed ACK timeout from the other side. */ #if ARDP_TC_SUPPORT conn->snd.thinSEGMAX = conn->snd.SEGMAX; conn->snd.thinWindow = conn->snd.SEGMAX; #endif conn->rcv.CUR = seg->SEQ; conn->rcv.IRS = seg->SEQ; conn->rcv.LCS = seg->SEQ; /* Fixed size of EACK bitmask */ conn->remoteMskSz = ((conn->snd.SEGMAX + 31) >> 5); } static void DisconnectTimerHandler(ArdpHandle* handle, ArdpConnRecord* conn, void* context) { QCC_DbgTrace(("DisconnectTimerHandler: handle=%p conn=%p", handle, conn)); /* Tricking the compiler */ QStatus reason = static_cast(reinterpret_cast(context)); QCC_DbgPrintf(("DisconnectTimerHandler: handle=%p conn=%p reason=%p", handle, conn, QCC_StatusText(reason))); SetState(conn, CLOSED); /* * In case the upper layer initiated the disconnect, we still need to send * DisconnectCb(). For all the other cases the DisconnectCb was issued inside Disconnect(). */ if (reason == ER_OK) { if (conn->snd.pending != 0) { FlushSendQueue(handle, conn, ER_ARDP_DISCONNECTING); } QCC_DbgPrintf(("DisconnectTimerHandler: DisconnectCb(handle=%p conn=%p reason = %s)", handle, conn, QCC_StatusText(reason))); #if ARDP_STATS ++handle->stats.disconnectCbs; #endif handle->cb.DisconnectCb(handle, conn, reason); /* * Change the status to ER_ARDP_INVALID_CONNECTION. This is needed in case the DisconnectTimer is rescheduled * in order to wait on RCV queue to drain. */ reason = ER_ARDP_INVALID_CONNECTION; conn->connectTimer.context = (void*) reason; } /* Check if there are any received buffers delivered to the upper layer that haven't been comsumed yet */ if (IsRcvQueueEmpty(handle, conn)) { DelConnRecord(handle, conn, false); } else { /* Reschedule connection removal */ QCC_DbgPrintf(("DisconnectTimerHandler: waiting for receive Q to drain handle=%p, con=%p", handle, conn)); UpdateTimer(handle, conn, &conn->connectTimer, ARDP_DISCONNECT_RETRY_TIMEOUT, ARDP_DISCONNECT_RETRY); } } static void ConnectTimerHandler(ArdpHandle* handle, ArdpConnRecord* conn, void* context) { QCC_UNUSED(context); QCC_DbgTrace(("ConnectTimerHandler: handle=%p conn=%p", handle, conn)); QStatus status = ER_FAIL; ArdpTimer* timer = &conn->connectTimer; QCC_DbgTrace(("ConnectTimerHandler: retries left %d", timer->retry)); if (timer->retry > 1) { status = DoSendSyn(handle, conn, conn->synData.buf, conn->synData.len); if (status == ER_WOULDBLOCK) { /* Retry sooner */ timer->delta = handle->config.connectTimeout >> 2; status = ER_OK; } else if (status == ER_OK) { timer->delta = handle->config.connectTimeout; } } if (status != ER_OK) { SetState(conn, CLOSED); #if ARDP_STATS ++handle->stats.connectCbs; #endif handle->cb.ConnectCb(handle, conn, conn->passive, NULL, 0, ER_TIMEOUT); #if ARDP_STATS ++handle->stats.rstSends; #endif #if ARDP_TC_SUPPORT Send(handle, conn, ARDP_FLAG_RST | ARDP_FLAG_VER, (conn->modeSimple) ? conn->snd.thinNXT : conn->snd.NXT, conn->rcv.CUR); #else Send(handle, conn, ARDP_FLAG_RST | ARDP_FLAG_VER, conn->snd.NXT, conn->rcv.CUR); #endif /* * Do not delete connection record here: * The upper layer will detect an error status and call ARDP_ReleaseConnection() */ timer->retry = 0; } else { timer->retry--; } } static void AckTimerHandler(ArdpHandle* handle, ArdpConnRecord* conn, void* context) { QCC_UNUSED(context); #if ARDP_TC_SUPPORT QStatus status = Send(handle, conn, ARDP_FLAG_ACK | ARDP_FLAG_VER, (conn->modeSimple) ? conn->snd.thinNXT : conn->snd.NXT, conn->rcv.CUR); #else QStatus status = Send(handle, conn, ARDP_FLAG_ACK | ARDP_FLAG_VER, conn->snd.NXT, conn->rcv.CUR); #endif if (status == ER_WOULDBLOCK) { conn->ackTimer.delta = 0; } } static void ExpireMessageSnd(ArdpHandle* handle, ArdpConnRecord* conn, ArdpSndBuf* sBuf, uint32_t msElapsed) { QCC_UNUSED(msElapsed); ArdpHeader* h = (ArdpHeader*) sBuf->hdr; uint32_t som = ntohl(h->som); uint16_t fcnt = ntohs(h->fcnt); uint16_t cnt = fcnt; ArdpSndBuf* start = &conn->snd.buf[som % conn->snd.SEGMAX]; /* Start fragment of the expired message */ sBuf = start; QCC_DbgPrintf(("ExpireMessageSnd: message with SOM %u and fcnt %d expired", som, fcnt)); do { h = (ArdpHeader*) sBuf->hdr; sBuf->timer.retry = 0; sBuf->ttl = ARDP_TTL_EXPIRED; sBuf = sBuf->next; cnt--; } while (cnt != 0); /* * If the last unAcked segment is associated with the expired message, * advance snd.UNA counter to the start of the next message. */ if (SEQ32_LET(som, conn->snd.UNA) && SEQ32_LT(conn->snd.UNA, som + fcnt)) { /* * Notice that it is possible for UNA to catch up with NXT when the expired * message is the last one that has been sent out. */ conn->snd.UNA = som + fcnt; /* Schedule "unsolicited" ACK to allow the receiver to move on */ if (conn->ackTimer.retry == 0) { UpdateTimer(handle, conn, &conn->ackTimer, ARDP_MIN_DELAYED_ACK_TIMEOUT, 1); } } #if ARDP_TC_SUPPORT /* Advance NXT counter in simple mode */ if (conn->modeSimple) { QCC_DbgPrintf(("ExpireMessageSnd(): thinNXT %u", conn->snd.thinNXT)); if (SEQ32_LET(som, conn->snd.thinNXT) && SEQ32_LT(conn->snd.thinNXT, som + fcnt)) { conn->snd.thinNXT = som + fcnt; QCC_DbgPrintf(("ExpireMessageSnd(): Update thinNXT %u", conn->snd.thinNXT)); } } #endif } static QStatus SendMsgData(ArdpHandle* handle, ArdpConnRecord* conn, ArdpSndBuf* sBuf, uint32_t ttl) { ArdpHeader* h = (ArdpHeader*) sBuf->hdr; qcc::ScatterGatherList msgSG; uint32_t buf32[ARDP_FIXED_HEADER_LEN >> 2]; uint32_t len; size_t sent; QStatus status; QCC_DbgTrace(("SendMsgData(): handle=%p, conn=%p, hdr=%p, data=%p, datalen=%d, ttl=%u, tStart=%u", handle, conn, sBuf->hdr, sBuf->data, sBuf->datalen, sBuf->ttl, sBuf->tStart)); msgSG.AddBuffer(&buf32[0], ARDP_FIXED_HEADER_LEN); h->ack = htonl(conn->rcv.CUR); h->lcs = htonl(conn->rcv.LCS); h->acknxt = htonl(conn->snd.UNA); h->flags = ARDP_FLAG_ACK | ARDP_FLAG_VER; h->ttl = htonl(ttl); QCC_DbgPrintf(("SendMsgData(): seq = %u, ack=%u, lcs = %u, ttl=%u", ntohl(h->seq), conn->rcv.CUR, conn->rcv.LCS, ttl)); if (conn->rcv.eack.sz == 0) { len = ARDP_FIXED_HEADER_LEN; } else { QCC_DbgPrintf(("SendMsgData(): have EACKs")); h->flags |= ARDP_FLAG_EACK; len = ARDP_FIXED_HEADER_LEN + conn->rcv.eack.fixedSz; msgSG.AddBuffer(conn->rcv.eack.htnMask, conn->rcv.eack.fixedSz); } /* Safe to type cast since len < 512 */ h->hlen = (uint8_t)(len >> 1); /* Marshal the header structure into a byte buffer */ MarshalHeader(buf32, h); /* Add data payload buffer */ msgSG.AddBuffer(sBuf->data, sBuf->datalen); #if ARDP_TESTHOOKS /* * Call the outbound testhook in case the test team needs to munge the * outbound data. */ if (handle->th.SendToSG) { handle->th.SendToSG(handle, conn, SEND_MSG_DATA, msgSG); } #endif status = qcc::SendToSG(conn->sock, conn->ipAddr, conn->ipPort, msgSG, sent, conn->sndFlags); if (status == ER_OK) { /* Piggyback ACKs with data. Cancel ACK timer. */ conn->ackTimer.retry = 0; conn->ackPending = 0; handle->trafficJam = false; } else if (status == ER_WOULDBLOCK) { handle->trafficJam = true; } conn->sndFlags = qcc::QCC_MSG_NONE; return status; } static QStatus Disconnect(ArdpHandle* handle, ArdpConnRecord* conn, QStatus reason) { QStatus status = ER_OK; uint32_t timeout = 0; QCC_DbgTrace(("Disconnect(handle=%p, conn=%p, reason=%s)", handle, conn, QCC_StatusText(reason))); if (conn->state == CLOSE_WAIT || conn->state == CLOSED) { QCC_DbgPrintf(("Disconnect(handle=%p, conn=%p, reason=%s) Already disconnect%s", handle, conn, QCC_StatusText(reason), conn->state == CLOSED ? "ed" : "ing")); return ER_OK; } if (!IsConnValid(handle, conn)) { return ER_ARDP_INVALID_CONNECTION; } /* Is there a nice macro that would wrap integer into pointer? Just to avoid nasty surprises... */ assert(sizeof(QStatus) <= sizeof(void*)); SetState(conn, CLOSE_WAIT); /* If the local side is the one initiating the disconnect, send RST segment to the remote */ if (reason != ER_ARDP_REMOTE_CONNECTION_RESET) { #if ARDP_STATS ++handle->stats.rstSends; #endif #if ARDP_TC_SUPPORT status = Send(handle, conn, ARDP_FLAG_RST | ARDP_FLAG_VER, (conn->modeSimple) ? conn->snd.thinNXT : conn->snd.NXT, conn->rcv.CUR); #else status = Send(handle, conn, ARDP_FLAG_RST | ARDP_FLAG_VER, conn->snd.NXT, conn->rcv.CUR); #endif if (status != ER_OK) { QCC_LogError(status, ("Disconnect: failed to send RST to the remote")); } } /* If this disconnect is not a result of ARDP_Disconnect(), inform the upper layer that we are disconnecting */ if (reason != ER_OK) { if (conn->snd.pending != 0) { FlushSendQueue(handle, conn, ER_ARDP_DISCONNECTING); } timeout = handle->config.timewait; QCC_DbgPrintf(("Disconnect: Call DisconnectCb() on conn %p, state %s reason %s ", conn, State2Text(conn->state), QCC_StatusText(reason))); #if ARDP_STATS ++handle->stats.disconnectCbs; #endif handle->cb.DisconnectCb(handle, conn, reason); } InitTimer(handle, conn, &conn->connectTimer, DisconnectTimerHandler, (void*) reason, timeout, ARDP_DISCONNECT_RETRY); return status; } /* * error = measuredRTT - meanRTT * new meanRTT = 7/8 * meanRTT + 1/8 * error * if (measuredRTT >= (meanRTT - meanVAR)) * new meanVar = 3/4 * meanVar + 1/4 * |error| * else * new meanVar = 31/32 * meanVar + 1/32 * |error| * * Since ARDP segments can have varying length, maintain additional * mean RTT calculation of UDP MTU unit that will be used in message TTL estimate. */ static void AdjustRTT(ArdpHandle* handle, ArdpConnRecord* conn, ArdpSndBuf* sBuf) { uint32_t now = TimeNow(handle->tbase); uint16_t units = (sBuf->datalen + UDP_MTU - 1) / UDP_MTU; uint32_t rtt = now - sBuf->tStart; uint32_t rttUnit = rtt / units; int32_t err; if (!conn->rttInit) { conn->rttMean = rtt; conn->rttMeanVar = rtt >> 1; conn->rttInit = true; } err = rtt - conn->rttMean; QCC_DbgHLPrintf(("AdjustRtt: mean = %u, var =%u, rtt = %u, now = %u, tStart= %u, error = %d", conn->rttMean, conn->rttMeanVar, rtt, now, sBuf->tStart, err)); conn->rttMean = (7 * conn->rttMean + rtt) >> 3; if ((rtt + conn->rttMeanVar) >= conn->rttMean) { conn->rttMeanVar = (conn->rttMeanVar * 3 + ABS(err)) >> 2; } else { conn->rttMeanVar = (conn->rttMeanVar * 31 + ABS(err)) >> 5; } rttUnit = (7 * conn->rttMeanUnit + rttUnit) >> 3; conn->backoff = 0; QCC_DbgHLPrintf(("AdjustRtt: New mean = %u, var =%u", conn->rttMean, conn->rttMeanVar)); } inline static uint32_t GetRTO(ArdpHandle* handle, ArdpConnRecord* conn) { QCC_UNUSED(handle); /* RTO = (rttMean + (4 * rttMeanVar)) << backoff */ uint32_t ms = (MAX((uint32_t)ARDP_MIN_RTO, conn->rttMean + (4 * conn->rttMeanVar))) << conn->backoff; if (ms < conn->snd.DACKT) { ms += (conn->snd.DACKT >> 1); } return MIN(ms, (uint32_t)ARDP_MAX_RTO); } inline static uint32_t GetDataTimeout(ArdpHandle* handle, ArdpConnRecord* conn) { uint32_t timeout = handle->config.totalDataRetryTimeout; if (conn->rttInit) { timeout = MAX(timeout, (conn->snd.SEGMAX * conn->snd.SEGBMAX * (conn->rttMean >> 1)) / UDP_MTU); } return timeout; } static void RetransmitTimerHandler(ArdpHandle* handle, ArdpConnRecord* conn, void* context) { ArdpSndBuf* sBuf = (ArdpSndBuf*) context; ArdpTimer* timer = &sBuf->timer; uint32_t msElapsed = TimeNow(handle->tbase) - sBuf->tStart; uint32_t timeout = GetDataTimeout(handle, conn); QCC_DbgTrace(("RetransmitTimerHandler: handle=%p conn=%p context=%p", handle, conn, context)); assert(sBuf->inUse && "RetransmitTimerHandler: trying to resend flushed buffer"); sBuf->retransmits++; if ((msElapsed >= timeout) && (timer->retry > handle->config.minDataRetries)) { QCC_DbgHLPrintf(("RetransmitTimerHandler seq=%u hit the time limit %u, retries %u", ntohl(((ArdpHeader*)sBuf->hdr)->seq), timeout, timer->retry)); timer->retry = 0; Disconnect(handle, conn, ER_TIMEOUT); } else { QStatus status; QCC_DbgPrintf(("RetransmitTimerHandler: context=sBuf=%p seq=%u retries=%d", sBuf, ntohl(((ArdpHeader*)sBuf->hdr)->seq), timer->retry)); /* * Check TTL of the segment about to be retransmitted. If TTL expired, * do not retransmit and flush the whole message. */ if (sBuf->ttl != ARDP_TTL_INFINITE) { /* Factor in mean RTT to account for time on the wire */ if (conn->rttInit) { msElapsed += MIN((conn->rttMeanUnit * (sBuf->datalen + UDP_MTU - 1) / UDP_MTU) >> 1, (conn->rttMean >> 1)); } if (msElapsed >= sBuf->ttl) { #if ARDP_STATS ++handle->stats.outboundDrops; ++handle->stats.inflightDrops; #endif QCC_DbgPrintf(("RetransmitTimerHandler: segment %u expired", ntohl(((ArdpHeader*)sBuf->hdr)->seq))); ExpireMessageSnd(handle, conn, sBuf, msElapsed); return; } } else { msElapsed = 0; } #if ARDP_TC_SUPPORT if (!IsValidRetransmit(conn, sBuf)) { return; } #endif status = SendMsgData(handle, conn, sBuf, sBuf->ttl - msElapsed); if (status == ER_OK) { conn->backoff = MAX(conn->backoff, timer->retry); if (conn->rttInit) { timer->delta = GetRTO(handle, conn); } else { timer->delta = handle->config.initialDataTimeout; } timer->retry++; #if ARDP_TC_SUPPORT if (conn->modeSimple) { QCC_DbgPrintf(("RetransmitTimerHandler(): thinWindow %u, thinNXT %u", conn->snd.thinWindow, conn->snd.thinNXT)); /* * If this is a Simple Mode connection and this segment has never been sent, * update our "thin" accounting. */ if (SEQ32_LET(conn->snd.thinNXT, ntohl(((ArdpHeader*)sBuf->hdr)->seq))) { assert(conn->snd.thinWindow != 0); conn->snd.thinWindow--; conn->snd.thinNXT++; } QCC_DbgPrintf(("RetransmitTimerHandler(): Update thinWindow %u, thinNXT %u", conn->snd.thinWindow, conn->snd.thinNXT)); } #endif } else if (status == ER_WOULDBLOCK) { QCC_DbgHLPrintf(("RetransmitTimerHandler: segment %u ER_WOULDBLOCK", ntohl(((ArdpHeader*)sBuf->hdr)->seq))); timer->delta = 0; } else { QCC_LogError(status, ("RetransmitTimerHandler: Write to Socket went bad. Disconnect.")); timer->retry = 0; Disconnect(handle, conn, status); } } } static inline bool IsDataRetransmitScheduled(ArdpConnRecord* conn) { return (((conn->snd.UNA + 1) != conn->snd.NXT) && (conn->snd.UNA != conn->snd.NXT)); } static void PersistTimerHandler(ArdpHandle* handle, ArdpConnRecord* conn, void* context) { QCC_UNUSED(context); ArdpTimer* timer = &conn->persistTimer; QStatus status; QCC_DbgHLPrintf(("PersistTimerHandler: handle=%p conn=%p context=%p delta %u retry %u", handle, conn, context, timer->delta, timer->retry)); if ((conn->window < conn->snd.SEGMAX) && !IsDataRetransmitScheduled(conn)) { if (timer->retry > 1) { QCC_DbgPrintf(("PersistTimerHandler: window %u", conn->window)); #if ARDP_TC_SUPPORT status = Send(handle, conn, ARDP_FLAG_ACK | ARDP_FLAG_VER | ARDP_FLAG_NUL, (conn->modeSimple) ? conn->snd.thinNXT : conn->snd.NXT, conn->rcv.CUR); #else status = Send(handle, conn, ARDP_FLAG_ACK | ARDP_FLAG_VER | ARDP_FLAG_NUL, conn->snd.NXT, conn->rcv.CUR); #endif if (status == ER_OK) { timer->retry--; //timer->delta = handle->config.persistInterval << ((handle->config.totalAppTimeout / handle->config.persistInterval) - timer->retry); #if ARDP_STATS ++handle->stats.nulSends; #endif } } else { QCC_LogError(ER_ARDP_PERSIST_TIMEOUT, ("PersistTimerHandler: Persist Timeout (frozen window %d)", conn->window)); Disconnect(handle, conn, ER_ARDP_PERSIST_TIMEOUT); } } } static void ProbeTimerHandler(ArdpHandle* handle, ArdpConnRecord* conn, void* context) { ArdpTimer* timer = &conn->probeTimer; QStatus status; uint32_t now = *((uint32_t* ) context); uint32_t elapsed = now - conn->lastSeen; QCC_DbgHLPrintf(("ProbeTimerHandler: handle=%p conn=%p delta %u now %u lastSeen = %u elapsed %u", handle, conn, timer->delta, now, conn->lastSeen, elapsed)); /* If there are no sent segments in flight, reset RTT calculation. */ if (!IsDataRetransmitScheduled(conn)) { conn->rttInit = false; } /* * Checking for total link timeout in very unlikely case the socket write is blocked for * exceedingly long time period during which we fail to send probe NUL segment. */ if ((elapsed > timer->delta) || (elapsed >= handle->config.linkTimeout)) { if (timer->retry == 0) { QCC_DbgHLPrintf(("ProbeTimerHandler: Probe Timeout: now =%u, lastSeen = %u, (limit of %u)", now, conn->lastSeen, handle->config.linkTimeout)); Disconnect(handle, conn, ER_ARDP_PROBE_TIMEOUT); } else { QCC_DbgHLPrintf(("ProbeTimerHandler: send ping (NUL packet)")); #if ARDP_TC_SUPPORT status = Send(handle, conn, ARDP_FLAG_ACK | ARDP_FLAG_VER | ARDP_FLAG_NUL, (conn->modeSimple) ? conn->snd.thinNXT : conn->snd.NXT, conn->rcv.CUR); #else status = Send(handle, conn, ARDP_FLAG_ACK | ARDP_FLAG_VER | ARDP_FLAG_NUL, conn->snd.NXT, conn->rcv.CUR); #endif if (status == ER_OK) { timer->retry--; #if ARDP_STATS ++handle->stats.nulSends; #endif } else if (status != ER_WOULDBLOCK) { /* Socket error */ Disconnect(handle, conn, ER_FAIL); } } } } ArdpHandle* ARDP_AllocHandle(ArdpGlobalConfig* config) { QCC_DbgTrace(("ARDP_AllocHandle()")); srand(qcc::Rand32()); ArdpHandle* handle = new ArdpHandle; memset(handle, 0, sizeof(ArdpHandle)); SetEmpty(&handle->conns); SetEmpty(&handle->dataTimers); GetTimeNow(&handle->tbase); handle->msnext = ARDP_NO_TIMEOUT; memcpy(&handle->config, config, sizeof(ArdpGlobalConfig)); return handle; } void ARDP_FreeHandle(ArdpHandle* handle) { QCC_DbgTrace(("ARDP_FreeHandle(handle=0%p)", handle)); if (!IsEmpty(&handle->conns)) { for (ListNode* ln = &handle->conns; (ln = ln->fwd) != &handle->conns;) { ListNode* tmp = ln; ln = ln->bwd; SetState((ArdpConnRecord*)tmp, CLOSED); DelConnRecord(handle, (ArdpConnRecord*)tmp, false); } } delete handle; } void ARDP_SetAcceptCb(ArdpHandle* handle, ARDP_ACCEPT_CB AcceptCb) { QCC_DbgTrace(("ARDP_SetAcceptCb(handle=%p, AcceptCb=%p)", handle, AcceptCb)); handle->cb.AcceptCb = AcceptCb; } void ARDP_SetConnectCb(ArdpHandle* handle, ARDP_CONNECT_CB ConnectCb) { QCC_DbgTrace(("ARDP_SetConnectCb(handle=%p, ConnectCb=%p)", handle, ConnectCb)); handle->cb.ConnectCb = ConnectCb; } void ARDP_SetDisconnectCb(ArdpHandle* handle, ARDP_DISCONNECT_CB DisconnectCb) { QCC_DbgTrace(("ARDP_SetDisconnectCb(handle=%p, DisconnectCb=%p)", handle, DisconnectCb)); handle->cb.DisconnectCb = DisconnectCb; } void ARDP_SetRecvCb(ArdpHandle* handle, ARDP_RECV_CB RecvCb) { QCC_DbgTrace(("ARDP_SetRecvCb(handle=%p, RecvCb=%p)", handle, RecvCb)); handle->cb.RecvCb = RecvCb; } void ARDP_SetSendCb(ArdpHandle* handle, ARDP_SEND_CB SendCb) { QCC_DbgTrace(("ARDP_SetSendCb(handle=%p, SendCb=%p)", handle, SendCb)); handle->cb.SendCb = SendCb; } void ARDP_SetSendWindowCb(ArdpHandle* handle, ARDP_SEND_WINDOW_CB SendWindowCb) { QCC_DbgTrace(("ARDP_SetSendWindowCb(handle=%p, SendWindowCb=%p)", handle, SendWindowCb)); handle->cb.SendWindowCb = SendWindowCb; } #if ARDP_TESTHOOKS void ARDP_HookSendToSG(ArdpHandle* handle, ARDP_SENDTOSG_TH SendToSG) { QCC_DbgTrace(("ARDP_HookSendToSG(handle=%p, RecvCb=%p)", handle, SendToSG)); handle->th.SendToSG = SendToSG; } void ARDP_HookSendTo(ArdpHandle* handle, ARDP_SENDTO_TH SendTo) { QCC_DbgTrace(("ARDP_HookSendTo(handle=%p, SendTo=%p)", handle, SendTo)); handle->th.SendTo = SendTo; } void ARDP_HookRecvFrom(ArdpHandle* handle, ARDP_RECVFROM_TH RecvFrom) { QCC_DbgTrace(("ARDP_HookRecvFrom(handle=%p, RecvFrom=%p)", handle, RecvFrom)); handle->th.RecvFrom = RecvFrom; } #endif #if ARDP_STATS ArdpStats* ARDP_GetStats(ArdpHandle* handle) { QCC_DbgTrace(("ARDP_GetStats(handle=%p)", handle)); return &handle->stats; } void ARDP_ResetStats(ArdpHandle* handle) { QCC_DbgTrace(("ARDP_ResetStats(handle=%p)", handle)); memset(&handle->stats, 0, sizeof(handle->stats)); } #endif void ARDP_SetHandleContext(ArdpHandle* handle, void* context) { QCC_DbgTrace(("ARDP_SetHandleContext(handle=%p, context=%p)", handle, context)); handle->context = context; } void ARDP_ReleaseConnection(ArdpHandle* handle, ArdpConnRecord* conn) { QCC_DbgTrace(("ARDP_ReleaseConnection(handle=%p, conn=%p)", handle, conn)); if (!IsConnValid(handle, conn)) { QCC_LogError(ER_ARDP_INVALID_CONNECTION, ("ARDP_ReleaseConnection(handle=%p), context = %p", handle, handle->context)); return; } DelConnRecord(handle, conn, true); } void* ARDP_GetHandleContext(ArdpHandle* handle) { QCC_DbgTrace(("ARDP_GetHandleContext(handle=%p)", handle)); return handle->context; } bool ARDP_IsConnValid(ArdpHandle* handle, ArdpConnRecord* conn, uint32_t connId) { QCC_DbgTrace(("ARDP_IsConnValid(handle=%p, conn=%p)", handle, conn)); if (IsConnValid(handle, conn)) { if (conn->id == connId) { return true; } } return false; } QStatus ARDP_SetConnContext(ArdpHandle* handle, ArdpConnRecord* conn, void* context) { QCC_DbgTrace(("ARDP_SetConnContext(handle=%p, conn=%p, context=%p)", handle, conn, context)); if (!IsConnValid(handle, conn)) { QCC_LogError(ER_ARDP_INVALID_CONNECTION, ("ARDP_SetHandleContext(handle=%p), context = %p", handle, handle->context)); return ER_ARDP_INVALID_CONNECTION; } conn->context = context; return ER_OK; } void* ARDP_GetConnContext(ArdpHandle* handle, ArdpConnRecord* conn) { QCC_DbgTrace(("ARDP_GetConnContext(handle=%p, conn=%p)", handle, conn)); if (!IsConnValid(handle, conn)) { QCC_LogError(ER_ARDP_INVALID_CONNECTION, ("ARDP_GetHandleContext(handle=%p), context = %p", handle, handle->context)); return NULL; } return conn->context; } uint32_t ARDP_GetConnId(ArdpHandle* handle, ArdpConnRecord* conn) { QCC_DbgTrace(("ARDP_GetConnId(handle=%p, conn=%p)", handle, conn)); if (!IsConnValid(handle, conn)) { QCC_LogError(ER_ARDP_INVALID_CONNECTION, ("ARDP_GetConnId(handle=%p), context = %p", handle, handle->context)); return ARDP_CONN_ID_INVALID; } return conn->id; } uint32_t ARDP_GetConnPending(ArdpHandle* handle, ArdpConnRecord* conn) { QCC_DbgTrace(("ARDP_GetConnPending(handle=%p, conn=%p)", handle, conn)); if (!IsConnValid(handle, conn)) { QCC_LogError(ER_ARDP_INVALID_CONNECTION, ("ARDP_GetConnPending(handle=%p), context = %p", handle, handle->context)); assert(false && "Connection not found"); return 0; } return conn->snd.pending; } qcc::IPAddress ARDP_GetIpAddrFromConn(ArdpHandle* handle, ArdpConnRecord* conn) { QCC_DbgTrace(("ARDP_GetIpAddrFromConn(handle=%p, conn=%p)", handle, conn)); if (!IsConnValid(handle, conn)) { QCC_LogError(ER_ARDP_INVALID_CONNECTION, ("ARDP_GetIpAddrFromConn(handle=%p), context = %p", handle, handle->context)); return qcc::IPAddress(); } return conn->ipAddr; } uint16_t ARDP_GetIpPortFromConn(ArdpHandle* handle, ArdpConnRecord* conn) { QCC_DbgTrace(("ARDP_GetIpPortFromConn(handle=%p, conn=%p)", handle, conn)); if (!IsConnValid(handle, conn)) { QCC_LogError(ER_ARDP_INVALID_CONNECTION, ("ARDP_GetIpPortFromConn(handle=%p), context = %p", handle, handle->context)); return 0; } return conn->ipPort; } /* * Dynamic data timeout based on connection statistics. * Add some headroom for data timeout as it will appear outside ARDP. */ uint32_t ARDP_GetDataTimeout(ArdpHandle* handle, ArdpConnRecord* conn) { if (!IsConnValid(handle, conn)) { QCC_LogError(ER_ARDP_INVALID_CONNECTION, ("ARDP_GetIpPortFromConn(handle=%p), context = %p", handle, handle->context)); return handle->config.totalDataRetryTimeout + 2 * handle->config.initialDataTimeout; } return (GetDataTimeout(handle, conn) + 2 * handle->config.initialDataTimeout); } static ArdpConnRecord* NewConnRecord(void) { QCC_DbgTrace(("NewConnRecord()")); ArdpConnRecord* conn = new ArdpConnRecord(); memset(conn, 0, sizeof(ArdpConnRecord)); do { conn->id = qcc::Rand32(); } while (conn->id == ARDP_CONN_ID_INVALID); QCC_DbgTrace(("NewConnRecord(): conn %p, id %u", conn, conn->id)); SetEmpty(&conn->list); return conn; } static QStatus InitRcv(ArdpConnRecord* conn, uint32_t segmax, uint32_t segbmax) { conn->rcv.SEGMAX = segmax; /* The maximum number of outstanding segments that we can buffer (we will tell other side) */ conn->rcv.SEGBMAX = segbmax; /* The largest buffer that can be received on this connection (our buffer size) */ conn->rcv.buf = (ArdpRcvBuf*) malloc(segmax * sizeof(ArdpRcvBuf)); if (conn->rcv.buf == NULL) { QCC_DbgPrintf(("InitRcv: Failed to allocate space for receive structure")); return ER_OUT_OF_MEMORY; } memset(conn->rcv.buf, 0, segmax * sizeof(ArdpRcvBuf)); for (uint32_t i = 0; i < segmax; i++) { conn->rcv.buf[i].next = &conn->rcv.buf[((i + 1) % segmax)]; } return ER_OK; } /* Extra Initialization after connection has been established */ static void PostInitRcv(ArdpConnRecord* conn) { conn->rcv.LCS = conn->rcv.CUR; for (uint16_t i = 0; i < conn->rcv.SEGMAX; i++) { conn->rcv.buf[i].seq = conn->rcv.IRS; } } static QStatus InitConnRecord(ArdpHandle* handle, ArdpConnRecord* conn, qcc::SocketFd sock, qcc::IPAddress ipAddr, uint16_t ipPort, uint16_t foreign) { QCC_DbgTrace(("InitConnRecord(handle=%p, conn=%p, sock=%d, ipAddr=\"%s\", ipPort=%d, foreign=%d)", handle, conn, sock, ipAddr.ToString().c_str(), ipPort, foreign)); uint16_t local; uint32_t count = 0; conn->state = CLOSED; /* Starting state is always CLOSED */ local = (qcc::Rand32() % 65534) + 1; /* Allocate an "ephemeral" source port */ /* Make sure this is a unique combiation of foreign/local */ while (FindConn(handle, local, foreign) != NULL) { local++; count++; if (count == 65535) { /* Really? We exhausted all the connections?! */ QCC_LogError(ER_FAIL, ("InitConnRecord: Cannot get a new connection record. Too many connections?")); return ER_FAIL; } } conn->local = local; conn->foreign = foreign; /* The ARDP port of the foreign host */ conn->sock = sock; /* The socket to use when talking on this connection */ conn->ipAddr = ipAddr; /* The IP address of the foreign host */ conn->ipPort = ipPort; /* The UDP port of the foreign host */ conn->lastSeen = TimeNow(handle->tbase); /* Initialize the sender side of the connection */ conn->snd.ISS = qcc::Rand32(); /* Initial sequence number used for sending data over this connection */ conn->snd.NXT = conn->snd.ISS + 1; /* The sequence number of the next segment to be sent over this connection */ #if ARDP_TC_SUPPORT conn->snd.thinNXT = conn->snd.NXT; /* The sequence number of the next segment to be sent over simple mode connection */ #endif conn->snd.UNA = conn->snd.ISS; /* The oldest unacknowledged segment is the ISS */ conn->snd.LCS = conn->snd.ISS; /* The most recently consumed segment (we keep this in sync with the other side) */ conn->rttInit = false; conn->rttMean = handle->config.initialDataTimeout; conn->rttMeanUnit = handle->config.initialDataTimeout; conn->rttMeanVar = 0; conn->backoff = 0; return ER_OK; } static void ProtocolDemux(uint8_t* buf, uint16_t len, uint16_t* local, uint16_t* foreign) { QCC_UNUSED(len); QCC_DbgTrace(("ProtocolDemux(buf=%p, len=%d, local*=%p, foreign*=%p)", buf, len, local, foreign)); *local = ntohs(*reinterpret_cast(buf + DST_OFFSET)); *foreign = ntohs(*reinterpret_cast(buf + SRC_OFFSET)); QCC_DbgTrace(("ProtocolDemux(): local %d, foreign %d", *local, *foreign)); } static ArdpConnRecord* FindConn(ArdpHandle* handle, uint16_t local, uint16_t foreign) { QCC_DbgTrace(("FindConn(handle=%p, local=%d, foreign=%d)", handle, local, foreign)); for (ListNode* ln = &handle->conns; (ln = ln->fwd) != &handle->conns;) { ArdpConnRecord* conn = (ArdpConnRecord*)ln; QCC_DbgPrintf(("FindConn(): conn %p local = %d, foreign = %d", conn, conn->local, conn->foreign)); if (conn->local == local && conn->foreign == foreign) { QCC_DbgPrintf(("FindConn(): Found conn %p", conn)); return conn; } } return NULL; } static QStatus SendData(ArdpHandle* handle, ArdpConnRecord* conn, uint8_t* buf, uint32_t len, uint32_t ttl) { QStatus status = ER_OK; uint32_t timeout = handle->config.initialDataTimeout; uint16_t fcnt; uint32_t lastLen; uint8_t* segData = buf; uint32_t som = htonl(conn->snd.NXT); uint16_t index = conn->snd.NXT % conn->snd.SEGMAX; ArdpSndBuf* sBuf = &conn->snd.buf[index]; uint32_t now = TimeNow(handle->tbase); uint32_t ttlSend = ttl; QCC_DbgTrace(("SendData(handle=%p, conn=%p, buf=%p, len=%u, ttl=%u)", handle, conn, buf, len, ttl)); QCC_DbgPrintf(("SendData(): Sending %u bytes of data from src=0x%x to dst=0x%x", len, conn->local, conn->foreign)); /* Check if message needs to be fragmented */ if (len <= conn->snd.maxDlen) { /* Data fits into one segment */ fcnt = 1; lastLen = len; } else { /* Need fragmentation */ fcnt = (len + (conn->snd.maxDlen - 1)) / conn->snd.maxDlen; lastLen = len - conn->snd.maxDlen * (fcnt - 1); QCC_DbgPrintf(("SendData(): Large buffer %d, partitioning into %d segments", len, fcnt)); } assert(fcnt != 0); /* Check if receiver's window is wide enough to accept FCNT number of segments */ if (fcnt > conn->window) { QCC_DbgPrintf(("SendData(): number of fragments %u exceeds the window size %u", fcnt, conn->window)); return ER_ARDP_BACKPRESSURE; } /* Check if send queue is deep enough to hold FCNT number of segments */ if (fcnt > (conn->snd.SEGMAX - conn->snd.pending)) { QCC_DbgPrintf(("SendData(): number of fragments %u exceeds the send queue depth %u", fcnt, conn->snd.SEGMAX - conn->snd.pending)); return ER_ARDP_BACKPRESSURE; } /* * Check if the message's TTL is less than half RTT. If this is the case, * do not bother sending, return error. */ if (conn->rttInit && (ttl != ARDP_TTL_INFINITE)) { uint32_t expireThreshold = MIN((conn->rttMeanUnit * (len + UDP_MTU - 1) / UDP_MTU) >> 1, ((conn->rttMean * fcnt) >> 1)); if ((ttl + conn->snd.DACKT) <= expireThreshold) { #if ARDP_STATS ++handle->stats.outboundDrops; ++handle->stats.preflightDrops; #endif QCC_DbgPrintf(("SendMsgData(): Dropping expired message (conn=0x%p, buf=0x%p, len=%d, ttl=%u, dack=%u, rttMean=%u)", conn, sBuf->data, sBuf->datalen, ttl, conn->snd.DACKT, conn->rttMean >> 1)); return ER_ARDP_TTL_EXPIRED; } /* If we passed the above "expire" test only due to factoring in DACKT, do not adjust ttl */ if (ttl > expireThreshold) { ttlSend = ttl - expireThreshold; } } for (uint16_t i = 0; i < fcnt; i++) { ArdpHeader* h = (ArdpHeader*) sBuf->hdr; uint16_t segLen = (i == (fcnt - 1)) ? lastLen : conn->snd.maxDlen; status = ER_OK; QCC_DbgPrintf(("SendData: Segment %d, snd.NXT=%u, snd.UNA=%u", i, conn->snd.NXT, conn->snd.UNA)); assert((conn->snd.NXT - conn->snd.UNA) < conn->snd.SEGMAX); h->som = som; h->fcnt = htons(fcnt); h->src = htons(conn->local); h->dst = htons(conn->foreign);; h->dlen = htons(segLen); h->seq = htonl(conn->snd.NXT); sBuf->ttl = ttl; sBuf->tStart = now; sBuf->data = segData; sBuf->datalen = segLen; if (h->dst == 0) { QCC_DbgPrintf(("SendData(): destination = 0")); } if (!handle->trafficJam #if ARDP_TC_SUPPORT && (conn->snd.thinWindow > 0)) { #else ) { #endif status = SendMsgData(handle, conn, sBuf, ttlSend); if (conn->rttInit) { timeout = GetRTO(handle, conn); } else { timeout = handle->config.initialDataTimeout; } } /* * If we are unable to write to socket right away, buffer the outbound segments * in retransmit queue. */ if (handle->trafficJam #if ARDP_TC_SUPPORT || (conn->modeSimple && (conn->snd.thinWindow == 0)) #endif ) { timeout = 0; status = ER_OK; } /* * We update our accounting only if the message has been sent successfully * or has been put on the retransmit queue. */ if (status == ER_OK) { sBuf->inUse = true; UpdateTimer(handle, conn, &sBuf->timer, timeout, 1); /* Since we scheduled a retransmit timer, cancel active persist timer */ QCC_DbgHLPrintf(("Cancel persist timer: handle=%p, conn=%p, id=%u (%d)", handle, conn, conn->id, conn->id)); conn->persistTimer.retry = 0; EnList(handle->dataTimers.bwd, (ListNode*) &sBuf->timer); conn->snd.pending++; assert(((conn->snd.pending) <= conn->snd.SEGMAX) && "Number of pending segments in send queue exceeds MAX!"); conn->snd.NXT++; #if ARDP_TC_SUPPORT if (conn->modeSimple && (conn->snd.thinWindow != 0)) { QCC_DbgPrintf(("SendData(): thinWindow %u, thinNXT %u", conn->snd.thinWindow, conn->snd.thinNXT)); conn->snd.thinWindow--; conn->snd.thinNXT++; QCC_DbgPrintf(("SendData(): Update thinWindow %u, thinNXT %u", conn->snd.thinWindow, conn->snd.thinNXT)); } #endif } else { /* Something irrevocably bad happened on the socket. Disconnect. */ Disconnect(handle, conn, status); break; } segData += segLen; sBuf = sBuf->next; } return status; } static QStatus DoSendSyn(ArdpHandle* handle, ArdpConnRecord* conn, uint8_t* buf, uint16_t len) { QCC_UNUSED(buf); ArdpSynHeader hSyn; qcc::ScatterGatherList msgSG; uint32_t buf32[(ARDP_SYN_HEADER_SIZE + 3) >> 2]; size_t sent; QCC_DbgTrace(("DoSendSyn(handle=%p, conn=%p, buf=%p, len = %d)", handle, conn, buf, len)); hSyn.flags = ARDP_FLAG_SYN | ARDP_FLAG_VER; if (conn->passive) { hSyn.flags |= ARDP_FLAG_ACK; } hSyn.hlen = ARDP_SYN_HEADER_SIZE >> 1; hSyn.src = htons(conn->local); hSyn.dst = htons(conn->foreign); hSyn.dlen = htons(len); hSyn.seq = htonl(conn->snd.ISS); hSyn.ack = htonl(conn->rcv.CUR); hSyn.segmax = htons(conn->rcv.SEGMAX); hSyn.segbmax = htons(conn->rcv.SEGBMAX); hSyn.dackt = htonl(handle->config.delayedAckTimeout); hSyn.options = htons(ARDP_FLAG_SDM); if (hSyn.dst == 0) { QCC_DbgPrintf(("DoSendSyn(): destination = 0")); } /* Marshal the header structure into a byte buffer */ MarshalSynHeader(buf32, &hSyn); QCC_DbgPrintf(("DoSendSyn(): hSyn.seq=%u data=%p (%s), len=%u", ntohl(hSyn.seq), conn->synData.buf, conn->synData.buf, conn->synData.len)); msgSG.AddBuffer(&buf32[0], ARDP_SYN_HEADER_SIZE); msgSG.AddBuffer(conn->synData.buf, conn->synData.len); #if ARDP_TESTHOOKS /* * Call the outbound testhook in case the test team needs to munge the * outbound data. */ if (handle->th.SendToSG) { handle->th.SendToSG(handle, conn, DO_SEND_SYN, msgSG); } #endif #if ARDP_STATS ++handle->stats.synSends; #endif return qcc::SendToSG(conn->sock, conn->ipAddr, conn->ipPort, msgSG, sent); } static QStatus SendSyn(ArdpHandle* handle, ArdpConnRecord* conn, uint8_t* buf, uint16_t len) { QStatus status; QCC_DbgTrace(("SendSyn(handle=%p, conn=%p, buf=%p, len=%d)", handle, conn, buf, len)); conn->synData.buf = (uint8_t*) malloc(len); if (conn->synData.buf == NULL) { return ER_OUT_OF_MEMORY; } conn->synData.len = len; memcpy(conn->synData.buf, buf, len); status = DoSendSyn(handle, conn, buf, len); if (status == ER_OK) { InitTimer(handle, conn, &conn->connectTimer, ConnectTimerHandler, NULL, handle->config.connectTimeout, handle->config.connectRetries + 1); QCC_DbgPrintf(("SendSyn(): timer=%p, retries=%u", conn->connectTimer, conn->connectTimer.retry)); } return status; } static QStatus SendRst(ArdpHandle* handle, qcc::SocketFd sock, qcc::IPAddress ipAddr, uint16_t ipPort, uint16_t local, uint16_t foreign) { QCC_DbgTrace(("SendRst(handle=%p, sock=%d., ipAddr=\"%s\", ipPort=%d., local=%d., foreign=%d.)", handle, sock, ipAddr.ToString().c_str(), ipPort, local, foreign)); ArdpHeader h; uint32_t buf32[ARDP_FIXED_HEADER_LEN >> 2]; memset(&h, 0, sizeof(ArdpHeader)); h.flags = ARDP_FLAG_RST | ARDP_FLAG_VER; h.hlen = ARDP_FIXED_HEADER_LEN >> 1; h.src = htons(local); h.dst = htons(foreign); MarshalHeader(buf32, &h); QCC_DbgPrintf(("SendRst(): SendTo(sock=%d., ipAddr=\"%s\", port=%d., buf=%p, len=%d", sock, ipAddr.ToString().c_str(), ipPort, &h, ARDP_FIXED_HEADER_LEN)); #if ARDP_TESTHOOKS /* * Call the outbound testhook in case the test team needs to munge the * outbound data. */ if (handle->th.SendTo) { handle->th.SendTo(handle, NULL, SEND_RST, &h, ARDP_FIXED_HEADER_LEN); } #endif #if ARDP_STATS ++handle->stats.rstSends; #endif size_t sent; return qcc::SendTo(sock, ipAddr, ipPort, &h, ARDP_FIXED_HEADER_LEN, sent); } static QStatus UpdateSndSegments(ArdpHandle* handle, ArdpConnRecord* conn, uint32_t ack, uint32_t lcs) { QCC_DbgTrace(("UpdateSndSegments(): handle=%p, conn=%p, ack=%u, lcs=%u", handle, conn, ack, lcs)); uint16_t index = ack % conn->snd.SEGMAX; ArdpSndBuf* sBuf = &conn->snd.buf[index]; bool needUpdate = false; /* Nothing to clean up */ if (conn->snd.pending == 0) { conn->snd.LCS = lcs; return ER_OK; } /* * Count only "good" roundrips to ajust RTT values. * Note, that we decrement retries with each retransmit. */ if ((sBuf->retransmits == 0) && (sBuf->timer.retry != 0)) { AdjustRTT(handle, conn, sBuf); } /* Cycle through the buffers from snd.LCS + 1 to ACK */ index = (conn->snd.LCS + 1) % conn->snd.SEGMAX; sBuf = &conn->snd.buf[index]; for (uint32_t i = 0; i < (ack - conn->snd.LCS); i++) { ArdpHeader* h = (ArdpHeader*) sBuf->hdr; uint32_t seq = ntohl(h->seq); uint16_t fcnt = ntohs(h->fcnt); if (!(sBuf->inUse) || (SEQ32_LT(ack, seq))) { QCC_LogError(ER_ARDP_INVALID_RESPONSE, ("Bad update: %s SND %u ACK %u", (sBuf->inUse) ? "full" : "empty", seq, ack)); return ER_ARDP_INVALID_RESPONSE; } if (sBuf->inUse) { /* If fragmented, wait for the last segment. Issue sendCB on the first fragment in message.*/ QCC_DbgPrintf(("UpdateSndSegments(): fragment=%u, som=%u, fcnt=%d", ntohl(h->seq), ntohl(h->som), fcnt)); DeList((ListNode*) &sBuf->timer); sBuf->timer.retry = 0; /* * If the message has been consumed by the receiver, * check if this is the last fragment in the message and issue SendCb() */ if (SEQ32_LET(seq, lcs) && seq == (ntohl(h->som) + (fcnt - 1))) { QCC_DbgPrintf(("UpdateSndSegments(): last fragment=%u, som=%u, fcnt=%d", seq, ntohl(h->som), fcnt)); /* First segment in message, keeps the original pointer to message buffer */ index = ntohl(h->som) % conn->snd.SEGMAX; FlushMessage(handle, conn, &conn->snd.buf[index], (sBuf->ttl != ARDP_TTL_EXPIRED) ? ER_OK : ER_ARDP_TTL_EXPIRED); } } sBuf = sBuf->next; } /* Update snd.UNA counter if the TTL of segments following last ACKed segment have expired */ while (sBuf->inUse && (sBuf->ttl == ARDP_TTL_EXPIRED)) { ArdpHeader* h = (ArdpHeader*) sBuf->hdr; uint32_t seq = ntohl(h->seq); conn->snd.UNA = seq + 1; sBuf = sBuf->next; needUpdate = true; } /* Schedule "unsolicited" ACK */ if (needUpdate && (conn->ackTimer.retry == 0)) { UpdateTimer(handle, conn, &conn->ackTimer, ARDP_MIN_DELAYED_ACK_TIMEOUT, 1); } /* Update the counter on our SND side */ conn->snd.LCS = lcs; return ER_OK; } static void FastRetransmit(ArdpHandle* handle, ArdpConnRecord* conn, ArdpSndBuf* sBuf) { QCC_UNUSED(conn); /* * Fast retransmit to fill the gap. Schedule only for those segments that haven't been * tried for retransmission yet. */ if ((sBuf->fastRT == handle->config.fastRetransmitAckCounter) && (sBuf->retransmits == 0)) { QCC_DbgPrintf(("FastRetransmit(): priority re-send %u", ntohl(((ArdpHeader*)sBuf->hdr)->seq))); sBuf->timer.when = TimeNow(handle->tbase); } sBuf->fastRT++; } static void CancelEackedSegments(ArdpHandle* handle, ArdpConnRecord* conn, uint32_t ack, uint32_t* bitMask) { QCC_DbgHLPrintf(("CancelEackedSegments(): handle=%p, conn=%p, bitMask=%p, ack=%u (snd.Una %u)", handle, conn, bitMask, ack, conn->snd.UNA)); uint32_t start = ack + 1; uint32_t index = start % conn->snd.SEGMAX; ArdpSndBuf* sBuf = &conn->snd.buf[index]; uint32_t bitCheck = (uint32_t)(1 << 31); #ifndef NDEBUG DumpBitMask(conn, bitMask, conn->remoteMskSz, true); #endif FastRetransmit(handle, conn, sBuf); /* * Bitmask starts at ACK + 1. Cycle through the mask and cancel retransmit timers * on EACKed segments. */ start = start + 1; /* Iterate over 32-bit bins */ for (uint32_t i = 0; i < conn->remoteMskSz; i++) { uint32_t mask32 = ntohl(bitMask[i]); index = (start + (i * 32)) % conn->snd.SEGMAX; sBuf = &conn->snd.buf[index]; while (mask32 != 0) { if (mask32 & bitCheck) { QCC_DbgPrintf(("CancelEackedSegments(): set retries to zero for timer %p (seq %u)", sBuf->timer, ntohl(((ArdpHeader*)(sBuf->hdr))->seq))); if (sBuf->timer.retry != 0) { DeList((ListNode*) &sBuf->timer); sBuf->timer.retry = 0; } } else if (i < 1) { /* * Schedule fast retransmits for gaps in the first 32-segment window. * Catch the others next time the EACK window moves. */ FastRetransmit(handle, conn, sBuf); } mask32 = mask32 << 1; sBuf = sBuf->next; } } } static void ShiftRcvMsk(ArdpConnRecord* conn) { QCC_DbgPrintf(("ShiftRcvMsk")); if (conn->rcv.eack.sz == 0) { /* No EACKS */ return; } /* First bit represents rcv.CUR + 2 */ uint32_t saveBits = 0; uint16_t newSz = 0; uint32_t i = 1; /* Shift the bitmask */ conn->rcv.eack.mask[0] = conn->rcv.eack.mask[0] << 1; if (conn->rcv.eack.mask[0] > 0) { newSz = 1; } for (; i < conn->rcv.eack.sz; i++) { if (conn->rcv.eack.mask[i] == 0) { continue; } saveBits = conn->rcv.eack.mask[i] >> 31; conn->rcv.eack.mask[i] = conn->rcv.eack.mask[i] << 1; conn->rcv.eack.mask[i - 1] = conn->rcv.eack.mask[i - 1] | saveBits; if (conn->rcv.eack.mask[i] > 0) { newSz = i + 1; } else if (saveBits != 0) { newSz = i; } conn->rcv.eack.htnMask[i - 1] = htonl(conn->rcv.eack.mask[i - 1]); } conn->rcv.eack.htnMask[i - 1] = htonl(conn->rcv.eack.mask[i - 1]); conn->rcv.eack.sz = newSz; #ifndef NDEBUG DumpBitMask(conn, conn->rcv.eack.mask, conn->rcv.eack.fixedSz >> 2, false); #endif } static void AddRcvMsk(ArdpConnRecord* conn, uint32_t delta) { QCC_DbgPrintf(("AddRcvMsk: delta = %d", delta)); /* First bit represents rcv.CUR + 2 */ uint32_t bin32 = (delta - 1) / 32; uint32_t offset = (uint32_t)32 - (delta - (bin32 << 5)); assert(bin32 < (uint32_t) (conn->rcv.eack.fixedSz >> 2)); conn->rcv.eack.mask[bin32] = conn->rcv.eack.mask[bin32] | ((uint32_t)1 << offset); QCC_DbgPrintf(("AddRcvMsk: bin = %d, offset=%d, mask = 0x%f", bin32, offset, conn->rcv.eack.mask[bin32])); if (conn->rcv.eack.sz < bin32 + 1) { conn->rcv.eack.sz = bin32 + 1; } conn->rcv.eack.htnMask[bin32] = htonl(conn->rcv.eack.mask[bin32]); #ifndef NDEBUG DumpBitMask(conn, conn->rcv.eack.mask, conn->rcv.eack.fixedSz >> 2, false); #endif } static void DumpRcvQueue(ArdpConnRecord* conn) { uint32_t i; for (i = 0; i < conn->rcv.SEGMAX; i++) { QCC_LogError(ER_OK, ("%d: %s, %s seq %u, som %u, fcnt %d ttl %x", i, (conn->rcv.buf[i].flags && ARDP_BUFFER_IN_USE) ? "in use" : "not in use", (conn->rcv.buf[i].flags && ARDP_BUFFER_DELIVERED) ? "delivered" : "not delivered", conn->rcv.buf[i].seq, conn->rcv.buf[i].som, conn->rcv.buf[i].fcnt, conn->rcv.buf[i].ttl)); } } static QStatus ReleaseRcvBuffers(ArdpHandle* handle, ArdpConnRecord* conn, uint32_t seq, uint16_t fcnt, QStatus reason) { uint16_t index = seq % conn->rcv.SEGMAX; ArdpRcvBuf* consumed = &conn->rcv.buf[index]; uint32_t count = fcnt; QCC_DbgTrace(("ReleaseRcvBuffers(handle=%p, conn=%p, seq=%u, fcnt=%u, reason=%s)", handle, conn, seq, fcnt, QCC_StatusText(reason))); if (fcnt == 0) { QCC_DbgHLPrintf(("Invalid fragment count %u", fcnt)); assert((fcnt > 0) && "fcnt cannot be zero"); return ER_FAIL; } if (seq != (conn->rcv.LCS + 1)) { if (reason == ER_ARDP_TTL_EXPIRED) { QCC_DbgPrintf(("Expired segment %u is not first in rcv queue (%u)", seq, conn->rcv.LCS + 1)); return ER_OK; } else { QCC_LogError(ER_OK, ("conn %p, Consumed message %u is not first in rcv queue (%u)", conn, seq, conn->rcv.LCS + 1)); DumpRcvQueue(conn); assert(0 && "Consumed message is not first in rcv queue"); return ER_FAIL; } } /* Perform additional validation if the buffer was handed to us by the transport layer */ if (reason != ER_ARDP_TTL_EXPIRED) { if (conn->rcv.buf[index].seq != seq) { QCC_DbgHLPrintf(("ReleaseRcvBuffers: released buffer seq=%u does not match rcv %u", seq, conn->rcv.buf[index].seq)); assert(0 && "ReleaseRcvBuffers: Buffer sequence validation failed"); return ER_FAIL; } } /* * Release all the buffers associated with consumed message. * Also, release the subsequent buffers with expired TTL. */ do { consumed->flags = 0; consumed->ttl = ARDP_TTL_INFINITE; if (consumed->data != NULL) { free(consumed->data); consumed->data = NULL; } conn->rcv.LCS++; if (count != 0) { count--; } QCC_DbgPrintf(("ReleaseRcvBuffers: released buffer %p (seq=%u)", consumed, conn->rcv.LCS)); consumed = consumed->next; QCC_DbgPrintf(("ReleaseRcvBuffers: next buffer %p, ttl = 0x%x, is %s", consumed, consumed->ttl, (consumed->flags & ARDP_BUFFER_DELIVERED) ? "delivered" : "not delivered")); } while (count != 0 || (consumed->ttl == ARDP_TTL_EXPIRED && !(consumed->flags & ARDP_BUFFER_DELIVERED))); /* * If we advanced the receive queue based on expired messages in RCV window, * it's possible that RCV.CUR < RCV.LCS. * This can happen when a message has been only partially received * and it's TTL has expired before we had a chance to assemble a complete message. * We need to update left edge of ACK window to match LCS. */ if (SEQ32_LT(conn->rcv.CUR, conn->rcv.LCS)) { conn->rcv.CUR = conn->rcv.LCS; QCC_DbgPrintf(("ReleaseRcvBuffers: new conn->rcv.CUR=%u", conn->rcv.CUR)); } /* Schedule "unsolicited" ACK if the ACK timer is not running. */ if (conn->ackTimer.retry == 0) { QCC_DbgHLPrintf(("ReleaseRcvBuffers: Schedule ACK timer to inform about new values of rcv.CUR %u and rcv.LCS %u", conn->rcv.CUR, conn->rcv.LCS)); UpdateTimer(handle, conn, &conn->ackTimer, handle->config.delayedAckTimeout, 1); } return ER_OK; } static void AdvanceRcvQueue(ArdpHandle* handle, ArdpConnRecord* conn, ArdpRcvBuf* current) { uint32_t seq = current->seq; bool isExpiring = false; ArdpRcvBuf* startFrag; ArdpRcvBuf* fragment; uint32_t startSeq = 0; uint16_t fcnt = 0; uint16_t count; do { uint32_t tNow = TimeNow(handle->tbase); QCC_DbgPrintf(("AdvanceRcvQueue: segment %u (%p)", seq, current)); assert((seq - conn->rcv.LCS) <= conn->rcv.SEGMAX); ShiftRcvMsk(conn); if (isExpiring) { /* Check if last fragment. If this is the case, release the associated buffers */ if (seq == (startSeq + fcnt - 1)) { ReleaseRcvBuffers(handle, conn, startSeq, fcnt, ER_ARDP_TTL_EXPIRED); isExpiring = false; } } else if (current->ttl != ARDP_TTL_INFINITE && (tNow - current->tRecv >= current->ttl)) { QCC_DbgPrintf(("AdvanceRcvQueue(): Detected expired fragment %u (start %u, fcnt %u)", current->seq, current->som, current->fcnt)); #if ARDP_STATS ++handle->stats.inboundDrops; #endif startFrag = &conn->rcv.buf[current->som % conn->rcv.SEGMAX]; startSeq = current->som; fcnt = current->fcnt; fragment = startFrag; count = 0; /* Mark all the fragments in the message as expired. */ do { fragment->ttl = ARDP_TTL_EXPIRED; fragment = fragment->next; count++; } while (count < fcnt); /* * If this is the complete message, flush the message and release the associated buffers. * Else, iterate till we get to the last fragment. */ if (seq == (current->som + current->fcnt - 1)) { ReleaseRcvBuffers(handle, conn, current->som, current->fcnt, ER_ARDP_TTL_EXPIRED); isExpiring = false; } else { isExpiring = true; } } else { isExpiring = false; /* Check if last fragment. If this is the case, re-assemble the message */ if (current->seq == current->som + (current->fcnt - 1)) { startFrag = &conn->rcv.buf[current->som % conn->rcv.SEGMAX]; fragment = startFrag; QCC_DbgPrintf(("AdvanceRcvQueue(): RecvCb(conn=0x%p, buf=%p, seq=%u, fcnt (@ %p)=%d)", conn, startFrag, startFrag->seq, &(startFrag->fcnt), startFrag->fcnt)); #if ARDP_STATS ++handle->stats.recvCbs; #endif handle->cb.RecvCb(handle, conn, startFrag, ER_OK); /* Mark all the fragments as delivered, and while we're at it note */ for (uint32_t i = 0; i < current->fcnt; i++) { fragment->flags |= ARDP_BUFFER_DELIVERED; fragment = fragment->next; } } } current = current->next; seq++; } while (((current->flags & ARDP_BUFFER_IN_USE) && !(current->flags & ARDP_BUFFER_DELIVERED)) || isExpiring); if (SEQ32_LT(conn->rcv.CUR, seq - 1)) { conn->rcv.CUR = seq - 1; } if (conn->ackTimer.retry == 0) { QCC_DbgHLPrintf(("AdvanceReleaseQueue: Schedule ACK timer to inform about new values of rcv.CUR %u and rcv.LCS %u", conn->rcv.CUR, conn->rcv.LCS)); UpdateTimer(handle, conn, &conn->ackTimer, handle->config.delayedAckTimeout, 1); } QCC_DbgHLPrintf(("AdvanceRcvQueue: rcv.CUR = %u, rcv.LCS = %u", conn->rcv.CUR, conn->rcv.LCS)); } static void FlushExpiredRcvMessages(ArdpHandle* handle, ArdpConnRecord* conn, uint32_t acknxt) { uint16_t index = (conn->rcv.CUR) % conn->rcv.SEGMAX; ArdpRcvBuf* current = &conn->rcv.buf[index]; uint32_t startSeq; uint32_t seq; uint32_t delta; ArdpRcvBuf* start; QCC_DbgTrace(("FlushExpiredRcvMessages(handle=%p, conn=%p, acknxt=%u", handle, conn, acknxt)); QCC_DbgPrintf(("FlushExpiredRcvMessages(acknxt=%u, lcs=%u, cur=%u", acknxt, conn->rcv.LCS, conn->rcv.CUR)); /* Move to the start of the message */ if (!(current->flags & ARDP_BUFFER_IN_USE) || (current->seq == (current->som + current->fcnt - 1))) { /* All the fragments of the last message were received or the buffer is empty (expired) */ start = current->next; startSeq = conn->rcv.CUR + 1; delta = 0; /* If this is the tail of RCV queue, just update the counter */ if ((conn->rcv.eack.sz == 0) && (conn->rcv.LCS == conn->rcv.CUR)) { conn->rcv.LCS = acknxt - 1; conn->rcv.CUR = acknxt - 1; if (conn->ackTimer.retry == 0) { QCC_DbgHLPrintf(("FlushExpiredRcvMessages: Schedule ACK timer to inform about new values of rcv.CUR %u and rcv.LCS %u", conn->rcv.CUR, conn->rcv.LCS)); UpdateTimer(handle, conn, &conn->ackTimer, handle->config.delayedAckTimeout, 1); } return; } } else { /* Message was partially received. Move to the beginning of incomplete message */ start = &conn->rcv.buf[current->som % conn->rcv.SEGMAX]; delta = (conn->rcv.CUR + 1) - current->som; startSeq = current->som; } current = start; seq = startSeq; /* Mark all the segments with sequence numbers up to ACKNXT as expired */ do { assert(!(current->flags & ARDP_BUFFER_DELIVERED)); QCC_DbgPrintf(("FlushExpiredRcvMessages: seq = %u", seq)); current->ttl = ARDP_TTL_EXPIRED; /* Update EACK mask */ if (delta == 0) { ShiftRcvMsk(conn); } else { delta--; } seq++; current = current->next; } while (SEQ32_LT(seq, acknxt)); /* * Update counter for the current ACK counter to ACKNXT - 1. */ if (SEQ32_LT(conn->rcv.CUR, acknxt - 1)) { conn->rcv.CUR = acknxt - 1; } /* Release the buffers associated with the expired message(s) */ ReleaseRcvBuffers(handle, conn, startSeq, seq - startSeq, ER_ARDP_TTL_EXPIRED); /* If there are pending complete messages, deliver them to transport layer */ if ((current->flags & ARDP_BUFFER_IN_USE) && !(current->flags & ARDP_BUFFER_DELIVERED)) { QCC_DbgPrintf(("FlushExpiredRcvMessages: advance seq %u", current->seq)); AdvanceRcvQueue(handle, conn, current); } if (conn->ackTimer.retry == 0) { QCC_DbgHLPrintf(("FlushExpiredRcvMessages: Schedule ACK timer to inform about new values of rcv.CUR %u and rcv.LCS %u", conn->rcv.CUR, conn->rcv.LCS)); UpdateTimer(handle, conn, &conn->ackTimer, handle->config.delayedAckTimeout, 1); } QCC_DbgPrintf(("FlushExpiredRcvMessages(UPDATE rcv.CUR = %u, rcv.LCS = %u, acknxt = %u", conn->rcv.CUR, conn->rcv.LCS, acknxt)); } static QStatus AddRcvBuffer(ArdpHandle* handle, ArdpConnRecord* conn, ArdpSeg* seg, uint8_t* buf, uint16_t len, bool ordered) { QCC_UNUSED(len); uint16_t index = seg->SEQ % conn->rcv.SEGMAX; ArdpRcvBuf* current = &conn->rcv.buf[index]; QCC_DbgTrace(("AddRcvBuffer(handle=%p, conn=%p, seg=%p, buf=%p, len=%d, ordered=%s", handle, conn, seg, buf, len, (ordered ? "true" : "false"))); QCC_DbgPrintf(("AddRcvBuffer: seg->SEQ = %u, first=%u", seg->SEQ, conn->rcv.LCS + 1)); assert(buf != NULL && len != 0); if (current->seq == seg->SEQ) { QCC_DbgPrintf(("AddRcvBuffer: duplicate segment %u, acknowledge", seg->SEQ)); return ER_OK; } if (current->flags & ARDP_BUFFER_IN_USE) { QCC_DbgHLPrintf(("AddRcvBuffer: attempt to overwrite buffer that has not been released( in use %u seg->seq %u)", current->seq, seg->SEQ)); assert(!(current->flags & ARDP_BUFFER_IN_USE) && "AddRcvBuffer: attempt to overwrite buffer that has not been released"); return ER_FAIL; } /* Allocate holding buffer, pad up to 1K */ current->data = (uint8_t*) malloc((((seg->DLEN + 1023) >> 10) << 10) * sizeof(uint8_t)); if (current->data == NULL) { QCC_LogError(ER_OUT_OF_MEMORY, ("Failed to allocate rcv data buffer")); return ER_OUT_OF_MEMORY; } current->seq = seg->SEQ; current->datalen = seg->DLEN; current->flags = ARDP_BUFFER_IN_USE; memcpy(current->data, buf + (seg->HLEN * 2), seg->DLEN); current->fcnt = seg->FCNT; current->som = seg->SOM; /* * Get the remaining time to live for this message and mark when we received * it. */ current->ttl = seg->TTL; current->tRecv = TimeNow(handle->tbase); /* Deliver this segment (and following out-of-order segments) to the upper layer. */ if (ordered) { AdvanceRcvQueue(handle, conn, current); } else { AddRcvMsk(conn, (seg->SEQ - (conn->rcv.CUR + 1))); } return ER_OK; } static bool CheckConfigValid(uint16_t segmax, uint16_t segbmax, uint16_t window, bool isSimpleMode = false) { uint32_t ackMaskSize = isSimpleMode ? 0 : (window + 31) >> 5; uint8_t hlen = ARDP_FIXED_HEADER_LEN + ackMaskSize * sizeof(uint32_t); uint32_t maxPayload = segbmax - (UDP_HEADER_SIZE + hlen); if (segmax > ARDP_MAX_WINDOW_SIZE) { QCC_LogError(ER_INVALID_CONFIG, ("SEGMAX %u exceeds ARDP maximum window size %u", segmax, ARDP_MAX_WINDOW_SIZE)); return false; } if (segbmax <= (UDP_HEADER_SIZE + hlen)) { QCC_LogError(ER_FAIL, ("SEGBMAX too small %u (need at least %u)", segbmax, (UDP_HEADER_SIZE + hlen))); return false; } if ((maxPayload * segmax) < (uint32_t) (ALLJOYN_MAX_PACKET_LEN)) { QCC_LogError(ER_INVALID_CONFIG, ("SEGMAX %u and SEGBMAX %u cannot fit max Alljoyn message %u", segmax, segbmax, ALLJOYN_MAX_PACKET_LEN)); return false; } return true; } static QStatus InitSnd(ArdpHandle* handle, ArdpConnRecord* conn) { uint8_t* buffer; uint32_t ackMaskSize = (conn->rcv.SEGMAX + 31) >> 5; uint8_t hlen = ARDP_FIXED_HEADER_LEN + ackMaskSize * sizeof(uint32_t); conn->rcv.eack.fixedSz = ackMaskSize * sizeof(uint32_t); conn->snd.maxDlen = conn->snd.SEGBMAX - (UDP_HEADER_SIZE + hlen); QCC_DbgPrintf(("InitSnd(): actual max payload len %d", conn->snd.maxDlen)); #if ARDP_TC_SUPPORT /* If this is a simple mode connection, adjust SEGMAX locally to accomodate the largest possible AllJoyn message */ if (conn->modeSimple) { conn->snd.SEGMAX = (ALLJOYN_MAX_PACKET_LEN + conn->snd.maxDlen - 1) / conn->snd.maxDlen; } if (!CheckConfigValid(conn->snd.SEGMAX, conn->snd.SEGBMAX, conn->rcv.SEGMAX, conn->modeSimple)) { return ER_FAIL; } #else if (!CheckConfigValid(conn->snd.SEGMAX, conn->snd.SEGBMAX, conn->rcv.SEGMAX)) { return ER_FAIL; } #endif conn->window = conn->snd.SEGMAX; conn->snd.buf = (ArdpSndBuf*) malloc(conn->snd.SEGMAX * sizeof(ArdpSndBuf)); if (conn->snd.buf == NULL) { QCC_DbgPrintf(("InitSnd(): Failed to allocate send buffer info")); return ER_OUT_OF_MEMORY; } memset(conn->snd.buf, 0, conn->snd.SEGMAX * sizeof(ArdpSndBuf)); /* Allocate contiguous space for sent data segment headers */ buffer = (uint8_t*) malloc(conn->snd.SEGMAX * ARDP_FIXED_HEADER_LEN); if (buffer == NULL) { QCC_DbgPrintf(("InitSnd(): Failed to allocate send buffer headers")); free(conn->snd.buf); return ER_OUT_OF_MEMORY; } memset(buffer, 0, conn->snd.SEGMAX * ARDP_FIXED_HEADER_LEN); /* Array of pointers to headers of unAcked sent data buffers */ for (uint32_t i = 0; i < conn->snd.SEGMAX; i++) { InitTimer(handle, conn, &conn->snd.buf[i].timer, RetransmitTimerHandler, &conn->snd.buf[i], handle->config.initialDataTimeout, 0); conn->snd.buf[i].next = &conn->snd.buf[(i + 1) % conn->snd.SEGMAX]; conn->snd.buf[i].hdr = buffer; buffer += ARDP_FIXED_HEADER_LEN; } return ER_OK; } static void ArdpMachine(ArdpHandle* handle, ArdpConnRecord* conn, ArdpSeg* seg, uint8_t* buf, uint16_t len) { QStatus status; QCC_DbgTrace(("ArdpMachine(handle=%p, conn=%p, seg=%p, buf=%p, len=%d)", handle, conn, seg, buf, len)); switch (conn->state) { case CLOSED: { QCC_DbgPrintf(("ArdpMachine(): conn->state = CLOSED")); if (seg->FLG & ARDP_FLAG_RST) { #if ARDP_STATS ++handle->stats.rstRecvs; #endif QCC_DbgPrintf(("ArdpMachine(): CLOSED: RST on a closed connection")); break; } if (seg->FLG & ARDP_FLAG_ACK || seg->FLG & ARDP_FLAG_NUL) { QCC_DbgPrintf(("ArdpMachine(): CLOSED: Probe or ACK on a closed connection")); #if ARDP_STATS if (seg->FLG & ARDP_FLAG_NUL) { ++handle->stats.nulRecvs; } #endif /* * ACK + 1> */ #if ARDP_STATS ++handle->stats.rstSends; #endif Send(handle, conn, ARDP_FLAG_RST | ARDP_FLAG_VER, seg->ACK + 1, 0); break; } QCC_DbgPrintf(("ArdpMachine(): CLOSED: Unexpected segment on a closed connection")); /* * */ #if ARDP_STATS ++handle->stats.rstSends; #endif Send(handle, conn, ARDP_FLAG_RST | ARDP_FLAG_ACK | ARDP_FLAG_VER, 0, seg->SEQ); break; } case LISTEN: { QCC_DbgPrintf(("ArdpMachine(): conn->state = LISTEN")); if (seg->FLG & ARDP_FLAG_RST) { #if ARDP_STATS ++handle->stats.rstRecvs; #endif QCC_DbgPrintf(("ArdpMachine(): LISTEN: RST on a LISTENing connection")); break; } if (seg->FLG & ARDP_FLAG_ACK || seg->FLG & ARDP_FLAG_NUL) { QCC_DbgPrintf(("ArdpMachine(): LISTEN: Foreign host ACKing a Listening connection")); #if ARDP_STATS if (seg->FLG & ARDP_FLAG_NUL) { ++handle->stats.nulRecvs; } #endif /* * */ #if ARDP_STATS ++handle->stats.rstSends; #endif Send(handle, conn, ARDP_FLAG_RST | ARDP_FLAG_VER, seg->ACK + 1, 0); Disconnect(handle, conn, ER_ARDP_INVALID_RESPONSE); break; } if (seg->FLG & ARDP_FLAG_SYN) { QCC_DbgPrintf(("ArdpMachine(): LISTEN: SYN received. Accepting")); #if ARDP_STATS ++handle->stats.synRecvs; #endif UnmarshalSynSegment(conn, buf, seg); QCC_DbgPrintf(("ArdpMachine(): LISTEN: SYN received: the other side can receive max %d bytes", conn->snd.SEGBMAX)); if (handle->cb.AcceptCb != NULL) { uint8_t* data = buf + ARDP_SYN_HEADER_SIZE; #if ARDP_STATS ++handle->stats.acceptCbs; #endif if (handle->cb.AcceptCb(handle, conn->ipAddr, conn->ipPort, conn, data, seg->DLEN, ER_OK) == false) { QCC_DbgPrintf(("ArdpMachine(): LISTEN: SYN received. AcceptCb() returned \"false\"")); #if ARDP_STATS ++handle->stats.rstSends; #endif Send(handle, conn, ARDP_FLAG_RST | ARDP_FLAG_VER, seg->ACK + 1, seg->SEQ); SetState(conn, CLOSED); DelConnRecord(handle, conn, false); } } break; } break; } case SYN_SENT: { QCC_DbgPrintf(("ArdpMachine(): conn->state = SYN_SENT")); status = ER_OK; if (seg->FLG & ARDP_FLAG_RST) { QCC_DbgHLPrintf(("ArdpMachine(): SYN_SENT: connection refused. state -> CLOSED")); /* * If detected that ARDP versions do not match (and are within valid range), * an educated guess would be that this was the reason for the remote side sending RST. * In future, when more than one version of ARDP exists, the protocol will * make an attempt to match the version indicated by the remote provided the version * is locally supported. */ if ((seg->FLG & ARDP_VERSION_BITS) != ARDP_FLAG_VER) { QCC_DbgHLPrintf(("ArdpMachine(): SYN_SENT: Detected unsupported protocol version 0x%x", seg->FLG & ARDP_VERSION_BITS)); } #if ARDP_STATS ++handle->stats.rstRecvs; #endif status = ER_ARDP_REMOTE_CONNECTION_RESET; } else if (seg->FLG & ARDP_FLAG_SYN) { QCC_DbgPrintf(("ArdpMachine(): SYN_SENT: SYN received")); #if ARDP_STATS ++handle->stats.synRecvs; #endif UnmarshalSynSegment(conn, buf, seg); status = InitSnd(handle, conn); assert(status == ER_OK && "ArdpMachine():SYN_SENT: Failed to initialize Send queue"); if (seg->FLG & ARDP_FLAG_ACK) { conn->sndFlags = qcc::QCC_MSG_CONFIRM; if ((seg->FLG & ARDP_VERSION_BITS) != ARDP_FLAG_VER) { QCC_DbgHLPrintf(("ArdpMachine(): SYN_SENT: Unsupported protocol version 0x%x", seg->FLG & ARDP_VERSION_BITS)); status = ER_ARDP_VERSION_NOT_SUPPORTED; } else if (seg->ACK != conn->snd.ISS) { QCC_DbgPrintf(("ArdpMachine(): SYN_SENT: ACK does not ASK ISS")); status = ER_ARDP_INVALID_RESPONSE; } else { QCC_DbgPrintf(("ArdpMachine(): SYN_SENT: SYN | ACK received. state -> OPEN")); #if ARDP_STATS ++handle->stats.synackRecvs; #endif conn->snd.UNA = seg->ACK + 1; PostInitRcv(conn); SetState(conn, OPEN); /* Stop connect retry timer */ conn->connectTimer.retry = 0; /* Initialize and kick off link timeout timer */ conn->lastSeen = TimeNow(handle->tbase); InitTimer(handle, conn, &conn->probeTimer, ProbeTimerHandler, &conn->lastSeen, handle->config.linkTimeout / handle->config.keepaliveRetries, handle->config.keepaliveRetries); /* Initialize persist (dead window) timer */ InitTimer(handle, conn, &conn->persistTimer, PersistTimerHandler, NULL, handle->config.persistInterval, 0); /* Initialize delayed ACK timer */ InitTimer(handle, conn, &conn->ackTimer, AckTimerHandler, NULL, handle->config.delayedAckTimeout, 0); #if ARDP_STATS ++handle->stats.synackackSends; #endif /* * */ status = Send(handle, conn, ARDP_FLAG_ACK | ARDP_FLAG_VER, conn->snd.NXT, conn->rcv.CUR); if ((handle->cb.ConnectCb) && (status == ER_OK)) { QCC_DbgPrintf(("ArdpMachine(): SYN_SENT->OPEN: ConnectCb(handle=%p, conn=%p", handle, conn)); assert(!conn->passive); uint8_t* data = &buf[ARDP_SYN_HEADER_SIZE]; #if ARDP_STATS ++handle->stats.connectCbs; #endif handle->cb.ConnectCb(handle, conn, false, data, seg->DLEN, ER_OK); if (conn->synData.buf != NULL) { free(conn->synData.buf); conn->synData.buf = NULL; } } } } else { QCC_DbgPrintf(("ArdpMachine(): SYN_SENT: SYN with no ACK implies simulateous connection attempt: state -> SYN_RCVD")); uint8_t* data = &buf[ARDP_SYN_HEADER_SIZE]; if (handle->cb.AcceptCb != NULL) { status = ER_OK; #if ARDP_STATS ++handle->stats.acceptCbs; #endif handle->cb.AcceptCb(handle, conn->ipAddr, conn->ipPort, conn, data, seg->DLEN, ER_OK); } else { status = ER_ARDP_INVALID_STATE; } } } if (status != ER_OK && status != ER_WOULDBLOCK) { SetState(conn, CLOSED); /* Stop connect retry timer */ conn->connectTimer.retry = 0; handle->cb.ConnectCb(handle, conn, false, NULL, 0, status); /* * Do not delete conection record here: * The upper layer will detect an error status and call ARDP_ReleaseConnection() */ } break; } case SYN_RCVD: { QCC_DbgPrintf(("ArdpMachine(): conn->state = SYN_RCVD")); if (seg->FLG & ARDP_FLAG_RST) { #if ARDP_STATS ++handle->stats.rstRecvs; #endif QCC_DbgPrintf(("ArdpMachine(): SYN_RCVD: Got RST during passive open")); Disconnect(handle, conn, ER_ARDP_REMOTE_CONNECTION_RESET); break; } if (IN_RANGE(uint32_t, conn->rcv.CUR + 1, conn->rcv.SEGMAX, seg->SEQ) == false) { QCC_DbgPrintf(("ArdpMachine(): SYN_RCVD: unacceptable sequence %u", seg->SEQ)); /* */ Send(handle, conn, ARDP_FLAG_ACK | ARDP_FLAG_VER, conn->snd.NXT, conn->rcv.CUR); break; } if (seg->FLG & ARDP_FLAG_SYN) { #if ARDP_STATS ++handle->stats.synRecvs; #endif QCC_DbgPrintf(("ArdpMachine(): SYN_RCVD: Got SYN, state -> CLOSED")); Disconnect(handle, conn, ER_ARDP_INVALID_RESPONSE); break; } if (seg->FLG & ARDP_FLAG_EACK) { QCC_DbgPrintf(("ArdpMachine(): SYN_RCVD: Got EACK. Send RST")); Disconnect(handle, conn, ER_ARDP_INVALID_RESPONSE); break; } if (seg->FLG & ARDP_FLAG_ACK) { conn->sndFlags = qcc::QCC_MSG_CONFIRM; if (seg->ACK == conn->snd.ISS) { QCC_DbgPrintf(("ArdpMachine(): SYN_RCVD: Got ACK with correct acknowledge. state -> OPEN")); #if ARDP_STATS ++handle->stats.synackackRecvs; #endif conn->snd.UNA = seg->ACK + 1; PostInitRcv(conn); SetState(conn, OPEN); /* Stop connect retry timer */ conn->connectTimer.retry = 0; /* Initialize and kick off link timeout timer */ conn->lastSeen = TimeNow(handle->tbase); InitTimer(handle, conn, &conn->probeTimer, ProbeTimerHandler, &conn->lastSeen, handle->config.linkTimeout / handle->config.keepaliveRetries, handle->config.keepaliveRetries); /* Initialize persist (dead window) timer */ InitTimer(handle, conn, &conn->persistTimer, PersistTimerHandler, NULL, handle->config.persistInterval, 0); /* Initialize delayed ACK timer */ InitTimer(handle, conn, &conn->ackTimer, AckTimerHandler, NULL, handle->config.delayedAckTimeout, 0); if (seg->FLG & ARDP_FLAG_NUL) { #if ARDP_STATS ++handle->stats.nulRecvs; ++handle->stats.nulSends; #endif Send(handle, conn, ARDP_FLAG_ACK | ARDP_FLAG_VER, conn->snd.NXT, conn->rcv.CUR); } if (handle->cb.ConnectCb) { QCC_DbgPrintf(("ArdpMachine(): SYN_RCVD->OPEN: ConnectCb(handle=%p, conn=%p", handle, conn)); assert(conn->passive); uint8_t* data = &buf[ARDP_SYN_HEADER_SIZE]; #if ARDP_STATS ++handle->stats.connectCbs; #endif handle->cb.ConnectCb(handle, conn, true, data, seg->DLEN, ER_OK); if (conn->synData.buf != NULL) { free(conn->synData.buf); conn->synData.buf = NULL; } } break; } else { /* */ QCC_DbgPrintf(("ArdpMachine(): SYN_RCVD: Got ACK with incorrect acknowledge %u. RST", seg->ACK)); Disconnect(handle, conn, ER_ARDP_INVALID_RESPONSE); break; } } else { QCC_DbgPrintf(("ArdpMachine(): SYN_RCVD: Got datagram with no ACK")); break; } break; } case OPEN: { QCC_DbgPrintf(("ArdpMachine(): conn->state = OPEN")); uint32_t validWindow = (seg->DLEN != 0) ? conn->rcv.SEGMAX : (conn->rcv.SEGMAX + 1); bool isDuplicate = false; if (seg->FLG & ARDP_FLAG_RST) { #if ARDP_STATS ++handle->stats.rstRecvs; #endif QCC_DbgPrintf(("ArdpMachine(): OPEN: got RST, disconnect")); Disconnect(handle, conn, ER_ARDP_REMOTE_CONNECTION_RESET); break; } if (IN_RANGE(uint32_t, conn->rcv.LCS + 1, validWindow, seg->SEQ) == false) { if (seg->DLEN != 0) { /* Check if data segment is a duplicate. Did the remote side miss our ACK? */ if ((IN_RANGE(uint32_t, conn->rcv.CUR + 1 - conn->rcv.SEGMAX, conn->rcv.SEGMAX, seg->SEQ) == true)) { /* This is a duplicate data segment */ isDuplicate = true; QCC_DbgHLPrintf(("ArdpMachine(): OPEN: duplicate data segment %u, conn->rcv.CUR + 1 = %u, conn->rcv.LCS + 1 = %u", seg->SEQ, conn->rcv.CUR + 1, conn->rcv.LCS + 1)); } } /* Bad bad bad remote! Disconnect. */ if (!isDuplicate) { QCC_LogError(ER_ARDP_INVALID_RESPONSE, ("ArdpMachine(): OPEN: unacceptable sequence %u, conn->rcv.CUR + 1 = %u, conn->rcv.LCS + 1 = %u, MAX = %d", seg->SEQ, conn->rcv.CUR + 1, conn->rcv.LCS + 1, conn->rcv.SEGMAX)); Disconnect(handle, conn, ER_ARDP_INVALID_RESPONSE); break; } } if (seg->FLG & ARDP_FLAG_SYN) { #if ARDP_STATS ++handle->stats.synRecvs; #endif /* Did the remote side miss our ACK of SYN-ACK? */ if (isDuplicate && !conn->passive && ((seg->FLG & ARDP_FLAG_ACK) && (seg->ACK == conn->snd.ISS))) { QCC_DbgPrintf(("ArdpMachine(): OPEN: Got duplicate SYN-ACK, acknowledge")); #if ARDP_TC_SUPPORT Send(handle, conn, ARDP_FLAG_ACK | ARDP_FLAG_VER, (conn->modeSimple) ? conn->snd.thinNXT : conn->snd.NXT, conn->rcv.CUR); #else Send(handle, conn, ARDP_FLAG_ACK | ARDP_FLAG_VER, conn->snd.NXT, conn->rcv.CUR); #endif } else { QCC_DbgPrintf(("ArdpMachine(): OPEN: Got unexpected SYN, disconnect")); Disconnect(handle, conn, ER_ARDP_INVALID_RESPONSE); } break; } if (SEQ32_LT(conn->rcv.CUR + 1, seg->ACKNXT)) { QCC_DbgPrintf(("ArdpMachine(): OPEN: FlushExpiredRcvMessages: seq = %u, expected %u got %u", seg->SEQ, conn->rcv.CUR + 1, seg->ACKNXT)); FlushExpiredRcvMessages(handle, conn, seg->ACKNXT); } if (seg->FLG & ARDP_FLAG_ACK) { QCC_DbgHLPrintf(("ArdpMachine(): OPEN: Got ACK %u LCS %u Window %u", seg->ACK, seg->LCS, seg->WINDOW)); bool needUpdate = false; conn->sndFlags = qcc::QCC_MSG_CONFIRM; if ((IN_RANGE(uint32_t, conn->snd.UNA, ((conn->snd.NXT - conn->snd.UNA) + 1), seg->ACK) == true) || (conn->snd.LCS != seg->LCS)) { conn->snd.UNA = seg->ACK + 1; needUpdate = true; } if (seg->FLG & ARDP_FLAG_EACK) { uint32_t* eackBuf = reinterpret_cast(buf + ARDP_FIXED_HEADER_LEN); /* * Flush the segments using EACK */ QCC_DbgPrintf(("ArdpMachine(): OPEN: EACK is set")); CancelEackedSegments(handle, conn, seg->ACK, eackBuf); } if (needUpdate) { status = UpdateSndSegments(handle, conn, seg->ACK, seg->LCS); if (status != ER_OK) { Disconnect(handle, conn, status); break; } } } /* If we got NUL segment, send ACK without delay */ if (seg->FLG & ARDP_FLAG_NUL) { QCC_DbgPrintf(("ArdpMachine(): OPEN: got NUL, send LCS %u", conn->rcv.LCS)); #if ARDP_STATS ++handle->stats.nulRecvs; #endif #if ARDP_TC_SUPPORT status = Send(handle, conn, ARDP_FLAG_ACK | ARDP_FLAG_VER, (conn->modeSimple) ? conn->snd.thinNXT : conn->snd.NXT, conn->rcv.CUR); #else status = Send(handle, conn, ARDP_FLAG_ACK | ARDP_FLAG_VER, conn->snd.NXT, conn->rcv.CUR); #endif /* If socket was busy, re-schedule ACK timer immediately. */ if (status == ER_WOULDBLOCK) { UpdateTimer(handle, conn, &conn->ackTimer, 0, 1); } } else if (seg->DLEN) { isDuplicate = (SEQ32_LT(seg->SEQ, conn->rcv.CUR + 1)) ? true : isDuplicate; QCC_DbgHLPrintf(("ArdpMachine(): OPEN: Got %d bytes of Data with SEQ %u, rcv.CUR = %u (%s)).", seg->DLEN, seg->SEQ, conn->rcv.CUR, isDuplicate ? "duplicate" : "new")); status = ER_OK; /* * Update RCV buffers if the segment is not a duplicate. */ if (!isDuplicate) { status = AddRcvBuffer(handle, conn, seg, buf, len, seg->SEQ == (conn->rcv.CUR + 1)); if (status != ER_OK) { Disconnect(handle, conn, status); break; } } conn->ackPending++; /* Schedule ACK timer if it's not running already */ if (conn->ackTimer.retry == 0) { UpdateTimer(handle, conn, &conn->ackTimer, handle->config.delayedAckTimeout, 1); QCC_DbgHLPrintf(("ArdpMachine():schedule ackTimer @ %u", conn->ackTimer.when)); } else if (conn->ackPending >= (uint32_t) (conn->rcv.SEGMAX >> 2)) { QCC_DbgHLPrintf(("ArdpMachine():accumulated %d segments, send urgent ACK", conn->ackPending)); AckTimerHandler(handle, conn, NULL); } } /* Schedule persist timer only if there are no pending retransmits */ if (!IsDataRetransmitScheduled(conn) && (seg->WINDOW < conn->snd.SEGMAX) && (conn->persistTimer.retry == 0)) { QCC_DbgHLPrintf(("Schedule persist timer: handle=%p, conn=%p, id=%u (%d)", handle, conn, conn->id, conn->id)); /* Start Persist Timer */ UpdateTimer(handle, conn, &conn->persistTimer, handle->config.persistInterval, handle->config.totalAppTimeout / handle->config.persistInterval + 1); } else if ((conn->persistTimer.retry != 0) && ((seg->WINDOW >= conn->snd.SEGMAX) || IsDataRetransmitScheduled(conn))) { QCC_DbgHLPrintf(("Cancel persist timer: handle=%p, conn=%p, id=%u (%d)", handle, conn, conn->id, conn->id)); /* Cancel Persist Timer */ conn->persistTimer.retry = 0; } if (conn->window != seg->WINDOW) { conn->window = seg->WINDOW; if (handle->cb.SendWindowCb != NULL) { handle->cb.SendWindowCb(handle, conn, conn->window, (conn->window != 0) ? ER_OK : ER_ARDP_BACKPRESSURE); } } break; } case CLOSE_WAIT: { QCC_DbgPrintf(("ArdpMachine(): conn->state = CLOSE_WAIT")); /* * Ignore segment with set RST. * The transition to CLOSED is based on delay TIMWAIT only. */ break; } default: assert(0 && "ArdpMachine(): unexpected conn->state %d"); break; } } QStatus ARDP_StartPassive(ArdpHandle* handle) { QCC_DbgTrace(("ARDP_StartPassive(handle=%p)", handle)); handle->accepting = true; return ER_OK; } QStatus ARDP_Connect(ArdpHandle* handle, qcc::SocketFd sock, qcc::IPAddress ipAddr, uint16_t ipPort, uint16_t segmax, uint16_t segbmax, ArdpConnRecord**pConn, uint8_t* buf, uint16_t len, void* context) { QCC_DbgTrace(("ARDP_Connect(handle=%p, sock=%d, ipAddr=\"%s\", ipPort=%d, segmax=%d, segbmax=%d, pConn=%p, buf=%p, len=%d, context=%p)", handle, sock, ipAddr.ToString().c_str(), ipPort, segmax, segbmax, pConn, buf, len, context)); ArdpConnRecord* conn; QStatus status; *pConn = NULL; if (!CheckConfigValid(segmax, segbmax, ARDP_MAX_WINDOW_SIZE)) { return ER_INVALID_CONFIG; } conn = NewConnRecord(); status = InitConnRecord(handle, conn, sock, ipAddr, ipPort, 0); if (status != ER_OK) { delete conn; return status; } /* Initialize the receiver side of the connection. */ status = InitRcv(conn, segmax, segbmax); if (status == ER_OK) { conn->context = context; conn->passive = false; EnList(handle->conns.bwd, (ListNode*)conn); status = SendSyn(handle, conn, buf, len); } if (status != ER_OK) { DelConnRecord(handle, conn, false); } else { SetState(conn, SYN_SENT); *pConn = conn; } return status; } QStatus ARDP_Accept(ArdpHandle* handle, ArdpConnRecord* conn, uint16_t segmax, uint16_t segbmax, uint8_t* buf, uint16_t len) { QCC_DbgTrace(("ARDP_Accept(handle=%p, conn=%p, segmax=%d, segbmax=%d, buf=%p (%s), len=%d)", handle, conn, segmax, segbmax, buf, buf, len)); QStatus status = ER_OK; if (!IsConnValid(handle, conn)) { return ER_ARDP_INVALID_CONNECTION; } #if ARDP_TC_SUPPORT if (!CheckConfigValid(segmax, segbmax, ARDP_MAX_WINDOW_SIZE, conn->modeSimple)) { #else if (!CheckConfigValid(segmax, segbmax, ARDP_MAX_WINDOW_SIZE)) { #endif status = ER_INVALID_CONFIG; } if (status == ER_OK) { /* Initialize Receive side of the connection */ status = InitRcv(conn, segmax, segbmax); } if (status == ER_OK) { /* Initialize Send side of the connection */ status = InitSnd(handle, conn); } if (status != ER_OK) { #if ARDP_STATS ++handle->stats.rstSends; #endif #if ARDP_TC_SUPPORT Send(handle, conn, ARDP_FLAG_RST | ARDP_FLAG_VER, (conn->modeSimple) ? conn->snd.thinNXT : conn->snd.NXT, 0); #else Send(handle, conn, ARDP_FLAG_RST | ARDP_FLAG_VER, conn->snd.NXT, 0); #endif /* * Important!!! Current assumption is that ARDP_Accept() is being called from within AcceptCb() * in transport layer. If this is ever to change (i.e., ARDP_Accept() is moved outside AcceptCb(), * then connection state should be set to CLOSED and connection record is removed here. */ return status; } SetState(conn, SYN_RCVD); /* */ SendSyn(handle, conn, buf, len); return ER_OK; } QStatus ARDP_Disconnect(ArdpHandle* handle, ArdpConnRecord* conn) { QCC_DbgTrace(("ARDP_Disconnect(handle=%p, conn=%p)", handle, conn)); if (!IsConnValid(handle, conn)) { return ER_ARDP_INVALID_CONNECTION; } return Disconnect(handle, conn, ER_OK); } QStatus ARDP_RecvReady(ArdpHandle* handle, ArdpConnRecord* conn, ArdpRcvBuf* rcv) { QCC_DbgTrace(("ARDP_RecvReady(handle=%p, conn=%p, rcv=%p)", handle, conn, rcv)); assert(rcv != NULL); if (!IsConnValid(handle, conn)) { return ER_ARDP_INVALID_CONNECTION; } if (conn->state == OPEN) { return ReleaseRcvBuffers(handle, conn, rcv->seq, rcv->fcnt, ER_OK); } else if ((conn->state == CLOSED) || (conn->state == CLOSE_WAIT)) { uint32_t i; for (i = 0; i < rcv->fcnt; i++) { if (rcv->data != NULL) { free(rcv->data); } rcv->flags = 0; rcv->data = NULL; if (!(rcv->next->flags & ARDP_BUFFER_IN_USE) || (rcv->next->som != rcv->som)) { break; } rcv = rcv->next; } return ER_OK; } else { return ER_ARDP_INVALID_STATE; } } QStatus ARDP_Send(ArdpHandle* handle, ArdpConnRecord* conn, uint8_t* buf, uint32_t len, uint32_t ttl) { QCC_DbgTrace(("ARDP_Send(handle=%p, conn=%p, buf=%p, len=%d., ttl=%d.)", handle, conn, buf, len, ttl)); if (!IsConnValid(handle, conn)) { return ER_ARDP_INVALID_CONNECTION; } if (conn->state != OPEN) { return ER_ARDP_INVALID_STATE; } if (buf == NULL || len == 0) { return ER_INVALID_DATA; } QCC_DbgPrintf(("NXT=%u, UNA=%u", conn->snd.NXT, conn->snd.UNA)); if ((conn->window == 0) || (conn->snd.NXT - conn->snd.UNA) >= conn->snd.SEGMAX) { QCC_DbgPrintf(("NXT - UNA=%u, window=%u", conn->snd.NXT - conn->snd.UNA, conn->window)); return ER_ARDP_BACKPRESSURE; } else { return SendData(handle, conn, buf, len, ttl); } } static QStatus Receive(ArdpHandle* handle, ArdpConnRecord* conn, uint8_t* rxbuf, uint16_t len) { QCC_DbgTrace(("Receive(handle=%p, conn=%p, rxbuf=%p, len=%d)", handle, conn, rxbuf, len)); ArdpSeg seg; uint8_t hdrSz; seg.FLG = rxbuf[FLAGS_OFFSET]; /* The flags of the current segment */ seg.HLEN = rxbuf[HLEN_OFFSET]; /* The header len */ if (seg.FLG & ARDP_FLAG_RST) { /* This is a disconnect from the remote, no checks are needed */ ArdpMachine(handle, conn, &seg, rxbuf, len); return ER_OK; } seg.DLEN = ntohs(*reinterpret_cast(rxbuf + DLEN_OFFSET)); /* The data payload size */ hdrSz = (seg.FLG & ARDP_FLAG_SYN) ? ARDP_SYN_HEADER_SIZE : ARDP_FIXED_HEADER_LEN; /* Perform length validation checks */ if (((seg.HLEN * 2) < hdrSz) || (len < hdrSz) || (seg.DLEN + (seg.HLEN * 2)) != len) { QCC_LogError(ER_ARDP_INVALID_RESPONSE, ("Receive: length check failed len = %u, seg.hlen = %u, seg.dlen = %u", len, (seg.HLEN * 2), seg.DLEN)); return ER_ARDP_INVALID_RESPONSE; } seg.SEQ = ntohl(*reinterpret_cast(rxbuf + SEQ_OFFSET)); /* The send sequence of the current segment */ seg.ACK = ntohl(*reinterpret_cast(rxbuf + ACK_OFFSET)); /* The cumulative acknowledgement number to our sends */ if (!(seg.FLG & ARDP_FLAG_SYN)) { seg.LCS = ntohl(*reinterpret_cast(rxbuf + LCS_OFFSET)); /* The last consumed segment on receiver side (them) */ seg.WINDOW = conn->snd.SEGMAX - (conn->snd.NXT - (seg.LCS + 1)); /* The receiver's window */ #if ARDP_TC_SUPPORT if (conn->modeSimple) { QCC_DbgPrintf(("Receive(): thinWindow %u, thinNXT %u", conn->snd.thinWindow, conn->snd.thinNXT)); conn->snd.thinWindow = conn->snd.thinSEGMAX - (conn->snd.thinNXT - (seg.LCS + 1)); /* The receiver's window in simple mode */ QCC_DbgPrintf(("Receive(): Update thinWindow %u, thinNXT %u", conn->snd.thinWindow, conn->snd.thinNXT)); } #endif seg.ACKNXT = ntohl(*reinterpret_cast(rxbuf + ACKNXT_OFFSET)); /* The first valid segment sender wants to be acknowledged */ QCC_DbgHLPrintf(("Receive() window = %u, seq = %u, ack = %u, lcs = %u, acknxt = %u", seg.WINDOW, seg.SEQ, seg.ACK, seg.LCS, seg.ACKNXT)); seg.TTL = ntohl(*reinterpret_cast(rxbuf + TTL_OFFSET)); /* TTL associated with this segment */ seg.SOM = ntohl(*reinterpret_cast(rxbuf + SOM_OFFSET)); /* Sequence number of the first fragment in message */ seg.FCNT = ntohs(*reinterpret_cast(rxbuf + FCNT_OFFSET)); /* Number of segments comprising fragmented message */ /* Perform sequence validation checks */ if (SEQ32_LT(conn->snd.NXT, seg.ACK)) { QCC_LogError(ER_ARDP_INVALID_RESPONSE, ("Receive: ack %u ahead of SND>NXT %u", seg.ACK, conn->snd.NXT)); return ER_ARDP_INVALID_RESPONSE; } if (SEQ32_LT(seg.ACK, seg.LCS)) { QCC_LogError(ER_ARDP_INVALID_RESPONSE, ("Receive: lcs %u and ack %u out of order", seg.LCS, seg.ACK)); return ER_ARDP_INVALID_RESPONSE; } /* * SEQ and ACKNXT must fall within receive window. In case of segment with no payload, * allow one extra. */ if (((seg.SEQ - seg.ACKNXT) > conn->rcv.SEGMAX) || (SEQ32_LT(seg.SEQ, seg.ACKNXT)) || ((seg.DLEN != 0) && ((seg.SEQ - seg.ACKNXT) == conn->rcv.SEGMAX))) { QCC_LogError(ER_ARDP_INVALID_RESPONSE, ("Receive: incorrect sequence numbers seg.seq = %u, seg.acknxt = %u", seg.SEQ, seg.ACKNXT)); return ER_ARDP_INVALID_RESPONSE; } /* Additional checks for invalid payload values */ if (seg.DLEN != 0) { if ((seg.FCNT == 0) || (seg.FCNT > conn->rcv.SEGMAX) || ((seg.SEQ - seg.SOM) >= seg.FCNT)) { QCC_LogError(ER_ARDP_INVALID_RESPONSE, ("Receive: incorrect data segment seq = %u, som = %u, fcnt = %u", seg.SEQ, seg.SOM, seg.FCNT)); return ER_ARDP_INVALID_RESPONSE; } } } ArdpMachine(handle, conn, &seg, rxbuf, len); return ER_OK; } QStatus Accept(ArdpHandle* handle, ArdpConnRecord* conn, uint8_t* rxbuf, uint16_t len) { QCC_DbgTrace(("Accept(handle=%p, conn=%p, buf=%p, len=%d)", handle, conn, rxbuf, len)); assert(conn->state == CLOSED && "Accept(): ConnRecord in invalid state"); if (!(rxbuf[FLAGS_OFFSET] & ARDP_FLAG_SYN) || (rxbuf[FLAGS_OFFSET] & ARDP_FLAG_RST)) { return ER_ARDP_INVALID_CONNECTION; } if ((rxbuf[FLAGS_OFFSET] & ARDP_VERSION_BITS) != ARDP_FLAG_VER) { QCC_DbgHLPrintf(("Accept(): Unsupported protocol version 0x%x", rxbuf[FLAGS_OFFSET] & ARDP_VERSION_BITS)); return ER_ARDP_VERSION_NOT_SUPPORTED; } conn->state = LISTEN; /* The call to Accept() implies a jump to LISTEN */ conn->passive = true; /* This connection is (will be) the result of a passive open */ return Receive(handle, conn, rxbuf, len); } static bool IsDuplicateConnRequest(ArdpHandle* handle, uint16_t foreign, qcc::IPAddress address) { for (ListNode* ln = &handle->conns; (ln = ln->fwd) != &handle->conns;) { ArdpConnRecord* conn = (ArdpConnRecord*)ln; if ((conn->foreign == foreign) && (conn->ipAddr == address)) { QCC_DbgPrintf(("isDuplicateConnRequest(): Found conn %p, foreign %u", conn, foreign)); return true; } } return false; } QStatus ARDP_Run(ArdpHandle* handle, qcc::SocketFd sock, bool sockRead, bool sockWrite, uint32_t* ms) { const size_t bufferSize = 65536; /* UDP packet can be up to 64K long */ uint32_t buf32[bufferSize >> 2]; uint8_t* buf = reinterpret_cast(buf32); qcc::IPAddress address; /* The IP address of the foreign side */ uint16_t port; /* Will be the UDP port of the foreign side */ size_t nbytes; /* The number of bytes actually received */ QStatus status = ER_OK; //QCC_DbgTrace(("ARDP_Run(handle=%p, sock=%d., socketRead=%d., socketWrite=%d., ms=%p)", handle, sock, sockRead, sockWrite, ms)); if (sockWrite) { handle->trafficJam = false; } if (sockRead) { while ((status = qcc::RecvFrom(sock, address, port, buf, bufferSize, nbytes)) == ER_OK) { #if ARDP_TESTHOOKS /* * Call the inbound testhook in case the test team needs to munge the * inbound data. */ if (handle->th.RecvFrom) { handle->th.RecvFrom(handle, NULL, ARDP_RUN, buf, nbytes); } #endif if (nbytes > 0 && nbytes < 65536) { uint16_t local, foreign; ProtocolDemux(buf, nbytes, &local, &foreign); if (local == 0) { if (handle->accepting && handle->cb.AcceptCb) { if (!IsDuplicateConnRequest(handle, foreign, address)) { ArdpConnRecord* conn = NewConnRecord(); status = InitConnRecord(handle, conn, sock, address, port, foreign); if (status == ER_OK) { EnList(handle->conns.bwd, (ListNode*)conn); status = Accept(handle, conn, buf, nbytes); } if (status != ER_OK) { SetState(conn, CLOSED); DelConnRecord(handle, conn, false); } } /* * Else the remote most likely timed out waiting for our SYN_ACK. * We should rely on local connection retry mechanism to kick in * and eventually establish the connection. */ } else { status = ER_ARDP_INVALID_STATE; } if (status != ER_OK) { QCC_LogError(status, ("Failed to accept incoming connection request from %s (ARDP port %u)", address.ToString().c_str(), foreign)); SendRst(handle, sock, address, port, local, foreign); } } else { /* Is there an open connection? */ ArdpConnRecord* conn = FindConn(handle, local, foreign); if (!conn) { /* Is there a half open connection? */ conn = FindConn(handle, local, 0); } if (conn) { if ((conn->state != CLOSED) && (conn->state != CLOSE_WAIT)) { QCC_DbgHLPrintf(("ARDP_Run conn state %s", State2Text(conn->state))); conn->lastSeen = TimeNow(handle->tbase); conn->probeTimer.retry = handle->config.keepaliveRetries; status = Receive(handle, conn, buf, nbytes); if (status == ER_ARDP_INVALID_RESPONSE) { Disconnect(handle, conn, status); } } else { uint8_t flags = *reinterpret_cast(buf + FLAGS_OFFSET); /* Only send repeat RST if this is a NUL segment. * This is done to alleviate a situation when original RST has not reached * the remote. This can potentially cause the remote to keep the link * alive (sending pings and retransmit data) until it hits probe timeout */ if (flags & ARDP_FLAG_NUL) { SendRst(handle, sock, address, port, local, foreign); } } } } } else { QCC_DbgHLPrintf(("ARDP_Run(): Socket read failed (nbytes = %d)", nbytes)); break; } } } handle->msnext = CheckTimers(handle); /* Tell the higher levels when to call back next (timer expiration) */ *ms = handle->msnext; QCC_DbgHLPrintf(("ARDP_Run(): Call back in %u ms", *ms)); if (handle->trafficJam) { status = (QStatus) ER_ARDP_WRITE_BLOCKED; //QCC_DbgPrintf(("ARDP_Run(): ER_ARDP_WRITE_BLOCKED")); } return status; } } // namespace ajn alljoyn-15.04b/alljoyn_core/router/ArdpProtocol.h000066400000000000000000000365241255700255500221360ustar00rootroot00000000000000/** * @file ArdpProtocol is an implementation of the Reliable Datagram Protocol * (RDP) adapted to AllJoyn. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_ARDP_PROTOCOL_H #define _ALLJOYN_ARDP_PROTOCOL_H #ifndef ARDP_TESTHOOKS #define ARDP_TESTHOOKS 1 /**< Enabling test hooks defaults to off */ #endif #ifndef ARDP_STATS #define ARDP_STATS 1 /**< Enabling statistics gathering defaults to off */ #endif #ifndef ARDP_TC_SUPPORT #define ARDP_TC_SUPPORT 0 /**< Enabling support for simple mode connection to Thin Client defaults to off */ #endif #include #include #include #include #if ARDP_TESTHOOKS #include "ScatterGatherList.h" #endif namespace ajn { const uint32_t ARDP_NO_TIMEOUT = 0xffffffff; /**< To indicate that no timed actions are pending */ const uint32_t ARDP_CONN_ID_INVALID = 0xffffffff; /* To indicate invalid connection */ /** * @brief Per-protocol-instance (global) configuration variables. */ typedef struct { uint32_t connectTimeout; /**< udp_connect_timeout configuration variable */ uint32_t connectRetries; /**< udp_connect_retries configuration variable */ uint32_t initialDataTimeout; /**< udp_initial_data_timeout configuration variable */ uint32_t totalDataRetryTimeout; /**< udp_total_data_retry_timeout configuration variable */ uint32_t minDataRetries; /**< udp_min_data_retries configuration variable */ uint32_t persistInterval; /**< udp_persist_interval configuration variable */ uint32_t totalAppTimeout; /**< udp_total_app_timeout configuration variable */ uint32_t linkTimeout; /**< udp_link_timeout configuration variable */ uint32_t keepaliveRetries; /**< udp_keepalive_retries configuration variable */ uint32_t fastRetransmitAckCounter; /**< udp_fast_retransmit_ack_counter configuration variable */ uint32_t delayedAckTimeout; /**< udp_delayed_ack_timeout configuration variable */ uint32_t timewait; /**< udp_timewait configuration variable */ uint32_t segbmax; /**< udp_segbmax configuration variable */ uint32_t segmax; /**< udp_segmax configuration variable */ } ArdpGlobalConfig; /** * @brief This is the format of an RDP datagram header on the wire. * * This is expected to be sent in "network byte order" AKA big endian. Use the * usual htonl(), ntohl() functions. */ #pragma pack(push, 1) typedef struct { uint8_t flags; /**< See Control flag definitions above */ uint8_t hlen; /**< Length of the header in units of two octets (number of uint16_t) */ uint16_t src; /**< Used to distinguish between multiple connections on the local side. */ uint16_t dst; /**< Used to distinguish between multiple connections on the foreign side. */ uint16_t dlen; /**< The length of the data in the current segment. Does not include the header size. */ uint32_t seq; /**< The sequence number of the current segment. */ uint32_t ack; /**< The number of the segment that the sender of this segment last received correctly and in sequence. */ uint32_t ttl; /**< Time-to-live. Zero means forever. */ uint32_t lcs; /**< Last "in-order" consumed segment. */ uint32_t acknxt; /**< First unexpired segment, TTL accounting */ uint32_t som; /**< Start sequence number for fragmented message */ uint16_t fcnt; /**< Number of segments comprising fragmented message */ uint16_t reserve; /**< Reserved for future use */ } ArdpHeader; #pragma pack(pop) /* Maximum header length, implied by the fact that hlen filed is 8 bits */ static const uint16_t ARDP_MAX_HEADER_LEN = 255; /* Length of fixed part of the header (sans EACKs), see below ArdpHeader structure */ static const uint16_t ARDP_FIXED_HEADER_LEN = 36; /** * Max window size (segments in flight). Limited by : * a) header filed size (8 bit) * b) presence of EACK mask that has to be in 32-bit chunks and depends on window size. */ const uint16_t ARDP_MAX_WINDOW_SIZE = ((ARDP_MAX_HEADER_LEN * 2 - ARDP_FIXED_HEADER_LEN) >> 5) << 5; typedef struct ARDP_CONN_RECORD ArdpConnRecord; #define ARDP_FLAG_SYN 0x01 /**< Control flag. Request to open a connection. Must be separate segment. */ #define ARDP_FLAG_ACK 0x02 /**< Control flag. Acknowledge a segment. May accompany message */ #define ARDP_FLAG_EACK 0x04 /**< Control flag. Non-cumulative (extended) acknowledgement */ #define ARDP_FLAG_RST 0x08 /**< Control flag. Reset this connection. Must be separate segment. */ #define ARDP_FLAG_NUL 0x10 /**< Control flag. Null (zero-length) segment. Must have zero data length but may share ACK and EACK info. */ #define ARDP_FLAG_VER 0x40 /**< Control flag. Bits 6-7 of flags byte. Current version is (1) */ #define ARDP_FLAG_SDM 0x0001 /**< Sequenced delivery mode option. Indicates in-order sequence delivery is in force. */ #if ARDP_TC_SUPPORT #define ARDP_FLAG_SIMPLE_MODE 0x0002 /**< No EACKs */ #endif typedef struct ARDP_HANDLE ArdpHandle; typedef struct ARDP_RCV_BUFFER { uint32_t seq; /**< Sequence number */ uint32_t datalen; /**< Data payload size */ uint8_t* data; /**< Pointer to data payload */ ARDP_RCV_BUFFER* next; /**< Pointer to the next buffer */ uint32_t som; /**< Sequence number of first segment in fragmented message */ uint32_t ttl; /**< Remaining time to live of the AllJoyn message */ uint32_t tRecv; /**< Local time at which the segment was received (used for TTL calcs) */ uint16_t fcnt; /**< Number of segments comprising fragmented message */ uint8_t flags; /**< Buffer state flags */ } ArdpRcvBuf; #if ARDP_TESTHOOKS enum TesthookSource { SEND_MSG_HEADER = 1, SEND_MSG_DATA, DO_SEND_SYN, SEND_RST, ARDP_RUN }; typedef void (*ARDP_SENDTOSG_TH)(ArdpHandle* handle, ArdpConnRecord* conn, TesthookSource source, qcc::ScatterGatherList& msgSG); typedef void (*ARDP_SENDTO_TH)(ArdpHandle* handle, ArdpConnRecord* conn, TesthookSource source, void* buf, uint32_t len); typedef void (*ARDP_RECVFROM_TH)(ArdpHandle* handle, ArdpConnRecord* conn, TesthookSource source, void* buf, uint32_t len); typedef struct { ARDP_SENDTOSG_TH SendToSG; /**< Called just before a scatter-gather list is sent to a socket, after ARDP is done with the data */ ARDP_SENDTO_TH SendTo; /**< Called just before a buffer is sent to a socket, after ARDP is done with the data */ ARDP_RECVFROM_TH RecvFrom; /**< Called after a message is received from a socket, before ARDP does anything */ } ArdpTesthooks; #endif typedef void (*ARDP_CONNECT_CB)(ArdpHandle* handle, ArdpConnRecord* conn, bool passive, uint8_t* buf, uint16_t len, QStatus status); typedef void (*ARDP_DISCONNECT_CB)(ArdpHandle* handle, ArdpConnRecord* conn, QStatus status); typedef bool (*ARDP_ACCEPT_CB)(ArdpHandle* handle, qcc::IPAddress ipAddr, uint16_t ipPort, ArdpConnRecord* conn, uint8_t* buf, uint16_t len, QStatus status); typedef void (*ARDP_RECV_CB)(ArdpHandle* handle, ArdpConnRecord* conn, ArdpRcvBuf* rcvbufs, QStatus status); typedef void (*ARDP_SEND_CB)(ArdpHandle* handle, ArdpConnRecord* conn, uint8_t* buf, uint32_t len, QStatus status); typedef void (*ARDP_SEND_WINDOW_CB)(ArdpHandle* handle, ArdpConnRecord* conn, uint16_t window, QStatus status); typedef struct { ARDP_ACCEPT_CB AcceptCb; /**< Called when new connection comes in */ ARDP_CONNECT_CB ConnectCb; /**< Called when new connection transitions to OPEN state */ ARDP_DISCONNECT_CB DisconnectCb; /**< Called when connection goes to CLOSE_WAIT state */ ARDP_RECV_CB RecvCb; /**< Called when new data arrives */ ARDP_SEND_CB SendCb; /**< Called when the buffer is sent off into the network */ ARDP_SEND_WINDOW_CB SendWindowCb; /**< Called when the send window changes */ } ArdpCallbacks; /** * @brief The basic ARDP API. * * The ARDP is an asynchronous-sockets-like API. * * - Connect is the active version of open. Connect begins the SYN, * SYN-ACK, ACK thre-way handshake. The connect callback is fired when * the outgoing connection enters the OPEN state. * * - Accept is the passive version of open. Accept simply enables accepting * connection requests to do the three-way handshake. The accept callback * is fired when the incoming connection enters the OPEN state. * * - Disconnect is used to close both Active and Passive connections. The * disconnect callback is fired when the connection enters the CLOSE_WAIT * state. Disconnect can be started by either end of the connection. * * - Send is an asynchronous send that is complete when the write callback * is fired. Send data is not buffered if the send window does not allow * immediate transmission. This is to avoid buffering large numbers of * messages that may have a short TTL. the client should check TTL * immediately before passing data into ARDP. Returning from the send * callback has the side effect of opening the send window (telling the * other side it can send more data). There is a separate helper callback * that fires whenever the send window changes to allow triggering of * sends. * * - Recv is an asynchronous read that is complete when the receive callback * is fired. Calling receive with a buffer has the side-effect of * widening the receive window (and telling the other side it can send * data). Returning from the read callback has the effect of * acknowledging the underlying segment that was received (allowing the * other side to send more data). * * Call-in functions are expected to be set by the ARDP protocol and call-out functions are * expected to be set by the client. Since this code is expected to run on embedded * systems, we don't protect the API using class mechanisms, we just trust that since * it is we who are implementing the client, we'll do it correctly. */ ArdpHandle* ARDP_AllocHandle(ArdpGlobalConfig* config); void ARDP_FreeHandle(ArdpHandle* handle); void ARDP_SetHandleContext(ArdpHandle* handle, void* context); void* ARDP_GetHandleContext(ArdpHandle* handle); bool ARDP_IsConnValid(ArdpHandle* handle, ArdpConnRecord* conn, uint32_t connId); void ARDP_ReleaseConn(ArdpHandle* handle, ArdpConnRecord* conn); QStatus ARDP_SetConnContext(ArdpHandle* handle, ArdpConnRecord* conn, void* context); void* ARDP_GetConnContext(ArdpHandle* handle, ArdpConnRecord* conn); uint32_t ARDP_GetConnId(ArdpHandle* handle, ArdpConnRecord* conn); uint32_t ARDP_GetConnPending(ArdpHandle* handle, ArdpConnRecord* conn); qcc::IPAddress ARDP_GetIpAddrFromConn(ArdpHandle* handle, ArdpConnRecord* conn); uint16_t ARDP_GetIpPortFromConn(ArdpHandle* handle, ArdpConnRecord* conn); QStatus ARDP_Run(ArdpHandle* handle, qcc::SocketFd sock, bool readReady, bool writeReady, uint32_t* ms); QStatus ARDP_StartPassive(ArdpHandle* handle); QStatus ARDP_Accept(ArdpHandle* handle, ArdpConnRecord* conn, uint16_t segmax, uint16_t segbmax, uint8_t* buf, uint16_t len); QStatus ARDP_Acknowledge(ArdpHandle* handle, ArdpConnRecord* conn, uint8_t* buf, uint16_t len); void ARDP_SetAcceptCb(ArdpHandle* handle, ARDP_ACCEPT_CB AcceptCb); QStatus ARDP_Connect(ArdpHandle* handle, qcc::SocketFd sock, qcc::IPAddress ipAddr, uint16_t ipPort, uint16_t segmax, uint16_t segbmax, ArdpConnRecord** conn, uint8_t* buf, uint16_t len, void* context); void ARDP_SetConnectCb(ArdpHandle* handle, ARDP_CONNECT_CB ConnectCb); QStatus ARDP_Disconnect(ArdpHandle* handle, ArdpConnRecord* conn); void ARDP_SetDisconnectCb(ArdpHandle* handle, ARDP_DISCONNECT_CB DisconnectCb); void ARDP_ReleaseConnection(ArdpHandle* handle, ArdpConnRecord* conn); QStatus ARDP_RecvReady(ArdpHandle* handle, ArdpConnRecord* conn, ArdpRcvBuf* rcvbuf); void ARDP_SetRecvCb(ArdpHandle* handle, ARDP_RECV_CB RecvCb); QStatus ARDP_Send(ArdpHandle* handle, ArdpConnRecord* conn, uint8_t* buf, uint32_t len, uint32_t ttl); void ARDP_SetSendCb(ArdpHandle* handle, ARDP_SEND_CB SendCb); void ARDP_SetSendWindowCb(ArdpHandle* handle, ARDP_SEND_WINDOW_CB SendWindowCb); uint32_t ARDP_GetDataTimeout(ArdpHandle* handle, ArdpConnRecord* conn); #if ARDP_TESTHOOKS void ARDP_HookSendToSG(ArdpHandle* handle, ARDP_SENDTOSG_TH SendToSG); void ARDP_HookSendTo(ArdpHandle* handle, ARDP_SENDTO_TH SendTo); void ARDP_HookRecvFrom(ArdpHandle* handle, ARDP_RECVFROM_TH RecvFrom); #endif #if ARDP_STATS typedef struct { uint32_t acceptCbs; /**< The number of times the accept callback was fired */ uint32_t connectCbs; /**< The number of times the connect callback was fired */ uint32_t disconnectCbs; /**< The number of times the disconnect callback was fired */ uint32_t sendCbs; /**< The number of times the send callback was fired */ uint32_t recvCbs; /**< The number of times the receive callback was fired */ uint32_t outboundDrops; /**< The total number of outbound messages that have been dropped */ uint32_t preflightDrops; /**< The number of outbound messages that have been dropped before making it to the wire */ uint32_t inflightDrops; /**< The number of outbound messages that have been dropped after making it to the wire */ uint32_t inboundDrops; /**< The total number of inbound messages that have been dropped */ uint32_t synSends; /**< The number of SYN packets we have sent (3-way handshake part one) */ uint32_t synRecvs; /**< The number of SYN packets we have received (3-way handshake part one) */ uint32_t synackSends; /**< The number of SYN-ACK packets we have sent (3-way handshake part two) */ uint32_t synackRecvs; /**< The number of SYN-ACK packets we have received (3-way handshake part two) */ uint32_t synackackSends; /**< The number of SYN-ACK ACK packets we have sent (3-way handshake part three) */ uint32_t synackackRecvs; /**< The number of SYN-ACK ACK packets we have received (3-way handshake part three) */ uint32_t rstSends; /**< The number of RST packets we have sent */ uint32_t rstRecvs; /**< The number of RST packets we have received */ uint32_t nulSends; /**< The number of NUL packets we have sent */ uint32_t nulRecvs; /**< The number of NUL packets we have received */ } ArdpStats; ArdpStats* ARDP_GetStats(ArdpHandle* handle); void ARDP_ResetStats(ArdpHandle* handle); #endif } // namespace ajn #endif // _ALLJOYN_ARDP_PROTOCOL_H alljoyn-15.04b/alljoyn_core/router/Bus.cc000066400000000000000000000166571255700255500204220ustar00rootroot00000000000000/** * @file * * Bus is the top-level object responsible for implementing the message bus. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include "Bus.h" #include "DaemonRouter.h" #include "TransportList.h" #define QCC_MODULE "ALLJOYN_DAEMON" using namespace ajn; using namespace qcc; using namespace std; /* * Set the number of concurrent method and signal handlers on our local endpoint * to four. */ const uint32_t EP_CONCURRENCY = 4; Bus::Bus(const char* applicationName, TransportFactoryContainer& factories, const char* listenSpecs) : BusAttachment(new Internal(applicationName, *this, factories, new DaemonRouter, true, listenSpecs, EP_CONCURRENCY), EP_CONCURRENCY) { GetInternal().GetRouter().SetGlobalGUID(GetInternal().GetGlobalGUID()); } Bus::~Bus() { /* Make sure all listeners are unregistered */ listenersLock.Lock(MUTEX_CONTEXT); set::iterator it = busListeners.begin(); while (it != busListeners.end()) { BusListener* listener = **it; listenersLock.Unlock(MUTEX_CONTEXT); UnregisterBusListener(*listener); listenersLock.Lock(MUTEX_CONTEXT); it = busListeners.begin(); } listenersLock.Unlock(MUTEX_CONTEXT); } QStatus Bus::StartListen(const qcc::String& listenSpec, bool& listening) { QStatus status; /** Get the transport */ Transport* trans = GetInternal().GetTransportList().GetTransport(listenSpec); if (trans) { status = trans->StartListen(listenSpec.c_str()); if (ER_OK == status) { if (trans->IsBusToBus()) { if (!externalAddrs.empty()) { externalAddrs += ';'; } externalAddrs += listenSpec + ",guid=" + GetInternal().GetGlobalGUID().ToString(); } else { if (!localAddrs.empty()) { localAddrs += ';'; } localAddrs += listenSpec + ",guid=" + GetInternal().GetGlobalGUID().ToString(); } listening = true; } } else { status = ER_BUS_TRANSPORT_NOT_AVAILABLE; } return status; } QStatus Bus::StartListen(const char* listenSpecs) { QStatus status(ER_OK); qcc::String specs = listenSpecs; bool listening = false; if (!IsStarted()) { status = ER_BUS_BUS_NOT_STARTED; } else { size_t pos = 0; while (qcc::String::npos != pos) { size_t endPos = specs.find_first_of(';', pos); qcc::String spec((qcc::String::npos == endPos) ? specs.substr(pos) : specs.substr(pos, endPos - pos)); QStatus s(StartListen(spec, listening)); if (status == ER_OK) { status = s; } pos = ((qcc::String::npos == endPos) || (specs.size() <= endPos + 1)) ? qcc::String::npos : endPos + 1; } /* * BusAttachment needs to be listening on at least one transport */ if (listening) { status = ER_OK; } else { status = ER_BUS_NO_TRANSPORTS; } } if (status != ER_OK) { QCC_LogError(status, ("BusAttachment::StartListen failed")); } return status; } QStatus Bus::StopListen(const char* listenSpecs) { QStatus status(ER_OK); qcc::String specs = listenSpecs; if (!IsStarted()) { status = ER_BUS_BUS_NOT_STARTED; QCC_LogError(status, ("BusAttachment::StopListen() failed")); } else { size_t pos = 0; while (qcc::String::npos != pos) { size_t endPos = specs.find_first_of(';', pos); qcc::String spec = (qcc::String::npos == endPos) ? specs.substr(pos) : specs.substr(pos, endPos - pos); QStatus s = ER_BUS_TRANSPORT_NOT_AVAILABLE; Transport* trans = GetInternal().GetTransportList().GetTransport(spec); if (trans) { s = trans->StopListen(spec.c_str()); if (ER_OK != s) { QCC_LogError(s, ("Transport::StopListen failed")); } // TODO - remove spec from localAddrs and externalAddrs??? } if (status == ER_OK) { status = s; } pos = ((qcc::String::npos == endPos) || (specs.size() <= endPos + 1)) ? qcc::String::npos : endPos + 1; } } return status; } void Bus::RegisterBusListener(BusListener& listener) { listenersLock.Lock(MUTEX_CONTEXT); BusListener* l = &listener; busListeners.insert(ProtectedBusListener(l)); if (busListeners.size() == 1) { /* * The bus gets name changed callbacks from the daemon router. */ reinterpret_cast(GetInternal().GetRouter()).AddBusNameListener(this); } listenersLock.Unlock(MUTEX_CONTEXT); } void Bus::UnregisterBusListener(BusListener& listener) { /* Find listener and remove it*/ listenersLock.Lock(MUTEX_CONTEXT); BusListener* pListener = &listener; set::iterator it = busListeners.find(ProtectedBusListener(pListener)); if (it != busListeners.end()) { ProtectedBusListener l = *it; busListeners.erase(it); /* Unregister name listener for this attachment if no listeners are registered */ if (busListeners.size() == 0) { reinterpret_cast(GetInternal().GetRouter()).RemoveBusNameListener(this); } /* Wait for any callbacks on listener to complete */ while (l.GetRefCount() > 1) { listenersLock.Unlock(MUTEX_CONTEXT); qcc::Sleep(5); listenersLock.Lock(MUTEX_CONTEXT); } } listenersLock.Unlock(MUTEX_CONTEXT); } void Bus::NameOwnerChanged(const qcc::String& alias, const qcc::String* oldOwner, SessionOpts::NameTransferType oldOwnerNameTransfer, const qcc::String* newOwner, SessionOpts::NameTransferType newOwnerNameTransfer) { QCC_UNUSED(oldOwnerNameTransfer); QCC_UNUSED(newOwnerNameTransfer); listenersLock.Lock(MUTEX_CONTEXT); set::iterator it = busListeners.begin(); while (it != busListeners.end()) { ProtectedBusListener l = *it; listenersLock.Unlock(MUTEX_CONTEXT); (*l)->NameOwnerChanged(alias.c_str(), oldOwner ? oldOwner->c_str() : NULL, newOwner ? newOwner->c_str() : NULL); listenersLock.Lock(MUTEX_CONTEXT); it = busListeners.upper_bound(l); } listenersLock.Unlock(MUTEX_CONTEXT); } alljoyn-15.04b/alljoyn_core/router/Bus.h000066400000000000000000000134401255700255500202470ustar00rootroot00000000000000/** * @file * Bus is the top-level object responsible for implementing the message bus. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_BUS_H #define _ALLJOYN_BUS_H #ifndef __cplusplus #error Only include Bus.h in C++ code. #endif #include #include #include #include #include #include #include #include #include "TransportList.h" #include "DaemonRouter.h" #include "BusInternal.h" namespace ajn { class Bus : public BusAttachment, public NameListener { public: /** * Construct a Bus. * * @param applicationName Name of the application. * * @param factories A container of transport factories that knows * how to create the individual transports. Some * transports may be defined as default, in which * case they are automatically instantiated. If * not, they are instantiated based on the listen * spec if present. * * @param listenSpecs A semicolon separated list of bus addresses that this daemon is capable of listening on. */ Bus(const char* applicationName, TransportFactoryContainer& factories, const char* listenSpecs = NULL); /** * Destruct a Bus. */ ~Bus(); /** * Listen for incoming AllJoyn connections on a given transport address. * * This method will fail if the BusAttachment instance is a strictly for client-side use. * * @param listenSpecs A list of transport connection spec strings each of the form: * @c \:\=\,\=\... * * @return * - ER_OK if successful * - ER_BUS_NO_TRANSPORTS if transport can not be found to listen for. */ QStatus StartListen(const char* listenSpecs); /** * Stop listening for incomming AllJoyn connections on a given transport address. * * @param listenSpecs A transport connection spec string of the form: * @c \:\=\,\=\...[;] * * @return ER_OK */ QStatus StopListen(const char* listenSpecs); /** * Get addresses that can be used by applications running on the same * machine (i.e., unix: and tcp:). * * @return Local bus addresses in standard DBus address notation */ const qcc::String& GetLocalAddresses() const { return localAddrs; } /** * Get addresses that can be used by applications running on other * machines (i.e., tcp:). * * @return External bus addresses in standard DBus address notation */ const qcc::String& GetExternalAddresses() const { return externalAddrs; } /** * Get all unique names and their exportable alias (well-known) names. * * @param nameVec Vector of (uniqueName, aliases) pairs where aliases is a vector of alias names. */ void GetUniqueNamesAndAliases(std::vector > >& nameVec) const { reinterpret_cast(GetInternal().GetRouter()).GetUniqueNamesAndAliases(nameVec); } /** * Register an object that will receive bus event notifications. * * @param listener Object instance that will receive bus event notifications. */ void RegisterBusListener(BusListener& listener); /** * Unregister an object that was previously registered as a BusListener * * @param listener BusListener to be un registered. */ void UnregisterBusListener(BusListener& listener); private: void NameOwnerChanged(const qcc::String& alias, const qcc::String* oldOwner, SessionOpts::NameTransferType oldOwnerNameTransfer, const qcc::String* newOwner, SessionOpts::NameTransferType newOwnerNameTransfer); /** * Listen for incomming AllJoyn connections on a single transport address. * * @param listenSpec A transport connection spec string of the form: * @c \:\=\,\=\...[;] * * @param listening [OUT] true if started listening on specified transport. * * @return * - ER_OK if successful * - ER_BUS_NO_TRANSPORTS if transport can not be found to listen for. */ QStatus StartListen(const qcc::String& listenSpec, bool& listening); qcc::String localAddrs; ///< Bus Addresses locally accessable qcc::String externalAddrs; ///< Bus Addresses externall accessable typedef qcc::ManagedObj ProtectedBusListener; std::set busListeners; qcc::Mutex listenersLock; }; } #endif alljoyn-15.04b/alljoyn_core/router/BusController.cc000066400000000000000000000132151255700255500224510ustar00rootroot00000000000000/** * @file * * BusController is responsible for responding to standard DBus messages * directed at the bus itself. */ /****************************************************************************** * * * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include "BusController.h" #include "DaemonRouter.h" #include "BusInternal.h" #define QCC_MODULE "ALLJOYN_DAEMON" using namespace std; using namespace qcc; using namespace ajn; BusController::BusController(Bus& alljoynBus, AuthListener* authListener) : bus(alljoynBus), authListener(authListener), dbusObj(bus, this), alljoynObj(bus, this, reinterpret_cast(bus.GetInternal().GetRouter())), sessionlessObj(bus, this, reinterpret_cast(bus.GetInternal().GetRouter())), #ifndef NDEBUG alljoynDebugObj(this), #endif initComplete(false) { DaemonRouter& router(reinterpret_cast(bus.GetInternal().GetRouter())); router.SetBusController(this); router.SetAllJoynObj(&alljoynObj); router.SetSessionlessObj(&sessionlessObj); } BusController::~BusController() { Stop(); Join(); } QStatus BusController::Init(const qcc::String& listenSpecs) { QStatus status; /* * Start the object initialization chain (see ObjectRegistered callback below) */ status = dbusObj.Init(); if (ER_OK != status) { QCC_LogError(status, ("DBusObj::Init failed")); } else { if (status == ER_OK) { status = bus.Start(); } if (status == ER_OK) { while (!initComplete) { qcc::Sleep(4); } } if (status == ER_OK) { status = bus.StartListen(listenSpecs.c_str()); if (status != ER_OK) { bus.Stop(); bus.Join(); } } } return status; } QStatus BusController::Stop() { QStatus status = dbusObj.Stop(); if (status != ER_OK) { QCC_LogError(status, ("dbusObj::Stop failed")); } QStatus tStatus = alljoynObj.Stop(); if (tStatus != ER_OK) { QCC_LogError(tStatus, ("alljoynObj::Stop failed")); } status = (status == ER_OK) ? tStatus : status; tStatus = sessionlessObj.Stop(); if (tStatus != ER_OK) { QCC_LogError(tStatus, ("sessionlessObj::Stop failed")); } status = (status == ER_OK) ? tStatus : status; #ifndef NDEBUG tStatus = alljoynDebugObj.Stop(); if (tStatus != ER_OK) { QCC_LogError(tStatus, ("alljoynDebugObj::Stop failed")); } status = (status == ER_OK) ? tStatus : status; #endif tStatus = bus.Stop(); if (tStatus != ER_OK) { QCC_LogError(tStatus, ("bus::Stop failed")); } status = (status == ER_OK) ? tStatus : status; return status; } QStatus BusController::Join() { QStatus status = dbusObj.Join(); if (status != ER_OK) { QCC_LogError(status, ("dbusObj::Join failed")); } QStatus tStatus = alljoynObj.Join(); if (tStatus != ER_OK) { QCC_LogError(tStatus, ("alljoynObj::Join failed")); } status = (status == ER_OK) ? tStatus : status; tStatus = sessionlessObj.Join(); if (tStatus != ER_OK) { QCC_LogError(tStatus, ("sessionlessObj::Join failed")); } status = (status == ER_OK) ? tStatus : status; #ifndef NDEBUG tStatus = alljoynDebugObj.Join(); if (tStatus != ER_OK) { QCC_LogError(tStatus, ("alljoynDebugObj::Join failed")); } status = (status == ER_OK) ? tStatus : status; #endif tStatus = bus.Join(); if (tStatus != ER_OK) { QCC_LogError(tStatus, ("bus::Join failed")); } status = (status == ER_OK) ? tStatus : status; return status; } /* * The curious code below is to force various bus objects to be registered in order: * * /org/freedesktop/DBus * /org/alljoyn/Bus * /org/alljoyn/Debug * * The last one is optional and only registered for debug builds */ void BusController::ObjectRegistered(BusObject* obj) { QStatus status; bool isDone = false; if (obj == &dbusObj) { status = alljoynObj.Init(); if (status != ER_OK) { isDone = true; QCC_LogError(status, ("alljoynObj::Init failed")); } } if (obj == &alljoynObj) { status = sessionlessObj.Init(); if (status != ER_OK) { isDone = true; QCC_LogError(status, ("sessionlessObj::Init failed")); } } #ifndef NDEBUG if (obj == &sessionlessObj) { status = alljoynDebugObj.Init(); if (status != ER_OK) { isDone = true; QCC_LogError(status, ("alljoynDebugObj::Init failed")); } } if (obj == &alljoynDebugObj) { isDone = true; } #else if (obj == &sessionlessObj) { isDone = true; } #endif if (isDone) { initComplete = true; } } alljoyn-15.04b/alljoyn_core/router/BusController.h000066400000000000000000000072411255700255500223150ustar00rootroot00000000000000/** * @file * * BusController is responsible for responding to standard DBus and Bus * specific messages directed at the bus itself. */ /****************************************************************************** * * * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_BUSCONTROLLER_H #define _ALLJOYN_BUSCONTROLLER_H #include #include #include "Bus.h" #include "DBusObj.h" #include "AllJoynObj.h" #include "AllJoynDebugObj.h" #include "SessionlessObj.h" #include "ProtectedAuthListener.h" namespace ajn { /** * BusController is responsible for responding to DBus and AllJoyn * specific messages directed at the bus itself. */ class BusController { public: /** * Constructor * * @param bus Bus to associate with this controller. * @param authListener Optional authentication listener */ BusController(Bus& bus, AuthListener* authListener = NULL); /** * Destructor */ virtual ~BusController(); /** * Initialize the bus controller and start the bus * * @param listeSpecs The listen specs for the bus. * * @return Returns ER_OK if controller was successfully initialized. */ QStatus Init(const qcc::String& listenSpecs); /** * Stop the bus controller. * * @return ER_OK if successful. */ QStatus Stop(); /** * Join the bus controller. * * @return ER_OK if successful. */ QStatus Join(); /** * Return the daemon bus object responsible for org.alljoyn.Bus. * * @return The AllJoynObj. */ AllJoynObj& GetAllJoynObj() { return alljoynObj; } /** * Return the bus associated with this bus controller * * @return Return the bus */ Bus& GetBus() { return bus; } /** * ObjectRegistered callback. * * @param obj BusObject that has been registered */ void ObjectRegistered(BusObject* obj); /** * Get the sessionlessObj. * * @return The sessionlessObj singleton */ SessionlessObj& GetSessionlessObj() { return sessionlessObj; } /** * Get the auth listener for this bus controller */ AuthListener* GetAuthListener() { return authListener; } private: Bus& bus; /** Listener for authenticating clients */ AuthListener* authListener; /** Bus object responsible for org.freedesktop.DBus */ DBusObj dbusObj; /** Bus object responsible for org.alljoyn.Bus */ AllJoynObj alljoynObj; /** Bus object responsible for org.alljoyn.Sessionless */ SessionlessObj sessionlessObj; #ifndef NDEBUG /** Bus object responsible for org.alljoyn.Debug */ debug::AllJoynDebugObj alljoynDebugObj; #endif /** Event to wait on while initialization completes */ bool initComplete; }; } #endif alljoyn-15.04b/alljoyn_core/router/ConfigDB.cc000066400000000000000000000451071255700255500212740ustar00rootroot00000000000000/** * @file * AllJoyn-Daemon Config file database class */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #if !defined(QCC_OS_GROUP_WINDOWS) #include #endif #include #include #include #include #include #include #include #include #include #include #include "ConfigDB.h" #ifdef ENABLE_POLICYDB #include "PolicyDB.h" #endif using namespace ajn; using namespace qcc; using namespace std; /** * Coverts the path to an absolute path based on various criteria. For POSIX * platforms, it interprets the "~/" to mean the user's home directory and * "~user/" as the home directory of "user" and returns the absolute path with * "~/" or "~user/" replaced with the path to the user's home directory. If * the given path does not start with "/", then the base path name extracted * from fileName to generate the absolute path name. * * @param path Path name to be made into an absolute path * @param fileName [optional] Absolute path to a file that will be used as the * basis for generating an absolute path when given a relative * path. */ static String ExpandPath(const String& path, const String& fileName = String::Empty) { #if defined(QCC_OS_GROUP_WINDOWS) #define PATH_SEP "/\\" bool absolute = (path.empty() || (path[0] == '/') || (path[0] == '\\') || path[1] == ':'); #else #define PATH_SEP '/' bool absolute = path.empty() || (path[0] == '/'); #endif if (absolute) { return path; #if defined(QCC_OS_GROUP_POSIX) } else if (path[0] == '~') { /* * A path starting with "~" indicates that it is relative to the home * directory. This nomenclature comes from UNIX shells. What is not * as well known, is that "~username" indicates the home directory of * "username" rather than home directory of the current user if "~" is * specified by itself. */ size_t position = path.find_first_of(PATH_SEP); String user = path.substr(1, position - 1); String home; struct passwd* pwd = NULL; if (user.empty()) { home = getenv("HOME"); /* If HOME is not set get the user's home directory from the /etc/passwd */ if (home.empty()) { pwd = getpwuid(getuid()); } } else { pwd = getpwnam(user.c_str()); } if (pwd) { home = pwd->pw_dir; } return home + path.substr(position); #endif } else if (fileName.empty()) { // Use path as is. return path; } else { // A path relative to the currently processed file return fileName.substr(0, fileName.find_last_of(PATH_SEP) + 1) + path; } #undef PATH_SEP } ConfigDB* ConfigDB::singleton = NULL; #ifdef ENABLE_POLICYDB void ConfigDB::NameOwnerChanged(const String& alias, const String* oldOwner, SessionOpts::NameTransferType oldOwnerNameTransfer, const String* newOwner, SessionOpts::NameTransferType newOwnerNameTransfer) { rwlock.RDLock(); PolicyDB policy = db->policyDB; rwlock.Unlock(); policy->NameOwnerChanged(alias, oldOwner, oldOwnerNameTransfer, newOwner, newOwnerNameTransfer); } #endif ConfigDB::ConfigDB(const String defaultXml, const String fileName) : defaultXml(defaultXml), fileName(fileName), db(new DB()), stopping(false) { assert(!singleton); if (!singleton) { singleton = this; } } ConfigDB::~ConfigDB() { delete db; singleton = NULL; } bool ConfigDB::LoadConfig(Bus* bus) { if (stopping) { return false; } StringSource defaultSrc(defaultXml); DB* newDb = new DB(); bool success = true; /* * The default config XML may have multiple root tags. * Strictly speaking this is not valid XML, but it is convenient for * composing default values with an internal configuration. Because of * this structure, we need to process defaultSrc until all the bytes are * read. */ while (success && (defaultSrc.Remaining() > 0)) { success = newDb->ParseSource("", defaultSrc); } if (!fileName.empty()) { success = newDb->ParseFile(ExpandPath(fileName)); } newDb->Finalize(bus); if (success) { rwlock.WRLock(); DB* old = db; db = newDb; rwlock.Unlock(); delete old; } else { delete newDb; } return success; } bool ConfigDB::DB::ParseSource(const String& fileName, Source& src) { XmlParseContext xmlParseCtx(src); const XmlElement* root = xmlParseCtx.GetRoot(); bool success; success = XmlElement::Parse(xmlParseCtx) == ER_OK; if (success) { if (root->GetName() == "busconfig") { success = ProcessBusconfig(fileName, *root); } else { Log(LOG_ERR, "Error processing \"%s\": Unknown tag found at top level: <%s>\n", fileName.c_str(), root->GetName().c_str()); success = false; } } else { Log(LOG_ERR, "File \"%s\" contains invalid XML constructs.\n", fileName.c_str()); } return success; } bool ConfigDB::DB::ParseFile(const String& fileName, bool ignoreMissing) { bool success = true; FileSource fs(fileName.c_str()); if (fs.IsValid()) { success = ParseSource(fileName, fs); } else if (!ignoreMissing) { Log(LOG_ERR, "Failed to open \"%s\": %s\n", fileName.c_str(), strerror(errno)); success = false; } return success; } bool ConfigDB::DB::ProcessAuth(const String& fileName, const XmlElement& auth) { QCC_UNUSED(fileName); static const char wspace[] = " \t\v\r\n"; bool success = true; String mechanisms(auth.GetContent()); size_t toks, toke; /* * Normalize the auth string to separate the tokens by a single space * rather than any random combination of white space characters. */ toks = mechanisms.find_first_not_of(wspace); while (toks != String::npos) { toke = mechanisms.find_first_of(wspace, toks); authList += mechanisms.substr(toks, toke - toks); authList.push_back(' '); toks = mechanisms.find_first_not_of(wspace, toke); } if (!authList.empty()) { // Remove the trailing ' ' that was leftover from normalization. authList.erase(authList.size() - 1); } return success; } bool ConfigDB::DB::ProcessBusconfig(const String& fileName, const XmlElement& busconfig) { bool success = true; const vector& elements = busconfig.GetChildren(); vector::const_iterator it; for (it = elements.begin(); success && (it != elements.end()); ++it) { const String& tag = (*it)->GetName(); if (tag == "auth") { success = ProcessAuth(fileName, *(*it)); } else if (tag == "flag") { success = ProcessFlag(fileName, *(*it)); } else if (tag == "fork") { success = ProcessFork(fileName, *(*it)); } else if (tag == "include") { success = ProcessInclude(fileName, *(*it)); } else if (tag == "includedir") { success = ProcessIncludedir(fileName, *(*it)); } else if (tag == "keep_umask") { success = ProcessKeepUmask(fileName, *(*it)); } else if (tag == "limit") { success = ProcessLimit(fileName, *(*it)); } else if (tag == "listen") { success = ProcessListen(fileName, *(*it)); } else if (tag == "pidfile") { success = ProcessPidfile(fileName, *(*it)); #ifdef ENABLE_POLICYDB } else if (tag == "policy") { success = ProcessPolicy(fileName, *(*it)); #else } else if (tag == "policy") { success = true; // Ignore policies #endif } else if (tag == "property") { success = ProcessProperty(fileName, *(*it)); } else if (tag == "syslog") { success = ProcessSyslog(fileName, *(*it)); } else if (tag == "type") { success = ProcessType(fileName, *(*it)); } else if (tag == "user") { success = ProcessUser(fileName, *(*it)); } else { Log(LOG_NOTICE, "Error processing \"%s\": Unknown tag found in : %s - ignoring\n", fileName.c_str(), tag.c_str()); } } return success; } bool ConfigDB::DB::ProcessFork(const String& fileName, const XmlElement& fork) { QCC_UNUSED(fileName); QCC_UNUSED(fork); bool success = true; this->fork = true; #ifndef NDEBUG if (!fork.GetAttributes().empty() || !fork.GetChildren().empty() || !fork.GetContent().empty()) { Log(LOG_INFO, "Ignoring extraneous data with <%s> tag.\n", fork.GetName().c_str()); } #endif return success; } bool ConfigDB::DB::ProcessInclude(const String& fileName, const XmlElement& include) { bool success = true; String includeFileName = ExpandPath(include.GetContent(), fileName); const map& attrs = include.GetAttributes(); bool ignoreMissing = false; if (includeFileName.empty()) { success = false; Log(LOG_ERR, "Error processing \"%s\": <%s> block is empty.\n", fileName.c_str(), include.GetName().c_str()); goto exit; } if (!attrs.empty()) { map::const_iterator it; for (it = attrs.begin(); it != attrs.end(); ++it) { if (it->first == "ignore_missing") { ignoreMissing = (it->second == "yes"); } else { Log(LOG_NOTICE, "Error Processing \"%s\": Unknown attribute \"%s\" in tag <%s> - ignoring.\n", fileName.c_str(), it->first.c_str(), include.GetName().c_str()); } } } success = ParseFile(includeFileName, ignoreMissing); exit: return success; } bool ConfigDB::DB::ProcessIncludedir(const String& fileName, const XmlElement& includedir) { bool success = true; String includeDirectory = ExpandPath(includedir.GetContent(), fileName); const map& attrs = includedir.GetAttributes(); bool ignoreMissing = false; DirListing listing; QStatus status; if (includeDirectory.empty()) { success = false; Log(LOG_ERR, "Error processing \"%s\": <%s> block is empty.\n", fileName.c_str(), includedir.GetName().c_str()); goto exit; } if (!attrs.empty()) { map::const_iterator it; for (it = attrs.begin(); it != attrs.end(); ++it) { if (it->first == "ignore_missing") { ignoreMissing = (it->second == "yes"); } else { Log(LOG_NOTICE, "Error Processing \"%s\": Unknown attribute \"%s\" in tag <%s> - ignoring.\n", fileName.c_str(), it->first.c_str(), includedir.GetName().c_str()); } } } status = GetDirListing(includeDirectory.c_str(), listing); if (status != ER_OK) { if (!ignoreMissing) { Log(LOG_ERR, "Error processing \"%s\": Failed to access directory \"%s\": %s\n", fileName.c_str(), includeDirectory.c_str(), strerror(errno)); success = false; } goto exit; } for (DirListing::const_iterator it = listing.begin(); it != listing.end(); ++it) { if ((*it != ".") && (*it != "..")) { success = ParseFile(includeDirectory + "/" + *it); } } exit: return success; } bool ConfigDB::DB::ProcessKeepUmask(const String& fileName, const XmlElement& keepUmask) { QCC_UNUSED(fileName); QCC_UNUSED(keepUmask); bool success = true; this->keepUmask = true; #ifndef NDEBUG if (!keepUmask.GetAttributes().empty() || !keepUmask.GetChildren().empty() || !keepUmask.GetContent().empty()) { Log(LOG_INFO, "Ignoring extraneous data with <%s> tag.\n", keepUmask.GetName().c_str()); } #endif return success; } bool ConfigDB::DB::ProcessLimit(const String& fileName, const XmlElement& limit) { bool success = true; String name = limit.GetAttribute("name"); String valstr = limit.GetContent(); uint32_t value; if (name.empty()) { Log(LOG_ERR, "Error processing \"%s\": 'name' attribute missing from <%s> tag.\n", fileName.c_str(), limit.GetName().c_str()); success = false; goto exit; } if (valstr.empty()) { Log(LOG_ERR, "Error processing \"%s\": Value not specified for limit \"%s\".\n", fileName.c_str(), name.c_str()); success = false; goto exit; } value = StringToU32(valstr); if ((value == 0) && (valstr[0] != '0')) { Log(LOG_ERR, "Error processing \"%s\": Limit value for \"%s\" must be an unsigned 32 bit integer (not \"%s\").\n", fileName.c_str(), name.c_str(), valstr.c_str()); success = false; goto exit; } limitMap[name] = value; exit: return success; } bool ConfigDB::DB::ProcessFlag(const String& fileName, const XmlElement& flag) { bool success = true; String name = flag.GetAttribute("name"); String valstr = flag.GetContent(); if (name.empty()) { Log(LOG_ERR, "Error processing \"%s\": 'name' attribute missing from <%s> tag.\n", fileName.c_str(), flag.GetName().c_str()); success = false; goto exit; } if (valstr == "true") { limitMap[name] = 1; } else if (valstr == "false") { limitMap[name] = 0; } else { Log(LOG_ERR, "Error processing \"%s\": Flag value for \"%s\" must be \"true\" or \"false\" (not \"%s\").\n", fileName.c_str(), name.c_str(), valstr.c_str()); success = false; } exit: return success; } bool ConfigDB::DB::ProcessProperty(const String& fileName, const XmlElement& property) { bool success = true; String name = property.GetAttribute("name"); String valstr = property.GetContent(); if (name.empty()) { Log(LOG_ERR, "Error processing \"%s\": 'name' attribute missing from <%s> tag.\n", fileName.c_str(), property.GetName().c_str()); success = false; goto exit; } propertyMap[name] = valstr; exit: return success; } bool ConfigDB::DB::ProcessListen(const String& fileName, const XmlElement& listen) { bool success = true; String addr = listen.GetContent(); if (addr.empty()) { Log(LOG_ERR, "Error processing \"%s\": <%s> block is empty.\n", fileName.c_str(), listen.GetName().c_str()); success = false; } else { bool added = listenList->insert(addr).second; if (!added) { Log(LOG_WARNING, "Warning processing \"%s\": Duplicate listen spec found (ignoring): %s\n", fileName.c_str(), addr.c_str()); } } return success; } bool ConfigDB::DB::ProcessPidfile(const String& fileName, const XmlElement& pidfile) { bool success = true; this->pidfile = ExpandPath(pidfile.GetContent(), fileName); if (this->pidfile.empty()) { success = false; Log(LOG_ERR, "Error processing \"%s\": <%s> block is empty.\n", fileName.c_str(), pidfile.GetName().c_str()); } return success; } #ifdef ENABLE_POLICYDB bool ConfigDB::DB::ProcessPolicy(const String& fileName, const XmlElement& policy) { bool success = true; const vector& elements = policy.GetChildren(); const map& attrs = policy.GetAttributes(); if (attrs.size() != 1) { Log(LOG_ERR, "Error processing \"%s\": Exactly one policy category must be specified.\n", fileName.c_str()); return false; } map::const_iterator pit = attrs.begin(); const String& cat = pit->first; const String& catValue = pit->second; for (vector::const_iterator it = elements.begin(); success && (it != elements.end()); ++it) { const String& permStr = (*it)->GetName(); QCC_DEBUG_ONLY(Log(LOG_DEBUG, "Processing tag <%s> in \"%s\"...\n", permStr.c_str(), fileName.c_str())); success = policyDB->AddRule(cat, catValue, permStr, (*it)->GetAttributes()); if (!success) { Log(LOG_ERR, "Error processing \"%s\": Invalid policy: cat=\"%s\" catValue=\"%s\" perm=\"%s\" \n", fileName.c_str(), cat.c_str(), catValue.c_str(), permStr.c_str()); } } return success; } #endif bool ConfigDB::DB::ProcessSyslog(const String& fileName, const XmlElement& syslog) { QCC_UNUSED(fileName); QCC_UNUSED(syslog); bool success = true; this->syslog = true; #ifndef NDEBUG if (!syslog.GetAttributes().empty() || !syslog.GetChildren().empty() || !syslog.GetContent().empty()) { Log(LOG_INFO, "Ignoring extraneous data with tag.\n", syslog.GetName().c_str()); } #endif return success; } bool ConfigDB::DB::ProcessType(const String& fileName, const XmlElement& type) { bool success = true; this->type = type.GetContent(); if (this->type.empty()) { success = false; Log(LOG_ERR, "Error processing \"%s\": <%s> block is empty.\n", fileName.c_str(), type.GetName().c_str()); } return success; } bool ConfigDB::DB::ProcessUser(const String& fileName, const XmlElement& user) { bool success = true; this->user = user.GetContent(); if (this->user.empty()) { success = false; Log(LOG_ERR, "Error processing \"%s\": <%s> block is empty.\n", fileName.c_str(), user.GetName().c_str()); } return success; } alljoyn-15.04b/alljoyn_core/router/ConfigDB.h000066400000000000000000000346071255700255500211410ustar00rootroot00000000000000/** * @file * AllJoyn-Daemon Config file database class */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _CONFIGDB_H #define _CONFIGDB_H #include #include #include #include #include #include #include #include #include #include "Bus.h" #ifdef ENABLE_POLICYDB #include "NameTable.h" #include "PolicyDB.h" #endif /** * Configuration file database class. */ namespace ajn { #ifdef ENABLE_POLICYDB class ConfigDB : public NameListener { #else class ConfigDB { #endif public: /** Typedef for list of daemon listen addresses. */ typedef std::set _ListenList; typedef qcc::ManagedObj<_ListenList> ListenList; /** Typedef for map of certain resource limits - also used for flags. */ typedef std::unordered_map LimitMap; /** Typedef for map of properties. */ typedef std::unordered_map PropertyMap; /** * Get a pointer to the ConfigDB singleton object. * * @return A pointer to the ConfigDB singleton object. */ static ConfigDB* GetConfigDB() { assert(singleton); return singleton; } /** * Constructor. This must be called before any other code can call * ConifgDB::GetConfigDB(). This should only be called once in a routing * node program and the object's lifetime should be that of the routing * node program. The easiest way to do this is to just instantiate * ConfigDB once as an object on the stack at the begining of main(). * Other code that accesses the ConfigDB should get a pointer from * ConfigDB::GetConfigDB(). * * @param defaultXml XML with the default configuration for limits, * flags, and properties. * @param fileName [optional] Name of the config file to load. */ ConfigDB(const qcc::String defaultXml, const qcc::String fileName = ""); /** * Destructor. */ ~ConfigDB(); /** * Shutdown configDB */ void Shutdown() { stopping = true; } #ifdef ENABLE_POLICYDB /** * Get a reference to the PolicyDB managed object. * * @return A reference to the PolicyDB managed object. */ PolicyDB GetPolicyDB() const { rwlock.RDLock(); PolicyDB pdb = db->policyDB; rwlock.Unlock(); return pdb; } #endif /** * (Re)Load the configuration. * * @param bus [optional] Pointer to the Bus object (may be NULL if * the Bus has not been created yet.) * * @return true if config file loaded successfully. */ bool LoadConfig(Bus* bus = NULL); /** * Get the bus type specified in the config file. * * @return The bus type. */ qcc::String GetType() const { rwlock.RDLock(); qcc::String type = db->type; rwlock.Unlock(); return type; } /** * Get the username the daemon should run as. * * @return The username. */ qcc::String GetUser() const { rwlock.RDLock(); qcc::String user = db->user; rwlock.Unlock(); return user; } /** * Get the path to the file where the PID should be stored. * * @return The file path for storing the PID. */ qcc::String GetPidfile() const { rwlock.RDLock(); qcc::String pidfile = db->pidfile; rwlock.Unlock(); return pidfile; } /** * Get whether the daemon should fork off into its own autonomous process * or not. * * @return true if daemon should fork. */ bool GetFork() const { rwlock.RDLock(); bool fork = db->fork; rwlock.Unlock(); return fork; } /** * Get whether the daemon should keep its umask setting or not when forking. * * @return true if daemon should keep its umask. */ bool GetKeepUmask() const { rwlock.RDLock(); bool keepUmask = db->keepUmask; rwlock.Unlock(); return keepUmask; } /** * Get whether the daemon should send log messages to syslog. * * @return true if daemon should send log mesages to syslog. */ bool GetSyslog() const { rwlock.RDLock(); bool syslog = db->syslog; rwlock.Unlock(); return syslog; } /** * Get the list of listen address specifications. * * @return List of listen address specifications. */ ListenList GetListen() const { rwlock.RDLock(); ListenList l = db->listenList; rwlock.Unlock(); return l; } /** * Get the list of supported authentication mechanisms. * * @return List of supported authentication mechanisms. */ qcc::String GetAuth() const { rwlock.RDLock(); qcc::String authList = db->authList; rwlock.Unlock(); return authList; } /** * Get the value of a specific limit. * * @param key The name of the limit to retrieve. * @param errVal [OPTIONAL] Value to use if key not found. * * @return Limit value. */ const uint32_t GetLimit(const qcc::String& key, uint32_t errVal = 0) const { rwlock.RDLock(); LimitMap::const_iterator it = db->limitMap.find(key); uint32_t limit = (it == db->limitMap.end()) ? errVal : it->second; rwlock.Unlock(); return limit; } /** * Get the value of a specific flag. * * @param key The name of the flag to retrieve. * * @return Flag value if set; false if not set. */ const bool GetFlag(const qcc::String& key, bool errVal = false) const { return GetLimit(key, errVal ? 1 : 0) == 1; } /** * Get the value of a specific property. * * @param key The name of the property. * @param errVal [OPTIONAL] Value to use if key not found. * * @return The property value if set, or the empty string. */ qcc::String GetProperty(const qcc::String& key, const qcc::String errVal = "") const { rwlock.RDLock(); PropertyMap::const_iterator it = db->propertyMap.find(key); qcc::String property = (it == db->propertyMap.end()) ? errVal : it->second; rwlock.Unlock(); return property; } private: /** Internal Config database data structure. */ struct DB { bool fork; /**< Indicates whether daemon should fork or not. */ bool syslog; /**< Indicates whether daemon should send to syslog or stdout. */ bool keepUmask; /**< Indicates whether daemon should keep its umask or not. */ qcc::String type; /**< Bus type. */ qcc::String user; /**< User identity daemon should run as. */ qcc::String pidfile; /**< File to store PID. */ qcc::String authList; /**< Authentication mechanism list. */ ListenList listenList; /**< Listen address list. */ LimitMap limitMap; /**< Resource limit map. */ PropertyMap propertyMap; /**< Property map. */ #ifdef ENABLE_POLICYDB PolicyDB policyDB; /**< The Policy database. */ #endif /** * Constructor. */ DB() : fork(false), syslog(false), keepUmask(false) { } /** * This is called when all config items have been processed. * * @param bus Pointer to the Bus object (may be NULL if the Bus * has not been created yet.) */ void Finalize(Bus* bus) { #ifndef ENABLE_POLICYDB QCC_UNUSED(bus); #else policyDB->Finalize(bus); #endif } /** * Parse the XML source stream. * * @param fileName Name of the configuration file. * * @return true if parsing was successful. */ bool ParseSource(const qcc::String& fileName, qcc::Source& src); /** * Parse the specified XML file. * * @param fileName Name of the configuration file. * * @return true if parsing was successful. */ bool ParseFile(const qcc::String& fileName, bool ignore_missing = false); /** * Parse the tag. * * @param fileName Name of the configuration file. * * @return true if parsing was successful. */ bool ProcessAuth(const qcc::String& fileName, const qcc::XmlElement& auth); /** * Parse the * * @param fileName Name of the configuration file. * * @return true if parsing was successful. */ bool ProcessBusconfig(const qcc::String& fileName, const qcc::XmlElement& busconfig); /** * Parse the tag. * * @param fileName Name of the configuration file. * * @return true if parsing was successful. */ bool ProcessFork(const qcc::String& fileName, const qcc::XmlElement& fork); /** * Parse the tag. * * @param fileName Name of the configuration file. * * @return true if parsing was successful. */ bool ProcessInclude(const qcc::String& fileName, const qcc::XmlElement& include); /** * Parse the tag. * * @param fileName Name of the configuration file. * * @return true if parsing was successful. */ bool ProcessIncludedir(const qcc::String& fileName, const qcc::XmlElement& includedir); /** * Parse the tag. * * @param fileName Name of the configuration file. * * @return true if parsing was successful. */ bool ProcessKeepUmask(const qcc::String& fileName, const qcc::XmlElement& keepUmask); /** * Parse the tag. * * @param fileName Name of the configuration file. * * @return true if parsing was successful. */ bool ProcessLimit(const qcc::String& fileName, const qcc::XmlElement& limit); /** * Parse the tag. * * @param fileName Name of the configuration file. * * @return true if parsing was successful. */ bool ProcessFlag(const qcc::String& fileName, const qcc::XmlElement& limit); /** * Parse the tag. * * @param fileName Name of the configuration file. * * @return true if parsing was successful. */ bool ProcessProperty(const qcc::String& fileName, const qcc::XmlElement& limit); /** * Parse the tag. * * @param fileName Name of the configuration file. * * @return true if parsing was successful. */ bool ProcessListen(const qcc::String& fileName, const qcc::XmlElement& listen); /** * Parse the tag. * * @param fileName Name of the configuration file. * * @return true if parsing was successful. */ bool ProcessPidfile(const qcc::String& fileName, const qcc::XmlElement& pidfile); #ifdef ENABLE_POLICYDB /** * Parse the tag. * * @param fileName Name of the configuration file. * * @return true if parsing was successful. */ bool ProcessPolicy(const qcc::String& fileName, const qcc::XmlElement& policy); #endif /** * Parse the tag. * * @param fileName Name of the configuration file. * * @return true if parsing was successful. */ bool ProcessSyslog(const qcc::String& fileName, const qcc::XmlElement& syslog); /** * Parse the tag. * * @param fileName Name of the configuration file. * * @return true if parsing was successful. */ bool ProcessType(const qcc::String& fileName, const qcc::XmlElement& type); /** * Parse the tag. * * @param fileName Name of the configuration file. * * @return true if parsing was successful. */ bool ProcessUser(const qcc::String& fileName, const qcc::XmlElement& user); }; /** * Constructor. */ ConfigDB(); /** * Copy constructor. * ConfigDB may not be copy constructed. * * @param other sink being copied. */ ConfigDB(const ConfigDB& other); /** * Assignment operator. * ConfigDB may not be assigned. * * @param other RHS of assignment. */ ConfigDB& operator=(const ConfigDB& other); #ifdef ENABLE_POLICYDB void NameOwnerChanged(const qcc::String& alias, const qcc::String* oldOwner, SessionOpts::NameTransferType oldOwnerNameTransfer, const qcc::String* newOwner, SessionOpts::NameTransferType newOwnerNameTransfer); #endif const qcc::String defaultXml; /**< Default configuration. */ const qcc::String fileName; /**< Config file to read. */ DB* db; /**< The current config database storage object. */ bool stopping; static ConfigDB* singleton; mutable qcc::RWLock rwlock; }; } #endif alljoyn-15.04b/alljoyn_core/router/ConvertUTF.cc000066400000000000000000000532661255700255500216650ustar00rootroot00000000000000/* * Copyright 2001-2004 Unicode, Inc. * * Disclaimer * * This source code is provided as is by Unicode, Inc. No claims are * made as to fitness for any particular purpose. No warranties of any * kind are expressed or implied. The recipient agrees to determine * applicability of information provided. If this file has been * purchased on magnetic or optical media from Unicode, Inc., the * sole remedy for any claim will be exchange of defective media * within 90 days of receipt. * * Limitations on Rights to Redistribute This Code * * Unicode, Inc. hereby grants the right to freely use the information * supplied in this file in the creation of products supporting the * Unicode Standard, and to make copies of this file in any form * for internal or external distribution as long as this notice * remains attached. */ /* --------------------------------------------------------------------- Conversions between UTF32, UTF-16, and UTF-8. Source code file. Author: Mark E. Davis, 1994. Rev History: Rick McGowan, fixes & updates May 2001. Sept 2001: fixed const & error conditions per mods suggested by S. Parent & A. Lillich. June 2002: Tim Dodd added detection and handling of incomplete source sequences, enhanced error detection, added casts to eliminate compiler warnings. July 2003: slight mods to back out aggressive FFFE detection. Jan 2004: updated switches in from-UTF8 conversions. Oct 2004: updated to use UNI_MAX_LEGAL_UTF32 in UTF-32 conversions. See the header file "ConvertUTF.h" for complete documentation. ------------------------------------------------------------------------ */ #include "ConvertUTF.h" #ifdef CVTUTF_DEBUG #include #endif static const int halfShift = 10; /* used for shifting by 10 bits */ static const UTF32 halfBase = 0x0010000UL; static const UTF32 halfMask = 0x3FFUL; #define UNI_SUR_HIGH_START (UTF32)0xD800 #define UNI_SUR_HIGH_END (UTF32)0xDBFF #define UNI_SUR_LOW_START (UTF32)0xDC00 #define UNI_SUR_LOW_END (UTF32)0xDFFF #define false 0 #define true 1 /* --------------------------------------------------------------------- */ ConversionResult ConvertUTF32toUTF16( const UTF32** sourceStart, const UTF32* sourceEnd, UTF16** targetStart, UTF16* targetEnd, ConversionFlags flags) { ConversionResult result = conversionOK; const UTF32* source = *sourceStart; UTF16* target = *targetStart; while (source < sourceEnd) { UTF32 ch; if (target >= targetEnd) { result = targetExhausted; break; } ch = *source++; if (ch <= UNI_MAX_BMP) { /* Target is a character <= 0xFFFF */ /* UTF-16 surrogate values are illegal in UTF-32; 0xffff or 0xfffe are both reserved values */ if (ch >= UNI_SUR_HIGH_START && ch <= UNI_SUR_LOW_END) { if (flags == strictConversion) { --source; /* return to the illegal value itself */ result = sourceIllegal; break; } else { *target++ = UNI_REPLACEMENT_CHAR; } } else { *target++ = (UTF16)ch; /* normal case */ } } else if (ch > UNI_MAX_LEGAL_UTF32) { if (flags == strictConversion) { result = sourceIllegal; } else { *target++ = UNI_REPLACEMENT_CHAR; } } else { /* target is a character in range 0xFFFF - 0x10FFFF. */ if (target + 1 >= targetEnd) { --source; /* Back up source pointer! */ result = targetExhausted; break; } ch -= halfBase; *target++ = (UTF16)((ch >> halfShift) + UNI_SUR_HIGH_START); *target++ = (UTF16)((ch & halfMask) + UNI_SUR_LOW_START); } } *sourceStart = source; *targetStart = target; return result; } /* --------------------------------------------------------------------- */ ConversionResult ConvertUTF16toUTF32( const UTF16** sourceStart, const UTF16* sourceEnd, UTF32** targetStart, UTF32* targetEnd, ConversionFlags flags) { ConversionResult result = conversionOK; const UTF16* source = *sourceStart; UTF32* target = *targetStart; UTF32 ch, ch2; while (source < sourceEnd) { const UTF16* oldSource = source; /* In case we have to back up because of target overflow. */ ch = *source++; /* If we have a surrogate pair, convert to UTF32 first. */ if (ch >= UNI_SUR_HIGH_START && ch <= UNI_SUR_HIGH_END) { /* If the 16 bits following the high surrogate are in the source buffer... */ if (source < sourceEnd) { ch2 = *source; /* If it's a low surrogate, convert to UTF32. */ if (ch2 >= UNI_SUR_LOW_START && ch2 <= UNI_SUR_LOW_END) { ch = ((ch - UNI_SUR_HIGH_START) << halfShift) + (ch2 - UNI_SUR_LOW_START) + halfBase; ++source; } else if (flags == strictConversion) { /* it's an unpaired high surrogate */ --source; /* return to the illegal value itself */ result = sourceIllegal; break; } } else { /* We don't have the 16 bits following the high surrogate. */ --source; /* return to the high surrogate */ result = sourceExhausted; break; } } else if (flags == strictConversion) { /* UTF-16 surrogate values are illegal in UTF-32 */ if (ch >= UNI_SUR_LOW_START && ch <= UNI_SUR_LOW_END) { --source; /* return to the illegal value itself */ result = sourceIllegal; break; } } if (target >= targetEnd) { source = oldSource; /* Back up source pointer! */ result = targetExhausted; break; } *target++ = ch; } *sourceStart = source; *targetStart = target; #ifdef CVTUTF_DEBUG if (result == sourceIllegal) { fprintf(stderr, "ConvertUTF16toUTF32 illegal seq 0x%04x,%04x\n", ch, ch2); fflush(stderr); } #endif return result; } /* --------------------------------------------------------------------- */ /* * Index into the table below with the first byte of a UTF-8 sequence to * get the number of trailing bytes that are supposed to follow it. * Note that *legal* UTF-8 values can't have 4 or 5-bytes. The table is * left as-is for anyone who may want to do such conversion, which was * allowed in earlier algorithms. */ static const char trailingBytesForUTF8[256] = { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 2, 3, 3, 3, 3, 3, 3, 3, 3, 4, 4, 4, 4, 5, 5, 5, 5 }; /* * Magic values subtracted from a buffer value during UTF8 conversion. * This table contains as many values as there might be trailing bytes * in a UTF-8 sequence. */ static const UTF32 offsetsFromUTF8[6] = { 0x00000000UL, 0x00003080UL, 0x000E2080UL, 0x03C82080UL, 0xFA082080UL, 0x82082080UL }; /* * Once the bits are split out into bytes of UTF-8, this is a mask OR-ed * into the first byte, depending on how many bytes follow. There are * as many entries in this table as there are UTF-8 sequence types. * (I.e., one byte sequence, two byte... etc.). Remember that sequencs * for *legal* UTF-8 will be 4 or fewer bytes total. */ static const UTF8 firstByteMark[7] = { 0x00, 0x00, 0xC0, 0xE0, 0xF0, 0xF8, 0xFC }; /* --------------------------------------------------------------------- */ /* The interface converts a whole buffer to avoid function-call overhead. * Constants have been gathered. Loops & conditionals have been removed as * much as possible for efficiency, in favor of drop-through switches. * (See "Note A" at the bottom of the file for equivalent code.) * If your compiler supports it, the "isLegalUTF8" call can be turned * into an inline function. */ /* --------------------------------------------------------------------- */ ConversionResult ConvertUTF16toUTF8( const UTF16** sourceStart, const UTF16* sourceEnd, UTF8** targetStart, UTF8* targetEnd, ConversionFlags flags) { ConversionResult result = conversionOK; const UTF16* source = *sourceStart; UTF8* target = *targetStart; while (source < sourceEnd) { UTF32 ch; unsigned short bytesToWrite = 0; const UTF32 byteMask = 0xBF; const UTF32 byteMark = 0x80; const UTF16* oldSource = source; /* In case we have to back up because of target overflow. */ ch = *source++; /* If we have a surrogate pair, convert to UTF32 first. */ if (ch >= UNI_SUR_HIGH_START && ch <= UNI_SUR_HIGH_END) { /* If the 16 bits following the high surrogate are in the source buffer... */ if (source < sourceEnd) { UTF32 ch2 = *source; /* If it's a low surrogate, convert to UTF32. */ if (ch2 >= UNI_SUR_LOW_START && ch2 <= UNI_SUR_LOW_END) { ch = ((ch - UNI_SUR_HIGH_START) << halfShift) + (ch2 - UNI_SUR_LOW_START) + halfBase; ++source; } else if (flags == strictConversion) { /* it's an unpaired high surrogate */ --source; /* return to the illegal value itself */ result = sourceIllegal; break; } } else { /* We don't have the 16 bits following the high surrogate. */ --source; /* return to the high surrogate */ result = sourceExhausted; break; } } else if (flags == strictConversion) { /* UTF-16 surrogate values are illegal in UTF-32 */ if (ch >= UNI_SUR_LOW_START && ch <= UNI_SUR_LOW_END) { --source; /* return to the illegal value itself */ result = sourceIllegal; break; } } /* Figure out how many bytes the result will require */ if (ch < (UTF32)0x80) { bytesToWrite = 1; } else if (ch < (UTF32)0x800) { bytesToWrite = 2; } else if (ch < (UTF32)0x10000) { bytesToWrite = 3; } else if (ch < (UTF32)0x110000) { bytesToWrite = 4; } else { bytesToWrite = 3; ch = UNI_REPLACEMENT_CHAR; } target += bytesToWrite; if (target > targetEnd) { source = oldSource; /* Back up source pointer! */ target -= bytesToWrite; result = targetExhausted; break; } switch (bytesToWrite) { /* note: everything falls through. */ case 4: *--target = (UTF8)((ch | byteMark) & byteMask); ch >>= 6; case 3: *--target = (UTF8)((ch | byteMark) & byteMask); ch >>= 6; case 2: *--target = (UTF8)((ch | byteMark) & byteMask); ch >>= 6; case 1: *--target = (UTF8)(ch | firstByteMark[bytesToWrite]); } target += bytesToWrite; } *sourceStart = source; *targetStart = target; return result; } /* --------------------------------------------------------------------- */ /* * Utility routine to tell whether a sequence of bytes is legal UTF-8. * This must be called with the length pre-determined by the first byte. * If not calling this from ConvertUTF8to*, then the length can be set by: * length = trailingBytesForUTF8[*source]+1; * and the sequence is illegal right away if there aren't that many bytes * available. * If presented with a length > 4, this returns false. The Unicode * definition of UTF-8 goes up to 4-byte sequences. */ static Boolean isLegalUTF8(const UTF8*source, int length) { UTF8 a; const UTF8*srcptr = source + length; switch (length) { default: return false; /* Everything else falls through when "true"... */ case 4: if ((a = (*--srcptr)) < 0x80 || a > 0xBF) { return false; } case 3: if ((a = (*--srcptr)) < 0x80 || a > 0xBF) { return false; } case 2: if ((a = (*--srcptr)) > 0xBF) { return false; } switch (*source) { /* no fall-through in this inner switch */ case 0xE0: if (a < 0xA0) { return false; } break; case 0xED: if (a > 0x9F) { return false; } break; case 0xF0: if (a < 0x90) { return false; } break; case 0xF4: if (a > 0x8F) { return false; } break; default: if (a < 0x80) { return false; } } case 1: if (*source >= 0x80 && *source < 0xC2) { return false; } } if (*source > 0xF4) { return false; } return true; } /* --------------------------------------------------------------------- */ /* * Exported function to return whether a UTF-8 sequence is legal or not. * This is not used here; it's just exported. */ Boolean isLegalUTF8Sequence(const UTF8*source, const UTF8*sourceEnd) { int length = trailingBytesForUTF8[*source] + 1; if (source + length > sourceEnd) { return false; } return isLegalUTF8(source, length); } /* --------------------------------------------------------------------- */ ConversionResult ConvertUTF8toUTF16( const UTF8** sourceStart, const UTF8* sourceEnd, UTF16** targetStart, UTF16* targetEnd, ConversionFlags flags) { ConversionResult result = conversionOK; const UTF8* source = *sourceStart; UTF16* target = *targetStart; while (source < sourceEnd) { UTF32 ch = 0; unsigned short extraBytesToRead = trailingBytesForUTF8[*source]; if (source + extraBytesToRead >= sourceEnd) { result = sourceExhausted; break; } /* Do this check whether lenient or strict */ if (!isLegalUTF8(source, extraBytesToRead + 1)) { result = sourceIllegal; break; } /* * The cases all fall through. See "Note A" below. */ switch (extraBytesToRead) { case 5: ch += *source++; ch <<= 6; /* remember, illegal UTF-8 */ case 4: ch += *source++; ch <<= 6; /* remember, illegal UTF-8 */ case 3: ch += *source++; ch <<= 6; case 2: ch += *source++; ch <<= 6; case 1: ch += *source++; ch <<= 6; case 0: ch += *source++; } ch -= offsetsFromUTF8[extraBytesToRead]; if (target >= targetEnd) { source -= (extraBytesToRead + 1); /* Back up source pointer! */ result = targetExhausted; break; } if (ch <= UNI_MAX_BMP) { /* Target is a character <= 0xFFFF */ /* UTF-16 surrogate values are illegal in UTF-32 */ if (ch >= UNI_SUR_HIGH_START && ch <= UNI_SUR_LOW_END) { if (flags == strictConversion) { source -= (extraBytesToRead + 1); /* return to the illegal value itself */ result = sourceIllegal; break; } else { *target++ = UNI_REPLACEMENT_CHAR; } } else { *target++ = (UTF16)ch; /* normal case */ } } else if (ch > UNI_MAX_UTF16) { if (flags == strictConversion) { result = sourceIllegal; source -= (extraBytesToRead + 1); /* return to the start */ break; /* Bail out; shouldn't continue */ } else { *target++ = UNI_REPLACEMENT_CHAR; } } else { /* target is a character in range 0xFFFF - 0x10FFFF. */ if (target + 1 >= targetEnd) { source -= (extraBytesToRead + 1); /* Back up source pointer! */ result = targetExhausted; break; } ch -= halfBase; *target++ = (UTF16)((ch >> halfShift) + UNI_SUR_HIGH_START); *target++ = (UTF16)((ch & halfMask) + UNI_SUR_LOW_START); } } *sourceStart = source; *targetStart = target; return result; } /* --------------------------------------------------------------------- */ ConversionResult ConvertUTF32toUTF8( const UTF32** sourceStart, const UTF32* sourceEnd, UTF8** targetStart, UTF8* targetEnd, ConversionFlags flags) { ConversionResult result = conversionOK; const UTF32* source = *sourceStart; UTF8* target = *targetStart; while (source < sourceEnd) { UTF32 ch; unsigned short bytesToWrite = 0; const UTF32 byteMask = 0xBF; const UTF32 byteMark = 0x80; ch = *source++; if (flags == strictConversion) { /* UTF-16 surrogate values are illegal in UTF-32 */ if (ch >= UNI_SUR_HIGH_START && ch <= UNI_SUR_LOW_END) { --source; /* return to the illegal value itself */ result = sourceIllegal; break; } } /* * Figure out how many bytes the result will require. Turn any * illegally large UTF32 things (> Plane 17) into replacement chars. */ if (ch < (UTF32)0x80) { bytesToWrite = 1; } else if (ch < (UTF32)0x800) { bytesToWrite = 2; } else if (ch < (UTF32)0x10000) { bytesToWrite = 3; } else if (ch <= UNI_MAX_LEGAL_UTF32) { bytesToWrite = 4; } else { bytesToWrite = 3; ch = UNI_REPLACEMENT_CHAR; result = sourceIllegal; } target += bytesToWrite; if (target > targetEnd) { --source; /* Back up source pointer! */ target -= bytesToWrite; result = targetExhausted; break; } switch (bytesToWrite) { /* note: everything falls through. */ case 4: *--target = (UTF8)((ch | byteMark) & byteMask); ch >>= 6; case 3: *--target = (UTF8)((ch | byteMark) & byteMask); ch >>= 6; case 2: *--target = (UTF8)((ch | byteMark) & byteMask); ch >>= 6; case 1: *--target = (UTF8) (ch | firstByteMark[bytesToWrite]); } target += bytesToWrite; } *sourceStart = source; *targetStart = target; return result; } /* --------------------------------------------------------------------- */ ConversionResult ConvertUTF8toUTF32( const UTF8** sourceStart, const UTF8* sourceEnd, UTF32** targetStart, UTF32* targetEnd, ConversionFlags flags) { ConversionResult result = conversionOK; const UTF8* source = *sourceStart; UTF32* target = *targetStart; while (source < sourceEnd) { UTF32 ch = 0; unsigned short extraBytesToRead = trailingBytesForUTF8[*source]; if (source + extraBytesToRead >= sourceEnd) { result = sourceExhausted; break; } /* Do this check whether lenient or strict */ if (!isLegalUTF8(source, extraBytesToRead + 1)) { result = sourceIllegal; break; } /* * The cases all fall through. See "Note A" below. */ switch (extraBytesToRead) { case 5: ch += *source++; ch <<= 6; case 4: ch += *source++; ch <<= 6; case 3: ch += *source++; ch <<= 6; case 2: ch += *source++; ch <<= 6; case 1: ch += *source++; ch <<= 6; case 0: ch += *source++; } ch -= offsetsFromUTF8[extraBytesToRead]; if (target >= targetEnd) { source -= (extraBytesToRead + 1); /* Back up the source pointer! */ result = targetExhausted; break; } if (ch <= UNI_MAX_LEGAL_UTF32) { /* * UTF-16 surrogate values are illegal in UTF-32, and anything * over Plane 17 (> 0x10FFFF) is illegal. */ if (ch >= UNI_SUR_HIGH_START && ch <= UNI_SUR_LOW_END) { if (flags == strictConversion) { source -= (extraBytesToRead + 1); /* return to the illegal value itself */ result = sourceIllegal; break; } else { *target++ = UNI_REPLACEMENT_CHAR; } } else { *target++ = ch; } } else { /* i.e., ch > UNI_MAX_LEGAL_UTF32 */ result = sourceIllegal; *target++ = UNI_REPLACEMENT_CHAR; } } *sourceStart = source; *targetStart = target; return result; } /* --------------------------------------------------------------------- Note A. The fall-through switches in UTF-8 reading code save a temp variable, some decrements & conditionals. The switches are equivalent to the following loop: { int tmpBytesToRead = extraBytesToRead+1; do { ch += *source++; --tmpBytesToRead; if (tmpBytesToRead) ch <<= 6; } while (tmpBytesToRead > 0); } In UTF-8 writing code, the switches on "bytesToWrite" are similarly unrolled loops. --------------------------------------------------------------------- */ alljoyn-15.04b/alljoyn_core/router/ConvertUTF.h000066400000000000000000000144421255700255500215200ustar00rootroot00000000000000#ifndef _CONVERTUTF_H #define _CONVERTUTF_H /* * Copyright 2001-2004 Unicode, Inc. * * Disclaimer * * This source code is provided as is by Unicode, Inc. No claims are * made as to fitness for any particular purpose. No warranties of any * kind are expressed or implied. The recipient agrees to determine * applicability of information provided. If this file has been * purchased on magnetic or optical media from Unicode, Inc., the * sole remedy for any claim will be exchange of defective media * within 90 days of receipt. * * Limitations on Rights to Redistribute This Code * * Unicode, Inc. hereby grants the right to freely use the information * supplied in this file in the creation of products supporting the * Unicode Standard, and to make copies of this file in any form * for internal or external distribution as long as this notice * remains attached. */ /* --------------------------------------------------------------------- Conversions between UTF32, UTF-16, and UTF-8. Header file. Several funtions are included here, forming a complete set of conversions between the three formats. UTF-7 is not included here, but is handled in a separate source file. Each of these routines takes pointers to input buffers and output buffers. The input buffers are const. Each routine converts the text between *sourceStart and sourceEnd, putting the result into the buffer between *targetStart and targetEnd. Note: the end pointers are *after* the last item: e.g. *(sourceEnd - 1) is the last item. The return result indicates whether the conversion was successful, and if not, whether the problem was in the source or target buffers. (Only the first encountered problem is indicated.) After the conversion, *sourceStart and *targetStart are both updated to point to the end of last text successfully converted in the respective buffers. Input parameters: sourceStart - pointer to a pointer to the source buffer. The contents of this are modified on return so that it points at the next thing to be converted. targetStart - similarly, pointer to pointer to the target buffer. sourceEnd, targetEnd - respectively pointers to the ends of the two buffers, for overflow checking only. These conversion functions take a ConversionFlags argument. When this flag is set to strict, both irregular sequences and isolated surrogates will cause an error. When the flag is set to lenient, both irregular sequences and isolated surrogates are converted. Whether the flag is strict or lenient, all illegal sequences will cause an error return. This includes sequences such as: , , or in UTF-8, and values above 0x10FFFF in UTF-32. Conformant code must check for illegal sequences. When the flag is set to lenient, characters over 0x10FFFF are converted to the replacement character; otherwise (when the flag is set to strict) they constitute an error. Output parameters: The value "sourceIllegal" is returned from some routines if the input sequence is malformed. When "sourceIllegal" is returned, the source value will point to the illegal value that caused the problem. E.g., in UTF-8 when a sequence is malformed, it points to the start of the malformed sequence. Author: Mark E. Davis, 1994. Rev History: Rick McGowan, fixes & updates May 2001. Fixes & updates, Sept 2001. ------------------------------------------------------------------------ */ /* --------------------------------------------------------------------- The following 4 definitions are compiler-specific. The C standard does not guarantee that wchar_t has at least 16 bits, so wchar_t is no less portable than unsigned short! All should be unsigned values to avoid sign extension during bit mask & shift operations. ------------------------------------------------------------------------ */ /* Define The Unicode basics types in terms used by SPLICE. typedef uint32_t UTF32; at least 32 bits typedef uint16_t UTF16; at least 16 bits typedef uint8_t UTF8; typically 8 bits typedef uint8_t Boolean; 0 or 1 */ typedef unsigned long UTF32; /* at least 32 bits */ typedef unsigned short UTF16; /* at least 16 bits */ typedef unsigned char UTF8; /* typically 8 bits */ typedef unsigned char Boolean; /* 0 or 1 */ /* Some fundamental constants */ #define UNI_REPLACEMENT_CHAR (UTF32)0x0000FFFD #define UNI_MAX_BMP (UTF32)0x0000FFFF #define UNI_MAX_UTF16 (UTF32)0x0010FFFF #define UNI_MAX_UTF32 (UTF32)0x7FFFFFFF #define UNI_MAX_LEGAL_UTF32 (UTF32)0x0010FFFF typedef enum { conversionOK, /* conversion successful */ sourceExhausted, /* partial character in source, but hit end */ targetExhausted, /* insuff. room in target for conversion */ sourceIllegal /* source sequence is illegal/malformed */ } ConversionResult; typedef enum { strictConversion = 0, lenientConversion } ConversionFlags; /* This is for C++ and does no harm in C */ #ifdef __cplusplus extern "C" { #endif ConversionResult ConvertUTF8toUTF16( const UTF8** sourceStart, const UTF8* sourceEnd, UTF16** targetStart, UTF16* targetEnd, ConversionFlags flags); ConversionResult ConvertUTF16toUTF8( const UTF16** sourceStart, const UTF16* sourceEnd, UTF8** targetStart, UTF8* targetEnd, ConversionFlags flags); ConversionResult ConvertUTF8toUTF32( const UTF8** sourceStart, const UTF8* sourceEnd, UTF32** targetStart, UTF32* targetEnd, ConversionFlags flags); ConversionResult ConvertUTF32toUTF8( const UTF32** sourceStart, const UTF32* sourceEnd, UTF8** targetStart, UTF8* targetEnd, ConversionFlags flags); ConversionResult ConvertUTF16toUTF32( const UTF16** sourceStart, const UTF16* sourceEnd, UTF32** targetStart, UTF32* targetEnd, ConversionFlags flags); ConversionResult ConvertUTF32toUTF16( const UTF32** sourceStart, const UTF32* sourceEnd, UTF16** targetStart, UTF16* targetEnd, ConversionFlags flags); Boolean isLegalUTF8Sequence(const UTF8*source, const UTF8*sourceEnd); #ifdef __cplusplus } #endif /* --------------------------------------------------------------------- */ #endif alljoyn-15.04b/alljoyn_core/router/DBusObj.cc000066400000000000000000000510731255700255500211500ustar00rootroot00000000000000/** * @file * * This file implements the standard DBus interfaces */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #include #include #include #include #include #include "Bus.h" #include "BusController.h" #include "BusInternal.h" #include "BusUtil.h" #include "ConfigDB.h" #include "DBusObj.h" #include "NameTable.h" #ifdef ENABLE_POLICYDB #include "PolicyDB.h" #endif #define QCC_MODULE "ALLJOYN" using namespace std; using namespace qcc; #define MethodHander(a) static_cast(a) namespace ajn { DBusObj::DBusObj(Bus& bus, BusController* busController) : BusObject(org::freedesktop::DBus::ObjectPath, false), bus(bus), router(reinterpret_cast(bus.GetInternal().GetRouter())), dbusIntf(NULL), busController(busController) { } DBusObj::~DBusObj() { bus.UnregisterBusObject(*this); router.RemoveBusNameListener(this); } QStatus DBusObj::Init() { QStatus status; /* Make this object implement org.freedesktop.DBus */ dbusIntf = bus.GetInterface(org::freedesktop::DBus::InterfaceName); if (!dbusIntf) { status = ER_BUS_NO_SUCH_INTERFACE; QCC_LogError(status, ("Failed to get %s interface", org::freedesktop::DBus::InterfaceName)); return status; } /* Hook up the methods to their handlers */ AddInterface(*dbusIntf); const MethodEntry methodEntries[] = { { dbusIntf->GetMember("ListNames"), MethodHander(&DBusObj::ListNames) }, { dbusIntf->GetMember("ListActivatableNames"), MethodHander(&DBusObj::ListActivatableNames) }, { dbusIntf->GetMember("RequestName"), MethodHander(&DBusObj::RequestName) }, { dbusIntf->GetMember("ReleaseName"), MethodHander(&DBusObj::ReleaseName) }, { dbusIntf->GetMember("NameHasOwner"), MethodHander(&DBusObj::NameHasOwner) }, { dbusIntf->GetMember("StartServiceByName"), MethodHander(&DBusObj::StartServiceByName) }, { dbusIntf->GetMember("GetNameOwner"), MethodHander(&DBusObj::GetNameOwner) }, { dbusIntf->GetMember("GetConnectionUnixUser"), MethodHander(&DBusObj::GetConnectionUnixUser) }, { dbusIntf->GetMember("GetConnectionUnixProcessID"), MethodHander(&DBusObj::GetConnectionUnixProcessID) }, { dbusIntf->GetMember("AddMatch"), MethodHander(&DBusObj::AddMatch) }, { dbusIntf->GetMember("RemoveMatch"), MethodHander(&DBusObj::RemoveMatch) }, { dbusIntf->GetMember("GetId"), MethodHander(&DBusObj::GetId) }, { dbusIntf->GetMember("UpdateActivationEnvironment"), MethodHander(&DBusObj::UpdateActivationEnvironment) }, { dbusIntf->GetMember("ListQueuedOwners"), MethodHander(&DBusObj::ListQueuedOwners) }, { dbusIntf->GetMember("GetAdtAuditSessionData"), MethodHander(&DBusObj::GetAdtAuditSessionData) }, { dbusIntf->GetMember("GetConnectionSELinuxSecurityContext"), MethodHander(&DBusObj::GetConnectionSELinuxSecurityContext) }, { dbusIntf->GetMember("ReloadConfig"), MethodHander(&DBusObj::ReloadConfig) } }; status = AddMethodHandlers(methodEntries, ArraySize(methodEntries)); if (ER_OK != status) { QCC_LogError(status, ("AddMethods failed")); } /* Listen for changes to the name table and register object */ if (ER_OK == status) { router.AddBusNameListener(this); status = bus.RegisterBusObject(*this); } return status; } void DBusObj::ObjectRegistered() { /* Acquire org.freedesktop.DBus name (locally) */ uint32_t disposition = DBUS_REQUEST_NAME_REPLY_EXISTS; QStatus status = router.AddAlias(org::freedesktop::DBus::WellKnownName, bus.GetInternal().GetLocalEndpoint()->GetUniqueName(), DBUS_NAME_FLAG_DO_NOT_QUEUE, disposition, NULL, NULL); if ((ER_OK != status) || (DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER != disposition)) { status = (ER_OK == status) ? ER_FAIL : status; QCC_LogError(status, ("Failed to register well-known name \"%s\" (disposition=%d)", org::freedesktop::DBus::WellKnownName, disposition)); } if (status == ER_OK) { BusObject::ObjectRegistered(); busController->ObjectRegistered(this); } } void DBusObj::ListNames(const InterfaceDescription::Member* member, Message& msg) { QCC_UNUSED(member); /* Get the name list */ vector namesVec; router.GetBusNames(namesVec); /* Send the response */ size_t numNames = namesVec.size(); MsgArg* names = new MsgArg[numNames]; vector::const_iterator it = namesVec.begin(); size_t i = 0; while (it != namesVec.end()) { names[i].typeId = ALLJOYN_STRING; names[i].v_string.str = it->c_str(); names[i].v_string.len = it->size(); ++it; ++i; } MsgArg namesArray(ALLJOYN_ARRAY); namesArray.v_array.SetElements("s", numNames, names); QStatus status = MethodReply(msg, &namesArray, 1); if (ER_OK != status) { QCC_LogError(status, ("DBusObj::ListNames failed")); } } void DBusObj::ListActivatableNames(const InterfaceDescription::Member* member, Message& msg) { QCC_UNUSED(member); MsgArg namesArray(ALLJOYN_ARRAY); namesArray.v_array.SetElements("s", 0, NULL); QStatus status = MethodReply(msg, &namesArray, 1); if (ER_OK != status) { QCC_LogError(status, ("DBusObj::ListActivatableNames failed")); } } void DBusObj::NameHasOwner(const InterfaceDescription::Member* member, Message& msg) { QCC_UNUSED(member); QStatus status; MsgArg boolArg = MsgArg(ALLJOYN_BOOLEAN); /* Get the name */ const MsgArg* nameArg = msg->GetArg(0); assert(nameArg && (ALLJOYN_STRING == nameArg->typeId)); /* Find name */ boolArg.v_bool = router.FindEndpoint(nameArg->v_string.str)->IsValid(); /* Send the response */ status = MethodReply(msg, &boolArg, 1); if (ER_OK != status) { QCC_LogError(status, ("DBusObj::NameHasOwner failed")); } } void DBusObj::RequestName(const InterfaceDescription::Member* member, Message& msg) { QCC_UNUSED(member); QStatus status; void* context = (void*) &msg; const char* nameArg = msg->GetArg(0)->v_string.str; const uint32_t flagsArg = msg->GetArg(1)->v_uint32; #ifdef ENABLE_POLICYDB PolicyDB policyDB = ConfigDB::GetConfigDB()->GetPolicyDB(); String sender = msg->GetSender(); BusEndpoint ep = router.FindEndpoint(sender); if (*nameArg != ':' && IsLegalBusName(nameArg) && policyDB->OKToOwn(nameArg, ep)) { #else if (*nameArg != ':' && IsLegalBusName(nameArg)) { #endif /* Attempt to add the alias */ /* Response will be handled in AddAliasCB */ uint32_t disposition; status = router.AddAlias(nameArg, msg->GetSender(), flagsArg, disposition, this, context); if (ER_OK != status) { QCC_LogError(status, ("Router::AddAlias failed")); MethodReply(msg, "FAILURE"); } } else { qcc::String errMsg("\""); errMsg += "Request for invalid busname, \""; errMsg += nameArg; errMsg += "\", not allowed."; MethodReply(msg, "org.freedesktop.DBus.Error.InvalidArgs", errMsg.c_str()); } } void DBusObj::ReleaseName(const InterfaceDescription::Member* member, Message& msg) { QCC_UNUSED(member); void* context = (void*) &msg; const MsgArg* nameArg = msg->GetArg(0); assert(nameArg && (ALLJOYN_STRING == nameArg->typeId)); /* Attempt to remove the alias */ uint32_t disposition; router.RemoveAlias(nameArg->v_string.str, msg->GetSender(), disposition, this, context); } void DBusObj::StartServiceByName(const InterfaceDescription::Member* member, Message& msg) { QCC_UNUSED(member); qcc::String description("Unable to start service: "); description += msg->GetDestination(); description += "("; description += QCC_StatusText(ER_NOT_IMPLEMENTED); description += ")"; MethodReply(msg, "org.freedesktop.DBus.Error.Spawn.Failed", description.c_str()); } void DBusObj::GetNameOwner(const InterfaceDescription::Member* member, Message& msg) { QCC_UNUSED(member); QStatus status; const MsgArg* nameArg = msg->GetArg(0); BusEndpoint ep = router.FindEndpoint(nameArg->v_string.str); if (!ep->IsValid()) { status = MethodReply(msg, "org.freedesktop.DBus.Error.NameHasNoOwner"); } else { MsgArg replyArg(ALLJOYN_STRING); const qcc::String& uniqueName = ep->GetUniqueName(); replyArg.v_string.str = uniqueName.c_str(); replyArg.v_string.len = uniqueName.size(); status = MethodReply(msg, &replyArg, 1); } /* Log any error */ if (ER_OK != status) { QCC_LogError(status, ("DBusObj::GetNameOwner failed")); } } void DBusObj::GetConnectionUnixUser(const InterfaceDescription::Member* member, Message& msg) { QCC_UNUSED(member); QStatus status; const MsgArg* nameArg = msg->GetArg(0); BusEndpoint ep = router.FindEndpoint(nameArg->v_string.str); if (!ep->IsValid()) { status = MethodReply(msg, "org.freedesktop.DBus.Error.NameHasNoOwner"); } else { if (ep->SupportsUnixIDs()) { MsgArg rsp("u", ep->GetUserId()); status = MethodReply(msg, &rsp, 1); } else { status = MethodReply(msg, "org.freedestop.DBus.Error.Failed"); } } /* Log any error */ if (ER_OK != status) { QCC_LogError(status, ("DBusObj::GetConnectionUnixUser failed")); } } void DBusObj::GetConnectionUnixProcessID(const InterfaceDescription::Member* member, Message& msg) { QCC_UNUSED(member); QStatus status; const MsgArg* nameArg = msg->GetArg(0); BusEndpoint ep = router.FindEndpoint(nameArg->v_string.str); if (!ep->IsValid()) { status = MethodReply(msg, "org.freedesktop.DBus.Error.NameHasNoOwner"); } else { if (ep->SupportsUnixIDs()) { MsgArg rsp("u", ep->GetProcessId()); status = MethodReply(msg, &rsp, 1); } else { status = MethodReply(msg, "org.freedestop.DBus.Error.Failed"); } } /* Log any error */ if (ER_OK != status) { QCC_LogError(status, ("DBusObj::GetConnectionUnixProcessID failed")); } } void DBusObj::AddMatch(const InterfaceDescription::Member* member, Message& msg) { QCC_UNUSED(member); QStatus status; const MsgArg* nameArg = msg->GetArg(0); assert(nameArg && (nameArg->typeId == ALLJOYN_STRING)); Rule rule(nameArg->v_string.str, &status); if (ER_OK == status) { BusEndpoint ep = router.FindEndpoint(msg->GetSender()); if (ep->IsValid()) { status = router.AddRule(ep, rule); } else { status = ER_BUS_NO_ENDPOINT; } } if (ER_OK == status) { status = MethodReply(msg, (const MsgArg*) NULL, 0); } else { QCC_LogError(status, ("AddMatch failed")); status = MethodReply(msg, "org.freedesktop.DBus.Error.OOM", QCC_StatusText(status)); } } void DBusObj::RemoveMatch(const InterfaceDescription::Member* member, Message& msg) { QCC_UNUSED(member); QStatus status; const MsgArg* nameArg = msg->GetArg(0); assert(nameArg && (nameArg->typeId == ALLJOYN_STRING)); Rule rule(nameArg->v_string.str, &status); if (ER_OK == status) { BusEndpoint ep = router.FindEndpoint(msg->GetSender()); if (ep->IsValid()) { status = router.RemoveRule(ep, rule); } else { status = ER_BUS_NO_ENDPOINT; } } if (ER_OK == status) { status = MethodReply(msg, (const MsgArg*)NULL, 0); } else { QCC_DbgTrace(("RemoveMatch failed with %s", QCC_StatusText(status))); status = MethodReply(msg, "org.freedesktop.DBus.Error.MatchRuleNotFound", QCC_StatusText(status)); } } void DBusObj::GetId(const InterfaceDescription::Member* member, Message& msg) { QCC_UNUSED(member); MsgArg replyArg(ALLJOYN_STRING); const qcc::String& guid = bus.GetInternal().GetGlobalGUID().ToString(); replyArg.v_string.str = guid.c_str(); replyArg.v_string.len = guid.size(); QStatus status = MethodReply(msg, &replyArg, 1); if (ER_OK != status) { QCC_LogError(status, ("GetId failed")); } } void DBusObj::UpdateActivationEnvironment(const InterfaceDescription::Member* member, Message& msg) { QCC_UNUSED(member); // TODO: Implement me. QStatus status = MethodReply(msg, "org.freedesktop.DBus.Error.NotSupported", NULL); if (ER_OK != status) { QCC_LogError(status, ("Reply failed")); } } void DBusObj::ListQueuedOwners(const InterfaceDescription::Member* member, Message& msg) { QCC_UNUSED(member); const MsgArg* nameArg = msg->GetArg(0); assert(nameArg && (ALLJOYN_STRING == nameArg->typeId)); vector namesVec; router.GetQueuedNames(nameArg->v_string.str, namesVec); /* Send the response */ /* * The first name in the list returned by the GetQueuedNames is the primary * owner. ListQueuedNames returns a list of queued secondary owners. * The messaged returned by org.freedesktop.DBus.ListQueuedOwners should * only send a list of secondary owners. */ size_t numNames = namesVec.size(); if (numNames > 0) { --numNames; } MsgArg* names = new MsgArg[numNames]; vector::const_iterator it = namesVec.begin(); size_t i = 0; if (it != namesVec.end()) { ++it; //skip the first Queued Name it is the primary owner. while (it != namesVec.end()) { names[i].typeId = ALLJOYN_STRING; names[i].v_string.str = it->c_str(); names[i].v_string.len = it->size(); ++it; ++i; } } MsgArg namesArray(ALLJOYN_ARRAY); namesArray.v_array.SetElements("s", numNames, names); /* Call Stabilize so that the names array can be deleted */ namesArray.Stabilize(); delete [] names; QStatus status = MethodReply(msg, &namesArray, 1); if (ER_OK != status) { QCC_LogError(status, ("DBusObj::ListQueuedOwners failed")); } } void DBusObj::GetAdtAuditSessionData(const InterfaceDescription::Member* member, Message& msg) { QCC_UNUSED(member); // TODO: Implement me. QStatus status = MethodReply(msg, "org.freedesktop.DBus.Error.NotSupported", NULL); if (ER_OK != status) { QCC_LogError(status, ("Reply failed")); } } void DBusObj::GetConnectionSELinuxSecurityContext(const InterfaceDescription::Member* member, Message& msg) { QCC_UNUSED(member); // TODO: Implement me. QStatus status = MethodReply(msg, "org.freedesktop.DBus.Error.NotSupported", NULL); if (ER_OK != status) { QCC_LogError(status, ("Reply failed")); } } void DBusObj::ReloadConfig(const InterfaceDescription::Member* member, Message& msg) { QCC_UNUSED(member); MethodReply(msg, "org.freedesktop.DBus.Error.Failed"); } void DBusObj::AddAliasComplete(const qcc::String& aliasName, uint32_t disposition, void* context) { QCC_UNUSED(aliasName); assert(context); Message* msg = (Message*) context; MsgArg replyArg(ALLJOYN_UINT32); replyArg.v_uint32 = (uint32_t) disposition; QStatus status = MethodReply(*msg, &replyArg, 1); if (ER_OK != status) { QCC_LogError(status, ("Failed to send RequestName reply")); } } void DBusObj::RemoveAliasComplete(const qcc::String& aliasName, uint32_t disposition, void* context) { QCC_UNUSED(aliasName); assert(context); Message* msg = (Message*) context; MsgArg replyArg(ALLJOYN_UINT32); replyArg.v_uint32 = (uint32_t)disposition; QStatus status = MethodReply(*msg, &replyArg, 1); if (ER_OK != status) { QCC_LogError(status, ("Failed to send ReleaseName reply")); } } void DBusObj::NameOwnerChanged(const qcc::String& alias, const qcc::String* oldOwner, SessionOpts::NameTransferType oldOwnerNameTransfer, const qcc::String* newOwner, SessionOpts::NameTransferType newOwnerNameTransfer) { QStatus status; const qcc::String& shortGuidStr = bus.GetInternal().GetGlobalGUID().ToShortString(); /* Silently ignore addition of reserved bus names */ if (!dbusIntf || (0 == strcmp(alias.c_str(), org::alljoyn::Bus::WellKnownName)) || (0 == strcmp(alias.c_str(), org::freedesktop::DBus::WellKnownName))) { return; } MsgArg aliasArg(ALLJOYN_STRING); aliasArg.v_string.str = alias.c_str(); aliasArg.v_string.len = alias.size(); /* When newOwner and oldOwner are the same, only the name transfer changed. */ if (newOwner != oldOwner) { /* Send a NameLost signal if necessary */ /* Don't send lost signal for a lost unique name since the endpoint is already gone */ if (oldOwner && !oldOwner->empty() && (alias[0] != ':') && (0 == ::strncmp(oldOwner->c_str() + 1, shortGuidStr.c_str(), shortGuidStr.size()))) { const InterfaceDescription::Member* nameLost = dbusIntf->GetMember("NameLost"); assert(nameLost); status = Signal(oldOwner->c_str(), 0, *nameLost, &aliasArg, 1); if (ER_OK != status) { QCC_DbgPrintf(("Failed to send NameLost signal for %s to %s (%s)", alias.c_str(), oldOwner->c_str(), QCC_StatusText(status))); } } /* Send a NameAcquired signal if necessary */ if (newOwner && !newOwner->empty() && (0 == ::strncmp(newOwner->c_str() + 1, shortGuidStr.c_str(), shortGuidStr.size()))) { const InterfaceDescription::Member* nameAcquired = dbusIntf->GetMember("NameAcquired"); assert(nameAcquired); status = Signal(newOwner->c_str(), 0, *nameAcquired, &aliasArg, 1); if (ER_OK != status) { QCC_DbgPrintf(("Failed to send NameAcquired signal for %s to %s (%s)", alias.c_str(), newOwner->c_str(), QCC_StatusText(status))); } } } /* Send NameOwnerChanged signal */ if ((oldOwner && SessionOpts::SLS_NAMES != oldOwnerNameTransfer) || (newOwner && SessionOpts::SLS_NAMES != newOwnerNameTransfer)) { MsgArg ownerChangedArgs[3]; size_t numArgs = ArraySize(ownerChangedArgs); MsgArg::Set(ownerChangedArgs, numArgs, "sss", alias.c_str(), (oldOwner && SessionOpts::SLS_NAMES != oldOwnerNameTransfer) ? oldOwner->c_str() : "", (newOwner && SessionOpts::SLS_NAMES != newOwnerNameTransfer) ? newOwner->c_str() : ""); const InterfaceDescription::Member* nameOwnerChanged = dbusIntf->GetMember("NameOwnerChanged"); assert(nameOwnerChanged); status = Signal(NULL, 0, *nameOwnerChanged, ownerChangedArgs, numArgs); if (status != ER_OK) { QCC_DbgPrintf(("Failed to send NameOwnerChanged signal for %s to %s (%s)", alias.c_str(), newOwner ? newOwner->c_str() : "", QCC_StatusText(status))); } } } } alljoyn-15.04b/alljoyn_core/router/DBusObj.h000066400000000000000000000201511255700255500210030ustar00rootroot00000000000000/** * @file * BusObject responsible for implementing the standard DBus methods (org.freedesktop.DBus.*) * for messages directed to the bus. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_DBUSOBJ_H #define _ALLJOYN_DBUSOBJ_H #include #include #include #include #include "Bus.h" #include "DaemonRouter.h" #include "NameTable.h" namespace ajn { /** Forward Declaration */ class BusController; /** * BusObject responsible for implementing the standard DBus methods (org.freedesktop.DBus.*) * for messages directed to the bus. */ class DBusObj : public BusObject, public NameListener { public: /** * Constructor * * @param bus The bus instance * @param router The DaemonRouter associated with the bus. * @param busController Controller that created this object. */ DBusObj(Bus& bus, BusController* busController); /** * Destructor */ ~DBusObj(); /** * Initialize and register this DBusObj instance. * * @return ER_OK if successful. */ QStatus Init(); /** * Stop DBusObj. * * @return ER_OK if successful. */ QStatus Stop() { return ER_OK; } /** * Join DBusObj. * * @return ER_OK if successful. */ QStatus Join() { return ER_OK; } /** * Called when object is successfully registered. */ void ObjectRegistered(void); void NameOwnerChanged(const qcc::String& alias, const qcc::String* oldOwner, SessionOpts::NameTransferType oldOwnerNameTransfer, const qcc::String* newOwner, SessionOpts::NameTransferType newOwnerNameTransfer); /** * Respond to a bus request for the list of registered bus names (both unique and well-known). * * @param member Member. * @param msg The incoming message. */ void ListNames(const InterfaceDescription::Member* member, Message& msg); /** * Respond to a bus request for the list of activatable bus names. * * @param member Member. * @param msg The incoming message. */ void ListActivatableNames(const InterfaceDescription::Member* member, Message& msg); /** * Determine whether a given bus name is registered (owned). * * @param member Member. * @param msg The incoming message. */ void NameHasOwner(const InterfaceDescription::Member* member, Message& msg); /** * Return the unique name of the endpoint that owns the given well-known name. * * @param member Member. * @param msg The incoming message. */ void GetNameOwner(const InterfaceDescription::Member* member, Message& msg); /** * Respond to a bus request to reserve a bus name * * @param member Member. * @param msg The incoming message. */ void RequestName(const InterfaceDescription::Member* member, Message& msg); /** * Respond to a bus request to release a bus name * * @param member Member. * @param msg The incoming message. */ void ReleaseName(const InterfaceDescription::Member* member, Message& msg); /** * Respond to a bus request to start a service. * * @param member Member. * @param msg The incoming message. */ void StartServiceByName(const InterfaceDescription::Member* member, Message& msg); /** * Respond to a bus request to get the unix user id of the process associated with an endpoint. * * @param member Member. * @param msg The incoming message. */ void GetConnectionUnixUser(const InterfaceDescription::Member* member, Message& msg); /** * Respond to a bus request to get the process id of the process associated with an endpoint. * * @param member Member. * @param msg The incoming message. */ void GetConnectionUnixProcessID(const InterfaceDescription::Member* member, Message& msg); /** * Respond to a bus request to add a bus routing rule. * * @param member Member. * @param msg The incoming message. */ void AddMatch(const InterfaceDescription::Member* member, Message& msg); /** * Respond to a bus request to remove a bus routing rule. * * @param member Member. * @param msg The incoming message. */ void RemoveMatch(const InterfaceDescription::Member* member, Message& msg); /** * Respond to a bus request to get the global (for all transports/endpoints) UUID. * * @param member Member. * @param msg The incoming message. */ void GetId(const InterfaceDescription::Member* member, Message& msg); /** * Respond to a bus request to update the activation environment. * * @param member Member. * @param msg The incoming message. */ void UpdateActivationEnvironment(const InterfaceDescription::Member* member, Message& msg); /** * Respond to a bus request to get the list of queued owners. * * @param member Member. * @param msg The incoming message. */ void ListQueuedOwners(const InterfaceDescription::Member* member, Message& msg); /** * Respond to a bus request to get the ADT audit session data. * * @param member Member. * @param msg The incoming message. */ void GetAdtAuditSessionData(const InterfaceDescription::Member* member, Message& msg); /** * Respond to a bus request to get the SE Linux security context for a connection. * * @param member Member. * @param msg The incoming message. */ void GetConnectionSELinuxSecurityContext(const InterfaceDescription::Member* member, Message& msg); /** * Respond to a bus request to reload the config file. * * @param member Member. * @param msg The incoming message. */ void ReloadConfig(const InterfaceDescription::Member* member, Message& msg); private: Bus& bus; /**< The bus */ DaemonRouter& router; /**< The daemon-side router associated with the bus */ const InterfaceDescription* dbusIntf; /**< org.freedesktop.DBus interface */ BusController* busController; /**< The BusController that created this object */ /** * Called upon completion of NameTable::AddAlias operation. This callback is called * BEFORE any NameTable listeners are called. * @see NameTable * * @param aliasName Name of alias. * @param disposition Alias disposition. * @param context Context passed to AddAlias */ void AddAliasComplete(const qcc::String& aliasName, uint32_t disposition, void* context); /** * Called upon completion of NameTable::RemoveAlias operation. This callback is called * BEFORE any NameTable listeners are called. * @see NameTable * * @param aliasName Name of alias. * @param disposition Alias disposition. * @param context Context passed to AddAlias */ void RemoveAliasComplete(const qcc::String& aliasName, uint32_t disposition, void* context); friend class ServiceStartHandler; }; } #endif alljoyn-15.04b/alljoyn_core/router/DaemonRouter.cc000066400000000000000000001101711255700255500222570ustar00rootroot00000000000000/** * @file * Router is responsible for taking inbound messages and routing them * to an appropriate set of endpoints. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #include #include #include #include "BusEndpoint.h" #include "ConfigDB.h" #include "DaemonRouter.h" #include "EndpointHelper.h" #include "AllJoynObj.h" #include "SessionlessObj.h" #ifdef ENABLE_POLICYDB #include "PolicyDB.h" #endif #define QCC_MODULE "ROUTER" using namespace std; using namespace qcc; namespace ajn { DaemonRouter::DaemonRouter() : ruleTable(), nameTable(), busController(NULL), alljoynObj(NULL), sessionlessObj(NULL) { #ifdef ENABLE_POLICYDB AddBusNameListener(ConfigDB::GetConfigDB()); #endif } DaemonRouter::~DaemonRouter() { } static inline QStatus SendThroughEndpoint(Message& msg, BusEndpoint& ep, SessionId sessionId) { QCC_DbgTrace(("SendThroughEndpoint(): Routing \"%s\" (%d) through \"%s\"", msg->Description().c_str(), msg->GetCallSerial(), ep->GetUniqueName().c_str())); QStatus status; if ((sessionId != 0) && (ep->GetEndpointType() == ENDPOINT_TYPE_VIRTUAL)) { status = VirtualEndpoint::cast(ep)->PushMessage(msg, sessionId); } else { status = ep->PushMessage(msg); } // if the bus is stopping or the endpoint is closing we don't expect to be able to send if ((status != ER_OK) && (status != ER_BUS_ENDPOINT_CLOSING) && (status != ER_BUS_STOPPING)) { QCC_DbgPrintf(("SendThroughEndpoint(dest=%s, ep=%s, id=%u) failed: %s", msg->GetDestination(), ep->GetUniqueName().c_str(), sessionId, QCC_StatusText(status))); } return status; } QStatus DaemonRouter::PushMessage(Message& msg, BusEndpoint& origSender) { QCC_DbgTrace(("DaemonRouter::PushMessage(): Routing \"%s\" (%d) from \"%s\"", msg->Description().c_str(), msg->GetCallSerial(), origSender->GetUniqueName().c_str())); /* * Reference count protects local endpoint from being deregistered while in use. */ if (!localEndpoint->IsValid()) { return ER_BUS_ENDPOINT_CLOSING; } QStatus status = ER_OK; BusEndpoint sender = origSender; bool replyExpected = (msg->GetType() == MESSAGE_METHOD_CALL) && ((msg->GetFlags() & ALLJOYN_FLAG_NO_REPLY_EXPECTED) == 0); const char* destination = msg->GetDestination(); SessionId sessionId = msg->GetSessionId(); bool isSessionless = msg->GetFlags() & ALLJOYN_FLAG_SESSIONLESS; bool destinationEmpty = destination[0] == '\0'; BusEndpoint destEndpoint; if (!destinationEmpty) { nameTable.Lock(); destEndpoint = nameTable.FindEndpoint(destination); nameTable.Unlock(); } #ifdef ENABLE_POLICYDB PolicyDB policyDB = ConfigDB::GetConfigDB()->GetPolicyDB(); NormalizedMsgHdr nmh(msg, policyDB, origSender); if ((sender != localEndpoint) && !policyDB->OKToSend(nmh, destEndpoint)) { /* The sender is not allowed to send this message. */ return ER_BUS_POLICY_VIOLATION; } #endif /* * Sessionless messages don't have a session id even though they have a dedicated * session to travel over. Therefore, get the sessionId from the endpoint if possible. */ if (isSessionless && (sender->GetEndpointType() == ENDPOINT_TYPE_BUS2BUS)) { QCC_DbgPrintf(("DaemonRouter::PushMessage(): RouteSessionlessMessage(): ENDPOINT_TYPE_BUS2BUS. Sender sessionId=%d.", RemoteEndpoint::cast(sender)->GetSessionId())); /* * The Sessionless Object is responsible for routing of sessionless * signals. Specifically, sessionless signals that are received solely * to "catch-up" a newly connected local client are routed directly to * that client by the Sessionless Object. */ RemoteEndpoint rep = RemoteEndpoint::cast(sender); sessionlessObj->RouteSessionlessMessage(rep->GetSessionId(), msg); return ER_OK; } /* * If the message originated at the local endpoint check if the serial number needs to be * updated before queuing the message on a remote endpoint. */ if (origSender == localEndpoint) { QCC_DbgPrintf(("DaemonRouter::PushMessage(): UpdateSerialNumber()")); LocalEndpoint::cast(origSender)->UpdateSerialNumber(msg); } if (!destinationEmpty) { QCC_DbgPrintf(("DaemonRouter::PushMessage(): destinationEmpty=false")); nameTable.Lock(); if (destEndpoint->IsValid()) { QCC_DbgPrintf(("DaemonRouter::PushMessage(): Valid destEndpoint")); /* If this message is coming from a bus-to-bus ep, make sure the receiver is willing to receive it */ if (!((sender->GetEndpointType() == ENDPOINT_TYPE_BUS2BUS) && !destEndpoint->AllowRemoteMessages())) { QCC_DbgPrintf(("DaemonRouter::PushMessage(): destEndpoint allows remote messages")); /* * If the sender doesn't allow remote messages reject method * calls that go off device and require a reply because the * reply will be blocked and this is most definitely not what * the sender expects. */ if ((destEndpoint->GetEndpointType() == ENDPOINT_TYPE_VIRTUAL) && replyExpected && !sender->AllowRemoteMessages()) { QCC_DbgPrintf(("DaemonRouter::PushMessage(): Blocked method call from \"%s\" to \"%s\" (serial=%d). Caller does not allow remote messages", msg->GetSender(), destEndpoint->GetUniqueName().c_str(), msg->GetCallSerial())); QStatus result = msg->ErrorMsg(msg, "org.alljoyn.Bus.Blocked", "Method reply would be blocked because caller does not allow remote messages"); assert(ER_OK == result); QCC_UNUSED(result); BusEndpoint busEndpoint = BusEndpoint::cast(localEndpoint); PushMessage(msg, busEndpoint); #ifdef ENABLE_POLICYDB } else if ((destEndpoint != localEndpoint) && !policyDB->OKToReceive(nmh, destEndpoint)) { /* * The destination is not allowed to recieve the message. * If a reply is expected, return an error to the sender. */ QCC_DbgPrintf(("DaemonRouter::PushMessage(): Blocked method call from \"%s\" to \"%s\" (serial=%d). Caller does not allow remote messages", msg->GetSender(), destEndpoint->GetUniqueName().c_str(), msg->GetCallSerial())); if (replyExpected) { QStatus result = msg->ErrorMsg(msg, "org.alljoyn.Bus.Blocked", "Destination not allowed to receive method call"); assert(ER_OK == result); QCC_UNUSED(result); BusEndpoint busEndpoint = BusEndpoint::cast(localEndpoint); PushMessage(msg, busEndpoint); } status = ER_BUS_POLICY_VIOLATION; #endif } else { nameTable.Unlock(); QCC_DbgPrintf(("DaemonRouter::PushMessage(): SendThroughEndpoint()")); status = SendThroughEndpoint(msg, destEndpoint, sessionId); nameTable.Lock(); } } else { QCC_DbgPrintf(("Blocked message from \"%s\" to \"%s\" (serial=%d). Receiver does not allow remote messages", msg->GetSender(), destEndpoint->GetUniqueName().c_str(), msg->GetCallSerial())); /* If caller is expecting a response return an error indicating the method call was blocked */ if (replyExpected) { qcc::String description("Remote method calls blocked for bus name: "); description += destination; QStatus result = msg->ErrorMsg(msg, "org.alljoyn.Bus.Blocked", description.c_str()); assert(ER_OK == result); QCC_UNUSED(result); BusEndpoint busEndpoint = BusEndpoint::cast(localEndpoint); PushMessage(msg, busEndpoint); } } // if the bus is stopping or the endpoint is closing we can't push the message if ((ER_OK != status) && (ER_BUS_ENDPOINT_CLOSING != status) && (status != ER_BUS_STOPPING)) { QCC_DbgPrintf(("BusEndpoint::PushMessage failed: %s", QCC_StatusText(status))); } nameTable.Unlock(); } else { nameTable.Unlock(); if ((msg->GetFlags() & ALLJOYN_FLAG_AUTO_START) && (sender->GetEndpointType() != ENDPOINT_TYPE_BUS2BUS) && (sender->GetEndpointType() != ENDPOINT_TYPE_NULL)) { QCC_DbgPrintf(("DaemonRouter::PushMessage(): Start service not implemented")); status = ER_NOT_IMPLEMENTED; } else { status = ER_BUS_NO_ROUTE; } if (status != ER_OK) { if (replyExpected) { QCC_LogError(status, ("DaemonRouter::PushMessage(): Returning error \"%s\" no route to \"%s\"", msg->Description().c_str(), destination)); /* Need to let the sender know its reply message cannot be passed on. */ qcc::String description("Unknown bus name: "); description += destination; QStatus result = msg->ErrorMsg(msg, "org.freedesktop.DBus.Error.ServiceUnknown", description.c_str()); assert(ER_OK == result); QCC_UNUSED(result); BusEndpoint busEndpoint = BusEndpoint::cast(localEndpoint); PushMessage(msg, busEndpoint); } else { /* * The daemon may try and push a message when the program is * shutting down this will result in a no route error. Although * it is a valid error it is not a LogError. This is typically * something like a NameLost signal because the program with the * bundled router just shutdown. */ if (ER_BUS_NO_ROUTE == status) { QCC_DbgHLPrintf(("DaemonRouter::PushMessage(): Discarding \"%s\" no route to \"%s\"(%d): status=\"%s\"", msg->Description().c_str(), destination, sessionId, QCC_StatusText(status))); } else { QCC_LogError(status, ("DaemonRouter::PushMessage(): Discarding \"%s\" no route to \"%s\"(%d)", msg->Description().c_str(), destination, sessionId)); } } } } } else if (sessionId == 0) { /* * The message has an empty destination field and no session is specified so this is a * regular broadcast message. */ QCC_DbgPrintf(("DaemonRouter::PushMessage(): broadcast messsage")); nameTable.Lock(); ruleTable.Lock(); RuleIterator it = ruleTable.Begin(); while (it != ruleTable.End()) { if (msg->IsSessionless() && it->second.sessionless == Rule::SESSIONLESS_TRUE) { /* Skip rule, it will be handled by SessionlessObj below */ ++it; } else if (it->second.IsMatch(msg)) { BusEndpoint dest = it->first; QCC_DbgPrintf(("DaemonRouter::PushMessage(): Routing \"%s\" (%d) to \"%s\"", msg->Description().c_str(), msg->GetCallSerial(), dest->GetUniqueName().c_str())); /* * If the message originated locally or the destination allows remote messages * forward the message, otherwise silently ignore it. */ bool sendMsg = !((sender->GetEndpointType() == ENDPOINT_TYPE_BUS2BUS) && !dest->AllowRemoteMessages()); #ifdef ENABLE_POLICYDB sendMsg = sendMsg && ((dest == localEndpoint) || policyDB->OKToReceive(nmh, dest)); #endif if (sendMsg) { ruleTable.Unlock(); nameTable.Unlock(); QCC_DbgPrintf(("DaemonRouter::PushMessage(): SendThroughEndpoint()")); QStatus tStatus = SendThroughEndpoint(msg, dest, sessionId); status = (status == ER_OK) ? tStatus : status; nameTable.Lock(); ruleTable.Lock(); } it = ruleTable.AdvanceToNextEndpoint(dest); } else { ++it; } } ruleTable.Unlock(); nameTable.Unlock(); if (msg->IsSessionless()) { /* Give "locally generated" sessionless message to SessionlessObj */ if (sender->GetEndpointType() != ENDPOINT_TYPE_BUS2BUS) { status = sessionlessObj->PushMessage(msg); } } else if (msg->IsGlobalBroadcast()) { /* * A bit of explanation is needed here. The AllJoyn daemon-to-daemon method * "DetachSession" is sent with session id == 0 (and NULL dest) rather than using the * session id being detached. This is because the receiver of the detach session message * is the bus controller of the session participant and is therefore not a member of the * session. Unfortunately, because of the lack of a session id in this message, it was * discovered that the detach session message was capable of arriving at its destination * BEFORE the last user message(s) were received over the session. This caused * occasional loss of user data when there was more than one B2B endpoint that could * route to the receiving bus controller. * * The fix to this problem is unfortunately needed here. If the message is using * sessionId 0 and the message is a detach session message, then the session id in the * message body is used for selecting a B2B endpoint rather than the one that is in the * message header (0). */ if ((sessionId == 0) && (::strcmp("DetachSession", msg->GetMemberName()) == 0) && (::strcmp(org::alljoyn::Daemon::InterfaceName, msg->GetInterface()) == 0)) { /* Clone the message since this message is unmarshalled by the LocalEndpoint too * and the process of unmarshalling is not thread-safe. */ Message clone = Message(msg, true); QStatus status = clone->UnmarshalArgs("us"); if (status == ER_OK) { sessionId = clone->GetArg(0)->v_uint32; } else { QCC_LogError(status, ("Failed to unmarshal args for DetachSession message")); } } /* Route global broadcast to all bus-to-bus endpoints that aren't the sender of the message */ m_b2bEndpointsLock.Lock(MUTEX_CONTEXT); set::iterator it = m_b2bEndpoints.begin(); while (it != m_b2bEndpoints.end()) { RemoteEndpoint ep = *it; if ((ep != origSender) && ((sessionId == 0) || ep->GetSessionId() == sessionId)) { BusEndpoint busEndpoint = BusEndpoint::cast(ep); bool sendMsg = true; #ifdef ENABLE_POLICYDB sendMsg = sendMsg && ((busEndpoint == localEndpoint) || policyDB->OKToReceive(nmh, busEndpoint)); #endif if (sendMsg) { m_b2bEndpointsLock.Unlock(MUTEX_CONTEXT); QCC_DbgPrintf(("DaemonRouter::PushMessage(): SendThroughEndpoint()")); QStatus tStatus = SendThroughEndpoint(msg, busEndpoint, sessionId); status = (status == ER_OK) ? tStatus : status; m_b2bEndpointsLock.Lock(MUTEX_CONTEXT); it = m_b2bEndpoints.lower_bound(ep); } } if (it != m_b2bEndpoints.end()) { ++it; } } m_b2bEndpointsLock.Unlock(MUTEX_CONTEXT); } } else { /* * The message has an empty destination field and a session id was specified so this is a * session multicast message. */ QCC_DbgPrintf(("DaemonRouter::PushMessage(): Session multicast message()")); sessionCastSetLock.Lock(MUTEX_CONTEXT); RemoteEndpoint lastB2b; /* We need to obtain the first entry in the sessionCastSet that has the id equal to 'sessionId' * and the src equal to 'msg->GetSender()'. * Note: sce.id has been set to sessionId - 1. Since the src is compared first, and session Ids * are integers, upper_bound will return the iterator to the first element with the desired or * greater src(if not present) and desired or greater id in most cases. */ SessionCastEntry sce(sessionId - 1, msg->GetSender()); set::iterator sit = sessionCastSet.upper_bound(sce); bool foundDest = false; bool okToReceive = true; /* In other cases, it may return the iterator to an element that has the desired src and * (sessionId - 1). In that case iterate, until the id is less than the desired one. */ while ((sit != sessionCastSet.end()) && (sit->src == sce.src) && (sit->id < sessionId)) { sit++; } QCC_DbgPrintf(("DaemonRouter::PushMessage(): Sending to sessionCast subset")); while ((sit != sessionCastSet.end()) && (sit->id == sessionId) && (sit->src == sce.src)) { QCC_DbgPrintf(("DaemonRouter::PushMessage(): Trying \"%s\"", sit->destEp->GetUniqueName().c_str())); QCC_DbgPrintf(("DaemonRouter::PushMessage(): sit->b2bEp=\"%s\"", sit->b2bEp->GetUniqueName().c_str())); QCC_DbgPrintf(("DaemonRouter::PushMessage(): lastB2b=\"%s\"", lastB2b->GetUniqueName().c_str())); if (sit->b2bEp != lastB2b) { QCC_DbgPrintf(("DaemonRouter::PushMessage(): sit->b2bEp != lastB2b")); BusEndpoint ep = sit->destEp; #ifdef ENABLE_POLICYDB okToReceive = (ep == localEndpoint) || policyDB->OKToReceive(nmh, ep); #endif if (okToReceive) { QCC_DbgPrintf(("DaemonRouter::PushMessage(): okToReceive")); foundDest = true; lastB2b = sit->b2bEp; SessionCastEntry entry = *sit; sessionCastSetLock.Unlock(MUTEX_CONTEXT); QCC_DbgPrintf(("DaemonRouter::PushMessage(): SendThroughEndpoint(): ep=\"%s\", sessionId=%d", ep->GetUniqueName().c_str(), sessionId)); QStatus tStatus = SendThroughEndpoint(msg, ep, sessionId); status = (status == ER_OK) ? tStatus : status; sessionCastSetLock.Lock(MUTEX_CONTEXT); sit = sessionCastSet.lower_bound(entry); } } if (sit != sessionCastSet.end()) { ++sit; } } if (!foundDest) { status = okToReceive ? ER_BUS_NO_ROUTE : ER_BUS_POLICY_VIOLATION; } sessionCastSetLock.Unlock(MUTEX_CONTEXT); } return status; } void DaemonRouter::GetBusNames(vector& names) const { nameTable.GetBusNames(names); } BusEndpoint DaemonRouter::FindEndpoint(const qcc::String& busName) { BusEndpoint ep = nameTable.FindEndpoint(busName); if (!ep->IsValid()) { m_b2bEndpointsLock.Lock(MUTEX_CONTEXT); for (set::const_iterator it = m_b2bEndpoints.begin(); it != m_b2bEndpoints.end(); ++it) { if ((*it)->GetUniqueName() == busName) { RemoteEndpoint rep = *it; ep = BusEndpoint::cast(rep); break; } } m_b2bEndpointsLock.Unlock(MUTEX_CONTEXT); } return ep; } QStatus DaemonRouter::AddRule(BusEndpoint& endpoint, Rule& rule) { QStatus status = ruleTable.AddRule(endpoint, rule); /* Allow sessionlessObj to examine this rule */ if (status == ER_OK) { sessionlessObj->AddRule(endpoint->GetUniqueName(), rule); } return status; } QStatus DaemonRouter::RemoveRule(BusEndpoint& endpoint, Rule& rule) { QStatus status = ruleTable.RemoveRule(endpoint, rule); if (ER_OK == status) { /* Allow sessionlessObj to examine rule being removed */ sessionlessObj->RemoveRule(endpoint->GetUniqueName(), rule); } return status; } QStatus DaemonRouter::RegisterEndpoint(BusEndpoint& endpoint) { QCC_DbgTrace(("DaemonRouter::RegisterEndpoint(%s, %d)", endpoint->GetUniqueName().c_str(), endpoint->GetEndpointType())); QStatus status = ER_OK; /* Keep track of local endpoint */ if (endpoint->GetEndpointType() == ENDPOINT_TYPE_LOCAL) { localEndpoint = LocalEndpoint::cast(endpoint); } if (endpoint->GetEndpointType() == ENDPOINT_TYPE_BUS2BUS) { /* AllJoynObj is in charge of managing bus-to-bus endpoints and their names */ RemoteEndpoint busToBusEndpoint = RemoteEndpoint::cast(endpoint); status = alljoynObj->AddBusToBusEndpoint(busToBusEndpoint); /* Add to list of bus-to-bus endpoints */ m_b2bEndpointsLock.Lock(MUTEX_CONTEXT); m_b2bEndpoints.insert(busToBusEndpoint); m_b2bEndpointsLock.Unlock(MUTEX_CONTEXT); } else { /* Bus-to-client endpoints appear directly on the bus */ nameTable.AddUniqueName(endpoint); } /* Notify local endpoint that it is connected */ if (endpoint == localEndpoint) { localEndpoint->OnBusConnected(); } return status; } void DaemonRouter::UnregisterEndpoint(const qcc::String& epName, EndpointType epType) { QCC_UNUSED(epType); QCC_DbgTrace(("DaemonRouter::UnregisterEndpoint: %s", epName.c_str())); /* Attempt to get the endpoint */ nameTable.Lock(); BusEndpoint endpoint = FindEndpoint(epName); nameTable.Unlock(); if (ENDPOINT_TYPE_BUS2BUS == endpoint->GetEndpointType()) { /* Inform bus controller of bus-to-bus endpoint removal */ RemoteEndpoint busToBusEndpoint = RemoteEndpoint::cast(endpoint); alljoynObj->RemoveBusToBusEndpoint(busToBusEndpoint); /* Remove the bus2bus endpoint from the list */ m_b2bEndpointsLock.Lock(MUTEX_CONTEXT); set::iterator it = m_b2bEndpoints.begin(); while (it != m_b2bEndpoints.end()) { RemoteEndpoint rep = *it; if (rep == busToBusEndpoint) { m_b2bEndpoints.erase(it); break; } ++it; } m_b2bEndpointsLock.Unlock(MUTEX_CONTEXT); /* Remove entries from sessionCastSet with same b2bEp */ sessionCastSetLock.Lock(MUTEX_CONTEXT); set::iterator sit = sessionCastSet.begin(); while (sit != sessionCastSet.end()) { set::iterator doomed = sit; ++sit; if (doomed->b2bEp == endpoint) { sessionCastSet.erase(doomed); } } sessionCastSetLock.Unlock(MUTEX_CONTEXT); } else { /* Remove any session routes */ RemoveSessionRoutes(endpoint->GetUniqueName().c_str(), 0); /* Remove endpoint from names and rules */ nameTable.RemoveUniqueName(endpoint->GetUniqueName()); RemoveAllRules(endpoint); PermissionMgr::CleanPermissionCache(endpoint); } /* * If the local endpoint is being deregistered this indicates the router is being shut down. */ if (endpoint == localEndpoint) { localEndpoint->Invalidate(); localEndpoint = LocalEndpoint(); } } QStatus DaemonRouter::AddSessionRef(String vepName, SessionId id, RemoteEndpoint b2bEp) { if (!b2bEp->IsValid()) { return ER_BUS_NO_ENDPOINT; } QStatus status = ER_BUS_NO_ENDPOINT; VirtualEndpoint hostRNEp; if (FindEndpoint(vepName, hostRNEp) && (hostRNEp->IsValid())) { hostRNEp->AddSessionRef(id, b2bEp); status = ER_OK; } return status; } void DaemonRouter::RemoveSessionRef(String vepName, SessionId id) { VirtualEndpoint hostRNEp; if (FindEndpoint(vepName, hostRNEp) && (hostRNEp->IsValid())) { hostRNEp->RemoveSessionRef(id); } } QStatus DaemonRouter::AddSessionRoute(SessionId id, BusEndpoint& srcEp, RemoteEndpoint* srcB2bEp, BusEndpoint& destEp, RemoteEndpoint& destB2bEp) { QCC_DbgTrace(("DaemonRouter::AddSessionRoute(%u, %s, %s, %s, %s)", id, srcEp->GetUniqueName().c_str(), srcB2bEp ? (*srcB2bEp)->GetUniqueName().c_str() : "", destEp->GetUniqueName().c_str(), destB2bEp->GetUniqueName().c_str())); QStatus status = ER_OK; if (id == 0) { return ER_BUS_NO_SESSION; } if (destEp->GetEndpointType() == ENDPOINT_TYPE_VIRTUAL) { VirtualEndpoint vDestEp = VirtualEndpoint::cast(destEp); /* If the destination leaf node is virtual, add a session ref */ QCC_DbgPrintf(("DaemonRouter::AddSessionRoute(): destEp is ENDPOINT_TYPE_VIRTUAL)")); if (destB2bEp->IsValid()) { QCC_DbgPrintf(("DaemonRouter::AddSessionRoute(): AddSessionRef(id=%d., destEp=%s, destB2bEp=\"%s\")", id, destEp->GetUniqueName().c_str(), destB2bEp->GetUniqueName().c_str())); status = vDestEp->AddSessionRef(id, destB2bEp); if (status == ER_OK) { /* AddSessionRef for the directly connected routing node. */ QCC_DbgPrintf(("DaemonRouter::AddSessionRoute(): AddSessionRef routing node(id=%d., RN=%s, destB2bEp=\"%s\")", id, destB2bEp->GetRemoteName().c_str(), destB2bEp->GetUniqueName().c_str())); status = AddSessionRef(destB2bEp->GetRemoteName(), id, destB2bEp); if (status != ER_OK) { QCC_LogError(status, ("DaemonRouter::AddSessionRoute(): AddSessionRef routing node failed(id=%d., RN=%s, destB2bEp=\"%s\")", id, destB2bEp->GetRemoteName().c_str(), destB2bEp->GetUniqueName().c_str())); vDestEp->RemoveSessionRef(id); /* Need to hit NameTable here since name ownership of a destEp alias may have changed */ nameTable.UpdateVirtualAliases(destEp->GetUniqueName()); } } if (status == ER_OK) { String vepGuid = vDestEp->GetRemoteGUIDShortString(); if (vepGuid != destB2bEp->GetRemoteGUID().ToShortString()) { String memberRoutingNode = ":" + vepGuid + ".1"; QCC_DbgPrintf(("DaemonRouter::AddSessionRoute(): AddSessionRef indirectly connected routing node(id=%d., memberRoutingNode=%s, destB2bEp=\"%s\")", id, memberRoutingNode.c_str(), destB2bEp->GetUniqueName().c_str())); /* If the directly connected routing node is not the destination's routing node. * i.e. multipoint session case where members are indirectly connected via the * host routing node, increment a ref for the destination's routing node. */ status = AddSessionRef(memberRoutingNode, id, destB2bEp); if (status != ER_OK) { QCC_LogError(status, ("DaemonRouter::AddSessionRoute(): AddSessionRef indirectly connected routing node failed(id=%d., RN=%s, destB2bEp=\"%s\")", id, memberRoutingNode.c_str(), destB2bEp->GetUniqueName().c_str())); vDestEp->RemoveSessionRef(id); RemoveSessionRef(destB2bEp->GetRemoteName(), id); /* Need to hit NameTable here since name ownership of a destEp and destB2bEp->GetRemoteName() alias may have changed */ nameTable.UpdateVirtualAliases(destEp->GetUniqueName()); nameTable.UpdateVirtualAliases(destB2bEp->GetRemoteName()); } } } } else { status = ER_BUS_NO_SESSION; } if (status != ER_OK) { QCC_LogError(status, ("AddSessionRef(this=%s, %u, %s%s) failed", destEp->GetUniqueName().c_str(), id, destB2bEp->IsValid() ? "" : "opts, ", destB2bEp->GetUniqueName().c_str())); } } /* * srcB2bEp is only NULL when srcEP is non-virtual */ if ((status == ER_OK) && srcB2bEp) { assert(srcEp->GetEndpointType() == ENDPOINT_TYPE_VIRTUAL); QCC_DbgPrintf(("DaemonRouter::AddSessionRoute(): AddSessionRef(id=%d.,srcEp=%s, srcB2bEp=\"%s\")", id, srcEp->GetUniqueName().c_str(), (*srcB2bEp)->GetUniqueName().c_str())); status = VirtualEndpoint::cast(srcEp)->AddSessionRef(id, *srcB2bEp); if (status == ER_OK) { /* AddSessionRef for the directly connected routing node. */ QCC_DbgPrintf(("DaemonRouter::AddSessionRoute(): AddSessionRef routing node(id=%d.,RN=%s, srcB2bEp=\"%s\")", id, (*srcB2bEp)->GetRemoteName().c_str(), (*srcB2bEp)->GetUniqueName().c_str())); status = AddSessionRef((*srcB2bEp)->GetRemoteName(), id, *srcB2bEp); if (status != ER_OK) { QCC_LogError(status, ("DaemonRouter::AddSessionRoute(): AddSessionRef routing node(id=%d.,RN=%s, srcB2bEp=\"%s\") failed", id, (*srcB2bEp)->GetRemoteName().c_str(), (*srcB2bEp)->GetUniqueName().c_str())); VirtualEndpoint::cast(srcEp)->RemoveSessionRef(id); /* Need to hit NameTable here since name ownership of a srcEp alias may have changed */ nameTable.UpdateVirtualAliases(srcEp->GetUniqueName()); } } if (status != ER_OK) { assert(destEp->GetEndpointType() == ENDPOINT_TYPE_VIRTUAL); QCC_LogError(status, ("AddSessionRef(this=%s, %u, %s) failed", srcEp->GetUniqueName().c_str(), id, (*srcB2bEp)->GetUniqueName().c_str())); VirtualEndpoint vDestEp = VirtualEndpoint::cast(destEp); vDestEp->RemoveSessionRef(id); RemoveSessionRef(destB2bEp->GetRemoteName(), id); String vepGuid = vDestEp->GetRemoteGUIDShortString(); /* Need to hit NameTable here since name ownership of a destEp, destB2bEp->GetRemoteName() * and memberRoutingNode alias may have changed */ nameTable.UpdateVirtualAliases(destEp->GetUniqueName()); nameTable.UpdateVirtualAliases(destB2bEp->GetRemoteName()); if (vepGuid != destB2bEp->GetRemoteGUID().ToShortString()) { String memberRoutingNode = ":" + vepGuid + ".1"; RemoveSessionRef(memberRoutingNode, id); nameTable.UpdateVirtualAliases(destB2bEp->GetRemoteName()); } } } /* Set sessionId on B2B endpoints */ if (status == ER_OK) { if (srcB2bEp) { QCC_DbgPrintf(("DaemonRouter::AddSessionRoute(): SetSessionId(%d.) on srcB2bEp \"%s\")", id, (*srcB2bEp)->GetUniqueName().c_str())); (*srcB2bEp)->SetSessionId(id); } QCC_DbgPrintf(("DaemonRouter::AddSessionRoute(): SetSessionId(%d.) on destB2bEp \"%s\")", id, destB2bEp->GetUniqueName().c_str())); destB2bEp->SetSessionId(id); } /* Add sessionCast entries */ if (status == ER_OK) { sessionCastSetLock.Lock(MUTEX_CONTEXT); SessionCastEntry entry(id, srcEp->GetUniqueName(), destB2bEp, destEp); QCC_DbgPrintf(("DaemonRouter::AddSessionRoute(): sessionCastSet.insert(%d., \"%s\", \"%s\", \"%s\")", id, srcEp->GetUniqueName().c_str(), destB2bEp->GetUniqueName().c_str(), destEp->GetUniqueName().c_str())); sessionCastSet.insert(entry); if (srcEp != destEp) { /* Prevent double entry for self-join */ if (srcB2bEp) { QCC_DbgPrintf(("DaemonRouter::AddSessionRoute(): sessionCastSet.insert(%d., \"%s\", \"%s\", \"%s\")", id, destEp->GetUniqueName().c_str(), (*srcB2bEp)->GetUniqueName().c_str(), srcEp->GetUniqueName().c_str())); sessionCastSet.insert(SessionCastEntry(id, destEp->GetUniqueName(), *srcB2bEp, srcEp)); } else { RemoteEndpoint none; QCC_DbgPrintf(("DaemonRouter::AddSessionRoute(): sessionCastSet.insert(%d., \"%s\", \"%s\", \"%s\")", id, destEp->GetUniqueName().c_str(), srcB2bEp ? (*srcB2bEp)->GetUniqueName().c_str() : "none", srcEp->GetUniqueName().c_str())); sessionCastSet.insert(SessionCastEntry(id, destEp->GetUniqueName(), none, srcEp)); } } sessionCastSetLock.Unlock(MUTEX_CONTEXT); } return status; } void DaemonRouter::RemoveSelfJoinSessionRoute(const char* src, SessionId id) { QCC_DbgTrace(("DaemonRouter::RemoveSelfJoinSessionRoute(\"%s\", %d.)", src, id)); String srcStr = src; BusEndpoint ep = FindEndpoint(srcStr); sessionCastSetLock.Lock(MUTEX_CONTEXT); set::const_iterator it = sessionCastSet.begin(); for (; it != sessionCastSet.end(); ++it) { if ((it->id == id) && (it->src == src) && (it->destEp == ep)) { sessionCastSet.erase(it); break; } } sessionCastSetLock.Unlock(MUTEX_CONTEXT); } void DaemonRouter::RemoveSessionRoutes(const char* src, SessionId id) { QCC_DbgTrace(("DaemonRouter::RemoveSessionRoutes(\"%s\", %d.)", src, id)); String srcStr = src; BusEndpoint ep = FindEndpoint(srcStr); sessionCastSetLock.Lock(MUTEX_CONTEXT); set::const_iterator it = sessionCastSet.begin(); while (it != sessionCastSet.end()) { if (((it->id == id) || (id == 0)) && ((it->src == src) || (it->destEp == ep))) { SessionCastEntry entry = *it; sessionCastSet.erase(it); sessionCastSetLock.Unlock(); if ((entry.id != 0) && (entry.destEp->GetEndpointType() == ENDPOINT_TYPE_VIRTUAL)) { VirtualEndpoint vDestEp = VirtualEndpoint::cast(entry.destEp); String vepGuid = vDestEp->GetRemoteGUIDShortString(); vDestEp->RemoveSessionRef(entry.id); /* RemoveSessionRef for the directly connected routing node. */ RemoveSessionRef(entry.b2bEp->GetRemoteName(), entry.id); if (vepGuid != entry.b2bEp->GetRemoteGUID().ToShortString()) { /* If the directly connected routing node is not the destination's routing node. * i.e. multipoint session case where members are indirectly connected via the * host routing node, decrement a ref for the destination's routing node. */ String memberRoutingNode = ":" + vepGuid + ".1"; RemoveSessionRef(memberRoutingNode, entry.id); } /* Need to hit NameTable here since name ownership of a destEp alias may have changed */ nameTable.UpdateVirtualAliases(entry.destEp->GetUniqueName()); } sessionCastSetLock.Lock(); it = sessionCastSet.upper_bound(entry); } else { ++it; } } sessionCastSetLock.Unlock(MUTEX_CONTEXT); } } alljoyn-15.04b/alljoyn_core/router/DaemonRouter.h000066400000000000000000000411461255700255500221260ustar00rootroot00000000000000/** * @file * DaemonRouter is a "full-featured" router responsible for routing Bus messages * between one or more remote endpoints and a single local endpoint. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_DAEMONROUTER_H #define _ALLJOYN_DAEMONROUTER_H #include #include #include "Transport.h" #include #include "LocalTransport.h" #include "Router.h" #include "NameTable.h" #include "RuleTable.h" namespace ajn { /** * @internal Forward delcarations */ class BusController; class AllJoynObj; class SessionlessObj; /** * DaemonRouter is a "full-featured" router responsible for routing Bus messages * between one or more remote endpoints and a single local endpoint. */ class DaemonRouter : public Router { friend class _LocalEndpoint; public: /** * Constructor */ DaemonRouter(); /** * Destructor */ ~DaemonRouter(); /** * Set the AllJoynObj associated with this router. * * @param alljoynObj The bus controller. */ void SetAllJoynObj(AllJoynObj* alljoynObj) { this->alljoynObj = alljoynObj; } /** * Set the SessionlessObj associated with this router. * * @param sessionlessObj The bus controller. */ void SetSessionlessObj(SessionlessObj* sessionlessObj) { this->sessionlessObj = sessionlessObj; } /** * Set the busController associated with this router. * * @param busController The bus controller. */ void SetBusController(BusController* busController) { this->busController = busController; } /** * Get the bus controller associated with this router */ BusController* GetBusController() { return busController; } /** * Add a bus name listener. * * @param listener Pointer to object that implements AllJoynNameListerer */ void AddBusNameListener(NameListener* listener) { nameTable.AddListener(listener); } /** * Remote a bus name listener. * * @param listener Pointer to object that implements AllJoynNameListerer */ void RemoveBusNameListener(NameListener* listener) { nameTable.RemoveListener(listener); } /** * Set GUID of the bus. * * @param guid GUID of bus associated with this router. */ void SetGlobalGUID(const qcc::GUID128& guid) { nameTable.SetGUID(guid); } /** * Generate a unique endpoint name. * * @return A unique bus name that can be assigned to a (server-side) endpoint. */ qcc::String GenerateUniqueName(void) { return nameTable.GenerateUniqueName(); } /** * Return whether this is a unique name of a locally connected endpoint. * * @param uniqueName Unique name to check. * @return true if a locally connected endpoint has this unique name. */ bool IsValidLocalUniqueName(qcc::String uniqueName) { return nameTable.IsValidLocalUniqueName(uniqueName); } /** * Add a well-known (alias) bus name. * * @param aliasName Alias (well-known) name of bus. * @param uniqueName Unique name of endpoint attempting to own aliasName. * @param flags AddAlias flags from NameTable. * @param disposition [OUT] Outcome of add alias operation. Valid if return code is ER_OK. * @param listener Optional listener whose AddAliasComplete method will be called if return code is ER_OK. * @param context Optional context passed to listener. * @return ER_OK if successful; */ QStatus AddAlias(const qcc::String& aliasName, const qcc::String& uniqueName, uint32_t flags, uint32_t& disposition, NameListener* listener = NULL, void* context = NULL) { return nameTable.AddAlias(aliasName, uniqueName, flags, disposition, listener, context); } /** * Remove a well-known bus name. * * @param aliasName Well-known name to be removed. * @param ownerName Unique name of owner of aliasName. * @param disposition Outcome of remove alias operation. Valid only if return code is ER_OK. * @param listener Optional listener whose RemoveAliasComplete method will be called if return code is ER_OK. * @param context Optional context passed to listener. */ void RemoveAlias(const qcc::String& aliasName, const qcc::String& ownerName, uint32_t& disposition, NameListener* listener = NULL, void* context = NULL) { nameTable.RemoveAlias(aliasName, ownerName, disposition, listener, context); } /** * Get a list of bus names. * * @param names OUT Parameter: Vector of bus names. */ void GetBusNames(std::vector& names) const; /** * Find the endpoint that owns the given unique or well-known name. * * @param busname Unique or well-known bus name * @return Returns either the bus endpoint or an invalid bus endpoint with */ BusEndpoint FindEndpoint(const qcc::String& busname); /** * Find the remote or bus-to-bus endpoint that owns the given unique or well-known name. * * @param busname Unique or well-known bus name * @param endpoint Returns the bus endpoint * * @return Returns true if the endpoint was found, false if it was not found. */ bool FindEndpoint(const qcc::String& busname, RemoteEndpoint& endpoint) { BusEndpoint ep = FindEndpoint(busname); if ((ep->GetEndpointType() == ENDPOINT_TYPE_REMOTE) || (ep->GetEndpointType() == ENDPOINT_TYPE_BUS2BUS)) { endpoint = RemoteEndpoint::cast(ep); return true; } else { endpoint->Invalidate(); return false; } } /** * Find the virtual endpoint that owns the given unique or well-known name. * * @param busname Unique or well-known bus name * @param endpoint Returns the bus endpoint * * @return Returns true if the endpoint was found, false if it was not found. */ bool FindEndpoint(const qcc::String& busname, VirtualEndpoint& endpoint) { BusEndpoint ep = FindEndpoint(busname); if (ep->GetEndpointType() == ENDPOINT_TYPE_VIRTUAL) { endpoint = VirtualEndpoint::cast(ep); return true; } else { endpoint->Invalidate(); return false; } } /** * Add a rule for an endpoint. * * @param endpoint The endpoint that this rule applies to. * @param rule Rule for endpoint * @return ER_OK if successful; */ QStatus AddRule(BusEndpoint& endpoint, Rule& rule); /** * Remove a rule for an endpoint. * * @param endpoint Endpoint that rule applies to. * @param rule Rule to remove. * @return ER_OK if successful; */ QStatus RemoveRule(BusEndpoint& endpoint, Rule& rule); /** * Remove all rules for a given endpoint. * * @param endpoint Endpoint whose rules will be removed. * @return ER_OK if successful; */ QStatus RemoveAllRules(BusEndpoint& endpoint) { return ruleTable.RemoveAllRules(endpoint); } /** * Route an incoming Message Bus Message from an endpoint. * * @param sender Endpoint that is sending the message * @param msg Message to be processed. * @return ER_OK if successful. */ QStatus PushMessage(Message& msg, BusEndpoint& sender); /** * Register an endpoint. * This method must be called by an endpoint before attempting to use the router. * * @param endpoint Endpoint being registered. */ QStatus RegisterEndpoint(BusEndpoint& endpoint); /** * Un-register an endpoint. * This method must be called by an endpoint before the endpoint is deallocted. * * @param epName Name of endpoint being unregistered. */ void UnregisterEndpoint(const qcc::String& epName, EndpointType epType); /** * Return true if this router is in contact with a bus (either locally or remotely) * This method can be used to determine whether messages sent to "the bus" will be routed. * * @return true iff the messages can be routed currently. */ bool IsBusRunning(void) const { return localEndpoint->IsValid(); } /** * Indicate that this Bus instance is an AllJoyn daemon * * @return true since DaemonRouter is always part of an AllJoyn daemon. */ bool IsDaemon() const { return true; } /** * Lock name table */ void LockNameTable() { nameTable.Lock(); } /** * Unlock name table */ void UnlockNameTable() { nameTable.Unlock(); } /** * Get all unique names and their exportable alias (well-known) names. * * @param nameVec Vector of (uniqueName, aliases) pairs where aliases is a vector of alias names. */ void GetUniqueNamesAndAliases(std::vector > >& nameVec) const { nameTable.GetUniqueNamesAndAliases(nameVec); } /** * Get all the unique names that are in queue for the same alias (well-known) name * * @param[in] busName (well-known) name * @param[out] names vecter of uniqueNames in queue for the */ void GetQueuedNames(const qcc::String& busName, std::vector& names) { nameTable.GetQueuedNames(busName, names); } /** * Set (or clear) a virtual alias. * A virtual alias is a well-known bus name for a virtual endpoint. * Virtual aliases differ from regular aliases in that the local bus controller * does not handle name queueing. It is up to the remote endpoint to manange * the queueing for such aliases. * * @param alias The virtual alias being modified. * @param newOwnerEp The VirtualEndpoint that is the new owner of alias or NULL if none. * @param requestingEp A Virtual endpoint from the remote daemon that is requesting this change. * @return true iff alias was a change to the name table */ bool SetVirtualAlias(const qcc::String& alias, VirtualEndpoint* newOwnerEp, VirtualEndpoint& requestingEp) { return nameTable.SetVirtualAlias(alias, newOwnerEp, requestingEp); } /** * Remove well-known names associated with a virtual endpoint. * * @param uniqueName UniqueName of virtual endpoint whose well-known names are to be removed. */ void RemoveVirtualAliases(const qcc::String& uniqueName) { nameTable.RemoveVirtualAliases(uniqueName); } /** * Update propagation info of names associated with a virtual endpoint. * * @param uniqueName UniqueName of virtual endpoint whose propagation info is to be updated. */ void UpdateVirtualAliases(const qcc::String& uniqueName) { nameTable.UpdateVirtualAliases(uniqueName); } /** * Add a session route. * * @param id Session Id. * @param srcEp Route source endpoint. * @param srcB2bEp Source B2B endpoint. (NULL if srcEp is not virtual). * @param destEp BusEndpoint of route destination. * @param destB2bEp [IN/OUT] If passed in as invalid endpoint type, attempt to use optsHint to choose destB2bEp and return selected ep. * @return ER_OK if successful. */ QStatus AddSessionRoute(SessionId id, BusEndpoint& srcEp, RemoteEndpoint* srcB2bEp, BusEndpoint& destEp, RemoteEndpoint& destB2bEp); /** * Remove existing session routes. * This method removes routes that involve uniqueName as a source or as a destination for a particular session id. * When sessionId is 0, all routes that involved uniqueName are removed. * * @param uniqueName Unique name. * @param id Session id or 0 to indicate "all sessions". */ void RemoveSessionRoutes(const char* uniqueName, SessionId id); /** * Remove self-join related session-route. * * @param uniqueName Unique name. * @param id Session id or 0 to indicate "all sessions". * */ void RemoveSelfJoinSessionRoute(const char* src, SessionId id); /** * Return the routing rule table. * * @return the routing rule table. */ RuleTable& GetRuleTable() { return ruleTable; } private: LocalEndpoint localEndpoint; /**< The local endpoint */ RuleTable ruleTable; /**< Routing rule table */ NameTable nameTable; /**< BusName to transport lookupl table */ BusController* busController; /**< The bus controller used with this router */ AllJoynObj* alljoynObj; /**< AllJoyn bus object used with this router */ SessionlessObj* sessionlessObj; /**< Sessionless bus object used with this router */ std::set m_b2bEndpoints; /**< Collection of Bus-to-bus endpoints */ qcc::Mutex m_b2bEndpointsLock; /**< Lock that protects m_b2bEndpoints */ /** Session multicast destination map */ struct SessionCastEntry { SessionId id; qcc::String src; RemoteEndpoint b2bEp; BusEndpoint destEp; SessionCastEntry(SessionId id, const qcc::String& src) : id(id), src(src) { } SessionCastEntry(SessionId id, const qcc::String& src, RemoteEndpoint& b2bEp, BusEndpoint& destEp) : id(id), src(src), b2bEp(b2bEp), destEp(destEp) { } bool operator<(const SessionCastEntry& other) const { /* The order of comparison of src and id has been reversed, so that upper_bound can be * used with (desiredID -1) to obtain the first entry that has the desired src and id. */ return (src < other.src) || ((src == other.src) && ((id < other.id) || ((id == other.id) && ((b2bEp < other.b2bEp) || ((b2bEp == other.b2bEp) && (destEp < other.destEp)))))); } bool operator==(const SessionCastEntry& other) const { return (id == other.id) && (src == other.src) && (b2bEp == other.b2bEp) && (destEp == other.destEp); } qcc::String ToString() const { char idbuf[16]; char ptrbuf[16]; qcc::String str; str.append("id: "); snprintf(idbuf, sizeof(idbuf), "%u", id); str.append(idbuf); str.append(", src: "); str.append(src); str.append(", remote: "); snprintf(ptrbuf, sizeof(ptrbuf), "%p", b2bEp.unwrap()); str.append(ptrbuf); str.append("("); str.append(b2bEp->GetUniqueName()); str.append(","); str.append(b2bEp->GetRemoteName()); str.append(")"); str.append(", dest: "); snprintf(ptrbuf, sizeof(ptrbuf), "%p", destEp.unwrap()); str.append(ptrbuf); str.append(" "); str.append(destEp->GetUniqueName()); return str; } }; std::set sessionCastSet; /**< Session multicast set */ qcc::Mutex sessionCastSetLock; /**< Lock that protects sessionCastSet */ /* Add a session ref to the virtualendpoint with the specified name * @param vepName: Name of virtual endpoint to which a ref needs to be added. * @param id: Id of the session * @param b2bEp: B2b endpoint of the session */ QStatus AddSessionRef(qcc::String vepName, SessionId id, RemoteEndpoint b2bEp); /* Remove a session ref to the virtualendpoint with the specified name * @param vepName: Name of virtual endpoint to which a ref needs to be decremented. * @param id: Id of the session */ void RemoveSessionRef(qcc::String vepName, SessionId id); }; } #endif alljoyn-15.04b/alljoyn_core/router/DaemonSLAPTransport.cc000066400000000000000000001041351255700255500234560ustar00rootroot00000000000000/** * @file * Implementation of DaemonSLAPTransport. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #include #include "DaemonRouter.h" #include "BusInternal.h" #include "RemoteEndpoint.h" #include "Router.h" #include "DaemonSLAPTransport.h" #include "BusController.h" #include "ConfigDB.h" #define QCC_MODULE "DAEMON_SLAP" using namespace std; using namespace qcc; namespace ajn { const char* DaemonSLAPTransport::TransportName = "slap"; /* * An endpoint class to handle the details of authenticating a connection over the SLAP transport. */ class _DaemonSLAPEndpoint : public _RemoteEndpoint { public: enum EndpointState { EP_ILLEGAL = 0, EP_INITIALIZED, /**< This endpoint structure has been allocated but not used */ EP_FAILED, /**< Starting the RX and TX threads has failed and this endpoint is not usable */ EP_STARTING, /**< The RX and TX threads are being started */ EP_STARTED, /**< The RX and TX threads have been started (they work as a unit) */ EP_STOPPING, /**< The RX and TX threads are stopping (have run ThreadExit) but have not been joined */ EP_DONE /**< The RX and TX threads have been shut down and joined */ }; enum AuthState { AUTH_ILLEGAL = 0, AUTH_INITIALIZED, /**< This endpoint structure has been allocated but no auth thread has been run */ AUTH_AUTHENTICATING, /**< We have spun up an authentication thread and it has begun running our user function */ AUTH_FAILED, /**< The authentication has failed and the authentication thread is exiting immidiately */ AUTH_SUCCEEDED, /**< The auth process (Establish) has succeeded and the connection is ready to be started */ AUTH_DONE, /**< The auth thread has been successfully shut down and joined */ }; _DaemonSLAPEndpoint(DaemonSLAPTransport* transport, BusAttachment& bus, bool incoming, const qcc::String connectSpec, UARTFd fd, uint32_t packetSize, uint32_t baudrate) : _RemoteEndpoint(bus, incoming, connectSpec, &m_stream, DaemonSLAPTransport::TransportName), m_transport(transport), m_authThread(this), m_fd(fd), m_authState(AUTH_INITIALIZED), m_epState(EP_INITIALIZED), m_timer("SLAPEp", true, 1, false, 10), m_rawStream(fd), m_stream(&m_rawStream, m_timer, packetSize, 4, baudrate), m_uartController(&m_rawStream, bus.GetInternal().GetIODispatch(), &m_stream) { } EndpointState GetEpState(void) { return m_epState; } ~_DaemonSLAPEndpoint() { } QStatus Authenticate(void); void AuthStop(void); void AuthJoin(void); void SetEpFailed(void) { m_epState = EP_FAILED; } void SetEpStarting(void) { m_epState = EP_STARTING; } void SetEpStarted(void) { m_epState = EP_STARTED; } void SetEpStopping(void) { assert(m_epState == EP_STARTING || m_epState == EP_STARTED || m_epState == EP_STOPPING); m_epState = EP_STOPPING; } void SetEpDone(void) { assert(m_epState == EP_FAILED || m_epState == EP_STOPPING); m_epState = EP_DONE; } AuthState GetAuthState(void) { return m_authState; } UARTFd GetFd() { return m_fd; } QStatus Stop(); QStatus Join(); virtual void ThreadExit(qcc::Thread* thread); QStatus SetIdleTimeouts(uint32_t& reqIdleTimeout, uint32_t& reqProbeTimeout) { uint32_t maxIdleProbes = m_transport->m_numHbeatProbes; /* If reqProbeTimeout == 0, Make no change to Probe timeout. */ if (reqProbeTimeout == 0) { reqProbeTimeout = _RemoteEndpoint::GetProbeTimeout(); } else if (reqProbeTimeout > m_transport->m_maxHbeatProbeTimeout) { /* Max allowed Probe timeout is m_maxHbeatProbeTimeout */ reqProbeTimeout = m_transport->m_maxHbeatProbeTimeout; } /* If reqIdleTimeout == 0, Make no change to Idle timeout. */ if (reqIdleTimeout == 0) { reqIdleTimeout = _RemoteEndpoint::GetIdleTimeout(); } /* Requested link timeout must be >= m_minHbeatIdleTimeout */ if (reqIdleTimeout < m_transport->m_minHbeatIdleTimeout) { reqIdleTimeout = m_transport->m_minHbeatIdleTimeout; } /* Requested link timeout must be <= m_maxHbeatIdleTimeout */ if (reqIdleTimeout > m_transport->m_maxHbeatIdleTimeout) { reqIdleTimeout = m_transport->m_maxHbeatIdleTimeout; } return _RemoteEndpoint::SetIdleTimeouts(reqIdleTimeout, reqProbeTimeout, maxIdleProbes); } private: class AuthThread : public qcc::Thread { public: AuthThread(_DaemonSLAPEndpoint* ep) : Thread("auth"), m_endpoint(ep) { } private: virtual qcc::ThreadReturn STDCALL Run(void* arg); _DaemonSLAPEndpoint* m_endpoint; }; DaemonSLAPTransport* m_transport; /**< The server holding the connection */ AuthThread m_authThread; /**< Thread used to do blocking calls during startup */ UARTFd m_fd; /**< The file descriptor for UART */ volatile AuthState m_authState; /**< The state of the endpoint authentication process */ volatile EndpointState m_epState; /**< The state of the endpoint authentication process */ Timer m_timer; /**< Multipurpose timer for sending/resend/acks */ UARTStream m_rawStream; /**< The raw UART stream */ SLAPStream m_stream; /**< The SLAP stream used for Alljoyn communication */ UARTController m_uartController; /**< Controller responsible for reading from UART */ }; void _DaemonSLAPEndpoint::ThreadExit(qcc::Thread* thread) { if (thread == &m_authThread) { if (m_authState == AUTH_INITIALIZED) { m_authState = AUTH_FAILED; } m_transport->Alert(); } _RemoteEndpoint::ThreadExit(thread); } QStatus _DaemonSLAPEndpoint::Authenticate(void) { QCC_DbgTrace(("DaemonSLAPEndpoint::Authenticate()")); m_timer.Start(); m_uartController.Start(); QStatus status = m_stream.ScheduleLinkControlPacket(); /* * Start the authentication thread. */ if (status == ER_OK) { status = m_authThread.Start(this, this); } if (status != ER_OK) { QCC_DbgPrintf(("DaemonSLAPEndpoint::Authenticate() Failed to authenticate endpoint")); m_authState = AUTH_FAILED; /* Alert the Run() thread to refresh the list of com ports to listen on. */ m_transport->Alert(); } return status; } void _DaemonSLAPEndpoint::AuthStop(void) { QCC_DbgTrace(("DaemonSLAPEndpoint::AuthStop()")); /* Stop the controller only if Authentication failed */ if (m_authState != AUTH_SUCCEEDED) { m_timer.Stop(); m_uartController.Stop(); } /* * Ask the auth thread to stop executing. The only ways out of the thread * run function will set the state to either AUTH_SUCCEEDED or AUTH_FAILED. * There is a very small chance that we will send a stop to the thread after * it has successfully authenticated, but we expect that this will result in * an AUTH_FAILED state for the vast majority of cases. In this case, we * notice that the thread failed the next time through the main server run * loop, join the thread via AuthJoin below and delete the endpoint. Note * that this is a lazy cleanup of the endpoint. */ m_authThread.Stop(); } void _DaemonSLAPEndpoint::AuthJoin(void) { QCC_DbgTrace(("DaemonSLAPEndpoint::AuthJoin()")); /* Join the controller only if Authentication failed */ if (m_authState != AUTH_SUCCEEDED) { m_timer.Join(); m_uartController.Join(); } /* * Join the auth thread to stop executing. All threads must be joined in * order to communicate their return status. The auth thread is no exception. * This is done in a lazy fashion from the main server accept loop, where we * cleanup every time through the loop. */ m_authThread.Join(); } QStatus _DaemonSLAPEndpoint::Stop(void) { QCC_DbgTrace(("DaemonSLAPEndpoint::Stop()")); m_timer.Stop(); m_uartController.Stop(); QStatus status = _RemoteEndpoint::Stop(); return status; } QStatus _DaemonSLAPEndpoint::Join(void) { QCC_DbgTrace(("DaemonSLAPEndpoint::Join()")); m_timer.Join(); m_uartController.Join(); QStatus status = _RemoteEndpoint::Join(); return status; } void* _DaemonSLAPEndpoint::AuthThread::Run(void* arg) { QCC_UNUSED(arg); QCC_DbgPrintf(("DaemonSLAPEndpoint::AuthThread::Run()")); m_endpoint->m_authState = AUTH_AUTHENTICATING; /* * We're running an authentication process here and we are cooperating with * the main server thread. This thread is running in an object that is * allocated on the heap, and the server is managing these objects so we * need to coordinate getting all of this cleaned up. * * Since this is a serial point-to-point connection, we do not bother about * denial of service attacks. */ uint8_t byte; size_t nbytes; QCC_DbgPrintf(("DaemonSLAPEndpoint::AuthThread::Run() calling pullbytes")); /* * Eat the first byte of the stream. This is required to be zero by the * DBus protocol. It is used in the Unix socket implementation to carry * out-of-band capabilities, but is discarded here. We do this here since * it involves a read that can block. */ QStatus status = m_endpoint->m_stream.PullBytes(&byte, 1, nbytes); if ((status != ER_OK) || (nbytes != 1) || (byte != 0)) { QCC_LogError(status, ("Failed to read first byte from stream %d %d", nbytes, byte)); /* * Management of the resources used by the authentication thread is done * in one place, by the server Accept loop. The authentication thread * writes its state into the connection and the server Accept loop reads * this state. As soon as we set this state to AUTH_FAILED, we are * telling the Accept loop that we are done with the conn data * structure. That thread is then free to do anything it wants with the * connection, including deleting it, so we are not allowed to touch * conn after setting this state. * * In addition to releasing responsibility for the conn data structure, * when we set the state to AUTH_SUCCEEDED we are telling the server * accept loop that we are exiting now and so it can Join() on us (the * authentication thread) without being worried about blocking since the * next thing we do is exit. */ m_endpoint->m_authState = AUTH_FAILED; /* Alert the Run() thread to refresh the list of com ports to listen on. */ m_endpoint->m_transport->Alert(); return (void*)ER_FAIL; } /* Initialized the features for this endpoint */ m_endpoint->GetFeatures().isBusToBus = false; m_endpoint->GetFeatures().handlePassing = false; /* Run the actual connection authentication code. */ qcc::String authName; qcc::String redirection; DaemonRouter& router = reinterpret_cast(m_endpoint->m_transport->m_bus.GetInternal().GetRouter()); AuthListener* authListener = router.GetBusController()->GetAuthListener(); /* Since the DaemonSLAPTransport allows untrusted clients, it must implement UntrustedClientStart and * UntrustedClientExit. * As a part of Establish, the endpoint can call the Transport's UntrustedClientStart method if * it is an untrusted client, so the transport MUST call m_endpoint->SetListener before calling Establish * Note: This is only required on the accepting end i.e. for incoming endpoints. * Thin Client 14.06 or higher uses ANONYMOUS to connect to routing nodes. */ m_endpoint->SetListener(m_endpoint->m_transport); status = m_endpoint->Establish("ANONYMOUS", authName, redirection, authListener); if (status != ER_OK) { QCC_LogError(status, ("Failed to establish SLAP endpoint")); /* * Management of the resources used by the authentication thread is done * in one place, by the server Accept loop. The authentication thread * writes its state into the connection and the server Accept loop reads * this state. As soon as we set this state to AUTH_FAILED, we are * telling the Accept loop that we are done with the conn data * structure. That thread is then free to do anything it wants with the * connection, including deleting it, so we are not allowed to touch * conn after setting this state. * * In addition to releasing responsibility for the conn data structure, * when we set the state to AUTH_SUCCEEDED we are telling the server * accept loop that we are exiting now and so it can Join() on us (the * authentication thread) without being worried about blocking since the * next thing we do is exit. */ m_endpoint->m_authState = AUTH_FAILED; /* Alert the Run() thread to refresh the list of com ports to listen on. */ m_endpoint->m_transport->Alert(); return (void*)status; } /* * Tell the transport that the authentication has succeeded and that it can * now bring the connection up. */ DaemonSLAPEndpoint dEp = DaemonSLAPEndpoint::wrap(m_endpoint); m_endpoint->m_transport->Authenticated(dEp); QCC_DbgPrintf(("DaemonSLAPEndpoint::AuthThread::Run(): Returning")); /* * We are now done with the authentication process. We have succeeded doing * the authentication and we may or may not have succeeded in starting the * endpoint TX and RX threads depending on what happened down in * Authenticated(). What concerns us here is that we are done with this * thread (the authentication thread) and we are about to exit. Before * exiting, we must tell server accept loop that we are done with this data * structure. As soon as we set this state to AUTH_SUCCEEDED that thread is * then free to do anything it wants with the connection, including deleting * it, so we are not allowed to touch conn after setting this state. * * In addition to releasing responsibility for the conn data structure, when * we set the state to AUTH_SUCCEEDED we are telling the server accept loop * that we are exiting now and so it can Join() the authentication thread * without being worried about blocking since the next thing we do is exit. */ m_endpoint->m_authState = AUTH_SUCCEEDED; return (void*)status; } DaemonSLAPTransport::DaemonSLAPTransport(BusAttachment& bus) : m_bus(bus), stopping(false) { /* * We know we are daemon code, so we'd better be running with a daemon * router. This is assumed elsewhere. */ assert(bus.GetInternal().GetRouter().IsDaemon()); } DaemonSLAPTransport::~DaemonSLAPTransport() { Stop(); Join(); } QStatus DaemonSLAPTransport::Start() { stopping = false; ConfigDB* config = ConfigDB::GetConfigDB(); m_minHbeatIdleTimeout = config->GetLimit("slap_min_idle_timeout", MIN_HEARTBEAT_IDLE_TIMEOUT_DEFAULT); m_maxHbeatIdleTimeout = config->GetLimit("slap_max_idle_timeout", MAX_HEARTBEAT_IDLE_TIMEOUT_DEFAULT); m_defaultHbeatIdleTimeout = config->GetLimit("slap_default_idle_timeout", DEFAULT_HEARTBEAT_IDLE_TIMEOUT_DEFAULT); m_numHbeatProbes = HEARTBEAT_NUM_PROBES; m_maxHbeatProbeTimeout = config->GetLimit("slap_max_probe_timeout", MAX_HEARTBEAT_PROBE_TIMEOUT_DEFAULT); m_defaultHbeatProbeTimeout = config->GetLimit("slap_default_probe_timeout", DEFAULT_HEARTBEAT_PROBE_TIMEOUT_DEFAULT); QCC_DbgPrintf(("DaemonSLAPTransport: Using m_minHbeatIdleTimeout=%u, m_maxHbeatIdleTimeout=%u, m_numHbeatProbes=%u, m_defaultHbeatProbeTimeout=%u m_maxHbeatProbeTimeout=%u", m_minHbeatIdleTimeout, m_maxHbeatIdleTimeout, m_numHbeatProbes, m_defaultHbeatProbeTimeout, m_maxHbeatProbeTimeout)); return Thread::Start(); } QStatus DaemonSLAPTransport::Stop() { stopping = true; /* * Tell the DaemonSLAPTransport::Run thread to shut down. */ QStatus status = Thread::Stop(); if (status != ER_OK) { QCC_LogError(status, ("DaemonSLAPTransport::Stop(): Failed to Stop() main thread")); } m_lock.Lock(MUTEX_CONTEXT); /* * Ask any authenticating endpoints to shut down and exit their threads. */ for (set::iterator i = m_authList.begin(); i != m_authList.end(); ++i) { DaemonSLAPEndpoint ep = *i; ep->AuthStop(); } /* * Ask any running endpoints to shut down and exit their threads. */ for (set::iterator i = m_endpointList.begin(); i != m_endpointList.end(); ++i) { DaemonSLAPEndpoint ep = *i; ep->Stop(); } m_lock.Unlock(MUTEX_CONTEXT); return ER_OK; } QStatus DaemonSLAPTransport::Join() { /* * Wait for the DaemonSLAPTransport::Run thread to exit. */ QStatus status = Thread::Join(); if (status != ER_OK) { QCC_LogError(status, ("DaemonSLAPTransport::Join(): Failed to Join() main thread")); return status; } m_lock.Lock(MUTEX_CONTEXT); /* * Any authenticating endpoints have been asked to shut down and exit their * authentication threads in a previously required Stop(). We need to * Join() all of these auth threads here. */ set::iterator it = m_authList.begin(); while (it != m_authList.end()) { DaemonSLAPEndpoint ep = *it; m_authList.erase(it); m_lock.Unlock(MUTEX_CONTEXT); ep->AuthJoin(); m_lock.Lock(MUTEX_CONTEXT); it = m_authList.upper_bound(ep); } /* * Any running endpoints have been asked it their threads in a previously * required Stop(). We need to Join() all of thesse threads here. This * Join() will wait on the endpoint rx and tx threads to exit as opposed to * the joining of the auth thread we did above. */ it = m_endpointList.begin(); while (it != m_endpointList.end()) { DaemonSLAPEndpoint ep = *it; m_endpointList.erase(it); m_lock.Unlock(MUTEX_CONTEXT); ep->Join(); m_lock.Lock(MUTEX_CONTEXT); it = m_endpointList.upper_bound(ep); } stopping = false; m_lock.Unlock(MUTEX_CONTEXT); return ER_OK; } QStatus DaemonSLAPTransport::NormalizeTransportSpec(const char* inSpec, qcc::String& outSpec, std::map& argMap) const { QStatus status = ParseArguments(DaemonSLAPTransport::TransportName, inSpec, argMap); qcc::String type = Trim(argMap["type"]); qcc::String dev = Trim(argMap["dev"]); qcc::String baud = Trim(argMap["baud"]); /* * databits, parity, and stopbits are optional. They default to 8, none, and 1. */ qcc::String databits = Trim(argMap["databits"]); if (databits.empty()) { argMap["databits"] = databits = "8"; } qcc::String parity = Trim(argMap["parity"]); if (parity.empty()) { argMap["parity"] = parity = "none"; } qcc::String stopbits = Trim(argMap["stopbits"]); if (stopbits.empty()) { argMap["stopbits"] = stopbits = "1"; } if (status == ER_OK) { /* * Include only the type and dev in the outSpec. The outSpec * is intended to be unique per device (i.e. you can't have two * connections to the same device with different parameters). */ outSpec = "slap:"; if (!type.empty()) { outSpec.append("type="); outSpec.append(type); } else { status = ER_BUS_BAD_TRANSPORT_ARGS; } if (!dev.empty()) { outSpec.append(",dev="); outSpec.append(dev); } else { status = ER_BUS_BAD_TRANSPORT_ARGS; } } return status; } QStatus DaemonSLAPTransport::StartListen(const char* listenSpec) { if (stopping == true) { return ER_BUS_TRANSPORT_NOT_STARTED; } /* Normalize the listen spec. */ QStatus status; qcc::String normSpec; map serverArgs; status = NormalizeTransportSpec(listenSpec, normSpec, serverArgs); if (status != ER_OK) { QCC_LogError(status, ("DaemonTransport::StartListen(): Invalid SLAP listen spec \"%s\"", listenSpec)); return status; } m_lock.Lock(MUTEX_CONTEXT); for (list::iterator i = m_listenList.begin(); i != m_listenList.end(); i++) { if (i->normSpec == normSpec) { m_lock.Unlock(MUTEX_CONTEXT); return ER_BUS_ALREADY_LISTENING; } } /* Ignore incorrect listen spec i.e. other than uart */ if (serverArgs["type"] == "uart") { m_listenList.push_back(ListenEntry(normSpec, serverArgs)); } m_lock.Unlock(MUTEX_CONTEXT); Thread::Alert(); return ER_OK; } QStatus DaemonSLAPTransport::StopListen(const char* listenSpec) { QCC_UNUSED(listenSpec); return ER_OK; } void DaemonSLAPTransport::EndpointExit(RemoteEndpoint& ep) { /* * This is a callback driven from the remote endpoint thread exit function. * Our DaemonEndpoint inherits from class RemoteEndpoint and so when * either of the threads (transmit or receive) of one of our endpoints exits * for some reason, we get called back here. */ QCC_DbgPrintf(("DaemonSLAPTransport::EndpointExit()")); DaemonSLAPEndpoint dEp = DaemonSLAPEndpoint::cast(ep); /* Remove the dead endpoint from the live endpoint list */ m_lock.Lock(MUTEX_CONTEXT); QCC_DbgPrintf(("DaemonSLAPTransport::EndpointExit()setting stopping")); dEp->SetEpStopping(); Thread::Alert(); m_lock.Unlock(MUTEX_CONTEXT); ep->Invalidate(); } void* DaemonSLAPTransport::Run(void* arg) { QCC_UNUSED(arg); QStatus status = ER_OK; m_lock.Lock(MUTEX_CONTEXT); while (!IsStopping()) { /* * Each time through the loop we create a set of events to wait on. * We need to wait on the stop event and all of the SocketFds of the * addresses and ports we are listening on. If the list changes, the * code that does the change Alert()s this thread and we wake up and * re-evaluate the list of SocketFds. * Set reload to true to indicate that the set of events has been reloaded. */ QCC_DbgPrintf(("DaemonSLAPTransport::Run()")); UARTFd uartFd = (UARTFd) - 1; set::iterator i = m_authList.begin(); while (i != m_authList.end()) { uartFd = (UARTFd) - 1; DaemonSLAPEndpoint ep = *i; _DaemonSLAPEndpoint::AuthState authState = ep->GetAuthState(); if (authState == _DaemonSLAPEndpoint::AUTH_FAILED) { /* * The endpoint has failed authentication and the auth thread is * gone or is going away. Since it has failed there is no way this * endpoint is going to be started so we can get rid of it as soon * as we Join() the (failed) authentication thread. */ QCC_DbgPrintf(("DaemonSLAPTransport::Run(): Scavenging failed authenticator")); m_authList.erase(i); uartFd = ep->GetFd(); m_lock.Unlock(MUTEX_CONTEXT); ep->AuthStop(); ep->AuthJoin(); m_lock.Lock(MUTEX_CONTEXT); i = m_authList.upper_bound(ep); for (list::iterator it = m_listenList.begin(); it != m_listenList.end(); it++) { if (it->listenFd == uartFd) { QCC_DbgPrintf(("DaemonSLAPTransport::Run(): Reenabling %s in the listenEvents", it->args["port"].c_str())); it->listenFd = (UARTFd) - 1; it->endpointStarted = false; Thread::Alert(); } } } else { i++; } } i = m_endpointList.begin(); while (i != m_endpointList.end()) { uartFd = (UARTFd) - 1; DaemonSLAPEndpoint ep = *i; _DaemonSLAPEndpoint::EndpointState endpointState = ep->GetEpState(); /* * There are two possibilities for the disposition of the RX and * TX threads. First, they were never successfully started. In * this case, the epState will be EP_FAILED. If we find this, we * can just remove the useless endpoint from the list and delete * it. Since the threads were never started, they must not be * joined. */ if (endpointState == _DaemonSLAPEndpoint::EP_FAILED) { m_endpointList.erase(i); uartFd = ep->GetFd(); i = m_endpointList.upper_bound(ep); } else if (endpointState == _DaemonSLAPEndpoint::EP_STOPPING) { /* * The second possibility for the disposition of the RX and * TX threads is that they were successfully started but * have been stopped for some reason, either because of a * Disconnect() or a network error. In this case, the * epState will be EP_STOPPING, which was set in the * EndpointExit function. If we find this, we need to Join * the endpoint threads, remove the endpoint from the * endpoint list and delete it. Note that we are calling * the endpoint Join() to join the TX and RX threads and not * the endpoint AuthJoin() to join the auth thread. */ m_endpointList.erase(i); uartFd = ep->GetFd(); m_lock.Unlock(MUTEX_CONTEXT); ep->Stop(); ep->Join(); m_lock.Lock(MUTEX_CONTEXT); i = m_endpointList.upper_bound(ep); } else { i++; } if (uartFd != -1) { for (list::iterator it = m_listenList.begin(); it != m_listenList.end(); it++) { if (it->listenFd == uartFd) { QCC_DbgPrintf(("DaemonSLAPTransport::Run(): Reenabling back %s in the listenEvents", it->args["port"].c_str())); it->listenFd = (UARTFd) - 1; it->endpointStarted = false; break; } } } } vector checkEvents, signaledEvents; checkEvents.clear(); checkEvents.push_back(&stopEvent); for (list::iterator it = m_listenList.begin(); it != m_listenList.end(); ++it) { if (it->listenFd == -1) { /* open the port and set listen fd */ UARTFd listenFd; QStatus uartStatus = UART(it->args["dev"], StringToU32(it->args["baud"]), StringToU32(it->args["databits"]), it->args["parity"], StringToU32(it->args["stopbits"]), listenFd); if (uartStatus == ER_OK && listenFd != -1) { it->listenFd = listenFd; checkEvents.push_back(new Event(it->listenFd, Event::IO_READ)); QCC_DbgPrintf(("DaemonSLAPTransport::Run(): Adding checkevent for %s to list of events", it->args["dev"].c_str())); } else { QCC_LogError(uartStatus, ("DaemonSLAPTransport::Run(): Failed to open for %s", it->args["dev"].c_str())); m_listenList.erase(it++); } } else if (!it->endpointStarted) { checkEvents.push_back(new Event(it->listenFd, Event::IO_READ)); QCC_DbgPrintf(("DaemonSLAPTransport::Run(): Adding checkevent for %s to list of events", it->args["dev"].c_str())); } } m_lock.Unlock(MUTEX_CONTEXT); status = Event::Wait(checkEvents, signaledEvents); if (ER_OK != status) { break; } m_lock.Lock(MUTEX_CONTEXT); for (vector::iterator i = signaledEvents.begin(); i != signaledEvents.end(); ++i) { if (*i == &stopEvent) { /* This thread has been alerted or is being stopped. Will check the IsStopping() * flag when the while condition is encountered */ stopEvent.ResetEvent(); continue; } else { Event* e = *i; QCC_DbgPrintf(("DaemonSLAPTransport::Run(): Accepting connection ")); for (list::iterator i = m_listenList.begin(); i != m_listenList.end(); i++) { if (i->listenFd == e->GetFD()) { i->endpointStarted = true; static const bool truthiness = true; DaemonSLAPTransport* ptr = this; uint32_t packetSize = SLAP_DEFAULT_PACKET_SIZE; uint32_t baudrate = StringToU32(i->args["baud"]); QCC_DbgPrintf(("DaemonSLAPTransport::Run(): Creating endpoint for %s", i->args["dev"].c_str())); DaemonSLAPEndpoint conn(ptr, m_bus, truthiness, "slap", i->listenFd, packetSize, baudrate); QCC_DbgPrintf(("DaemonSLAPTransport::Run(): Authenticating endpoint for %s", i->args["dev"].c_str())); status = conn->Authenticate(); if (status == ER_OK) { m_authList.insert(conn); } break; } } } } for (vector::iterator i = checkEvents.begin(); i != checkEvents.end(); ++i) { Event* evt = *i; if (evt != &stopEvent) { delete evt; } } } m_lock.Unlock(MUTEX_CONTEXT); QCC_DbgPrintf(("DaemonSLAPTransport::Run() is exiting. status = %s", QCC_StatusText(status))); return (void*) status; } void DaemonSLAPTransport::Authenticated(DaemonSLAPEndpoint& conn) { QCC_DbgPrintf(("DaemonSLAPTransport::Authenticated()")); /* * If the transport is stopping, dont start the Tx and RxThreads. */ if (stopping == true) { return; } /* * If Authenticated() is being called, it is as a result of the * authentication thread telling us that it has succeeded. What we need to * do here is to try and Start() the endpoint which will spin up its TX and * RX threads and register the endpoint with the daemon router. As soon as * we call Start(), we are transferring responsibility for error reporting * through endpoint ThreadExit() function. This will percolate out our * EndpointExit function. It will expect to find on the endpoint * list so we move it from the authList to the endpointList before calling * Start. */ m_lock.Lock(MUTEX_CONTEXT); set::iterator i = find(m_authList.begin(), m_authList.end(), conn); assert(i != m_authList.end() && "DaemonSLAPTransport::Authenticated(): Conn not on m_authList"); /* * Note here that we have not yet marked the authState as AUTH_SUCCEEDED so * this is a point in time where the authState can be AUTH_AUTHENTICATING * and the endpoint can be on the endpointList and not the authList. */ m_authList.erase(i); m_endpointList.insert(conn); m_lock.Unlock(MUTEX_CONTEXT); conn->SetListener(this); conn->SetEpStarting(); QStatus status = conn->Start(m_defaultHbeatIdleTimeout, m_defaultHbeatProbeTimeout, m_numHbeatProbes, m_maxHbeatProbeTimeout); if (status != ER_OK) { QCC_LogError(status, ("DaemonSLAPTransport::Authenticated(): Failed to start DaemonSLAPEndpoint")); /* * We were unable to start up the endpoint for some reason. As soon as * we set this state to EP_FAILED, we are telling the server accept loop * that we tried to start the connection but it failed. This connection * is now useless and is a candidate for cleanup. This will be * prevented until authState changes from AUTH_AUTHENTICATING to * AUTH_SUCCEEDED. This may be a little confusing, but the * authentication process has really succeeded but the endpoint start * has failed. The combination of status in this case will be * AUTH_SUCCEEDED and EP_FAILED. Once this state is detected by the * server accept loop it is then free to do anything it wants with the * connection, including deleting it. */ conn->SetEpFailed(); } else { /* * We were able to successfully start up the endpoint. As soon as we * set this state to EP_STARTED, we are telling the server accept loop * that there are TX and RX threads wandering around in this endpoint. */ conn->SetEpStarted(); } } QStatus DaemonSLAPTransport::UntrustedClientStart() { /** Since UART implies physical security, always allow clients with ANONYMOUS authentication to connect. */ return ER_OK; } } alljoyn-15.04b/alljoyn_core/router/DaemonSLAPTransport.h000066400000000000000000000237611255700255500233250ustar00rootroot00000000000000/** * @file * DaemonSLAPTransport is a specialization of class Transport for communication between an AllJoyn * client application and the daemon over UART. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_DAEMONSLAPTRANSPORT_H #define _ALLJOYN_DAEMONSLAPTRANSPORT_H #ifndef __cplusplus #error Only include DaemonSLAPTransport.h in C++ code. #endif #include #include #include #include #include #include #include #include #include "Transport.h" #include "RemoteEndpoint.h" namespace ajn { class _DaemonSLAPEndpoint; typedef qcc::ManagedObj<_DaemonSLAPEndpoint> DaemonSLAPEndpoint; /** * @brief A class for the daemon end of the transport communicating over UART using the SLAP protocol. * */ class DaemonSLAPTransport : public Transport, public _RemoteEndpoint::EndpointListener, public qcc::Thread { friend class _DaemonSLAPEndpoint; public: /* Default packet size */ static const uint32_t SLAP_DEFAULT_PACKET_SIZE = 4000; /** * @internal * @brief Authentication complete notificiation. * * @param conn Reference to the DaemonSLAPEndpoint that completed authentication. */ void Authenticated(DaemonSLAPEndpoint& conn); /** * Create a transport to receive incoming connections from AllJoyn application. * * @param bus The bus associated with this transport. */ DaemonSLAPTransport(BusAttachment& bus); /** * Destructor */ ~DaemonSLAPTransport(); /** * Start the transport and associate it with the router. * * @return ER_OK if successful. */ QStatus Start(); /** * Stop the transport. * * @return ER_OK if successful. */ QStatus Stop(); /** * Pend the caller until the transport stops. * @return ER_OK if successful. */ QStatus Join(); /** * Determine if this transport is running. Running means Start() has been called. * * @return Returns true if the transport is running. */ bool IsRunning() { return Thread::IsRunning(); } /** * Get the transport mask for this transport * * @return the TransportMask for this transport. */ TransportMask GetTransportMask() const { return TRANSPORT_LOCAL; } /** * @internal * @brief Normalize a transport specification. * * Given a transport specification, convert it into a form which is guaranteed to * have a one-to-one relationship with a connection instance. * * @param inSpec Input transport connect spec. * @param outSpec Output transport connect spec. * @param argMap Parsed parameter map. * * @return ER_OK if successful. */ QStatus NormalizeTransportSpec(const char* inSpec, qcc::String& outSpec, std::map& argMap) const; /** * Start listening for incoming connections on a specified bus address. * * @param listenSpec Transport specific key/value arguments that specify the physical interface to listen on. * * @return * - ER_OK if successful. * - an error status otherwise. */ QStatus StartListen(const char* listenSpec); /** * @brief Stop listening for incoming connections on a specified bus address. * * This method cancels a StartListen request. Therefore, the listenSpec must * match previous call to StartListen(). * * @param listenSpec Transport specific key/value arguments that specify the physical interface to listen on. * * @return ER_OK if successful. */ QStatus StopListen(const char* listenSpec); /** * Returns the name of this transport */ const char* GetTransportName() const { return TransportName; } /** * Name of transport used in transport specs. */ static const char* TransportName; /** * Indicates whether this transport is used for client-to-bus or bus-to-bus connections. * * @return Always returns false, DaemonSLAPTransports are only used to accept connections from a local client. */ bool IsBusToBus() const { return false; } /** * Callback for Daemon RemoteEndpoint exit. * * @param endpoint Daemon RemoteEndpoint instance that has exited. */ void EndpointExit(RemoteEndpoint& endpoint); /** * Callback indicating that an untrusted client is trying to connect to this daemon. */ QStatus UntrustedClientStart(); /** * Callback indicating that an untrusted client has disconnected from this daemon. */ void UntrustedClientExit() { }; private: /** * @brief The default values for range and default idle timeout for * the DaemonSLAPTransport in seconds. * * This corresponds to the configuration items "slap_min_idle_timeout", * "slap_max_idle_timeout" and "slap_default_idle_timeout" * To override this value, change the limit, "slap_min_idle_timeout", * "slap_max_idle_timeout" and "slap_default_idle_timeout" */ static const uint32_t MIN_HEARTBEAT_IDLE_TIMEOUT_DEFAULT = 3; static const uint32_t MAX_HEARTBEAT_IDLE_TIMEOUT_DEFAULT = 30; static const uint32_t DEFAULT_HEARTBEAT_IDLE_TIMEOUT_DEFAULT = 20; /** * @brief The default probe timeout for DaemonSLAPTransport in seconds. * * This corresponds to the configuration item "slap_default_probe_timeout" * and "slap_max_probe_timeout" * To override this value, change the limit, "slap_default_probe_timeout" * and "slap_max_probe_timeout" */ static const uint32_t MAX_HEARTBEAT_PROBE_TIMEOUT_DEFAULT = 30; static const uint32_t DEFAULT_HEARTBEAT_PROBE_TIMEOUT_DEFAULT = 3; /** * @brief The number of DBus pings sent from Routing node to leaf node. * */ static const uint32_t HEARTBEAT_NUM_PROBES = 1; /** * Empty private overloaded virtual function for Thread::Start * this avoids the overloaded-virtual warning. For the Thread::Start * function. */ QStatus Start(void* arg, qcc::ThreadListener* listener) { return Thread::Start(arg, listener); } BusAttachment& m_bus; /**< The message bus for this transport */ bool stopping; /**< True if Stop() has been called but endpoints still exist */ struct ListenEntry { qcc::String normSpec; std::map args; qcc::UARTFd listenFd; bool endpointStarted; ListenEntry(qcc::String normSpec, std::map args) : normSpec(normSpec), args(args), listenFd((qcc::UARTFd)-1), endpointStarted(false) { } bool operator<(const ListenEntry& other) const { return (normSpec < other.normSpec) || ((normSpec == other.normSpec) && ((args < other.args) || ((args == other.args) && ((listenFd < other.listenFd) || ((listenFd == other.listenFd) && (endpointStarted < other.endpointStarted)))))); } bool operator==(const ListenEntry& other) const { return (normSpec == other.normSpec) && (args == other.args) && (listenFd == other.listenFd) && (endpointStarted == other.endpointStarted); } }; std::list m_listenList; /**< File descriptors the transport is listening on */ std::set m_endpointList; /**< List of active endpoints */ std::set m_authList; /**< List of active endpoints */ qcc::Mutex m_lock; /**< Mutex that protects the endpoint and auth list, and listen list */ /** * @internal * @brief Thread entry point. * * @param arg Thread entry arg. */ qcc::ThreadReturn STDCALL Run(void* arg); uint32_t m_minHbeatIdleTimeout; /**< The minimum allowed idle timeout for the Heartbeat between Routing node and Leaf node - configurable in router config */ uint32_t m_defaultHbeatIdleTimeout; /**< The default idle timeout for the Heartbeat between Routing node and Leaf node - configurable in router config */ uint32_t m_maxHbeatIdleTimeout; /**< The maximum allowed idle timeout for the Heartbeat between Routing node and Leaf node - configurable in router config */ uint32_t m_defaultHbeatProbeTimeout; /**< The time the Routing node should wait for Heartbeat response to be recieved from the Leaf node - configurable in router config */ uint32_t m_maxHbeatProbeTimeout; /**< The max time the Routing node should wait for Heartbeat response to be recieved from the Leaf node - configurable in router config */ uint32_t m_numHbeatProbes; /**< Number of probes Routing node should wait for Heartbeat response to be recieved from the Leaf node before declaring it dead - Transport specific */ }; } // namespace ajn #endif // _ALLJOYN_DAEMON_SLAP_TRANSPORT_H alljoyn-15.04b/alljoyn_core/router/DaemonTransport.cc000066400000000000000000000125371255700255500230020ustar00rootroot00000000000000/** * @file * Platform independent methods for DaemonTransport. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #include #include #include "BusInternal.h" #include "RemoteEndpoint.h" #include "Router.h" #include "DaemonTransport.h" #include "ConfigDB.h" #define QCC_MODULE "DAEMON_TRANSPORT" using namespace std; using namespace qcc; namespace ajn { DaemonTransport::DaemonTransport(BusAttachment& bus) : Thread("DaemonTransport"), bus(bus), stopping(false) { /* * We know we are daemon code, so we'd better be running with a daemon * router. This is assumed elsewhere. */ assert(bus.GetInternal().GetRouter().IsDaemon()); } DaemonTransport::~DaemonTransport() { Stop(); Join(); } QStatus DaemonTransport::Start() { stopping = false; ConfigDB* config = ConfigDB::GetConfigDB(); m_minHbeatIdleTimeout = config->GetLimit("dt_min_idle_timeout", MIN_HEARTBEAT_IDLE_TIMEOUT_DEFAULT); m_maxHbeatIdleTimeout = config->GetLimit("dt_max_idle_timeout", MAX_HEARTBEAT_IDLE_TIMEOUT_DEFAULT); m_defaultHbeatIdleTimeout = config->GetLimit("dt_default_idle_timeout", DEFAULT_HEARTBEAT_IDLE_TIMEOUT_DEFAULT); m_numHbeatProbes = HEARTBEAT_NUM_PROBES; m_maxHbeatProbeTimeout = config->GetLimit("dt_max_probe_timeout", MAX_HEARTBEAT_PROBE_TIMEOUT_DEFAULT); m_defaultHbeatProbeTimeout = config->GetLimit("dt_default_probe_timeout", DEFAULT_HEARTBEAT_PROBE_TIMEOUT_DEFAULT); QCC_DbgPrintf(("DaemonTransport: Using m_minHbeatIdleTimeout=%u, m_maxHbeatIdleTimeout=%u, m_numHbeatProbes=%u, m_defaultHbeatProbeTimeout=%u m_maxHbeatProbeTimeout=%u", m_minHbeatIdleTimeout, m_maxHbeatIdleTimeout, m_numHbeatProbes, m_defaultHbeatProbeTimeout, m_maxHbeatProbeTimeout)); return ER_OK; } QStatus DaemonTransport::Stop(void) { stopping = true; /* * Tell the server accept loop thread to shut down through the thread * base class. */ QStatus status = Thread::Stop(); if (status != ER_OK) { QCC_LogError(status, ("DaemonDaemonTransport::Stop(): Failed to Stop() server thread")); return status; } endpointListLock.Lock(MUTEX_CONTEXT); /* * Ask any running endpoints to shut down and exit their threads. */ for (list::iterator i = endpointList.begin(); i != endpointList.end(); ++i) { (*i)->Stop(); } endpointListLock.Unlock(MUTEX_CONTEXT); return ER_OK; } QStatus DaemonTransport::Join(void) { /* * Wait for the server accept loop thread to exit. */ QStatus status = Thread::Join(); if (status != ER_OK) { QCC_LogError(status, ("DaemonTransport::Join(): Failed to Join() server thread")); return status; } /* * A call to Stop() above will ask all of the endpoints to stop. We still * need to wait here until all of the threads running in those endpoints * actually stop running. When a remote endpoint thread exits the endpoint * will call back into our EndpointExit() and have itself removed from the * list. We poll for the all-exited condition, yielding the CPU to let * the endpoint therad wake and exit. */ endpointListLock.Lock(MUTEX_CONTEXT); while (endpointList.size() > 0) { endpointListLock.Unlock(MUTEX_CONTEXT); qcc::Sleep(50); endpointListLock.Lock(MUTEX_CONTEXT); } endpointListLock.Unlock(MUTEX_CONTEXT); stopping = false; return ER_OK; } void DaemonTransport::EndpointExit(RemoteEndpoint& ep) { /* * This is a callback driven from the remote endpoint thread exit function. * Our DaemonEndpoint inherits from class RemoteEndpoint and so when * either of the threads (transmit or receive) of one of our endpoints exits * for some reason, we get called back here. */ QCC_DbgTrace(("DaemonTransport::EndpointExit()")); /* Remove the dead endpoint from the live endpoint list */ endpointListLock.Lock(MUTEX_CONTEXT); list::iterator i = find(endpointList.begin(), endpointList.end(), ep); if (i != endpointList.end()) { endpointList.erase(i); } else { QCC_LogError(ER_FAIL, ("DaemonTransport::EndpointExit() endpoint missing from endpointList")); } endpointListLock.Unlock(MUTEX_CONTEXT); ep->Invalidate(); } } // namespace ajn alljoyn-15.04b/alljoyn_core/router/DaemonTransport.h000066400000000000000000000210301255700255500226300ustar00rootroot00000000000000/** * @file * DaemonTransport is a specialization of class Transport for communication between an AllJoyn * client application and the daemon. This is the daemon's counterpart to ClientTransport. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_DAEMONTRANSPORT_H #define _ALLJOYN_DAEMONTRANSPORT_H #ifndef __cplusplus #error Only include DaemonTransport.h in C++ code. #endif #include #include #include #include #include #include #include "Transport.h" #include "RemoteEndpoint.h" namespace ajn { /** * @brief A class for the daemon end of the client transport * * The DaemonTransport class has different incarnations depending on the platform. */ class DaemonTransport : public Transport, public _RemoteEndpoint::EndpointListener, public qcc::Thread { friend class _DaemonEndpoint; public: /** * Create a transport to receive incoming connections from AllJoyn application. * * @param bus The bus associated with this transport. */ DaemonTransport(BusAttachment& bus); /** * Destructor */ virtual ~DaemonTransport(); /** * Start the transport and associate it with the router. * * @return ER_OK if successful. */ virtual QStatus Start(); /** * Stop the transport. * * @return ER_OK if successful. */ virtual QStatus Stop(); /** * Determine if this transport is stopping. * Stopping means Stop() has been called but endpoints still exist. * * @return Returns true if the transport is running. */ bool IsTransportStopping() { return stopping; } /** * Pend the caller until the transport stops. * @return ER_OK if successful. */ virtual QStatus Join(); /** * Determine if this transport is running. Running means Start() has been called. * * @return Returns true if the transport is running. */ bool IsRunning() { return Thread::IsRunning(); } /** * Get the transport mask for this transport * * @return the TransportMask for this transport. */ TransportMask GetTransportMask() const { return TRANSPORT_LOCAL; } /** * @internal * @brief Normalize a transport specification. * * Given a transport specification, convert it into a form which is guaranteed to * have a one-to-one relationship with a connection instance. * * @param inSpec Input transport connect spec. * @param outSpec Output transport connect spec. * @param argMap Parsed parameter map. * * @return ER_OK if successful. */ virtual QStatus NormalizeTransportSpec(const char* inSpec, qcc::String& outSpec, std::map& argMap) const; /** * Start listening for incoming connections on a specified bus address. * * @param listenSpec Transport specific key/value arguments that specify the physical interface to listen on. * * @return * - ER_OK if successful. * - an error status otherwise. */ virtual QStatus StartListen(const char* listenSpec); /** * @brief Stop listening for incoming connections on a specified bus address. * * This method cancels a StartListen request. Therefore, the listenSpec must * match previous call to StartListen(). * * @param listenSpec Transport specific key/value arguments that specify the physical interface to listen on. * * @return ER_OK if successful. */ virtual QStatus StopListen(const char* listenSpec); /** * Returns the name of this transport */ virtual const char* GetTransportName() const { return TransportName; } /** * Name of transport used in transport specs. */ static const char* TransportName; /** * Indicates whether this transport is used for client-to-bus or bus-to-bus connections. * * @return Always returns false, DaemonTransports are only used to accept connections from a local client. */ bool IsBusToBus() const { return false; } /** * Callback for Daemon RemoteEndpoint exit. * * @param endpoint Daemon RemoteEndpoint instance that has exited. */ void EndpointExit(RemoteEndpoint& endpoint); protected: std::list endpointList; /**< List of active endpoints */ qcc::Mutex endpointListLock; /**< Mutex that protects the endpoint list */ BusAttachment& bus; /**< The message bus for this transport */ private: /** * @brief The default values for range and default idle timeout for * the DaemonTransport in seconds. * * This corresponds to the configuration items "dt_min_idle_timeout", * "dt_max_idle_timeout" and "dt_default_idle_timeout" * To override this value, change the limit, "dt_min_idle_timeout", * "dt_max_idle_timeout" and "dt_default_idle_timeout" */ static const uint32_t MIN_HEARTBEAT_IDLE_TIMEOUT_DEFAULT = 3; static const uint32_t MAX_HEARTBEAT_IDLE_TIMEOUT_DEFAULT = 30; static const uint32_t DEFAULT_HEARTBEAT_IDLE_TIMEOUT_DEFAULT = 20; /** * @brief The default probe timeout for DaemonTransport in seconds. * * This corresponds to the configuration item "dt_default_probe_timeout" * and "dt_max_probe_timeout" * To override this value, change the limit, "dt_default_probe_timeout" * and "dt_max_probe_timeout" */ static const uint32_t MAX_HEARTBEAT_PROBE_TIMEOUT_DEFAULT = 30; static const uint32_t DEFAULT_HEARTBEAT_PROBE_TIMEOUT_DEFAULT = 3; /** * @brief The number of DBus pings sent from Routing node to leaf node. * */ static const uint32_t HEARTBEAT_NUM_PROBES = 1; /** * Empty private overloaded virtual function for Thread::Start * this avoids the overloaded-virtual warning. For the Thread::Start * function. */ QStatus Start(void* arg, qcc::ThreadListener* listener) { return Thread::Start(arg, listener); } bool stopping; /**< True if Stop() has been called but endpoints still exist */ /** * @internal * @brief Thread entry point. * * @param arg Thread entry arg. */ qcc::ThreadReturn STDCALL Run(void* arg); uint32_t m_minHbeatIdleTimeout; /**< The minimum allowed idle timeout for the Heartbeat between Routing node and Leaf node - configurable in router config */ uint32_t m_defaultHbeatIdleTimeout; /**< The default idle timeout for the Heartbeat between Routing node and Leaf node - configurable in router config */ uint32_t m_maxHbeatIdleTimeout; /**< The maximum allowed idle timeout for the Heartbeat between Routing node and Leaf node - configurable in router config */ uint32_t m_defaultHbeatProbeTimeout; /**< The time the Routing node should wait for Heartbeat response to be recieved from the Leaf node - configurable in router config */ uint32_t m_maxHbeatProbeTimeout; /**< The max time the Routing node should wait for Heartbeat response to be recieved from the Leaf node - configurable in router config */ uint32_t m_numHbeatProbes; /**< Number of probes Routing node should wait for Heartbeat response to be recieved from the Leaf node before declaring it dead - Transport specific */ }; } // namespace ajn #endif // _ALLJOYN_DAEMONTRANSPORT_H alljoyn-15.04b/alljoyn_core/router/EndpointHelper.h000066400000000000000000000047251255700255500224440ustar00rootroot00000000000000/** * @file * Helper functions for dealing with endpoints */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ENDPOINT_HELPER_H #define _ENDPOINT_HELPER_H #include #include "BusEndpoint.h" #include "RemoteEndpoint.h" #include "VirtualEndpoint.h" #include "LocalTransport.h" namespace ajn { inline bool operator ==(const BusEndpoint& ep, const VirtualEndpoint& vep) { return ep.iden(vep); } inline bool operator ==(const VirtualEndpoint& vep, const BusEndpoint& ep) { return ep.iden(vep); } inline bool operator !=(const BusEndpoint& ep, const VirtualEndpoint& vep) { return !ep.iden(vep); } inline bool operator !=(const VirtualEndpoint& vep, const BusEndpoint& ep) { return !ep.iden(vep); } inline bool operator ==(const BusEndpoint& ep, const RemoteEndpoint& rep) { return ep.iden(rep); } inline bool operator ==(const RemoteEndpoint& rep, const BusEndpoint& ep) { return ep.iden(rep); } inline bool operator !=(const BusEndpoint& ep, const RemoteEndpoint& rep) { return !ep.iden(rep); } inline bool operator !=(const RemoteEndpoint& rep, const BusEndpoint& ep) { return !ep.iden(rep); } inline bool operator ==(const BusEndpoint& ep, const LocalEndpoint& lep) { return ep.iden(lep); } inline bool operator ==(const LocalEndpoint& lep, const BusEndpoint& ep) { return ep.iden(lep); } inline bool operator !=(const BusEndpoint& ep, const LocalEndpoint& lep) { return !ep.iden(lep); } inline bool operator !=(const LocalEndpoint& lep, const BusEndpoint& ep) { return !ep.iden(lep); } } #endif alljoyn-15.04b/alljoyn_core/router/NameTable.cc000066400000000000000000000574721255700255500215210ustar00rootroot00000000000000/** * @file * NameTable is a thread-safe mapping between unique/well-known * bus names and the BusEndpoint that these names exist on. * This mapping is many (names) to one (endpoint). Every endpoint has * exactly one unique name and zero or more well-known names. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #include "NameTable.h" #include "VirtualEndpoint.h" #include "EndpointHelper.h" #include #define QCC_MODULE "ALLJOYN" using namespace std; using namespace qcc; namespace ajn { SessionOpts::NameTransferType NameTable::GetNameTransfer(const VirtualEndpoint& vep) { multimap b2bEps = vep->GetBusToBusEndpoints(); if (b2bEps.empty()) { return SessionOpts::ALL_NAMES; } else { SessionOpts::NameTransferType nameTransfer = SessionOpts::SLS_NAMES; for (multimap::const_iterator it = b2bEps.begin(); it != b2bEps.end(); ++it) { if (it->second->GetFeatures().nameTransfer != SessionOpts::SLS_NAMES) { nameTransfer = SessionOpts::ALL_NAMES; break; } } return nameTransfer; } } SessionOpts::NameTransferType NameTable::GetNameTransfer(BusEndpoint& ep) { if (ep->GetEndpointType() == ENDPOINT_TYPE_VIRTUAL) { VirtualEndpoint vep = VirtualEndpoint::cast(ep); return GetNameTransfer(vep); } else { return SessionOpts::ALL_NAMES; } } qcc::String NameTable::GenerateUniqueName(void) { return uniquePrefix + U32ToString(IncrementAndFetch((int32_t*)&uniqueId)); } void NameTable::SetGUID(const qcc::GUID128& guid) { QCC_DbgPrintf(("AllJoyn Daemon GUID = %s (%s)\n", guid.ToString().c_str(), guid.ToShortString().c_str())); uniquePrefix = ":"; uniquePrefix.append(guid.ToShortString()); uniquePrefix.append("."); } void NameTable::AddUniqueName(BusEndpoint& endpoint) { QCC_DbgTrace(("NameTable::AddUniqueName(%s)", endpoint->GetUniqueName().c_str())); SessionOpts::NameTransferType nameTransfer = GetNameTransfer(endpoint); const qcc::String& uniqueName = endpoint->GetUniqueName(); lock.Lock(MUTEX_CONTEXT); UniqueNameEntry entry = { endpoint, nameTransfer }; uniqueNames[uniqueName] = entry; lock.Unlock(MUTEX_CONTEXT); /* Notify listeners */ CallListeners(uniqueName, NULL, SessionOpts::ALL_NAMES, &uniqueName, nameTransfer); } void NameTable::RemoveUniqueName(const qcc::String& uniqueName) { QCC_DbgTrace(("RemoveUniqueName %s", uniqueName.c_str())); /* Erase the unique bus name and any well-known names that use the same endpoint */ lock.Lock(MUTEX_CONTEXT); unordered_map::iterator it = uniqueNames.find(uniqueName); if (it != uniqueNames.end()) { BusEndpoint endpoint = it->second.endpoint; SessionOpts::NameTransferType nameTransfer = it->second.nameTransfer; /* Remove well-known names asssociated with uniqueName */ unordered_map, Hash, Equal>::iterator ait = aliasNames.begin(); while (ait != aliasNames.end()) { deque::iterator lit = ait->second.begin(); bool startOver = false; while (lit != ait->second.end()) { if (lit->endpointName == endpoint->GetUniqueName()) { if (lit == ait->second.begin()) { uint32_t disposition; String alias = ait->first; String epName = endpoint->GetUniqueName(); /* Must unlock before calling RemoveAlias because it can call out (and cannot be locked at the time) */ lock.Unlock(MUTEX_CONTEXT); RemoveAlias(alias, epName, disposition, NULL, NULL); lock.Lock(MUTEX_CONTEXT); /* Make sure iterator is still valid */ it = uniqueNames.find(uniqueName); if (it == uniqueNames.end()) { break; } if (DBUS_RELEASE_NAME_REPLY_RELEASED == disposition) { ait = aliasNames.begin(); startOver = true; break; } else { QCC_LogError(ER_FAIL, ("Failed to release %s from %s", alias.c_str(), epName.c_str())); break; } } else { ait->second.erase(lit); break; } } else { ++lit; } } if (!startOver) { ++ait; } } if (it != uniqueNames.end()) { uniqueNames.erase(it); QCC_DbgPrintf(("Removed ep=%s from name table", uniqueName.c_str())); } lock.Unlock(MUTEX_CONTEXT); /* Notify listeners */ CallListeners(uniqueName, &uniqueName, nameTransfer, NULL, SessionOpts::ALL_NAMES); } else { lock.Unlock(MUTEX_CONTEXT); } } QStatus NameTable::AddAlias(const qcc::String& aliasName, const qcc::String& uniqueName, uint32_t flags, uint32_t& disposition, NameListener* listener, void* context) { QStatus status; QCC_DbgTrace(("NameTable: AddAlias(%s, %s)", aliasName.c_str(), uniqueName.c_str())); lock.Lock(MUTEX_CONTEXT); unordered_map::const_iterator it = uniqueNames.find(uniqueName); if (it != uniqueNames.end()) { unordered_map, Hash, Equal>::iterator wasIt = aliasNames.find(aliasName); NameQueueEntry entry = { uniqueName, flags }; /* * The value of origOwner comes from data that may be freed after the lock is released, so we can't * just use a pointer here, must make a copy. newOwner does not have the same problem. */ qcc::String origOwner; SessionOpts::NameTransferType origOwnerNameTransfer = SessionOpts::ALL_NAMES; const qcc::String* newOwner = NULL; if (wasIt != aliasNames.end()) { assert(!wasIt->second.empty()); const NameQueueEntry& primary = wasIt->second[0]; if (primary.endpointName == uniqueName) { /* Enpoint already owns this alias */ disposition = DBUS_REQUEST_NAME_REPLY_ALREADY_OWNER; } else if ((primary.flags & DBUS_NAME_FLAG_ALLOW_REPLACEMENT) && (flags & DBUS_NAME_FLAG_REPLACE_EXISTING)) { /* Make endpoint the current owner */ wasIt->second.push_front(entry); disposition = DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER; origOwner = primary.endpointName; newOwner = &uniqueName; } else { if (flags & DBUS_NAME_FLAG_DO_NOT_QUEUE) { /* Cannot replace current owner */ disposition = DBUS_REQUEST_NAME_REPLY_EXISTS; } else { /* Add this new potential owner to the end of the list */ wasIt->second.push_back(entry); disposition = DBUS_REQUEST_NAME_REPLY_IN_QUEUE; } } } else { /* No pre-existing queue for this name */ aliasNames[aliasName] = deque(1, entry); disposition = DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER; newOwner = &uniqueName; /* Check to see if we are overriding a virtual (remote) name */ map::const_iterator vit = virtualAliasNames.find(aliasName); if (vit != virtualAliasNames.end()) { origOwner = vit->second.endpoint->GetUniqueName(); origOwnerNameTransfer = vit->second.nameTransfer; } } lock.Unlock(MUTEX_CONTEXT); if (listener) { listener->AddAliasComplete(aliasName, disposition, context); } if (newOwner) { CallListeners(aliasName, origOwner.empty() ? NULL : &origOwner, origOwnerNameTransfer, newOwner, SessionOpts::ALL_NAMES); } status = ER_OK; } else { status = ER_BUS_NO_ENDPOINT; lock.Unlock(MUTEX_CONTEXT); } return status; } void NameTable::RemoveAlias(const qcc::String& aliasName, const qcc::String& ownerName, uint32_t& disposition, NameListener* listener, void* context) { qcc::String oldOwner; qcc::String newOwner; SessionOpts::NameTransferType newOwnerNameTransfer = SessionOpts::ALL_NAMES; qcc::String aliasNameCopy(aliasName); QCC_DbgTrace(("NameTable: RemoveAlias(%s, %s)", aliasName.c_str(), ownerName.c_str())); lock.Lock(MUTEX_CONTEXT); /* Find endpoint for aliasName */ unordered_map, Hash, Equal>::iterator it = aliasNames.find(aliasName); if (it != aliasNames.end()) { deque& queue = it->second; assert(!queue.empty()); if (queue[0].endpointName == ownerName) { /* Remove primary */ if (queue.size() > 1) { queue.pop_front(); BusEndpoint ep = FindEndpoint(queue[0].endpointName); if (ep->IsValid()) { newOwner = queue[0].endpointName; } } if (newOwner.empty()) { /* Check to see if there is a (now unmasked) remote owner for the alias */ map::const_iterator vit = virtualAliasNames.find(aliasName); if (vit != virtualAliasNames.end()) { newOwner = vit->second.endpoint->GetUniqueName(); newOwnerNameTransfer = vit->second.nameTransfer; } aliasNames.erase(it); } oldOwner = ownerName; disposition = DBUS_RELEASE_NAME_REPLY_RELEASED; } else { /* Alias is not owned by ownerName */ disposition = DBUS_RELEASE_NAME_REPLY_NOT_OWNER; } } else { disposition = DBUS_RELEASE_NAME_REPLY_NON_EXISTENT; } lock.Unlock(MUTEX_CONTEXT); if (listener) { listener->RemoveAliasComplete(aliasNameCopy, disposition, context); } if (!oldOwner.empty()) { CallListeners(aliasNameCopy, &oldOwner, SessionOpts::ALL_NAMES, newOwner.empty() ? NULL : &newOwner, newOwnerNameTransfer); } } bool NameTable::IsValidLocalUniqueName(const qcc::String& uniqueName) const { bool ret = false; size_t period_pos = uniqueName.find("."); if (period_pos != String::npos) { size_t period_pos1 = uniqueName.find(".", period_pos + 1); if (period_pos1 == String::npos) { // Contains exactly one "." String guid = uniqueName.substr(0, GUID128::SIZE_SHORT + 2); if (guid == uniquePrefix) { //guid matches uniquePrefix String idStr = uniqueName.substr(GUID128::SIZE_SHORT + 2); uint32_t id = StringToU32(idStr); if ((id != 0) && (id <= uniqueId)) { //valid id ret = true; } } } } return ret; } BusEndpoint NameTable::FindEndpoint(const qcc::String& busName) const { BusEndpoint ep; lock.Lock(MUTEX_CONTEXT); if (busName[0] == ':') { unordered_map::const_iterator it = uniqueNames.find(busName); if (it != uniqueNames.end()) { ep = it->second.endpoint; } } else { unordered_map, Hash, Equal>::const_iterator it = aliasNames.find(busName); if (it != aliasNames.end()) { assert(!it->second.empty()); ep = FindEndpoint(it->second[0].endpointName); } /* Fallback to virtual (remote) aliases if a suitable local one cannot be found */ if (!ep->IsValid()) { map::const_iterator vit = virtualAliasNames.find(busName); if (vit != virtualAliasNames.end()) { VirtualEndpoint vep = vit->second.endpoint; ep = BusEndpoint::cast(vep); } } } lock.Unlock(MUTEX_CONTEXT); return ep; } void NameTable::GetBusNames(vector& names) const { lock.Lock(MUTEX_CONTEXT); unordered_map, Hash, Equal>::const_iterator it = aliasNames.begin(); while (it != aliasNames.end()) { names.push_back(it->first); ++it; } unordered_map::const_iterator uit = uniqueNames.begin(); while (uit != uniqueNames.end()) { names.push_back(uit->first); ++uit; } lock.Unlock(MUTEX_CONTEXT); } void NameTable::GetUniqueNamesAndAliases(vector > >& names) const { /* Create a intermediate map to avoid N^2 perf */ multimap epMap; lock.Lock(MUTEX_CONTEXT); unordered_map::const_iterator uit = uniqueNames.begin(); while (uit != uniqueNames.end()) { epMap.insert(pair(uit->second.endpoint, uit->first)); ++uit; } unordered_map, Hash, Equal>::const_iterator ait = aliasNames.begin(); while (ait != aliasNames.end()) { if (!ait->second.empty()) { BusEndpoint ep = FindEndpoint(ait->second.front().endpointName); if (ep->IsValid()) { epMap.insert(pair(ep, ait->first)); } } ++ait; } map::const_iterator vit = virtualAliasNames.begin(); while (vit != virtualAliasNames.end()) { VirtualEndpoint vep = vit->second.endpoint; epMap.insert(pair(BusEndpoint::cast(vep), vit->first.c_str())); ++vit; } lock.Unlock(MUTEX_CONTEXT); /* Fill in the caller's vector */ qcc::String uniqueName; vector aliasVec; BusEndpoint lastEp; multimap::iterator it = epMap.begin(); names.reserve(uniqueNames.size()); // prevent dynamic resizing in loop for (;;) { if ((it == epMap.end()) || (lastEp != it->first)) { if (!uniqueName.empty()) { names.push_back(pair >(uniqueName, aliasVec)); } uniqueName.clear(); aliasVec.clear(); if (it == epMap.end()) { break; } } const String& name = it->second; if (name[0] == ':') { uniqueName = name; } else { aliasVec.push_back(name); } lastEp = it->first; ++it; } } void NameTable::GetQueuedNames(const qcc::String& busName, std::vector& names) { unordered_map, Hash, Equal>::iterator ait = aliasNames.find(busName.c_str()); if (ait != aliasNames.end()) { names.reserve(ait->second.size()); //prevent dynamic resizing in loop for (deque::iterator lit = ait->second.begin(); lit != ait->second.end(); ++lit) { names.push_back(lit->endpointName); } } else { names.clear(); } } void NameTable::UpdateVirtualAliases(const qcc::String& epName) { lock.Lock(MUTEX_CONTEXT); BusEndpoint tempEp = FindEndpoint(epName); VirtualEndpoint ep = VirtualEndpoint::cast(tempEp); QCC_DbgTrace(("NameTable::UpdateVirtualAliases(%s)", ep->IsValid() ? ep->GetUniqueName().c_str() : "")); if (ep->IsValid()) { map::iterator vit = virtualAliasNames.begin(); while (vit != virtualAliasNames.end()) { SessionOpts::NameTransferType oldNameTransfer = SessionOpts::ALL_NAMES; SessionOpts::NameTransferType newNameTransfer = SessionOpts::ALL_NAMES; bool madeChange = false; if (vit->second.endpoint == ep) { oldNameTransfer = vit->second.nameTransfer; newNameTransfer = GetNameTransfer(vit->second.endpoint); madeChange = (oldNameTransfer != newNameTransfer); vit->second.nameTransfer = newNameTransfer; } String alias = vit->first.c_str(); if (madeChange && (aliasNames.find(alias) == aliasNames.end())) { lock.Unlock(MUTEX_CONTEXT); CallListeners(alias, &epName, oldNameTransfer, &epName, newNameTransfer); lock.Lock(MUTEX_CONTEXT); vit = virtualAliasNames.upper_bound(alias); } else { ++vit; } } } lock.Unlock(MUTEX_CONTEXT); } void NameTable::RemoveVirtualAliases(const qcc::String& epName) { lock.Lock(MUTEX_CONTEXT); BusEndpoint tempEp = FindEndpoint(epName); VirtualEndpoint ep = VirtualEndpoint::cast(tempEp); QCC_DbgTrace(("NameTable::RemoveVirtualAliases(%s)", ep->IsValid() ? ep->GetUniqueName().c_str() : "")); if (ep->IsValid()) { map::iterator vit = virtualAliasNames.begin(); while (vit != virtualAliasNames.end()) { if (vit->second.endpoint == ep) { String alias = vit->first.c_str(); SessionOpts::NameTransferType nameTransfer = vit->second.nameTransfer; virtualAliasNames.erase(vit++); if (aliasNames.find(alias) == aliasNames.end()) { lock.Unlock(MUTEX_CONTEXT); CallListeners(alias, &epName, nameTransfer, NULL, SessionOpts::ALL_NAMES); lock.Lock(MUTEX_CONTEXT); vit = virtualAliasNames.upper_bound(alias); } } else { ++vit; } } } lock.Unlock(MUTEX_CONTEXT); } bool NameTable::SetVirtualAlias(const qcc::String& alias, VirtualEndpoint* newOwner, VirtualEndpoint& requestingEndpoint) { QCC_DbgTrace(("NameTable::SetVirtualAlias(%s, %p/%s, %p/%s)", alias.c_str(), newOwner ? (*newOwner).unwrap() : NULL, newOwner ? (*newOwner)->GetUniqueName().c_str() : "", requestingEndpoint.unwrap(), requestingEndpoint->GetUniqueName().c_str())); lock.Lock(MUTEX_CONTEXT); VirtualEndpoint oldOwner; String oldName; SessionOpts::NameTransferType oldOwnerNameTransfer = SessionOpts::ALL_NAMES; map::iterator vit = virtualAliasNames.find(alias); if (vit != virtualAliasNames.end()) { oldOwner = vit->second.endpoint; } if (oldOwner->IsValid()) { oldName = oldOwner->GetUniqueName(); oldOwnerNameTransfer = vit->second.nameTransfer; /* * Virtual aliases cannot directly change ownership from one remote daemon to another. * Allowing this would allow a daemon to "take" an existing name from another daemon. * Name changes are allowed within the same remote daemon or when the name is not already * owned. */ const String& reqOwnerName = requestingEndpoint->GetUniqueName(); size_t oldPeriodOff = oldName.find_first_of('.'); size_t reqPeriodOff = reqOwnerName.find_first_of('.'); if ((oldPeriodOff == String::npos) || (0 != oldName.compare(0, oldPeriodOff, reqOwnerName, 0, reqPeriodOff))) { lock.Unlock(MUTEX_CONTEXT); return false; } } bool maskingLocalName = (aliasNames.find(alias) != aliasNames.end()); String newName; SessionOpts::NameTransferType newOwnerNameTransfer = SessionOpts::ALL_NAMES; bool madeChange = false; if (newOwner && (*newOwner)->IsValid()) { newOwnerNameTransfer = GetNameTransfer(*newOwner); VirtualAliasEntry entry = { *newOwner, newOwnerNameTransfer }; virtualAliasNames[alias] = entry; madeChange = !newOwner->iden(oldOwner) || (oldOwnerNameTransfer != newOwnerNameTransfer); } else { virtualAliasNames.erase(StringMapKey(alias)); madeChange = true; } if (newOwner && (*newOwner)->IsValid()) { newName = (*newOwner)->GetUniqueName(); } lock.Unlock(MUTEX_CONTEXT); /* Virtual aliases cannot override locally requested aliases */ if (madeChange && !maskingLocalName) { CallListeners(alias, oldName.empty() ? NULL : &oldName, oldOwnerNameTransfer, newName.empty() ? NULL : &newName, newOwnerNameTransfer); } return madeChange; } void NameTable::AddListener(NameListener* listener) { lock.Lock(MUTEX_CONTEXT); listeners.insert(ProtectedNameListener(listener)); lock.Unlock(MUTEX_CONTEXT); } void NameTable::RemoveListener(NameListener* listener) { lock.Lock(MUTEX_CONTEXT); ProtectedNameListener pl(listener); set::iterator it = listeners.find(pl); if (it != listeners.end()) { /* Remove listener from set */ listeners.erase(it); /* Wait until references to pl reach q (pl is only remaining ref) */ while (pl.GetRefCount() > 1) { lock.Unlock(MUTEX_CONTEXT); qcc::Sleep(4); lock.Lock(MUTEX_CONTEXT); } } lock.Unlock(MUTEX_CONTEXT); } void NameTable::CallListeners(const qcc::String& aliasName, const qcc::String* oldOwner, SessionOpts::NameTransferType oldOwnerNameTransfer, const qcc::String* newOwner, SessionOpts::NameTransferType newOwnerNameTransfer) { lock.Lock(MUTEX_CONTEXT); set::iterator it = listeners.begin(); while (it != listeners.end()) { ProtectedNameListener nl = *it; lock.Unlock(MUTEX_CONTEXT); (*nl)->NameOwnerChanged(aliasName, oldOwner, oldOwnerNameTransfer, newOwner, newOwnerNameTransfer); lock.Lock(MUTEX_CONTEXT); it = listeners.upper_bound(nl); } lock.Unlock(MUTEX_CONTEXT); } } alljoyn-15.04b/alljoyn_core/router/NameTable.h000066400000000000000000000317421255700255500213530ustar00rootroot00000000000000/** * @file * NameTable is a thread-safe mapping between unique/well-known * bus names and the Transport that these names exist on. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_NAMETABLE_H #define _ALLJOYN_NAMETABLE_H #include #include #include #include #include #include #include #include #include #include "BusEndpoint.h" #include "VirtualEndpoint.h" #include namespace ajn { /** @internal Forward reference */ class NameListener; /** * NameTable is a thread-safe mapping between unique/well-known * bus names and the BusEndpoint that these names exist on. * This mapping is many (names) to one (endpoint). Every endpoint has * exactly one unique name and zero or more well-known names. */ class NameTable { public: /** * AddAlias complete callback */ typedef void (*AddAliasComplete)(qcc::String& busName, uint32_t disposition, void* context); /** * RemoveAlias complete callback */ typedef void (*RemoveAliasComplete)(qcc::String& busName, uint32_t disposition, void* context); /** * Constructor */ NameTable() : uniqueId(0), uniquePrefix(":1.") { } /** * Set the GUID of the bus. * This unique bus names are assigned using the bus guid as a prefix. This * ensures that AllJoyn endpoints are globally unique. * * @param guid The bus guid. */ void SetGUID(const qcc::GUID128& guid); /** * Register a listener that will be called whenever ownership of a bus name * (unique or well-known) changes. * * @param listener Listener to be notified */ void AddListener(NameListener* listener); /** * Un-Register a listener that was previously registered with AddListener. * * @param listener Listener to be notified */ void RemoveListener(NameListener* listener); /** * Generate a unique bus name. * * @return A unique name string that can be assigned to a msgbus endpoint. */ qcc::String GenerateUniqueName(void); /** * Add an endpoint and it's unique name to the name table. * * @param endpoint Endpoint whose unique name will be added to the name table. */ void AddUniqueName(BusEndpoint& endpoint); /** * Release a unique name and any well-known names associated with the endpoint. * * @param uniqueName Unique name. */ void RemoveUniqueName(const qcc::String& uniqueName); /** * Add a well-known (alias) bus name. * * @param aliasName Alias (well-known) name of bus. * @param uniqueName Unique name of endpoint attempting to own aliasName. * @param flags AliasFlags associated with alias request. * @param disposition [OUT] Outcome of add alias. Only valid if return status is ER_OK. * @param listener Optional listener whose AddAliasComplete callback will be called if return code is ER_OK. * @param context Optional context passed to AddAliasComplete callback. * @return ER_OK if successful; */ QStatus AddAlias(const qcc::String& aliasName, const qcc::String& uniqueName, uint32_t flags, uint32_t& disposition, NameListener* listener = NULL, void* context = NULL); /** * Remove a well-known bus name. * * @param aliasName Well-known name to remove. * @param ownerName Unique name of busName owner. * @param disposition [OUT] Outcome of remove alias operation. Only valid if return is ER_OK. * @param listener Optional listener whose RemoveAliasComplete callback will be called if return code is ER_OK. * @param context Optional context passed to RemoveAliasComplete callback. */ void RemoveAlias(const qcc::String& aliasName, const qcc::String& ownerName, uint32_t& disposition, NameListener* listener = NULL, void* context = NULL); /** * Set a virtual alias. * A virtual alias is a well-known bus name for a virtual endpoint. * Virtual aliases differ from regular aliases in that the local bus controller * does not handle name queueing. It is up to the remote endpoint to manange * the queueing for such aliases. * * @param alias The virtual alias being modified. * @param newownerEp The VirtualEndpoint that is the new owner of alias or NULL if none. * @param requestingEndpoint The VirtualEndpoint that is requesting the change * @return true if this request caused changes to the name table. */ bool SetVirtualAlias(const qcc::String& alias, VirtualEndpoint* newOwnerEp, VirtualEndpoint& requestingEndpoint); /** * Remove well-known names associated with a virtual endpoint. * * @param uniqueName UniqueName of virtual endpoint whose well-known names are to be removed. */ void RemoveVirtualAliases(const qcc::String& uniqueName); /** * Update propagation info of names associated with a virtual endpoint. * * @param uniqueName UniqueName of virtual endpoint whose propagation info is to be updated. */ void UpdateVirtualAliases(const qcc::String& uniqueName); /** * Find an endpoint for a given unique or alias bus name. * * @param busName Name of bus. * @return Returns the endpoint if it was found or an invalid endpoint if not found */ BusEndpoint FindEndpoint(const qcc::String& busName) const; /** * Return whether this is a unique name of a locally connected endpoint. * * @param uniqueName Unique name to check. * @return true if a locally connected endpoint has this unique name. */ bool IsValidLocalUniqueName(const qcc::String& uniqueName) const; /** * Get all bus names from name table. * * @param[out] names Vector of names. */ void GetBusNames(std::vector& names) const; /** * Get all unique names and their alias (well-known) names. * * @param[out] nameVec Vector of (uniqueName, aliases) pairs where aliases is a vector of alias names. */ void GetUniqueNamesAndAliases(std::vector > >& nameVec) const; /** * Get all the unique names that are in queue for the same alias (well-known) name * * @param[in] busName (well-known) name * @param[out] names vecter of uniqueNames in queue for the */ void GetQueuedNames(const qcc::String& busName, std::vector& names); /** * Lock table. */ void Lock() { lock.Lock(MUTEX_CONTEXT); } /** * Lock table. */ void Unlock() { lock.Unlock(MUTEX_CONTEXT); } private: typedef struct { BusEndpoint endpoint; SessionOpts::NameTransferType nameTransfer; } UniqueNameEntry; typedef struct { qcc::String endpointName; uint32_t flags; } NameQueueEntry; typedef struct { VirtualEndpoint endpoint; SessionOpts::NameTransferType nameTransfer; } VirtualAliasEntry; /** * Hash functor */ struct Hash { inline size_t operator()(const qcc::String& s) const { return qcc::hash_string(s.c_str()); } }; struct Equal { inline bool operator()(const qcc::String& s1, const qcc::String& s2) const { return s1 == s2; } }; mutable qcc::Mutex lock; /**< Lock protecting name tables */ std::unordered_map uniqueNames; /**< Unique name table */ std::unordered_map, Hash, Equal> aliasNames; /**< Alias name table */ uint32_t uniqueId; qcc::String uniquePrefix; typedef qcc::ManagedObj ProtectedNameListener; std::set listeners; /**< Listeners regsitered with name table */ std::map virtualAliasNames; /**< map of virtual aliases to virtual endpts */ /** * Returns the minimum name transfer value for sessions with the endpoint. * * @param ep the endpoint */ SessionOpts::NameTransferType GetNameTransfer(BusEndpoint& ep); /** * Returns the minimum name transfer value for sessions with the endpoint. * * @param vep the virtual endpoint */ SessionOpts::NameTransferType GetNameTransfer(const VirtualEndpoint& vep); /** * Helper used to call the listners * * @param alias Well-known bus name now owned by listener. * @param oldOwner Unique name of old owner of alias or NULL if none existed. * @param oldOwnerNameTransfer Whether the old owner should be propagated (ALL_NAMES, P2P_NAMES or MP_NAMES) * or not (SLS_NAMES). * @param newOwner Unique name of new owner of alias or NULL if none (now) exists. * @param newOwnerNameTransfer Whether the new owner should be propagated (ALL_NAMES, P2P_NAMES or MP_NAMES) * or not (SLS_NAMES). */ void CallListeners(const qcc::String& aliasName, const qcc::String* oldOwner, SessionOpts::NameTransferType oldOwnerNameTransfer, const qcc::String* newOwner, SessionOpts::NameTransferType newOwnerNameTransfer); }; /** * AllJoynNameListeners are notified by the NameTable when message * bus name events interest occur. */ class NameListener { public: /** * Virtual destructor for derivable class. */ virtual ~NameListener() { } /** * Called when a bus name changes ownership. * * @param alias Well-known bus name now owned by listener. * @param oldOwner Unique name of old owner of alias or NULL if none existed. * @param oldOwnerNameTransfer Whether the old owner should be propagated (ALL_NAMES, P2P_NAMES or MP_NAMES) * or not (SLS_NAMES). * @param newOwner Unique name of new owner of alias or NULL if none (now) exists. * @param newOwnerNameTransfer Whether the new owner should be propagated (ALL_NAMES, P2P_NAMES or MP_NAMES) * or not (SLS_NAMES). */ virtual void NameOwnerChanged(const qcc::String& alias, const qcc::String* oldOwner, SessionOpts::NameTransferType oldOwnerNameTransfer, const qcc::String* newOwner, SessionOpts::NameTransferType newOwnerNameTransfer) = 0; /** * Called upon completion of AddAlias call. * This method is guaranteed to be called BEFORE any "owner changed" or other asynchronous callback * that was triggered by the AddAlias call. * * @param aliasName Name of alias * @param disposition Disposition of aliasName as a result of AddAlias call. * @param context Context passed to AddAlias. */ virtual void AddAliasComplete(const qcc::String& aliasName, uint32_t disposition, void* context) { QCC_UNUSED(aliasName); QCC_UNUSED(disposition); QCC_UNUSED(context); } /** * Called upon completion of RemoveAlias call. * This method is guaranteed to be called BEFORE any "owner changed" or other asynchronous callback * that was triggered by the RemoveAlias call. * * @param aliasName Name of alias * @param disposition Disposition of aliasName as a result of AddAlias call. * @param context Context passed to AddAlias. */ virtual void RemoveAliasComplete(const qcc::String& aliasName, uint32_t disposition, void* context) { QCC_UNUSED(aliasName); QCC_UNUSED(disposition); QCC_UNUSED(context); } }; } #endif alljoyn-15.04b/alljoyn_core/router/PermissionMgr.cc000066400000000000000000000066521255700255500224610ustar00rootroot00000000000000/** * @file * This class is to manage the permission of an endpoint on using transports or invoking method/signal calls on another peer */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include "ConfigDB.h" #include "PermissionMgr.h" #include "RemoteEndpoint.h" #define QCC_MODULE "PERMISSION_MGR" namespace ajn { PermissionMgr::DaemonBusCallPolicy PermissionMgr::GetDaemonBusCallPolicy(BusEndpoint sender) { static bool enableRestrict = ConfigDB::GetConfigDB()->GetFlag("restrict_untrusted_clients"); QCC_DbgTrace(("PermissionMgr::GetDaemonBusCallPolicy(send=%s)", sender->GetUniqueName().c_str())); DaemonBusCallPolicy policy = STDBUSCALL_ALLOW_ACCESS_SERVICE_ANY; if (enableRestrict) { if (sender->GetEndpointType() == ENDPOINT_TYPE_NULL || sender->GetEndpointType() == ENDPOINT_TYPE_LOCAL) { policy = STDBUSCALL_ALLOW_ACCESS_SERVICE_ANY; } else if (sender->GetEndpointType() == ENDPOINT_TYPE_REMOTE) { RemoteEndpoint rEndpoint = RemoteEndpoint::cast(sender); QCC_DbgPrintf(("This is a RemoteEndpoint. ConnSpec = %s", rEndpoint->GetConnectSpec().c_str())); if ((rEndpoint->GetConnectSpec() == "unix") || (rEndpoint->GetConnectSpec() == "npipe") || (rEndpoint->GetConnectSpec() == "localhost") || (rEndpoint->GetConnectSpec() == "slap")) { policy = STDBUSCALL_ALLOW_ACCESS_SERVICE_ANY; } else if (rEndpoint->GetConnectSpec() == "tcp") { if (!rEndpoint->IsTrusted()) { policy = STDBUSCALL_ALLOW_ACCESS_SERVICE_LOCAL; } else { policy = STDBUSCALL_ALLOW_ACCESS_SERVICE_ANY; } } else { policy = STDBUSCALL_SHOULD_REJECT; QCC_LogError(ER_FAIL, ("Unrecognized connect spec for endpoint:%s. connectspec=%s", sender->GetUniqueName().c_str(), rEndpoint->GetConnectSpec().c_str())); } } else if (sender->GetEndpointType() == ENDPOINT_TYPE_BUS2BUS || sender->GetEndpointType() == ENDPOINT_TYPE_VIRTUAL) { policy = STDBUSCALL_SHOULD_REJECT; QCC_LogError(ER_FAIL, ("Bus-to-bus endpoint(%s) is not ALLOW_ACCESSed to invoke daemon standard method call", sender->GetUniqueName().c_str())); } else { policy = STDBUSCALL_SHOULD_REJECT; QCC_LogError(ER_FAIL, ("Unexpected endponit type(%d)", sender->GetEndpointType())); } } return policy; } } // namespace ajn { alljoyn-15.04b/alljoyn_core/router/PermissionMgr.h000066400000000000000000000061561255700255500223220ustar00rootroot00000000000000/** * @file * This class is to manage the permission of an endpoint on using transports or invoking method/signal calls on another peer. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _PERMISSION_MGR_H #define _PERMISSION_MGR_H #include "LocalTransport.h" #include "TransportList.h" #include namespace ajn { #define MAX_PERM_CHECKEDCALL_SIZE (512) class TransportPermission { public: /** * Filter out transports that the endpoint has no permissions to use * @param srcEp The source endpoint * @param sender The sender's well-known name string * @param transports The transport mask * @param callerName The caller that invokes this method */ static QStatus FilterTransports(BusEndpoint& srcEp, const qcc::String& sender, TransportMask& transports, const char* callerName); }; class PermissionMgr { public: typedef enum { STDBUSCALL_ALLOW_ACCESS_SERVICE_ANY = 0, /**< A standard daemon bus call is allowed to interact with any local or remote service */ STDBUSCALL_ALLOW_ACCESS_SERVICE_LOCAL = 1, /**< A standard daemon bus call is allowed, but it can only interact with local service */ STDBUSCALL_SHOULD_REJECT = 2 /**< A standard daemon bus call should always be rejected */ } DaemonBusCallPolicy; /** * Add an alias ID to a UnixEndpoint User ID * @param srcEp The source endpoint * @param origUID The unique User ID * @param aliasUID The alias User ID */ static uint32_t AddAliasUnixUser(BusEndpoint& srcEp, qcc::String& sender, uint32_t origUID, uint32_t aliasUID); /** * Cleanup the permission information cache of an enpoint before it exits. */ static QStatus CleanPermissionCache(BusEndpoint& endpoint); /** * Get the policy for a bus endpoint's permission of invoking the standard DBus and AllJoyn inteface. * @param endpoint The bus endpoint. * @return the policy associated with the bus endpoint for invoking the standard DBus and AllJoyn inteface. */ static DaemonBusCallPolicy GetDaemonBusCallPolicy(BusEndpoint sender); }; } // namespace ajn #endif //_PERMISSION_MGR_H alljoyn-15.04b/alljoyn_core/router/RouterGlobals.cc000066400000000000000000000024241255700255500224400ustar00rootroot00000000000000/** * @file * Static global creation and destruction */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include "RouterGlobals.h" #include "ns/IpNameService.h" namespace ajn { void RouterGlobals::Init() { IpNameService::Init(); } void RouterGlobals::Shutdown() { IpNameService::Shutdown(); } } alljoyn-15.04b/alljoyn_core/router/RouterGlobals.h000066400000000000000000000023431255700255500223020ustar00rootroot00000000000000/** * @file * Router static global creation and destruction */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_ROUTERGLOBALS_H #define _ALLJOYN_ROUTERGLOBALS_H #include namespace ajn { class RouterGlobals { public: static void Init(); static void Shutdown(); }; } #endif alljoyn-15.04b/alljoyn_core/router/RuleTable.cc000066400000000000000000000046411255700255500215360ustar00rootroot00000000000000/** * @file * MsgRouter is responsible for taking inbound messages and routing them * to an appropriate set of endpoints. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include "RuleTable.h" #include #include #define QCC_MODULE "ALLJOYN" using namespace std; using namespace qcc; namespace ajn { QStatus RuleTable::AddRule(BusEndpoint& endpoint, const Rule& rule) { QCC_DbgPrintf(("AddRule for endpoint %s\n %s", endpoint->GetUniqueName().c_str(), rule.ToString().c_str())); Lock(); rules.insert(std::pair(endpoint, rule)); Unlock(); return ER_OK; } QStatus RuleTable::RemoveRule(BusEndpoint& endpoint, Rule& rule) { QStatus status = ER_BUS_MATCH_RULE_NOT_FOUND; Lock(); std::pair range = rules.equal_range(endpoint); while (range.first != range.second) { if (range.first->second == rule) { const RuleIterator begin = range.first; const RuleIterator end = ++range.first; rules.erase(begin, end); status = ER_OK; break; } ++range.first; } Unlock(); return status; } QStatus RuleTable::RemoveAllRules(BusEndpoint& endpoint) { Lock(); std::pair range = rules.equal_range(endpoint); if (range.first != rules.end()) { rules.erase(range.first, range.second); } Unlock(); return ER_OK; } } alljoyn-15.04b/alljoyn_core/router/RuleTable.h000066400000000000000000000102631255700255500213750ustar00rootroot00000000000000/** * @file * RuleTable is a thread-safe store used for storing * and retrieving message bus routing rules. */ /****************************************************************************** * * * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_RULETABLE_H #define _ALLJOYN_RULETABLE_H #include #include #include "BusEndpoint.h" #include "Rule.h" namespace ajn { /** Rule iterator */ typedef std::multimap::iterator RuleIterator; /** * RuleTable is a thread-safe store used for storing * and retrieving message bus routing rules. */ class RuleTable { public: /** * Add a rule for an endpoint. * * @param endpoint The endpoint that this rule applies to. * @param rule Rule for endpoint * @return ER_OK if successful; */ QStatus AddRule(BusEndpoint& endpoint, const Rule& rule); /** * Remove a rule for an endpoint. * * @param endpoint The endpoint that rule applies to. * @param rule Rule to remove. * @return ER_OK if successful; */ QStatus RemoveRule(BusEndpoint& endpoint, Rule& rule); /** * Remove all rules for a given endpoint. * * @param endpoint Endpoint whose rules will be removed. * @return ER_OK if successful; */ QStatus RemoveAllRules(BusEndpoint& endpoint); /** * Obtain exclusive access to rule table. * This method only needs to be called before using methods that return or use * AllJoynRuleIterators. Atomic rule table operations will obtain the lock internally. * * @return ER_OK if successful. */ QStatus Lock() { return lock.Lock(MUTEX_CONTEXT); } /** * Release exclusive access to rule table. * * @return ER_OK if successful. */ QStatus Unlock() { return lock.Unlock(MUTEX_CONTEXT); } /** * Return an iterator to the start of the rules. * Caller should obtain lock before calling this method. * @return Iterator to first rule. */ RuleIterator Begin() { return rules.begin(); } /** * Return an iterator to the end of the rules. * @return Iterator to end of rules. */ RuleIterator End() { return rules.end(); } /** * Find all rules for a given endpoint. * Caller should obtain lock before calling this method. * * @param endpoint Endpoint whose rules are needed. * @return Iterator to first rule for given endpoint. */ RuleIterator FindRulesForEndpoint(BusEndpoint& endpoint) { return rules.find(endpoint); } /** * lower_bound algorithm for rule table. * * @param ep BusEndpoint that rule applies to. * @param rule Rule * @return lower_bound itertor for ep, rule. */ RuleIterator LowerBound(BusEndpoint endpoint, const Rule& rule); /** * Advance iterator to next endpoint. * * @param endpoint Endpoint before advance. * @return Iterator to next endpoint in ruleTable or end. * */ RuleIterator AdvanceToNextEndpoint(BusEndpoint endpoint) { std::multimap::iterator ret = rules.upper_bound(endpoint); return ret; } private: qcc::Mutex lock; /**< Lock protecting rule table */ std::multimap rules; /**< Rule table */ }; } #endif alljoyn-15.04b/alljoyn_core/router/SConscript000066400000000000000000000063601255700255500213620ustar00rootroot00000000000000# Copyright AllSeen Alliance. All rights reserved. # # Permission to use, copy, modify, and/or distribute this software for any # purpose with or without fee is hereby granted, provided that the above # copyright notice and this permission notice appear in all copies. # # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. # from os.path import basename Import('env') router_env = env.Clone() vars = Variables() vars.Add(EnumVariable('POLICYDB', 'Enable policy support', 'off', allowed_values=('on', 'off'))) vars.Update(router_env) Help(vars.GenerateHelpText(router_env)) if router_env['OS'] == "darwin": # Darwin has its own version of the daemon transport srcs = [ f for f in router_env.Glob('*.cc') + router_env.Glob('*.c') + [router_env['OS'] + '/DaemonTransport' + router_env['OS'].capitalize() + '.cc'] ] else: srcs = [ f for f in router_env.Glob('*.cc') + router_env.Glob('*.c') + [router_env['OS_GROUP'] + '/DaemonTransport' + router_env['OS_GROUP'].capitalize() + '.cc']] srcs += [router_env['OS_GROUP'] + '/Socket.cc'] if router_env['OS'] != "android": srcs += [router_env['OS_GROUP'] + '/PermissionMgr' + router_env['OS_GROUP'].capitalize() + '.cc'] router_env.Append(CPPPATH = [ router_env.Dir('..').srcnode(), router_env.Dir('.').srcnode(), router_env.Dir('$OS_GROUP').srcnode() ]) if router_env['POLICYDB'] == 'on': router_env.Append(CPPDEFINES = [ 'ENABLE_POLICYDB' ]) router_env.Append(CPPPATH = [ router_env.Dir('policydb').srcnode() ]) srcs += [ 'policydb/PolicyDB.cc' ] router_objs = router_env.Object(srcs) router_objs.extend(router_env.SConscript('ns/SConscript', exports = ['router_env'])) if router_env['OS'] == "android": router_objs.extend(router_env.SConscript('android/SConscript', exports = ['router_env'])) # Standalone daemon object file srobj = router_env.SConscript('standalone/SConscript', exports = ['router_env']) # Bundled daemon object file brobj = router_env.SConscript('bundled/SConscript', exports = ['router_env']) progs = router_env.SConscript('${OS_GROUP}/SConscript', exports=['router_env', 'router_objs', 'srobj']) # Bundled daemon library lib = router_env.StaticLibrary('ajrouter', brobj + router_objs); # AllJoyn Daemon test programs if router_env['OS'] == 'darwin': if router_env['CPU'] in ['arm', 'armv7', 'armv7s', 'arm64',]: print 'Not building unit tests for iOS...' tests = [] else: print 'Building unit tests for darwin...' tests = router_env.SConscript('test/SConscript', exports = ['router_env', 'router_objs', 'srobj']) else: tests = router_env.SConscript('test/SConscript', exports = ['router_env', 'router_objs', 'srobj']) # Return daemon and related tests ret = progs + tests, lib, srobj, router_objs Return('ret') alljoyn-15.04b/alljoyn_core/router/SessionlessObj.cc000066400000000000000000002132411255700255500226220ustar00rootroot00000000000000/** * @file * This file implements the org.alljoyn.sl interfaces. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include "SessionlessObj.h" #include "BusController.h" #include "ConfigDB.h" #ifdef ENABLE_POLICYDB #include "PolicyDB.h" #endif #define QCC_MODULE "SESSIONLESS" using namespace std; using namespace qcc; /** * Inside window calculation. * Returns true if p is in range [beg, beg+sz) * This function properly accounts for possible wrap-around in [beg, beg+sz) region. */ #define IN_WINDOW(tp, beg, sz, p) (((static_cast((beg) + (sz)) > (beg)) && ((p) >= (beg)) && ((p) < static_cast((beg) + (sz)))) || \ ((static_cast((beg) + (sz)) < (beg)) && !(((p) < (beg)) && (p) >= static_cast((beg) + (sz))))) /** * IS_GREATER_OR_EQUAL returns true if first (non-type) param is greater than or * equal to the second while taking into account the possibility of wrap-around */ #define IS_GREATER_OR_EQUAL(tp, a, b) IN_WINDOW(tp, (b), (numeric_limits::max() >> 1), (a)) /** * IS_GREATER returns true if first (non-type) param is greater than the second * while taking into account the possibility of wrap-around */ #define IS_GREATER(tp, a, b) (IS_GREATER_OR_EQUAL(tp, (a), (b)) && ((a) != (b))) namespace ajn { /** Constants */ #define SESSIONLESS_SESSION_PORT 100 /** Interface definitions for org.alljoyn.sessionless */ static const char* ObjectPath = "/org/alljoyn/sl"; /**< Object path */ static const char* InterfaceName = "org.alljoyn.sl"; /**< Interface name */ static const char* WellKnownName = "org.alljoyn.sl"; /**< Well known bus name */ /** The advertised name when the match rule does not specify an interface */ static const char* WildcardInterfaceName = "org.alljoyn"; /* * Do not update the version without reviewing where it is used below. It is * encoded in the 'x' part of the "org.alljoyn.sl.x" advertised name, thus care * must be taken to ensure that the advertised name is still a valid name. * * The encoding serves a few needs: * 1. Version 0 implementations will see the "org.alljoyn.sl." advertisements * from version 1 implementations and behave as before, * 2. Version 1 implementations will see the "org.alljoyn.sl." advertisements * from version 0 implementations and behave as before, * and most importantly, * 3. Version 1 implementations will see the "org.alljoyn.sl." advertisements * from version 1 implementations and ignore them if not looking for the * wildcard interface. */ const uint32_t SessionlessObj::version = 1; /* * The context for the implements query response. It must be delivered on * a separate thread than the Query callback to avoid deadlock. */ SessionlessObj::SendResponseWork::SendResponseWork(SessionlessObj& slObj, TransportMask transport, const qcc::String& name, const qcc::IPEndpoint& src, const qcc::IPEndpoint& dst) : Work(slObj), transport(transport), name(name), src(src), dst(dst) { } void SessionlessObj::SendResponseWork::Run() { MDNSPacket response; response->SetSource(src); response->SetDestination(dst); MDNSAdvertiseRData advRData; advRData.SetTransport(slObj.sessionOpts.transports & TRANSPORT_IP); advRData.SetValue("name", name); String guid = slObj.bus.GetInternal().GetGlobalGUID().ToString(); MDNSResourceRecord advertiseRecord("advertise." + guid + ".local.", MDNSResourceRecord::TXT, MDNSResourceRecord::INTERNET, 120, &advRData); response->AddAdditionalRecord(advertiseRecord); QStatus status = IpNameService::Instance().Response(transport, 120, response); if (ER_OK == status) { QCC_DbgPrintf(("Sent implements response for name=%s", name.c_str())); } else { QCC_LogError(status, ("Response failed")); } } /* * Internal context passed through JoinSessionAsync. This holds a snapshot of * the remote cache state at the time we issue the JoinSessionAsync. */ struct RemoteCacheSnapshot { RemoteCacheSnapshot(SessionlessObj::RemoteCache& cache) : name(cache.name), guid(cache.guid) { } qcc::String name; qcc::String guid; }; SessionlessObj::SessionlessObj(Bus& bus, BusController* busController, DaemonRouter& router) : BusObject(ObjectPath, false), bus(bus), busController(busController), router(router), legacyRule("type='error',sessionless='t'"), sessionlessIface(NULL), requestSignalsSignal(NULL), requestRangeSignal(NULL), requestRangeMatchSignal(NULL), timer("sessionless", true), curChangeId(0), sessionOpts(SessionOpts::TRAFFIC_MESSAGES, false, SessionOpts::PROXIMITY_ANY, TRANSPORT_ANY, SessionOpts::SLS_NAMES), sessionPort(SESSIONLESS_SESSION_PORT), advanceChangeId(false), nextRulesId(0), backoff(ConfigDB::GetConfigDB()->GetLimit("sls_backoff", 1500), ConfigDB::GetConfigDB()->GetLimit("sls_backoff_linear", 4), ConfigDB::GetConfigDB()->GetLimit("sls_backoff_exponential", 32), ConfigDB::GetConfigDB()->GetLimit("sls_backoff_max", 15 * 60)) { sessionOpts.transports = ConfigDB::GetConfigDB()->GetLimit("sls_preferred_transports", TRANSPORT_ANY); } SessionlessObj::~SessionlessObj() { IpNameService::Instance().UnregisterListener(*this); /* Unbind session port */ bus.UnbindSessionPort(sessionPort); /* Remove name listener */ router.RemoveBusNameListener(this); /* Unregister bus object */ bus.UnregisterBusObject(*this); } QStatus SessionlessObj::Init() { QCC_DbgTrace(("SessionlessObj::Init")); QStatus status; /* Create the org.alljoyn.sl interface */ InterfaceDescription* intf = NULL; status = bus.CreateInterface(InterfaceName, intf); if (status != ER_OK) { QCC_LogError(status, ("Failed to create interface %s", InterfaceName)); return status; } intf->AddSignal("RequestSignals", "u", NULL, 0); intf->AddSignal("RequestRange", "uu", NULL, 0); intf->AddSignal("RequestRangeMatch", "uuas", NULL, 0); intf->Activate(); /* Make this object implement org.alljoyn.sl */ const InterfaceDescription* sessionlessIntf = bus.GetInterface(InterfaceName); if (!sessionlessIntf) { status = ER_BUS_NO_SUCH_INTERFACE; QCC_LogError(status, ("Failed to get %s interface", InterfaceName)); return status; } /* Cache requestSignals, requestRange, and requestRangeMatch interface members */ requestSignalsSignal = sessionlessIntf->GetMember("RequestSignals"); assert(requestSignalsSignal); requestRangeSignal = sessionlessIntf->GetMember("RequestRange"); assert(requestRangeSignal); requestRangeMatchSignal = sessionlessIntf->GetMember("RequestRangeMatch"); assert(requestRangeMatchSignal); /* Register a signal handler for requestSignals */ status = bus.RegisterSignalHandler(this, static_cast(&SessionlessObj::RequestSignalsSignalHandler), requestSignalsSignal, NULL); if (status != ER_OK) { QCC_LogError(status, ("Failed to register RequestSignals signal handler")); } /* Register a signal handler for requestRange */ status = bus.RegisterSignalHandler(this, static_cast(&SessionlessObj::RequestRangeSignalHandler), requestRangeSignal, NULL); if (status != ER_OK) { QCC_LogError(status, ("Failed to register RequestRange signal handler")); } /* Register a signal handler for requestRangeMatch */ status = bus.RegisterSignalHandler(this, static_cast(&SessionlessObj::RequestRangeMatchSignalHandler), requestRangeMatchSignal, NULL); if (status != ER_OK) { QCC_LogError(status, ("Failed to register RequestRangeMatch signal handler")); } /* Register signal handler for FoundAdvertisedName */ /* (If we werent in the daemon, we could just use BusListener, but it doesnt work without the full BusAttachment implementation */ const InterfaceDescription* ajIntf = bus.GetInterface(org::alljoyn::Bus::InterfaceName); assert(ajIntf); status = bus.RegisterSignalHandler(this, static_cast(&SessionlessObj::FoundAdvertisedNameSignalHandler), ajIntf->GetMember("FoundAdvertisedName"), NULL); if (status != ER_OK) { QCC_LogError(status, ("Failed to register FoundAdvertisedName signal handler")); } /* Register signal handler for SessionLostWithReason */ /* (If we werent in the daemon, we could just use SessionListener, but it doesnt work without the full BusAttachment implementation */ status = bus.RegisterSignalHandler(this, static_cast(&SessionlessObj::SessionLostSignalHandler), ajIntf->GetMember("SessionLostWithReason"), NULL); if (status != ER_OK) { QCC_LogError(status, ("Failed to register SessionLost signal handler")); } /* Register signal handler for SessionLostWithReasonAndDisposition */ /* (If we werent in the daemon, we could just use SessionListener, but it doesnt work without the full BusAttachment implementation */ status = bus.RegisterSignalHandler(this, static_cast(&SessionlessObj::SessionLostSignalHandler), ajIntf->GetMember("SessionLostWithReasonAndDisposition"), NULL); if (status != ER_OK) { QCC_LogError(status, ("Failed to register SessionLost signal handler")); } /* Register a name table listener */ if (status == ER_OK) { router.AddBusNameListener(this); } /* Start the worker */ if (status == ER_OK) { status = timer.Start(); } /* Bind the session port and establish self as port listener */ if (status == ER_OK) { status = bus.BindSessionPort(sessionPort, sessionOpts, *this); } /* Register sessionObj */ if (ER_OK == status) { status = bus.RegisterBusObject(*this); } IpNameService::Instance().RegisterListener(*this); return status; } QStatus SessionlessObj::Stop() { return timer.Stop(); } QStatus SessionlessObj::Join() { return timer.Join(); } void SessionlessObj::ObjectRegistered(void) { QCC_DbgTrace(("SessionlessObj::ObjectRegistered")); QStatus status; /* Acquire org.alljoyn.sl name */ uint32_t disposition = DBUS_REQUEST_NAME_REPLY_EXISTS; status = router.AddAlias(WellKnownName, bus.GetInternal().GetLocalEndpoint()->GetUniqueName(), DBUS_NAME_FLAG_DO_NOT_QUEUE, disposition, NULL, NULL); if ((ER_OK != status) || (DBUS_REQUEST_NAME_REPLY_PRIMARY_OWNER != disposition)) { status = (ER_OK == status) ? ER_FAIL : status; QCC_LogError(status, ("Failed to register well-known name \"%s\" (disposition=%d)", WellKnownName, disposition)); } /* Must call base class */ BusObject::ObjectRegistered(); /* Notify parent */ busController->ObjectRegistered(this); } void SessionlessObj::AddRule(const qcc::String& epName, Rule& rule) { if (rule.sessionless == Rule::SESSIONLESS_TRUE) { QCC_DbgPrintf(("AddRule(epName=%s,rule=%s)", epName.c_str(), rule.ToString().c_str())); ScheduleWork(new AddRuleWork(*this, epName, rule)); } } SessionlessObj::AddRuleWork::AddRuleWork(SessionlessObj& slObj, const qcc::String& epName, Rule& rule) : Work(slObj), epName(epName), rule(rule) { } void SessionlessObj::AddRuleWork::Run() { slObj.router.LockNameTable(); slObj.lock.Lock(); uint32_t fromRulesId = slObj.nextRulesId; bool isNewRule = true; uint32_t ruleId = slObj.nextRulesId; for (std::pair range = slObj.rules.equal_range(epName); range.first != range.second; ++range.first) { if (range.first->second == rule) { isNewRule = false; ruleId = range.first->second.id; break; } } slObj.rules.insert(std::pair(epName, TimestampedRule(rule, ruleId))); if (isNewRule) { ++slObj.nextRulesId; } slObj.ScheduleWork(); /* For retrieving from our own cache after releasing the locks below */ uint32_t fromChangeId = slObj.curChangeId - (numeric_limits::max() >> 1); uint32_t toChangeId = slObj.curChangeId + 1; uint32_t toRulesId = slObj.nextRulesId; slObj.FindAdvertisedNames(); slObj.lock.Unlock(); slObj.router.UnlockNameTable(); /* Retrieve from our own cache */ slObj.HandleRangeRequest(epName.c_str(), 0, fromChangeId, toChangeId, fromRulesId, toRulesId); } void SessionlessObj::RemoveRule(const qcc::String& epName, Rule& rule) { if (rule.sessionless == Rule::SESSIONLESS_TRUE) { QCC_DbgPrintf(("RemoveRule(epName=%s,rule=%s)", epName.c_str(), rule.ToString().c_str())); ScheduleWork(new RemoveRuleWork(*this, epName, rule)); } } SessionlessObj::RemoveRuleWork::RemoveRuleWork(SessionlessObj& slObj, const qcc::String& epName, Rule& rule) : Work(slObj), epName(epName), rule(rule) { } void SessionlessObj::RemoveRuleWork::Run() { slObj.router.LockNameTable(); slObj.lock.Lock(); std::pair range = slObj.rules.equal_range(epName); while (range.first != range.second) { if (range.first->second == rule) { slObj.RemoveImplicitRules(range.first); slObj.rules.erase(range.first); break; } ++range.first; } if (slObj.rules.empty()) { slObj.CancelFindAdvertisedNames(); } slObj.lock.Unlock(); slObj.router.UnlockNameTable(); } SessionlessObj::PushMessageWork::PushMessageWork(SessionlessObj& slObj, Message& msg) : Work(slObj), msg(msg) { } bool SessionlessObj::IsSessionlessEmitter(String name) { lock.Lock(); SessionlessMessageKey key(name.c_str(), "", "", ""); LocalCache::iterator mit = localCache.lower_bound(key); bool ret = (mit != localCache.end() && (mit->first.find(name) == 0)); lock.Unlock(); return ret; } void SessionlessObj::PushMessageWork::Run() { slObj.router.LockNameTable(); slObj.lock.Lock(); /* Match the message against any existing implicit rules */ uint32_t fromRulesId = slObj.nextRulesId - (numeric_limits::max() >> 1); uint32_t toRulesId = slObj.nextRulesId; slObj.SendMatchingThroughEndpoint(0, msg, fromRulesId, toRulesId); /* Put the message in the local cache */ SessionlessMessageKey key(msg->GetSender(), msg->GetInterface(), msg->GetMemberName(), msg->GetObjectPath()); slObj.advanceChangeId = true; SessionlessMessage val(slObj.curChangeId, msg); LocalCache::iterator it = slObj.localCache.find(key); if (it == slObj.localCache.end()) { slObj.localCache.insert(pair(key, val)); } else { it->second = val; } slObj.lock.Unlock(); slObj.router.UnlockNameTable(); } QStatus SessionlessObj::PushMessage(Message& msg) { QCC_DbgPrintf(("PushMessage(msg={sender='%s',interface='%s',member='%s',path='%s'})", msg->GetSender(), msg->GetInterface(), msg->GetMemberName(), msg->GetObjectPath())); /* Validate message */ if (!msg->IsSessionless()) { return ER_FAIL; } ScheduleWork(new PushMessageWork(*this, msg)); return ER_OK; } void SessionlessObj::RouteSessionlessMessage(SessionId sid, Message& msg) { QCC_DbgPrintf(("RouteSessionlessMessage(sid=%u,msg={sender='%s',interface='%s',member='%s',path='%s'})", sid, msg->GetSender(), msg->GetInterface(), msg->GetMemberName(), msg->GetObjectPath())); router.LockNameTable(); lock.Lock(); RemoteCaches::iterator cit = FindRemoteCache(sid); if (cit == remoteCaches.end()) { QCC_LogError(ER_WARNING, ("Received message on unknown sid %u, ignoring", sid)); lock.Unlock(); router.UnlockNameTable(); return; } RemoteCache& cache = cit->second; if (find(cache.routedMessages.begin(), cache.routedMessages.end(), RoutedMessage(msg)) != cache.routedMessages.end()) { /* We are retrying and have already routed this message, ignore it */ lock.Unlock(); router.UnlockNameTable(); return; } else { cache.routedMessages.push_back(RoutedMessage(msg)); } SendMatchingThroughEndpoint(sid, msg, cache.fromRulesId, cache.toRulesId); lock.Unlock(); router.UnlockNameTable(); return; } void SessionlessObj::SendMatchingThroughEndpoint(SessionId sid, Message msg, uint32_t fromRulesId, uint32_t toRulesId) { bool isAnnounce = (0 == strcmp(msg->GetInterface(), "org.alljoyn.About")) && (0 == strcmp(msg->GetMemberName(), "Announce")); uint32_t rulesRangeLen = toRulesId - fromRulesId; RuleIterator rit = rules.begin(); while (rit != rules.end()) { bool isExplicitMatch = false; String epName = rit->first; BusEndpoint ep = router.FindEndpoint(epName); bool epTypeIsLeaf = (ep->GetEndpointType() == ENDPOINT_TYPE_NULL || ep->GetEndpointType() == ENDPOINT_TYPE_REMOTE); bool epCanReceive = ep->IsValid() && (ep->AllowRemoteMessages() || epTypeIsLeaf); RuleIterator end = rules.upper_bound(epName); for (; rit != end; ++rit) { if (IN_WINDOW(uint32_t, fromRulesId, rulesRangeLen, rit->second.id) && epCanReceive) { if (rit->second.IsMatch(msg)) { isExplicitMatch = true; if (isAnnounce && !rit->second.implements.empty()) { /* * Add an implicit rule so that we will receive Announce * signals if the interface of interest is removed from the * Announce signal. */ String ruleStr = String("sender='") + msg->GetSender() + "',interface='org.alljoyn.About',member='Announce'"; Rule rule(ruleStr.c_str()); AddImplicitRule(rule, rit); } } else if (rit->second == legacyRule) { /* * Legacy clients will add the "type='error',sessionless='t'" * rule. In that case the expected behavior is that incoming * sessionless signals will route through the daemon router's * rule table. */ router.GetRuleTable().Lock(); for (ajn::RuleIterator drit = router.GetRuleTable().FindRulesForEndpoint(ep); !isExplicitMatch && (drit != router.GetRuleTable().End()) && (drit->first == ep); ++drit) { isExplicitMatch = drit->second.IsMatch(msg); } router.GetRuleTable().Unlock(); } } } bool isImplicitMatch = false; if (isAnnounce && !isExplicitMatch && epCanReceive) { /* The message did not match any rules for this endpoint. * Check if it matches (only) an implicit rule. */ isImplicitMatch = IsOnlyImplicitMatch(epName, msg); } if (isExplicitMatch || isImplicitMatch) { lock.Unlock(); router.UnlockNameTable(); SendThroughEndpoint(msg, ep, sid); router.LockNameTable(); lock.Lock(); rit = rules.upper_bound(epName); } } } SessionlessObj::CancelMessageWork::CancelMessageWork(SessionlessObj& slObj, Message& msg) : Work(slObj), msg(msg) { } void SessionlessObj::CancelMessageWork::Run() { QStatus status = ER_BUS_NO_SUCH_MESSAGE; qcc::String sender = msg->GetSender(); uint32_t serialNum = msg->GetArg(0)->v_uint32; slObj.lock.Lock(); SessionlessMessageKey key(sender.c_str(), "", "", ""); LocalCache::iterator it = slObj.localCache.lower_bound(key); while ((it != slObj.localCache.end()) && (sender == it->second.second->GetSender())) { if (it->second.second->GetCallSerial() == serialNum) { if (!it->second.second->IsExpired()) { status = ER_OK; } slObj.localCache.erase(it); break; } ++it; } slObj.lock.Unlock(); slObj.busController->GetAllJoynObj().CancelSessionlessMessageReply(msg, status); } void SessionlessObj::CancelMessage(Message& msg) { QCC_DbgTrace(("SessionlessObj::CancelMessage(%s, 0x%x)", msg->GetSender(), msg->GetArg(0)->v_uint32)); ScheduleWork(new CancelMessageWork(*this, msg)); } void SessionlessObj::NameOwnerChanged(const String& name, const String* oldOwner, SessionOpts::NameTransferType oldOwnerNameTransfer, const String* newOwner, SessionOpts::NameTransferType newOwnerNameTransfer) { QCC_UNUSED(oldOwnerNameTransfer); QCC_UNUSED(newOwnerNameTransfer); QCC_DbgTrace(("SessionlessObj::NameOwnerChanged(%s, %s, %s)", name.c_str(), oldOwner ? oldOwner->c_str() : "(null)", newOwner ? newOwner->c_str() : "(null)")); /* When newOwner and oldOwner are the same, only the name transfer changed. */ if (newOwner == oldOwner) { return; } /* Remove entries from rules for names exiting from the bus */ if (oldOwner && !newOwner) { ScheduleWork(new NameOwnerChangedWork(*this, name, *oldOwner)); } } SessionlessObj::NameOwnerChangedWork::NameOwnerChangedWork(SessionlessObj& slObj, const qcc::String& name, const qcc::String& oldOwner) : Work(slObj), name(name), oldOwner(oldOwner) { } void SessionlessObj::NameOwnerChangedWork::Run() { slObj.router.LockNameTable(); slObj.lock.Lock(); std::pair range = slObj.rules.equal_range(name); if (range.first != slObj.rules.end()) { slObj.RemoveImplicitRules(name); slObj.rules.erase(range.first, range.second); } /* Remove stored sessionless messages sent by the old owner */ SessionlessMessageKey key(oldOwner.c_str(), "", "", ""); LocalCache::iterator mit = slObj.localCache.lower_bound(key); while ((mit != slObj.localCache.end()) && (::strcmp(oldOwner.c_str(), mit->second.second->GetSender()) == 0)) { slObj.localCache.erase(mit++); } /* Stop discovery if nobody is looking for sessionless signals */ if (slObj.rules.empty()) { slObj.CancelFindAdvertisedNames(); } slObj.lock.Unlock(); slObj.router.UnlockNameTable(); } void SessionlessObj::FoundAdvertisedNameSignalHandler(const InterfaceDescription::Member* member, const char* sourcePath, Message& msg) { QCC_UNUSED(member); QCC_UNUSED(sourcePath); /* Parse the args */ const char* name; TransportMask transport; const char* prefix; QStatus status = msg->GetArgs("sqs", &name, &transport, &prefix); if (status != ER_OK) { QCC_LogError(status, ("GetArgs failed")); return; } FoundAdvertisedNameHandler(name, transport, prefix); } void SessionlessObj::FoundAdvertisedNameHandler(const char* name, TransportMask transport, const char* prefix, bool doInitialBackoff) { QCC_UNUSED(prefix); /* Examine found name to see if we need to connect to it */ if ((transport & sessionOpts.transports) == 0) { QCC_DbgPrintf(("FoundAdvertisedName(name=%s,transport=0x%x,...): Transport not preferred", name, transport)); return; } String guid, iface; uint32_t version, changeId; QStatus status = ParseAdvertisedName(name, &version, &guid, &iface, &changeId); if (status != ER_OK) { QCC_LogError(status, ("Found invalid name \"%s\"", name)); return; } QCC_DbgPrintf(("FoundAdvertisedName(name=%s,transport=0x%x,...) guid=%s,version=%u,iface=%s,changeId=%u", name, transport, guid.c_str(), version, iface.c_str(), changeId)); /* Add/replace sessionless adv name for remote daemon */ busController->GetAllJoynObj().AddAdvNameAlias(guid, transport, name); /* Join session if we need signals from this advertiser and we aren't already getting them */ lock.Lock(); RemoteCaches::iterator cit = remoteCaches.find(guid); if (cit == remoteCaches.end()) { remoteCaches.insert(pair(guid, RemoteCache(name, version, guid, iface, changeId, transport))); } else { cit->second.name = name; cit->second.ifaces.insert(iface); if (IS_GREATER(uint32_t, changeId, cit->second.changeId)) { cit->second.changeId = changeId; cit->second.retries = 0; /* Reset the backoff schedule when new signals are available. */ } cit->second.transport = transport; } ScheduleWork(doInitialBackoff); lock.Unlock(); } bool SessionlessObj::AcceptSessionJoiner(SessionPort port, const char* joiner, const SessionOpts& opts) { QCC_UNUSED(port); QCC_UNUSED(joiner); QCC_UNUSED(opts); QCC_DbgPrintf(("AcceptSessionJoiner(port=%d,joiner=%s,...)", port, joiner)); return true; } void SessionlessObj::SessionJoined(SessionPort port, SessionId sid, const char* joiner) { QCC_UNUSED(port); QCC_UNUSED(sid); QCC_UNUSED(joiner); QCC_DbgPrintf(("SessionJoined(port=%d,sid=%u,joiner=%s)", port, sid, joiner)); } void SessionlessObj::SessionLostSignalHandler(const InterfaceDescription::Member* member, const char* sourcePath, Message& msg) { QCC_UNUSED(member); QCC_UNUSED(sourcePath); uint32_t sid = 0; uint32_t reason = 0; msg->GetArgs("uu", &sid, &reason); QCC_DbgPrintf(("SessionLost(sid=%u,reason=%d)", sid, reason)); DoSessionLost(sid, static_cast(reason)); } void SessionlessObj::DoSessionLost(SessionId sid, SessionLostReason reason) { QCC_DbgTrace(("SessionlessObj::DoSessionLost(%u)", sid)); lock.Lock(); RemoteCaches::iterator cit = FindRemoteCache(sid); if (cit != remoteCaches.end()) { RemoteCache& cache = cit->second; /* Reset in progress */ cache.state = RemoteCache::IDLE; cache.sid = 0; if (reason == ALLJOYN_SESSIONLOST_REMOTE_END_LEFT_SESSION) { /* We got all the signals */ cache.retries = 0; cache.routedMessages.clear(); if (IS_GREATER(uint32_t, cache.toRulesId - 1, cache.appliedRulesId)) { cache.appliedRulesId = cache.toRulesId - 1; } if (IS_GREATER(uint32_t, cache.toChangeId - 1, cache.receivedChangeId)) { cache.receivedChangeId = cache.toChangeId - 1; cache.haveReceived = true; } /* Get the sessions rolling if necessary */ ScheduleWork(); } else { /* An error occurred while getting the signals, so retry */ if (ScheduleWork(cache) != ER_OK) { /* Retries exhausted. Clear state and wait for new advertisment */ EraseRemoteCache(cit); } } } lock.Unlock(); } void SessionlessObj::RequestSignalsSignalHandler(const InterfaceDescription::Member* member, const char* sourcePath, Message& msg) { QCC_UNUSED(member); QCC_UNUSED(sourcePath); uint32_t fromId; QStatus status = msg->GetArgs("u", &fromId); if (status == ER_OK) { /* Send all signals in the range [fromId, curChangeId] */ QCC_DbgPrintf(("RequestSignals(sender=%s,sid=%u,fromId=%u)", msg->GetSender(), msg->GetSessionId(), fromId)); bus.EnableConcurrentCallbacks(); /* HandleRangeRequest could block */ HandleRangeRequest(msg->GetSender(), msg->GetSessionId(), fromId, curChangeId + 1); } else { QCC_LogError(status, ("Message::GetArgs failed")); } } void SessionlessObj::RequestRangeSignalHandler(const InterfaceDescription::Member* member, const char* sourcePath, Message& msg) { QCC_UNUSED(member); QCC_UNUSED(sourcePath); uint32_t fromId, toId; QStatus status = msg->GetArgs("uu", &fromId, &toId); if (status == ER_OK) { QCC_DbgPrintf(("RequestRange(sender=%s,sid=%u,fromId=%u,toId=%u)", msg->GetSender(), msg->GetSessionId(), fromId, toId)); bus.EnableConcurrentCallbacks(); /* HandleRangeRequest could block */ HandleRangeRequest(msg->GetSender(), msg->GetSessionId(), fromId, toId); } else { QCC_LogError(status, ("Message::GetArgs failed")); } } void SessionlessObj::RequestRangeMatchSignalHandler(const InterfaceDescription::Member* member, const char* sourcePath, Message& msg) { QCC_UNUSED(member); QCC_UNUSED(sourcePath); uint32_t fromId, toId; size_t numMatchRuleArgs; const MsgArg* matchRuleArgs; QStatus status = msg->GetArgs("uuas", &fromId, &toId, &numMatchRuleArgs, &matchRuleArgs); if (status == ER_OK) { QCC_DbgPrintf(("RequestRangeMatch(sender=%s,sid=%u,fromId=%u,toId=%u,numMatchRules=%d)", msg->GetSender(), msg->GetSessionId(), fromId, toId, numMatchRuleArgs)); vector matchRules; for (size_t i = 0; i < numMatchRuleArgs; ++i) { char* matchRule; matchRuleArgs[i].Get("s", &matchRule); QCC_DbgPrintf((" [%d] %s", i, matchRule)); matchRules.push_back(matchRule); } bus.EnableConcurrentCallbacks(); /* HandleRangeRequest could block */ HandleRangeRequest(msg->GetSender(), msg->GetSessionId(), fromId, toId, 0, 0, matchRules); } else { QCC_LogError(status, ("Message::GetArgs failed")); } } void SessionlessObj::HandleRangeRequest(const char* sender, SessionId sid, uint32_t fromChangeId, uint32_t toChangeId, uint32_t fromLocalRulesId, uint32_t toLocalRulesId, std::vector remoteRules) { QStatus status = ER_OK; bool messageErased = false; QCC_DbgTrace(("SessionlessObj::HandleControlSignal(%d, %d)", fromChangeId, toChangeId)); /* Advance the curChangeId */ router.LockNameTable(); lock.Lock(); if (advanceChangeId) { ++curChangeId; advanceChangeId = false; } /* Send all messages in local cache in range [fromChangeId, toChangeId) */ LocalCache::iterator it = localCache.begin(); uint32_t rangeLen = toChangeId - fromChangeId; while (it != localCache.end()) { if (IN_WINDOW(uint32_t, fromChangeId, rangeLen, it->second.first)) { SessionlessMessageKey key = it->first; if (it->second.second->IsExpired()) { /* Remove expired message without sending */ localCache.erase(it++); messageErased = true; } else if (sid != 0) { /* Send message to remote destination */ bool isMatch = remoteRules.empty(); for (vector::iterator rit = remoteRules.begin(); !isMatch && (rit != remoteRules.end()); ++rit) { Rule rule(rit->c_str()); isMatch = rule.IsMatch(it->second.second) || (rule == legacyRule); } if (isMatch) { BusEndpoint ep = router.FindEndpoint(sender); if (ep->IsValid()) { lock.Unlock(); router.UnlockNameTable(); QCC_DbgPrintf(("Send cid=%u,serialNum=%u to sid=%u", it->second.first, it->second.second->GetCallSerial(), sid)); SendThroughEndpoint(it->second.second, ep, sid); router.LockNameTable(); lock.Lock(); } } it = localCache.upper_bound(key); } else { /* Send message to local destination */ SendMatchingThroughEndpoint(sid, it->second.second, fromLocalRulesId, toLocalRulesId); it = localCache.upper_bound(key); } } else { ++it; } } lock.Unlock(); router.UnlockNameTable(); /* Alert the advertiser worker */ if (messageErased) { uint32_t zero = 0; SessionlessObj* slObj = this; status = timer.AddAlarm(Alarm(zero, slObj)); } /* Close the session */ if (sid != 0) { status = bus.LeaveSession(sid); if (status == ER_OK) { QCC_DbgPrintf(("LeaveSession(sid=%u)", sid)); } else { QCC_LogError(status, ("LeaveSession sid=%u failed", sid)); } } } void SessionlessObj::AlarmTriggered(const Alarm& alarm, QStatus reason) { QCC_DbgTrace(("SessionlessObj::AlarmTriggered(alarm, %s)", QCC_StatusText(reason))); QStatus status = ER_OK; if (reason == ER_OK) { Timespec tilExpire; uint32_t expire; /* Send name service responses if needed */ Work* work = static_cast(alarm->GetContext()); if (work) { work->Run(); delete work; } /* Purge the local cache of expired messages */ lock.Lock(); LocalCache::iterator it = localCache.begin(); while (it != localCache.end()) { if (it->second.second->IsExpired(&expire)) { localCache.erase(it++); } else { ++it; } } lock.Unlock(); /* Change advertisment if needed */ UpdateAdvertisements(); /* Look for new/failed joinsessions to try/retry (after backoff) */ router.LockNameTable(); lock.Lock(); Timespec now; GetTimeNow(&now); RemoteCaches::iterator cit = remoteCaches.begin(); while (cit != remoteCaches.end()) { String guid = cit->first; RemoteCache& cache = cit->second; WorkType pendingWork = PendingWork(cache); if ((cache.nextJoinTime <= now) && (cache.state == RemoteCache::IDLE) && pendingWork) { RemoteCacheSnapshot* ctx = new RemoteCacheSnapshot(cache); cache.state = RemoteCache::IN_PROGRESS; if (pendingWork == SessionlessObj::APPLY_NEW_RULES) { cache.fromChangeId = cache.receivedChangeId - (numeric_limits::max() >> 1); cache.toChangeId = cache.receivedChangeId + 1; cache.fromRulesId = cache.appliedRulesId + 1; cache.toRulesId = nextRulesId; } else if (pendingWork == SessionlessObj::REQUEST_NEW_SIGNALS) { cache.fromChangeId = cache.receivedChangeId + 1; cache.toChangeId = cache.changeId + 1; cache.fromRulesId = cache.appliedRulesId - (numeric_limits::max() >> 1); cache.toRulesId = nextRulesId; } String name = cache.name; SessionOpts opts = sessionOpts; opts.transports = cache.transport; uint32_t retries = cache.retries; /* Need to release locks around JoinSessionAsync to avoid deadlock, see ASACORE-1402 */ lock.Unlock(); router.UnlockNameTable(); status = bus.JoinSessionAsync(name.c_str(), sessionPort, NULL, opts, this, reinterpret_cast(ctx)); router.LockNameTable(); lock.Lock(); cit = remoteCaches.find(guid); if (cit != remoteCaches.end()) { cache = cit->second; if (status == ER_OK) { QCC_DbgPrintf(("JoinSessionAsync(name=%s,...) pending", cache.name.c_str())); /* retries could be reset while unlocked, only increment if that hasn't happened */ if (cache.retries == retries) { ++cache.retries; } } else { QCC_LogError(status, ("JoinSessionAsync to %s failed", cache.name.c_str())); cache.state = RemoteCache::IDLE; /* Retry with a random backoff */ ScheduleWork(cache, false); if ((tilExpire == Timespec::Zero) || (cache.nextJoinTime < tilExpire)) { tilExpire = cache.nextJoinTime; } } } if (status != ER_OK) { delete ctx; } } cit = remoteCaches.upper_bound(guid); } lock.Unlock(); router.UnlockNameTable(); /* Rearm alarm */ if (tilExpire != Timespec::Zero) { SessionlessObj* slObj = this; timer.AddAlarm(Alarm(tilExpire, slObj)); } } else if (reason == ER_TIMER_EXITING) { Work* work = static_cast(alarm->GetContext()); if (work) { delete work; } } } void SessionlessObj::JoinSessionCB(QStatus status, SessionId sid, const SessionOpts& opts, void* context) { QCC_UNUSED(opts); RemoteCacheSnapshot* ctx = reinterpret_cast(context); QCC_DbgPrintf(("JoinSessionCB(status=%s,sid=%u) name=%s", QCC_StatusText(status), sid, ctx->name.c_str())); /* Send out RequestRange message if join was successful. Otherwise retry. */ router.LockNameTable(); lock.Lock(); RemoteCaches::iterator cit = remoteCaches.find(ctx->guid); if (cit != remoteCaches.end()) { RemoteCache& cache = cit->second; uint32_t fromId = cache.fromChangeId; uint32_t toId = cache.toChangeId; bool rangeCapable = false; bool matchCapable = false; vector matchRules; if (status == ER_OK) { /* Update session ID */ cache.sid = sid; /* Check to see if session host is capable of handling RequestRange */ BusEndpoint ep = router.FindEndpoint(ctx->name); if (ep->IsValid() && (ep->GetEndpointType() == ENDPOINT_TYPE_VIRTUAL)) { RemoteEndpoint rep = VirtualEndpoint::cast(ep)->GetBusToBusEndpoint(sid); if (rep->IsValid()) { rangeCapable = (rep->GetRemoteProtocolVersion() >= 6); matchCapable = (rep->GetRemoteProtocolVersion() >= 10); } } if (!rangeCapable && (toId != cache.changeId + 1)) { /* This session can't be used because the remote side doesn't support RequestRange */ status = bus.LeaveSession(sid); QCC_LogError(status, ("Failed to leave session %u", sid)); DoSessionLost(sid, ALLJOYN_SESSIONLOST_REMOTE_END_LEFT_SESSION); status = ER_FAIL; } if (matchCapable) { uint32_t rulesRangeLen = cache.toRulesId - cache.fromRulesId; for (RuleIterator rit = rules.begin(); rit != rules.end(); ++rit) { if (IN_WINDOW(uint32_t, cache.fromRulesId, rulesRangeLen, rit->second.id)) { matchRules.push_back(rit->second.ToString()); } } for (ImplicitRuleIterator irit = implicitRules.begin(); irit != implicitRules.end(); ++irit) { qcc::String sender = irit->sender; if (sender.substr(1, sender.find_last_of('.') - 1) == cache.guid) { matchRules.push_back(irit->ToString()); } } } } else { QCC_DbgPrintf(("JoinSessionAsync to %s failed - %s", cache.name.c_str(), QCC_StatusText(status))); /* Clear in progress */ cache.state = RemoteCache::IDLE; cache.sid = 0; if (ScheduleWork(cache) != ER_OK) { /* Retries exhausted. Clear state and wait for new advertisment */ EraseRemoteCache(cit); } } lock.Unlock(); router.UnlockNameTable(); if (status == ER_OK) { /* * Send the request signal if join was successful. Prefer * RequestRange since it may be possible to receive duplicates when * RequestSignals is used together with RequestRange. * * The request signal is sent to the owner of the cache's advertised * name, not the advertised name. The owner of the cache's name is * the remote routing node, and will always be :GUID.1. The reason * to send to the owner and not the advertised name is that the * advertised name can be cancelled/released after joining the * session but before the request signal is sent if the remote * router advertises a new change ID in that interval. */ String name = ":" + ctx->guid + ".1"; if (matchCapable) { status = RequestRangeMatch(name.c_str(), sid, fromId, toId, matchRules); } else if (rangeCapable) { status = RequestRange(name.c_str(), sid, fromId, toId); } else { status = RequestSignals(name.c_str(), sid, fromId); } if (status != ER_OK) { QCC_LogError(status, ("Failed to send Request to %s", name.c_str())); status = bus.LeaveSession(sid); QCC_LogError(status, ("Failed to leave session %u", sid)); lock.Lock(); cit = remoteCaches.find(ctx->guid); if (cit != remoteCaches.end()) { cache = cit->second; /* Clear in progress */ cache.state = RemoteCache::IDLE; cache.sid = 0; if (ScheduleWork(cache) != ER_OK) { /* Retries exhausted. Clear state and wait for new advertisment */ EraseRemoteCache(cit); } } lock.Unlock(); } } } else { lock.Unlock(); router.UnlockNameTable(); QCC_LogError(ER_FAIL, ("Missing cache in remoteCaches for %s", ctx->guid.c_str())); } delete ctx; } QStatus SessionlessObj::ParseAdvertisedName(const qcc::String& name, uint32_t* version, qcc::String* guid, qcc::String* iface, uint32_t* changeId) { size_t guidPos = String::npos; size_t changePos = name.find_last_of('.'); if (changePos != String::npos) { if (changeId) { *changeId = StringToU32(name.substr(changePos + 2), 16); } guidPos = name.find_last_of('.', changePos); } if (guidPos == String::npos) { return ER_FAIL; } if (guid) { *guid = name.substr(guidPos + 2, changePos - guidPos - 2); } if (version) { *version = name[guidPos + 1] - 'x'; } if (iface && (guidPos > 3)) { *iface = name.substr(0, guidPos - 3); if (*iface == WildcardInterfaceName) { iface->clear(); } } return ER_OK; } QStatus SessionlessObj::RequestSignals(const char* name, SessionId sid, uint32_t fromId) { MsgArg args[1]; args[0].Set("u", fromId); QCC_DbgPrintf(("RequestSignals(name=%s,sid=%u,fromId=%d)", name, sid, fromId)); return Signal(name, sid, *requestSignalsSignal, args, ArraySize(args)); } QStatus SessionlessObj::RequestRange(const char* name, SessionId sid, uint32_t fromId, uint32_t toId) { MsgArg args[2]; args[0].Set("u", fromId); args[1].Set("u", toId); QCC_DbgPrintf(("RequestRange(name=%s,sid=%u,fromId=%d,toId=%d)", name, sid, fromId, toId)); return Signal(name, sid, *requestRangeSignal, args, ArraySize(args)); } QStatus SessionlessObj::RequestRangeMatch(const char* name, SessionId sid, uint32_t fromId, uint32_t toId, std::vector& matchRules) { MsgArg args[3]; args[0].Set("u", fromId); args[1].Set("u", toId); args[2].Set("a$", matchRules.size(), matchRules.empty() ? NULL : &matchRules[0]); QCC_DbgPrintf(("RequestRangeMatch(name=%s,sid=%u,fromId=%d,toId=%d,numRules=%d)", name, sid, fromId, toId, matchRules.size())); return Signal(name, sid, *requestRangeMatchSignal, args, ArraySize(args)); } QStatus SessionlessObj::SendThroughEndpoint(Message& msg, BusEndpoint& ep, SessionId sid) { QStatus status; #ifdef ENABLE_POLICYDB PolicyDB policyDB = ConfigDB::GetConfigDB()->GetPolicyDB(); BusEndpoint dummy; NormalizedMsgHdr nmh(msg, policyDB, dummy); bool okToReceive = policyDB->OKToReceive(nmh, ep); #else bool okToReceive = true; #endif if (!okToReceive) { status = ER_BUS_POLICY_VIOLATION; } else if (ep->GetEndpointType() == ENDPOINT_TYPE_VIRTUAL) { status = VirtualEndpoint::cast(ep)->PushMessage(msg, sid); } else { status = ep->PushMessage(msg); } if ((status != ER_OK) && (status != ER_BUS_ENDPOINT_CLOSING) && (status != ER_BUS_STOPPING)) { QCC_LogError(status, ("SendThroughEndpoint(dest=%s,ep=%s,sid=%u) failed", msg->GetDestination(), ep->GetUniqueName().c_str(), sid)); } return status; } void SessionlessObj::UpdateAdvertisements() { /* Figure out what we need to advertise. */ map advertisements; lock.Lock(); for (LocalCache::iterator it = localCache.begin(); it != localCache.end(); ++it) { Message msg = it->second.second; advertisements[msg->GetInterface()] = max(advertisements[msg->GetInterface()], it->second.first); advertisements[WildcardInterfaceName] = max(advertisements[WildcardInterfaceName], it->second.first); /* The v0 advertisement */ } /* First pass: cancel any names that don't need to be advertised anymore. */ vector cancelNames; for (map::iterator last = lastAdvertisements.begin(); last != lastAdvertisements.end();) { String name = last->first; if (advertisements.find(name) == advertisements.end()) { cancelNames.push_back(AdvertisedName(name, last->second)); lastAdvertisements.erase(last); last = lastAdvertisements.upper_bound(name); } else { ++last; } } /* Second pass: update/add any new advertisements. */ vector advertiseNames; for (map::iterator it = advertisements.begin(); it != advertisements.end(); ++it) { map::iterator last = lastAdvertisements.find(it->first); if (last == lastAdvertisements.end() || IS_GREATER(uint32_t, it->second, last->second)) { if (last != lastAdvertisements.end()) { cancelNames.push_back(AdvertisedName(last->first, last->second)); lastAdvertisements.erase(last); } advertiseNames.push_back(AdvertisedName(it->first, it->second)); lastAdvertisements[it->first] = it->second; } } lock.Unlock(); for (vector::iterator it = cancelNames.begin(); it != cancelNames.end(); ++it) { CancelAdvertisedName(*it); } for (vector::iterator it = advertiseNames.begin(); it != advertiseNames.end(); ++it) { AdvertiseName(*it); } } qcc::String SessionlessObj::AdvertisedName(const qcc::String& iface, uint32_t changeId) { String name = iface; name.append(".sl."); name.append('x' + version); name.append(bus.GetGlobalGUIDShortString()); name.append(".x"); name.append(U32ToString(changeId, 16)); return name; } QStatus SessionlessObj::AdvertiseName(const qcc::String& name) { QStatus status = bus.RequestName(name.c_str(), DBUS_NAME_FLAG_DO_NOT_QUEUE); if (status == ER_OK) { status = bus.AdvertiseName(name.c_str(), sessionOpts.transports & ~TRANSPORT_LOCAL); } if (status == ER_OK) { QCC_DbgPrintf(("AdvertiseName(name=%s)", name.c_str())); } else { QCC_LogError(status, ("Failed to request/advertise \"%s\"", name.c_str())); } return status; } void SessionlessObj::CancelAdvertisedName(const qcc::String& name) { QStatus status = bus.CancelAdvertiseName(name.c_str(), sessionOpts.transports & ~TRANSPORT_LOCAL); if (status != ER_OK) { QCC_LogError(status, ("Failed to cancel advertisment for \"%s\"", name.c_str())); } status = bus.ReleaseName(name.c_str()); if (status == ER_OK) { QCC_DbgPrintf(("CancelAdvertiseName(name=%s)", name.c_str())); } else { QCC_LogError(status, ("Failed to release name \"%s\"", name.c_str())); } } void SessionlessObj::FindAdvertisedNames() { set names; for (RuleIterator rit = rules.begin(); rit != rules.end(); ++rit) { String name; if (rit->second.implements.empty()) { name = "name='" + (rit->second.iface.empty() ? WildcardInterfaceName : rit->second.iface) + ".sl.*'"; } else { for (set::const_iterator iit = rit->second.implements.begin(); iit != rit->second.implements.end(); ++iit) { if (!name.empty()) { name += ","; } name += "implements='" + *iit + "'"; } } if (name.empty()) { continue; } if (findingNames.insert(name).second) { names.insert(name); } } if (!findingNames.empty()) { /* * If we're finding anything, we always need to find the v0 * advertisement for backwards compatibility. */ String name = String("name='") + WildcardInterfaceName + ".sl.*'"; if (findingNames.insert(name).second) { names.insert(name); } } lock.Unlock(); router.UnlockNameTable(); set::iterator it = names.begin(); while (it != names.end()) { String name = *it; QCC_DbgPrintf(("FindAdvertisement(%s)", name.c_str())); QStatus status = FindAdvertisementByTransport(name.c_str(), sessionOpts.transports & ~TRANSPORT_LOCAL); if (status != ER_OK) { QCC_LogError(status, ("FindAdvertisementByTransport failed for name %s :", name.c_str())); } it++; } router.LockNameTable(); lock.Lock(); } void SessionlessObj::CancelFindAdvertisedNames() { set names = findingNames; findingNames.clear(); lock.Unlock(); router.UnlockNameTable(); set::iterator it = names.begin(); while (it != names.end()) { String name = *it; QStatus status = CancelFindAdvertisementByTransport(name.c_str(), sessionOpts.transports & ~TRANSPORT_LOCAL); if (status == ER_OK) { QCC_DbgPrintf(("CancelFindAdvertisement(%s)", name.c_str())); } else { QCC_LogError(status, ("CancelFindAdvertisementByTransport failed for name %s :", name.c_str())); } it++; } router.LockNameTable(); lock.Lock(); } SessionlessObj::RemoteCaches::iterator SessionlessObj::FindRemoteCache(SessionId sid) { RemoteCaches::iterator cit; for (cit = remoteCaches.begin(); cit != remoteCaches.end(); ++cit) { if (cit->second.sid == sid) { break; } } return cit; } void SessionlessObj::ScheduleWork(bool doInitialBackoff) { RemoteCaches::iterator cit = remoteCaches.begin(); while (cit != remoteCaches.end()) { RemoteCache& cache = cit->second; String guid = cache.guid; if (PendingWork(cache) && ScheduleWork(cache, true, doInitialBackoff) != ER_OK) { /* Retries exhausted. Clear state and wait for new advertisment */ EraseRemoteCache(cit); cit = remoteCaches.upper_bound(guid); } else { ++cit; } } } QStatus SessionlessObj::ScheduleWork(RemoteCache& cache, bool addAlarm, bool doInitialBackoff) { if (cache.state != RemoteCache::IDLE) { return ER_OK; } QStatus status = GetNextJoinTime(backoff, doInitialBackoff, cache.retries, cache.firstJoinTime, cache.nextJoinTime); if (status != ER_OK) { QCC_LogError(ER_FAIL, ("Exhausted JoinSession retries to %s", cache.guid.c_str())); return ER_FAIL; } if (addAlarm) { SessionlessObj* slObj = this; QStatus status = timer.AddAlarm(Alarm(cache.nextJoinTime, slObj)); if (status != ER_OK) { QCC_LogError(status, ("Timer::AddAlarm failed")); } } return ER_OK; } /* * The backoff schedule looks like this: * * Initial * | Linear * | | Exponential * | | | Constant * | | | | * v v v v * | T || 1T | 2T | 3T | 4T || 8T | 16T | 32T || 32T | 32T ... * * The actual join time is randomly distributed over the retry interval above. */ QStatus SessionlessObj::GetNextJoinTime(const BackoffLimits& backoff, bool doInitialBackoff, uint32_t retries, qcc::Timespec& firstJoinTime, qcc::Timespec& nextJoinTime) { if (retries == 0) { GetTimeNow(&firstJoinTime); } qcc::Timespec startTime; uint32_t delayMs = 1; for (uint32_t m = 0, i = 0; i <= retries; ++i) { if (i == 0) { /* Initial backoff */ startTime = firstJoinTime; delayMs = doInitialBackoff ? backoff.periodMs : 1; } else if (i <= backoff.linear) { /* Linear backoff */ m = m + 1; startTime += delayMs; delayMs = m * backoff.periodMs; } else if (m < backoff.exponential) { /* Exponential backoff */ m = m << 1; startTime += delayMs; delayMs = m * backoff.periodMs; } else { /* Constant backoff */ startTime += delayMs; } } nextJoinTime = (startTime + qcc::Rand32() % delayMs); if ((nextJoinTime - firstJoinTime) < (backoff.maxSecs * 1000)) { return ER_OK; } else { return ER_FAIL; } } SessionlessObj::WorkType SessionlessObj::PendingWork(RemoteCache& cache) { if (cache.haveReceived && IS_GREATER(uint32_t, nextRulesId - 1, cache.appliedRulesId)) { if (IsMatch(cache, cache.appliedRulesId + 1, nextRulesId)) { return APPLY_NEW_RULES; } } else if (IS_GREATER(uint32_t, cache.changeId, cache.receivedChangeId)) { if (IsMatch(cache, cache.appliedRulesId - (numeric_limits::max() >> 1), nextRulesId)) { return REQUEST_NEW_SIGNALS; } } return NONE; } bool SessionlessObj::IsMatch(RemoteCache& cache, uint32_t fromRulesId, uint32_t toRulesId) { if (cache.version == 0) { return true; } uint32_t rulesRangeLen = toRulesId - fromRulesId; for (RuleIterator rit = rules.begin(); rit != rules.end(); ++rit) { if (IN_WINDOW(uint32_t, fromRulesId, rulesRangeLen, rit->second.id) && (cache.ifaces.find(rit->second.iface) != cache.ifaces.end())) { return true; } } return false; } bool SessionlessObj::QueryHandler(TransportMask transport, MDNSPacket query, const qcc::IPEndpoint& src, const qcc::IPEndpoint& dst) { MDNSResourceRecord* searchRecord; if (!query->GetAdditionalRecord("search.*", MDNSResourceRecord::TXT, &searchRecord)) { return false; } MDNSSearchRData* searchRData = static_cast(searchRecord->GetRData()); if (!searchRData) { QCC_DbgPrintf(("Ignoring query with invalid search info")); return false; } bool sentResponse = false; String ruleStr; for (int i = 0; !sentResponse && i < searchRData->GetNumFields(); ++i) { pair field = searchRData->GetFieldAt(i); if (field.first == "implements") { if (!ruleStr.empty()) { ruleStr += ","; } ruleStr += "implements='" + field.second + "'"; } else if (field.first == ";") { sentResponse = SendResponseIfMatch(transport, src, dst, ruleStr); ruleStr.clear(); } } if (!sentResponse) { sentResponse = SendResponseIfMatch(transport, src, dst, ruleStr); } return sentResponse; } bool SessionlessObj::SendResponseIfMatch(TransportMask transport, const qcc::IPEndpoint& src, const qcc::IPEndpoint& dst, const qcc::String& ruleStr) { if (ruleStr.empty()) { return false; } bool sendResponse = false; Rule rule(ruleStr.c_str()); String name; lock.Lock(); for (LocalCache::iterator mit = localCache.begin(); mit != localCache.end(); ++mit) { Message& msg = mit->second.second; if (rule.IsMatch(msg)) { name = AdvertisedName(msg->GetInterface(), lastAdvertisements[msg->GetInterface()]); sendResponse = true; break; } } lock.Unlock(); if (sendResponse) { ScheduleWork(new SendResponseWork(*this, transport, name, src, dst)); } return sendResponse; } bool SessionlessObj::ResponseHandler(TransportMask transport, MDNSPacket response, uint16_t recvPort) { MDNSResourceRecord* advRecord; if (!response->GetAdditionalRecord("advertise.*", MDNSResourceRecord::TXT, &advRecord)) { return false; } if (advRecord->GetRRttl() == 0) { return false; } MDNSAdvertiseRData* advRData = static_cast(advRecord->GetRData()); if (!advRData) { QCC_DbgPrintf(("Ignoring response with invalid advertisement info")); return false; } /* * We always want to fetch advertisements received on the * multicast port (the unsolicited case). We only want to fetch * advertisements received on the unicast port when they are a * response to our implements query. * * The check for only 1 name in the response is what determines * that the response is to our implements query. The situation * is that a unicast response may include all the names * advertised by the responder, even ones we didn't ask for. So * since we never explicitly ask for org.alljoyn.About.sl names * then if there's more than 1 name in the response the response * must have been for a different query. */ bool unsolicited = (recvPort == IpNameService::MULTICAST_MDNS_PORT); bool solicited = (advRData->GetNumNames() == 1); if (!unsolicited && !solicited) { return false; } /* * Next step is to see if the response matches any of our rules. If it * does, then report the name as found. */ router.LockNameTable(); lock.Lock(); for (RuleIterator rit = rules.begin(); rit != rules.end(); ++rit) { Rule& rule = rit->second; if (rule.iface != "org.alljoyn.About") { continue; } String name; for (int i = 0; i < advRData->GetNumFields(); ++i) { pair field = advRData->GetFieldAt(i); if ((field.first == "name") && (field.second.find(rule.iface) == 0)) { name = field.second; } else if (field.first == "transport") { transport = StringToU32(field.second, 16); if (!name.empty()) { QCC_DbgPrintf(("Received %s implements response (name=%s) ttl %d", (unsolicited ? "unsolicited" : "solicited"), name.c_str(), advRecord->GetRRttl())); FoundAdvertisedNameHandler(name.c_str(), transport, name.c_str(), unsolicited); } name.clear(); } } if (!name.empty()) { QCC_DbgPrintf(("Received %s implements response (name=%s) ttl %d", (unsolicited ? "unsolicited" : "solicited"), name.c_str(), advRecord->GetRRttl())); FoundAdvertisedNameHandler(name.c_str(), transport, name.c_str(), unsolicited); } } lock.Unlock(); router.UnlockNameTable(); /* Always return false since we're just sniffing for org.alljoyn.About.sl. advertisements */ return false; } QStatus SessionlessObj::FindAdvertisementByTransport(const char* matching, TransportMask transports) { Message reply(bus); MsgArg args[2]; size_t numArgs = ArraySize(args); MsgArg::Set(args, numArgs, "sq", matching, transports); const ProxyBusObject& alljoynObj = bus.GetAllJoynProxyObj(); QStatus status = alljoynObj.MethodCall(org::alljoyn::Bus::InterfaceName, "FindAdvertisementByTransport", args, numArgs, reply); if (ER_OK == status) { uint32_t disposition; status = reply->GetArgs("u", &disposition); if (ER_OK == status) { switch (disposition) { case ALLJOYN_FINDADVERTISEDNAME_REPLY_SUCCESS: break; case ALLJOYN_FINDADVERTISEDNAME_REPLY_ALREADY_DISCOVERING: status = ER_ALLJOYN_FINDADVERTISEDNAME_REPLY_ALREADY_DISCOVERING; break; case ALLJOYN_FINDADVERTISEDNAME_REPLY_FAILED: status = ER_ALLJOYN_FINDADVERTISEDNAME_REPLY_FAILED; break; default: status = ER_BUS_UNEXPECTED_DISPOSITION; break; } } } else { QCC_LogError(status, ("%s.FindAdvertisement returned ERROR_MESSAGE (error=%s)", org::alljoyn::Bus::InterfaceName, reply->GetErrorDescription().c_str())); } return status; } QStatus SessionlessObj::CancelFindAdvertisementByTransport(const char* matching, TransportMask transports) { Message reply(bus); MsgArg args[2]; size_t numArgs = ArraySize(args); MsgArg::Set(args, numArgs, "sq", matching, transports); const ProxyBusObject& alljoynObj = bus.GetAllJoynProxyObj(); QStatus status = alljoynObj.MethodCall(org::alljoyn::Bus::InterfaceName, "CancelFindAdvertisementByTransport", args, numArgs, reply); if (ER_OK == status) { uint32_t disposition; status = reply->GetArgs("u", &disposition); if (ER_OK == status) { switch (disposition) { case ALLJOYN_CANCELFINDADVERTISEDNAME_REPLY_SUCCESS: break; case ALLJOYN_CANCELFINDADVERTISEDNAME_REPLY_FAILED: status = ER_ALLJOYN_CANCELFINDADVERTISEDNAME_REPLY_FAILED; break; default: status = ER_BUS_UNEXPECTED_DISPOSITION; break; } } } else { QCC_LogError(status, ("%s.CancelFindAdvertisement returned ERROR_MESSAGE (error=%s)", org::alljoyn::Bus::InterfaceName, reply->GetErrorDescription().c_str())); } return status; } void SessionlessObj::EraseRemoteCache(RemoteCaches::iterator cit) { RemoveImplicitRules(cit->second); remoteCaches.erase(cit); } void SessionlessObj::AddImplicitRule(const Rule& rule, const RuleIterator& explicitRule) { for (ImplicitRuleIterator irit = implicitRules.begin(); irit != implicitRules.end(); ++irit) { if (*irit == rule) { for (std::vector::iterator erit = irit->explicitRules.begin(); erit != irit->explicitRules.end(); ++erit) { if (*erit == explicitRule) { return; } } irit->explicitRules.push_back(explicitRule); return; } } implicitRules.push_back(ImplicitRule(rule, explicitRule)); } void SessionlessObj::RemoveImplicitRules(const qcc::String& epName) { QCC_DbgTrace(("SessionlessObj::RemoveImplicitRules(epName=%s)", epName.c_str())); ImplicitRuleIterator irit = implicitRules.begin(); while (irit != implicitRules.end()) { std::vector::iterator erit = irit->explicitRules.begin(); while (erit != irit->explicitRules.end()) { if ((*erit)->first == epName) { irit->explicitRules.erase(erit); erit = irit->explicitRules.begin(); } else { ++erit; } } if (irit->explicitRules.empty()) { implicitRules.erase(irit); irit = implicitRules.begin(); } else { ++irit; } } } void SessionlessObj::RemoveImplicitRules(const RuleIterator& explicitRule) { QCC_DbgTrace(("SessionlessObj::RemoveImplicitRules(explicitrule=%s for endpoint %s)", explicitRule->second.ToString().c_str(), explicitRule->first.c_str())); ImplicitRuleIterator irit = implicitRules.begin(); while (irit != implicitRules.end()) { bool deleted = false; for (std::vector::iterator erit = irit->explicitRules.begin(); erit != irit->explicitRules.end(); ++erit) { if (*erit == explicitRule) { irit->explicitRules.erase(erit); if (irit->explicitRules.empty()) { implicitRules.erase(irit); deleted = true; } break; } } if (deleted) { irit = implicitRules.begin(); } else { irit++; } } } void SessionlessObj::RemoveImplicitRules(const RemoteCache& cache) { QCC_DbgTrace(("SessionlessObj::RemoveImplicitRules(remotecache=%s)", cache.guid.c_str())); String guid = cache.guid; ImplicitRuleIterator irit = implicitRules.begin(); while (irit != implicitRules.end()) { String sender = irit->sender; if (sender.substr(1, sender.find_last_of('.') - 1) == guid) { implicitRules.erase(irit); irit = implicitRules.begin(); } else { irit++; } } } bool SessionlessObj::IsOnlyImplicitMatch(const qcc::String& epName, Message& msg) { QCC_DbgTrace(("IsOnlyImplicitMatch(epName=%s, msg.sender=%s)", epName.c_str(), msg->GetSender())); /* Find the implicit rule that matches the message sender, check all associated * explicit rules that originate from epName. If none of those matches, the match is * purely implicit, and the implicit match rule should be removed for this epName. */ for (ImplicitRuleIterator irit = implicitRules.begin(); irit != implicitRules.end(); ++irit) { if (irit->IsMatch(msg)) { bool hasExplicitMatch = false; std::pair range = rules.equal_range(epName); bool hasExplicitRules = (range.first != range.second); for (; range.first != range.second; range.first++) { if (range.first->second.IsMatch(msg)) { hasExplicitMatch = true; break; } } if (hasExplicitRules && !hasExplicitMatch) { /* remove all explicit rules related to epName */ vector::iterator erit = irit->explicitRules.begin(); while (erit != irit->explicitRules.end()) { if ((*erit)->first == epName) { irit->explicitRules.erase(erit); erit = irit->explicitRules.begin(); } else { erit++; } } if (irit->explicitRules.empty()) { implicitRules.erase(irit); } return true; } return false; } } return false; } void SessionlessObj::ScheduleWork(Work* work) { const uint32_t timeout = 0; SessionlessObj* pObj = this; Alarm alarm(timeout, pObj, work); QStatus status = timer.AddAlarm(alarm); if (ER_OK != status) { /* * When daemon is closing the daemon will receive multiple error * because the timer is exiting. print a high level debug message * not a log error since this is expected behaver and should not * be presented to the user if they don't want to see it. */ if (ER_TIMER_EXITING == status) { QCC_DbgHLPrintf(("Timer::AddAlarm failed : %s", QCC_StatusText(status))); } else { QCC_LogError(status, ("Timer::AddAlarm failed")); } delete work; } } } alljoyn-15.04b/alljoyn_core/router/SessionlessObj.h000066400000000000000000000623661255700255500224760ustar00rootroot00000000000000/** * @file * SessionObj is for implementing the daemon-to-daemon inteface org.alljoyn.sl */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_SESSIONLESSOBJ_H #define _ALLJOYN_SESSIONLESSOBJ_H #include #include #include #include #include #include #include #include #include #include #include "Bus.h" #include "DaemonRouter.h" #include "NameTable.h" #include "RuleTable.h" #include "Transport.h" #include "ns/IpNameService.h" namespace ajn { /** Forward Declaration */ class BusController; /** * BusObject responsible for implementing the standard AllJoyn interface org.alljoyn.sl. */ class SessionlessObj : public BusObject, public NameListener, public SessionListener, public SessionPortListener, public BusAttachment::JoinSessionAsyncCB, public qcc::AlarmListener, public IpNameServiceListener { public: /** * Constructor * * @param bus Bus to associate with org.freedesktop.DBus message handler. * @param router The DaemonRouter associated with the bus. * @param busController Controller that created this object. */ SessionlessObj(Bus& bus, BusController* busController, DaemonRouter& router); /** * Destructor */ ~SessionlessObj(); /** * Initialize and register this DBusObj instance. * * @return ER_OK if successful. */ QStatus Init(); /** * Stop SessionlessObj. * * @return ER_OK if successful. */ QStatus Stop(); /** * Join SessionlessObj. * * @return ER_OK if successful. */ QStatus Join(); /** * Called when object is successfully registered. */ void ObjectRegistered(void); /** * Add a rule for an endpoint. * * @param epName The name of the endpoint that this rule applies to. * @param rule Rule for endpoint */ void AddRule(const qcc::String& epName, Rule& rule); /** * Remove a rule for an endpoint. * * @param epName The name of the endpoint that rule applies to. * @param rule Rule to remove. */ void RemoveRule(const qcc::String& epName, Rule& rule); /** * Push a sessionless signal. * * @param msg Message to be pushed. */ QStatus PushMessage(Message& msg); /** * Route an incoming sessionless signal if possible. * * @param sid Session ID associated with sessionless message. * @param msg Sesionless message to be routed. */ void RouteSessionlessMessage(uint32_t sid, Message& msg); /** * Remove a sessionless signal with a given serial number from the store/forward cache. * * @param msg The org.alljoyn.Bus.CancelSessionlessMessage method call message. */ void CancelMessage(Message& msg); void NameOwnerChanged(const qcc::String& busName, const qcc::String* oldOwner, SessionOpts::NameTransferType oldOwnerNameTransfer, const qcc::String* newOwner, SessionOpts::NameTransferType newOwnerNameTransfer); /** * Receive FoundAdvertisedName signals. * * @param member FoundAdvertisedName interface member. * @param sourcePath Sender of signal. * @param msg FoundAdvertisedName message. */ void FoundAdvertisedNameSignalHandler(const InterfaceDescription::Member* member, const char* sourcePath, Message& msg); /** * Accept/reject join attempt on sessionlesss port. * Implements SessionPortListener::AcceptSessionJoiner. * * @param port Session port of join attempt. * @param joiner Unique name of joiner. * @param opts SesionOpts specified by joiner. * * @return true if session is accepted. false otherwise. */ bool AcceptSessionJoiner(SessionPort port, const char* joiner, const SessionOpts& opts); /** * Called by the bus when a session has been successfully joined. * Implements SessionPortListener::SessionJoined. * * @param port Session port of join attempt. * @param sid Id of session. * @param joiner Unique name of joiner. */ void SessionJoined(SessionPort port, SessionId sid, const char* joiner); /** * Receive SessionLost signals. * * @param member SessionLost interface member. * @param sourcePath Sender of signal. * @param msg SessionLost message. */ void SessionLostSignalHandler(const InterfaceDescription::Member* member, const char* sourcePath, Message& msg); /** * Process incoming RequestSignals signals from remote daemons. * * @param member Interface member for signal * @param sourcePath object path sending the signal. * @param msg The signal message. */ void RequestSignalsSignalHandler(const InterfaceDescription::Member* member, const char* sourcePath, Message& msg); /** * Process incoming RequestRange signals from remote daemons. * * @param member Interface member for signal * @param sourcePath object path sending the signal. * @param msg The signal message. */ void RequestRangeSignalHandler(const InterfaceDescription::Member* member, const char* sourcePath, Message& msg); /** * Process incoming RequestRangeMatch signals from remote daemons. * * @param member Interface member for signal * @param sourcePath object path sending the signal. * @param msg The signal message. */ void RequestRangeMatchSignalHandler(const InterfaceDescription::Member* member, const char* sourcePath, Message& msg); /** * The parameters of the backoff algorithm. */ struct BackoffLimits { uint32_t periodMs; /**< the initial backoff period */ uint32_t linear; /**< the maximum linear backoff coefficient before switching to exponential */ uint32_t exponential; /**< the maximum exponential backoff coefficient before switching to constant */ uint32_t maxSecs; /**< the total backoff time in seconds before giving up */ BackoffLimits(uint32_t periodMs, uint32_t linear, uint32_t exponential, uint32_t maxSecs) : periodMs(periodMs), linear(linear), exponential(exponential), maxSecs(maxSecs) { } }; /** * Computes the next time to try fetching signals from a remote router. * * This implements the backoff algorithm. * * @param[in] backoff the backoff algorithm parameters * @param[in] doInitialBackoff true to do the initial backoff or false to skip. * @param[in] retries the number of fetches tried so far. * @param[in,out] firstJoinTime set when retries is 0, used in computing nextJoinTime when retries is greater than 0. * @param[out] nextJoinTime the next time to try fetching signals. * * @return ER_FAIL if the total retry time is exhausted, ER_OK otherwise */ static QStatus GetNextJoinTime(const BackoffLimits& backoff, bool doInitialBackoff, uint32_t retries, qcc::Timespec& firstJoinTime, qcc::Timespec& nextJoinTime); /** * Is this endpoint a sessionless emitter. * * @param name Name of endpoint to check. * * @return true if this endpoint is emitting a sessionless signal. */ bool IsSessionlessEmitter(qcc::String name); private: friend struct RemoteCacheSnapshot; /** * SessionlessObj worker. * * @param alarm The alarm object for the timeout that expired. */ void AlarmTriggered(const qcc::Alarm& alarm, QStatus reason); /** * JoinSession Callback. */ void JoinSessionCB(QStatus status, SessionId sid, const SessionOpts& opts, void* context); /** * Emit the range of cached sessionless signals [fromId, toId). * * When sid is 0, rules in the specified local range are applied before * emitting the signals. * * When sid is non-0, rules in the remote rules are applied before emitting * the signals. * * @param sender Unique name of requestor/sender * @param sid Session ID * @param fromId Beginning of changeId range (inclusive) * @param toId End of changeId range (exclusive) * @param fromLocalRulesId Beginning of rules ID range (inclusive) * @param toLocalRulesId End of rules ID range (exclusive) * @param remoteRules Remotely-supplied rules to apply */ void HandleRangeRequest(const char* sender, SessionId sid, uint32_t fromId, uint32_t toId, uint32_t fromLocalRulesId = 0, uint32_t toLocalRulesId = 0, std::vector remoteRules = std::vector()); /** * SessionLost helper handler. * * @param sid Session ID of lost session. * @param reason The reason for the session being lost. */ void DoSessionLost(SessionId sid, SessionLostReason reason); Bus& bus; /**< The bus */ BusController* busController; /**< BusController that created this BusObject */ DaemonRouter& router; /**< The router */ /* The version implemented. */ static const uint32_t version; const Rule legacyRule; const InterfaceDescription* sessionlessIface; /**< org.alljoyn.sl interface */ const InterfaceDescription::Member* requestSignalsSignal; /**< org.alljoyn.sl.RequestSignal signal */ const InterfaceDescription::Member* requestRangeSignal; /**< org.alljoyn.sl.RequestRange signal */ const InterfaceDescription::Member* requestRangeMatchSignal; /**< org.alljoyn.sl.RequestRangeMatch signal */ qcc::Timer timer; /**< Timer object for reaping expired names */ /** A key into the local sessionless message queue */ class SessionlessMessageKey : public qcc::String { public: SessionlessMessageKey(const char* sender, const char* iface, const char* member, const char* objPath) : qcc::String(sender, 0, ::strlen(sender) + ::strlen(iface) + ::strlen(member) + ::strlen(objPath) + 4) { append(':'); append(iface); append(':'); append(member); append(':'); append(objPath); } }; typedef std::pair SessionlessMessage; typedef std::map LocalCache; /** Storage for sessionless messages waiting to be delivered */ LocalCache localCache; struct RoutedMessage { RoutedMessage(const Message& msg) : sender(msg->GetSender()), serial(msg->GetCallSerial()) { } qcc::String sender; uint32_t serial; bool operator==(const RoutedMessage& other) const { return (sender == other.sender) && (serial == other.serial); } }; class RemoteCache { public: RemoteCache(const qcc::String& name, uint32_t version, const qcc::String& guid, const qcc::String& iface, uint32_t changeId, TransportMask transport) : name(name), version(version), guid(guid), changeId(changeId), transport(transport), haveReceived(false), receivedChangeId(std::numeric_limits::max()), appliedRulesId(std::numeric_limits::max()), state(IDLE), retries(0), sid(0) { ifaces.insert(iface); } /* The most recent advertisement */ qcc::String name; /* The union of all the advertisements */ uint32_t version; qcc::String guid; std::set ifaces; uint32_t changeId; TransportMask transport; /* State */ bool haveReceived; /* true once we have received something from the remote cache */ uint32_t receivedChangeId; uint32_t appliedRulesId; /* Work item */ uint32_t fromChangeId, toChangeId; uint32_t fromRulesId, toRulesId; /* Work item state */ enum { IDLE = 0, IN_PROGRESS } state; uint32_t retries; qcc::Timespec firstJoinTime; qcc::Timespec nextJoinTime; SessionId sid; std::list routedMessages; }; typedef std::map RemoteCaches; /** The state of found remote caches */ RemoteCaches remoteCaches; /** Find the remote cache work item with the matching session ID */ RemoteCaches::iterator FindRemoteCache(SessionId sid); /** Erase info associated with the remote cache */ void EraseRemoteCache(RemoteCaches::iterator cit); qcc::Mutex lock; /**< Mutex that protects this object's data structures */ uint32_t curChangeId; /**< Change id assoc with current pushed signal(s) */ bool isDiscoveryStarted; /**< True when FindAdvetiseName is ongoing */ SessionOpts sessionOpts; /**< SessionOpts used by internal session */ SessionPort sessionPort; /**< SessionPort used by internal session */ bool advanceChangeId; /**< Set to true when changeId should be advanced on next SLS send request */ uint32_t nextRulesId; /**< The next added rule change ID */ const BackoffLimits backoff; /**< The backoff algorithm parameters */ /** * Internal helper for parsing an advertised name into its guid, change * ID, and version parts. * * An advertised name has the following form: "org.alljoyn.sl.xGUID.xCID". * The 'x' of "xGUID" is abused to indicate a version. 'x' is version 0, * 'y' is version 1, etc. This is to enable backwards compatibility for * version 0 implementations. * * @param[in] name * @param[out] version * @param[out] guid * @param[out] iface * @param[out] changeId * * @return ER_OK if parsed succesfully */ QStatus ParseAdvertisedName(const qcc::String& name, uint32_t* version, qcc::String* guid, qcc::String* iface, uint32_t* changeId); /** * Internal helper for sending the RequestSignals signal. * * @param[in] name Advertised name of sender * @param[in] sid Session ID * @param[in] fromId Beginning of changeId range (inclusive) */ QStatus RequestSignals(const char* name, SessionId sid, uint32_t fromId); /** * Internal helper for sending the RequestRange signal. * * @param[in] name Advertised name of sender * @param[in] sid Session ID * @param[in] fromId Beginning of changeId range (inclusive) * @param[in] toId End of changeId range (exclusive) */ QStatus RequestRange(const char* name, SessionId sid, uint32_t fromId, uint32_t toId); /** * Internal helper for sending the RequestRangeMatch signal. * * @param[in] name Advertised name of sender * @param[in] sid Session ID * @param[in] fromId Beginning of changeId range (inclusive) * @param[in] toId End of changeId range (exclusive) * @param[in] matchRules Match rules to apply to changeId range */ QStatus RequestRangeMatch(const char* name, SessionId sid, uint32_t fromId, uint32_t toId, std::vector& matchRules); /** * Internal helper for sending sessionless signals. * * @param[in] msg The sessionless signal * @param[in] ep The destination endpoint * @param[in] sid Session ID */ QStatus SendThroughEndpoint(Message& msg, BusEndpoint& ep, SessionId sid); /* * Internal helper for sending sessionless signals filtered by our rule table. * * @param[in] sid Session ID * @param[in] msg The sessionless signal * @param[in] fromRulesId Beginning of rules ID range (inclusive) * @param[in] toRulesId End of rules ID range (exclusive) */ void SendMatchingThroughEndpoint(SessionId sid, Message msg, uint32_t fromRulesId, uint32_t toRulesId); /** * A match rule that includes a change ID for recording when it was entered * into the rule table. */ struct TimestampedRule : public Rule { TimestampedRule(Rule& rule, uint32_t id) : Rule(rule), id(id) { } uint32_t id; }; /** Table of endpoint name, timestamped rule. */ std::multimap rules; /** Rule iterator */ typedef std::multimap::iterator RuleIterator; /** * An implicit match rule that includes a list of explicit rules that it is * associated with. */ struct ImplicitRule : public Rule { ImplicitRule(const Rule& rule, const RuleIterator& explicitRule) : Rule(rule) { explicitRules.push_back(explicitRule); } std::vector explicitRules; }; /** List of implicit rules. */ std::vector implicitRules; /** Implicit rule iterator */ typedef std::vector::iterator ImplicitRuleIterator; /** * Add an implicit, explicit rule entry. Each implicit rule is associated * with at least one explicit rule. * * @param[in] implicitRule the implicit rule * @param[in] explicitRule the iterator of the explicit rule in rules */ void AddImplicitRule(const Rule& implicitRule, const RuleIterator& explicitRule); /** * Remove explicit rules associated with an endpoint from the implicit * rules. When all explicit associations are removed, the implicit rule is * removed. * * @param[in] epName the name of the endpoint */ void RemoveImplicitRules(const qcc::String& epName); /** * Remove an explicit rule from all implicit rule entries. When all * explicit associations for an implicit rule are removed, the implicit * rule is removed. * * @param[in] explicitRule the iterator of the explicit rule in rules */ void RemoveImplicitRules(const RuleIterator& explicitRule); /** * Remove implicit rules that have the sender value of the remote cache. * * @param[in] cache the remote cache */ void RemoveImplicitRules(const RemoteCache& cache); /** * Returns true if the message matches the implicit rule associated with * an endpoint and a message's sender, but does not match any explicit * rule associated with the endpoint. * * If true is returned, the implicit rule in question is disassociated * from the endpoint (i.e. all of its explicit rules that were associated * with the endpoint are removed). * * @param[in] epName the name of the endpoint * @param[in] msg the Message to compare with the implicit rules * * @return true if the Message matches only the implicit rule associated with * the endpoint and the Message's sender. */ bool IsOnlyImplicitMatch(const qcc::String& epName, Message& msg); /* * Advertise or cancel the SL advertisements. * * Walks through the local queue and determines if the advertisements need to * be updated or cancelled. Updates lastAdvertisements. Called without any * locks. */ void UpdateAdvertisements(); /* * Map from last advertised name to last advertised change ID. */ std::map lastAdvertisements; /* * Helper to create a segmented advertised name. */ qcc::String AdvertisedName(const qcc::String& iface, uint32_t changeId); /* * Helper to request and advertise a name. */ QStatus AdvertiseName(const qcc::String& name); /* * Helper to cancel advertisement and release a name. */ void CancelAdvertisedName(const qcc::String& name); /* * List of advertised names currently being looked for. */ std::set findingNames; /* * Find advertised names based from the sessionless match rules. */ void FindAdvertisedNames(); /* * Stop finding advertised names from the sessionless match rules. */ void CancelFindAdvertisedNames(); /* * @param[in] cache * @param[in] fromRulesId The beginning of rules ID range (inclusive) * @param[in] toRulesId The end of rules ID range (exclusive) * * @return true if the sessionless match rules include a match for the * cache. */ bool IsMatch(RemoteCache& cache, uint32_t fromRulesId, uint32_t toRulesId); typedef enum { NONE = 0, /**< No work, we have received all signals and applied all the rules. */ APPLY_NEW_RULES = 1, /**< There are new rules that need to be applied the remote caches */ REQUEST_NEW_SIGNALS = 2 /**< There are new signals in the cache that need to be received */ } WorkType; /* * Return the pending work needing to be done for a remote cache. */ WorkType PendingWork(RemoteCache& cache); /* * Schedule work to be done for any of the remote caches we know about. */ void ScheduleWork(bool doInitialBackoff = true); /* * Schedule work to be done for a remote cache. */ QStatus ScheduleWork(RemoteCache& cache, bool addAlarm = true, bool doInitialBackoff = true); bool QueryHandler(TransportMask transport, MDNSPacket query, const qcc::IPEndpoint& src, const qcc::IPEndpoint& dst); bool SendResponseIfMatch(TransportMask transport, const qcc::IPEndpoint& src, const qcc::IPEndpoint& dst, const qcc::String& ruleStr); bool ResponseHandler(TransportMask transport, MDNSPacket response, uint16_t recvPort); void FoundAdvertisedNameHandler(const char* name, TransportMask transport, const char* prefix, bool doInitialBackoff = true); QStatus FindAdvertisementByTransport(const char* matching, TransportMask transports); QStatus CancelFindAdvertisementByTransport(const char* matching, TransportMask transports); void HandleRangeMatchRequest(const char* sender, SessionId sid, uint32_t fromChangeId, uint32_t toChangeId, std::vector& matchRules); /* * Base class of work to execute on worker (AlarmTriggered) thread. */ class Work { public: SessionlessObj& slObj; Work(SessionlessObj& slObj) : slObj(slObj) { } virtual ~Work() { } virtual void Run() = 0; private: virtual void operator=(const Work&) { } }; class SendResponseWork : public Work { public: TransportMask transport; qcc::String name; qcc::IPEndpoint src; qcc::IPEndpoint dst; SendResponseWork(SessionlessObj& slObj, TransportMask transport, const qcc::String& name, const qcc::IPEndpoint& src, const qcc::IPEndpoint& dst); virtual void Run(); }; class AddRuleWork : public Work { public: qcc::String epName; Rule rule; AddRuleWork(SessionlessObj& slObj, const qcc::String& epName, Rule& rule); virtual void Run(); }; class RemoveRuleWork : public Work { public: qcc::String epName; Rule rule; RemoveRuleWork(SessionlessObj& slObj, const qcc::String& epName, Rule& rule); virtual void Run(); }; class PushMessageWork : public Work { public: Message msg; PushMessageWork(SessionlessObj& slObj, Message& msg); virtual void Run(); }; class CancelMessageWork : public Work { public: Message msg; CancelMessageWork(SessionlessObj& slObj, Message& msg); virtual void Run(); }; class NameOwnerChangedWork : public Work { public: qcc::String name; qcc::String oldOwner; NameOwnerChangedWork(SessionlessObj& slObj, const qcc::String& name, const qcc::String& oldOwner); virtual void Run(); }; /* * Schedule work to execute on worker (AlarmTriggered) thread. * * @param[in] work the work to execute. It must be new'd by the caller and * will be deleted after execution. */ void ScheduleWork(Work* work); }; } #endif alljoyn-15.04b/alljoyn_core/router/TCPTransport.cc000066400000000000000000006274341255700255500222350ustar00rootroot00000000000000/** * @file * TCPTransport is an implementation of TCPTransportBase for daemons. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #include #include #include #include #include #include "BusInternal.h" #include "BusController.h" #include "ConfigDB.h" #include "RemoteEndpoint.h" #include "Router.h" #include "DaemonRouter.h" #include "ns/IpNameService.h" #include "TCPTransport.h" /* * How the transport fits into the system * ====================================== * * AllJoyn provides the concept of a Transport which provides a relatively * abstract way for the daemon to use different network mechanisms for getting * Messages from place to another. Conceptually, think of, for example, a Unix * transport that moves bits using unix domain sockets and a TCP transport that * moves Messages over a TCP connection. * * In networking 101, one discovers that BSD sockets is oriented toward clients * and servers. There are different sockets calls required for a program * implementing a server-side part and a client side part. The server-side * listens for incoming connection requests and the client-side initiates the * requests. AllJoyn clients are bus attachments that our Applications may use * and these can only initiate connection requests to AllJoyn daemons. Although * dameons may at first blush appear as the service side of a typical BSD * sockets client-server pair, it turns out that while daemons obviously must * listen for incoming connections, they also must be able to initiate * connection requests to other daemons. It turns out that there is very little * in the way of common code when comparing the client version of a TCP * transport and a daemon version. Therefore you will find a TCPTransport * class in here the dameon directory and a client version, called simply * TCPTransport, in the src directory. * * This file is the TCPTransport. It needs to act as both a client and a * server explains the presence of both connect-like methods and listen-like * methods here. * * A fundamental idiom in the AllJoyn system is that of a thread. Active * objects in the system that have threads wandering through them will implement * Start(), Stop() and Join() methods. These methods work together to manage * the autonomous activities that can happen in a TCPTransport. These * activities are carried out by so-called hardware threads. POSIX defines * functions used to control hardware threads, which it calls pthreads. Many * threading packages use similar constructs. * * In a threading package, a start method asks the underlying system to arrange * for the start of thread execution. Threads are not necessarily running when * the start method returns, but they are being *started*. Some time later, a * thread of execution appears in a thread run function, at which point the * thread is considered *running*. In the case of the TCPTransport, the Start() method * spins up a thread to run the BSD sockets' server accept loop. This * also means that as soon as Start() is executed, a thread may be using underlying * socket file descriptors and one must be very careful about convincing the * accept loop thread to exit before deleting the resources. * * In generic threads packages, executing a stop method asks the underlying * system to arrange for a thread to end its execution. The system typically * sends a message to the thread to ask it to stop doing what it is doing. The * thread is running until it responds to the stop message, at which time the * run method exits and the thread is considered *stopping*. The * TCPTransport provides a Stop() method to do exactly that. * * Note that neither of Start() nor Stop() are synchronous in the sense that one * has actually accomplished the desired effect upon the return from a call. Of * particular interest is the fact that after a call to Stop(), threads will * still be *running* for some non-deterministic time. * * In order to wait until all of the threads have actually stopped, a blocking * call is required. In threading packages this is typically called join, and * our corresponding method is called Join(). A user of the DaemonTcpTransport * must assume that immediately after a call to Start() is begun, and until a * call to Join() returns, there may be threads of execution wandering anywhere * in the DaemonTcpTransport and in any callback registered by the caller. * * The high-level process for how an advertisement translates into a transport * Connect() is a bit opaque, so we paint a high-level picture here. * * First, a service (that will be handling RPC calls and emitting signals) * acquires a name on the bus, binds a session and calls AdvertiseName. This * filters down (possibly through language bindings) to the AllJoyn object, into * the transports on the transport list (the TCP transport is one of those) and * eventually to the IpNameService::AdvertiseName() method we call since we are * an IP-based transport. The IP name service will multicast the advertisements * to other daemons listening on our device's connected networks. * * A client that is interested in using the service calls the discovery * method FindAdvertisedName. This filters down (possibly through * language bindings) to the AllJoyn object, into the transports on the * transport list (us) and we eventually call IpNameService::FindAdvertisedName() * since we are an IP-based transport. The IP name service multicasts the * discovery message to other daemons listening on our networks. * * The daemon remembers which clients have expressed interest in which services, * and expects name services to call back with the bus addresses of daemons they * find which have the associated services. In version zero of the protocol, * the only endpoint type supported was a TCP endpoint. In the case of version * one, we have four, so we now see "different" bus addresses coming from the * name service and "different" connect specs coming from AllJoyn proper. * * When a new advertisement is received (because we called our listener's * Found() method here, the bus address is "hidden" from interested clients and * replaced with a more generic TransportMask bit (for us it will be * TRANSPORT_TCP). The client either responds by ignoring the advertisement, * waits to accumulate more answers or joins a session to the implied * daemon/service. A reference to a SessionOpts object is provided as a * parameter to a JoinSession call if the client wants to connect. This * SessionOpts reference is passed down into the transport (selected by the * TransportMask) into the Connect() method which is used to establish the * connection. * * The four different connection mechanisms can be viewed as a matrix; * * IPv4 IPv6 * --------------- --------------- * TRAFFIC MESSAGES | TRAFFIC_RAW_RELIABLE | Reliable IPv4 Reliable IPv6 * TRAFFIC_RAW_UNRELIABLE | Unreliable IPv4 Unreliable IPv6 * * The bits in the provided SessionOpts select the row, but the column is left * free (unspecified). This means that it is up to the transport to figure out * which one to use. Clearly, if only one of the two address flavors is * possible (known from examining the returned bus address which is called a * connect spec in the Connect() method) the transport should choose that one. * If both IPv4 or IPv6 are available, it is up to the transport (again, us) to * choose the "best" method since we don't bother clients with that level of * detail. We (TCP) generally choose IPv6 when given the choice since DHCP on * IPv4 is sometimes problematic in some networks. * * Internals * ========= * * We spend a lot of time on the threading aspects of the transport since they * are often the hardest part to get right and are complicated. This is where * the bugs live. * * As mentioned above, the AllJoyn system uses the concept of a Transport. You * are looking at the TCPTransport. Each transport also has the concept * of an Endpoint. The most important function fo an endpoint is to provide * non-blocking semantics to higher level code. This is provided by a transmit * thread on the write side which can block without blocking the higher level * code, and a receive thread which can similarly block waiting for data without * blocking the higher level code. * * Endpoints are specialized into the LocalEndpoint and the RemoteEndpoint * classes. LocalEndpoint represents a connection from a router to the local * bus attachment or daemon (within the "current" process). A RemoteEndpoint * represents a connection from a router to a remote attachment or daemon. By * definition, the TCPTransport provides RemoteEndpoint functionality. * * RemoteEndpoints are further specialized according to the flavor of the * corresponding transport, and so you will see a TCPEndpoint class * defined below which provides functionality to send messages from the local * router to a destination off of the local process using a TCP transport * mechanism. * * RemoteEndpoints use AllJoyn stream objects to actually move bits. This * is a thin layer on top of a Socket (which is another thin layer on top of * a BSD socket) that provides PushBytes() adn PullBytes() methods. Remote * endpoints read and write data by through a callback mechanism implemented * using IODispatch. * * The ReadCallback is made when there is data available to read from the socket. * The job of the ReadCallback is to read bytes that appear on the * input side of the stream and to unmarshal them into AllJoyn Messages. Once * an endpoint has a message, it calls into the Message router (PushMessage) to * arrange for delivery. The WriteCallback is made when the socket is ready to * accept data and is enabled when there are messages in the endpoint's transmit * queue. The WriteCallback will pull messages off the endpoint's transmit queue, * marshal it, and then it will write the bytes to the transport mechanism. * * The TCPEndpoint inherits the infrastructure requred to do most of its * work from the more generic RemoteEndpoint class. It needs to do specific * TCP-related work and also provide for authenticating the endpoint before it * is allowed to start pumping messages. Authentication means running some * mysterious (to us) process that may involve some unknown number of challenge * and response messsages being exchanged between the client and server side of * the connection. Since we cannot block a caller waiting for authentication, * this must done on another thread; and this must be done before the * RemoteEndpoint is Start()ed and registered with IODispatch -- * before its Read and Write callbacks are * set up to occur, lest they start pumping messages and interfering with the * authentication process. * * Authentication can, of course, succeed or fail based on timely interaction * between the two sides, but it can also be abused in a denial of service * attack. If a client simply starts the process but never responds, it could * tie up a daemon's resources, and coordinated action could bring down a * daemon. Because of this, we need to provide a way to reach in and abort * authentications that are "taking too long." * * As described above, a daemon can listen for inbound connections and it can * initiate connections to remote daemons. Authentication must happen in both * cases. * * If you consider all that is happening, we are talking about a complicated * system of many threads that are appearing and disappearing in the system at * unpredictable times. These threads have dependencies in the resources * associated with them (sockets and events in particular). These resources may * have further dependencies that must be respected. For example, Events may * have references to Sockets. The Sockets must not be released before the * Events are released, because the events would be left with stale handles. An * even scarier case is if an underlying Socket FD is reused at just the wrong * time, it would be possible to switch a Socket FD from one connection to * another out from under an Event without its knowledge. * * To summarize, consider the following "big picture' view of the transport. A * single TCPTransport is constructed if the daemon TransportList indicates that * TCP support is required. The high-level daemon code (see bbdaemon.cc for * example) builds a TransportFactoryContainer that is initialized with a * factory that knows how to make TCPTransport objects if they are needed, and * associates the factory with the string "tcp". The daemon also constructs * "server args" which may contain the string "tcp" or "unix". If the factory * container provides a "tcp" factory and the server args specify a "tcp" * transport is needed then a TCPTransport object is instantiated and entered * into the daemon's internal transport list (list of available transports). * Also provided for each transport is an abstract address to listen for * incoming connection requests on. * * When the daemon is brought up, its TransportList is Start()ed. The transport * specs string (e.g., "unix:abstract=alljoyn;tcp:") is provided to * TransportList::Start() as a parameter. The transport specs string is parsed * and in the example above, results in "unix" transports and "tcp" transports * being instantiated and started. As mentioned previously "tcp" in the daemon * translates into TCPTransport. Once the desired transports are instantiated, * each is Start()ed in turn. In the case of the TCPTransport, this will start * the server accept loop. Initially there are no sockets to listen on. * * The daemon then needs to start listening on some inbound addresses and ports. * This is done by the StartListen() command which you can find in bbdaemon, for * example. This alwo takes the same king of server args string shown above but * this time the address and port information are used. For example, one might * use the string "tcp:addr=0.0.0.0,port=9955;" to specify which address and * port to listen to. This Bus::StartListen() call is translated into a * TCPTransport::StartListen() call which is provided with the string * which we call a "listen spec". Our StartListen() will create a Socket, bind * the socket to the address and port provided and save the new socket on a list * of "listenFds." It will then Alert() the already running server accept loop * thread -- see TCPTransport::Run(). Each time through the server accept * loop, Run() will examine the list of listenFds and will associate an Event * with the corresponding socketFd and wait for connection requests. * * There is a complementary call to stop listening on addresses. Since the * server accept loop is depending on the associated sockets, StopListen must * not close those Sockets, it must ask the server accept loop to do so in a * coordinated way. * * When an inbound connection request is received, the accept loop will wake up * and create a TCPEndpoint for the *proposed* new connection. Recall * that an endpoint is not brought up immediately, but an authentication step * must be performed. The server accept loop starts this process by placing the * new TCPEndpoint on an authList, or list of authenticating endpoints. * It then calls the endpoint Authenticate() method which spins up an * authentication thread and returns immediately. This process transfers the * responsibility for the connection and its resources to the authentication * thread. Authentication can succeed, fail, or take to long and be aborted. * * If authentication succeeds, the authentication thread calls back into the * TCPTransport's Authenticated() method. Along with indicating that * authentication has completed successfully, this transfers ownership of the * TCPEndpoint back to the TCPTransport from the authentication * thread. At this time, the TCPEndpoint is Start()ed which spins up * the transmit and receive threads and enables Message routing across the * transport. * * If the authentication fails, the authentication thread simply sets a the * TCPEndpoint state to FAILED and exits. The server accept loop looks at * authenticating endpoints (those on the authList)each time through its loop. * If an endpoint has failed authentication, and its thread has actually gone * away (or more precisely is at least going away in such a way that it will * never touch the endpoint data structure again). This means that the endpoint * can be deleted. * * If the authentication takes "too long" we assume that a denial of service * attack in in progress. We call AuthStop() on such an endpoint which will most * likely induce a failure (unless we happen to call abort just as the endpoint * actually finishes the authentication which is highly unlikely but okay). * This AuthStop() will cause the endpoint to be scavenged using the above mechanism * the next time through the accept loop. * * A daemon transport can accept incoming connections, and it can make outgoing * connections to another daemon. This case is simpler than the accept case * since it is expected that a socket connect can block, so it is possible to do * authentication in the context of the thread calling Connect(). Connect() is * provided a so-called "connect spec" which provides an IP address ("addr=xxxx"), * port ("port=yyyy") in a String. * * A check is always made to catch an attempt for the daemon to connect to * itself which is a system-defined error (it causes the daemon grief, so we * avoid it here by looking to see if one of the listenFds is listening on an * interface that corresponds to the address in the connect spec). * * If the connect is allowed, we do the usual BSD sockets thing where we create * a socket and connect to the specified remote address. The DBus spec says that * all connections must begin with one uninterpreted byte so we send that. This * byte is only meaningful in Unix domain sockets transports, but we must send it * anyway. * * The next step is to create a TCPEndpoint and to put it on the endpointList. * Note that the endpoint doesn't go on the authList as in the server case, it * goes on the list of active endpoints. This is because a failure to authenticate * on the client side results in a call to EndpointExit which is the same code path as * a failure when the endpoint is up. The failing endpoint must be on the endpoint * list in order to allow authentication errors to be propagated back to higher-level * code in a meaningful context. Once the endpoint is stored on the list, Connect() * starts client-side Authentication with the remote (server) side. If Authentication * succeeds, the endpoint is Start()ed which will register the endpoint with IODispatch * that enables callbacks to be made to start Message routing across the link. * The endpoint is left on the endpoint list in this case. * If authentication fails, the endpoint is removed from the active * list. This is thread-safe since there is no authentication thread running because * the authentication was done in the context of the thread calling Connect() which * is the one deleting the endpoint; and the endpoint is not registered with IODispatch * if the authentication fails. * * Shutting the TCPTransport down involves orchestrating the orderly termination * of: * * 1) Threads that may be running in the server accept loop with associated Events * and their dependent socketFds stored in the listenFds list. * 2) Threads that may be running authentication with associated endpoint objects, * streams and SocketFds. These threads are accessible through endpoint objects * stored on the authList. * 3) Unregistering the endpoint from IODispatch that stops any future read/write callbacks * from occuring and schedules a ExitCallback that can be used for clean up. * * Note that we also have to understand and deal with the fact that threads * running in state (2) above, will exit and depend on the server accept loop to * scavenge the associated objects off of the authList and delete them. This * means that the server accept loop cannot be Stop()ped until the authList is * empty. We further have to understand that read/write callbacks running in state (3) above * will depend on the hooked EndpointExit function to dispose of associated * resources. This will happen in the context of either the IODispatch callbacks (the last to go). * We can't delete the transport until all of its * associated endpoint threads/callbacks are Join()ed. Also, since the server accept loop * is looking at the list of listenFDs, we must be careful about deleting those * sockets out from under the server thread. The system should call * StopListen() on all of the listen specs it called StartListen() on; but we * need to be prepared to clean up any "unstopped" listen specs in a coordinated * way. This, in turn, means that the server accept loop cannot be Stop()ped * until all of the listenFds are cleaned up. * * There are a lot of dependencies here, so be careful when making changes to * the thread and resource management here. It's quite easy to shoot yourself * in multiple feet you never knew you had if you make an unwise modification, * and sometimes the results are tiny little time-bombs set to go off in * completely unrelated code (if, for example, a socket is deleted and reused * by another piece of code while the transport still has an event referencing * the socket now used by the other module). */ #define QCC_MODULE "TCP" using namespace std; using namespace qcc; const uint32_t TCP_LINK_TIMEOUT_PROBE_ATTEMPTS = 1; const uint32_t TCP_LINK_TIMEOUT_PROBE_RESPONSE_DELAY = 10; const uint32_t TCP_LINK_TIMEOUT_MIN_LINK_TIMEOUT = 40; namespace ajn { /** * Name of transport used in transport specs. */ const char* TCPTransport::TransportName = "tcp"; /** * Default router advertisement prefix. */ const char* const TCPTransport::ALLJOYN_DEFAULT_ROUTER_ADVERTISEMENT_PREFIX = "org.alljoyn.BusNode."; /* * An endpoint class to handle the details of authenticating a connection in a * way that avoids denial of service attacks. */ class _TCPEndpoint : public _RemoteEndpoint { public: friend class TCPTransport; /** * There are three threads that can be running around in this data * structure. An auth thread is run before the endpoint is started in order * to handle the security stuff that must be taken care of before messages * can start passing. This enum reflects the states of the authentication * process and the state can be found in m_authState. Once authentication * is complete, the auth thread must go away, but it must also be joined, * which is indicated by the AUTH_DONE state. The state of Read and Write * callbacks is dealt with by the EndpointState. */ enum AuthState { AUTH_ILLEGAL = 0, AUTH_INITIALIZED, /**< This endpoint structure has been allocated but no auth thread has been run */ AUTH_AUTHENTICATING, /**< We have spun up an authentication thread and it has begun running our user function */ AUTH_FAILED, /**< The authentication has failed and the authentication thread is exiting immidiately */ AUTH_SUCCEEDED, /**< The auth process (Establish) has succeeded and the connection is ready to be started */ AUTH_DONE, /**< The auth thread has been successfully shut down and joined */ }; /** * There is one dedicated thread and two types callbacks that can be running * around in this data structure. * Read and Write callbacks are used to pump * messages through an endpoint. These callbacks cannot be run until the * authentication process has completed. This enum reflects the states of * the endpoint Read and WriteCallbacks and can be found in m_epState. The auth * thread is dealt with by the AuthState enum above. These callbacks must cease * to occur once the endpoint has completely exited, which is indicated by the EP_DONE state. */ enum EndpointState { EP_ILLEGAL = 0, EP_INITIALIZED, /**< This endpoint structure has been allocated but not used */ EP_FAILED, /**< Starting the Read and WriteCallbacks has failed and this endpoint is not usable */ EP_STARTING, /**< The Read and WriteCallbacks are being started */ EP_STARTED, /**< The Read and WriteCallbacks have been started (they work as a unit) */ EP_STOPPING, /**< The Read and WriteCallbacks are stopping (have run ThreadExit) but have not been joined */ EP_DONE /**< The Read and WriteCallbacks have been shut down and joined */ }; /** * Connections can either be created as a result of a Connect() or an Accept(). * If a connection happens as a result of a connect it is the active side of * a connection. If a connection happens because of an Accpet() it is the * passive side of a connection. This is important because of reference * counting of bus-to-bus endpoints. */ enum SideState { SIDE_ILLEGAL = 0, SIDE_INITIALIZED, /**< This endpoint structure has been allocated but don't know if active or passive yet */ SIDE_ACTIVE, /**< This endpoint is the active side of a connection */ SIDE_PASSIVE /**< This endpoint is the passive side of a connection */ }; _TCPEndpoint(TCPTransport* transport, BusAttachment& bus, bool incoming, const qcc::String connectSpec, qcc::SocketFd sock, const qcc::IPAddress& ipAddr, uint16_t port) : _RemoteEndpoint(bus, incoming, connectSpec, &m_stream, "tcp"), m_transport(transport), m_sideState(SIDE_INITIALIZED), m_authState(AUTH_INITIALIZED), m_epState(EP_INITIALIZED), m_tStart(qcc::Timespec(0)), m_authThread(this), m_stream(sock), m_ipAddr(ipAddr), m_port(port) { } _TCPEndpoint(TCPTransport* transport, BusAttachment& bus, bool incoming, const qcc::String connectSpec, const AddressFamily family, const SocketType type, const qcc::IPAddress& ipAddr, uint16_t port) : _RemoteEndpoint(bus, incoming, connectSpec, &m_stream, "tcp"), m_transport(transport), m_sideState(SIDE_INITIALIZED), m_authState(AUTH_INITIALIZED), m_epState(EP_INITIALIZED), m_tStart(qcc::Timespec(0)), m_authThread(this), m_stream(family, type), m_ipAddr(ipAddr), m_port(port) { } virtual ~_TCPEndpoint() { } QStatus GetLocalIp(qcc::String& ipAddrStr) { SocketFd sockFd = m_stream.GetSocketFd(); IPAddress ipaddr; uint16_t port; QStatus status = GetLocalAddress(sockFd, ipaddr, port); if (status == ER_OK) { ipAddrStr = ipaddr.ToString(); } return status; }; QStatus GetRemoteIp(qcc::String& ipAddrStr) { ipAddrStr = m_ipAddr.ToString(); return ER_OK; }; void SetStartTime(qcc::Timespec tStart) { m_tStart = tStart; } qcc::Timespec GetStartTime(void) { return m_tStart; } QStatus Authenticate(void); void AuthStop(void); void AuthJoin(void); const qcc::IPAddress& GetIPAddress() { return m_ipAddr; } uint16_t GetPort() { return m_port; } SideState GetSideState(void) { return m_sideState; } void SetActive(void) { m_sideState = SIDE_ACTIVE; } void SetPassive(void) { m_sideState = SIDE_PASSIVE; } AuthState GetAuthState(void) { return m_authState; } void SetAuthDone(void) { Timespec tNow; GetTimeNow(&tNow); SetStartTime(tNow); m_authState = AUTH_DONE; } EndpointState GetEpState(void) { return m_epState; } void SetEpFailed(void) { m_epState = EP_FAILED; } void SetEpStarting(void) { m_epState = EP_STARTING; } void SetEpStarted(void) { m_epState = EP_STARTED; } void SetEpStopping(void) { assert(m_epState == EP_STARTING || m_epState == EP_STARTED || m_epState == EP_STOPPING || m_epState == EP_FAILED); m_epState = EP_STOPPING; } void SetEpDone(void) { assert(m_epState == EP_FAILED || m_epState == EP_STOPPING); m_epState = EP_DONE; } QStatus SetLinkTimeout(uint32_t& linkTimeout) { QStatus status = ER_OK; if (linkTimeout > 0) { uint32_t to = max(linkTimeout, TCP_LINK_TIMEOUT_MIN_LINK_TIMEOUT); to -= TCP_LINK_TIMEOUT_PROBE_RESPONSE_DELAY * TCP_LINK_TIMEOUT_PROBE_ATTEMPTS; status = _RemoteEndpoint::SetLinkTimeout(to, TCP_LINK_TIMEOUT_PROBE_RESPONSE_DELAY, TCP_LINK_TIMEOUT_PROBE_ATTEMPTS); if ((status == ER_OK) && (to > 0)) { linkTimeout = to + TCP_LINK_TIMEOUT_PROBE_RESPONSE_DELAY * TCP_LINK_TIMEOUT_PROBE_ATTEMPTS; } } else { _RemoteEndpoint::SetLinkTimeout(0, 0, 0); } return status; } QStatus SetIdleTimeouts(uint32_t& reqIdleTimeout, uint32_t& reqProbeTimeout) { uint32_t maxIdleProbes = m_transport->m_numHbeatProbes; /* If reqProbeTimeout == 0, Make no change to Probe timeout. */ if (reqProbeTimeout == 0) { reqProbeTimeout = _RemoteEndpoint::GetProbeTimeout(); } else if (reqProbeTimeout > m_transport->m_maxHbeatProbeTimeout) { /* Max allowed Probe timeout is m_maxHbeatProbeTimeout */ reqProbeTimeout = m_transport->m_maxHbeatProbeTimeout; } /* If reqIdleTimeout == 0, Make no change to Idle timeout. */ if (reqIdleTimeout == 0) { reqIdleTimeout = _RemoteEndpoint::GetIdleTimeout(); } /* Requested link timeout must be >= m_minHbeatIdleTimeout */ if (reqIdleTimeout < m_transport->m_minHbeatIdleTimeout) { reqIdleTimeout = m_transport->m_minHbeatIdleTimeout; } /* Requested link timeout must be <= m_maxHbeatIdleTimeout */ if (reqIdleTimeout > m_transport->m_maxHbeatIdleTimeout) { reqIdleTimeout = m_transport->m_maxHbeatIdleTimeout; } return _RemoteEndpoint::SetIdleTimeouts(reqIdleTimeout, reqProbeTimeout, maxIdleProbes); } /* * Return true if the auth thread is STARTED, RUNNING or STOPPING. A true * response means the authentication thread is in a state that indicates * a possibility it might touch the endpoint data structure. This means * don't delete the endpoint if this method returns true. This method * indicates nothing about endpoint Read and WriteCallback state. */ bool IsAuthThreadRunning(void) { return m_authThread.IsRunning(); } virtual void ThreadExit(qcc::Thread* thread); private: class AuthThread : public qcc::Thread { public: AuthThread(_TCPEndpoint* ep) : Thread("auth"), m_endpoint(ep) { } private: virtual qcc::ThreadReturn STDCALL Run(void* arg); _TCPEndpoint* m_endpoint; }; TCPTransport* m_transport; /**< The server holding the connection */ volatile SideState m_sideState; /**< Is this an active or passive connection */ volatile AuthState m_authState; /**< The state of the endpoint authentication process */ volatile EndpointState m_epState; /**< The state of the endpoint authentication process */ qcc::Timespec m_tStart; /**< Timestamp indicating when the authentication process started */ AuthThread m_authThread; /**< Thread used to do blocking calls during startup */ qcc::SocketStream m_stream; /**< Stream used by authentication code */ qcc::IPAddress m_ipAddr; /**< Remote IP address. */ uint16_t m_port; /**< Remote port. */ }; void _TCPEndpoint::ThreadExit(qcc::Thread* thread) { /* If the auth thread exits before it even enters the AuthThread::Run() function, set the state to AUTH_FAILED. */ if (thread == &m_authThread) { if (m_authState == AUTH_INITIALIZED) { m_authState = AUTH_FAILED; } m_transport->Alert(); } _RemoteEndpoint::ThreadExit(thread); } QStatus _TCPEndpoint::Authenticate(void) { QCC_DbgTrace(("TCPEndpoint::Authenticate()")); /* * Start the authentication thread. */ QStatus status = m_authThread.Start(this, this); if (status != ER_OK) { m_authState = AUTH_FAILED; } return status; } void _TCPEndpoint::AuthStop(void) { QCC_DbgTrace(("TCPEndpoint::AuthStop()")); /* * Ask the auth thread to stop executing. The only ways out of the thread * run function will set the state to either AUTH_SUCCEEDED or AUTH_FAILED. * There is a very small chance that we will send a stop to the thread after * it has successfully authenticated, but we expect that this will result in * an AUTH_FAILED state for the vast majority of cases. In this case, we * notice that the thread failed the next time through the main server run * loop, join the thread via AuthJoin below and delete the endpoint. Note * that this is a lazy cleanup of the endpoint. */ m_authThread.Stop(); } void _TCPEndpoint::AuthJoin(void) { QCC_DbgTrace(("TCPEndpoint::AuthJoin()")); /* * Join the auth thread to stop executing. All threads must be joined in * order to communicate their return status. The auth thread is no exception. * This is done in a lazy fashion from the main server accept loop, where we * cleanup every time through the loop. */ m_authThread.Join(); } void* _TCPEndpoint::AuthThread::Run(void* arg) { QCC_UNUSED(arg); QCC_DbgTrace(("TCPEndpoint::AuthThread::Run()")); m_endpoint->m_authState = AUTH_AUTHENTICATING; /* * We're running an authentication process here and we are cooperating with * the main server thread. This thread is running in an object that is * allocated on the heap, and the server is managing these objects so we * need to coordinate getting all of this cleaned up. * * There is a state variable that only we write. The server thread only * reads this variable, so there are no data sharing issues. If there is an * authentication failure, this thread sets that state variable to * AUTH_FAILED and then exits. The server holds a list of currently * authenticating connections and will look for AUTH_FAILED connections when * it runs its Accept loop. If it finds one, it will AuthJoin() this * thread. Since we set AUTH_FAILED immediately before exiting, there will * be no problem having the server block waiting for the Join() to complete. * We fail authentication here and let the server clean up after us, lazily. * * If we succeed in the authentication process, we set the state variable * to AUTH_SUCEEDED and then call back into the server telling it that we are * up and running. It needs to take us off of the list of authenticating * connections and put us on the list of running connections. This thread * will quickly go away and will be replaced by the Read and WriteCallbacks of * the running RemoteEndpoint. * * If we are running an authentication process, we are probably ultimately * blocked on a socket. We expect that if the server is asked to shut * down, it will run through its list of authenticating connections and * AuthStop() each one. That will cause a thread Stop() which should unblock * all of the reads and return an error which will eventually pop out here * with an authentication failure. * * Finally, if the server decides we've spent too much time here and we are * actually a denial of service attack, it can close us down by doing an * AuthStop() on the authenticating endpoint. This will do a thread Stop() * on the auth thread of the endpoint which will pop out of here as an * authentication failure as well. The only ways out of this method must be * with state = AUTH_FAILED or state = AUTH_SUCCEEDED. */ uint8_t byte; size_t nbytes; /* * Eat the first byte of the stream. This is required to be zero by the * DBus protocol. It is used in the Unix socket implementation to carry * out-of-band capabilities, but is discarded here. We do this here since * it involves a read that can block. */ QStatus status = m_endpoint->m_stream.PullBytes(&byte, 1, nbytes); if ((status != ER_OK) || (nbytes != 1) || (byte != 0)) { QCC_LogError(status, ("Failed to read first byte from stream")); /* * Management of the resources used by the authentication thread is done * in one place, by the server Accept loop. The authentication thread * writes its state into the connection and the server Accept loop reads * this state. As soon as we set this state to AUTH_FAILED, we are * telling the Accept loop that we are done with the conn data * structure. That thread is then free to do anything it wants with the * connection, including deleting it, so we are not allowed to touch * conn after setting this state. * * In addition to releasing responsibility for the conn data structure, * when we set the state to AUTH_SUCCEEDED we are telling the server * accept loop that we are exiting now and so it can Join() on us (the * authentication thread) without being worried about blocking since the * next thing we do is exit. */ m_endpoint->m_authState = AUTH_FAILED; return (void*)ER_FAIL; } /* Initialize the features for this endpoint */ m_endpoint->GetFeatures().isBusToBus = false; m_endpoint->GetFeatures().isBusToBus = false; m_endpoint->GetFeatures().handlePassing = false; /* * Check any application connecting over TCP to see if it is running on the same machine and * set the group ID appropriately if so. */ TCPEndpoint tcpEp = TCPEndpoint::wrap(m_endpoint); TCPTransport::CheckEndpointLocalMachine(tcpEp); /* Run the actual connection authentication code. */ qcc::String authName; qcc::String redirection; DaemonRouter& router = reinterpret_cast(m_endpoint->m_transport->m_bus.GetInternal().GetRouter()); AuthListener* authListener = router.GetBusController()->GetAuthListener(); /* Since the TCPTransport allows untrusted clients, it must implement UntrustedClientStart and * UntrustedClientExit. * As a part of Establish, the endpoint can call the Transport's UntrustedClientStart method if * it is an untrusted client, so the transport MUST call m_endpoint->SetListener before calling Establish * Note: This is only required on the accepting end i.e. for incoming endpoints. * Thin Client 14.06 or higher uses ANONYMOUS to connect to routing nodes. */ m_endpoint->SetListener(m_endpoint->m_transport); status = m_endpoint->Establish("ANONYMOUS", authName, redirection, authListener); if (status != ER_OK) { QCC_LogError(status, ("Failed to establish TCP endpoint")); /* * Management of the resources used by the authentication thread is done * in one place, by the server Accept loop. The authentication thread * writes its state into the connection and the server Accept loop reads * this state. As soon as we set this state to AUTH_FAILED, we are * telling the Accept loop that we are done with the conn data * structure. That thread is then free to do anything it wants with the * connection, including deleting it, so we are not allowed to touch * conn after setting this state. * * In addition to releasing responsibility for the conn data structure, * when we set the state to AUTH_SUCCEEDED we are telling the server * accept loop that we are exiting now and so it can Join() on us (the * authentication thread) without being worried about blocking since the * next thing we do is exit. */ m_endpoint->m_authState = AUTH_FAILED; return (void*)status; } /* * Tell the transport that the authentication has succeeded and that it can * now bring the connection up. */ m_endpoint->m_transport->Authenticated(tcpEp); QCC_DbgTrace(("TCPEndpoint::AuthThread::Run(): Returning")); /* * We are now done with the authentication process. We have succeeded doing * the authentication and we may or may not have succeeded in starting the * endpoint TX and RX threads depending on what happened down in * Authenticated(). What concerns us here is that we are done with this * thread (the authentication thread) and we are about to exit. Before * exiting, we must tell server accept loop that we are done with this data * structure. As soon as we set this state to AUTH_SUCCEEDED that thread is * then free to do anything it wants with the connection, including deleting * it, so we are not allowed to touch conn after setting this state. * * In addition to releasing responsibility for the conn data structure, when * we set the state to AUTH_SUCCEEDED we are telling the server accept loop * that we are exiting now and so it can Join() the authentication thread * without being worried about blocking since the next thing we do is exit. */ m_endpoint->m_authState = AUTH_SUCCEEDED; return (void*)status; } TCPTransport::TCPTransport(BusAttachment& bus) : Thread("TCPTransport"), m_bus(bus), m_stopping(false), m_routerNameAdvertised(false), m_listener(0), m_foundCallback(m_listener), m_networkEventCallback(*this), m_isAdvertising(false), m_isDiscovering(false), m_isListening(false), m_isNsEnabled(false), m_reload(STATE_RELOADING), m_nsReleaseCount(0), m_wildcardIfaceProcessed(false), m_maxRemoteClientsTcp(0), m_numUntrustedClients(0), m_dynamicScoreUpdater(*this) { QCC_DbgTrace(("TCPTransport::TCPTransport()")); /* * We know we are daemon code, so we'd better be running with a daemon * router. This is assumed elsewhere. */ assert(m_bus.GetInternal().GetRouter().IsDaemon()); } TCPTransport::~TCPTransport() { QCC_DbgTrace(("TCPTransport::~TCPTransport()")); Stop(); Join(); } void TCPTransport::Authenticated(TCPEndpoint& conn) { QCC_DbgTrace(("TCPTransport::Authenticated()")); /* * If the transport is stopping, dont set up the Read and WriteCallback * mechanism for endpoints. */ if (m_stopping == true) { return; } /* * If Authenticated() is being called, it is as a result of the * authentication thread telling us that it has succeeded. What we need to * do here is to try and Start() the endpoint which will set up * Read and WriteCallbacks and register the endpoint with the daemon router. * As soon as we call Start(), we are transferring responsibility for error reporting * through endpoint ThreadExit() function. This will percolate out our * EndpointExit function. It will expect to find on the endpoint * list so we move it from the authList to the endpointList before calling * Start. */ m_endpointListLock.Lock(MUTEX_CONTEXT); set::iterator i = find(m_authList.begin(), m_authList.end(), conn); assert(i != m_authList.end() && "TCPTransport::Authenticated(): Conn not on m_authList"); /* * Note here that we have not yet marked the authState as AUTH_SUCCEEDED so * this is a point in time where the authState can be AUTH_AUTHENTICATING * and the endpoint can be on the endpointList and not the authList. */ m_authList.erase(i); m_endpointList.insert(conn); m_endpointListLock.Unlock(MUTEX_CONTEXT); conn->SetListener(this); conn->SetEpStarting(); QStatus status = conn->Start(m_defaultHbeatIdleTimeout, m_defaultHbeatProbeTimeout, m_numHbeatProbes, m_maxHbeatProbeTimeout); if (status != ER_OK) { QCC_LogError(status, ("TCPTransport::Authenticated(): Failed to start TCP endpoint")); /* * We were unable to start up the endpoint for some reason. As soon as * we set this state to EP_FAILED, we are telling the server accept loop * that we tried to start the connection but it failed. This connection * is now useless and is a candidate for cleanup. This will be * prevented until authState changes from AUTH_AUTHENTICATING to * AUTH_SUCCEEDED. This may be a little confusing, but the * authentication process has really succeeded but the endpoint start * has failed. The combination of status in this case will be * AUTH_SUCCEEDED and EP_FAILED. Once this state is detected by the * server accept loop it is then free to do anything it wants with the * connection, including deleting it. */ conn->SetEpFailed(); } else { /* * We were able to successfully start up the endpoint. As soon as we * set this state to EP_STARTED, we are telling the server accept loop * that there are Read and WriteCallbacks wandering around in this endpoint. */ conn->SetEpStarted(); } m_dynamicScoreUpdater.Alert(); } QStatus TCPTransport::Start() { /* * We rely on the status of the server accept thread as the primary * gatekeeper. * * A true response from IsRunning tells us that the server accept thread is * STARTED, RUNNING or STOPPING. * * When a thread is created it is in state INITIAL. When an actual tread is * spun up as a result of Start(), it becomes STARTED. Just before the * user's Run method is called, the thread becomes RUNNING. If the Run * method exits, the thread becomes STOPPING. When the thread is Join()ed * it becomes DEAD. * * IsRunning means that someone has called Thread::Start() and the process * has progressed enough that the thread has begun to execute. If we get * multiple Start() calls calls on multiple threads, this test may fail to * detect multiple starts in a failsafe way and we may end up with multiple * server accept threads running. We assume that since Start() requests * come in from our containing transport list it will not allow concurrent * start requests. */ if (IsRunning()) { QCC_LogError(ER_BUS_BUS_ALREADY_STARTED, ("TCPTransport::Start(): Already started")); return ER_BUS_BUS_ALREADY_STARTED; } m_stopping = false; /* * Get the guid from the bus attachment which will act as the globally unique * ID of the daemon. */ qcc::String guidStr = m_bus.GetInternal().GetGlobalGUID().ToString(); /* * We're a TCP transport, and TCP is an IP protocol, so we want to use the IP * name service for our advertisement and discovery work. When we acquire * the name service, we are basically bumping a reference count and starting * it if required. * * Start() will legally be called exactly once, but Stop() and Join() may be called * multiple times. Since we are essentially reference counting the name service * singleton, we can only call Release() on it once. So we have a release count * variable that allows us to only release the singleton on the first transport * Join() */ m_nsReleaseCount = 0; IpNameService::Instance().Acquire(guidStr); /* * Tell the name service to call us back on our FoundCallback method when * we hear about a new well-known bus name. */ IpNameService::Instance().SetCallback(TRANSPORT_TCP, new CallbackImpl&, uint32_t> (&m_foundCallback, &FoundCallback::Found)); /* * Tell the name service to call us back on our NetworkEventCallback when it * detects that an interface has become IFF_UP or its IP address has changed. */ IpNameService::Instance().SetNetworkEventCallback(TRANSPORT_TCP, new CallbackImpl&> (&m_networkEventCallback, &NetworkEventCallback::Handler)); ConfigDB* config = ConfigDB::GetConfigDB(); uint32_t maxConn = config->GetLimit("max_completed_connections", ALLJOYN_MAX_COMPLETED_CONNECTIONS_TCP_DEFAULT); uint32_t maxRemoteClients = config->GetLimit("max_remote_clients_tcp", ALLJOYN_MAX_REMOTE_CLIENTS_TCP_DEFAULT); uint32_t maxUntrustedClients = config->GetLimit("max_untrusted_clients"); if (maxUntrustedClients) { QCC_LogError(ER_WARNING, ("TCPTransport::Start(): The config option \"max_untrusted_clients\" has been deprecated.")); m_maxRemoteClientsTcp = maxUntrustedClients; } else { m_maxRemoteClientsTcp = maxRemoteClients; } m_maxRemoteClientsTcp = std::min(m_maxRemoteClientsTcp, (int32_t) maxConn); uint32_t availConn = maxConn - (m_authList.size() + m_endpointList.size()); uint32_t availRemoteClientsTcp = m_maxRemoteClientsTcp - m_numUntrustedClients; availRemoteClientsTcp = std::min(availRemoteClientsTcp, availConn); IpNameService::Instance().UpdateDynamicScore(TRANSPORT_TCP, availConn, maxConn, availRemoteClientsTcp, m_maxRemoteClientsTcp); m_dynamicScoreUpdater.Start(); /* * Start the server accept loop through the thread base class. This will * close or open the IsRunning() gate we use to control access to our * public API. */ return Thread::Start(); } QStatus TCPTransport::Stop(void) { QCC_DbgTrace(("TCPTransport::Stop()")); /* * It is legal to call Stop() more than once, so it must be possible to * call Stop() on a stopped transport. */ m_stopping = true; /* * Tell the name service to disregard all our prior advertisements and * discoveries. The internal state will shortly be discarded as well. */ m_listenRequestsLock.Lock(MUTEX_CONTEXT); QCC_DbgTrace(("TCPTransport::Stop(): Gratuitously clean out advertisements.")); for (list::iterator i = m_advertising.begin(); i != m_advertising.end(); ++i) { IpNameService::Instance().CancelAdvertiseName(TRANSPORT_TCP, *i, TRANSPORT_TCP); } m_advertising.clear(); m_routerNameAdvertised = false; m_isAdvertising = false; QCC_DbgTrace(("TCPTransport::Stop(): Gratuitously clean out discoveries.")); for (list::iterator i = m_discovering.begin(); i != m_discovering.end(); ++i) { IpNameService::Instance().CancelFindAdvertisement(TRANSPORT_TCP, *i, TRANSPORT_TCP); } m_discovering.clear(); m_isDiscovering = false; m_listenRequestsLock.Unlock(MUTEX_CONTEXT); /* * Tell the name service to stop calling us back if it's there (we may get * called more than once in the chain of destruction) so the pointer is not * required to be non-NULL. */ IpNameService::Instance().SetCallback(TRANSPORT_TCP, NULL); IpNameService::Instance().SetNetworkEventCallback(TRANSPORT_TCP, NULL); IpNameService::Instance().UpdateDynamicScore(TRANSPORT_TCP, 0, 0, 0, 0); /* * Tell the server accept loop thread to shut down through the thread * base class. */ QStatus status = Thread::Stop(); if (status != ER_OK) { QCC_LogError(status, ("TCPTransport::Stop(): Failed to Stop() server thread")); return status; } m_endpointListLock.Lock(MUTEX_CONTEXT); /* * Ask any authenticating ACTIVE endpoints to shut down and return to the * caller. By its presence on the m_activeEndpointsThreadList, we know that * an external (from the point of this module) thread is authenticating and * is probably blocked waiting for the other side to respond. We can't call * Stop() to stop that thread from running, we have to Alert() it to make it * pop out of its blocking calls. */ for (set::iterator i = m_activeEndpointsThreadList.begin(); i != m_activeEndpointsThreadList.end(); ++i) { (*i)->Alert(); } /* * Ask any authenticating endpoints to shut down and exit their threads. By its * presence on the m_authList, we know that the endpoint is authenticating and * the authentication thread has responsibility for dealing with the endpoint * data structure. We call Stop() to stop that thread from running. The * endpoint Read and WriteCallbacks will not be running yet. */ for (set::iterator i = m_authList.begin(); i != m_authList.end(); ++i) { TCPEndpoint ep = *i; ep->AuthStop(); } /* * Ask any running endpoints to shut down and exit their threads. By its * presence on the m_endpointList, we know that authentication is compete and * the Read and WriteCallbacks have responsibility for dealing with the endpoint * data structure. We call Stop() to stop those threads from running. Since * the connnection is on the m_endpointList, we know that the authentication * thread has handed off responsibility. */ for (set::iterator i = m_endpointList.begin(); i != m_endpointList.end(); ++i) { TCPEndpoint ep = *i; ep->Stop(); } m_endpointListLock.Unlock(MUTEX_CONTEXT); m_dynamicScoreUpdater.Stop(); return ER_OK; } QStatus TCPTransport::Join(void) { QCC_DbgTrace(("TCPTransport::Join()")); /* * It is legal to call Join() more than once, so it must be possible to * call Join() on a joined transport and also on a joined name service. */ QStatus status = Thread::Join(); if (status != ER_OK) { return status; } /* * Tell the IP name service instance that we will no longer be making calls * and it may shut down if we were the last transport. This release can * be thought of as a reference counted Stop()/Join() so it is appropriate * to make it here since we are expecting the possibility of blocking. * * Since it is reference counted, we can't just call it willy-nilly. We * have to be careful since our Join() can be called multiple times. */ int count = qcc::IncrementAndFetch(&m_nsReleaseCount); if (count == 1) { IpNameService::Instance().Release(); } /* * A required call to Stop() that needs to happen before this Join will ask * all of the endpoints to stop; and will also cause any authenticating * endpoints to stop. We still need to wait here until all of the threads * running in those endpoints actually stop running. * * Since Stop() is a request to stop, and this is what has ultimately been * done to both authentication threads and Read and WriteCallbacks, it is possible * that a thread is actually running after the call to Stop(). If that * thread happens to be an authenticating endpoint, it is possible that an * authentication actually completes after Stop() is called. This will move * a connection from the m_authList to the m_endpointList, so we need to * make sure we wait for all of the connections on the m_authList to go away * before we look for the connections on the m_endpointlist. */ m_endpointListLock.Lock(MUTEX_CONTEXT); /* * Any authenticating endpoints have been asked to shut down and exit their * authentication threads in a previously required Stop(). We need to * Join() all of these auth threads here. */ set::iterator it = m_authList.begin(); while (it != m_authList.end()) { TCPEndpoint ep = *it; m_authList.erase(it); m_endpointListLock.Unlock(MUTEX_CONTEXT); ep->AuthJoin(); m_endpointListLock.Lock(MUTEX_CONTEXT); it = m_authList.upper_bound(ep); } /* * Any running endpoints have been asked it their threads in a previously * required Stop(). We need to Join() all of thesse threads here. This * Join() will wait on the endpoint Read and WriteCallbacks to exit as opposed to * the joining of the auth thread we did above. */ it = m_endpointList.begin(); while (it != m_endpointList.end()) { TCPEndpoint ep = *it; m_endpointList.erase(it); m_endpointListLock.Unlock(MUTEX_CONTEXT); ep->Join(); m_endpointListLock.Lock(MUTEX_CONTEXT); it = m_endpointList.upper_bound(ep); } m_endpointListLock.Unlock(MUTEX_CONTEXT); m_dynamicScoreUpdater.Join(); m_stopping = false; return ER_OK; } /** * This is a convenience function that tells a caller whether or not this * transport will support a set of options for a connection. Lets the caller * decide up front whether or not a connection will succeed due to options * conflicts. */ bool TCPTransport::SupportsOptions(const SessionOpts& opts) const { QCC_DbgTrace(("TCPTransport::SupportsOptions()")); bool rc = true; /* * TCP only suports reliable messaging, which means TRAFFIC_RAW_RELIABLE * (raw sockets over a reliable underlying transport) or TRAFFIC_MESSAGES * (which is AllJoyn Messages over a reliable underlying transport). It's * not an error if we don't match, we just don't have anything to offer. */ if (opts.traffic != SessionOpts::TRAFFIC_MESSAGES && opts.traffic != SessionOpts::TRAFFIC_RAW_RELIABLE) { QCC_DbgPrintf(("TCPTransport::SupportsOptions(): traffic type mismatch")); rc = false; } /* * The other session option that we need to filter on is the transport * bitfield. This transport supports TRANSPORT_TCP of course, but we allow * TRANSPORT_WLAN, TRANSPORT_WWAN, and TRANSPORT_LAN to be synonymous with * TRANSPORT_TCP. If you are explicitly looking for something other than * TCP (or one of the aliases) we can't help you. */ if (!(opts.transports & TRANSPORT_TCP)) { QCC_DbgPrintf(("TCPTransport::SupportsOptions(): transport mismatch")); rc = false; } QCC_DbgPrintf(("TCPTransport::SupportsOptions(): returns \"%s\"", rc == true ? "true" : "false")); return rc; } /* * The default interface for the name service to use. The wildcard character * means to listen and transmit over all interfaces that are up and multicast * capable, with any IP address they happen to have. This default also applies * to the search for listen address interfaces. */ static const char* INTERFACES_DEFAULT = "*"; QStatus TCPTransport::GetListenAddresses(const SessionOpts& opts, std::vector& busAddrs) const { QCC_DbgTrace(("TCPTransport::GetListenAddresses()")); /* * We are given a session options structure that defines the kind of * transports that are being sought. It's not an error if we don't match * requested options, we just don't have anything to offer. */ if (SupportsOptions(opts) == false) { QCC_DbgPrintf(("TCPTransport::GetListenAddresses(): Supported options mismatch")); return ER_OK; } /* * The name service is initialized by the call to Init() in our Start() * method and then started there. It is Stop()ped in our Stop() method and * joined in our Join(). In the case of a call here, the transport will * probably be started, and we will probably find the name service started, * but there is no requirement to ensure this. If m_ns is NULL, we need to * complain so the user learns to Start() the transport before calling * IfConfig. A call to IsRunning() here is superfluous since we really * don't care about anything but the name service in this method. */ if (IpNameService::Instance().Started() == false) { QCC_LogError(ER_BUS_TRANSPORT_NOT_STARTED, ("TCPTransport::GetListenAddresses(): NameService not started")); return ER_BUS_TRANSPORT_NOT_STARTED; } /* * Our goal is here is to match a list of interfaces provided in the * configuration database (or a wildcard) to a list of interfaces that are * IFF_UP in the system. The first order of business is to get the list of * interfaces in the system. We do that using a convenient OS-inependent * call into the name service. * * We can't cache this list since it may change as the phone wanders in * and out of range of this and that and the underlying IP addresses change * as DHCP doles out whatever it feels like at any moment. */ QCC_DbgPrintf(("TCPTransport::GetListenAddresses(): IfConfig()")); std::vector entries; QStatus status = qcc::IfConfig(entries); if (status != ER_OK) { QCC_LogError(status, ("TCPTransport::GetListenAddresses(): ns.IfConfig() failed")); return status; } /* * The next thing to do is to get the list of requested interfaces that * have been processed. A '*' or '0.0.0.0' being a wildcard indicating * that we want to match any interface. If there is no configuration * item, we default to something rational. */ std::set interfaceSet; bool haveWildcard = false; /* * Check for wildcard anywhere in the configuration string. This trumps * anything else that may be there and ensures we get only one copy of * the addresses if someone tries to trick us with duplicate "*". * If we have already processed a specification in the configuration * database for the wildcard network interface "*" or the wildcard * network address we only add the default interface to the set of * processed interfaces. If we haven't processed a wildcard * specification, we look for any interfaces that we have processed, * these interface names will map to a non-default IP address in the * m_requestedInterfaces map. We also look for any IP addresses that * we have processed, these will map to a non-empty network interface * name in the m_requestedAddresses map. We add the interface names in * both cases to the processed interfaceSet. */ if (m_wildcardIfaceProcessed || m_wildcardAddressProcessed) { interfaceSet.insert(INTERFACES_DEFAULT); haveWildcard = true; } else { for (std::map::const_iterator it = m_requestedInterfaces.begin(); it != m_requestedInterfaces.end(); it++) { if (it->first != "*" && it->second.GetAddress().ToString() != "0.0.0.0") { interfaceSet.insert(it->first); } } for (std::map::const_iterator it = m_requestedAddresses.begin(); it != m_requestedAddresses.end(); it++) { if (it->first != "0.0.0.0" && !it->second.empty()) { interfaceSet.insert(it->second); } } } if (interfaceSet.size() == 0) { interfaceSet.insert(INTERFACES_DEFAULT); haveWildcard = true; } /* * Walk the requested set of processed interfaces and try to match it * up with interfaces actually found in the system via IfConfig(). */ for (std::set::const_iterator it = interfaceSet.begin(); it != interfaceSet.end(); it++) { /* * We got a set of interfaces, so we need to work our way through * the set. Each entry in the list may be an interface name, or a * wildcard. */ qcc::String currentInterface = *it; QCC_DbgPrintf(("TCPTransport::GetListenAddresses(): looking for interface %s", currentInterface.c_str())); /* * Walk the list of interfaces that we got from the system and see if * we find a match. */ for (uint32_t i = 0; i < entries.size(); ++i) { QCC_DbgPrintf(("TCPTransport::GetListenAddresses(): matching %s", entries[i].m_name.c_str())); /* * To match a configuration entry, the name of the interface must: * * - match the name in the currentInterface (or be wildcarded); * - be UP which means it has an IP address assigned; * - not be the LOOPBACK device and therefore be remotely available. */ uint32_t mask = qcc::IfConfigEntry::UP | qcc::IfConfigEntry::LOOPBACK; uint32_t state = qcc::IfConfigEntry::UP; if ((entries[i].m_flags & mask) == state) { QCC_DbgPrintf(("TCPTransport::GetListenAddresses(): %s has correct state", entries[i].m_name.c_str())); if (haveWildcard || entries[i].m_name == currentInterface) { QCC_DbgPrintf(("TCPTransport::GetListenAddresses(): %s has correct name", entries[i].m_name.c_str())); /* * This entry matches our search criteria, so we need to * turn the IP address that we found into a busAddr. We * must be a TCP transport, and we have an IP address * already in a string, so we can easily put together the * desired busAddr. */ QCC_DbgTrace(("TCPTransport::GetListenAddresses(): %s match found", entries[i].m_name.c_str())); /* * We know we have an interface that speaks IP and * which has an IP address we can pass back. We know * it is capable of receiving incoming connections, but * the $64,000 questions are, does it have a listener * and what port is that listener listening on. * * There is one name service associated with the daemon * TCP transport. It may be advertising a different port on each * network interface. If multiple listeners are created for * a network interface, the name service only advertises the * lastly set port for that network interface. Ask the name * service for a map that correlates the different interfaces * it is advertising on to the respective ports we are listening on. */ qcc::String ipv4address; qcc::String ipv6address; std::map reliableIpv4PortMap, unreliableIpv4PortMap; uint16_t reliableIpv6Port, unreliableIpv6port; IpNameService::Instance().Enabled(TRANSPORT_TCP, reliableIpv4PortMap, reliableIpv6Port, unreliableIpv4PortMap, unreliableIpv6port); /* * If no listening port corresponding to this network interface is found in the map, * then it hasn't been set and this implies that there is no listener for this transport * on this network interface. We should only return a bus address corresponding to this * network interface if we have a listener on this network interface. * * Note that if we find a "*" in the reliableIPv4PortMap it is a wildcard and therefore * matches the entry we are comparing to, in which case we are not comparing the entry to * what's in the port map, we are using what's in the port map to confirm the entry. */ bool portMapWildcard = reliableIpv4PortMap.find(qcc::String("*")) != reliableIpv4PortMap.end(); bool portMapExplicit = reliableIpv4PortMap.find(entries[i].m_name) != reliableIpv4PortMap.end(); if (portMapWildcard || portMapExplicit) { uint16_t port = 0; if (portMapWildcard) { port = reliableIpv4PortMap[qcc::String("*")]; } else { port = reliableIpv4PortMap[entries[i].m_name]; } /* * Now put this information together into a bus address * that the rest of the AllJoyn world can understand. * (Note: only IPv4 "reliable" addresses are supported * at this time.) */ if (!entries[i].m_addr.empty() && (entries[i].m_family == QCC_AF_INET)) { qcc::String busAddr = "tcp:addr=" + entries[i].m_addr + "," "port=" + U32ToString(port) + "," "family=ipv4"; busAddrs.push_back(busAddr); } } } } } } /* * If we can get the list and walk it, we have succeeded. It is not an * error to have no available interfaces. In fact, it is quite expected * in a phone if it is not associated with an access point over wi-fi. */ QCC_DbgPrintf(("TCPTransport::GetListenAddresses(): done")); return ER_OK; } void TCPTransport::EndpointExit(RemoteEndpoint& ep) { /* * This is a callback driven from the remote endpoint thread exit function. * Our TCPEndpoint inherits from class RemoteEndpoint and so when * either of the threads (transmit or receive) of one of our endpoints exits * for some reason, we get called back here. We only get called if either * the Read and WriteCallbacks stop taking place, which implies that they * have been run. It turns out that in the case of an endpoint receiving * a connection, it means that authentication has succeeded. * In the case of an endpoint doing the connect, the EndpointExit may have * resulted from an authentication error since authentication is done in the * context of the Connect()ing thread and may be reported through EndpointExit. */ QCC_DbgTrace(("TCPTransport::EndpointExit()")); TCPEndpoint tep = TCPEndpoint::cast(ep); /* * If this is an active connection, what has happened is that the reference * count on the underlying RemoteEndpoint has been decremented to zero and * the Stop() function of the endpoint has been called. This means that * we are done with the endpoint and it should be cleaned up. Marking * the connection as active prevented the passive side cleanup, so we need * to deal with cleanup now. */ tep->SetPassive(); /* * Mark the endpoint as no longer running. Since we are called from * the RemoteEndpoint ThreadExit routine, we know it has stopped both * the Read and WriteCallbacks. */ tep->SetEpStopping(); /* * Wake up the server accept loop so that it deals with our passing immediately. */ Alert(); } void TCPTransport::ManageEndpoints(Timespec authTimeout, Timespec sessionSetupTimeout) { bool managed = false; m_endpointListLock.Lock(MUTEX_CONTEXT); /* * Run through the list of connections on the authList and cleanup * any that are no longer running or are taking too long to authenticate * (we assume a denial of service attack in this case). */ set::iterator i = m_authList.begin(); while (i != m_authList.end()) { TCPEndpoint ep = *i; _TCPEndpoint::AuthState authState = ep->GetAuthState(); if (authState == _TCPEndpoint::AUTH_FAILED) { /* * The endpoint has failed authentication and the auth thread is * gone or is going away. Since it has failed there is no way this * endpoint is going to be started so we can get rid of it as soon * as we Join() the (failed) authentication thread. */ QCC_DbgHLPrintf(("TCPTransport::ManageEndpoints(): Scavenging failed authenticator")); m_authList.erase(i); m_endpointListLock.Unlock(MUTEX_CONTEXT); ep->AuthJoin(); m_endpointListLock.Lock(MUTEX_CONTEXT); i = m_authList.upper_bound(ep); managed = true; continue; } Timespec tNow; GetTimeNow(&tNow); if (ep->GetStartTime() + authTimeout < tNow) { /* * This endpoint is taking too long to authenticate. Stop the * authentication process. The auth thread is still running, so we * can't just delete the connection, we need to let it stop in its * own time. What that thread will do is to set AUTH_FAILED and * exit. we will then clean it up the next time through this loop. * In the hope that the thread can exit and we can catch its exit * here and now, we take our thread off the OS ready list (Sleep) * and let the other thread run before looping back. */ QCC_DbgHLPrintf(("TCPTransport::ManageEndpoints(): Scavenging slow authenticator")); ep->AuthStop(); qcc::Sleep(1); } ++i; } /* * We've handled the authList, so now run through the list of connections on * the endpointList and cleanup any that are no longer running or Join() * authentication threads that have successfully completed. */ i = m_endpointList.begin(); while (i != m_endpointList.end()) { TCPEndpoint ep = *i; /* * We are only managing passive connections here, or active connections * that are done and are explicitly ready to be cleaned up. */ _TCPEndpoint::SideState sideState = ep->GetSideState(); if (sideState == _TCPEndpoint::SIDE_ACTIVE) { ++i; continue; } _TCPEndpoint::AuthState authState = ep->GetAuthState(); _TCPEndpoint::EndpointState endpointState = ep->GetEpState(); if (authState == _TCPEndpoint::AUTH_SUCCEEDED) { /* * The endpoint has succeeded authentication and the auth thread is * gone or is going away. Take this opportunity to join the auth * thread. Since the auth thread promised not to touch the state * after setting AUTH_SUCCEEEDED, we can safely change the state * here since we now own the conn. We do this through a method call * to enable this single special case where we are allowed to set * the state. */ QCC_DbgHLPrintf(("TCPTransport::ManageEndpoints(): Scavenging failed authenticator")); m_endpointListLock.Unlock(MUTEX_CONTEXT); ep->AuthJoin(); ep->SetAuthDone(); m_endpointListLock.Lock(MUTEX_CONTEXT); i = m_endpointList.upper_bound(ep); continue; } /* * Passive endpoints need to be monitored between the time the endpoint is created via listen/accept * up until responsibility for lifecycle of the endpoint can be transferred to the session management * code in AllJoynObj. Otherwise, an endpoint can exist indefinitely if no session related control * messages are received over the new endpoint. */ if (authState == _TCPEndpoint::AUTH_DONE) { Timespec tNow; GetTimeNow(&tNow); if ((ep->GetFeatures().isBusToBus && !ep->IsSessionRouteSetUp()) && (ep->GetStartTime() + sessionSetupTimeout < tNow)) { /* This is a connection that timedout waiting for routing to be set up. Kill it */ QCC_DbgHLPrintf(("TCPTransport:: Stopping endpoint that timedout waiting for routing to be set up %s.\n", ep->GetUniqueName().c_str())); ep->Stop(); } } /* * There are two possibilities for the disposition of the Read and * WriteCallbacks. First, they were never successfully started. In * this case, the epState will be EP_FAILED. If we find this, we * can just remove the useless endpoint from the list and delete * it. Since the threads were never started, they must not be * joined. */ if (endpointState == _TCPEndpoint::EP_FAILED) { m_endpointList.erase(i); m_endpointListLock.Unlock(MUTEX_CONTEXT); ep->AuthJoin(); m_endpointListLock.Lock(MUTEX_CONTEXT); i = m_endpointList.upper_bound(ep); managed = true; continue; } /* * The second possibility for the disposition of the Read and * WriteCallbacks is that they were successfully started but * have been stopped for some reason, either because of a * Disconnect() or a network error. In this case, the * epState will be EP_STOPPING, which was set in the * EndpointExit function. If we find this, we need to Join * the endpoint threads, remove the endpoint from the * endpoint list and delete it. Note that we are calling * the endpoint Join() to join the TX and RX threads and not * the endpoint AuthJoin() to join the auth thread. */ if (endpointState == _TCPEndpoint::EP_STOPPING) { m_endpointList.erase(i); m_endpointListLock.Unlock(MUTEX_CONTEXT); ep->AuthJoin(); ep->Join(); m_endpointListLock.Lock(MUTEX_CONTEXT); i = m_endpointList.upper_bound(ep); managed = true; continue; } ++i; } m_endpointListLock.Unlock(MUTEX_CONTEXT); if (managed) { m_dynamicScoreUpdater.Alert(); } } void* TCPTransport::Run(void* arg) { QCC_UNUSED(arg); QCC_DbgTrace(("TCPTransport::Run()")); /* * We need to find the defaults for our connection limits. These limits * can be specified in the configuration database with corresponding limits * used for DBus. If any of those are present, we use them, otherwise we * provide some hopefully reasonable defaults. */ ConfigDB* config = ConfigDB::GetConfigDB(); /* * authTimeout is the maximum amount of time we allow incoming connections to * mess about while they should be authenticating. If they take longer * than this time, we feel free to disconnect them as deniers of service. */ Timespec authTimeout = config->GetLimit("auth_timeout", ALLJOYN_AUTH_TIMEOUT_DEFAULT); /* * sessionSetupTimeout is the maximum amount of time we allow incoming connections to * mess about while they should be sending messages to set up the session routes. * If they take longer than this time, we feel free to disconnect them as deniers of service. */ Timespec sessionSetupTimeout = config->GetLimit("session_setup_timeout", ALLJOYN_SESSION_SETUP_TIMEOUT_DEFAULT); /* * maxAuth is the maximum number of incoming connections that can be in * the process of authenticating. If starting to authenticate a new * connection would mean exceeding this number, we drop the new connection. */ uint32_t maxAuth = config->GetLimit("max_incomplete_connections", ALLJOYN_MAX_INCOMPLETE_CONNECTIONS_TCP_DEFAULT); /* * maxConn is the maximum number of active connections possible over the * TCP transport. If starting to process a new connection would mean * exceeding this number, we drop the new connection. */ uint32_t maxConn = config->GetLimit("max_completed_connections", ALLJOYN_MAX_COMPLETED_CONNECTIONS_TCP_DEFAULT); m_minHbeatIdleTimeout = config->GetLimit("tcp_min_idle_timeout", MIN_HEARTBEAT_IDLE_TIMEOUT_DEFAULT); m_maxHbeatIdleTimeout = config->GetLimit("tcp_max_idle_timeout", MAX_HEARTBEAT_IDLE_TIMEOUT_DEFAULT); m_defaultHbeatIdleTimeout = config->GetLimit("tcp_default_idle_timeout", DEFAULT_HEARTBEAT_IDLE_TIMEOUT_DEFAULT); m_numHbeatProbes = HEARTBEAT_NUM_PROBES; m_maxHbeatProbeTimeout = config->GetLimit("tcp_max_probe_timeout", MAX_HEARTBEAT_PROBE_TIMEOUT_DEFAULT); m_defaultHbeatProbeTimeout = config->GetLimit("tcp_default_probe_timeout", DEFAULT_HEARTBEAT_PROBE_TIMEOUT_DEFAULT); QCC_DbgPrintf(("TCPTransport: Using m_minHbeatIdleTimeout=%u, m_maxHbeatIdleTimeout=%u, m_numHbeatProbes=%u, m_defaultHbeatProbeTimeout=%u m_maxHbeatProbeTimeout=%u", m_minHbeatIdleTimeout, m_maxHbeatIdleTimeout, m_numHbeatProbes, m_defaultHbeatProbeTimeout, m_maxHbeatProbeTimeout)); QStatus status = ER_OK; while (!IsStopping()) { /* * We did an Acquire on the name service in our Start() method which * ultimately caused this thread to run. If we were the first transport * to Acquire() the name service, it will have done a Start() to crank * up its own run thread. Just because we did that Start() before we * did our Start(), it does not necessarily mean that thread will come * up and run before us. If we happen to come up before our name service * we'll hang around until it starts to run. After all, nobody is going * to attempt to connect until we advertise something, and we need the * name service to advertise. */ if (IpNameService::Instance().Started() == false) { QCC_DbgTrace(("TCPTransport::Run(): Wait for IP name service")); qcc::Sleep(1); continue; } /* * Each time through the loop we create a set of events to wait on. * We need to wait on the stop event and all of the SocketFds of the * addresses and ports we are listening on. If the list changes, the * code that does the change Alert()s this thread and we wake up and * re-evaluate the list of SocketFds. * Set reload to STATE_RELOADED to indicate that the set of events has been reloaded. */ m_listenFdsLock.Lock(MUTEX_CONTEXT); m_reload = STATE_RELOADED; vector checkEvents, signaledEvents; checkEvents.push_back(&stopEvent); for (list >::const_iterator i = m_listenFds.begin(); i != m_listenFds.end(); ++i) { checkEvents.push_back(new Event(i->second, Event::IO_READ)); } m_listenFdsLock.Unlock(MUTEX_CONTEXT); /* * We have our list of events, so now wait for something to happen * on that list (or get alerted). */ signaledEvents.clear(); status = Event::Wait(checkEvents, signaledEvents); if (ER_OK != status) { for (vector::iterator i = checkEvents.begin(); i != checkEvents.end(); ++i) { if (*i != &stopEvent) { delete *i; } } QCC_LogError(status, ("Event::Wait failed")); break; } /* * We're back from our Wait() so one of three things has happened. Our * thread has been asked to Stop(), our thread has been Alert()ed, or * one of the socketFds we are listening on for connecte events has * becomed signalled. * * If we have been asked to Stop(), or our thread has been Alert()ed, * the stopEvent will be on the list of signalled events. The * difference can be found by a call to IsStopping() which is found * above. An alert means that a request to start or stop listening * on a given address and port has been queued up for us. */ for (vector::iterator i = signaledEvents.begin(); i != signaledEvents.end(); ++i) { /* * The stopEvent may get set indirectly by ManageEndpoints below, so * make sure to reset it before calling ManageEndpoints. */ if (*i == &stopEvent) { stopEvent.ResetEvent(); } /* * In order to rationalize management of resources, we manage the * various lists in one place on one thread. This thread is a * convenient victim, so we do it here. */ ManageEndpoints(authTimeout, sessionSetupTimeout); if (*i == &stopEvent) { continue; } /* * Since the current event is not the stop event, it must reflect at * least one of the SocketFds we are waiting on for incoming * connections. Go ahead and Accept() the new connection on the * current SocketFd. */ IPAddress remoteAddr; uint16_t remotePort; SocketFd newSock; for (;;) { status = Accept((*i)->GetFD(), remoteAddr, remotePort, newSock); if (status != ER_OK) { break; } QCC_DbgHLPrintf(("TCPTransport::Run(): Accepting connection newSock=%d", newSock)); QCC_DbgPrintf(("TCPTransport::Run(): maxAuth == %d", maxAuth)); QCC_DbgPrintf(("TCPTransport::Run(): maxConn == %d", maxConn)); QCC_DbgPrintf(("TCPTransport::Run(): mAuthList.size() == %d", m_authList.size())); QCC_DbgPrintf(("TCPTransport::Run(): mEndpointList.size() == %d", m_endpointList.size())); assert(m_authList.size() + m_endpointList.size() <= maxConn); /* * Do we have a slot available for a new connection? If so, use * it. */ m_endpointListLock.Lock(MUTEX_CONTEXT); if ((m_authList.size() < maxAuth) && (m_authList.size() + m_endpointList.size() < maxConn)) { static const bool truthiness = true; TCPTransport* ptr = this; TCPEndpoint conn(ptr, m_bus, truthiness, TCPTransport::TransportName, newSock, remoteAddr, remotePort); conn->SetPassive(); Timespec tNow; GetTimeNow(&tNow); conn->SetStartTime(tNow); /* * By putting the connection on the m_authList, we are * transferring responsibility for the connection to the * Authentication thread. Therefore, we must check that the * thread actually started running to ensure the handoff * worked. If it didn't we need to deal with the connection * here. Since there are no threads running we can just * pitch the connection. */ std::pair::iterator, bool> ins = m_authList.insert(conn); status = conn->Authenticate(); if (status != ER_OK) { m_authList.erase(ins.first); } m_endpointListLock.Unlock(MUTEX_CONTEXT); } else { m_endpointListLock.Unlock(MUTEX_CONTEXT); qcc::SetLinger(newSock, true, 0); qcc::Shutdown(newSock); qcc::Close(newSock); status = ER_CONNECTION_LIMIT_EXCEEDED; QCC_LogError(status, ("TCPTransport::Run(): No slot for new connection")); } } /* * Accept returns ER_WOULDBLOCK when all of the incoming connections have been handled */ if (ER_WOULDBLOCK == status) { status = ER_OK; } if (status != ER_OK) { QCC_LogError(status, ("TCPTransport::Run(): Error accepting new connection. Ignoring...")); } } /* * We're going to loop back and create a new list of checkEvents that * reflect the current state, so we need to delete the checkEvents we * created on this iteration. */ for (vector::iterator i = checkEvents.begin(); i != checkEvents.end(); ++i) { if (*i != &stopEvent) { delete *i; } } } /* * If we're stopping, it is our responsibility to clean up the list of FDs * we are listening to. Since we've gotten a Stop() and are exiting the * server loop, and FDs are added in the server loop, this is the place to * get rid of them. We don't have to take the list lock since a Stop() * request to the TCPTransport is required to lock out any new * requests that may possibly touch the listen FDs list. * Set m_reload to STATE_EXITED to indicate that the TCPTransport::Run * thread has exited. */ m_listenFdsLock.Lock(MUTEX_CONTEXT); for (list >::iterator i = m_listenFds.begin(); i != m_listenFds.end(); ++i) { qcc::SetLinger(i->second, true, 0); qcc::Shutdown(i->second); qcc::Close(i->second); } m_listenFds.clear(); m_reload = STATE_EXITED; m_listenFdsLock.Unlock(MUTEX_CONTEXT); QCC_DbgPrintf(("TCPTransport::Run is exiting status=%s", QCC_StatusText(status))); return (void*) status; } /* * The purpose of this code is really to ensure that we don't have any listeners * active on Android systems if we have no ongoing advertisements. This is to * satisfy a requirement driven from the Android Compatibility Test Suite (CTS) * which fails systems that have processes listening for TCP connections when * the test is run. * * Listeners and advertisements are interrelated. In order to Advertise a * service, the name service must have an endpoint to include in its * advertisements; and there must be at least one listener running and ready to * receive connections before telling the name service to advertise. * * Discovery requests do not require listeners be present per se before being * forwarded to the name service. A discovery request will ulitmately lead to a * bus-to-bus connection once a remote daemon has been discovered; but the local * side will always start the connection. Sessions throw a bit of a monkey * wrench in the works, though. Since a JoinSession request is sent to the * (already connected) remote daemon and it decides what to do, we don't want to * arbitrarily constrain the remote daemon by disallowing it to try and connect * back to the local daemon. For this reason, we do require listeners to be * present before discovery starts. * * So the goal is to not have active listeners in the system unless there are * outstanding advertisements or discovery requests, but we cannot have * outstanding advertisements or discovery requests until there are active * listeners. Some care is obviously required here to accomplish this * seemingly inconsistent behavior. * * We call the state of no outstanding advertisements and not outstanding * discovery requests "Name Service Quiescent". In this case, the name service * must be disabled so that it doesn't interact with the network and cause a CTS * failure. As soon as a either a discovery request or an advertisement request * is started, we need to enable the name service to recieve and send network * packets, which will cause the daemon process to begin listening on the name * service well-known UDP port. * * Before an advertisement or a discovery request can acutally be sent over the * wire, we must start a listener which will receive connection requests, and * we must provide the name service with endpoint information that it can include * in its advertisement. So, from the name service and network perspective, * listens must preceed advertisements. * * In order to accomplish the CTS requirements, however, advertisements must * preceed listens. It turns out that this is how the high-level system wants * to work. Essentually, the system calls StartListen at the beginning of time * (when the daemon is first brought up) and it calls StopListen at the end of * time (when the daemon is going down). Advertisements and discovery requests * come and go in between as clients and services come up and go down. * * To deal with this time-inversion, we save a list of all listen requests, a * list of all advertisement requests and a list of all discovery requests. At * the beginning of time we get one or more StartListen calls and save the * listen specs, but do not actually do the socket operations to start the * corresponding socket-level listens. When the first advertisement or * discovery request comes in from the higher-level code, we first start all of * the saved listens and then enable the name service and ask it to start * advertising or discovering as appropriate. Further advertisements and * discovery requests are also saved, but the calls to the name service are * passed through when it is not quiescent. * * We keep track of the disable advertisement and discovery calls as well. Each * time an advertisement or discover operation is disabled, we remove the * corresponding entry in the associated list. As soon as all advertisements * and discovery operations are disabled, we disable the name service and remove * our TCP listeners, and therefore remove all listeners from the system. Since * we have a saved a list of listeners, they can be restarted if another * advertisement or discovery request comes in. * * We need to do all of this in one place (here) to make it easy to keep the * state of the transport (us) and the name service consistent. We are * basically a state machine handling the following transitions: * * START_LISTEN_INSTANCE: An instance of a StartListen() has happened so we * need to add the associated listen spec to our list of listeners and be * ready for a subsequent advertisement. We expect these to happen at the * beginning of time; but there is nothing preventing a StartListen after we * start advertising. In this case we need to execute the start listen. * * STOP_LISTEN_INSTANCE: An instance of a StopListen() has happened so we need * to remove the listen spec from our list of listeners. We expect these to * happen at the end of time; but there is nothing preventing a StopListen * at any other time. In this case we need to execute the stop listen and * remove the specified listener immediately * * ENABLE_ADVERTISEMENT_INSTANCE: An instance of an EnableAdvertisement() has * happened. If there are no other ongoing advertisements, we need to * enable the stored listeners, pass the endpoint information down to the * name servcie, enable the name service communication with the outside * world if it is disabled and finally pass the advertisement down to the * name service. If there are other ongoing advertisements we just pass * down the new advertisement. It is an AllJoyn system programming error to * start advertising before starting at least one listen. * * DISABLE_ADVERTISEMENT_INSTANCE: An instance of a DisableAdvertisement() * call has happened. We always want to pass the corresponding Cancel down * to the name service. If we decide that this is the last of our ongoing * advertisements, we need to continue and disable the name service from * talking to the outside world. For completeness, we remove endpoint * information from the name service. Finally, we shut down our TCP * transport listeners. * * ENABLE_DISCOVERY_INSTANCE: An instance of an EnableDiscovery() has * happened. This is a fundamentally different request than an enable * advertisement. We don't need any listeners to be present in order to do * discovery, but the name service must be enabled so it can send and * receive WHO-HAS packets. If the name service communications are * disabled, we need to enable them. In any case we pass the request down * to the name service. * * DISABLE_DISCOVERY_INSTANCE: An instance of a DisableDiscovery() call has * happened. There is no corresponding disable call in the name service, * but we do have to decide if we want to disable the name service to keep * it from listening. We do so if this is the last discovery instance and * there are no other advertisements. * * There are five member variables that reflect the state of the transport * and name service with respect to this code: * * m_isListening: The list of listeners is reflected by currently listening * sockets. We have network infrastructure in place to receive inbound * connection requests. * * m_isNsEnabled: The name service is up and running and listening on its * sockets for incoming requests. * * m_isAdvertising: We are advertising at least one well-known name either actively or quietly . * If we are m_isAdvertising then m_isNsEnabled must be true. * * m_isDiscovering: The list of discovery requests has been sent to the name * service. If we are m_isDiscovering then m_isNsEnabled must be true. */ void TCPTransport::RunListenMachine(ListenRequest& listenRequest) { QCC_DbgPrintf(("TCPTransport::RunListenMachine()")); /* * Do some consistency checks to make sure we're not confused about what * is going on. * * First, if we are not listening, then we had better not think we're * advertising(actively or quietly) or discovering. If we are * not listening, then the name service must not be enabled and sending * or responding to external daemons. */ if (m_isListening == false) { assert(m_isAdvertising == false); assert(m_isDiscovering == false); assert(m_isNsEnabled == false); } /* * If we think the name service is enabled, it had better think it is * enabled. It must be enabled either because we have requested it to * start advertising (actively or quietly) or we are discovering. * If there are listeners, then the m_listenPortMap (a map matching * the different interfaces to the ports on which we are listening * on those interfaces) must be non-empty. */ if (m_isNsEnabled && !m_stopping) { assert(m_isListening); assert(!m_listenPortMap.empty()); } /* * If we think we are advertising, we'd better have an entry in * the advertisements list to advertise, and there must be * listeners waiting for inbound connections as a result of those * advertisements. If we are advertising the name service had * better be enabled. */ if (m_isAdvertising && !m_stopping) { assert(!m_advertising.empty()); assert(m_isListening); assert(!m_listenPortMap.empty()); assert(m_isNsEnabled); } /* * If we are discovering, we'd better have an entry in the discovering * list to make us discover, and there must be listeners waiting for * inbound connections as a result of session operations driven by those * discoveries. If we are discovering the name service had better be * enabled. */ if (m_isDiscovering && !m_stopping) { assert(!m_discovering.empty()); assert(m_isListening); assert(!m_listenPortMap.empty()); assert(m_isNsEnabled); } /* * Now that are sure we have a consistent view of the world, let's do * what needs to be done. */ switch (listenRequest.m_requestOp) { case START_LISTEN_INSTANCE: StartListenInstance(listenRequest); break; case STOP_LISTEN_INSTANCE: StopListenInstance(listenRequest); break; case ENABLE_ADVERTISEMENT_INSTANCE: EnableAdvertisementInstance(listenRequest); break; case DISABLE_ADVERTISEMENT_INSTANCE: DisableAdvertisementInstance(listenRequest); break; case ENABLE_DISCOVERY_INSTANCE: EnableDiscoveryInstance(listenRequest); break; case DISABLE_DISCOVERY_INSTANCE: DisableDiscoveryInstance(listenRequest); break; case HANDLE_NETWORK_EVENT: HandleNetworkEventInstance(listenRequest); break; case UPDATE_DYNAMIC_SCORE_INSTANCE: UpdateDynamicScoreInstance(listenRequest); break; } } void TCPTransport::StartListenInstance(ListenRequest& listenRequest) { QCC_DbgPrintf(("TCPTransport::StartListenInstance()")); /* * We have a new StartListen request, so save the listen spec so we * can restart the listen if we stop advertising. */ NewListenOp(START_LISTEN, listenRequest.m_requestParam); /* * If we're running on Windows, we always start listening immediately * since Windows uses TCP as the client to daemon communication link. * * On other operating systems (i.e. Posix) we use unix domain sockets and so * we can delay listening to passify the Android Compatibility Test Suite. * We do this unless we have any outstanding advertisements or discovery * operations in which case we start up the listens immediately. * * We have a bit of a chicken-and-egg problem when we want to start a quiet * advertisement of the daemon router for embedded AllJoyn clients. We * don't want to start the quiet advertisement until we have a listener, but * then we don't start listeners until we have advertisements in order to * pass the Android Compatibility Test Suite. * * There is only one quiet advertisement that needs to be done * automagically, and this is the daemon router advertisement we do based on * configuration. So, we take a peek at this configuration item and if it * is set, we go ahead and execute the DoStartListen to crank up a listener. * We actually start the quiet advertisement there in DoStartListen, after * we have a valid listener to respond to remote requests. Note that we are * just driving the start listen, and there is no quiet advertisement yet so * the corresponding must not yet be set. */ ConfigDB* config = ConfigDB::GetConfigDB(); uint32_t maxRemoteClients = config->GetLimit("max_remote_clients_tcp", ALLJOYN_MAX_REMOTE_CLIENTS_TCP_DEFAULT); uint32_t maxUntrustedClients = config->GetLimit("max_untrusted_clients"); if (maxUntrustedClients) { QCC_LogError(ER_WARNING, ("TCPTransport::Start(): The config option \"max_untrusted_clients\" has been deprecated.")); m_maxRemoteClientsTcp = maxUntrustedClients; } else { m_maxRemoteClientsTcp = maxRemoteClients; } routerName = config->GetProperty("router_advertisement_prefix", ALLJOYN_DEFAULT_ROUTER_ADVERTISEMENT_PREFIX); if (m_isAdvertising || m_isDiscovering || (!routerName.empty() && (m_numUntrustedClients < m_maxRemoteClientsTcp))) { routerName.append(m_bus.GetInternal().GetGlobalGUID().ToShortString()); DoStartListen(listenRequest.m_requestParam); } } void TCPTransport::StopListenInstance(ListenRequest& listenRequest) { QCC_DbgPrintf(("TCPTransport::StopListenInstance()")); /* * We have a new StopListen request, so we need to remove this * particular listen spec from our lists so it will not be * restarted. */ bool empty = NewListenOp(STOP_LISTEN, listenRequest.m_requestParam); /* * If we have just removed the last listener, we have a problem if * we have advertisements. This is because we will be * advertising soon to be non-existent endpoints. The question is, * what do we want to do about it. We could just ignore it since * since clients receiving advertisements may just try to connect to * a non-existent endpoint and fail. It does seem better to log an * error and then cancel any outstanding advertisements since they * are soon to be meaningless. * */ if (empty && m_isAdvertising) { QCC_LogError(ER_FAIL, ("TCPTransport::StopListenInstance(): No listeners with outstanding advertisements.")); for (list::iterator i = m_advertising.begin(); i != m_advertising.end(); ++i) { IpNameService::Instance().CancelAdvertiseName(TRANSPORT_TCP, *i, TRANSPORT_TCP); } } /* * Execute the code that will actually tear down the specified * listening endpoint. Note that we always stop listening * immediately since that is Good (TM) from a power and CTS point of * view. We only delay starting to listen. */ DoStopListen(listenRequest.m_requestParam); } void TCPTransport::EnableAdvertisementInstance(ListenRequest& listenRequest) { QCC_DbgPrintf(("TCPTransport::EnableAdvertisementInstance()")); /* * We have a new advertisement request to deal with. The first * order of business is to save the well-known name away for * use later. */ bool isFirst; NewAdvertiseOp(ENABLE_ADVERTISEMENT, listenRequest.m_requestParam, isFirst); /* * If it turned out that is the first advertisement on our list, we * need to prepare before actually doing the advertisement. */ if (isFirst) { /* * If we don't have any listeners up and running, we need to get them * up. If this is a Windows box, the listeners will start running * immediately and will never go down, so they may already be running. */ if (!m_isListening) { for (list::iterator i = m_listening.begin(); i != m_listening.end(); ++i) { QStatus status = DoStartListen(*i); if (ER_OK != status) { continue; } } } /* * We can only enable the requested advertisement if there is something * listening inbound connections on. Therefore, we should only enable * the name service if there is a listener. This catches the case where * there was no StartListen() done before the first advertisement. */ if (m_isListening) { if (!m_isNsEnabled) { IpNameService::Instance().Enable(TRANSPORT_TCP, m_listenPortMap, 0, std::map(), 0, true, false, false, false); m_isNsEnabled = true; } } } /* If we encounter the situation where there are no listeners it is * possible that we don't have any of the specified interfaces IFF_UP * yet. When those interfaces come up the backlog of advertisements * that came in will be processed. */ if (!m_isListening) { QCC_DbgPrintf(("TCPTransport::EnableAdvertisementInstance(): Advertise with no TCP listeners")); if (!m_pendingAdvertisements.empty()) { for (std::list::iterator it = m_pendingAdvertisements.begin(); it != m_pendingAdvertisements.end(); it++) { if (listenRequest.m_requestParam == it->m_requestParam) { return; } } } m_pendingAdvertisements.push_back(listenRequest); return; } /* * We think we're ready to send the advertisement. Are we really? */ assert(m_isListening); assert(!m_listenPortMap.empty()); assert(m_isNsEnabled); assert(IpNameService::Instance().Started() && "TCPTransport::EnableAdvertisementInstance(): IpNameService not started"); QStatus status = IpNameService::Instance().AdvertiseName(TRANSPORT_TCP, listenRequest.m_requestParam, listenRequest.m_requestParamOpt, listenRequest.m_requestTransportMask); if (status != ER_OK) { QCC_LogError(status, ("TCPTransport::EnableAdvertisementInstance(): Failed to advertise \"%s\"", listenRequest.m_requestParam.c_str())); } QCC_DbgPrintf(("TCPTransport::EnableAdvertisementInstance(): Done")); m_isAdvertising = true; } void TCPTransport::DisableAdvertisementInstance(ListenRequest& listenRequest) { QCC_DbgPrintf(("TCPTransport::DisableAdvertisementInstance()")); /* * We have a new disable advertisement request to deal with. The first * order of business is to remove the well-known name from our saved list. */ bool isFirst; bool isEmpty = NewAdvertiseOp(DISABLE_ADVERTISEMENT, listenRequest.m_requestParam, isFirst); /* * We always cancel any advertisement to allow the name service to * send out its lost advertisement message. */ QStatus status = IpNameService::Instance().CancelAdvertiseName(TRANSPORT_TCP, listenRequest.m_requestParam, listenRequest.m_requestTransportMask); if (status != ER_OK) { QCC_LogError(status, ("TCPTransport::DisableAdvertisementInstance(): Failed to Cancel \"%s\"", listenRequest.m_requestParam.c_str())); } /* We check to make sure that this cancellation is not for an * advertisement that has not yet gone into effect because we * are still waiting on the specified network interface to * become IFF_UP. We don't want to send out advertisements * whenever the interface comes up. If this is the last * advertisement and we are no longer discovering we should * not start listening when the interface comes up. */ if (!m_pendingAdvertisements.empty()) { for (std::list::iterator it = m_pendingAdvertisements.begin(); it != m_pendingAdvertisements.end(); it++) { if (listenRequest.m_requestParam == it->m_requestParam) { m_pendingAdvertisements.erase(it); break; } } } /* * If it turns out that this was the last advertisement on our list, we need * to think about disabling our listeners and turning off the name service. * We only to this if there are no discovery instances in progress. */ if (isEmpty && !m_isDiscovering) { /* * Since the cancel advertised name has been sent, we can disable the * name service. We do this by telling it we don't want it to be * enabled on any of the possible ports. */ IpNameService::Instance().Enable(TRANSPORT_TCP, m_listenPortMap, 0, std::map(), 0, false, false, false, false); m_isNsEnabled = false; /* * If we had the name service running, we must have had listeners * waiting for connections due to the name service. We need to stop * them all now, but only if we are not running on a Windows box. * Windows needs the listeners running at all times since it uses * TCP for the client to daemon connections. The listen spec may * involve network interfaces or IP addresses and we need to do * some translation from a specified network interface to the * corresponding IP address. */ for (list::iterator i = m_listening.begin(); i != m_listening.end(); ++i) { map argMap; qcc::String spec; QStatus status = NormalizeListenSpec(i->c_str(), spec, argMap); assert(status == ER_OK && "TCPTransport::DisableAdvertisementInstance(): Invalid TCP listen spec"); QCC_UNUSED(status); if (argMap.find("iface") != argMap.end()) { qcc::String interface = argMap["iface"]; qcc::String normSpec = "tcp:addr=" + m_requestedInterfaces[interface].GetAddress().ToString() + ",port=" + U32ToString(m_requestedInterfaces[interface].GetPort()); DoStopListen(normSpec); } else if (argMap.find("addr") != argMap.end()) { DoStopListen(*i); } } m_isListening = false; m_listenPortMap.clear(); m_pendingDiscoveries.clear(); m_pendingAdvertisements.clear(); m_wildcardIfaceProcessed = false; } if (isEmpty) { m_isAdvertising = false; } } void TCPTransport::EnableDiscoveryInstance(ListenRequest& listenRequest) { QCC_DbgPrintf(("TCPTransport::EnableDiscoveryInstance()")); /* * We have a new discovery request to deal with. The first * order of business is to save the well-known name away for * use later. */ bool isFirst; NewDiscoveryOp(ENABLE_DISCOVERY, listenRequest.m_requestParam, isFirst); /* * If it turned out that is the first discovery request on our list, we need * to prepare before actually doing the discovery. */ if (isFirst) { /* * If we don't have any listeners up and running, we need to get them * up. If this is a Windows box, the listeners will start running * immediately and will never go down, so they may already be running. * However, we only set up the m_listenPortMap (a map of the network * interfaces to the corresponding ports on which we are listening) * when we are sure that the specified network interfaces are IFF_UP. */ if (!m_isListening) { for (list::iterator i = m_listening.begin(); i != m_listening.end(); ++i) { QStatus status = DoStartListen(*i); if (ER_OK != status) { continue; } } } /* * We can only enable the requested advertisement if there is something * listening inbound connections on. Therefore, we should only enable * the name service if there is a listener. This catches the case where * there was no StartListen() done before the first discover. */ if (m_isListening) { if (!m_isNsEnabled) { IpNameService::Instance().Enable(TRANSPORT_TCP, m_listenPortMap, 0, std::map(), 0, true, false, false, false); m_isNsEnabled = true; } } } /* If we encounter the situation where there are no listeners it is * possible that we don't have any of the specified interfaces IFF_UP * yet, when those interfaces come up the backlog of discoveries * that came in will be processed. */ if (!m_isListening) { QCC_DbgPrintf(("TCPTransport::EnableDiscoveryInstance(): Discover with no TCP listeners")); if (!m_pendingDiscoveries.empty()) { for (std::list::iterator it = m_pendingDiscoveries.begin(); it != m_pendingDiscoveries.end(); it++) { if (listenRequest.m_requestParam == it->m_requestParam) { return; } } } m_pendingDiscoveries.push_back(listenRequest); return; } /* * We think we're ready to send the FindAdvertisement. Are we really? */ assert(m_isListening); assert(!m_listenPortMap.empty()); assert(m_isNsEnabled); assert(IpNameService::Instance().Started() && "TCPTransport::EnableDiscoveryInstance(): IpNameService not started"); QStatus status = IpNameService::Instance().FindAdvertisement(TRANSPORT_TCP, listenRequest.m_requestParam, listenRequest.m_requestTransportMask); if (status != ER_OK) { QCC_LogError(status, ("TCPTransport::EnableDiscoveryInstance(): Failed to begin discovery with multicast NS \"%s\"", listenRequest.m_requestParam.c_str())); } m_isDiscovering = true; } void TCPTransport::DisableDiscoveryInstance(ListenRequest& listenRequest) { QCC_DbgPrintf(("TCPTransport::DisableDiscoveryInstance()")); /* * We have a new disable discovery request to deal with. The first * order of business is to remove the well-known name from our saved list. */ bool isFirst; bool isEmpty = NewDiscoveryOp(DISABLE_DISCOVERY, listenRequest.m_requestParam, isFirst); if (m_isListening && !m_listenPortMap.empty() && m_isNsEnabled && IpNameService::Instance().Started()) { QStatus status = IpNameService::Instance().CancelFindAdvertisement(TRANSPORT_TCP, listenRequest.m_requestParam, listenRequest.m_requestTransportMask); if (status != ER_OK) { QCC_LogError(status, ("TCPTransport::DisableDiscoveryInstance(): Failed to cancel discovery with \"%s\"", listenRequest.m_requestParam.c_str())); } } if (!m_pendingDiscoveries.empty()) { for (std::list::iterator it = m_pendingDiscoveries.begin(); it != m_pendingDiscoveries.end(); it++) { if (listenRequest.m_requestParam == it->m_requestParam) { m_pendingDiscoveries.erase(it); break; } } } /* * If it turns out that this was the last discovery operation on * our list, we need to think about disabling our listeners and turning off * the name service. We only to this if there are no advertisements in * progress. */ if (isEmpty && !m_isAdvertising) { IpNameService::Instance().Enable(TRANSPORT_TCP, m_listenPortMap, 0, std::map(), 0, false, false, false, false); m_isNsEnabled = false; /* * If we had the name service running, we must have had listeners * waiting for connections due to the name service. We need to stop * them all now, but only if we are not running on a Windows box. * Windows needs the listeners running at all times since it uses * TCP for the client to daemon connections. The listen spec may * involve network interfaces or IP addresses and we need to do * some translation from a specified network interface to the * corresponding IP address. */ for (list::iterator i = m_listening.begin(); i != m_listening.end(); ++i) { map argMap; qcc::String spec; QStatus status = NormalizeListenSpec(i->c_str(), spec, argMap); assert(status == ER_OK && "TCPTransport::DisableDiscoveryInstance(): Invalid TCP listen spec"); QCC_UNUSED(status); if (argMap.find("iface") != argMap.end()) { qcc::String interface = argMap["iface"]; qcc::String normSpec = "tcp:addr=" + m_requestedInterfaces[interface].GetAddress().ToString() + ",port=" + U32ToString(m_requestedInterfaces[interface].GetPort()); DoStopListen(normSpec); } else if (argMap.find("addr") != argMap.end()) { DoStopListen(*i); } } m_isListening = false; m_listenPortMap.clear(); m_pendingDiscoveries.clear(); m_pendingAdvertisements.clear(); m_wildcardIfaceProcessed = false; } if (isEmpty) { m_isDiscovering = false; } } bool TCPTransport::EnableRouterAdvertisement() { ConfigDB* config = ConfigDB::GetConfigDB(); uint32_t maxConn = config->GetLimit("max_completed_connections", ALLJOYN_MAX_COMPLETED_CONNECTIONS_TCP_DEFAULT); uint32_t maxAuth = config->GetLimit("max_incomplete_connections", ALLJOYN_MAX_INCOMPLETE_CONNECTIONS_TCP_DEFAULT); if (m_routerNameAdvertised == false && !routerName.empty() && m_numUntrustedClients < m_maxRemoteClientsTcp && m_authList.size() < maxAuth && (m_authList.size() + m_endpointList.size()) < maxConn) { return true; } return false; } bool TCPTransport::DisableRouterAdvertisement() { ConfigDB* config = ConfigDB::GetConfigDB(); uint32_t maxConn = config->GetLimit("max_completed_connections", ALLJOYN_MAX_COMPLETED_CONNECTIONS_TCP_DEFAULT); uint32_t maxAuth = config->GetLimit("max_incomplete_connections", ALLJOYN_MAX_INCOMPLETE_CONNECTIONS_TCP_DEFAULT); if (m_routerNameAdvertised == true && !routerName.empty() && ((m_numUntrustedClients >= m_maxRemoteClientsTcp) || (m_authList.size() >= maxAuth) || (m_authList.size() + m_endpointList.size()) >= maxConn)) { return true; } return false; } void TCPTransport::UpdateDynamicScoreInstance(ListenRequest& listenRequest) { QCC_UNUSED(listenRequest); ConfigDB* config = ConfigDB::GetConfigDB(); uint32_t maxConn = config->GetLimit("max_completed_connections", ALLJOYN_MAX_COMPLETED_CONNECTIONS_TCP_DEFAULT); uint32_t availConn = maxConn - (m_authList.size() + m_endpointList.size()); uint32_t availRemoteClientsTcp = m_maxRemoteClientsTcp - m_numUntrustedClients; availRemoteClientsTcp = std::min(availRemoteClientsTcp, availConn); IpNameService::Instance().UpdateDynamicScore(TRANSPORT_TCP, availConn, maxConn, availRemoteClientsTcp, m_maxRemoteClientsTcp); } /* * The default address for use in listen specs. INADDR_ANY means to listen * for TCP connections on any interfaces that are currently up or any that may * come up in the future. */ static const char* ADDR4_DEFAULT = "0.0.0.0"; /* * The default port for use in listen specs. This port is used by the TCP * listener to listen for incoming connection requests. This is the default * port for a "reliable" IPv4 listener since being able to deal with IPv4 * connection requests is required as part of the definition of the TCP * transport. * * All other mechanisms (unreliable IPv4, reliable IPv6, unreliable IPv6) * rely on the presence of an u4port, r6port, and u6port respectively to * enable those mechanisms if possible. */ static const uint16_t PORT_DEFAULT = 9955; QStatus TCPTransport::NormalizeListenSpec(const char* inSpec, qcc::String& outSpec, map& argMap) const { qcc::String family; /* * We don't make any calls that require us to be in any particular state * with respect to threading so we don't bother to call IsRunning() here. * * Take the string in inSpec, which must start with "tcp:" and parse it, * looking for comma-separated "key=value" pairs and initialize the * argMap with those pairs. * * There are lots of legal possibilities for an IP-based transport, but * all we are going to recognize is the "reliable IPv4 mechanism" and * so we will summarily pitch everything else. * * We expect to end up with a normalized outSpec that looks something * like: * * "tcp:addr=0.0.0.0,port=9955" * * That's all. We still allow "addr=0.0.0.0,port=9955,family=ipv4" but * since the only thing that was ever allowed was really reliable IPv4, we * ignore family. The old stuff is normalized to the above. * * In the future we may want to revisit this and use position/order of keys * to imply more information. For example: * * "addr=0.0.0.0,port=9955,family=ipv4,reliable=true, * addr=0.0.0.0,port=9956,family=ipv4,reliable=false;" * * might translate into: * * "tcp:addr=0.0.0.0,port=9955" * udp:addr=0.0.0.0,port=9956;" * * Note the new significance of position. */ QStatus status = ParseArguments(GetTransportName(), inSpec, argMap); if (status != ER_OK) { return status; } map::iterator iter; /* * We just ignore the family since ipv4 was the only possibld working choice. */ iter = argMap.find("family"); if (iter != argMap.end()) { argMap.erase(iter); } /* * Transports, by definition, may support reliable Ipv4, unreliable IPv4, * reliable IPv6 and unreliable IPv6 mechanisms to move bits. In this * incarnation, the TCP transport will only support reliable IPv4; so we * log errors and ignore any requests for other mechanisms. */ iter = argMap.find("u4addr"); if (iter != argMap.end()) { QCC_LogError(ER_BUS_BAD_TRANSPORT_ARGS, ("TCPTransport::NormalizeListenSpec(): The mechanism implied by \"u4addr\" is not supported.")); argMap.erase(iter); } iter = argMap.find("u4port"); if (iter != argMap.end()) { QCC_LogError(ER_BUS_BAD_TRANSPORT_ARGS, ("TCPTransport::NormalizeListenSpec(): The mechanism implied by \"u4port\" is not supported.")); argMap.erase(iter); } iter = argMap.find("r6addr"); if (iter != argMap.end()) { QCC_LogError(ER_BUS_BAD_TRANSPORT_ARGS, ("TCPTransport::NormalizeListenSpec(): The mechanism implied by \"r6addr\" is not supported.")); argMap.erase(iter); } iter = argMap.find("r6port"); if (iter != argMap.end()) { QCC_LogError(ER_BUS_BAD_TRANSPORT_ARGS, ("TCPTransport::NormalizeListenSpec(): The mechanism implied by \"r6port\" is not supported.")); argMap.erase(iter); } iter = argMap.find("u6addr"); if (iter != argMap.end()) { QCC_LogError(ER_BUS_BAD_TRANSPORT_ARGS, ("TCPTransport::NormalizeListenSpec(): The mechanism implied by \"u6addr\" is not supported.")); argMap.erase(iter); } iter = argMap.find("u6port"); if (iter != argMap.end()) { QCC_LogError(ER_BUS_BAD_TRANSPORT_ARGS, ("TCPTransport::NormalizeListenSpec(): The mechanism implied by \"u6port\" is not supported.")); argMap.erase(iter); } /* * Now, begin normalizing what we want to see in a listen spec. * * All listen specs must start with the name of the transport followed by * a colon. */ outSpec = GetTransportName() + qcc::String(":"); /* * The TCP transport must absolutely support the IPv4 "reliable" mechanism * (TCP). We therefore must provide an addr either from explicit keys or * generated from the defaults. */ iter = argMap.find("iface"); /* * Now, deal with the iface. */ if (iter != argMap.end()) { outSpec.append("iface=" + iter->second); } else { iter = argMap.find("addr"); if (iter == argMap.end()) { /* * We have no value associated with an "addr" key. Do we have an * "r4addr" which would be synonymous? If so, save it as an addr, * erase it and point back to the new addr. */ iter = argMap.find("r4addr"); if (iter != argMap.end()) { argMap["addr"] = iter->second; argMap.erase(iter); } iter = argMap.find("addr"); } /* * Now, deal with the addr, possibly derived from r4addr. */ if (iter != argMap.end()) { /* * We have a value associated with the "addr" key. Run it through a * conversion function to make sure it's a valid value and to get into * in a standard representation. */ IPAddress addr; status = addr.SetAddress(iter->second, false); if (status == ER_OK) { /* * The addr had better be an IPv4 address, otherwise we bail. */ if (!addr.IsIPv4()) { QCC_LogError(ER_BUS_BAD_TRANSPORT_ARGS, ("TCPTransport::NormalizeListenSpec(): The addr \"%s\" is not a legal IPv4 address.", iter->second.c_str())); return ER_BUS_BAD_TRANSPORT_ARGS; } iter->second = addr.ToString(); outSpec.append("addr=" + addr.ToString()); } else { QCC_LogError(ER_BUS_BAD_TRANSPORT_ARGS, ("TCPTransport::NormalizeListenSpec(): The addr \"%s\" is not a legal IPv4 address.", iter->second.c_str())); return ER_BUS_BAD_TRANSPORT_ARGS; } } } if (iter == argMap.end()) { /* * We have no value associated with an "iface" or "addr" key. Use the default * network interface name for the outspec and create a new key for the map. */ outSpec.append("iface=" + qcc::String(INTERFACES_DEFAULT)); argMap["iface"] = INTERFACES_DEFAULT; } /* * The TCP transport must absolutely support the IPv4 "reliable" mechanism * (TCP). We therefore must provide an port either from explicit keys or * generated from the defaults. */ iter = argMap.find("port"); if (iter == argMap.end()) { /* * We have no value associated with a "port" key. Do we have a * "r4port" which would be synonymous? If so, save it as a port, * erase it and point back to the new port. */ iter = argMap.find("r4port"); if (iter != argMap.end()) { argMap["port"] = iter->second; argMap.erase(iter); } iter = argMap.find("port"); } /* * Now, deal with the port. */ if (iter != argMap.end()) { /* * We have a value associated with the "port" key. Run it through a * conversion function to make sure it's a valid value. We put it into * a 32 bit int to make sure it will actually fit into a 16-bit port * number. */ uint32_t port = StringToU32(iter->second); if (port <= 0xffff) { outSpec.append(",port=" + iter->second); } else { QCC_LogError(ER_BUS_BAD_TRANSPORT_ARGS, ("TCPTransport::NormalizeListenSpec(): The key \"port\" has a bad value \"%s\".", iter->second.c_str())); return ER_BUS_BAD_TRANSPORT_ARGS; } } else { /* * We have no value associated with an "port" key. Use the default * IPv4 listen port for the outspec and create a new key for the map. */ qcc::String portString = U32ToString(PORT_DEFAULT); outSpec += ",port=" + portString; argMap["port"] = portString; } return ER_OK; } QStatus TCPTransport::NormalizeTransportSpec(const char* inSpec, qcc::String& outSpec, map& argMap) const { QCC_DbgPrintf(("TCPTransport::NormalizeTransportSpec")); QStatus status; /* * Aside from the presence of the guid, the only fundamental difference * between a listenSpec and a transportSpec (actually a connectSpec) is that * a connectSpec must have a valid and specific address IP address to * connect to (i.e., INADDR_ANY isn't a valid IP address to connect to). * This means that we can just call NormalizeListenSpec to get everything * into standard form. */ status = NormalizeListenSpec(inSpec, outSpec, argMap); if (status != ER_OK) { return status; } /* * Since there is no guid present if we've fallen through to here, the only * difference between a connectSpec and a listenSpec is that a connectSpec * requires the presence of a non-default IP address. So we just check for * the default addresses and fail if we find one. */ map::iterator i = argMap.find("addr"); assert(i != argMap.end()); if ((i->second == ADDR4_DEFAULT)) { QCC_LogError(ER_BUS_BAD_TRANSPORT_ARGS, ("TCPTransport::NormalizeTransportSpec(): The addr may not be the default address.")); return ER_BUS_BAD_TRANSPORT_ARGS; } return ER_OK; } QStatus TCPTransport::Connect(const char* connectSpec, const SessionOpts& opts, BusEndpoint& newEp) { QCC_DbgHLPrintf(("TCPTransport::Connect(): %s", connectSpec)); /* * We are given a session options structure that defines the kind of * connection that is being sought. Can we support the connection being * requested? If not, don't even try. */ if (SupportsOptions(opts) == false) { QStatus status = ER_BUS_BAD_SESSION_OPTS; QCC_LogError(status, ("TCPTransport::Connect(): Supported options mismatch")); return status; } /* * We need to find the defaults for our connection limits. These limits * can be specified in the configuration database with corresponding limits * used for DBus. If any of those are present, we use them, otherwise we * provide some hopefully reasonable defaults. */ ConfigDB* config = ConfigDB::GetConfigDB(); /* * maxAuth is the maximum number of incoming connections that can be in * the process of authenticating. If starting to authenticate a new * connection would mean exceeding this number, we drop the new connection. */ uint32_t maxAuth = config->GetLimit("max_incomplete_connections", ALLJOYN_MAX_INCOMPLETE_CONNECTIONS_TCP_DEFAULT); /* * maxConn is the maximum number of active connections possible over the * TCP transport. If starting to process a new connection would mean * exceeding this number, we drop the new connection. */ uint32_t maxConn = config->GetLimit("max_completed_connections", ALLJOYN_MAX_COMPLETED_CONNECTIONS_TCP_DEFAULT); QStatus status; bool isConnected = false; /* * We only want to allow this call to proceed if we have a running server * accept thread that isn't in the process of shutting down. We use the * thread response from IsRunning to give us an idea of what our server * accept (Run) thread is doing. See the comment in Start() for details * about what IsRunning actually means, which might be subtly different from * your intuitition. * * If we see IsRunning(), the thread might actually have gotten a Stop(), * but has not yet exited its Run routine and become STOPPING. To plug this * hole, we need to check IsRunning() and also m_stopping, which is set in * our Stop() method. */ if (IsRunning() == false || m_stopping == true) { QCC_LogError(ER_BUS_TRANSPORT_NOT_STARTED, ("TCPTransport::Connect(): Not running or stopping; exiting")); return ER_BUS_TRANSPORT_NOT_STARTED; } /* * If we pass the IsRunning() gate above, we must have a server accept * thread spinning up or shutting down but not yet joined. Since the name * service is started before the server accept thread is spun up, and * deleted after it is joined, we must have a started name service or someone * isn't playing by the rules; so an assert is appropriate here. */ assert(IpNameService::Instance().Started() && "TCPTransport::Connect(): IpNameService not started"); /* * Parse and normalize the connectArgs. When connecting to the outside * world, there are no reasonable defaults and so the addr and port keys * MUST be present. */ qcc::String normSpec; map argMap; status = NormalizeTransportSpec(connectSpec, normSpec, argMap); if (ER_OK != status) { QCC_LogError(status, ("TCPTransport::Connect(): Invalid TCP connect spec \"%s\"", connectSpec)); return status; } /* * These fields (addr, port) Are all guaranteed to be present now and an * underlying network (even if it is Wi-Fi P2P) is assumed to be up and * functioning. */ assert(argMap.find("addr") != argMap.end() && "TCPTransport::Connect(): addr not present in argMap"); assert(argMap.find("port") != argMap.end() && "TCPTransport::Connect(): port not present in argMap"); IPAddress ipAddr(argMap.find("addr")->second); uint16_t port = StringToU32(argMap["port"]); /* * The semantics of the Connect method tell us that we want to connect to a * remote daemon. TCP will happily allow us to connect to ourselves, but * this is not always possible in the various transports AllJoyn may use. * To avoid unnecessary differences, we do not allow a requested connection * to "ourself" to succeed. * * The code here is not a failsafe way to prevent this since thre are going * to be multiple processes involved that have no knowledge of what the * other is doing (for example, the wireless supplicant and this daemon). * This means we can't synchronize and there will be race conditions that * can cause the tests for selfness to fail. The final check is made in the * bus hello protocol, which will abort the connection if it detects it is * conected to itself. We just attempt to short circuit the process where * we can and not allow connections to proceed that will be bound to fail. * * One defintion of a connection to ourself is if we find that a listener * has has been started via a call to our own StartListener() with the same * connectSpec as we have now. This is the simple case, but it also turns * out to be the uncommon case. * * It is perfectly legal to start a listener using the INADDR_ANY address, * which tells the system to listen for connections on any network interface * that happens to be up or that may come up in the future. This is the * default listen address and is the most common case. If this option has * been used, we expect to find a listener with a normalized adresss that * looks like "addr=0.0.0.0,port=y". If we detect this kind of connectSpec * we have to look at the currently up interfaces and see if any of them * match the address provided in the connectSpec. If so, we are attempting * to connect to ourself and we must fail that request. */ char anyspec[64]; snprintf(anyspec, sizeof(anyspec), "%s:addr=0.0.0.0,port=%u", GetTransportName(), port); qcc::String normAnySpec; map normArgMap; status = NormalizeListenSpec(anyspec, normAnySpec, normArgMap); if (ER_OK != status) { QCC_LogError(status, ("TCPTransport::Connect(): Invalid INADDR_ANY connect spec")); return status; } /* * Look to see if we are already listening on the provided connectSpec * either explicitly or via the INADDR_ANY address. */ QCC_DbgHLPrintf(("TCPTransport::Connect(): Checking for connection to self")); m_listenFdsLock.Lock(MUTEX_CONTEXT); bool anyEncountered = false; for (list >::iterator i = m_listenFds.begin(); i != m_listenFds.end(); ++i) { QCC_DbgHLPrintf(("TCPTransport::Connect(): Checking listenSpec %s", i->first.c_str())); /* * If the provided connectSpec is already explicitly listened to, it is * an error. */ if (i->first == normSpec) { m_listenFdsLock.Unlock(MUTEX_CONTEXT); QCC_DbgHLPrintf(("TCPTransport::Connect(): Explicit connection to self")); return ER_BUS_ALREADY_LISTENING; } /* * If we are listening to INADDR_ANY and the supplied port, then we have * to look to the currently UP interfaces to decide if this call is bogus * or not. Set a flag to remind us. */ if (i->first == normAnySpec) { QCC_DbgHLPrintf(("TCPTransport::Connect(): Possible implicit connection to self detected")); anyEncountered = true; } } m_listenFdsLock.Unlock(MUTEX_CONTEXT); /* * If we are listening to INADDR_ANY, we are going to have to see if any * currently UP interfaces have an address that matches the connectSpec * addr. */ if (anyEncountered) { QCC_DbgHLPrintf(("TCPTransport::Connect(): Checking for implicit connection to self")); std::vector entries; QStatus status = qcc::IfConfig(entries); /* * Only do the check for self-ness if we can get interfaces to check. * This is a non-fatal error since we know that there is an end-to-end * check happening in the bus hello exchange, so if there is a problem * it will simply be detected later. */ if (status == ER_OK) { /* * Loop through the network interface entries looking for an UP * interface that has the same IP address as the one we're trying to * connect to. We know any match on the address will be a hit since * we matched the port during the listener check above. Since we * have a listener listening on *any* UP interface on the specified * port, a match on the interface address with the connect address * is a hit. */ for (uint32_t i = 0; i < entries.size(); ++i) { QCC_DbgHLPrintf(("TCPTransport::Connect(): Checking interface %s", entries[i].m_name.c_str())); if (entries[i].m_flags & qcc::IfConfigEntry::UP) { QCC_DbgHLPrintf(("TCPTransport::Connect(): Interface UP with addresss %s", entries[i].m_addr.c_str())); IPAddress foundAddr(entries[i].m_addr); if (foundAddr == ipAddr) { QCC_DbgHLPrintf(("TCPTransport::Connect(): Attempted connection to self; exiting")); return ER_BUS_ALREADY_LISTENING; } } } } } static const bool falsiness = false; TCPTransport* ptr = this; AddressFamily family = QCC_AF_INET; SocketType type = QCC_SOCK_STREAM; TCPEndpoint tcpEp = TCPEndpoint(ptr, m_bus, falsiness, normSpec, family, type, ipAddr, port); /* * Before starting the underlying transport mechanism, we need to create * a TCPEndpoint object that will orchestrate the movement of data * across the transport. */ /* * On the active side of a connection, we don't need an authentication * thread to run since we have the caller thread to fill that role. */ tcpEp->SetActive(); /* * Initialize the "features" for this endpoint */ tcpEp->GetFeatures().isBusToBus = true; tcpEp->GetFeatures().allowRemote = m_bus.GetInternal().AllowRemoteMessages(); tcpEp->GetFeatures().handlePassing = false; tcpEp->GetFeatures().nameTransfer = opts.nameTransfer; /* * Check any application connecting over TCP to see if it is running on the same machine and * set the group ID appropriately if so. */ CheckEndpointLocalMachine(tcpEp); qcc::String authName; qcc::String redirection; /* * This is a little tricky. We usually manage endpoints in one place * using the main server accept loop thread. Endpoints read and write data * by using a callback mechanism implemented using IODispatch and these * callbacks are expected to be made regularly until the EndpointExit function * is called when the endpoints are stopped. The general endpoint management uses these * mechanisms. However, we are about to get into a state where we are * off trying to start an endpoint, but we are using another thread * which has called into TCPTransport::Connect(). We are about to do * blocking I/O in the authentication establishment dance, but we can't * just kill off this thread since it isn't ours for the whacking. If * the transport is stopped, we do however need a way to stop an * in-process establishment. It's not reliable to just close a socket * out from uder a thread, so we really need to Alert() the thread * making the blocking calls. So we keep a separate list of Thread* * that may need to be Alert()ed and run through that list when the * transport is stopping. This will cause the I/O calls in Establish() * to return and we can then allow the "external" threads to return * and avoid nasty deadlocks. */ Thread* thread = GetThread(); m_endpointListLock.Lock(MUTEX_CONTEXT); m_activeEndpointsThreadList.insert(thread); /* * Go ahead and do the authentication in the context of this thread. Even * though we don't have the server accept loop thread watching this endpoint * we keep we keep the states consistent since the endpoint will eventually * to there. */ DaemonRouter& router = reinterpret_cast(m_bus.GetInternal().GetRouter()); AuthListener* authListener = router.GetBusController()->GetAuthListener(); QCC_DbgPrintf(("TCPTransport::Connect(): maxAuth == %d", maxAuth)); QCC_DbgPrintf(("TCPTransport::Connect(): maxConn == %d", maxConn)); QCC_DbgPrintf(("TCPTransport::Connect(): mAuthList.size() == %d", m_authList.size())); QCC_DbgPrintf(("TCPTransport::Connect(): mEndpointList.size() == %d", m_endpointList.size())); /* Ensure that the connection limits for TCPEndpoints have not been hit. */ if ((m_authList.size() < maxAuth) && (m_authList.size() + m_endpointList.size() < maxConn)) { m_authList.insert(tcpEp); status = ER_OK; } else { QCC_LogError(status, ("TCPTransport::Connect(): No slot for new connection")); /* Remove this thread from the m_activeEndpointsThreadList */ set::iterator i = find(m_activeEndpointsThreadList.begin(), m_activeEndpointsThreadList.end(), thread); assert(i != m_activeEndpointsThreadList.end() && "TCPTransport::Connect(): Thread* not on m_activeEndpointsThreadList"); m_activeEndpointsThreadList.erase(i); m_endpointListLock.Unlock(MUTEX_CONTEXT); return ER_CONNECTION_LIMIT_EXCEEDED; } m_endpointListLock.Unlock(); status = tcpEp->m_stream.SetNagle(false); if (status == ER_OK) { /* * We got a socket, created an endpoint and inserted it into the m_authList, * now tell TCP to connect to the remote address and * port. */ String addrStr = ipAddr.ToString(); status = tcpEp->m_stream.Connect(addrStr, port); if (status == ER_OK) { /* * We now have a TCP connection established, but DBus (the wire * protocol which we are using) requires that every connection, * irrespective of transport, start with a single zero byte. This * is so that the Unix-domain socket transport used by DBus can pass * SCM_RIGHTS out-of-band when that byte is sent. */ uint8_t nul = 0; size_t sent; status = tcpEp->m_stream.PushBytes(&nul, 1, sent); if (status != ER_OK) { QCC_LogError(status, ("TCPTransport::Connect(): Failed to send initial NUL byte")); } isConnected = true; } else { QCC_LogError(status, ("TCPTransport::Connect(): Failed")); } } if (status == ER_OK) { status = tcpEp->Establish("ANONYMOUS", authName, redirection, authListener); if (status == ER_OK) { tcpEp->SetListener(this); tcpEp->SetEpStarting(); status = tcpEp->Start(m_defaultHbeatIdleTimeout, m_defaultHbeatProbeTimeout, m_numHbeatProbes, m_maxHbeatProbeTimeout); if (status == ER_OK) { tcpEp->SetEpStarted(); tcpEp->SetAuthDone(); } else { tcpEp->SetEpFailed(); tcpEp->SetAuthDone(); } } /* * If we have a successful authentication, we pass the connection off to the * server accept loop to manage. */ if (status == ER_OK) { m_endpointListLock.Lock(MUTEX_CONTEXT); m_authList.erase(tcpEp); m_endpointList.insert(tcpEp); m_endpointListLock.Unlock(MUTEX_CONTEXT); newEp = BusEndpoint::cast(tcpEp); } } if (status != ER_OK) { if (isConnected) { tcpEp->m_stream.Close(); } m_endpointListLock.Lock(MUTEX_CONTEXT); m_authList.erase(tcpEp); m_endpointListLock.Unlock(); /* If we got this connection and its endpoint up without * a problem, we return a pointer to the new endpoint. We aren't going to * clean it up since it is an active connection, so we can safely pass the * endoint back up to higher layers. * Invalidate the endpoint in case of error. */ newEp->Invalidate(); } /* * In any case, we are done with blocking I/O on the current thread, so * we need to remove its pointer from the list we kept around to break it * out of blocking I/O. If we were successful, the TCPEndpoint was passed * to the m_endpointList, where the main server accept loop will deal with * it using its Read and WriteCallback-based mechanisms. If we were unsuccessful * the TCPEndpoint was destroyed and we will return an error below after * cleaning up the underlying socket. */ m_endpointListLock.Lock(MUTEX_CONTEXT); set::iterator i = find(m_activeEndpointsThreadList.begin(), m_activeEndpointsThreadList.end(), thread); assert(i != m_activeEndpointsThreadList.end() && "TCPTransport::Connect(): Thread* not on m_activeEndpointsThreadList"); m_activeEndpointsThreadList.erase(i); m_endpointListLock.Unlock(MUTEX_CONTEXT); m_dynamicScoreUpdater.Alert(); return status; } QStatus TCPTransport::StartListen(const char* listenSpec) { QCC_DbgPrintf(("TCPTransport::StartListen()")); /* * We only want to allow this call to proceed if we have a running server * accept thread that isn't in the process of shutting down. We use the * thread response from IsRunning to give us an idea of what our server * accept (Run) thread is doing. See the comment in Start() for details * about what IsRunning actually means, which might be subtly different from * your intuitition. * * If we see IsRunning(), the thread might actually have gotten a Stop(), * but has not yet exited its Run routine and become STOPPING. To plug this * hole, we need to check IsRunning() and also m_stopping, which is set in * our Stop() method. */ if (IsRunning() == false || m_stopping == true) { QCC_LogError(ER_BUS_TRANSPORT_NOT_STARTED, ("TCPTransport::StartListen(): Not running or stopping; exiting")); return ER_BUS_TRANSPORT_NOT_STARTED; } /* * Normalize the listen spec. Although this looks like a connectSpec it is * different in that reasonable defaults are possible. We do the * normalization here so we can report an error back to the caller. */ qcc::String normSpec; map argMap; QStatus status = NormalizeListenSpec(listenSpec, normSpec, argMap); if (status != ER_OK) { QCC_LogError(status, ("TCPTransport::StartListen(): Invalid TCP listen spec \"%s\"", listenSpec)); return status; } /* * We allow the listen request to be specified with either * a network interface name or an IP address. */ qcc::String key = ""; if (argMap.find("iface") != argMap.end()) { key = "iface"; } else if (argMap.find("addr") != argMap.end()) { key = "addr"; } QCC_DbgPrintf(("TCPTransport::StartListen(): %s = \"%s\", port = \"%s\"", key.c_str(), argMap[key].c_str(), argMap["port"].c_str())); /* * Because we are sending a *request* to start listening on a given * normalized listen spec to another thread, and the server thread starts * and stops listening on given listen specs when it decides to eventually * run, it is be possible for a calling thread to send multiple requests to * start or stop listening on the same listenSpec before the server thread * responds. * * In order to deal with these two timelines, we keep a list of normalized * listenSpecs that we have requested to be started, and not yet requested * to be removed. This list (the mListenSpecs) must be consistent with * client requests to start and stop listens. This list is not necessarily * consistent with what is actually being listened on. That is a separate * list called mListenFds. * * So, check to see if someone has previously requested that the address and * port in question be listened on. We need to do this here to be able to * report an error back to the caller. */ m_listenSpecsLock.Lock(MUTEX_CONTEXT); for (list::iterator i = m_listenSpecs.begin(); i != m_listenSpecs.end(); ++i) { if (*i == normSpec) { m_listenSpecsLock.Unlock(MUTEX_CONTEXT); return ER_BUS_ALREADY_LISTENING; } } m_listenSpecsLock.Unlock(MUTEX_CONTEXT); QueueStartListen(normSpec); return ER_OK; } void TCPTransport::QueueStartListen(qcc::String& normSpec) { QCC_DbgPrintf(("TCPTransport::QueueStartListen()")); /* * In order to start a listen, we send the server accept thread a message * containing the START_LISTEN_INSTANCE request code and the normalized * listen spec which specifies the address and port instance to listen on. */ ListenRequest listenRequest; listenRequest.m_requestOp = START_LISTEN_INSTANCE; listenRequest.m_requestParam = normSpec; m_listenRequestsLock.Lock(MUTEX_CONTEXT); /* Process the request */ RunListenMachine(listenRequest); m_listenRequestsLock.Unlock(MUTEX_CONTEXT); } QStatus TCPTransport::DoStartListen(qcc::String& normSpec) { QCC_DbgPrintf(("TCPTransport::DoStartListen()")); /* * Since the name service is created before the server accept thread is spun * up, and stopped when it is stopped, we must have a started name service or * someone isn't playing by the rules; so an assert is appropriate here. */ assert(IpNameService::Instance().Started() && "TCPTransport::DoStartListen(): IpNameService not started"); qcc::String interfaces = ConfigDB::GetConfigDB()->GetProperty("ns_interfaces"); if (interfaces.size()) { QCC_LogError(ER_WARNING, ("TCPTransport::DoStartListen(): The mechanism implied by \"ns_interfaces\" is no longer supported.")); } /* * Parse the normalized listen spec. The easiest way to do this is to * re-normalize it. If there's an error at this point, we have done * something wrong since the listen spec was presumably successfully * normalized before sending it in -- so we assert. */ qcc::String spec; map argMap; QStatus status = NormalizeListenSpec(normSpec.c_str(), spec, argMap); assert(status == ER_OK && "TCPTransport::DoStartListen(): Invalid TCP listen spec"); qcc::String key = ""; if (argMap.find("iface") != argMap.end()) { key = "iface"; } else if (argMap.find("addr") != argMap.end()) { key = "addr"; } QCC_DbgPrintf(("TCPTransport::DoStartListen(): %s = \"%s\", port = \"%s\"", key.c_str(), argMap[key].c_str(), argMap["port"].c_str())); /* * If we're going to listen on an address, we are going to listen on a * corresponding network interface. We need to convince the name service * to send advertisements out over that interface, or nobody will know to * connect to the listening daemon. * * So, we need to get the configuration item telling us which network * interfaces we should run the name service over and listen on. The * name service waits until it finds the specified interface IFF_UP and * multicast capable with an assigned IP address and then starts using * the interface. If the configuration item contains "*" (the wildcard) * it is interpreted as meaning all multicast-capable interfaces. If the * configuration item is empty (not assigned in the configuration database) * it defaults to "*". */ /* * We have been given a listenSpec that provides an iface or addr and a port * in the parameters to this method. We are expected to listen on that * network interface's primary IPv4 address and port for inbound connections. * The name service will also advertise and discover over this network interface. * * We can either be given the wildcard iface "*", a specific network * interface name, the default address "0.0.0.0" or a specific address. * If given "*" or "0.0.0.0", this means that the TCP Transport will * listen for inbound connections on the INADDR_ANY address and the name * service will advertise and discover over any currently IFF_UP interface * or any interface that may come IFF_UP in the future. * * If given a network interface name, the TCP Transport will listen for * inbound connections on the current primary IPv4 address of that network * interface and the name service will advertise and discover over that * network interface. * * If given a specific address, the TCP Transport will listen for * inbound connections on the specified address and the name service * will advertise and discover over the underlying network interface * as long as it retains that address. * * iface Action * -------- ----------------------------------------- * 1. * Listen on 0.0.0.0 and advertise/discover * over '*'. This is the default case where * the system listens on all interfaces and * advertises / discovers on all interfaces. * This is the "speak alljoyn over all of * your interfaces" situation. * * 2. 'specific' Listen only on the primary address of the * named netowrk interface and advertise and * discover over that specific interface. * This may not be exactly what is desired, * but it may be. We do what we are told. * Note that by doing this, one is limiting * the number of daemons that can be run on * a host using the same address and port * to one. Other daemons configured this * way must select another port. This is * how we expect people to limit AllJoyn to * talking only over a specific interface. * This allows that interface to change IP * addresses on the fly. This reqires the * interface name to be known a-priori but * does not require the IP address of the * network interface named 'specific' to be * known a-priori. * * address Action * -------- ----------------------------------------- * 1. 0.0.0.0 Listen on 0.0.0.0 and advertise/discover * over '*'. This is the default case where * the system listens on all interfaces and * advertises / discovers on all interfaces. * This is the "speak alljoyn over all of * your interfaces" situation. * * 2. 'a.b.c.d' Listen only on the specified address if * or when it appears on the network and * advertise and discover over the * underlying interface for that address, * so long as it retains the address. * This may not be exactly what is desired, * but it may be. We do what we are told. * Note that by doing this, one is limiting * the number of daemons that can be run on * a host using the same address and port * to one. Other daemons configured this * way must select another port. * * This is much harder to describe than to implement; but the upshot is * that we listen on the primary IPv4 address of the named network interface * that comes in with the listenSpec and we enable the name service on that * same interface. It is up to the person doing the configuration to * understand what he or she is trying to do and the impact of choosing those values. */ uint16_t listenPort = StringToU32(argMap["port"]); qcc::String interface = ""; qcc::IPAddress addr; if (argMap.find("iface") != argMap.end()) { interface = argMap["iface"]; } if (argMap.find("addr") != argMap.end()) { addr = IPAddress(argMap["addr"]); } /* We first determine whether a network interface name or an IP * address was specified and then we invoke the appropriate name * service method. */ if (!interface.empty()) { m_requestedInterfaces[interface] = qcc::IPEndpoint("0.0.0.0", listenPort); m_listenPortMap[interface] = listenPort; } else if (addr.Size() && addr.IsIPv4()) { m_requestedAddresses[addr.ToString()] = ""; m_requestedAddressPortMap[addr.ToString()] = listenPort; } if (!interface.empty()) { status = IpNameService::Instance().OpenInterface(TRANSPORT_TCP, interface); } else if (addr.Size() && addr.IsIPv4()) { status = IpNameService::Instance().OpenInterface(TRANSPORT_TCP, addr.ToString()); } if (status != ER_OK) { QCC_LogError(status, ("TCPTransport::DoStartListen(): OpenInterface() failed for %s", (interface.empty() ? addr.ToString().c_str() : interface.c_str()))); } return status; } void TCPTransport::UntrustedClientExit() { /* An untrusted client has exited, update the counts and re-enable the advertisement if necessary. */ m_listenRequestsLock.Lock(); if (m_numUntrustedClients >= 0) { m_numUntrustedClients--; QCC_DbgPrintf((" TCPTransport::UntrustedClientExit() m_numUntrustedClients=%d m_maxRemoteClientsTcp=%d", m_numUntrustedClients, m_maxRemoteClientsTcp)); } m_listenRequestsLock.Unlock(); m_dynamicScoreUpdater.Alert(); } QStatus TCPTransport::UntrustedClientStart() { /* An untrusted client Establish has finished, so update the counts and disable the advertisement if necessary */ QStatus status = ER_OK; m_listenRequestsLock.Lock(); m_numUntrustedClients++; QCC_DbgPrintf((" TCPTransport::UntrustedClientStart() m_numUntrustedClients=%d m_maxRemoteClientsTcp=%d", m_numUntrustedClients, m_maxRemoteClientsTcp)); if (m_numUntrustedClients > m_maxRemoteClientsTcp) { /* This could happen in the following situation: * The max untrusted clients is set to 1. Two untrusted clients try to * connect to this daemon at the same time. When the 2nd one * finishes the EndpointAuth::Establish, it will call into this method * and hit this case and will be rejected. */ status = ER_BUS_NOT_ALLOWED; m_numUntrustedClients--; } m_listenRequestsLock.Unlock(); m_dynamicScoreUpdater.Alert(); return status; } QStatus TCPTransport::StopListen(const char* listenSpec) { QCC_DbgPrintf(("TCPTransport::StopListen()")); /* * We only want to allow this call to proceed if we have a running server * accept thread that isn't in the process of shutting down. We use the * thread response from IsRunning to give us an idea of what our server * accept (Run) thread is doing. See the comment in Start() for details * about what IsRunning actually means, which might be subtly different from * your intuitition. * * If we see IsRunning(), the thread might actually have gotten a Stop(), * but has not yet exited its Run routine and become STOPPING. To plug this * hole, we need to check IsRunning() and also m_stopping, which is set in * our Stop() method. */ if (IsRunning() == false || m_stopping == true) { QCC_LogError(ER_BUS_TRANSPORT_NOT_STARTED, ("TCPTransport::StopListen(): Not running or stopping; exiting")); return ER_BUS_TRANSPORT_NOT_STARTED; } /* * Normalize the listen spec. We are going to use the name string that was * put together for the StartListen call to find the listener instance to * stop, so we need to do it exactly the same way. */ qcc::String normSpec; map argMap; QStatus status = NormalizeListenSpec(listenSpec, normSpec, argMap); if (status != ER_OK) { QCC_LogError(status, ("TCPTransport::StopListen(): Invalid TCP listen spec \"%s\"", listenSpec)); return status; } /* * Because we are sending a *request* to stop listening on a given * normalized listen spec to another thread, and the server thread starts * and stops listening on given listen specs when it decides to eventually * run, it is be possible for a calling thread to send multiple requests to * start or stop listening on the same listenSpec before the server thread * responds. * * In order to deal with these two timelines, we keep a list of normalized * listenSpecs that we have requested to be started, and not yet requested * to be removed. This list (the mListenSpecs) must be consistent with * client requests to start and stop listens. This list is not necessarily * consistent with what is actually being listened on. That is reflected by * a separate list called mListenFds. * * We consult the list of listen spects for duplicates when starting to * listen, and we make sure that a listen spec is on the list before * queueing a request to stop listening. Asking to stop listening on a * listen spec we aren't listening on is not an error, since the goal of the * user is to not listen on a given address and port -- and we aren't. */ m_listenSpecsLock.Lock(MUTEX_CONTEXT); for (list::iterator i = m_listenSpecs.begin(); i != m_listenSpecs.end(); ++i) { if (*i == normSpec) { m_listenSpecs.erase(i); QueueStopListen(normSpec); break; } } m_listenSpecsLock.Unlock(MUTEX_CONTEXT); return ER_OK; } void TCPTransport::QueueStopListen(qcc::String& normSpec) { QCC_DbgPrintf(("TCPTransport::QueueStopListen()")); /* * In order to stop a listen, we send the server accept thread a message * containing the STOP_LISTEN_INTANCE request code and the normalized listen * spec which specifies the address and port instance to stop listening on. */ ListenRequest listenRequest; listenRequest.m_requestOp = STOP_LISTEN_INSTANCE; listenRequest.m_requestParam = normSpec; m_listenRequestsLock.Lock(MUTEX_CONTEXT); /* Process the request */ RunListenMachine(listenRequest); m_listenRequestsLock.Unlock(MUTEX_CONTEXT); } void TCPTransport::DoStopListen(qcc::String& normSpec) { QCC_DbgPrintf(("TCPTransport::DoStopListen()")); /* * Since the name service is started before the server accept thread is spun * up, and stopped after it is stopped, we must have a started name service or * someone isn't playing by the rules; so an assert is appropriate here. */ assert(IpNameService::Instance().Started() && "TCPTransport::DoStopListen(): IpNameService not started"); /* * Find the (single) listen spec and remove it from the list of active FDs * used by the server accept loop (run thread). */ m_listenFdsLock.Lock(MUTEX_CONTEXT); qcc::SocketFd stopFd = qcc::INVALID_SOCKET_FD; bool found = false; for (list >::iterator i = m_listenFds.begin(); i != m_listenFds.end(); ++i) { if (i->first == normSpec) { stopFd = i->second; m_listenFds.erase(i); found = true; break; } } if (found) { if (m_reload != STATE_EXITED) { /* If the TCPTransport::Run thread is still running, set m_reload to * STATE_RELOADING, unlock the mutex, alert the main Run thread that * there is a change and wait for the Run thread to finish any connections * it may be accepting and then reload the set of events. */ m_reload = STATE_RELOADING; Alert(); /* Wait until TCPTransport::Run thread has reloaded the * set of events or exited. */ while (m_reload == STATE_RELOADING) { m_listenFdsLock.Unlock(MUTEX_CONTEXT); qcc::Sleep(2); m_listenFdsLock.Lock(MUTEX_CONTEXT); } } /* * If we took a socketFD off of the list of active FDs, we need to tear it * down. */ qcc::SetLinger(stopFd, true, 0); qcc::Shutdown(stopFd); qcc::Close(stopFd); } m_listenFdsLock.Unlock(MUTEX_CONTEXT); } bool TCPTransport::NewDiscoveryOp(DiscoveryOp op, qcc::String namePrefix, bool& isFirst) { QCC_DbgPrintf(("TCPTransport::NewDiscoveryOp()")); bool first = false; if (op == ENABLE_DISCOVERY) { QCC_DbgPrintf(("TCPTransport::NewDiscoveryOp(): Registering discovery of namePrefix \"%s\"", namePrefix.c_str())); first = m_discovering.empty(); if (find(m_discovering.begin(), m_discovering.end(), namePrefix) == m_discovering.end()) { m_discovering.push_back(namePrefix); } } else { list::iterator i = find(m_discovering.begin(), m_discovering.end(), namePrefix); if (i == m_discovering.end()) { QCC_DbgPrintf(("TCPTransport::NewDiscoveryOp(): Cancel of non-existent namePrefix \"%s\"", namePrefix.c_str())); } else { QCC_DbgPrintf(("TCPTransport::NewDiscoveryOp(): Unregistering discovery of namePrefix \"%s\"", namePrefix.c_str())); m_discovering.erase(i); } } isFirst = first; return m_discovering.empty(); } bool TCPTransport::NewAdvertiseOp(AdvertiseOp op, qcc::String name, bool& isFirst) { QCC_DbgPrintf(("TCPTransport::NewAdvertiseOp()")); bool first = false; if (op == ENABLE_ADVERTISEMENT) { QCC_DbgPrintf(("TCPTransport::NewAdvertiseOp(): Registering advertisement of namePrefix \"%s\"", name.c_str())); first = m_advertising.empty(); if (find(m_advertising.begin(), m_advertising.end(), name) == m_advertising.end()) { m_advertising.push_back(name); } } else { list::iterator i = find(m_advertising.begin(), m_advertising.end(), name); if (i == m_advertising.end()) { QCC_DbgPrintf(("TCPTransport::NewAdvertiseOp(): Cancel of non-existent name \"%s\"", name.c_str())); } else { QCC_DbgPrintf(("TCPTransport::NewAdvertiseOp(): Unregistering advertisement of namePrefix \"%s\"", name.c_str())); m_advertising.erase(i); } } isFirst = first; return m_advertising.empty(); } bool TCPTransport::NewListenOp(ListenOp op, qcc::String normSpec) { QCC_DbgPrintf(("TCPTransport::NewListenOp()")); if (op == START_LISTEN) { QCC_DbgPrintf(("TCPTransport::NewListenOp(): Registering listen of normSpec \"%s\"", normSpec.c_str())); m_listening.push_back(normSpec); } else { list::iterator i = find(m_listening.begin(), m_listening.end(), normSpec); if (i == m_listening.end()) { QCC_DbgPrintf(("TCPTransport::NewAdvertiseOp(): StopListen of non-existent spec \"%s\"", normSpec.c_str())); } else { QCC_DbgPrintf(("TCPTransport::NewAdvertiseOp(): StopListen of normSpec \"%s\"", normSpec.c_str())); m_listening.erase(i); } } return m_listening.empty(); } void TCPTransport::EnableDiscovery(const char* namePrefix, TransportMask transports) { QCC_DbgPrintf(("TCPTransport::EnableDiscovery()")); /* * We only want to allow this call to proceed if we have a running server * accept thread that isn't in the process of shutting down. We use the * thread response from IsRunning to give us an idea of what our server * accept (Run) thread is doing. See the comment in Start() for details * about what IsRunning actually means, which might be subtly different from * your intuitition. * * If we see IsRunning(), the thread might actually have gotten a Stop(), * but has not yet exited its Run routine and become STOPPING. To plug this * hole, we need to check IsRunning() and also m_stopping, which is set in * our Stop() method. */ if (IsRunning() == false || m_stopping == true) { QCC_LogError(ER_BUS_TRANSPORT_NOT_STARTED, ("TCPTransport::EnableDiscovery(): Not running or stopping; exiting")); return; } QueueEnableDiscovery(namePrefix, transports); } void TCPTransport::QueueEnableDiscovery(const char* namePrefix, TransportMask transports) { QCC_DbgPrintf(("TCPTransport::QueueEnableDiscovery()")); ListenRequest listenRequest; listenRequest.m_requestOp = ENABLE_DISCOVERY_INSTANCE; listenRequest.m_requestParam = namePrefix; listenRequest.m_requestTransportMask = transports; m_listenRequestsLock.Lock(MUTEX_CONTEXT); /* Process the request */ RunListenMachine(listenRequest); m_listenRequestsLock.Unlock(MUTEX_CONTEXT); } void TCPTransport::DisableDiscovery(const char* namePrefix, TransportMask transports) { QCC_DbgPrintf(("TCPTransport::DisableDiscovery()")); /* * We only want to allow this call to proceed if we have a running server * accept thread that isn't in the process of shutting down. We use the * thread response from IsRunning to give us an idea of what our server * accept (Run) thread is doing. See the comment in Start() for details * about what IsRunning actually means, which might be subtly different from * your intuitition. * * If we see IsRunning(), the thread might actually have gotten a Stop(), * but has not yet exited its Run routine and become STOPPING. To plug this * hole, we need to check IsRunning() and also m_stopping, which is set in * our Stop() method. */ if (IsRunning() == false || m_stopping == true) { QCC_LogError(ER_BUS_TRANSPORT_NOT_STARTED, ("TCPTransport::DisbleDiscovery(): Not running or stopping; exiting")); return; } QueueDisableDiscovery(namePrefix, transports); } void TCPTransport::QueueDisableDiscovery(const char* namePrefix, TransportMask transports) { QCC_DbgPrintf(("TCPTransport::QueueDisableDiscovery()")); ListenRequest listenRequest; listenRequest.m_requestOp = DISABLE_DISCOVERY_INSTANCE; listenRequest.m_requestParam = namePrefix; listenRequest.m_requestTransportMask = transports; m_listenRequestsLock.Lock(MUTEX_CONTEXT); /* Process the request */ RunListenMachine(listenRequest); m_listenRequestsLock.Unlock(MUTEX_CONTEXT); } QStatus TCPTransport::EnableAdvertisement(const qcc::String& advertiseName, bool quietly, TransportMask transports) { QCC_DbgPrintf(("TCPTransport::EnableAdvertisement()")); /* * We only want to allow this call to proceed if we have a running server * accept thread that isn't in the process of shutting down. We use the * thread response from IsRunning to give us an idea of what our server * accept (Run) thread is doing. See the comment in Start() for details * about what IsRunning actually means, which might be subtly different from * your intuitition. * * If we see IsRunning(), the thread might actually have gotten a Stop(), * but has not yet exited its Run routine and become STOPPING. To plug this * hole, we need to check IsRunning() and also m_stopping, which is set in * our Stop() method. */ if (IsRunning() == false || m_stopping == true) { QCC_LogError(ER_BUS_TRANSPORT_NOT_STARTED, ("TCPTransport::EnableAdvertisement(): Not running or stopping; exiting")); return ER_BUS_TRANSPORT_NOT_STARTED; } QueueEnableAdvertisement(advertiseName, quietly, transports); return ER_OK; } void TCPTransport::QueueEnableAdvertisement(const qcc::String& advertiseName, bool quietly, TransportMask transports) { QCC_DbgPrintf(("TCPTransport::QueueEnableAdvertisement()")); ListenRequest listenRequest; listenRequest.m_requestOp = ENABLE_ADVERTISEMENT_INSTANCE; listenRequest.m_requestParam = advertiseName; listenRequest.m_requestParamOpt = quietly; listenRequest.m_requestTransportMask = transports; m_listenRequestsLock.Lock(MUTEX_CONTEXT); /* Process the request */ RunListenMachine(listenRequest); m_listenRequestsLock.Unlock(MUTEX_CONTEXT); } void TCPTransport::DisableAdvertisement(const qcc::String& advertiseName, TransportMask transports) { QCC_DbgPrintf(("TCPTransport::DisableAdvertisement()")); /* * We only want to allow this call to proceed if we have a running server * accept thread that isn't in the process of shutting down. We use the * thread response from IsRunning to give us an idea of what our server * accept (Run) thread is doing. See the comment in Start() for details * about what IsRunning actually means, which might be subtly different from * your intuitition. * * If we see IsRunning(), the thread might actually have gotten a Stop(), * but has not yet exited its Run routine and become STOPPING. To plug this * hole, we need to check IsRunning() and also m_stopping, which is set in * our Stop() method. */ if (IsRunning() == false || m_stopping == true) { QCC_LogError(ER_BUS_TRANSPORT_NOT_STARTED, ("TCPTransport::DisableAdvertisement(): Not running or stopping; exiting")); return; } QueueDisableAdvertisement(advertiseName, transports); } void TCPTransport::QueueDisableAdvertisement(const qcc::String& advertiseName, TransportMask transports) { QCC_DbgPrintf(("TCPTransport::QueueDisableAdvertisement()")); ListenRequest listenRequest; listenRequest.m_requestOp = DISABLE_ADVERTISEMENT_INSTANCE; listenRequest.m_requestParam = advertiseName; listenRequest.m_requestTransportMask = transports; m_listenRequestsLock.Lock(MUTEX_CONTEXT); /* Process the request */ RunListenMachine(listenRequest); m_listenRequestsLock.Unlock(MUTEX_CONTEXT); } void TCPTransport::UpdateRouterAdvertisementAndDynamicScore() { QCC_DbgPrintf(("TCPTransport::UpdateRouterAdvertisementAndDynamicScore()")); /* * We only want to allow this call to proceed if we have a running server * accept thread that isn't in the process of shutting down. We use the * thread response from IsRunning to give us an idea of what our server * accept (Run) thread is doing. See the comment in Start() for details * about what IsRunning actually means, which might be subtly different from * your intuitition. * * If we see IsRunning(), the thread might actually have gotten a Stop(), * but has not yet exited its Run routine and become STOPPING. To plug this * hole, we need to check IsRunning() and also m_stopping, which is set in * our Stop() method. */ if (IsRunning() == false || m_stopping == true) { QCC_DbgPrintf(("TCPTransport::UpdateRouterAdvertisementAndDynamicScore(): Not running or stopping; exiting")); return; } QueueUpdateRouterAdvertisementAndDynamicScore(); } void TCPTransport::QueueUpdateRouterAdvertisementAndDynamicScore() { QCC_DbgPrintf(("TCPTransport::QueueUpdateRouterAdvertisementAndDynamicScore()")); ListenRequest updateScoreListenRequest; updateScoreListenRequest.m_requestOp = UPDATE_DYNAMIC_SCORE_INSTANCE; ListenRequest enableAdvListenRequest; enableAdvListenRequest.m_requestOp = ENABLE_ADVERTISEMENT_INSTANCE; enableAdvListenRequest.m_requestParam = routerName; enableAdvListenRequest.m_requestParamOpt = true; enableAdvListenRequest.m_requestTransportMask = TRANSPORT_TCP; ListenRequest disableAdvListenRequest; disableAdvListenRequest.m_requestOp = DISABLE_ADVERTISEMENT_INSTANCE; disableAdvListenRequest.m_requestParam = routerName; disableAdvListenRequest.m_requestTransportMask = TRANSPORT_TCP; m_listenRequestsLock.Lock(MUTEX_CONTEXT); /* Process the request(s) */ RunListenMachine(updateScoreListenRequest); if (EnableRouterAdvertisement()) { RunListenMachine(enableAdvListenRequest); m_routerNameAdvertised = true; } else if (DisableRouterAdvertisement()) { RunListenMachine(disableAdvListenRequest); m_routerNameAdvertised = false; } m_listenRequestsLock.Unlock(MUTEX_CONTEXT); } void TCPTransport::FoundCallback::Found(const qcc::String& busAddr, const qcc::String& guid, std::vector& nameList, uint32_t timer) { QCC_DbgPrintf(("TCPTransport::FoundCallback::Found(): busAddr = \"%s\"", busAddr.c_str())); /* * Whenever the name service receives a message indicating that a bus-name * is out on the network somewhere, it sends a message back to us via this * callback. In order to avoid duplication of effort, the name service does * not manage a cache of names, but delegates that to the daemon having this * transport. If the timer parameter is non-zero, it indicates that the * nameList (actually a vector of bus-name Strings) can be expected to be * valid for the value of timer in seconds. If timer is zero, it means that * the bus names in the nameList are no longer available and should be * flushed out of the daemon name cache. * * The name service does not have a cache and therefore cannot time out * entries, but also delegates that task to the daemon. It is expected that * remote daemons will send keepalive messages that the local daemon will * recieve, also via this callback. Since we are just a go-between, we * pretty much just pass what we find on back to the daemon, modulo some * filtering to avoid situations we don't yet support: * * 1. Currently this transport has no clue how to handle anything but * reliable IPv4 endpoints (addr, port), so we filter everything else * out (by removing the unsupported endpoints from the bus address) */ qcc::String addr("addr="); qcc::String port("port="); qcc::String comma(","); /* * Find where the addr name starts. */ size_t i = busAddr.find(addr); if (i == String::npos) { QCC_DbgPrintf(("TCPTransport::FoundCallback::Found(): No addr in busaddr.")); return; } i += addr.size(); /* * We assume that the address is always followed by the port so there must * be a comma following the address. */ size_t j = busAddr.find(comma, i); if (j == String::npos) { QCC_DbgPrintf(("TCPTransport::FoundCallback::Found(): No comma after addr in busaddr.")); return; } size_t k = busAddr.find(port); if (k == String::npos) { QCC_DbgPrintf(("TCPTransport::FoundCallback::Found(): No port in busaddr.")); return; } k += port.size(); size_t l = busAddr.find(comma, k); if (l == String::npos) { l = busAddr.size(); } /* * We have the following situation now. Either: * * "addr=192.168.1.1,port=9955,addr=fe80::1260:4bff:fe74:5de9,port=9955" * ^ ^ ^ ^ * i j k l = 30 * * or * * "addr=192.168.1.1,port=9955" * ^ ^ ^ ^ * i j k l = 30 * * So construct a new bus address with only the reliable IPv4 part pulled * out. */ qcc::String newBusAddr = String("tcp:") + addr + busAddr.substr(i, j - i) + "," + port + busAddr.substr(k, l - k); QCC_DbgPrintf(("TCPTransport::FoundCallback::Found(): newBusAddr = \"%s\".", newBusAddr.c_str())); /* * Let AllJoyn know that we've found a service(s). */ if (m_listener) { QCC_DbgPrintf(("TCPTransport::FoundCallback::Found(): FoundNames(): %s", newBusAddr.c_str())); m_listener->FoundNames(newBusAddr, guid, TRANSPORT_TCP, &nameList, timer); } } void TCPTransport::NetworkEventCallback::Handler(const std::map& ifMap) { QCC_DbgPrintf(("TCPTransport::NetworkEventCallback::Handler()")); /* * We only want to allow this call to proceed if we have a running server * accept thread that isn't in the process of shutting down. We use the * thread response from IsRunning to give us an idea of what our server * accept (Run) thread is doing. See the comment in Start() for details * about what IsRunning actually means, which might be subtly different from * your intuitition. * * If we see IsRunning(), the thread might actually have gotten a Stop(), * but has not yet exited its Run routine and become STOPPING. To plug this * hole, we need to check IsRunning() and also m_stopping, which is set in * our Stop() method. */ if (m_transport.IsRunning() == false || m_transport.m_stopping == true) { QCC_LogError(ER_BUS_TRANSPORT_NOT_STARTED, ("TCPTransport::NetworkEventCallback::Handler(): Not running or stopping; exiting")); return; } m_transport.QueueHandleNetworkEvent(ifMap); } void TCPTransport::QueueHandleNetworkEvent(const std::map& ifMap) { QCC_DbgPrintf(("TCPTransport::QueueHandleNetworkEvent()")); ListenRequest listenRequest; listenRequest.m_requestOp = HANDLE_NETWORK_EVENT; listenRequest.ifMap = ifMap; m_listenRequestsLock.Lock(MUTEX_CONTEXT); /* Process the request */ RunListenMachine(listenRequest); m_listenRequestsLock.Unlock(MUTEX_CONTEXT); } /* This is the callback handler that is invoked when the name service detects that a network interface * has become IFF_UP or a network interface's IP address has changed. When we invoke the OpenInterface() * method of the name service from the DoStartListen() method, it will also trigger the name service to * refresh the set of interfaces and invoke this callback to get things started. On network events, a map * of interfaces to IP addresses that have changed is provided. Whenever OpenInterface() is called, a map * of interfaces to IP addresses for all the interfaces that are currently up is provided. Note that this * handler may also be invoked because another transport called the OpenInterface() method of the name * service and one or more of the interfaces requested by this transport has become IFF_UP. */ void TCPTransport::HandleNetworkEventInstance(ListenRequest& listenRequest) { QCC_DbgTrace(("TCPTransport::HandleNetworkEventInstance()")); std::map& ifMap = listenRequest.ifMap; QStatus status = ER_OK; list replacedList; list > addedList; bool wildcardIfaceRequested = (m_requestedInterfaces.find("*") != m_requestedInterfaces.end()); bool wildcardAddressRequested = (m_requestedAddresses.find("0.0.0.0") != m_requestedAddresses.end()); /* If we don't have any interfaces or addresses that we are required to listen on then we return. * If a wildcard interface or wildcard address was specified, once we have processed the request * we no longer care about dynamic changes to the state of the network interfaces since we are * listening on IN_ADDR_ANY at this point so we return. */ if ((m_requestedInterfaces.empty() && m_requestedAddresses.empty()) || ((wildcardIfaceRequested && m_wildcardIfaceProcessed) || (wildcardAddressRequested && m_wildcardAddressProcessed))) { return; } /* * We walk through the list of interfaces that have changed in some way provided to us by the name service. * For each interface, we check if that interface is one of the interfaces specified in the configuration * database. If we don't have a wildcard interface or wildcard address in the configuration database and * the current interface's network interface name or IP address is not specified in the configuration * database, then we proceed to the next interface in the list. If the current interface's network name * is in the configuration database and its IP address has not changed we proceed to the next interface. * Similarly, if a network IP address still corresponds to the same network interface we proceed to the * next interface in the list. At this point, we check if the change in IP address for a network interface * is a change from the default address "0.0.0.0". If it is, then this is the first time we are learning of * the actual IP address of the specified interface. If it isn't, then this is a previously known interface * that has just changed its IP address. We save a copy of its listen spec so that we can stop listening on * the old IP address once we start listening on the new IP address. If we find an address has previously * been specified in the configuration database, we remove that entry so that we only listen on the port * specified by a network interface name if both network interface and IP address is specified for the same * interface. We then update the IP address to the current one for that network interface. Similarly, if * we are learning of a specified IP address's network name for the first time we update our records. If we * have a wildcard in the configuration database that we have not yet processed, we process it the first time * while walking the list of interfaces and return. */ for (std::map::const_iterator it = ifMap.begin(); it != ifMap.end(); it++) { qcc::String interface = it->first; qcc::IPAddress address = it->second; qcc::String addressStr = address.ToString(); bool currentIfaceRequested = (m_requestedInterfaces.find(interface) != m_requestedInterfaces.end()); bool currentAddressRequested = (m_requestedAddresses.find(addressStr) != m_requestedAddresses.end()); if (!wildcardIfaceRequested && !wildcardAddressRequested && !currentIfaceRequested && !currentAddressRequested) { continue; } if (!wildcardIfaceRequested && currentIfaceRequested && m_requestedInterfaces[interface].GetAddress() == address) { continue; } if (!wildcardAddressRequested && currentAddressRequested && m_requestedAddresses[addressStr] == interface) { continue; } if (!wildcardIfaceRequested && currentIfaceRequested) { if (m_requestedInterfaces[interface].GetAddress() != qcc::IPAddress("0.0.0.0")) { qcc::String replacedSpec = "tcp:addr=" + m_requestedInterfaces[interface].GetAddress().ToString() + ",port=" + U32ToString(m_requestedInterfaces[interface].GetPort()); if (m_requestedAddresses.find(m_requestedInterfaces[interface].GetAddress().ToString()) != m_requestedAddresses.end()) { m_requestedAddresses.erase(m_requestedInterfaces[interface].GetAddress().ToString()); } replacedList.push_back(replacedSpec); } m_requestedInterfaces[interface] = qcc::IPEndpoint(address, m_requestedInterfaces[interface].GetPort()); } if (!wildcardAddressRequested && currentAddressRequested) { if (!m_requestedAddresses[addressStr].empty()) { m_requestedAddresses[addressStr] = interface; continue; } m_requestedAddresses[addressStr] = interface; } qcc::IPAddress listenAddr; uint16_t listenPort = 0; if (wildcardIfaceRequested) { listenAddr = qcc::IPAddress("0.0.0.0"); listenPort = m_requestedInterfaces["*"].GetPort(); } else if (wildcardAddressRequested) { listenAddr = qcc::IPAddress("0.0.0.0"); listenPort = m_requestedAddressPortMap["0.0.0.0"]; } else { if (!listenAddr.Size() && currentIfaceRequested) { listenAddr = m_requestedInterfaces[interface].GetAddress(); listenPort = m_requestedInterfaces[interface].GetPort(); } else if (!listenAddr.Size() && currentAddressRequested) { listenAddr = address; listenPort = m_requestedAddressPortMap[addressStr]; } else { continue; } } if (!listenAddr.Size() || !listenAddr.IsIPv4()) { continue; } /* * We have the name service work out of the way, so we can now create the * TCP listener sockets and set SO_REUSEADDR/SO_REUSEPORT so we don't have * to wait for four minutes to relaunch the daemon if it crashes. */ SocketFd listenFd = INVALID_SOCKET_FD; status = Socket(QCC_AF_INET, QCC_SOCK_STREAM, listenFd); if (status != ER_OK) { continue; } /* * Set the SO_REUSEADDR socket option so we don't have to wait for four * minutes while the endpoint is in TIME_WAIT if we crash (or control-C). */ status = qcc::SetReuseAddress(listenFd, true); if (status != ER_OK && status != ER_NOT_IMPLEMENTED) { qcc::Close(listenFd); continue; } /* * We call accept in a loop so we need the listenFd to be non-blocking. */ status = qcc::SetBlocking(listenFd, false); if (status != ER_OK) { qcc::Close(listenFd); continue; } /* * Bind the socket to the listen address and start listening for incoming * connections on it. */ status = Bind(listenFd, listenAddr, listenPort); if (status == ER_OK) { /* * If the port was set to zero then we will have bound an ephemeral port. If * so call GetLocalAddress() to update the connect spec with the port allocated by bind. */ if (listenPort == 0) { qcc::GetLocalAddress(listenFd, listenAddr, listenPort); } if (wildcardIfaceRequested) { m_requestedInterfaces["*"] = qcc::IPEndpoint("0.0.0.0", listenPort); } else if (wildcardAddressRequested) { m_requestedAddressPortMap["0.0.0.0"] = listenPort; } else { if (currentIfaceRequested) { m_requestedInterfaces[interface] = qcc::IPEndpoint(m_requestedInterfaces[interface].GetAddress().ToString(), listenPort); } else if (currentAddressRequested) { m_requestedAddressPortMap[addressStr] = listenPort; } } qcc::String normSpec = "tcp:addr=" + listenAddr.ToString() + ",port=" + U32ToString(listenPort); status = qcc::Listen(listenFd, MAX_LISTEN_CONNECTIONS); /* We make a list of the new listen specs on which we are listening so * that we can add those to the m_listenFds when we're done procesing * the list of network interfaces. */ if (status == ER_OK) { addedList.push_back(pair(normSpec, listenFd)); } else { QCC_LogError(status, ("TCPTransport::HandleNetworkEventInstance(): Listen failed")); } } else { QCC_LogError(status, ("TCPTransport::HandleNetworkEventInstance(): Failed to bind to %s/%d", listenAddr.ToString().c_str(), listenPort)); } /* We update the map of interface names to port numbers * here to account for ephemeral ports since only at * this point do we know the actual ephemeral port number * after we call Bind() and are actually listening. */ if (wildcardIfaceRequested) { m_listenPortMap["*"] = listenPort; } else if (wildcardAddressRequested) { m_listenPortMap["0.0.0.0"] = listenPort; } else { if (currentIfaceRequested) { m_listenPortMap[interface] = listenPort; } else if (currentAddressRequested) { m_listenPortMap[addressStr] = listenPort; } } /* * The IP name service is very flexible about what to advertise. It assumes * that a so-called transport is going to be doing the advertising. An IP * transport, by definition, has a reliable data transmission capability and * an unreliable data transmission capability. In the IP world, reliable * data is sent using TCP and unreliable data is sent using UDP (the Packet * Engine in the AllJoyn world). Also, IP implies either IPv4 or IPv6 * addressing. * * In the TCPTransport, we only support reliable data transfer over IPv4 * addresses, so we leave all of the other possibilities turned off (provide * a zero port). Remember the port we enabled so we can re-enable the name * service if listeners come and go. */ IpNameService::Instance().Enable(TRANSPORT_TCP, m_listenPortMap, 0, std::map(), 0, true, false, false, false); /* * There is a special case in which we respond to embedded AllJoyn bus * attachements actively looking for daemons to connect to. We don't want * do blindly do this all the time so we can pass the Android Compatibility * Test, so we crank up an advertisement when we do the start listen (which * is why we bother to do all of the serialization of DoStartListen work * anyway). We make this a configurable advertisement so users of bundled * daemons can change the advertisement and know they are connecting to * "their" daemons if desired. * * We pull the advertisement prefix out of the configuration and if it is * there, we append the short GUID of the daemon to make it unique and then * advertise it quietly via the IP name service. The quietly option means * that we do not send gratuitous is-at (advertisements) of the name, but we * do respond to who-has requests on the name. */ ConfigDB* config = ConfigDB::GetConfigDB(); uint32_t maxConn = config->GetLimit("max_completed_connections", ALLJOYN_MAX_COMPLETED_CONNECTIONS_TCP_DEFAULT); if (EnableRouterAdvertisement()) { bool isFirst; NewAdvertiseOp(ENABLE_ADVERTISEMENT, routerName, isFirst); uint32_t availConn = maxConn - (m_authList.size() + m_endpointList.size()); uint32_t availRemoteClientsTcp = m_maxRemoteClientsTcp - m_numUntrustedClients; availRemoteClientsTcp = std::min(availRemoteClientsTcp, availConn); IpNameService::Instance().UpdateDynamicScore(TRANSPORT_TCP, availConn, maxConn, availRemoteClientsTcp, m_maxRemoteClientsTcp); QStatus status = IpNameService::Instance().AdvertiseName(TRANSPORT_TCP, routerName, true, TRANSPORT_TCP); m_routerNameAdvertised = true; if (status != ER_OK) { QCC_LogError(status, ("TCPTransport::HandleNetworkEventInstance(): Failed to AdvertiseNameQuietly \"%s\"", routerName.c_str())); } m_isAdvertising = true; } m_isListening = true; m_isNsEnabled = true; /* If we have a wildcard specified in the configuration database, we want to stop * listening on all the non-wildcard addresses/ports we may have previously opened * and so we add all of those listen specs to the replaced list so we can stop * listening on those addresses/ports and just listen on IN_ADDR_ANY alone. We * also ensure that our listenPortMap only has a wildcard entry. */ if (wildcardIfaceRequested) { m_wildcardIfaceProcessed = true; for (std::map::const_iterator iter = m_requestedInterfaces.begin(); iter != m_requestedInterfaces.end(); iter++) { if (iter->first != "*" && iter->second.GetAddress() != qcc::IPAddress("0.0.0.0")) { qcc::String replacedSpec = "tcp:addr=" + m_requestedInterfaces[iter->first].GetAddress().ToString() + ",port=" + U32ToString(m_requestedInterfaces[iter->first].GetPort()); m_listenPortMap.erase(iter->first); replacedList.push_back(replacedSpec); } } m_requestedInterfaces.clear(); m_requestedAddresses.clear(); m_requestedAddressPortMap.clear(); m_requestedInterfaces["*"] = qcc::IPEndpoint("0.0.0.0", listenPort); break; } else if (wildcardAddressRequested) { m_wildcardAddressProcessed = true; for (std::map::const_iterator iter = m_requestedAddresses.begin(); iter != m_requestedAddresses.end(); iter++) { if (iter->first != "0.0.0.0" && !iter->second.empty()) { qcc::String replacedSpec = "tcp:addr=" + iter->first + ",port=" + U32ToString(m_listenPortMap[iter->first]); m_listenPortMap.erase(iter->first); replacedList.push_back(replacedSpec); } } m_requestedAddresses.clear(); m_requestedAddressPortMap.clear(); m_requestedAddresses["0.0.0.0"] = "*"; break; } } /* We add the listen specs to the m_listenFds at this point */ m_listenFdsLock.Lock(MUTEX_CONTEXT); if (!addedList.empty()) { for (list >::iterator it = addedList.begin(); it != addedList.end(); it++) { m_listenFds.push_back(*it); } } /* * Signal the (probably) waiting run thread so it will wake up and add this * new socket to its list of sockets it is waiting for connections on. */ m_listenFdsLock.Unlock(MUTEX_CONTEXT); Alert(); /* * We stop listening on all the listen specs that were replaced during the processing. * These listen specs usually represent the old IP addresses that are no longer in use. * In addition, if the last advertisement or discovery request was cancelled before * the relevant network interfaces became IFF_UP, we also stop listening. */ if (m_advertising.empty() && m_discovering.empty()) { for (list >::iterator it = addedList.begin(); it != addedList.end(); it++) { replacedList.push_back(it->first); } IpNameService::Instance().Enable(TRANSPORT_TCP, m_listenPortMap, 0, std::map(), 0, false, false, false, false); m_isListening = false; m_isNsEnabled = false; m_listenPortMap.clear(); m_pendingDiscoveries.clear(); m_pendingAdvertisements.clear(); m_wildcardIfaceProcessed = false; } for (list::iterator it = replacedList.begin(); it != replacedList.end(); it++) { DoStopListen(*it); } /* * If there were pending advertisements that came in before the network interfaces * became IFF_UP, we enable those pending advertisements. */ for (list::iterator it = m_pendingAdvertisements.begin(); it != m_pendingAdvertisements.end(); it++) { EnableAdvertisementInstance(*it); } m_pendingAdvertisements.clear(); /* * If there were pending discoveries that came in before the network interfaces * became IFF_UP, we enable those pending discoveries. */ for (list::iterator it = m_pendingDiscoveries.begin(); it != m_pendingDiscoveries.end(); it++) { EnableDiscoveryInstance(*it); } m_pendingDiscoveries.clear(); } void TCPTransport::CheckEndpointLocalMachine(TCPEndpoint endpoint) { #ifdef QCC_OS_GROUP_WINDOWS String ipAddrStr; endpoint->GetRemoteIp(ipAddrStr); std::vector entries; IfConfig(entries); for (uint32_t i = 0; i < entries.size(); i++) { if (ipAddrStr == entries[i].m_addr) { endpoint->SetGroupId(GetUsersGid(DESKTOP_APPLICATION)); break; } } #endif } ThreadReturn STDCALL TCPTransport::DynamicScoreUpdater::Run(void* arg) { QCC_UNUSED(arg); while (!IsStopping()) { Event::Wait(Event::neverSet); GetStopEvent().ResetEvent(); m_transport.UpdateRouterAdvertisementAndDynamicScore(); } return 0; } } // namespace ajn alljoyn-15.04b/alljoyn_core/router/TCPTransport.h000066400000000000000000001027571255700255500220730ustar00rootroot00000000000000/** * @file * TCPTransport is a specialization of class Transport for daemons talking over * TCP. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_TCPTRANSPORT_H #define _ALLJOYN_TCPTRANSPORT_H #ifndef __cplusplus #error Only include TCPTransport.h in C++ code. #endif #include #include #include #include #include #include #include #include #include #include #include #include "Transport.h" #include "RemoteEndpoint.h" #include "ns/IpNameService.h" namespace ajn { class _TCPEndpoint; typedef qcc::ManagedObj<_TCPEndpoint> TCPEndpoint; /** * @brief A class for TCP Transports used in daemons. * * The TCPTransport class has different incarnations depending on whether or not * an instantiated endpoint using the transport resides in a daemon, or in the * case of Windows, on a service or client. The differences between these * versions revolves around routing and discovery. This class provides a * specialization of class Transport for use by daemons. */ class TCPTransport : public Transport, public _RemoteEndpoint::EndpointListener, public qcc::Thread { friend class _TCPEndpoint; public: class DynamicScoreUpdater : public qcc::Thread { public: DynamicScoreUpdater(TCPTransport& transport) : m_transport(transport) { }; virtual qcc::ThreadReturn STDCALL Run(void* arg); private: TCPTransport& m_transport; }; friend class DynamicScoreUpdater; /** * Create a TCP based transport for use by daemons. * * @param bus The BusAttachment associated with this endpoint */ TCPTransport(BusAttachment& bus); /** * Destructor */ virtual ~TCPTransport(); /** * Start the transport and associate it with a router. * * @return * - ER_OK if successful. * - an error status otherwise. */ QStatus Start(); /** * Stop the transport. * * @return * - ER_OK if successful. * - an error status otherwise. */ QStatus Stop(); /** * Pend the caller until the transport stops. * * @return * - ER_OK if successful * - an error status otherwise. */ QStatus Join(); /** * Determine if this transport is running. Running means Start() has been called. * * @return Returns true if the transport is running. */ bool IsRunning() { return Thread::IsRunning(); } /** * @internal * @brief Normalize a transport specification. * * Given a transport specification, convert it into a form which is guaranteed to * have a one-to-one relationship with a connection instance. * * @param inSpec Input transport connect spec. * @param outSpec Output transport connect spec. * @param argMap Parsed parameter map. * * @return ER_OK if successful. */ QStatus NormalizeTransportSpec(const char* inSpec, qcc::String& outSpec, std::map& argMap) const; /** * Connect to a specified remote AllJoyn/DBus address. * * @param connectSpec Transport specific key/value args used to configure the client-side endpoint. * The form of this string is @c ":=,=..." * @param opts Requested sessions opts. * @param newep [OUT] Endpoint created as a result of successful connect. * @return * - ER_OK if successful. * - an error status otherwise. */ QStatus Connect(const char* connectSpec, const SessionOpts& opts, BusEndpoint& newep); /** * Start listening for incomming connections on a specified bus address. * * @param listenSpec Transport specific key/value arguments that specify the physical interface to listen on. * - Valid transport is @c "tcp". All others ignored. * - Valid keys are: * - @c addr = IP address of server to connect to. * - @c port = Port number of server to connect to. * * @return * - ER_OK if successful. * - an error status otherwise. */ QStatus StartListen(const char* listenSpec); /** * @brief Stop listening for incomming connections on a specified bus address. * * This method cancels a StartListen request. Therefore, the listenSpec must * match previous call to StartListen(). * * @param listenSpec Transport specific key/value arguments that specify the physical interface to listen on. * - Valid transport is @c "tcp". All others ignored. * - Valid keys are: * - @c addr = IP address of server to connect to. * - @c port = Port number of server to connect to. * * @return * - ER_OK if successful. * - an error status otherwise. */ QStatus StopListen(const char* listenSpec); /** * Set a listener for transport related events. There can only be one * listener set at a time. Setting a listener implicitly removes any * previously set listener. * * @param listener Listener for transport related events. */ void SetListener(TransportListener* listener) { m_listener = listener; } /** * @internal * @brief Start discovering busses. */ void EnableDiscovery(const char* namePrefix, TransportMask transports); /** * @internal * @brief Stop discovering busses. */ void DisableDiscovery(const char* namePrefix, TransportMask transports); /** * Start advertising a well-known name with a given quality of service. * * @param advertiseName Well-known name to add to list of advertised names. * @param quietly Advertise the name quietly * @return * - ER_OK if successful. * - an error status otherwise. */ QStatus EnableAdvertisement(const qcc::String& advertiseName, bool quietly, TransportMask completetransports); /** * Stop advertising a well-known name with a given quality of service. * * @param advertiseName Well-known name to remove from list of advertised names. */ void DisableAdvertisement(const qcc::String& advertiseName, TransportMask completetransports); bool EnableRouterAdvertisement(); bool DisableRouterAdvertisement(); void UpdateDynamicScore(); void UpdateRouterAdvertisementAndDynamicScore(); /** * Returns the name of this transport */ const char* GetTransportName() const { return TransportName; } /** * Get the transport mask for this transport * * @return the TransportMask for this transport. */ TransportMask GetTransportMask() const { return TRANSPORT_TCP; } /** * Get a list of the possible listen specs of the current Transport for a * given set of session options. * * Session options specify high-level characteristics of session, such as * whether or not the underlying transport carries data encapsulated in * AllJoyn messages, and whether or not delivery is reliable. * * It is possible that there is more than one answer to the question: what * abstract address should I use when talking to another endpoint. Each * Transports is equipped to understand how many answers there are and also * which answers are better than the others. This method fills in the * provided vector with a list of currently available busAddresses ordered * according to which the transport thinks would be best. * * If there are no addresses appropriate to the given session options the * provided vector of String is left unchanged. If there are addresses, * they are added at the end of the provided vector. * * @param opts Session options describing the desired characteristics of * an underlying session * @param busAddrs A vector of String to which bus addresses corresponding * to IFF_UP interfaces matching the desired characteristics * are added. * @return * - ER_OK if successful. * - an error status otherwise. */ QStatus GetListenAddresses(const SessionOpts& opts, std::vector& busAddrs) const; /** * Does this transport support connections as described by the provided * Session options. * * @param opts Proposed session options. * @return * - true if the SessionOpts specifies a supported option set. * - false otherwise. */ bool SupportsOptions(const SessionOpts& opts) const; /** * Indicates whether this transport is used for client-to-bus or bus-to-bus connections. * * @return Always returns true, TCP is a bus-to-bus transport. */ bool IsBusToBus() const { return true; } /** * Callback for TCPEndpoint exit. * * @param endpoint TCPEndpoint instance that has exited. */ void EndpointExit(RemoteEndpoint& endpoint); /** * Name of transport used in transport specs. */ static const char* TransportName; private: /** * Empty private overloaded virtual function for Thread::Start * this avoids the overloaded-virtual warning. For the Thread::Start * function. */ QStatus Start(void* arg, qcc::ThreadListener* listener) { return Thread::Start(arg, listener); } TCPTransport(const TCPTransport& other); TCPTransport& operator =(const TCPTransport& other); /** * This function will check the given endpoint to see if it is running on the same machine or not * by comparing the connecting IP address with the local machine's addresses. If there is a match * then this app is running on the local machine. Windows Universal Applications aren't allowed * to use the loopback interface so this must be a Desktop Application, set the group ID * accordingly. Since this code is only needed on Windows it is inside #ifdef * QCC_OS_GROUP_WINDOWS. * * @param endpoint The endpoint to check and set the group ID on */ static void CheckEndpointLocalMachine(TCPEndpoint endpoint); BusAttachment& m_bus; /**< The message bus for this transport */ bool m_stopping; /**< True if Stop() has been called but endpoints still exist */ bool m_routerNameAdvertised; /**< True if routerName is advertised */ TransportListener* m_listener; /**< Registered TransportListener */ std::set m_authList; /**< List of authenticating endpoints */ std::set m_endpointList; /**< List of active endpoints */ std::set m_activeEndpointsThreadList; /**< List of threads starting up active endpoints */ qcc::Mutex m_endpointListLock; /**< Mutex that protects the endpoint and auth lists */ std::list > m_listenFds; /**< File descriptors the transport is listening on */ qcc::Mutex m_listenFdsLock; /**< Mutex that protects m_listenFds */ std::list m_listenSpecs; /**< Listen specs clients have requested us to listen on */ qcc::Mutex m_listenSpecsLock; /**< Mutex that protects m_listenSpecs */ std::list m_discovering; /**< Name prefixes the transport is looking for */ std::list m_advertising; /**< Names the transport is advertising */ std::list m_listening; /**< ListenSpecs on which the transport is listening */ qcc::Mutex m_discoLock; /**< Mutex that protects discovery and advertisement lists */ /** * @internal * @brief Commmand codes sent to the server accept loop thread. */ enum RequestOp { START_LISTEN_INSTANCE, /**< A StartListen() has happened */ STOP_LISTEN_INSTANCE, /**< A StopListen() has happened */ ENABLE_ADVERTISEMENT_INSTANCE, /**< An EnableAdvertisement() has happened */ DISABLE_ADVERTISEMENT_INSTANCE, /**< A DisableAdvertisement() has happened */ ENABLE_DISCOVERY_INSTANCE, /**< An EnableDiscovery() has happened */ DISABLE_DISCOVERY_INSTANCE, /**< A DisableDiscovery() has happened */ HANDLE_NETWORK_EVENT, /**< A network event has happened */ UPDATE_DYNAMIC_SCORE_INSTANCE /**< A change to the dynamic score has happened */ }; /** * @internal * @brief Request code for communicating StartListen, StopListen requests * and started-advertising and stopped-advertising notifications to the * server accept loop thread. */ class ListenRequest { public: RequestOp m_requestOp; qcc::String m_requestParam; bool m_requestParamOpt; TransportMask m_requestTransportMask; std::map ifMap; }; qcc::Mutex m_listenRequestsLock; /**< Mutex that protects m_listenRequests */ /** * @internal * @brief Manage the list of endpoints for the transport. */ void ManageEndpoints(qcc::Timespec authTimeout, qcc::Timespec sessionSetupTimeout); /** * @internal * @brief Thread entry point. * * @param arg Unused thread entry arg. */ qcc::ThreadReturn STDCALL Run(void* arg); /** * @internal * @brief Queue a StartListen request for the server accept loop * * The server accept loop (executing in TCPTransport::Run() uses the * socket FD resources that are used to listen on the endpoints specified * by the listenSpec parameters. Creation and deletion of these resources * then happen with the involvement of two threads. * * In order to serialize the creation, deletion and use of these resources * we only change them in one place -- in the server accept loop. This * means that we need to queue requests to start and stop listening on a * given listen spec to the accept loop thread. * * The sequence of events for StartListen() is then: * * 1. The client calls StartListen(). * 2. StartListen() calls QueueStartListen() to send a request to the * server accept loop thread. * 3. The server accept loop thread picks up the request and calls * DoStartListen() which allocates the resources. * * A similar sequence happens for StopListen(). * * @param listenSpec A String containing the string specifying the address * and port to listen on. * * @see QueueStartListen * @see DoStartListen * @see StopListen */ void QueueStartListen(qcc::String& listenSpec); /** * @internal @brief Perform the work required for a StartListen request * (doing it in the context of the server accept loop thread) * * @param listenSpec A String containing the string specifying the address * and port to listen on. * * @see StartListen * @see QueueStartListen */ QStatus DoStartListen(qcc::String& listenSpec); /** * @internal * @brief Queue a StopListen request for the server accept loop * * The server accept loop (executing in TCPTransport::Run() uses the * socket FD resources that are used to listen on the endpoints specified * by the listenSpec parameters. Creation and deletion of these resources * then happen with the involvement of two threads. * * In order to serialize the creation, deletion and use of these resources * we only change them in one place -- the server accept loop. This means * that we need to queue requests to start and stop listening on a given * listen spec to the accept loop thread. * * The sequence of events for StopListen() is then: * * 1. The client calls StopListen(). * 2. StopListen() calls QueueStopListen() to send a request to the * server accept loop thread. * 3. The server accept loop thread picks up the request and calls * DoStopListen() which allocates the resources. * * A similar sequence happens for StartListen(). * * @param listenSpec A String containing the string specifying the address * and port to stop listening on. * * @see QueueStopListen * @see DoStopListen * @see StartListen */ void QueueStopListen(qcc::String& listenSpec); /** * @internal @brief Perform the work required for a StopListen request * (doing it in the context of the server accept loop thread) * * @param listenSpec A String containing the string specifying the address * and port to stop listening on. * * @see StopListen * @see QueueStopListen */ void DoStopListen(qcc::String& listenSpec); void QueueHandleNetworkEvent(const std::map&); /** * @internal * @brief Authentication complete notificiation. * * @param conn Reference to the TCPEndpoint that completed authentication. */ void Authenticated(TCPEndpoint& conn); /** * @internal * @brief Normalize a listen specification. * * Given a listen specification (which is the same as a transport * specification but with relaxed semantics allowing defaults), convert * it into a form which is guaranteed to have a one-to-one relationship * with a listener instance. * * @param inSpec Input transport connect spec. * @param outSpec Output transport connect spec. * @param argMap Parsed parameter map. * * @return ER_OK if successful. */ QStatus NormalizeListenSpec(const char* inSpec, qcc::String& outSpec, std::map& argMap) const; class FoundCallback { public: FoundCallback(TransportListener*& listener) : m_listener(listener) { } void Found(const qcc::String& busAddr, const qcc::String& guid, std::vector& nameList, uint32_t timer); private: /* Private assigment operator - does nothing */ FoundCallback operator=(const FoundCallback&); TransportListener*& m_listener; }; FoundCallback m_foundCallback; /**< Called by IpNameService when new busses are discovered */ class NetworkEventCallback { public: NetworkEventCallback(TCPTransport& transport) : m_transport(transport) { } void Handler(const std::map&); private: /* Private assigment operator - does nothing */ NetworkEventCallback operator=(const NetworkEventCallback&); TCPTransport& m_transport; }; NetworkEventCallback m_networkEventCallback; /**< Called by IpNameService when new network interfaces come up */ /** * @brief The default timeout for in-process authentications. * * The authentication process can be used as the basis of a denial of * service attack by simply stopping in mid-authentication. If an * authentication takes longer than this number of milliseconds, it may be * summarily aborted if another connection comes in. This value can be * overridden in the config file by setting "auth_timeout". */ static const uint32_t ALLJOYN_AUTH_TIMEOUT_DEFAULT = 20000; /** * @brief The default timeout for session establishment following authentication. * * The session establishment process can be used as the basis of a denial of * service attack by simply not sending the AttachSession. If the session * establishment takes longer than this number of milliseconds, it may be * summarily aborted if another connection comes in. This value can be * overridden in the config file by setting "session_setup_timeout". The 30 second * number comes from the the timeout used for AttachSession method calls which is * 30 seconds. */ static const uint32_t ALLJOYN_SESSION_SETUP_TIMEOUT_DEFAULT = 30000; /** * @brief The default value for the maximum number of authenticating * connections. * * This corresponds to the configuration item "max_incomplete_connections" * in the DBus configuration, but it applies only to the TCP transport. To * override this value, change the limit, "max_incomplete_connections_tcp". * Typically, DBus sets this value to 10,000 which is essentially infinite * from the perspective of a phone. Since this represents a transient state * in connection establishment, there should be few connections in this * state, so we default to a quite low number. */ static const uint32_t ALLJOYN_MAX_INCOMPLETE_CONNECTIONS_TCP_DEFAULT = 10; /** * @brief The default value for the maximum number of TCP connections * (remote endpoints). * * This corresponds to the configuration item "max_completed_connections" * in the DBus configuration, but it applies only to the TCP transport. * To override this value, change the limit, "max_completed_connections_tcp". * Typically, DBus sets this value to 100,000 which is essentially infinite * from the perspective of a phone. Since we expect bus topologies to be * relatively small, we default to a quite low number. * * @warning This maximum is enforced on incoming connections only. An * AllJoyn daemon is free to form as many outbound connections as it pleases * but if the total number of connections exceeds this value, no inbound * connections will be accepted. This is because we are defending against * attacks from "abroad" and trust ourselves implicitly. */ static const uint32_t ALLJOYN_MAX_COMPLETED_CONNECTIONS_TCP_DEFAULT = 50; /** * @brief The default value for the maximum number of remote clients using tcp. * * This corresponds to the configuration item "max_remote_clients_tcp" * To override this value, change the limit, "max_remote_clients_tcp". * * @warning This maximum is enforced on incoming connections from untrusted clients over tcp. * This is to limit the amount of resources being used by untrusted clients over tcp. */ static const uint32_t ALLJOYN_MAX_REMOTE_CLIENTS_TCP_DEFAULT = 0; /** * @brief The default value for the router advertisement prefix that untrusted thin clients * will use for the discovery of the daemon. * * This corresponds to the configuration item "router_advertisement_prefix" * To override this value, change the limit, "router_advertisement_prefix". * */ static const char* const ALLJOYN_DEFAULT_ROUTER_ADVERTISEMENT_PREFIX; /** * @brief The default values for range and default idle timeout for TCPTransport in seconds. * * This corresponds to the configuration items "tcp_min_idle_timeout", * "tcp_max_idle_timeout" and "tcp_default_idle_timeout" * To override this value, change the limit, "tcp_min_idle_timeout", * "tcp_max_idle_timeout" and "tcp_default_idle_timeout" */ static const uint32_t MIN_HEARTBEAT_IDLE_TIMEOUT_DEFAULT = 3; static const uint32_t MAX_HEARTBEAT_IDLE_TIMEOUT_DEFAULT = 30; static const uint32_t DEFAULT_HEARTBEAT_IDLE_TIMEOUT_DEFAULT = 20; /** * @brief The default probe timeout for TCPTransport in seconds. * * This corresponds to the configuration item "tcp_default_probe_timeout" * and "tcp_max_probe_timeout" * To override this value, change the limit, "tcp_default_probe_timeout" * and "tcp_max_probe_timeout" */ static const uint32_t MAX_HEARTBEAT_PROBE_TIMEOUT_DEFAULT = 30; static const uint32_t DEFAULT_HEARTBEAT_PROBE_TIMEOUT_DEFAULT = 3; /** * @brief The number of DBus pings sent from Routing node to leaf node. * */ static const uint32_t HEARTBEAT_NUM_PROBES = 1; /* * The Android Compatibility Test Suite (CTS) is used by Google to enforce a * common idea of what it means to be Android. One of their tests is to * make sure there are no TCP or UDP listeners in running processes when the * phone is idle. Since we want to be able to run our daemon on idle phones * and manufacturers want their Android phones to pass the CTS, we have got * to be able to shut off our listeners unless they are actually required. * * To do this, we need to keep track of whether or not the daemon is * actively advertising or discovering. To this end, we keep track of the * advertise and discover calls, and if there are any outstanding (not * canceled) we enable the Name Service to talk to the outside world. If * there are no outstanding operations, we tell the Name Service to shut up. * * There is nothing preventing us from receiving multiple identical * discovery and advertisement requests, so we allow multiple instances of * an identical name on the list. We could reference count the entries, but * this seems like a relatively rare condition, so we take the * straightforward approach. */ enum DiscoveryOp { ENABLE_DISCOVERY, /**< A request to start a discovery has been received */ DISABLE_DISCOVERY /**< A request to cancel a discovery has been received */ }; enum AdvertiseOp { ENABLE_ADVERTISEMENT, /**< A request to start advertising has been received */ DISABLE_ADVERTISEMENT /**< A request to cancel advertising has been received */ }; enum ListenOp { START_LISTEN, /**< A request to start listening has been received */ STOP_LISTEN /**< A request to stop listening has been received */ }; /** * @brief Add or remove a discover indication. * * The transport has received a new discovery operation. This will either * be an EnableDiscovery() or DisbleDiscovery() discriminated by the * DiscoveryOp enum. * * We want to keep a list of name prefixes that are currently active for * well-known name discovery. The presence of a non-zero size of this list * indicates discovery is in-process and the Name Service should be kept * alive (it can be listening for inbound packets in particular). * * @return true if the list of discoveries is empty as a result of the * operation. */ bool NewDiscoveryOp(DiscoveryOp op, qcc::String namePrefix, bool& isFirst); /** * @brief Add or remove an advertisement indication. * * Called when the transport has received a new advertisement operation. * This will either be an EnableAdvertisement() or DisbleAdvertisement() * discriminated by the AdvertiseOp enum. * * We want to keep a list of names that are currently being advertised. The * presence of a non-zero size of this list indicates that at least one * advertisement is in-process and the Name Service should be kept alive to * respond to WHO_HAS queries. * * @return true if the list of advertisements is empty as a result of the * operation. */ bool NewAdvertiseOp(AdvertiseOp op, qcc::String name, bool& isFirst); /** * @brief Add or remove a listen operation. * * Called when the transport has received a new listen operation. * This will either be an StartListen() or StopListen() * discriminated by the ListenOp enum. * * We want to keep a list of listen specs that are currently being listened * on. This lest is kept so we can tear down the listeners if there are no * advertisements and recreate it if an advertisement is started. * * This is keep TCP from having a listener so that the Android Compatibility * test suite can pass with when the daemon is in the quiescent state. * * @return true if the list of listeners is empty as a result of the * operation. */ bool NewListenOp(ListenOp op, qcc::String name); void QueueEnableDiscovery(const char* namePrefix, TransportMask transports); void QueueDisableDiscovery(const char* namePrefix, TransportMask transports); void QueueEnableAdvertisement(const qcc::String& advertiseName, bool quietly, TransportMask completetransports); void QueueDisableAdvertisement(const qcc::String& advertiseName, TransportMask completetransports); void QueueUpdateRouterAdvertisementAndDynamicScore(); void RunListenMachine(ListenRequest& listenRequest); void StartListenInstance(ListenRequest& listenRequest); void StopListenInstance(ListenRequest& listenRequest); void EnableAdvertisementInstance(ListenRequest& listenRequest); void DisableAdvertisementInstance(ListenRequest& listenRequest); void EnableDiscoveryInstance(ListenRequest& listenRequest); void DisableDiscoveryInstance(ListenRequest& listenRequest); void HandleNetworkEventInstance(ListenRequest& listenRequest); void UpdateDynamicScoreInstance(ListenRequest& listenRequest); void UntrustedClientExit(); QStatus UntrustedClientStart(); bool m_isAdvertising; bool m_isDiscovering; bool m_isListening; bool m_isNsEnabled; enum State { STATE_RELOADING = 0, /**< The set of listen FDs has changed and needs to be reloaded by the main thread */ STATE_RELOADED, /**< The set of listen FDs has been reloaded by the main thread */ STATE_EXITED /**< The main TCPTransport thread has exited */ }; State m_reload; /**< Flag used for synchronization of DoStopListen with the Run thread */ std::map m_listenPortMap; /**< If m_isListening, a map of the ports on which we are listening on different interfaces/addresses */ std::map m_requestedInterfaces; /**< A map of requested interfaces and corresponding IP addresses/ports or defaults */ std::map m_requestedAddresses; /**< A map of requested IP addresses to interfaces or defaults */ std::map m_requestedAddressPortMap; /**< A map of requested IP addresses to ports */ std::list m_pendingAdvertisements; /**< A list of advertisement requests that came in while no interfaces were yet IFF_UP */ std::list m_pendingDiscoveries; /**< A list of discovery requests that came in while no interfaces were yet IFF_UP */ int32_t m_nsReleaseCount; /**< the number of times we have released the name service singleton */ bool m_wildcardIfaceProcessed; bool m_wildcardAddressProcessed; /**< The router advertisement prefix set in the configuration file appended with the BusController's unique name */ qcc::String routerName; int32_t m_maxRemoteClientsTcp; /**< the maximum number of untrusted clients allowed at any point of time */ int32_t m_numUntrustedClients; /**< Number of untrusted clients currently registered with the daemon */ uint32_t m_minHbeatIdleTimeout; /**< The minimum allowed idle timeout for the Heartbeat between Routing node and Leaf node - configurable in router config */ uint32_t m_defaultHbeatIdleTimeout; /**< The default idle timeout for the Heartbeat between Routing node and Leaf node - configurable in router config */ uint32_t m_maxHbeatIdleTimeout; /**< The maximum allowed idle timeout for the Heartbeat between Routing node and Leaf node - configurable in router config */ uint32_t m_defaultHbeatProbeTimeout; /**< The time the Routing node should wait for Heartbeat response to be recieved from the Leaf node - configurable in router config */ uint32_t m_maxHbeatProbeTimeout; /**< The max time the Routing node should wait for Heartbeat response to be recieved from the Leaf node - configurable in router config */ uint32_t m_numHbeatProbes; /**< Number of probes Routing node should wait for Heartbeat response to be recieved from the Leaf node before declaring it dead - Transport specific */ DynamicScoreUpdater m_dynamicScoreUpdater; }; } // namespace ajn #endif // _ALLJOYN_TCPTRANSPORT_H alljoyn-15.04b/alljoyn_core/router/UDPTransport.cc000066400000000000000000017750071255700255500222400ustar00rootroot00000000000000/** * @file * UDPTransport is an implementation of UDPTransportBase for daemons. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include "BusInternal.h" #include "BusController.h" #include "ConfigDB.h" #include "RemoteEndpoint.h" #include "Router.h" #include "DaemonRouter.h" #include "ArdpProtocol.h" #include "ns/IpNameService.h" #include "UDPTransport.h" #if ARDP_TESTHOOKS #include "ScatterGatherList.h" #endif #ifndef ADVERTISE_ROUTER_OVER_UDP #define ADVERTISE_ROUTER_OVER_UDP 0 #endif /* * How the transport fits into the system * ====================================== * * AllJoyn provides the concept of a Transport which provides a relatively * abstract way for the daemon to use different network mechanisms for getting * Messages from place to another. Conceptually, think of, for example, a Unix * transport that moves bits using unix domain sockets or a TCP transport that * moves Messages over a TCP connection. A UDP transport moves Messages over * UDP datagrams using a reliability layer. * * BSD sockets is oriented toward clients and servers. There are different * sockets calls required for a program implementing a server-side part and a * client side part. The server-side listens for incoming connection requests * and the client-side initiates the requests. AllJoyn clients are bus * attachments that our Applications may use and these can only initiate * connection requests to AllJoyn daemons. Although dameons may at first blush * appear as the service side of a typical BSD sockets client-server pair, it * turns out that while daemons obviously must listen for incoming connections, * they also must be able to initiate connection requests to other daemons. * This explains the presence of both connect-like methods and listen-like * methods here. * * A fundamental idiom in the AllJoyn system is that of a thread. Active * objects in the system that have threads wandering through them will implement * Start(), Stop() and Join() methods. These methods work together to manage * the autonomous activities that can happen in a UDPTransport. These * activities are carried out by so-called hardware threads. POSIX defines * functions used to control hardware threads, which it calls pthreads. Many * threading packages use similar constructs. * * In a threading package, a start method asks the underlying system to arrange * for the start of thread execution. Threads are not necessarily running when * the start method returns, but they are being *started*. Some time later, a * thread of execution appears in a thread run function, at which point the * thread is considered *running*. In the case of the UDPTransport, the Start() * method spins up a thread to run the basic maintenance operations such as * deciding when to listen and advertise. Another thread(s) is started to deal * with handling callbacks for deadlock avoidance. The AllJoyn daemon is a * fundamentally multithreaded environemnt, so multiple threads may be trying to * connect, disconnect, and write from the daemon side, and at the same time * connect, disconnect, read and write callbacks may be coming from the network * side. This means that as soon as UDPTransport::Start() is executed, multiple * threads, originating both in the transport and from outside, may be wandering * around in objects used by the tansport; and so one must be very careful about * resource management. This is the source of much of the complexity in this * module. * * In generic threads packages, executing a stop method asks the underlying * system to arrange for a thread to end its execution. The system typically * sends a message to the thread to ask it to stop doing what it is doing. The * thread is running until it responds to the stop message, at which time the * run method exits and the thread is considered *stopping*. The UDPTransport * provides a Stop() method to do exactly that. Note that neither of Start() * nor Stop() are synchronous in the sense that one has actually accomplished * the desired effect upon the return from a call. Of particular interest is * the fact that after a call to Stop(), threads will still be *running* for * some non-deterministic time. In order to wait until all of the threads have * actually stopped, a blocking call is required. In threading packages this is * typically called join, and our corresponding method is called Join(). A user * of the UDPTransport must assume that immediately after a call to Start() is * begun, and until a call to Join() returns, there may be threads of execution * wandering anywhere in the transport and in any callback registered by the * caller. The same model applies to connection endpoints (_UDPEndpoint) * instances. Further complicating _UDPEndpoint design is that the thread * lifetime methods may be called repeatedly or never (in the case of some forms * of timeout); and so the transport needs to ensure that all combinations of * these state transitions occur in an orderly and deterministic manner. * * The high-level process regarding how an advertisement translates into a * transport Connect() is a bit opaque, so we paint a high-level picture here. * First, a service (that will be *handling* RPC calls and *emitting* signals) * acquires a name on the bus, binds a session port and calls AdvertiseName. * This filters down (possibly through language bindings) to the AllJoyn Object. * The AllJoynObj essentially turns a DBus into an AllJoyn bus. The AllJoyn * Object consults the transports on the transport list (the UDP transport is * one of those) and eventually sends an advertisement request to each specified * transport by calling each transport's EnableAdvertisement() method. We * transnslate this call to a call to the the IpNameService::AdvertiseName() * method we call since we are an IP-based transport. The IP name service will * multicast the advertisements to other daemons listening on our device's * connected networks. * * A client that is interested in using the service calls the discovery * method FindAdvertisedName. This filters down (possibly through * language bindings) to the AllJoyn object, into the transports on the * transport list (us) and we eventually call IpNameService::FindAdvertisedName() * since we are an IP-based transport. The IP name service multicasts the * discovery message to other daemons listening on our networks. * * The daemon remembers which clients have expressed interest in which services, * and expects name services to call back with the bus addresses of daemons they * find which have the associated services. When a new advertisement is * received, the name service fires a callback into the transport, and it, in turn, calls * into its associated BusListener to pass the information back to the daemon. * * The callback includes information about the discovered name, the IP address, * port and daemon GUID of the remote daemon (now Routing Node). This bus * address is "hidden" from interested clients and replaced with a more generic * name and TransportMask bit (for us it will be TRANSPORT_UDP). The client * either responds by (1) ignoring the advertisement; (2) waiting to accumulate * more answers to see what the options are; or (3) joins a session to the * implied daemon/service. A reference to a SessionOpts object is provided as a * parameter to a JoinSession call if the client wants to connect. This * SessionOpts reference is passed down into the transport (selected by the * TransportMask) into the Connect() method which is used to establish the * connection and can be used to determine if the discovered name posesses * certain desired characteristics (to aid in determine the course of action * of the client * * There are four basic connection mechanisms that are described by the options. * These can be viewed as a matrix; * * IPv4 IPv6 * --------------- --------------- * TRAFFIC MESSAGES | TRAFFIC_RAW_RELIABLE | Reliable IPv4 Reliable IPv6 * TRAFFIC_RAW_UNRELIABLE | Unreliable IPv4 Unreliable IPv6 * * Note that although the UDP protocol is unreliable, the AllJoyn Reliable Datagram * Protocol is an additional reliability layer, so that TRAFFIC_MESSAGES are actually * sent over the UDP protocol. * The bits in the provided SessionOpts select the row, but the column is left * free (unspecified). This means that it is up to the transport to figure out * which one to use. Clearly, if only one of the two address flavors is * possible (known from examining the returned bus address which is called a * connect spec in the Connect() method) the transport should choose that one. * If both IPv4 or IPv6 are available, it is up to the transport (again, us) to * choose the "best" method since we don't bother clients with that level of * detail. * * Perhaps somewhat counter-intuitively, advertisements relating to the * UDP Transport use the addr (unreliable IPv4 or IPv6 address), and port * unreliable IPv4 or IPv6 port). * At the same time, the UDP Transport tells clients of the transport that it * supports TRAFFIC MESSAGES only. This is because the underlying network * protocol used is UDP which is inherently unreliable. We provide a * reliability layer to translate the unreliable UDP4 and UDP6 datagrams into * reliable AllJoyn messages. The UDP Transpot does not provide RAW sockets * which is a deprecated traffic type. * * Internals * ========= * * We spend a lot of time on the threading aspects of the transport since they * are often the hardest part to get right and are complicated. This is where * the bugs live. * * As mentioned above, the AllJoyn system uses the concept of a Transport. You * are looking at the UDPTransport. Each transport also has the concept of an * Endpoint. The most important function fo an endpoint is to provide (usually) * non-blocking semantics to higher level code. If the source thread overruns * the ability of the transport to move bits (reliably), we must apply * back-pressure by blocking the calling thread, but usually a call to PushBytes * results in an immediate UDP datagram sendto. In the UDP transport there are * separate worker threads assigned to reading UDP datagrams, running the * reliability layer and dispatching received AllJoyn messages. * * Endpoints are specialized into the LocalEndpoint and the RemoteEndpoint * classes. LocalEndpoint represents a connection from a router to the local * bus attachment or daemon (within the "current" process). A RemoteEndpoint * represents a connection from a router to a remote attachment or daemon. By * definition, the UDPTransport provides RemoteEndpoint functionality. * * RemoteEndpoints are further specialized according to the flavor of the * corresponding transport, and so you will see a UDPEndpoint class defined * below which provides functionality to send messages from the local router to * a destination off of the local process using a UDP transport mechanism. * * RemoteEndpoints use AllJoyn stream objects to actually move bits. In UDP * this is a bit of an oxymoron, however an AllJoyn stream is a thin layer on * top of a Socket (which is another thin layer on top of a BSD socket) that * provides a PushBytes() method. Although UDP is not a stream-based protocol, * we treat each received datagram as a separate stream for the purposes of * passing back to the AllJoyn core which expectes to be able to read bytes from * a message backing object. * * Unlike a TCP transport, there are no dedicated receive threads. Receive * operations in UDP are not associted with a particular endpoint at all, other * than using the required endpoint as a convencient place holder for a * connection data structure. The UDP Transport operates more in an * Asynchronous IO-like fashion. Received datagrams appear out of the ARDP * protocol as callbacks and are sent into a callback dispatcher thread. Once * the dispatcher has an inbound datagram(s) it reassembles and unmarshals the * datagrams into an AllJoyn Message. It then calls into the daemon * (PushMessage) to arrange for delivery. A separate thread runs the * maintenance aspects of the UDP reliability layer (to drive retransmissions, * timeouts, etc.) and the endpoint management code (to drive the lifetime state * transitions of endpoints). * * The UDPEndpoint inherits some infrastructure from the more generic * RemoteEndpoint class. Since the UDP transport is a not a stream-based * protocol, it does redefine some of the basic operation of the RemoteEndpoint * to suit its needs. The RemoteEndpoint is also somewhat bound to the concept * of stream and receive thread, so we have to jump through some hoops to * coexist. * * The UDP endpoint does not use SASL for authentication and implements required * dameon exchanges in the SYN, SYN + ACK echanges of the underlying ARDP * protocol. Although there is no authentication, per se, we still call this * handshake phase authentication since the BusHello is part of the * authentication phase of the TCP Transport. Authentication can, of course, * succeed or fail based on timely interaction between the two sides, but it can * also be abused in a denial of service attack. If a client simply starts the * process but never responds, it could tie up a daemon's resources, and * coordinated action could bring down a daemon. Because of this, we provide a * way to reach in and abort authentications that are "taking too long" and free * the associated resources. * * As described above, a daemon can listen for inbound connections and it can * initiate connections to remote daemons. Authentication must happen in both * cases and so we need to worry about denial of service in both directions and * recover gracefully. * * When the daemon is brought up, its TransportList is Start()ed. The transport * specs string (e.g., "unix:abstract=alljoyn;udp:;tcp:") is provided to * TransportList::Start() as a parameter. The transport specs string is parsed * and in the example above, results in "unix" transports, "tcp" transports and * "udp" transports being instantiated and started. As mentioned previously * "udp:" in the daemon translates into UDPTransport. Once the desired * transports are instantiated, each is Start()ed in turn. In the case of the * UDPTransport, this will start the maintenance loop. Initially there are no * sockets to listen on. * * The daemon then needs to start listening on inbound addresses and ports. * This is done by the StartListen() command. This also takes the same kind of * server args string shown above but this time the address and port information * are used. For example, one might use the string * "udp:addr=0.0.0.0,port=9955;" to specify which address and port to listen * to. This Bus::StartListen() call is translated into a transport * StartListen() call which is provided with the string described above, which * we call a "listen spec". Our UDPTransport::StartListen() will arange to * create a Socket, bind the socket to the address and port provided and save * the new socket on a list of "listenFds" (we may listen on separate sockets * corresponding to multiple network interfaces). Another of the many * complications we have to deal with is that the Android Compatibility Test * Suite (CTS) requires that an idle phone not have any sockets listening for * inbound data. In order to pass the CTS in the case of the pre-installed * daemon, we must only have open name service sockets when actively advertising * or discovering. This implies that we need to track the adveritsement state * and enable or disable the name service depending on that state. * * An inbound connection request in the UDP transport is consists of receiving a * SYN datagram. The AcceptCb() is called from the reliability layer (on * reception of a SYN packet) in order to ask whether or not the connection * should be accepted. If AcceptCb() determines there are enough resources for * a new connection it will call ARDP_Accept to provide a BusHello reply and * return true indicating acceptance, or false which means rejection. If the * connection is accepted, a ConnectCb() is fired and the callback dispatcher * thread will ultimately handle the incoming request and create a UDPEndpoint * for the *proposed* new connection. * * Recall that an endpoint is not brought up immediately, but an authentication * step must be performed. The required information (BusHello reply) is * provided back in the SYN + ACK packet. The final ACK of the three-way * handshake completes the inbound connection establishment process. * If the authentication takes "too long" we assume that a denial of service * attack in in progress. We fail such partial connections and the endpoint * management code removes them. * * A daemon transport can accept incoming connections, and it can make outgoing * connections to another daemon. This case is simpler than the accept case * since it is expected that a socket connect can block higner level code, so it * is possible to do authentication in the context of the thread calling * Connect(). Connect() is provided a so-called "connect spec" which provides * an IP address ("addr=xxxx"), port ("port=yyyy") in a String. A check is * always made to catch an attempt for the daemon to connect to itself which is * a system-defined error (it causes the daemon grief, so we avoid it here by * looking to see if one of the listenFds is listening on an interface that * corresponds to the address in the connect spec). If the connect is allowed, * ee kick off a process in the underlying UDP reliability layer that * corresponds to the 3-way handshake of TCP. * * Shutting the UDPTransport down involves orchestrating the orderly termination * of: * * 1) Threads that may be running in the maintenance loop with associated Events * and their dependent socketFds stored in the listenFds list; * 3) The callback dispatcher thread that may be out wandering around in the * daemon doing its work; * 2) Threads that may be running around in endpoints and streams trying to write * Mesages to the network. * * We have to be careful to follow the AllJoyn threading model transitions in * both the UDPTransport and all of its associated _UdpEndpoints. There are * reference counts of endpoints to be respected as well. In order to ensure * orderly termination of endoints and deterministic disposition of threads * which may be executing in those endpoints, We want the last reference count * held on an endpoint to be the one held by the transport. There is much * work (see IncrementAndFetch, DecrementAndFetch, ManagedObj for example) * done to ensure this outcome. * * There are a lot of very carefully managed relationships here, so be careful * when making changes to the thread and resource management aspects of any * transport. Taking lock order lightly is a recipe for disaster. Always * consider what locks are taken where and in what order. It's quite easy to * shoot yourself in multiple feet you never knew you had if you make an unwise * modification, and this can sometimes result in tiny little time-bombs set to * go off in seemingly completely unrelated code. * * A note on connection establishment * ================================== * * In the TCP transport, a separate synchronous sequence is executed before * AllJoyn messages can begin flowing. First a NUL byte is sent as is required * in the DBus spec. In order to get a destination address for the BusHello * message, the local side relies on the SASL three-way handshake exchange: * * SYN ------------> * <- SYN + ACK * ACK ------------> * NUL ------------> * AUTH ANONYMOUS -> * <- OK * BEGIN ----------> * * Once this is done, the active connector sends a BusHello Message and the * passive side sends a response * * BusHello -------> * <- BusHello reply * * In the UDP Transport, we get rid of basically the whole Authentication * process and exchange required information in the SYN, SYN + ACK and * ACK packets of the protocol three-way handshake. * * The initial ARDP SYN packet *implies* AUTH_ANONYMOUS and contains the * BusHello message data from the Local (initiating/active) side of the * connection. The SYN + ACK segment in response from the remote side contains * the response to the BusHello that was sent in the SYN packet. * * SYN + BusHello --> * <- SYN + ACK + BusHello Reply * ACK -------------> * * This all happens in a TCP-like SYN, SYN + ACK, ACK exchange with AllJoyn * data. At the reception of the final ACK, the connection is up and running. * * This exchange is implemented using a number of callback functions that * fire on the local (active) and remote (passive) side of the connection. * * 1) The actively connecting side provides a BusHello message in call to * ARDP_Connect(). As described above, ARDP provides this message as data in * the SYN segment which is the first part of the three-way handshake; * * 2) When the passive side receives the SYN segment, its AcceptCb() callback is * fired. The data provided in the accept callback contains the BusHello * message from the actively opening side. The passive side, if it chooses * to accept the connection, makes a call to ARDP_Accept() with its reply to * the BusHello from the active side as data. ARDP provides this data back * in the SYN + ACK segment as the second part of its three-way handshake; * * 3) The actively connecting side receives a ConnectCb() callback as a result * of the SYN + ACK coming back from the passive side. This indicates that * the newly established connection is going into the OPEN state from the * local side's (ARDP) perspective. Prior to firing the callback, ARDP * automatically sends the final ACK and completes the three-way handshake. * The ConectCb() with the active indication means that a SYN + ACK has been * received that includes the reply to the original BusHello message. * * 4) When the final ACK of the three-way handshake is delivered to the passive * opener side, it transitions the passive side to the OPEN state and fires * a ConnectCb() callback with the passive indication meaning that the final * ACK of the three-way handhake has arrived. * * From the perspective of the UDP Transport, this translates into the following * sequence diagram that reflects the three-way handshake that is going on under * the whole thing. * * Active Side Passive Side * =========== ============ * ARDP_Connect([out]BusHello message) --> AcceptCb([in]BusHello message) -----+ * | * +--- ConnectCb([in]BusHello reply) <-------- ARDP_Accept([out]BusHello reply) <--+ * | * +------------------------------------------> ConnectCb(NULL) * */ #define QCC_MODULE "UDP" #define SENT_SANITY 0 /**< If non-zero make sure ARDP is returning buffers correctly (expensive) */ #define BYTEDUMPS 0 /**< If non-zero do byte-by-byte debug dumps of sent and received buffers (super-expensive) */ #define RETURN_ORPHAN_BUFS 0 /**< If non-zero, call ARDP_RecvReady on any buffers we can't forward (processed after endpoint is torn down) */ using namespace std; using namespace qcc; const uint32_t UDP_STALL_REPORT_INTERVAL = 10000; /** Minimum time between stall warning log messages */ const uint32_t UDP_ENDPOINT_MANAGEMENT_TIMER = 1000; /** Maximum time between calls to ManageEndpoints -- a watchdog */ const uint32_t UDP_ENDPOINT_MANAGEMENT_MIN = 100; /** There's really no reason to run the management faster than this */ const uint32_t UDP_WAIT_WATCHDOG_TIMEOUT = 5000; /** Max time in EP_WAITING state before giving up on sending msgs */ const uint32_t UDP_WATCHDOG_TIMEOUT = 30000; /**< How long to wait before printing an error if an endpoint is not going away */ const uint32_t UDP_MESSAGE_PUMP_TIMEOUT = 10000; /**< How long to keep a message pump thread running with nothing to do */ const uint32_t UDP_CONNECT_TIMEOUT = 1000; /**< How long before we expect a connection to complete */ const uint32_t UDP_CONNECT_RETRIES = 10; /**< How many times do we retry a connection before giving up */ const uint32_t UDP_INITIAL_DATA_TIMEOUT = 1000; /**< Initial value for how long do we wait before retrying sending data */ const uint32_t UDP_TOTAL_DATA_RETRY_TIMEOUT = 30000; /**< Initial total amount of time to try and send data before giving up */ const uint32_t UDP_MIN_DATA_RETRIES = 5; /**< Minimum number of times to try and send data before giving up */ const uint32_t UDP_PERSIST_INTERVAL = 1000; /**< How long do we wait before pinging the other side due to a zero window */ const uint32_t UDP_TOTAL_APP_TIMEOUT = 30000; /**< How long to we try to ping for window opening before deciding app is not pulling data */ const uint32_t UDP_LINK_TIMEOUT = 30000; /**< How long before we decide a link is down (with no reponses to keepalive probes */ const uint32_t UDP_KEEPALIVE_RETRIES = 5; /**< How many times do we try to probe on an idle link before terminating the connection */ const uint32_t UDP_FAST_RETRANSMIT_ACK_COUNTER = 1; /**< How many duplicate acknowledgements to we need to trigger a data retransmission */ const uint32_t UDP_DELAYED_ACK_TIMEOUT = 100; /**< How long do we wait until acknowledging received segments */ const uint32_t UDP_TIMEWAIT = 1000; /**< How long do we stay in TIMWAIT state before releasing the per-connection resources */ /* * Note that UDP_SEGBMAX * UDP_SEGMAX must be greater than or equal to * ALLJOYN_MAX_PACKET_LEN (135168) to ensure we can deliver a maximally sized AllJoyn * message. */ const uint32_t UDP_SEGBMAX = 4440; /**< Maximum size of an ARDP segment (quantum of reliable transmission) */ const uint32_t UDP_SEGMAX = 93; /**< Maximum number of ARDP segment in-flight (bandwidth-delay product sizing) */ namespace ajn { /** * Name of transport used in transport specs. */ const char* UDPTransport::TransportName = "udp"; /** * Default router advertisement prefix. Currently Thin Library devices cannot * connect to routing nodes over UDP. */ #if ADVERTISE_ROUTER_OVER_UDP const char* const UDPTransport::ALLJOYN_DEFAULT_ROUTER_ADVERTISEMENT_PREFIX = "org.alljoyn.BusNode."; #endif /** * Prefix to quietly advertise when working around ASACORE-1298. Keeps an * advertisement outstanding to prevent closing listen sockets out from under * UDP Endpoints. */ #if WORKAROUND_1298 const char* const WORKAROUND_1298_PREFIX = "org.alljoyn.wa1298."; #endif const char* TestConnStr = "ARDP TEST CONNECT REQUEST"; const char* TestAcceptStr = "ARDP TEST ACCEPT"; #ifndef NDEBUG #if BYTEDUMPS static void DumpLine(uint8_t* buf, uint32_t len, uint32_t width) { for (uint32_t i = 0; i < width; ++i) { if (i > len) { printf(" "); } else { printf("%02x ", buf[i]); } } printf(": "); for (uint32_t i = 0; i < len && i < width; ++i) { if (iscntrl(buf[i]) || !isascii(buf[i])) { printf("."); } else { printf("%c", buf[i]); } } printf("\n"); } static void DumpBytes(uint8_t* buf, uint32_t len) { if (_QCC_DbgPrintCheck(DBG_GEN_MESSAGE, QCC_MODULE)) { for (uint32_t i = 0; i < len; i += 16) { DumpLine(buf + i, len - i > 16 ? 16 : len - i, 16); } } } #endif // BYTEDUMPS #endif // NDEBUG #ifndef NDEBUG /* * Quick Debug Print for focused printf debugging outside QCC framework. Useful * if you want to get your bearings but don't want to see the entire debug spew. * Use just like QCC_DebugPrintf. */ #define QDP(x) \ do { \ qdtm(); \ printf x; \ printf("\n"); \ } while (0) void qdtm(void) { printf("******** %u: ", GetTimestamp()); } #else #define QDP(x) do { } while (0) #endif #ifndef NDEBUG #define SEAL_SIZE 4 static void SealBuffer(uint8_t* p) { *p++ = 'S'; *p++ = 'E'; *p++ = 'A'; *p++ = 'L'; } static void CheckSeal(uint8_t* p) { assert(*p++ == 'S' && *p++ == 'E' && *p++ == 'A' && *p++ == 'L' && "CheckSeal(): Seal blown"); } #endif class _UDPEndpoint; static bool IsUdpEpStarted(_UDPEndpoint* ep); static void UdpEpStateLock(_UDPEndpoint* ep); static void UdpEpStateUnlock(_UDPEndpoint* ep); /** * A skeletal variety of a Stream used to fake the system into believing that * there is a stream-based protocol at work here. This is not intended to be * wired into IODispatch but is used to allow the daemon to to run in a * threadless, streamless environment without major changes. */ class ArdpStream : public qcc::Stream { public: ArdpStream() : m_transport(NULL), m_endpoint(NULL), m_handle(NULL), m_conn(NULL), m_connId(0), m_lock(), m_disc(false), m_discSent(false), m_discStatus(ER_OK), m_writeCondition(NULL), m_sendsOutstanding(0) { QCC_DbgTrace(("ArdpStream::ArdpStream()")); m_writeCondition = new qcc::Condition(); } virtual ~ArdpStream() { QCC_DbgTrace(("ArdpStream::~ArdpStream()")); QCC_DbgPrintf(("ArdpStream::~ArdpStream(): delete events")); delete m_writeCondition; m_writeCondition = NULL; } /** * Get a pointer to the associated UDP transport instance. */ UDPTransport* GetTransport() const { QCC_DbgTrace(("ArdpStream::GetTransport(): => %p", m_transport)); return m_transport; } /** * Set the pointer to the associated UDP transport instance. */ void SetTransport(UDPTransport* transport) { QCC_DbgTrace(("ArdpStream::SetTransport(transport=%p)", transport)); m_transport = transport; } /** * Get a pointer to the associated UDP endpoint. */ _UDPEndpoint* GetEndpoint() const { QCC_DbgTrace(("ArdpStream::GetEndpoint(): => %p", m_endpoint)); return m_endpoint; } /** * Set the pointer to the associated UDP endpoint instance. */ void SetEndpoint(_UDPEndpoint* endpoint) { QCC_DbgTrace(("ArdpStream::SetEndpoint(endpoint=%p)", endpoint)); m_endpoint = endpoint; } /** * Get the information that describes the underlying ARDP protocol connection. */ ArdpHandle* GetHandle() const { QCC_DbgTrace(("ArdpStream::GetHandle(): => %p", m_handle)); return m_handle; } /** * Set the handle to the underlying ARDP protocol instance. */ void SetHandle(ArdpHandle* handle) { QCC_DbgTrace(("ArdpStream::SetHandle(handle=%p)", handle)); m_handle = handle; } /** * Get the information that describes the underlying ARDP protocol * connection. */ ArdpConnRecord* GetConn() const { QCC_DbgTrace(("ArdpStream::GetConn(): => %p", m_conn)); return m_conn; } /** * Set the information that describes the underlying ARDP protocol * connection. */ void SetConn(ArdpConnRecord* conn) { QCC_DbgTrace(("ArdpStream::SetConn(conn=%p)", conn)); m_conn = conn; } /** * Get the underlying ARDP protocol connection identifier. */ uint32_t GetConnId() const { QCC_DbgTrace(("ArdpStream::GetConnId(): => %p", m_connId)); return m_connId; } /** * Set the underlying ARDP protocol connection ID */ void SetConnId(uint32_t connId) { QCC_DbgTrace(("ArdpStream::SetConnId(connId=%d.)", connId)); m_connId = connId; } /** * Add the currently running thread to a set of threads that may be * currently referencing the internals of the stream. We need this list to * make sure we don't try to delete the stream if there are threads * currently using the stream, and to wake those threads in case the threads * are blocked waiting for a send to complete when the associated endpoint * is shut down. */ void AddCurrentThread() { QCC_DbgTrace(("ArdpStream::AddCurrentThread()")); ThreadEntry entry; entry.m_thread = qcc::Thread::GetThread(); entry.m_stream = this; m_lock.Lock(MUTEX_CONTEXT); m_threads.insert(entry); m_lock.Unlock(MUTEX_CONTEXT); } /** * Remove the currently running thread from the set of threads that may be * currently referencing the internals of the stream. */ void RemoveCurrentThread() { QCC_DbgTrace(("ArdpStream::RemoveCurrentThread()")); ThreadEntry entry; entry.m_thread = qcc::Thread::GetThread(); entry.m_stream = this; m_lock.Lock(MUTEX_CONTEXT); set::iterator i = m_threads.find(entry); assert(i != m_threads.end() && "ArdpStream::RemoveCurrentThread(): Thread not on m_threads"); m_threads.erase(i); m_lock.Unlock(MUTEX_CONTEXT); } /** * Wake all of the treads that may be waiting on the condition for a chance * to contend for the resource. We expect this function to be used to wake * all of the threads in the case that the stream is shutting down. * Presumably they will all wake up and notice that the stream is going away * and exit */ void WakeThreadSet() { QCC_DbgTrace(("ArdpStream::WakeThreadSet()")); m_lock.Lock(MUTEX_CONTEXT); if (m_writeCondition) { m_writeCondition->Broadcast(); } m_lock.Unlock(MUTEX_CONTEXT); } /** * Determine whether or not there is a thread waiting on the stream for a write * operation to complete. */ bool ThreadSetEmpty() { QCC_DbgTrace(("ArdpStream::ThreadSetEmpty()")); m_lock.Lock(MUTEX_CONTEXT); bool empty = m_threads.empty(); m_lock.Unlock(MUTEX_CONTEXT); QCC_DbgTrace(("ArdpStream::ThreadSetEmpty(): -> %s", empty ? "true" : "false")); return empty; } /** * Get the number of outstanding send buffers -- the number of sends that have been * called, but have not completed and had the buffers returned by ARDP. */ uint32_t GetSendsOutstanding() { QCC_DbgTrace(("ArdpStream::GetSendsOutstanding() -> %d.", m_sendsOutstanding)); m_transport->m_cbLock.Lock(MUTEX_CONTEXT); uint32_t sendsOutstanding = m_sendsOutstanding; m_transport->m_cbLock.Unlock(MUTEX_CONTEXT); return sendsOutstanding; } /** * Set the stream's write condition if it exists. This will wake exactly * one waiting thread which will then loop back around and try to do its * work again. */ void SignalWriteCondition() { QCC_DbgTrace(("ArdpStream::SignalWriteCondition()")); m_lock.Lock(MUTEX_CONTEXT); if (m_writeCondition) { m_writeCondition->Signal(); } m_lock.Unlock(MUTEX_CONTEXT); } /** * Send some bytes to the other side of the conection described by the * m_conn member variable. * * The caller of this function is most likely the daemon router that is * moving a message to a remote destination. It was written expecting this * call to copy bytes into TCP or block when TCP applies backpressure. As * soon as the call returns, the router expects to be able to delete the * message backing buffer (our buf) and go on about its business. * * That means we basically have to do the same thing here unless we start * ripping the guts out of the system. That means the daemon router expects * to see and endpoint with a stream in it that has this PushBytes method. * * we need to copy the data in and return immediately if there is no * backpressure from the protocol; or copy the data in and block the caller * if there is backpressure. Backpressure is indicated by the * ER_ARDP_BACKPRESSURE return. If this happens, we cannot send any more * data until we get a send callback indicating the other side has consumed * some data. In this case we need to block the calling thread until it can * continue. * * When a buffer is sent, the ARDP protocol takes ownership of it until it * is ACKed by the other side or it times out. When the ACK happens, a send * callback is fired that will record the actual status of the send and free * the buffer. The status of the write is not known until the next read or * write operation. */ QStatus PushBytes(const void* buf, size_t numBytes, size_t& numSent, uint32_t ttl) { QCC_DbgTrace(("ArdpStream::PushBytes(buf=%p, numBytes=%d., numSent=%p)", buf, numBytes, &numSent)); QStatus status = ER_OK; /* * Start out by assuming that nothing worked and we have sent nothing. */ numSent = 0; /* * If either the transport or the endpoint is not in a state where it * indicates that it is ready to send, we need to return an error. * * Unfortunately, the system will try to do all kinds of things to an * endpoint even though it has just stopped it. To prevent cascades of * error logs, we need to return a "magic" error code and not log an * error if we detect that either the transport or the endpoint is * shutting down. Higher level code (especially AllJoynObj) will look * for this error and not do any logging if it is a transient error * during shutdown, as identified by the error return value * ER_BUS_ENDPOINT_CLOSING. * * There is a window between the start of a remote disconnect event and * the endpoint state change where the endpoint can think it is up and * started but the stream can think it has started going down. We'll * catch that case before actually starting the send. */ if (m_transport->IsRunning() == false || m_transport->m_stopping == true) { return ER_BUS_ENDPOINT_CLOSING; } if (IsUdpEpStarted(m_endpoint) == false) { return ER_BUS_ENDPOINT_CLOSING; } /* * We can proceed, but we are a new thread that is going to be wandering * down into the stream code, so add ourselves to the list of threads * wandering around in the associated endpoint. We need to keep track * of this in case the endpoint is stopped while the current thread is * wandering around in the stream trying to get the send done. */ AddCurrentThread(); #ifndef NDEBUG #if BYTEDUMPS DumpBytes((uint8_t*)buf, numBytes); #endif #endif /* * Copy in the bytes to preserve the buffer management approach expected by * higher level code. */ QCC_DbgPrintf(("ArdpStream::PushBytes(): Copy in")); #ifndef NDEBUG uint8_t* buffer = new uint8_t[numBytes + SEAL_SIZE]; SealBuffer(buffer + numBytes); #else uint8_t* buffer = new uint8_t[numBytes]; #endif memcpy(buffer, buf, numBytes); /* * Set up a timeout on the write. If we call ARDP_Send, we expect it to * come back with some a send callback if it accepts the data. As a * double-check, we add our own timeout that expires in twice the we * expect ARDP to time out. This is effectively a watchdog that barks * when ARDP is not doing what we expect it to. */ uint32_t timeout; Timespec tStart; m_transport->m_ardpLock.Lock(); timeout = 2 * ARDP_GetDataTimeout(m_handle, m_conn); m_transport->m_ardpLock.Unlock(); GetTimeNow(&tStart); QCC_DbgPrintf(("ArdpStream::PushBytes(): Start time is %" PRIu64 ".%03d.", tStart.seconds, tStart.mseconds)); /* * This is the point at which a classic condition vairable wait idiom * comes into play. Extracted from all of the dependencies here, it * would look something like: * * mutex.Lock() * while (condition != met) { * condition.Wait(mutex); * } * mutex.Unlock(); * * The mutex in question is the cbLock, which synchronizes this thread * (think a consumer contending for the protected resource) with the * callback thread from ARDP (think producer -- making the ARDP resource * available). The condition in question is whether or not are done trying * to write to the stream (we can either succeed or error out). */ bool done = false; m_transport->m_cbLock.Lock(); while (done != true) { /* * We're in a loop here that could possibly run for many seconds * trying to get data out, so we need to check to make sure that the * transport is not shutting down each time through the loop. */ if (m_transport->IsRunning() == false || m_transport->m_stopping == true) { status = ER_BUS_ENDPOINT_CLOSING; done = true; continue; } /* * Check the watchdog to make sure it has not timed out. */ Timespec tNow; GetTimeNow(&tNow); int32_t tRemaining = tStart + timeout - tNow; QCC_DbgPrintf(("ArdpStream::PushBytes(): tRemaining is %d.", tRemaining)); if (tRemaining <= 0) { status = ER_TIMEOUT; QCC_LogError(status, ("ArdpStream::PushBytes(): Timed out")); done = true; continue; } /* * Above, we did a coarse granularity checks for whether or not the * endpoint was ready to accept data. There is one case for which * we have to be more careful though. That's the shutdown case. * When we speak about shutdown, think socket shutdown. We have * queued up a bunch of data, and we want to do the equivalent of a * shutdown(SHUT_WR) when we stop our endpoint. This means we want * to wait for existing data to be sent, and then we want to shut * down the endpoint. * * The equivalent of a shutdown(SHUT_WR) in our case is calling * Stop() on an endpoint. If the Stop() is a result of a local * shutdown, the endpoint will immediately transition to the * EP_STOPPING state. This change will cause the endpoint * management thread to run. The management thread will notice the * local stop and transition immediately to EP_WAITING state. The * endpoint remains in EP_WAITING until all of the in-process sends * complete, at which time an ARDP_Disconnect() is sent and the * endpoint continues the destruction process. * * We need to make sure that we are in EP_STARTED state when we make * the ARDP_Send() call, and that we do not allow a change of state * out of EP_STARTED while the call is executing, otherwise we risk * making a send call and queueing a write during the time at which * the management thread is deciding when to execute the * ARDP_Disconnect. * * There at least three threads that may be interested in the * instantaneous value of the state: there's us, who is trying to * send bytes to the endpoint; there's the management thread who may * be wanting to change the state of the endpoint; and there's a * LeaveSession thread that may be driving a Stop(). We take the * endpoint state change lock and hold it during the ARDP call to * prevent possible inconsistencies. * * There is a window between the start of a remote disconnect event * and the endpoint state change where the endpoint can think it is * up and started but the stream can think it has started going * down. If we start a send during that time it is doomed to fail, * so we check for this corner case at the last possible time. */ UdpEpStateLock(m_endpoint); if (IsUdpEpStarted(m_endpoint)) { if (m_disc || m_discSent) { /* * The corner case mentioned above has happened, so don't * bother to start the ARDP_Send since we'll just get an * error. * * Note that there used to be a consistency checking assert * right here. It was removed since the disconnect callback * doesn't update the state of the stream and the state of * the endpoint atomically. The "obvious" consistency check * here failed under stress. As discussed in a comment in * DisconnectCb(), the inconsistency is harmless, but we * minimize its impact here. */ UdpEpStateUnlock(m_endpoint); status = ER_BUS_ENDPOINT_CLOSING; done = true; continue; } else { /* * We think everything is up and ready in ARDP-land, so we * can go ahead and start a send. */ m_transport->m_ardpLock.Lock(); status = ARDP_Send(m_handle, m_conn, buffer, numBytes, ttl); m_transport->m_ardpLock.Unlock(); } } else { /* * The endpoint is not in started state, which means it is * disconnecting which means it is closing from the point of * view of higher level code. The AllJoynObj, for example, * special-cases a return of ER_BUS_ENDPOINT_CLOSING since * it is "expected." */ UdpEpStateUnlock(m_endpoint); status = ER_BUS_ENDPOINT_CLOSING; done = true; continue; } UdpEpStateUnlock(m_endpoint); /* * If we do something that is going to bug the ARDP protocol, we need * to call back into ARDP ASAP to get it moving. This is done in the * main thread, which we need to wake up. Note that we don't set * m_manage so we don't trigger endpoint management, we just trigger * ARDP_Run to happen. */ m_transport->Alert(); /* * If the send succeeded, then the bits are on their way off to the * destination. The send callback associated with this PushBytes() * will take care of freeing the buffer we allocated. We return back * to the caller as if we were TCP and had copied the bytes into the * kernel. */ if (status == ER_OK) { /* * The bytes are in flight, so as far as we are concerned they * were successfully written; so indicate that to the caller. * * If we have successfully sent the bytes, the ARDP protocol has * taken responsibility for them, so the buffer is now gone. We * can't ever touch this buffer so we need to rid ourselves of * the reference to it. */ numSent = numBytes; m_transport->m_cbLock.Lock(MUTEX_CONTEXT); ++m_sendsOutstanding; #if SENT_SANITY m_sentSet.insert(buffer); #endif m_transport->m_cbLock.Unlock(MUTEX_CONTEXT); buffer = NULL; done = true; continue; } /* * If the send failed, and the failure was not due to the * application of backpressure by the protocol, we have a hard * failure and we must give up. Since the buffer wasn't sent, the * callback won't happen and we need to dispose of it here and now. */ if (status != ER_ARDP_BACKPRESSURE) { QCC_LogError(status, ("ArdpStream::PushBytes(): Hard failure")); done = true; continue; } /* * If backpressure has been applied by the ARDP protocol, we can't * send another message on this connection until the other side ACKs * one of the outstanding datagrams. It communicates this to us by * a send callback which, in turn, signals the condition variable * we'll be waiting on and wakes us up. The Wait here corresponds to * the Wait in the condition idiom outlined above. * * What if the backpressure error happens and there are no * outstanding messages? That is, what if the UDP buffer is full * and we cant' send even the one message. Since there is no * message in process, there will never be a SendCb to bug the * condition to wake us up and therefore the send will time out. We * assume that ARDP will allow us to send at least one message * before blocking us due to backpressure; so this is therefore * assumed to be a non-problem. */ if (status == ER_ARDP_BACKPRESSURE) { QCC_DbgPrintf(("ArdpStream::PushBytes(): Backpressure. Condition::Wait().")); assert(m_writeCondition && "ArdpStream::PushBytes(): m_writeCondition must be set"); status = m_writeCondition->TimedWait(m_transport->m_cbLock, tRemaining); /* * We expect that the wait will return either ER_OK if it * succeeds, or ER_TIMEOUT. If the Wait fails in other ways * then we will stop trying and communicate the failure back to * the caller since we really don't know what might have * happened and whether or not this is recoverable. */ if (status != ER_OK && status != ER_TIMEOUT) { QCC_LogError(status, ("ArdpStream::PushBytes(): Condition::Wait() returned unexpected error")); done = true; continue; } /* * If there was a disconnect in the underlying connection, there's * nothing we can do but return the error. */ if (m_disc) { status = ER_UDP_DISCONNECT; QCC_LogError(status, ("ArdpStream::PushBytes(): Stream disconnected")); done = true; continue; } QCC_DbgPrintf(("ArdpStream::PushBytes(): Backpressure loop")); assert(done == false && "ArdpStream::PushBytes(): loop error"); } /* * We are at the end of the while (condition != true) piece of the * condition variable wait idiom. To get here, we must have tried * to send a message. That send either did or did not work out. If * it succeeded, done will have been set to true and we'll break out * of the while loop. If there was a hard failure, done will have * also been set to true and we'll break out. If We detected * backpressure, we blocked on the condition variable until it was * set. This indicates that backpressure may have been relieved. * we need to loop back and try the ARDP_Send again, maybe * encountering backpressure again. */ } /* * If the buffer was successfully sent off to ARDP, then we no longer * have ownership of the buffer and the pointer will have been set to * NULL. If it is not NULL we own it and must dispose of it. */ if (buffer) { #ifndef NDEBUG CheckSeal(buffer + numBytes); #endif delete[] buffer; buffer = NULL; } /* * This is the last unlock in the condition wait idiom outlined above. * We are all done here. */ m_transport->m_cbLock.Unlock(); RemoveCurrentThread(); return status; } /* * A version of PushBytes that doesn't care about TTL. */ QStatus PushBytes(const void* buf, size_t numBytes, size_t& numSent) { QCC_DbgTrace(("ArdpStream::PushBytes(buf=%p, numBytes=%d., numSent=%p)", buf, numBytes, &numSent)); return PushBytes(buf, numBytes, numSent, 0); } /** * Get some bytes from the other side of the conection described by the * m_conn member variable. Data must be present in the message buffer * list since we expect that a RecvCb that added a buffer to that list is * what is going to be doing the read that will eventually call PullBytes. * In that case, since the data is expected to be present, will * be zero. */ QStatus PullBytes(void* buf, size_t reqBytes, size_t& actualBytes, uint32_t timeout) { QCC_UNUSED(buf); QCC_UNUSED(reqBytes); QCC_UNUSED(actualBytes); QCC_UNUSED(timeout); QCC_DbgTrace(("ArdpStream::PullBytes(buf=%p, reqBytes=%d., actualBytes=%d., timeout=%d.)", buf, reqBytes, actualBytes, timeout)); assert(0 && "ArdpStream::PullBytes(): Should never be called"); return ER_FAIL; } /** * Set the stram up for being torn down before going through the expected * lifetime state transitions. */ void EarlyExit() { QCC_DbgTrace(("ArdpStream::EarlyExit()")); /* * An EarlyExit is one when a stream has been created in the expectation * that an endpoint will be brought up, but the system changed its mind * in mid-"stream" and therefore there is no disconnect processing needed * and there must be no threads waiting. */ m_lock.Lock(MUTEX_CONTEXT); m_disc = true; m_conn = NULL; m_discStatus = ER_UDP_EARLY_EXIT; m_lock.Unlock(MUTEX_CONTEXT); } /** * Get the disconnected status. If the stream has been disconnected, return * true otherwise false. */ bool GetDisconnected() { QCC_DbgTrace(("ArdpStream::Disconnected(): -> %s", m_disc ? "true" : "false")); return m_disc; } /** * In the case of a local disconnect, disc sent means that ARDP_Disconnect() * has been called. Determine if this call has been made or not. */ bool GetDiscSent() { QCC_DbgTrace(("ArdpStream::GetDiscSent(): -> %s", m_discSent ? "true" : "false")); return m_discSent; } /** * In the case of a remote disconnect, disc status reflects the reason the * stream was disconnected. In the local case, will be ER_OK until the * disconnect happens, then will be ER_UDP_LOCAL_DISCONNECT. */ QStatus GetDiscStatus() { QCC_DbgTrace(("ArdpStream::GetDiscStatus(): -> \"%s\"", QCC_StatusText(m_discStatus))); return m_discStatus; } /** * Process a disconnect event, either local or remote. */ void Disconnect(bool sudden, QStatus status) { QCC_DbgTrace(("ArdpStream::Disconnect(sudden==%d., status==\"%s\")", sudden, QCC_StatusText(status))); QCC_DbgPrintf(("ArdpStream::Disconnect(): ConnId == %d.", m_connId)); /* * A "sudden" disconnect is an unexpected or unsolicited disconnect * initiated from the remote side. In this case, we will have have * gotten an ARDP DisconnectCb() which tells us that the connection is * gone and we shouldn't use it again. * * If sudden is not true, then this is as a result of a local request to * terminate the connection. This means we need to call ARDP and let it * know we are disconnecting. We wait for the DisconnectCb() that must * happen as a result of the ARDP_Disconnect() to declare the connection * completely gone. * * The details can get very intricate becuase once a remote side has * disconnected, we can get a flood of disconnects from different local * users of the endopint as the daemon figures out what it no longer * needs as a result of a remote endpoint going away. We just have to * harden ourselves against many duplicate calls. There are three bits * to worry about (sudden, m_discSent, and m_disc) and so there are * eight possibile conditions/states here. We just break them all out. */ #ifndef NDEBUG if (status == ER_OK) { assert(sudden == false); } if (sudden) { assert(status != ER_OK); } #endif QCC_DbgPrintf(("ArdpStream::Disconnect(): sudden==%d., m_disc==%d., m_discSent==%d., status==\"%s\"", sudden, m_disc, m_discSent, QCC_StatusText(status))); m_lock.Lock(MUTEX_CONTEXT); if (sudden == false) { if (m_disc == false) { if (m_discSent == false) { /* * sudden = false, m_disc = false, m_discSent == false * * This is a new solicited local disconnect event that is * happening on a stream that has never seen a disconnect * event. We need to do an ARDP_Disconnect() to start the * disconnect process. We expect status to be * ER_UDP_LOCAL_DISCONNECT by contract. If we fail to send * the ARDP_Disconnect() the disconnect status is updated * to the reason we couldn't send it. */ assert(status == ER_UDP_LOCAL_DISCONNECT && "ArdpStream::Disconnect(): Unexpected status"); m_transport->m_ardpLock.Lock(); QCC_DbgPrintf(("ArdpStream::Disconnect(): ARDP_Disconnect()")); status = ARDP_Disconnect(m_handle, m_conn); m_transport->m_ardpLock.Unlock(); if (status == ER_OK) { m_discSent = true; m_discStatus = ER_UDP_LOCAL_DISCONNECT; } else { QCC_LogError(status, ("ArdpStream::Disconnect(): Cannot send ARDP_Disconnect()")); m_disc = true; m_conn = NULL; m_discSent = true; m_discStatus = status; } /* * Tell the endpoint manager that something interesting has * happened */ m_transport->m_manage = UDPTransport::STATE_MANAGE; m_transport->Alert(); } else { /* * sudden = false, m_disc = false, m_discSent == true * * This disconnect event is happening as a result of the * ARDP disconnect callback. We expect that the status * passed in is ER_OK to confirm that this is the response * to the ARDP_Disconnect(). This completes the locally * initiated disconnect process. If this happens, we expect * status to be ER_OK by contract and we expect the * disconnect status to have been set to * ER_UDP_LOCAL_DISCONNECT by us. */ assert(status == ER_OK && "ArdpStream::Disconnect(): Unexpected status"); assert(m_discStatus == ER_UDP_LOCAL_DISCONNECT && "ArdpStream::Disconnect(): Unexpected status"); m_disc = true; m_conn = NULL; /* * Tell the endpoint manager that something interesting has * happened */ m_transport->m_manage = UDPTransport::STATE_MANAGE; m_transport->Alert(); } } else { if (m_discSent == false) { /* * sudden = false, m_disc = true, m_discSent == false * * This is a locally initiated disconnect that happens as a * result of a previously received remote disconnect. This * can happen when the daemon begins dereferencing * (Stopping) endpoints as a result of a previously reported * disconnect. * * The connection should already be gone. */ assert(m_conn == NULL && "ArdpStream::Disconnect(): m_conn unexpectedly live"); assert(m_disc == true && "ArdpStream::Disconnect(): unexpectedly not disconnected"); } else { /* * sudden = false, m_disc = true, m_discSent == true * * This is a locally initiated disconnect that happens after * a local disconnect that has completed (ARDP_Disconnect() * has been called and its DisconnectCb() has been received. * This can happen when the daemon begins dereferencing * (Stopping) endpoints as a result of a previously reported * disconnect but is a little slow at doing so. * * The connection should already be gone. */ assert(m_conn == NULL && "ArdpStream::Disconnect(): m_conn unexpectedly live"); assert(m_disc == true && "ArdpStream::Disconnect(): unexpectedly not disconnected"); } } } else { if (m_disc == false) { if (m_discSent == false) { /* * sudden = true, m_disc = false, m_discSent == false * * This is a new unsolicited remote disconnect event that is * happening on a stream that has never seen a disconnect * event. */ m_conn = NULL; m_disc = true; m_discStatus = status; } else { /* * sudden = true, m_disc = false, m_discSent == true * * This is an unsolicited remote disconnect event that is * happening on a stream that has previously gotten a local * disconnect event and called ARDP_Disconnect() but has not * yet received the DisconnectCb() as a result of that * ARDP_Disconnect(). * * This indicates a race between the local disconnect and a * remote disconnect. Any sudden disconnect means the * connection is gone; so a remote disconnect trumps an * in-process local disconnect. This means we go right to * m_disc = true. We'll leave the original m_discStatus * alone. */ m_conn = NULL; m_disc = true; } } else { if (m_discSent == false) { /* * sudden = true, m_disc = true, m_discSent == false * * This is a second unsolicited remote disconnect event that * is happening on a stream that has previously gotten a * remote disconnect event -- a duplicate in other words. * We'll leave the original m_discStatus alone. * * The connection should already be gone. */ assert(m_conn == NULL && "ArdpStream::Disconnect(): m_conn unexpectedly live"); assert(m_disc == true && "ArdpStream::Disconnect(): unexpectedly not disconnected"); } else { /* * sudden = true, m_disc = true, m_discSent == true * * This is an unsolicited remote disconnect event that is * happening on a stream that has previously gotten a local * disconnect event that has completed. We have already * called ARDP_Disconnect() and gotten the DisconnectCb() * and the connection is gone. This can happen if both * sides decide to take down connections at about the same * time. We'll leave the original m_discStatus alone. * * The connection should already be gone. */ assert(m_conn == NULL && "ArdpStream::Disconnect(): m_conn unexpectedly live"); assert(m_disc == true && "ArdpStream::Disconnect(): unexpectedly not disconnected"); } } } #ifndef NDEBUG if (sudden) { assert(m_disc == true); } #endif m_lock.Unlock(MUTEX_CONTEXT); } /** * This is the data sent callback which is plumbed from the ARDP protocol up * to this stream. This callback means that the buffer is no longer * required and may be freed. The ARDP protocol only had temporary custody * of the buffer. */ void SendCb(ArdpHandle* handle, ArdpConnRecord* conn, uint8_t* buf, uint32_t len, QStatus status) { QCC_UNUSED(handle); QCC_UNUSED(conn); QCC_UNUSED(len); QCC_UNUSED(status); QCC_DbgTrace(("ArdpStream::SendCb(handle=%p, conn=%p, buf=%p, len=%d.)", handle, conn, buf, len)); m_transport->m_cbLock.Lock(); --m_sendsOutstanding; #if SENT_SANITY set::iterator i = find(m_sentSet.begin(), m_sentSet.end(), buf); if (i == m_sentSet.end()) { QCC_LogError(ER_FAIL, ("ArdpStream::SendCb(): Callback for unexpected buffer (%p, %d.): Ignored.", buf, len)); } else { m_sentSet.erase(i); } #endif m_transport->m_cbLock.Unlock(); #ifndef NDEBUG CheckSeal(buf + len); #endif delete[] buf; /* * If there are any threads waiting for a chance to send bits, wake them * up. They will retry their sends when this event gets set. If the * send callbacks are part of normal operation, the sends may succeed * the next time around. If this callback is part of disconnect * processing the next send will fail with an error; and PushBytes() * will manage the outstanding write count. */ if (m_writeCondition) { QCC_DbgPrintf(("ArdpStream::SendCb(): Condition::Signal()")); m_writeCondition->Signal(); } } class ThreadEntry { public: qcc::Thread* m_thread; ArdpStream* m_stream; }; private: ArdpStream(const ArdpStream& other); ArdpStream operator=(const ArdpStream& other); UDPTransport* m_transport; /**< The transport that created the endpoint that created the stream */ _UDPEndpoint* m_endpoint; /**< The endpoint that created the stream */ ArdpHandle* m_handle; /**< The handle to the ARDP protocol instance this stream works with */ ArdpConnRecord* m_conn; /**< The ARDP connection associated with this endpoint / stream combination */ uint32_t m_connId; /**< The ARDP connection identifier */ qcc::Mutex m_lock; /**< Mutex that protects m_threads and disconnect state */ bool m_disc; /**< Set to true when ARDP fires the DisconnectCb on the associated connection */ bool m_discSent; /**< Set to true when the endpoint calls ARDP_Disconnect */ QStatus m_discStatus; /**< The status code that was the reason for the last disconnect */ qcc::Condition* m_writeCondition; /**< The write event that callers are blocked on to apply backpressure */ int32_t m_sendsOutstanding; /**< The number of Message sends that are outstanding (in-flight) with ARDP */ std::set m_threads; /**< Threads that are wandering around in the stream and possibly associated endpoint */ #if SENT_SANITY std::set m_sentSet; #endif class BufEntry { public: BufEntry() : m_buf(NULL), m_len(0), m_pulled(0), m_rcv(NULL), m_cnt(0) { } uint8_t* m_buf; uint16_t m_len; uint16_t m_pulled; ArdpRcvBuf* m_rcv; uint16_t m_cnt; }; }; bool operator<(const ArdpStream::ThreadEntry& lhs, const ArdpStream::ThreadEntry& rhs) { return lhs.m_thread < rhs.m_thread; } /* * A class to encapsulate a queue of messages to be dispatched and an associated * thread to pump the messages. * * Whevever we have an AllJoyn Message that is ready for delivery, ideally we * would just hand it off to the daemon router by calling PushMessage and the * router would just deliver it. There is a problem though. What the router * does is to look up the destination endpoint(s) -- there may be more than one * if we have a signal -- and it will stick the messages on the receive queue * for the endpoint(s). The catch is that if the endpoint receive queue is full * (because the endpoint is not consuming messages fast enough) the router will * block the calling thread. If we were to allow the UDP Transport message * dispatcher thread itselfto block, it would essentially stop the entire UDP * Transport until the destination endpoint in question got around to doing * something about its messages. We cannot allow that to happen. * * We want to apply backpressure directly to the source if a message cannot be * delivered. The way to do that is to avoid calling ARDP_RecvReady() until the * message is delivered. Backpressure will not be applied at the other side * until the maximum number of in-flight messages are queued. This means that * we need to be able to accommodate ardpConfig.segmax messages queued up for * each endpoint. * * The phenomenon of the destination queue filling up has been called the "slow * reader problem." Daemon Router-based solutions are being considered, but we * have to do something now; so we solve the problem by having a thread other * than the message dispatcher thread dispatch the PushMessage to the router. * The RemoteEndpoint has a pool of up to 100 threads available, but they are * deeply wired down into the concept of a stream socket, which we don't use. * So the thread in question lives here. * * It is relatively cheap to spin up a thread, but this behavior is highly * platform dependent so we don't want to do this arbitrarily frequently. Since * our threads consume at least one qcc::Event which, in turn, consumes one or * two FDs, we need to be careful about leaving lots of them around. This leads * to a design wjere we associate a thread with an endpoint in an on-demand * basis, with the thread exiting after some relatively short period of non-use, * but hanging around for bursts of messages. */ class MessagePump { public: MessagePump(UDPTransport* transport) : m_transport(transport), m_lock(), m_activeThread(NULL), m_pastThreads(), m_queue(), m_condition(), m_spawnedThreads(0), m_stopping(false) { QCC_DbgTrace(("MessagePump::MessagePump()")); } virtual ~MessagePump() { QCC_DbgTrace(("MessagePump::~MessagePump()")); QCC_DbgTrace(("MessagePump::~MessagePump(): Dealing with threads")); Stop(); Join(); QCC_DbgTrace(("MessagePump::~MessagePump(): Dealing with remaining queued messages")); while (m_queue.empty() == false) { QueueEntry entry = m_queue.front(); m_queue.pop(); m_transport->m_ardpLock.Lock(); ARDP_RecvReady(entry.m_handle, entry.m_conn, entry.m_rcv); m_transport->m_ardpLock.Unlock(); } assert(m_queue.empty() && "MessagePump::~MessagePump(): Message queue must be empty here"); assert(m_activeThread == NULL && "MessagePump::~MessagePump(): Active thread must be gone here"); assert(m_pastThreads.empty() && "MessagePump::~MessagePump(): Past threads must be gone here"); QCC_DbgTrace(("MessagePump::~MessagePump(): Done")); } /* * Determine whether or not there is an active pump thread that may be wanting to * call out to the daemon. */ bool IsActive() { QCC_DbgTrace(("MessagePump::IsActive()")); bool ret = m_activeThread != NULL; QCC_DbgPrintf(("MessagePump::IsActive() => \"%s\"", ret ? "true" : "false")); return ret; } /* * The Message Pump doesn't inherit from qcc::Thread so it isn't going to * Start(), Stop() and Join() direcly. It HASA Thread That is Start()ed * on-demand. We do implement Stop() to allow us to do something when we * need to cause the pump thread to stop. */ QStatus Stop() { QCC_DbgTrace(("MessagePump::Stop()")); QStatus status = ER_OK; /* * There may be at most one m_activeThread running. We need to set its * state to STOPPING. This thread isn't going to be waiting on its stop * event though. In order to minimize the number of events we create, * it will be waiting on a condition variable and then test for stopping * whenever it wakes up. So we have to call Stop() to set the state and * then Signal() our condition variable to wake up the thread. */ m_lock.Lock(); m_stopping = true; if (m_activeThread) { QCC_DbgPrintf(("MessagePump::Stop(): m_activeThread->Stop()")); m_activeThread->Stop(); QCC_DbgPrintf(("MessagePump::Stop(): m_condition.Signal()")); m_condition.Signal(); } #ifndef NDEBUG else { QCC_DbgPrintf(("MessagePump::Stop(): m_activeThread is NULL")); } #endif m_lock.Unlock(); QCC_DbgTrace(("MessagePump::Stop() => \"%s\"", QCC_StatusText(status))); return status; } /* * The Message Pump doesn't inherit from qcc::Thread so it isn't going to * Start(), Stop() and Join() direcly. It HASA Thread That is Start()ed * on-demand and can be Stop()ped. It also HASA list of threads that have * decided to shut down. We implement Join() to allow us to join *all* of * those threads when we need the pump to shut down */ QStatus Join() { QCC_DbgTrace(("MessagePump::Join()")); return DoJoin(true); } /* * The Message Pump doesn't inherit from qcc::Thread so it isn't going to * Start(), Stop() and Join() direcly. It HASA Thread That is Start()ed * on-demand and can be Stop()ped. It also HASA list of threads that have * decided to shut down. We implement JoinPast() to allow the endpoint * management thread to join those shutdown threads but allow an active * thread to continue running. */ QStatus JoinPast() { QCC_DbgTrace(("MessagePump::JoinPast()")); return DoJoin(false); } /* * Common internal method implementing both flavors of join. */ QStatus DoJoin(bool both) { QCC_DbgTrace(("MessagePump::DoJoin(both=\"%s\")", both ? "true" : "false")); QStatus status = ER_OK; /* * There may be at most one m_activeThread running and there may be a * set of past threads that need Join()ing. We expect that the active * thread will stop and put itself on the past threads queue. So we * need to join all of the threads on the past threads queue until the * spawned thread count goes to zero. We also expect that pump threads * will time out and exit if unused and the endpoint manager will have * periodically joined any past threads so this may not happen much in * practice. */ m_lock.Lock(); while (m_spawnedThreads) { QCC_DbgPrintf(("MessagePump::DoJoin(): m_spawnedThreads=%d.", m_spawnedThreads)); assert((m_activeThread ? 1 : 0) + m_pastThreads.size() == m_spawnedThreads && "MessagePump::DoJoin(): m_spawnedThreads count inconsistent"); if (m_pastThreads.size()) { PumpThread* pt = m_pastThreads.front(); m_pastThreads.pop(); --m_spawnedThreads; m_lock.Unlock(); QStatus status = pt->Join(); if (status != ER_OK) { QCC_LogError(status, ("MessagePump::DoJoin: PumpThread Join() error")); } delete pt; pt = NULL; m_lock.Lock(); } else { /* * If there is a spawned thread left and no threads on the * past threads list, it means that there is an acive thread * that has not yet stopped. Since the endpoint manager wants * to clean up zombies periodically, it needs to be able to * Join() past threads but not the active thread. It calls * JoinPast() to do this, and JoinPast() calls DoJoin(both=false) * which sets both to false. The endpoint Join() needs to * wait for all threads to be joined so it calls Join() which * calls DoJoin(both=true). */ if (both) { /* * We need to wait for the active thread to put itself on * the past threads queue. * * TODO: use condition variable and thread exit routine * instead of sleeping/polling. */ assert(m_stopping == true && "MessagePump::DoJoin(): m_stopping must be true if both=true)"); m_lock.Unlock(); qcc::Sleep(10); m_lock.Lock(); /* * We are taking and giving the mutex lock constantly in * order to call out to Join() in particular which might * block. Since we are turning loose of the lock, it could * be the case that there are race conditions between the * Stop() and condition Signal that is going to drive the * active thread to exit, and the spinning up of new active * threads. In order to prevent waiting around forever, we * keep poking the active thread as we wait for it to go * away. */ if (m_activeThread) { m_activeThread->Stop(); m_condition.Signal(); } } else { /* * Okay to leave the m_activeThread unJoin()ed. */ break; } } } #ifndef NDEBUG if (both) { assert(m_spawnedThreads == 0 && "MessagePump::DoJoin(): m_spawnedThreads must be 0 after DoJoin(true)"); } else { assert(m_spawnedThreads <= 1 && "MessagePump::DoJoin(): m_spawnedThreads must be 0 or 1 after DoJoin(false)"); } #endif m_lock.Unlock(); QCC_DbgPrintf(("MessagePump::DoJoin(): m_spawnedThreads=%d. at return", m_spawnedThreads)); QCC_DbgPrintf(("MessagePump::DoJoin() => \"%s\"", QCC_StatusText(status))); return status; } void RecvCb(ArdpHandle* handle, ArdpConnRecord* conn, uint32_t connId, ArdpRcvBuf* rcv, QStatus status) { QCC_DbgTrace(("MessagePump::RecvCb(handle=%p, conn=%p, connId=%d., rcv=%p, status=%s)", handle, conn, connId, rcv, QCC_StatusText(status))); assert(status == ER_OK && "MessagePump::RecvCb(): Asked to dispatch an error!?"); /* * We always want to pump the message in the callback so create a queue * entry and push it onto the queue. If we start a thread, the first * thing it will do is to check the condition (queue is not empty) so it * will handle this entry. If it turns out that there is a thread that * has stopped we don't want to spin up a new thread, but we can queue * up the message which will be handled when the pump is cleaned up. */ m_lock.Lock(); QueueEntry entry(handle, conn, connId, rcv, status); m_queue.push(entry); /* * RecvCb() callbacks can continue to happen after we have stopped the * active thread, so make sure we don't spin up a new thread that might * after we acknowledge a Stop() request. */ if (m_stopping) { QCC_DbgPrintf(("MessagePump::RecvCb(): Stopping")); m_lock.Unlock(); return; } /* * The thread rules: If there is no pump thread in existence, create one * and start it running. Put the PumpThread* into m_activeThread. If * there is a PumpThread* in m_activeThread, it must be running. If you * want to stop a pump thread you must remove it from m_activeThread * before you do the stop. If a thread detects it is no longer needed * (the wait times out) it will remove itself as the active thread and * put itself on the past threads list so it can be Join()ed. * * Here's a tricky question: what happens if we can allocate a pump * thread object but we can't start the pump thread? We need the thread * to do something with the data, but we have no thread. We could sit * in a loop trying to spawn a thread here. but that would block ARDP * that is trying to get rid of incoming messages. We can wait for a * next incoming message to try again, but since the thread is going to * open the receive window we will only get SEGMAX tries and then the * process stalls. If no new connection happens to start driving the * process again, the messages simply remain on the input queue. We * choose bailing and waiting for a new message to drive the process * since if we cannot spin up a thread, we have bigger problems than * a temporarily stalled message. The bytes aren't lost, they are * temporarily stashed until things maybe get better. We hope ARDP * is understanding. */ if (m_activeThread == NULL) { QCC_DbgPrintf(("MessagePump::RecvCb(): Spin up new PumpThread")); m_activeThread = new PumpThread(this); QStatus status = m_activeThread->Start(NULL, NULL); /* * The choice described in the above comment. */ if (status != ER_OK) { delete m_activeThread; m_activeThread = NULL; m_lock.Unlock(); return; } else { ++m_spawnedThreads; } } QCC_DbgPrintf(("MessagePump::RecvCb(): m_spawnedThreads=%d.", m_spawnedThreads)); assert(m_activeThread && "MessagePump::RecvCb(): Expecting an active thread at this time."); /* * It may be the case that the active thread is stopping but it has not * yet moved its pointer m_activeThread to the list of past threads. In * this case, there will be nobody to read and dispatch the queue entry * correcponding to the RecvCb. We expect that if the thread * IsStopping() it must be because someone has called Stop() on the * message pump, and the place where this is done is in the endpoint * Stop() method. This means that the endpoint is in the process of * being torn down. When the message pump is eventually deleted, the * queued messages will be pulled off the queue and returned to ARDP. * The upshot is that it is okay that the thread is stopping. We return * any queued messages in the order that we received them in the * destructor. We just print a message that this is happening in debug * mode. */ #ifndef NDEBUG if (m_activeThread->IsStopping()) { QCC_DbgPrintf(("MessagePump::RecvCb(): Thread stopping.")); } #endif /* * Signal the condition to wake up an existing thread that may be asleep * waiting for something to do. */ m_condition.Signal(); m_lock.Unlock(); } private: class QueueEntry { public: QueueEntry(ArdpHandle* handle, ArdpConnRecord* conn, uint32_t connId, ArdpRcvBuf* rcv, QStatus status) : m_handle(handle), m_conn(conn), m_connId(connId), m_rcv(rcv), m_status(status) { } ArdpHandle* m_handle; ArdpConnRecord* m_conn; uint32_t m_connId; ArdpRcvBuf* m_rcv; QStatus m_status; }; class PumpThread : public qcc::Thread { public: PumpThread(MessagePump* pump) : qcc::Thread(qcc::String("PumpThread")), m_pump(pump) { } void ThreadExit(Thread* thread); protected: qcc::ThreadReturn STDCALL Run(void* arg); private: MessagePump* m_pump; }; UDPTransport* m_transport; /**< The UDP Transport instance associated with this pump */ qcc::Mutex m_lock; /**< Mutex that protects multithread access to the queue */ PumpThread* m_activeThread; /**< Thread doing the actual work */ std::queue m_pastThreads; /**< Queue of transient threads have shut down or are shutting and need to be joined */ std::queue m_queue; /**< Queue of received messages and associated data to dispatch to the router */ qcc::Condition m_condition; /**< Condition variable coordinating consumption of queue entries by the pump thread */ uint32_t m_spawnedThreads; /**< The number of threads that have been spawned but not joined */ bool m_stopping; /**< True if Stop() has been called and we shouldn't spin up new threads */ }; /* * An endpoint class to abstract the notion of an addressible point in the * network. Endpoints are used by the Routing Node to deal with the details of * moving bits from here to there. */ class _UDPEndpoint : public _RemoteEndpoint { public: /** * The UDP Transport is a flavor of a RemoteEndpoint. The daemon thinks of * remote endpoints as moving through a number of states, some that have * threads wandering around and some that do not. In order to make sure we * are in agreement with what the daemon things we will be doing we keep * state regarding what threads would be doing if they were actually here * and running. We also keep track of how endpoints were started and how * they move through the process from construction to running. * * * +----------------+ * | EP_INITIALIZED | * +----------------+ * | | * Connect() | | AcceptCb() * | | * +-----------+ +-----------+ * | | * v v * +-------------------+ +--------------------+ * | EP_ACTIVE_STARTED | | EP_PASSIVE_STARTED | * +-------------------+ +--------------------+ * | | * Handshake | | Handshake * +-----------+ +-----------+ * Daemon Register | | Daemon Register * v v * +----------------+ * | EP_STARTED | * +----------------+ * | * Shut down | <----------------------+ * | | Idle * v | * +----------------+ +----------------+ * | EP_STOPPING | -------> | EP_WAITING | * +----------------+ local +----------------+ * | disconnect * Thread join | * v * +----------------+ * | EP_JOINED | * +----------------+ * | * Daemon Unregister | * v * +----------------+ * | EP_DONE | * +----------------+ * * * When an endoint is constructed, it begins its live in EP_INITIALIZED. * endpoints are constructed for the purpose of service passive or active * connections. A passive connection is one that is driven from a connection * coming in from a remote host. An active connection is one that is driven * by a local thread calling UDPTransport::Connect(). * * When an inbound connection causes an accept callback to fire, AcceptCb() * will create a UDP Endpoint and set the state to EP_PASSIVE_STARTED. * These endoints are put on the m_preList for deadlock avoidance and are * then quickly moved to the m_authList where they wait for authentication * to complete. When the three-way ARDP handshake completes, as indicated * by a DoConnectcb() firing for that connection, the endpoint is removed * from the m_authList and put on the running endpoint list. Since Start() * can't be called with locks held (it calls out to the daemon router), it * is actually called after the endpoint goes onto the endpoint list, * meaning we will see endpoints in state EP_PASSIVE_STARTED for short * periods of time on the running endpoints list. * * When an outbound connection causes a UDP Endpoint to be created the endpoint * is set to state EP_ACTIVE_STARTED. This is done in the DoConnectCB() function * that indicates that the three-way handshake has completed. For the same * deadlock-avoidance reason as in the passive case, the endpoint is placed on the * running endpoint list and then Start() is called. This means will will see * endpoints on the running endpoint list for transient periods of time in state * EP_ACTIVE_STARTED. * * Once started, it means that the endpoint is connected (registered) to the * daemon router and is happily running and capable of pumping messages in and * out. * * As soon as either the local side or the remote side decides that the * endpoint has been around long enough, Stop() is called. This may happen * either due to a Disconnect callback in the case of the remote side, or a * Stop() called as the result of a LeaveSession on the local side. It is * possible that there are multiple threads running around in the endpoint * due to unconsumed remote messages making their way through the router, * unsent messages of local origin making their way down to ARDP, or threads * trying to PushMessage into the endpoint. The transition into state * EP_STOPPING means the no new operations are allowed on the endpoint and * the process of causing all threads to abort and leave the endpoint are * started. * * If the source of the disconnect is a local LeaveSession, we need to * simulate socket shutdown behavior. Specifically, we simulate * shutdown(sockfd, SHUT_RDWR) which is what is done in the TCP Transport. * In this state, we wait until all buffers sent to ARDP have been disposed * of one way or another. If the other side receives all queued buffers and * acknowledges them we have a clean endpoint shutdown. This additional state * is called EP_WAITING and is enabled only if a local (expected) disconnect * has been received. * * After the endpoint is EP_STOPPING and EP_WAITING is not enabled, or if * the endpoint is EP_WAITING and queued buffers are fully sent, the * endpoint management function notices the situation and then calls Join() * to mark the endpoint as being thread-free, buffer-free ande ready to * close. This causes the endpoint to enter the EP_JOINED state. * * Once an endpoint is in state EP_JOINED, an exit function is scheduled to * be run to make sure the endpoint is completely disconnected from the * daemon router. This Exit() function will set the endpoint state to * EP_DONE when its job is done. * * If the endpoint is in state EP_DONE, the endpoint management thread will * remove it from the running endpoint list and delete it. */ enum EndpointState { EP_ILLEGAL = 0, EP_INITIALIZED, /**< The endpoint structure has been allocated but not used */ EP_ACTIVE_STARTED, /**< The endpoint has begun the process of coming up, due to a passive connection request */ EP_PASSIVE_STARTED, /**< The endpoint has begun the process of coming up, due to a passive connection request */ EP_STARTED, /**< The endpoint is ready for use, registered with daemon, maybe threads wandering thorugh */ EP_STOPPING, /**< The endpoint is stopping but join has not been called */ EP_WAITING, /**< Waiting for ARDP to send any queued data before closing (disconnecting) */ EP_JOINED, /**< The endpoint is stopping and join has been called */ EP_DONE /**< Threads have been shut down and joined */ }; #ifndef NDEBUG void PrintEpState(const char* prefix) { switch (m_epState) { case EP_INITIALIZED: QCC_DbgPrintf(("%s: EP_INITIALIZED", prefix)); break; case EP_ACTIVE_STARTED: QCC_DbgPrintf(("%s: EP_ACTIVE_STARTED", prefix)); break; case EP_PASSIVE_STARTED: QCC_DbgPrintf(("%s: EP_PASSIVE_STARTED", prefix)); break; case EP_STARTED: QCC_DbgPrintf(("%s: EP_STARTED", prefix)); break; case EP_STOPPING: QCC_DbgPrintf(("%s: EP_STOPPING", prefix)); break; case EP_WAITING: QCC_DbgPrintf(("%s: EP_WAITING", prefix)); break; case EP_JOINED: QCC_DbgPrintf(("%s: EP_JOINED", prefix)); break; case EP_DONE: QCC_DbgPrintf(("%s: EP_DONE", prefix)); break; default: QCC_DbgPrintf(("%s: Bad state", prefix)); assert(false && "_Endpoint::PrintEpState(): Bad state"); break; } } #endif /** * Connections can either be created as a result of incoming or outgoing * connection requests. If a connection happens as a result of a Connect() * it is the active side of a connection. If a connection happens because * of an accept of an inbound ARDP SYN it is the passive side of an ARDP * connection. This is important because of reference counting of * bus-to-bus endpoints. The daemon calls Connect() or ARDP calls * AcceptCb() to form connections. The daemon actually never calls * disconnect, it removes a final reference to a remote endpoint. ARDP * does, however call a disconnect callback. */ enum SideState { SIDE_ILLEGAL = 0, SIDE_INITIALIZED, /**< This endpoint structure has been allocated but don't know if active or passive yet */ SIDE_ACTIVE, /**< This endpoint is the active side of a connection */ SIDE_PASSIVE /**< This endpoint is the passive side of a connection */ }; /** * Construct a remote endpoint suitable for the UDP transport. */ _UDPEndpoint(UDPTransport* transport, BusAttachment& bus, bool incoming, const qcc::String connectSpec) : _RemoteEndpoint(bus, incoming, connectSpec, NULL, transport->GetTransportName(), false, true), m_transport(transport), m_stream(NULL), m_handle(NULL), m_conn(NULL), m_id(0), m_ipAddr(), m_ipPort(0), m_registered(false), m_sideState(SIDE_INITIALIZED), m_epState(EP_INITIALIZED), m_tStart(qcc::Timespec(0)), m_tStop(qcc::Timespec(0)), m_tWaitStart(qcc::Timespec(0)), m_tStall(qcc::Timespec(0)), m_remoteExited(false), m_exitScheduled(false), m_disconnected(false), m_refCount(0), m_pushCount(0), m_stateLock(), m_wait(true) { QCC_DbgHLPrintf(("_UDPEndpoint::_UDPEndpoint(transport=%p, bus=%p, incoming=%d., connectSpec=\"%s\")", transport, &bus, incoming, connectSpec.c_str())); } /** * Destroy a UDP transport remote endpoint. */ virtual ~_UDPEndpoint() { QCC_DbgHLPrintf(("_UDPEndpoint::~_UDPEndpoint()")); QCC_DbgHLPrintf(("_UDPEndpoint::~_UDPEndpoint(): m_refCount==%d.", m_refCount)); QCC_DbgHLPrintf(("_UDPEndpoint::~_UDPEndpoint(): m_pushCount==%d.", m_pushCount)); /* * Double check that the remote endpoint is sure that its threads are gone, * since our destructor is going to call its Stop() and Join() anyway. * before deleting it. */ _RemoteEndpoint::Stop(); _RemoteEndpoint::Exited(); _RemoteEndpoint::Join(); assert(IncrementAndFetch(&m_refCount) == 1 && "_UDPEndpoint::~_UDPEndpoint(): non-zero reference count"); assert(IncrementAndFetch(&m_pushCount) == 1 && "_UDPEndpoint::~_UDPEndpoint(): non-zero PushMessage count"); /* * Make sure that the endpoint isn't in a condition where a thread might * conceivably be wandering around in it. At this point, if everything * is working as expected there should be no reason for taking a lock, * but then again, if everything is working there also should be no * reason for an assert. */ if (m_stream) { /* * If we have gotten to this point, there certainly must have been a * call to Stop() which must have called the stream Disconnect(). This * means that it is safe to call delete the stream. We double-check * that there are no threads waiting on completions of send operations * and the ARDP connection is/was disconnected. */ assert(m_stream->ThreadSetEmpty() != false && "_UDPEndpoint::~_UDPEndpoint(): Threads present during destruction"); assert(m_stream->GetDisconnected() && "_UDPEndpoint::~_UDPEndpoint(): Not disconnected"); } DestroyStream(); } /** * This is to absolutely, positively ensure that there are no threads * wandering around in an endpoint, or are about to start wandering around * in an endpoint as it gets destroyed. */ uint32_t IncrementRefs() { return IncrementAndFetch(&m_refCount); } /** * This is to absolutely, positively ensure that there are no threads * wandering around in an endpoint, or are about to start wandering around * in an endpoint as it gets destroyed. */ uint32_t DecrementRefs() { return DecrementAndFetch(&m_refCount); } /** * Return the number of threads currently exectuting in and under * PushMessage(). The endpoint management code cannot make a decision about * sending an ARDP disconnect with the PushMessage count nonzero, since even * though there are no messages in-flight, PushMessage might continue * running and do a send which would be lost if an ARDP disconnect was done * before the ARDP_Send actually acknowledged the bits. */ uint32_t GetPushMessageCount() { return m_pushCount; } /** * Override Start() since we are not going to hook in IOdispatch or start TX and * RX threads or anything like that. */ QStatus Start() { IncrementAndFetch(&m_refCount); /* * Whenever we change state, we need to protect against multiple threads * trying to do something at the same time. Since state changes may be * initiated on threads that know nothing about our endpionts and what * state they are really in, we need to lock the endpoint list to make * sure nothing is changed out from under us. We are careful to keep * this lock order the same "everywhere." Since we are often called * from endpoint management code that holds the endpoint list lock, we * take that one first (reentrancy is enabled so we get it if we already * hold it). */ m_transport->m_endpointListLock.Lock(MUTEX_CONTEXT); m_stateLock.Lock(MUTEX_CONTEXT); /* * What state are are we coming from? */ #ifndef NDEBUG PrintEpState("_UdpEndpoint::Start()"); #endif QCC_DbgHLPrintf(("_UDPEndpoint::Start()")); QCC_DbgPrintf(("_UDPEndpoint::Start(): isBusToBus = %s, allowRemote = %s)", GetFeatures().isBusToBus ? "true" : "false", GetFeatures().allowRemote ? "true" : "false")); if (m_stream) { bool empty = m_stream->ThreadSetEmpty(); assert(empty && "_UDPEndpoint::Start(): Threads present during Start()"); if (empty == false) { QCC_LogError(ER_FAIL, ("_UDPEndpoint::Start(): Threads present during Start()")); m_stateLock.Unlock(MUTEX_CONTEXT); m_transport->m_endpointListLock.Unlock(MUTEX_CONTEXT); DecrementAndFetch(&m_refCount); return ER_FAIL; } } if (GetFeatures().isBusToBus) { QCC_DbgPrintf(("_UDPEndpoint::Start(): endpoint switching to ENDPOINT_TYPE_BUS2BUS")); SetEndpointType(ENDPOINT_TYPE_BUS2BUS); } #ifndef NDEBUG /* * Debug consistency check. If we are starting an endpoint it must be * on either the m_authList or the m_endpointList exactly once, and it * must be associated with an ARDP connection. */ uint32_t found = 0; for (set::iterator i = m_transport->m_authList.begin(); i != m_transport->m_authList.end(); ++i) { UDPEndpoint ep = *i; if (GetConnId() == ep->GetConnId()) { QCC_DbgPrintf(("_UDPEndpoint::Start(): found endpoint with conn ID == %d. on m_authList", GetConnId())); ++found; } } for (set::iterator i = m_transport->m_endpointList.begin(); i != m_transport->m_endpointList.end(); ++i) { UDPEndpoint ep = *i; if (GetConnId() == ep->GetConnId()) { QCC_DbgPrintf(("_UDPEndpoint::Start(): found endpoint with conn ID == %d. on m_endpointList", GetConnId())); ++found; } } assert(found == 1 && "_UDPEndpoint::Start(): Endpoint not on exactly one pending list"); #endif /* * No threads to Start(), so we jump right to started state. */ assert((IsEpPassiveStarted() || IsEpActiveStarted()) && "_UDPEndpoint::Start(): Endpoint not pre-started corrrectly"); SetEpStarted(); /* * We need to hook back into the router and do what RemoteEndpoint would have * done had we really started RX and TX threads. Since we know an instance of * this object is on exactly one of our endpoint lists, we'll get a reference * to a valid object here. */ SetStarted(true); BusEndpoint bep = BusEndpoint::wrap(this); /* * We know we hold a reference, so now we can call out to the daemon * with it. We also never call back out to the daemon with a lock held * since you really never know what it might do. We do keep the thread * reference count bumped since there is a thread that will wander back * out through here eventually. */ m_stateLock.Unlock(MUTEX_CONTEXT); m_transport->m_endpointListLock.Unlock(MUTEX_CONTEXT); QCC_DbgPrintf(("_UDPEndpoint::Start(): RegisterEndpoint()")); QStatus status = m_transport->m_bus.GetInternal().GetRouter().RegisterEndpoint(bep); if (status == ER_OK) { m_registered = true; } DecrementAndFetch(&m_refCount); return status; } /** * Perform the AllJoyn thread lifecycle Stop() operation. Unlike the * standard method, Stop() can be called multiple times in this transport * since not all operations are serialized through a single RemoteEndpoint * ThreadExit. * * Override RemoteEndpoint::Stop() since we are not going to unhook * IOdispatch or stop TX and RX threads or anything like that. */ QStatus Stop() { IncrementAndFetch(&m_refCount); QCC_DbgHLPrintf(("_UDPEndpoint::Stop()")); QCC_DbgPrintf(("_UDPEndpoint::Stop(): Unique name == %s, connId == %d.", GetUniqueName().c_str(), GetConnId())); /* * Whenever we change state, we need to protect against multiple threads * trying to do something at the same time. Since state changes may be * initiated on threads that know nothing about our endpionts and what * state they are really in, we need to lock the endpoint list to make * sure nothing is changed out from under us. We are careful to keep * this lock order the same "everywhere." Since we are often called * from endpoint management code that holds the endpoint list lock, we * take that one first (reentrancy is enabled so we get it if we already * hold it). */ m_transport->m_endpointListLock.Lock(MUTEX_CONTEXT); m_stateLock.Lock(MUTEX_CONTEXT); /* * What state are are we coming from? */ #ifndef NDEBUG PrintEpState("_UdpEndpoint::Stop()"); #endif /* * If we've never been completely started, there are not threads running * around inside us so all we have to do is to perform an EarlyExit() to * ensure that disconnect status is correct and wake up the endpoint * management thread whose resposibility it is for actually dealing with * Stop()ped endpoints. If we're doing an early exit we do not expect * there to be any threads waiting to be stopped. */ if (IsEpInitialized() || IsEpActiveStarted() || IsEpPassiveStarted()) { QCC_DbgPrintf(("_UDPEndpoint::Stop(): Never Start()ed")); if (m_stream) { assert(m_stream->ThreadSetEmpty() == true && "_UDPEndpoint::Stop(): Inactive endpoint with threads?"); m_stream->EarlyExit(); } /* * We were never started, so presumably there is no data buffered * and waiting to be sent. Disable the EP_WAITING state since it is * completely unnecessary. */ SetEpWaitEnable(false); SetEpStopping(); m_stateLock.Unlock(MUTEX_CONTEXT); m_transport->m_endpointListLock.Unlock(MUTEX_CONTEXT); m_transport->m_manage = UDPTransport::STATE_MANAGE; m_transport->Alert(); DecrementAndFetch(&m_refCount); return ER_OK; } /* * If we're already on the way toward being shut down or are actually * shut down, there's nothing to do since this function has already been * called at some earlier time. We will bug the endpoint managment * thread again to make sure it knows about us. Don't set the state to * EP_STOPPING here or it will possibly overwrite other completed work * if Stop() is called multiple times. */ if (IsEpStopping() || IsEpWaiting() || IsEpJoined() || IsEpDone()) { QCC_DbgPrintf(("_UDPEndpoint::Stop(): Already stopping, waiting, joined or done")); m_stateLock.Unlock(MUTEX_CONTEXT); m_transport->m_endpointListLock.Unlock(MUTEX_CONTEXT); DecrementAndFetch(&m_refCount); return ER_OK; } /* * By a process of elimination, the only possible state we could be in * is EP_STARTED. Did someone add a state and forget to handle it here? */ assert(IsEpStarted() == true && "_UDPEndpoint::Stop(): Endpoint expected to be in EP_STARTED state at this point"); QCC_DbgPrintf(("_UDPEndpoint::Stop(): Stopping while IsEpStarted()")); #ifndef NDEBUG /* * Debug consistency check. If we are stopping an endpoint it must be * on either the m_authList or the m_endpointList exactly once, and it * must be associated with an ARDP connection. */ uint32_t found = 0; for (set::iterator i = m_transport->m_authList.begin(); i != m_transport->m_authList.end(); ++i) { UDPEndpoint ep = *i; if (GetConnId() == ep->GetConnId()) { QCC_DbgPrintf(("_UDPEndpoint::Stop(): found endpoint with conn ID == %d. on m_authList", GetConnId())); ++found; } } for (set::iterator i = m_transport->m_endpointList.begin(); i != m_transport->m_endpointList.end(); ++i) { UDPEndpoint ep = *i; if (GetConnId() == ep->GetConnId()) { QCC_DbgPrintf(("_UDPEndpoint::Stop(): found endpoint with conn ID == %d. on m_endpointList", GetConnId())); ++found; } } assert(found == 1 && "_UDPEndpoint::Stop(): Endpoint not on exactly one pending list"); #endif /* * Set the state of the endpoint to stopping. This will prevent any * more PushMessage calls from starting operations in the endpoint and * will prevent any additional inbound data from being dispatched to the * Daemon Router. */ SetEpStopping(); m_transport->m_manage = UDPTransport::STATE_MANAGE; m_transport->Alert(); m_stateLock.Unlock(MUTEX_CONTEXT); m_transport->m_endpointListLock.Unlock(MUTEX_CONTEXT); DecrementAndFetch(&m_refCount); return ER_OK; } /** * Perform the AllJoyn thread lifecycle Join() operation. Join() can be called * multiple times. */ QStatus Join() { IncrementAndFetch(&m_refCount); QCC_DbgHLPrintf(("_UDPEndpoint::Join()")); QCC_DbgPrintf(("_UDPEndpoint::Join(): Unique name == %s", GetUniqueName().c_str())); /* * Whenever we change state, we need to protect against multiple threads * trying to do something at the same time. Since state changes may be * initiated on threads that know nothing about our endpionts and what * state they are really in, we need to lock the endpoint list to make * sure nothing is changed out from under us. We are careful to keep * this lock order the same "everywhere." Since we are often called * from endpoint management code that holds the endpoint list lock, we * take that one first (reentrancy is enabled so we get it if we already * hold it). */ m_transport->m_endpointListLock.Lock(MUTEX_CONTEXT); m_stateLock.Lock(MUTEX_CONTEXT); /* * What state are are we coming from? */ #ifndef NDEBUG PrintEpState("_UdpEndpoint::Join()"); #endif /* * If we've never been completely started, there are not threads running * around inside us so all we have to do is to perform an (actually * redundant) EarlyExit() to ensure that disconnect status is correct and * wake up the endpoint management thread whose resposibility it is for * actually dealing with Join()ed endpoints. If we're doing an early exit * we do not expect there to be any threads waiting to be stopped. */ if (IsEpInitialized() || IsEpActiveStarted() | IsEpPassiveStarted()) { QCC_DbgPrintf(("_UDPEndpoint::Join(): Never Start()ed")); if (m_stream) { m_stream->EarlyExit(); assert(m_stream->ThreadSetEmpty() == true && "_UDPEndpoint::Join(): Inactive endpoint with threads?"); } SetEpJoined(); /* * Tell the endpoint management code that something has happened * that it may be concerned about. */ m_transport->m_manage = UDPTransport::STATE_MANAGE; m_transport->Alert(); m_stateLock.Unlock(MUTEX_CONTEXT); m_transport->m_endpointListLock.Unlock(MUTEX_CONTEXT); DecrementAndFetch(&m_refCount); return ER_OK; } /* * The AllJoyn threading model requires that we allow multiple calls to * Join(). We expect that the first time through the state will be * EP_STOPPING, in which case we may have things to do. Once we have * done a successful Join(), the state will be EP_JOINED or eventually * EP_DONE all of which mean we have nothing left to do. Don't update * state here or we may overwrite other work that has previously taken * us to EP_DONE. */ if (IsEpJoined() || IsEpDone()) { QCC_DbgPrintf(("_UDPEndpoint::Join(): Already Join()ed")); m_stateLock.Unlock(MUTEX_CONTEXT); m_transport->m_endpointListLock.Unlock(MUTEX_CONTEXT); DecrementAndFetch(&m_refCount); return ER_OK; } /* * By a process of elimination, we are either in EP_STARTED, EP_WAITING * or EP_STOPPING state. It is a programming error to call Join() * without first calling Stop(). Calling Stop() will put us in either * EP_STOPPING or EP_WAITING state. */ assert((IsEpStopping() || IsEpWaiting()) && "_UDPEndpoint::Join(): Stop() not previously called or unexpected state"); QCC_DbgPrintf(("_UDPEndpoint::Join(): Join() from IsEpStopping() or IsEpWaiting()")); /* * The only way Join() will be called while we are in EP_WAITING state * is if the Transport itself starts shutting down. In this case, it is * pointless to wait until any outstanding writes are finished, but we * do need to do the disconnect and switch to EP_STOPPED. Calling * Disconnect will deal with causing ARDP to abort any outstanding * transactions. This last minute change of plans may cause us to poll * for completion of this cleanup in the sleep loop below. */ if (IsEpWaiting()) { QCC_DbgPrintf(("_UDPEndpoint::Join(): Join() from IsEpWaiting()")); ArdpStream* stream = GetStream(); if (stream) { QCC_DbgPrintf(("_UDPEndpoint::Join(): Local stream->Disconnect()")); stream->Disconnect(false, ER_UDP_LOCAL_DISCONNECT); } /* * Set the disconnect status of our underlying BusEndpoint so that * higher levels can determine what to do in response. ER_OK means * voluntary here, and we are presumably voluntarily shutting down. * Note that SetEpDisconnectStatus() may rewrite status code. */ SetEpDisconnectStatus(ER_OK); SetEpWaitEnable(false); SetEpStopping(); } /* * If there were any threads blocked waiting to get bytes through to a * remote host, they should have been woken up in Stop() and in the * normal course of events they should have woken up and left of their * own accord. ManageEndpoints should have waited for that to happen * before calling Join(). If we happen to get caught with active * endpoints alive when the TRANSPORT is shutting down, however, we may * have to wait for that to happen here. We can't do anything until * there are no threads wandering around in the endpoint or risk * crashing the daemon. We just have to trust that they will cooperate. */ int32_t timewait = m_transport->m_ardpConfig.timewait; while (m_stream && m_stream->ThreadSetEmpty() == false) { QCC_DbgPrintf(("_UDPEndpoint::Join(): Waiting for threads to exit")); /* * Make sure the threads are "poked" to wake them up. */ m_stream->WakeThreadSet(); /* * Note that we are calling Sleep() with both the endpoint list lock * and the state lock taken. This is dangerous from a deadlock * point of view, but the threads that we want to wake up are * waiting on an event in the ArdpStream associated with the * endpoint. They will never ask for one of our locks, so they * won't deadlock. What can happen is that we block either the * maintenance thread or the dispatcher for timwait milliseconds * (typically one second). This sounds bad, but we have added code * in the maintenance theread to wait until these threads are gone * beore calling Join() so in the normal course of events, this code * should never be executed. It is here to make sure threads are * gone before deleting the endpoint in the case of the UDP * Transport being torn down unexpectedly. In that case, it will * not be a problem to bock other threads, since they are going away * or are already gone. */ qcc::Sleep(10); timewait -= 10; if (timewait <= 0) { QCC_DbgPrintf(("_UDPEndpoint::Join(): TIMWAIT expired with threads pending")); break; } } /* * The same story as in the comment above applies to the disconnect callback. * We expect that in the normal course of events, the endpoint management * thread will wait until the disconnection process is complete before * actually calling Join. */ if (m_stream && m_stream->GetDisconnected() == false) { QCC_LogError(ER_UDP_NOT_DISCONNECTED, ("_UDPEndpoint::Join(): Not disconnected")); m_stream->EarlyExit(); } QCC_DbgPrintf(("_UDPEndpoint::Join(): Going to EP_JOINED")); SetEpJoined(); /* * Tell the endpoint management code that something has happened that * it may be concerned about. */ m_transport->m_manage = UDPTransport::STATE_MANAGE; m_transport->Alert(); m_stateLock.Unlock(MUTEX_CONTEXT); m_transport->m_endpointListLock.Unlock(MUTEX_CONTEXT); DecrementAndFetch(&m_refCount); return ER_OK; } /* * Stop() and Join() are relly internal to the UDP Transport threading model. * We can consider ourselves free to call Stop() and Join() from everywhere * and anywhere just so long as we don't release our reference to the endpoint * until after we are sure that the daemon has no more references to the * endpoint. * * The last thing we need to do is to arrange for all references to the * endpoint to be removed by calling DaemonRouter::UnregisterEndpoint(). * Unfortunately, the RemoteEndpoint has the idea of TX and RX threading * calling out into streams ingrained into it, so we can't just do this * shutdown ourselves. We really have to call into the RemoteEndpoint(). * We have an Exit() function there that does what needs to be done in the * case of no threads to call an exit callback, but we also have to be very * careful about calling it from any old thread context since * UnregisterEndoint() will need to take the daemon name table lock, which * is often held during call-outs. To avoid deadlocks, we need to esure * that calls to Exit() are done on our dispatcher thread which we know will * not be holding any locks. */ QStatus Exit() { IncrementAndFetch(&m_refCount); QCC_DbgHLPrintf(("_UDPEndpoint::Exit()")); /* * Whenever we change state, we need to protect against multiple threads * trying to do something at the same time. We have to be careful since * _RemoteEndpoint can happily call out to the daemon or call back into * our endpoint. Don't take any locks while the possibility exists of * the daemon wandering off and doing something. Whatever it is doing * the endpoint management code will hold a reference to the endpoint * until Exit() completes so we let the daemon go and grab the locks * after it returns. Note that we do increment the thread reference * count that indicates that a thread is wandering around and will pop * back up through this function sometime later. */ _RemoteEndpoint::Exit(); _RemoteEndpoint::Stop(); m_remoteExited = true; m_registered = false; m_transport->m_endpointListLock.Lock(MUTEX_CONTEXT); m_stateLock.Lock(MUTEX_CONTEXT); /* * Jump to done state. Our ManageEndpoints() will pick up on the fact * that this endpoint is done and deal with it by releasing any * references to it. */ QCC_DbgPrintf(("_UDPEndpoint::Exit(): Going to EP_DONE state")); SetEpDone(); /* * Tell the endpoint management code that something has happened that * it may be concerned about. */ m_transport->m_manage = UDPTransport::STATE_MANAGE; m_transport->Alert(); m_stateLock.Unlock(MUTEX_CONTEXT); m_transport->m_endpointListLock.Unlock(MUTEX_CONTEXT); DecrementAndFetch(&m_refCount); return ER_OK; } /** * Get a pointer to the UDP Transport that owns this Endpoint. */ UDPTransport* GetTransport() { return m_transport; } /** * Get the boolean indication that the RemoteEndpoint exit function has been * called. */ bool GetExited() { QCC_DbgHLPrintf(("_UDPEndpoint::GetExited(): -> %s", m_remoteExited ? "true" : "false")); return m_remoteExited; } /** * Set the boolean indication that the RemoteEndpoint exit function has been * scheduled. */ void SetExitScheduled() { QCC_DbgHLPrintf(("_UDPEndpoint::SetExitScheduled()")); m_exitScheduled = true; } /** * Get the boolean indication that the RemoteEndpoint exit function has been * scheduled. */ bool GetExitScheduled() { QCC_DbgHLPrintf(("_UDPEndpoint::GetExitScheduled(): -> %s", m_exitScheduled ? "true" : "false")); return m_exitScheduled; } /** * Get a boolean indication that the endpoint has been registered with the * daemon. */ bool GetRegistered() { QCC_DbgHLPrintf(("_UDPEndpoint::GetRegistered(): -> %s", m_registered ? "true" : "false")); return m_registered; } /** * Create a skeletal stream that we'll use basically as a place to hold some * connection information. */ void CreateStream(ArdpHandle* handle, ArdpConnRecord* conn, uint32_t dataTimeout, uint32_t dataRetries) { QCC_UNUSED(dataTimeout); QCC_UNUSED(dataRetries); IncrementAndFetch(&m_refCount); QCC_DbgHLPrintf(("_UDPEndpoint::CreateStream(handle=%p, conn=%p)", handle, conn)); m_transport->m_ardpLock.Lock(); assert(m_stream == NULL && "_UDPEndpoint::CreateStream(): stream already exists"); /* * The stream for a UDP endpoint is basically just a convenient place to * stick the connection identifier. For the TCP transport it is a real * stream that connects to an underlying socket stream. */ m_stream = new ArdpStream(); m_stream->SetTransport(m_transport); m_stream->SetEndpoint(this); m_stream->SetHandle(handle); m_stream->SetConn(conn); m_stream->SetConnId(ARDP_GetConnId(handle, conn)); /* * This is actually a call to the underlying endpoint that provides the * stream for Marshaling and unmarshaling. This is what hooks our * PushMessage() back into the ArdpStream PushBytes(). */ SetStream(m_stream); m_transport->m_ardpLock.Unlock(); DecrementAndFetch(&m_refCount); } /** * Get the ArdpStream* pointer to the skeletal stream associated with this * endpoint. */ ArdpStream* GetStream() { QCC_DbgTrace(("_UDPEndpoint::GetStream() => %p", m_stream)); return m_stream; } /** * Delete the skeletal stream that we used to stash our connection * information. */ void DestroyStream() { IncrementAndFetch(&m_refCount); QCC_DbgHLPrintf(("_UDPEndpoint::DestroyStream()")); if (m_stream) { assert(m_stream->GetConn() == NULL && "_UDPEndpoint::DestroyStream(): Cannot destroy stream unless stream's m_conn is NULL"); m_stream->SetHandle(NULL); delete m_stream; } m_stream = NULL; m_conn = NULL; DecrementAndFetch(&m_refCount); } /** * Take a Message destined to be send over the connection represented * by the UDP Endpoint and ask it to Deliver() itself though this * remote endpoint (we are a descendent). DeliverNonBlocking() will * end up calling PushBytes() on the Stream Sink associated with the * endpoint. This will find its way down to the PushBytes() defined * in our ARDP Stream. * * We have a bit of a tricky situation in that AllJoyn likes to send * fire-and-forget messages -- signals. It sometimes wants to make a * connection and send a bunch of signals and then disconnect. We can't * just call ARDP_Disconnect with signals queued for transmission which * would send RST and tear down the connection before those signals get * sent. Method calls are okay, since the caller needs to wait for the * return values, which indicates they were sent (and responded to) but * signals are a different beast. We need to simulate TCP's half-close * behavior. This means our version of a close needs to wait for ARDP to * send any queued messages before calling ARDP_Disconnect. * * A client will use JoinSession to drive the UDPTransport::Connect() that * we, in turn, use to drive ARDP_Connect(). When an AllJoyn client is * done with a connection it will call LeaveSession(). This will not call * a disconnect function, but will cause the associated endpoint to be * invalidated and will call UDPEndpoint::Stop(). This call to Stop() * begins the endpoint shutdown process, which must disallow any further * writes (enforce a SHUTDOWN_WR-like behavior) but keep the underlying * connection up until all data has been sent and acknowledged. At that * point, the ARDP_Disconnect() can be called and the endpoint actually * torn down. There is no Shutdown() on an Endpoint that causes it to * behave like a TCP state machine, so we get to implement that behavior * ourselves. * * This affects us here in that we have to respect a stopping indication on * the UDPEndpoint (as well as the transport). Since the message passed to * us is going to wander down through the endpoint into the stream and then * on out ARDP, we have to admit the possibility that even though ARDP may * not have heard about a message passing through here, it is in our system. * Therefore, we have a counter that indicates how many calls to * PushMessage() are in process on this endpoint. If this counter is * nonzero we have to treat this case as if a Message were in flight. It * may turn out that down in the ARDPStream we detect that the endpoint is * closing, but we need to include coverage for the in-process case here. * * The Endpoint Management thread is what processes the closing of * connections and the disposition of endpoints, so it will have to wait * until the in-flight message count goes to zero and also the * PushMessage()s in-process goes to zero before executing a * ARDP_Disconnect(). */ QStatus PushMessage(Message& msg) { /* * Increment the counter indicating that another thread is running * inside PushMessage for the current endpoint. THis is different from * the counter indicating "something is executing inside the endpoint" * bumped below. */ IncrementAndFetch(&m_pushCount); IncrementAndFetch(&m_refCount); QCC_DbgTrace(("_UDPEndpoint::PushMessage(msg=%p)", &msg)); /* * If either the transport or the endpoint is not in a state where it * indicates that it is ready to send, we need to return an error. * * Unfortunately, the system will try to do all kinds of things to an * endpoint even though it has just stopped it. To prevent cascades of * error logs, we need to return a "magic" error code and not log an * error if we detect that either the transport or the endpoint is * shutting down. Higher level code (especially AllJoynObj) will look * for this error and not do any logging if it is a transient error * during shutdown, as identified by the error return value * ER_BUS_ENDPOINT_CLOSING. */ if (m_transport->IsRunning() == false || m_transport->m_stopping == true) { QStatus status = ER_BUS_ENDPOINT_CLOSING; DecrementAndFetch(&m_refCount); DecrementAndFetch(&m_pushCount); return status; } if (IsEpStarted() == false) { QStatus status = ER_BUS_ENDPOINT_CLOSING; DecrementAndFetch(&m_refCount); DecrementAndFetch(&m_pushCount); return status; } /* * We need to make sure that this endpoint stays on one of our endpoint * lists while we figure out what to do with it. If we are taken off * the endpoint list we could actually be deleted while doing this * operation, so take the lock to make sure at least the UDP transport * holds a reference during this process. */ m_transport->m_endpointListLock.Lock(MUTEX_CONTEXT); /* * Find the managed endpoint to which the connection ID of the current * object refers. If the endpoint state was EP_STARTED above, and we * hold the endpoint lock, we should find the endpoint on the list. */ uint32_t found = 0; for (set::iterator i = m_transport->m_endpointList.begin(); i != m_transport->m_endpointList.end(); ++i) { UDPEndpoint ep = *i; if (GetConnId() == ep->GetConnId()) { QCC_DbgPrintf(("_UDPEndpoint::PushMessage(): found endpoint with conn ID == %d. on m_endpointList", GetConnId())); ++found; } } if (found == 0) { QCC_LogError(ER_UDP_ENDPOINT_REMOVED, ("_UDPEndpoint::PushMessage(): Endpoint is gone")); m_transport->m_endpointListLock.Unlock(MUTEX_CONTEXT); DecrementAndFetch(&m_refCount); DecrementAndFetch(&m_pushCount); return ER_UDP_ENDPOINT_REMOVED; } /* * Since we know an instance of this object is on our endpoint list, * we'll get a reference to a valid object here. */ RemoteEndpoint rep = RemoteEndpoint::wrap(this); /* * If we are going to pass the Message off to be delivered, the act of * delivering will change the write state of the message. Since * delivering to a multipoint session is done by taking a Message and * sending it off to multiple endpoints for delivery, if we just use the * Message we are given, we will eventually change the writeState of the * message to MESSAGE_COMPLETE when we've pushed all of the bits. That * would cause any subsequent PushMessage calls to complete before * actually writing any bits since they would think they are done. This * means we have to do a deep copy of every message before we send it. */ Message msgCopy = Message(msg, true); /* * We know we hold a reference, so now we can call out to the daemon * with it. Even if we release the endpoint list lock, our thread will * be registered in the endpoint so it won't go away. The message * handler should call right back into our stream and we should pop back * out in short order. */ m_transport->m_endpointListLock.Unlock(MUTEX_CONTEXT); QCC_DbgPrintf(("_UDPEndpoint::PushMessage(): DeliverNonBlocking()")); QStatus status = msgCopy->DeliverNonBlocking(rep); QCC_DbgPrintf(("_UDPEndpoint::PushMessage(): DeliverNonBlocking() returns \"%s\"", QCC_StatusText(status))); DecrementAndFetch(&m_refCount); DecrementAndFetch(&m_pushCount); return status; } /** * Callback letting us know that our connection has been disconnected for * some reason. * * For deadlock avoidance purposes, this callback always comes from the * transport dispatcher thread. * * It is important to realize that this callback is not called in the * context of the ARDP thread, it is dispatched from that callback on * another thread. Therefore it is possible that during the dispatch time, * the connection may have beome invalid. In order to remove ourselves from * this possibility, we plumb through the connection ID that was given to us * in the original callback. Since the dispatcher used that ID to look us * up via our saved connection ID they should be the same and we can treat * this as a unique identifier for the purposes of aligning, looking up and * releasing resources even if the underlying connection that corresponded * to this ID may have dropped out from under us. */ void DisconnectCb(ArdpHandle* handle, ArdpConnRecord* conn, uint32_t connId, QStatus status) { QCC_UNUSED(handle); QCC_UNUSED(conn); QCC_UNUSED(connId); IncrementAndFetch(&m_refCount); QCC_DbgHLPrintf(("_UDPEndpoint::DisconnectCb(handle=%p, conn=%p, connId=%d.)", handle, conn, connId)); /* * We need to look and see if this endpoint is on the endopint list * and then make sure that it stays on the list, so take the lock to make sure * at least the UDP transport holds a reference during this process. */ m_transport->m_endpointListLock.Lock(MUTEX_CONTEXT); #ifndef NDEBUG /* * The callback dispatcher looked to see if the endpoint was on the * endpoint list before it made the call here, and it incremented the * thread reference count before calling. We should find an endpoint * still on the endpoint list since the management thread should not * remove the endpoint with threads wandering around in it. */ uint32_t found = 0; for (set::iterator i = m_transport->m_endpointList.begin(); i != m_transport->m_endpointList.end(); ++i) { UDPEndpoint ep = *i; if (GetConnId() == ep->GetConnId()) { assert(connId == GetConnId() && "_UDPEndpoint::DisconnectCb(): Inconsistent connId"); QCC_DbgPrintf(("_UDPEndpoint::DisconnectCb(): found endpoint with conn ID == %d. on m_endpointList", GetConnId())); ++found; } } assert(found == 1 && "_UDPEndpoint::DisconnectCb(): Endpoint is gone"); #endif /* * We need to figure out if this disconnect callback is due to an * unforeseen event on the network (coming out of the protocol) or if it * is a callback in response to a local disconnect. The key is the * reported status will only be ER_OK if the callback is in response to * a local disconnect that has already begun through a call to * _UDPEndpoint::Stop(). We turn the fact that this is a part of a * local disconnect in to the fact that it is not a "sudden" or * unexpected callback and give it to the stream Disconnect() function * that is going to handle the details of managing the state of the * connection. */ bool sudden = (status != ER_OK); QCC_DbgPrintf(("_UDPEndpoint::DisconnectCb(): sudden==\"%s\"", sudden ? "true" : "false")); /* * Always let the stream see the disconnect event. It is the piece of * code that is really dealing with the hard details. * * Note that calling Disconnect() here and Stop() at the bottom of the * function creates a transient situation in which the stream thinks it * is disconnected and the endpoint thinks it is connected in the sudden * (remote) disconnect case. These two calls, m_stream->Disconnect() * and Stop() should really be done "together" and with the stream lock * and state lock held. This was noticed very late in the game, and is * now special-cased (checked for) in ArdpStream::PushBytes(). This is * harmless since ARDP_Send() will return an error since we are trying * to send to a disconnected connection. The point is, though, that the * state of the endoint and the state of the stream will be transiently * incoherent, so consistency checks will probably fail under stress. */ if (m_stream) { QCC_DbgPrintf(("_UDPEndpoint::DisconnectCb(): Disconnect(): m_stream=%p", m_stream)); QCC_DbgPrintf(("_UDPEndpoint::DisconnectCb(): m_stream->Disconnect() on endpoint with conn ID == %d.", GetConnId())); m_stream->Disconnect(sudden, status); } /* * Set the disconnect status in the underlying BusEndpoint so that * higher levels can determine what to do in response to the endpoint * stopping. Note that SetEpDisconnectStatus() may rewrite status code. */ SetEpDisconnectStatus(status); /* * We believe that the connection must go away here since this is either * an unsolicited remote disconnection which always results in the * connection going away or a confirmation of a local disconnect that * also results in the connection going away. */ m_conn = NULL; #ifndef NDEBUG /* * If there is no connection, we expect the stream to report that it is * disconnected. If it does not now, there is no way for it to ever * become "more disconnected." */ if (m_stream) { assert(m_stream->GetDisconnected() && "_UDPEndpoint::DisconnectCb(): Stream not playing by the rules of the game"); } #endif /* * Since we know an instance of this object is on exactly one of our * endpoint lists we'll get a reference to a valid object here. The * thread reference count being non-zero means we will not be deleted * out from under the call. */ RemoteEndpoint rep = RemoteEndpoint::wrap(this); /* * Since this is a disconnect it will eventually require endpoint * management, so we make a note to run the endpoint management code. */ m_transport->m_manage = UDPTransport::STATE_MANAGE; m_transport->Alert(); /* * Never, ever call out to the daemon with a lock taken. You will * eventually regret it. */ m_transport->m_endpointListLock.Unlock(MUTEX_CONTEXT); /* * The connection is gone, so Stop() so it can continue being torn down * by the daemon router (and us). This may have already been done in * the case of a local disconnect callback. It was the original Stop() * that must have happened that precipitated the confirmation callback * from ARDP -- the DisconnectCb that we are running now. */ Stop(); DecrementAndFetch(&m_refCount); } /** * Callback letting us know that we received data over our connection. We * are passed responsibility for the buffer in this callback. * * For deadlock avoidance purposes, this callback always comes from the * transport dispatcher thread. * * It is important to realize that this callback is not called in the * context of the ARDP thread, it is dispatched from that callback on * another thread. Therefore it is possible that during the dispatch time, * the connection may have beome invalid. In order to remove ourselves from * this possibility, we plumb through the connection ID that was given to us * in the original callback. Since the dispatcher used that ID to look us * up via our saved connection ID they should be the same and we can treat * this as a unique identifier for the purposes of aligning, looking up and * releasing resources even if the underlying connection that corresponded * to this ID may have dropped out from under us. */ void RecvCb(ArdpHandle* handle, ArdpConnRecord* conn, uint32_t connId, ArdpRcvBuf* rcv, QStatus status) { QCC_UNUSED(connId); IncrementAndFetch(&m_refCount); QCC_DbgHLPrintf(("_UDPEndpoint::RecvCb(handle=%p, conn=%p, connId=%d., rcv=%p, status=%s)", handle, conn, connId, rcv, QCC_StatusText(status))); /* * Our contract with ARDP says that it will provide us with valid data * if it calls us back. */ assert(rcv != NULL && rcv->data != NULL && rcv->datalen != 0 && "_UDPEndpoint::RecvCb(): No data from ARDP in RecvCb()"); /* * We need to look and see if this endpoint is on the endopint list and * then make sure that it stays on the list, so take the lock to make * sure at least the UDP transport holds a reference during this * process. */ QCC_DbgPrintf(("_UDPEndpoint::RecvCb(): Taking m_endpointListLock")); m_transport->m_endpointListLock.Lock(MUTEX_CONTEXT); #ifndef NDEBUG /* * The callback dispatcher looked to see if the endpoint was on the * endpoint list before it made the call here, and it incremented the * thread reference count before calling. We should find an endpoint * still on the endpoint list since the management thread should not * remove the endpoint with threads wandering around in it. */ uint32_t found = 0; for (set::iterator i = m_transport->m_endpointList.begin(); i != m_transport->m_endpointList.end(); ++i) { UDPEndpoint ep = *i; if (GetConnId() == ep->GetConnId()) { assert(connId == GetConnId() && "_UDPEndpoint::RecvCb(): Inconsistent connId"); QCC_DbgPrintf(("_UDPEndpoint::RecvCb(): found endpoint with conn ID == %d. on m_endpointList", GetConnId())); ++found; } } assert(found == 1 && "_UDPEndpoint::RecvCb(): Endpoint is gone"); #endif if (IsEpStarted() == false) { QCC_DbgPrintf(("_UDPEndpoint::RecvCb(): Not accepting inbound messages")); #if RETURN_ORPHAN_BUFS QCC_DbgPrintf(("_UDPEndpoint::RecvCb(): ARDP_RecvReady()")); m_transport->m_ardpLock.Lock(); /* * We got a receive callback that includes data destined for an * endpoint that is no longer accepting messages. Most likely it is * shutting down. The details of shutting down the endpoint and * discussing those details with ARDP is handled elsewhere, so all * we need to do is to return the buffer that we are ingoring. * * We're in a receive callback, but the callback function is * dispatched on another thread that is unrelated to the thread on * which the original ARDP callback was fired. This is important * since if we are in the ARDP callback thread the conn is * guaranteed to be valid since the function is beign called from * ARDP. In a thread that may be dispatched later this is no longer * the case. The conn may have been torn down between the time the * original callback was fired and when the dipatcher has actually * run. If this is the case, we can only trust that ARDP has done * the right thing and cleaned up its buffers. ARDP owns the * disposition of the buffers and we did our best -- we called back. * If an error is returned, pretty much all we can do is just log or * print an error message. Since we aren't in charge at all, we * just print a message if in debug mode. */ #ifndef NDEBUG QStatus alternateStatus = #endif ARDP_RecvReady(handle, conn, rcv); #ifndef NDEBUG if (alternateStatus != ER_OK) { QCC_DbgPrintf(("_UDPEndpoint::RecvCb(): ARDP_RecvReady() returns status==\"%s\"", QCC_StatusText(status))); } #endif m_transport->m_ardpLock.Unlock(); #else // not RETURN_ORPHAN_BUFS /* * Since we are getting an indication that the endpoint is going * down, we assume that the endpoint will continue the process and * be destroyed. In this case, we assume that ARDP is going to * particpate in closing down the connection and released any * pending buffers. This means that we can just ignore the buffer * here. We'll just print a message saying that's what we did. */ QCC_DbgPrintf(("UDPEndpoint::RecvCb(): Orphaned RECV_CB for conn ID == %d. ignored", connId)); #endif // not RETURN_ORPHAN_BUFS m_transport->m_endpointListLock.Unlock(MUTEX_CONTEXT); DecrementAndFetch(&m_refCount); return; } if (rcv->fcnt == 0) { QCC_LogError(ER_UDP_INVALID, ("_UDPEndpoint::RecvCb(): Unexpected rcv->fcnt==%d.", rcv->fcnt)); QCC_DbgPrintf(("_UDPEndpoint::RecvCb(): ARDP_RecvReady()")); m_transport->m_ardpLock.Lock(); /* * We got a bogus fragment count and so we will assert this is a * bogus condition below. Don't bother printing an error if ARDP * also doesn't take the bogus buffers back. */ ARDP_RecvReady(handle, conn, rcv); m_transport->m_ardpLock.Unlock(); m_transport->m_endpointListLock.Unlock(MUTEX_CONTEXT); DecrementAndFetch(&m_refCount); assert(false && "_UDPEndpoint::RecvCb(): unexpected rcv->fcnt"); return; } /* * The daemon knows nothing about message fragments, so we must * reassemble the fragements into a contiguous buffer before doling it * out to the daemon router. What we get is a singly linked list of * ArdpRcvBuf* that we have to walk. There is no cumulative length, so * we have to do two passes through the list: one pass to calculate the * length so we can allocate a contiguous buffer, and one to copy the * data into the buffer. */ uint8_t* msgbuf = NULL; uint32_t mlen = 0; if (rcv->fcnt != 1) { QCC_DbgPrintf(("_UDPEndpoint::RecvCb(): Calculating message length")); ArdpRcvBuf* tmp = rcv; for (uint32_t i = 0; i < rcv->fcnt; ++i) { QCC_DbgPrintf(("_UDPEndpoint::RecvCb(): Found fragment of %d. bytes", tmp->datalen)); if (tmp->datalen == 0 || tmp->datalen > 65535) { QCC_LogError(ER_UDP_INVALID, ("_UDPEndpoint::RecvCb(): Unexpected tmp->datalen==%d.", tmp->datalen)); m_transport->m_endpointListLock.Unlock(MUTEX_CONTEXT); QCC_DbgPrintf(("_UDPEndpoint::RecvCb(): ARDP_RecvReady()")); m_transport->m_ardpLock.Lock(); /* * We got a bogus fragment count and so we will assert this * is a bogus condition below. Don't bother printing an * error if ARDP also doesn't take the bogus buffers back. */ ARDP_RecvReady(handle, conn, rcv); m_transport->m_ardpLock.Unlock(); DecrementAndFetch(&m_refCount); assert(false && "_UDPEndpoint::RecvCb(): unexpected rcv->fcnt"); return; } mlen += tmp->datalen; tmp = tmp->next; } QCC_DbgPrintf(("_UDPEndpoint::RecvCb(): Found Message of %d. bytes", mlen)); #ifndef NDEBUG msgbuf = new uint8_t[mlen + SEAL_SIZE]; SealBuffer(msgbuf + mlen); #else msgbuf = new uint8_t[mlen]; #endif uint32_t offset = 0; tmp = rcv; QCC_DbgPrintf(("_UDPEndpoint::RecvCb(): Reassembling fragements")); for (uint32_t i = 0; i < rcv->fcnt; ++i) { QCC_DbgPrintf(("_UDPEndpoint::RecvCb(): Copying fragment of %d. bytes", tmp->datalen)); memcpy(msgbuf + offset, tmp->data, tmp->datalen); offset += tmp->datalen; tmp = tmp->next; } QCC_DbgPrintf(("_UDPEndpoint::RecvCb(): Message of %d. bytes reassembled", mlen)); } uint8_t* messageBuf = msgbuf ? msgbuf : rcv->data; uint32_t messageLen = mlen ? mlen : rcv->datalen; #ifndef NDEBUG #if BYTEDUMPS DumpBytes(messageBuf, messageLen); #endif #endif /* * Since we know the callback dispatcher verified it could find an * intance of this object is on an endpoint lists, and it bumped the * thread reference count, we know we'll get a reference to a * still-valid object here. */ RemoteEndpoint rep = RemoteEndpoint::wrap(this); BusEndpoint bep = BusEndpoint::cast(rep); /* * We know we hold a reference that will stay alive until we leave this * function, so now we can call out to the daemon all we want. */ m_transport->m_endpointListLock.Unlock(MUTEX_CONTEXT); /* * The point here is to create an AllJoyn Message from the * inbound bytes which we know a priori to contain exactly one * Message if present. We have a back door in the Message code * that lets us load our bytes directly into the message. Note * that this LoadBytes does a buffer copy, so we are free to * release ownership of the incoming buffer at any time after * that. */ Message msg(m_transport->m_bus); QCC_DbgPrintf(("_UDPEndpoint::RecvCb(): LoadBytes()")); status = msg->LoadBytes(messageBuf, messageLen); if (status != ER_OK) { QCC_LogError(status, ("_UDPEndpoint::RecvCb(): Cannot load bytes")); /* * If there's some kind of problem, we have to give the buffer * back to the protocol now. */ m_transport->m_ardpLock.Lock(); #ifndef NDEBUG QStatus alternateStatus = #endif ARDP_RecvReady(handle, conn, rcv); #ifndef NDEBUG if (alternateStatus != ER_OK) { QCC_DbgPrintf(("_UDPEndpoint::RecvCb(): ARDP_RecvReady() returns status==\"%s\"", QCC_StatusText(alternateStatus))); } #endif m_transport->m_ardpLock.Unlock(); /* * If we allocated a reassembly buffer, free it too. */ if (msgbuf) { #ifndef NDEBUG CheckSeal(msgbuf + mlen); #endif delete[] msgbuf; msgbuf = NULL; } /* * If we do something that is going to bug the ARDP protocol, we * need to call back into ARDP ASAP to get it moving. This is done * in the main thread, which we need to wake up. */ m_transport->Alert(); DecrementAndFetch(&m_refCount); return; } /* * The bytes are now loaded into what amounts to a backing buffer for * the Message. With the exception of the Message header, these are * still the raw bytes from the wire, so we have to Unmarshal() them * before proceeding (remembering to free the reassembly buffer if it * exists. */ if (msgbuf) { #ifndef NDEBUG CheckSeal(msgbuf + mlen); #endif delete[] msgbuf; msgbuf = NULL; } qcc::String endpointName(rep->GetUniqueName()); QCC_DbgPrintf(("_UDPEndpoint::RecvCb(): Unmarshal()")); status = msg->Unmarshal(endpointName, false, false, true, 0); if (status != ER_OK) { QCC_DbgPrintf(("_UDPEndpoint::RecvCb(): Can't Unmarhsal() Message. Probably duplicate signal delivery")); /* * If there's some kind of problem, we have to give the buffer * back to the protocol now. */ m_transport->m_ardpLock.Lock(); #ifndef NDEBUG QStatus alternateStatus = #endif ARDP_RecvReady(handle, conn, rcv); #ifndef NDEBUG if (alternateStatus != ER_OK) { QCC_DbgPrintf(("_UDPEndpoint::RecvCb(): ARDP_RecvReady() returns status==\"%s\"", QCC_StatusText(alternateStatus))); } #endif m_transport->m_ardpLock.Unlock(); /* * If we do something that is going to bug the ARDP protocol, we * need to call back into ARDP ASAP to get it moving. This is done * in the main thread, which we need to wake up. */ m_transport->Alert(); DecrementAndFetch(&m_refCount); return; } QCC_DbgPrintf(("_UDPEndpoint::RecvCb(): PushMessage()")); status = m_transport->m_bus.GetInternal().GetRouter().PushMessage(msg, bep); if (status != ER_OK) { QCC_LogError(status, ("_UDPEndpoint::RecvCb(): PushMessage failed")); } /* * We're all done with the message we got from ARDP, so we need to let * it know that it can reuse the buffer (and open its receive window). */ QCC_DbgPrintf(("_UDPEndpoint::RecvCb(): ARDP_RecvReady()")); m_transport->m_ardpLock.Lock(); #ifndef NDEBUG QStatus alternateStatus = #endif ARDP_RecvReady(handle, conn, rcv); #ifndef NDEBUG if (alternateStatus != ER_OK) { QCC_DbgPrintf(("_UDPEndpoint::RecvCb(): ARDP_RecvReady() returns status==\"%s\"", QCC_StatusText(alternateStatus))); } #endif m_transport->m_ardpLock.Unlock(); /* * If we do something that is going to bug the ARDP protocol, we need to * call back into ARDP ASAP to get it moving. This is done in the main * thread, which we need to wake up. */ m_transport->Alert(); DecrementAndFetch(&m_refCount); } /** * Callback letting us know that the remote side has acknowledged reception * of our data and the buffer can be recycled/freed * * For deadlock avoidance purposes, this callback always comes from the * transport dispatcher thread. * * It is important to realize that this callback is not called in the * context of the ARDP thread, it is dispatched from that callback on * another thread. Therefore it is possible that during the dispatch time, * the connection may have beome invalid. In order to remove ourselves from * this possibility, we plumb through the connection ID that was given to us * in the original callback. Since the dispatcher used that ID to look us * up via our saved connection ID they should be the same and we can treat * this as a unique identifier for the purposes of aligning, looking up and * releasing resources even if the underlying connection that corresponded * to this ID may have dropped out from under us. */ void SendCb(ArdpHandle* handle, ArdpConnRecord* conn, uint32_t connId, uint8_t* buf, uint32_t len, QStatus status) { QCC_UNUSED(connId); IncrementAndFetch(&m_refCount); QCC_DbgHLPrintf(("_UDPEndpoint::SendCb(handle=%p, conn=%p, buf=%p, len=%d.)", handle, conn, buf, len)); /* * We need to look and see if this endpoint is on the endopint list * and then make sure that it stays on the list, so take the lock to make sure * at least the UDP transport holds a reference during this process. */ m_transport->m_endpointListLock.Lock(MUTEX_CONTEXT); #ifndef NDEBUG /* * The callback dispatcher looked to see if the endpoint was on the * endpoint list before it made the call here, and it incremented the * thread reference count before calling. We should find an endpoint * still on the endpoint list since the management thread should not * remove the endpoint with threads wandering around in it. */ uint32_t found = 0; for (set::iterator i = m_transport->m_endpointList.begin(); i != m_transport->m_endpointList.end(); ++i) { UDPEndpoint ep = *i; if (GetConnId() == ep->GetConnId()) { assert(connId == GetConnId() && "_UDPEndpoint::SendCb(): Inconsistent connId"); QCC_DbgPrintf(("_UDPEndpoint::SendCb(): found endpoint with conn ID == %d. on m_endpointList", GetConnId())); ++found; } } assert(found == 1 && "_UDPEndpoint::SendCb(): Endpoint is gone"); #endif /* * We know we are still on the endpoint list and we know we have the * thread reference count bumped so it is safe to release the lock. */ m_transport->m_endpointListLock.Unlock(MUTEX_CONTEXT); /* * If there is a thread trying to send bytes in this in this endpoint, * it first calls into PushMessage() and this indirectly calls into the * underlying stream's PushBytes(). If there is a pending PushBytes() a * thread will be blocked waiting for its ARDP send to complete. In * that case, we must call back into the stream to unblock that pending * thread. The stream actually does some more involved checking of the * returned buffers, so we let it do the free unless it is gone. * * If there is no stream, we are guaranteed there is no thread waiting * for something and so we can just proceed to free the memory since the * failure will have already been communicated up to the caller by * another mechanism, e.g., DisconnectCb(). */ if (m_stream) { m_stream->SendCb(handle, conn, buf, len, status); } else { #ifndef NDEBUG CheckSeal(buf + len); #endif delete[] buf; } DecrementAndFetch(&m_refCount); } /** * Get the handle to the underlying ARDP protocol implementation. */ ArdpHandle* GetHandle() { QCC_DbgTrace(("_UDPEndpoint::GetHandle() => %p", m_handle)); return m_handle; } /** * Set the handle to the underlying ARDP protocol implementation. */ void SetHandle(ArdpHandle* handle) { QCC_DbgTrace(("_UDPEndpoint::SetHandle(handle=%p)", handle)); m_handle = handle; } /** * Get the pointer to the underlying ARDP protocol connection information. */ ArdpConnRecord* GetConn() { QCC_DbgTrace(("_UDPEndpoint::GetConn(): => %p", m_conn)); return m_conn; } /** * Set the pointer to the underlying ARDP protocol connection information. */ void SetConn(ArdpConnRecord* conn) { QCC_DbgTrace(("_UDPEndpoint::SetConn(conn=%p)", conn)); m_conn = conn; m_transport->m_ardpLock.Lock(); uint32_t cid = ARDP_GetConnId(m_handle, conn); #ifndef NDEBUG if (cid == ARDP_CONN_ID_INVALID) { QCC_DbgPrintf(("_UDPEndpoint::SetConn(conn=%p): conn is invalid!", conn)); } #endif SetConnId(cid); m_transport->m_ardpLock.Unlock(); } /** * Get the connection ID of the original ARDP protocol connection. We keep * this around for debugging purposes after the connection goes away. */ uint32_t GetConnId() { // QCC_DbgTrace(("_UDPEndpoint::GetConnId(): => %d.", m_id)); return m_id; } /** * Set the connection ID of the original ARDP protocol connection. We keep * this around for debugging purposes after the connection goes away. */ void SetConnId(uint32_t id) { QCC_DbgTrace(("_UDPEndpoint::SetConnId(id=%d.)", id)); m_id = id; } /** * Get the IP address of the remote side of the connection. */ qcc::IPAddress GetIpAddr() { QCC_DbgTrace(("_UDPEndpoint::GetIpAddr(): => \"%s\"", m_ipAddr.ToString().c_str())); return m_ipAddr; } /** * Set the IP address of the remote side of the connection. */ void SetIpAddr(qcc::IPAddress& ipAddr) { QCC_DbgTrace(("_UDPEndpoint::SetIpAddr(ipAddr=\"%s\")", ipAddr.ToString().c_str())); m_ipAddr = ipAddr; } /** * Get the UDP/IP port of the remote side of the connection. */ uint16_t GetIpPort() { QCC_DbgTrace(("_UDPEndpoint::GetIpPort(): => %d.", m_ipPort)); return m_ipPort; } /** * Set the UDP/IP port of the remote side of the connection. */ void SetIpPort(uint16_t ipPort) { QCC_DbgTrace(("_UDPEndpoint::SetIpPort(ipPort=%d.)", ipPort)); m_ipPort = ipPort; } /** * Get the IP address of the local side of the connection. */ QStatus GetLocalIp(qcc::String& ipAddrStr) { QCC_UNUSED(ipAddrStr); QCC_DbgTrace(("_UDPEndpoint::GetLocalIp(ipAddrStr=%0)", &ipAddrStr)); /* * We are only sure about the endpoint's underlying address when it is * running. It may be the case that the endpoint completes the process * of getting torn down between our test and the call ot get the address * from ARDP, but the worst thing that can happen is that we return * ER_OK but the IPAddress string returned is empty. */ if (IsEpStarted() == false) { return ER_UDP_ENDPOINT_NOT_STARTED; } m_transport->m_ardpLock.Lock(); ipAddrStr = ARDP_GetIpAddrFromConn(GetHandle(), GetConn()).ToString(); m_transport->m_ardpLock.Unlock(); return ER_OK; }; /** * Get the IP address of the remote side of the connection. */ QStatus GetRemoteIp(qcc::String& ipAddrStr) { QCC_DbgTrace(("_UDPEndpoint::GetRemoteIp(ipAddrStr=%p): => \"%s\"", &ipAddrStr, m_ipAddr.ToString().c_str())); ipAddrStr = m_ipAddr.ToString(); return ER_OK; }; /** * Set the time at which authentication was started. */ void SetStartTime(qcc::Timespec tStart) { QCC_DbgTrace(("_UDPEndpoint::SetStartTime()")); m_tStart = tStart; } /** * Get the time at which authentication was started. */ qcc::Timespec GetStartTime(void) { QCC_DbgTrace(("_UDPEndpoint::GetStartTime(): => %" PRIu64 ".%03d.", m_tStart.seconds, m_tStart.mseconds)); return m_tStart; } /** * Set the time at which the stop process for the endpoint was begun. */ void SetStopTime(qcc::Timespec tStop) { QCC_DbgTrace(("_UDPEndpoint::SetStopTime()")); m_tStop = tStop; } /** * Get the time at which the stop process for the endpoint was begun. */ qcc::Timespec GetStopTime(void) { QCC_DbgTrace(("_UDPEndpoint::GetStopTime(): => %" PRIu64 ".%03d.", m_tStop.seconds, m_tStop.mseconds)); return m_tStop; } /** * Set the time at which the shutdown (EP_WAITING) process for the endpoint * was begun. */ void SetWaitStartTime(qcc::Timespec tWaitStart) { QCC_DbgTrace(("_UDPEndpoint::SetWaitStartTime()")); m_tWaitStart = tWaitStart; } /** * Get the time at which the shutdown (EP_WAITING) process for the endpoint * was begun. */ qcc::Timespec GetWaitStartTime(void) { QCC_DbgTrace(("_UDPEndpoint::GetWaitStartTime(): => %" PRIu64 ".%03d.", m_tWaitStart.seconds, m_tWaitStart.mseconds)); return m_tWaitStart; } /** * Set the time at which the last stall warning was emitted. */ void SetStallTime(qcc::Timespec tStall) { QCC_DbgTrace(("_UDPEndpoint::SetStallTime()")); m_tStall = tStall; } /** * Get the time at which the lst stall warning was emitted. */ qcc::Timespec GetStallTime(void) { QCC_DbgTrace(("_UDPEndpoint::GetStallTime(): => %" PRIu64 ".%03d.", m_tStall.seconds, m_tStall.mseconds)); return m_tStall; } /** * Which side of a connection are we -- active or passive */ SideState GetSideState(void) { QCC_DbgTrace(("_UDPEndpoint::GetSideState(): => %d.", m_sideState)); return m_sideState; } /** * Note that we are the active side of a connection */ void SetActive(void) { QCC_DbgTrace(("_UDPEndpoint::SetActive()")); m_sideState = SIDE_ACTIVE; } /** * Note that we are the passive side of a connection */ void SetPassive(void) { QCC_DbgTrace(("_UDPEndpoint::SetPassive()")); m_sideState = SIDE_PASSIVE; } /** * Get the state of the overall endpoint. Failed, starting, stopping, etc. */ EndpointState GetEpState(void) { QCC_DbgTrace(("_UDPEndpoint::GetEpState(): => %d.", m_epState)); return m_epState; } /** * Check the state of the endpoint for initialized */ bool IsEpInitialized(void) { QCC_DbgTrace(("_UDPEndpoint::IsEpInitialized() <= \"%s\"", m_epState == EP_INITIALIZED ? "true" : "false")); return m_epState == EP_INITIALIZED; } /** * Set the state of the endpoint to active started */ void SetEpActiveStarted(void) { QCC_DbgTrace(("_UDPEndpoint::SetEpActiveStarted()")); assert(m_epState == EP_INITIALIZED); m_epState = EP_ACTIVE_STARTED; } /** * Check the state of the endpoint for active started */ bool IsEpActiveStarted(void) { QCC_DbgTrace(("_UDPEndpoint::IsEpActiveStarted() <= \"%s\"", m_epState == EP_ACTIVE_STARTED ? "true" : "false")); return m_epState == EP_ACTIVE_STARTED; } /** * Set the state of the endpoint to passive started */ void SetEpPassiveStarted(void) { QCC_DbgTrace(("_UDPEndpoint::SetEpPassiveStarted()")); assert(m_epState == EP_INITIALIZED); m_epState = EP_PASSIVE_STARTED; } /** * Check the state of the endpoint for passive started */ bool IsEpPassiveStarted(void) { QCC_DbgTrace(("_UDPEndpoint::IsEpPassiveStarted() <= \"%s\"", m_epState == EP_PASSIVE_STARTED ? "true" : "false")); return m_epState == EP_PASSIVE_STARTED; } /** * Set the state of the endpoint to started */ void SetEpStarted(void) { QCC_DbgTrace(("_UDPEndpoint::SetEpStarted()")); assert(m_epState == EP_ACTIVE_STARTED || m_epState == EP_PASSIVE_STARTED); m_epState = EP_STARTED; } /** * Check the state of the endpoint for started */ bool IsEpStarted(void) { QCC_DbgTrace(("_UDPEndpoint::IsEpStarted() <= \"%s\"", m_epState == EP_STARTED ? "true" : "false")); return m_epState == EP_STARTED; } /** * Enable the optional EP_WAITING state */ void SetEpWaitEnable(bool wait) { QCC_DbgTrace(("_UDPEndpoint::SetEpWaitEnable(wait=\"%s\")", wait ? "true" : "false")); m_wait = wait; } /** * Check to see if the EP_WAITING state is enabled */ bool IsEpWaitEnabled(void) { QCC_DbgTrace(("_UDPEndpoint::IsEpWaitEnabled() <= \"%s\"", m_wait ? "true" : "false")); return m_wait; } /** * Set the state of the endpoint to stopping. * * If wait is true, the endpoint is stopping because of a local disconnect * and the EP_WAITING state should follow EP_STOPPING to wait for the ARDP * write queue to empty before disconnecting. */ void SetEpStopping() { QCC_DbgTrace(("_UDPEndpoint::SetEpStopping()")); #ifndef NDEBUG PrintEpState("_UdpEndpoint::SetEpStopping()"); #endif /* * Don't allow backward progress. */ assert(m_epState != EP_JOINED || m_epState == EP_DONE); Timespec tNow; GetTimeNow(&tNow); SetStopTime(tNow); SetStallTime(tNow); m_epState = EP_STOPPING; } /** * Check the state of the endpoint for stopping */ bool IsEpStopping(void) { QCC_DbgTrace(("_UDPEndpoint::IsEpStopping() <= \"%s\"", m_epState == EP_STOPPING ? "true" : "false")); return m_epState == EP_STOPPING; } /** * Set the state of the endpoint to waiting */ void SetEpWaiting(void) { QCC_DbgTrace(("_UDPEndpoint::SetEpWaiting()")); assert(m_epState == EP_STOPPING); m_epState = EP_WAITING; } /** * Check the state of the endpoint for stopping */ bool IsEpWaiting(void) { QCC_DbgTrace(("_UDPEndpoint::IsEpWaiting() <= \"%s\"", m_epState == EP_WAITING ? "true" : "false")); return m_epState == EP_WAITING; } /** * Set the state of the endpoint to joined */ void SetEpJoined(void) { QCC_DbgTrace(("_UDPEndpoint::SetEpJoined()")); /* * It is illegal to set Join()ed directly from a started state without calling Stop() first. */ assert(m_epState != EP_STARTED); /* * Don't allow backward progress. */ assert(m_epState != EP_DONE); m_epState = EP_JOINED; } /** * Check the state of the endpoint for joined */ bool IsEpJoined(void) { QCC_DbgTrace(("_UDPEndpoint::IsEpJoined() <= \"%s\"", m_epState == EP_JOINED ? "true" : "false")); return m_epState == EP_JOINED; } /** * Set the state of the endpoint to done */ void SetEpDone(void) { QCC_DbgTrace(("_UDPEndpoint::SetEpDone()")); assert(m_epState == EP_JOINED); m_epState = EP_DONE; } /** * Check the state of the endpoint for doneness */ bool IsEpDone(void) { QCC_DbgTrace(("_UDPEndpoint::IsEpDone() <= \"%s\"", m_epState == EP_DONE ? "true" : "false")); return m_epState == EP_DONE; } /** * Set the disconnect status in the underlying BusEndpoint. This is * provided in order to let the endpoint management code set the protected * status if it needs to. */ void SetEpDisconnectStatus(QStatus status) { QCC_DbgTrace(("_UDPEndpoint::SetEpDisconnectStatus(status=%s)", QCC_StatusText(status))); /* * If something has previously gone wrong, leave it be. Especially * don't overwrite bad status with good. */ QStatus oldStatus = GetDisconnectStatus(); if (oldStatus != ER_OK) { QCC_DbgTrace(("_UDPEndpoint::SetEpDisconnectStatus(): Previously set status. Ignoring new")); return; } /* * This status is going to eventually percolate up to AllJoynObj which * translates it into its own version of status. It looks for specific * values, so we have to be careful that we don't surprise it. * * There are three values that AllJoynObj will be looking for that * originate at the transport level: * * ER_SOCK_OTHER_END_CLOSED: This is a very TCP-specific error that * means the stream socket on the other side of the L4 link * was closed. There is no socket that was closed, but as it * stands uers expect to see the specific session error called * ALLJOYN_SESSIONLOST_REMOTE_END_CLOSED_ABRUPTLY on a control-C * of the remote side. AllJoynObj requires the specific socket * error ER_SOCK_OTHER_END_CLOSED for this to happpen. So, even * though there is no socket being closed, we map all of our * specific ARDP errors to this value, which effectively means * link lost despite its name. * * ER_TIMEOUT: This means a link timeout was detected. ARDP has * two separate timeouts (persist timeout corresponds to an * application not pulling data, and probe timeout correcponds * to a link problem). We map both to ER_TIMEOUT since sessions * only admit one kind of timeout. * * ER_OK: This means a link went down expectedly as a result of a * local action on the endpoint. Even though we look at it as * a disconnect, higher levels want to see it as nothing went * wrong. */ switch (status) { case ER_ARDP_PERSIST_TIMEOUT: QCC_DbgTrace(("_UDPEndpoint::SetEpDisconnectStatus(): Map \"%s\" to \"ER_TIMEOUT\"", QCC_StatusText(status))); status = ER_TIMEOUT; break; case ER_ARDP_PROBE_TIMEOUT: QCC_DbgTrace(("_UDPEndpoint::SetEpDisconnectStatus(): Map \"%s\" to \"ER_TIMEOUT\"", QCC_StatusText(status))); status = ER_TIMEOUT; break; case ER_UDP_LOCAL_DISCONNECT: QCC_DbgTrace(("_UDPEndpoint::SetEpDisconnectStatus(): Map \"%s\" to \"ER_OK\"", QCC_StatusText(status))); status = ER_OK; break; default: QCC_DbgTrace(("_UDPEndpoint::SetEpDisconnectStatus(): Map \"%s\" to \"ER_SOCK_OTHER_END_CLOSED\"", QCC_StatusText(status))); status = ER_SOCK_OTHER_END_CLOSED; break; } /* * Set the bus endpoint version of the disconnect status with the * sanitized version. */ disconnectStatus = status; } /** * Set the boolean indicating that the disconenct logic has happened. This * is provided so that the transport can manually override this logic if an * error is detected prior to calling start (and where the disconnect * callback that drives that logic will never be called). */ void SetDisconnected() { QCC_DbgTrace(("_UDPEndpoint::SetDisconnected()")); m_disconnected = true; } /** * Set the link timeout for this connection * * TODO: How does the link timeout set by the application play with the * default link timeout managed by the protocol. We certainly don't want to * trigger the link timeout functionality of the remote endpoint since it is * going to expect all of the usual stream, thread, event functionality. * * For now, we just silently ignore SetLinkTimeout() and use the underlhing * ARDP mechanism. */ QStatus SetLinkTimeout(uint32_t& linkTimeout) { QCC_UNUSED(linkTimeout); QCC_DbgTrace(("_UDPEndpoint::SetLinkTimeout(linkTimeout=%d.)", linkTimeout)); QCC_DbgPrintf(("_UDPEndpoint::SetLinkTimeout(): Ignored", linkTimeout)); return ER_OK; } void StateLock() { m_stateLock.Lock(); } void StateUnlock() { m_stateLock.Unlock(); } private: UDPTransport* m_transport; /**< The server holding the connection */ ArdpStream* m_stream; /**< Convenient pointer to the underlying stream */ ArdpHandle* m_handle; /**< The handle to the underlying protocol */ ArdpConnRecord* m_conn; /**< The connection record for the underlying protocol */ uint32_t m_id; /**< The ID of the connection record for the underlying protocol */ qcc::IPAddress m_ipAddr; /**< Remote IP address. */ uint16_t m_ipPort; /**< Remote port. */ bool m_registered; /**< If true, a call-out to the daemon has been made to register this endpoint */ volatile SideState m_sideState; /**< Is this an active or passive connection */ volatile EndpointState m_epState; /**< The state of the endpoint itself */ qcc::Timespec m_tStart; /**< Timestamp indicating when the authentication process started */ qcc::Timespec m_tStop; /**< Timestamp indicating when the stop process for the endpoint was begun */ qcc::Timespec m_tWaitStart; /**< Timestamp indicating when the endpoint went into EP_WAITING state */ qcc::Timespec m_tStall; /**< Timestamp indicating when the last stall warning was logged */ bool m_remoteExited; /**< Indicates if the remote endpoint exit function has been run. Cannot delete until true. */ bool m_exitScheduled; /**< Indicates if the remote endpoint exit function has been scheduled. */ volatile bool m_disconnected; /**< Indicates an interlocked handling of the ARDP_Disconnect has happened */ volatile int32_t m_refCount; /**< Incremented if a thread is wandering through the endpoint, decrememted when it leaves */ volatile int32_t m_pushCount; /**< Incremented if a thread is wandering through the endpoint, decrememted when it leaves */ qcc::Mutex m_stateLock; /**< Mutex protecting the endpoint state against multiple threads attempting changes */ bool m_wait; /**< If true, follow EP_STOPPING state with EP_WAITING state */ }; /* * A thread function to dispatch all of the callbacks from the ARDP protocol. */ ThreadReturn STDCALL MessagePump::PumpThread::Run(void* arg) { QCC_UNUSED(arg); QCC_DbgTrace(("MessagePump::PumpThread::Run()")); assert(m_pump && "MessagePump::PumpThread::Run(): pointer to enclosing pump must be specified"); /* * We need to implement a classic condition variable idiom. Here the mutex * is the m_lock mutex member variable and the condition that needs to be * met is "something in the queue." This is complicated a bit (but not * much) since we need to live inside a while loop and execute until we are * asked to stop or have hung around for some time without something useful * to do (see the class doxygen for more description). * * Note that IsStopping() is a call to the thread base class that indicates * the underlying thread has received a Stop() request. The member variable * m_stopping is a boolean we use to synchronize the run thread and any * RecvCb() callbacks we might get from the UDP Transport dispatcher thread. * We don't want to have to understand the details of how and when the * internal stopping member of a thread is set, so we use our own with know * semantics for synchronization up here. */ QStatus status = ER_OK; m_pump->m_lock.Lock(); while (!m_pump->m_stopping && !IsStopping() && status != ER_TIMEOUT) { QCC_DbgPrintf(("MessagePump::PumpThread::Run(): Top.")); /* * Note that if the condition returns an unexpected status we loop in * the hope that it is recoverable. */ while (m_pump->m_queue.empty() && !m_pump->m_stopping && !IsStopping() && status != ER_TIMEOUT) { QCC_DbgPrintf(("MessagePump::PumpThread::Run(): TimedWait for condition")); status = m_pump->m_condition.TimedWait(m_pump->m_lock, UDP_MESSAGE_PUMP_TIMEOUT); QCC_DbgPrintf(("MessagePump::PumpThread::Run(): TimedWait returns \"%s\"", QCC_StatusText(status))); } QCC_DbgPrintf(("MessagePump::PumpThread::Run(): Done with wait.")); /* * One of three things has happened: 1) the condition has been signaled * because there is something on the queue; 2) the condition has been * signaled because we have been asked to stop; 3) the timed wait has * timed out and we have had nothing to do for that amount of time. If * we've been asked to stop, or we time out, we just loop back to the * top and break out of the while loop -- we just need to work if the * queue is not empty. */ if (m_pump->m_stopping || IsStopping() || status == ER_TIMEOUT) { continue; } else if (m_pump->m_queue.empty() == false) { QCC_DbgTrace(("MessagePump::PumpThread::Run(): Have work.")); /* * Pull the entry describing the message off the work queue. */ QueueEntry entry = m_pump->m_queue.front(); m_pump->m_queue.pop(); /* * We need to call out to the daemon to have it go ahead and push * the message off to the destination. This gets tricky since we * have several threads that need to deal with the endpoint * including those that may want to delete it. * * While we hold the endpoint lock we are going to call * IncrementRefs() on the endpoint to ensure it isn't deleted before * the call out to the endpoint is made. Then we call out to the * RecvCb() ahd then finally we DecrementRefs() to allow deletion. */ bool handled = false; m_pump->m_transport->m_endpointListLock.Lock(MUTEX_CONTEXT); for (set::iterator i = m_pump->m_transport->m_endpointList.begin(); i != m_pump->m_transport->m_endpointList.end(); ++i) { UDPEndpoint ep = *i; if (entry.m_connId == ep->GetConnId()) { QCC_DbgPrintf(("MessagePump::PumpThread::Run(): found endpoint with conn ID == %d. on m_endpointList", entry.m_connId)); /* * We have a managed object reference to ep, but also * increment the endpoint reference count (different from * the managed object reference count) to make sure the * endpoint manager doesn't try to delete the endpoint * before our call actually makes it there. */ ep->IncrementRefs(); m_pump->m_transport->m_endpointListLock.Unlock(MUTEX_CONTEXT); m_pump->m_lock.Unlock(); QCC_DbgPrintf(("MessagePump::PumpThread::Run(): Call out to endopint with connId=%d.", entry.m_connId)); ep->RecvCb(entry.m_handle, entry.m_conn, entry.m_connId, entry.m_rcv, entry.m_status); QCC_DbgPrintf(("MessagePump::PumpThread::Run(): Back from endpoint RecvCb()")); handled = true; m_pump->m_lock.Lock(); m_pump->m_transport->m_endpointListLock.Lock(MUTEX_CONTEXT); /* * Since we held a reference to ep and we incremented the * reference count, we expect this reference to remain * valid. We use it to decrement the refs and then forget * it. We can never use the iterator again since the moment * we released the lock it could have become invalid. */ ep->DecrementRefs(); break; } } m_pump->m_transport->m_endpointListLock.Unlock(MUTEX_CONTEXT); /* * If we were able to find an endpoint on which to dispatch this * callback then the endpoint RecvCb() took responsibility for the * message. * * If we were unable to find an endpoint to dispatch this callback * to we still need to do something about the message we were given. * This means returning the bytes back to ARDP. */ if (handled == false) { #if RETURN_ORPHAN_BUFS QCC_DbgPrintf(("MessagePump::PumpThread::Run(): Unable to find endpoint with conn ID == %d. on m_endpointList", entry.m_connId)); m_pump->m_transport->m_ardpLock.Lock(); ARDP_RecvReady(entry.m_handle, entry.m_conn, entry.m_rcv); m_pump->m_transport->m_ardpLock.Unlock(); #else // not RETURN_ORPHAN_BUFS QCC_DbgPrintf(("MessagePump::PumpThread::Run(): Unable to find endpoint with conn ID == %d. on m_endpointList. Ignore message", entry.m_connId)); #endif // not RETURN_ORPHAN_BUFS } } } /* * If we are exiting, we need to make sure that there are no race conditions * between our decision to exit and a RecvCb() decision to use an existing * active thread. We also need to recognize that if we are returning because * of an inactivity timeout we need to allow RecvCb() to spin up a new thread. * * We hold the pump lock here, and RecvCb() must also hold the lock thread * when it makes its decisions. If we know RecvCb() will run after we are * done. If we are exiting because of a Stop(), then IsStopping() will be * true and our version (m_stopping) will also be true. RecvCb() will not * spin up a new thread if m_stopping is true. If we are exiting because of * inactivity at this point IsStopping() and m_stopping may or may not be * true depending on races. We don't care, since m_stopping is going to * determine what happens after we are gone. We just exit. * * If we are exiting, we must be the active thread. The rules say we are * the one who must remove our own pointer from the activeThread, zero it * out and add ourselves to the pastThread queue. If we do this atomically * with the pump lock held, then RecvCb() can do what it needs to do also * atomically. */ QCC_DbgPrintf(("MessagePump::PumpThread::Run(): Exiting")); PumpThread* i = (PumpThread*)GetThread(); assert(m_pump->m_activeThread == i && "MessagePump::PumpThread::Run(): I should be the active thread"); m_pump->m_pastThreads.push(i); m_pump->m_activeThread = NULL; m_pump->m_lock.Unlock(); QCC_DbgPrintf(("MessagePump::PumpThread::Run(): Return")); /* * The last thing we need to do is to bug the endpoint so its endpoint * management function will run and Join() our thread. We've pushed our * thread ID onto the list of past threads, and the endpoint will assume * that we have exited and join us if our ID is on pastThreads. This will * happen even if we get swapped out "between" the Alert() and the return * (especially during the closing printfs in debug mode). */ QCC_DbgPrintf(("MessagePump::PumpThread::Run(): Alert()")); m_pump->m_transport->Alert(); QCC_DbgPrintf(("MessagePump::PumpThread::Run(): Return")); return 0; } static void UdpEpStateLock(_UDPEndpoint* ep) { ep->StateLock(); } static void UdpEpStateUnlock(_UDPEndpoint* ep) { ep->StateUnlock(); } static bool IsUdpEpStarted(_UDPEndpoint* ep) { return ep->IsEpStarted(); } /** * Construct a UDP Transport object. */ UDPTransport::UDPTransport(BusAttachment& bus) : Thread("UDPTransport"), m_bus(bus), m_stopping(false), m_routerNameAdvertised(false), m_listener(0), m_foundCallback(m_listener), m_networkEventCallback(*this), m_isAdvertising(false), m_isDiscovering(false), m_isListening(false), m_isNsEnabled(false), m_reload(STATE_RELOADING), m_manage(STATE_MANAGE), m_nsReleaseCount(0), m_wildcardIfaceProcessed(false), m_routerName(), m_maxRemoteClientsUdp(0), m_numUntrustedClients(0), m_authTimeout(0), m_sessionSetupTimeout(0), m_maxAuth(0), m_maxConn(0), m_currAuth(0), m_currConn(0), m_connLock(), m_dynamicScoreUpdater(*this), m_ardpLock(), m_cbLock(), m_handle(NULL), m_dispatcher(NULL), m_exitDispatcher(NULL), m_workerCommandQueue(), m_workerCommandQueueLock(), m_exitWorkerCommandQueue(), m_exitWorkerCommandQueueLock() #if WORKAROUND_1298 , m_done1298(false) #endif { QCC_DbgTrace(("UDPTransport::UDPTransport()")); /* * We know we are daemon code, so we'd better be running with a daemon * router. This is assumed elsewhere. */ assert(m_bus.GetInternal().GetRouter().IsDaemon()); /* * We need to find the defaults for our connection limits. These limits * can be specified in the configuration database with corresponding limits * used for DBus. If any of those are present, we use them, otherwise we * provide some hopefully reasonable defaults. */ ConfigDB* config = ConfigDB::GetConfigDB(); m_authTimeout = config->GetLimit("auth_timeout", ALLJOYN_AUTH_TIMEOUT_DEFAULT); m_sessionSetupTimeout = config->GetLimit("session_setup_timeout", ALLJOYN_SESSION_SETUP_TIMEOUT_DEFAULT); m_maxAuth = config->GetLimit("max_incomplete_connections", ALLJOYN_MAX_INCOMPLETE_CONNECTIONS_UDP_DEFAULT); m_maxConn = config->GetLimit("max_completed_connections", ALLJOYN_MAX_COMPLETED_CONNECTIONS_UDP_DEFAULT); ArdpGlobalConfig ardpConfig; ardpConfig.connectTimeout = config->GetLimit("udp_connect_timeout", UDP_CONNECT_TIMEOUT); ardpConfig.connectRetries = config->GetLimit("udp_connect_retries", UDP_CONNECT_RETRIES); ardpConfig.initialDataTimeout = config->GetLimit("udp_initial_data_timeout", UDP_INITIAL_DATA_TIMEOUT); ardpConfig.totalDataRetryTimeout = config->GetLimit("udp_total_data_retry_timeout", UDP_TOTAL_DATA_RETRY_TIMEOUT); ardpConfig.minDataRetries = config->GetLimit("udp_min_data_retries", UDP_MIN_DATA_RETRIES); ardpConfig.persistInterval = config->GetLimit("udp_persist_interval", UDP_PERSIST_INTERVAL); ardpConfig.totalAppTimeout = config->GetLimit("udp_total_app_timeout", UDP_TOTAL_APP_TIMEOUT); ardpConfig.linkTimeout = config->GetLimit("udp_link_timeout", UDP_LINK_TIMEOUT); ardpConfig.keepaliveRetries = config->GetLimit("udp_keepalive_retries", UDP_KEEPALIVE_RETRIES); ardpConfig.fastRetransmitAckCounter = config->GetLimit("udp_fast_retransmit_ack_counter", UDP_FAST_RETRANSMIT_ACK_COUNTER); ardpConfig.delayedAckTimeout = config->GetLimit("udp_delayed_ack_timeout", UDP_DELAYED_ACK_TIMEOUT); ardpConfig.timewait = config->GetLimit("udp_timewait", UDP_TIMEWAIT); ardpConfig.segbmax = config->GetLimit("udp_segbmax", UDP_SEGBMAX); ardpConfig.segmax = config->GetLimit("udp_segmax", UDP_SEGMAX); if (ardpConfig.segmax * ardpConfig.segbmax < ALLJOYN_MAX_PACKET_LEN) { QCC_LogError(ER_INVALID_CONFIG, ("UDPTransport::UDPTransport(): udp_segmax (%d) * udp_segbmax (%d) < ALLJOYN_MAX_PACKET_LEN (%d) ignored", ardpConfig.segbmax, ardpConfig.segmax, ALLJOYN_MAX_PACKET_LEN)); ardpConfig.segbmax = UDP_SEGBMAX; ardpConfig.segmax = UDP_SEGMAX; } memcpy(&m_ardpConfig, &ardpConfig, sizeof(ArdpGlobalConfig)); for (uint32_t i = 0; i < N_PUMPS; ++i) { m_messagePumps[i] = new MessagePump(this); } /* * User configured UDP-specific values trump defaults if longer. */ qcc::Timespec t = Timespec(ardpConfig.connectTimeout * ardpConfig.connectRetries); if (m_authTimeout < t) { m_authTimeout = m_sessionSetupTimeout = t; } /* * Initialize the hooks to and from the ARDP protocol. Note that * ARDP_AllocHandle is expected to "never fail." */ m_ardpLock.Lock(); m_handle = ARDP_AllocHandle(&ardpConfig); ARDP_SetHandleContext(m_handle, this); ARDP_SetAcceptCb(m_handle, ArdpAcceptCb); ARDP_SetConnectCb(m_handle, ArdpConnectCb); ARDP_SetDisconnectCb(m_handle, ArdpDisconnectCb); ARDP_SetRecvCb(m_handle, ArdpRecvCb); ARDP_SetSendCb(m_handle, ArdpSendCb); ARDP_SetSendWindowCb(m_handle, ArdpSendWindowCb); #if ARDP_TESTHOOKS /* * Initialize some testhooks as an example of how to do this. */ ARDP_HookSendToSG(m_handle, ArdpSendToSGHook); ARDP_HookSendTo(m_handle, ArdpSendToHook); ARDP_HookRecvFrom(m_handle, ArdpRecvFromHook); #endif /* * Call into ARDP and ask it to start accepting connections passively. * Since we are running in a constructor, there's not much we can do if it * fails. */ #ifndef NDEBUG QStatus status = #endif ARDP_StartPassive(m_handle); #ifndef NDEBUG if (status != ER_OK) { QCC_DbgPrintf(("UDPTransport::UDPTransport(): ARDP_StartPassive() returns status==\"%s\"", QCC_StatusText(status))); } #endif m_ardpLock.Unlock(); } /** * Destroy a UDP Transport object. */ UDPTransport::~UDPTransport() { QCC_DbgTrace(("UDPTransport::~UDPTransport()")); Stop(); Join(); for (uint32_t i = 0; i < N_PUMPS; ++i) { assert(m_messagePumps[i]->IsActive() == false && "UDPTransport::~UDPTransport(): Destroying with active message pump"); delete m_messagePumps[i]; m_messagePumps[i] = NULL; } ARDP_FreeHandle(m_handle); m_handle = NULL; QCC_DbgPrintf(("UDPTransport::~UDPTransport(): m_mAuthList.size() == %d", m_authList.size())); QCC_DbgPrintf(("UDPTransport::~UDPTransport(): m_mEndpointList.size() == %d", m_endpointList.size())); assert(m_preList.size() + m_authList.size() + m_endpointList.size() == 0 && "UDPTransport::~UDPTransport(): Destroying with enlisted endpoints"); //assert(IncrementAndFetch(&m_refCount) == 1 && "UDPTransport::~UDPTransport(): non-zero reference count"); } /** * Define an EndpointExit function even though it is not used in the UDP * Transport. This virtual function is expected by the daemon and must be * defined even though we will not use it. We short-circuit the EndpointExit * functionality by defining a new RemoteEndpoint::Stop() function that doesn't * require the functionality. */ void UDPTransport::EndpointExit(RemoteEndpoint& ep) { QCC_UNUSED(ep); QCC_DbgTrace(("UDPTransport::EndpointExit()")); } /* * A thread to dispatch all of the callbacks from the ARDP protocol. */ ThreadReturn STDCALL UDPTransport::DispatcherThread::Run(void* arg) { QCC_UNUSED(arg); IncrementAndFetch(&m_transport->m_refCount); QCC_DbgTrace(("UDPTransport::DispatcherThread::Run()")); vector checkEvents, signaledEvents; checkEvents.push_back(&stopEvent); while (!IsStopping()) { QCC_DbgTrace(("UDPTransport::DispatcherThread::Run(): Wait for some action")); signaledEvents.clear(); /* * We should never have a status returned from Event::Wait other than * ER_OK since we don't set a timeout. It is, however, the case that * Windows Event implementations may return ER_TIEMOUT even though no * timeout was set, and Posix systems may return ER_TIMER_NOT_ALLOWED. * If we were to exit in the face of such errors, the whole transport * would go down since the dispatcher thread would exit. All we can do * is to hope that any errors are transient and try again. In that * case, we will recover if the system does. We'll log an error, but * there's not really much we can do here. */ QStatus status = Event::Wait(checkEvents, signaledEvents); if (status != ER_OK) { QCC_LogError(status, ("UDPTransport::DispatcherThread::Run(): Event::Wait failed")); continue; } for (vector::iterator i = signaledEvents.begin(); i != signaledEvents.end(); ++i) { if (*i == &stopEvent) { QCC_DbgTrace(("UDPTransport::DispatcherThread::Run(): Reset stopEvent")); stopEvent.ResetEvent(); } } bool drained = false; do { WorkerCommandQueueEntry entry; /* * Pull an entry that describes what it is we need to do from the * queue. */ m_transport->m_workerCommandQueueLock.Lock(MUTEX_CONTEXT); QCC_DbgTrace(("UDPTransport::DispatcherThread::Run(): m_workerCommandQueue.size()=%d.", m_transport->m_workerCommandQueue.size())); if (m_transport->m_workerCommandQueue.empty()) { drained = true; } else { entry = m_transport->m_workerCommandQueue.front(); m_transport->m_workerCommandQueue.pop(); } m_transport->m_workerCommandQueueLock.Unlock(MUTEX_CONTEXT); /* * We keep at it until we completely drain this queue every time we * wake up. */ if (drained == false) { QCC_DbgTrace(("UDPTransport::DispatcherThread::Run(): command=%d., handle=%p, conn=%p., connId=%d.," "rcv=%p, passive=%d., buf=%p, len=%d., status=\"%s\"", entry.m_command, entry.m_handle, entry.m_conn, entry.m_connId, entry.m_rcv, entry.m_passive, entry.m_buf, entry.m_len, QCC_StatusText(entry.m_status))); /* * If the command is a connect callback, we may not have an * endpoint created yet. Otherwise we have a connection ID in * our command entry, and we expect it to refer to an endpoint * that is on the endpoint list. If it has been deleted out * from under us we shouldn't use it. Use the connection ID to * make the connection between ArdpConnRecord* and UDPEndpoint * (which also serves as our protocol demux functionality). */ if (entry.m_command == WorkerCommandQueueEntry::CONNECT_CB) { /* * We can't call out to some possibly windy code path out * through the daemon router with the m_endpointListLock * taken. */ QCC_DbgPrintf(("UDPTransport::DispatcherThread::Run(): CONNECT_CB: DoConnectCb()")); m_transport->DoConnectCb(entry.m_handle, entry.m_conn, entry.m_connId, entry.m_passive, entry.m_buf, entry.m_len, entry.m_status); /* * The UDPTransport::ConnectCb() handler allocated a copy of * the data buffer from ARDP since ARDP expected its buffer * back immediately. We need to delete this copy now that * we're done with it. */ #ifndef NDEBUG CheckSeal(entry.m_buf + entry.m_len); #endif delete[] entry.m_buf; entry.m_buf = NULL; entry.m_len = 0; } else { bool haveLock = true; m_transport->m_endpointListLock.Lock(MUTEX_CONTEXT); for (set::iterator i = m_transport->m_endpointList.begin(); i != m_transport->m_endpointList.end(); ++i) { UDPEndpoint ep = *i; if (entry.m_connId == ep->GetConnId()) { /* * We can't call out to some possibly windy code path * out through the daemon router with the * m_endpointListLock taken. But since we are going to * call into the endpoint, we'll bump the reference * count to indicate a thread is coming. If the ref * count bumped, the endpoint management code will not * kill the endpoint out from under us. */ ep->IncrementRefs(); m_transport->m_endpointListLock.Unlock(MUTEX_CONTEXT); haveLock = false; /* * This probably seems like a lot of trouble to make a * single method call. The problem is that if we don't * go through the trouble, we do the calls in an ARDP * callback. If we do it in a callback, that callback * must have been driven by a call to ARDP_Run() which * must have been called with the ardpLock taken. When * Start() (for example) does its RegisterEndpoint() the * daemon wants to take the name table lock to add the * endpoint to the name table. * * If another thread is sending a message through the * daemon, it wants to call into daemon router which * takes the nameTableLock to figure out which endpoint * to send to. If that destination endpoint happens to * be a UDP endpoint, it will need to take the ardpLock * to actually send the bits using ARDP_send. * * In once case the lock order is ardpLock, then * nameTableLock; in the other case the lock order is * nameTableLock, then ardpLock. Deadlock. * * Similar situations abound if we call out to the * daemon, so we cannot call into the daemon directly * from a callback which would imply the ardpLock is * taken. Instead of playing with fire, we route * callbacks to this thread to get the one call done. * * This approach does have the benefit of keeping all of * the call-outs from the ARDP protocol very quick, * amounting to usually a push onto a message queue. */ switch (entry.m_command) { case WorkerCommandQueueEntry::EXIT: { QCC_DbgPrintf(("UDPTransport::DispatcherThread::Run(): EXIT: Exit()")); ep->Exit(); break; } case WorkerCommandQueueEntry::SEND_CB: { QCC_DbgPrintf(("UDPTransport::DispatcherThread::Run(): SEND_CB: SendCb()")); ep->SendCb(entry.m_handle, entry.m_conn, entry.m_connId, entry.m_buf, entry.m_len, entry.m_status); break; } case WorkerCommandQueueEntry::RECV_CB: { QCC_DbgPrintf(("UDPTransport::DispatcherThread::Run(): RECV_CB: Call RecvCb() on endpoint message pump")); /* * We have N_PUMPS worth of what amounts to * worker threads to handle making the calls * out to the daemon router. This is to * handle cases where the reader of the * messages is slow, that then leads to the * callout to the PushMessage to block. * * We assume entry.connId to be selected * from a uniform distribution and so simply * selecting a message pump based on a mod * operation on the connection ID will * uniformly distribute the load among the * threads. * * We always select the same pump for a * given connection ID since that preserves * message ordering at the destination. * * There are complications here because * there is a possibility that the endpoint * we recently verified to exist may * actually not exist anymore as soon as we * let go of the endpoint list lock above. * The MessagePump deals with the * possibility that things are disappearing * out from underneath it. * * We assume that the message pumps array * will not be changed out from underneath * us while we are running at least. */ MessagePump* mp = m_transport->m_messagePumps[entry.m_connId % N_PUMPS]; assert(mp != NULL && "UDPTransport::DispatcherThread::Run(): Pumps array not initialized"); mp->RecvCb(entry.m_handle, entry.m_conn, entry.m_connId, entry.m_rcv, entry.m_status); break; } case WorkerCommandQueueEntry::DISCONNECT_CB: { QCC_DbgPrintf(("UDPTransport::DispatcherThread::Run(): DISCONNECT_CB: DisconnectCb(): connId=%d.", entry.m_connId)); ep->DisconnectCb(entry.m_handle, entry.m_conn, entry.m_connId, entry.m_status); break; } default: { assert(false && "UDPTransport::DispatcherThread::Run(): Unexpected command"); break; } } // switch(entry.m_command) /* * At this point, we assume that we have given the * m_endpointListLock and decremented the thread count * in the endpoint; and our iterator can no longer be * trusted (or is not there in the case of a CONNECT_CB * request. */ ep->DecrementRefs(); assert(haveLock == false && "UDPTransport::DispatcherThread::Run(): Should not have m_endpointListLock here"); break; } // if (entry.m_connId == ep->GetConnId()) } // for (set::iterator i ... /* * If we found an endpoint, we gave the lock, did the * operation and broke out of the iterator loop assuming the * iterator was no good any more. If we did not find the * endpoint, we still have the lock and we need to give it * up. Also, if we did not find an endpoint, we may have * a receive buffer we have to dispose of. We assume that * when the endpoint bailed, any callers waiting to write * were ejected and so there are no transmit buffers to * deal with. */ if (haveLock) { m_transport->m_endpointListLock.Unlock(MUTEX_CONTEXT); switch (entry.m_command) { case WorkerCommandQueueEntry::RECV_CB: { #if RETURN_ORPHAN_BUFS /* * If we get here, we have a receive callback * from ARDP but we don't have an endpoint to * route the message to. This is expected if * the endpoint has gone down but there are * messages queued up to be delivered to it. * Since there's nowhere to send such messages, * we just have to drop them. It is also * possible that ARDP has closed down the * connection under the sheets, so it may * consider the connection invalid. In that * case, we try to give it back, but if ARDP * doesn't take it back, we have to assume that * it has disposed of the buffers on its own. * We'll print a message if we are in debug mode * if that happens. */ QCC_DbgPrintf(("UDPTransport::DispatcherThread::Run(): Orphaned RECV_CB: ARDP_RecvReady()")); m_transport->m_ardpLock.Lock(); #ifndef NDEBUG QStatus alternateStatus = #endif ARDP_RecvReady(entry.m_handle, entry.m_conn, entry.m_rcv); #ifndef NDEBUG if (alternateStatus != ER_OK) { QCC_DbgPrintf(("UDPTransport::DispatcherThread::Run(): ARDP_RecvReady() returns status==\"%s\"", QCC_StatusText(alternateStatus))); } #endif m_transport->m_ardpLock.Unlock(); #else // not RETURN_ORPHAN_BUFS /* * If we get here, we have a receive callback * from ARDP but we don't have an endpoint to * route the message to. This is expected if * the endpoint has gone down but there are * messages queued up to be delivered to it. * Since there's nowhere to send such messages, * we just have to drop them. Since the * endpoint has been destroyed, we assume that * ARDP has closed down the connection and * released any pending buffers. This means * that we can just ignore the buffer. */ QCC_DbgPrintf(("UDPTransport::DispatcherThread::Run(): Orphaned RECV_CB for conn ID == %d. ignored", entry.m_connId)); #endif // not RETURN_ORPHAN_BUFS break; } default: break; } } } // else not CONNECT_CB } // if (drained == false) } while (drained == false); } QCC_DbgTrace(("UDPTransport::DispatcherThread::Run(): Exiting")); DecrementAndFetch(&m_transport->m_refCount); return 0; } /* * A thread dedicated to dispatching endpoint exit functions to avoid deadlock. */ ThreadReturn STDCALL UDPTransport::ExitDispatcherThread::Run(void* arg) { QCC_UNUSED(arg); IncrementAndFetch(&m_transport->m_refCount); QCC_DbgTrace(("UDPTransport::ExitDispatcherThread::Run()")); vector checkEvents, signaledEvents; checkEvents.push_back(&stopEvent); while (!IsStopping()) { QCC_DbgTrace(("UDPTransport::ExitDispatcherThread::Run(): Wait for some action")); signaledEvents.clear(); /* * We should never have a status returned from Event::Wait other than * ER_OK since we don't set a timeout. It is, however, the case that * Windows Event implementations may return ER_TIEMOUT even though no * timeout was set, and Posix systems may return ER_TIMER_NOT_ALLOWED. * If we were to exit in the face of such errors, the whole transport * would go down since the dispatcher thread would exit. All we can do * is to hope that any errors are transient and try again. In that * case, we will recover if the system does. We'll log an error, but * there's not really much we can do here. */ QStatus status = Event::Wait(checkEvents, signaledEvents); if (status != ER_OK) { QCC_LogError(status, ("UDPTransport::ExitDispatcherThread::Run(): Event::Wait failed")); continue; } for (vector::iterator i = signaledEvents.begin(); i != signaledEvents.end(); ++i) { if (*i == &stopEvent) { QCC_DbgTrace(("UDPTransport::ExitDispatcherThread::Run(): Reset stopEvent")); stopEvent.ResetEvent(); } } bool drained = false; do { WorkerCommandQueueEntry entry; /* * Pull an entry that describes what it is we need to do from the * queue. */ m_transport->m_exitWorkerCommandQueueLock.Lock(MUTEX_CONTEXT); QCC_DbgTrace(("UDPTransport::ExitDispatcherThread::Run(): m_exitWorkerCommandQueue.size()=%d.", m_transport->m_exitWorkerCommandQueue.size())); if (m_transport->m_exitWorkerCommandQueue.empty()) { drained = true; } else { entry = m_transport->m_exitWorkerCommandQueue.front(); m_transport->m_exitWorkerCommandQueue.pop(); } m_transport->m_exitWorkerCommandQueueLock.Unlock(MUTEX_CONTEXT); /* * We keep at it until we completely drain this queue every time we * wake up. */ if (drained == false) { QCC_DbgTrace(("UDPTransport::ExitDispatcherThread::Run(): command=%d., handle=%p, conn=%p., connId=%d.," "rcv=%p, passive=%d., buf=%p, len=%d., status=\"%s\"", entry.m_command, entry.m_handle, entry.m_conn, entry.m_connId, entry.m_rcv, entry.m_passive, entry.m_buf, entry.m_len, QCC_StatusText(entry.m_status))); bool haveLock = true; m_transport->m_endpointListLock.Lock(MUTEX_CONTEXT); for (set::iterator i = m_transport->m_endpointList.begin(); i != m_transport->m_endpointList.end(); ++i) { UDPEndpoint ep = *i; if (entry.m_connId == ep->GetConnId()) { /* * We can't call out to some possibly windy code path * out through the daemon router with the * m_endpointListLock taken. But since we are going to * call into the endpoint, we'll bump the reference * count to indicate a thread is coming. If the ref * count bumped, the endpoint management code will not * kill the endpoint out from under us. */ ep->IncrementRefs(); m_transport->m_endpointListLock.Unlock(MUTEX_CONTEXT); haveLock = false; switch (entry.m_command) { case WorkerCommandQueueEntry::EXIT: { QCC_DbgPrintf(("UDPTransport::ExitDispatcherThread::Run(): Call ep->Exit(). connId == %d.", ep->GetConnId())); ep->Exit(); break; } default: { assert(false && "UDPTransport::ExitDispatcherThread::Run(): Unexpected command"); break; } } /* * At this point, we assume that we have given the * m_endpointListLock and decremented the thread count * in the endpoint; and our iterator can no longer be * trusted. */ ep->DecrementRefs(); assert(haveLock == false && "UDPTransport::ExitDispatcherThread::Run(): Should not have m_endpointListLock here"); break; } // if (entry.m_connId == ep->GetConnId()) } // for (set::iterator i ... /* * If we found an endpoint, we gave the lock, did the operation * and broke out of the iterator loop assuming the iterator was * no good any more. If we did not find the endpoint, we still * have the lock and we need to give it up. */ if (haveLock) { m_transport->m_endpointListLock.Unlock(MUTEX_CONTEXT); } } // if (drained == false) } while (drained == false); } QCC_DbgTrace(("UDPTransport::ExitDispatcherThread::Run(): Exiting")); DecrementAndFetch(&m_transport->m_refCount); return 0; } /** * Start the UDP Transport and prepare it for accepting inbound connections or * forming outbound connections. */ QStatus UDPTransport::Start() { IncrementAndFetch(&m_refCount); QCC_DbgHLPrintf(("UDPTransport::Start()")); /* * The AllJoyn threading model says exactly one Start() can be done. */ if (IsRunning()) { QCC_LogError(ER_BUS_BUS_ALREADY_STARTED, ("UDPTransport::Start(): Already started")); DecrementAndFetch(&m_refCount); return ER_BUS_BUS_ALREADY_STARTED; } m_stopping = false; /* * Get the guid from the bus attachment which will act as the globally unique * ID of the daemon. */ qcc::String guidStr = m_bus.GetInternal().GetGlobalGUID().ToString(); /* * We're a UDP transport, and UDP is an IP protocol, so we want to use the IP * name service for our advertisement and discovery work. When we acquire * the name service, we are basically bumping a reference count and starting * it if required. * * Start() will legally be called exactly once, but Stop() and Join() may be called * multiple times. Since we are essentially reference counting the name service * singleton, we can only call Release() on it once. So we have a release count * variable that allows us to only release the singleton on the first transport * Join() */ QCC_DbgPrintf(("UDPTransport::Start(): Aquire instance of NS")); m_nsReleaseCount = 0; IpNameService::Instance().Acquire(guidStr); /* * Tell the name service to call us back on our FoundCallback method when * we hear about a new well-known bus name. */ QCC_DbgPrintf(("UDPTransport::Start(): Set NS callback")); IpNameService::Instance().SetCallback(TRANSPORT_UDP, new CallbackImpl&, uint32_t> (&m_foundCallback, &FoundCallback::Found)); IpNameService::Instance().SetNetworkEventCallback(TRANSPORT_UDP, new CallbackImpl&> (&m_networkEventCallback, &NetworkEventCallback::Handler)); uint32_t availConn = m_maxConn - m_currConn; uint32_t availRemoteClientsUdp = m_maxRemoteClientsUdp - m_numUntrustedClients; availRemoteClientsUdp = std::min(availRemoteClientsUdp, availConn); IpNameService::Instance().UpdateDynamicScore(TRANSPORT_UDP, availConn, m_maxConn, availRemoteClientsUdp, m_maxRemoteClientsUdp); QCC_DbgPrintf(("UDPTransport::Start(): Spin up message dispatcher thread")); m_dispatcher = new DispatcherThread(this); QStatus status = m_dispatcher->Start(NULL, NULL); if (status != ER_OK) { QCC_LogError(status, ("UDPTransport::Start(): Failed to Start() message dispatcher thread")); DecrementAndFetch(&m_refCount); return status; } QCC_DbgPrintf(("UDPTransport::Start(): Spin up exit dispatcher thread")); m_exitDispatcher = new ExitDispatcherThread(this); status = m_exitDispatcher->Start(NULL, NULL); if (status != ER_OK) { QCC_LogError(status, ("UDPTransport::Start(): Failed to Start() exit dispatcher thread")); DecrementAndFetch(&m_refCount); return status; } /* * Start the maintenance loop through the thread base class. This will * close or open the IsRunning() gate we use to control access to our public * API. */ QCC_DbgPrintf(("UDPTransport::Start(): Spin up main thread")); status = Thread::Start(); m_dynamicScoreUpdater.Start(); DecrementAndFetch(&m_refCount); return status; } bool operator<(const UDPTransport::ConnectEntry& lhs, const UDPTransport::ConnectEntry& rhs) { return lhs.m_connId < rhs.m_connId; } /** * Ask all of the threads that may be wandering around in the UDP Transport or * its associated endpoints to begin leaving. */ QStatus UDPTransport::Stop(void) { IncrementAndFetch(&m_refCount); QCC_DbgTrace(("UDPTransport::Stop()")); /* * It is legal to call Stop() more than once, so it must be possible to * call Stop() on a stopped transport. */ m_stopping = true; /* * Tell the name service to disregard all our prior advertisements and * discoveries. The internal state will shortly be discarded as well. */ m_listenRequestsLock.Lock(MUTEX_CONTEXT); QCC_DbgPrintf(("UDPTransport::Stop(): Gratuitously clean out advertisements.")); for (list::iterator i = m_advertising.begin(); i != m_advertising.end(); ++i) { IpNameService::Instance().CancelAdvertiseName(TRANSPORT_UDP, *i, TRANSPORT_UDP); } m_advertising.clear(); m_routerNameAdvertised = false; m_isAdvertising = false; QCC_DbgPrintf(("UDPTransport::Stop(): Gratuitously clean out discoveries.")); for (list::iterator i = m_discovering.begin(); i != m_discovering.end(); ++i) { IpNameService::Instance().CancelFindAdvertisement(TRANSPORT_UDP, *i, TRANSPORT_UDP); } m_discovering.clear(); m_isDiscovering = false; m_listenRequestsLock.Unlock(MUTEX_CONTEXT); /* * Tell the name service to stop calling us back if it's there (we may get * called more than once in the chain of destruction) so the pointer is not * required to be non-NULL. */ QCC_DbgPrintf(("UDPTransport::Stop(): Clear NS callback")); IpNameService::Instance().SetCallback(TRANSPORT_UDP, NULL); IpNameService::Instance().SetNetworkEventCallback(TRANSPORT_UDP, NULL); IpNameService::Instance().UpdateDynamicScore(TRANSPORT_UDP, 0, 0, 0, 0); /* * Ask any running endpoints to shut down and stop allowing routing to * happen through this transport. The endpoint needs to wake any threads * that may be waiting for I/O and arrange for itself to be cleaned up by * the maintenance thread. */ QCC_DbgPrintf(("UDPTransport::Stop(): Stop endpoints")); QCC_DbgPrintf(("UDPTransport::Stop(): Taking pre-auth list lock")); m_preListLock.Lock(MUTEX_CONTEXT); for (set::iterator i = m_preList.begin(); i != m_preList.end(); ++i) { UDPEndpoint ep = *i; /* * Since the UDP Transport is going down, we assume the entire routing * node is going down for a reason, and we should not be waiting for * queued data to make its way out to the remote side. We don't delay * the shutdown process for this reason at all. */ ep->SetEpWaitEnable(false); ep->Stop(); } QCC_DbgPrintf(("UDPTransport::Stop(): Giving pre-auth list lock")); m_preListLock.Unlock(MUTEX_CONTEXT); QCC_DbgPrintf(("UDPTransport::Stop(): Taking endpoint list lock")); m_endpointListLock.Lock(MUTEX_CONTEXT); for (set::iterator i = m_authList.begin(); i != m_authList.end(); ++i) { UDPEndpoint ep = *i; ep->SetEpWaitEnable(false); ep->Stop(); } for (set::iterator i = m_endpointList.begin(); i != m_endpointList.end(); ++i) { UDPEndpoint ep = *i; ep->SetEpWaitEnable(false); ep->Stop(); } /* * If there are any threads blocked trying to connect to a remote host, we * need to wake them up so they leave before we actually go away. We are * guaranteed by contract that if there is an entry in the connect threads * set, the thread is still there and the event has not been destroyed. * This is critical since the event was created on the stack of the * connecting thread. These entries will be verified as being gone in * Join(). */ QCC_DbgPrintf(("UDPTransport::Stop(): Alert connectThreads")); for (set::const_iterator i = m_connectThreads.begin(); i != m_connectThreads.end(); ++i) { i->m_event->SetEvent(); } QCC_DbgPrintf(("UDPTransport::Stop(): Giving endpoint list lock")); m_endpointListLock.Unlock(MUTEX_CONTEXT); m_dynamicScoreUpdater.Stop(); /* * This is the logical place to stop the dispatcher thread and the main * server thread, but we might have outstanding writes queued up with ARDP * at this point. The writes come back through callbacks which are driven * by the main thread and picked up and executed by the dispatcher thread. * We need to keep those puppies running until the number of outstanding * writes for all streams drop to zero -- so we do the stop in Join() where * we can block until this all happens. The endpoint Stop() calls above * will start the process. */ DecrementAndFetch(&m_refCount); return ER_OK; } /** * Wait for all of the threads that may be wandering around in the UDP Transport * or its associated endpoints to complete their cleanup process and leave the * transport. When this method completes, it must be safe to delete the object. * Note that this method may be called multiple times. */ QStatus UDPTransport::Join(void) { IncrementAndFetch(&m_refCount); QCC_DbgTrace(("UDPTransport::Join()")); /* * The logical place to stop the dispatcher thread and the main server * thread would be in Stop(), but we might have outstanding writes queued up * with ARDP at that point. The writes come back through callbacks which * are driven by the main thread and picked up and executed by the * dispatcher thread. We need to keep those puppies running until the * number of outstanding writes for all streams drop to zero -- so we do the * stop here in Join() where we can block until this all happens. The * endpoint Stop() calls in UDPTransport::Stop() will begin the process. We * need to wait for it to complete here. Since the endpoint manager will be * taking care of all of that and then deleting the endpoints, the most * straightforward thing to do here is to wait for the endpoints to go away * before proceeding with the transport takedown. */ QCC_DbgPrintf(("UDPTransport::Join(): Taking endpoint list lock")); m_endpointListLock.Lock(MUTEX_CONTEXT); QCC_DbgPrintf(("UDPTransport::Join(): Taking pre-auth list lock")); m_preListLock.Lock(MUTEX_CONTEXT); bool passive; do { passive = m_preList.empty() && m_authList.empty() && m_endpointList.empty(); if (!passive) { QCC_DbgPrintf(("UDPTransport::Join(): Giving pre-auth list lock")); m_preListLock.Unlock(MUTEX_CONTEXT); QCC_DbgPrintf(("UDPTransport::Join(): Giving endpoint list lock")); m_endpointListLock.Unlock(MUTEX_CONTEXT); qcc::Sleep(10); QCC_DbgPrintf(("UDPTransport::Join(): Taking endpoint list lock")); m_endpointListLock.Lock(MUTEX_CONTEXT); QCC_DbgPrintf(("UDPTransport::Join(): Taking pre-auth list lock")); m_preListLock.Lock(MUTEX_CONTEXT); } } while (!passive); QCC_DbgPrintf(("UDPTransport::Join(): Giving pre-auth list lock")); m_preListLock.Unlock(MUTEX_CONTEXT); QCC_DbgPrintf(("UDPTransport::Join(): Giving endpoint list lock")); m_endpointListLock.Unlock(MUTEX_CONTEXT); /* * Now that there are no enpoints needin them, we can go ahead and * take down the message pumps and dispatcher threads since thre * is no more work for them. */ QCC_DbgPrintf(("UDPTransport::Stop(): Stop() message pumps")); for (uint32_t i = 0; i < N_PUMPS; ++i) { m_messagePumps[i]->Stop(); } QCC_DbgPrintf(("UDPTransport::Join(): Stop message dispatcher thread")); if (m_dispatcher) { m_dispatcher->Stop(); } QCC_DbgPrintf(("UDPTransport::Join(): Stop exit dispatcher thread")); if (m_exitDispatcher) { m_exitDispatcher->Stop(); } /* * Tell the main server loop thread to shut down. We'll wait for it to do * so below. */ QCC_DbgPrintf(("UDPTransport::Join(): Stop main thread")); QStatus status = Thread::Stop(); if (status != ER_OK) { QCC_LogError(status, ("UDPTransport::Join(): Failed to Stop() server thread")); DecrementAndFetch(&m_refCount); return status; } /* * Join() all of the message pumps. */ QCC_DbgPrintf(("UDPTransport::Join(): Join() message pumps")); for (uint32_t i = 0; i < N_PUMPS; ++i) { m_messagePumps[i]->Join(); } /* * We waited for the dispatcher thread to finish dispatching all in-process * sends above, so it has nothing to do now and we can get rid of it. */ QCC_DbgPrintf(("UDPTransport::Join(): Join and delete message dispatcher thread")); if (m_dispatcher) { m_dispatcher->Join(); delete m_dispatcher; m_dispatcher = NULL; } QCC_DbgPrintf(("UDPTransport::Join(): Join and delete exit dispatcher thread")); if (m_exitDispatcher) { m_exitDispatcher->Join(); delete m_exitDispatcher; m_exitDispatcher = NULL; } /* * Now, if we have any message buffers queued up in our own internals it is * time to get rid of them. */ QCC_DbgPrintf(("UDPTransport::Join(): Return unused message buffers to ARDP")); while (m_workerCommandQueue.empty() == false) { WorkerCommandQueueEntry entry = m_workerCommandQueue.front(); m_workerCommandQueue.pop(); /* * The ARDP module will have allocated memory (in some private way) for * any messages that are waiting to be routed. We can't just ignore * that situation or we may leak memory. Give any buffers back to the * protocol before leaving. The assumption here is that ARDP will do * the right think in ARDP_REcvReady() and not require a subsequent * call to ARDP_Run() which will not happen since the main thread is * Stop()ped. */ if (entry.m_command == WorkerCommandQueueEntry::RECV_CB) { m_ardpLock.Lock(); #ifndef NDEBUG QStatus alternateStatus = #endif ARDP_RecvReady(entry.m_handle, entry.m_conn, entry.m_rcv); #ifndef NDEBUG if (alternateStatus != ER_OK) { QCC_DbgPrintf(("UDPTransport::Join(): ARDP_RecvReady() returns status==\"%s\"", QCC_StatusText(alternateStatus))); } #endif m_ardpLock.Unlock(); } /* * Similarly, we may have copied out the BusHello in a connect callback * so we need to delete that buffer if it's there. */ if (entry.m_command == WorkerCommandQueueEntry::CONNECT_CB) { #ifndef NDEBUG CheckSeal(entry.m_buf + entry.m_len); #endif delete[] entry.m_buf; } } /* * It is legal to call Join() more than once, so it must be possible to * call Join() on a joined transport and also on a joined name service. * Note that the thread we are joining here is the single UDP Transport * maintenance thread. When it finally closes, all of the threads * previously wandering around in the transport must be gone. */ QCC_DbgPrintf(("UDPTransport::Join(): Join main thread")); status = Thread::Join(); if (status != ER_OK) { QCC_LogError(status, ("UDPTransport::Join(): Failed to Join() server thread")); DecrementAndFetch(&m_refCount); return status; } /* * Tell the IP name service instance that we will no longer be making calls * and it may shut down if we were the last transport. This release can * be thought of as a reference counted Stop()/Join() so it is appropriate * to make it here since we are expecting the possibility of blocking. * * Since it is reference counted, we can't just call it willy-nilly. We * have to be careful since our Join() can be called multiple times. */ int count = qcc::IncrementAndFetch(&m_nsReleaseCount); if (count == 1) { IpNameService::Instance().Release(); } /* * We must have asked any running endpoints to shut down and to wake any * threads that may be waiting for I/O. Before we delete the endpoints * out from under those threads, we need to wait until they actually * all leave the endpoints. We are in a Join() so it's okay if we take * our time and since the transport is shutting down, no new endpoints * will be formed, so it is okay to hold the endpoint lock during the * Join()s. */ QCC_DbgPrintf(("UDPTransport::Join(): Taking pre-auth list lock")); m_preListLock.Lock(MUTEX_CONTEXT); for (set::iterator i = m_preList.begin(); i != m_preList.end(); ++i) { UDPEndpoint ep = *i; ep->Join(); } QCC_DbgPrintf(("UDPTransport::Join(): Giving pre-auth list lock")); m_preListLock.Unlock(MUTEX_CONTEXT); QCC_DbgPrintf(("UDPTransport::Join(): Taking endpoint list lock")); m_endpointListLock.Lock(MUTEX_CONTEXT); for (set::iterator i = m_authList.begin(); i != m_authList.end(); ++i) { UDPEndpoint ep = *i; ep->Join(); } for (set::iterator i = m_endpointList.begin(); i != m_endpointList.end(); ++i) { UDPEndpoint ep = *i; ep->Join(); } /* * If there were any threads blocked waiting to connect through to a * remote host, they should have been woken up in Stop() and they should * now wake up and be leaving of their own accord. We need to wait * until they are all actually done and gone before proceeding to what * will ultimately mean the destruction of the transport. */ while (m_connectThreads.empty() == false) { QCC_DbgTrace(("UDPTransport::Join(): Waiting for %d. threads to exit", m_connectThreads.size())); /* * Okay, this is the last call. If there are still any threads waiting * in UDPTransport::Connect() we need to convince them to leave. Bug * Their events again. */ for (set::iterator j = m_connectThreads.begin(); j != m_connectThreads.end(); ++j) { j->m_event->SetEvent(); } /* * Wait for "a while." This means long enough to get all of the * threads scheduled and run so they can wander out of the endpoint. * We would like to wait on an event that is bugged when all threads * have left the endpoint, but that would mean an expensive event * per endpoint only to optimize during shutdown and we just can't * afford that. So we poll, waiting long enough to ensure that our * thread is rescheduled. * * Some Linux boxes will busy-wait if the time is two milliseconds * or less, and most will round up to jiffy resolution (defaults to * 10 ms) and then bump again to the next higher Jiffy to ensure * that at least the requested time has elapsed. So we pick 10 ms * and expect the loop to run every 20 ms in the usual case, * ensuring that the waiting threads get time to run and leave. */ QCC_DbgPrintf(("UDPTransport::Join(): Giving endpoint list lock")); m_endpointListLock.Unlock(MUTEX_CONTEXT); qcc::Sleep(10); QCC_DbgPrintf(("UDPTransport::Join(): Taking endpoint list lock")); m_endpointListLock.Lock(MUTEX_CONTEXT); } /* * The above loop will not terminate until all connecting threads are gone. * There are now no threads running in UDP endpoints or in the transport and * since we already Join()ed the maintenance thread we can delete all of the * endpoints here. */ set::iterator i; QCC_DbgPrintf(("UDPTransport::Join(): Taking pre-auth list lock")); m_preListLock.Lock(MUTEX_CONTEXT); while ((i = m_preList.begin()) != m_preList.end()) { #ifndef NDEBUG UDPEndpoint ep = *i; QCC_DbgTrace(("UDPTransport::Join(): Erasing endpoint with conn ID == %d. from m_preList", ep->GetConnId())); #endif m_preList.erase(i); } QCC_DbgPrintf(("UDPTransport::Join(): Giving pre-auth list lock")); m_preListLock.Unlock(MUTEX_CONTEXT); while ((i = m_authList.begin()) != m_authList.end()) { #ifndef NDEBUG UDPEndpoint ep = *i; QCC_DbgTrace(("UDPTransport::Join(): Erasing endpoint with conn ID == %d. from m_authList", ep->GetConnId())); #endif m_authList.erase(i); /* * If the endpoint is on the auth list, it occupies a slot on the * authentication count and the total connection count. Update both * counts. */ m_connLock.Lock(MUTEX_CONTEXT); --m_currAuth; --m_currConn; m_connLock.Unlock(MUTEX_CONTEXT); } while ((i = m_endpointList.begin()) != m_endpointList.end()) { #ifndef NDEBUG UDPEndpoint ep = *i; QCC_DbgTrace(("UDPTransport::Join(): Erasing endpoint with conn ID == %d. from m_endpointList", ep->GetConnId())); #endif /* * If the endpoint is on the endpoint list, it occupies a slot only on * the total connection count. Update that count. */ m_connLock.Lock(MUTEX_CONTEXT); m_endpointList.erase(i); --m_currConn; m_connLock.Unlock(MUTEX_CONTEXT); } QCC_DbgPrintf(("UDPTransport::Join(): Giving endpoint list lock")); m_endpointListLock.Unlock(MUTEX_CONTEXT); m_dynamicScoreUpdater.Join(); m_stopping = false; DecrementAndFetch(&m_refCount); return ER_OK; } /** * This is a convenience function that tells a caller whether or not this * transport will support a set of options for a connection. Lets the caller * decide up front whether or not a connection will succeed due to options * conflicts. */ bool UDPTransport::SupportsOptions(const SessionOpts& opts) const { IncrementAndFetch(&m_refCount); QCC_DbgTrace(("UDPTransport::SupportsOptions()")); bool rc = true; /* * UDP does not support raw sockets, since there is only one socket that * must be shared among all users; so we only return true if the traffic * type is TRAFFIC_MESSAGES. It's not an error if we don't match, we just * don't have anything to offer. */ if (opts.traffic != SessionOpts::TRAFFIC_MESSAGES) { QCC_DbgPrintf(("UDPTransport::SupportsOptions(): traffic type mismatch")); rc = false; } /* * The other session option that we need to filter on is the transport * bitfield. If you are explicitly looking for something other than UDP we * can't help you. */ if ((opts.transports & TRANSPORT_UDP) == false) { QCC_DbgPrintf(("UDPTransport::SupportsOptions(): transport mismatch")); rc = false; } QCC_DbgPrintf(("UDPTransport::SupportsOptions(): returns \"%s\"", rc == true ? "true" : "false")); DecrementAndFetch(&m_refCount); return rc; } /* * The default interface for the name service to use. The wildcard character * means to listen and transmit over all interfaces that are up and multicast * capable, with any IP address they happen to have. This default also applies * to the search for listen address interfaces. */ static const char* INTERFACES_DEFAULT = "*"; /** * This is a somewhat obscure method used by the AllJoyn object to determine if * there are possibly multiple ways to connect to an advertised bus address. * Our goal is to enumerate all of the possible interfaces over which we can be * contacted -- for example, eth0, wlan0 -- and construct bus address strings * matching each one. */ QStatus UDPTransport::GetListenAddresses(const SessionOpts& opts, std::vector& busAddrs) const { IncrementAndFetch(&m_refCount); QCC_DbgTrace(("UDPTransport::GetListenAddresses()")); /* * We are given a session options structure that defines the kind of * transports that are being sought. It's not an error if we don't match * requested options, we just don't have anything to offer. */ if (SupportsOptions(opts) == false) { QCC_DbgPrintf(("UDPTransport::GetListenAddresses(): Supported options mismatch")); DecrementAndFetch(&m_refCount); return ER_OK; } /* * The name service is initialized by the call to Init() in our Start() * method and then started there. It is Stop()ped in our Stop() method and * joined in our Join(). In the case of a call here, the transport will * probably be started, and we will probably find the name service started, * but there is no requirement to ensure this. If m_ns is NULL, we need to * complain so the user learns to Start() the transport before calling * IfConfig. A call to IsRunning() here is superfluous since we really * don't care about anything but the name service in this method. */ if (IpNameService::Instance().Started() == false) { QCC_LogError(ER_BUS_TRANSPORT_NOT_STARTED, ("UDPTransport::GetListenAddresses(): NameService not started")); DecrementAndFetch(&m_refCount); return ER_BUS_TRANSPORT_NOT_STARTED; } /* * Our goal is here is to match a list of interfaces provided in the * configuration database (or a wildcard) to a list of interfaces that are * IFF_UP in the system. The first order of business is to get the list of * interfaces in the system. We do that using a convenient OS-inependent * call into the name service. * * We can't cache this list since it may change as the phone wanders in * and out of range of this and that and the underlying IP addresses change * as DHCP doles out whatever it feels like at any moment. */ QCC_DbgPrintf(("UDPTransport::GetListenAddresses(): IfConfig()")); std::vector entries; QStatus status = qcc::IfConfig(entries); if (status != ER_OK) { QCC_LogError(status, ("UDPTransport::GetListenAddresses(): IfConfig() failed")); DecrementAndFetch(&m_refCount); return status; } /* * The next thing to do is to get the list of requested interfaces that * have been processed. A '*' or '0.0.0.0' being a wildcard indicating * that we want to match any interface. If there is no configuration * item, we default to something rational. */ std::set interfaceSet; bool haveWildcard = false; /* * Check for wildcard anywhere in the configuration string. This trumps * anything else that may be there and ensures we get only one copy of * the addresses if someone tries to trick us with duplicate "*". */ if (m_wildcardIfaceProcessed || m_wildcardAddressProcessed) { interfaceSet.insert(INTERFACES_DEFAULT); haveWildcard = true; } else { for (std::map::const_iterator it = m_requestedInterfaces.begin(); it != m_requestedInterfaces.end(); it++) { if (it->first != "*" && it->second.GetAddress().ToString() != "0.0.0.0") { interfaceSet.insert(it->first); } } for (std::map::const_iterator it = m_requestedAddresses.begin(); it != m_requestedAddresses.end(); it++) { if (it->first != "0.0.0.0" && !it->second.empty()) { interfaceSet.insert(it->second); } } } if (interfaceSet.size() == 0) { interfaceSet.insert(INTERFACES_DEFAULT); haveWildcard = true; } /* * Walk the comma separated list from the configuration file and and try * to mach it up with interfaces actually found in the system. */ for (std::set::const_iterator it = interfaceSet.begin(); it != interfaceSet.end(); it++) { /* * We got a set of interfaces, so we need to work our way through * the set. Each entry in the list may be an interface name, or a * wildcard. */ qcc::String currentInterface = *it; QCC_DbgPrintf(("UDPTransport::GetListenAddresses(): looking for interface %s", currentInterface.c_str())); /* * Walk the list of interfaces that we got from the system and see if * we find a match. */ for (uint32_t i = 0; i < entries.size(); ++i) { QCC_DbgPrintf(("UDPTransport::GetListenAddresses(): matching %s", entries[i].m_name.c_str())); /* * To match a configuration entry, the name of the interface must: * * - match the name in the currentInterface (or be wildcarded); * - be UP which means it has an IP address assigned; * - not be the LOOPBACK device and therefore be remotely available. */ uint32_t mask = qcc::IfConfigEntry::UP | qcc::IfConfigEntry::LOOPBACK; uint32_t state = qcc::IfConfigEntry::UP; if ((entries[i].m_flags & mask) == state) { QCC_DbgPrintf(("UDPTransport::GetListenAddresses(): %s has correct state", entries[i].m_name.c_str())); if (haveWildcard || entries[i].m_name == currentInterface) { QCC_DbgPrintf(("UDPTransport::GetListenAddresses(): %s has correct name", entries[i].m_name.c_str())); /* * This entry matches our search criteria, so we need to * turn the IP address that we found into a busAddr. We * must be a UDP transport, and we have an IP address * already in a string, so we can easily put together the * desired busAddr. */ QCC_DbgPrintf(("UDPTransport::GetListenAddresses(): %s match found", entries[i].m_name.c_str())); /* * We know we have an interface that speaks IP and which has * an IP address we can pass back. We know it is capable of * receiving incoming connections, but the $64,000 questions * are, does it have a listener and what port is that * listener listening on. * * There is one name service associated with the daemon UDP * transport. It may be advertising a different port on each * network interface. If multiple listeners are created for * a network interface, the name service only advertises the * lastly set port for that network interface. Ask the name * service for a map that correlates the different interfaces * it is advertising on to the respective ports we are listening on. */ qcc::String ipv4address; qcc::String ipv6address; std::map reliableIpv4PortMap, unreliableIpv4PortMap; uint16_t reliableIpv6Port, unreliableIpv6port; IpNameService::Instance().Enabled(TRANSPORT_UDP, reliableIpv4PortMap, reliableIpv6Port, unreliableIpv4PortMap, unreliableIpv6port); /* * If no listening port corresponding to this network interface is found in the map, * then it hasn't been set and this implies that there is no listener for this transport * on this network interface. We should only return a bus address corresponding to this * network interface if we have a listener on this network interface. * * Note that if we find a "*" in the unreliableIPv4PortMap it is a wildcard and therefore * matches the entry we are comparing to, in which case we are not comparing the entry to * what's in the port map, we are using what's in the port map to confirm the entry. */ bool portMapWildcard = unreliableIpv4PortMap.find(qcc::String("*")) != unreliableIpv4PortMap.end(); bool portMapExplicit = unreliableIpv4PortMap.find(entries[i].m_name) != unreliableIpv4PortMap.end(); if (portMapWildcard || portMapExplicit) { uint16_t port = 0; if (portMapWildcard) { port = unreliableIpv4PortMap[qcc::String("*")]; } else { port = unreliableIpv4PortMap[entries[i].m_name]; } /* * Now put this information together into a bus address * that the rest of the AllJoyn world can understand. */ if (!entries[i].m_addr.empty() && (entries[i].m_family == QCC_AF_INET)) { qcc::String busAddr = "udp:addr=" + entries[i].m_addr + "," "port=" + U32ToString(port) + "," "family=ipv4"; QCC_DbgPrintf(("UDPTransport::GetListenAddresses(): push busAddr=\"%s\"", busAddr.c_str())); busAddrs.push_back(busAddr); } } } } } } /* * If we can get the list and walk it, we have succeeded. It is not an * error to have no available interfaces. In fact, it is quite expected * in a phone if it is not associated with an access point over wi-fi. */ QCC_DbgPrintf(("UDPTransport::GetListenAddresses(): done")); DecrementAndFetch(&m_refCount); return ER_OK; } void UDPTransport::EmitStallWarnings(UDPEndpoint& ep) { QCC_DbgTrace(("UDPTransport::EmitStallWarnings()")); ArdpStream* stream = ep->GetStream(); assert(stream && "UDPTransport::EmitStallWarnings(): stream must exist"); bool threadSetEmpty = stream->ThreadSetEmpty(); bool disconnected = stream->GetDisconnected(); Timespec tNow; GetTimeNow(&tNow); Timespec tStop = ep->GetStopTime(); int32_t tRemaining = tStop + UDP_WATCHDOG_TIMEOUT - tNow; /* * If tRemaining is less than zero, the endpoint is stalled. */ if (tRemaining < 0) { /* * Once stalled we don't want to print an error every time thought the * management loop, so we limit ourselves to logging errors every few * seconds */ Timespec tStalled = ep->GetStallTime(); int32_t tDelay = tStalled + UDP_STALL_REPORT_INTERVAL - tNow; if (tDelay > 0) { return; } ep->SetStallTime(tNow); QCC_LogError(ER_UDP_ENDPOINT_STALLED, ("UDPTransport::EmitStallWarnings(): Endpoint with conn ID == %d stalled", ep->GetConnId())); if (threadSetEmpty == false) { QCC_LogError(ER_UDP_ENDPOINT_STALLED, ("UDPTransport::EmitStallWarnings(): stalled not threadSetEmpty")); } if (disconnected == false) { QCC_LogError(ER_UDP_ENDPOINT_STALLED, ("UDPTransport::EmitStallWarnings(): stalled not disconnected")); ArdpStream* stream = ep->GetStream(); if (stream) { #ifndef NDEBUG bool disc = stream->GetDisconnected(); bool discSent = stream->GetDiscSent(); ArdpConnRecord* conn = stream->GetConn(); QCC_DbgPrintf(("UDPTransport::EmitStallWarnings(): stalled not disconneccted. disc=\"%s\", discSent=\"%s\", conn=%p", disc ? "true" : "false", discSent ? "true" : "false", conn)); #endif QCC_LogError(ER_UDP_ENDPOINT_STALLED, ("UDPTransport::EmitStallWarnings(): stalled not disconneccted.")); } else { QCC_LogError(ER_UDP_ENDPOINT_STALLED, ("UDPTransport::EmitStallWarnings(): stalled not disconnected. No stream")); } } if (threadSetEmpty == false && disconnected == false) { QCC_LogError(ER_UDP_ENDPOINT_STALLED, ("UDPTransport::EmitStallWarnings(): stalled with threadSetEmpty and disconnected")); } } } /** * This method is used to deal with the lifecycle of all endpoints created by * the UDP Transport. It is called on-demand and periodically by the main run * loop in order to detect connections / endpoints that are taking too long to * authenticate and also to deal with endpoints that are being torn down. * * The main complexities here are to ensure that there are no threads wandering * around in endpoints before we remove them, ensuring that the endpoints are * completely detached from the router and that the UDP Transport holds the final * reference to endpoints to make absolutely sure that there are going to be no * suprise threads popping up in a deleted object. We also cannot block waiting * for things to happen, since we would block the protocol (as it stands now there * is one thread managing endpoints and driving ARDP). */ void UDPTransport::ManageEndpoints(Timespec authTimeout, Timespec sessionSetupTimeout) { QCC_UNUSED(sessionSetupTimeout); QCC_DbgTrace(("UDPTransport::ManageEndpoints()")); bool managed = false; /* * We have an array of message pumps running in order to handle messages * that need to be pushed into the daemon router. There is a chance that * any one of these pumps has had a message pump thread running, but that * pump decided that it could stop the thread due to a lack of message * traffic. These threads that are stopped are called past threads. * Something needs to join those defunct pump threads and that something is * us. */ QCC_DbgPrintf(("UDPTransport::ManageEndpoints(): MessagePump::JoinPast()")); for (uint32_t i = 0; i < N_PUMPS; ++i) { m_messagePumps[i]->JoinPast(); } set::iterator i; QCC_DbgPrintf(("UDPTransport::ManageEndpoints(): Taking endpoint list lock")); m_endpointListLock.Lock(MUTEX_CONTEXT); /* * If there are any endpoints on the preList, move them to the authList. */ QCC_DbgPrintf(("UDPTransport::ManageEndpoints(): Taking pre-auth list lock")); m_preListLock.Lock(MUTEX_CONTEXT); QCC_DbgPrintf(("UDPTransport::ManageEndpoints(): There are %d. endpoints on m_preList", m_preList.size())); i = m_preList.begin(); while (i != m_preList.end()) { QCC_DbgPrintf(("UDPTransport::ManageEndpoints(): Moving endpoint from m_preList to m_authList")); UDPEndpoint ep = *i; QCC_DbgPrintf(("UDPTransport::ManageEndpoints(): Moving endpoint with connId == %d. from m_preList to m_authList", ep->GetConnId())); #ifndef NDEBUG ep->PrintEpState("UDPTransport::ManageEndpoints(): m_preList"); #endif m_authList.insert(ep); m_preList.erase(i); i = m_preList.begin(); } QCC_DbgPrintf(("UDPTransport::ManageEndpoints(): Giving pre-auth list lock")); m_preListLock.Unlock(MUTEX_CONTEXT); /* * If the transport has been told to start the process of shutting down, we * need to make sure we tell all of our endpoints to start the process of * disconnecting. */ if (IsRunning() == false || m_stopping == true) { QCC_DbgPrintf(("UDPTransport::ManageEndpoints(): m_stopping: Stopping endpoints on m_endpointList")); for (i = m_endpointList.begin(); i != m_endpointList.end(); ++i) { UDPEndpoint ep = *i; #ifndef NDEBUG ep->PrintEpState("UDPTransport::ManageEndpoints(): m_stopping m_endpointList"); #endif /* * The Endpoint Stop method will set m_manage and alert * the maintenance thread whenever it is called in case it * is called from a third party (Daemon Router, for * example). Be careful to only call stop if the endpoint * is in a "lower" state (hasn't progressed to at least * EP_STOPPING) or we end up efectively polling for * completion as we Stop() the endpoint which alerts the * maintenance thread which runs and causes us to Stop() * the endpoint, which ... */ if (ep->IsEpDone() == false && ep->IsEpJoined() == false && ep->IsEpWaiting() == false && ep->IsEpStopping() == false) { ep->SetEpWaitEnable(false); ep->Stop(); } } i = m_authList.begin(); while (i != m_authList.end()) { UDPEndpoint ep = *i; #ifndef NDEBUG ep->PrintEpState("UDPTransport::ManageEndpoints(): m_stopping m_authList"); #endif ep->SetEpWaitEnable(false); ep->Stop(); QCC_DbgPrintf(("UDPTransport::ManageEndpoints(): Moving endpoint with connId == %d. from m_authList to m_endpointList", ep->GetConnId())); m_endpointList.insert(ep); m_authList.erase(i); i = m_authList.begin(); } } /* * Run through the list of connections on the authList and cleanup any that * are taking too long to authenticate. These are connections that are in * the middle of the three-way handshake. */ QCC_DbgPrintf(("UDPTransport::ManageEndpoints(): There are %d. endpoints on m_authList", m_authList.size())); i = m_authList.begin(); while (i != m_authList.end()) { UDPEndpoint ep = *i; #ifndef NDEBUG ep->PrintEpState("UDPTransport::ManageEndpoints(): Managing m_authList"); #endif Timespec tNow; GetTimeNow(&tNow); if (ep->GetStartTime() + authTimeout < tNow) { QCC_DbgPrintf(("UDPTransport::ManageEndpoints(): Scavenging slow authenticator")); /* * If the authentication doesn't happen, the three-way handshake * doesn't complete and the endpoint just goes quiescent without * ever starting up. If an endpoint sits on the list of endpoints * currently authenticating for too long, we need to just whack it. * If the endpoint was created during a passive accept, there is no * problem, but if the endpoint was created as part of an active * connection, there is a thread waiting for the Connect to finish, * so we need to wake it and let it leave before getting rid of the * endpoint. */ bool threadWaiting = false; set::iterator j = m_connectThreads.begin(); for (; j != m_connectThreads.end(); ++j) { /* * The question of the moment will be: is the endpoint referred * to by the endpoint iterator i the same one referred to by the * connect thread entry referred to by the entry iterator j. If * it is, then we have a thread blocked on that endpoint and we * must wake it. We rely on matching the connection IDs to make * that call. * * Once we set the event to wake the thread, we still can't do * anything until the thread actually leaves, at which point we * will no longer find it in the connect threads set. */ if (j->m_connId == ep->GetConnId()) { QCC_DbgTrace(("UDPTransport::ManageEndpoints(): Waking thread on slow authenticator with conn ID == %d.", j->m_connId)); j->m_event->SetEvent(); threadWaiting = true; } } /* * No threads waiting in this endpoint. Just take it off of the * authList, make sure it is at least stopping and put it on the * endpoint list where it will be picked up and done away with. */ if (threadWaiting == false) { QCC_DbgHLPrintf(("UDPTransport::ManageEndpoints(): Moving slow authenticator with conn ID == %d. to m_endpointList", ep->GetConnId())); /* * If the endpoint is on the auth list, it occupies a slot on * both the authentication count and the total conneciton count. * If we remove it from the authentication list and put it on * the endpoint list, we are saying we are done with * authentication. Update that count, but leave the endpoint as * occupying a slot in the total connection count since it is an * endpoint on a list. */ m_connLock.Lock(MUTEX_CONTEXT); m_authList.erase(i); /* * If we are shutting down this endpoint because it hasn't * authenticated we presume there cannot be any interesting * information buffered for transmission to the remote side. We * therefore disable the EP_WAITING state. */ ep->SetEpWaitEnable(false); ep->Stop(); QCC_DbgPrintf(("UDPTransport::ManageEndpoints(): Moving endpoint with connId == %d. from m_authList to m_endpointList", ep->GetConnId())); m_endpointList.insert(ep); --m_currAuth; m_connLock.Unlock(MUTEX_CONTEXT); i = m_authList.upper_bound(ep); continue; } } ++i; } /* * We've handled the authList, so now run through the list of connections on * the endpointList and cleanup any that are no longer running. */ QCC_DbgPrintf(("UDPTransport::ManageEndpoints(): There are %d. endpoints on m_endpointList", m_endpointList.size())); i = m_endpointList.begin(); while (i != m_endpointList.end()) { UDPEndpoint ep = *i; #ifndef NDEBUG ep->PrintEpState("UDPTransport::ManageEndpoints(): Managing m_endpointList"); #endif /* * We expect endpoints to be in one of the following states if they are * on the m_endpointList: * * EP_PASSIVE_STARTING: The endpoint was created as a result of an * passive connection and was placed on the endpoint after making * its way throught the pre_list and authList. At this point the * three-way handshake completed and the endpoint is in a transient * state waiting for the daemon router registration process to * complete. * * EP_ACTIVE_STARTING: The endpoint was created as a result of an * active connection and was placed on the endpoint after the * three-way handshake completed in a transient state waiting for * the daemon router registration process to complete. * * EP_STARTED: The endpoint has been created and authenticated and * connected to the daemon router. It is acive and may be pumping * messages back and forth. * * EP_STOPPING: Stop() has been called on this endpoint because of a * locally or remotely initiated disconnect event. Endpoints in * this state must be Join()ed by this management thread. * * EP_WAITING: The endpoint has been Stop()ped, but the original event * leading up to the Stop() was a local disconnect. In this case * we need to simulate shutdown(sockfd, SHUTRDWR) behavior and so * we enter the EP_WAITING state until any outstanding sends to * ARDP complete. * * EP_JOINED: Both Stop() and Join() have been called on this endpoint * and there are no threads wandering through the endpoint. In the * case of a local disconnect, all outstanding ARDP sends have * completed. Once we reach the EP_JOINED state, a final Exit() * function is scheduled which will drive the transition to EP_DONE * state. * * EP_DONE: The endpoint has been Stop()ped, Join()ed and the Exit * function has been called to ensure that the endpoint is * completely detached from the daemon router. We are free to * delete endpoints in EP_DONE state. * * These are our expectations, so we assert that it is all true. */ assert((ep->IsEpPassiveStarted() || ep->IsEpActiveStarted() || ep->IsEpStarted() || ep->IsEpStopping() || ep->IsEpWaiting() || ep->IsEpJoined() || ep->IsEpDone()) && "UDPTransport::ManageEndpoints(): Endpoint in unexpected state"); /* * If the current endpoint is starting becuase of either an active or * passive connection request, it is in a transient state because a call * to the daemon router is outstanding. We can't just delete the * endpoint out from under the daemon router which may be at any * arbitrarily vulnerable point. We have to just let it finish. If it * never does, we have bigger problems than a stalled endpoint. */ if (ep->IsEpActiveStarted() || ep->IsEpPassiveStarted()) { Timespec tNow; GetTimeNow(&tNow); Timespec tStart = ep->GetStartTime(); if (tNow - tStart > UDP_WATCHDOG_TIMEOUT) { QCC_LogError(ER_UDP_ENDPOINT_STALLED, ("UDPTransport::ManageEndpoints(): Endpoint with conn ID == %d stalled (\"%s\")", ep->GetConnId(), ep->IsEpActiveStarted() ? "EP_ACTIVE_STARTED" : "EP_PASSIVE_STARTED")); #ifndef NDEBUG ep->PrintEpState("UDPTransport::ManageEndpoints(): Stalled"); #endif } } /* * Inside the following if statement is where the heavy lifting of the * state machine is done. This can be a little tricky since the daemon * wants to reference count the endpoints and will call Stop() but not * Join() in RemoveSessionRef() for example. This is because it doesn't * want to take possibly unbounded time to wait for the threads in the * endpoint to exit. What that means is that we can arbitrarily find * ourselves with endpoints in EP_STOPPING state that were happily * running the last time we looked; and we may have to wait for queued * messages to be transmitted (if IsEpWaitEnabled() is true); and we * will have to do the Join() to finish tearing down the endpoint; and * we will have to Schedule the Exit() function to disconnect from the * Daemon Router; and we will have to ultimately delete the endpoints. * We must also be sensitive to blocking for long periods of time since * we are called out of the main loop of the transport. This means * spending a lot of effort checking to make sure that functions will * complete without blocking before calling them. */ if (ep->IsEpStopping() || ep->IsEpWaiting() || ep->IsEpJoined()) { #ifndef NDEBUG if (ep->IsEpStopping()) { QCC_DbgPrintf(("UDPTransport::ManageEndpoints(): Endpoint with conn ID == %d is EP_STOPPING", ep->GetConnId())); } else if (ep->IsEpWaiting()) { QCC_DbgPrintf(("UDPTransport::ManageEndpoints(): Endpoint with conn ID == %d is EP_WAITING", ep->GetConnId())); } else { QCC_DbgPrintf(("UDPTransport::ManageEndpoints(): Endpoint with conn ID == %d is EP_JOINED", ep->GetConnId())); } #endif /* * Since we are basically waiting for other things to do what * they're supposed to at this point, we call a method that prints * out warnings and errors if these things are not happening at a * reasonable pace. There's not much we can do, but it is useful to * print this information. The function itself limits the amount * of spew. */ EmitStallWarnings(ep); ArdpStream* stream = ep->GetStream(); assert(stream && "UDPTransport::ManageEndpoints(): stream must exist in states EP_STOPPING, EP_WAITING and EP_JOINED"); /* * If we are in state EP_STOPPING, not too surprisingly, Stop() must * have been called by someone. * * When the endpoint transitions to EP_STOPPING, any new message * send requests are prevented from being passed on to the endpoint * and then to the underlying ArdpStream. * * We want to simulate shutdown behavior on a local disconnect; so * if the cause of the Stop() was a local disconnect, we need to * enter the EP_WAITING state, which is the shutdown state, and not * start the teardown process quite yet. * * If the cause of the Stop() was a remote disconnect, we go we want * to tear down the endpoint immediately. At this point, that means * telling any threads waiting for PushMessage() to wake up, notice * that the endpoint is stopping and leave. * * There are possibly many threads that may be interested in the * instantaneous value of the state: there's us, who is trying to * manage the state change; there may be some number of threads * trying to write data into the endpoint, and there may be a * LeaveSession thread that may be causing an initial Stop(). We * take the endpoint state change lock and hold it while we consider * makeing state changes to prevent possible inconsistencies. * * Lock order is always endpointListLock then stateLock. We have * the endpointListLock so we are okay. */ ep->StateLock(); if (ep->IsEpStopping()) { if (ep->IsEpWaitEnabled()) { QCC_DbgHLPrintf(("UDPTransport::ManageEndpoints(): Endpoint with conn ID == %d. entering EP_WAITING", ep->GetConnId())); Timespec tNow; GetTimeNow(&tNow); ep->SetWaitStartTime(tNow); ep->SetEpWaiting(); } else { QCC_DbgHLPrintf(("UDPTransport::ManageEndpoints(): Endpoint with conn ID == %d. WakeThreadSet()", ep->GetConnId())); stream->WakeThreadSet(); /* * If the reason we got to EP_STOPPING is because of a local * disconnnect during transport shutdown, we need to make * sure that a local disconnect is started so ARDP gets the * word. We do this if GetDiscSent() returns false * indicating that we've never started a local Disconnect, * and if GetDiscStatus is ER_OK indicating that a * coincident remote disconnect did not start. */ if (stream->GetDiscSent() == false && stream->GetDiscStatus() == ER_OK) { QCC_DbgHLPrintf(("UDPTransport::ManageEndpoints(): Endpoint with conn ID == %d. stream->Disconnect()", ep->GetConnId())); stream->Disconnect(false, ER_UDP_LOCAL_DISCONNECT); /* * Set the disconnect status in the underlying * BusEndpoint so that higher levels can determine what * to do in response. ER_OK means voluntary here, and * we are presumably voluntarily shutting down. Note * that SetEpDisconnectStatus() may rewrite status code. */ ep->SetEpDisconnectStatus(ER_OK); } } } /* * The difference between EP_STOPPING and EP_WAITING at this point * is that if we are in EP_STOPPING, we and ARDP have already * started the disconnect dance and all we have to do is wait for * disconnected status to become true and threads to leave before * moving forward with the state transitions to EP_DONE. * * In the case of a local disconnect (EP_WAITING) we have to wait * for the send buffers to drain and any pending PushMessage calls * to finish. When the shutdown is then complete, we need to * initiate the local disconnect to the stream, assert that there * are no further PushMessage()s in process and wait for the * disconnect dance with ARDP to complete. * * Here threadSetEmpty, if true, indicates that there are no threads * blocked waiting for operations involving the endpoint to * complete. quiescent means that there are no ARDP send operations * in progress. This is different from threadSetEmpty since threads * and ARDP operations may have different timelines. For example, a * thread can start a send, but be alerted and exit leaving an ARDP * operation in progress. Similarly, an ARDP operation may * complete, but a scheduled callback may not have executed to * notify a waiting thread. disconnected means that the disconnect * call and callback dance between the UDP Transport and ARDP has * finished. */ bool threadSetEmpty = stream->ThreadSetEmpty(); bool disconnected = stream->GetDisconnected(); #ifndef NDEBUG if (ep->IsEpWaiting()) { QCC_DbgHLPrintf(("UDPTransport::ManageEndpoints(): Endpoint with conn ID == %d. is EP_WAITING", ep->GetConnId())); QCC_DbgHLPrintf(("UDPTransport::ManageEndpoints(): EP_WAITING with push message count %d", ep->GetPushMessageCount())); QCC_DbgHLPrintf(("UDPTransport::ManageEndpoints(): EP_WAITING with sends outstanding %d.", stream->GetSendsOutstanding())); Timespec tNow; GetTimeNow(&tNow); Timespec tWaitStart = ep->GetWaitStartTime(); int32_t tRemaining = tWaitStart + UDP_WAIT_WATCHDOG_TIMEOUT - tNow; if (tRemaining < 0) { QCC_LogError(ER_TIMEOUT, ("UDPTransport::ManageEndpoints(): Max time in EP_WAITING Elapsed")); ep->SetEpWaitEnable(false); ep->SetEpStopping(); stream->Disconnect(false, ER_UDP_LOCAL_DISCONNECT); disconnected = stream->GetDisconnected(); /* * Set the disconnect status of the underlying BusEndpoint * so that higher levels can determine what to do in * response. This value percolates up to AllJoynObj and its * session lost handling, which will expect an ER_TIMEOUT if * a link timeout happens. That is what we infer if we * can't get the final data out. Note that * SetEpDisconnectStatus() may rewrite status code. */ ep->SetEpDisconnectStatus(ER_TIMEOUT); } } #endif /* * If we are in EP_WAITING state and 1) there are no threads that * may possibly be starting sends; and 2) ARDP has no queued * outstanding sends; then we are finished with the shutdown * behavior and we need to start the actual ARDP disconnect process * and transition back to EP_STOPPED where we wait for the process * to complete. */ if (ep->IsEpWaiting() && ep->GetPushMessageCount() == 0 && stream->GetSendsOutstanding() == 0) { QCC_DbgHLPrintf(("UDPTransport::ManageEndpoints(): Endpoint with conn ID == %d. exiting EP_WAITING", ep->GetConnId())); ep->SetEpWaitEnable(false); ep->SetEpStopping(); stream->Disconnect(false, ER_UDP_LOCAL_DISCONNECT); disconnected = stream->GetDisconnected(); /* * Set the disconnect status of the underlying BusEndpoint so * that higher levels can determine what to do in response. We * got all of the queued data out, so this voluntary disconnect * ended up ER_OK. Note that SetEpDisconnectStatus() may * rewrite status code. */ ep->SetEpDisconnectStatus(ER_OK); } ep->StateUnlock(); /* * If we are in EP_STOPPING state then we have 1) either * transitioned through EP_WAITING which means we have waited for * all outstanding sends to complete and then done the * stream->Disconnect(); or 2) we have bypassed EP_WAITING and gone * directly to EP_STOPPING since the disconnect is a result of a * control-C equivalent. In this case we need to do the Join as * soon as possible, but no sooner. We did a stream->Disconnect() * above which should have started the process but we need to wait * until the disconnect is complete and all buffers have been * returned from ARDP before actually destroying the endpoint. So * we wait in Stopping state until this happens. The Join() call * will make the endpoint completely unusable so we need to make * sure we are done. */ if (ep->IsEpStopping() && ep->GetPushMessageCount() == 0 && stream->GetSendsOutstanding() == 0 && threadSetEmpty && disconnected) { QCC_DbgHLPrintf(("UDPTransport::ManageEndpoints(): Join()ing stopping endpoint with conn ID == %d.", ep->GetConnId())); /* * We know we are in EP_STOPPING state here. We just verified * that we've dislodged any threads which may be waiting for the * endpoint, and we've gone through our disconnect dance with * ARDP. We now expect that Join() will complete without having * to wait for anything so we take that opportunity. */ QCC_DbgPrintf(("UDPTransport::ManageEndpoints(): Join() endpoint with conn ID == %d.", ep->GetConnId())); ep->Join(); /* * At this point, we have Join()ed the endpoint, but the * endpoint may still have tendrils connecting it to the Daemon * Router. Since disconnecting the Daemon Router involves a * call out to some foreign land, we don't want to make that * call with locks taken, first to avoid blocking the endpoint * management thread and second in case the router decides to * call back into ARDP (which could cause a deadlock). So we * shedule a function to make that happen; which then runs the * Exit() function in the context of the dispatcher thread. * * Note: since the call out to register endpoints cannot be made * with our locks held, we are never completely certain that a * registration has succeeded or not. For example, we could * have put the endpoint on the endpoint list and begun the call * out to the Daemon Router to register the endpoint, but * received an ARDP_Disconnect() before the register call * completed. When we get the ARDP_Disconnect() we will start * the process of tearing down the endpoint by calling Stop(), * then Join() above. Clearly, the Stop(), Join() and * scheduling of the Exit() happens asynchronously with respect * to the Daemon Registration process. The registration process * is a lengthy one involving creation of a virtual endpoint and * starting the ExchangeNames process. We expect that in a * networked system having a connection go down in the middle of * this process is not an unheard of situation and so we expect * the Daemon Router to gracefully handle the case that an * endpoint is invalidated and unregister is called before * during or after a call to register. * * So, if we have not scheduled an Exit() function to be called * on the endpoint, we do so irrespective of whether or not a * register has completed or is in process. * * ExitEndpoint will schedule the endpoint Exit() method to be * called which will set the state to EP_DONE when run, which * then opens the final gate to the endpoint destruction process. */ if (ep->GetExitScheduled() == false) { QCC_DbgPrintf(("UDPTransport::ManageEndpoints(): Schedule Exit() on endpoint with conn ID == %d.", ep->GetConnId())); ep->SetExitScheduled(); ExitEndpoint(ep->GetConnId()); } #ifndef NDEBUG } else { QCC_DbgPrintf(("UDPTransport::ManageEndpoints(): Endpoint with conn ID == %d. is not idle", ep->GetConnId())); QCC_DbgPrintf(("UDPTransport::ManageEndpoints(): conn ID == %d. ep->IsEpStopping()=\"%s\"", ep->GetConnId(), ep->IsEpStopping() ? "true" : "false")); QCC_DbgPrintf(("UDPTransport::ManageEndpoints(): conn ID == %d. threadSetEmpty=\"%s\"", ep->GetConnId(), threadSetEmpty ? "true" : "false")); QCC_DbgPrintf(("UDPTransport::ManageEndpoints(): conn ID == %d. disconnected=\"%s\"", ep->GetConnId(), disconnected ? "true" : "false")); #endif } } /* * If we find the endpoint in the EP_DONE state, the endpoint is ready * to go away and there must be no pending operations of any sort. * Given that caveat, we can just pitch it. When the reference count * goes to zero as a result of removing it from the endpoint list it * will be destroyed. We should be the only thread looking at the * endoint if it has been removed from the router. */ if (ep->IsEpDone()) { QCC_DbgHLPrintf(("UDPTransport::ManageEndpoints(): Endpoint with conn ID == %d. is EP_DONE", ep->GetConnId())); if (ep->GetExited()) { QCC_DbgHLPrintf(("UDPTransport::ManageEndpoints(): Endpoint with conn ID == %d. is exited", ep->GetConnId())); QCC_DbgHLPrintf(("UDPTransport::ManageEndpoints(): Removing reference for failed or done endpoint with conn ID == %d.", ep->GetConnId())); int32_t refs = ep->IncrementRefs(); if (refs == 1) { ep->DecrementRefs(); QCC_DbgHLPrintf(("UDPTransport::ManageEndpoints(): Endpoint with conn ID == %d. is histoire", ep->GetConnId())); /* * If the endpoint is on the endpoint list, it occupies a * slot only on the total connection count. Update that * count. */ m_connLock.Lock(MUTEX_CONTEXT); m_endpointList.erase(i); --m_currConn; m_connLock.Unlock(MUTEX_CONTEXT); i = m_endpointList.upper_bound(ep); managed = true; continue; } ep->DecrementRefs(); } else { QCC_DbgHLPrintf(("UDPTransport::ManageEndpoints(): Endpoint with conn ID == %d. NOT exited", ep->GetConnId())); } } ++i; } QCC_DbgPrintf(("UDPTransport::ManageEndpoints(): Giving endpoint list lock")); m_endpointListLock.Unlock(MUTEX_CONTEXT); if (managed) { m_dynamicScoreUpdater.Alert(); } } #if ARDP_TESTHOOKS /** * Provide do-nothing testhooks from the ARDP Protocol as a how-to example. */ void UDPTransport::ArdpSendToSGHook(ArdpHandle* handle, ArdpConnRecord* conn, TesthookSource source, qcc::ScatterGatherList& msgSG) { QCC_UNUSED(handle); QCC_UNUSED(conn); QCC_UNUSED(source); QCC_UNUSED(msgSG); QCC_DbgTrace(("UDPTransport::ArdpSendToSGHook(handle=%p, conn=%p, source=%d., msgSG=%p)", handle, conn, source, &msgSG)); } void UDPTransport::ArdpSendToHook(ArdpHandle* handle, ArdpConnRecord* conn, TesthookSource source, void* buf, uint32_t len) { QCC_UNUSED(handle); QCC_UNUSED(conn); QCC_UNUSED(source); QCC_UNUSED(buf); QCC_UNUSED(len); QCC_DbgTrace(("UDPTransport::ArdpSendToHook(handle=%p, conn=%p, source=%d., buf=%p, len=%d.)", handle, conn, buf, len)); } void UDPTransport::ArdpRecvFromHook(ArdpHandle* handle, ArdpConnRecord* conn, TesthookSource source, void* buf, uint32_t len) { QCC_UNUSED(handle); QCC_UNUSED(conn); QCC_UNUSED(source); QCC_UNUSED(buf); QCC_UNUSED(len); QCC_DbgTrace(("UDPTransport::ArdpSendToSGHook(handle=%p, conn=%p, source=%d., buf=%p, len=%d.)", handle, conn, buf, len)); } #endif /** * Callback from the ARDP Protocol. We just plumb this callback directly into * the transport. Note we don't take the ARDP re-entrancy protection lock since * we are already executing in the context of a thread that has called ARDP_Run * and must already have taken the lock. * * Since we are called directly from ARDP here, we assume that the handle and * connection must be valid since ARDP wouldn't have called us with them set to * an invalid value. */ bool UDPTransport::ArdpAcceptCb(ArdpHandle* handle, qcc::IPAddress ipAddr, uint16_t ipPort, ArdpConnRecord* conn, uint8_t* buf, uint16_t len, QStatus status) { QCC_DbgTrace(("UDPTransport::ArdpAcceptCb(handle=%p, ipAddr=\"%s\", port=%d., conn=%p, buf =%p, len = %d)", handle, ipAddr.ToString().c_str(), ipPort, conn, buf, len)); UDPTransport* const transport = static_cast(ARDP_GetHandleContext(handle)); return transport->AcceptCb(handle, ipAddr, ipPort, conn, buf, len, status); } /** * Callback from the ARDP Protocol. We just plumb this callback directly into * the transport. Note we don't take the ARDP re-entrancy protection lock when * we call back out into ARDP since we are already executing in the context of a * thread that has called ARDP_Run and must already have taken the lock. * * Since we are called directly from ARDP here, we assume that the handle and * connection must be valid since ARDP wouldn't have called us with them set to * an invalid value. */ void UDPTransport::ArdpConnectCb(ArdpHandle* handle, ArdpConnRecord* conn, bool passive, uint8_t* buf, uint16_t len, QStatus status) { QCC_DbgTrace(("UDPTransport::ArdpConnectCb(handle=%p, conn=%p, passive=%s, buf = %p, len = %d, status=%s)", handle, conn, passive ? "true" : "false", buf, len, QCC_StatusText(status))); UDPTransport* const transport = static_cast(ARDP_GetHandleContext(handle)); transport->ConnectCb(handle, conn, passive, buf, len, status); } /** * Callback from the ARDP Protocol. We just plumb this callback directly into * the transport. Note we don't take the ARDP re-entrancy protection lock when * we call back out into ARDP since we are already executing in the context of a * thread that has called ARDP_Run and must already have taken the lock. * * Since we are called directly from ARDP here, we assume that the handle and * connection must be valid since ARDP wouldn't have called us with them set to * an invalid value. */ void UDPTransport::ArdpDisconnectCb(ArdpHandle* handle, ArdpConnRecord* conn, QStatus status) { QCC_DbgTrace(("UDPTransport::ArdpDisconnectCb(handle=%p, conn=%p, status=\"%s\")", handle, conn, QCC_StatusText(status))); UDPTransport* const transport = static_cast(ARDP_GetHandleContext(handle)); transport->DisconnectCb(handle, conn, status); } /** * Callback from the ARDP Protocol. We just plumb this callback directly into * the transport. Note we don't take the ARDP re-entrancy protection lock when * we call back out into ARDP since we are already executing in the context of a * thread that has called ARDP_Run and must already have taken the lock. * * Since we are called directly from ARDP here, we assume that the handle and * connection must be valid since ARDP wouldn't have called us with them set to * an invalid value. */ void UDPTransport::ArdpRecvCb(ArdpHandle* handle, ArdpConnRecord* conn, ArdpRcvBuf* rcv, QStatus status) { QCC_DbgTrace(("UDPTransport::ArdpRecvCb(handle=%p, conn=%p, buf=%p, status=%s)", handle, conn, rcv, QCC_StatusText(status))); UDPTransport* const transport = static_cast(ARDP_GetHandleContext(handle)); transport->RecvCb(handle, conn, rcv, status); } /** * Callback from the ARDP Protocol. We just plumb this callback directly into * the transport. Note we don't take the ARDP re-entrancy protection lock when * we call back out into ARDP since we are already executing in the context of a * thread that has called ARDP_Run and must already have taken the lock. * * Since we are called directly from ARDP here, we assume that the handle and * connection must be valid since ARDP wouldn't have called us with them set to * an invalid value. */ void UDPTransport::ArdpSendCb(ArdpHandle* handle, ArdpConnRecord* conn, uint8_t* buf, uint32_t len, QStatus status) { QCC_DbgTrace(("UDPTransport::ArdpSendCb(handle=%p, conn=%p, buf=%p, len=%d.)", handle, conn, buf, len)); UDPTransport* const transport = static_cast(ARDP_GetHandleContext(handle)); transport->SendCb(handle, conn, buf, len, status); } /** * Callback from the ARDP Protocol. We just plumb this callback directly into * the transport. Note we don't take the ARDP re-entrancy protection lock when * we call back out into ARDP since we are already executing in the context of a * thread that has called ARDP_Run and must already have taken the lock. * * Since we are called directly from ARDP here, we assume that the handle and * connection must be valid since ARDP wouldn't have called us with them set to * an invalid value. */ void UDPTransport::ArdpSendWindowCb(ArdpHandle* handle, ArdpConnRecord* conn, uint16_t window, QStatus status) { QCC_DbgTrace(("UDPTransport::ArdpSendWindowCb(handle=%p, conn=%p, window=%d.)", handle, conn, window)); UDPTransport* const transport = static_cast(ARDP_GetHandleContext(handle)); transport->SendWindowCb(handle, conn, window, status); } /* * ARDP, being C, calls into the static member function ArdpAcceptCb(). That * function finds the transport "this" pointer in the handle and uses that to * call here, into the UDPTransport member method. * * Since we are called in the same thread context as ARDP here, we assume that * the handle and connection must be valid since ARDP wouldn't have called us * with them set to an invalid value. * * See "A note on connection establishment" earlier in this file to really make * sense of the following. * * This callback indicates that we are receiving a passive open request. We are * in LISTEN state and are responding to another side that has done an * ARDP_Connect(). We expect it to have provided a Hello message which we get * in the data that comes along with the SYN segment. Status should always be * ER_OK since it had to be to successfully get us to this point. * * If we can accept a new connection, we send a reply to the incoming Hello * message by calling ARDP_Accept() and we return true indicating that we have, * in fact, accepted the connection. * * Note we don't take the ARDP re-entrancy protection lock when we call back out * into ARDP since we are already executing in the context of a thread that has * called ARDP_Run and into the static handler and how we have been vectored * back to the transport object. This means that the current thread must have * already have taken the lock. */ bool UDPTransport::AcceptCb(ArdpHandle* handle, qcc::IPAddress ipAddr, uint16_t ipPort, ArdpConnRecord* conn, uint8_t* buf, uint16_t len, QStatus status) { IncrementAndFetch(&m_refCount); QCC_DbgHLPrintf(("UDPTransport::AcceptCb(handle=%p, ipAddr=\"%s\", ipPort=%d., conn=%p)", handle, ipAddr.ToString().c_str(), ipPort, conn)); /* * We never want to accept connections if we are shutting down. */ if (IsRunning() == false || m_stopping == true) { QCC_LogError(ER_BUS_TRANSPORT_NOT_STARTED, ("UDPTransport::AcceptCb(): Stopping or not running")); DecrementAndFetch(&m_refCount); return false; } if (buf == NULL || len == 0) { QCC_LogError(ER_UDP_INVALID, ("UDPTransport::AcceptCb(): No BusHello with SYN")); DecrementAndFetch(&m_refCount); return false; } /* * Here's the difficulty. It is very common for external threads to call * into the UDP transport and take the endpoint list lock to locate an * endpoint and then take the ARDP lock to do do something with the network * protocol based on the stream in that endpoint. The lock order here is * endpointListLock, then ardpLock. It is also equally common for the main * thread to take the ardpLock and then call into ARDP_Run(), which can call * out into a callback. Those callbacks then want to take the * enpointListLock to figure out how to deal with the callback. The lock * order there is ardpLock, then endpointListLock. * * We usually get around that problem by dispatching all callbacks on the * dispatcher thread which can also use the endpointListLock, then ardpLock * lock order just like external threads. * * The problem here is that AcceptCb() needs to return a boolean indicating * whether or not it can accept a connection, and this depends on the number * of endpoints. In order to look at the size of the lists of endpoints, * you need to take the endpoint list lock, which would result in a * potential deadlock. Also, if we create an endpoint, we need to take the * endpointListLock in order to add it to the auth list. In other words, we * must take the endpoint list lock, but we cannot take the endpoint list * lock. * * To work around the number of available endpoints issue, we keep an * atomically incremented and decremented number of available endpoints * around so we don't have to take a lock and call a size() method on a * couple of lists, as the TCP Transport would. To work around the second * problem we do the addition of the new endpoint to a "pre" queue protected * by a third lock that must never held while either holding or taking the * ARDP lock (which is held here since we are in a callback). * * Bringing up a connection means transiently adding a connection to the * count of currently authenticating connections, and also to the list of * current connections. Once the connectton is authenticated (complete) we * drop the currently-authenticating number back down. Neither of these * numbers are allowed to exceed configured values. */ m_connLock.Lock(MUTEX_CONTEXT); if (m_currAuth + 1U > m_maxAuth || m_currConn + 1U > m_maxConn) { QCC_LogError(ER_CONNECTION_LIMIT_EXCEEDED, ("UDPTransport::AcceptCb(): No slot for new connection")); m_connLock.Unlock(MUTEX_CONTEXT); DecrementAndFetch(&m_refCount); return false; } ++m_currAuth; ++m_currConn; m_connLock.Unlock(MUTEX_CONTEXT); QCC_DbgPrintf(("UDPTransport::AcceptCb(): Inbound connection accepted")); /* * We expect to get an org.alljoyn.Bus.BusHello message from the active side * in the data. */ Message activeHello(m_bus); status = activeHello->LoadBytes(buf, len); if (status != ER_OK) { QCC_LogError(status, ("UDPTransport::AcceptCb(): Can't LoadBytes() BusHello Message")); m_connLock.Lock(MUTEX_CONTEXT); --m_currAuth; --m_currConn; m_connLock.Unlock(MUTEX_CONTEXT); DecrementAndFetch(&m_refCount); return false; } /* * Unmarshal the message. We need to provide and endpoint unique name for * error reporting purposes, in order to to affix blame here if something * goes awry. If we don't pass true in checkSender Unmarshal won't validate * the endpoint name and will just print it out in case of problems. We * make (an illegal) one up since we don't have an endpoint yet. */ qcc::String endpointName(":0.0"); status = activeHello->Unmarshal(endpointName, false, false, true, 0); if (status != ER_OK) { QCC_LogError(status, ("UDPTransport::AcceptCb(): Can't Unmarhsal() BusHello Message")); m_connLock.Lock(MUTEX_CONTEXT); --m_currAuth; --m_currConn; m_connLock.Unlock(MUTEX_CONTEXT); DecrementAndFetch(&m_refCount); return false; } /* * Validate the fields in the incoming BusHello Message */ if (strcmp(activeHello->GetInterface(), org::alljoyn::Bus::InterfaceName) != 0) { status = ER_BUS_ESTABLISH_FAILED; QCC_LogError(status, ("UDPTransport::AcceptCb(): Unexpected interface=\"%s\" in BusHello Message", activeHello->GetInterface())); m_connLock.Lock(MUTEX_CONTEXT); --m_currAuth; --m_currConn; m_connLock.Unlock(MUTEX_CONTEXT); DecrementAndFetch(&m_refCount); return false; } if (activeHello->GetCallSerial() == 0) { status = ER_BUS_ESTABLISH_FAILED; QCC_LogError(status, ("UDPTransport::AcceptCb(): Unexpected zero serial in BusHello Message")); m_connLock.Lock(MUTEX_CONTEXT); --m_currAuth; --m_currConn; m_connLock.Unlock(MUTEX_CONTEXT); DecrementAndFetch(&m_refCount); return false; } if (strcmp(activeHello->GetDestination(), org::alljoyn::Bus::WellKnownName) != 0) { status = ER_BUS_ESTABLISH_FAILED; QCC_LogError(status, ("UDPTransport::AcceptCb(): Unexpected destination=\"%s\" in BusHello Message", activeHello->GetDestination())); m_connLock.Lock(MUTEX_CONTEXT); --m_currAuth; --m_currConn; m_connLock.Unlock(MUTEX_CONTEXT); DecrementAndFetch(&m_refCount); return false; } if (strcmp(activeHello->GetObjectPath(), org::alljoyn::Bus::ObjectPath) != 0) { status = ER_BUS_ESTABLISH_FAILED; QCC_LogError(status, ("UDPTransport::AcceptCb(): Unexpected object path=\"%s\" in BusHello Message", activeHello->GetObjectPath())); m_connLock.Lock(MUTEX_CONTEXT); --m_currAuth; --m_currConn; m_connLock.Unlock(MUTEX_CONTEXT); DecrementAndFetch(&m_refCount); return false; } bool isBusToBus; if (strcmp(activeHello->GetMemberName(), "BusHello") == 0) { isBusToBus = true; } else if (strcmp(activeHello->GetMemberName(), "SimpleHello") == 0) { isBusToBus = false; } else { status = ER_BUS_ESTABLISH_FAILED; QCC_LogError(status, ("UDPTransport::AcceptCb(): Unexpected member name=\"%s\" in BusHello Message", activeHello->GetMemberName())); m_connLock.Lock(MUTEX_CONTEXT); --m_currAuth; --m_currConn; m_connLock.Unlock(MUTEX_CONTEXT); DecrementAndFetch(&m_refCount); return false; } /* * The remote name of the endpoint on the passive side of the connection is * the sender of the BusHello Message, presumably the local bus attachment * of the remote daemon doing the imlied Connect(). */ qcc::String remoteName = activeHello->GetSender(); QCC_DbgPrintf(("UDPTransport::AcceptCb(): BusHello Message from sender=\"%s\"", remoteName.c_str())); status = activeHello->UnmarshalArgs("su"); if (status != ER_OK) { QCC_LogError(status, ("UDPTransport::AcceptCb(): Can't UnmarhsalArgs() BusHello Message")); m_connLock.Lock(MUTEX_CONTEXT); --m_currAuth; --m_currConn; m_connLock.Unlock(MUTEX_CONTEXT); DecrementAndFetch(&m_refCount); return false; } /* * We expect two arguments in the message: a remoteGUID and a protocol * version. The high order two bits of the protocol version are the * nameTransfer bits that will tell the allJoyn obj how many names to * exchange during ExchangeNames. */ size_t numArgs; const MsgArg* args; activeHello->GetArgs(numArgs, args); if (numArgs != 2 || args[0].typeId != ALLJOYN_STRING || args[1].typeId != ALLJOYN_UINT32) { status = ER_BUS_ESTABLISH_FAILED; QCC_LogError(status, ("UDPTransport::AcceptCb(): Unexpected number or type of arguments in BusHello Message")); m_connLock.Lock(MUTEX_CONTEXT); --m_currAuth; --m_currConn; m_connLock.Unlock(MUTEX_CONTEXT); DecrementAndFetch(&m_refCount); return false; } qcc::String remoteGUID = args[0].v_string.str; uint32_t protocolVersion = isBusToBus ? args[1].v_uint32 & 0x3FFFFFFF : args[1].v_uint32; uint32_t nameTransfer = isBusToBus ? args[1].v_uint32 >> 30 : 0; QCC_DbgPrintf(("UDPTransport::AcceptCb(): Got BusHello(). remoteGuid=\"%s\", protocolVersion=%d., nameTransfer=%d.", remoteGUID.c_str(), protocolVersion, nameTransfer)); if (remoteGUID == m_bus.GetInternal().GetGlobalGUID().ToString()) { status = ER_BUS_SELF_CONNECT; QCC_LogError(status, ("UDPTransport::AcceptCb(): BusHello was sent to self")); m_connLock.Lock(MUTEX_CONTEXT); --m_currAuth; --m_currConn; m_connLock.Unlock(MUTEX_CONTEXT); DecrementAndFetch(&m_refCount); return false; } /* * We need to reply to the hello from the other side. In order to do so we * need the unique name of the endpoint we are creating. This means that it * is now time to create that new endpoint. */ static const bool truthiness = true; UDPTransport* ptr = this; String normSpec = "udp:guid=" + remoteGUID + ",addr=" + ipAddr.ToString() + ",port=" + U32ToString(ipPort); UDPEndpoint udpEp(ptr, m_bus, truthiness, normSpec); /* * Some of this would "normally" be handled by EndpointAuth, but since we * are short-circuiting the process, we have to do the bookkeeping * ourselves. */ udpEp->GetFeatures().isBusToBus = isBusToBus; udpEp->GetFeatures().allowRemote = true; udpEp->GetFeatures().protocolVersion = protocolVersion; udpEp->GetFeatures().trusted = isBusToBus ? false : true; udpEp->GetFeatures().nameTransfer = isBusToBus ? static_cast(nameTransfer) : SessionOpts::ALL_NAMES; udpEp->SetRemoteGUID(remoteGUID); udpEp->SetPassive(); udpEp->SetIpAddr(ipAddr); udpEp->SetIpPort(ipPort); udpEp->CreateStream(handle, conn, m_ardpConfig.initialDataTimeout, m_ardpConfig.totalDataRetryTimeout / m_ardpConfig.initialDataTimeout); udpEp->SetHandle(handle); udpEp->SetConn(conn); /* * Check any application connecting over UDP to see if it is running on the same machine and * set the group ID appropriately if so. */ CheckEndpointLocalMachine(udpEp); /* * The unique name of the endpoint on the passive side of the connection is * a unique name generated on the passive side. We are calling out to the * daemon but only to construct a GUID, so this is okay. */ udpEp->SetUniqueName(m_bus.GetInternal().GetRouter().GenerateUniqueName()); /* * the remote name of the endpoint on the passive side of the connection is * the sender of the BusHello, which is the local bus attachement on the * remote side that did the impled Connect(). */ udpEp->SetRemoteName(remoteName); /* * Now, we have an endpoint that we need to keep alive but not fully * connected and ready to flow AllJoyn Messages until we get the expected * response to our Hello. That will come in as the ConnectCb we get in * passive mode that marks the end of the connection establishment phase. * * Set a timestamp in case this never comes for some reason. */ Timespec tNow; GetTimeNow(&tNow); udpEp->SetStartTime(tNow); udpEp->SetStopTime(tNow); /* * Note that our endpoint isn't actually connected to anything yet or saved * anywhere. Send a hello reply from our local endpoint. The unique name * in the BusHello reponse is the unique name of our UDP endpoint we just * allocated above. * * Note: The first param to HelloReply() is true even if isBusToBus==false becuase we * always want to reply as if to a BusHello method (ARDPHello has the same return values) */ QCC_DbgPrintf(("UDPTransport::AcceptCb(): HelloReply(true, \"%s\")", udpEp->GetUniqueName().c_str())); /* Send value SLS_NAMES(also value of older DAEMON_NAMES) for SLS_NAMES, * ALL_NAMES for other types. * These are the older values of nameTransfer to be sent in BusHello. */ status = activeHello->HelloReply(true, udpEp->GetUniqueName(), (nameTransfer == SessionOpts::SLS_NAMES) ? SessionOpts::SLS_NAMES : SessionOpts::ALL_NAMES); if (status != ER_OK) { status = ER_UDP_BUSHELLO; QCC_LogError(status, ("UDPTransport::AcceptCb(): Can't make a BusHello Reply Message")); m_connLock.Lock(MUTEX_CONTEXT); --m_currAuth; --m_currConn; m_connLock.Unlock(MUTEX_CONTEXT); DecrementAndFetch(&m_refCount); return false; } /* * The Function HelloReply creates and marshals the BusHello reply for the * remote side. Once it is marshaled, there is a buffer associated with the * message that contains the on-the-wire version of the messsage. The ARDP * code copies this data in to deal with the possibility of having to * retransmit it; So we need to remember to deal with freeing the buffer. */ size_t helloReplyBufLen = activeHello->GetBufferSize(); #ifndef NDEBUG uint8_t* helloReplyBuf = new uint8_t[helloReplyBufLen + SEAL_SIZE]; SealBuffer(helloReplyBuf + helloReplyBufLen); #else uint8_t* helloReplyBuf = new uint8_t[helloReplyBufLen]; #endif memcpy(helloReplyBuf, const_cast(activeHello->GetBuffer()), helloReplyBufLen); /* * Since we are in a callback from ARDP we can note a few assumptions. * First, that callback must have been driven by a call to ARDP_Run() which * must be called with the ARDP lock taken; so we don't have to do it again. * Second, since ARDP is calling out to us, and it is the UDP transport main * thread that drives ARDP, the only thing that is going to happen is that * the SYN + ACK will be sent. We don't have to deal with any possibility * of ARDP processing any inbound data while it is doing the accept. We * take advantage of this by not putting the endpoint on the auth list until * we get status back from ARDP_Accept. */ QCC_DbgPrintf(("UDPTransport::AcceptCb(): ARDP_Accept()")); status = ARDP_Accept(handle, conn, m_ardpConfig.segmax, m_ardpConfig.segbmax, helloReplyBuf, helloReplyBufLen); /* * No matter what, we need to free the buffer holding the Hello reply * message. */ delete[] helloReplyBuf; helloReplyBuf = NULL; if (status != ER_OK) { /* * If ARDP_Accept returns an error, most likely it is becuase the underlying * SYN + ACK didn't go out. The contract with ARDP says that if an error * happens here, we shouldn't expect a disconnect, so we just don't bother * to finish seting up the endpoint. * * Even though we haven't actually started the endpoint, we call Stop() to * set it up for the destruction process to make sure its state is changed * to be deletable (when we release our reference to it and the end of the * current scope). * * If we are stopping the endpoint before it ever really gets started, we * presume there can be no data queued for transmission, so we disable the * EP_WAITING state. */ udpEp->SetEpWaitEnable(false); udpEp->Stop(); QCC_LogError(status, ("UDPTransport::AcceptCb(): ARDP_Accept() failed")); m_connLock.Lock(MUTEX_CONTEXT); --m_currAuth; --m_currConn; m_connLock.Unlock(MUTEX_CONTEXT); DecrementAndFetch(&m_refCount); return false; } /* * Okay, this is now where we need to work around problem number two. We * are going to tell ARDP to proceed with the connection shortly and we need * the endpoint we just created to make it onto the list of currently * authenticating endpoints, and we need this to happen without taking the * endpointListLock. What we do is to put it on a "pre" authenticating list * that is dealt with especially carefully with respect to locks. * * Once we put the endpoint on a list, it is the responsibility of the code * managing the lists to deal with the authentication slots and total * connection slots. */ QCC_DbgPrintf(("UDPTransport::AcceptCb(): Taking pre-auth list lock")); m_preListLock.Lock(MUTEX_CONTEXT); QCC_DbgPrintf(("UDPTransport::AcceptCb(): Adding endpoint with conn ID == %d. to m_preList", udpEp->GetConnId())); assert(udpEp->IsEpInitialized() && "UDPTransport::AcceptCb(): Unexpected endpoint state"); /* * Set the endpoint state to indicate that it is starting up becuase of a * passive (begun by a remote host) connection attempt. */ udpEp->SetEpPassiveStarted(); m_preList.insert(udpEp); QCC_DbgPrintf(("UDPTransport::AcceptCb(): giving pre-auth list lock")); m_preListLock.Unlock(MUTEX_CONTEXT); /* * If we do something that is going to bug the ARDP protocol, we need to * call back into ARDP ASAP to get it moving. This is done in the main * thread, which we need to wake up. Since this is an accept it will * eventually require endpoint management, so we make a note to run the * endpoint management code. */ m_manage = STATE_MANAGE; Alert(); m_dynamicScoreUpdater.Alert(); DecrementAndFetch(&m_refCount); return true; } #ifndef NDEBUG void UDPTransport::DebugAuthListCheck(UDPEndpoint uep) { QCC_DbgTrace(("UDPTransport::DebugAuthListCheck()")); m_endpointListLock.Lock(MUTEX_CONTEXT); for (set::iterator i = m_authList.begin(); i != m_authList.end(); ++i) { UDPEndpoint ep = *i; if (uep->GetConnId() == ep->GetConnId()) { QCC_DbgPrintf(("UDPTransport::DebugAuthListCheck(): Endpoint with conn ID == %d. already on m_authList", uep->GetConnId())); assert(0 && "UDPTransport::DebugAuthListCheck(): Endpoint already on m_authList"); } } m_endpointListLock.Unlock(MUTEX_CONTEXT); } void UDPTransport::DebugEndpointListCheck(UDPEndpoint uep) { QCC_DbgTrace(("UDPTransport::DebugEndpointListCheck()")); m_endpointListLock.Lock(MUTEX_CONTEXT); for (set::iterator i = m_endpointList.begin(); i != m_endpointList.end(); ++i) { UDPEndpoint ep = *i; if (uep->GetConnId() == ep->GetConnId()) { QCC_DbgPrintf(("UDPTransport::DebugEndpointListCheck(): Endpoint with conn ID == %d. already on m_endpointList", uep->GetConnId())); assert(0 && "UDPTransport::DebugAuthListCheck(): Endpoint already on m_endpointList"); } } m_endpointListLock.Unlock(MUTEX_CONTEXT); } #endif /* * ARDP, being C, calls into the static member function ArdpConnectCb(). That * function finds the transport "this" pointer in the handle and uses that to * call here, into the UDPTransport member method ConnectCb(). Since we need to * call out to the daemon code in order to plumb in a new connection, we cannot * just call out from the ARDP callback. We have to arrange for the connection * to really be handled in another thread. The result of that process is that * we are called here. * * Since we are not called in the same thread context as ARDP here, we cannot * assume that the handle and connection are valid since ARDP has since run off * and possibly done many other things before we get scheduled and run. What * this means to us is that we cannot make any assumptions about the connection * referred to being valid. We have to admit the possibility that the "conn" * has gone away for some reason. * * See "A note on connection establishment" earlier in this file to really make * sense of the following. * * If passive is true, and status = ER_OK, this callback indicates that we are * getting the final callback as a result of the final part of the three-way * handshake. The passive connection was started with a SYN (+ BusHello), * replied with a SYN + ACK (+ BusHello) and is now getting the final ACK back. * * If passive is false, and status = ER_OK, this callback indicates that the * passive (other) side has accepted the connection and has returned the SYN + * ACK. We should see a BusHello message and a BusHello reply from the (other) * passive side in the data provided. * * If status != ER_OK, the status should be ER_TIMEOUT indicating that for some * reason the three-way handshake did not complete in the expected time/retries. * * Note we must take the ARDP re-entrancy protection lock if we call back out * into ARDP since we are executing in the context of a dispatcher thread and * not the callback directly. */ void UDPTransport::DoConnectCb(ArdpHandle* handle, ArdpConnRecord* conn, uint32_t connId, bool passive, uint8_t* buf, uint16_t len, QStatus status) { IncrementAndFetch(&m_refCount); QCC_DbgHLPrintf(("UDPTransport::DoConnectCb(handle=%p, conn=%p)", handle, conn)); /* * If the transport has been asked to stop, we don't want to take any more * actions that could cause endpoints to be brought up. We expect the * process of stopping will cause threads waiting active connections to * complete will be stopped in other ways, so it is safe to kill possible * responses here. */ if (IsRunning() == false || m_stopping == true) { status = ER_UDP_STOPPING; QCC_LogError(status, ("ArdpStream::PushBytes(): UDP Transport not running or stopping")); DecrementAndFetch(&m_refCount); return; } /* * We are in DoConnectCb() which is always run off of the dispatcher thread. * If we are going to take the preListLock and munge the preList we * absolutely, positively must not try to take ardpLock with preListLock * taken or we risk deadlock. In AcceptCb() which did have ardpLock taken, * we put any endpoints starting the authentication process on the * m_preList, so we have to move those to the m_authList where they are * really expected to be from now on. ManageEndpoints touches both lists * using the lock order endpointList, preList; so we must do the same. */ QCC_DbgPrintf(("UDPTransport::DoConnectCb(): Taking endpoint list lock")); m_endpointListLock.Lock(MUTEX_CONTEXT); QCC_DbgPrintf(("UDPTransport::DoConnectCb(): Taking pre-auth list lock")); m_preListLock.Lock(MUTEX_CONTEXT); set::iterator i = m_preList.begin(); while (i != m_preList.end()) { UDPEndpoint ep = *i; QCC_DbgPrintf(("UDPTransport::DoConnectCb(): Moving endpoint with connId == %d. from m_preList to m_authList", ep->GetConnId())); m_authList.insert(ep); m_preList.erase(i); i = m_preList.begin(); } QCC_DbgPrintf(("UDPTransport::DoConnectCb(): Giving pre-auth list lock")); m_preListLock.Unlock(MUTEX_CONTEXT); QCC_DbgPrintf(("UDPTransport::DoConnectCb(): Giving endpoint list lock")); m_endpointListLock.Unlock(MUTEX_CONTEXT); /* * The current connection ID is useful to have laying around in case we need * it for UDPTransport purposes. The transport uses the connection ID as a * sort of unique number to tie things together; so it will work for us even * though the underlying ARDP connection from which we get it goes down. * The tricky part is taht since we are dispatched and not called in the * context of an ARDP connect callback, the underlying conn may actually be * gone and the connId might be ARDP_CONN_ID_INVALID right now. Because of * this, we pass the connection ID (connId) given in the original callback * and don't try to get it now. * * Now we need to determine if this callback is a result of an active * (outgoing) connection request or a passive (incoming) request. */ if (passive) { /* * On the passive side, when we get a ConnectCb, we're done with the * three-way handshake if no error is returned. This marks the end of * the connection establishment phase and after we return, we should * expect AllJoyn messages to be flowing on the connection. * * If this is happening, we should have a UDPEndpoint on the m_authList * that reflects the ARDP connection that is in the process of being * formed. We need to find that endpoint (based on the provided conn), * take it off of the m_authlist and put it on the active enpoint list. * * If an error has been returned, we are getting the one notification * that the connection has failed. We nedd to find the endpoint that * has failed, so the error case looks pretty much like the success * case except for the final disposition. */ QCC_DbgPrintf(("UDPTransport::DoConnectCb(): passive connection callback with conn ID == %d.", connId)); QCC_DbgPrintf(("UDPTransport::DoConnectCb(): Finding endpoint with conn ID == %d. in m_authList", connId)); /* * We need to locate the endpoint that the provided conn parameter * refers to. Since this is a passive connection, we must have * accepted the connection, created an endpoint, and placed that * endpoint on the list of currently authenticating endpoints * (m_authList). * * We loop through the endpoints on the auth list, looking for * a match in the connection ID between the provided connection * and the connection ID provided in the conn. * * In a perfect world, the connection we got from ARDP is still * valid, and the connection stored in the endpoint is still valid. * Unfortunatly, this is not guaranteed to be the case since time * has passed since the endpoint was created and time has also passed * since we got the callback from ARDP that drove the process to get * us here. * * If either of the following calls returns ARDP_CONN_ID_INVALID it * means that ARDP has decided to remove the connection. In that case * we can no longer make any decision based on the conn ID. If the * connection ID in the endpoint is no longer valid, it will never * receive a callback to indicate the connection it is waiting for has * completed. That is okay, since it probably means a timeout has * happened. We just ignore the endpoints with invalid connections and * let the endpoint manager time them out and clean them up. If the * connection provided by ARDP is invalid it means that ARDP has removed * the connection between the time the precipitating ConnectCb() was * called and when we actually got run out of the dispatcher thread. In * this case, there may be an endpoint waiting to hear the connect * result, but since ARDP changed its mind, it never will. We just * ignore the callback with the (now) invalid connection and let the * endpoint manager time out the endpoint that may still be waiting for * the result and clean it up. Long explanation, but simple * implementation. Here, If cidFromConn is ARDP_CONN_ID_INVALID just * return since it is pointless to continue to bring up something that * will be unusable. */ m_ardpLock.Lock(); uint32_t cidFromConn = ARDP_GetConnId(m_handle, conn); m_ardpLock.Unlock(); if (cidFromConn == ARDP_CONN_ID_INVALID) { DecrementAndFetch(&m_refCount); return; } QCC_DbgPrintf(("UDPTransport::DoConnectCb(): Taking endpoint list lock")); m_endpointListLock.Lock(MUTEX_CONTEXT); bool haveLock = true; set::iterator i; for (i = m_authList.begin(); i != m_authList.end(); ++i) { UDPEndpoint ep = *i; /* * If cidFromEp is ARDP_CONN_ID_INVALID there's nothing we can do fo * this endpoint. Ignore it. If it was the one referred to by the * now defunct conn, it will time out on its own. */ m_ardpLock.Lock(); uint32_t cidFromEp = ARDP_GetConnId(m_handle, ep->GetConn()); m_ardpLock.Unlock(); if (cidFromEp == ARDP_CONN_ID_INVALID) { continue; } if (ep->GetConn() == conn && cidFromEp == cidFromConn) { QCC_DbgPrintf(("UDPTransport::DoConnectCb(): Moving endpoint with conn ID == %d to m_endpointList", connId)); /* * If the endpoint is on the auth list, it occupies a slot on * both the authentication count and the total connection count. * If we remove it from the authentication list and put it on * the endpoint list, we are saying we are done with * authentication, so we update that count, but leave the * endpoint as occupying a slot in the total connection count * since it is an endpoint on a list. */ m_connLock.Lock(MUTEX_CONTEXT); m_authList.erase(i); --m_currAuth; #ifndef NDEBUG DebugEndpointListCheck(ep); #endif QCC_DbgPrintf(("UDPTransport::DoConnectCb(): Adding endpoint with connId == %d. to m_endpointList", ep->GetConnId())); m_endpointList.insert(ep); m_connLock.Unlock(MUTEX_CONTEXT); QCC_DbgPrintf(("UDPTransport::DoConnectCb(): Start()ing endpoint with conn ID == %d.", connId)); /* * Cannot call out with the endpoint list lock taken. */ QCC_DbgPrintf(("UDPTransport::DoConnectCb(): giving endpoint list lock")); /* * If the inbound connection succeeded, we need to tell the daemon * that a new connection is ready to go. If the connection failed * we need to mark the connection for deletion and bug the endpoint * management code so it can purge the endpoint without delay. */ if (status == ER_OK) { m_endpointListLock.Unlock(MUTEX_CONTEXT); haveLock = false; ep->SetListener(this); ep->Start(); } else { /* * If the passive connection fails, it means that the * three-way handshake did not complete successfully. In * this case, the contract is that ARDP will call us back * and tell us; and we are supposed to acknowledge that fact * by releasing the connection and promising not to use it * again. */ ArdpStream* stream = ep->GetStream(); assert(stream && "UDPTransport::DoConnectCb(): must have a stream at this point"); QCC_DbgPrintf(("UDPTransport::DoConnectCb(): Disconnect() stream for endpoint with conn ID == %d.", connId)); stream->Disconnect(false, ER_UDP_LOCAL_DISCONNECT); /* * Set the disconnect status of the underlying BusEndpoint * so that higher levels can determine what to do in * response. Since this endpiont is not making it through * the connect process, most likely nobody will even notice * but we do so for completeness. Note that * SetEpDisconnectStatus() may rewrite status code. */ ep->SetEpDisconnectStatus(status); /* * If the connection faied before it was actually set up, we * presume that there can be no buffered data waiting to go * out so we disable the EP_WAITING state. */ ep->SetEpWaitEnable(false); ep->Stop(); m_endpointListLock.Unlock(MUTEX_CONTEXT); haveLock = false; m_ardpLock.Lock(); ARDP_ReleaseConnection(handle, conn); m_ardpLock.Unlock(); m_manage = UDPTransport::STATE_MANAGE; Alert(); } break; } } /* * If we didn't find the endpoint for the connection, we still have the * lock taken. */ if (haveLock) { QCC_DbgPrintf(("UDPTransport::DoConnectCb(): giving endpoint list lock")); m_endpointListLock.Unlock(MUTEX_CONTEXT); } DecrementAndFetch(&m_refCount); return; } else { /* * On the active side, we expect to be getting this callback when the * passive side does a SYN + ACK and provides a reply to our Hello * message that we sent in ARDP_Connect(). * * Since this is an active connection, we expect there to be a thread * driving the connection and it will be waiting for something to happen * good or bad so we need to remember to wake it up if we can. * * We can only wake up the thread if we have a valid connection, from * which we can extract a context in which we stashed a qcc::Event* that * we use to bug the thread. If ARDP reports the connection as valid * then we expect the event we find in the connection context to be * valid. * * An event used to wake the thread up is provided in the connection, * but we also need to make sure that the thread hasn't timed out or * been stopped for some other reason, in which case the event will not * be valid. */ QCC_DbgPrintf(("UDPTransport::DoConnectCb(): active connection callback with conn ID == %d.", connId)); m_ardpLock.Lock(); bool connValid = ARDP_IsConnValid(m_handle, conn, connId); qcc::Event* event = static_cast(ARDP_GetConnContext(m_handle, conn)); m_ardpLock.Unlock(); /* * We need to remember in the following code that we have a contract * with Connect() that says we take over ownership of the connection * limit counters after a successful call to ARDP_Connect(). Connect() * will have incremented both m_currAuth and m_currConn. The * authentication actually happened in the ARDP connect process, so we * need to keep these couters updated as we move things around, * succeeding or failing. * * If the connection is no longer valid, there's nothing we can do in * terms of waking any connecting thread up. The thread that started * all of this may or may not be there waiting. If it is there, we * can't wake it up. If it not there we are too late and even if we * proceed, that thread will not be satisfied and will be off trying to * figure out how to deal with the error. We will assume the worst and * let that thread continue its ruminations in the case that it is gone. * If it is still there, we and just let it time out. In either case, * we have it easy -- we just bail. */ if (connValid == false) { QCC_LogError(status, ("UDPTransport::DoConnectCb(): Provided connection no longer valid")); m_ardpLock.Lock(); ARDP_ReleaseConnection(handle, conn); m_ardpLock.Unlock(); m_connLock.Lock(MUTEX_CONTEXT); --m_currAuth; --m_currConn; m_connLock.Unlock(MUTEX_CONTEXT); DecrementAndFetch(&m_refCount); return; } /* * If the connection was valid, we expect to have an event still there * in its context. The thread originally waiting for this event may not * be there, but since we put the event in, we assert that it (at least) * is still there. */ assert(event && "UDPTransport::DoConnectCb(): Connection context did not provide an event"); /* * Is there still a thread with an event on its stack waiting for us * here? If there is, we need to bug it. If the thread is gone, we go * there is no point in going though the motions, and creating an * endpoint we would just have to fail. */ QCC_DbgPrintf(("UDPTransport::DoConnectCb(): Taking endpoint list lock")); m_endpointListLock.Lock(MUTEX_CONTEXT); bool eventValid = false; for (set::iterator j = m_connectThreads.begin(); j != m_connectThreads.end(); ++j) { if (j->m_connId == connId) { assert(j->m_event == event && "UDPTransport::DoConnectCb(): event != j->m_event"); eventValid = true; break; } } /* * If there is no valid event, there is no thread waiting for the * connect to complete. It must be gone if it has removed its * ConnectEntry; or there is a very unlikely chance that the connection * is down now, and was down when the thread created its entry and it * therefore used ARDP_CONN_ID_INVALID as its ID. In that case, it will * just have to time out. If the thread removed its valid ConnectEntry * it must have done so with the endpoint list lock taken, so we know it * is there if this test passes. */ if (eventValid == false) { QCC_LogError(status, ("UDPTransport::DoConnectCb(): No thread waiting for Connect() to complete")); m_endpointListLock.Unlock(MUTEX_CONTEXT); m_ardpLock.Lock(); ARDP_ReleaseConnection(handle, conn); m_ardpLock.Unlock(); m_connLock.Lock(MUTEX_CONTEXT); --m_currAuth; --m_currConn; m_connLock.Unlock(MUTEX_CONTEXT); DecrementAndFetch(&m_refCount); return; } /* * If the connect failed, wake up the thread waiting for completion * without creating an endpoint for it. */ if (status != ER_OK) { QCC_LogError(status, ("UDPTransport::DoConnectCb(): Connect error")); event->SetEvent(); m_endpointListLock.Unlock(MUTEX_CONTEXT); m_ardpLock.Lock(); ARDP_ReleaseConnection(handle, conn); m_ardpLock.Unlock(); m_connLock.Lock(MUTEX_CONTEXT); --m_currAuth; --m_currConn; m_connLock.Unlock(MUTEX_CONTEXT); DecrementAndFetch(&m_refCount); return; } /* * If we cannot find a BusHello, wake up the thread waiting for * completion without creating an endpoint for it. */ if (buf == NULL || len == 0) { QCC_LogError(ER_UDP_INVALID, ("UDPTransport::DoConnectCb(): No BusHello reply with SYN + ACK")); event->SetEvent(); m_endpointListLock.Unlock(MUTEX_CONTEXT); m_ardpLock.Lock(); ARDP_ReleaseConnection(handle, conn); m_ardpLock.Unlock(); m_connLock.Lock(MUTEX_CONTEXT); --m_currAuth; --m_currConn; m_connLock.Unlock(MUTEX_CONTEXT); DecrementAndFetch(&m_refCount); return; } /* * Load the bytes from the BusHello reply into a Message. */ Message helloReply(m_bus); status = helloReply->LoadBytes(buf, len); if (status != ER_OK) { QCC_LogError(status, ("UDPTransport::DoConnectCb(): Can't Unmarhsal() BusHello Reply Message")); event->SetEvent(); m_endpointListLock.Unlock(MUTEX_CONTEXT); m_ardpLock.Lock(); ARDP_ReleaseConnection(handle, conn); m_ardpLock.Unlock(); m_connLock.Lock(MUTEX_CONTEXT); --m_currAuth; --m_currConn; m_connLock.Unlock(MUTEX_CONTEXT); DecrementAndFetch(&m_refCount); return; } /* * Unmarshal the message. We need to provide and endpoint unique name * for error reporting purposes, in order to to affix blame here if * something goes awry. If we don't pass true in checkSender Unmarshal * won't validate the endpoint name and will just print it out in case * of problems. We make (an illegal) one up since we don't have an * endpoint yet. */ qcc::String endpointName(":0.0"); status = helloReply->Unmarshal(endpointName, false, false, true, 0); if (status != ER_OK) { QCC_LogError(status, ("UDPTransport::DoConnectCb(): Can't Unmarhsal() BusHello Message")); event->SetEvent(); m_endpointListLock.Unlock(MUTEX_CONTEXT); m_ardpLock.Lock(); ARDP_ReleaseConnection(handle, conn); m_ardpLock.Unlock(); m_connLock.Lock(MUTEX_CONTEXT); --m_currAuth; --m_currConn; m_connLock.Unlock(MUTEX_CONTEXT); DecrementAndFetch(&m_refCount); return; } /* * Validate the fields in the incoming BusHello Reply Message */ if (helloReply->GetType() != MESSAGE_METHOD_RET) { status = ER_BUS_ESTABLISH_FAILED; QCC_LogError(status, ("UDPTransport::DoConnectCb(): Response was not a reply Message")); event->SetEvent(); m_endpointListLock.Unlock(MUTEX_CONTEXT); m_ardpLock.Lock(); ARDP_ReleaseConnection(handle, conn); m_ardpLock.Unlock(); m_connLock.Lock(MUTEX_CONTEXT); --m_currAuth; --m_currConn; m_connLock.Unlock(MUTEX_CONTEXT); DecrementAndFetch(&m_refCount); return; } /* * The remote name is the sender of the BusHello reply message, * presumably the local bus attachment of the remote daemon doing * the implied Accept() */ qcc::String remoteName = helloReply->GetSender(); QCC_DbgPrintf(("UDPTransport::DoConnectCb(): BusHello reply from sender=\"%s\"", remoteName.c_str())); status = helloReply->UnmarshalArgs("ssu"); if (status != ER_OK) { QCC_LogError(status, ("UDPTransport::DoConnectCb(): Can't UnmarhsalArgs() BusHello Reply Message")); event->SetEvent(); m_endpointListLock.Unlock(MUTEX_CONTEXT); m_ardpLock.Lock(); ARDP_ReleaseConnection(handle, conn); m_ardpLock.Unlock(); m_connLock.Lock(MUTEX_CONTEXT); --m_currAuth; --m_currConn; m_connLock.Unlock(MUTEX_CONTEXT); DecrementAndFetch(&m_refCount); return; } /* * We expect three arguments in the message: the unique name of the * remote side, the remoteGUID and a protocol version. The high order * two bits of the protocol version are the nameTransfer bits that will * tell the allJoyn obj how many names to exchange during ExchangeNames. */ size_t numArgs; const MsgArg* args; helloReply->GetArgs(numArgs, args); if (numArgs != 3 || args[0].typeId != ALLJOYN_STRING || args[1].typeId != ALLJOYN_STRING || args[2].typeId != ALLJOYN_UINT32) { status = ER_BUS_ESTABLISH_FAILED; QCC_LogError(status, ("UDPTransport::DoConnectCb(): Unexpected number or type of arguments in BusHello Reply Message")); event->SetEvent(); m_endpointListLock.Unlock(MUTEX_CONTEXT); m_ardpLock.Lock(); ARDP_ReleaseConnection(handle, conn); m_ardpLock.Unlock(); m_connLock.Lock(MUTEX_CONTEXT); --m_currAuth; --m_currConn; m_connLock.Unlock(MUTEX_CONTEXT); DecrementAndFetch(&m_refCount); return; } qcc::String uniqueName = args[0].v_string.str; qcc::String remoteGUID = args[1].v_string.str; uint32_t protocolVersion = args[2].v_uint32 & 0x3FFFFFFF; uint32_t nameTransfer = args[2].v_uint32 >> 30; QCC_DbgPrintf(("UDPTransport::DoConnectCb(): Got BusHello() reply. uniqueName=\"%s\", remoteGuid=\"%s\", protocolVersion=%d., nameTransfer=%d.", uniqueName.c_str(), remoteGUID.c_str(), protocolVersion, nameTransfer)); /* * We have everything we need to start up, so it is now time to create * our new endpoint. */ m_ardpLock.Lock(); qcc::IPAddress ipAddr = ARDP_GetIpAddrFromConn(handle, conn); uint16_t ipPort = ARDP_GetIpPortFromConn(handle, conn); m_ardpLock.Unlock(); static const bool truthiness = true; UDPTransport* ptr = this; String normSpec = "udp:guid=" + remoteGUID + ",addr=" + ipAddr.ToString() + ",port=" + U32ToString(ipPort); UDPEndpoint udpEp(ptr, m_bus, truthiness, normSpec); /* * Make a note of when we started this process in case something * goes wrong. */ Timespec tNow; GetTimeNow(&tNow); udpEp->SetStartTime(tNow); udpEp->SetStopTime(tNow); /* * Some of this would "normally" be handled by EndpointAuth, but since we * are short-circuiting the process, we have to do the bookkeeping * ourselves. */ udpEp->GetFeatures().isBusToBus = true; udpEp->GetFeatures().allowRemote = true; udpEp->GetFeatures().protocolVersion = protocolVersion; udpEp->GetFeatures().trusted = false; udpEp->GetFeatures().nameTransfer = static_cast(nameTransfer); udpEp->SetRemoteGUID(remoteGUID); udpEp->SetActive(); udpEp->SetIpAddr(ipAddr); udpEp->SetIpPort(ipPort); udpEp->CreateStream(handle, conn, m_ardpConfig.initialDataTimeout, m_ardpConfig.totalDataRetryTimeout / m_ardpConfig.initialDataTimeout); udpEp->SetHandle(handle); udpEp->SetConn(conn); /* * Check any application connecting over UDP to see if it is running on the same machine and * set the group ID appropriately if so. */ CheckEndpointLocalMachine(udpEp); /* * The unique name of the endpoint on the active side of the connection is * the unique name generated on the passive side. */ udpEp->SetUniqueName(uniqueName); /* * The remote name of the endpoint on the active side of the connection * is the sender of the BusHello reply message, which is presumably the * local bus attachement on the remote side. */ udpEp->SetRemoteName(remoteName); /* * From our perspective as the active opener of the connection, we are * done. */ QCC_DbgPrintf(("UDPTransport::DoConnectCb(): Adding endpoint with conn ID == %d. to m_endpointList", connId)); #ifndef NDEBUG DebugEndpointListCheck(udpEp); #endif /* * We have a contract with Connect() that says we take over ownership of * the connection limit counters after a successful call to * ARDP_Connect(). Connect() will have incremented both m_currAuth and * m_currConn. The authentication actually happened in the ARDP connect * process, so what we need to do here is to decrement m_currAuth, but * leave m_currConn as it is to reflect the now fully authenticated and * active connection. */ m_connLock.Lock(MUTEX_CONTEXT); --m_currAuth; /* * Before putting the endpoint on the endpoint list, set the state to * indicate that it is starting up becuase of an active (begun by this * local host) connection attempt. */ udpEp->SetEpActiveStarted(); QCC_DbgPrintf(("UDPTransport::DoConnectCb(): adding endpoint with connId == %d. to m_endpointList", udpEp->GetConnId())); m_endpointList.insert(udpEp); m_connLock.Unlock(MUTEX_CONTEXT); /* * We cannot call out to the daemon (which Start() will do) with the * endpointListLock taken. This means that we will have to re-verify * that the thread originally attempting the connect is still there when * we come back. If it is going, we need to arrange to undo the * following work, but that's the way the threading-cookie crumbles. */ QCC_DbgPrintf(("UDPTransport::DoConnectCb(): giving endpoint list lock")); m_endpointListLock.Unlock(MUTEX_CONTEXT); /* * We now have a UDPEndpoint that needs to be Start()ed and put on the * active endpint list and hooked up to the demux so it can receive * inbound data. It needs to be Start()ed not because there are threads * that need to be started, but that is where we register our endpoint * with the router, and that is what will start the ExchangeNames * process. */ QCC_DbgPrintf(("UDPTransport::DoConnectCb(): Start()ing endpoint with conn ID == %d.", connId)); udpEp->SetListener(this); udpEp->Start(); QCC_DbgPrintf(("UDPTransport::DoConnectCb(): Taking endpoint list lock")); m_endpointListLock.Lock(MUTEX_CONTEXT); /* * There may be a thread waiting for this process to finish, so we need * to wake it up or understand what its disposition was or will be. The * moment we gave up the m_endpointListLock above in order to keep from * holding it though some possibly lengthy daemon operations, the * endpoint management thread could have decided to tear down the * endpoint and invalidate all of our work. The connection we so * carefully considered above could have been torn down by ARDP if the * other side decided to close the connection or RST it for some unknown * (to us) reason. * * At this point, we don't need to talk to ARDP, so the connection * identifier is all we really care about there. We are using it to tie * our stuff together so the one we remembered at the start of this * method is fine to use in order to find the waiting thread. If we got * to this piont, we have pulled an event out of a connection context * previously. This is a pointer to an event, but it points to an event * that was allocated on the heap by the thread that may or may not be * still waiting for use to wake it. We know the endpoint that was * formed as a result of this work is still there since we hold a * managed object reference to it. * * So, what we need to do is to find the thread that started this whole * long and involved process in order to make sure that the event is * still valid and bug that event. */ eventValid = false; for (set::iterator j = m_connectThreads.begin(); j != m_connectThreads.end(); ++j) { if (j->m_connId == connId) { /* * We believe that looking at the connection ID is sufficient to * idenfity the thread. Double check this assumption by * asserting that the pointer to the event the thread is waiting * on is the same as the pointer to the event we discovered * through the connection. If it is not, our assumption that * the connection ID is sufficient is broken. */ assert(j->m_event == event && "UDPTransport::DoConnectCb(): event != j->m_event"); eventValid = true; break; } } /* * We're all done cranking up the endpoint. If there's someone waiting, * we found them, so wake them up. If there's nobody there, stop the * endpoint since someone changed their mind and we need to begin the * process of taking it down (and undoing all of that work we just did). */ if (eventValid) { QCC_DbgPrintf(("UDPTransport::DoConnectCb(): Waking thread waiting for endpoint")); event->SetEvent(); } else { QCC_DbgPrintf(("UDPTransport::DoConnectCb(): No thread waiting for endpoint")); /* * If there is no thread waiting for the endpoint to connect, it cannot * have reported back success, so we presume there can be no buffered * data waiting go be transmitted over this endpoint. Therefore we * disable the EP_WAITING state. */ udpEp->SetEpWaitEnable(false); udpEp->Stop(); } QCC_DbgPrintf(("UDPTransport::DoConnectCb(): giving endpoint list lock")); m_endpointListLock.Unlock(MUTEX_CONTEXT); DecrementAndFetch(&m_refCount); return; } } /* * This is method that is called in order to begin the process of detaching from * the router. We do this bu ultimately calling _RemoteEndpoint::Exit() in our * Exit() function. The _RemoteEndpoint::Exit() function calls out to to the * Daemon Router UnregisterEndpoint() function. This function will, in turn, * remove the endpoint which will cause virtual endpoints to be removed. This * means NameChanged signals will be generated which are then sent out other * endpoints. * * NameOwnerChanged messages are sent using PushMessage which may turn right * around and translate into a PushBytes() back into an ARDP stream. If we run * this method out of the message dispatcher thread, and UnregisterEndpoint() * happens to cause a NameChanged signal that is sent out a UDP Endpoint, the * message dispatcher will block waiting for the PushBytes to complete, but the * SendCb will need to be processed by the dispatcher thread which is blocked. * This results in deadlock that is broken by the PushBytes watchdog timer. Not * good. * * On the other hand, if we drive the UnregisterEndpoint() call out of the * endpoint manager, and the PushBytes encounters transmission errors, the * call to PushBytes may time out, in which UnregisterEndpoint will be delayed * by the entire retransmission time. This would block the endpoint management * process for possibly a long time. * * So the only real option is to dedicate a separate thread to making our * EndpointExit calls, which we do. */ void UDPTransport::ExitEndpoint(uint32_t connId) { IncrementAndFetch(&m_refCount); QCC_DbgHLPrintf(("UDPTransport::ExitEndpoint(connId=%d.)", connId)); /* * If m_exitDispatcher is NULL, it means we are shutting down and the * dispatcher has gone away before the endpoint management thread has * actually stopped running. This is rare, but possible. */ if (m_exitDispatcher == NULL) { QCC_DbgPrintf(("UDPTransport::ExitEndpoint(): m_exitDispatcher is NULL")); DecrementAndFetch(&m_refCount); return; } UDPTransport::WorkerCommandQueueEntry entry; entry.m_command = UDPTransport::WorkerCommandQueueEntry::EXIT; entry.m_connId = connId; QCC_DbgPrintf(("UDPTransport::ExitEndpoint(): sending EXIT request to exit dispatcher for connId == %d", connId)); m_exitWorkerCommandQueueLock.Lock(MUTEX_CONTEXT); m_exitWorkerCommandQueue.push(entry); m_exitWorkerCommandQueueLock.Unlock(MUTEX_CONTEXT); m_exitDispatcher->Alert(); DecrementAndFetch(&m_refCount); } /* * ARDP, being C, calls into the static member function ArdpConnectCb(). That * function finds the transport "this" pointer in the handle and uses that to * call here, into the UDPTransport member method. * * Since we are called in the same thread context as ARDP here, we assume that * the handle and connection must be valid since ARDP wouldn't have called us * with them set to an invalid value. * * This is the indication from the ARDP protocol that a connection is in the * process of being formed. We want to spend as little time as possible here * (and avoid deadlocks as much as possible here) so we just immediately ask the * transport dispatcher to do something with this message and return. This case * is unlike the others because there may not be an endpoint to demux to yet. * * Note that we do not have to take the ARDP re-entrancy lock here because we * are in a callback from ARDP (via the associated static member function), * which must have been driven by a call to ARDP_Run which is required to be * protected by the re-entrancy lock. */ void UDPTransport::ConnectCb(ArdpHandle* handle, ArdpConnRecord* conn, bool passive, uint8_t* buf, uint16_t len, QStatus status) { IncrementAndFetch(&m_refCount); QCC_DbgHLPrintf(("UDPTransport::ConnectCb(handle=%p, conn=%p, passive=%d., buf=%p, len=%d., status=\"%s\")", handle, conn, passive, buf, len, QCC_StatusText(status))); /* * If m_dispatcher is NULL, it means we are shutting down and the message * dispatcher has gone away before the endpoint management thread has * actually stopped running. This is rare, but possible. */ if (m_dispatcher == NULL) { QCC_DbgPrintf(("UDPTransport::ConnectCb(): m_dispatcher is NULL")); DecrementAndFetch(&m_refCount); return; } UDPTransport::WorkerCommandQueueEntry entry; entry.m_command = UDPTransport::WorkerCommandQueueEntry::CONNECT_CB; entry.m_handle = handle; entry.m_conn = conn; entry.m_connId = ARDP_GetConnId(handle, conn); entry.m_passive = passive; #ifndef NDEBUG entry.m_buf = new uint8_t[len + SEAL_SIZE]; SealBuffer(entry.m_buf + len); #else entry.m_buf = new uint8_t[len]; #endif entry.m_len = len; memcpy(entry.m_buf, buf, len); entry.m_status = status; QCC_DbgPrintf(("UDPTransport::ConnectCb(): sending CONNECT_CB request to dispatcher)")); m_workerCommandQueueLock.Lock(MUTEX_CONTEXT); m_workerCommandQueue.push(entry); m_workerCommandQueueLock.Unlock(MUTEX_CONTEXT); m_dispatcher->Alert(); DecrementAndFetch(&m_refCount); } /* * ARDP, being C, calls into the static member function ArdpDisconnectCb(). * That function finds the transport "this" pointer in the handle and uses that * to call here, into the UDPTransport member method. * * Since we are called in the same thread context as ARDP here, we assume that * the handle and connection must be valid since ARDP wouldn't have called us * with them set to an invalid value. * * This is the indication from the ARDP protocol that a connection has been * disconnected. We want to spend as little time as possible here (and avoid * deadlocks as much as possible here) so we just immediately ask the transport * dispatcher to do something with this message and return. * * Note that we do not have to take the ARDP re-entrancy lock here because we * are in a callback from ARDP (via the associated static member function), * which must have been driven by a call to ARDP_Run which is required to be * protected by the re-entrancy lock. */ void UDPTransport::DisconnectCb(ArdpHandle* handle, ArdpConnRecord* conn, QStatus status) { IncrementAndFetch(&m_refCount); QCC_DbgHLPrintf(("UDPTransport::DisconnectCb(handle=%p, conn=%p, status=\"%s\")", handle, conn, QCC_StatusText(status))); /* * If m_dispatcher is NULL, it means we are shutting down and the dispatcher * has gone away before the endpoint management thread has actually stopped * running. This is rare, but possible. */ if (m_dispatcher == NULL) { QCC_DbgPrintf(("UDPTransport::DisconnectCb(): m_dispatcher is NULL")); DecrementAndFetch(&m_refCount); return; } UDPTransport::WorkerCommandQueueEntry entry; entry.m_command = UDPTransport::WorkerCommandQueueEntry::DISCONNECT_CB; entry.m_handle = handle; entry.m_conn = conn; entry.m_connId = ARDP_GetConnId(handle, conn); entry.m_status = status; QCC_DbgPrintf(("UDPTransport::DisconnectCb(): sending DISCONNECT_CB request to dispatcher)")); m_workerCommandQueueLock.Lock(MUTEX_CONTEXT); m_workerCommandQueue.push(entry); m_workerCommandQueueLock.Unlock(MUTEX_CONTEXT); m_dispatcher->Alert(); DecrementAndFetch(&m_refCount); } /* * ARDP, being C, calls into the static member function ArdpRecvCb(). That * function finds the transport "this" pointer in the handle and uses that to * call here, into the UDPTransport member method. * * Since we are called in the same thread context as ARDP here, we assume that * the handle and connection must be valid since ARDP wouldn't have called us * with them set to an invalid value. * * This is the indication from the ARDP protocol that we have received bytes. * We want to spend as little time as possible here (and avoid deadlocks as much * as possible here) so we just immediately ask the transport dispatcher to do * something with this message and return. The dispatcher will figure out which * endpoint this callback is destined for and demultiplex it accordingly. * * Note that we do not have to take the ARDP re-entrancy lock here because we * are in a callback from ARDP (via the associated static member function), * which must have been driven by a call to ARDP_Run which is required to be * protected by the re-entrancy lock. */ void UDPTransport::RecvCb(ArdpHandle* handle, ArdpConnRecord* conn, ArdpRcvBuf* rcv, QStatus status) { IncrementAndFetch(&m_refCount); QCC_DbgHLPrintf(("UDPTransport::RecvCb(handle=%p, conn=%p, rcv=%p, status=%s)", handle, conn, rcv, QCC_StatusText(status))); /* * If m_dispatcher is NULL, it means we are shutting down and the dispatcher * has gone away before the endpoint management thread has actually stopped * running. This is rare, but possible. */ if (m_dispatcher == NULL) { QCC_DbgPrintf(("UDPTransport::RecvCb(): m_dispatcher is NULL")); #if RETURN_ORPHAN_BUFS QCC_DbgPrintf(("UDPTransport::RecvCb(): ARDP_RecvReady()")); m_ardpLock.Lock(); ARDP_RecvReady(handle, conn, rcv); m_ardpLock.Unlock(); #else // not RETURN_ORPHAN_BUFS /* * If we get here, we have a receive callback from ARDP but we don't * have a message dispatcher to route the message to. This is expected * (rarely) if the transport is going down (think control-c) but ARDP * still has messages queued up to be delivered. Since there's nowhere * to send such messages, we just have to drop them. Since the endpoint * has been or is being destroyed, we assume that ARDP will close down * the connection and release any pending buffers as part of the * endpoint teardown. This means that we can just ignore the buffer * here. */ QCC_DbgPrintf(("UDPTransport::DispatcherThread::RecvCb(): Orphaned Recv_Cb for conn == %p ignored", conn)); #endif // not RETURN_ORPHAN_BUFS DecrementAndFetch(&m_refCount); return; } UDPTransport::WorkerCommandQueueEntry entry; entry.m_command = UDPTransport::WorkerCommandQueueEntry::RECV_CB; entry.m_handle = handle; entry.m_conn = conn; entry.m_connId = ARDP_GetConnId(handle, conn); entry.m_rcv = rcv; entry.m_status = status; QCC_DbgPrintf(("UDPTransport::RecvCb(): sending RECV_CB request to dispatcher)")); m_workerCommandQueueLock.Lock(MUTEX_CONTEXT); m_workerCommandQueue.push(entry); m_workerCommandQueueLock.Unlock(MUTEX_CONTEXT); m_dispatcher->Alert(); DecrementAndFetch(&m_refCount); } /* * ARDP, being C, calls into the static member function ArdpSendCb(). That * function finds the transport "this" pointer in the handle and uses that to * call here, into the UDPTransport member method. * * Since we are called in the same thread context as ARDP here, we assume that * the handle and connection must be valid since ARDP wouldn't have called us * with them set to an invalid value. * * This is the indication from the ARDP protocol that we have (usually) * successfully sent bytes. We want to spend as little time as possible here * (and avoid deadlocks as much as possible here) so we just immediately ask the * transport dispatcher to do something with this message and return. The * dispatcher will figure out which endpoint this callback is destined for and * demultiplex it accordingly. * * Note that we do not have to take the ARDP re-entrancy lock here because we * are in a callback from ARDP (via the associated static member function), * which must have been driven by a call to ARDP_Run which is required to be * protected by the re-entrancy lock. */ void UDPTransport::SendCb(ArdpHandle* handle, ArdpConnRecord* conn, uint8_t* buf, uint32_t len, QStatus status) { IncrementAndFetch(&m_refCount); QCC_DbgHLPrintf(("UDPTransport::SendCb(handle=%p, conn=%p, buf=%p, len=%d.)", handle, conn, buf, len)); /* * If m_dispatcher is NULL, it means we are shutting down and the dispatcher * has gone away before the endpoint management thread has actually stopped * running. This is rare, but possible. */ if (m_dispatcher == NULL) { QCC_DbgPrintf(("UDPTransport::SendCb(): m_dispatcher is NULL")); DecrementAndFetch(&m_refCount); return; } UDPTransport::WorkerCommandQueueEntry entry; entry.m_command = UDPTransport::WorkerCommandQueueEntry::SEND_CB; entry.m_handle = handle; entry.m_conn = conn; entry.m_connId = ARDP_GetConnId(handle, conn); entry.m_buf = buf; entry.m_len = len; entry.m_status = status; QCC_DbgPrintf(("UDPTransport::SendCb(): sending SEND_CB request for connId == %d. to dispatcher)", entry.m_connId)); m_workerCommandQueueLock.Lock(MUTEX_CONTEXT); m_workerCommandQueue.push(entry); m_workerCommandQueueLock.Unlock(MUTEX_CONTEXT); m_dispatcher->Alert(); DecrementAndFetch(&m_refCount); } /** * ARDP, being C, calls into the static member function ArdpSendWindowCb(). * That function finds the transport "this" pointer in the handle and uses that * to call here, into the UDPTransport member method. * * Since we are called in the same thread context as ARDP here, we assume that * the handle and connection must be valid since ARDP wouldn't have called us * with them set to an invalid value. * * This is an indication from the ARDP Procotol that the send window has * changed. * * Note that we do not have to take the ARDP re-entrancy lock here because we * are in a callback from ARDP (via the associated static member function), * which must have been driven by a call to ARDP_Run which is required to be * protected by the re-entrancy lock. */ void UDPTransport::SendWindowCb(ArdpHandle* handle, ArdpConnRecord* conn, uint16_t window, QStatus status) { QCC_UNUSED(handle); QCC_UNUSED(conn); QCC_UNUSED(window); QCC_UNUSED(status); IncrementAndFetch(&m_refCount); QCC_DbgTrace(("UDPTransport::SendWindowCb(handle=%p, conn=%p, window=%d.)", handle, conn, window)); QCC_DbgPrintf(("UDPTransport::SendWindowCb(): callback from conn ID == %d", ARDP_GetConnId(handle, conn))); DecrementAndFetch(&m_refCount); } /** * A struct to hold information about IO_WRITE events that can be used * transiently to enable ARDP to wait for sockets to become writable after * it discovers the socket queue is full. * * Would be nice if it could be a local type to UDPTransport::Run() but Android * balks. */ struct WriteEntry { WriteEntry(bool active, SocketFd socket, Event* event) : m_active(active), m_socket(socket), m_event(event) { } bool m_active; /**< If true indicates that ARDP wants to know when m_socket is writeable */ SocketFd m_socket; /**< The socket FD of interest */ Event* m_event; /**< The IO_WRITE event used to wait for writeable state */ }; /** * This is the run method of the main loop of the UDP Transport maintenance * thread -- the center of the UDP Transport universe. */ void* UDPTransport::Run(void* arg) { QCC_UNUSED(arg); QCC_DbgTrace(("UDPTransport::Run()")); /* * We did an Acquire on the name service in our Start() method which * ultimately caused this thread to run. If we were the first transport * to Acquire() the name service, it will have done a Start() to crank * up its own run thread. Just because we did that Start() before we * did our Start(), it does not necessarily mean that thread will come * up and run before us. If we happen to come up before our name service * we'll hang around until it starts to run. After all, nobody is going * to attempt to connect until we advertise something, and we need the * name service to advertise. */ while (IpNameService::Instance().Started() == false) { QCC_DbgPrintf(("UDPTransport::Run(): Wait for IP name service")); qcc::Sleep(10); } /* * ARDP wants to write its output to a datagram socket. This socket has a * buffer. If this buffer fills up, ARDP will begin getting ER_WOULDBLOCK * on its sendto calls. ARDP will return ER_ARDP_WRITE_BLOCKED in this * case. * * When this happens, ARDP needs to wait until the underlying socket becomes * writable. Since the select or epoll that is underlying our Event::Wait * is level, not edge triggered, we don't want to naively add write events, * which would then mostly be signaled causing the main loop to effectively * poll for readable sockets. * * In theory, we can have multiple listen specs for multiple interfaces, * which leads to multiple sockets coming ready and various times. We call * ARDP sequentially with these different sockets, so When ARDP_Run() * returns ER_ARDP_WRITE_BLOCKED on a call in which a specific socket is * supplied, we should assume that it is this socket ARDP wants to know * about becoming writable again. Since there can be multiple sockets, ARDP * can be interested in hearing about multiple sockets being writable. * * We don't want to be newing up annd deleting events all the time, so we * want to do the event creation when the list of listen FDs changes. We * are always interested in the IO_READ events, but sometimes interested in * the IO_WRITE events. Whenever we notice the list of listen FDs change, * we create a list of IO_READ events which will always be used, and a list * of corresponding IO_WRITE events from which we can pick and choose * depending on whether or not the look for the being-writable state. */ vector checkEvents, signaledEvents; vector writeEvents; qcc::Event ardpTimerEvent(qcc::Event::WAIT_FOREVER, 0); qcc::Event maintenanceTimerEvent(qcc::Event::WAIT_FOREVER, 0); checkEvents.push_back(&stopEvent); checkEvents.push_back(&ardpTimerEvent); checkEvents.push_back(&maintenanceTimerEvent); Timespec tLastManage; GetTimeNow(&tLastManage); QStatus status = ER_OK; /* * The purpose of this thread is to (1) manage all of our endpoints going * through the various states they do; (2) watch for the various sockets * corresponding to endpoints on sundry networks for becoming ready; and * (3) drive/whip the ARDP protocol to do our bidding. */ for (;;) { bool passive = m_preList.empty() && m_authList.empty() && m_endpointList.empty(); if (IsStopping() && passive) { QCC_DbgPrintf(("UDPTransport::Run(): IsStopping() && passive: exiting")); break; } /* * Each time through the loop we need to wait on the stop event and all * of the SocketFds of the addresses and ports we are listening on. We * expect the list of FDs to change rarely, so we want to spend most of * our time just driving the ARDP protocol and moving bits. We only * redo the list if we notice the state changed from STATE_RELOADED. * * Instead of trying to figure out which of the socket FDs that may have * changed between runs, we just reload the whole bunch. Since this is * rarely done, it is okay. */ m_listenFdsLock.Lock(MUTEX_CONTEXT); if (m_reload != STATE_RELOADED) { QCC_DbgPrintf(("UDPTransport::Run(): Not STATE_RELOADED. Deleting events")); for (vector::iterator i = checkEvents.begin(); i != checkEvents.end(); ++i) { if (*i != &stopEvent && *i != &ardpTimerEvent && *i != &maintenanceTimerEvent) { delete *i; } } for (vector::iterator i = writeEvents.begin(); i != writeEvents.end(); ++i) { delete i->m_event; } checkEvents.clear(); writeEvents.clear(); QCC_DbgPrintf(("UDPTransport::Run(): Not STATE_RELOADED. Creating events")); checkEvents.push_back(&stopEvent); checkEvents.push_back(&ardpTimerEvent); checkEvents.push_back(&maintenanceTimerEvent); QCC_DbgPrintf(("UDPTransport::Run(): Not STATE_RELOADED. Creating socket events")); for (list >::const_iterator i = m_listenFds.begin(); i != m_listenFds.end(); ++i) { QCC_DbgPrintf(("UDPTransport::Run(): Not STATE_RELOADED. Creating event for socket %d", i->second)); qcc::Event* eventRd = new Event(i->second, Event::IO_READ); checkEvents.push_back(eventRd); qcc::Event* eventWr = new Event(i->second, Event::IO_WRITE); WriteEntry entry(false, i->second, eventWr); writeEvents.push_back(entry); } m_reload = STATE_RELOADED; } m_listenFdsLock.Unlock(MUTEX_CONTEXT); /* * In order to rationalize management of resources, we manage the * various lists in one place on one thread. This isn't super-expensive * but can add up if there are lots of endpoings, so we don't want to do * this resource management exercise every time throught the socket read * loop, so limit the number of times it will be called. */ Timespec tNow; GetTimeNow(&tNow); int32_t tMin = tLastManage + UDP_ENDPOINT_MANAGEMENT_MIN - tNow; QCC_DbgPrintf(("UDPTransport::Run(): Defer ManageEndpoints() tMin=%d. ms", tMin)); int64_t tRemaining = tLastManage + UDP_ENDPOINT_MANAGEMENT_TIMER - tNow; QCC_DbgPrintf(("UDPTransport::Run(): Defer ManageEndpoints() tRemaining=%d. ms", tRemaining)); if (m_manage != STATE_MANAGED || tRemaining < 0) { QCC_DbgPrintf(("UDPTransport::Run(): ManageEndpoints() suggested")); /* * Get defensive about various threads bugging us constantly. There * is no reason to run ManageEndpoints faster than endpoints can be * created and destroyed -- so if we were just here less than some * minimum time ago, don't run the code but make sure it is scheduled * to run after that time. */ if (tMin < 0) { QCC_DbgPrintf(("UDPTransport::Run(): ManageEndpoints() due")); /* * Set m_manage to STATE_MANAGED before calling ManageEndpoints in * case something happens while ManageEndpoints is half-way done * which requires addiional endpoint management. */ m_manage = STATE_MANAGED; QCC_DbgPrintf(("UDPTransport::Run(): ManageEndpoints()")); ManageEndpoints(m_authTimeout, m_sessionSetupTimeout); tLastManage = tNow; uint32_t tManage = UDP_ENDPOINT_MANAGEMENT_TIMER; maintenanceTimerEvent.ResetTime(tManage, 0); } else { uint32_t tManage = UDP_ENDPOINT_MANAGEMENT_MIN; QCC_DbgPrintf(("UDPTransport::Run(): Defer ManageEndpoints() for %d. ms", tManage)); maintenanceTimerEvent.ResetTime(tManage, 0); } } /* * We now have a list of checkEvents that includes all of the IO_READ * socket events and maybe some write events. We have to decide which * write events should be tacked on the end and remove the others. * Since we expect the typical case will be to not be interested in * write events, we bias toward that case. Every time through the loop * we remove all write events from checkEvents. Then, we scan through * writeEvents looking for active events (which we expect to find only * rarely) and add them to checkEvents. We expect to be working with * very small vectors here. */ for (vector::iterator i = checkEvents.begin(); i != checkEvents.end();) { Event* checkEvent = *i; if (checkEvent->GetEventType() == Event::IO_WRITE) { i = checkEvents.erase(i); } else { ++i; } } /* * Add any write events we are actively seeking. */ for (vector::iterator i = writeEvents.begin(); i != writeEvents.end(); ++i) { if (i->m_active) { QCC_DbgPrintf(("UDPTransport::Run(): Looking for socket %d. to become writable")); checkEvents.push_back(i->m_event); } } signaledEvents.clear(); status = Event::Wait(checkEvents, signaledEvents); if (status == ER_TIMEOUT) { // QCC_LogError(status, ("UDPTransport::Run(): Catching Windows returning ER_TIMEOUT from Event::Wait()")); continue; } if (ER_OK != status) { QCC_LogError(status, ("UDPTransport::Run(): Event::Wait failed")); break; } /* * We're back from our Wait() so one of four things has happened. Our * thread has been asked to Stop(), our thread has been Alert()ed, our * timer has expired, or one of the socketFds we are listening on has * becomed signalled. * * If we have been asked to Stop(), or our thread has been Alert()ed, * the stopEvent will be on the list of signalled events. The way we * tell the difference is by looking at IsStopping() which we do up at * the top of the loop. In either case, we need to deal with managing * the endpoints. */ for (vector::iterator i = signaledEvents.begin(); i != signaledEvents.end(); ++i) { /* * Reset stop and timer events since we've heard them. */ if (*i == &stopEvent) { stopEvent.ResetEvent(); } else if (*i == &maintenanceTimerEvent) { maintenanceTimerEvent.ResetEvent(); } else if (*i == &ardpTimerEvent) { ardpTimerEvent.ResetEvent(); } /* * Events of interest to ARDP is if the time requested has expired * or if some socket has become readable or writable. First, * determine if this was a socket event (the socket became ready) or * if it was a timer event. If it was a socket ready event, * determine if the socket became readable or writable. */ bool socketReady = (*i != &ardpTimerEvent && *i != &maintenanceTimerEvent && *i != &stopEvent); bool readReady = (*i)->GetEventType() == Event::IO_READ; bool writeReady = (*i)->GetEventType() == Event::IO_WRITE; QCC_DbgPrintf(("UDPTransport::Run(): ARDP_Run(): readReady=\"%s\", writeReady=\"%s\"", readReady ? "true" : "false", writeReady ? "true" : "false")); uint32_t ms; QStatus ardpStatus; m_ardpLock.Lock(); if (socketReady) { ardpStatus = ARDP_Run(m_handle, (*i)->GetFD(), readReady, writeReady, &ms); } else { ardpStatus = ARDP_Run(m_handle, qcc::INVALID_SOCKET_FD, false, false, &ms); } m_ardpLock.Unlock(); /* * Every time we call ARDP_Run(), it lets us know when its next * timer will expire, so we tell our event to set itself in that * number of milliseconds so we can call back then. If it doesn't * have anything to do it returns -1 (WAIT_FOREVER). Just because * it doesn't know about something happening doesn't mean something * will not happen on this side. We need to bug this thread (send * an Alert() to wake us up) if we do anything that may require * deferred action. Since we don't know what that might be, it * means we need to do the Alert() whenever we call into ARDP and * do something we expect to require a retransmission or callback. */ ardpTimerEvent.ResetTime(ms, 0); /* * As described above, whenever we pass a socket into ARDP_Run() it * will return ER_ARDP_WRITE_BLOCKED if it wants us to call it back * when that socket becomes writable. If ARDP_run() does not return * ER_ARDP_WRITE_BLOCKED it is telling us that it is able to write or that * we should not worry about that socket being writable. */ if (socketReady) { for (vector::iterator j = writeEvents.begin(); j != writeEvents.end(); ++j) { if ((*i)->GetFD() == (*j).m_socket) { if (ardpStatus == ER_ARDP_WRITE_BLOCKED) { QCC_DbgPrintf(("UDPTransport::Run(): ARDP_Run(): ER_ARDP_WRITE_BLOCKED for SocketFd=%d.", (*i)->GetFD())); (*j).m_active = true; } else { QCC_DbgPrintf(("UDPTransport::Run(): ARDP_Run(): SocketFd=%d. not blocked for write", (*i)->GetFD())); (*j).m_active = false; } } } } } } /* * Don't leak events when stopping. */ for (vector::iterator i = checkEvents.begin(); i != checkEvents.end(); ++i) { if (*i != &stopEvent && *i != &ardpTimerEvent && *i != &maintenanceTimerEvent) { delete *i; } } checkEvents.clear(); for (vector::iterator i = writeEvents.begin(); i != writeEvents.end(); ++i) { delete i->m_event; } writeEvents.clear(); /* * If we're stopping, it is our responsibility to clean up the list of FDs * we are listening to. Since at this point we've Stop()ped and Join()ed * the protocol handlers, all we have to do is to close them down. * * Set m_reload to STATE_EXITED to indicate that the UDPTransport::Run * thread has exited. */ m_listenFdsLock.Lock(MUTEX_CONTEXT); for (list >::iterator i = m_listenFds.begin(); i != m_listenFds.end(); ++i) { qcc::Close(i->second); } m_listenFds.clear(); m_reload = STATE_EXITED; m_listenFdsLock.Unlock(MUTEX_CONTEXT); QCC_DbgPrintf(("UDPTransport::Run is exiting status=%s", QCC_StatusText(status))); return (void*) status; } /* * The purpose of this code is really to ensure that we don't have any listeners * active on Android systems if we have no ongoing advertisements. This is to * satisfy a requirement driven from the Android Compatibility Test Suite (CTS) * which fails systems that have processes listening for UDP connections when * the test is run. * * Listeners and advertisements are interrelated. In order to Advertise a * service, the name service must have an endpoint to include in its * advertisements; and there must be at least one listener running and ready to * receive connections before telling the name service to advertise. * * Discovery requests do not require listeners be present per se before being * forwarded to the name service. A discovery request will ulitmately lead to a * bus-to-bus connection once a remote daemon has been discovered; but the local * side will always start the connection. Sessions throw a bit of a monkey * wrench in the works, though. Since a JoinSession request is sent to the * (already connected) remote daemon and it decides what to do, we don't want to * arbitrarily constrain the remote daemon by disallowing it to try and connect * back to the local daemon. For this reason, we do require listeners to be * present before discovery starts. * * So the goal is to not have active listeners in the system unless there are * outstanding advertisements or discovery requests, but we cannot have * outstanding advertisements or discovery requests until there are active * listeners. Some care is obviously required here to accomplish this * seemingly inconsistent behavior. * * We call the state of no outstanding advertisements and not outstanding * discovery requests "Name Service Quiescent". In this case, the name service * must be disabled so that it doesn't interact with the network and cause a CTS * failure. As soon as a either a discovery request or an advertisement request * is started, we need to enable the name service to recieve and send network * packets, which will cause the daemon process to begin listening on the name * service well-known UDP port. * * Before an advertisement or a discovery request can acutally be sent over the * wire, we must start a listener which will receive connection requests, and * we must provide the name service with endpoint information that it can include * in its advertisement. So, from the name service and network perspective, * listens must preceed advertisements. * * In order to accomplish the CTS requirements, however, advertisements must * preceed listens. It turns out that this is how the high-level system wants * to work. Essentually, the system calls StartListen at the beginning of time * (when the daemon is first brought up) and it calls StopListen at the end of * time (when the daemon is going down). Advertisements and discovery requests * come and go in between as clients and services come up and go down. * * To deal with this time-inversion, we save a list of all listen requests, a * list of all advertisement requests and a list of all discovery requests. At * the beginning of time we get one or more StartListen calls and save the * listen specs, but do not actually do the socket operations to start the * corresponding socket-level listens. When the first advertisement or * discovery request comes in from the higher-level code, we first start all of * the saved listens and then enable the name service and ask it to start * advertising or discovering as appropriate. Further advertisements and * discovery requests are also saved, but the calls to the name service are * passed through when it is not quiescent. * * We keep track of the disable advertisement and discovery calls as well. Each * time an advertisement or discover operation is disabled, we remove the * corresponding entry in the associated list. As soon as all advertisements * and discovery operations are disabled, we disable the name service and remove * our UDP listeners, and therefore remove all listeners from the system. Since * we have a saved a list of listeners, they can be restarted if another * advertisement or discovery request comes in. * * We need to do all of this in one place (here) to make it easy to keep the * state of the transport (us) and the name service consistent. We are * basically a state machine handling the following transitions: * * START_LISTEN_INSTANCE: An instance of a StartListen() has happened so we * need to add the associated listen spec to our list of listeners and be * ready for a subsequent advertisement. We expect these to happen at the * beginning of time; but there is nothing preventing a StartListen after we * start advertising. In this case we need to execute the start listen. * * STOP_LISTEN_INSTANCE: An instance of a StopListen() has happened so we need * to remove the listen spec from our list of listeners. We expect these to * happen at the end of time; but there is nothing preventing a StopListen * at any other time. In this case we need to execute the stop listen and * remove the specified listener immediately * * ENABLE_ADVERTISEMENT_INSTANCE: An instance of an EnableAdvertisement() has * happened. If there are no other ongoing advertisements, we need to * enable the stored listeners, pass the endpoint information down to the * name servcie, enable the name service communication with the outside * world if it is disabled and finally pass the advertisement down to the * name service. If there are other ongoing advertisements we just pass * down the new advertisement. It is an AllJoyn system programming error to * start advertising before starting at least one listen. * * DISABLE_ADVERTISEMENT_INSTANCE: An instance of a DisableAdvertisement() * call has happened. We always want to pass the corresponding Cancel down * to the name service. If we decide that this is the last of our ongoing * advertisements, we need to continue and disable the name service from * talking to the outside world. For completeness, we remove endpoint * information from the name service. Finally, we shut down our UDP * transport listeners. * * ENABLE_DISCOVERY_INSTANCE: An instance of an EnableDiscovery() has * happened. This is a fundamentally different request than an enable * advertisement. We don't need any listeners to be present in order to do * discovery, but the name service must be enabled so it can send and * receive WHO-HAS packets. If the name service communications are * disabled, we need to enable them. In any case we pass the request down * to the name service. * * DISABLE_DISCOVERY_INSTANCE: An instance of a DisableDiscovery() call has * happened. There is no corresponding disable call in the name service, * but we do have to decide if we want to disable the name service to keep * it from listening. We do so if this is the last discovery instance and * there are no other advertisements. * * There are five member variables that reflect the state of the transport * and name service with respect to this code: * * m_isListening: The list of listeners is reflected by currently listening * sockets. We have network infrastructure in place to receive inbound * connection requests. * * m_isNsEnabled: The name service is up and running and listening on its * sockets for incoming requests. * * m_isAdvertising: We are advertising at least one well-known name either actively or quietly . * If we are m_isAdvertising then m_isNsEnabled must be true. * * m_isDiscovering: The list of discovery requests has been sent to the name * service. If we are m_isDiscovering then m_isNsEnabled must be true. */ void UDPTransport::RunListenMachine(ListenRequest& listenRequest) { IncrementAndFetch(&m_refCount); QCC_DbgTrace(("UDPTransport::RunListenMachine()")); /* * Do some consistency checks to make sure we're not confused about what * is going on. * * First, if we are not listening, then we had better not think we're * advertising(actively or quietly) or discovering. If we are * not listening, then the name service must not be enabled and sending * or responding to external daemons. */ if (m_isListening == false) { assert(m_isAdvertising == false); assert(m_isDiscovering == false); assert(m_isNsEnabled == false); } /* * If we think the name service is enabled, it had better think it is * enabled. It must be enabled either because we have requested it to * start advertising (actively or quietly) or we are discovering. * If there are listeners, then the m_listenPortMap (a map matching * the different interfaces to the ports on which we are listening * on those interfaces) must be non-empty. */ if (m_isNsEnabled && !m_stopping) { assert(m_isListening); assert(!m_listenPortMap.empty()); } /* * If we think we are advertising, we'd better have an entry in * the advertisements list to advertise, and there must be * listeners waiting for inbound connections as a result of those * advertisements. If we are advertising the name service had * better be enabled. */ if (m_isAdvertising && !m_stopping) { assert(!m_advertising.empty()); assert(m_isListening); assert(!m_listenPortMap.empty()); assert(m_isNsEnabled); } /* * If we are discovering, we'd better have an entry in the discovering * list to make us discover, and there must be listeners waiting for * inbound connections as a result of session operations driven by those * discoveries. If we are discovering the name service had better be * enabled. */ if (m_isDiscovering && !m_stopping) { assert(!m_discovering.empty()); assert(m_isListening); assert(!m_listenPortMap.empty()); assert(m_isNsEnabled); } /* * Now that are sure we have a consistent view of the world, let's do * what needs to be done. */ switch (listenRequest.m_requestOp) { case START_LISTEN_INSTANCE: StartListenInstance(listenRequest); break; case STOP_LISTEN_INSTANCE: StopListenInstance(listenRequest); break; case ENABLE_ADVERTISEMENT_INSTANCE: EnableAdvertisementInstance(listenRequest); break; case DISABLE_ADVERTISEMENT_INSTANCE: DisableAdvertisementInstance(listenRequest); break; case ENABLE_DISCOVERY_INSTANCE: EnableDiscoveryInstance(listenRequest); break; case DISABLE_DISCOVERY_INSTANCE: DisableDiscoveryInstance(listenRequest); break; case HANDLE_NETWORK_EVENT: HandleNetworkEventInstance(listenRequest); break; case UPDATE_DYNAMIC_SCORE_INSTANCE: UpdateDynamicScoreInstance(listenRequest); break; } DecrementAndFetch(&m_refCount); } void UDPTransport::StartListenInstance(ListenRequest& listenRequest) { IncrementAndFetch(&m_refCount); QCC_DbgTrace(("UDPTransport::StartListenInstance()")); /* * We have a new StartListen request, so save the listen spec so we * can restart the listen if we stop advertising. */ NewListenOp(START_LISTEN, listenRequest.m_requestParam); /* * There is only one quiet advertisement that needs to be done * automagically, and this is the daemon router advertisement we do based on * configuration. So, we take a peek at this configuration item and if it * is set, we go ahead and execute the DoStartListen to crank up a listener. * We actually start the quiet advertisement there in DoStartListen, after * we have a valid listener to respond to remote requests. Note that we are * just driving the start listen, and there is no quiet advertisement yet so * the corresponding must not yet be set. */ ConfigDB* config = ConfigDB::GetConfigDB(); uint32_t maxRemoteClients = config->GetLimit("max_remote_clients_udp", ALLJOYN_MAX_REMOTE_CLIENTS_UDP_DEFAULT); uint32_t maxUntrustedClients = config->GetLimit("max_untrusted_clients"); if (maxUntrustedClients) { QCC_LogError(ER_WARNING, ("UDPTransport::StartListenInstance(): The config option \"max_untrusted_clients\" has been deprecated.")); m_maxRemoteClientsUdp = maxUntrustedClients; } else { m_maxRemoteClientsUdp = maxRemoteClients; } m_maxRemoteClientsUdp = std::min(m_maxRemoteClientsUdp, (int32_t) m_maxConn); #if ADVERTISE_ROUTER_OVER_UDP m_routerName = config->GetProperty("router_advertisement_prefix", ALLJOYN_DEFAULT_ROUTER_ADVERTISEMENT_PREFIX); #endif if (m_isAdvertising || m_isDiscovering || (!m_routerName.empty() && (m_numUntrustedClients < m_maxRemoteClientsUdp))) { m_routerName.append(m_bus.GetInternal().GetGlobalGUID().ToShortString()); DoStartListen(listenRequest.m_requestParam); } DecrementAndFetch(&m_refCount); } void UDPTransport::StopListenInstance(ListenRequest& listenRequest) { IncrementAndFetch(&m_refCount); QCC_DbgTrace(("UDPTransport::StopListenInstance()")); /* * We have a new StopListen request, so we need to remove this * particular listen spec from our lists so it will not be * restarted. */ bool empty = NewListenOp(STOP_LISTEN, listenRequest.m_requestParam); /* * If we have just removed the last listener, we have a problem if we have * advertisements. This is because we will be advertising soon to be * non-existent endpoints. The question is, what do we want to do about it. * We could just ignore it since since clients receiving advertisements may * just try to connect to a non-existent endpoint and fail. It does seem * better to log an error and then cancel any outstanding advertisements * since they are soon to be meaningless. */ if (empty && m_isAdvertising) { QCC_LogError(ER_UDP_NO_LISTENER, ("UDPTransport::StopListenInstance(): No listeners with outstanding advertisements")); for (list::iterator i = m_advertising.begin(); i != m_advertising.end(); ++i) { IpNameService::Instance().CancelAdvertiseName(TRANSPORT_UDP, *i, TRANSPORT_UDP); } } /* * Execute the code that will actually tear down the specified * listening endpoint. Note that we always stop listening * immediately since that is Good (TM) from a power and CTS point of * view. We only delay starting to listen. */ DoStopListen(listenRequest.m_requestParam); DecrementAndFetch(&m_refCount); } void UDPTransport::EnableAdvertisementInstance(ListenRequest& listenRequest) { IncrementAndFetch(&m_refCount); QCC_DbgTrace(("UDPTransport::EnableAdvertisementInstance()")); /* * We have a new advertisement request to deal with. The first * order of business is to save the well-known name away for * use later. */ bool isFirst; NewAdvertiseOp(ENABLE_ADVERTISEMENT, listenRequest.m_requestParam, isFirst); /* * If it turned out that is the first advertisement on our list, we * need to prepare before actually doing the advertisement. */ if (isFirst) { /* * If we don't have any listeners up and running, we need to get them * up. If this is a Windows box, the listeners will start running * immediately and will never go down, so they may already be running. */ if (!m_isListening) { for (list::iterator i = m_listening.begin(); i != m_listening.end(); ++i) { QStatus status = DoStartListen(*i); if (ER_OK != status) { continue; } } } /* * We can only enable the requested advertisement if there is something * listening inbound connections on. Therefore, we should only enable * the name service if there is a listener. This catches the case where * there was no StartListen() done before the first advertisement. */ if (m_isListening) { if (!m_isNsEnabled) { IpNameService::Instance().Enable(TRANSPORT_UDP, std::map(), 0, m_listenPortMap, 0, false, false, true, false); m_isNsEnabled = true; } } } /* If we encounter the situation where there are no listeners it is * possible that we don't have any of the specified interfaces IFF_UP * yet. When those interfaces come up the backlog of advertisements * that came in will be processed. */ if (!m_isListening) { QCC_DbgPrintf(("UDPTransport::EnableAdvertisementInstance(): Advertise with no UDP listeners")); if (!m_pendingAdvertisements.empty()) { for (std::list::iterator it = m_pendingAdvertisements.begin(); it != m_pendingAdvertisements.end(); it++) { if (listenRequest.m_requestParam == it->m_requestParam) { DecrementAndFetch(&m_refCount); return; } } } m_pendingAdvertisements.push_back(listenRequest); DecrementAndFetch(&m_refCount); return; } /* * We think we're ready to send the advertisement. Are we really? */ assert(m_isListening); assert(!m_listenPortMap.empty()); assert(m_isNsEnabled); assert(IpNameService::Instance().Started() && "UDPTransport::EnableAdvertisementInstance(): IpNameService not started"); QStatus status = IpNameService::Instance().AdvertiseName(TRANSPORT_UDP, listenRequest.m_requestParam, listenRequest.m_requestParamOpt, listenRequest.m_requestTransportMask); if (status != ER_OK) { QCC_LogError(status, ("UDPTransport::EnableAdvertisementInstance(): Failed to advertise \"%s\"", listenRequest.m_requestParam.c_str())); } QCC_DbgPrintf(("UDPTransport::EnableAdvertisementInstance(): Done")); m_isAdvertising = true; DecrementAndFetch(&m_refCount); } void UDPTransport::DisableAdvertisementInstance(ListenRequest& listenRequest) { IncrementAndFetch(&m_refCount); QCC_DbgTrace(("UDPTransport::DisableAdvertisementInstance()")); /* * We have a new disable advertisement request to deal with. The first * order of business is to remove the well-known name from our saved list. */ bool isFirst; bool isEmpty = NewAdvertiseOp(DISABLE_ADVERTISEMENT, listenRequest.m_requestParam, isFirst); /* * We always cancel any advertisement to allow the name service to * send out its lost advertisement message. */ QStatus status = IpNameService::Instance().CancelAdvertiseName(TRANSPORT_UDP, listenRequest.m_requestParam, listenRequest.m_requestTransportMask); if (status != ER_OK) { QCC_LogError(status, ("UDPTransport::DisableAdvertisementInstance(): Failed to Cancel \"%s\"", listenRequest.m_requestParam.c_str())); } /* We check to make sure that this cancellation is not for an * advertisement that has not yet gone into effect because we * are still waiting on the specified network interface to * become IFF_UP. We don't want to send out advertisements * whenever the interface comes up. If this is the last * advertisement and we are no longer discovering we should * not start listening when the interface comes up. */ if (!m_pendingAdvertisements.empty()) { for (std::list::iterator it = m_pendingAdvertisements.begin(); it != m_pendingAdvertisements.end(); it++) { if (listenRequest.m_requestParam == it->m_requestParam) { m_pendingAdvertisements.erase(it); break; } } } /* * If it turns out that this was the last advertisement on our list, we need * to think about disabling our listeners and turning off the name service. * We only to this if there are no discovery instances in progress. */ if (isEmpty && !m_isDiscovering) { /* * Since the cancel advertised name has been sent, we can disable the * name service. We do this by telling it we don't want it to be * enabled on any of the possible ports. */ IpNameService::Instance().Enable(TRANSPORT_UDP, std::map(), 0, m_listenPortMap, 0, false, false, false, false); m_isNsEnabled = false; /* * If we had the name service running, we must have had listeners * waiting for connections due to the name service. We need to stop * them all now, but only if we are not running on a Windows box. * Windows needs the listeners running at all times since it uses * UDP for the client to daemon connections. The listen spec may * involve network interfaces or IP addresses and we need to do * some translation from a specified network interface to the * corresponding IP address. */ for (list::iterator i = m_listening.begin(); i != m_listening.end(); ++i) { map argMap; qcc::String spec; QStatus status = NormalizeListenSpec(i->c_str(), spec, argMap); assert(status == ER_OK && "UDPTransport::DisableAdvertisementInstance(): Invalid UDP listen spec"); QCC_UNUSED(status); if (argMap.find("iface") != argMap.end()) { qcc::String interface = argMap["iface"]; qcc::String normSpec = "udp:addr=" + m_requestedInterfaces[interface].GetAddress().ToString() + ",port=" + U32ToString(m_requestedInterfaces[interface].GetPort()); DoStopListen(normSpec); } else if (argMap.find("addr") != argMap.end()) { DoStopListen(*i); } } m_isListening = false; m_listenPortMap.clear(); m_pendingDiscoveries.clear(); m_pendingAdvertisements.clear(); m_wildcardIfaceProcessed = false; } if (isEmpty) { m_isAdvertising = false; } DecrementAndFetch(&m_refCount); } void UDPTransport::EnableDiscoveryInstance(ListenRequest& listenRequest) { IncrementAndFetch(&m_refCount); QCC_DbgTrace(("UDPTransport::EnableDiscoveryInstance()")); /* * We have a new discovery request to deal with. The first * order of business is to save the well-known name away for * use later. */ bool isFirst; NewDiscoveryOp(ENABLE_DISCOVERY, listenRequest.m_requestParam, isFirst); /* * If it turned out that is the first discovery request on our list, we need * to prepare before actually doing the discovery. */ if (isFirst) { /* * If we don't have any listeners up and running, we need to get them * up. If this is a Windows box, the listeners will start running * immediately and will never go down, so they may already be running. * However, we only set up the m_listenPortMap (a map of the network * interfaces to the corresponding ports on which we are listening) * when we are sure that the specified network interfaces are IFF_UP. */ if (!m_isListening) { for (list::iterator i = m_listening.begin(); i != m_listening.end(); ++i) { QStatus status = DoStartListen(*i); if (ER_OK != status) { continue; } } } /* * We can only enable the requested advertisement if there is something * listening inbound connections on. Therefore, we should only enable * the name service if there is a listener. This catches the case where * there was no StartListen() done before the first discover. */ if (m_isListening) { if (!m_isNsEnabled) { IpNameService::Instance().Enable(TRANSPORT_UDP, std::map(), 0, m_listenPortMap, 0, false, false, true, false); m_isNsEnabled = true; } } } /* If we encounter the situation where there are no listeners it is * possible that we don't have any of the specified interfaces IFF_UP * yet, when those interfaces come up the backlog of discoveries * that came in will be processed. */ if (!m_isListening) { QCC_DbgPrintf(("UDPTransport::EnableDiscoveryInstance(): Discover with no UDP listeners")); if (!m_pendingDiscoveries.empty()) { for (std::list::iterator it = m_pendingDiscoveries.begin(); it != m_pendingDiscoveries.end(); it++) { if (listenRequest.m_requestParam == it->m_requestParam) { DecrementAndFetch(&m_refCount); return; } } } m_pendingDiscoveries.push_back(listenRequest); DecrementAndFetch(&m_refCount); return; } /* * We think we're ready to send the FindAdvertisement. Are we really? */ assert(m_isListening); assert(!m_listenPortMap.empty()); assert(m_isNsEnabled); assert(IpNameService::Instance().Started() && "UDPTransport::EnableDiscoveryInstance(): IpNameService not started"); QStatus status = IpNameService::Instance().FindAdvertisement(TRANSPORT_UDP, listenRequest.m_requestParam, listenRequest.m_requestTransportMask); if (status != ER_OK) { QCC_LogError(status, ("UDPTransport::EnableDiscoveryInstance(): Failed to begin discovery with multicast NS \"%s\"", listenRequest.m_requestParam.c_str())); } m_isDiscovering = true; DecrementAndFetch(&m_refCount); } void UDPTransport::DisableDiscoveryInstance(ListenRequest& listenRequest) { IncrementAndFetch(&m_refCount); QCC_DbgTrace(("UDPTransport::DisableDiscoveryInstance()")); /* * We have a new disable discovery request to deal with. The first * order of business is to remove the well-known name from our saved list. */ bool isFirst; bool isEmpty = NewDiscoveryOp(DISABLE_DISCOVERY, listenRequest.m_requestParam, isFirst); if (m_isListening && !m_listenPortMap.empty() && m_isNsEnabled && IpNameService::Instance().Started()) { QStatus status = IpNameService::Instance().CancelFindAdvertisement(TRANSPORT_UDP, listenRequest.m_requestParam, listenRequest.m_requestTransportMask); if (status != ER_OK) { QCC_LogError(status, ("UDPTransport::DisableDiscoveryInstance(): Failed to cancel discovery with \"%s\"", listenRequest.m_requestParam.c_str())); } } if (!m_pendingDiscoveries.empty()) { for (std::list::iterator it = m_pendingDiscoveries.begin(); it != m_pendingDiscoveries.end(); it++) { if (listenRequest.m_requestParam == it->m_requestParam) { m_pendingDiscoveries.erase(it); break; } } } /* * If it turns out that this was the last discovery operation on * our list, we need to think about disabling our listeners and turning off * the name service. We only to this if there are no advertisements in * progress. */ if (isEmpty && !m_isAdvertising) { IpNameService::Instance().Enable(TRANSPORT_UDP, std::map(), 0, m_listenPortMap, 0, false, false, false, false); m_isNsEnabled = false; /* * If we had the name service running, we must have had listeners * waiting for connections due to the name service. We need to stop * them all now, but only if we are not running on a Windows box. * Windows needs the listeners running at all times since it uses * UDP for the client to daemon connections. The listen spec may * involve network interfaces or IP addresses and we need to do * some translation from a specified network interface to the * corresponding IP address. */ for (list::iterator i = m_listening.begin(); i != m_listening.end(); ++i) { map argMap; qcc::String spec; QStatus status = NormalizeListenSpec(i->c_str(), spec, argMap); assert(status == ER_OK && "UDPTransport::DisableDiscoveryInstance(): Invalid UDP listen spec"); QCC_UNUSED(status); if (argMap.find("iface") != argMap.end()) { qcc::String interface = argMap["iface"]; qcc::String normSpec = "udp:addr=" + m_requestedInterfaces[interface].GetAddress().ToString() + ",port=" + U32ToString(m_requestedInterfaces[interface].GetPort()); DoStopListen(normSpec); } else if (argMap.find("addr") != argMap.end()) { DoStopListen(*i); } } m_isListening = false; m_listenPortMap.clear(); m_pendingDiscoveries.clear(); m_pendingAdvertisements.clear(); m_wildcardIfaceProcessed = false; } if (isEmpty) { m_isDiscovering = false; } DecrementAndFetch(&m_refCount); } bool UDPTransport::EnableRouterAdvertisement() { if (m_routerNameAdvertised == false && !m_routerName.empty() && m_numUntrustedClients < m_maxRemoteClientsUdp && (m_maxAuth - m_currAuth) > 0 && (m_maxConn - m_currConn) > 0) { return true; } return false; } bool UDPTransport::DisableRouterAdvertisement() { if (m_routerNameAdvertised == true && !m_routerName.empty() && ((m_numUntrustedClients >= m_maxRemoteClientsUdp) || (m_maxAuth - m_currAuth <= 0) || (m_maxConn - m_currConn <= 0))) { return true; } return false; } void UDPTransport::UpdateDynamicScoreInstance(ListenRequest& listenRequest) { QCC_UNUSED(listenRequest); uint32_t availConn = m_maxConn - m_currConn; uint32_t availRemoteClientsUdp = m_maxRemoteClientsUdp - m_numUntrustedClients; availRemoteClientsUdp = std::min(availRemoteClientsUdp, availConn); IpNameService::Instance().UpdateDynamicScore(TRANSPORT_UDP, availConn, m_maxConn, availRemoteClientsUdp, m_maxRemoteClientsUdp); } /* * The default address for use in listen specs. INADDR_ANY means to listen * for UDP connections on any interfaces that are currently up or any that may * come up in the future. */ static const char* ADDR4_DEFAULT = "0.0.0.0"; /* * The default port for use in listen specs. */ static const uint16_t PORT_DEFAULT = 9955; QStatus UDPTransport::NormalizeListenSpec(const char* inSpec, qcc::String& outSpec, map& argMap) const { qcc::String family; /* * We don't make any calls that require us to be in any particular state * with respect to threading so we don't bother to call IsRunning() here. * * Take the string in inSpec, which must start with "udp:" and parse it, * looking for comma-separated "key=value" pairs and initialize the * argMap with those pairs. * * There are lots of legal possibilities for an IP-based transport, but * all we are going to recognize is the "reliable IPv4 mechanism" and * so we will summarily pitch everything else. * * We expect to end up with a normalized outSpec that looks something * like: * * "udp:addr=0.0.0.0,port=9955" * * That's all. We still allow "addr=0.0.0.0,port=9955,family=ipv4" but * ignore family. */ QStatus status = ParseArguments(GetTransportName(), inSpec, argMap); if (status != ER_OK) { return status; } map::iterator iter; /* * We just ignore the family since ipv4 was the only possibld working choice. */ iter = argMap.find("family"); if (iter != argMap.end()) { argMap.erase(iter); } /* * Transports, by definition, may support reliable Ipv4, unreliable IPv4, * reliable IPv6 and unreliable IPv6 mechanisms to move bits. In this * incarnation, the UDP transport will only support unrreliable IPv4; so we * log errors and ignore any requests for other mechanisms. */ iter = argMap.find("r4addr"); if (iter != argMap.end()) { QCC_LogError(ER_BUS_BAD_TRANSPORT_ARGS, ("UDPTransport::NormalizeListenSpec(): The mechanism implied by \"r4addr\" is not supported")); argMap.erase(iter); } iter = argMap.find("r4port"); if (iter != argMap.end()) { QCC_LogError(ER_BUS_BAD_TRANSPORT_ARGS, ("UDPTransport::NormalizeListenSpec(): The mechanism implied by \"r4port\" is not supported")); argMap.erase(iter); } iter = argMap.find("r6addr"); if (iter != argMap.end()) { QCC_LogError(ER_BUS_BAD_TRANSPORT_ARGS, ("UDPTransport::NormalizeListenSpec(): The mechanism implied by \"r6addr\" is not supported")); argMap.erase(iter); } iter = argMap.find("r6port"); if (iter != argMap.end()) { QCC_LogError(ER_BUS_BAD_TRANSPORT_ARGS, ("UDPTransport::NormalizeListenSpec(): The mechanism implied by \"r6port\" is not supported")); argMap.erase(iter); } iter = argMap.find("u6addr"); if (iter != argMap.end()) { QCC_LogError(ER_BUS_BAD_TRANSPORT_ARGS, ("UDPTransport::NormalizeListenSpec(): The mechanism implied by \"u6addr\" is not supported")); argMap.erase(iter); } iter = argMap.find("u6port"); if (iter != argMap.end()) { QCC_LogError(ER_BUS_BAD_TRANSPORT_ARGS, ("UDPTransport::NormalizeListenSpec(): The mechanism implied by \"u6port\" is not supported")); argMap.erase(iter); } /* * Now, begin normalizing what we want to see in a listen spec. * * All listen specs must start with the name of the transport followed by * a colon. */ outSpec = GetTransportName() + qcc::String(":"); /* * The UDP transport must absolutely support the IPv4 "unreliable" mechanism * (UDP). We therefore must provide an addr either from explicit keys or * generated from the defaults. */ iter = argMap.find("iface"); /* * Now, deal with the iface. */ if (iter != argMap.end()) { outSpec.append("iface=" + iter->second); } else { iter = argMap.find("addr"); if (iter == argMap.end()) { /* * We have no value associated with an "addr" key. Do we have an * "u4addr" which would be synonymous? If so, save it as an addr, * erase it and point back to the new addr. */ iter = argMap.find("u4addr"); if (iter != argMap.end()) { argMap["addr"] = iter->second; argMap.erase(iter); } iter = argMap.find("addr"); } /* * Now, deal with the addr, possibly derived from u4addr. */ if (iter != argMap.end()) { /* * We have a value associated with the "addr" key. Run it through a * conversion function to make sure it's a valid value and to get into * in a standard representation. */ IPAddress addr; status = addr.SetAddress(iter->second, false); if (status == ER_OK) { /* * The addr had better be an IPv4 address, otherwise we bail. */ if (!addr.IsIPv4()) { QCC_LogError(ER_BUS_BAD_TRANSPORT_ARGS, ("UDPTransport::NormalizeListenSpec(): The addr \"%s\" is not a legal IPv4 address.", iter->second.c_str())); return ER_BUS_BAD_TRANSPORT_ARGS; } iter->second = addr.ToString(); outSpec.append("addr=" + addr.ToString()); } else { QCC_LogError(ER_BUS_BAD_TRANSPORT_ARGS, ("UDPTransport::NormalizeListenSpec(): The addr \"%s\" is not a legal IPv4 address.", iter->second.c_str())); return ER_BUS_BAD_TRANSPORT_ARGS; } } } if (iter == argMap.end()) { /* * We have no value associated with an "iface" or "addr" key. Use the default * network interface name for the outspec and create a new key for the map. */ outSpec.append("iface=" + qcc::String(INTERFACES_DEFAULT)); argMap["iface"] = INTERFACES_DEFAULT; } /* * The UDP transport must absolutely support the IPv4 "unreliable" mechanism * (UDP). We therefore must provide a port either from explicit keys or * generated from the defaults. */ iter = argMap.find("port"); if (iter == argMap.end()) { /* * We have no value associated with a "port" key. Do we have a * "u4port" which would be synonymous? If so, save it as a port, * erase it and point back to the new port. */ iter = argMap.find("u4port"); if (iter != argMap.end()) { argMap["port"] = iter->second; argMap.erase(iter); } iter = argMap.find("port"); } /* * Now, deal with the port. */ if (iter != argMap.end()) { /* * We have a value associated with the "port" key. Run it through a * conversion function to make sure it's a valid value. We put it into * a 32 bit int to make sure it will actually fit into a 16-bit port * number. */ uint32_t port = StringToU32(iter->second); if (port <= 0xffff) { outSpec.append(",port=" + iter->second); } else { QCC_LogError(ER_BUS_BAD_TRANSPORT_ARGS, ("UDPTransport::NormalizeListenSpec(): The key \"port\" has a bad value \"%s\"", iter->second.c_str())); return ER_BUS_BAD_TRANSPORT_ARGS; } } else { /* * We have no value associated with an "port" key. Use the default * IPv4 listen port for the outspec and create a new key for the map. */ qcc::String portString = U32ToString(PORT_DEFAULT); outSpec += ",port=" + portString; argMap["port"] = portString; } return ER_OK; } QStatus UDPTransport::NormalizeTransportSpec(const char* inSpec, qcc::String& outSpec, map& argMap) const { QCC_DbgTrace(("UDPTransport::NormalizeTransportSpec()")); QStatus status; /* * Aside from the presence of the guid, the only fundamental difference * between a listenSpec and a transportSpec (actually a connectSpec) is that * a connectSpec must have a valid and specific address IP address to * connect to (i.e., INADDR_ANY isn't a valid IP address to connect to). * This means that we can just call NormalizeListenSpec to get everything * into standard form. */ status = NormalizeListenSpec(inSpec, outSpec, argMap); if (status != ER_OK) { return status; } /* * Since there is no guid present if we've fallen through to here, the only * difference between a connectSpec and a listenSpec is that a connectSpec * requires the presence of a non-default IP address. So we just check for * the default addresses and fail if we find one. */ map::iterator i = argMap.find("addr"); assert(i != argMap.end()); if ((i->second == ADDR4_DEFAULT)) { QCC_LogError(ER_BUS_BAD_TRANSPORT_ARGS, ("UDPTransport::NormalizeTransportSpec(): The addr may not be the default address")); return ER_BUS_BAD_TRANSPORT_ARGS; } return ER_OK; } /** * This is the method that is called in order to initiate an outbound (active) * connection. This is called from the AllJoyn Object in the course of * processing a JoinSession request in the context of a JoinSessionThread. */ QStatus UDPTransport::Connect(const char* connectSpec, const SessionOpts& opts, BusEndpoint& newEp) { IncrementAndFetch(&m_refCount); QCC_DbgTrace(("UDPTransport::Connect(connectSpec=%s, opts=%p, newEp-%p)", connectSpec, &opts, &newEp)); /* * We are given a session options structure that defines the kind of * connection that is being sought. Can we support the connection being * requested? If not, don't even try. */ if (SupportsOptions(opts) == false) { QStatus status = ER_BUS_BAD_SESSION_OPTS; QCC_LogError(status, ("UDPTransport::Connect(): Supported options mismatch")); DecrementAndFetch(&m_refCount); return status; } /* * We only want to allow this call to proceed if we have a running server * accept thread that isn't in the process of shutting down. We use the * thread response from IsRunning to give us an idea of what our server * accept (Run) thread is doing. See the comment in Start() for details * about what IsRunning actually means, which might be subtly different from * your intuitition. * * If we see IsRunning(), the thread might actually have gotten a Stop(), * but has not yet exited its Run routine and become STOPPING. To plug this * hole, we need to check IsRunning() and also m_stopping, which is set in * our Stop() method. */ if (IsRunning() == false || m_stopping == true) { QCC_LogError(ER_BUS_TRANSPORT_NOT_STARTED, ("UDPTransport::Connect(): Not running or stopping; exiting")); DecrementAndFetch(&m_refCount); return ER_BUS_TRANSPORT_NOT_STARTED; } /* * If we pass the IsRunning() gate above, we must have a server accept * thread spinning up or shutting down but not yet joined. Since the name * service is started before the server accept thread is spun up, and * deleted after it is joined, we must have a started name service or someone * isn't playing by the rules; so an assert is appropriate here. */ assert(IpNameService::Instance().Started() && "UDPTransport::Connect(): IpNameService not started"); /* * UDP Transport does not support raw sockets of any flavor. */ QStatus status; if (opts.traffic & SessionOpts::TRAFFIC_RAW_RELIABLE || opts.traffic & SessionOpts::TRAFFIC_RAW_UNRELIABLE) { status = ER_UDP_UNSUPPORTED; QCC_LogError(status, ("UDPTransport::Connect(): UDP Transport does not support raw traffic")); DecrementAndFetch(&m_refCount); return status; } /* * Parse and normalize the connectArgs. When connecting to the outside * world, there are no reasonable defaults and so the addr and port keys * MUST be present. */ qcc::String normSpec; map argMap; status = NormalizeTransportSpec(connectSpec, normSpec, argMap); if (ER_OK != status) { QCC_LogError(status, ("UDPTransport::Connect(): Invalid UDP connect spec \"%s\"", connectSpec)); DecrementAndFetch(&m_refCount); return status; } /* * These fields (addr, port) are all guaranteed to be present now and an * underlying network (even if it is Wi-Fi P2P) is assumed to be up and * functioning. */ assert(argMap.find("addr") != argMap.end() && "UDPTransport::Connect(): addr not present in argMap"); assert(argMap.find("port") != argMap.end() && "UDPTransport::Connect(): port not present in argMap"); IPAddress ipAddr(argMap.find("addr")->second); uint16_t ipPort = StringToU32(argMap["port"]); #ifndef NDEBUG if (ipAddr.IsLoopback()) { QCC_DbgPrintf(("UDPTransport::Connect(): \"%s\" is a loopback address", ipAddr.ToString().c_str())); } #endif /* * The semantics of the Connect method tell us that we want to connect to a * remote daemon. UDP will happily allow us to connect to ourselves, but * this is not always possible in the various transports AllJoyn may use. * To avoid unnecessary differences, we do not allow a requested connection * to "ourself" to succeed. * * The code here is not a failsafe way to prevent this since thre are going * to be multiple processes involved that have no knowledge of what the * other is doing (for example, the wireless supplicant and this daemon). * This means we can't synchronize and there will be race conditions that * can cause the tests for selfness to fail. The final check is made in the * BusHello protocol, which will abort the connection if it detects it is * conected to itself. We just attempt to short circuit the process where * we can and not allow connections to proceed that will be bound to fail. * * One defintion of a connection to ourself is if we find that a listener * has has been started via a call to our own StartListener() with the same * connectSpec as we have now. This is the simple case, but it also turns * out to be the uncommon case. * * It is perfectly legal to start a listener using the INADDR_ANY address, * which tells the system to listen for connections on any network interface * that happens to be up or that may come up in the future. This is the * default listen address and is the most common case. If this option has * been used, we expect to find a listener with a normalized adresss that * looks like "addr=0.0.0.0,port=y". If we detect this kind of connectSpec * we have to look at the currently up interfaces and see if any of them * match the address provided in the connectSpec. If so, we are attempting * to connect to ourself and we must fail that request. */ char anyspec[64]; snprintf(anyspec, sizeof(anyspec), "%s:addr=0.0.0.0,port=%u", GetTransportName(), ipPort); qcc::String normAnySpec; map normArgMap; status = NormalizeListenSpec(anyspec, normAnySpec, normArgMap); if (ER_OK != status) { QCC_LogError(status, ("UDPTransport::Connect(): Invalid INADDR_ANY connect spec")); DecrementAndFetch(&m_refCount); return status; } /* * Look to see if we are already listening on the provided connectSpec * explicitly. If we see that we are listening on the INADDR_ANY address * make a note of it. We sort that out in the next bit of code. */ QCC_DbgPrintf(("UDPTransport::Connect(): Checking for connection to self (\"%s\"", normSpec.c_str())); m_listenFdsLock.Lock(MUTEX_CONTEXT); bool anyEncountered = false; for (list >::iterator i = m_listenFds.begin(); i != m_listenFds.end(); ++i) { QCC_DbgPrintf(("UDPTransport::Connect(): Checking listenSpec %s", i->first.c_str())); /* * If the provided connectSpec is already explicitly listened to, it is * an error. */ if (i->first == normSpec) { m_listenFdsLock.Unlock(MUTEX_CONTEXT); QCC_DbgPrintf(("UDPTransport::Connect(): Explicit connection to self")); DecrementAndFetch(&m_refCount); return ER_BUS_ALREADY_LISTENING; } /* * If we are listening to INADDR_ANY and the supplied port, then we have * to take a closer look to decide if this call is bogus or not. Set a * flag to remind us. */ if (i->first == normAnySpec) { QCC_DbgPrintf(("UDPTransport::Connect(): Possible implicit connection to self detected")); anyEncountered = true; } } m_listenFdsLock.Unlock(MUTEX_CONTEXT); std::vector entries; status = qcc::IfConfig(entries); if (ER_OK != status) { QCC_LogError(status, ("UDPTransport::Connect(): Unable to read network interface configuration")); DecrementAndFetch(&m_refCount); return status; } /* * If we are listening to INADDR_ANY, we are going to have to see if any * currently UP interfaces have an IP address that matches the connectSpec * addr. */ if (anyEncountered) { /* * If anyEncountered is set to true, it means we discovered an INADDR_ANY listen spec with * a specified port that matches the one in the connect spec. We have to make sure * that we are not connecting to this INADDR_ANY listener through a loopback address. */ QCC_DbgPrintf(("UDPTransport::Connect(): Checking for implicit connection to self through loopback")); if (ipAddr.IsLoopback()) { QCC_DbgPrintf(("UDPTransport::Connect(): Attempted connection to self through loopback; exiting")); DecrementAndFetch(&m_refCount); return ER_BUS_ALREADY_LISTENING; } /* * Loop through the network interface entries looking for an UP * interface that has the same IP address as the one we're trying to * connect to. We know any match on the address will be a hit since we * matched the port during the listener check above. Since we have a * listener listening on *any* UP interface on the specified port, a * match on the interface address with the connect address is a hit. */ QCC_DbgPrintf(("UDPTransport::Connect(): Checking for implicit connection to self through INADDR_ANY")); for (uint32_t i = 0; i < entries.size(); ++i) { QCC_DbgPrintf(("UDPTransport::Connect(): Checking interface %s", entries[i].m_name.c_str())); if (entries[i].m_flags & qcc::IfConfigEntry::UP) { QCC_DbgPrintf(("UDPTransport::Connect(): Interface UP with addresss %s", entries[i].m_addr.c_str())); IPAddress foundAddr(entries[i].m_addr); if (foundAddr == ipAddr) { QCC_DbgPrintf(("UDPTransport::Connect(): Attempted connection to self; exiting")); DecrementAndFetch(&m_refCount); return ER_BUS_ALREADY_LISTENING; } } } } /* * Now, we have to figure out which socket to use for the connect. In the * TCP Transport we would typcially create a new socket here; but we want to * re-use an existing socket to save resources. * * In the Routing Node configuration, we expect to see some number of listen * specs. TCP interprets these as having IP addresses or interfaces and * ports on which we want to listen for incoming connections. In the UDP * Transport, we create a socket for each of these interfaces and listen for * incoming UDP datagrams on them. Currently, the only configuration used * is one listen spec that specifies INADDR_ANY (accept datagrams from all * interfaces). There is the possibility that multiple listen specs could * be used to bind only to specific interfaces, though. While we aren't * listening for inbound connections as TCP would, the effect is the same. * The action we take should therefore be conceptually similar to what TCP * would do. * * There are therefore two cases to consider: First, if there is a socket * bound to INADDR_ANY (which means that we got a listen on 0.0.0.0); and * second, there are possibly multiple sockets bound to specific addresses. * The upshot is that if we have a listening socket bound to INADDR_ANY we * just use it. If we don't listen to INADDR_ANY we look for a socket bound * to an IP address that puts it on the same network as the destination * specified for the connect. We don't actually have to do that since UDP * will route to the correct outgoing interface, but we keep the coherency * to avoid nasty surprises. * * Note: There is a check for INADDR_ANY above, but that is a check to make * sure we don't connect to ourselves inadvertently -- it includes the port * number so it is not a generic test for interface. Below, we are checking * to see if any of our sockets is bound to INADDR_ANY irrespective of port. */ qcc::SocketFd sock = 0; bool foundSock = false; QCC_DbgPrintf(("UDPTransport::Connect(): Look for socket corresponding to destination network")); m_listenFdsLock.Lock(MUTEX_CONTEXT); for (list >::iterator i = m_listenFds.begin(); i != m_listenFds.end(); ++i) { /* * Get the local address of the socket in question. */ IPAddress listenAddr; uint16_t listenPort; qcc::GetLocalAddress(i->second, listenAddr, listenPort); QCC_DbgPrintf(("UDPTransport::Connect(): Check out local address \"%s\"", listenAddr.ToString().c_str())); /* * If we encounter a socket bound to INADDR_ANY, we use it per the * simple "rules" above. */ if (listenAddr.ToString() == "0.0.0.0") { sock = i->second; foundSock = true; QCC_DbgPrintf(("UDPTransport::Connect(): Found socket (%d.) listening on INADDR_ANY", sock)); break; } /* * If this isn't a socket bound to INADDR_ANY it must be bound to a * specific interface. Find the corresponding interface information in * the IfConfig entries. We need the network mask from that entry so we * can see if the network numbers match. * * TODO: what if we have multiple interfaces with the same network * number i.e. 192.168.1.x? The advertisement will have come in over * one of them but we lose track of the source of the advertisement that * precipitated the JoinSession that got us here. We need to remember * that info (perhaps as a "zone index" equivalent) in the connect spec, * but that has to be plumbed in from the name service and allowed all * the way up into the AllJoyn obj and back down! */ uint32_t prefixLen = 0; for (uint32_t j = 0; j < entries.size(); ++j) { if (entries[j].m_addr == listenAddr.ToString()) { prefixLen = entries[j].m_prefixlen; } } QCC_DbgPrintf(("UDPTransport::Connect(): prefixlen=%d.", prefixLen)); /* * Create a netmask with a one in the leading bits for each position * implied by the prefix length. */ uint32_t mask = 0; for (uint32_t j = 0; j < prefixLen; ++j) { mask >>= 1; mask |= 0x80000000; } QCC_DbgPrintf(("UDPTransport::Connect(): net mask is 0x%x", mask)); /* * Is local address of the currently indexed listenFd on the same * network as the destination address supplied as a parameter to the * connect? If so, we use this listenFD as the socket to use when we * try to connect to the remote daemon. */ uint32_t network1 = listenAddr.GetIPv4AddressCPUOrder() & mask; uint32_t network2 = ipAddr.GetIPv4AddressCPUOrder() & mask; if (network1 == network2) { QCC_DbgPrintf(("UDPTransport::Connect(): network \"%s\" matches network \"%s\"", IPAddress(network1).ToString().c_str(), IPAddress(network2).ToString().c_str())); /* * Mark the socket as found, but don't break here in case there is a * socket bound to INADDR_ANY that happens to be later in the list. * We prefer to use that one since we assume a user configured it in * order to be more generic. We do the break there so that generic * choice other specific choices. */ sock = i->second; foundSock = true; } else { QCC_DbgPrintf(("UDPTransport::Connect(): network \"%s\" does not match network \"%s\"", IPAddress(network1).ToString().c_str(), IPAddress(network2).ToString().c_str())); } } m_listenFdsLock.Unlock(MUTEX_CONTEXT); if (foundSock == false) { status = ER_UDP_NO_NETWORK; QCC_LogError(status, ("UDPTransport::Connect(): Not listening on network implied by \"%s\"", ipAddr.ToString().c_str())); DecrementAndFetch(&m_refCount); return status; } #ifndef NDEBUG else { QCC_DbgPrintf(("UDPTransport::Connect(): Socket %d. talks to network implied by \"%s\"", sock, normSpec.c_str())); } #endif /* * We've done the basic homework to see if this is a reasonable request. * Now we need to make sure that we have the resources to allow the connect * to succeed. Specifically, we need to check to see if the connection * limits will be violated if we proceed. */ m_connLock.Lock(MUTEX_CONTEXT); if (m_currAuth + 1U > m_maxAuth || m_currConn + 1U > m_maxConn) { status = ER_CONNECTION_LIMIT_EXCEEDED; QCC_LogError(status, ("UDPTransport::Connect(): No slot for new connection")); m_connLock.Unlock(MUTEX_CONTEXT); DecrementAndFetch(&m_refCount); return status; } ++m_currAuth; ++m_currConn; m_connLock.Unlock(MUTEX_CONTEXT); QCC_DbgPrintf(("UDPTransport::Connect(): Compose BusHello")); Message hello(m_bus); /* Send value SLS_NAMES(also value of older DAEMON_NAMES) for SLS_NAMES, * ALL_NAMES for other types. * These are the older values of nameTransfer to be sent in BusHello. */ status = hello->HelloMessage(true, m_bus.GetInternal().AllowRemoteMessages(), (opts.nameTransfer == SessionOpts::SLS_NAMES) ? SessionOpts::SLS_NAMES : SessionOpts::ALL_NAMES); if (status != ER_OK) { status = ER_UDP_BUSHELLO; QCC_LogError(status, ("UDPTransport::Connect(): Can't make a BusHello Message")); m_connLock.Lock(MUTEX_CONTEXT); --m_currAuth; --m_currConn; m_connLock.Unlock(MUTEX_CONTEXT); DecrementAndFetch(&m_refCount); return status; } /* * The Function HelloMessage creates and marshals the BusHello Message for * the remote side. Once it is marshaled, there is a buffer associated with * the message that contains the on-the-wire version of the messsage. */ size_t buflen = hello->GetBufferSize(); #ifndef NDEBUG uint8_t* buf = new uint8_t[buflen + SEAL_SIZE]; SealBuffer(buf + buflen); #else uint8_t* buf = new uint8_t[buflen]; #endif memcpy(buf, const_cast(hello->GetBuffer()), buflen); /* * We are about to get into a state where we are off trying to start up an * endpoint, but we are executing in the context of an arbitrary thread that * has called into UDPTransport::Connect(). We want to block this thread, * but we will be needing to wake it up when the connection process * completes and also up in case the UDP transport is shut down during the * connection process. We need the ArdpConnRecord* in order to associate * the current thread and the event we'll be using with the connection * completion callback that will happen. * * As soon as we call ARDP_Connect() we are enabling the callback to happen, * but we don't have the ArdpConnRecord* we need until after ARDP_Connect() * returns. In order to keep the connect callback from happening, we take * the ARDP lock which prevents the callback from being run and we don't * give it back until we have the ArdpConnRecord* stashed away in a place * where it can be found by the callback. * * N.B. The event in question *must* remain in scope and valid during the * entire time the ConnectEntry we're about to make is on the set we're * about to put it on. */ qcc::Event event; ArdpConnRecord* conn; /* * We need to take the endpoint list lock which is going to protect the * std::set of entries identifying the connecting thread; and we need to * take the ARDP lock to hold off the callback. When holding two locks, * always consider lock order. Unfortunately, it is a common operation * for an external thread to take the endpoint lock, wander around in the * endpoints and figure out what to do then take the ARDP lock in order * to do it. It's also a common operation for our main thread to take the * ARDP lock and call into ARDP which calls out in a callback * and We'll keep that order. */ m_endpointListLock.Lock(MUTEX_CONTEXT); m_ardpLock.Lock(); QCC_DbgPrintf(("UDPTransport::Connect(): ARDP_Connect()")); status = ARDP_Connect(m_handle, sock, ipAddr, ipPort, m_ardpConfig.segmax, m_ardpConfig.segbmax, &conn, buf, buflen, &event); /* * The ARDP code takes the hello buffer and copies it into its internal * retry buffer, so we are responsible for disposition of the buffer no * matter if the connect succeeds or fails. */ delete[] buf; buf = NULL; /* * If the ARDP_Connect fails, we haven't started the connection process, so * we haven't passed responsibility for the connection counts off to the * callback (see note below). */ if (status != ER_OK) { assert(conn == NULL && "UDPTransport::Connect(): ARDP_Connect() failed but returned ArdpConnRecord"); QCC_LogError(status, ("UDPTransport::Connect(): ARDP_Connect() failed")); m_ardpLock.Unlock(); m_endpointListLock.Unlock(MUTEX_CONTEXT); m_connLock.Lock(MUTEX_CONTEXT); --m_currAuth; --m_currConn; m_connLock.Unlock(MUTEX_CONTEXT); DecrementAndFetch(&m_refCount); return status; } /* * Important note: Once we make a successful call to ARDP_Connect, we are * transferring responsibility for managing the connection limit counters to * the callback. If ARDP accepts the connection request it guarantees that * it will call back with status, and so we rely on that guarantee to manage * the counters in one place -- the callback. That means that we are no * longer allowed to touch the counters. Especially do not decrement them * if a future error is detected. The slots are occupied until the callback * responds either positively or negatively. */ Thread* thread = GetThread(); QCC_DbgPrintf(("UDPTransport::Connect(): Add thread=%p to m_connectThreads", thread)); assert(thread && "UDPTransport::Connect(): GetThread() returns NULL"); uint32_t cid = ARDP_GetConnId(m_handle, conn); ConnectEntry entry(thread, conn, cid, &event); /* * It looks like we just did a connect and so if it succeeded, we must have * a valid connection and connection ID. Time has passed between the time * we did the ARDP_Connect() and now, though. We must consider what might * happen if it turns out that ARDP has decided to invalidate the connection * now that it is off trying to connect. It guarantees that it will call * back with that connection when it is done trying to connect. What if * that already happened and we haven't had a chance to get our thread onto * the list of waiting threads. Admittedly, the chances of that happening * are extrememly low, but we can't get the conn until we do the connect and * the connection (actually ID) is all we have to tie the threads to the * connection process. Since this is such a wildly unlikely event, we don't * do anything to catch it, just describe why it will not hurt. * * If we are delayed inserting our thread on the list of waiting threads * until after the callback happens, the callback will have not been able to * find our thread and will have exited without doing anything, or at worst * it may have created an endpoint and then stopped it. No harm no foul. * This endpoint will be cleaned up by the endpoint manager. If the * connection is invalid by the time we create the ConnectEntry above, we * will create an entry with the connection ID set to ARDP_CONN_ID_INVALID. * In this case, we will insert an entry on the list which can never be * found. We will time out below. We'll remove the entry by finding what * we put in, which includes the inavlid conn ID. No harm no foul. There * is an extremely unlikely chance that we may do some work that could * strictly have been avoided if we went to some lengths here. */ m_connectThreads.insert(entry); /* * If we do something that is going to bug the ARDP protocol (in this case * start connect timers), we need to call back into ARDP ASAP to get it * moving. */ Alert(); /* * All done with the tricky part, so release the locks in inverse order */ m_ardpLock.Unlock(); m_endpointListLock.Unlock(MUTEX_CONTEXT); /* * Set up a watchdog timeout on the connect. If the other side plays by the * rules, we should get a callback. If there are authentication games played * during the connect, we need to detect that and time out ourselves, so the * endpoint can be scavenged. We add our own timeout that expires some time after we * expect ARDP to time out. On a connect that would be at * * connectTimeout * (1 + connectRetries) * * To give ARDP a chance, we timeout one retry interval later, at * * connectTimeout * (2 + connectRetries) * */ uint32_t timeout = m_ardpConfig.connectTimeout * (2 + m_ardpConfig.connectRetries); QCC_DbgPrintf(("UDPTransport::Connect(): qcc::Event::Wait(): timeout=%d.", timeout)); /* * We fired off the connect request. If the connect succeeds, when we wake * up we will find a UDPEndpoint on the m_endpointList with an ARDP * connection pointer matching the connection we got above. If this doesn't * happen, the process must've failed. */ status = qcc::Event::Wait(event, timeout); /* * Whether we succeeded or failed, we are done with blocking I/O on the * current thread, so we need to remove the connectEntry from the set we * kept it in. We still have the thread reference count set indicating we * are in the endpoint, but we are awake and headed out now. */ m_endpointListLock.Lock(MUTEX_CONTEXT); QCC_DbgPrintf(("UDPTransport::Connect(): Removing thread=%p from m_connectThreads", thread)); set::iterator j = m_connectThreads.find(entry); assert(j != m_connectThreads.end() && "UDPTransport::Connect(): Thread not on m_connectThreads"); m_connectThreads.erase(j); /* * We were a thread waiting on an action but no longer. It is possible that * the endpoint manager is waiting for this thread to leave, so tell it to * runs. */ m_manage = STATE_MANAGE; Alert(); if (status != ER_OK) { QCC_LogError(status, ("UDPTransport::Connect(): Event::Wait() failed")); m_endpointListLock.Unlock(MUTEX_CONTEXT); DecrementAndFetch(&m_refCount); return status; } /* * The way we figure out if the connect succeded is by looking for an * endpoint with a connection ID that is the same as the one returned to us * by the original call to ARDP_Connect(). * * The conn pointer and its associated ID will be plumbed from the call to * connect through to the creation of the endpoint in the connect callback; * so if an endpoint was created as a result of the call to ARDP_Connect() * that returned us a valid conn so long ago. That doesn't mean that the * connection must still be up and running now that we get around to looking * for it. It could actually be the case that ARDP has acutally * disconnected the connection and notified us through a disconnect callback * that has been queued up for processing. In that (again, unlikely but * real) case, the conn we have could now be invalid even though we haven't * heard about it yet since that fact is queued behind us in the dispatcher. * * All we want to do is to find an endpoint with the connection ID we got at * the start. If everything worked according to the textbooks, we got a * valid connection when we did the ARDP_Connect(), got a valid connection * ID from that connection, put a valid connection ID into the thread set * entry, a valid connection ID was put into the endpoint when it was * created in a connect callback, the connect callback found our thread * entry with the correct ID and woke us up. Now we look to make sure that * an endpoint was created by looking for one with the correct ID and all of * those IDs will match now. * * How can they not match? The process works from the ARDP_Connect() * through the ConnectCb(). The conn and ID are guaranteed by ARDP to match * during that time. Because we have to call out to the daemon, we need to * dispatch DoConnectCb() and any work there can refer to a defunct * connection. We are careful to pass the valid connection ID to * DoConnectCb() so it can refer back to use even though a connection may * have gone down. The upshot is that if we don't find an endpoint, it is * because our connection ID is ARDP_CONN_ID_INVALID and we missed the boat, * or the endpoint was never made. * * The case to worry about is if the endoint was made successfully and we * have connection ID ARDP_CONN_ID_INVALID. This could allow an unuseable * endpoint to hang around until the transport is shut down. For this to * happen, the connect would have to have been successful and an endpoint be * created and almost immediately receive a disconnect. ARDP would have to * notify via DisconnectCb() and this would have to happen before the call * to ARDP_GetConnId() that happens immediately after ARDP_Connect(). The * DisconnectCb() plumbs the original connection ID through to the callback * dispatcher, though, and so the DisconnnectCb() will start the process of * invalidating and releasing the endpoint even though we never saw any of * that happen here. We are okay even though we might have a connection ID * of ID ARDP_CONN_ID_INVALID -- the connect will fail because we can't find * an endpoint, but it already failed as evidenced by the disconnect event * we were worried about. */ QCC_DbgPrintf(("UDPTransport::Connect(): Finding endpoint with conn ID = %d. in m_endpointList", cid)); set::iterator i; for (i = m_endpointList.begin(); i != m_endpointList.end(); ++i) { UDPEndpoint ep = *i; if (ep->GetConnId() == cid) { QCC_DbgPrintf(("UDPTransport::Connect(): Success.")); /* * We know that we found an endpoint on the endpoint list so it has * a valid reference count, and we are doing this with the endpoint * list lock taken so nothing will be deleted out from under us. * This assignment to newEp will result in a new reference to a * valid object. */ newEp = BusEndpoint::cast(ep); break; } } m_endpointListLock.Unlock(MUTEX_CONTEXT); m_dynamicScoreUpdater.Alert(); DecrementAndFetch(&m_refCount); return status; } /** * Start listening for inbound connections over the ARDP Protocol using the * address and port information provided in the listenSpec. */ QStatus UDPTransport::StartListen(const char* listenSpec) { IncrementAndFetch(&m_refCount); QCC_DbgTrace(("UDPTransport::StartListen(\"%s\")", listenSpec)); /* * We only want to allow this call to proceed if we have a running server * accept thread that isn't in the process of shutting down. We use the * thread response from IsRunning to give us an idea of what our server * accept (Run) thread is doing. See the comment in Start() for details * about what IsRunning actually means, which might be subtly different from * your intuitition. * * If we see IsRunning(), the thread might actually have gotten a Stop(), * but has not yet exited its Run routine and become STOPPING. To plug this * hole, we need to check IsRunning() and also m_stopping, which is set in * our Stop() method. */ if (IsRunning() == false || m_stopping == true) { QCC_LogError(ER_BUS_TRANSPORT_NOT_STARTED, ("UDPTransport::StartListen(): Not running or stopping; exiting")); DecrementAndFetch(&m_refCount); return ER_BUS_TRANSPORT_NOT_STARTED; } /* * Normalize the listen spec. Although this looks like a connectSpec it is * different in that reasonable defaults are possible. We do the * normalization here so we can report an error back to the caller. */ qcc::String normSpec; map argMap; QStatus status = NormalizeListenSpec(listenSpec, normSpec, argMap); if (status != ER_OK) { QCC_LogError(status, ("UDPTransport::StartListen(): Invalid UDP listen spec \"%s\"", listenSpec)); DecrementAndFetch(&m_refCount); return status; } /* * We allow the listen request to be specified with either * a network interface name or an IP address. */ qcc::String key = ""; if (argMap.find("iface") != argMap.end()) { key = "iface"; } else if (argMap.find("addr") != argMap.end()) { key = "addr"; } /* * The daemon code is in a state where it lags in functionality a bit with * respect to the common code. Common supports the use of IPv6 addresses * but the name service is not quite ready for prime time. Until the name * service can properly distinguish between various cases, we fail any * request to listen on an IPv6 address. */ if (key == "addr") { IPAddress ipAddress; status = ipAddress.SetAddress(argMap["addr"].c_str()); if (ipAddress.IsIPv6()) { status = ER_INVALID_ADDRESS; QCC_LogError(status, ("UDPTransport::StartListen(): IPv6 address (\"%s\") in \"u4addr\" not allowed", argMap["u4addr"].c_str())); DecrementAndFetch(&m_refCount); return status; } } QCC_DbgPrintf(("UDPTransport::StartListen(): %s = \"%s\", port = \"%s\"", key.c_str(), argMap[key].c_str(), argMap["port"].c_str())); QCC_DbgTrace(("UDPTransport::StartListen(): Final normSpec=\"%s\"", normSpec.c_str())); /* * Because we are sending a *request* to start listening on a given * normalized listen spec to another thread, and the server thread starts * and stops listening on given listen specs when it decides to eventually * run, it is be possible for a calling thread to send multiple requests to * start or stop listening on the same listenSpec before the server thread * responds. * * In order to deal with these two timelines, we keep a list of normalized * listenSpecs that we have requested to be started, and not yet requested * to be removed. This list (the mListenSpecs) must be consistent with * client requests to start and stop listens. This list is not necessarily * consistent with what is actually being listened on. That is a separate * list called mListenFds. * * So, check to see if someone has previously requested that the address and * port in question be listened on. We need to do this here to be able to * report an error back to the caller. */ m_listenSpecsLock.Lock(MUTEX_CONTEXT); for (list::iterator i = m_listenSpecs.begin(); i != m_listenSpecs.end(); ++i) { if (*i == normSpec) { m_listenSpecsLock.Unlock(MUTEX_CONTEXT); DecrementAndFetch(&m_refCount); return ER_BUS_ALREADY_LISTENING; } } m_listenSpecsLock.Unlock(MUTEX_CONTEXT); QCC_DbgTrace(("UDPTransport::StartListen(): QueueStartListen(\"%s\")", normSpec.c_str())); QueueStartListen(normSpec); DecrementAndFetch(&m_refCount); return ER_OK; } void UDPTransport::QueueStartListen(qcc::String& normSpec) { IncrementAndFetch(&m_refCount); QCC_DbgTrace(("UDPTransport::QueueStartListen(\"%s\")", normSpec.c_str())); /* * In order to start a listen, we send the maintenance thread a message * containing the START_LISTEN_INSTANCE request code and the normalized * listen spec which specifies the address and port instance to listen on. */ ListenRequest listenRequest; listenRequest.m_requestOp = START_LISTEN_INSTANCE; listenRequest.m_requestParam = normSpec; m_listenRequestsLock.Lock(MUTEX_CONTEXT); /* Process the request */ RunListenMachine(listenRequest); m_listenRequestsLock.Unlock(MUTEX_CONTEXT); DecrementAndFetch(&m_refCount); } QStatus UDPTransport::DoStartListen(qcc::String& normSpec) { IncrementAndFetch(&m_refCount); QCC_DbgPrintf(("UDPTransport::DoStartListen(\"%s\")", normSpec.c_str())); /* * Since the name service is created before the server accept thread is spun * up, and stopped when it is stopped, we must have a started name service or * someone isn't playing by the rules; so an assert is appropriate here. */ assert(IpNameService::Instance().Started() && "UDPTransport::DoStartListen(): IpNameService not started"); qcc::String interfaces = ConfigDB::GetConfigDB()->GetProperty("ns_interfaces"); if (interfaces.size()) { QCC_LogError(ER_WARNING, ("UDPTransport::DoStartListen(): The mechanism implied by \"ns_interfaces\" is no longer supported.")); } /* * Parse the normalized listen spec. The easiest way to do this is to * re-normalize it. If there's an error at this point, we have done * something wrong since the listen spec was presumably successfully * normalized before sending it in -- so we assert. */ qcc::String spec; map argMap; QStatus status = NormalizeListenSpec(normSpec.c_str(), spec, argMap); assert(status == ER_OK && "UDPTransport::DoStartListen(): Invalid UDP listen spec"); qcc::String key = ""; if (argMap.find("iface") != argMap.end()) { key = "iface"; } else if (argMap.find("addr") != argMap.end()) { key = "addr"; } QCC_DbgPrintf(("UDPTransport::DoStartListen(): %s = \"%s\", port = \"%s\"", key.c_str(), argMap[key].c_str(), argMap["port"].c_str())); /* * We have been given a listenSpec that provides an iface or addr and a port * in the parameters to this method. We are expected to listen on that * network interface's primary IPv4 address and port for inbound connections. * The name service will also advertise and discover over this network interface. * * We can either be given the wildcard iface "*", a specific network * interface name, the default address "0.0.0.0" or a specific address. * If given "*" or "0.0.0.0", this means that the TCP Transport will * listen for inbound connections on the INADDR_ANY address and the name * service will advertise and discover over any currently IFF_UP interface * or any interface that may come IFF_UP in the future. * * If given a network interface name, the TCP Transport will listen for * inbound connections on the current primary IPv4 address of that network * interface and the name service will advertise and discover over that * network interface. * * If given a specific address, the TCP Transport will listen for * inbound connections on the specified address and the name service * will advertise and discover over the underlying network interface * as long as it retains that address. * * iface Action * ---------- ----------------------------------------- * 1. * Listen on 0.0.0.0 and advertise/discover * over '*'. This is the default case where * the system listens on all interfaces and * advertises / discovers on all interfaces. * This is the "speak alljoyn over all of * your interfaces" situation. * * 2. 'specific' Listen only on the primary address of the * named netowrk interface and advertise and * discover over that specific interface. * This may not be exactly what is desired, * but it may be. We do what we are told. * Note that by doing this, one is limiting * the number of daemons that can be run on * a host using the same address and port * to one. Other daemons configured this * way must select another port. This is * how we expect people to limit AllJoyn to * talking only over a specific interface. * This allows that interface to change IP * addresses on the fly. This reqires the * interface name to be known a-priori but * does not require the IP address of the * network interface named 'specific' to be * known a-priori. * * address Action * -------- ----------------------------------------- * 1. 0.0.0.0 Listen on 0.0.0.0 and advertise/discover * over '*'. This is the default case where * the system listens on all interfaces and * advertises / discovers on all interfaces. * This is the "speak alljoyn over all of * your interfaces" situation. * * 2. 'a.b.c.d' Listen only on the specified address if * or when it appears on the network and * advertise and discover over the * underlying interface for that address, * so long as it retains the address. * This may not be exactly what is desired, * but it may be. We do what we are told. * Note that by doing this, one is limiting * the number of daemons that can be run on * a host using the same address and port * to one. Other daemons configured this * way must select another port. * * This is much harder to describe than to implement; but the upshot is that * we listen on the primary IPv4 address of the named network interface that * comes in with the listenSpec and we enable the name service on that same * interface. It is up to the person doing the configuration to understand * what he or she is trying to do and the impact of choosing those values. */ uint16_t listenPort = StringToU32(argMap["port"]); qcc::String interface = ""; qcc::IPAddress addr; if (argMap.find("iface") != argMap.end()) { interface = argMap["iface"]; } if (argMap.find("addr") != argMap.end()) { addr = IPAddress(argMap["addr"]); } /* We first determine whether a network interface name or an IP address was * specified and then we invoke the appropriate name service method. */ if (!interface.empty()) { m_requestedInterfaces[interface] = qcc::IPEndpoint("0.0.0.0", listenPort); m_listenPortMap[interface] = listenPort; } else if (addr.Size() && addr.IsIPv4()) { m_requestedAddresses[addr.ToString()] = ""; m_requestedAddressPortMap[addr.ToString()] = listenPort; } if (!interface.empty()) { status = IpNameService::Instance().OpenInterface(TRANSPORT_UDP, interface); } else if (addr.Size() && addr.IsIPv4()) { status = IpNameService::Instance().OpenInterface(TRANSPORT_UDP, addr.ToString()); } if (status != ER_OK) { QCC_LogError(status, ("UDPTransport::DoStartListen(): OpenInterface() failed for %s", (interface.empty() ? addr.ToString().c_str() : interface.c_str()))); } DecrementAndFetch(&m_refCount); return status; } void UDPTransport::UntrustedClientExit() { QCC_DbgTrace((" UDPTransport::UntrustedClientExit()")); #if ADVERTISE_ROUTER_OVER_UDP /* An untrusted client has exited, update the counts and re-enable the advertisement if necessary. */ m_listenRequestsLock.Lock(); if (m_numUntrustedClients >= 0) { m_numUntrustedClients--; QCC_DbgPrintf((" UDPTransport::UntrustedClientExit() m_numUntrustedClients=%d m_maxRemoteClientsUdp=%d", m_numUntrustedClients, m_maxRemoteClientsUdp)); } m_listenRequestsLock.Unlock(); m_dynamicScoreUpdater.Alert(); #endif } QStatus UDPTransport::UntrustedClientStart() { QCC_DbgTrace((" UDPTransport::UntrustedClientStart()")); #if ADVERTISE_ROUTER_OVER_UDP QStatus status = ER_OK; m_listenRequestsLock.Lock(); m_numUntrustedClients++; QCC_DbgPrintf((" UDPTransport::UntrustedClientStart() m_numUntrustedClients=%d m_maxRemoteClientsUdp=%d", m_numUntrustedClients, m_maxRemoteClientsUdp)); if (m_numUntrustedClients > m_maxRemoteClientsUdp) { /* This could happen in the following situation: * The max untrusted clients is set to 1. Two untrusted clients try to * connect to this daemon at the same time. When the 2nd one * finishes the EndpointAuth::Establish, it will call into this method * and hit this case and will be rejected. */ status = ER_BUS_NOT_ALLOWED; m_numUntrustedClients--; } m_listenRequestsLock.Unlock(); m_dynamicScoreUpdater.Alert(); return status; #else return ER_UDP_NOT_IMPLEMENTED; #endif } /** * Stop listening for inbound connections over the ARDP Protocol using the * address and port information provided in the listenSpec. Must match a * previously started listenSpec. */ QStatus UDPTransport::StopListen(const char* listenSpec) { IncrementAndFetch(&m_refCount); QCC_DbgTrace(("UDPTransport::StopListen()")); /* * We only want to allow this call to proceed if we have a running server * accept thread that isn't in the process of shutting down. We use the * thread response from IsRunning to give us an idea of what our server * accept (Run) thread is doing. See the comment in Start() for details * about what IsRunning actually means, which might be subtly different from * your intuitition. * * If we see IsRunning(), the thread might actually have gotten a Stop(), * but has not yet exited its Run routine and become STOPPING. To plug this * hole, we need to check IsRunning() and also m_stopping, which is set in * our Stop() method. */ if (IsRunning() == false || m_stopping == true) { QCC_LogError(ER_BUS_TRANSPORT_NOT_STARTED, ("UDPTransport::StopListen(): Not running or stopping; exiting")); DecrementAndFetch(&m_refCount); return ER_BUS_TRANSPORT_NOT_STARTED; } /* * Normalize the listen spec. We are going to use the name string that was * put together for the StartListen call to find the listener instance to * stop, so we need to do it exactly the same way. */ qcc::String normSpec; map argMap; QStatus status = NormalizeListenSpec(listenSpec, normSpec, argMap); if (status != ER_OK) { QCC_LogError(status, ("UDPTransport::StopListen(): Invalid UDP listen spec \"%s\"", listenSpec)); DecrementAndFetch(&m_refCount); return status; } /* * Because we are sending a *request* to stop listening on a given * normalized listen spec to another thread, and the server thread starts * and stops listening on given listen specs when it decides to eventually * run, it is be possible for a calling thread to send multiple requests to * start or stop listening on the same listenSpec before the server thread * responds. * * In order to deal with these two timelines, we keep a list of normalized * listenSpecs that we have requested to be started, and not yet requested * to be removed. This list (the mListenSpecs) must be consistent with * client requests to start and stop listens. This list is not necessarily * consistent with what is actually being listened on. That is reflected by * a separate list called mListenFds. * * We consult the list of listen spects for duplicates when starting to * listen, and we make sure that a listen spec is on the list before * queueing a request to stop listening. Asking to stop listening on a * listen spec we aren't listening on is not an error, since the goal of the * user is to not listen on a given address and port -- and we aren't. */ m_listenSpecsLock.Lock(MUTEX_CONTEXT); for (list::iterator i = m_listenSpecs.begin(); i != m_listenSpecs.end(); ++i) { if (*i == normSpec) { m_listenSpecs.erase(i); QueueStopListen(normSpec); break; } } m_listenSpecsLock.Unlock(MUTEX_CONTEXT); DecrementAndFetch(&m_refCount); return ER_OK; } void UDPTransport::QueueStopListen(qcc::String& normSpec) { IncrementAndFetch(&m_refCount); QCC_DbgTrace(("UDPTransport::QueueStopListen()")); /* * In order to stop a listen, we send the server accept thread a message * containing the STOP_LISTEN_INTANCE request code and the normalized listen * spec which specifies the address and port instance to stop listening on. */ ListenRequest listenRequest; listenRequest.m_requestOp = STOP_LISTEN_INSTANCE; listenRequest.m_requestParam = normSpec; m_listenRequestsLock.Lock(MUTEX_CONTEXT); /* Process the request */ RunListenMachine(listenRequest); m_listenRequestsLock.Unlock(MUTEX_CONTEXT); DecrementAndFetch(&m_refCount); } void UDPTransport::DoStopListen(qcc::String& normSpec) { IncrementAndFetch(&m_refCount); QCC_DbgTrace(("UDPTransport::DoStopListen()")); /* * Since the name service is started before the server accept thread is spun * up, and stopped after it is stopped, we must have a started name service or * someone isn't playing by the rules; so an assert is appropriate here. */ assert(IpNameService::Instance().Started() && "UDPTransport::DoStopListen(): IpNameService not started"); /* * Find the (single) listen spec and remove it from the list of active FDs * used by the maintenance thread. */ QCC_DbgPrintf(("UDPTransport::DoStopListen(): Looking for listen FD with normspec \"%s\"", normSpec.c_str())); m_listenFdsLock.Lock(MUTEX_CONTEXT); qcc::SocketFd stopFd = qcc::INVALID_SOCKET_FD; bool found = false; for (list >::iterator i = m_listenFds.begin(); i != m_listenFds.end(); ++i) { if (i->first == normSpec) { QCC_DbgPrintf(("UDPTransport::DoStopListen(): Found normspec \"%s\"", normSpec.c_str())); stopFd = i->second; m_listenFds.erase(i); found = true; break; } } if (found) { if (m_reload != STATE_EXITED) { QCC_DbgPrintf(("UDPTransport::DoStopListen(): m_reload != STATE_EXITED")); /* * If the UDPTransport::Run thread is still running, set m_reload to * STATE_RELOADING, unlock the mutex, alert the main Run thread that * there is a change and wait for the Run thread to finish any * connections it may be accepting and then reload the set of * events. */ m_reload = STATE_RELOADING; QCC_DbgPrintf(("UDPTransport::DoStopListen(): Alert()")); Alert(); /* * Wait until UDPTransport::Run thread has reloaded the set of * events or exited. */ QCC_DbgPrintf(("UDPTransport::DoStopListen(): Wait for STATE_RELOADING()")); while (m_reload == STATE_RELOADING) { m_listenFdsLock.Unlock(MUTEX_CONTEXT); qcc::Sleep(10); m_listenFdsLock.Lock(MUTEX_CONTEXT); } QCC_DbgPrintf(("UDPTransport::DoStopListen(): Done waiting for STATE_RELOADING()")); } /* * If we took a socketFD off of the list of active FDs, we need to tear it * down. */ QCC_DbgPrintf(("UDPTransport::DoStopListen(): Close socket %d.", stopFd)); qcc::Close(stopFd); } m_listenFdsLock.Unlock(MUTEX_CONTEXT); DecrementAndFetch(&m_refCount); } bool UDPTransport::NewDiscoveryOp(DiscoveryOp op, qcc::String namePrefix, bool& isFirst) { IncrementAndFetch(&m_refCount); QCC_DbgTrace(("UDPTransport::NewDiscoveryOp()")); bool first = false; if (op == ENABLE_DISCOVERY) { QCC_DbgPrintf(("UDPTransport::NewDiscoveryOp(): Registering discovery of namePrefix \"%s\"", namePrefix.c_str())); first = m_discovering.empty(); if (find(m_discovering.begin(), m_discovering.end(), namePrefix) == m_discovering.end()) { m_discovering.push_back(namePrefix); } } else { list::iterator i = find(m_discovering.begin(), m_discovering.end(), namePrefix); if (i == m_discovering.end()) { QCC_DbgPrintf(("UDPTransport::NewDiscoveryOp(): Cancel of non-existent namePrefix \"%s\"", namePrefix.c_str())); } else { QCC_DbgPrintf(("UDPTransport::NewDiscoveryOp(): Unregistering discovery of namePrefix \"%s\"", namePrefix.c_str())); m_discovering.erase(i); } } isFirst = first; bool rc = m_discovering.empty(); DecrementAndFetch(&m_refCount); return rc; } bool UDPTransport::NewAdvertiseOp(AdvertiseOp op, qcc::String name, bool& isFirst) { IncrementAndFetch(&m_refCount); QCC_DbgTrace(("UDPTransport::NewAdvertiseOp()")); bool first = false; if (op == ENABLE_ADVERTISEMENT) { QCC_DbgPrintf(("UDPTransport::NewAdvertiseOp(): Registering advertisement of namePrefix \"%s\"", name.c_str())); first = m_advertising.empty(); if (find(m_advertising.begin(), m_advertising.end(), name) == m_advertising.end()) { m_advertising.push_back(name); } } else { list::iterator i = find(m_advertising.begin(), m_advertising.end(), name); if (i == m_advertising.end()) { QCC_DbgPrintf(("UDPTransport::NewAdvertiseOp(): Cancel of non-existent name \"%s\"", name.c_str())); } else { QCC_DbgPrintf(("UDPTransport::NewAdvertiseOp(): Unregistering advertisement of namePrefix \"%s\"", name.c_str())); m_advertising.erase(i); } } isFirst = first; bool rc = m_advertising.empty(); DecrementAndFetch(&m_refCount); return rc; } bool UDPTransport::NewListenOp(ListenOp op, qcc::String normSpec) { IncrementAndFetch(&m_refCount); QCC_DbgTrace(("UDPTransport::NewListenOp()")); if (op == START_LISTEN) { QCC_DbgPrintf(("UDPTransport::NewListenOp(): Registering listen of normSpec \"%s\"", normSpec.c_str())); m_listening.push_back(normSpec); } else { list::iterator i = find(m_listening.begin(), m_listening.end(), normSpec); if (i == m_listening.end()) { QCC_DbgPrintf(("UDPTransport::NewAdvertiseOp(): StopListen of non-existent spec \"%s\"", normSpec.c_str())); } else { QCC_DbgPrintf(("UDPTransport::NewAdvertiseOp(): StopListen of normSpec \"%s\"", normSpec.c_str())); m_listening.erase(i); } } bool rc = m_listening.empty(); DecrementAndFetch(&m_refCount); return rc; } void UDPTransport::EnableDiscovery(const char* namePrefix, TransportMask transports) { IncrementAndFetch(&m_refCount); QCC_DbgTrace(("UDPTransport::EnableDiscovery()")); /* * We only want to allow this call to proceed if we have a running server * accept thread that isn't in the process of shutting down. We use the * thread response from IsRunning to give us an idea of what our server * accept (Run) thread is doing. See the comment in Start() for details * about what IsRunning actually means, which might be subtly different from * your intuitition. * * If we see IsRunning(), the thread might actually have gotten a Stop(), * but has not yet exited its Run routine and become STOPPING. To plug this * hole, we need to check IsRunning() and also m_stopping, which is set in * our Stop() method. */ if (IsRunning() == false || m_stopping == true) { QCC_LogError(ER_BUS_TRANSPORT_NOT_STARTED, ("UDPTransport::EnableDiscovery(): Not running or stopping; exiting")); DecrementAndFetch(&m_refCount); return; } #if WORKAROUND_1298 if (!m_done1298) { QCC_DbgPrintf(("UDPTransport::EnableDiscovery(): Implementing workaround for ASACORE-1298")); qcc::String name = WORKAROUND_1298_PREFIX; name.append(m_bus.GetInternal().GetGlobalGUID().ToShortString()); QueueEnableAdvertisement(name, true, TRANSPORT_UDP); m_done1298 = true; } #endif QueueEnableDiscovery(namePrefix, transports); DecrementAndFetch(&m_refCount); } void UDPTransport::QueueEnableDiscovery(const char* namePrefix, TransportMask transports) { IncrementAndFetch(&m_refCount); QCC_DbgTrace(("UDPTransport::QueueEnableDiscovery()")); ListenRequest listenRequest; listenRequest.m_requestOp = ENABLE_DISCOVERY_INSTANCE; listenRequest.m_requestParam = namePrefix; listenRequest.m_requestTransportMask = transports; m_listenRequestsLock.Lock(MUTEX_CONTEXT); /* Process the request */ RunListenMachine(listenRequest); m_listenRequestsLock.Unlock(MUTEX_CONTEXT); DecrementAndFetch(&m_refCount); } void UDPTransport::DisableDiscovery(const char* namePrefix, TransportMask transports) { IncrementAndFetch(&m_refCount); QCC_DbgTrace(("UDPTransport::DisableDiscovery()")); /* * We only want to allow this call to proceed if we have a running server * accept thread that isn't in the process of shutting down. We use the * thread response from IsRunning to give us an idea of what our server * accept (Run) thread is doing. See the comment in Start() for details * about what IsRunning actually means, which might be subtly different from * your intuitition. * * If we see IsRunning(), the thread might actually have gotten a Stop(), * but has not yet exited its Run routine and become STOPPING. To plug this * hole, we need to check IsRunning() and also m_stopping, which is set in * our Stop() method. */ if (IsRunning() == false || m_stopping == true) { QCC_LogError(ER_BUS_TRANSPORT_NOT_STARTED, ("UDPTransport::DisbleDiscovery(): Not running or stopping; exiting")); DecrementAndFetch(&m_refCount); return; } QueueDisableDiscovery(namePrefix, transports); DecrementAndFetch(&m_refCount); } void UDPTransport::QueueDisableDiscovery(const char* namePrefix, TransportMask transports) { IncrementAndFetch(&m_refCount); QCC_DbgTrace(("UDPTransport::QueueDisableDiscovery()")); ListenRequest listenRequest; listenRequest.m_requestOp = DISABLE_DISCOVERY_INSTANCE; listenRequest.m_requestParam = namePrefix; listenRequest.m_requestTransportMask = transports; m_listenRequestsLock.Lock(MUTEX_CONTEXT); /* Process the request */ RunListenMachine(listenRequest); m_listenRequestsLock.Unlock(MUTEX_CONTEXT); DecrementAndFetch(&m_refCount); } QStatus UDPTransport::EnableAdvertisement(const qcc::String& advertiseName, bool quietly, TransportMask transports) { IncrementAndFetch(&m_refCount); QCC_DbgTrace(("UDPTransport::EnableAdvertisement()")); /* * We only want to allow this call to proceed if we have a running server * accept thread that isn't in the process of shutting down. We use the * thread response from IsRunning to give us an idea of what our server * accept (Run) thread is doing. See the comment in Start() for details * about what IsRunning actually means, which might be subtly different from * your intuitition. * * If we see IsRunning(), the thread might actually have gotten a Stop(), * but has not yet exited its Run routine and become STOPPING. To plug this * hole, we need to check IsRunning() and also m_stopping, which is set in * our Stop() method. */ if (IsRunning() == false || m_stopping == true) { QCC_LogError(ER_BUS_TRANSPORT_NOT_STARTED, ("UDPTransport::EnableAdvertisement(): Not running or stopping; exiting")); DecrementAndFetch(&m_refCount); return ER_BUS_TRANSPORT_NOT_STARTED; } #if WORKAROUND_1298 if (!m_done1298) { QCC_DbgPrintf(("UDPTransport::EnableAdvertisement(): Implementing workaround for ASACORE-1298")); qcc::String name = WORKAROUND_1298_PREFIX; name.append(m_bus.GetInternal().GetGlobalGUID().ToShortString()); QueueEnableAdvertisement(name, true, TRANSPORT_UDP); m_done1298 = true; } #endif QueueEnableAdvertisement(advertiseName, quietly, transports); DecrementAndFetch(&m_refCount); return ER_OK; } void UDPTransport::QueueEnableAdvertisement(const qcc::String& advertiseName, bool quietly, TransportMask transports) { IncrementAndFetch(&m_refCount); QCC_DbgTrace(("UDPTransport::QueueEnableAdvertisement()")); ListenRequest listenRequest; listenRequest.m_requestOp = ENABLE_ADVERTISEMENT_INSTANCE; listenRequest.m_requestParam = advertiseName; listenRequest.m_requestParamOpt = quietly; listenRequest.m_requestTransportMask = transports; m_listenRequestsLock.Lock(MUTEX_CONTEXT); /* Process the request */ RunListenMachine(listenRequest); m_listenRequestsLock.Unlock(MUTEX_CONTEXT); DecrementAndFetch(&m_refCount); } void UDPTransport::DisableAdvertisement(const qcc::String& advertiseName, TransportMask transports) { IncrementAndFetch(&m_refCount); QCC_DbgTrace(("UDPTransport::DisableAdvertisement()")); /* * We only want to allow this call to proceed if we have a running server * accept thread that isn't in the process of shutting down. We use the * thread response from IsRunning to give us an idea of what our server * accept (Run) thread is doing. See the comment in Start() for details * about what IsRunning actually means, which might be subtly different from * your intuitition. * * If we see IsRunning(), the thread might actually have gotten a Stop(), * but has not yet exited its Run routine and become STOPPING. To plug this * hole, we need to check IsRunning() and also m_stopping, which is set in * our Stop() method. */ if (IsRunning() == false || m_stopping == true) { QCC_LogError(ER_BUS_TRANSPORT_NOT_STARTED, ("UDPTransport::DisableAdvertisement(): Not running or stopping; exiting")); DecrementAndFetch(&m_refCount); return; } QueueDisableAdvertisement(advertiseName, transports); DecrementAndFetch(&m_refCount); } void UDPTransport::QueueDisableAdvertisement(const qcc::String& advertiseName, TransportMask transports) { IncrementAndFetch(&m_refCount); QCC_DbgTrace(("UDPTransport::QueueDisableAdvertisement()")); ListenRequest listenRequest; listenRequest.m_requestOp = DISABLE_ADVERTISEMENT_INSTANCE; listenRequest.m_requestParam = advertiseName; listenRequest.m_requestTransportMask = transports; m_listenRequestsLock.Lock(MUTEX_CONTEXT); /* Process the request */ RunListenMachine(listenRequest); m_listenRequestsLock.Unlock(MUTEX_CONTEXT); DecrementAndFetch(&m_refCount); } void UDPTransport::UpdateRouterAdvertisementAndDynamicScore() { QCC_DbgPrintf(("UDPTransport::UpdateRouterAdvertisementAndDynamicScore()")); /* * We only want to allow this call to proceed if we have a running server * accept thread that isn't in the process of shutting down. We use the * thread response from IsRunning to give us an idea of what our server * accept (Run) thread is doing. See the comment in Start() for details * about what IsRunning actually means, which might be subtly different from * your intuitition. * * If we see IsRunning(), the thread might actually have gotten a Stop(), * but has not yet exited its Run routine and become STOPPING. To plug this * hole, we need to check IsRunning() and also m_stopping, which is set in * our Stop() method. */ if (IsRunning() == false || m_stopping == true) { QCC_DbgPrintf(("UDPTransport::UpdateRouterAdvertisementAndDynamicScore(): Not running or stopping; exiting")); return; } QueueUpdateRouterAdvertisementAndDynamicScore(); } void UDPTransport::QueueUpdateRouterAdvertisementAndDynamicScore() { QCC_DbgPrintf(("UDPTransport::QueueUpdateRouterAdvertisementAndDynamicScore()")); ListenRequest updateScoreListenRequest; updateScoreListenRequest.m_requestOp = UPDATE_DYNAMIC_SCORE_INSTANCE; ListenRequest enableAdvListenRequest; enableAdvListenRequest.m_requestOp = ENABLE_ADVERTISEMENT_INSTANCE; enableAdvListenRequest.m_requestParam = m_routerName; enableAdvListenRequest.m_requestParamOpt = true; enableAdvListenRequest.m_requestTransportMask = TRANSPORT_UDP; ListenRequest disableAdvListenRequest; disableAdvListenRequest.m_requestOp = DISABLE_ADVERTISEMENT_INSTANCE; disableAdvListenRequest.m_requestParam = m_routerName; disableAdvListenRequest.m_requestTransportMask = TRANSPORT_UDP; m_listenRequestsLock.Lock(MUTEX_CONTEXT); /* Process the request(s) */ RunListenMachine(updateScoreListenRequest); if (EnableRouterAdvertisement()) { RunListenMachine(enableAdvListenRequest); m_routerNameAdvertised = true; } else if (DisableRouterAdvertisement()) { RunListenMachine(disableAdvListenRequest); m_routerNameAdvertised = false; } m_listenRequestsLock.Unlock(MUTEX_CONTEXT); } void UDPTransport::FoundCallback::Found(const qcc::String& busAddr, const qcc::String& guid, std::vector& nameList, uint32_t timer) { // Makes lots of noise! //QCC_DbgTrace(("UDPTransport::FoundCallback::Found(): busAddr = \"%s\" nameList %d", busAddr.c_str(), nameList.size())); qcc::String addr("addr="); qcc::String port("port="); qcc::String comma(","); size_t i = busAddr.find(addr); if (i == qcc::String::npos) { QCC_DbgPrintf(("UDPTransport::FoundCallback::Found(): No addr in busaddr.")); return; } i += addr.size(); size_t j = busAddr.find(comma, i); if (j == qcc::String::npos) { QCC_DbgPrintf(("UDPTransport::FoundCallback::Found(): No comma after addr in busaddr.")); return; } size_t k = busAddr.find(port); if (k == qcc::String::npos) { QCC_DbgPrintf(("UDPTransport::FoundCallback::Found(): No port in busaddr.")); return; } k += port.size(); /* * "addr=192.168.1.1,port=9955" * ^ ^ ^ * i j k */ qcc::String newBusAddr = qcc::String("udp:guid=") + guid + "," + addr + busAddr.substr(i, j - i) + "," + port + busAddr.substr(k); // QCC_DbgPrintf(("UDPTransport::FoundCallback::Found(): newBusAddr = \"%s\".", newBusAddr.c_str())); if (m_listener) { m_listener->FoundNames(newBusAddr, guid, TRANSPORT_UDP, &nameList, timer); } } void UDPTransport::NetworkEventCallback::Handler(const std::map& ifMap) { IncrementAndFetch(&m_transport.m_refCount); QCC_DbgPrintf(("UDPTransport::NetworkEventCallback::Handler()")); /* * We only want to allow this call to proceed if we have a running server * accept thread that isn't in the process of shutting down. We use the * thread response from IsRunning to give us an idea of what our server * accept (Run) thread is doing. See the comment in Start() for details * about what IsRunning actually means, which might be subtly different from * your intuitition. * * If we see IsRunning(), the thread might actually have gotten a Stop(), * but has not yet exited its Run routine and become STOPPING. To plug this * hole, we need to check IsRunning() and also m_stopping, which is set in * our Stop() method. */ if (m_transport.IsRunning() == false || m_transport.m_stopping == true) { QCC_LogError(ER_BUS_TRANSPORT_NOT_STARTED, ("UDPTransport::NetworkEventCallback::Handler(): Not running or stopping; exiting")); return; } m_transport.QueueHandleNetworkEvent(ifMap); DecrementAndFetch(&m_transport.m_refCount); } void UDPTransport::QueueHandleNetworkEvent(const std::map& ifMap) { IncrementAndFetch(&m_refCount); QCC_DbgPrintf(("UDPTransport::QueueHandleNetworkEvent()")); ListenRequest listenRequest; listenRequest.m_requestOp = HANDLE_NETWORK_EVENT; listenRequest.ifMap = ifMap; m_listenRequestsLock.Lock(MUTEX_CONTEXT); /* Process the request */ RunListenMachine(listenRequest); m_listenRequestsLock.Unlock(MUTEX_CONTEXT); DecrementAndFetch(&m_refCount); } /* This is the callback handler that is invoked when the name service detects that a network interface * has become IFF_UP or a network interface's IP address has changed. When we invoke the OpenInterface() * method of the name service from the DoStartListen() method, it will also trigger the name service to * refresh the set of interfaces and invoke this callback to get things started. On network events, a map * of interfaces to IP addresses that have changed is provided. Whenever OpenInterface() is called, a map * of interfaces to IP addresses for all the interfaces that are currently up is provided. Note that this * handler may also be invoked because another transport called the OpenInterface() method of the name * service and one or more of the interfaces requested by this transport has become IFF_UP. */ void UDPTransport::HandleNetworkEventInstance(ListenRequest& listenRequest) { QCC_DbgTrace(("UDPTransport::HandleNetworkEventInstance()")); std::map& ifMap = listenRequest.ifMap; QStatus status = ER_OK; IncrementAndFetch(&m_refCount); list replacedList; list > addedList; bool wildcardIfaceRequested = (m_requestedInterfaces.find("*") != m_requestedInterfaces.end()); bool wildcardAddressRequested = (m_requestedAddresses.find("0.0.0.0") != m_requestedAddresses.end()); /* If we don't have any interfaces or addresses that we are required to listen on then we return. * If a wildcard interface or wildcard address was specified, once we have processed the request * we no longer care about dynamic changes to the state of the network interfaces since we are * listening on IN_ADDR_ANY at this point so we return. */ if ((m_requestedInterfaces.empty() && m_requestedAddresses.empty()) || ((wildcardIfaceRequested && m_wildcardIfaceProcessed) || (wildcardAddressRequested && m_wildcardAddressProcessed))) { DecrementAndFetch(&m_refCount); return; } /* * We walk through the list of interfaces that have changed in some way provided to us by the name service. * For each interface, we check if that interface is one of the interfaces specified in the configuration * database. If we don't have a wildcard interface or wildcard address in the configuration database and * the current interface's network interface name or IP address is not specified in the configuration * database, then we proceed to the next interface in the list. If the current interface's network name * is in the configuration database and its IP address has not changed we proceed to the next interface. * Similarly, if a network IP address still corresponds to the same network interface we proceed to the * next interface in the list. At this point, we check if the change in IP address for a network interface * is a change from the default address "0.0.0.0". If it is, then this is the first time we are learning of * the actual IP address of the specified interface. If it isn't, then this is a previously known interface * that has just changed its IP address. We save a copy of its listen spec so that we can stop listening on * the old IP address once we start listening on the new IP address. If we find an address has previously * been specified in the configuration database, we remove that entry so that we only listen on the port * specified by a network interface name if both network interface and IP address is specified for the same * interface. We then update the IP address to the current one for that network interface. Similarly, if * we are learning of a specified IP address's network name for the first time we update our records. If we * have a wildcard in the configuration database that we have not yet processed, we process it the first time * while walking the list of interfaces and return. */ for (std::map::const_iterator it = ifMap.begin(); it != ifMap.end(); it++) { qcc::String interface = it->first; qcc::IPAddress address = it->second; qcc::String addressStr = address.ToString(); bool currentIfaceRequested = (m_requestedInterfaces.find(interface) != m_requestedInterfaces.end()); bool currentAddressRequested = (m_requestedAddresses.find(addressStr) != m_requestedAddresses.end()); if (!wildcardIfaceRequested && !wildcardAddressRequested && !currentIfaceRequested && !currentAddressRequested) { continue; } if (!wildcardIfaceRequested && currentIfaceRequested && m_requestedInterfaces[interface].GetAddress() == address) { continue; } if (!wildcardAddressRequested && currentAddressRequested && m_requestedAddresses[addressStr] == interface) { continue; } if (!wildcardIfaceRequested && currentIfaceRequested) { if (m_requestedInterfaces[interface].GetAddress() != qcc::IPAddress("0.0.0.0")) { qcc::String replacedSpec = "udp:addr=" + m_requestedInterfaces[interface].GetAddress().ToString() + ",port=" + U32ToString(m_requestedInterfaces[interface].GetPort()); if (m_requestedAddresses.find(m_requestedInterfaces[interface].GetAddress().ToString()) != m_requestedAddresses.end()) { m_requestedAddresses.erase(m_requestedInterfaces[interface].GetAddress().ToString()); } replacedList.push_back(replacedSpec); } m_requestedInterfaces[interface] = qcc::IPEndpoint(address, m_requestedInterfaces[interface].GetPort()); } if (!wildcardAddressRequested && currentAddressRequested) { if (!m_requestedAddresses[addressStr].empty()) { m_requestedAddresses[addressStr] = interface; continue; } m_requestedAddresses[addressStr] = interface; } qcc::IPAddress listenAddr; uint16_t listenPort = 0; if (wildcardIfaceRequested) { listenAddr = qcc::IPAddress("0.0.0.0"); listenPort = m_requestedInterfaces["*"].GetPort(); } else if (wildcardAddressRequested) { listenAddr = qcc::IPAddress("0.0.0.0"); listenPort = m_requestedAddressPortMap["0.0.0.0"]; } else { if (!listenAddr.Size() && currentIfaceRequested) { listenAddr = m_requestedInterfaces[interface].GetAddress(); listenPort = m_requestedInterfaces[interface].GetPort(); } else if (!listenAddr.Size() && currentAddressRequested) { listenAddr = address; listenPort = m_requestedAddressPortMap[addressStr]; } else { continue; } } if (!listenAddr.Size() || !listenAddr.IsIPv4()) { continue; } /* * We have the name service work out of the way, so we can now create the * TCP listener sockets and set SO_REUSEADDR/SO_REUSEPORT so we don't have * to wait for four minutes to relaunch the daemon if it crashes. */ QCC_DbgPrintf(("UDPTransport::HandleNetworkEventInstance(): Setting up socket")); SocketFd listenFd = INVALID_SOCKET_FD; status = Socket(QCC_AF_INET, QCC_SOCK_DGRAM, listenFd); if (status != ER_OK) { continue; } QCC_DbgPrintf(("UDPTransport::HandleNetworkEventInstance(): listenFd=%d.", listenFd)); /* * ARDP expects us to use select and non-blocking sockets. */ QCC_DbgPrintf(("UDPTransport::HandleNetworkEventInstance(): SetBlocking(listenFd=%d, false)", listenFd));; status = qcc::SetBlocking(listenFd, false); if (status != ER_OK) { QCC_LogError(status, ("UDPTransport::HandleNetworkEventInstance(): SetBlocking() failed")); qcc::Close(listenFd); continue; } /* * We are going to use UDP, and the socket buffers for UDP sockets are * most likely set unnecessarily low by default. IN the optimal case, * we are going to want to spew out SEGBMAX * SEGMAX bytes of data on * each connection. Typical values might be 65535 bytes per buffer * 50 * buffers = 3,276,800 bytes. Since there may be N connections running * over that single socket, it would imply a requirement to buffer N * 3 * megabytes total. Unlikely. We set the buffer large enough to buffer * enough in-flight data to service one fully utilized connection * completely. After the buffer fills, we share capacity. * * Just because we ask for this amount of buffer does not mean we will * get it. Systems provide a maximum number. On Linux, for example, * you can find the maximum value in /proc/sys/net/core/wmem_max. On my * Fedora 20- box it is set to 131071, so the doubled value returned by * GetSndBuf() would be 262142. Consider changing this value on a * server-class system. * * Note that this is not a fatal error if it fails. We just may get less * buffer capacity than we might like. */ size_t sndSize = m_ardpConfig.segmax * m_ardpConfig.segbmax; QCC_DbgPrintf(("UDPTransport::HandleNetworkEventInstance(): SetSndBuf(listenFd=%d, %u.)", listenFd, sndSize)); status = qcc::SetSndBuf(listenFd, sndSize); if (status != ER_OK) { QCC_LogError(status, ("UDPTransport::HandleNetworkEventInstance(): SetSndbuf() failed")); } #ifndef NDEBUG sndSize = 0; qcc::GetSndBuf(listenFd, sndSize); QCC_DbgPrintf(("UDPTransport::HandleNetworkEventInstance(): GetSndBuf(listenFd=%d) <= %u. bytes)", listenFd, sndSize)); #endif /* * Ditto for the receive side. The remote sides of connections may * conspire against us to have N fully utilized connections inbound from * different remotes to our single instance, but we cannot simply * allocate 300 megabytes of buffering, so we set the receive buffer to * SEGBMAX * SEGMAX as well, and limit buffer usage by letting UDP drop * inbound messages to rate limit overrunning connections. * * Just because we ask for this amount of buffer does not mean we will * get it. Systems provide a maximum number. On Linux, for example, * you can find the maximum value in /proc/sys/net/core/rmem_max. On my * Fedora 20- box it is set to 131071, so the doubled value returned by * GetRcvBuf() would be 262142. Consider changing this value on a * server-class system. * * Note that this is not a fatal error if it fails. We just may get less * buffer capacity than we might like. */ size_t rcvSize = m_ardpConfig.segmax * m_ardpConfig.segbmax; QCC_DbgPrintf(("UDPTransport::HandleNetworkEventInstance(): SetSndBuf(listenFd=%d, %u.)", listenFd, rcvSize)); status = qcc::SetRcvBuf(listenFd, rcvSize); if (status != ER_OK) { QCC_LogError(status, ("UDPTransport::HandleNetworkEventInstance(): SetRcvBuf() failed")); } #ifndef NDEBUG rcvSize = 0; qcc::GetRcvBuf(listenFd, rcvSize); QCC_DbgPrintf(("UDPTransport::HandleNetworkEventInstance(): GetRcvBuf(listenFd=%d) <= %u. bytes)", listenFd, rcvSize)); #endif QCC_DbgPrintf(("UDPTransport::HandleNetworkEventInstance(): Bind(listenFd=%d., listenAddr=\"%s\", listenPort=%u.)", listenFd, listenAddr.ToString().c_str(), listenPort)); status = Bind(listenFd, listenAddr, listenPort); if (status == ER_OK) { /* * If the port was not set (or set to zero) then we will have bound an ephemeral port. If * so call GetLocalAddress() to update the connect spec with the port allocated by bind. */ if (listenPort == 0) { qcc::GetLocalAddress(listenFd, listenAddr, listenPort); } if (wildcardIfaceRequested) { m_requestedInterfaces["*"] = qcc::IPEndpoint("0.0.0.0", listenPort); } else if (wildcardAddressRequested) { m_requestedAddressPortMap["0.0.0.0"] = listenPort; } else { if (currentIfaceRequested) { m_requestedInterfaces[interface] = qcc::IPEndpoint(m_requestedInterfaces[interface].GetAddress().ToString(), listenPort); } else if (currentAddressRequested) { m_requestedAddressPortMap[addressStr] = listenPort; } } qcc::String normSpec = "udp:addr=" + listenAddr.ToString() + ",port=" + U32ToString(listenPort); QCC_DbgPrintf(("UDPTransport::HandleNetworkEventInstance(): new normSpec=\"%s\"", normSpec.c_str())); /* * Okay, we're ready to receive datagrams on this socket now. Tell the * maintenance thread that something happened here and it needs to reload * its FDs. */ QCC_DbgPrintf(("UDPTransport::HandleNetworkEventInstance(): addeList.push_back(normSpec=\"%s\", listenFd=%d)", normSpec.c_str(), listenFd)); /* We make a list of the new listen specs on which we are listening so * that we can add those to the m_listenFds when we're done procesing * the list of network interfaces. */ addedList.push_back(pair(normSpec, listenFd)); } else { QCC_LogError(status, ("UDPTransport::HandleNetworkEventInstance(): Failed to bind to %s/%d", listenAddr.ToString().c_str(), listenPort)); } /* We update the map of interface names to port numbers * here to account for ephemeral ports since only at * this point do we know the actual ephemeral port number * after we call Bind() and are actually listening. */ if (wildcardIfaceRequested) { m_listenPortMap["*"] = listenPort; } else if (wildcardAddressRequested) { m_listenPortMap["0.0.0.0"] = listenPort; } else { if (currentIfaceRequested) { m_listenPortMap[interface] = listenPort; } else if (currentAddressRequested) { m_listenPortMap[addressStr] = listenPort; } } /* * The IP name service is very flexible about what to advertise. It assumes * that a so-called transport is going to be doing the advertising. An IP * transport, by definition, has a reliable data transmission capability and * an unreliable data transmission capability. In the IP world, reliable * data is sent using TCP and unreliable data is sent using UDP (we use UDP * but build a reliability layer on top of it). Also, IP implies either * IPv4 or IPv6 addressing. * * In the UDPTransport, we only support unreliable data transfer over IPv4 * addresses, so we leave all of the other possibilities turned off (provide * a zero port). Remember the port we enabled so we can re-enable the name * service if listeners come and go. */ QCC_DbgPrintf(("UDPTransport::HandleNetworkEventInstance(): IpNameService::Instance().Enable()")); IpNameService::Instance().Enable(TRANSPORT_UDP, std::map(), 0, m_listenPortMap, 0, false, false, true, false); /* * There is a special case in which we respond to embedded AllJoyn bus * attachements actively looking for daemons to connect to. We don't want * do blindly do this all the time so we can pass the Android Compatibility * Test, so we crank up an advertisement when we do the start listen (which * is why we bother to do all of the serialization of DoStartListen work * anyway). We make this a configurable advertisement so users of bundled * daemons can change the advertisement and know they are connecting to * "their" daemons if desired. * * We pull the advertisement prefix out of the configuration and if it is * there, we append the short GUID of the daemon to make it unique and then * advertise it quietly via the IP name service. The quietly option means * that we do not send gratuitous is-at (advertisements) of the name, but we * do respond to who-has requests on the name. */ if (EnableRouterAdvertisement()) { QCC_DbgPrintf(("UDPTransport::HandleNetworkEventInstance(): Advertise m_routerName=\"%s\"", m_routerName.c_str())); bool isFirst; NewAdvertiseOp(ENABLE_ADVERTISEMENT, m_routerName, isFirst); uint32_t availConn = m_maxConn - m_currConn; uint32_t availRemoteClientsUdp = m_maxRemoteClientsUdp - m_numUntrustedClients; availRemoteClientsUdp = std::min(availRemoteClientsUdp, availConn); IpNameService::Instance().UpdateDynamicScore(TRANSPORT_UDP, availConn, m_maxConn, availRemoteClientsUdp, m_maxRemoteClientsUdp); m_routerNameAdvertised = true; QStatus status = IpNameService::Instance().AdvertiseName(TRANSPORT_UDP, m_routerName, true, TRANSPORT_UDP); if (status != ER_OK) { QCC_LogError(status, ("UDPTransport::HandleNetworkEventInstance(): Failed to AdvertiseNameQuietly \"%s\"", m_routerName.c_str())); } m_isAdvertising = true; } m_isListening = true; m_isNsEnabled = true; /* If we have a wildcard specified in the configuration database, we want to stop * listening on all the non-wildcard addresses/ports we may have previously opened * and so we add all of those listen specs to the replaced list so we can stop * listening on those addresses/ports and just listen on IN_ADDR_ANY alone. We * also ensure that our listenPortMap only has a wildcard entry. */ if (wildcardIfaceRequested) { m_wildcardIfaceProcessed = true; for (std::map::const_iterator iter = m_requestedInterfaces.begin(); iter != m_requestedInterfaces.end(); iter++) { if (iter->first != "*" && iter->second.GetAddress() != qcc::IPAddress("0.0.0.0")) { qcc::String replacedSpec = "udp:addr=" + m_requestedInterfaces[iter->first].GetAddress().ToString() + ",port=" + U32ToString(m_requestedInterfaces[iter->first].GetPort()); m_listenPortMap.erase(iter->first); replacedList.push_back(replacedSpec); } } m_requestedInterfaces.clear(); m_requestedAddresses.clear(); m_requestedAddressPortMap.clear(); m_requestedInterfaces["*"] = qcc::IPEndpoint("0.0.0.0", listenPort); break; } else if (wildcardAddressRequested) { m_wildcardAddressProcessed = true; for (std::map::const_iterator iter = m_requestedAddresses.begin(); iter != m_requestedAddresses.end(); iter++) { if (iter->first != "0.0.0.0" && !iter->second.empty()) { qcc::String replacedSpec = "udp:addr=" + iter->first + ",port=" + U32ToString(m_listenPortMap[iter->first]); m_listenPortMap.erase(iter->first); replacedList.push_back(replacedSpec); } } m_requestedAddresses.clear(); m_requestedAddressPortMap.clear(); m_requestedAddresses["0.0.0.0"] = "*"; break; } } /* We add the listen specs to the m_listenFds at this point */ if (!addedList.empty()) { m_listenFdsLock.Lock(MUTEX_CONTEXT); for (list >::iterator it = addedList.begin(); it != addedList.end(); it++) { m_listenFds.push_back(*it); } m_reload = STATE_RELOADING; m_listenFdsLock.Unlock(MUTEX_CONTEXT); } /* * Signal the (probably) waiting run thread so it will wake up and add this * new socket to its list of sockets it is waiting for connections on. */ Alert(); DecrementAndFetch(&m_refCount); /* * We stop listening on all the listen specs that were replaced during the processing. * These listen specs usually represent the old IP addresses that are no longer in use. * In addition, if the last advertisement or discovery request was cancelled before * the relevant network interfaces became IFF_UP, we also stop listening. */ if (m_advertising.empty() && m_discovering.empty()) { for (list >::iterator it = addedList.begin(); it != addedList.end(); it++) { replacedList.push_back(it->first); } IpNameService::Instance().Enable(TRANSPORT_UDP, std::map(), 0, m_listenPortMap, 0, false, false, false, false); m_isListening = false; m_isNsEnabled = false; m_listenPortMap.clear(); m_pendingDiscoveries.clear(); m_pendingAdvertisements.clear(); m_wildcardIfaceProcessed = false; } for (list::iterator it = replacedList.begin(); it != replacedList.end(); it++) { DoStopListen(*it); } /* * If there were pending advertisements that came in before the network interfaces * became IFF_UP, we enable those pending advertisements. */ for (list::iterator it = m_pendingAdvertisements.begin(); it != m_pendingAdvertisements.end(); it++) { EnableAdvertisementInstance(*it); } m_pendingAdvertisements.clear(); /* * If there were pending discoveries that came in before the network interfaces * became IFF_UP, we enable those pending discoveries. */ for (list::iterator it = m_pendingDiscoveries.begin(); it != m_pendingDiscoveries.end(); it++) { EnableDiscoveryInstance(*it); } m_pendingDiscoveries.clear(); } void UDPTransport::CheckEndpointLocalMachine(UDPEndpoint endpoint) { #ifdef QCC_OS_GROUP_WINDOWS String ipAddrStr; endpoint->GetRemoteIp(ipAddrStr); std::vector entries; IfConfig(entries); for (uint32_t i = 0; i < entries.size(); i++) { if (ipAddrStr == entries[i].m_addr) { endpoint->SetGroupId(GetUsersGid(DESKTOP_APPLICATION)); break; } } #endif } ThreadReturn STDCALL UDPTransport::DynamicScoreUpdater::Run(void* arg) { QCC_UNUSED(arg); while (!IsStopping()) { Event::Wait(Event::neverSet); GetStopEvent().ResetEvent(); m_transport.UpdateRouterAdvertisementAndDynamicScore(); } return 0; } } // namespace ajn alljoyn-15.04b/alljoyn_core/router/UDPTransport.h000066400000000000000000001170431255700255500220670ustar00rootroot00000000000000/** * @file * UDPTransport is a specialization of class Transport for daemons talking over * UDP. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_UDPTRANSPORT_H #define _ALLJOYN_UDPTRANSPORT_H #ifndef __cplusplus #error Only include UDPTransport.h in C++ code. #endif #include #include #include #include #include #include #include #include #include #include #include #include #include "Transport.h" #include "RemoteEndpoint.h" #include "ArdpProtocol.h" #include "ns/IpNameService.h" #define WORKAROUND_1298 1 /**< Implement workaround for ASACORE-1298 */ namespace ajn { class ConnectEntry; bool operator<(const ConnectEntry& lhs, const ConnectEntry& rhs); class _UDPEndpoint; /**< Forward declaration for a class of endpoints implementing UDP Transport functionality */ class MessagePump; /**< Forward declaration for a class implementing an active message pump to move messages into the router */ #define N_PUMPS 8 /**< The number of message pumps and possibly concurrent threads we use to move messages */ typedef qcc::ManagedObj<_UDPEndpoint> UDPEndpoint; /** * @brief A class for UDP Transports used in daemons. */ class UDPTransport : public Transport, public _RemoteEndpoint::EndpointListener, public qcc::Thread { friend class MessagePump; friend class _UDPEndpoint; friend class ArdpStream; public: class DynamicScoreUpdater : public qcc::Thread { public: DynamicScoreUpdater(UDPTransport& transport) : m_transport(transport) { }; virtual qcc::ThreadReturn STDCALL Run(void* arg); private: UDPTransport& m_transport; }; friend class DynamicScoreUpdater; /** * Create a UDP based transport for use by daemons. * * @param bus The BusAttachment associated with this endpoint */ UDPTransport(BusAttachment& bus); /** * Destructor */ virtual ~UDPTransport(); /** * Start the transport and associate it with a router. * * @return * - ER_OK if successful. * - an error status otherwise. */ QStatus Start(); /** * Stop the transport. * * @return * - ER_OK if successful. * - an error status otherwise. */ QStatus Stop(); /** * Pend the caller until the transport stops. * * @return * - ER_OK if successful * - an error status otherwise. */ QStatus Join(); /** * Determine if this transport is running. Running means Start() has been called. * * @return Returns true if the transport is running. */ bool IsRunning() { return Thread::IsRunning(); } /** * @internal * @brief Normalize a transport specification. * * Given a transport specification, convert it into a form which is guaranteed to * have a one-to-one relationship with a connection instance. * * @param inSpec Input transport connect spec. * @param outSpec Output transport connect spec. * @param argMap Parsed parameter map. * * @return ER_OK if successful. */ QStatus NormalizeTransportSpec(const char* inSpec, qcc::String& outSpec, std::map& argMap) const; /** * Connect to a specified remote AllJoyn/DBus address. * * @param connectSpec Transport specific key/value args used to configure the client-side endpoint. * The form of this string is @c ":=,=..." * @param opts Requested sessions opts. * @param newep [OUT] Endpoint created as a result of successful connect. * @return * - ER_OK if successful. * - an error status otherwise. */ QStatus Connect(const char* connectSpec, const SessionOpts& opts, BusEndpoint& newep); /** * Start listening for incomming connections on a specified bus address. * * @param listenSpec Transport specific key/value arguments that specify the physical interface to listen on. * - Valid transport is @c "udp". All others ignored. * - Valid keys are: * - @c addr = IP address of server to connect to. * - @c port = Port number of server to connect to. * * @return * - ER_OK if successful. * - an error status otherwise. */ QStatus StartListen(const char* listenSpec); /** * @brief Stop listening for incomming connections on a specified bus address. * * This method cancels a StartListen request. Therefore, the listenSpec must * match previous call to StartListen(). * * @param listenSpec Transport specific key/value arguments that specify the physical interface to listen on. * - Valid transport is @c "udp". All others ignored. * - Valid keys are: * - @c addr = IP address of server to connect to. * - @c port = Port number of server to connect to. * * @return * - ER_OK if successful. * - an error status otherwise. */ QStatus StopListen(const char* listenSpec); /** * Set a listener for transport related events. There can only be one * listener set at a time. Setting a listener implicitly removes any * previously set listener. * * @param listener Listener for transport related events. */ void SetListener(TransportListener* listener) { m_listener = listener; } /** * @internal * @brief Start discovering busses. */ void EnableDiscovery(const char* namePrefix, TransportMask transports); /** * @internal * @brief Stop discovering busses. */ void DisableDiscovery(const char* namePrefix, TransportMask transports); /** * Start advertising a well-known name with a given quality of service. * * @param advertiseName Well-known name to add to list of advertised names. * @param quietly Advertise the name quietly * @return * - ER_OK if successful. * - an error status otherwise. */ QStatus EnableAdvertisement(const qcc::String& advertiseName, bool quietly, TransportMask transports); /** * Stop advertising a well-known name with a given quality of service. * * @param advertiseName Well-known name to remove from list of advertised names. */ void DisableAdvertisement(const qcc::String& advertiseName, TransportMask transports); bool EnableRouterAdvertisement(); bool DisableRouterAdvertisement(); void UpdateRouterAdvertisementAndDynamicScore(); /** * Returns the name of this transport */ const char* GetTransportName() const { return TransportName; } /** * Get the transport mask for this transport * * @return the TransportMask for this transport. */ TransportMask GetTransportMask() const { return TRANSPORT_UDP; } /** * Get a list of the possible listen specs of the current Transport for a * given set of session options. * * Session options specify high-level characteristics of session, such as * whether or not the underlying transport carries data encapsulated in * AllJoyn messages, and whether or not delivery is reliable. * * It is possible that there is more than one answer to the question: what * abstract address should I use when talking to another endpoint. Each * Transports is equipped to understand how many answers there are and also * which answers are better than the others. This method fills in the * provided vector with a list of currently available busAddresses ordered * according to which the transport thinks would be best. * * If there are no addresses appropriate to the given session options the * provided vector of String is left unchanged. If there are addresses, * they are added at the end of the provided vector. * * @param opts Session options describing the desired characteristics of * an underlying session * @param busAddrs A vector of String to which bus addresses corresponding * to IFF_UP interfaces matching the desired characteristics * are added. * @return * - ER_OK if successful. * - an error status otherwise. */ QStatus GetListenAddresses(const SessionOpts& opts, std::vector& busAddrs) const; /** * Does this transport support connections as described by the provided * session options. * * @param opts Proposed session options. * @return * - true if the SessionOpts specifies a supported option set. * - false otherwise. */ bool SupportsOptions(const SessionOpts& opts) const; /** * Indicates whether this transport is used for client-to-bus or bus-to-bus connections. * * @return Always returns true, UDP is a bus-to-bus transport. */ bool IsBusToBus() const { return true; } /** * Callback for UDPEndpoint exit. * * @param endpoint UDPEndpoint instance that has exited. */ void EndpointExit(RemoteEndpoint& endpoint); /** * Name of transport used in transport specs. */ static const char* TransportName; class ConnectEntry; class ConnectEntry { public: ConnectEntry(qcc::Thread* thread, ArdpConnRecord* conn, uint32_t connId, qcc::Event* event) : m_thread(thread), m_conn(conn), m_connId(connId), m_event(event) { } friend bool operator<(const ConnectEntry& lhs, const ConnectEntry& rhs); qcc::Thread* m_thread; ArdpConnRecord* m_conn; uint32_t m_connId; qcc::Event* m_event; }; private: /** * Empty private overloaded virtual function for Thread::Start * this avoids the overloaded-virtual warning. For the Thread::Start * function. */ QStatus Start(void* arg, qcc::ThreadListener* listener) { return Thread::Start(arg, listener); } UDPTransport(const UDPTransport& other); UDPTransport& operator =(const UDPTransport& other); /** * This function will check the given endpoint to see if it is running on the same machine or not * by comparing the connecting IP address with the local machine's addresses. If there is a match * then this app is running on the local machine. Windows Universal Applications aren't allowed * to use the loopback interface so this must be a Desktop Application, set the group ID * accordingly. Since this code is only needed on Windows it is inside #ifdef * QCC_OS_GROUP_WINDOWS. * * @param endpoint The endpoint to check and set the group ID on */ static void CheckEndpointLocalMachine(UDPEndpoint endpoint); BusAttachment& m_bus; /**< The message bus for this transport */ mutable volatile int32_t m_refCount; /**< Incremented if a thread is doing something somewhere */ bool m_stopping; /**< True if Stop() has been called but endpoints still exist */ bool m_routerNameAdvertised; /**< True if routerName is advertised */ TransportListener* m_listener; /**< Registered TransportListener */ std::set m_preList; /**< "Pre" list of authenticating endpoints (see AcceptCb comments) */ qcc::Mutex m_preListLock; /**< Mutex that protects the endpoint and auth lists */ std::set m_authList; /**< List of authenticating endpoints */ std::set m_endpointList; /**< List of active endpoints */ std::set m_connectThreads; /**< List of threads starting up active endpoints */ qcc::Mutex m_endpointListLock; /**< Mutex that protects the endpoint and auth lists */ MessagePump* m_messagePumps[N_PUMPS]; /**< array of MessagePumps (with possiblly running pump threads) */ std::list > m_listenFds; /**< File descriptors the transport is listening on */ qcc::Mutex m_listenFdsLock; /**< Mutex that protects m_listenFds */ std::list m_listenSpecs; /**< Listen specs clients have requested us to listen on */ qcc::Mutex m_listenSpecsLock; /**< Mutex that protects m_listenSpecs */ std::list m_discovering; /**< Name prefixes the transport is looking for */ std::list m_advertising; /**< Names the transport is advertising */ std::list m_listening; /**< ListenSpecs on which the transport is listening */ qcc::Mutex m_discoLock; /**< Mutex that protects discovery and advertisement lists */ /** * @internal * @brief Commmand codes sent to the server accept loop thread. */ enum RequestOp { START_LISTEN_INSTANCE, /**< A StartListen() has happened */ STOP_LISTEN_INSTANCE, /**< A StopListen() has happened */ ENABLE_ADVERTISEMENT_INSTANCE, /**< An EnableAdvertisement() has happened */ DISABLE_ADVERTISEMENT_INSTANCE, /**< A DisableAdvertisement() has happened */ ENABLE_DISCOVERY_INSTANCE, /**< An EnableDiscovery() has happened */ DISABLE_DISCOVERY_INSTANCE, /**< A DisableDiscovery() has happened */ HANDLE_NETWORK_EVENT, /**< A network event has happened */ UPDATE_DYNAMIC_SCORE_INSTANCE /**< A change to the dynamic score has happened */ }; /** * @internal * @brief Request code for communicating StartListen, StopListen requests * and started-advertising and stopped-advertising notifications to the * server accept loop thread. */ class ListenRequest { public: RequestOp m_requestOp; qcc::String m_requestParam; bool m_requestParamOpt; TransportMask m_requestTransportMask; std::map ifMap; }; qcc::Mutex m_listenRequestsLock; /**< Mutex that protects m_listenRequests */ /** * @internal * @brief Log Warnings if endpoints are not progressing throughg states as expected */ void EmitStallWarnings(UDPEndpoint& ep); /** * @internal * @brief Manage the list of endpoints for the transport. */ void ManageEndpoints(qcc::Timespec authTimeout, qcc::Timespec sessionSetupTimeout); /** * @internal * @brief Thread entry point. * * @param arg Unused thread entry arg. */ qcc::ThreadReturn STDCALL Run(void* arg); /** * @internal * @brief Queue a StartListen request for the server accept loop * * The server accept loop (executing in UDPTransport::Run() uses the * socket FD resources that are used to listen on the endpoints specified * by the listenSpec parameters. Creation and deletion of these resources * then happen with the involvement of two threads. * * In order to serialize the creation, deletion and use of these resources * we only change them in one place -- in the server accept loop. This * means that we need to queue requests to start and stop listening on a * given listen spec to the accept loop thread. * * The sequence of events for StartListen() is then: * * 1. The client calls StartListen(). * 2. StartListen() calls QueueStartListen() to send a request to the * server accept loop thread. * 3. The server accept loop thread picks up the request and calls * DoStartListen() which allocates the resources. * * A similar sequence happens for StopListen(). * * @param listenSpec A String containing the string specifying the address * and port to listen on. * * @see QueueStartListen * @see DoStartListen * @see StopListen */ void QueueStartListen(qcc::String& listenSpec); /** * @internal @brief Perform the work required for a StartListen request * (doing it in the context of the server accept loop thread) * * @param listenSpec A String containing the string specifying the address * and port to listen on. * * @see StartListen * @see QueueStartListen */ QStatus DoStartListen(qcc::String& listenSpec); /** * @internal * @brief Queue a StopListen request for the server accept loop * * The server accept loop (executing in UDPTransport::Run() uses the * socket FD resources that are used to listen on the endpoints specified * by the listenSpec parameters. Creation and deletion of these resources * then happen with the involvement of two threads. * * In order to serialize the creation, deletion and use of these resources * we only change them in one place -- the server accept loop. This means * that we need to queue requests to start and stop listening on a given * listen spec to the accept loop thread. * * The sequence of events for StopListen() is then: * * 1. The client calls StopListen(). * 2. StopListen() calls QueueStopListen() to send a request to the * server accept loop thread. * 3. The server accept loop thread picks up the request and calls * DoStopListen() which allocates the resources. * * A similar sequence happens for StartListen(). * * @param listenSpec A String containing the string specifying the address * and port to stop listening on. * * @see QueueStopListen * @see DoStopListen * @see StartListen */ void QueueStopListen(qcc::String& listenSpec); /** * @internal @brief Perform the work required for a StopListen request * (doing it in the context of the server accept loop thread) * * @param listenSpec A String containing the string specifying the address * and port to stop listening on. * * @see StopListen * @see QueueStopListen */ void DoStopListen(qcc::String& listenSpec); void QueueHandleNetworkEvent(const std::map&); /** * @internal * @brief Authentication complete notificiation. * * @param conn Reference to the UDPEndpoint that completed authentication. */ void Authenticated(UDPEndpoint& conn); /** * @internal * @brief Normalize a listen specification. * * Given a listen specification (which is the same as a transport * specification but with relaxed semantics allowing defaults), convert * it into a form which is guaranteed to have a one-to-one relationship * with a listener instance. * * @param inSpec Input transport connect spec. * @param outSpec Output transport connect spec. * @param argMap Parsed parameter map. * * @return ER_OK if successful. */ QStatus NormalizeListenSpec(const char* inSpec, qcc::String& outSpec, std::map& argMap) const; class FoundCallback { public: FoundCallback(TransportListener*& listener) : m_listener(listener) { } void Found(const qcc::String& busAddr, const qcc::String& guid, std::vector& nameList, uint32_t timer); private: /* Private assigment operator - does nothing */ FoundCallback operator=(const FoundCallback&); TransportListener*& m_listener; }; FoundCallback m_foundCallback; /**< Called by IpNameService when new busses are discovered */ class NetworkEventCallback { public: NetworkEventCallback(UDPTransport& transport) : m_transport(transport) { } void Handler(const std::map&); private: /* Private assigment operator - does nothing */ NetworkEventCallback operator=(const NetworkEventCallback&); UDPTransport& m_transport; }; NetworkEventCallback m_networkEventCallback; /**< Called by IpNameService when new network interfaces come up */ /** * @brief The default timeout for in-process authentications. * * The authentication process can be used as the basis of a denial of * service attack by simply stopping in mid-authentication. If an * authentication takes longer than this number of milliseconds, it may be * summarily aborted if another connection comes in. This value can be * overridden in the config file by setting "auth_timeout". */ static const uint32_t ALLJOYN_AUTH_TIMEOUT_DEFAULT = 20000; /** * @brief The default timeout for session establishment following authentication. * * The session establishment process can be used as the basis of a denial of * service attack by simply not sending the AttachSession. If the session * establishment takes longer than this number of milliseconds, it may be * summarily aborted if another connection comes in. This value can be * overridden in the config file by setting "session_setup_timeout". The 30 second * number comes from the the timeout used for AttachSession method calls which is * 30 seconds. */ static const uint32_t ALLJOYN_SESSION_SETUP_TIMEOUT_DEFAULT = 30000; /** * @brief The default value for the maximum number of authenticating * connections. * * This corresponds to the configuration item "max_incomplete_connections" * in the DBus configuration, but it applies only to the UDP transport. To * override this value, change the limit, "max_incomplete_connections_udp". * Typically, DBus sets this value to 10,000 which is essentially infinite * from the perspective of a phone. Since this represents a transient state * in connection establishment, there should be few connections in this * state, so we default to a quite low number. */ static const uint32_t ALLJOYN_MAX_INCOMPLETE_CONNECTIONS_UDP_DEFAULT = 10; /** * @brief The default value for the maximum number of UDP connections * (remote endpoints). * * This corresponds to the configuration item "max_completed_connections" * in the DBus configuration, but it applies only to the UDP transport. * To override this value, change the limit, "max_completed_connections_udp". * Typically, DBus sets this value to 100,000 which is essentially infinite * from the perspective of a phone. Since we expect bus topologies to be * relatively small, we default to a quite low number. * * @warning This maximum is enforced on incoming connections only. An * AllJoyn daemon is free to form as many outbound connections as it pleases * but if the total number of connections exceeds this value, no inbound * connections will be accepted. This is because we are defending against * attacks from "abroad" and trust ourselves implicitly. */ static const uint32_t ALLJOYN_MAX_COMPLETED_CONNECTIONS_UDP_DEFAULT = 50; /** * @brief The default value for the maximum number of remote clients over udp. * * This corresponds to the configuration item "max_remote_clients_udp" * To override this value, change the limit, "max_remote_clients_udp". * * @warning This maximum is enforced on incoming connections from untrusted clients over udp. * This is to limit the amount of resources being used by untrusted clients over udp. */ static const uint32_t ALLJOYN_MAX_REMOTE_CLIENTS_UDP_DEFAULT = 0; /** * @brief The default value for the router advertisement prefix that untrusted thin clients * will use for the discovery of the daemon. * * This corresponds to the configuration item "router_advertisement_prefix" * To override this value, change the limit, "router_advertisement_prefix". * */ static const char* const ALLJOYN_DEFAULT_ROUTER_ADVERTISEMENT_PREFIX; /* * The Android Compatibility Test Suite (CTS) is used by Google to enforce a * common idea of what it means to be Android. One of their tests is to * make sure there are no UDP or UDP listeners in running processes when the * phone is idle. Since we want to be able to run our daemon on idle phones * and manufacturers want their Android phones to pass the CTS, we have got * to be able to shut off our listeners unless they are actually required. * * To do this, we need to keep track of whether or not the daemon is * actively advertising or discovering. To this end, we keep track of the * advertise and discover calls, and if there are any outstanding (not * canceled) we enable the Name Service to talk to the outside world. If * there are no outstanding operations, we tell the Name Service to shut up. * * There is nothing preventing us from receiving multiple identical * discovery and advertisement requests, so we allow multiple instances of * an identical name on the list. We could reference count the entries, but * this seems like a relatively rare condition, so we take the * straightforward approach. */ enum DiscoveryOp { ENABLE_DISCOVERY, /**< A request to start a discovery has been received */ DISABLE_DISCOVERY /**< A request to cancel a discovery has been received */ }; enum AdvertiseOp { ENABLE_ADVERTISEMENT, /**< A request to start advertising has been received */ DISABLE_ADVERTISEMENT /**< A request to cancel advertising has been received */ }; enum ListenOp { START_LISTEN, /**< A request to start listening has been received */ STOP_LISTEN /**< A request to stop listening has been received */ }; /** * @brief Add or remove a discover indication. * * The transport has received a new discovery operation. This will either * be an EnableDiscovery() or DisbleDiscovery() discriminated by the * DiscoveryOp enum. * * We want to keep a list of name prefixes that are currently active for * well-known name discovery. The presence of a non-zero size of this list * indicates discovery is in-process and the Name Service should be kept * alive (it can be listening for inbound packets in particular). * * @return true if the list of discoveries is empty as a result of the * operation. */ bool NewDiscoveryOp(DiscoveryOp op, qcc::String namePrefix, bool& isFirst); /** * @brief Add or remove an advertisement indication. * * Called when the transport has received a new advertisement operation. * This will either be an EnableAdvertisement() or DisbleAdvertisement() * discriminated by the AdvertiseOp enum. * * We want to keep a list of names that are currently being advertised. The * presence of a non-zero size of this list indicates that at least one * advertisement is in-process and the Name Service should be kept alive to * respond to WHO_HAS queries. * * @return true if the list of advertisements is empty as a result of the * operation. */ bool NewAdvertiseOp(AdvertiseOp op, qcc::String name, bool& isFirst); /** * @brief Add or remove a listen operation. * * Called when the transport has received a new listen operation. * This will either be an StartListen() or StopListen() * discriminated by the ListenOp enum. * * We want to keep a list of listen specs that are currently being listened * on. This lest is kept so we can tear down the listeners if there are no * advertisements and recreate it if an advertisement is started. * * This is keep UDP from having a listener so that the Android Compatibility * test suite can pass with when the daemon is in the quiescent state. * * @return true if the list of listeners is empty as a result of the * operation. */ bool NewListenOp(ListenOp op, qcc::String name); void QueueEnableDiscovery(const char* namePrefix, TransportMask transports); void QueueDisableDiscovery(const char* namePrefix, TransportMask transports); void QueueEnableAdvertisement(const qcc::String& advertiseName, bool quietly, TransportMask transports); void QueueDisableAdvertisement(const qcc::String& advertiseName, TransportMask transports); void QueueUpdateRouterAdvertisementAndDynamicScore(); void RunListenMachine(ListenRequest& listenRequest); void StartListenInstance(ListenRequest& listenRequest); void StopListenInstance(ListenRequest& listenRequest); void EnableAdvertisementInstance(ListenRequest& listenRequest); void DisableAdvertisementInstance(ListenRequest& listenRequest); void EnableDiscoveryInstance(ListenRequest& listenRequest); void DisableDiscoveryInstance(ListenRequest& listenRequest); void HandleNetworkEventInstance(ListenRequest& listenRequest); void UpdateDynamicScoreInstance(ListenRequest& listenRequest); void UntrustedClientExit(); QStatus UntrustedClientStart(); bool m_isAdvertising; bool m_isDiscovering; bool m_isListening; bool m_isNsEnabled; enum ReloadState { STATE_RELOADING = 0, /**< The set of listen FDs has changed and needs to be reloaded by the main thread */ STATE_RELOADED, /**< The set of listen FDs has been reloaded by the main thread */ STATE_EXITED /**< The main UDPTransport thread has exited */ }; ReloadState m_reload; /**< Flag used for synchronization of DoStopListen with the Run thread */ enum ManageState { STATE_MANAGE = 0, /**< The state of the endpoints has changed and needs to be managed by the main thread */ STATE_MANAGED /**< The state of the endpoints has been managed by the main thread */ }; ManageState m_manage; /**< Flag used for synchronization of ManageEndpoints() */ std::map m_listenPortMap; /**< If m_isListening, a map of the ports on which we are listening on different interfaces/addresses */ std::map m_requestedInterfaces; /**< A map of requested interfaces and corresponding IP addresses/ports or defaults */ std::map m_requestedAddresses; /**< A map of requested IP addresses to interfaces or defaults */ std::map m_requestedAddressPortMap; /**< A map of requested IP addresses to ports */ std::list m_pendingAdvertisements; /**< A list of advertisement requests that came in while no interfaces were yet IFF_UP */ std::list m_pendingDiscoveries; /**< A list of discovery requests that came in while no interfaces were yet IFF_UP */ int32_t m_nsReleaseCount; /**< the number of times we have released the name service singleton */ bool m_wildcardIfaceProcessed; /**< flag to avoid processing network events if we have a wildcard interface request */ bool m_wildcardAddressProcessed; /**< The router advertisement prefix set in the configuration file appended with the BusController's unique name */ qcc::String m_routerName; int32_t m_maxRemoteClientsUdp; /**< the maximum number of untrusted clients allowed at any point of time */ int32_t m_numUntrustedClients; /**< Number of untrusted clients currently registered with the daemon */ /** * authTimeout is the maximum amount of time we allow incoming connections to * mess about while they should be authenticating. If they take longer * than this time, we feel free to disconnect them as deniers of service. */ qcc::Timespec m_authTimeout; /** * sessionSetupTimeout is the maximum amount of time we allow incoming connections to * mess about while they should be sending messages to set up the session routes. * If they take longer than this time, we feel free to disconnect them as deniers of service. */ qcc::Timespec m_sessionSetupTimeout; /** * m_maxAuth is the maximum number of incoming connections that can be in * the process of authenticating. If starting to authenticate a new * connection would mean exceeding this number, we drop the new connection. */ uint32_t m_maxAuth; /** * m_maxConn is the maximum number of active connections possible over the * UDP transport. If starting to process a new connection would mean * exceeding this number, we reject the new connection. */ uint32_t m_maxConn; /** * m_currAuth is the current number of incoming connections that are in the * process of authenticating. If starting to authenticate a new connection * would mean this number exceeding m_maxAuth, we reject the new connection. */ volatile int32_t m_currAuth; /** * m_currConn is current number of active connections running over the * UDP transport. If starting to process a new connection would mean * this number exceeds m_maxConn, we reject the new connection. */ volatile int32_t m_currConn; qcc::Mutex m_connLock; /**< m_currAuth and m_currConn must be changed atomically, so need to be mutex protected */ DynamicScoreUpdater m_dynamicScoreUpdater; /** * arcpConfig are the limits from the daemon configuration database relating * to the various configurable settings for the ARDP protocol. */ ArdpGlobalConfig m_ardpConfig; qcc::Mutex m_ardpLock; /**< Since written for embedded as well as daemon environments, ARDP is not thread-safe */ qcc::Mutex m_cbLock; /**< Lock to synchronize interactions between callback contexts and other threads */ ArdpHandle* m_handle; /** * MessageDispatcherThread handles AllJoyn messages that have been received * by the transport and need to be sent of into the daemon router and off * to a destination. */ class DispatcherThread : public qcc::Thread { public: DispatcherThread(UDPTransport* transport) : qcc::Thread(qcc::String("UDP Dispatcher")), m_transport(transport) { } void ThreadExit(Thread* thread); protected: qcc::ThreadReturn STDCALL Run(void* arg); private: UDPTransport* m_transport; }; DispatcherThread* m_dispatcher; /** Pointer to the message dispatcher thread for the transport */ /** * MessageDispatcherThread handles EndpointExit processing to avoid deadlock * in cases where DaemonRouter::UnregisterEndpoint() calls back out into * PushMessage() due to NameChanged. */ class ExitDispatcherThread : public qcc::Thread { public: ExitDispatcherThread(UDPTransport* transport) : qcc::Thread(qcc::String("UDP Exit Dispatcher")), m_transport(transport) { } void ThreadExit(Thread* thread); protected: qcc::ThreadReturn STDCALL Run(void* arg); private: UDPTransport* m_transport; }; ExitDispatcherThread* m_exitDispatcher; /** Pointer to the exit dispatcher thread for the transport */ class WorkerCommandQueueEntry { public: WorkerCommandQueueEntry() : m_command(NONE), m_handle(NULL), m_conn(NULL), m_connId(0), m_rcv(NULL), m_passive(false), m_buf(NULL), m_len(0), m_status(ER_OK) { } enum Command { NONE, EXIT, CONNECT_CB, DISCONNECT_CB, RECV_CB, SEND_CB }; Command m_command; ArdpHandle* m_handle; ArdpConnRecord* m_conn; uint32_t m_connId; ArdpRcvBuf* m_rcv; bool m_passive; uint8_t* m_buf; uint32_t m_len; QStatus m_status; }; std::queue m_workerCommandQueue; /** Queue of commands to dispatch to the router */ qcc::Mutex m_workerCommandQueueLock; /**< Lock to synchronize access to the message dispatcher command queue */ std::queue m_exitWorkerCommandQueue; /** Queue of exit commands to dispatch to the router */ qcc::Mutex m_exitWorkerCommandQueueLock; /**< Lock to synchronize access to the exit dispatcher command queue */ #if WORKAROUND_1298 bool m_done1298; /**< True if workaround for "socket closed during CancelAdvertise" issue (ASACORE-1298) has been done */ #endif #ifndef NDEBUG void DebugPreListCheck(UDPEndpoint uep); void DebugAuthListCheck(UDPEndpoint uep); void DebugEndpointListCheck(UDPEndpoint uep); #endif #if ARDP_TESTHOOKS static void ArdpSendToSGHook(ArdpHandle* handle, ArdpConnRecord* conn, TesthookSource source, qcc::ScatterGatherList& msgSG); static void ArdpSendToHook(ArdpHandle* handle, ArdpConnRecord* conn, TesthookSource source, void* buf, uint32_t len); static void ArdpRecvFromHook(ArdpHandle* handle, ArdpConnRecord* conn, TesthookSource source, void* buf, uint32_t len); #endif static bool ArdpAcceptCb(ArdpHandle* handle, qcc::IPAddress ipAddr, uint16_t ipPort, ArdpConnRecord* conn, uint8_t* buf, uint16_t len, QStatus status); static void ArdpConnectCb(ArdpHandle* handle, ArdpConnRecord* conn, bool passive, uint8_t* buf, uint16_t len, QStatus status); static void ArdpDisconnectCb(ArdpHandle* handle, ArdpConnRecord* conn, QStatus status); static void ArdpRecvCb(ArdpHandle* handle, ArdpConnRecord* conn, ArdpRcvBuf* rcv, QStatus status); static void ArdpSendCb(ArdpHandle* handle, ArdpConnRecord* conn, uint8_t* buf, uint32_t len, QStatus status); static void ArdpSendWindowCb(ArdpHandle* handle, ArdpConnRecord* conn, uint16_t window, QStatus status); bool AcceptCb(ArdpHandle* handle, qcc::IPAddress ipAddr, uint16_t ipPort, ArdpConnRecord* conn, uint8_t* buf, uint16_t len, QStatus status); void ConnectCb(ArdpHandle* handle, ArdpConnRecord* conn, bool passive, uint8_t* buf, uint16_t len, QStatus status); void DoConnectCb(ArdpHandle* handle, ArdpConnRecord* conn, uint32_t connId, bool passive, uint8_t* buf, uint16_t len, QStatus status); void DisconnectCb(ArdpHandle* handle, ArdpConnRecord* conn, QStatus status); void RecvCb(ArdpHandle* handle, ArdpConnRecord* conn, ArdpRcvBuf* rcv, QStatus status); void SendCb(ArdpHandle* handle, ArdpConnRecord* conn, uint8_t* buf, uint32_t len, QStatus status); void SendWindowCb(ArdpHandle* handle, ArdpConnRecord* conn, uint16_t window, QStatus status); void ExitEndpoint(uint32_t connId); }; } // namespace ajn #endif // _ALLJOYN_UDPTRANSPORT_H alljoyn-15.04b/alljoyn_core/router/VirtualEndpoint.cc000066400000000000000000000266621255700255500230150ustar00rootroot00000000000000/** * @file * A VirtualEndpoint is a representation of an AllJoyn endpoint that exists behind a remote * AllJoyn daemon. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include "VirtualEndpoint.h" #include "EndpointHelper.h" #include #define QCC_MODULE "ALLJOYN_OBJ" using namespace std; using namespace qcc; namespace ajn { _VirtualEndpoint::_VirtualEndpoint(const String& uniqueName, RemoteEndpoint& b2bEp) : _BusEndpoint(ENDPOINT_TYPE_VIRTUAL), m_uniqueName(uniqueName), m_hasRefs(false), m_epState(EP_STARTED) { /** * Set the Virtual Endpoint's user and group IDs from the bus-to-bus endpoint since * that is the machine that we are connecting to the remote endpoint through. */ SetUserId(b2bEp->GetUserId()); SetGroupId(b2bEp->GetGroupId()); m_b2bEndpoints.insert(pair(0, b2bEp)); } QStatus _VirtualEndpoint::PushMessage(Message& msg) { return PushMessage(msg, msg->GetSessionId()); } QStatus _VirtualEndpoint::PushMessage(Message& msg, SessionId id) { QCC_DbgTrace(("_VirtualEndpoint::PushMessage(this=%s [%x], SessionId=%u)", GetUniqueName().c_str(), this, id)); QStatus status = ER_BUS_NO_ROUTE; vector tryEndpoints; /* * There may be multiple routes from this virtual endpoint so we are going to try all of * them until we either succeed or run out of options. */ m_b2bEndpointsLock.Lock(MUTEX_CONTEXT); if (id != 0) { for (multimap::iterator it = m_b2bEndpoints.lower_bound(id); (it != m_b2bEndpoints.end()) && (id == it->first); ++it) { RemoteEndpoint ep = it->second; tryEndpoints.push_back(ep); } } else { /* * When the session ID is 0, any b2bEp is a valid choice. Prefer the * ones that are directly connected, which we can tell by comparing the * GUIDs. */ String thisShortGuid = GetRemoteGUIDShortString(); for (multimap::iterator it = m_b2bEndpoints.begin(); (it != m_b2bEndpoints.end()) && (id == it->first); ++it) { RemoteEndpoint ep = it->second; String epShortGuid = ep->GetRemoteName().substr(1, ep->GetRemoteName().find_last_of('.') - 1); if (thisShortGuid == epShortGuid) { tryEndpoints.push_back(ep); } } for (multimap::iterator it = m_b2bEndpoints.begin(); (it != m_b2bEndpoints.end()) && (id == it->first); ++it) { RemoteEndpoint ep = it->second; String epShortGuid = ep->GetRemoteName().substr(1, ep->GetRemoteName().find_last_of('.') - 1); if (thisShortGuid != epShortGuid) { tryEndpoints.push_back(ep); } } } m_b2bEndpointsLock.Unlock(MUTEX_CONTEXT); /* * We got the candidates so now try them all. */ for (vector::iterator iter = tryEndpoints.begin(); iter != tryEndpoints.end(); ++iter) { if (status != ER_OK) { status = (*iter)->PushMessage(msg); } } return status; } RemoteEndpoint _VirtualEndpoint::GetBusToBusEndpoint(SessionId sessionId, int* b2bCount) const { RemoteEndpoint ret; if (b2bCount) { *b2bCount = 0; } m_b2bEndpointsLock.Lock(MUTEX_CONTEXT); multimap::const_iterator it = m_b2bEndpoints.lower_bound(sessionId); while ((it != m_b2bEndpoints.end()) && (it->first == sessionId)) { if (!ret->IsValid()) { ret = it->second; } if (b2bCount) { (*b2bCount)++; } ++it; } m_b2bEndpointsLock.Unlock(MUTEX_CONTEXT); return ret; } std::multimap _VirtualEndpoint::GetBusToBusEndpoints() const { m_b2bEndpointsLock.Lock(MUTEX_CONTEXT); std::multimap b2bEndpoints = m_b2bEndpoints; m_b2bEndpointsLock.Unlock(MUTEX_CONTEXT); return b2bEndpoints; } bool _VirtualEndpoint::AddBusToBusEndpoint(RemoteEndpoint& endpoint) { QCC_DbgTrace(("_VirtualEndpoint::AddBusToBusEndpoint(this=%s, b2b=%s)", GetUniqueName().c_str(), endpoint->GetUniqueName().c_str())); m_b2bEndpointsLock.Lock(MUTEX_CONTEXT); /* Sanity check */ assert(m_epState == EP_STARTED); multimap::iterator it = m_b2bEndpoints.begin(); bool found = false; while ((it != m_b2bEndpoints.end()) && (it->first == 0)) { if (it->second == endpoint) { found = true; break; } ++it; } if (!found) { m_b2bEndpoints.insert(pair(0, endpoint)); } m_b2bEndpointsLock.Unlock(MUTEX_CONTEXT); return !found; } void _VirtualEndpoint::GetSessionIdsForB2B(RemoteEndpoint& endpoint, set& sessionIds) { m_b2bEndpointsLock.Lock(MUTEX_CONTEXT); multimap::iterator it = m_b2bEndpoints.begin(); while (it != m_b2bEndpoints.end()) { if (it->first && (it->second == endpoint)) { sessionIds.insert(it->first); } ++it; } m_b2bEndpointsLock.Unlock(MUTEX_CONTEXT); } bool _VirtualEndpoint::HasSession(SessionId sessionId) { m_b2bEndpointsLock.Lock(MUTEX_CONTEXT); bool found = false; multimap::iterator it = m_b2bEndpoints.lower_bound(sessionId); if (it != m_b2bEndpoints.end() && (it->first == sessionId)) { found = true; } m_b2bEndpointsLock.Unlock(MUTEX_CONTEXT); return found; } bool _VirtualEndpoint::RemoveBusToBusEndpoint(RemoteEndpoint& endpoint) { QCC_DbgTrace(("_VirtualEndpoint::RemoveBusToBusEndpoint(this=%s, b2b=%s)", GetUniqueName().c_str(), endpoint->GetUniqueName().c_str())); m_b2bEndpointsLock.Lock(MUTEX_CONTEXT); multimap::iterator it = m_b2bEndpoints.begin(); while (it != m_b2bEndpoints.end()) { if (it->second == endpoint) { /* A non-zero session means that the b2b has one less ref */ if (it->first != 0) { it->second->DecrementRef(); } m_b2bEndpoints.erase(it++); } else { ++it; } } /* * This Virtual endpoint reports itself as empty (of b2b endpoints) when any of the following are true: * 1) The last b2b ep is being removed. * 2) A last session route through this vep is being removed and the b2bEp being removed doesnt connect to the same * remote daemon directly. * * This algorithm allows for cleanup of the following triangular routing problem: * - Device A connects to device B * - Device A connects to device C * - Device B connects to device C * - At this point, each device has a vep for A with 2 b2bEps. * - Now device A leaves the bus. * - B knows to remove the direct B2BEp to A but it (would otherwise) think it can still reach A through C * - C knows to remove the direct B2bEp to A but it (would otherwise) think it can still reach A through B * This algorithm solves this problem by removing the veps when they no longer route for any session AND * when they are suseptible to the triangular route problem. */ bool isEmpty = (m_b2bEndpoints.lower_bound(1) == m_b2bEndpoints.end()); if (isEmpty) { it = m_b2bEndpoints.begin(); while (it != m_b2bEndpoints.end()) { /* If the Remote guid of a endpoint in the m_b2bEndpoints map is the same as the VirtualEndpoint GUID: * then this Virtual endpoint is still valid. */ if (it->second->GetRemoteGUID().ToShortString() == GetRemoteGUIDShortString()) { isEmpty = false; break; } ++it; } } if (isEmpty) { /* The last b2b endpoint has been removed from this virtual endpoint. Set the state to STOPPING. */ m_epState = EP_STOPPING; } m_b2bEndpointsLock.Unlock(MUTEX_CONTEXT); return isEmpty; } String _VirtualEndpoint::GetRemoteGUIDShortString() { size_t pos = GetUniqueName().find_first_of("."); return GetUniqueName().substr(1, pos - 1); } QStatus _VirtualEndpoint::AddSessionRef(SessionId id, RemoteEndpoint& b2bEp) { QCC_DbgTrace(("_VirtualEndpoint::AddSessionRef(this=%s [%x], id=%u, b2b=%s)", GetUniqueName().c_str(), this, id, b2bEp->GetUniqueName().c_str())); assert(id != 0); m_b2bEndpointsLock.Lock(MUTEX_CONTEXT); /* Sanity check. Make sure b2bEp is connected to this virtual ep (with sessionId == 0) */ bool canUse = CanUseRoute(b2bEp); if (canUse) { /* Increment b2bEp ref */ b2bEp->IncrementRef(); /* Map sessionId to b2bEp */ m_b2bEndpoints.insert(pair(id, b2bEp)); m_hasRefs = true; } m_b2bEndpointsLock.Unlock(MUTEX_CONTEXT); return canUse ? ER_OK : ER_BUS_NO_ENDPOINT; } void _VirtualEndpoint::RemoveSessionRef(SessionId id) { QCC_DbgTrace(("_VirtualEndpoint::RemoveSessionRef(this=%s [%x], id=%u)", GetUniqueName().c_str(), this, id)); assert(id != 0); m_b2bEndpointsLock.Lock(MUTEX_CONTEXT); multimap::iterator it = m_b2bEndpoints.find(id); if (it != m_b2bEndpoints.end()) { it->second->DecrementRef(); m_b2bEndpoints.erase(it); } else { QCC_DbgPrintf(("_VirtualEndpoint::RemoveSessionRef: vep=%s failed to find session = %u", m_uniqueName.c_str(), id)); } m_b2bEndpointsLock.Unlock(MUTEX_CONTEXT); } bool _VirtualEndpoint::CanUseRoute(const RemoteEndpoint& b2bEndpoint) const { bool isFound = false; m_b2bEndpointsLock.Lock(MUTEX_CONTEXT); multimap::const_iterator it = m_b2bEndpoints.begin(); while ((it != m_b2bEndpoints.end()) && (it->first == 0)) { if (it->second == b2bEndpoint) { isFound = true; break; } ++it; } m_b2bEndpointsLock.Unlock(MUTEX_CONTEXT); return isFound; } bool _VirtualEndpoint::CanRouteWithout(const qcc::GUID128& guid) const { bool canRoute = false; m_b2bEndpointsLock.Lock(MUTEX_CONTEXT); multimap::const_iterator it = m_b2bEndpoints.begin(); while (it != m_b2bEndpoints.end()) { if (guid != it->second->GetRemoteGUID()) { canRoute = true; break; } ++it; } m_b2bEndpointsLock.Unlock(MUTEX_CONTEXT); return canRoute; } } alljoyn-15.04b/alljoyn_core/router/VirtualEndpoint.h000066400000000000000000000173241255700255500226520ustar00rootroot00000000000000/** * @file * A VirtualEndpoint is a representation of an AllJoyn endpoint that exists behind a remote * AllJoyn daemon. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_VIRTUALENDPOINT_H #define _ALLJOYN_VIRTUALENDPOINT_H #include #include #include #include "BusEndpoint.h" #include "RemoteEndpoint.h" #include #include namespace ajn { class _VirtualEndpoint; /** * %VirtualEndpoint is an alias for a remote bus connection that exists * behind a remote AllJoyn daemon. */ typedef qcc::ManagedObj<_VirtualEndpoint> VirtualEndpoint; /** * %_VirtualEndpoint is managed class that implements the virtual endpoint functionality. */ class _VirtualEndpoint : public _BusEndpoint { public: /** * Default constructor initializes an invalid endpoint. This allows for the declaration of uninitialized VirtualEndpoint variables. */ _VirtualEndpoint() : m_epState(EP_ILLEGAL) { } /** * Constructor * * @param uniqueName Unique name for this endpoint. * @param b2bEp Initial Bus-to-bus endpoint for this virtual endpoint. */ _VirtualEndpoint(const qcc::String& uniqueName, RemoteEndpoint& b2bEp); virtual ~_VirtualEndpoint() { } /** * Send an outgoing message. * * @param msg Message to be sent. * @return * - ER_OK if successful. * - An error status otherwise */ QStatus PushMessage(Message& msg); /** * Send an outgoing message over a specific session. * * @param msg Message to be sent. * @param id SessionId to use for outgoing message. * @return * - ER_OK if successful. * - An error status otherwise */ QStatus PushMessage(Message& msg, SessionId id); /** * Get unique bus name. * * @return * - unique bus name * - empty if server has not yet assigned one (client-side). */ const qcc::String& GetUniqueName() const { return m_uniqueName; } /** * Get the BusToBus endpoint associated with this virtual endpoint. * * @param sessionId Id of session between src and dest. * @param b2bCount [OUT] Number of b2bEps that can route for given session. May be NULL. * @return The current (top of queue) bus-to-bus endpoint or an invalid endpoint * (endpoint->IsValid() == false) if there is no such endpoint. */ RemoteEndpoint GetBusToBusEndpoint(SessionId sessionId = 0, int* b2bCount = NULL) const; /** * Gets the BusToBus endpoints associated with this virtual endpoint. * * @return The set of BusToBus endpoints that can route for this virtual endpoint. */ std::multimap GetBusToBusEndpoints() const; /** * Add an alternate bus-to-bus endpoint that can route for this endpoint. * * @param endpoint A bus-to-bus endpoint that can route to this virutual endpoint. * @return true if endpoint was added. */ bool AddBusToBusEndpoint(RemoteEndpoint& endpoint); /** * Remove a bus-to-bus endpoint that can route for thie virtual endpoint. * * @param endpoint Bus-to-bus endpoint to remove from list of routes * @return true iff virtual endpoint has no bus-to-bus endpoint and should be removed. */ bool RemoveBusToBusEndpoint(RemoteEndpoint& endpoint); /** * Map a session id to one of this VirtualEndpoint's B2B endpoints. * * @param sessionId The session id. * @param b2bEp The bus-to-bus endpoint for the session. * @return ER_OK if successful. */ QStatus AddSessionRef(SessionId sessionId, RemoteEndpoint& b2bEp); /** * Remove (counted) mapping of sessionId to B2B endpoint. * * @param sessionId The session id. */ void RemoveSessionRef(SessionId sessionId); /** * Return true iff the given bus-to-bus endpoint can potentially be used to route * messages for this virtual endpoint. * * @param b2bEndpoint B2B endpoint being checked for suitability as a route for this virtual endpoint. * @return true iff the B2B endpoint can be used to route messages for this virtual endpoint. */ virtual bool CanUseRoute(const RemoteEndpoint& b2bEndpoint) const; /** * Return true iff the virtual endpoint can route to destination without the aid of the * daemon identified by guid. * * @param guid GUID of daemon that should be ignored when determing whether vep can route to dest. * @return true iff the vep can route to its dest without the aid of daemon identified by guid. */ bool CanRouteWithout(const qcc::GUID128& guid) const; /** * Get the set of sessionIds that route through a given bus-to-bus endpoint. * * @param[IN] b2bEndpoint B2B endpoint. * @param[OUT] set of sessionIds that route through the given endpoint. */ void GetSessionIdsForB2B(RemoteEndpoint& endpoint, std::set& sessionIds); /** * Indicate whether this endpoint is allowed to receive messages from remote devices. * VirtualEndpoints are always allowed to receive remote messages. * * @return true */ bool AllowRemoteMessages() { return true; } /** * Return true if this Virtual endpoint is a member of the specified session. * @param sessionId The session id. * * @return true if this endpoint is a member of the session Id passed in. */ bool HasSession(SessionId sessionId); enum EndpointState { EP_ILLEGAL = 0, /**< This is an invalid endpoint. i.e. constructed with the default constructor. */ EP_STARTED, /**< The endpoint has at least one bus-to-bus endpoint */ EP_STOPPING, /**< The endpoint is being stopped. */ }; /** * Indicates whether the virtual endpoint is being stopped. * * @return true iff the endpoint is in the process of being stopped. */ bool IsStopping(void) { return m_epState == EP_STOPPING; } /** * Returns the remote GUID short string of the virtual endpoint * * @return remote short string of Virtual endpoint's guid. */ qcc::String GetRemoteGUIDShortString(); private: /* Private assigment operator - does nothing */ _VirtualEndpoint operator=(const _VirtualEndpoint&); const qcc::String m_uniqueName; /**< The unique name for this endpoint */ std::multimap m_b2bEndpoints; /**< Set of b2bs that can route for this virtual ep */ mutable qcc::Mutex m_b2bEndpointsLock; /**< Lock that protects m_b2bEndpoints */ bool m_hasRefs; EndpointState m_epState; /**< The state of the virtual endpoint */ }; } #endif alljoyn-15.04b/alljoyn_core/router/android/000077500000000000000000000000001255700255500207635ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/router/android/PermissionDB.cc000066400000000000000000000342241255700255500236350ustar00rootroot00000000000000/** * @file * AllJoyn permission database class */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #include #include #include "PermissionDB.h" #include "BusEndpoint.h" #define QCC_MODULE "PERMISSION_MGR" using namespace std; using namespace qcc; namespace ajn { static PermissionDB permissionDB; /** * Get the assigned permissions of the installed Android package with specific user id * @param uid The user Id * @param permissions Container to store the permission entries * @return true if permission information for the user id is found */ static bool GetPermsAssignedByAndroid(const uint32_t uid, std::set& permissions); /** * Get the assigned permissions of the installed Android package with specific shared user id * @param sharedUid The shared user Id * @param permissions Container to store the permission entries * @param root The root element of a parsed xml file * @return true if permission information for the shared user id is found */ static bool GetPermsBySharedUserId(const char* sharedUid, std::set& permissions, const XmlElement* root); PermissionDB& PermissionDB::GetDB() { return permissionDB; } bool PermissionDB::VerifyPermsOnAndroid(const uint32_t userId, const std::set& permsReq) { bool pass = true; /* Root user with id 0 can do anything. */ if (userId == 0) { return true; } permissionDbLock.Lock(MUTEX_CONTEXT); if (unknownApps.find(userId) != unknownApps.end()) { permissionDbLock.Unlock(MUTEX_CONTEXT); return true; } std::map >::const_iterator uidPermsIt = uidPermsMap.find(userId); std::set permsOwned; if (uidPermsIt == uidPermsMap.end()) { /* If no permission info is found because of failure to read the "/data/system/packages.xml" file, then ignore the permission check */ if (!GetPermsAssignedByAndroid(userId, permsOwned)) { unknownApps.insert(userId); permissionDbLock.Unlock(MUTEX_CONTEXT); return true; } uidPermsMap[userId] = permsOwned; } else { permsOwned = uidPermsIt->second; } std::set::const_iterator permsIt; for (permsIt = permsReq.begin(); permsIt != permsReq.end(); permsIt++) { QCC_DbgHLPrintf(("PermissionDB::Check permission %s at user %d", (*permsIt).c_str(), userId)); set::iterator permsOwnedIt = permsOwned.find(*permsIt); if (permsOwnedIt == permsOwned.end()) { pass = false; QCC_DbgHLPrintf(("PermissionDB::Permission %s is not granted for user %d", (*permsIt).c_str(), userId)); break; } } permissionDbLock.Unlock(MUTEX_CONTEXT); return pass; } bool PermissionDB::IsWifiAllowed(uint32_t uid) { QCC_DbgTrace(("PermissionDB::IsWifiAllowed(uid = %u)", uid)); bool allowed = true; // For Android app, permissions "android.permission.INTERNET" and "android.permission.CHANGE_WIFI_MULTICAST_STATE" are required for usage of wifi. uint32_t userId = UniqueUserID(uid); std::set permsReq; permsReq.insert("android.permission.INTERNET"); permsReq.insert("android.permission.CHANGE_WIFI_MULTICAST_STATE"); allowed = VerifyPermsOnAndroid(userId, permsReq); return allowed; } bool PermissionDB::VerifyPeerPermissions(const uint32_t uid, const std::set& permsReq) { bool pass = true; uint32_t userId = UniqueUserID(uid); pass = VerifyPermsOnAndroid(userId, permsReq); return pass; } QStatus PermissionDB::AddAliasUnixUser(uint32_t origUID, uint32_t aliasUID) { QCC_DbgTrace(("PermissionDB::AddAliasUnixUser(origUID = %d -> aliasUID = %d)", origUID, aliasUID)); QStatus status = ER_OK; /* It is not allowed to use user id 0 (root user) as alias */ if (aliasUID == 0) { status = ER_FAIL; } /* If the same, then do nothing*/ if (status == ER_OK && UniqueUserID(aliasUID) != origUID) { permissionDbLock.Lock(MUTEX_CONTEXT); uidPermsMap.erase(UniqueUserID(aliasUID)); uidAliasMap[aliasUID] = origUID; permissionDbLock.Unlock(MUTEX_CONTEXT); } return status; } uint32_t PermissionDB::UniqueUserID(uint32_t userID) { uint32_t uid = userID; permissionDbLock.Lock(MUTEX_CONTEXT); std::map::const_iterator it = uidAliasMap.find(userID); if (it != uidAliasMap.end()) { uid = uidAliasMap[userID]; } permissionDbLock.Unlock(MUTEX_CONTEXT); return uid; } QStatus PermissionDB::RemovePermissionCache(BusEndpoint& endpoint) { QCC_DbgTrace(("PermissionDB::RemovePermissionCache(endpoint = %s)", endpoint->GetUniqueName().c_str())); permissionDbLock.Lock(MUTEX_CONTEXT); uint32_t userId = endpoint->GetUserId(); uidAliasMap.erase(userId); uidPermsMap.erase(UniqueUserID(userId)); unknownApps.erase(UniqueUserID(userId)); permissionDbLock.Unlock(MUTEX_CONTEXT); return ER_OK; } static bool GetPermsAssignedByAndroid(uint32_t uid, std::set& permissions) { QCC_DbgTrace(("PermissionDB::GetPermsAssignedByAndroid(uid = %d)", uid)); const char* xml = "/data/system/packages.xml"; // The file contains information about all installed Android packages including Permissions const uint32_t MAX_ID_SIZE = 32; char userId [MAX_ID_SIZE]; snprintf(userId, MAX_ID_SIZE, "%d", uid); FileSource source(xml); if (!source.IsValid()) { QCC_LogError(ER_FAIL, ("Failed to open %s", xml)); return false; } XmlParseContext xmlParseCtx(source); bool success = XmlElement::Parse(xmlParseCtx) == ER_OK; bool found = false; bool isSharedUserId = false; const XmlElement* root = xmlParseCtx.GetRoot(); if (success) { if (root->GetName().compare("packages") == 0) { QCC_DbgPrintf(("Xml Tag %s", "packages")); const vector& elements = root->GetChildren(); vector::const_iterator it; bool isSystemApp = false; for (it = elements.begin(); it != elements.end() && !found; ++it) { if ((*it)->GetName().compare("package") == 0) { QCC_DbgPrintf(("Xml Tag %s", "package")); const map& attrs((*it)->GetAttributes()); map::const_iterator attrIt; isSystemApp = false; for (attrIt = attrs.begin(); attrIt != attrs.end(); ++attrIt) { if (attrIt->first.compare("codePath") == 0) { uint32_t cmpLen = attrIt->second.size() < strlen("/system/app") ? attrIt->second.size() : strlen("/system/app"); if (attrIt->second.compare(0, cmpLen, "/system/app") == 0) { QCC_DbgPrintf(("Xml Tag %s = %s", "codePath", attrIt->second.c_str())); isSystemApp = true; } } else if (attrIt->first.compare("userId") == 0) { QCC_DbgPrintf(("Xml Tag %s = %s", "userId", attrIt->second.c_str())); if (attrIt->second.compare(userId) == 0) { QCC_DbgHLPrintf(("PermissionDB::GetPermsAssignedByAndroid() entry for userId %d is found", uid)); found = true; break; } } else if (attrIt->first.compare("sharedUserId") == 0) { if (attrIt->second.compare(userId) == 0) { QCC_DbgHLPrintf(("PermissionDB::GetPermsAssignedByAndroid() entry for userId %d is found", uid)); found = true; isSharedUserId = true; break; } } } if (found) { /* If this is a pre-installed system app, then we trust it without checking the permissions becasue the permissions for system apps is not listed in packages.xml */ if (isSystemApp) { return false; } /* If this is a shared user Id, then we should read the permissions from element*/ if (isSharedUserId) { found = GetPermsBySharedUserId(userId, permissions, root); break; } const vector& childElements = (*it)->GetChildren(); for (vector::const_iterator childIt = childElements.begin(); childIt != childElements.end(); ++childIt) { if ((*childIt)->GetName().compare("perms") == 0) { QCC_DbgPrintf(("Xml Tag %s", "perms")); const vector& permElements = (*childIt)->GetChildren(); for (vector::const_iterator permIt = permElements.begin(); permIt != permElements.end(); ++permIt) { if ((*permIt)->GetName().compare("item") == 0) { QCC_DbgPrintf(("Xml Tag %s", "item")); const map& itemAttrs((*permIt)->GetAttributes()); map::const_iterator itemAttrIt; for (itemAttrIt = itemAttrs.begin(); itemAttrIt != itemAttrs.end(); ++itemAttrIt) { if (itemAttrIt->first.compare("name") == 0) { QCC_DbgPrintf(("Xml Tag %s = (%s)", "name", itemAttrIt->second.c_str())); permissions.insert(itemAttrIt->second); } } } } break; } } } } } } } if (!found) { QCC_LogError(ER_ALLJOYN_ACCESS_PERMISSION_WARNING, ("Cannot find permission info for userId %d in File %s", uid, xml)); } return found; } static bool GetPermsBySharedUserId(const char* sharedUid, std::set& permissions, const XmlElement* root) { QCC_DbgTrace(("PermissionDB::GetPermsBySharedUserId(sharedUid = %s)", sharedUid)); bool found = false; const vector& elements = root->GetChildren(); vector::const_iterator it; for (it = elements.begin(); it != elements.end() && !found; ++it) { if ((*it)->GetName().compare("shared-user") == 0) { QCC_DbgPrintf(("Xml Tag %s", "shared-user")); const map& attrs((*it)->GetAttributes()); map::const_iterator attrIt; for (attrIt = attrs.begin(); attrIt != attrs.end(); ++attrIt) { if (attrIt->first.compare("userId") == 0) { QCC_DbgPrintf(("Xml Tag %s = %s", "userId", attrIt->second.c_str())); if (attrIt->second.compare(sharedUid) == 0) { QCC_DbgHLPrintf(("PermissionDB::GetPermsBySharedUserId() entry for sharedUid %s is found", sharedUid)); found = true; } } } } if (found) { const vector& childElements = (*it)->GetChildren(); for (vector::const_iterator childIt = childElements.begin(); childIt != childElements.end(); ++childIt) { if ((*childIt)->GetName().compare("perms") == 0) { QCC_DbgPrintf(("Xml Tag %s", "perms")); const vector& permElements = (*childIt)->GetChildren(); for (vector::const_iterator permIt = permElements.begin(); permIt != permElements.end(); ++permIt) { if ((*permIt)->GetName().compare("item") == 0) { QCC_DbgPrintf(("Xml Tag %s", "item")); const map& itemAttrs((*permIt)->GetAttributes()); map::const_iterator itemAttrIt; for (itemAttrIt = itemAttrs.begin(); itemAttrIt != itemAttrs.end(); ++itemAttrIt) { if (itemAttrIt->first.compare("name") == 0) { QCC_DbgPrintf(("Xml Tag %s = (%s)", "name", itemAttrIt->second.c_str())); permissions.insert(itemAttrIt->second); } } } } break; } } } } return found; } } // namespace ajn alljoyn-15.04b/alljoyn_core/router/android/PermissionDB.h000066400000000000000000000065271255700255500235040ustar00rootroot00000000000000/** * @file * Implement a permission verification class */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_PERMISSION_DB_H #define _ALLJOYN_PERMISSION_DB_H #include "BusEndpoint.h" #include #include #include #include namespace ajn { class PermissionDB { public: /** * Get the singleton instance of PermissionDB */ static PermissionDB& GetDB(); /** * Check whether the endpoint is allowed to use WIFI * @param uid UserId to be checked * @return true if allowed */ bool IsWifiAllowed(uint32_t uid); /** * Check whether the endpoint owns the required permissions * @param uid The user id of the endpoint to be verified * @param permsReq The list of permissions to be verified * @return true if the endpoint passes the verification */ bool VerifyPeerPermissions(const uint32_t uid, const std::set& permsReq); /** * Remove the permission information cache of an enpoint before it exits. * @param endponit The endpoint that will exits * @return ER_OK if successful */ QStatus RemovePermissionCache(BusEndpoint& endpoint); /** * Add an alias ID to a UnixEndpoint User ID * @param origUID The unique User ID * @param aliasUID The alias User ID * @return ER_OK if successfully */ QStatus AddAliasUnixUser(uint32_t origUID, uint32_t aliasUID); private: /** * Check whether the uid owns the required permissions on Android * @param uid The user Id of an Android app * @param permsReq The required permissions * @return true if the uid meets the permission requirement */ bool VerifyPermsOnAndroid(const uint32_t uid, const std::set& permsReq); /** * Get the unique user ID of an alias user ID * @param userID The user ID of the endpoint * @return the unique user ID if it exists otherwise keep unchanged */ uint32_t UniqueUserID(uint32_t userID); qcc::Mutex permissionDbLock; std::map > uidPermsMap; /**< cache the permissions owned by an endpoint identified by user id */ std::map uidAliasMap; /**< map of alias user id to the unique user id. */ std::set unknownApps; /**< apps whose permission info is unknown */ }; } #endif alljoyn-15.04b/alljoyn_core/router/android/PermissionMgrAndroid.cc000066400000000000000000000071541255700255500254000ustar00rootroot00000000000000/** * @file * This class is to manage the permission of an endpoint on using transports or invoking method/signal calls on another peer */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include "PermissionMgr.h" #include "PermissionDB.h" #include #include #include #include #include #include using namespace qcc; #define QCC_MODULE "PERMISSION_MGR" namespace ajn { QStatus TransportPermission::FilterTransports(BusEndpoint& srcEp, const qcc::String& sender, TransportMask& transports, const char* callerName) { QCC_DbgPrintf(("TransportPermission::FilterTransports() callerName(%s)", callerName)); QStatus status = ER_OK; if (srcEp->IsValid()) { if (transports & TRANSPORT_IP) { bool allowed = PermissionDB::GetDB().IsWifiAllowed(srcEp->GetUserId()); if (!allowed) { transports &= ~TRANSPORT_IP; QCC_LogError(ER_ALLJOYN_ACCESS_PERMISSION_WARNING, ("AllJoynObj::%s() WARNING: No permission to use Wifi", ((callerName == NULL) ? "" : callerName))); } } if (transports == 0) { status = ER_BUS_NO_TRANSPORTS; } } else { status = ER_BUS_NO_ENDPOINT; QCC_LogError(ER_BUS_NO_ENDPOINT, ("AllJoynObj::CheckTransportsPermission No Bus Endpoint found for Sender %s", sender.c_str())); } return status; } uint32_t PermissionMgr::AddAliasUnixUser(BusEndpoint& srcEp, qcc::String& sender, uint32_t origUID, uint32_t aliasUID) { QCC_DbgHLPrintf(("PermissionMgr::AddAliasUnixUser() origUID(%d), aliasUID(%d)", origUID, aliasUID)); QStatus status = ER_OK; uint32_t replyCode = ALLJOYN_ALIASUNIXUSER_REPLY_SUCCESS; if (!(srcEp->IsValid())) { status = ER_BUS_NO_ENDPOINT; QCC_LogError(status, ("AliasUnixUser Failed to find endpoint for sender=%s", sender.c_str())); replyCode = ALLJOYN_ALIASUNIXUSER_REPLY_FAILED; } else { origUID = srcEp->GetUserId(); if (origUID == (uint32_t)-1 || aliasUID == (uint32_t)-1) { QCC_LogError(ER_FAIL, ("AliasUnixUser Invalid user id origUID=%d aliasUID=%d", origUID, aliasUID)); replyCode = ALLJOYN_ALIASUNIXUSER_REPLY_FAILED; } } if (replyCode == ALLJOYN_ALIASUNIXUSER_REPLY_SUCCESS) { if (PermissionDB::GetDB().AddAliasUnixUser(origUID, aliasUID) != ER_OK) { replyCode = ALLJOYN_ALIASUNIXUSER_REPLY_FAILED; } } return replyCode; } QStatus PermissionMgr::CleanPermissionCache(BusEndpoint& endpoint) { QCC_DbgHLPrintf(("PermissionMgr::CleanPermissionCache()")); return PermissionDB::GetDB().RemovePermissionCache(endpoint); } } // namespace ajn { alljoyn-15.04b/alljoyn_core/router/android/SConscript000066400000000000000000000015731255700255500230030ustar00rootroot00000000000000# Copyright AllSeen Alliance. All rights reserved. # # Permission to use, copy, modify, and/or distribute this software for any # purpose with or without fee is hereby granted, provided that the above # copyright notice and this permission notice appear in all copies. # # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. # Import('router_env') objs = router_env.Object(router_env.Glob('*.cc')) Return('objs') alljoyn-15.04b/alljoyn_core/router/bundled/000077500000000000000000000000001255700255500207605ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/router/bundled/BundledRouter.cc000066400000000000000000000260421255700255500240510ustar00rootroot00000000000000/** * @file * Implementation of class for launching a bundled router */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #include #include #include #include #include #include #include #include "BundledRouter.h" #include "Bus.h" #include "BusController.h" #include "ConfigDB.h" #include "Transport.h" #include "TCPTransport.h" #include "UDPTransport.h" #define QCC_MODULE "ALLJOYN_ROUTER" using namespace qcc; using namespace std; namespace ajn { static const char bundledConfig[] = "" " alljoyn_bundled" " tcp:iface=*,port=0" " udp:iface=*,port=0" " 20000" " 4" " 16" " 8" " 0" " Battery powered and chargeable" " Intermediate mobility" " 3-6 hr" " Wireless" " false" ""; /* * Router Power Source * Always AC powered * Battery powered and chargeable * Battery powered and not chargeable * * Router Mobility * Always Stationary * Low mobility * Intermediate mobility * High mobility * * Router Availability * 0-3 hr * 3-6 hr * 6-9 hr * 9-12 hr * 12-15 hr * 15-18 hr * 18-21 hr * 21-24 hr * * Router Node Connection * Access Point * Wired * Wireless * */ ClientAuthListener::ClientAuthListener() : AuthListener(), maxAuth(2) { } bool ClientAuthListener::RequestCredentials(const char* authMechanism, const char* authPeer, uint16_t authCount, const char* userId, uint16_t credMask, Credentials& creds) { QCC_UNUSED(userId); if (authCount > maxAuth) { return false; } printf("RequestCredentials for authenticating %s using mechanism %s\n", authPeer, authMechanism); if (strcmp(authMechanism, PasswordManager::GetAuthMechanism().c_str()) == 0) { if (credMask & AuthListener::CRED_PASSWORD) { creds.SetPassword(PasswordManager::GetPassword()); } return true; } return false; } void ClientAuthListener::AuthenticationComplete(const char* authMechanism, const char* authPeer, bool success) { QCC_UNUSED(authMechanism); QCC_UNUSED(authPeer); QCC_UNUSED(success); QCC_DbgPrintf(("Authentication %s %s\n", authMechanism, success ? "succesful" : "failed")); } bool ExistFile(const char* fileName) { if (fileName) { FILE* file = fopen(fileName, "r"); if (file) { fclose(file); return true; } } return false; } /* * Create the singleton bundled router instance. * * Sidebar on starting a bundled router * ==================================== * * How this works is via a fairly non-obvious mechanism, so we describe the * process here. If it is desired to use the bundled router, the user (for * example bbclient or bbservice) calls BundledRouterInit(). This will then * call the constructor for the BundledRouter object. The constructor calls * into a static method (RegisterRouterLauncher) of the NullTransport to * register itself as the router to be launched. This sets the stage for the * use of the bundled router. * * When the program using the bundled router tries to connect to a bus * attachment it calls BusAttachment::Connect(). This tries to connect to an * existing router first and if that connect does not succeed, it tries to * connect over the NullTransport to the bundled router. * * The NullTransport::Connect() method looks to see if it (the null transport) * is running, and if it is not it looks to see if it has a routerLauncher. * Recall that the constructor for the BundledRouter object registered itself as * a router launcher, so the null transport will find the launcher since it * included the object file corresponding to this source. The null transport * then does a routerLauncher->Start() which calls back into the bundled router * object BundledRouter::Start() method below, providing the router with the * NullTransport pointer. The Start() method brings up the bundled router and * links the routing node to the bus attachment using the provided null transport. * * So to summarize, one uses the bundled router simply by calling * BundledRouterInit() This creates a bundled router object and registers it with * the null transport. When trying to connect to a router using a bus * attachment in the usual way, if there is no currently running native router * process, the bus attachment will automagically try to connect to a registered * bundled router using the null transport. This will start the bundled router * and then connect to it. * * Stopping the bundled router happens in the BundledRouterShutdown(). */ BundledRouter::BundledRouter() : transportsInitialized(false), stopping(false), ajBus(NULL), ajBusController(NULL) { NullTransport::RegisterRouterLauncher(this); LoggerSetting::GetLoggerSetting("bundled-router"); /* * Setup the config */ #ifndef NDEBUG #if defined(QCC_OS_ANDROID) configFile = "/mnt/sdcard/.alljoyn/config.xml"; #else configFile = "./config.xml"; #endif qcc::String configStr = bundledConfig; if (ExistFile(configFile.c_str())) { configStr = ""; } else { configFile = ""; } config = new ConfigDB(configStr, configFile); #else config = new ConfigDB(bundledConfig); #endif } BundledRouter::~BundledRouter() { QCC_DbgPrintf(("BundledRouter::~BundledRouter")); lock.Lock(MUTEX_CONTEXT); while (!transports.empty()) { set::iterator iter = transports.begin(); NullTransport* trans = *iter; transports.erase(iter); lock.Unlock(MUTEX_CONTEXT); trans->Disconnect("null:"); lock.Lock(MUTEX_CONTEXT); } lock.Unlock(MUTEX_CONTEXT); Join(); delete config; } QStatus BundledRouter::Start(NullTransport* nullTransport) { QStatus status = ER_OK; QCC_DbgHLPrintf(("Using BundledRouter")); #ifndef NDEBUG if (configFile.size() > 0) { QCC_DbgHLPrintf(("Using external config file: %s", configFile.c_str())); } #endif /* * If the bundled router is in the process of stopping we need to wait until the operation is * complete (BundledRouter::Join has exited) before we attempt to start up again. */ lock.Lock(MUTEX_CONTEXT); while (stopping) { if (!transports.empty()) { assert(transports.empty()); } lock.Unlock(MUTEX_CONTEXT); qcc::Sleep(5); lock.Lock(MUTEX_CONTEXT); } if (transports.empty()) { if (!config->LoadConfig()) { status = ER_BUS_BAD_XML; QCC_LogError(status, ("Error parsing configuration")); goto ErrorExit; } /* * Extract the listen specs */ const ConfigDB::ListenList listenList = config->GetListen(); String listenSpecs; for (ConfigDB::_ListenList::const_iterator it = listenList->begin(); it != listenList->end(); ++it) { if (!listenSpecs.empty()) { listenSpecs.append(";"); } listenSpecs.append(*it); } /* * Register the transport factories - this is a one time operation */ if (!transportsInitialized) { Add(new TransportFactory(TCPTransport::TransportName, false)); Add(new TransportFactory(UDPTransport::TransportName, false)); transportsInitialized = true; } QCC_DbgPrintf(("Starting bundled router bus attachment")); /* * Create and start the routing node */ ajBus = new Bus("bundled-router", *this, listenSpecs.c_str()); if (PasswordManager::GetAuthMechanism() != "ANONYMOUS" && PasswordManager::GetPassword() != "") { ajBusController = new BusController(*ajBus, &authListener); } else { ajBusController = new BusController(*ajBus, NULL); } status = ajBusController->Init(listenSpecs); if (ER_OK != status) { goto ErrorExit; } } /* * Use the null transport to link the routing node and client bus together */ status = nullTransport->LinkBus(ajBus); if (status != ER_OK) { goto ErrorExit; } transports.insert(nullTransport); lock.Unlock(MUTEX_CONTEXT); return ER_OK; ErrorExit: if (transports.empty()) { delete ajBusController; ajBusController = NULL; delete ajBus; ajBus = NULL; } lock.Unlock(MUTEX_CONTEXT); return status; } void BundledRouter::Join() { QCC_DbgPrintf(("BundledRouter::Join")); lock.Lock(MUTEX_CONTEXT); if (transports.empty() && ajBus && ajBusController) { QCC_DbgPrintf(("Joining bundled router bus attachment")); ajBusController->Join(); delete ajBusController; ajBusController = NULL; delete ajBus; ajBus = NULL; /* * Clear the stopping state */ stopping = false; } lock.Unlock(MUTEX_CONTEXT); } QStatus BundledRouter::Stop(NullTransport* nullTransport) { QCC_DbgPrintf(("BundledRouter::Stop")); lock.Lock(MUTEX_CONTEXT); transports.erase(nullTransport); QStatus status = ER_OK; if (transports.empty()) { /* * Set the stopping state to block any calls to Start until * after Join() has been called. */ stopping = true; if (ajBusController) { status = ajBusController->Stop(); } } lock.Unlock(MUTEX_CONTEXT); return status; } } // namespace ajn alljoyn-15.04b/alljoyn_core/router/bundled/BundledRouter.h000066400000000000000000000044101255700255500237060ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_BUNDLEDROUTER_H #define _ALLJOYN_BUNDLEDROUTER_H #include #include "NullTransport.h" #include "PasswordManager.h" #include "TransportFactory.h" namespace ajn { class Bus; class BusController; class ConfigDB; class ClientAuthListener : public AuthListener { public: ClientAuthListener(); private: bool RequestCredentials(const char* authMechanism, const char* authPeer, uint16_t authCount, const char* userId, uint16_t credMask, Credentials& creds); void AuthenticationComplete(const char* authMechanism, const char* authPeer, bool success); uint32_t maxAuth; }; class BundledRouter : public RouterLauncher, public TransportFactoryContainer { public: BundledRouter(); ~BundledRouter(); /** * Launch the bundled router */ QStatus Start(NullTransport* nullTransport); /** * Terminate the bundled router */ QStatus Stop(NullTransport* nullTransport); /** * Wait for bundled router to exit */ void Join(); private: bool transportsInitialized; bool stopping; Bus* ajBus; BusController* ajBusController; ClientAuthListener authListener; qcc::Mutex lock; std::set transports; ConfigDB* config; #ifndef NDEBUG qcc::String configFile; #endif }; } #endif alljoyn-15.04b/alljoyn_core/router/bundled/BundledRouterInit.cc000066400000000000000000000041351255700255500246740ustar00rootroot00000000000000/** * @file * Implementation of class for launching a bundled router */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include "BundledRouter.h" #include "RouterGlobals.h" static ajn::BundledRouter* bundledRouter = NULL; extern "C" { static uint32_t allJoynRouterInitCount = 0; static qcc::Mutex allJoynRouterInitLock; QStatus AJ_CALL AllJoynRouterInit(void) { allJoynRouterInitLock.Lock(); if (allJoynRouterInitCount == 0) { ajn::RouterGlobals::Init(); bundledRouter = new ajn::BundledRouter(); allJoynRouterInitCount = 1; } else if (allJoynRouterInitCount < 0xFFFFFFFF) { allJoynRouterInitCount++; } allJoynRouterInitLock.Unlock(); return ER_OK; } QStatus AJ_CALL AllJoynRouterShutdown(void) { allJoynRouterInitLock.Lock(); if (allJoynRouterInitCount > 0) { allJoynRouterInitCount--; if (allJoynRouterInitCount == 0) { delete bundledRouter; bundledRouter = NULL; ajn::RouterGlobals::Shutdown(); } } allJoynRouterInitLock.Unlock(); return ER_OK; } } alljoyn-15.04b/alljoyn_core/router/bundled/SConscript000066400000000000000000000016061255700255500227750ustar00rootroot00000000000000# Copyright AllSeen Alliance. All rights reserved. # # Permission to use, copy, modify, and/or distribute this software for any # purpose with or without fee is hereby granted, provided that the above # copyright notice and this permission notice appear in all copies. # # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. # Import('router_env') src = router_env.Glob('*.cc') obj = router_env.Object(src) Return('obj') alljoyn-15.04b/alljoyn_core/router/darwin/000077500000000000000000000000001255700255500206275ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/router/darwin/DaemonTransportDarwin.cc000066400000000000000000000031261255700255500254250ustar00rootroot00000000000000/** * @file */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include "../DaemonTransport.h" #define QCC_MODULE "ALLJOYN" using namespace std; using namespace qcc; namespace ajn { const char* DaemonTransport::TransportName = ""; void* DaemonTransport::Run(void* arg) { return NULL; } QStatus DaemonTransport::NormalizeTransportSpec(const char* inSpec, qcc::String& outSpec, map& argMap) const { return ER_OK; } QStatus DaemonTransport::StartListen(const char* listenSpec) { return ER_OK; } QStatus DaemonTransport::StopListen(const char* listenSpec) { return ER_OK; } } // namespace ajn alljoyn-15.04b/alljoyn_core/router/ns/000077500000000000000000000000001255700255500177635ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/router/ns/IpNameService.cc000066400000000000000000000542321255700255500227720ustar00rootroot00000000000000/** * @file * The lightweight name service implementation */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include "BusInternal.h" #include "IpNameService.h" #include "IpNameServiceImpl.h" #define QCC_MODULE "IPNS" namespace ajn { const uint16_t IpNameService::MULTICAST_MDNS_PORT = 5353; static IpNameService* singletonIpNameService = NULL; void IpNameService::Init() { singletonIpNameService = new IpNameService(); } void IpNameService::Shutdown() { delete singletonIpNameService; singletonIpNameService = NULL; } IpNameService& IpNameService::Instance() { return *singletonIpNameService; } IpNameService::IpNameService() : m_constructed(false), m_destroyed(false), m_refCount(0), m_pimpl(NULL) { // // AllJoyn is a multithreaded system. Since the name service instance is // created on first use, the first use is in the Start() method of each // IP-related transport, and the starting of the transports happens on a // single thread, assume we are single-threaded here and don't do anything // fancy to prevent interleaving scenarios on the private implementation // constructor. // m_pimpl = new IpNameServiceImpl; m_constructed = true; } IpNameService::~IpNameService() { // // We get here (on Linux) because when main() returns, the function // __run_exit_handlers() is called which, in turn, calls the destructors of // all of the static objects in whatever order the linker has decided will // be best. // // For us, the troublesome object is going to be the BundledRouter. It is // torn down by the call to its destructor which may happen before or after // the call to our destructor. If we are destroyed first, the bundled // daemon may happily continue to call into the name service singleton since // it may have no idea that it is about to go away. // // Eventually, we want to explicitly control the construction and // destruction order, but for now we have to live with the insanity (and // complexity) of dealing with out-of-order destruction. // // The name service singleton is a static, so its underlying memory won't go // away. So by marking the singleton as destroyed we will have a lasting // indication that it has become unusable in case some bozo (the bundled // daemon) accesses us during destruction time after we have been destroyed. // // The exit handlers are going to be called by the main thread (that // originally called the main function), so the destructors will be called // sequentially. The interesting problem, though, is that the BundledRouter // is going to have possibly more than one transport running, and typically // each of those transports has multiple threads that could conceivably be // making name service calls. So, while our destructor is being called by // the main thread, it is possible that other transport threads will also // be calling. Like in hunting rabbits, We've got to be very, very careful. // // First, make sure no callbacks leak out of the private implementation // during this critical time by turning off ALL callbacks to ALL transports. // if (m_pimpl) { m_pimpl->ClearCallbacks(); m_pimpl->ClearNetworkEventCallbacks(); } // // Now we slam shut an entry gate so that no new callers can get through and // try to do things while we are destroying the private implementation. // m_destroyed = true; // // No new callers will now be let in, but there may be existing callers // rummaging around in the object. If the private implemetation is not // careful about multithreading, it can begin destroying itself with // existing calls in progress. Thankfully, that's not our problem here. // We assume it will do the right thing. // if (m_pimpl) { // // Deleting the private implementation must accomplish an orderly shutdown // with an impled Stop() and Join(). // delete m_pimpl; m_pimpl = NULL; } } #define ASSERT_STATE(function) \ { \ assert(m_constructed && "IpNameService::" # function "(): Singleton not constructed"); \ assert(!m_destroyed && "IpNameService::" # function "(): Singleton destroyed"); \ assert(m_pimpl && "IpNameService::" # function "(): Private impl is NULL"); \ } void IpNameService::Acquire(const qcc::String& guid, bool loopback) { // // If the entry gate has been closed, we do not allow an Acquire to actually // acquire a reference. The singleton is going away and so we assume we are // running __run_exit_handlers() so main() has returned. We are definitely // shutting down, and the process is going to exit, so tricking callers who // may be temporarily running is okay. // if (m_destroyed) { return; } // // The only way someone can get to us is if they call Instance() which will // cause the object to be constructed. // assert(m_constructed && "IpNameService::Acquire(): Singleton not constructed"); ASSERT_STATE("Acquire"); int refs = qcc::IncrementAndFetch(&m_refCount); if (refs == 1) { // // The first transport in gets to set the GUID and the loopback mode. // There should be only one GUID associated with a daemon process, so // this should never change; and loopback is a test mode set by a test // program pretending to be a single transport, so this is fine as well. // Init(guid, loopback); Start(); } } void IpNameService::Release() { // // If the entry gate has been closed, we do not allow a Release to actually // release a reference. The singleton is going away and so we assume we are // running __run_exit_handlers() so main() has returned. We are definitely // shutting down, and the process is going to exit, so tricking callers who // may be temporarily running is okay. // if (m_destroyed) { return; } ASSERT_STATE("Release"); int refs = qcc::DecrementAndFetch(&m_refCount); if (refs == 0) { // // The last transport to release its interest in the name service gets // pay the price for waiting for the service to exit. Since we do a // Join(), this method is expected to be called out of a transport's // Join() so the price is expected. // Stop(); Join(); } } QStatus IpNameService::Start() { // // If the entry gate has been closed, we do not allow a Start to actually // start anything. The singleton is going away and so we assume we are // running __run_exit_handlers() so main() has returned. We are definitely // shutting down, and the process is going to exit, so tricking callers who // may be temporarily running is okay. // if (m_destroyed) { return ER_OK; } ASSERT_STATE("Start"); return m_pimpl->Start(); } bool IpNameService::Started() { // // If the entry gate has been closed, we do not allow a Started to actually // test anything. We just return false. The singleton is going away and so // we assume we are running __run_exit_handlers() so main() has returned. // We are definitely shutting down, and the process is going to exit, so // tricking callers who may be temporarily running is okay. // if (m_destroyed) { return false; } ASSERT_STATE("Started"); return m_pimpl->Started(); } QStatus IpNameService::Stop() { // // If the entry gate has been closed, we do not allow a Stop to actually // stop anything. The singleton is going away and so we assume we are // running __run_exit_handlers() so main() has returned. We are definitely // shutting down, and the process is going to exit, so tricking callers who // may be temporarily running is okay. The destructor is going to handle // the actual Stop() and Join(). // if (m_destroyed) { return ER_OK; } ASSERT_STATE("Stop"); return m_pimpl->Stop(); } QStatus IpNameService::Join() { // // If the entry gate has been closed, we do not allow a Join to actually // join anything. The singleton is going away and so we assume we are // running __run_exit_handlers() so main() has returned. We are definitely // shutting down, and the process is going to exit, so tricking callers who // may be temporarily running is okay. The destructor is going to handle // the actual Stop() and Join(). // if (m_destroyed) { return ER_OK; } ASSERT_STATE("Join"); return m_pimpl->Join(); } QStatus IpNameService::Init(const qcc::String& guid, bool loopback) { // // If the entry gate has been closed, we do not allow an Init to actually // init anything. The singleton is going away and so we assume we are // running __run_exit_handlers() so main() has returned. We are definitely // shutting down, and the process is going to exit, so tricking callers who // may be temporarily running is okay. // if (m_destroyed) { return ER_OK; } ASSERT_STATE("Init"); return m_pimpl->Init(guid, loopback); } void IpNameService::SetCallback(TransportMask transportMask, Callback&, uint32_t>* cb) { // // If the entry gate has been closed, we do not allow a SetCallback to actually // set anything. The singleton is going away and so we assume we are // running __run_exit_handlers() so main() has returned. We are definitely // shutting down, and the process is going to exit, so tricking callers who // may be temporarily running is okay. // // The gotcha is that if there is a valid callback set, and the caller is // now setting the callback to NULL to prevent any new callbacks, the caller // will expect that no callbacks will follow this call. This is taken care // of by calling SetCallback(NULL) on the private implemtation BEFORE // setting m_destroyed in our destructor. In other words, the possible set // to NULL has already been done. // if (m_destroyed) { return; } ASSERT_STATE("SetCallback"); m_pimpl->SetCallback(transportMask, cb); } void IpNameService::SetNetworkEventCallback(TransportMask transportMask, Callback&>* cb) { if (m_destroyed) { return; } ASSERT_STATE("SetNetworkEventCallback"); m_pimpl->SetNetworkEventCallback(transportMask, cb); } QStatus IpNameService::CreateVirtualInterface(const qcc::IfConfigEntry& entry) { // // If the entry gate has been closed, we do not allow an OpenInterface to // actually open anything. The singleton is going away and so we assume we // are running __run_exit_handlers() so main() has returned. We are // definitely shutting down, and the process is going to exit, so tricking // callers who may be temporarily running is okay. // if (m_destroyed) { return ER_OK; } ASSERT_STATE("CreateVirtualInterface"); return m_pimpl->CreateVirtualInterface(entry); } QStatus IpNameService::DeleteVirtualInterface(const qcc::String& ifceName) { // // If the entry gate has been closed, we do not allow an OpenInterface to // actually open anything. The singleton is going away and so we assume we // are running __run_exit_handlers() so main() has returned. We are // definitely shutting down, and the process is going to exit, so tricking // callers who may be temporarily running is okay. // if (m_destroyed) { return ER_OK; } ASSERT_STATE("DeleteVirtualInterface"); return m_pimpl->DeleteVirtualInterface(ifceName); } QStatus IpNameService::OpenInterface(TransportMask transportMask, const qcc::String& name) { // // If the entry gate has been closed, we do not allow an OpenInterface to // actually open anything. The singleton is going away and so we assume we // are running __run_exit_handlers() so main() has returned. We are // definitely shutting down, and the process is going to exit, so tricking // callers who may be temporarily running is okay. // if (m_destroyed) { return ER_OK; } ASSERT_STATE("OpenInterface"); return m_pimpl->OpenInterface(transportMask, name); } QStatus IpNameService::OpenInterface(TransportMask transportMask, const qcc::IPAddress& address) { // // If the entry gate has been closed, we do not allow an OpenInterface to // actually open anything. The singleton is going away and so we assume we // are running __run_exit_handlers() so main() has returned. We are // definitely shutting down, and the process is going to exit, so tricking // callers who may be temporarily running is okay. // if (m_destroyed) { return ER_OK; } ASSERT_STATE("OpenInterface"); return m_pimpl->OpenInterface(transportMask, address); } QStatus IpNameService::CloseInterface(TransportMask transportMask, const qcc::String& name) { // // If the entry gate has been closed, we do not allow a CloseInterface to // actually close anything. The singleton is going away and so we assume we // are running __run_exit_handlers() so main() has returned. We are // definitely shutting down, and the process is going to exit, so tricking // callers who may be temporarily running is okay. // if (m_destroyed) { return ER_OK; } ASSERT_STATE("CloseInterface"); return m_pimpl->CloseInterface(transportMask, name); } QStatus IpNameService::CloseInterface(TransportMask transportMask, const qcc::IPAddress& address) { // // If the entry gate has been closed, we do not allow a CloseInterface to // actually close anything. The singleton is going away and so we assume we // are running __run_exit_handlers() so main() has returned. We are // definitely shutting down, and the process is going to exit, so tricking // callers who may be temporarily running is okay. // if (m_destroyed) { return ER_OK; } ASSERT_STATE("CloseInterface"); return m_pimpl->CloseInterface(transportMask, address); } QStatus IpNameService::Enable(TransportMask transportMask, const std::map& reliableIPv4PortMap, uint16_t reliableIPv6Port, const std::map& unreliableIPv4PortMap, uint16_t unreliableIPv6Port, bool enableReliableIPv4, bool enableReliableIPv6, bool enableUnreliableIPv4, bool enableUnreliableIPv6) { // // If the entry gate has been closed, we do not allow an Enable to actually // enable anything. The singleton is going away and so we assume we are // running __run_exit_handlers() so main() has returned. We are definitely // shutting down, and the process is going to exit, so tricking callers who // may be temporarily running is okay. // if (m_destroyed) { return ER_OK; } ASSERT_STATE("Enable"); m_pimpl->Enable(transportMask, reliableIPv4PortMap, reliableIPv6Port, unreliableIPv4PortMap, unreliableIPv6Port, enableReliableIPv4, enableReliableIPv6, enableUnreliableIPv4, enableUnreliableIPv6); return ER_OK; } QStatus IpNameService::UpdateDynamicScore(TransportMask transportMask, uint32_t availableTransportConnections, uint32_t maximumTransportConnections, uint32_t availableTransportRemoteClients, uint32_t maximumTransportRemoteClients) { ASSERT_STATE("UpdateDynamicScore"); m_pimpl->UpdateDynamicScore(transportMask, availableTransportConnections, maximumTransportConnections, availableTransportRemoteClients, maximumTransportRemoteClients); return ER_OK; } QStatus IpNameService::Enabled(TransportMask transportMask, std::map& reliableIPv4PortMap, uint16_t& reliableIPv6Port, std::map& unreliableIPv4PortMap, uint16_t& unreliableIPv6Port) { // // If the entry gate has been closed, we do not allow an Enabled to actually // do anything. The singleton is going away and so we assume we are // running __run_exit_handlers() so main() has returned. We are definitely // shutting down, and the process is going to exit, so tricking callers who // may be temporarily running is okay. // if (m_destroyed) { reliableIPv6Port = unreliableIPv6Port = 0; reliableIPv4PortMap.clear(); unreliableIPv4PortMap.clear(); return ER_OK; } ASSERT_STATE("Enabled"); return m_pimpl->Enabled(transportMask, reliableIPv4PortMap, reliableIPv6Port, unreliableIPv4PortMap, unreliableIPv6Port); } QStatus IpNameService::FindAdvertisement(TransportMask transportMask, const qcc::String& matching, TransportMask completeTransportMask) { // // If the entry gate has been closed, we do not allow a FindAdvertisedName // to actually find anything. The singleton is going away and so we assume // we are running __run_exit_handlers() so main() has returned. We are // definitely shutting down, and the process is going to exit, so tricking // callers who may be temporarily running is okay. // if (m_destroyed) { return ER_OK; } ASSERT_STATE("FindAdvertisement"); return m_pimpl->FindAdvertisement(transportMask, matching, IpNameServiceImpl::ALWAYS_RETRY, completeTransportMask); } QStatus IpNameService::CancelFindAdvertisement(TransportMask transportMask, const qcc::String& matching, TransportMask completeTransportMask) { if (m_destroyed) { return ER_OK; } ASSERT_STATE("CancelFindAdvertisement"); return m_pimpl->CancelFindAdvertisement(transportMask, matching, IpNameServiceImpl::ALWAYS_RETRY, completeTransportMask); } QStatus IpNameService::RefreshCache(TransportMask transportMask, const qcc::String& guid, const qcc::String& matching) { if (m_destroyed) { return ER_OK; } ASSERT_STATE("RefreshCache"); return m_pimpl->RefreshCache(transportMask, guid, matching); } QStatus IpNameService::AdvertiseName(TransportMask transportMask, const qcc::String& wkn, bool quietly, TransportMask completeTransportMask) { // // If the entry gate has been closed, we do not allow an AdvertiseName to // actually advertise anything. The singleton is going away and so we // assume we are running __run_exit_handlers() so main() has returned. We // are definitely shutting down, and the process is going to exit, so // tricking callers who may be temporarily running is okay. // if (m_destroyed) { return ER_OK; } ASSERT_STATE("AdvertiseName"); return m_pimpl->AdvertiseName(transportMask, wkn, quietly, completeTransportMask); } QStatus IpNameService::CancelAdvertiseName(TransportMask transportMask, const qcc::String& wkn, TransportMask completeTransportMask) { // // If the entry gate has been closed, we do not allow a CancelAdvertiseName // to actually cancel anything. The singleton is going away and so we // assume we are running __run_exit_handlers() so main() has returned. We // are definitely shutting down, and the process is going to exit, so // tricking callers who may be temporarily running is okay. // if (m_destroyed) { return ER_OK; } ASSERT_STATE("CancelAdvertiseName"); return m_pimpl->CancelAdvertiseName(transportMask, wkn, completeTransportMask); } QStatus IpNameService::OnProcSuspend() { if (m_destroyed) { return ER_OK; } ASSERT_STATE("OnProcSuspend"); return m_pimpl->OnProcSuspend(); } QStatus IpNameService::OnProcResume() { if (m_destroyed) { return ER_OK; } ASSERT_STATE("OnProcResume"); return m_pimpl->OnProcResume(); } void IpNameService::RegisterListener(IpNameServiceListener& listener) { if (m_destroyed) { return; } ASSERT_STATE("RegisterListener"); m_pimpl->RegisterListener(listener); } void IpNameService::UnregisterListener(IpNameServiceListener& listener) { if (m_destroyed) { return; } ASSERT_STATE("UnregisterListener"); m_pimpl->UnregisterListener(listener); } QStatus IpNameService::Ping(TransportMask transportMask, const qcc::String& guid, const qcc::String& name) { if (m_destroyed) { return ER_OK; } ASSERT_STATE("Ping"); return m_pimpl->Ping(transportMask, guid, name); } QStatus IpNameService::Query(TransportMask transportMask, MDNSPacket mdnsPacket) { if (m_destroyed) { return ER_OK; } ASSERT_STATE("Query"); return m_pimpl->Query(transportMask, mdnsPacket); } QStatus IpNameService::Response(TransportMask transportMask, uint32_t ttl, MDNSPacket mdnsPacket) { if (m_destroyed) { return ER_OK; } ASSERT_STATE("Response"); return m_pimpl->Response(transportMask, ttl, mdnsPacket); } bool IpNameService::RemoveFromPeerInfoMap(const qcc::String& guid) { if (m_destroyed) { return false; } ASSERT_STATE("RemoveFromPeerInfoMap"); return m_pimpl->RemoveFromPeerInfoMap(guid); } } // namespace ajn alljoyn-15.04b/alljoyn_core/router/ns/IpNameService.h000066400000000000000000000620031255700255500226270ustar00rootroot00000000000000/** * @file * Singleton for the AllJoyn IP Name Service */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _IP_NAME_SERVICE_H #define _IP_NAME_SERVICE_H #ifndef __cplusplus #error Only include IpNameService.h in C++ code. #endif #include #include #include #include #include #include #include "IpNsProtocol.h" namespace ajn { class IpNameServiceImpl; class IpNameServiceListener { public: virtual ~IpNameServiceListener() { } virtual bool QueryHandler(TransportMask transport, MDNSPacket query, const qcc::IPEndpoint& src, const qcc::IPEndpoint& dst) { QCC_UNUSED(transport); QCC_UNUSED(src); QCC_UNUSED(dst); return false; } virtual bool ResponseHandler(TransportMask transport, MDNSPacket response, uint16_t recvPort) { QCC_UNUSED(transport); QCC_UNUSED(recvPort); return false; } }; /** * @brief API to provide an implementation dependent IP (Layer 3) Name Service * singleton for AllJoyn. * * The IpNameService is implemented as a Meyers singleton, so a static method is * requred to get a reference to the sinle instance of the singleton. The * underlying object will be constructed the first time this method is called. * * We expect that there may be zero to N transports running under control of a * given daemon that will need the name service. Unfortunately, since we may * have a bundled daemon running, we are going to have to admit the possibility * of the ++ static initialization order fiasco. * * The BundledRouter is a static and so the destruction order of the two objects * (him and us) depends on whatever the linker decides the order should be. * * We use the nifty counter mechanism to create the IpNameService static object * We want to have all of the tear-down of the threads performed before main() ends * The singleton will be destructed during the static destruction phase. We reference * count instances of transports that register with the IpNameService to * stop and join the IpNameService object. * * Whenever a transport comes up and wants to interact with the IpNameService it * calls our static Instance() method to get a reference to the underlying name * service object. The first thing * that a transport must do is to Acquire() the instance of the name service, * which is going to bump a reference count and do the hard work of starting the * IpNameService. The last thing a transport must do is to Release() the * instance of the name service. This will do the work of stopping and joining * the name service threads when the last reference is released. Since this * operation may block waiting for the name service thread to exit, this should * only be done in the transport's Join() method. */ class IpNameService { public: /** * @brief The port number for the MDNS name service. * * @see IPv4 Multicast Address space Registry IANA */ static const uint16_t MULTICAST_MDNS_PORT; /** * @brief Return a reference to the IpNameService singleton. */ static IpNameService& Instance(); /** * @brief Notify the singleton that there is a transport coming up that will * be using the IP name service. * * Whenever a transport comes up and wants to interact with the * IpNameService it calls our static Instance() method to get a reference to * the underlying name service object. * The first thing that a transport must do is to Acquire() * the instance of the name service, which is going to bump a reference * count and do the hard work of starting the IpNameService. A transport * author can think of this call as performin a reference-counted Start() * * @param guid A string containing the GUID assigned to the daemon which is * hosting the name service. * @param loopback If true, receive our own advertisements. * Typically used for test programs to listen to themselves talk. */ void Acquire(const qcc::String& guid, bool loopback = false); /** * @brief Notify the singleton that there a transport is going down and will no * longer be using the IP name service. * * The last thing a transport must do is to Release() the instance of the * name service. This will do the work of stopping and joining the name * service threads when the last reference is released. Since this * operation may block waiting for the name service thread to exit, this * should only be done in the transport's Join() method. * * @param guid A string containing the GUID assigned to the daemon which is * hosting the name service. * @param loopback If true, receive our own advertisements. * Typically used for test programs to listen to themselves talk. */ void Release(); /** * @brief Determine if the IpNameService singleton has been started. * * Basically, this determines if the reference count is strictly positive. * * @return True if the singleton has been started, false otherwise. */ bool Started(); /** * @brief Set the callback function that is called to notify a transport about * found and lost well-known names. * * @param transportMask A bitmask containing the transport handling the specified * endpoints. This allows the found advertisements to be demultiplexed into * the interested transports. * @param cb The callback method on the transport that will be called to notify * a transport about found and lost well-known names. */ void SetCallback(TransportMask transportMask, Callback&, uint32_t>* cb); /** * @brief Set the Callback for notification of network interface events. */ void SetNetworkEventCallback(TransportMask transportMask, Callback&>* cb); void RegisterListener(IpNameServiceListener& listener); void UnregisterListener(IpNameServiceListener& listener); /** * @brief Ping a name over the network interfaces opened by the specified * transport. * * @param transportMask A bitmask containing the transport requesting the * ping on. * @param guid The guid for this name * @param name The name to ping. */ QStatus Ping(TransportMask transportMask, const qcc::String& guid, const qcc::String& name); QStatus Query(TransportMask transportMask, MDNSPacket mdnsPacket); QStatus Response(TransportMask transportMask, uint32_t ttl, MDNSPacket mdnsPacket); /** * @brief Creat a virtual network interface. In normal cases WiFi-Direct * creates a soft-AP for a temporary network. In some OSs like WinRT, there is * no API to detect the presence of the soft-AP. Thus we need to manually create * a virtual network interface for it. * * @param entry Contains the network interface parameters * * @return Status of the operation. Returns ER_OK on success. * * @see qcc::IfConfig() * @see qcc::IfConfigEntry */ QStatus CreateVirtualInterface(const qcc::IfConfigEntry& entry); /** * @brief Delete a virtual network interface. In normal cases WiFi-Direct * creates a soft-AP for a temporary network. Once the P2P keep-alive connection is * terminated, we delete the virual network interface that represents the * soft-AP. * * @param ifceName The virtual network interface name * * @return Status of the operation. Returns ER_OK on success. * */ QStatus DeleteVirtualInterface(const qcc::String& ifceName); /** * @brief Enable the name service to advertise over the provided network interface * on behalf of the specified transport. * * @param transportMask A bitmask containing the transport requesting the * advertisements. * @param name The name of the network interface (cf. eth0) over which * advertisements will be sent. */ QStatus OpenInterface(TransportMask transportMask, const qcc::String& name); /** * @brief Enable the name service to advertise over the network interface * having the specified IP address on behalf of the specified transport. * * @param transportMask A bitmask containing the transport requesting the * advertisements. * @param address The IP address of the network interface (cf. 192.168.1.101) * over which advertisements will be sent. */ QStatus OpenInterface(TransportMask transportMask, const qcc::IPAddress& address); /** * @brief Disable the name service from advertising over the provided network * interface on behalf of the specified transport. * * @param transportMask A bitmask containing the transport requesting the * advertisements. * @param name The name of the network interface (cf. eth0) over which * advertisements will no longer be sent. */ QStatus CloseInterface(TransportMask transportMask, const qcc::String& name); /** * @brief Disable the name service from advertising over the network interface * having the specified IP address on behalf of the specified transport. * * @param transportMask A bitmask containing the transport requesting the * advertisements. * @param address The IP address of the network interface (cf. 192.168.1.101) * over which advertisements will no longer be sent. */ QStatus CloseInterface(TransportMask transportMask, const qcc::IPAddress& address); /** * @brief Notify the name service that that there is or is not a listener on * the specified endpoints. * * The IpNameService is shared among several transports. In order to * advertise the presence of a network endpoint managed by a transport, the * transports need to advise us of the IP addresses and ports on which it * can be contacted. Each transport may use a different set of addresses * and ports, and so each transport must identify itself to the name * service. This is done using the TransportMask. There is a bit in the * TransportMask for each transport in the system. * * A transport is defined as a module that provides reliable and/or * unreliable data transfer over IPv4 and/or IPv6. Support for reliable and * unreliable modes is optional, as is support for IPv4 and IPv6. Port * numbers for reliable, unreliable, IPv4 and IPv6 may also differ. An * enable bit is conceptually required since support for each endpoint type * is optional. This makes for thirteen parameters. * * transportMask, * enableReliableIPv4, reliableIPv4Addr, reliableIPv4Port * enableReliableIPv6, reliableIPv6Addr, reliableIPv6Port * enableUnreliableIPv4, unreliableIPv4Addr, unreliableIPv4Port * enableUnReliableIPv6, unreliableIPv6Addr, unreliableIPv6Port * * It turns out that since AllJoyn lives in a mobile environment, the * transport must listen on the "any" address. This is because an IP * address assigned to a given network interface cannot generally be * predicted in advance. * * The mechanism used to "control" which network interfaces can accept * incoming connections, is the presence of outgoing advertisements on those * interfaces. If a transport desires to accept connections over an * interface, it performs an OpenInterface() on that interface which begins * the process of sending advertisements. The IP (V4 and or V6) address of * the interface is added to advertisements and sent out over the network. * This which provides the receiver of the advertisements with an IP address * and port to connect to. The advertising transport, since it is listening * on the "any" address, will respond to all connect requests coming from * clients on the associated network. If the transport wants to filter * further on source IP addresses, it certainly can; but this is not a * concern of the name service. * * This all means that we do not need to specify the IP addresses on which * the reliable and unreliable protocols are listening. Additionally, it * turns out that TCP and UDP port numbers zero are reserved by IANA and so * we can use a port number of zero to indicate a non-enabled condition. * This means that the enabled parameters are not required. This means that * there are five required parameters to this call instead of thirteen: * * transportMask, * reliableIPv4Port, reliableIPv6Port, * unreliableIPv4Port, unreliableIPv6Port, * enableReliableIPv4, enableReliableIPv6, * enableUnreliableIPv4, enableUnreliableIPv6 * * In many cases, the transports will not support all combinations. For * example, the tcp transport currently only supports reliable IPv4 * connections, and so the call for this transport might be: * * SetEndpointsForTransport(TRANSPORT_WLAN, 9955, 0, 0, 0, true, false, false, false); * * The Android Compatibility Test Suite demands that an Android phone may * not hold an open socket in the quiescent state. Since we provide a * native daemon that always runs on the phone, and the daemon has * transports that want to listen on sockets, there must be a way to close * those sockets (and the multicast sockets in the name service) and not * use them at all when there are no advertisements or discovery operations * in progress. This also helps with power consumption. * * Enable() communicates the fact that there is or is not a listener for the * specified transport port and this, in turn, implies whether or not * advertisements should be sent and received over the interfaces opened by * the given transport. * * @param transportMask A bitmask containing the transport handling the specified * endpoints. * @param reliableIPv4PortMap Indicates a map of interfaces to port numbers * of a server listening for connections if enableReliableIPv4 is true * @param reliableIPv6Port Indicates the port number of a server listening for * connections if enableUnreliableIPv4 is true * @param unreliableIPv4PortMap Indicates a map of interfaces to port numbers * of a server listening for connections if enableReliableIPv6 is true * @param unreliableIPv6Port Indicates the port number of a server listening for * connections if enableUnreliableIPv6 is true. * @param enableReliableIPv4 * - true indicates this protocol is enabled. * - false indicates this protocol is not enabled. * @param enableReliableIPv6 * - true indicates this protocol is enabled. * - false indicates this protocol is not enabled. * @param enableUnreliableIPv4 * - true indicates this protocol is enabled. * - false indicates this protocol is not enabled. * @param enableUnreliableIPv4 * - true indicates this protocol is enabled. * - false indicates this protocol is not enabled. */ QStatus Enable(TransportMask transportMask, const std::map& reliableIPv4PortMap, uint16_t reliableIPv6Port, const std::map& unreliableIPv4PortMap, uint16_t unreliableIPv6PortMap, bool enableReliableIPv4, bool enableReliableIPv6, bool enableUnreliableIPv4, bool enableUnreliableIPv6); QStatus UpdateDynamicScore(TransportMask transportMask, uint32_t availableTransportConnections, uint32_t maximumTransportConnections, uint32_t availableTransportRemoteClients, uint32_t maximumTransportRemoteClients); /** * @brief Ask the name service whether or not it thinks there is or is not a * listener on the specified ports for the given transport. * * @param transportMask A bitmask containing the transport handling the specified * endpoints. * @param reliableIPv4PortMap If empty, indicates this protocol is not enabled. If * not empty, indicates the interfaces/port numbers of a server listening for connections. * @param reliableIPv6Port If zero, indicates this protocol is not enabled. If * non-zero, indicates the port number of a server listening for connections. * @param unreliableIPv4PortMap If empty, indicates this protocol is not enabled. If * not empty, indicates the interfaces/port numbers of a server listening for connections. * @param unreliableIPv6Port If zero, indicates this protocol is not enabled. If * non-zero, indicates the port number of a server listening for connections. */ QStatus Enabled(TransportMask transportMask, std::map& reliableIPv4PortMap, uint16_t& reliableIPv6Port, std::map& unreliableIPv4PortMap, uint16_t& unreliableIPv6Port); /** * @brief Discover well-known names starting with the specified prefix over * the network interfaces opened by the specified transport. * * @param transportMask A bitmask containing the transport requesting the * discovery operation. * @param matching The Key, value match criteria that the caller wants to be notified of (via signal) * when a remote Bus instance is found with an advertisement that matches the criteria. */ QStatus FindAdvertisement(TransportMask transportMask, const qcc::String& matching, TransportMask completeTransportMask); QStatus RefreshCache(TransportMask transportMask, const qcc::String& guid, const qcc::String& matching); /** * @brief Stop discovering well-known names starting with the specified * prefix over the network interfaces opened by the specified transport. * * @param transportMask A bitmask containing the transport requesting the * discovery operation. * @param matching The Key, value match criteria that the caller wants to be notified of (via signal) * when a remote Bus instance is found with an advertisement that matches the criteria. */ QStatus CancelFindAdvertisement(TransportMask transportMask, const qcc::String& matching, TransportMask completeTransportMask); /** * @brief Advertise a well-known name over the network interfaces opened by the * specified transport. * * @param transportMask A bitmask containing the transport requesting the * advertisement. * @param wkn The well-known name to advertise. * @param quietly The quietly parameter, if true, specifies to not do * gratuitous advertisements (send periodic is-at messages indicating we * have the provided name avialable) but do respond to who-has requests * for the name. */ QStatus AdvertiseName(TransportMask transportMask, const qcc::String& wkn, bool quietly, TransportMask completeTransportMask); /** * @brief Stop advertising a well-known name over the network interfaces * opened by the specified transport. * * @param transportMask A bitmask containing the transport requesting the * advertisement be canceled. * @param wkn The well-known name to stop advertising. */ QStatus CancelAdvertiseName(TransportMask transportMask, const qcc::String& wkn, TransportMask completeTransportMask); /** * @brief Handle the suspending event of the process. Release exclusive socket file descriptor and port. */ QStatus OnProcSuspend(); /** * @brief Handle the resuming event of the process. Re-acquire exclusive socket file descriptor and port. */ QStatus OnProcResume(); /** * @brief Remove the entry correspongding to guid from the PeerInfoMap * @param guid The entry corresponding to this guid needs to be removed from the PeerInfoMap */ bool RemoveFromPeerInfoMap(const qcc::String& guid); private: static void Init(); static void Shutdown(); friend class RouterGlobals; /** * This is a singleton so the constructor is marked private to prevent * construction of an IpNameService instance in any other sneaky way than * the nifty counter mechanism. */ IpNameService(); /** * This is a singleton so the destructor is marked private to prevent * destruction of an IpNameService instance in any other sneaky way than the * Meyers singleton mechanism. */ virtual ~IpNameService(); /** * This is a singleton so the copy constructor is marked private to prevent * destruction of an IpNameService instance in any other sneaky way than the * Meyers singleton mechanism. */ IpNameService(const IpNameService& other); /** * This is a singleton so the assignment constructor is marked private to * prevent destruction of an IpNameService instance in any other sneaky way * than the Meyers singleton mechanism. */ IpNameService& operator =(const IpNameService& other); /** * @brief Start the IpNameService singleton. * * Since the IpNameService is shared among transports, the responsibility * for starting, stopping and joining the name service should not reside * with any single transport. We provide a reference counting mechanism to * deal with this and so the actual Start() method is private and called * from the public Acquire(). * * @return ER_OK if the start operation completed successfully, or an error code * if not. */ QStatus Start(); /** * @brief Stop the IpNameService singleton. * * Since the IpNameService is shared among transports, the responsibility * for starting, stopping and joining the name service should not reside * with any single transport. We provide a reference counting mechanism to * deal with this and so the actual Stop() method is private and called from * the public Release(). * * @return ER_OK if the stop operation completed successfully, or an error code * if not. */ QStatus Stop(); /** * @brief Join the IpNameService singleton. * * Since the IpNameService is shared among transports, the responsibility * for starting, stopping and joining the name service should not reside * with any single transport. We provide a reference counting mechanism to * deal with this and so the actual Join() method is private and called from * the public Release(). * * @return ER_OK if the join operation completed successfully, or an error code * if not. */ QStatus Join(); /** * @brief Initialize the IpNameService singleton. * * Since the IpNameService is shared among transports, the responsibility for * initializing the shared name service should not reside with any single * transport. We provide a reference counting mechanism to deal with this and * so the actual Init() method is private and called from the public Acquire(). * The first transport to Acquire() provides the GUID, which must be unchanging * across transports since they are all managed by a single daemon. * * @param guid A string containing the GUID assigned to the daemon which is * hosting the name service. * @param loopback If true, receive our own advertisements. * Typically used for test programs to listen to themselves talk. */ QStatus Init(const qcc::String& guid, bool loopback = false); bool m_constructed; /**< State variable indicating the singleton has been constructed */ bool m_destroyed; /**< State variable indicating the singleton has been destroyed */ int32_t m_refCount; /**< The number of transports that have registered as users of the singleton */ IpNameServiceImpl* m_pimpl; /**< A pointer to the private implementation of the name service */ }; } // namespace ajn #endif // _IP_NAME_SERVICE_H alljoyn-15.04b/alljoyn_core/router/ns/IpNameServiceImpl.cc000066400000000000000000014443341255700255500236230ustar00rootroot00000000000000/** * @file * The lightweight name service implementation */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #if defined(QCC_OS_GROUP_WINDOWS) #define close closesocket #include #include #include #include #endif #include #include #include #include #include #include #include #include #include #include #include "BusUtil.h" #include "IpNameServiceImpl.h" #define QCC_MODULE "IPNS" using namespace std; using namespace qcc; namespace ajn { int32_t INCREMENTAL_PACKET_ID; #define RESET_SCHEDULE_ALERTCODE 1 #define PACKET_TIME_ACCURACY_MS 20 #define DYNAMIC_RANK_RANGE 18000u #define TCP_NORMALIZED_CONNECTIONS 500u #define UDP_NORMALIZED_CONNECTIONS 5000u #define TCL_NORMALIZED_CONNECTIONS 100u // ============================================================================ // Long sidebar on why this looks so complicated: // // In order to understand all of the trouble we are going to go through below, // it is helpful to thoroughly understand what is done on our platforms in the // presence of multicast. This is long reading, but worthwhile reading if you // are trying to understand what is going on. I don't know of anywhere you // can find all of this written in one place. // // The first thing to grok is that all platforms are implemented differently. // Windows and Linux use IGMP to enable and disable multicast, and use other // multicast-related socket calls to do the fine-grained control. Android // doesn't bother to compile its kernel with CONFIG_IP_MULTICAST set. This // doesn't mean that there is no multicast code in the Android kernel, it means // there is no IGMP code in the kernel. Since IGMP isn't implemented, Android // can't use it to enable and disable multicast at the driver level, so it uses // wpa_supplicant driver-private commands instead. This means that you will // probably get three different answers if you ask how some piece of the // multicast puzzle works. // // On the send side, multicast is controlled by the IP_MULTICAST_IF (or for // IPv6 IPV6_MULTICAST_IF) socket. In IPv4 you provide an IP address and in // IPv6 you provide an interface index. These differences are abstracted in // the qcc code and there you are asked to provide an interface name, which the // abstraction function uses to figure out the appropriate address or index // depending on the address family. Unfortunately, you can't abstract away // the operating system differences in how they interpret the calls; so you // really need to understand what is happening at a low level in order to get // the high level multicast operations to do what you really want. // // If you do nothing (leave the sockets as you find them), or set the interface // address to 0.0.0.0 for IPv4 or the interface index to 0 for IPv6 the // multicast output interface is essentially selected by the system routing // code. // // In Linux (and Android), multicast packets are sent out the interface that is // used for the default route (the default interface). You can see this if you // type "ip ro sh". In Windows, however, the system chooses its default // interface by looking for the lowest value for the routing metric for a // destination IP address of 224.0.0.0 in its routing table. You can see this // in the output of "route print". // // We want all of our multicast code to work in the presence of IP addresses // changing when phones move from one Wifi access point to another, or when our // desktop access point changes when someone with a mobile access point walks // by; so it is also important to know what will happen when these addresses // change (or come up or go down). // // On Linux, if you set the IP_MULTICAST_IF to 0.0.0.0 (or index 0 in IPv6) and // bring down the default interface or change the IP address on the default // interface, you will begin to fail the multicast sends with "network // unreachable" errors since the default route goes away when you change the IP // address (e.g, just do somthing like "sudo ifconfig eth1 10.4.108.237 netmask // 255.255.255.0 up to change the address). Until you provide a new default // route (e.g., "route add default gw 10.4.108.1") the multicast packets will be // dropped, but as soon as a new default route is set, they will begin flowing // again. // // In Windows, if you set the IP_MULTICAST_IF address to 0.0.0.0 and release the // ip address (e.g., "ipconfig /release") the sends may still appear to work at // the level of the program but nothing goes out the original interface. The // sends fail silently. This is because Windows will dynamically change the // default multicast route according to its internal multicast routing table. // It selects another interface based on a routing metric, and it could, for // example, just switch to a VMware virtual interface silently. The name // service would never know it just "broke" and is no longer sending packets out // the interface it thinks it is. // // When we set up multicast advertisements in our system, we most likely do not // want to route our advertisements only to the default adapter. For example, // on a desktop system, the default interface is probably one of the wired // Ethernets. We may or many not want to advertise on that interface, but we // may also want to advertise on other wired interfaces and other wireless // interfaces as well. // // We do not want the system to start changing multicast destinations out from // under us, EVER. Because of this, the only time using INADDR_ANY would be // appropriate in the IP_MULTICAST_IF socket option is in the simplest, static // network situations. For the general case, we really need to keep multiple // sockets that are each talking to an INTERFACE of interest (not an IP address // of interest, since they can change at any time because of normal access point // dis-associations, for example). // // Since we determined that we needed to use IP_MULTICAST_IF to control which // interfaces are used for discovery, we needed to understand exactly what // changing an IP address out from under a corresponding interface would do. // // The first thing we observed is that IP_MULTICAST_IF takes an IP address in // the case of IPv4, but we wanted to specify an interface index as in IPv6 or // for mere mortal human beings, a name (e.g., "wlan0"). It may be the case // that the interface does not have an IP address assigned (is not up or // connected to an access point) at the time we want to start our name service, // so a call to set the IP_MULTICAST_IF (via the appropriate abstract qcc call) // would not be possible until an address is available, perhaps an arbitrary // unknowable time later. If sendto() operations are attempted and the IP // address is not valid one will see "network unreachable" errors. As we will // discuss shortly, joining a multicast group also requires an IP address in the // case of IPv4 (need to send IGMP Join messages), so it is not possible to // express interest in receiving multicast packets until an IP address is // available. // // So we needed to provide an API that allows a user to specify a network // interface over which she is interested in advertising. This explains the // method OpenInterface(qcc::String interface) defined below. The client is // expected to figure out which interfaces it wants to do discovery over (e.g., // "wlan0", "eth0") and explicitly tell the name service which interfaces it is // interested in. We clearly need a lazy evaluation mechanism in the name // service to look at the interfaces which the client expresses interest in, and // when IP addresses are available, or change, we begin using those interfaces. // If the interfaces go down, or change out from under the name service, we need // to deal with that fact and make things right. // // We can either hook system "IP address changed" or "interface state changed" // events to drive the re-evaluation process as described above, or we can poll // for those changes. Since the event systems in our various target platforms // are wildly different, creating an abstract event system is non-trivial (for // example, a DBus-based network manager exists on Linux, but even though // Android is basically Linux and has DBus, it doesn't use it. You'd need to // use Netlink sockets on most Posix systems, but Darwin doesn't have Netlink. // Windows is from another planet. // // Because of all of these complications, we just choose the better part of // valor and poll for changes using a maintenance thread that fires off every // second and looks for changes in the networking environment and adjusts // accordingly. // // We could check for IP address changes on the interfaces and re-evaluate and // open new sockets bound to the correct interfaces whenever an address change // happens. It is possible, however, that we could miss the fact that we have // switched access points if DHCP gives us the same IP address. Windows, for // example, could happily begin rerouting packets to other interfaces if one // goes down. If the interface comes back up on a different access point, which // gives out the same IP address, Windows could bring us back up but leave the // multicast route pointing somewhere else and we would never notice. Because // of these byzantine kinds of errors, we chose the better part of valor and // decided to close all of our multicast sockets down and restart them in a // known state periodically. // // The receive side has similar kinds of issues. // // In order to receive multicast datagrams sent to a particular port, it is // necessary to bind that local port leaving the local address unspecified // (i.e., INADDR_ANY or in6addr_any). What you might think of as binding is // then actually handled by the Internet Group Management Protocol (IGMP) or its // ICMPv6 equivalent. Recall that Android does not implement IGMP, so we have // yet another complication. // // Using IGMP, we join the socket to the multicast group instead of binding the // socket to a specific interface (address) and port. Binding the socket to // INADDR_ANY or in6addr_any may look strange, but it is actually the right // thing to do. Since joining a multicast group requires sending packets over // the IGMP protocol, we need a valid IP address in order to do the join. As // mentioned above, an interface must be IFF_UP with an assigned IP address in // order to join a multicast group. // // The socket option for joining a multicast group, of course, works differently // for IPv4 and IPv6. IP_ADD_MEMBERSHIP (for IPv4) has a provided IP address // that can be either INADDR_ANY or a specific address. If INADDR_ANY is // provided, the interface of the default route is added to the group, and the // IGMP join is sent out that interface. IPV6_ADD_MEMBERSHIP (for IPv6) has a // provided interface index that can be either 0 or a specific interface. If 0 // is provided, the interface of the default route is added to the group, and // the IGMP Join (actually an ICMPv6 equivalent) is sent out that interface. If // a specific interface index is that interface is added to the group and the // IGMP join is sent out that interface. Note that since an ICMP packet is sent, // the interface must be IFF_UP with an assigned IP address even though the // interface is specified by an index. // // A side effect of the IGMP join deep down in the kernel is to enable reception // of multicast MAC addresses in the device driver. Since there is no IGMP in // Android, we must rely on a multicast (Java) lock being taken by some external // code on phones that do not leave multicast always enabled (HTC Desire, for // example). When the Java multicast lock is taken, a private driver command is // sent to the wpa_supplicant which, in turn, calls into the appropriate network // device driver(s) to enable reception of multicast MAC packets. This is // completely out of our control here. // // Similar to the situation on the send side, we most likely do not want to rely // on the system routing tables to configure which network interfaces our name // service receives over; so we really need to provide a specific address. // // If a specific IP address is provided, then that address must be an address // assigned to a currently-UP interface. This is the same catch-22 as we have // on the send side. We need to lazily evaluate the interface in order to find // if an IP address has appeared on that interface and then join the multicast // group to enable multicast on the underlying network device. // // It turns out that in Linux, the IP address passed to the join multicast group // socket option call is actually not significant after the initial call. It is // used to look up an interface and its associated net device and to then set // the PACKET_MULTICAST filter on the net device to receive packets destined for // the specified multicast address. If the IP address associated with the // interface changes, multicast messages will continue to be received. // // Of course, Windows does it differently. They look at the IP address passed // to the socket option as being significant, and so if the underlying IP // address changes on a Windows system, multicast packets will no longer be // delivered. Because of this, the receive side of the multicast name service // has also got to look for changes to IP address configuration and re-set // itself whenever it finds a change. // // So the code you find below may look overly complicated, but (hopefully most // of it, anyway) needs to be that way. // // As an aside, the daemon that owns us can be happy as a clam by simply binding // to INADDR_ANY since the semantics of this action, as interpreted by both // Windows and Linux, are to listen for connections on all current and future // interfaces and their IP addresses. The complexity is fairly well contained // here. // ============================================================================ // // There are configurable attributes of the name service which are determined // by the configuration database. A module name is required and is defined // here. An example of how to use this is in setting the interfaces the name // service will use for discovery. // // // * // false // false // false // // // // The value of the interfaces property used to configure the name service // to run discovery over all interfaces in the system. // const char* IpNameServiceImpl::INTERFACES_WILDCARD = "*"; // // Define WORKAROUND_2_3_BUG to send name service messages over the old site // administered addresses to work around a forward compatibility bug introduced // in version 2.3 daemons. They neglect to join the new IANA assigned multicast // groups and so cannot receive advertisements on those groups. In order to // workaround this problem, we send version zero name service messages over the // old groups. The old versions can send new IANA multicast group messages so // we can receive advertisements from them. They just can't hear our new // messages // #define WORKAROUND_2_3_BUG 0 #if WORKAROUND_2_3_BUG // // This is just a random IPv4 multicast group chosen out of the defined site // administered block of addresses. This was a temporary choice while an IANA // reservation was in process, and remains for backward compatibility. // const char* IpNameServiceImpl::IPV4_MULTICAST_GROUP = "239.255.37.41"; // // This is an IPv6 version of the temporary IPv4 multicast address described // above. IPv6 multicast groups are composed of a prefix containing 0xff and // then flags (4 bits) followed by the IPv6 Scope (4 bits) and finally the IPv4 // group, as in "ff03::239.255.37.41". The Scope corresponding to the IPv4 // Local Scope group is defined to be "3" by RFC 2365. Unfortunately, the // qcc::IPAddress code can't deal with "ff03::239.255.37.41" so we have to // translate it. // const char* IpNameServiceImpl::IPV6_MULTICAST_GROUP = "ff03::efff:2529"; #endif #if 1 // // This is the IANA assigned IPv4 multicast group for AllJoyn. This is // a Local Network Control Block address. // // See IPv4 Multicast Address space Registry IANA // const char* IpNameServiceImpl::IPV4_ALLJOYN_MULTICAST_GROUP = "224.0.0.113"; const char* IpNameServiceImpl::IPV4_MDNS_MULTICAST_GROUP = "224.0.0.251"; #endif // // This is the IANA assigned UDP port for the AllJoyn Name Service. See // see Service Name and Transport Protocol Port Number Registry IANA // const uint16_t IpNameServiceImpl::MULTICAST_PORT = 9956; const uint16_t IpNameServiceImpl::BROADCAST_PORT = IpNameServiceImpl::MULTICAST_PORT; const uint16_t IpNameServiceImpl::MULTICAST_MDNS_PORT = 5353; const uint16_t IpNameServiceImpl::BROADCAST_MDNS_PORT = IpNameServiceImpl::MULTICAST_MDNS_PORT; // // This is the IANA assigned IPv6 multicast group for AllJoyn. The assigned // address is a variable scope address (ff0x) but we always use the link local // scope (ff02). See IPv4 Multicast Address space Registry IANA // const char* IpNameServiceImpl::IPV6_ALLJOYN_MULTICAST_GROUP = "ff02::13a"; const char* IpNameServiceImpl::IPV6_MDNS_MULTICAST_GROUP = "ff02::fb"; const uint32_t IpNameServiceImpl::RETRY_INTERVALS[] = { 1, 2, 6, 18 }; /** * Default router search prefix. */ const char* const IpNameServiceImpl::ALLJOYN_DEFAULT_ROUTER_ADVERTISEMENT_PREFIX = "org.alljoyn.BusNode."; const char* const IpNameServiceImpl::ALLJOYN_DEFAULT_ROUTER_POWER_SOURCE = "Battery powered and chargeable"; const char* const IpNameServiceImpl::ALLJOYN_DEFAULT_ROUTER_MOBILITY = "Intermediate mobility"; const char* const IpNameServiceImpl::ALLJOYN_DEFAULT_ROUTER_AVAILABILITY = "3-6 hr"; const char* const IpNameServiceImpl::ALLJOYN_DEFAULT_ROUTER_NODE_TYPE = "Wireless"; IpNameServiceImpl::IpNameServiceImpl() : Thread("IpNameServiceImpl"), m_state(IMPL_SHUTDOWN), m_isProcSuspending(false), m_terminal(false), m_protect_callback(false), m_protect_net_callback(false), m_timer(0), m_tDuration(DEFAULT_DURATION), m_tRetransmit(RETRANSMIT_TIME), m_tQuestion(QUESTION_TIME), m_modulus(QUESTION_MODULUS), m_retries(ArraySize(RETRY_INTERVALS)), m_loopback(false), m_broadcast(false), m_enableIPv4(false), m_enableIPv6(false), m_enableV1(false), m_wakeEvent(), m_forceLazyUpdate(false), m_refreshAdvertisements(false), m_enabled(false), m_doEnable(false), m_doDisable(false), m_ipv6QuietSockFd(qcc::INVALID_SOCKET_FD), m_ipv4UnicastSockFd(qcc::INVALID_SOCKET_FD), m_unicastEvent(NULL), m_protectListeners(false), m_packetScheduler(*this), m_networkChangeScheduleCount(ArraySize(RETRY_INTERVALS)), m_staticScore(0), m_dynamicScore(0), m_priority(0), m_powerSource(0), m_mobility(0), m_availability(0), m_nodeConnection(0) { QCC_DbgHLPrintf(("IpNameServiceImpl::IpNameServiceImpl()")); TRANSPORT_INDEX_TCP = IndexFromBit(TRANSPORT_TCP); TRANSPORT_INDEX_UDP = IndexFromBit(TRANSPORT_UDP); memset(&m_any[0], 0, sizeof(m_any)); memset(&m_callback[0], 0, sizeof(m_callback)); memset(&m_networkEventCallback[0], 0, sizeof(m_networkEventCallback)); memset(&m_enabledReliableIPv4[0], 0, sizeof(m_enabledReliableIPv4)); memset(&m_enabledUnreliableIPv4[0], 0, sizeof(m_enabledUnreliableIPv4)); memset(&m_enabledReliableIPv6[0], 0, sizeof(m_enabledReliableIPv6)); memset(&m_enabledUnreliableIPv6[0], 0, sizeof(m_enabledUnreliableIPv6)); memset(&m_reliableIPv6Port[0], 0, sizeof(m_reliableIPv6Port)); memset(&m_unreliableIPv6Port[0], 0, sizeof(m_unreliableIPv6Port)); memset(&m_processTransport[0], 0, sizeof(m_processTransport)); memset(&m_doNetworkCallback[0], 0, sizeof(m_doNetworkCallback)); for (uint32_t i = 0; i < N_TRANSPORTS; i++) { m_dynamicParams[i].availableTransportConnections = 0; m_dynamicParams[i].availableTransportRemoteClients = 0; m_dynamicParams[i].maximumTransportConnections = 0; m_dynamicParams[i].maximumTransportRemoteClients = 0; } } QStatus IpNameServiceImpl::Init(const qcc::String& guid, bool loopback) { QCC_DbgHLPrintf(("IpNameServiceImpl::Init()")); // // Can only call Init() if the object is not running or in the process // of initializing // if (m_state != IMPL_SHUTDOWN) { return ER_FAIL; } // // There should be no queued packets between IMPL_SHUTDOWN to // IMPL_INITIALIZING. // assert(m_outbound.size() == 0); assert(m_burstQueue.size() == 0); m_state = IMPL_INITIALIZING; ConfigDB* config = ConfigDB::GetConfigDB(); // // We enable v0 and v1 traffic unless explicitly configured not to do so. // m_enableV1 = config->GetFlag("ns_enable_v1", true); // // We enable outbound traffic on a per-interface basis. Whether or not we // will consider using a network interface address to send name service // packets depends on the configuration. // m_enableIPv4 = !config->GetFlag("ns_disable_ipv4"); m_enableIPv6 = !config->GetFlag("ns_disable_ipv6"); LoadStaticRouterParams(config); m_staticScore = ComputeStaticScore(m_powerSource, m_mobility, m_availability, m_nodeConnection); if (m_enableV1) { m_broadcast = !config->GetFlag("ns_disable_directed_broadcast"); } else { // // V2 doesn't require broadcast. // m_broadcast = false; } m_guid = guid; m_loopback = loopback; m_terminal = false; m_networkChangeScheduleCount = ArraySize(RETRY_INTERVALS); return ER_OK; } // // When we moved the name service out of the TCP transport and promoted it to a // singleton, we opened a bit of a can of worms because of the C++ static // destruction order fiasco and our interaction with the bundled daemon. // // Since the bundled daemon may be destroyed after the IP name service singleton // it is possible that multiple threads (transports) may be still accessing the // name service as it is being destroyed. This horrific situation will be // resolved when we accomplish strict destructor ordering, but for now, we have // the possibility. // // This object was never intended to provide multithread safe destruction and so // we are exposed in the case where the object destroys itself around a thread // that is executing in one of its methods. The chances are small that this // happens, but the chance is non-zero; and the result might be a crash after // the process main() function exits! // IpNameServiceImpl::~IpNameServiceImpl() { QCC_DbgHLPrintf(("IpNameServiceImpl::~IpNameServiceImpl()")); // // Stop the worker thread to get things calmed down. // if (IsRunning()) { Stop(); Join(); } // // We may have some open sockets. Windows boxes may have Winsock shut down // by the time we get to this destructor so we are out of luck trying to // make the necessary calls. // #if !defined(QCC_OS_GROUP_WINDOWS) ClearLiveInterfaces(); #endif for (uint32_t i = 0; i < N_TRANSPORTS; ++i) { // // Delete any callbacks that any users of this class may have set. We // assume we are not multithreaded at this point. // delete m_callback[i]; m_callback[i] = NULL; delete m_networkEventCallback[i]; m_networkEventCallback[i] = NULL; // // We can just blow away the requested interfaces without a care since // nobody else clears them and we are obviously done with them. // m_requestedInterfaces[i].clear(); } // // If we opened a socket to send quiet responses (unicast, not over the // multicast channel) we need to close it. // if (m_ipv6QuietSockFd != qcc::INVALID_SOCKET_FD) { qcc::Close(m_ipv6QuietSockFd); m_ipv6QuietSockFd = qcc::INVALID_SOCKET_FD; } // // m_unicastEvent must be deleted before closing m_ipv4UnicastSockFd, // because m_unicastEvent's destructor code path is using // m_ipv4UnicastSockFd. // if (m_unicastEvent) { delete m_unicastEvent; m_unicastEvent = NULL; } if (m_ipv4UnicastSockFd != qcc::INVALID_SOCKET_FD) { qcc::Close(m_ipv4UnicastSockFd); m_ipv4UnicastSockFd = qcc::INVALID_SOCKET_FD; } // // All shut down and ready for bed. // m_state = IMPL_SHUTDOWN; } QStatus IpNameServiceImpl::CreateVirtualInterface(const qcc::IfConfigEntry& entry) { QCC_DbgPrintf(("IpNameServiceImpl::CreateVirtualInterface(%s)", entry.m_name.c_str())); std::vector::const_iterator it = m_virtualInterfaces.begin(); for (; it != m_virtualInterfaces.end(); it++) { if (it->m_name == entry.m_name) { QCC_DbgPrintf(("Interface(%s) already exists", entry.m_name.c_str())); return ER_FAIL; } } m_virtualInterfaces.push_back(entry); m_forceLazyUpdate = true; m_wakeEvent.SetEvent(); return ER_OK; } QStatus IpNameServiceImpl::DeleteVirtualInterface(const qcc::String& ifceName) { QCC_DbgPrintf(("IpNameServiceImpl::DeleteVirtualInterface(%s)", ifceName.c_str())); std::vector::iterator it = m_virtualInterfaces.begin(); for (; it != m_virtualInterfaces.end(); it++) { if (it->m_name == ifceName) { m_virtualInterfaces.erase(it); m_forceLazyUpdate = true; m_wakeEvent.SetEvent(); return ER_OK; } } QCC_DbgPrintf(("Interface(%s) does not exist", ifceName.c_str())); return ER_FAIL; } QStatus IpNameServiceImpl::OpenInterface(TransportMask transportMask, const qcc::String& name) { QCC_DbgHLPrintf(("IpNameServiceImpl::OpenInterface(%s)", name.c_str())); // // Exactly one bit must be set in a transport mask in order to identify the // one transport (in the AllJoyn sense) that is making the request. // if (CountOnes(transportMask) != 1) { QCC_LogError(ER_BAD_TRANSPORT_MASK, ("IpNameServiceImpl::OpenInterface(): Bad transport mask")); return ER_BAD_TRANSPORT_MASK; } // // Can only call OpenInterface() if the object is running. // if (m_state != IMPL_RUNNING) { QCC_DbgPrintf(("IpNameServiceImpl::OpenInterface(): Not running")); return ER_FAIL; } // // If the user specifies the wildcard interface name, this trumps everything // else. // if (name == INTERFACES_WILDCARD) { qcc::IPAddress wildcard("0.0.0.0"); return OpenInterface(transportMask, wildcard); } qcc::IPAddress addr; QStatus status = addr.SetAddress(name, false); if (status == ER_OK) { return OpenInterface(transportMask, addr); } uint32_t transportIndex = IndexFromBit(transportMask); assert(transportIndex < 16 && "IpNameServiceImpl::OpenInterface(): Bad transport index"); if (transportIndex >= 16) { return ER_BAD_TRANSPORT_MASK; } // // There are at least two threads that can wander through the vector below // so we need to protect access to the list with a convenient mutex. // m_mutex.Lock(); for (uint32_t i = 0; i < m_requestedInterfaces[transportIndex].size(); ++i) { if (m_requestedInterfaces[transportIndex][i].m_interfaceName == name) { QCC_DbgPrintf(("IpNameServiceImpl::OpenInterface(): Already opened.")); // We need to be idempotent. It is possible that one of the // transports has been shut down, but some other transports // are still up. We want to allow the transport that was shut // down the possibility of being revived and refreshing its // network state. m_processTransport[transportIndex] = true; m_forceLazyUpdate = true; m_wakeEvent.SetEvent(); m_mutex.Unlock(); return ER_OK; } } InterfaceSpecifier specifier; specifier.m_interfaceName = name; specifier.m_interfaceAddr = qcc::IPAddress("0.0.0.0"); specifier.m_transportMask = transportMask; m_processTransport[transportIndex] = true; m_requestedInterfaces[transportIndex].push_back(specifier); m_forceLazyUpdate = true; m_wakeEvent.SetEvent(); m_mutex.Unlock(); return ER_OK; } QStatus IpNameServiceImpl::OpenInterface(TransportMask transportMask, const qcc::IPAddress& addr) { QCC_DbgHLPrintf(("IpNameServiceImpl::OpenInterface(%s)", addr.ToString().c_str())); // // Exactly one bit must be set in a transport mask in order to identify the // one transport (in the AllJoyn sense) that is making the request. // if (CountOnes(transportMask) != 1) { QCC_LogError(ER_BAD_TRANSPORT_MASK, ("IpNameServiceImpl::OpenInterface(): Bad transport mask")); return ER_BAD_TRANSPORT_MASK; } uint32_t transportIndex = IndexFromBit(transportMask); assert(transportIndex < 16 && "IpNameServiceImpl::OpenInterface(): Bad transport index"); if (transportIndex >= 16) { return ER_BAD_TRANSPORT_MASK; } // // Can only call OpenInterface() if the object is running. // if (m_state != IMPL_RUNNING) { QCC_DbgPrintf(("IpNameServiceImpl::OpenInterface(): Not running")); return ER_FAIL; } // // There are at least two threads that can wander through the vector below // so we need to protect access to the list with a convenient mutex. // m_mutex.Lock(); // // We treat the INADDR_ANY address (and the equivalent IPv6 address as a // wildcard. To have the same semantics as using INADDR_ANY in the TCP // transport listen spec, and avoid resulting user confusion, we need to // interpret this as "use any interfaces that are currently up, or may come // up in the future to send and receive name service messages over." This // trumps anything else the user might throw at us. We set a global flag to // indicate this mode of operation and clear it if we see a CloseInterface() // on INADDR_ANY. These calls are not reference counted. // m_any[transportIndex] = false; if (addr == qcc::IPAddress("0.0.0.0") || addr == qcc::IPAddress("0::0") || addr == qcc::IPAddress("::")) { QCC_DbgPrintf(("IpNameServiceImpl::OpenInterface(): Wildcard address")); m_any[transportIndex] = true; m_processTransport[transportIndex] = true; m_forceLazyUpdate = true; m_wakeEvent.SetEvent(); m_mutex.Unlock(); return ER_OK; } for (uint32_t i = 0; i < m_requestedInterfaces[transportIndex].size(); ++i) { if (m_requestedInterfaces[transportIndex][i].m_interfaceAddr == addr) { QCC_DbgPrintf(("IpNameServiceImpl::OpenInterface(): Already opened.")); // We need to be idempotent. It is possible that one of the // transports has been shut down, but some other transports // are still up. We want to allow the transport that was shut // down the possibility of being revived and refreshing its // network state. m_processTransport[transportIndex] = true; m_forceLazyUpdate = true; m_wakeEvent.SetEvent(); m_mutex.Unlock(); return ER_OK; } } InterfaceSpecifier specifier; specifier.m_interfaceName = ""; specifier.m_interfaceAddr = addr; specifier.m_transportMask = transportMask; m_processTransport[transportIndex] = true; m_requestedInterfaces[transportIndex].push_back(specifier); m_forceLazyUpdate = true; m_wakeEvent.SetEvent(); m_mutex.Unlock(); return ER_OK; } QStatus IpNameServiceImpl::CloseInterface(TransportMask transportMask, const qcc::String& name) { QCC_DbgHLPrintf(("IpNameServiceImpl::CloseInterface(%s)", name.c_str())); // // Exactly one bit must be in set a transport mask in order to identify the // one transport (in the AllJoyn sense) that is making the request. // if (CountOnes(transportMask) != 1) { QCC_LogError(ER_BAD_TRANSPORT_MASK, ("IpNameServiceImpl::CloseInterface(): Bad transport mask")); return ER_BAD_TRANSPORT_MASK; } // // Can only call CloseInterface() if the object is running. // if (m_state != IMPL_RUNNING) { QCC_DbgPrintf(("IpNameServiceImpl::CloseInterface(): Not running")); return ER_FAIL; } uint32_t transportIndex = IndexFromBit(transportMask); assert(transportIndex < 16 && "IpNameServiceImpl::CloseInterface(): Bad transport index"); if (transportIndex >= 16) { return ER_BAD_TRANSPORT_MASK; } // // There are at least two threads that can wander through the vector below // so we need to protect access to the list with a convenient mutex. // m_mutex.Lock(); // // use Meyers' idiom to keep iterators sane. Note that we don't close the // socket in this call, we just remove the request and the lazy updator will // just not use it when it re-evaluates what to do. // for (vector::iterator i = m_requestedInterfaces[transportIndex].begin(); i != m_requestedInterfaces[transportIndex].end();) { if ((*i).m_interfaceName == name) { i = m_requestedInterfaces[transportIndex].erase(i); } else { ++i; } } m_forceLazyUpdate = true; m_wakeEvent.SetEvent(); m_mutex.Unlock(); return ER_OK; } QStatus IpNameServiceImpl::CloseInterface(TransportMask transportMask, const qcc::IPAddress& addr) { QCC_DbgHLPrintf(("IpNameServiceImpl::CloseInterface(%s)", addr.ToString().c_str())); // // Exactly one bit must be set in a transport mask in order to identify the // one transport (in the AllJoyn sense) that is making the request. // if (CountOnes(transportMask) != 1) { QCC_LogError(ER_BAD_TRANSPORT_MASK, ("IpNameServiceImpl::CloseInterface(): Bad transport mask")); return ER_BAD_TRANSPORT_MASK; } // // Can only call CloseInterface() if the object is running. // if (m_state != IMPL_RUNNING) { QCC_DbgPrintf(("IpNameServiceImpl::CloseInterface(): Not running")); return ER_FAIL; } uint32_t transportIndex = IndexFromBit(transportMask); assert(transportIndex < 16 && "IpNameServiceImpl::CloseInterface(): Bad transport index"); if (transportIndex >= 16) { return ER_BAD_TRANSPORT_MASK; } // // There are at least two threads that can wander through the vector below // so we need to protect access to the list with a convenient mutex. // m_mutex.Lock(); // // We treat the INADDR_ANY address (and the equivalent IPv6 address as a // wildcard. We set a global flag in OpenInterface() to indicate this mode // of operation and clear it here. These calls are not reference counted // so one call to CloseInterface(INADDR_ANY) will stop this mode // irrespective of how many opens are done. // if (addr == qcc::IPAddress("0.0.0.0") || addr == qcc::IPAddress("0::0") || addr == qcc::IPAddress("::")) { QCC_DbgPrintf(("IpNameServiceImpl::CloseInterface(): Wildcard address")); m_any[transportIndex] = false; m_mutex.Unlock(); return ER_OK; } // // use Meyers' idiom to keep iterators sane. Note that we don't close the // socket in this call, we just remove the request and the lazy updator will // just not use it when it re-evaluates what to do. // for (vector::iterator i = m_requestedInterfaces[transportIndex].begin(); i != m_requestedInterfaces[transportIndex].end();) { if ((*i).m_interfaceAddr == addr) { i = m_requestedInterfaces[transportIndex].erase(i); } else { ++i; } } m_forceLazyUpdate = true; m_wakeEvent.SetEvent(); m_mutex.Unlock(); return ER_OK; } void IpNameServiceImpl::ClearLiveInterfaces(void) { QCC_DbgPrintf(("IpNameServiceImpl::ClearLiveInterfaces()")); // // ClearLiveInterfaces is not called with the mutex taken so we need to // grab it. // m_mutex.Lock(); for (uint32_t i = 0; i < m_liveInterfaces.size(); ++i) { if (m_liveInterfaces[i].m_multicastMDNSsockFd != qcc::INVALID_SOCKET_FD || m_liveInterfaces[i].m_multicastsockFd != qcc::INVALID_SOCKET_FD) { QCC_DbgPrintf(("IpNameServiceImpl::ClearLiveInterfaces(): clear interface %d", i)); // // If the multicast bit is set, we have done an IGMP join. In this // case, we must arrange an IGMP drop via the appropriate socket option // (via the qcc absraction layer). Android doesn't bother to compile its // kernel with CONFIG_IP_MULTICAST set. This doesn't mean that there is // no multicast code in the Android kernel, it means there is no IGMP // code in the kernel. What this means to us is that even through we // are doing an IP_DROP_MEMBERSHIP request, which is ultimately an IGMP // operation, the request will filter through the IP code before being // ignored and will do useful things in the kernel even though // CONFIG_IP_MULTICAST was not set for the Android build -- i.e., we // have to do it anyway. // if (m_liveInterfaces[i].m_flags & qcc::IfConfigEntry::MULTICAST || m_liveInterfaces[i].m_flags & qcc::IfConfigEntry::LOOPBACK) { if (m_liveInterfaces[i].m_address.IsIPv4()) { #if 1 if (m_liveInterfaces[i].m_multicastMDNSsockFd != qcc::INVALID_SOCKET_FD) { qcc::LeaveMulticastGroup(m_liveInterfaces[i].m_multicastMDNSsockFd, qcc::QCC_AF_INET, IPV4_MDNS_MULTICAST_GROUP, m_liveInterfaces[i].m_interfaceName); } if (m_liveInterfaces[i].m_multicastsockFd != qcc::INVALID_SOCKET_FD) { qcc::LeaveMulticastGroup(m_liveInterfaces[i].m_multicastsockFd, qcc::QCC_AF_INET, IPV4_ALLJOYN_MULTICAST_GROUP, m_liveInterfaces[i].m_interfaceName); } #endif } else if (m_liveInterfaces[i].m_address.IsIPv6()) { if (m_liveInterfaces[i].m_multicastMDNSsockFd != qcc::INVALID_SOCKET_FD) { qcc::LeaveMulticastGroup(m_liveInterfaces[i].m_multicastMDNSsockFd, qcc::QCC_AF_INET6, IPV6_MDNS_MULTICAST_GROUP, m_liveInterfaces[i].m_interfaceName); } if (m_liveInterfaces[i].m_multicastsockFd != qcc::INVALID_SOCKET_FD) { qcc::LeaveMulticastGroup(m_liveInterfaces[i].m_multicastsockFd, qcc::QCC_AF_INET6, IPV6_ALLJOYN_MULTICAST_GROUP, m_liveInterfaces[i].m_interfaceName); } } } // // Always delete the event before closing the socket because the event // is monitoring the socket state and therefore has a reference to the // socket. One the socket is closed the FD can be reused and our event // can end up monitoring the wrong socket and interfere with the correct // operation of other unrelated event/socket pairs. // if (m_liveInterfaces[i].m_multicastMDNSsockFd != qcc::INVALID_SOCKET_FD) { delete m_liveInterfaces[i].m_multicastMDNSevent; m_liveInterfaces[i].m_multicastMDNSevent = NULL; qcc::Close(m_liveInterfaces[i].m_multicastMDNSsockFd); m_liveInterfaces[i].m_multicastMDNSsockFd = qcc::INVALID_SOCKET_FD; } if (m_liveInterfaces[i].m_multicastsockFd != qcc::INVALID_SOCKET_FD) { delete m_liveInterfaces[i].m_multicastevent; m_liveInterfaces[i].m_multicastevent = NULL; qcc::Close(m_liveInterfaces[i].m_multicastsockFd); m_liveInterfaces[i].m_multicastsockFd = qcc::INVALID_SOCKET_FD; } } } QCC_DbgPrintf(("IpNameServiceImpl::ClearLiveInterfaces(): Clear interfaces")); m_liveInterfaces.clear(); m_mutex.Unlock(); QCC_DbgPrintf(("IpNameServiceImpl::ClearLiveInterfaces(): Done")); } QStatus IpNameServiceImpl::CreateUnicastSocket() { if (m_ipv4UnicastSockFd == qcc::INVALID_SOCKET_FD) { QStatus status = qcc::Socket(qcc::QCC_AF_INET, qcc::QCC_SOCK_DGRAM, m_ipv4UnicastSockFd); if (status != ER_OK) { QCC_LogError(status, ("CreateUnicastSocket: qcc::Socket(%d) failed: %d - %s", qcc::QCC_AF_INET, qcc::GetLastError(), qcc::GetLastErrorString().c_str())); m_ipv4UnicastSockFd = qcc::INVALID_SOCKET_FD; return status; } status = qcc::SetRecvPktAncillaryData(m_ipv4UnicastSockFd, qcc::QCC_AF_INET, true); if (status != ER_OK) { QCC_LogError(status, ("CreateUnicastSocket: enable recv ancillary data" " failed for sockFd %d", m_ipv4UnicastSockFd)); qcc::Close(m_ipv4UnicastSockFd); m_ipv4UnicastSockFd = qcc::INVALID_SOCKET_FD; return status; } // // We must be able to reuse the address/port combination so other // AllJoyn daemon instances on the same host can listen in if desired. // This will set the SO_REUSEPORT socket option if available or fall // back onto SO_REUSEADDR if not. // status = qcc::SetReusePort(m_ipv4UnicastSockFd, true); if (status != ER_OK && status != ER_NOT_IMPLEMENTED) { QCC_LogError(status, ("CreateUnicastSocket(): SetReusePort() failed")); qcc::Close(m_ipv4UnicastSockFd); m_ipv4UnicastSockFd = qcc::INVALID_SOCKET_FD; return status; } // // We bind to an ephemeral port. // status = qcc::Bind(m_ipv4UnicastSockFd, qcc::IPAddress("0.0.0.0"), 0); if (status != ER_OK) { QCC_LogError(status, ("CreateUnicastSocket(): bind failed")); qcc::Close(m_ipv4UnicastSockFd); m_ipv4UnicastSockFd = qcc::INVALID_SOCKET_FD; return status; } } return ER_OK; } QStatus CreateMulticastSocket(IfConfigEntry entry, const char* ipv4_multicast_group, const char* ipv6_multicast_group, uint16_t port, bool broadcast, SocketFd& sockFd) { QStatus status = qcc::Socket(entry.m_family, qcc::QCC_SOCK_DGRAM, sockFd); if (status != ER_OK) { QCC_LogError(status, ("CreateMulticastSocket: qcc::Socket(%d) failed: %d - %s", entry.m_family, qcc::GetLastError(), qcc::GetLastErrorString().c_str())); return status; } status = qcc::SetRecvPktAncillaryData(sockFd, entry.m_family, true); if (status != ER_OK) { QCC_LogError(status, ("CreateMulticastSocket: enable recv ancillary data" " failed for sockFd %d", sockFd)); qcc::Close(sockFd); return status; } if (entry.m_family == qcc::QCC_AF_INET6) { status = qcc::SetRecvIPv6Only(sockFd, true); if (status != ER_OK) { QCC_LogError(status, ("CreateMulticastSocket: enable recv IPv6 only" " failed for sockFd %d", sockFd)); qcc::Close(sockFd); return status; } } if (broadcast && entry.m_flags & qcc::IfConfigEntry::BROADCAST) { // // If we're going to send broadcasts, we have to ask for // permission for the multicast NS socket FD. // status = qcc::SetBroadcast(sockFd, true); if (status != ER_OK && status != ER_NOT_IMPLEMENTED) { QCC_LogError(status, ("CreateMulticastSocket: enable broadcast failed")); qcc::Close(sockFd); return status; } } // // We must be able to reuse the address/port combination so other // AllJoyn daemon instances on the same host can listen in if desired. // This will set the SO_REUSEPORT socket option if available or fall // back onto SO_REUSEADDR if not. // status = qcc::SetReusePort(sockFd, true); if (status != ER_OK && status != ER_NOT_IMPLEMENTED) { QCC_LogError(status, ("CreateMulticastSocket(): SetReusePort() failed")); qcc::Close(sockFd); return status; } // // If the MULTICAST or LOOPBACK flag is set, we are going to try and // multicast out over the interface in question. If one of the flags is // not set, then we want to fall back to IPv4 subnet directed broadcast, // so we optionally do all of the multicast games and take the interface // live even if it doesn't support multicast. // if (entry.m_flags & qcc::IfConfigEntry::MULTICAST || entry.m_flags & qcc::IfConfigEntry::LOOPBACK) { // // Restrict the scope of the sent muticast packets to the local subnet. // status = qcc::SetMulticastHops(sockFd, entry.m_family, 1); if (status != ER_OK && status != ER_NOT_IMPLEMENTED) { QCC_LogError(status, ("CreateMulticastSocket(): SetMulticastHops() failed")); qcc::Close(sockFd); return status; } // // In order to control which interfaces get our multicast datagrams, it // is necessary to do so via a socket option. See the Long Sidebar above. // Yes, you have to do it differently depending on whether or not you're // using IPv4 or IPv6. // status = qcc::SetMulticastInterface(sockFd, entry.m_family, entry.m_name); if (status != ER_OK && status != ER_NOT_IMPLEMENTED) { QCC_LogError(status, ("CreateMulticastSocket(): SetMulticastInterface() failed")); qcc::Close(sockFd); return status; } } if (entry.m_family == qcc::QCC_AF_INET) { status = qcc::Bind(sockFd, qcc::IPAddress("0.0.0.0"), port); if (status != ER_OK) { QCC_LogError(status, ("CreateMulticastSocket(): bind(0.0.0.0) failed")); qcc::Close(sockFd); return status; } } else if (entry.m_family == qcc::QCC_AF_INET6) { status = qcc::Bind(sockFd, qcc::IPAddress("::"), port); if (status != ER_OK) { QCC_LogError(status, ("CreateMulticastSocket(): bind(::) failed")); qcc::Close(sockFd); return status; } } // // The IGMP join must be done after the bind for Windows XP. Other // OSes are fine with it, but XP balks. // if (entry.m_flags & qcc::IfConfigEntry::MULTICAST || entry.m_flags & qcc::IfConfigEntry::LOOPBACK) { // // Arrange an IGMP join via the appropriate socket option (via the // qcc abstraction layer). Android doesn't bother to compile its // kernel with CONFIG_IP_MULTICAST set. This doesn't mean that // there is no multicast code in the Android kernel, it means there // is no IGMP code in the kernel. What this means to us is that // even through we are doing an IP_ADD_MEMBERSHIP request, which is // ultimately an IGMP operation, the request will filter through the // IP code before being ignored and will do useful things in the // kernel even though CONFIG_IP_MULTICAST was not set for the // Android build -- i.e., we have to do it anyway. // if (entry.m_family == qcc::QCC_AF_INET) { #if 1 status = qcc::JoinMulticastGroup(sockFd, qcc::QCC_AF_INET, ipv4_multicast_group, entry.m_name); #endif } else if (entry.m_family == qcc::QCC_AF_INET6) { status = qcc::JoinMulticastGroup(sockFd, qcc::QCC_AF_INET6, ipv6_multicast_group, entry.m_name); } if (status != ER_OK) { QCC_LogError(status, ("CreateMulticastSocket(): JoinMulticastGroup failed")); qcc::Close(sockFd); return status; } } return ER_OK; } // // N.B. This function must be called with m_mutex locked since we wander through // the list of requested interfaces that can also be modified by the user in the // context of her thread(s). // void IpNameServiceImpl::LazyUpdateInterfaces(const qcc::NetworkEventSet& networkEvents) { QCC_DbgPrintf(("IpNameServiceImpl::LazyUpdateInterfaces()")); // // However desirable it may be, the decision to simply use an existing // open socket exposes us to system-dependent behavior. For example, // In Linux and Windows, an IGMP join must be done on an interface that // is currently IFF_UP and IFF_MULTICAST with an assigned IP address. // On Linux, that join remains in effect (net devices will continue to // recieve multicast packets destined for our group) even if the net // device goes down and comes back up with a different IP address. On // Windows, however, if the interface goes down, an IGMP drop is done // and multicast receives will stop. Since the socket never returns // any status unless we actually send data, it is very possible that // the state of the system can change out from underneath us without // our knowledge, and we would simply stop receiving multicasts. This // behavior is not specified anywhere that I am aware of, so Windows // cannot really be said to be broken. It is just different, like it // is in so many other ways. In Android, IGMP isn't even compiled into // the kernel, and so an out-of-band mechanism is used (wpa_supplicant // private driver commands called by the Java multicast lock). // // It can be argued that since we are using Android phones (sort-of Linux) // when mobility is a concern, and Windows boxes would be relatively static, // we could get away with ignoring the possibility of missing interface // state changes. Since we are really talking an average of a couple of // IGMP packets every 30 seconds we take the conservative approach and tear // down all of our sockets and restart them every time through. // ClearLiveInterfaces(); // // If m_enable is false, we need to make sure that no packets are sent // and no sockets are listening for connections. This is for Android // Compatibility Test Suite (CTS) conformance. The only way we can talk // to the outside world is via one of the live interfaces, so if we don't // make any new ones, this will accomplish the requirement. // bool processAnyTransport = false; for (uint32_t i = 0; i < N_TRANSPORTS; ++i) { if (m_processTransport[i] || m_doNetworkCallback[i]) { processAnyTransport = true; break; } } if (m_enabled == false && processAnyTransport == false) { QCC_DbgPrintf(("IpNameServiceImpl::LazyUpdateInterfaces(): Communication with the outside world is forbidden")); if (m_unicastEvent) { delete m_unicastEvent; m_unicastEvent = NULL; } if (m_ipv4UnicastSockFd != qcc::INVALID_SOCKET_FD) { qcc::Close(m_ipv4UnicastSockFd); m_ipv4UnicastSockFd = qcc::INVALID_SOCKET_FD; } return; } if (m_isProcSuspending) { QCC_DbgPrintf(("IpNameServiceImpl::LazyUpdateInterfaces(): The process is suspending. Stop communicating with the outside world")); if (m_unicastEvent) { delete m_unicastEvent; m_unicastEvent = NULL; } if (m_ipv4UnicastSockFd != qcc::INVALID_SOCKET_FD) { qcc::Close(m_ipv4UnicastSockFd); m_ipv4UnicastSockFd = qcc::INVALID_SOCKET_FD; } return; } // // Call IfConfig to get the list of interfaces currently configured in the // system. This also pulls out interface flags, addresses and MTU. If we // can't get the system interfaces, we give up for now and hope the error // is transient. // QCC_DbgPrintf(("IpNameServiceImpl::LazyUpdateInterfaces(): IfConfig()")); std::vector entries; QStatus status = qcc::IfConfig(entries); if (status != ER_OK) { QCC_LogError(status, ("LazyUpdateInterfaces: IfConfig() failed")); if (m_unicastEvent) { delete m_unicastEvent; m_unicastEvent = NULL; } if (m_ipv4UnicastSockFd != qcc::INVALID_SOCKET_FD) { qcc::Close(m_ipv4UnicastSockFd); m_ipv4UnicastSockFd = qcc::INVALID_SOCKET_FD; } return; } // add the virtual network interfaces if any if (m_virtualInterfaces.size() > 0) { entries.insert(entries.end(), m_virtualInterfaces.begin(), m_virtualInterfaces.end()); } // // There are two fundamental ways we can look for interfaces to use. We // can either walk the list of IfConfig entries (real interfaces on the // system) looking for any that match our list of user-requested // interfaces; or we can walk the list of user-requested interfaces looking // for any that match the list of real IfConfig entries. Since we have an // m_any mode that means match all real IfConfig entries, we need to walk // the real IfConfig entries. // for (uint32_t i = 0; (m_state == IMPL_RUNNING || m_terminal) && (i < entries.size()); ++i) { // // We expect that every device in the system must have a name. // It might be some crazy random GUID in Windows, but it will have // a name. // assert(entries[i].m_name.size()); QCC_DbgPrintf(("IpNameServiceImpl::LazyUpdateInterfaces(): Checking out interface %s", entries[i].m_name.c_str())); // // We are never interested in interfaces that are not UP. // if ((entries[i].m_flags & qcc::IfConfigEntry::UP) == 0) { QCC_DbgPrintf(("IpNameServiceImpl::LazyUpdateInterfaces(): not UP")); continue; } #if defined(QCC_OS_LINUX) if ((entries[i].m_flags & qcc::IfConfigEntry::RUNNING) == 0) { QCC_DbgPrintf(("IpNameServiceImpl::LazyUpdateInterfaces(): not RUNNING")); continue; } #endif // // LOOPBACK interfaces are a special case: sending messages to // the local host is handled by the MULTICAST_LOOP socket // option which is enabled by default. However we must stil // use the loopback interface in the case there are no other // interfaces UP. Furthermore, multicast LOOPBACK over IPv6 // doesn't appear to work consistently, so we are only // interested in IPv4 multicast interfaces. // if ((entries[i].m_flags & qcc::IfConfigEntry::LOOPBACK) != 0 && (entries[i].m_family != qcc::QCC_AF_INET)) { QCC_DbgPrintf(("IpNameServiceImpl::LazyUpdateInterfaces(): ignoring non-IPv4 loopback")); continue; } // // When initializing the name service, the user can decide whether or // not she wants to advertise and listen over IPv4 or IPv6. We need // to check for that configuration here. Since the rest of the code // just works with the live interfaces irrespective of address family, // this is the only place we need to do this check. // if ((m_enableIPv4 == false && entries[i].m_family == qcc::QCC_AF_INET) || (m_enableIPv6 == false && entries[i].m_family == qcc::QCC_AF_INET6)) { QCC_DbgPrintf(("IpNameServiceImpl::LazyUpdateInterfaces(): family %d not enabled", entries[i].m_family)); continue; } // // The current real interface entry is a candidate for use. We need to // decide if we are actually going to use it either based on the // wildcard mode or the list of requestedInterfaces provided by each of // the transports. // bool useEntry = false; for (uint32_t j = 0; j < N_TRANSPORTS; ++j) { QCC_DbgPrintf(("IpNameServiceImpl::LazyUpdateInterfaces(): Check out interface cantidates for transport %d", j)); if (m_any[j]) { QCC_DbgPrintf(("IpNameServiceImpl::LazyUpdateInterfaces(): Wildcard set mode for transport %d", j)); // // All interfaces means all except for "special use" interfaces // like Wi-Fi Direct interfaces on Android. We don't know what // interfaces are actually in use by the Wi-Fi Direct subsystem // but it does seem that any P2P-based interface will begin with // the string "p2p" as in "p2p0" or "p2p-p2p0-0". // // Note that this assumes that the Wi-Fi Direct transport will // never try to open an interface with a wild-card. // #if defined(QCC_OS_ANDROID) if (entries[i].m_name.find("p2p") == qcc::String::npos) { QCC_DbgPrintf(("IpNameServiceImpl::LazyUpdateInterfaces(): Use entry \"%s\" since not a P2P interface", entries[i].m_name.c_str())); useEntry = true; } #else // // There is no such thing as a "special use" interface on any of // our other platforms, so we always use them. // QCC_DbgPrintf(("IpNameServiceImpl::LazyUpdateInterfaces(): Use entry \"%s\" since P2P not supported", entries[i].m_name.c_str())); useEntry = true; #endif } else { m_mutex.Lock(); QCC_DbgPrintf(("IpNameServiceImpl::LazyUpdateInterfaces(): m_any not set, look for explicitly requested interfaces for transport %d (%d currently requested)", j, m_requestedInterfaces[j].size())); for (uint32_t k = 0; k < m_requestedInterfaces[j].size(); ++k) { QCC_DbgPrintf(("IpNameServiceImpl::LazyUpdateInterfaces(): Check out requested interfaces \"%s\"", m_requestedInterfaces[j][k].m_interfaceName.c_str())); // // If the current real interface name matches the name in the // requestedInterface list, we will try to use it. // if (m_requestedInterfaces[j][k].m_interfaceName.size() != 0 && m_requestedInterfaces[j][k].m_interfaceName == entries[i].m_name) { QCC_DbgPrintf(("IpNameServiceImpl::LazyUpdateInterfaces(): Use because found requestedInterface name " " \"%s\" for transport %d", entries[i].m_name.c_str(), j)); useEntry = true; break; } // // If the current real interface IP Address matches the name in // the requestedInterface list, we will try to use it. // if (m_requestedInterfaces[j][k].m_interfaceName.size() == 0 && m_requestedInterfaces[j][k].m_interfaceAddr == qcc::IPAddress(entries[i].m_addr)) { QCC_DbgPrintf(("IpNameServiceImpl::LazyUpdateInterfaces(): Use because found requestedInterface address " "\"%s\" for transport %d.", entries[i].m_addr.c_str(), i)); useEntry = true; break; } } m_mutex.Unlock(); } } // // If we aren't configured to use this entry, or have no idea how to use // this entry (not AF_INET or AF_INET6), try the next one. // if (useEntry == false || (entries[i].m_family != qcc::QCC_AF_INET && entries[i].m_family != qcc::QCC_AF_INET6)) { QCC_DbgPrintf(("IpNameServiceImpl::LazyUpdateInterfaces(): Won't use this IfConfig entry")); continue; } // // If we fall through to here, we have decided that the host configured // entries[i] interface describes an interface we want to use to send // and receive our name service messages over. We keep a list of "live" // interfaces that reflect the interfaces we've previously made the // decision to use, so we'll set up a socket and move it there. We have // to be careful about what kind of socket we are going to use for each // entry (IPv4 or IPv6) and whether or not multicast is actually supported // on the interface. // // This next condition may be a bit confusing, so we break it out a bit // for clarity. We can posibly use an interface if it supports either // loopback, multicast, or broadcast. What we want to do is to detect // the condition when we cannot use it, so we invert the logic. That // means !multicast && !broadcast && !loopback. Not being able to // support broadcast is also true if we don't want to (i.e., m_broadcast // is false). This expression then looks like !loopback && !multicast && // (!broadcast || !m_broadcast). broadcast really implies AF_INET since // there is no broadcast in IPv6 but we double-check this condition and // come up with: // // !loopback && !multicast && (!broadcast || !m_broadcast || !AF_INET). // // To avoid a horribly complicated if statement, we make it look like // the above explanation. The resulting debug print is intimidating, // but it says exactly the right thing for those in the know. // bool loopback = (entries[i].m_flags & qcc::IfConfigEntry::LOOPBACK) != 0; bool multicast = (entries[i].m_flags & qcc::IfConfigEntry::MULTICAST) != 0; bool broadcast = (entries[i].m_flags & qcc::IfConfigEntry::BROADCAST) != 0; bool af_inet = entries[i].m_family == qcc::QCC_AF_INET; if (!loopback && !multicast && (!broadcast || !m_broadcast || !af_inet)) { QCC_DbgPrintf(("LazyUpdateInterfaces: !loopback && !multicast && (!broadcast || !m_broadcast || !af_inet). Ignoring")); continue; } // // We've decided the interface in question is interesting and we want to // use it to send and receive name service messages. Now we need to // start the long process of convincing the network to do what we want. // This is going to mostly be done by setting a series of socket // options. The small number of the ones we need are absracted in the // qcc package. // We set up 3 sockets - one to listen for Multicast NS packets, one for MDNS packets // and 1 for unicast MDNS packets. // qcc::SocketFd multicastMDNSsockFd = qcc::INVALID_SOCKET_FD; qcc::SocketFd multicastsockFd = qcc::INVALID_SOCKET_FD; if (entries[i].m_family != qcc::QCC_AF_INET && entries[i].m_family != qcc::QCC_AF_INET6) { assert(!"IpNameServiceImpl::LazyUpdateInterfaces(): Unexpected value in m_family (not AF_INET or AF_INET6"); continue; } status = CreateMulticastSocket(entries[i], IPV4_MDNS_MULTICAST_GROUP, IPV6_MDNS_MULTICAST_GROUP, MULTICAST_MDNS_PORT, m_broadcast, multicastMDNSsockFd); if (status != ER_OK) { QCC_DbgPrintf(("Failed to create multicast socket for MDNS packets.")); continue; } status = CreateMulticastSocket(entries[i], IPV4_ALLJOYN_MULTICAST_GROUP, IPV6_ALLJOYN_MULTICAST_GROUP, MULTICAST_PORT, m_broadcast, multicastsockFd); if (status != ER_OK) { QCC_DbgPrintf(("Failed to create multicast socket for NS packets.")); qcc::Close(multicastMDNSsockFd); continue; } // // Now take the interface "live." // LiveInterface live; live.m_interfaceName = entries[i].m_name; live.m_interfaceAddr = entries[i].m_addr; live.m_prefixlen = entries[i].m_prefixlen; live.m_address = qcc::IPAddress(entries[i].m_addr); live.m_flags = entries[i].m_flags; live.m_mtu = entries[i].m_mtu; live.m_index = entries[i].m_index; live.m_multicastsockFd = multicastsockFd; live.m_multicastMDNSsockFd = multicastMDNSsockFd; live.m_multicastPort = MULTICAST_PORT; live.m_multicastMDNSPort = MULTICAST_MDNS_PORT; live.m_unicastPort = 0; live.m_messageSent = false; if (multicastsockFd != qcc::INVALID_SOCKET_FD) { live.m_multicastevent = new qcc::Event(multicastsockFd, qcc::Event::IO_READ); } else { live.m_multicastevent = NULL; } if (multicastMDNSsockFd != qcc::INVALID_SOCKET_FD) { live.m_multicastMDNSevent = new qcc::Event(multicastMDNSsockFd, qcc::Event::IO_READ); } else { live.m_multicastMDNSevent = NULL; } QCC_DbgPrintf(("Pushing back interface %s addr %s", live.m_interfaceName.c_str(), entries[i].m_addr.c_str())); // // Lazy update is called with the mutex taken, so this is safe here. // m_liveInterfaces.push_back(live); } if (m_liveInterfaces.size() > 0) { if (m_ipv4UnicastSockFd == qcc::INVALID_SOCKET_FD) { CreateUnicastSocket(); m_unicastEvent = new qcc::Event(m_ipv4UnicastSockFd, qcc::Event::IO_READ); } IPAddress listenAddr; uint16_t listenPort = 0; if (m_ipv4UnicastSockFd != qcc::INVALID_SOCKET_FD) { qcc::GetLocalAddress(m_ipv4UnicastSockFd, listenAddr, listenPort); } for (uint32_t i = 0; (m_state == IMPL_RUNNING || m_terminal) && (i < m_liveInterfaces.size()); ++i) { m_liveInterfaces[i].m_unicastPort = listenPort; } } else { if (m_unicastEvent) { delete m_unicastEvent; m_unicastEvent = NULL; } if (m_ipv4UnicastSockFd != qcc::INVALID_SOCKET_FD) { qcc::Close(m_ipv4UnicastSockFd); m_ipv4UnicastSockFd = qcc::INVALID_SOCKET_FD; } } // Schedule the processing of the transports' // network event callbacks on the network event // packet scheduler thread. processAnyTransport = false; for (uint32_t i = 0; i < N_TRANSPORTS; ++i) { if (m_processTransport[i]) { m_doNetworkCallback[i] = true; m_processTransport[i] = false; processAnyTransport = true; } } if (processAnyTransport) { m_packetScheduler.Alert(); } if (m_refreshAdvertisements) { QCC_DbgHLPrintf(("Now refreshing advertisements on interface event")); m_timer = m_tRetransmit + 1; m_networkChangeScheduleCount = 0; std::map ifMap; for (std::set::const_iterator it = networkEvents.begin(); it != networkEvents.end(); it++) { m_networkEvents.insert(*it); } m_packetScheduler.Alert(); m_refreshAdvertisements = false; } } QStatus IpNameServiceImpl::Enable(TransportMask transportMask, const std::map& reliableIPv4PortMap, uint16_t reliableIPv6Port, const std::map& unreliableIPv4PortMap, uint16_t unreliableIPv6Port, bool enableReliableIPv4, bool enableReliableIPv6, bool enableUnreliableIPv4, bool enableUnreliableIPv6) { QCC_UNUSED(unreliableIPv6Port); QCC_DbgHLPrintf(("IpNameServiceImpl::Enable(0x%x, %d., %d., %d., %d., %d, %d, %d, %d )", transportMask, reliableIPv4PortMap.size(), reliableIPv6Port, unreliableIPv4PortMap.size(), unreliableIPv6Port, enableReliableIPv4, enableReliableIPv6, enableUnreliableIPv4, enableUnreliableIPv6)); // // Exactly one bit must be set in a transport mask in order to identify the // one transport (in the AllJoyn sense) that is making the request. // if (CountOnes(transportMask) != 1) { QCC_LogError(ER_BAD_TRANSPORT_MASK, ("IpNameServiceImpl::Enable(): Bad transport mask")); return ER_BAD_TRANSPORT_MASK; } uint32_t i = IndexFromBit(transportMask); assert(i < 16 && "IpNameServiceImpl::Enable(): Bad callback index"); if (i >= 16) { return ER_BAD_TRANSPORT_MASK; } // // This is a bit non-intuitive. We have to disable the name service (stop // listening on the sockets for the multicast groups) to pass the Android // Compatibility Test. We have to make sure that if we are disabling the // name service by removing its last advertisement, we leave ourselves up // for long enough to get the last cancel advertised name out. // // We synchronize with the main run thread which will do that work by // requesting it to enable or disable, and it figures out the right thing // to do with respect to the advertised names. // // We keep track of what is going on with two variables: // // tells us if there was an enabled port somewhere // before we started. // // tells us if this operation is to enable or disable some // port. // m_mutex.Lock(); bool somethingWasEnabled = false; for (uint32_t j = 0; j < N_TRANSPORTS; ++j) { if (m_enabledReliableIPv4[j] || m_enabledUnreliableIPv4[j] || m_enabledReliableIPv6[j] || m_enabledUnreliableIPv6[j]) { somethingWasEnabled = true; } } bool enabling = enableReliableIPv4 || enableUnreliableIPv4 || enableReliableIPv6 || enableUnreliableIPv6; // // If enabling is true, then we need to cancel any pending disables since // the name service needs to be alive and we absolutely don't want to do a // pending shutdown sequence if it is queued. // if (enabling) { m_doDisable = false; // // If we weren't already enabled, then we certainly want to be so // since we know we're going to add a port listener in a moment. // if (somethingWasEnabled == false) { m_doEnable = true; } } // Keep a backup copy of the state so we can correctly // send out cancel advertisements. By the time cancel // advertise packets are scheduled for transmission and // the packets are rewritten, the relevant transport may // no longer be enabled. m_priorReliableIPv4PortMap[i] = m_reliableIPv4PortMap[i]; m_priorUnreliableIPv4PortMap[i] = m_unreliableIPv4PortMap[i]; std::map::const_iterator it = reliableIPv4PortMap.find("*"); if (it != reliableIPv4PortMap.end()) { if (enableReliableIPv4) { m_reliableIPv4PortMap[i].clear(); m_reliableIPv4PortMap[i]["*"] = it->second; } else { m_reliableIPv4PortMap[i].clear(); } } else { for (it = reliableIPv4PortMap.begin(); it != reliableIPv4PortMap.end(); it++) { if (enableReliableIPv4) { m_reliableIPv4PortMap[i][it->first] = it->second; } else { m_reliableIPv4PortMap[i].erase(it->first); } } } it = unreliableIPv4PortMap.find("*"); if (it != unreliableIPv4PortMap.end()) { if (enableUnreliableIPv4) { m_unreliableIPv4PortMap[i].clear(); m_unreliableIPv4PortMap[i]["*"] = it->second; } else { m_unreliableIPv4PortMap[i].clear(); } } else { for (it = unreliableIPv4PortMap.begin(); it != unreliableIPv4PortMap.end(); it++) { if (enableUnreliableIPv4) { m_unreliableIPv4PortMap[i][it->first] = it->second; } else { m_unreliableIPv4PortMap[i].erase(it->first); } } } m_reliableIPv6Port[i] = reliableIPv6Port; m_unreliableIPv6Port[i] = reliableIPv6Port; m_enabledReliableIPv4[i] = !m_reliableIPv4PortMap[i].empty(); m_enabledUnreliableIPv4[i] = !m_unreliableIPv4PortMap[i].empty(); m_enabledReliableIPv6[i] = enableReliableIPv6; m_enabledUnreliableIPv6[i] = enableUnreliableIPv6; // // We might be wanting to disable the name service depending on whether we // end up disabling the last of the enabled ports. // bool somethingIsEnabled = false; for (uint32_t j = 0; j < N_TRANSPORTS; ++j) { if (m_enabledReliableIPv4[j] || m_enabledUnreliableIPv4[j] || m_enabledReliableIPv6[j] || m_enabledUnreliableIPv6[j]) { somethingIsEnabled = true; } } // // If the end result of doing the operation above ends up that there are no // longer any enabled ports, the name service definitely needs to end up // disabled. Therefore we need to cancel any any pending enable requests. // if (somethingIsEnabled == false) { m_doEnable = false; // // If we weren't already disabled, and we are then we certainly want to be so // since we know we just deleted the going to add a port listener in a moment. // if (somethingWasEnabled == true) { m_doDisable = true; } } m_mutex.Unlock(); m_forceLazyUpdate = true; m_wakeEvent.SetEvent(); return ER_OK; } uint16_t IpNameServiceImpl::ComputePriority(uint32_t staticScore, uint32_t dynamicScore) { uint32_t combinedScore = staticScore + dynamicScore; if (combinedScore > std::numeric_limits::max()) { combinedScore = std::numeric_limits::max(); } uint32_t priority = std::numeric_limits::max() - combinedScore; // Oldver versions of the name service without the router ranking // feature use the priority value 1 and this needs to be excluded. if (priority == 1) { priority = 2; } return priority; } uint32_t IpNameServiceImpl::LoadParam(const ConfigDB* config, const qcc::String param) { if (param == "router_power_source") { String powerSource = ToLowerCase(config->GetProperty("router_power_source", ALLJOYN_DEFAULT_ROUTER_POWER_SOURCE)); if (powerSource == "always ac powered") { return 2700; } else if (powerSource == "battery powered and chargeable") { return 1800; } else if (powerSource == "battery powered and not chargeable") { return 900; } else { QCC_LogError(ER_WARNING, ("Ignoring invalid config value:%s for router power source, using default value instead", powerSource.c_str())); return 1800; } } else if (param == "router_mobility") { String mobility = ToLowerCase(config->GetProperty("router_mobility", ALLJOYN_DEFAULT_ROUTER_MOBILITY)); if (mobility == "always stationary") { return 8100; } else if (mobility == "low mobility") { return 6075; } else if (mobility == "intermediate mobility") { return 4050; } else if (mobility == "high mobility") { return 2025; } else { QCC_LogError(ER_WARNING, ("Ignoring invalid config value:%s for router mobility, using default value instead", mobility.c_str())); return 4050; } } else if (param == "router_availability") { String availability = ToLowerCase(config->GetProperty("router_availability", ALLJOYN_DEFAULT_ROUTER_AVAILABILITY)); if (availability == "0-3 hr") { return 1012; } else if (availability == "3-6 hr") { return 2025; } else if (availability == "6-9 hr") { return 3037; } else if (availability == "9-12 hr") { return 4050; } else if (availability == "12-15 hr") { return 5062; } else if (availability == "15-18 hr") { return 6075; } else if (availability == "18-21 hr") { return 7087; } else if (availability == "21-24 hr") { return 8100; } else { QCC_LogError(ER_WARNING, ("Ignoring invalid config value:%s for router availability, using default value instead", availability.c_str())); return 2025; } } else if (param == "router_node_connection") { String nodeConnection = ToLowerCase(config->GetProperty("router_node_connection", ALLJOYN_DEFAULT_ROUTER_NODE_TYPE)); if (nodeConnection == "access point") { return 8100; } else if (nodeConnection == "wired") { return 8100; } else if (nodeConnection == "wireless") { return 4050; } else { QCC_LogError(ER_WARNING, ("Ignoring invalid config value:%s for router node connection, using default value instead", nodeConnection.c_str())); return 4050; } } else { QCC_LogError(ER_WARNING, ("Ignoring invalid config parameter")); return std::numeric_limits::max(); } } void IpNameServiceImpl::LoadStaticRouterParams(const ConfigDB* config) { m_powerSource = LoadParam(config, "router_power_source"); m_mobility = LoadParam(config, "router_mobility"); m_availability = LoadParam(config, "router_availability"); m_nodeConnection = LoadParam(config, "router_node_connection"); } uint32_t IpNameServiceImpl::ComputeStaticScore(uint32_t powerSource, uint32_t mobility, uint32_t availability, uint32_t nodeConnection) { assert(powerSource >= ROUTER_POWER_SOURCE_MIN && powerSource <= ROUTER_POWER_SOURCE_MAX); assert(mobility >= ROUTER_MOBILITY_MIN && mobility <= ROUTER_MOBILITY_MAX); assert(availability >= ROUTER_AVAILABILITY_MIN && availability <= ROUTER_AVAILABILITY_MAX); assert(nodeConnection >= ROUTER_NODE_CONNECTION_MIN && nodeConnection <= ROUTER_NODE_CONNECTION_MAX); return (powerSource + mobility + availability + nodeConnection); } uint32_t IpNameServiceImpl::ComputeDynamicScore(uint32_t availableTcpConnections, uint32_t maximumTcpConnections, uint32_t availableUdpConnections, uint32_t maximumUdpConnections, uint32_t availableTcpRemoteClients, uint32_t maximumTcpRemoteClients) { assert(availableTcpConnections <= maximumTcpConnections); assert(availableUdpConnections <= maximumUdpConnections); assert(availableTcpRemoteClients <= maximumTcpRemoteClients); uint32_t tcpScore = 0; uint32_t udpScore = 0; uint32_t tclScore = 0; uint8_t transports = 0; /* * The dynamic score should be zero whenever the tclScore is zero irrespective of advertisements. * The tcpScore and the udpScore are only relevant to the computation of the dynamic score if * the tclScore is non-zero. */ if (maximumTcpRemoteClients) { tclScore = ((DYNAMIC_RANK_RANGE * availableTcpRemoteClients) / (TCL_NORMALIZED_CONNECTIONS)) + ((DYNAMIC_RANK_RANGE * availableTcpRemoteClients) / (maximumTcpRemoteClients)); if (tclScore) { transports++; if (maximumTcpConnections) { tcpScore = ((DYNAMIC_RANK_RANGE * availableTcpConnections) / (TCP_NORMALIZED_CONNECTIONS)) + ((DYNAMIC_RANK_RANGE * availableTcpConnections) / (maximumTcpConnections)); transports++; } if (maximumUdpConnections) { udpScore = ((DYNAMIC_RANK_RANGE * availableUdpConnections) / (UDP_NORMALIZED_CONNECTIONS)) + ((DYNAMIC_RANK_RANGE * availableUdpConnections) / (maximumUdpConnections)); transports++; } } } if (transports == 2) { return ((tcpScore + udpScore + tclScore) / (4u)); } else if (transports == 3) { return ((tcpScore + udpScore + tclScore) / (6u)); } return 0; } uint16_t IpNameServiceImpl::GetCurrentPriority() { return m_priority; } QStatus IpNameServiceImpl::UpdateDynamicScore(TransportMask transportMask, uint32_t availableTransportConnections, uint32_t maximumTransportConnections, uint32_t availableTransportRemoteClients, uint32_t maximumTransportRemoteClients) { uint32_t i = IndexFromBit(transportMask); assert(i < 16 && "IpNameServiceImpl::UpdateDynamicScore(): Bad index"); m_dynamicParams[i].availableTransportConnections = availableTransportConnections; m_dynamicParams[i].maximumTransportConnections = maximumTransportConnections; m_dynamicParams[i].availableTransportRemoteClients = availableTransportRemoteClients; m_dynamicParams[i].maximumTransportRemoteClients = maximumTransportRemoteClients; m_dynamicScore = ComputeDynamicScore(m_dynamicParams[TRANSPORT_INDEX_TCP].availableTransportConnections, m_dynamicParams[TRANSPORT_INDEX_TCP].maximumTransportConnections, m_dynamicParams[TRANSPORT_INDEX_UDP].availableTransportConnections, m_dynamicParams[TRANSPORT_INDEX_UDP].maximumTransportConnections, m_dynamicParams[TRANSPORT_INDEX_TCP].availableTransportRemoteClients, m_dynamicParams[TRANSPORT_INDEX_TCP].maximumTransportRemoteClients); m_priority = ComputePriority(m_staticScore, m_dynamicScore); return ER_OK; } qcc::String IpNameServiceImpl::ToLowerCase(const qcc::String& str) { qcc::String s = str; for (unsigned i = 0; i < s.size(); ++i) { s[i] = tolower(s[i]); } return s; } QStatus IpNameServiceImpl::Enabled(TransportMask transportMask, std::map& reliableIPv4PortMap, uint16_t& reliableIPv6Port, std::map& unreliableIPv4PortMap, uint16_t& unreliableIPv6Port) { QCC_DbgPrintf(("IpNameServiceImpl::Enabled()")); // // Exactly one bit must be set in a transport mask in order to identify the // one transport (in the AllJoyn sense) that is making the request. // if (CountOnes(transportMask) != 1) { QCC_LogError(ER_BAD_TRANSPORT_MASK, ("IpNameServiceImpl::Enable(): Bad transport mask")); return ER_BAD_TRANSPORT_MASK; } uint32_t i = IndexFromBit(transportMask); assert(i < 16 && "IpNameServiceImpl::Enabled(): Bad callback index"); if (i >= 16) { return ER_BAD_TRANSPORT_MASK; } m_mutex.Lock(); reliableIPv4PortMap = m_reliableIPv4PortMap[i]; unreliableIPv4PortMap = m_unreliableIPv4PortMap[i]; reliableIPv6Port = m_reliableIPv6Port[i]; unreliableIPv6Port = m_unreliableIPv6Port[i]; m_mutex.Unlock(); return ER_OK; } void IpNameServiceImpl::TriggerTransmission(Packet packet) { BurstResponseHeader brh(packet); uint32_t nsVersion, msgVersion; packet->GetVersion(nsVersion, msgVersion); assert(m_enableV1 || (msgVersion != 0 && msgVersion != 1)); //Queue one instance of the packet, the rest will be taken care of by the PacketScheduler thread //QueueProtocolMessage limits the maximum number of outstanding packets to MAX_IPNS_MESSAGES. //Limiting m_burstQueue size could posssibly lead to stalls of up to 18 seconds (RETRY_INTERVALS). QueueProtocolMessage(packet); m_mutex.Lock(); Timespec now; GetTimeNow(&now); brh.nextScheduleTime = now + BURST_RESPONSE_INTERVAL; m_burstQueue.push_back(brh); m_packetScheduler.Alert(); m_mutex.Unlock(); } QStatus IpNameServiceImpl::FindAdvertisement(TransportMask transportMask, const qcc::String& matchingStr, LocatePolicy policy, TransportMask completeTransportMask) { QCC_UNUSED(policy); QCC_DbgHLPrintf(("IpNameServiceImpl::FindAdvertisement(0x%x, \"%s\", %d)", transportMask, matchingStr.c_str(), policy)); // // Exactly one bit must be set in a transport mask in order to identify the // one transport (in the AllJoyn sense) that is making the request. // if (CountOnes(transportMask) != 1) { QCC_LogError(ER_BAD_TRANSPORT_MASK, ("IpNameServiceImpl::FindAdvertisement(): Bad transport mask")); return ER_BAD_TRANSPORT_MASK; } uint32_t transportIndex = IndexFromBit(transportMask); if (transportIndex >= 16) { return ER_BAD_TRANSPORT_MASK; } MatchMap matching; ParseMatchRule(matchingStr, matching); // // Only version 2 supports more than just the name key. // uint8_t type = TRANSMIT_V2; MatchMap::iterator name = matching.find("name"); if (m_enableV1 && (matching.size() == 1) && (name != matching.end())) { type |= TRANSMIT_V0_V1; } // // Send a request to the network over our multicast channel, asking for // anyone who supports the specified well-known name. // // We are now at version one of the protocol. There is no significant // difference between version zero and version one messages, but down-version // (version zero) clients don't know that, so they will ignore version one // messages. This means that if we want to have clients running older daemons // be able to hear our discovery requests, we need to send both flavors of // message. Since the version is located in the message header, this means // two messages. // // Do it once for version two. // if (type & TRANSMIT_V2) { m_v2_queries[transportIndex].insert(matchingStr); uint32_t secondOfPairIndex = IndexFromBit(TRANSPORT_SECOND_OF_PAIR); bool isFirstOfPair = (transportMask == TRANSPORT_FIRST_OF_PAIR); bool isSecondOfPair = (transportMask == TRANSPORT_SECOND_OF_PAIR); bool isFirstOfPairRequested = ((completeTransportMask & TRANSPORT_FIRST_OF_PAIR) == TRANSPORT_FIRST_OF_PAIR); bool isSecondOfPairRequested = ((completeTransportMask & TRANSPORT_SECOND_OF_PAIR) == TRANSPORT_SECOND_OF_PAIR); // If this is the first of the pair, only send if second is not requested in the complete transport mask bool sendForFirstOfPair = (isFirstOfPair && !isSecondOfPairRequested); // If this is the second of the pair of transports, send if this transport is enabled or the first transport was requested. bool sendForSecondOfPair = (isSecondOfPair && (isFirstOfPairRequested || m_enabledUnreliableIPv4[secondOfPairIndex])); if (sendForFirstOfPair || sendForSecondOfPair) { MDNSPacket query; MDNSSearchRData* searchRData = new MDNSSearchRData(); for (MatchMap::iterator it = matching.begin(); it != matching.end(); ++it) { searchRData->SetValue(it->first, it->second); } MDNSResourceRecord searchRecord("search." + m_guid + ".local.", MDNSResourceRecord::TXT, MDNSResourceRecord::INTERNET, 120, searchRData); query->AddAdditionalRecord(searchRecord); Query(completeTransportMask, query); delete searchRData; } } // // Do it once for version zero. // if ((type & TRANSMIT_V0_V1) && (transportMask != TRANSPORT_UDP)) { m_v0_v1_queries[transportIndex].insert(name->second); WhoHas whoHas; // // We understand all messages from version zero to version one, but we // are sending a version zero message. The whole point of sending a // version zero message is that can be understood by down-level code // so we can't use the new versioning scheme. We have to use some // sneaky way to tell an in-the know version one client that the // packet is from a version one client and that is through the setting // of the UDP flag. // whoHas.SetVersion(0, 0); whoHas.SetTransportMask(transportMask); // // We have to use some sneaky way to tell an in-the know version one // client that the packet is from a version one client and that is // through the setting of the UDP flag. TCP transports are the only // possibility for version zero packets and it always sets the TCP // flag, of course. // whoHas.SetTcpFlag(true); whoHas.SetUdpFlag(true); whoHas.SetIPv4Flag(true); whoHas.AddName(name->second); NSPacket nspacket; nspacket->SetVersion(0, 0); nspacket->SetTimer(m_tDuration); nspacket->AddQuestion(whoHas); m_mutex.Lock(); // Search for the same name in the burstQueue. // If present, remove the entry to preserve the ordering of outgoing packets. std::list::iterator it = m_burstQueue.begin(); while (it != m_burstQueue.end()) { uint32_t nsVersion; uint32_t msgVersion; (*it).packet->GetVersion(nsVersion, msgVersion); if (nsVersion == 0 && msgVersion == 0) { NSPacket temp = NSPacket::cast((*it).packet); if (temp->GetQuestion(0).GetName(0) == name->second) { m_burstQueue.erase(it++); continue; } } it++; } m_mutex.Unlock(); TriggerTransmission(Packet::cast(nspacket)); } // // Do it again for version one. // if ((type & TRANSMIT_V0_V1) && (transportMask != TRANSPORT_UDP)) { WhoHas whoHas; // // We understand all messages from version zero to version one, and we // are sending a version one message. // whoHas.SetVersion(1, 1); whoHas.SetTransportMask(transportMask); whoHas.AddName(name->second); NSPacket nspacket; nspacket->SetVersion(1, 1); nspacket->SetTimer(m_tDuration); nspacket->AddQuestion(whoHas); m_mutex.Lock(); // Search for the same name in the burstQueue. // If present, remove the entry to preserve the ordering of outgoing packets. std::list::iterator it = m_burstQueue.begin(); while (it != m_burstQueue.end()) { uint32_t nsVersion; uint32_t msgVersion; (*it).packet->GetVersion(nsVersion, msgVersion); if (nsVersion == 1 && msgVersion == 1) { NSPacket temp = NSPacket::cast((*it).packet); if (temp->GetQuestion(0).GetName(0) == name->second) { m_burstQueue.erase(it++); continue; } } it++; } m_mutex.Unlock(); TriggerTransmission(Packet::cast(nspacket)); } return ER_OK; } QStatus IpNameServiceImpl::CancelFindAdvertisement(TransportMask transportMask, const qcc::String& matchingStr, LocatePolicy policy, TransportMask completeTransportMask) { QCC_UNUSED(policy); QCC_UNUSED(completeTransportMask); if (CountOnes(transportMask) != 1) { QCC_LogError(ER_BAD_TRANSPORT_MASK, ("IpNameServiceImpl::CancelFindAdvertisement(): Bad transport mask")); return ER_BAD_TRANSPORT_MASK; } uint32_t transportIndex = IndexFromBit(transportMask); if (transportIndex >= 16) { return ER_BAD_TRANSPORT_MASK; } MatchMap matching; ParseMatchRule(matchingStr, matching); // // Only version 2 supports more than just the name key. // bool nameOnly = false; MatchMap::iterator name = matching.find("name"); if ((matching.size() == 1) && (name != matching.end())) { nameOnly = true; } m_mutex.Lock(); if (m_enableV1 && nameOnly) { m_v0_v1_queries[transportIndex].erase(name->second); } m_v2_queries[transportIndex].erase(matchingStr); m_mutex.Unlock(); return ER_OK; } const uint32_t MIN_THRESHOLD_CACHE_REFRESH_MS = 1000; // Purge entries from PeerInfo map that havent recieved a response // for 3 Cache refresh cycles i.e. 3 * 120 seconds. const uint32_t PEER_INFO_MAP_PURGE_TIMEOUT = 3 * 120 * 1000; QStatus IpNameServiceImpl::RefreshCache(TransportMask transportMask, const qcc::String& guid, const qcc::String& matchingStr, LocatePolicy policy, bool ping) { QCC_UNUSED(policy); QCC_DbgHLPrintf(("IpNameServiceImpl::RefreshCache(0x%x, \"%s\", %d)", transportMask, matchingStr.c_str(), policy)); QCC_DbgPrintf(("IpNameServiceImpl::RefreshCache %s", matchingStr.c_str())); String longGuid; MatchMap matching; ParseMatchRule(matchingStr, matching); // // We first retrieve the destination for the guid from the PeerInfoMap and set the destination for the // MDNS packet that we will be sending out over unicast to this guid // m_mutex.Lock(); std::unordered_map, Hash, Equal>::iterator it = m_peerInfoMap.end(); if (!ping) { it = m_peerInfoMap.find(guid); longGuid = guid; } else { for (std::unordered_map, Hash, Equal>::iterator i = m_peerInfoMap.begin(); i != m_peerInfoMap.end(); ++i) { if (qcc::GUID128(i->first).ToShortString() == guid) { it = i; longGuid = it->first; break; } } } // the guid was not found in the m_peerInfoMap the name is unknown. if (it != m_peerInfoMap.end()) { std::set::iterator pit = it->second.begin(); PrintPeerInfoMap(); // The check here is because we could be in a session with a name and there could be no valid peer info for it // The name will be removed by layer above when we are no longer in a session with that name and it is no longer advertised if (!it->second.empty()) { Timespec now; GetTimeNow(&now); QCC_DbgPrintf(("Entry found in Peer Info Map. Setting unicast destination")); while (pit != it->second.end()) { PeerInfo peerInfo = *pit; if (!ping && ((now - (*pit).lastQueryTimeStamp) < MIN_THRESHOLD_CACHE_REFRESH_MS)) { ++pit; continue; } if (!ping) { // Purge entries from PeerInfo map that havent recieved a response for 3 Cache refresh cycles if ((now - (*pit).lastResponseTimeStamp) >= PEER_INFO_MAP_PURGE_TIMEOUT) { it->second.erase(pit++); continue; } (*pit).lastQueryTimeStamp = now; } MDNSPacket query; query->SetDestination((*pit).unicastInfo); MDNSSearchRData* searchRData = new MDNSSearchRData(); for (MatchMap::iterator it1 = matching.begin(); it1 != matching.end(); ++it1) { searchRData->SetValue(it1->first, it1->second); } if (ping) { MDNSPingRData* pingRData = new MDNSPingRData(); for (MatchMap::iterator it1 = matching.begin(); it1 != matching.end(); ++it1) { pingRData->SetValue("n", it1->second); } MDNSResourceRecord pingRecord("ping." + m_guid + ".local.", MDNSResourceRecord::TXT, MDNSResourceRecord::INTERNET, 120, pingRData); query->AddAdditionalRecord(pingRecord); delete pingRData; } MDNSResourceRecord searchRecord("search." + m_guid + ".local.", MDNSResourceRecord::TXT, MDNSResourceRecord::INTERNET, 120, searchRData); query->AddAdditionalRecord(searchRecord); delete searchRData; m_mutex.Unlock(); Query(transportMask, query); m_mutex.Lock(); it = m_peerInfoMap.find(longGuid); if (it == m_peerInfoMap.end()) { break; } pit = it->second.upper_bound(peerInfo); } } } else { if (ping) { m_mutex.Unlock(); return ER_ALLJOYN_PING_REPLY_INCOMPATIBLE_REMOTE_ROUTING_NODE; } QCC_DbgPrintf((" IpNameServiceImpl::RefreshCache(): Entry not found in PeerInfoMap")); } m_mutex.Unlock(); return ER_OK; } void IpNameServiceImpl::SetCriticalParameters( uint32_t tDuration, uint32_t tRetransmit, uint32_t tQuestion, uint32_t modulus, uint32_t retries) { m_tDuration = tDuration; m_tRetransmit = tRetransmit; m_tQuestion = tQuestion; m_modulus = modulus; m_retries = (retries < ArraySize(RETRY_INTERVALS)) ? retries : ArraySize(RETRY_INTERVALS); } QStatus IpNameServiceImpl::SetCallback(TransportMask transportMask, Callback&, uint32_t>* cb) { QCC_DbgPrintf(("IpNameServiceImpl::SetCallback()")); // // Exactly one bit must be set in a transport mask in order to identify the // one transport (in the AllJoyn sense) that is making the request. // if (CountOnes(transportMask) != 1) { QCC_LogError(ER_BAD_TRANSPORT_MASK, ("IpNameServiceImpl::SetCallback(): Bad transport mask")); return ER_BAD_TRANSPORT_MASK; } uint32_t i = IndexFromBit(transportMask); assert(i < 16 && "IpNameServiceImpl::SetCallback(): Bad callback index"); if (i >= 16) { return ER_BAD_TRANSPORT_MASK; } m_mutex.Lock(); // Wait till the callback is in use. while (m_protect_callback) { m_mutex.Unlock(); qcc::Sleep(2); m_mutex.Lock(); } Callback&, uint32_t>* goner = m_callback[i]; m_callback[i] = NULL; delete goner; m_callback[i] = cb; m_mutex.Unlock(); return ER_OK; } QStatus IpNameServiceImpl::SetNetworkEventCallback(TransportMask transportMask, Callback&>* cb) { QCC_DbgPrintf(("IpNameServiceImpl::SetNetworkEventCallback()")); // // Exactly one bit must be set in a transport mask in order to identify the // one transport (in the AllJoyn sense) that is making the request. // if (CountOnes(transportMask) != 1) { QCC_LogError(ER_BAD_TRANSPORT_MASK, ("IpNameServiceImpl::SetNetworkEventCallback(): Bad transport mask")); return ER_BAD_TRANSPORT_MASK; } uint32_t i = IndexFromBit(transportMask); assert(i < 16 && "IpNameServiceImpl::SetNetworkEventCallback(): Bad callback index"); if (i >= 16) { return ER_BAD_TRANSPORT_MASK; } m_mutex.Lock(); // Wait till the callback is in use. while (m_protect_net_callback) { m_mutex.Unlock(); qcc::Sleep(2); m_mutex.Lock(); } Callback&>* goner = m_networkEventCallback[i]; m_networkEventCallback[i] = NULL; delete goner; m_networkEventCallback[i] = cb; m_mutex.Unlock(); return ER_OK; } void IpNameServiceImpl::ClearCallbacks(void) { QCC_DbgPrintf(("IpNameServiceImpl::ClearCallbacks()")); m_mutex.Lock(); // Wait till the callback is in use. while (m_protect_callback) { m_mutex.Unlock(); qcc::Sleep(2); m_mutex.Lock(); } // // Delete any callbacks that any users of this class may have set. // for (uint32_t i = 0; i < N_TRANSPORTS; ++i) { Callback&, uint32_t>* goner = m_callback[i]; m_callback[i] = NULL; delete goner; } m_mutex.Unlock(); } void IpNameServiceImpl::ClearNetworkEventCallbacks(void) { QCC_DbgPrintf(("IpNameServiceImpl::ClearNetworkEventCallbacks()")); m_mutex.Lock(); // Wait till the callback is in use. while (m_protect_net_callback) { m_mutex.Unlock(); qcc::Sleep(2); m_mutex.Lock(); } // // Delete any callbacks that any users of this class may have set. // for (uint32_t i = 0; i < N_TRANSPORTS; ++i) { Callback&>* goner = m_networkEventCallback[i]; m_networkEventCallback[i] = NULL; delete goner; } m_mutex.Unlock(); } size_t IpNameServiceImpl::NumAdvertisements(TransportMask transportMask) { QCC_DbgPrintf(("IpNameServiceImpl::NumAdvertisements()")); // // Exactly one bit must be set in a transport mask in order to identify the // one transport (in the AllJoyn sense) that is making the request. // if (CountOnes(transportMask) != 1) { QCC_LogError(ER_BAD_TRANSPORT_MASK, ("IpNameServiceImpl::NumAdvertisements(): Bad transport mask")); return 0; } uint32_t i = IndexFromBit(transportMask); assert(i < 16 && "IpNameServiceImpl::NumAdvertisements(): Bad callback index"); if (i >= 16) { return ER_BAD_TRANSPORT_MASK; } return m_advertised[i].size(); } QStatus IpNameServiceImpl::AdvertiseName(TransportMask transportMask, const qcc::String& wkn, bool quietly, TransportMask completeTransportMask) { QCC_DbgHLPrintf(("IpNameServiceImpl::AdvertiseName(0x%x, \"%s\", %d)", transportMask, wkn.c_str(), quietly)); vector wknVector; wknVector.push_back(wkn); return AdvertiseName(transportMask, wknVector, quietly, completeTransportMask); } QStatus IpNameServiceImpl::AdvertiseName(TransportMask transportMask, vector& wkn, bool quietly, TransportMask completeTransportMask) { QCC_DbgHLPrintf(("IpNameServiceImpl::AdvertiseName(0x%x, 0x%p, %d)", transportMask, &wkn, quietly)); // // Exactly one bit must be set in a transport mask in order to identify the // one transport (in the AllJoyn sense) that is making the request. // if (CountOnes(transportMask) != 1) { QCC_LogError(ER_BAD_TRANSPORT_MASK, ("IpNameServiceImpl::AdvertiseName(): Bad transport mask")); return ER_BAD_TRANSPORT_MASK; } uint32_t transportIndex = IndexFromBit(transportMask); assert(transportIndex < 16 && "IpNameServiceImpl::AdvertiseName(): Bad transport index"); if (transportIndex >= 16) { return ER_BAD_TRANSPORT_MASK; } if (m_state != IMPL_RUNNING) { QCC_DbgPrintf(("IpNameServiceImpl::AdvertiseName(): Not IMPL_RUNNING")); return ER_FAIL; } // // There are at least two threads wandering through the advertised list. // We are running short on toes, so don't shoot any more off by not being // thread-unaware. // m_mutex.Lock(); // // Make a note to ourselves which services we are advertising so we can // respond to protocol questions in the future. Only allow one entry per // name. We keep separate lists of quietly advertised names and actively // advertised names since it makes it easy to decide which names go in // periodic keep-alive advertisements. // if (quietly) { for (uint32_t i = 0; i < wkn.size(); ++i) { set::iterator j = find(m_advertised_quietly[transportIndex].begin(), m_advertised_quietly[transportIndex].end(), wkn[i]); if (j == m_advertised_quietly[transportIndex].end()) { m_advertised_quietly[transportIndex].insert(wkn[i]); } else { // // Nothing has changed, so don't bother. // QCC_DbgPrintf(("IpNameServiceImpl::AdvertiseName(): Duplicate advertisement")); m_mutex.Unlock(); return ER_OK; } } // // Since we are advertising quietly, we need to quietly return without // advertising the name, which would happen if we just fell out of the // if-else. // m_mutex.Unlock(); return ER_OK; } else { for (uint32_t i = 0; i < wkn.size(); ++i) { set::iterator j = find(m_advertised[transportIndex].begin(), m_advertised[transportIndex].end(), wkn[i]); if (j == m_advertised[transportIndex].end()) { m_advertised[transportIndex].insert(wkn[i]); } else { // // Nothing has changed, so don't bother. // QCC_DbgPrintf(("IpNameServiceImpl::AdvertiseName(): Duplicate advertisement")); m_mutex.Unlock(); return ER_OK; } } // // If the advertisement retransmission timer is cleared, then set us // up to retransmit. This has to be done with the mutex locked since // the main thread is playing with this value as well. // if (m_timer == 0) { m_timer = m_tDuration; } } m_mutex.Unlock(); // // We are now at version one of the protocol. There is a significant // difference between version zero and version one messages, so down-version // (version zero) clients will not know what to do with version one // messages. This means that if we want to have clients running older // daemons be able to hear our advertisements, we need to send both flavors // of message. Since the version is located in the message header, this // means two messages. // // Do it once for version two. // uint32_t secondOfPairIndex = IndexFromBit(TRANSPORT_SECOND_OF_PAIR); bool isFirstOfPair = (transportMask == TRANSPORT_FIRST_OF_PAIR); bool isSecondOfPair = (transportMask == TRANSPORT_SECOND_OF_PAIR); bool isFirstOfPairRequested = ((completeTransportMask & TRANSPORT_FIRST_OF_PAIR) == TRANSPORT_FIRST_OF_PAIR); bool isSecondOfPairRequested = ((completeTransportMask & TRANSPORT_SECOND_OF_PAIR) == TRANSPORT_SECOND_OF_PAIR); // If this is the first of the pair, only send if second is not requested in the complete transport mask bool sendForFirstOfPair = (isFirstOfPair && !isSecondOfPairRequested); // If this is the second of the pair of transports, send if this transport is enabled or the first transport was requested. bool sendForSecondOfPair = (isSecondOfPair && (isFirstOfPairRequested || m_enabledUnreliableIPv4[secondOfPairIndex])); if (sendForFirstOfPair || sendForSecondOfPair) { //version two MDNSAdvertiseRData* advRData = new MDNSAdvertiseRData(); advRData->SetTransport(completeTransportMask & (TRANSPORT_TCP | TRANSPORT_UDP)); for (uint32_t i = 0; i < wkn.size(); ++i) { advRData->SetValue("name", wkn[i]); } MDNSResourceRecord advRecord("advertise." + m_guid + ".local.", MDNSResourceRecord::TXT, MDNSResourceRecord::INTERNET, 120, advRData); MDNSPacket mdnsPacket; mdnsPacket->AddAdditionalRecord(advRecord); mdnsPacket->SetVersion(2, 2); Response(completeTransportMask, 120, mdnsPacket); delete advRData; } // // Do it once for version zero. // if (m_enableV1 && (transportMask != TRANSPORT_UDP)) { // // The underlying protocol is capable of identifying both TCP and UDP // services. Right now, the only possibility is TCP, so this is not // exposed to the user unneccesarily. // IsAt isAt; // // We understand all messages from version zero to version one, and we // are sending a version zero message. The whole point of sending a // version zero message is that can be understood by down-level code // so we can't use the new versioning scheme. // isAt.SetVersion(0, 0); // // We don't actually send the transport mask in version zero packets // but we make a note to ourselves to let us know on behalf ow what // transport we will be sending. // isAt.SetTransportMask(transportMask); // // We have to use some sneaky way to tell an in-the know version one // client that the packet is from a version one client and that is // through the setting of the UDP flag. TCP transports are the only // possibility for version zero packets and it always sets the TCP // flag, of course. // isAt.SetTcpFlag(true); isAt.SetUdpFlag(true); // // Always send the provided daemon GUID out with the reponse. // isAt.SetGuid(m_guid); // // Send a protocol message describing the entire list of names we have // for the provided protocol. // isAt.SetCompleteFlag(true); // // The only possibility for version zero is that the port is the // reliable IPv4 port. When the message goes out a selected interface, // the protocol handler will write out the addresses according to its // rules. // isAt.SetPort(0); // // Add the provided names to the is-at message that will be sent out on the // network. // for (uint32_t i = 0; i < wkn.size(); ++i) { isAt.AddName(wkn[i]); } // // The header ties the whole protocol message together. By setting the // timer, we are asking for everyone who hears the message to remember // the advertisements for that number of seconds. // NSPacket nspacket; nspacket->SetVersion(0, 0); nspacket->SetTimer(m_tDuration); nspacket->AddAnswer(isAt); // // We don't want allow the caller to advertise an unlimited number of // names and consume all available network resources. We expect // AdvertiseName() to typically be called once per advertised name, but // since we allow a vector of names we need to limit that size somehow. // The easy way is to assume that all of the names are the maximum size // and just limit based on the maximum NS packet size and the maximum // name size of 256 bytes. This, however, leaves just five names which // seems too restrictive. So, we do it the more time-consuming way and // put together the message and then see if it's "too big." // // This isn't terribly elegant, but we don't know the IP address(es) over // which the message will be sent. These are added in the loop that // actually does the packet sends, with the interface addresses dynamically // added onto the message. We have no clue here if an IPv4 or IPv6 or both // flavors of address will exist on a given interface, nor how many // interfaces there are. All we can do here is to assume the worst case for // the size (both exist) and add the 20 bytes (four for IPv4, sixteen for // IPv6) that the addresses may consume in the final packet. // if (nspacket->GetSerializedSize() + 20 <= NS_MESSAGE_MAX) { // // Queue this message for transmission out on the various live interfaces. // QueueProtocolMessage(Packet::cast(nspacket)); } else { QCC_LogError(ER_PACKET_TOO_LARGE, ("IpNameServiceImpl::AdvertiseName(): Resulting NS message too large")); return ER_PACKET_TOO_LARGE; } } // // Do it once for version one. // if (m_enableV1 && (transportMask != TRANSPORT_UDP)) { IsAt isAt; // // We understand all messages from version zero to version one, and we // are sending a version one message; // isAt.SetVersion(1, 1); isAt.SetTransportMask(transportMask); // // Version one allows us to provide four possible endpoints. The // address will be rewritten on the way out with the address of the // appropriate interface. We delay the checks for the listening ports // to the point at which the packet is re-written on per-interface. // basis. // isAt.SetReliableIPv4("", 0); isAt.SetUnreliableIPv4("", 0); // This is a trick to make V2 NS ignore V1 packets. We set the IPv6 reliable bit, // that tells version two capable NS that a version two message will follow, and // to ignore the version one messages. isAt.SetReliableIPv6("", m_reliableIPv6Port[transportIndex]); if (m_unreliableIPv6Port[transportIndex]) { isAt.SetUnreliableIPv6("", m_unreliableIPv6Port[transportIndex]); } // // Always send the provided daemon GUID out with the reponse. // isAt.SetGuid(m_guid); // // Send a protocol message describing the entire list of names we have // for the provided protocol. // isAt.SetCompleteFlag(true); // // Add the provided names to the is-at message that will be sent out on the // network. // for (uint32_t i = 0; i < wkn.size(); ++i) { isAt.AddName(wkn[i]); } // // The header ties the whole protocol message together. By setting the // timer, we are asking for everyone who hears the message to remember // the advertisements for that number of seconds. // NSPacket nspacket; nspacket->SetVersion(1, 1); nspacket->SetTimer(m_tDuration); nspacket->AddAnswer(isAt); // // We don't want allow the caller to advertise an unlimited number of // names and consume all available network resources. We expect // AdvertiseName() to typically be called once per advertised name, but // since we allow a vector of names we need to limit that size somehow. // The easy way is to assume that all of the names are the maximum size // and just limit based on the maximum NS packet size and the maximum // name size of 256 bytes. This, however, leaves just five names which // seems too restrictive. So, we do it the more time-consuming way and // put together the message and then see if it's "too big." // // This isn't terribly elegant, but we don't know the IP address(es) over // which the message will be sent. These are added in the loop that // actually does the packet sends, with the interface addresses dynamically // added onto the message. We have no clue here if an IPv4 or IPv6 or both // flavors of address will exist on a given interface, nor how many // interfaces there are. All we can do here is to assume the worst case for // the size (both exist) and add the 20 bytes (four for IPv4, sixteen for // IPv6) that the addresses may consume in the final packet. // if (nspacket->GetSerializedSize() + 20 <= NS_MESSAGE_MAX) { // // Queue this message for transmission out on the various live interfaces. // QueueProtocolMessage(Packet::cast(nspacket)); } else { QCC_LogError(ER_PACKET_TOO_LARGE, ("IpNameServiceImpl::AdvertiseName(): Resulting NS message too large")); return ER_PACKET_TOO_LARGE; } } return ER_OK; } QStatus IpNameServiceImpl::CancelAdvertiseName(TransportMask transportMask, const qcc::String& wkn, TransportMask completeTransportMask) { QCC_DbgPrintf(("IpNameServiceImpl::CancelAdvertiseName(0x%x, \"%s\")", transportMask, wkn.c_str())); vector wknVector; wknVector.push_back(wkn); return CancelAdvertiseName(transportMask, wknVector, completeTransportMask); } QStatus IpNameServiceImpl::CancelAdvertiseName(TransportMask transportMask, vector& wkn, TransportMask completeTransportMask) { QCC_DbgPrintf(("IpNameServiceImpl::CancelAdvertiseName(0x%x, 0x%p)", transportMask, &wkn)); // // Exactly one bit must be set in a transport mask in order to identify the // one transport (in the AllJoyn sense) that is making the request. // if (CountOnes(transportMask) != 1) { QCC_LogError(ER_BAD_TRANSPORT_MASK, ("IpNameServiceImpl::CancelAdvertiseName(): Bad transport mask")); return ER_BAD_TRANSPORT_MASK; } uint32_t transportIndex = IndexFromBit(transportMask); assert(transportIndex < 16 && "IpNameServiceImpl::CancelAdvertiseName(): Bad transport index"); if (transportIndex >= 16) { return ER_BAD_TRANSPORT_MASK; } if (m_state != IMPL_RUNNING) { QCC_DbgPrintf(("IpNameServiceImpl::CancelAdvertiseName(): Not IMPL_RUNNING")); return ER_FAIL; } // // There are at least two threads wandering through the advertised list. // We are running short on toes, so don't shoot any more off by not being // thread-unaware. // m_mutex.Lock(); // // Remove the given services from our list of services we are advertising. // bool changed = false; // // We cancel advertisements in either the quietly or actively advertised // lists through this method. Note that it is only actively advertised // names that have changes in status reflected out on the network. The // variable drives this network operation and so is not // set in the quietly advertised list even though the list was changed. // for (uint32_t i = 0; i < wkn.size(); ++i) { set::iterator j = find(m_advertised[transportIndex].begin(), m_advertised[transportIndex].end(), wkn[i]); if (j != m_advertised[transportIndex].end()) { m_advertised[transportIndex].erase(j); changed = true; } set::iterator k = find(m_advertised_quietly[transportIndex].begin(), m_advertised_quietly[transportIndex].end(), wkn[i]); if (k != m_advertised_quietly[transportIndex].end()) { m_advertised_quietly[transportIndex].erase(k); } } // // If we have no more advertisements, there is no need to repeatedly state // this so turn off the retransmit timer. The main thread is playing with // this number too, so this must be done with the mutex locked. Note that // the timer only reflects the presence of active advertisements. // bool activeAdvertisements = false; for (uint32_t i = 0; i < N_TRANSPORTS; ++i) { if (m_advertised[i].size()) { activeAdvertisements = true; } } if (activeAdvertisements == false) { m_timer = 0; } m_mutex.Unlock(); // // Even though changed may be false, we may still need to send out the packet // since TCP is enabled. // // // Do it once for version two. // uint32_t secondOfPairIndex = IndexFromBit(TRANSPORT_SECOND_OF_PAIR); bool isFirstOfPair = (transportMask == TRANSPORT_FIRST_OF_PAIR); bool isSecondOfPair = (transportMask == TRANSPORT_SECOND_OF_PAIR); bool isFirstOfPairRequested = ((completeTransportMask & TRANSPORT_FIRST_OF_PAIR) == TRANSPORT_FIRST_OF_PAIR); bool isSecondOfPairRequested = ((completeTransportMask & TRANSPORT_SECOND_OF_PAIR) == TRANSPORT_SECOND_OF_PAIR); // If this is the first of the pair, only send if second is not requested in the complete transport mask bool sendForFirstOfPair = (isFirstOfPair && !isSecondOfPairRequested); // If this is the second of the pair of transports, send if this transport is enabled or the first transport was requested. bool sendForSecondOfPair = (isSecondOfPair && (isFirstOfPairRequested || m_enabledUnreliableIPv4[secondOfPairIndex])); if (sendForFirstOfPair || sendForSecondOfPair) { MDNSAdvertiseRData* advRData = new MDNSAdvertiseRData(); advRData->SetTransport(completeTransportMask & (TRANSPORT_TCP | TRANSPORT_UDP)); for (uint32_t i = 0; i < wkn.size(); ++i) { advRData->SetValue("name", wkn[i]); } MDNSResourceRecord advRecord("advertise." + m_guid + ".local.", MDNSResourceRecord::TXT, MDNSResourceRecord::INTERNET, 0, advRData); MDNSPacket mdnsPacket; mdnsPacket->AddAdditionalRecord(advRecord); mdnsPacket->SetVersion(2, 2); Response(completeTransportMask, 0, mdnsPacket); delete advRData; } // // If we didn't actually make a change that needs to be sent out on the // network, just return. // if (changed == false) { return ER_OK; } // // We are now at version one of the protocol. There is a significant // difference between version zero and version one messages, so down-version // (version zero) clients will not know what to do with version one // messages. This means that if we want to have clients running older // daemons be able to hear our advertisements, we need to send both flavors // of message. Since the version is located in the message header, this // means two messages. // // Do it once for version zero. // if (m_enableV1 && (transportMask != TRANSPORT_UDP)) { // // Send a protocol answer message describing the list of names we have just // been asked to withdraw. // // This code assumes that the daemon talks over TCP. True for now. // IsAt isAt; // // We understand all messages from version zero to version one, and we // are sending a version zero message. The whole point of sending a // version zero message is that can be understood by down-level code // so we can't use the new versioning scheme. We have to use some // sneaky way to tell an in-the know version one client that the // packet is from a version one client and that is through the setting // of the UDP flag. // isAt.SetVersion(0, 0); // // We don't actually send the transport mask in version zero packets // but we make a note to ourselves to let us know on behalf of what // transport we will be sending. // isAt.SetTransportMask(transportMask); // // We have to use some sneaky way to tell an in-the know version one // client that the packet is from a version one client and that is // through the setting of the UDP flag. TCP transports are the only // possibility for version zero packets and it always sets the TCP // flag, of course. // isAt.SetTcpFlag(true); isAt.SetUdpFlag(true); // // Always send the provided daemon GUID out with the response. // isAt.SetGuid(m_guid); // // The only possibility in version zero is that the port is the reliable // IPv4 port. When the message goes out a selected interface, the // protocol handler will write out the addresses according to its rules. // isAt.SetPort(0); // // Copy the names we are withdrawing the advertisement for into the // protocol message object. // for (uint32_t i = 0; i < wkn.size(); ++i) { isAt.AddName(wkn[i]); } // // When withdrawing advertisements, a complete flag means that we are // withdrawing all of the advertisements. If the complete flag is // not set, we have some advertisements remaining. // if (m_advertised[transportIndex].size() == 0) { isAt.SetCompleteFlag(true); } // // The header ties the whole protocol message together. We're at version // zero of the protocol. // NSPacket nspacket; nspacket->SetVersion(0, 0); // // We want to signal that everyone can forget about these names // so we set the timer value to 0. // nspacket->SetTimer(0); nspacket->AddAnswer(isAt); // // Queue this message for transmission out on the various live interfaces. // QueueProtocolMessage(Packet::cast(nspacket)); } // // Do it once for version one. // if (m_enableV1 && (transportMask != TRANSPORT_UDP)) { // // Send a protocol answer message describing the list of names we have just // been asked to withdraw. // IsAt isAt; // // We understand all messages from version zero to version one, and we // are sending a version one message; // isAt.SetVersion(1, 1); // // Tell the other side what transport is no longer advertising these // names. // isAt.SetTransportMask(transportMask); // // Version one allows us to provide four possible endpoints. The // address will be rewritten on the way out with the address of the // appropriate interface. We delay the checks for the listening ports // to the point at which the packet is re-written on per-interface. // isAt.SetReliableIPv4("", 0); isAt.SetUnreliableIPv4("", 0); // This is a trick to make V2 NS ignore V1 packets. We set the IPv6 reliable bit, // that tells version two capable NS that a version two message will follow, and // to ignore the version one messages. isAt.SetReliableIPv6("", m_reliableIPv6Port[transportIndex]); if (m_unreliableIPv6Port[transportIndex]) { isAt.SetUnreliableIPv6("", m_unreliableIPv6Port[transportIndex]); } // // Always send the provided daemon GUID out with the reponse. // isAt.SetGuid(m_guid); // // Copy the names we are withdrawing the advertisement for into the // protocol message object. // for (uint32_t i = 0; i < wkn.size(); ++i) { isAt.AddName(wkn[i]); } // // When withdrawing advertisements, a complete flag means that we are // withdrawing all of the advertisements. If the complete flag is // not set, we have some advertisements remaining. // if (m_advertised[transportIndex].size() == 0) { isAt.SetCompleteFlag(true); } // // The header ties the whole protocol message together. We're at version // one of the protocol. // NSPacket nspacket; nspacket->SetVersion(1, 1); // // We want to signal that everyone can forget about these names // so we set the timer value to 0. // nspacket->SetTimer(0); nspacket->AddAnswer(isAt); // // Queue this message for transmission out on the various live interfaces. // QueueProtocolMessage(Packet::cast(nspacket)); } return ER_OK; } QStatus IpNameServiceImpl::Ping(TransportMask transportMask, const qcc::String& guid, const qcc::String& name) { qcc::String pingString = "name='" + name + "'"; return RefreshCache(transportMask, guid, pingString, ALWAYS_RETRY, true); } QStatus IpNameServiceImpl::Query(TransportMask completeTransportMask, MDNSPacket mdnsPacket) { QCC_DbgPrintf(("IpNameServiceImpl::Query(0x%x, ...)", completeTransportMask)); if (m_state != IMPL_RUNNING) { QCC_DbgPrintf(("IpNameServiceImpl::Query(): Not running")); return ER_FAIL; } // // Fill in mandatory sections of query // mdnsPacket->SetVersion(2, 2); int32_t id = IncrementAndFetch(&INCREMENTAL_PACKET_ID); MDNSHeader mdnsHeader(id, MDNSHeader::MDNS_QUERY); mdnsPacket->SetHeader(mdnsHeader); if (completeTransportMask & TRANSPORT_TCP) { MDNSQuestion mdnsQuestion("_alljoyn._tcp.local.", MDNSResourceRecord::PTR, MDNSResourceRecord::INTERNET); mdnsPacket->AddQuestion(mdnsQuestion); } if (completeTransportMask & TRANSPORT_UDP) { MDNSQuestion mdnsQuestion("_alljoyn._udp.local.", MDNSResourceRecord::PTR, MDNSResourceRecord::INTERNET); mdnsPacket->AddQuestion(mdnsQuestion); } MDNSSenderRData* refRData = new MDNSSenderRData(); refRData->SetSearchID(id); MDNSResourceRecord refRecord("sender-info." + m_guid + ".local.", MDNSResourceRecord::TXT, MDNSResourceRecord::INTERNET, 120, refRData); mdnsPacket->AddAdditionalRecord(refRecord); delete refRData; if (mdnsPacket->DestinationSet()) { QueueProtocolMessage(Packet::cast(mdnsPacket)); } else { m_mutex.Lock(); // Search for the same name in the burstQueue. // If present, remove the entry to preserve the ordering of outgoing packets. std::list::iterator it = m_burstQueue.begin(); while (it != m_burstQueue.end()) { uint32_t nsVersion; uint32_t msgVersion; (*it).packet->GetVersion(nsVersion, msgVersion); if (msgVersion == 2) { MDNSPacket temp = MDNSPacket::cast((*it).packet); if (temp->GetHeader().GetQRType() == MDNSHeader::MDNS_QUERY) { if ((completeTransportMask & temp->GetTransportMask()) == completeTransportMask) { MDNSResourceRecord* tmpSearchRecord; temp->GetAdditionalRecord("search.*", MDNSResourceRecord::TXT, MDNSTextRData::TXTVERS, &tmpSearchRecord); MDNSSearchRData* tmpSearchRData = static_cast(tmpSearchRecord->GetRData()); MDNSResourceRecord* searchRecord; mdnsPacket->GetAdditionalRecord("search.*", MDNSResourceRecord::TXT, MDNSTextRData::TXTVERS, &searchRecord); MDNSSearchRData* searchRData = static_cast(searchRecord->GetRData()); if (tmpSearchRData->GetNumSearchCriteria() == 1) { if (searchRData->GetSearchCriterion(0) == tmpSearchRData->GetSearchCriterion(0)) { m_burstQueue.erase(it++); continue; } } } } } it++; } m_mutex.Unlock(); TriggerTransmission(Packet::cast(mdnsPacket)); } return ER_OK; } QStatus IpNameServiceImpl::Response(TransportMask completeTransportMask, uint32_t ttl, MDNSPacket mdnsPacket) { QCC_DbgHLPrintf(("IpNameServiceImpl::Response(0x%x, ...)", completeTransportMask)); if (m_state != IMPL_RUNNING) { QCC_DbgPrintf(("IpNameServiceImpl::Response(): Not running")); return ER_FAIL; } // // Fill in the mandatory sections of the response // mdnsPacket->SetVersion(2, 2); int32_t id = IncrementAndFetch(&INCREMENTAL_PACKET_ID); MDNSHeader mdnsHeader(id, MDNSHeader::MDNS_RESPONSE); mdnsPacket->SetHeader(mdnsHeader); // We defer the checks for the listening ports to the point when the packet is re-written. if (completeTransportMask & TRANSPORT_TCP) { MDNSPtrRData* ptrRDataTcp = new MDNSPtrRData(); ptrRDataTcp->SetPtrDName(m_guid + "._alljoyn._tcp.local."); MDNSResourceRecord ptrRecordTcp("_alljoyn._tcp.local.", MDNSResourceRecord::PTR, MDNSResourceRecord::INTERNET, 120, ptrRDataTcp); delete ptrRDataTcp; MDNSSrvRData* srvRDataTcp = new MDNSSrvRData(1 /*priority */, 1 /* weight */, 0 /* port */, m_guid + ".local." /* target */); MDNSResourceRecord srvRecordTcp(m_guid + "._alljoyn._tcp.local.", MDNSResourceRecord::SRV, MDNSResourceRecord::INTERNET, 120, srvRDataTcp); delete srvRDataTcp; MDNSTextRData* txtRDataTcp = new MDNSTextRData(); if (m_reliableIPv6Port[TRANSPORT_INDEX_TCP]) { txtRDataTcp->SetValue("r6port", U32ToString(m_reliableIPv6Port[TRANSPORT_INDEX_TCP])); } MDNSResourceRecord txtRecordTcp(m_guid + "._alljoyn._tcp.local.", MDNSResourceRecord::TXT, MDNSResourceRecord::INTERNET, 120, txtRDataTcp); delete txtRDataTcp; mdnsPacket->AddAnswer(ptrRecordTcp); mdnsPacket->AddAnswer(srvRecordTcp); mdnsPacket->AddAnswer(txtRecordTcp); } // We defer the checks for the listening ports to the point when the packet is re-written. if (completeTransportMask & TRANSPORT_UDP) { MDNSPtrRData* ptrRDataUdp = new MDNSPtrRData(); ptrRDataUdp->SetPtrDName(m_guid + "._alljoyn._udp.local."); MDNSResourceRecord ptrRecordUdp("_alljoyn._udp.local.", MDNSResourceRecord::PTR, MDNSResourceRecord::INTERNET, 120, ptrRDataUdp); delete ptrRDataUdp; MDNSSrvRData* srvRDataUdp = new MDNSSrvRData(1 /*priority */, 1 /* weight */, 0 /* port */, m_guid + ".local." /* target */); MDNSResourceRecord srvRecordUdp(m_guid + "._alljoyn._udp.local.", MDNSResourceRecord::SRV, MDNSResourceRecord::INTERNET, 120, srvRDataUdp); delete srvRDataUdp; MDNSTextRData* txtRDataUdp = new MDNSTextRData(); if (m_unreliableIPv6Port[TRANSPORT_INDEX_UDP]) { txtRDataUdp->SetValue("u6port", U32ToString(m_unreliableIPv6Port[TRANSPORT_INDEX_UDP])); } MDNSResourceRecord txtRecordUdp(m_guid + "._alljoyn._udp.local.", MDNSResourceRecord::TXT, MDNSResourceRecord::INTERNET, 120, txtRDataUdp); delete txtRDataUdp; mdnsPacket->AddAnswer(ptrRecordUdp); mdnsPacket->AddAnswer(srvRecordUdp); mdnsPacket->AddAnswer(txtRecordUdp); } MDNSSenderRData* refRData = new MDNSSenderRData(); refRData->SetSearchID(id); MDNSResourceRecord refRecord("sender-info." + m_guid + ".local.", MDNSResourceRecord::TXT, MDNSResourceRecord::INTERNET, ttl, refRData); mdnsPacket->AddAdditionalRecord(refRecord); delete refRData; // // We don't want allow the caller to advertise an unlimited number of // names and consume all available network resources. We expect // AdvertiseName() to typically be called once per advertised name, but // since we allow a vector of names we need to limit that size somehow. // The easy way is to assume that all of the names are the maximum size // and just limit based on the maximum NS packet size and the maximum // name size of 256 bytes. This, however, leaves just five names which // seems too restrictive. So, we do it the more time-consuming way and // put together the message and then see if it's "too big." // // This isn't terribly elegant, but we don't know the IP address(es) over // which the message will be sent. These are added in the loop that // actually does the packet sends, with the interface addresses dynamically // added onto the message. We have no clue here if an IPv4 or IPv6 or both // flavors of address will exist on a given interface, nor how many // interfaces there are. All we can do here is to assume the worst case for // the size (both exist) and add the 20 bytes (four for IPv4, sixteen for // IPv6) that the addresses may consume in the final packet. // if (mdnsPacket->GetSerializedSize() + 20 <= NS_MESSAGE_MAX) { // // Queue this message for transmission out on the various live interfaces. // if (mdnsPacket->DestinationSet()) { QueueProtocolMessage(Packet::cast(mdnsPacket)); } else { MDNSResourceRecord* advRecord; if (mdnsPacket->GetAdditionalRecord("advertise.*", MDNSResourceRecord::TXT, MDNSTextRData::TXTVERS, &advRecord)) { MDNSAdvertiseRData* advRData = static_cast(advRecord->GetRData()); m_mutex.Lock(); // Search for the same name in the burstQueue. // If present, remove the entry to preserve the ordering of outgoing packets. std::list::iterator it = m_burstQueue.begin(); while (it != m_burstQueue.end()) { uint32_t nsVersion; uint32_t msgVersion; (*it).packet->GetVersion(nsVersion, msgVersion); if (msgVersion == 2) { MDNSPacket temp = MDNSPacket::cast((*it).packet); if (temp->GetHeader().GetQRType() == MDNSHeader::MDNS_RESPONSE) { if (completeTransportMask == temp->GetTransportMask()) { MDNSResourceRecord* tmpAdvRecord; if (temp->GetAdditionalRecord("advertise.*", MDNSResourceRecord::TXT, MDNSTextRData::TXTVERS, &tmpAdvRecord)) { MDNSAdvertiseRData* tmpAdvRData = static_cast(tmpAdvRecord->GetRData()); if ((tmpAdvRData->GetNumTransports() == 1) && (advRData->GetNumNames(completeTransportMask) == tmpAdvRData->GetNumNames(completeTransportMask))) { bool matching = true; for (uint32_t k = 0; k < advRData->GetNumNames(completeTransportMask); k++) { if (advRData->GetNameAt(completeTransportMask, k) != tmpAdvRData->GetNameAt(completeTransportMask, k)) { matching = false; } } if (matching) { m_burstQueue.erase(it++); continue; } } } } } } it++; } m_mutex.Unlock(); } TriggerTransmission(Packet::cast(mdnsPacket)); } } else { QCC_LogError(ER_PACKET_TOO_LARGE, ("IpNameServiceImpl::AdvertiseName(): Resulting NS message too large")); return ER_PACKET_TOO_LARGE; } return ER_OK; } QStatus IpNameServiceImpl::OnProcSuspend() { if (!m_isProcSuspending) { m_isProcSuspending = true; m_forceLazyUpdate = true; m_wakeEvent.SetEvent(); } return ER_OK; } QStatus IpNameServiceImpl::OnProcResume() { if (m_isProcSuspending) { m_isProcSuspending = false; m_forceLazyUpdate = true; m_wakeEvent.SetEvent(); } return ER_OK; } void IpNameServiceImpl::RegisterListener(IpNameServiceListener& listener) { m_mutex.Lock(); m_listeners.push_back(&listener); m_mutex.Unlock(); } void IpNameServiceImpl::UnregisterListener(IpNameServiceListener& listener) { m_mutex.Lock(); // Wait till the listeners are not in use. while (m_protectListeners) { m_mutex.Unlock(); qcc::Sleep(2); m_mutex.Lock(); } m_listeners.remove(&listener); m_mutex.Unlock(); } void IpNameServiceImpl::QueueProtocolMessage(Packet packet) { // Maximum number of IpNameService protocol messages that can be queued. static const size_t MAX_IPNS_MESSAGES = 50; QCC_DbgPrintf(("IpNameServiceImpl::QueueProtocolMessage()")); uint32_t nsVersion, msgVersion; packet->GetVersion(nsVersion, msgVersion); assert(m_enableV1 || (msgVersion != 0 && msgVersion != 1)); m_mutex.Lock(); while (m_outbound.size() >= MAX_IPNS_MESSAGES) { m_mutex.Unlock(); qcc::Sleep(10); m_mutex.Lock(); } if (m_state == IMPL_RUNNING) { m_outbound.push_back(packet); m_wakeEvent.SetEvent(); } m_mutex.Unlock(); } // // If you set HAPPY_WANDERER to 1, it will enable a test behavior that // simulates the daemon happily wandering in and out of range of an // imaginary access point. // // It is essentially a trivial one-dimensional random walk across a fixed // domain. When Wander() is called, der froliche wandering daemon moves // in a random direction for one meter. When the daemon "walks" out of // range, Wander() returns false and the test will arrange that name // service messages are discarded. When the daemon "walks" back into // range, messages are delivered again. We generally call Wander() out // DoPeriodicMaintenance() which ticks every second, but also out of // HandleProtocolAnswer() so the random walk is at a non-constant rate // driven by network activity. Very nasty. // // The environment is 100 meters long, and the range of the access point // is 50 meters. The daemon starts right at the edge of the range and is // expected to hover around that point, but wander random distances in and // out. // // (*) X | // | <- D -> | // --------------------------------------------------- // 0 50 100 // // Since this is a very dangerous setting, turning it on is a two-step // process (set the #define and enable the bool); and we log every action // as an error. It will be hard to ignore this and accidentally leave it // turned on. // #define HAPPY_WANDERER 0 #if HAPPY_WANDERER static const uint32_t WANDER_LIMIT = 100; static const uint32_t WANDER_RANGE = WANDER_LIMIT / 2; static const uint32_t WANDER_START = WANDER_RANGE; bool g_enableWander = false; void WanderInit(void) { srand(time(NULL)); } bool Wander(void) { // // If you don't explicitly enable this behavior, Wander() always returns // "in-range". // if (g_enableWander == false) { return true; } static uint32_t x = WANDER_START; static bool xyzzy = false; if (xyzzy == false) { WanderInit(); xyzzy = true; } switch (x) { case 0: // Valderi ++x; break; case WANDER_LIMIT: // Valdera --x; break; default: // Valderahahahahahaha x += rand() & 1 ? 1 : -1; break; } QCC_LogError(ER_FAIL, ("Wander(): Wandered to %d which %s in-range", x, x < WANDER_RANGE ? "is" : "is NOT")); return x < WANDER_RANGE; } #endif void IpNameServiceImpl::SendProtocolMessage( qcc::SocketFd sockFd, qcc::IPAddress interfaceAddress, uint32_t interfaceAddressPrefixLen, uint32_t flags, bool sockFdIsIPv4, Packet packet, uint32_t interfaceIndex, const qcc::IPAddress& localAddress) { QCC_DbgPrintf(("**********IpNameServiceImpl::SendProtocolMessage()")); #if HAPPY_WANDERER if (Wander() == false) { QCC_LogError(ER_FAIL, ("IpNameServiceImpl::SendProtocolMessage(): Wander(): out of range")); return; } else { QCC_LogError(ER_FAIL, ("IpNameServiceImpl::SendProtocolMessage(): Wander(): in range")); } #endif uint32_t nsVersion, msgVersion; packet->GetVersion(nsVersion, msgVersion); size_t size = packet->GetSerializedSize(); if (size > NS_MESSAGE_MAX) { QCC_LogError(ER_FAIL, ("SendProtocolMessage: Message (%d bytes) is longer than NS_MESSAGE_MAX (%d bytes)", size, NS_MESSAGE_MAX)); return; } uint8_t* buffer = new uint8_t[size]; size = packet->Serialize(buffer); size_t sent; // // We have the concept of a quiet advertisement which means that we don't // actively send out is-at packets announcing that we have corresponding // well-known names. We don't announce them gratuitously, but we do respond // to queries on the names we are quietly advertising. With quiet // advertisements come quiet responses. This means that we don't yell our // answers over IP multicast, but we politely and quietly respond over // unicast. // // So the first thing to do is to decide whether or not we need to respond // quietly or over the multicast channel. If this protocol message corresponds // to a quiet advertisement, the destination address in the header will have // been set and we can just respond directly to that address and bail. // // One complication is that the name service wants to discover all possible // interfaces and send all advertisements out all interfaces over all // flavors (IPv4 and IPv6) and be completely in control of routing. In the // case of quiet responses we only want to send out responses when the // flavor of the address and socket match, and we only want to send messages // out on the network number on which the advertisement came in. Rather // than fight with the natural inclination of the bulk of the code, we just // quickly open a new socket and let the system route the message out in its // usual way. // // This is a bit of a hack, but then again, this is an experimental change // as of now. // if (packet->DestinationSet()) { QStatus status = ER_OK; qcc::IPEndpoint destination = packet->GetDestination(); qcc::AddressFamily family = destination.addr.IsIPv4() ? qcc::QCC_AF_INET : qcc::QCC_AF_INET6; if (family == qcc::QCC_AF_INET6 && m_ipv6QuietSockFd == qcc::INVALID_SOCKET_FD) { status = qcc::Socket(family, qcc::QCC_SOCK_DGRAM, m_ipv6QuietSockFd); } if (status != ER_OK) { QCC_LogError(status, ("IpNameServiceImpl::SendProtocolMessage(): Socket() failed: %d - %s", qcc::GetLastError(), qcc::GetLastErrorString().c_str())); } if (status == ER_OK) { QCC_DbgHLPrintf(("IpNameServiceImpl::SendProtocolMessage(): Sending quietly to \"%s\" over \"%s\"", destination.ToString().c_str(), m_liveInterfaces[interfaceIndex].m_interfaceName.c_str())); if (family == qcc::QCC_AF_INET) { status = qcc::SendTo(sockFd, destination.addr, destination.port, buffer, size, sent); } else { status = qcc::SendTo(m_ipv6QuietSockFd, destination.addr, destination.port, m_liveInterfaces[interfaceIndex].m_index, buffer, size, sent); } } if (status != ER_OK) { QCC_LogError(status, ("IpNameServiceImpl::SendProtocolMessage(): Error quietly sending to \"%s\"", destination.ToString().c_str())); } delete [] buffer; return; } // // Since we have fallen through to here, // Now it's time to send the packets. Packets is plural since we will try // to get our name service information across to peers in as many ways as is // reasonably possible since it turns out that discovery is a weak link in // the system. This means we will try broadcast and IPv6 multicast whenever // possible. // if (sockFdIsIPv4) { // // If the underlying interface told us that it supported multicast, send // the packet out on our IPv4 multicast groups (IANA registered and // legacy). // #if 1 if (flags & qcc::IfConfigEntry::MULTICAST || flags & qcc::IfConfigEntry::LOOPBACK) { #if WORKAROUND_2_3_BUG if ((msgVersion == 0) && m_enableV1) { qcc::IPAddress ipv4SiteAdminMulticast(IPV4_MULTICAST_GROUP); QCC_DbgHLPrintf(("IpNameServiceImpl::SendProtocolMessage(): Sending actively to \"%s\" over \"%s\"", ipv4SiteAdminMulticast.ToString().c_str(), m_liveInterfaces[interfaceIndex].m_interfaceName.c_str())); QStatus status = qcc::SendTo(sockFd, ipv4SiteAdminMulticast, MULTICAST_PORT, buffer, size, sent); if (status != ER_OK) { QCC_LogError(status, ("IpNameServiceImpl::SendProtocolMessage(): Error sending to IPv4 Site Administered multicast group")); } } #endif if (msgVersion == 2) { qcc::IPAddress ipv4LocalMulticast(IPV4_MDNS_MULTICAST_GROUP); QCC_DbgHLPrintf(("IpNameServiceImpl::SendProtocolMessage(): Sending actively to \"%s\" over \"%s\"", ipv4LocalMulticast.ToString().c_str(), m_liveInterfaces[interfaceIndex].m_interfaceName.c_str())); /* * Send the message from the port we are expecting to receive * (unicast) replies on. Explicitly specify the interface we * are sending on, otherwise the OS will pick for us. */ QStatus status = SetMulticastInterface(m_ipv4UnicastSockFd, qcc::QCC_AF_INET, m_liveInterfaces[interfaceIndex].m_interfaceName); if (status != ER_OK) { QCC_LogError(status, ("IpNameServiceImpl::SendProtocolMessage(): Error setting multicast interface")); } status = qcc::SendTo(m_ipv4UnicastSockFd, ipv4LocalMulticast, MULTICAST_MDNS_PORT, buffer, size, sent); if (status != ER_OK) { QCC_LogError(status, ("IpNameServiceImpl::SendProtocolMessage(): Error sending to IPv4 Local Network Control Block multicast group")); } } else if (m_enableV1) { qcc::IPAddress ipv4LocalMulticast(IPV4_ALLJOYN_MULTICAST_GROUP); if (localAddress == qcc::IPAddress("0.0.0.0") || localAddress == ipv4LocalMulticast) { QCC_DbgHLPrintf(("IpNameServiceImpl::SendProtocolMessage(): Sending actively to \"%s\" over \"%s\"", ipv4LocalMulticast.ToString().c_str(), m_liveInterfaces[interfaceIndex].m_interfaceName.c_str())); QStatus status = qcc::SendTo(sockFd, ipv4LocalMulticast, MULTICAST_PORT, buffer, size, sent); if (status != ER_OK) { QCC_LogError(status, ("IpNameServiceImpl::SendProtocolMessage(): Error sending to IPv4 Local Network Control Block multicast group")); } } } } #endif // // If the interface is broadcast-capable, We want to send out a subnet // directed broadcast over IPv4. // if (flags & qcc::IfConfigEntry::BROADCAST) { // // If there was a problem getting the IP address prefix // length, it will come in as -1. In this case, we can't form // a proper subnet directed broadcast and so we don't try. An // error will have been logged when we did the IfConfig, so // don't flood out any more, just silently ignore the problem. // if (m_broadcast && interfaceAddressPrefixLen != static_cast(-1)) { assert(m_enableV1 != false); // // In order to ensure that our broadcast goes to the correct // interface and is not just sent out some default way, we // have to form a subnet directed broadcast. To do this we need // the IP address and netmask. // QCC_DbgPrintf(("IpNameServiceImpl::SendProtocolMessage(): InterfaceAddress %s, prefix %d", interfaceAddress.ToString().c_str(), interfaceAddressPrefixLen)); // // Create a netmask with a one in the leading bits for each position // implied by the prefix length. // uint32_t mask = 0; for (uint32_t i = 0; i < interfaceAddressPrefixLen; ++i) { mask >>= 1; mask |= 0x80000000; } // // The subnet directed broadcast address is the address part of the // interface address (defined by the mask) with the rest of the bits // set to one. // uint32_t addr = (interfaceAddress.GetIPv4AddressCPUOrder() & mask) | ~mask; qcc::IPAddress ipv4Broadcast(addr); QCC_DbgHLPrintf(("IpNameServiceImpl::SendProtocolMessage(): Sending actively to \"%s\" over \"%s\"", ipv4Broadcast.ToString().c_str(), m_liveInterfaces[interfaceIndex].m_interfaceName.c_str())); if (msgVersion != 2 && (localAddress == qcc::IPAddress("0.0.0.0") || localAddress == ipv4Broadcast)) { QStatus status = qcc::SendTo(sockFd, ipv4Broadcast, BROADCAST_PORT, buffer, size, sent); if (status != ER_OK) { QCC_LogError(ER_FAIL, ("IpNameServiceImpl::SendProtocolMessage(): Error sending to IPv4 (broadcast)")); } } } else { QCC_DbgPrintf(("IpNameServiceImpl::SendProtocolMessage(): Subnet directed broadcasts are disabled")); } } else { QCC_DbgPrintf(("IpNameServiceImpl::SendProtocolMessage(): Interface does not support broadcast")); } } else { if (flags & qcc::IfConfigEntry::MULTICAST || flags & qcc::IfConfigEntry::LOOPBACK) { #if WORKAROUND_2_3_BUG if ((msgVersion == 0) && m_enableV1) { qcc::IPAddress ipv6SiteAdmin(IPV6_MULTICAST_GROUP); QCC_DbgHLPrintf(("IpNameServiceImpl::SendProtocolMessage(): Sending actively to \"%s\" over \"%s\"", ipv6SiteAdmin.ToString().c_str(), m_liveInterfaces[interfaceIndex].m_interfaceName.c_str())); QStatus status = qcc::SendTo(sockFd, ipv6SiteAdmin, MULTICAST_PORT, buffer, size, sent); if (status != ER_OK) { QCC_LogError(status, ("IpNameServiceImpl::SendProtocolMessage(): Error sending to IPv6 Site Administered multicast group ")); } } #endif QStatus status = ER_OK; if (msgVersion == 2) { qcc::IPAddress ipv6AllJoyn(IPV6_MDNS_MULTICAST_GROUP); QCC_DbgHLPrintf(("IpNameServiceImpl::SendProtocolMessage(): Sending actively to \"%s\" over \"%s\"", ipv6AllJoyn.ToString().c_str(), m_liveInterfaces[interfaceIndex].m_interfaceName.c_str())); /* * Ideally we would send the message from the port we are * expecting to receive (unicast) replies on. But since we do * not receive v6 unicast packets, we will be sending from * whatever port sockFd is bound to. */ status = qcc::SendTo(sockFd, ipv6AllJoyn, MULTICAST_MDNS_PORT, buffer, size, sent); } else if (m_enableV1) { qcc::IPAddress ipv6AllJoyn(IPV6_ALLJOYN_MULTICAST_GROUP); QCC_DbgHLPrintf(("IpNameServiceImpl::SendProtocolMessage(): Sending actively to \"%s\" over \"%s\"", ipv6AllJoyn.ToString().c_str(), m_liveInterfaces[interfaceIndex].m_interfaceName.c_str())); status = qcc::SendTo(sockFd, ipv6AllJoyn, MULTICAST_PORT, buffer, size, sent); } if (status != ER_OK) { QCC_LogError(status, ("IpNameServiceImpl::SendProtocolMessage(): Error sending to IPv6 Link-Local Scope multicast group ")); } } } delete [] buffer; } bool IpNameServiceImpl::InterfaceRequested(uint32_t transportIndex, uint32_t liveIndex) { QCC_DbgPrintf(("IpNameServiceImpl::InterfaceRequested()")); // // Look for the wildcard condition (any interface) and take into account // that doesn't mean P2P on Android. // #if defined(QCC_OS_ANDROID) if (m_any[transportIndex] && m_liveInterfaces[liveIndex].m_interfaceName.find("p2p") == qcc::String::npos) { QCC_DbgPrintf(("IpNameServiceImpl::InterfaceRequested(): Interface \"%s\" approved.", m_liveInterfaces[liveIndex].m_interfaceName.c_str())); return true; } #else if (m_any[transportIndex]) { QCC_DbgPrintf(("IpNameServiceImpl::InterfaceRequested(): Interface \"%s\" approved.", m_liveInterfaces[liveIndex].m_interfaceName.c_str())); return true; } #endif // // Now, the question is whether or not the current interface as indicated by // the interface name is on the list of requested interfaces for the // transport mask found in the message. If it is not, we must not send this // message out the current interface. // for (uint32_t i = 0; i < m_requestedInterfaces[transportIndex].size(); ++i) { // // If the current interface name matches the name in the requestedInterface list, // we will send this message out the current interface. // if (m_requestedInterfaces[transportIndex][i].m_interfaceName == m_liveInterfaces[liveIndex].m_interfaceName) { QCC_DbgPrintf(("IpNameServiceImpl::InterfaceRequested(): Interface \"%s\" approved.", m_liveInterfaces[liveIndex].m_interfaceName.c_str())); return true; } // // If the current interface IP address matches the IP address in the // requestedInterface list, we will send this message out the current interface. // if (m_requestedInterfaces[transportIndex][i].m_interfaceName.size() == 0 && m_requestedInterfaces[transportIndex][i].m_interfaceAddr == qcc::IPAddress(m_liveInterfaces[liveIndex].m_interfaceAddr)) { QCC_DbgPrintf(("IpNameServiceImpl::InterfaceRequested(): Interface \"%s\" approved.", m_liveInterfaces[liveIndex].m_interfaceName.c_str())); return true; } } return false; } void IpNameServiceImpl::RewriteVersionSpecific( uint32_t msgVersion, Packet packet, bool haveIPv4address, qcc::IPAddress ipv4address, bool haveIPv6address, qcc::IPAddress ipv6address, uint16_t unicastIpv4Port, const qcc::String& interface, uint16_t const reliableTransportPort, const uint16_t unreliableTransportPort) { QCC_UNUSED(interface); QCC_DbgPrintf(("IpNameServiceImpl::RewriteVersionSpecific()")); // // We're modifying answers in-place so clear any state we might have // previously added. // NSPacket nsPacket; MDNSPacket mdnspacket; switch (msgVersion) { case 0: QCC_DbgPrintf(("IpNameServiceImpl::RewriteVersionSpecific(): Answer gets version zero")); nsPacket = NSPacket::cast(packet); // // At this point, we know both of our local IPv4 and IPv6 addresses if they exist. Now, we have to // walk the list of answer (is-at) messages and rewrite the provided addresses // that will correspond to the interface we are sending the message out // of. // for (uint8_t j = 0; j < nsPacket->GetNumberAnswers(); ++j) { QCC_DbgPrintf(("IpNameServiceImpl::RewriteVersionSpecific(): Rewrite answer %d.", j)); IsAt* isAt; nsPacket->GetAnswer(j, &isAt); isAt->ClearIPv4(); isAt->ClearIPv6(); isAt->ClearReliableIPv4(); isAt->ClearUnreliableIPv4(); isAt->ClearReliableIPv6(); isAt->ClearUnreliableIPv6(); QCC_DbgPrintf(("IpNameServiceImpl::RewriteVersionSpecific(): Answer gets version zero")); isAt->SetVersion(0, 0); isAt->SetTcpFlag(true); isAt->SetPort(reliableTransportPort); // // Remember that we must sneak in the fact that we are a post-zero name // service by the old "setting the UDP flag" trick. // isAt->SetUdpFlag(true); // // For version zero, the name service was an integral part of the TCP // transport. Because of this, we know implicitly that the only kind of // address supported was the reliable IPv4 address. This means we just // need to set the IPv4 address. // if (haveIPv4address) { isAt->SetIPv4(ipv4address.ToString()); } } break; case 1: { QCC_DbgPrintf(("IpNameServiceImpl::RewriteVersionSpecific(): Answer gets version one")); nsPacket = NSPacket::cast(packet); // // At this point, we know both of our local IPv4 and IPv6 addresses if they exist. Now, we have to // walk the list of answer (is-at) messages and rewrite the provided addresses // that will correspond to the interface we are sending the message out // of. // for (uint8_t j = 0; j < nsPacket->GetNumberAnswers(); ++j) { QCC_DbgPrintf(("IpNameServiceImpl::RewriteVersionSpecific(): Rewrite answer %d.", j)); IsAt* isAt; nsPacket->GetAnswer(j, &isAt); isAt->ClearIPv4(); isAt->ClearIPv6(); isAt->ClearReliableIPv4(); isAt->ClearUnreliableIPv4(); isAt->ClearReliableIPv6(); isAt->ClearUnreliableIPv6(); QCC_DbgPrintf(("IpNameServiceImpl::RewriteVersionSpecific(): Answer gets version one")); isAt->SetVersion(1, 1); uint32_t transportIndex = IndexFromBit(isAt->GetTransportMask()); assert(transportIndex < 16 && "IpNameServiceImpl::RewriteVersionSpecific(): Bad transport index in messageg"); if (transportIndex >= 16) { return; } // // Now we can write the various addresses into the // packet if they are called for. // if (haveIPv4address && reliableTransportPort) { isAt->SetReliableIPv4(ipv4address.ToString(), reliableTransportPort); } if (haveIPv4address && unreliableTransportPort) { isAt->SetUnreliableIPv4(ipv4address.ToString(), unreliableTransportPort); } // This is a trick to make V2 NS ignore V1 packets. We set the IPv6 reliable bit, // that tells version two capable NS that a version two message will follow, and // to ignore the version one messages. isAt->SetReliableIPv6(ipv6address.ToString(), m_reliableIPv6Port[transportIndex]); if (haveIPv6address && m_unreliableIPv6Port[transportIndex]) { isAt->SetUnreliableIPv6(ipv6address.ToString(), m_unreliableIPv6Port[transportIndex]); } } break; } case 2: { //Need to rewrite ipv4Address into A record,ipv6address, unicast NS response ports into reference record. mdnspacket = MDNSPacket::cast(packet); MDNSHeader mdnsheader = mdnspacket->GetHeader(); MDNSResourceRecord* refRecord; mdnspacket->GetAdditionalRecord("sender-info.*", MDNSResourceRecord::TXT, MDNSTextRData::TXTVERS, &refRecord); MDNSSenderRData* refRData = static_cast(refRecord->GetRData()); if (mdnsheader.GetQRType() == MDNSHeader::MDNS_QUERY) { if (haveIPv4address && (unicastIpv4Port != 0)) { refRData->SetIPV4ResponsePort(unicastIpv4Port); refRData->SetIPV4ResponseAddr(ipv4address.ToString()); } else { refRData->RemoveEntry("ipv4"); refRData->RemoveEntry("upcv4"); } } else { //Response packet for (int i = 0; i < mdnspacket->GetNumAnswers(); i++) { MDNSResourceRecord* answerRecord; mdnspacket->GetAnswerAt(i, &answerRecord); MDNSResourceRecord* resourceRecord; MDNSARData* addrRData; MDNSTextRData* txtRData; MDNSSrvRData* srvRData; switch (answerRecord->GetRRType()) { case MDNSResourceRecord::SRV: if (answerRecord->GetDomainName().find("._tcp.") != String::npos) { srvRData = static_cast(answerRecord->GetRData()); if (haveIPv4address) { if (!mdnspacket->GetAdditionalRecord(srvRData->GetTarget(), MDNSResourceRecord::A, &resourceRecord)) { // Add an IPv4 address record addrRData = new MDNSARData(); mdnspacket->AddAdditionalRecord(MDNSResourceRecord(m_guid + ".local.", MDNSResourceRecord::A, MDNSResourceRecord::INTERNET, 120, addrRData)); mdnspacket->GetAdditionalRecord(srvRData->GetTarget(), MDNSResourceRecord::A, &resourceRecord); delete addrRData; } addrRData = static_cast(resourceRecord->GetRData()); if (addrRData) { addrRData->SetAddr(ipv4address.ToString()); refRData->SetIPV4ResponsePort(unicastIpv4Port); if (reliableTransportPort) { srvRData->SetPort(reliableTransportPort); } } } else { mdnspacket->RemoveAdditionalRecord(m_guid + ".local.", MDNSResourceRecord::A); refRData->RemoveEntry("ipv4"); refRData->RemoveEntry("upcv4"); } } else if (answerRecord->GetDomainName().find("._udp.") != String::npos) { srvRData = static_cast(answerRecord->GetRData()); if (haveIPv4address) { if (!mdnspacket->GetAdditionalRecord(srvRData->GetTarget(), MDNSResourceRecord::A, &resourceRecord)) { // Add an IPv4 address record addrRData = new MDNSARData(); mdnspacket->AddAdditionalRecord(MDNSResourceRecord(m_guid + ".local.", MDNSResourceRecord::A, MDNSResourceRecord::INTERNET, 120, addrRData)); delete addrRData; mdnspacket->GetAdditionalRecord(srvRData->GetTarget(), MDNSResourceRecord::A, &resourceRecord); } addrRData = static_cast(resourceRecord->GetRData()); if (addrRData) { addrRData->SetAddr(ipv4address.ToString()); if (unicastIpv4Port != 0) { refRData->SetIPV4ResponsePort(unicastIpv4Port); } if (unreliableTransportPort) { srvRData->SetPort(unreliableTransportPort); } } } else { mdnspacket->RemoveAdditionalRecord(m_guid + ".local.", MDNSResourceRecord::A); refRData->RemoveEntry("ipv4"); refRData->RemoveEntry("upcv4"); } } break; case MDNSResourceRecord::TXT: txtRData = static_cast(answerRecord->GetRData()); if (answerRecord->GetDomainName().find("._tcp.") != String::npos) { if (m_reliableIPv6Port[TRANSPORT_INDEX_TCP]) { txtRData->SetValue("r6port", U32ToString(m_reliableIPv6Port[TRANSPORT_INDEX_TCP])); } } else if (answerRecord->GetDomainName().find("._udp.") != String::npos) { if (m_unreliableIPv6Port[TRANSPORT_INDEX_UDP]) { txtRData->SetValue("u6port", U32ToString(m_unreliableIPv6Port[TRANSPORT_INDEX_UDP])); } } break; default: break; } } } break; } default: assert(false && "IpNameServiceImpl::RewriteVersionSpecific(): Bad message version"); break; } } bool IpNameServiceImpl::SameNetwork(uint32_t interfaceAddressPrefixLen, qcc::IPAddress addressA, qcc::IPAddress addressB) { QCC_DbgPrintf(("IpNameServiceImpl::SameNetwork(%d, \"%s\", \"%s\")", interfaceAddressPrefixLen, addressA.ToString().c_str(), addressB.ToString().c_str())); // // If there was a problem getting the IP address prefix length, it will come // in as -1. In this case, we can't determine what part of the addresses // are network number so we don't try. // if (interfaceAddressPrefixLen == static_cast(-1)) { QCC_LogError(ER_FAIL, ("IpNameServiceImpl::SameNetwork(): Bad network prefix")); return false; } if (addressA.IsIPv6()) { if (addressB.IsIPv4()) { QCC_DbgPrintf(("IpNameServiceImpl::SameNetwork(): Network families are different")); return false; } if (interfaceAddressPrefixLen > 128) { QCC_LogError(ER_FAIL, ("IpNameServiceImpl::SameNetwork(): Bad IPv6 network prefix")); return false; } uint8_t addrA[qcc::IPAddress::IPv6_SIZE]; addressA.RenderIPv6Binary(addrA, qcc::IPAddress::IPv6_SIZE); uint8_t addrB[qcc::IPAddress::IPv6_SIZE]; addressB.RenderIPv6Binary(addrB, qcc::IPAddress::IPv6_SIZE); uint32_t nBytes = interfaceAddressPrefixLen / 8; for (uint32_t i = 0; i < nBytes; ++i) { if (addrA[i] != addrB[i]) { QCC_DbgPrintf(("IpNameServiceImpl::SameNetwork(): IPv6 networks are different")); return false; } } uint32_t nBits = interfaceAddressPrefixLen % 8; uint8_t mask = 0; for (uint32_t i = 0; i < nBits; ++i) { mask >>= 1; mask |= 0x80; } if (interfaceAddressPrefixLen == 128) { return true; } if ((addrA[nBytes] & mask) == (addrB[nBytes] & mask)) { QCC_DbgPrintf(("IpNameServiceImpl::SameNetwork(): IPv6 networks are the same")); return true; } else { QCC_DbgPrintf(("IpNameServiceImpl::SameNetwork(): IPv6 networks are different")); return false; } } else if (addressA.IsIPv4()) { if (addressB.IsIPv6()) { QCC_DbgPrintf(("IpNameServiceImpl::SameNetwork(): Network families are different")); return false; } if (interfaceAddressPrefixLen > 32) { QCC_LogError(ER_FAIL, ("IpNameServiceImpl::SameNetwork(): Bad IPv4 network prefix")); return false; } // // Create a netmask with a one in the leading bits for each position // implied by the prefix length. // uint32_t mask = 0; for (uint32_t i = 0; i < interfaceAddressPrefixLen; ++i) { mask >>= 1; mask |= 0x80000000; } // // The subnet directed broadcast address is the address part of the // interface address (defined by the mask) with the rest of the bits // set to one. // uint32_t addrA = (addressA.GetIPv4AddressCPUOrder() & mask); uint32_t addrB = (addressB.GetIPv4AddressCPUOrder() & mask); // // If the masked off network bits are the same, the two addresses belong // to the same network. // if (addrA == addrB) { QCC_DbgPrintf(("IpNameServiceImpl::SameNetwork(): IPv4 networks are the same")); return true; } else { QCC_DbgPrintf(("IpNameServiceImpl::SameNetwork(): IPv4 networks are different")); return false; } } assert(false && "IpNameServiceImpl::SameNetwork(): Not IPv4 or IPv6?"); return false; } void IpNameServiceImpl::SendOutboundMessageQuietly(Packet packet) { QCC_DbgPrintf(("IpNameServiceImpl::SendOutboundMessageQuietly()")); // // Sending messages quietly is a "new thing" so we don't bother to send // down-version messages quietly since nobody will have a need for them. // uint32_t nsVersion, msgVersion; packet->GetVersion(nsVersion, msgVersion); if (msgVersion == 0) { QCC_DbgPrintf(("IpNameServiceImpl::SendOutboundMessageQuietly(): Down-version message ignored")); return; } // // Keep a record of which interfaces have been already used for sending this message. // for (uint32_t i = 0; i < m_liveInterfaces.size(); ++i) { m_liveInterfaces[i].m_messageSent = false; } // // If we are doing a quiet response, we'd better have a destination address // to use. // assert(packet->DestinationSet() && "IpNameServiceImpl::SendOutboundMessageQuietly(): No destination IP address"); qcc::IPEndpoint destination = packet->GetDestination(); // // We have a destination address for the message which came ultimately from // the recvfrom that received the who-has message that drove the process // that got us here. Someone figured out how to send us this message, and // we already figured out that we have an advertisement that matches that // message, but are we sure that we are allowed to send a response out the // interface specified by the network part of the destination address? // // Well, we have obviously opened the interface over which the message was // received or it would not have been received; so *some* transport has // opened that interface. The question now is, was it the interface that // advertised the name that opened the interface over which we received the // who-has that caused us to respond? It could be that transport A opened // the interface, but transport B advertised the name. the right place to // do this check is up when the name was first received since we may have a // collection of names here and we aren't really sure which one of those // corresponds to the original request, so we simply assume that the right // thing to do was done and we just send the message on out the interface // corresponding to the destination address. // // Now, when higher level code queues up messages for us to send, it doesn't // know to what interfaces we will eventually send the messages, and // therefore what IP addresses we will be need to send as the contact // addresses in the messages. We expect our transport listeners to be // listening to the appropriate INADDR_ANY address, and that they are // relying on us to get the IP addressing information of the various // networks we are talking to correct when we send out address and port // information. What this means is that we are going to have to rewrite the // correct addresses into our is-at messages on the fly as we prepare to // send them out. // // So we need to walk the list of live interfaces and figure out which one // corresponds to the network part of the destination address. // for (uint32_t i = 0; (m_state == IMPL_RUNNING) && (i < m_liveInterfaces.size()); ++i) { QCC_DbgPrintf(("IpNameServiceImpl::SendOutboundMessageQuietly(): Checking out live interface %d. (\"%s\")", i, m_liveInterfaces[i].m_interfaceName.c_str())); // // Don't bother to do anything if the socket FD isn't initialized, since // we most likely couldn't have actually received this message over that // socket (unless we're in a transient state) and so we shouldn't send // it out that interface. // if (m_liveInterfaces[i].m_multicastMDNSsockFd == qcc::INVALID_SOCKET_FD) { QCC_DbgPrintf(("IpNameServiceImpl::SendOutboundMessageQuietly(): Interface %d. is not live", i)); continue; } QCC_DbgPrintf(("IpNameServiceImpl::SendOutboundMessageQuietly(): Interface %d. is live", i)); // // Link-local multicast send is directed based on the interface index and the address family. // If the current index and family are the same as those of an already-handled interface, // there no need to send again here. // bool alreadyHandled = false; for (uint32_t previousIndex = 0; previousIndex < i; ++previousIndex) { if ((m_liveInterfaces[previousIndex].m_index == m_liveInterfaces[i].m_index) && (m_liveInterfaces[previousIndex].m_address.IsIPv6() == m_liveInterfaces[i].m_address.IsIPv6()) && (m_liveInterfaces[previousIndex].m_messageSent)) { alreadyHandled = true; break; } } if (alreadyHandled) { QCC_DbgPrintf(("IpNameServiceImpl::SendOutboundMessageQuietly(): skipping already-handled iface index = %u, IsIPv6 = %u\n", m_liveInterfaces[i].m_index, (uint32_t)m_liveInterfaces[i].m_address.IsIPv6())); continue; } // // We need to start doing cuts to figure out where (not) to send this // message. The easiest cut is on address type. If we have an IPv4 // destination address we quite obviously aren't going to send it out an // interface with an IPv6 address or vice versa. // if ((destination.addr.IsIPv4() && m_liveInterfaces[i].m_address.IsIPv6()) || (destination.addr.IsIPv6() && m_liveInterfaces[i].m_address.IsIPv4())) { QCC_DbgPrintf(("IpNameServiceImpl::SendOutboundMessageQuietly(): Interface %d. is address family mismatched", i)); continue; } // // Now we know we have a destination address which is the same address family // as the current interface address. Now, we need to see if they are on the // same network. // // The interesting tidbit for us now is the network address prefix // length (cf. net mask) that will let us know what part of the // destination address corresponds to the network number and will allow // us to compare destination address network with interface address // network. // uint32_t interfaceAddressPrefixLen = m_liveInterfaces[i].m_prefixlen; if (SameNetwork(interfaceAddressPrefixLen, m_liveInterfaces[i].m_address, destination.addr)) { uint32_t flags = m_liveInterfaces[i].m_flags; // // Okay, we have found the interface that received the who-has message // that started this process. // // When higher level code queues up messages, it doesn't know to // what interfaces and therefore over what source IP addresses we // will be using to send messages out on. What this means is that // we are going to have to rewrite any IP addresses into is-at // messages on the fly as we prepare to send them out. // // The next thing we need to do is to pull out the IP address of the // current interface. It may be either IPv4 or IPv6 -- all we know // now is that it matches the destination. // uint16_t unicastPortv4 = 0; qcc::IPAddress ipv4address; bool haveIPv4address = m_liveInterfaces[i].m_address.IsIPv4(); if (haveIPv4address) { QCC_DbgPrintf(("IpNameServiceImpl::SendOutboundMessageQuietly(): Interface %d. is IPv4", i)); ipv4address = m_liveInterfaces[i].m_address; unicastPortv4 = m_liveInterfaces[i].m_unicastPort; } bool interfaceIsIPv4 = haveIPv4address; qcc::IPAddress ipv6address; bool haveIPv6address = m_liveInterfaces[i].m_address.IsIPv6(); if (haveIPv6address) { QCC_DbgPrintf(("IpNameServiceImpl::SendOutboundMessageQuietly(): Interface %d. is IPv6", i)); ipv6address = m_liveInterfaces[i].m_address; } // // Each interface in our list is going to have either an IPv4 or an IPv6 // address. When we send the message, we want to send out both flavors // (Ipv4 and IPv6) over each interface since we want to maximize the // possibility that clients will actually receive this information // (i.e. we send IPv4 addressing over an IPv6 packet). This is because // the probability to get a name service packet out is actually greater // over IPv6, but TCP transports want to listen on IPv4. We do the // inverse just for consistency and to prepare for when TCP might // actually use IPv6. // // So, if the current address is IPv4, we scan for an IPv6 address on // another interface of the same name. If the current address is IPv6, // we for an IPv4 address. // for (uint32_t j = 0; j < m_liveInterfaces.size(); ++j) { if (m_liveInterfaces[j].m_multicastMDNSsockFd == qcc::INVALID_SOCKET_FD || m_liveInterfaces[j].m_interfaceName != m_liveInterfaces[i].m_interfaceName) { continue; } if (haveIPv4address == false && m_liveInterfaces[j].m_address.IsIPv4()) { QCC_DbgPrintf(("IpNameServiceImpl::SendOutboundMessageQuietly(): Interface %d. has IPv4 counterpart %d.", i, j)); haveIPv4address = true; ipv4address = m_liveInterfaces[j].m_address; unicastPortv4 = m_liveInterfaces[j].m_unicastPort; break; } if (haveIPv6address == false && m_liveInterfaces[j].m_address.IsIPv6()) { QCC_DbgPrintf(("IpNameServiceImpl::SendOutboundMessageQuietly(): Interface %d. has IPv6 counterpart %d.", i, j)); haveIPv6address = true; ipv6address = m_liveInterfaces[j].m_address; break; } } if (!haveIPv4address) { QCC_DbgPrintf(("IpNameServiceImpl::SendOutboundMessageQuietly(): Interface %d does not have an IPv4 address.", i)); continue; } // // Do the version-specific rewriting of the addresses in this NS/MDNS message. // uint16_t reliableTransportPort = 0; uint16_t unreliableTransportPort = 0; if (m_reliableIPv4PortMap[TRANSPORT_INDEX_TCP].find("*") != m_reliableIPv4PortMap[TRANSPORT_INDEX_TCP].end()) { reliableTransportPort = m_reliableIPv4PortMap[TRANSPORT_INDEX_TCP]["*"]; } else if (m_reliableIPv4PortMap[TRANSPORT_INDEX_TCP].find("0.0.0.0") != m_reliableIPv4PortMap[TRANSPORT_INDEX_TCP].end()) { reliableTransportPort = m_reliableIPv4PortMap[TRANSPORT_INDEX_TCP]["0.0.0.0"]; } else if (m_reliableIPv4PortMap[TRANSPORT_INDEX_TCP].find(m_liveInterfaces[i].m_interfaceName) != m_reliableIPv4PortMap[TRANSPORT_INDEX_TCP].end()) { reliableTransportPort = m_reliableIPv4PortMap[TRANSPORT_INDEX_TCP][m_liveInterfaces[i].m_interfaceName]; } else if (m_reliableIPv4PortMap[TRANSPORT_INDEX_TCP].find(m_liveInterfaces[i].m_interfaceAddr.ToString()) != m_reliableIPv4PortMap[TRANSPORT_INDEX_TCP].end()) { reliableTransportPort = m_reliableIPv4PortMap[TRANSPORT_INDEX_TCP][m_liveInterfaces[i].m_interfaceAddr.ToString()]; } if (m_unreliableIPv4PortMap[TRANSPORT_INDEX_UDP].find("*") != m_unreliableIPv4PortMap[TRANSPORT_INDEX_UDP].end()) { unreliableTransportPort = m_unreliableIPv4PortMap[TRANSPORT_INDEX_UDP]["*"]; } else if (m_unreliableIPv4PortMap[TRANSPORT_INDEX_UDP].find("0.0.0.0") != m_unreliableIPv4PortMap[TRANSPORT_INDEX_UDP].end()) { unreliableTransportPort = m_unreliableIPv4PortMap[TRANSPORT_INDEX_UDP]["0.0.0.0"]; } else if (m_unreliableIPv4PortMap[TRANSPORT_INDEX_UDP].find(m_liveInterfaces[i].m_interfaceName) != m_unreliableIPv4PortMap[TRANSPORT_INDEX_UDP].end()) { unreliableTransportPort = m_unreliableIPv4PortMap[TRANSPORT_INDEX_UDP][m_liveInterfaces[i].m_interfaceName]; } else if (m_unreliableIPv4PortMap[TRANSPORT_INDEX_UDP].find(m_liveInterfaces[i].m_interfaceAddr.ToString()) != m_unreliableIPv4PortMap[TRANSPORT_INDEX_UDP].end()) { unreliableTransportPort = m_unreliableIPv4PortMap[TRANSPORT_INDEX_UDP][m_liveInterfaces[i].m_interfaceAddr.ToString()]; } qcc::SocketFd sockFd = qcc::INVALID_SOCKET_FD; /* The socket the outbound message will be sent on. */ if (msgVersion == 0) { sockFd = m_liveInterfaces[i].m_multicastsockFd; NSPacket nsPacket = NSPacket::cast(packet); if (nsPacket->GetNumberAnswers() && !reliableTransportPort) { continue; } } else if (msgVersion == 1) { sockFd = m_liveInterfaces[i].m_multicastsockFd; NSPacket nsPacket = NSPacket::cast(packet); if (nsPacket->GetNumberAnswers() && !reliableTransportPort && !unreliableTransportPort) { continue; } } else { MDNSPacket mdnsPacket = MDNSPacket::cast(packet); if (mdnsPacket->GetHeader().GetQRType() == MDNSHeader::MDNS_RESPONSE) { /* * Unlike v0 and v1 messages, v2 messages may be sent from * either the multicast or unicast port. To prevent * firewalls from dropping responses, we want to send from * the port we received on. */ if (mdnsPacket->GetSource().port == MULTICAST_MDNS_PORT) { sockFd = m_liveInterfaces[i].m_multicastMDNSsockFd; } else { sockFd = m_ipv4UnicastSockFd; } MDNSResourceRecord* ptrRecordTcp = NULL; MDNSResourceRecord* ptrRecordUdp = NULL; bool tcpAnswer = mdnsPacket->GetAnswer("_alljoyn._tcp.local.", MDNSResourceRecord::PTR, &ptrRecordTcp); bool udpAnswer = mdnsPacket->GetAnswer("_alljoyn._udp.local.", MDNSResourceRecord::PTR, &ptrRecordUdp); if (!tcpAnswer && !udpAnswer) { continue; } if (tcpAnswer && !udpAnswer) { if (!reliableTransportPort) { continue; } uint32_t numMatches = mdnsPacket->GetNumMatches("advertise.*", MDNSResourceRecord::TXT, MDNSTextRData::TXTVERS); for (uint32_t match = 0; match < numMatches; match++) { MDNSResourceRecord* advRecord; if (!mdnsPacket->GetAdditionalRecordAt("advertise.*", MDNSResourceRecord::TXT, MDNSTextRData::TXTVERS, match, &advRecord)) { continue; } MDNSAdvertiseRData* advRData = static_cast(advRecord->GetRData()); if (!advRData) { continue; } std::list tcpNames; uint32_t numTcp = advRData->GetNumNames(TRANSPORT_TCP); uint32_t numUdp = advRData->GetNumNames(TRANSPORT_UDP); uint32_t numTcpUdp = advRData->GetNumNames(TRANSPORT_TCP | TRANSPORT_UDP); if (!numUdp && !numTcpUdp) { continue; } for (uint32_t j = 0; j < numTcp; j++) { String name = advRData->GetNameAt(TRANSPORT_TCP, j); tcpNames.push_back(name); } for (uint32_t j = 0; j < numTcpUdp; j++) { String name = advRData->GetNameAt(TRANSPORT_TCP | TRANSPORT_UDP, j); tcpNames.push_back(name); } advRData->Reset(); advRData->SetTransport(TRANSPORT_TCP); for (std::list::iterator iter = tcpNames.begin(); iter != tcpNames.end(); iter++) { advRData->SetValue("name", *iter); } } } if (udpAnswer && !tcpAnswer) { if (!unreliableTransportPort) { continue; } uint32_t numMatches = mdnsPacket->GetNumMatches("advertise.*", MDNSResourceRecord::TXT, MDNSTextRData::TXTVERS); for (uint32_t match = 0; match < numMatches; match++) { MDNSResourceRecord* advRecord; if (!mdnsPacket->GetAdditionalRecordAt("advertise.*", MDNSResourceRecord::TXT, MDNSTextRData::TXTVERS, match, &advRecord)) { continue; } MDNSAdvertiseRData* advRData = static_cast(advRecord->GetRData()); if (!advRData) { continue; } std::list udpNames; uint32_t numTcp = advRData->GetNumNames(TRANSPORT_TCP); uint32_t numUdp = advRData->GetNumNames(TRANSPORT_UDP); uint32_t numTcpUdp = advRData->GetNumNames(TRANSPORT_TCP | TRANSPORT_UDP); if (!numTcp && !numTcpUdp) { continue; } for (uint32_t j = 0; j < numUdp; j++) { String name = advRData->GetNameAt(TRANSPORT_UDP, j); udpNames.push_back(name); } for (uint32_t j = 0; j < numTcpUdp; j++) { String name = advRData->GetNameAt(TRANSPORT_TCP | TRANSPORT_UDP, j); udpNames.push_back(name); } advRData->Reset(); advRData->SetTransport(TRANSPORT_UDP); for (std::list::iterator iter = udpNames.begin(); iter != udpNames.end(); iter++) { advRData->SetValue("name", *iter); } } } if (tcpAnswer && udpAnswer) { if (!reliableTransportPort && !unreliableTransportPort) { continue; } else if (!reliableTransportPort) { MDNSPtrRData* ptrRData = static_cast(ptrRecordTcp->GetRData()); String name = ptrRData->GetPtrDName(); mdnsPacket->RemoveAnswer(name, MDNSResourceRecord::SRV); mdnsPacket->RemoveAnswer(name, MDNSResourceRecord::TXT); mdnsPacket->RemoveAnswer("_alljoyn._tcp.local.", MDNSResourceRecord::PTR); uint32_t numMatches = mdnsPacket->GetNumMatches("advertise.*", MDNSResourceRecord::TXT, MDNSTextRData::TXTVERS); for (uint32_t match = 0; match < numMatches; match++) { MDNSResourceRecord* advRecord; if (!mdnsPacket->GetAdditionalRecordAt("advertise.*", MDNSResourceRecord::TXT, MDNSTextRData::TXTVERS, match, &advRecord)) { continue; } MDNSAdvertiseRData* advRData = static_cast(advRecord->GetRData()); if (!advRData) { continue; } std::list udpNames; uint32_t numUdp = advRData->GetNumNames(TRANSPORT_UDP); uint32_t numTcpUdp = advRData->GetNumNames(TRANSPORT_TCP | TRANSPORT_UDP); for (uint32_t j = 0; j < numUdp; j++) { String name = advRData->GetNameAt(TRANSPORT_UDP, j); udpNames.push_back(name); } for (uint32_t j = 0; j < numTcpUdp; j++) { String name = advRData->GetNameAt(TRANSPORT_TCP | TRANSPORT_UDP, j); udpNames.push_back(name); } advRData->Reset(); advRData->SetTransport(TRANSPORT_UDP); for (std::list::iterator iter = udpNames.begin(); iter != udpNames.end(); iter++) { advRData->SetValue("name", *iter); } } } else if (!unreliableTransportPort) { MDNSPtrRData* ptrRData = static_cast(ptrRecordUdp->GetRData()); String name = ptrRData->GetPtrDName(); mdnsPacket->RemoveAnswer(name, MDNSResourceRecord::SRV); mdnsPacket->RemoveAnswer(name, MDNSResourceRecord::TXT); mdnsPacket->RemoveAnswer("_alljoyn._udp.local.", MDNSResourceRecord::PTR); MDNSResourceRecord* advRecord; uint32_t numMatches = mdnsPacket->GetNumMatches("advertise.*", MDNSResourceRecord::TXT, MDNSTextRData::TXTVERS); for (uint32_t match = 0; match < numMatches; match++) { if (!mdnsPacket->GetAdditionalRecordAt("advertise.*", MDNSResourceRecord::TXT, MDNSTextRData::TXTVERS, match, &advRecord)) { continue; } MDNSAdvertiseRData* advRData = static_cast(advRecord->GetRData()); if (!advRData) { continue; } std::list tcpNames; uint32_t numTcp = advRData->GetNumNames(TRANSPORT_TCP); uint32_t numTcpUdp = advRData->GetNumNames(TRANSPORT_TCP | TRANSPORT_UDP); for (uint32_t j = 0; j < numTcp; j++) { String name = advRData->GetNameAt(TRANSPORT_TCP, j); tcpNames.push_back(name); } for (uint32_t j = 0; j < numTcpUdp; j++) { String name = advRData->GetNameAt(TRANSPORT_TCP | TRANSPORT_UDP, j); tcpNames.push_back(name); } advRData->Reset(); advRData->SetTransport(TRANSPORT_TCP); for (std::list::iterator iter = tcpNames.begin(); iter != tcpNames.end(); iter++) { advRData->SetValue("name", *iter); } } } } } else { /* * Send the message from the port we are expecting to * receive (unicast) replies on. */ sockFd = m_ipv4UnicastSockFd; MDNSQuestion* questionUdp; MDNSQuestion* questionTcp; bool tcpQuestion = mdnsPacket->GetQuestion("_alljoyn._tcp.local.", &questionTcp); bool udpQuestion = mdnsPacket->GetQuestion("_alljoyn._udp.local.", &questionUdp); bool reliableTransportAllowed = (reliableTransportPort != 0); bool unreliableTransportAllowed = (unreliableTransportPort != 0); if (tcpQuestion && udpQuestion) { if (!reliableTransportAllowed) { mdnsPacket->RemoveQuestion("_alljoyn._tcp.local."); } else if (!unreliableTransportAllowed) { mdnsPacket->RemoveQuestion("_alljoyn._udp.local."); } } } } QCC_DbgPrintf(("IpNameServiceImpl::SendOutboundMessageQuietly(): Rewrite NS/MDNS packet %p", &(*packet))); RewriteVersionSpecific(msgVersion, packet, haveIPv4address, ipv4address, haveIPv6address, ipv6address, unicastPortv4, m_liveInterfaces[i].m_interfaceName, reliableTransportPort, unreliableTransportPort); // // Send the protocol message described by the header, containing rewritten is-at messages. // if (sockFd != qcc::INVALID_SOCKET_FD) { QCC_DbgPrintf(("IpNameServiceImpl::SendOutboundMessageQuietly(): SendProtocolMessage()")); SendProtocolMessage(sockFd, ipv4address, interfaceAddressPrefixLen, flags, interfaceIsIPv4, packet, i); m_liveInterfaces[i].m_messageSent = true; } } } } void IpNameServiceImpl::SendOutboundMessageActively(Packet packet, const qcc::IPAddress& localAddress) { QCC_DbgPrintf(("IpNameServiceImpl::SendOutboundMessageActively()")); // // Make a note of what version this message is on, since there is a // difference in what information is there that will need to be passed down // in order to rewrite the addresses (see below). // uint32_t nsVersion, msgVersion; packet->GetVersion(nsVersion, msgVersion); // // Keep a record of which interfaces have been already used for sending this message. // for (uint32_t i = 0; i < m_liveInterfaces.size(); ++i) { m_liveInterfaces[i].m_messageSent = false; } // // We walk the list of live interfaces looking for those with IPv4 or IPv6 // addresses, rewrite the messages as required for those interfaces and send // them out if they have been enabled. // QCC_DbgPrintf(("IpNameServiceImpl::SendOutboundMessageActively(): Walk interfaces")); bool removedUdp = false; bool removedTcp = false; std::list removedTcpAnswers; std::list removedUdpAnswers; std::list removedTcpQuestions; std::list removedUdpQuestions; std::map > tcpNames; std::map > udpNames; std::map > tcpUdpNames; for (uint32_t i = 0; (m_state == IMPL_RUNNING || m_terminal) && (i < m_liveInterfaces.size()); ++i) { if (packet->InterfaceIndexSet()) { if (m_liveInterfaces[i].m_index != packet->GetInterfaceIndex()) { continue; } if (packet->AddressFamilySet()) { if (m_liveInterfaces[i].m_address.GetAddressFamily() != packet->GetAddressFamily()) { continue; } } } QCC_DbgPrintf(("IpNameServiceImpl::SendOutboundMessageActively(): Checking out live interface %d. (\"%s\")", i, m_liveInterfaces[i].m_interfaceName.c_str())); // // Don't bother to do anything if the socket FD isn't initialized, since // we wouldn't be able to send anyway. // if (m_liveInterfaces[i].m_multicastMDNSsockFd == qcc::INVALID_SOCKET_FD) { QCC_DbgPrintf(("IpNameServiceImpl::SendOutboundMessageActively(): Interface %d. is not live", i)); continue; } QCC_DbgPrintf(("IpNameServiceImpl::SendOutboundMessageActively(): Interface %d. is live", i)); // // Link-local multicast send is directed based on the interface index and the address family. // If the current index and family are the same as those of an already-handled interface, there // is no need to send again here. // bool alreadyHandled = false; for (uint32_t previousIndex = 0; previousIndex < i; ++previousIndex) { if ((m_liveInterfaces[previousIndex].m_index == m_liveInterfaces[i].m_index) && (m_liveInterfaces[previousIndex].m_address.IsIPv6() == m_liveInterfaces[i].m_address.IsIPv6()) && (m_liveInterfaces[previousIndex].m_messageSent)) { alreadyHandled = true; break; } } if (alreadyHandled) { QCC_DbgPrintf(("IpNameServiceImpl::SendOutboundMessageActively(): skipping already-handled iface index = %u, IsIPv6 = %u\n", m_liveInterfaces[i].m_index, (uint32_t)m_liveInterfaces[i].m_address.IsIPv6())); continue; } // // We have a candidate interface to send the message out on. The // question is whether or not the current interface as indicated by the // interface name is on the list of requested interfaces for the // transport mask found in the message. If it is not, we must not send // this message out the current interface. // // The requested interfaces are stored on a per-transport basis. Each // transport can open a different list of interfaces, and these lists // are selected by the which is derived from the // transport mask passed to the originating advertisement or discovery // operation. The transport mask comes to us in the questions and // answers stored in the message (header). // // To keep things at least slightly simpler, if any of the questions or // answers in our message have a transport mask that refers to a // transport that, in turn, has either a wildcard or the current // specific interface opened, we approve this interface as one to which // the message can be sent. // // We have to be careful about sending messages from transports that // open a wildcard interface as well. Wildcard means all interfaces, // but all interfaces really means all except for "special use" // interfaces like Wi-Fi Direct interfaces on Android. We don't know // what interfaces are actually in use by the Wi-Fi Direct subsystem but // it does seem that any P2P-based interface will begin with the string // "p2p" as in "p2p0" or "p2p-p2p0-0". // bool interfaceApproved = false; if (msgVersion <= 1) { NSPacket nsPacket = NSPacket::cast(packet); // // Do we have any questions that need to go out on this interface? // for (uint8_t j = 0; j < nsPacket->GetNumberQuestions(); ++j) { WhoHas* whoHas; nsPacket->GetQuestion(j, &whoHas); // // Get the transport mask referred to by the current question (who-has) // and convert the mask into an index into the per-transport data. // TransportMask transportMask = whoHas->GetTransportMask(); assert(transportMask != TRANSPORT_NONE && "IpNameServiceImpl::SendOutboundMessageActively(): TransportMask must always be set"); uint32_t transportIndex = IndexFromBit(transportMask); assert(transportIndex < 16 && "IpNameServiceImpl::SendOutboundMessageActively(): Bad transport index"); if (transportIndex >= 16) { return; } // // If this interface is requested as an outbound interface for this // transport, we approve sending it over that interface. // if (InterfaceRequested(transportIndex, i)) { interfaceApproved = true; break; } } // // Do we have any answers that need to go out on this interface? // for (uint8_t j = 0; j < nsPacket->GetNumberAnswers(); ++j) { IsAt* isAt; nsPacket->GetAnswer(j, &isAt); TransportMask transportMask = isAt->GetTransportMask(); assert(transportMask != TRANSPORT_NONE && "IpNameServiceImpl::SendOutboundMessageActively(): TransportMask must always be set"); uint32_t transportIndex = IndexFromBit(transportMask); assert(transportIndex < 16 && "IpNameServiceImpl::SendOutboundMessageActively(): Bad transport index"); if (transportIndex >= 16) { return; } // // If this interface is requested as an outbound interface for this // transport, we approve sending it over that interface. // if (InterfaceRequested(transportIndex, i)) { interfaceApproved = true; break; } } } else { //version two MDNSPacket mdnspacket = MDNSPacket::cast(packet); MDNSResourceRecord* answer; if (mdnspacket->GetHeader().GetQRType() == MDNSHeader::MDNS_QUERY) { MDNSQuestion* question; if (mdnspacket->GetQuestion("_alljoyn._tcp.local.", &question)) { // // If this interface is requested as an outbound interface for this // transport, we approve sending it over that interface. // if (InterfaceRequested(TRANSPORT_INDEX_TCP, i)) { interfaceApproved = true; } } if (mdnspacket->GetQuestion("_alljoyn._udp.local.", &question)) { // // If this interface is requested as an outbound interface for this // transport, we approve sending it over that interface. // if (InterfaceRequested(TRANSPORT_INDEX_UDP, i)) { interfaceApproved = true; } } } else { if (mdnspacket->GetAnswer("_alljoyn._tcp.local.", MDNSResourceRecord::PTR, &answer)) { // // If this interface is requested as an outbound interface for this // transport, we approve sending it over that interface. // if (InterfaceRequested(TRANSPORT_INDEX_TCP, i)) { interfaceApproved = true; } } if (mdnspacket->GetAnswer("_alljoyn._udp.local.", MDNSResourceRecord::PTR, &answer)) { // // If this interface is requested as an outbound interface for this // transport, we approve sending it over that interface. // if (InterfaceRequested(TRANSPORT_INDEX_UDP, i)) { interfaceApproved = true; } } } } // // If no questions nor answers of our message need to go out, then we // don't do anything on this interface. // if (interfaceApproved == false) { QCC_DbgPrintf(("IpNameServiceImpl::SendOutboundMessageActively(): No questions or answers for this interface")); continue; } // // When higher level code queues up messages, it doesn't know to what // interfaces and therefore over what source IP addresses we will be // using to send messages out on. We expect our transport listeners to // be listening to the appropriate INADDR_ANY address, and that they are // relying on us to get the IP addressing information of the various // networks we are talking to correct when we send out address and port // information. What this means is that we are going to rewrite any IP // addresses into is-at messages on the fly as we prepare to send them // out our sundry interfaces. who-has messages don't include any source // addresses, so we can leave them as-is. // // The next thing we need to do is to pull out the IP address of the // current interface. It may be either IPv4 or IPv6. // qcc::IPAddress ipv4address; uint16_t unicastPortv4 = 0; bool haveIPv4address = m_liveInterfaces[i].m_address.IsIPv4(); if (haveIPv4address) { ipv4address = m_liveInterfaces[i].m_address; unicastPortv4 = m_liveInterfaces[i].m_unicastPort; QCC_DbgPrintf(("IpNameServiceImpl::SendOutboundMessageActively(): Interface %d. is IPv4", i)); } bool interfaceIsIPv4 = haveIPv4address; qcc::IPAddress ipv6address; bool haveIPv6address = m_liveInterfaces[i].m_address.IsIPv6(); if (haveIPv6address) { ipv6address = m_liveInterfaces[i].m_address; QCC_DbgPrintf(("IpNameServiceImpl::SendOutboundMessageActively(): Interface %d. is IPv6", i)); } // // While we're here pulling out IP addresses, take the time to get the // network address prefix length (cf. net mask) and flags for the // interface. We'll need to pass them on down to the method that does // the sending so it can figure out subnet directed broadcast addresses // if it needs to. // uint32_t interfaceAddressPrefixLen = m_liveInterfaces[i].m_prefixlen; uint32_t flags = m_liveInterfaces[i].m_flags; // // Each interface in our list is going to have either an IPv4 or an IPv6 // address. When we send the message, we want to send out both flavors // (Ipv4 and IPv6) over each interface since we want to maximize the // possibility that clients will actually receive this information // (i.e. we send IPv4 addressing over an IPv6 packet). This is because // the probability to get a name service packet out is actually greater // over IPv6, but TCP transports want to listen on IPv4. We do the // inverse just for consistency and to prepare for when TCP might // actually use IPv6. // // So, if the current address is IPv4, we scan for an IPv6 address on // another interface of the same name. If the current address is IPv6, // we for an IPv4 address. // for (uint32_t j = 0; j < m_liveInterfaces.size(); ++j) { if (m_liveInterfaces[j].m_multicastMDNSsockFd == qcc::INVALID_SOCKET_FD || m_liveInterfaces[j].m_interfaceName != m_liveInterfaces[i].m_interfaceName) { continue; } if (haveIPv4address == false && m_liveInterfaces[j].m_address.IsIPv4()) { QCC_DbgPrintf(("IpNameServiceImpl::SendOutboundMessageActively(): Interface %d. has IPv4 counterpart %d.", i, j)); haveIPv4address = true; ipv4address = m_liveInterfaces[j].m_address; unicastPortv4 = m_liveInterfaces[j].m_unicastPort; break; } if (haveIPv6address == false && m_liveInterfaces[j].m_address.IsIPv6()) { QCC_DbgPrintf(("IpNameServiceImpl::SendOutboundMessageActively(): Interface %d. has IPv6 counterpart %d.", i, j)); haveIPv6address = true; ipv6address = m_liveInterfaces[j].m_address; break; } } if (!haveIPv4address) { QCC_DbgPrintf(("IpNameServiceImpl::SendOutboundMessageActively(): Interface %d does not have an IPv4 address.", i)); continue; } // // At this point, we are ready to multicast out an interface and we know // both of our IPv4 and IPv6 addresses if they exist. Now, we have to // walk the list of answer (is-at) messages and rewrite the provided addresses // that will correspond to the interface we are sending the message out // of. Recall that until this point, nobody knew the addresses that the // message was going out over. Question (who-has) messages don't have any // address information so we don't have to touch them. // // // Do the version-specific rewriting of the addresses in this NS/MDNS packet. // uint16_t reliableTransportPort = 0; uint16_t unreliableTransportPort = 0; if (m_reliableIPv4PortMap[TRANSPORT_INDEX_TCP].find("*") != m_reliableIPv4PortMap[TRANSPORT_INDEX_TCP].end()) { reliableTransportPort = m_reliableIPv4PortMap[TRANSPORT_INDEX_TCP]["*"]; } else if (m_reliableIPv4PortMap[TRANSPORT_INDEX_TCP].find("0.0.0.0") != m_reliableIPv4PortMap[TRANSPORT_INDEX_TCP].end()) { reliableTransportPort = m_reliableIPv4PortMap[TRANSPORT_INDEX_TCP]["0.0.0.0"]; } else if (m_reliableIPv4PortMap[TRANSPORT_INDEX_TCP].find(m_liveInterfaces[i].m_interfaceName) != m_reliableIPv4PortMap[TRANSPORT_INDEX_TCP].end()) { reliableTransportPort = m_reliableIPv4PortMap[TRANSPORT_INDEX_TCP][m_liveInterfaces[i].m_interfaceName]; } else if (m_reliableIPv4PortMap[TRANSPORT_INDEX_TCP].find(m_liveInterfaces[i].m_interfaceAddr.ToString()) != m_reliableIPv4PortMap[TRANSPORT_INDEX_TCP].end()) { reliableTransportPort = m_reliableIPv4PortMap[TRANSPORT_INDEX_TCP][m_liveInterfaces[i].m_interfaceAddr.ToString()]; } if (m_unreliableIPv4PortMap[TRANSPORT_INDEX_UDP].find("*") != m_unreliableIPv4PortMap[TRANSPORT_INDEX_UDP].end()) { unreliableTransportPort = m_unreliableIPv4PortMap[TRANSPORT_INDEX_UDP]["*"]; } else if (m_unreliableIPv4PortMap[TRANSPORT_INDEX_UDP].find("0.0.0.0") != m_unreliableIPv4PortMap[TRANSPORT_INDEX_UDP].end()) { unreliableTransportPort = m_unreliableIPv4PortMap[TRANSPORT_INDEX_UDP]["0.0.0.0"]; } else if (m_unreliableIPv4PortMap[TRANSPORT_INDEX_UDP].find(m_liveInterfaces[i].m_interfaceName) != m_unreliableIPv4PortMap[TRANSPORT_INDEX_UDP].end()) { unreliableTransportPort = m_unreliableIPv4PortMap[TRANSPORT_INDEX_UDP][m_liveInterfaces[i].m_interfaceName]; } else if (m_unreliableIPv4PortMap[TRANSPORT_INDEX_UDP].find(m_liveInterfaces[i].m_interfaceAddr.ToString()) != m_unreliableIPv4PortMap[TRANSPORT_INDEX_UDP].end()) { unreliableTransportPort = m_unreliableIPv4PortMap[TRANSPORT_INDEX_UDP][m_liveInterfaces[i].m_interfaceAddr.ToString()]; } bool ttlZero = false; if (msgVersion == 0) { NSPacket nsPacket = NSPacket::cast(packet); if (nsPacket->GetNumberAnswers() && !reliableTransportPort) { continue; } } else if (msgVersion == 1) { NSPacket nsPacket = NSPacket::cast(packet); if (nsPacket->GetNumberAnswers() && !reliableTransportPort && !unreliableTransportPort) { continue; } } else { MDNSPacket mdnsPacket = MDNSPacket::cast(packet); if (mdnsPacket->GetHeader().GetQRType() == MDNSHeader::MDNS_RESPONSE) { MDNSResourceRecord* ptrRecordTcp = NULL; MDNSResourceRecord* ptrRecordUdp = NULL; bool tcpAnswer = mdnsPacket->GetAnswer("_alljoyn._tcp.local.", MDNSResourceRecord::PTR, &ptrRecordTcp); bool udpAnswer = mdnsPacket->GetAnswer("_alljoyn._udp.local.", MDNSResourceRecord::PTR, &ptrRecordUdp); uint32_t numMatches = mdnsPacket->GetNumMatches("advertise.*", MDNSResourceRecord::TXT, MDNSTextRData::TXTVERS); for (uint32_t match = 0; match < numMatches; match++) { MDNSResourceRecord* advRecord; if (!mdnsPacket->GetAdditionalRecordAt("advertise.*", MDNSResourceRecord::TXT, MDNSTextRData::TXTVERS, match, &advRecord)) { continue; } uint32_t ttl = advRecord->GetRRttl(); if (!ttl) { ttlZero = true; } } if (!tcpAnswer && !udpAnswer) { continue; } if (tcpAnswer && !udpAnswer) { if (!reliableTransportPort && !ttlZero) { continue; } } if (udpAnswer && !tcpAnswer) { if (!unreliableTransportPort && !ttlZero) { continue; } } if (tcpAnswer && udpAnswer) { if (!reliableTransportPort && !unreliableTransportPort && !ttlZero) { continue; } else if (!reliableTransportPort) { uint32_t numMatches = mdnsPacket->GetNumMatches("advertise.*", MDNSResourceRecord::TXT, MDNSTextRData::TXTVERS); for (uint32_t match = 0; match < numMatches; match++) { MDNSResourceRecord* advRecord; if (!mdnsPacket->GetAdditionalRecordAt("advertise.*", MDNSResourceRecord::TXT, MDNSTextRData::TXTVERS, match, &advRecord)) { continue; } MDNSAdvertiseRData* advRData = static_cast(advRecord->GetRData()); if (!advRData) { continue; } if (!advRecord->GetRRttl()) { continue; } uint32_t numNames = advRData->GetNumNames(TRANSPORT_TCP); for (uint32_t j = 0; j < numNames; j++) { String name = advRData->GetNameAt(TRANSPORT_TCP, j); tcpNames[match].push_back(name); } numNames = advRData->GetNumNames(TRANSPORT_UDP); for (uint32_t j = 0; j < numNames; j++) { String name = advRData->GetNameAt(TRANSPORT_UDP, j); udpNames[match].push_back(name); } numNames = advRData->GetNumNames(TRANSPORT_TCP | TRANSPORT_UDP); for (uint32_t j = 0; j < numNames; j++) { String name = advRData->GetNameAt(TRANSPORT_TCP | TRANSPORT_UDP, j); tcpUdpNames[match].push_back(name); } advRData->Reset(); advRData->SetTransport(TRANSPORT_UDP); if (udpNames.find(match) != udpNames.end()) { for (std::list::iterator iter = udpNames[match].begin(); iter != udpNames[match].end(); iter++) { advRData->SetValue("name", *iter); } } if (tcpUdpNames.find(match) != tcpUdpNames.end()) { for (std::list::iterator iter = tcpUdpNames[match].begin(); iter != tcpUdpNames[match].end(); iter++) { advRData->SetValue("name", *iter); } } if (packet->InterfaceIndexSet()) { tcpNames.erase(match); udpNames.erase(match); tcpUdpNames.erase(match); } } if (!ttlZero) { removedTcp = true; MDNSPtrRData* ptrRData = static_cast(ptrRecordTcp->GetRData()); String name = ptrRData->GetPtrDName(); if (!packet->InterfaceIndexSet()) { MDNSResourceRecord* record; if (mdnsPacket->GetAnswer(name, MDNSResourceRecord::SRV, &record)) { removedTcpAnswers.push_back(*record); } if (mdnsPacket->GetAnswer(name, MDNSResourceRecord::TXT, &record)) { removedTcpAnswers.push_back(*record); } } removedTcpAnswers.push_back(*ptrRecordTcp); mdnsPacket->RemoveAnswer(name, MDNSResourceRecord::SRV); mdnsPacket->RemoveAnswer(name, MDNSResourceRecord::TXT); mdnsPacket->RemoveAnswer("_alljoyn._tcp.local.", MDNSResourceRecord::PTR); } } else if (!unreliableTransportPort) { MDNSResourceRecord* advRecord; uint32_t numMatches = mdnsPacket->GetNumMatches("advertise.*", MDNSResourceRecord::TXT, MDNSTextRData::TXTVERS); for (uint32_t match = 0; match < numMatches; match++) { if (!mdnsPacket->GetAdditionalRecordAt("advertise.*", MDNSResourceRecord::TXT, MDNSTextRData::TXTVERS, match, &advRecord)) { continue; } MDNSAdvertiseRData* advRData = static_cast(advRecord->GetRData()); if (!advRData) { continue; } if (!advRecord->GetRRttl()) { continue; } uint32_t numNames = advRData->GetNumNames(TRANSPORT_TCP); for (uint32_t j = 0; j < numNames; j++) { String name = advRData->GetNameAt(TRANSPORT_TCP, j); tcpNames[match].push_back(name); } numNames = advRData->GetNumNames(TRANSPORT_UDP); for (uint32_t j = 0; j < numNames; j++) { String name = advRData->GetNameAt(TRANSPORT_UDP, j); udpNames[match].push_back(name); } numNames = advRData->GetNumNames(TRANSPORT_TCP | TRANSPORT_UDP); for (uint32_t j = 0; j < numNames; j++) { String name = advRData->GetNameAt(TRANSPORT_TCP | TRANSPORT_UDP, j); tcpUdpNames[match].push_back(name); } advRData->Reset(); advRData->SetTransport(TRANSPORT_TCP); if (tcpNames.find(match) != tcpNames.end()) { for (std::list::iterator iter = tcpNames[match].begin(); iter != tcpNames[match].end(); iter++) { advRData->SetValue("name", *iter); } } if (tcpUdpNames.find(match) != tcpUdpNames.end()) { for (std::list::iterator iter = tcpUdpNames[match].begin(); iter != tcpUdpNames[match].end(); iter++) { advRData->SetValue("name", *iter); } } if (packet->InterfaceIndexSet()) { tcpNames.erase(match); udpNames.erase(match); tcpUdpNames.erase(match); } } if (!ttlZero) { removedUdp = true; MDNSPtrRData* ptrRData = static_cast(ptrRecordUdp->GetRData()); String name = ptrRData->GetPtrDName(); if (!packet->InterfaceIndexSet()) { MDNSResourceRecord* record; if (mdnsPacket->GetAnswer(name, MDNSResourceRecord::SRV, &record)) { removedUdpAnswers.push_back(*record); } if (mdnsPacket->GetAnswer(name, MDNSResourceRecord::TXT, &record)) { removedUdpAnswers.push_back(*record); } } removedUdpAnswers.push_back(*ptrRecordUdp); mdnsPacket->RemoveAnswer(name, MDNSResourceRecord::SRV); mdnsPacket->RemoveAnswer(name, MDNSResourceRecord::TXT); mdnsPacket->RemoveAnswer("_alljoyn._udp.local.", MDNSResourceRecord::PTR); } } } } else { MDNSQuestion* questionUdp; MDNSQuestion* questionTcp; bool tcpQuestion = mdnsPacket->GetQuestion("_alljoyn._tcp.local.", &questionTcp); bool udpQuestion = mdnsPacket->GetQuestion("_alljoyn._udp.local.", &questionUdp); bool reliableTransportAllowed = (reliableTransportPort != 0); bool unreliableTransportAllowed = (unreliableTransportPort != 0); if (tcpQuestion && udpQuestion) { if (!reliableTransportAllowed) { removedTcp = true; if (!packet->InterfaceIndexSet()) { removedTcpQuestions.push_back(*questionTcp); } mdnsPacket->RemoveQuestion("_alljoyn._tcp.local."); } else if (!unreliableTransportAllowed) { removedUdp = true; if (!packet->InterfaceIndexSet()) { removedUdpQuestions.push_back(*questionUdp); } mdnsPacket->RemoveQuestion("_alljoyn._udp.local."); } } } } if (ttlZero && !reliableTransportPort) { if (m_priorReliableIPv4PortMap[TRANSPORT_INDEX_TCP].find("*") != m_priorReliableIPv4PortMap[TRANSPORT_INDEX_TCP].end()) { reliableTransportPort = m_priorReliableIPv4PortMap[TRANSPORT_INDEX_TCP]["*"]; } else if (m_priorReliableIPv4PortMap[TRANSPORT_INDEX_TCP].find("0.0.0.0") != m_priorReliableIPv4PortMap[TRANSPORT_INDEX_TCP].end()) { reliableTransportPort = m_priorReliableIPv4PortMap[TRANSPORT_INDEX_TCP]["0.0.0.0"]; } else if (m_priorReliableIPv4PortMap[TRANSPORT_INDEX_TCP].find(m_liveInterfaces[i].m_interfaceName) != m_priorReliableIPv4PortMap[TRANSPORT_INDEX_TCP].end()) { reliableTransportPort = m_priorReliableIPv4PortMap[TRANSPORT_INDEX_TCP][m_liveInterfaces[i].m_interfaceName]; } else if (m_priorReliableIPv4PortMap[TRANSPORT_INDEX_TCP].find(m_liveInterfaces[i].m_interfaceAddr.ToString()) != m_priorReliableIPv4PortMap[TRANSPORT_INDEX_TCP].end()) { reliableTransportPort = m_priorReliableIPv4PortMap[TRANSPORT_INDEX_TCP][m_liveInterfaces[i].m_interfaceAddr.ToString()]; } } if (ttlZero && !unreliableTransportPort) { if (m_priorUnreliableIPv4PortMap[TRANSPORT_INDEX_UDP].find("*") != m_priorUnreliableIPv4PortMap[TRANSPORT_INDEX_UDP].end()) { unreliableTransportPort = m_priorUnreliableIPv4PortMap[TRANSPORT_INDEX_UDP]["*"]; } else if (m_priorUnreliableIPv4PortMap[TRANSPORT_INDEX_UDP].find("0.0.0.0") != m_priorUnreliableIPv4PortMap[TRANSPORT_INDEX_UDP].end()) { unreliableTransportPort = m_priorUnreliableIPv4PortMap[TRANSPORT_INDEX_UDP]["0.0.0.0"]; } else if (m_priorUnreliableIPv4PortMap[TRANSPORT_INDEX_UDP].find(m_liveInterfaces[i].m_interfaceName) != m_priorUnreliableIPv4PortMap[TRANSPORT_INDEX_UDP].end()) { unreliableTransportPort = m_priorUnreliableIPv4PortMap[TRANSPORT_INDEX_UDP][m_liveInterfaces[i].m_interfaceName]; } else if (m_priorUnreliableIPv4PortMap[TRANSPORT_INDEX_UDP].find(m_liveInterfaces[i].m_interfaceAddr.ToString()) != m_priorUnreliableIPv4PortMap[TRANSPORT_INDEX_UDP].end()) { unreliableTransportPort = m_priorUnreliableIPv4PortMap[TRANSPORT_INDEX_UDP][m_liveInterfaces[i].m_interfaceAddr.ToString()]; } } if (!reliableTransportPort && !unreliableTransportPort) { continue; } // // Do the version-specific rewriting of the addresses/ports in this NS/MDNS packet. // QCC_DbgPrintf(("IpNameServiceImpl::SendOutboundMessageActively(): Rewrite NS/MDNS packet %p", &(*packet))); RewriteVersionSpecific(msgVersion, packet, haveIPv4address, ipv4address, haveIPv6address, ipv6address, unicastPortv4, m_liveInterfaces[i].m_interfaceName, reliableTransportPort, unreliableTransportPort); // // Send the protocol message described by the header, containing rewritten is-at messages. // if (msgVersion == 2) { QCC_DbgPrintf(("IpNameServiceImpl::SendOutboundMessageActively(): SendProtocolMessage()")); SendProtocolMessage(m_liveInterfaces[i].m_multicastMDNSsockFd, ipv4address, interfaceAddressPrefixLen, flags, interfaceIsIPv4, packet, i, localAddress); m_liveInterfaces[i].m_messageSent = true; } else if (m_liveInterfaces[i].m_multicastsockFd != qcc::INVALID_SOCKET_FD) { QCC_DbgPrintf(("IpNameServiceImpl::SendOutboundMessageActively(): SendProtocolMessage()")); SendProtocolMessage(m_liveInterfaces[i].m_multicastsockFd, ipv4address, interfaceAddressPrefixLen, flags, interfaceIsIPv4, packet, i, localAddress); m_liveInterfaces[i].m_messageSent = true; } if (removedTcp) { MDNSPacket mdnsPacket = MDNSPacket::cast(packet); for (std::list::const_iterator it = removedTcpAnswers.begin(); it != removedTcpAnswers.end(); it++) { mdnsPacket->AddAnswer(*it); } for (std::list::const_iterator it = removedTcpQuestions.begin(); it != removedTcpQuestions.end(); it++) { mdnsPacket->AddQuestion(*it); } } if (removedUdp) { MDNSPacket mdnsPacket = MDNSPacket::cast(packet); for (std::list::const_iterator it = removedUdpAnswers.begin(); it != removedUdpAnswers.end(); it++) { mdnsPacket->AddAnswer(*it); } for (std::list::const_iterator it = removedUdpQuestions.begin(); it != removedUdpQuestions.end(); it++) { mdnsPacket->AddQuestion(*it); } } if (removedTcp || removedUdp) { MDNSPacket mdnsPacket = MDNSPacket::cast(packet); uint32_t numMatches = mdnsPacket->GetNumMatches("advertise.*", MDNSResourceRecord::TXT, MDNSTextRData::TXTVERS); for (uint32_t match = 0; match < numMatches; match++) { if (tcpNames.find(match) == tcpNames.end() && udpNames.find(match) == udpNames.end() && tcpUdpNames.find(match) == tcpUdpNames.end()) { continue; } MDNSResourceRecord* advRecord; if (!mdnsPacket->GetAdditionalRecordAt("advertise.*", MDNSResourceRecord::TXT, MDNSTextRData::TXTVERS, match, &advRecord)) { continue; } MDNSAdvertiseRData* advRData = static_cast(advRecord->GetRData()); if (!advRData) { continue; } advRData->Reset(); if (tcpNames.find(match) != tcpNames.end()) { advRData->SetTransport(TRANSPORT_TCP); for (std::list::iterator iter = tcpNames[match].begin(); iter != tcpNames[match].end(); iter++) { advRData->SetValue("name", *iter); } } if (udpNames.find(match) != udpNames.end()) { advRData->SetTransport(TRANSPORT_UDP); for (std::list::iterator iter = udpNames[match].begin(); iter != udpNames[match].end(); iter++) { advRData->SetValue("name", *iter); } } if (tcpUdpNames.find(match) != tcpUdpNames.end()) { advRData->SetTransport(TRANSPORT_TCP | TRANSPORT_UDP); for (std::list::iterator iter = tcpUdpNames[match].begin(); iter != tcpUdpNames[match].end(); iter++) { advRData->SetValue("name", *iter); } } } } tcpNames.clear(); udpNames.clear(); tcpUdpNames.clear(); removedTcpAnswers.clear(); removedTcpQuestions.clear(); removedUdpAnswers.clear(); removedUdpQuestions.clear(); removedTcp = false; removedUdp = false; } } void IpNameServiceImpl::SendOutboundMessages(void) { QCC_DbgPrintf(("IpNameServiceImpl::SendOutboundMessages()")); int count = m_outbound.size(); // // Send any messages we have queued for transmission. We expect to be // called with the mutex locked so we can wander around in the various // protected data structures freely. // while ((count) && (m_state == IMPL_RUNNING || m_terminal)) { count--; // // Pull a message off of the outbound queue. What we get is a // header object that will tie together a number of "question" // (who-has) objects and a number of "answer" (is-at) objects. // Packet packet = m_outbound.front(); // // We have the concept of quiet advertisements that imply quiet // (unicast) responses. If we have a quiet response, we know because a // destination address will have been set in the header. // if (packet->DestinationSet()) { SendOutboundMessageQuietly(packet); } else { SendOutboundMessageActively(packet); } // // The current message has been sent to any and all of interfaces that // make sense, so we can discard it and loop back for another. // m_outbound.pop_front(); } } void* IpNameServiceImpl::Run(void* arg) { QCC_UNUSED(arg); QCC_DbgPrintf(("IpNameServiceImpl::Run()")); // // This method is executed by the name service main thread and becomes the // center of the name service universe. All incoming and outgoing messages // percolate through this thread because of the way we have to deal with // interfaces coming up and going down underneath us in a mobile // environment. See the "Long Sidebar" comment above for some details on // the pain this has caused. // // Ultimately, this means we have a number of sockets open that correspond // to the "live" interfaces we are listening to. We have to listen to all // of these sockets in what amounts to a select() below. That means we // have live FDs waiting in the select. On the other hand, we want to be // responsive in the case of a user turning on wireless and immediately // doing a Locate(). This requirement implies that we need to update the // interface state whenever we do a Locate. This Locate() will be done in // the context of a user thread. So we have a requirement that we avoid // changing the state of the FDs in another thread and the requirement // that we change the state of the FDs when the user wants to Locate(). // Either we play synchronization games and distribute our logic or do // everything here. Because it is easier to manage the process in one // place, we have all messages gonig through this thread. // size_t bufsize = NS_MESSAGE_MAX; uint8_t* buffer = new uint8_t[bufsize]; // // Instantiate an event that fires after one second, and once per second // thereafter. Used to drive protocol maintenance functions, especially // dealing with interface state changes. // const uint32_t MS_PER_SEC = 1000; qcc::Event timerEvent(MS_PER_SEC, MS_PER_SEC); qcc::NetworkEventSet networkEvents; qcc::SocketFd networkEventFd = qcc::INVALID_SOCKET_FD; #ifndef QCC_OS_GROUP_WINDOWS networkEventFd = qcc::NetworkEventSocket(); qcc::Event* networkEvent = new Event(networkEventFd, qcc::Event::IO_READ); #else qcc::Event* networkEvent = new Event(true); #endif qcc::Timespec tNow, tLastLazyUpdate; GetTimeNow(&tLastLazyUpdate); m_mutex.Lock(); while ((m_state == IMPL_RUNNING) || (m_state == IMPL_STOPPING) || m_terminal) { // // If we are shutting down, we need to make sure that we send out the // terminal is-at messages that correspond to a CancelAdvertiseName for // any of the names we are advertising. These messages are queued while // handling the thread stop event (below) and m_terminal is set to true. // So, if the thread has been asked to stop and stopEvent is still set, // run through the loop, so the messages can be queued and m_terminal // can be set to true. // The first time through the loop in which we find the m_outbound list // empty it means that all of the terminal messages have been sent and // we can exit. So if we find m_terminal true and m_outbound.empty() // true, we break out of the loop and exit. // if (m_terminal && m_outbound.empty()) { QCC_DbgPrintf(("IpNameServiceImpl::Run(): m_terminal && m_outbound.empty() -> m_terminal = false")); m_terminal = false; break; } GetTimeNow(&tNow); // // In order to pass the Android Compatibility Test, we need to be able // to enable and disable communication with the outside world. Enabling // is straightforward enough, but when we disable, we need to be careful // about turning things off before we've sent out all possibly queued // packets. // if (m_doEnable) { m_enabled = true; m_doEnable = false; } if (m_doDisable && m_outbound.empty()) { QCC_DbgPrintf(("IpNameServiceImpl::Run(): m_doDisable && m_outbound.empty() -> m_enabled = false")); m_enabled = false; m_doDisable = false; } // // We need to figure out which interfaces we can send and receive // protocol messages over. On one hand, we don't want to get carried // away with multicast group joins and leaves since we could get tangled // up in IGMP rate limits. On the other hand we want to do this often // enough to appear responsive to the user when she moves into proximity // with another device. // // Some quick measurements indicate that a Linux box can take about 15 // seconds to associate, Windows and Android about 5 seconds. Based on // the lower limits, it won't do much good to lazy update faster than // about once every five seconds; so we take that as an upper limit on // how often we allow a lazy update. On the other hand, we want to // make sure we do a lazy update at least every 15 seconds. We define // a couple of constants, LAZY_UPDATE_{MAX,MIN}_INTERVAL to allow this // range. // // What drives the middle ground between MAX and MIN timing? The // presence or absence of FindAdvertisement() and AdvertiseName() // calls. If the application is poked by an impatient user who "knows" // she should be able to connect, she may arrange to send out a // FindAdvertiseName() or AdvertiseName(). This is indicated to us by a // message on the m_outbound queue. // // So there are three basic cases which cause us to rn the lazy updater: // // 1) If m_forceLazyUpdate is true, some major configuration change // has happened and we need to update no matter what. // // 2) If a message is found on the outbound queue, we need to do a // lazy update if LAZY_UPDATE_MIN_INTERVAL has passed since the // last update. // // 3) If LAZY_UPDATE_MAX_INTERVAL has elapsed since the last lazy // update, we need to update. // if (m_forceLazyUpdate) { QCC_DbgPrintf(("IpNameServiceImpl::Run(): LazyUpdateInterfaces()")); LazyUpdateInterfaces(networkEvents); networkEvents.clear(); tLastLazyUpdate = tNow; m_forceLazyUpdate = false; } SendOutboundMessages(); // // Now, worry about what to do next. Create a set of events to wait on. // We always wait on the stop event, the timer event and the event used // to signal us when an outging message is queued or a forced wakeup for // a lazy update is done. // vector checkEvents, signaledEvents; checkEvents.push_back(&stopEvent); if (IsPeriodicMaintenanceTimerNeeded()) { checkEvents.push_back(&timerEvent); } checkEvents.push_back(&m_wakeEvent); checkEvents.push_back(networkEvent); if (m_unicastEvent) { checkEvents.push_back(m_unicastEvent); } // // We also need to wait on events from all of the sockets that // correspond to the "live" interfaces we need to listen for inbound // multicast messages on. // for (uint32_t i = 0; i < m_liveInterfaces.size(); ++i) { if (m_liveInterfaces[i].m_multicastMDNSsockFd != qcc::INVALID_SOCKET_FD) { checkEvents.push_back(m_liveInterfaces[i].m_multicastMDNSevent); } if (m_liveInterfaces[i].m_multicastsockFd != qcc::INVALID_SOCKET_FD) { checkEvents.push_back(m_liveInterfaces[i].m_multicastevent); } } // // We are going to go to sleep for possibly as long as a second, so // we definitely need to release other (user) threads that might // be waiting to talk to us. // m_mutex.Unlock(); // // Wait for something to happen. if we get an error, there's not // much we can do about it but bail. // QStatus status = qcc::Event::Wait(checkEvents, signaledEvents); if (status != ER_OK && status != ER_TIMEOUT) { QCC_LogError(status, ("IpNameServiceImpl::Run(): Event::Wait(): Failed")); m_mutex.Lock(); break; } // // Loop over the events for which we expect something has happened // for (vector::iterator i = signaledEvents.begin(); i != signaledEvents.end(); ++i) { if (*i == &stopEvent) { QCC_DbgPrintf(("IpNameServiceImpl::Run(): Stop event fired")); // // We heard the stop event, so reset it. Our contract is that once // we've heard this event, we have to exit the run routine fairly // quickly. We can take some time to clean up, but there will be // someone else eventually blocked waiting for us to exit, so we // can't get carried away. // stopEvent.ResetEvent(); // // What we need to do is to send out is-at messages telling // anyone interested in our names that they are no longer valid. // This is a fairly complicated process that can involve sending // multiple packets out multiple interfaces, so we clearly don't // want to duplicate code here to make it all happen. We use a // special case of normal operation to prevent new requests from // being queued, issue our own terminal requests corresponding to // the is-at messages metioned above, and then we run until they // are all processed and then we exit. // // Calling Retransmit(index, true, false) will queue the desired // terminal is-at messages from the given transport on the // m_outbound list. To ensure that they are sent before we // exit, we set m_terminal to true. We will have set m_state to // IMPL_STOPPING in IpNameServiceImpl::Stop. This stops new // external requests from being acted upon. We then continue in // our loop until the outbound queue is empty and then exit the // run routine (above). // m_terminal = true; for (uint32_t index = 0; index < N_TRANSPORTS; ++index) { vector empty; Retransmit(index, true, false, qcc::IPEndpoint("0.0.0.0", 0), qcc::IPEndpoint("0.0.0.0", 0), TRANSMIT_V0_V1, MaskFromIndex(index), empty); Retransmit(index, true, false, qcc::IPEndpoint("0.0.0.0", 0), qcc::IPEndpoint("0.0.0.0", 0), TRANSMIT_V2, TRANSPORT_TCP | TRANSPORT_UDP, empty); } break; } else if (*i == &timerEvent) { // QCC_DbgPrintf(("IpNameServiceImpl::Run(): Timer event fired")); // // This is an event that fires every second to give us a chance // to do any protocol maintenance, like retransmitting queued // advertisements. // DoPeriodicMaintenance(); } else if (*i == &m_wakeEvent) { QCC_DbgPrintf(("IpNameServiceImpl::Run(): Wake event fired")); // // This is an event that fires whenever a message has been // queued on the outbound name service message queue. We // always check the queue whenever we run through the loop, // (it'll happen before we sleep again) but we do have to reset // it. // m_wakeEvent.ResetEvent(); } else if (*i == networkEvent) { QCC_DbgPrintf(("IpNameServiceImpl::Run(): Network event fired")); #ifndef QCC_OS_GROUP_WINDOWS NetworkEventType eventType = qcc::NetworkEventReceive(networkEventFd, networkEvents); if (eventType == QCC_RTM_DELADDR) { m_forceLazyUpdate = true; } if (eventType == QCC_RTM_NEWADDR) { m_forceLazyUpdate = true; m_refreshAdvertisements = true; } if (eventType == QCC_RTM_SUSPEND) { delete networkEvent; networkEvent = NULL; qcc::Close(networkEventFd); networkEventFd = qcc::NetworkEventSocket(); networkEvent = new Event(networkEventFd, qcc::Event::IO_READ); m_forceLazyUpdate = true; } #else networkEvent->ResetEvent(); m_forceLazyUpdate = true; m_refreshAdvertisements = true; #endif } else { QCC_DbgPrintf(("IpNameServiceImpl::Run(): Socket event fired")); // // This must be activity on one of our multicast listener sockets. // qcc::SocketFd sockFd = (*i)->GetFD(); QCC_DbgPrintf(("IpNameServiceImpl::Run(): Call qcc::RecvFrom()")); qcc::IPAddress remoteAddress, localAddress; uint16_t remotePort; size_t nbytes; int32_t localInterfaceIndex; QStatus status = qcc::RecvWithAncillaryData(sockFd, remoteAddress, remotePort, localAddress, buffer, bufsize, nbytes, localInterfaceIndex); if (status != ER_OK) { // // We have a RecvFrom error. We want to avoid states where // we get repeated read errors and just end up in an // infinite loop getting errors sucking up all available // CPU, so we make sure we sleep for at least a short time // after detecting the error. // // Our basic strategy is to hope that this is a transient // error, or one that will be recovered at the next lazy // update. We don't want to blindly force a lazy update // or we may get into an infinite lazy update loop, so // the worst that can happen is that we introduce a short // delay here in our handler whenever we detect an error. // // On Windows ER_WOULBLOCK can be expected because it takes // an initial call to recv to determine if the socket is readable. // if (status == ER_OS_ERROR) { if (sockFd == m_ipv4UnicastSockFd) { if (m_unicastEvent) { delete m_unicastEvent; m_unicastEvent = NULL; } qcc::Close(m_ipv4UnicastSockFd); m_ipv4UnicastSockFd = INVALID_SOCKET_FD; } m_forceLazyUpdate = true; QCC_LogError(status, ("IpNameServiceImpl::Run(): qcc::RecvFrom(%d, ...): Failed", sockFd)); continue; } else if (status != ER_WOULDBLOCK) { QCC_LogError(status, ("IpNameServiceImpl::Run(): qcc::RecvFrom(%d, ...): Failed", sockFd)); qcc::Sleep(1); } continue; } QCC_DbgHLPrintf(("IpNameServiceImpl::Run(): Got IPNS message from \"%s\"", remoteAddress.ToString().c_str())); // Find out the destination port and interface index for this message. uint16_t localPort = std::numeric_limits::max(); int32_t ifIndex = -1; bool destIsIPv4Local = false; bool destIsIPv6Local = false; String ifName; for (uint32_t i = 0; i < m_liveInterfaces.size(); ++i) { if (m_liveInterfaces[i].m_multicastMDNSsockFd == sockFd) { localPort = m_liveInterfaces[i].m_multicastMDNSPort; ifIndex = m_liveInterfaces[i].m_index; ifName = m_liveInterfaces[i].m_interfaceName; } if (m_liveInterfaces[i].m_multicastsockFd == sockFd) { localPort = m_liveInterfaces[i].m_multicastPort; ifIndex = m_liveInterfaces[i].m_index; ifName = m_liveInterfaces[i].m_interfaceName; } if (!destIsIPv4Local && m_liveInterfaces[i].m_address.IsIPv4() && localAddress == m_liveInterfaces[i].m_address) { destIsIPv4Local = true; localPort = m_liveInterfaces[i].m_unicastPort; ifIndex = m_liveInterfaces[i].m_index; } if (!destIsIPv6Local && m_liveInterfaces[i].m_address.IsIPv6() && localAddress == m_liveInterfaces[i].m_address) { destIsIPv6Local = true; localPort = m_liveInterfaces[i].m_unicastPort; ifIndex = m_liveInterfaces[i].m_index; } } if (localPort != std::numeric_limits::max() && ifIndex != -1) { QCC_DbgHLPrintf(("Processing packet on interface index %d that was received on index %d from %s:%u to %s:%u", ifIndex, localInterfaceIndex, remoteAddress.ToString().c_str(), remotePort, localAddress.ToString().c_str(), localPort)); } if (ifIndex != -1 && !destIsIPv4Local && ifIndex != localInterfaceIndex) { QCC_DbgHLPrintf(("Ignoring non-unicast or unexpected packet that was received on a different interface")); continue; } // // We got a message over the multicast channel. Deal with it. // if (localPort != std::numeric_limits::max() && ifIndex != -1) { qcc::IPEndpoint remote(remoteAddress, remotePort); qcc::IPEndpoint local(localAddress, localPort); HandleProtocolMessage(buffer, nbytes, remote, local, ifIndex); } } } m_mutex.Lock(); } m_mutex.Unlock(); // We took the time to send out a final // advertisement(s) above, indicating that we are going away. // Clear live interfaces and exit. ClearLiveInterfaces(); delete networkEvent; if (networkEventFd != qcc::INVALID_SOCKET_FD) { qcc::Close(networkEventFd); } delete [] buffer; return 0; } void IpNameServiceImpl::GetResponsePackets(std::list& packets, bool quietly, const qcc::IPEndpoint destination, uint8_t type, TransportMask completeTransportMask, const int32_t interfaceIndex, const qcc::AddressFamily family) { m_mutex.Lock(); bool tcpProcessed = false; bool udpProcessed = false; for (uint32_t transportIndex = 0; transportIndex < N_TRANSPORTS; ++transportIndex) { if ((type & TRANSMIT_V2) && !m_advertised[transportIndex].empty()) { MDNSSenderRData senderRData; MDNSResourceRecord refRecord("sender-info." + m_guid + ".local.", MDNSResourceRecord::TXT, MDNSResourceRecord::INTERNET, 120, &senderRData); MDNSARData addrRData; MDNSResourceRecord aRecord(m_guid + ".local.", MDNSResourceRecord::A, MDNSResourceRecord::INTERNET, 120, &addrRData); MDNSAAAARData aaaaRData; MDNSResourceRecord aaaaRecord(m_guid + ".local.", MDNSResourceRecord::AAAA, MDNSResourceRecord::INTERNET, 120, &aaaaRData); uint32_t aaaaRecordSize = aaaaRecord.GetSerializedSize(); int32_t id = IncrementAndFetch(&INCREMENTAL_PACKET_ID); MDNSHeader mdnsHeader(id, MDNSHeader::MDNS_RESPONSE); MDNSPtrRData ptrRDataTcp; ptrRDataTcp.SetPtrDName(m_guid + "._alljoyn._tcp.local."); MDNSResourceRecord ptrRecordTcp("_alljoyn._tcp.local.", MDNSResourceRecord::PTR, MDNSResourceRecord::INTERNET, 120, &ptrRDataTcp); MDNSSrvRData srvRDataTcp(1 /*priority */, 1 /* weight */, 0 /* port */, m_guid + ".local." /* target */); MDNSResourceRecord srvRecordTcp(m_guid + "._alljoyn._tcp.local.", MDNSResourceRecord::SRV, MDNSResourceRecord::INTERNET, 120, &srvRDataTcp); MDNSTextRData txtRDataTcp; MDNSPtrRData ptrRDataUdp; ptrRDataUdp.SetPtrDName(m_guid + "._alljoyn._udp.local."); MDNSResourceRecord ptrRecordUdp("_alljoyn._udp.local.", MDNSResourceRecord::PTR, MDNSResourceRecord::INTERNET, 120, &ptrRDataUdp); MDNSSrvRData srvRDataUdp(1 /*priority */, 1 /* weight */, 0 /* port */, m_guid + ".local." /* target */); MDNSResourceRecord srvRecordUdp(m_guid + "._alljoyn._udp.local.", MDNSResourceRecord::SRV, MDNSResourceRecord::INTERNET, 120, &srvRDataUdp); MDNSTextRData txtRDataUdp; MDNSAdvertiseRData advertiseRData; MDNSResourceRecord advertiseRecord("advertise." + m_guid + ".local.", MDNSResourceRecord::TXT, MDNSResourceRecord::INTERNET, 120, &advertiseRData); MDNSPacket pilotPacket; pilotPacket->SetHeader(mdnsHeader); pilotPacket->SetVersion(2, 2); if (m_reliableIPv6Port[TRANSPORT_INDEX_TCP]) { txtRDataTcp.SetValue("r6port", U32ToString(m_reliableIPv6Port[TRANSPORT_INDEX_TCP])); } MDNSResourceRecord txtRecordTcp(m_guid + "._alljoyn._tcp.local.", MDNSResourceRecord::TXT, MDNSResourceRecord::INTERNET, 120, &txtRDataTcp); if (m_unreliableIPv6Port[TRANSPORT_INDEX_UDP]) { txtRDataUdp.SetValue("u6port", U32ToString(m_unreliableIPv6Port[TRANSPORT_INDEX_UDP])); } MDNSResourceRecord txtRecordUdp(m_guid + "._alljoyn._udp.local.", MDNSResourceRecord::TXT, MDNSResourceRecord::INTERNET, 120, &txtRDataUdp); pilotPacket->AddAdditionalRecord(advertiseRecord); pilotPacket->AddAdditionalRecord(refRecord); pilotPacket->AddAdditionalRecord(aRecord); if (quietly) { pilotPacket->SetDestination(destination); } else { pilotPacket->ClearDestination(); if (interfaceIndex != -1) { pilotPacket->SetInterfaceIndex(interfaceIndex); } if (family != qcc::QCC_AF_UNSPEC) { pilotPacket->SetAddressFamily(family); } } MDNSResourceRecord* advRecord; pilotPacket->GetAdditionalRecord("advertise.*", MDNSResourceRecord::TXT, MDNSTextRData::TXTVERS, &advRecord); MDNSAdvertiseRData* advRData = static_cast(advRecord->GetRData()); MDNSResourceRecord* refRecord1; pilotPacket->GetAdditionalRecord("sender-info.*", MDNSResourceRecord::TXT, MDNSTextRData::TXTVERS, &refRecord1); MDNSSenderRData* refRData = static_cast(refRecord1->GetRData()); refRData->SetSearchID(id); packets.push_back(Packet::cast(pilotPacket)); TransportMask transportMaskArr[3] = { TRANSPORT_TCP, TRANSPORT_UDP, TRANSPORT_TCP | TRANSPORT_UDP }; if ((transportIndex == IndexFromBit(TRANSPORT_TCP) && tcpProcessed) || (transportIndex == IndexFromBit(TRANSPORT_UDP) && udpProcessed)) { continue; } for (int i = 0; i < 3; i++) { TransportMask tm = transportMaskArr[i]; if (completeTransportMask == TRANSPORT_TCP) { if (tm == TRANSPORT_UDP) { continue; } } else if (completeTransportMask == TRANSPORT_UDP) { if (tm == TRANSPORT_TCP) { continue; } } else if (completeTransportMask != (TRANSPORT_TCP | TRANSPORT_UDP)) { continue; } set advertising = GetAdvertising(tm); int count = 0; for (set::iterator i = advertising.begin(); i != advertising.end(); ++i) { QCC_DbgPrintf(("IpNameServiceImpl::GetResponsePackets(): Accumulating \"%s\"", (*i).c_str())); // // It is possible that we have accumulated more advertisements than will // fit in a UDP IpNameServiceImpl packet. A name service is-at message is going // to consist of a header and its answer section, which is made from an // IsAt object. We first ask both of these objects to return their size // so we know how much space is committed already. Note that we ask the // header for its max possible size since the header may be modified to // add actual IPv4 and IPv6 addresses when it is sent. // size_t currentSize = packets.back()->GetSerializedSize(); // // This isn't terribly elegant, but we don't know the IP address(es) // over which the message will be sent. These are added in the loop // that actually does the packet sends, with the interface addresses // dynamically added onto the message. We have no clue here if an IPv4 // or IPv6 or both flavors of address will exist on a given interface, // nor how many interfaces there are. All we can do here is to assume // the worst case for the size (both exist) and add the 20 bytes (four // for IPv4, sixteen for IPv6) that the addresses may consume in the // final packet. // currentSize += aaaaRecordSize; MDNSAdvertiseRData currentAdvert; currentAdvert.SetUniqueCount(advRData->GetUniqueCount()); if (!count) { currentAdvert.SetTransport(tm); } currentAdvert.SetValue("name", *i); uint32_t currentAdvertSize = currentAdvert.GetSerializedSize() - 2; // // We cheat a little in order to avoid a string copy and use our // knowledge that names are stored as a byte count followed by the // string bytes. If the current name won't fit into the currently // assembled message, we need to flush the current message and start // again. // if (currentSize + currentAdvertSize > NS_MESSAGE_MAX) { QCC_DbgPrintf(("IpNameServiceImpl::GetResponsePackets(): Message is full")); QCC_DbgPrintf(("IpNameServiceImpl::GetResponsePackets(): Sending partial list")); id = IncrementAndFetch(&INCREMENTAL_PACKET_ID); mdnsHeader.SetId(id); MDNSPacket additionalPacket; additionalPacket->SetHeader(mdnsHeader); if ((tm & TRANSPORT_TCP) && (!m_reliableIPv4PortMap[TRANSPORT_INDEX_TCP].empty() || m_reliableIPv6Port[TRANSPORT_INDEX_TCP])) { MDNSResourceRecord txtRecordTcp(m_guid + "._alljoyn._tcp.local.", MDNSResourceRecord::TXT, MDNSResourceRecord::INTERNET, 120, &txtRDataTcp); additionalPacket->AddAnswer(ptrRecordTcp); additionalPacket->AddAnswer(srvRecordTcp); additionalPacket->AddAnswer(txtRecordTcp); } if (tm & TRANSPORT_UDP && (!m_unreliableIPv4PortMap[TRANSPORT_INDEX_UDP].empty() || m_unreliableIPv6Port[TRANSPORT_INDEX_UDP])) { MDNSResourceRecord txtRecordUdp(m_guid + "._alljoyn._udp.local.", MDNSResourceRecord::TXT, MDNSResourceRecord::INTERNET, 120, &txtRDataUdp); additionalPacket->AddAnswer(ptrRecordUdp); additionalPacket->AddAnswer(srvRecordUdp); additionalPacket->AddAnswer(txtRecordUdp); } additionalPacket->AddAdditionalRecord(advertiseRecord); additionalPacket->AddAdditionalRecord(refRecord); additionalPacket->AddAdditionalRecord(aRecord); additionalPacket->SetVersion(2, 2); additionalPacket->GetAdditionalRecord("advertise.*", MDNSResourceRecord::TXT, &advRecord); advRData = static_cast(advRecord->GetRData()); additionalPacket->GetAdditionalRecord("sender-info.*", MDNSResourceRecord::TXT, &refRecord1); refRData = static_cast(refRecord1->GetRData()); advRData->Reset(); advRData->SetTransport(tm); advRData->SetValue("name", *i); refRData->SetSearchID(id); if (quietly) { additionalPacket->SetDestination(destination); } else { additionalPacket->ClearDestination(); if (interfaceIndex != -1) { additionalPacket->SetInterfaceIndex(interfaceIndex); } if (family != qcc::QCC_AF_UNSPEC) { additionalPacket->SetAddressFamily(family); } } packets.push_back(Packet::cast(additionalPacket)); count = 1; } else { QCC_DbgPrintf(("IpNameServiceImpl::GetResponsePackets(): Message has room. Adding \"%s\"", (*i).c_str())); MDNSResourceRecord* answer; bool tcpAnswer = MDNSPacket::cast(packets.back())->GetAnswer("_alljoyn._tcp.local.", MDNSResourceRecord::PTR, &answer); bool udpAnswer = MDNSPacket::cast(packets.back())->GetAnswer("_alljoyn._udp.local.", MDNSResourceRecord::PTR, &answer); if (!udpAnswer && (tm & TRANSPORT_UDP) && (!m_unreliableIPv4PortMap[TRANSPORT_INDEX_UDP].empty() || m_unreliableIPv6Port[TRANSPORT_INDEX_UDP])) { MDNSPacket::cast(packets.back())->AddAnswer(ptrRecordUdp); MDNSPacket::cast(packets.back())->AddAnswer(srvRecordUdp); MDNSPacket::cast(packets.back())->AddAnswer(txtRecordUdp); } if (!tcpAnswer && (tm & TRANSPORT_TCP) && (!m_reliableIPv4PortMap[TRANSPORT_INDEX_TCP].empty() || m_reliableIPv6Port[TRANSPORT_INDEX_TCP])) { MDNSPacket::cast(packets.back())->AddAnswer(ptrRecordTcp); MDNSPacket::cast(packets.back())->AddAnswer(srvRecordTcp); MDNSPacket::cast(packets.back())->AddAnswer(txtRecordTcp); } if (!count) { advRData->SetTransport(tm); } advRData->SetValue("name", *i); count++; } } if (quietly) { set advertising_quietly = GetAdvertisingQuietly(tm); for (set::iterator i = advertising_quietly.begin(); i != advertising_quietly.end(); ++i) { QCC_DbgPrintf(("IpNameServiceImpl::GetResponsePackets(): Accumulating (quiet) \"%s\"", (*i).c_str())); size_t currentSize = packets.back()->GetSerializedSize(); currentSize += aaaaRecordSize; MDNSAdvertiseRData currentAdvert; currentAdvert.SetUniqueCount(advRData->GetUniqueCount()); if (!count) { currentAdvert.SetTransport(tm); } advRData->SetValue("name", *i); uint32_t currentAdvertSize = currentAdvert.GetSerializedSize() - 2; if (currentSize + currentAdvertSize > NS_MESSAGE_MAX) { QCC_DbgPrintf(("IpNameServiceImpl::GetResponsePackets(): Message is full")); QCC_DbgPrintf(("IpNameServiceImpl::GetResponsePackets(): Sending partial list")); id = IncrementAndFetch(&INCREMENTAL_PACKET_ID); mdnsHeader.SetId(id); MDNSPacket additionalPacket; additionalPacket->SetHeader(mdnsHeader); if ((tm & TRANSPORT_TCP) && (!m_reliableIPv4PortMap[TRANSPORT_INDEX_TCP].empty() || m_reliableIPv6Port[TRANSPORT_INDEX_TCP])) { if (m_reliableIPv6Port[TRANSPORT_INDEX_TCP]) { txtRDataTcp.SetValue("r6port", U32ToString(m_reliableIPv6Port[TRANSPORT_INDEX_TCP])); } MDNSResourceRecord txtRecordTcp(m_guid + "._alljoyn._tcp.local.", MDNSResourceRecord::TXT, MDNSResourceRecord::INTERNET, 120, &txtRDataTcp); additionalPacket->AddAnswer(ptrRecordTcp); additionalPacket->AddAnswer(srvRecordTcp); additionalPacket->AddAnswer(txtRecordTcp); } if (tm & TRANSPORT_UDP && (!m_unreliableIPv4PortMap[TRANSPORT_INDEX_UDP].empty() || m_unreliableIPv6Port[TRANSPORT_INDEX_UDP])) { if (m_unreliableIPv6Port[TRANSPORT_INDEX_UDP]) { txtRDataUdp.SetValue("u6port", U32ToString(m_unreliableIPv6Port[TRANSPORT_INDEX_UDP])); } MDNSResourceRecord txtRecordUdp(m_guid + "._alljoyn._udp.local.", MDNSResourceRecord::TXT, MDNSResourceRecord::INTERNET, 120, &txtRDataUdp); additionalPacket->AddAnswer(ptrRecordUdp); additionalPacket->AddAnswer(srvRecordUdp); additionalPacket->AddAnswer(txtRecordUdp); } additionalPacket->AddAdditionalRecord(advertiseRecord); additionalPacket->AddAdditionalRecord(refRecord); additionalPacket->AddAdditionalRecord(aRecord); additionalPacket->SetVersion(2, 2); additionalPacket->GetAdditionalRecord("advertise.*", MDNSResourceRecord::TXT, &advRecord); advRData = static_cast(advRecord->GetRData()); additionalPacket->GetAdditionalRecord("sender-info.*", MDNSResourceRecord::TXT, &refRecord1); refRData = static_cast(refRecord1->GetRData()); advRData->Reset(); advRData->SetTransport(tm); advRData->SetValue("name", *i); refRData->SetSearchID(id); additionalPacket->SetDestination(destination); packets.push_back(Packet::cast(additionalPacket)); count = 1; } else { MDNSResourceRecord* answer; bool tcpAnswer = MDNSPacket::cast(packets.back())->GetAnswer("_alljoyn._tcp.local.", MDNSResourceRecord::PTR, &answer); bool udpAnswer = MDNSPacket::cast(packets.back())->GetAnswer("_alljoyn._udp.local.", MDNSResourceRecord::PTR, &answer); if (!udpAnswer && (tm & TRANSPORT_UDP) && (!m_unreliableIPv4PortMap[TRANSPORT_INDEX_UDP].empty() || m_unreliableIPv6Port[TRANSPORT_INDEX_UDP])) { MDNSPacket::cast(packets.back())->AddAnswer(ptrRecordUdp); MDNSPacket::cast(packets.back())->AddAnswer(srvRecordUdp); MDNSPacket::cast(packets.back())->AddAnswer(txtRecordUdp); } if (!tcpAnswer && (tm & TRANSPORT_TCP) && (!m_reliableIPv4PortMap[TRANSPORT_INDEX_TCP].empty() || m_reliableIPv6Port[TRANSPORT_INDEX_TCP])) { MDNSPacket::cast(packets.back())->AddAnswer(ptrRecordTcp); MDNSPacket::cast(packets.back())->AddAnswer(srvRecordTcp); MDNSPacket::cast(packets.back())->AddAnswer(txtRecordTcp); } if (!count) { advRData->SetTransport(tm); } QCC_DbgPrintf(("IpNameServiceImpl::GetResponsePackets(): Message has room. Adding (quiet) \"%s\"", (*i).c_str())); advRData->SetValue("name", *i); count++; } } } } tcpProcessed = true; udpProcessed = true; } } m_mutex.Unlock(); } void IpNameServiceImpl::GetQueryPackets(std::list& packets, const uint8_t type, const int32_t interfaceIndex, const qcc::AddressFamily family) { m_mutex.Lock(); for (uint32_t transportIndex = 0; transportIndex < N_TRANSPORTS; ++transportIndex) { if (m_enableV1 && (type & TRANSMIT_V0_V1) && !m_v0_v1_queries[transportIndex].empty()) { { uint32_t nQuerySent = 0; WhoHas whoHas; whoHas.SetVersion(0, 0); whoHas.SetTransportMask(MaskFromIndex(transportIndex)); whoHas.SetTcpFlag(true); whoHas.SetUdpFlag(true); whoHas.SetIPv4Flag(true); NSPacket pilotPacket; pilotPacket->SetVersion(0, 0); pilotPacket->SetTimer(m_tDuration); pilotPacket->AddQuestion(whoHas); pilotPacket->ClearDestination(); if (interfaceIndex != -1) { pilotPacket->SetInterfaceIndex(interfaceIndex); } if (family != qcc::QCC_AF_UNSPEC) { pilotPacket->SetAddressFamily(family); } packets.push_back(Packet::cast(pilotPacket)); ++nQuerySent; WhoHas* pWhoHas; pilotPacket->GetQuestion(0, &pWhoHas); for (set::const_iterator i = m_v0_v1_queries[transportIndex].begin(); i != m_v0_v1_queries[transportIndex].end(); ++i) { size_t currentSize = packets.back()->GetSerializedSize(); currentSize += 20; if (currentSize + 1 + i->size() > NS_MESSAGE_MAX) { QCC_DbgPrintf(("IpNameServiceImpl::GetQueryPackets(): Resetting current list")); NSPacket additionalPacket; whoHas.Reset(); whoHas.AddName(*i); additionalPacket->SetVersion(0, 0); additionalPacket->SetTimer(m_tDuration); additionalPacket->AddQuestion(whoHas); if (interfaceIndex != -1) { additionalPacket->SetInterfaceIndex(interfaceIndex); } if (family != qcc::QCC_AF_UNSPEC) { additionalPacket->SetAddressFamily(family); } packets.push_back(Packet::cast(additionalPacket)); additionalPacket->GetQuestion(0, &pWhoHas); ++nQuerySent; } else { pWhoHas->AddName(*i); } } } { WhoHas whoHas; whoHas.SetVersion(1, 1); whoHas.SetTransportMask(MaskFromIndex(transportIndex)); NSPacket pilotPacket; pilotPacket->SetVersion(1, 1); pilotPacket->SetTimer(m_tDuration); pilotPacket->AddQuestion(whoHas); pilotPacket->ClearDestination(); if (interfaceIndex != -1) { pilotPacket->SetInterfaceIndex(interfaceIndex); } if (family != qcc::QCC_AF_UNSPEC) { pilotPacket->SetAddressFamily(family); } packets.push_back(Packet::cast(pilotPacket)); WhoHas* pWhoHas; pilotPacket->GetQuestion(0, &pWhoHas); for (set::const_iterator i = m_v0_v1_queries[transportIndex].begin(); i != m_v0_v1_queries[transportIndex].end(); ++i) { size_t currentSize = packets.back()->GetSerializedSize(); currentSize += 20; if (currentSize + 1 + i->size() > NS_MESSAGE_MAX) { NSPacket additionalPacket; whoHas.Reset(); whoHas.AddName(*i); additionalPacket->SetVersion(1, 1); additionalPacket->SetTimer(m_tDuration); additionalPacket->AddQuestion(whoHas); if (interfaceIndex != -1) { additionalPacket->SetInterfaceIndex(interfaceIndex); } if (family != qcc::QCC_AF_UNSPEC) { additionalPacket->SetAddressFamily(family); } packets.push_back(Packet::cast(additionalPacket)); additionalPacket->GetQuestion(0, &pWhoHas); } else { pWhoHas->AddName(*i); } } } } } MDNSQuestion mdnsTCPQuestion("_alljoyn._tcp.local.", MDNSResourceRecord::PTR, MDNSResourceRecord::INTERNET); MDNSQuestion mdnsUDPQuestion("_alljoyn._udp.local.", MDNSResourceRecord::PTR, MDNSResourceRecord::INTERNET); MDNSAAAARData aaaaRData; MDNSResourceRecord aaaaRecord(m_guid + ".local.", MDNSResourceRecord::AAAA, MDNSResourceRecord::INTERNET, 120, &aaaaRData); uint32_t aaaaRecordSize = aaaaRecord.GetSerializedSize(); MDNSPacket pilotPacket; int32_t id = IncrementAndFetch(&INCREMENTAL_PACKET_ID); MDNSHeader mdnsHeader(id, MDNSHeader::MDNS_QUERY); pilotPacket->SetHeader(mdnsHeader); pilotPacket->SetVersion(2, 2); if (!m_v2_queries[TRANSPORT_INDEX_UDP].empty()) { pilotPacket->AddQuestion(mdnsUDPQuestion); } if (!m_v2_queries[TRANSPORT_INDEX_TCP].empty()) { pilotPacket->AddQuestion(mdnsTCPQuestion); } MDNSSearchRData searchRefData; MDNSResourceRecord searchRecord("search." + m_guid + ".local.", MDNSResourceRecord::TXT, MDNSResourceRecord::INTERNET, 120, &searchRefData); MDNSSenderRData senderRData; MDNSResourceRecord refRecord("sender-info." + m_guid + ".local.", MDNSResourceRecord::TXT, MDNSResourceRecord::INTERNET, 120, &senderRData); pilotPacket->AddAdditionalRecord(searchRecord); pilotPacket->AddAdditionalRecord(refRecord); MDNSResourceRecord* searchRecord1; pilotPacket->GetAdditionalRecord("search.*", MDNSResourceRecord::TXT, &searchRecord1); MDNSSearchRData* searchRData = static_cast(searchRecord1->GetRData()); MDNSResourceRecord* refRecord1; pilotPacket->GetAdditionalRecord("sender-info.*", MDNSResourceRecord::TXT, &refRecord1); MDNSSenderRData* refRData = static_cast(refRecord1->GetRData()); refRData->SetSearchID(id); pilotPacket->ClearDestination(); if (interfaceIndex != -1) { pilotPacket->SetInterfaceIndex(interfaceIndex); } if (family != qcc::QCC_AF_UNSPEC) { pilotPacket->SetAddressFamily(family); } bool pilotAdded = false; uint32_t count = 0; set addedQueries; for (uint32_t transportIndex = 0; transportIndex < N_TRANSPORTS; ++transportIndex) { if ((type & TRANSMIT_V2) && !m_v2_queries[transportIndex].empty()) { if (!pilotAdded) { packets.push_back(Packet::cast(pilotPacket)); pilotAdded = true; } for (set::const_iterator i = m_v2_queries[transportIndex].begin(); i != m_v2_queries[transportIndex].end(); ++i) { if (addedQueries.find(*i) != addedQueries.end() && (transportIndex == TRANSPORT_INDEX_UDP || transportIndex == TRANSPORT_INDEX_TCP)) { continue; } size_t currentSize = packets.back()->GetSerializedSize(); currentSize += aaaaRecordSize; MatchMap matching; ParseMatchRule(*i, matching); MDNSSearchRData currentQuery; currentQuery.SetUniqueCount(searchRData->GetUniqueCount()); for (MatchMap::iterator j = matching.begin(); j != matching.end(); ++j) { currentQuery.SetValue(j->first, j->second); } currentQuery.SetValue(";"); uint32_t currentQuerySize = currentQuery.GetSerializedSize() - 2; if ((currentSize + currentQuerySize) > NS_MESSAGE_MAX) { QCC_DbgPrintf(("IpNameServiceImpl::GetQueryPackets(): Message is full")); QCC_DbgPrintf(("IpNameServiceImpl::GetQueryPackets(): Resetting current list")); id = IncrementAndFetch(&INCREMENTAL_PACKET_ID); mdnsHeader.SetId(id); MDNSPacket additionalPacket; additionalPacket->SetHeader(mdnsHeader); additionalPacket->SetVersion(2, 2); additionalPacket->AddAdditionalRecord(searchRecord); additionalPacket->AddAdditionalRecord(refRecord); additionalPacket->GetAdditionalRecord("search.*", MDNSResourceRecord::TXT, &searchRecord1); searchRData = static_cast(searchRecord1->GetRData()); additionalPacket->GetAdditionalRecord("sender-info.*", MDNSResourceRecord::TXT, &refRecord1); refRData = static_cast(refRecord1->GetRData()); searchRData->Reset(); if (!m_v2_queries[TRANSPORT_INDEX_UDP].empty()) { additionalPacket->AddQuestion(mdnsUDPQuestion); } if (!m_v2_queries[TRANSPORT_INDEX_TCP].empty()) { additionalPacket->AddQuestion(mdnsTCPQuestion); } for (MatchMap::iterator j = matching.begin(); j != matching.end(); ++j) { searchRData->SetValue(j->first, j->second); } count = 1; refRData->SetSearchID(id); additionalPacket->ClearDestination(); if (interfaceIndex != -1) { additionalPacket->SetInterfaceIndex(interfaceIndex); } if (family != qcc::QCC_AF_UNSPEC) { additionalPacket->SetAddressFamily(family); } packets.push_back(Packet::cast(additionalPacket)); addedQueries.insert(*i); } else { if (count > 0) { searchRData->SetValue(";"); } for (MatchMap::iterator j = matching.begin(); j != matching.end(); ++j) { searchRData->SetValue(j->first, j->second); } if (transportIndex == TRANSPORT_INDEX_UDP || transportIndex == TRANSPORT_INDEX_TCP) { addedQueries.insert(*i); } count++; } } } } m_mutex.Unlock(); } void IpNameServiceImpl::Retransmit(uint32_t transportIndex, bool exiting, bool quietly, const qcc::IPEndpoint& destination, const qcc::IPEndpoint& source, uint8_t type, TransportMask completeTransportMask, vector& wkns, const int32_t interfaceIndex, const qcc::AddressFamily family) { // // Type can be one of the following 3 values: // - TRANSMIT_V0_V1: transmit version zero and version one messages. // - TRANSMIT_V2: transmit version two messages. // - TRANSMIT_V0_V1 | TRANSMIT_V2: transmit version zero, version one and // version two messages. // // If V1 is not enabled we only respond to queries for quiet names from V1 // to support legacy thin core leaf nodes looking for router nodes. // if (!m_enableV1 && !quietly) { type &= ~TRANSMIT_V0_V1; } if (type == 0) { //Nothing to transmit return; } QCC_DbgPrintf(("IpNameServiceImpl::Retransmit()")); // // There are at least two threads wandering through the advertised list. // We are running short on toes, so don't shoot any more off by not being // thread-unaware. // m_mutex.Lock(); // // We've been asked to retransmit our advertised names. There are two main // classes of names: those actively advertised and those quietly advertised. // The difference is that quietly advertised names only go out when a // who-has message is received. They are not sent periodically. The // reception of a who-has message is indicated by the parameter // being set to true. Since we want to allow passive observers to hear our // responses, if we get a who-has message, no matter what is being looked // or, we take the opportunity to retransmit all of our names whether or not // they are quitely or actively advertised. Since quiet responses are a // "new thing," we don't worry about sending down-version packets. This all // means quiet advertisement responses are quite simple as compared to // active advertisement responses. They are a special case though. // // So, based on these observations, we retransmit our whole list if // is true and the advertised quietly list is not empty or if the // advertised list is not empty -- otherwise we don't have anything to do. // bool doRetransmit = (quietly && !m_advertised_quietly[transportIndex].empty()) || !m_advertised[transportIndex].empty(); if (doRetransmit == false) { QCC_DbgPrintf(("IpNameServiceImpl::Retransmit(): Nothing to do for transportIndex %d", transportIndex)); m_mutex.Unlock(); return; } // // We are now at version one of the protocol. There is a significant // difference between version zero and version one messages, so down-version // (version zero) clients will not know what to do with versino one // messages. This means that if we want to have clients running older // daemons be able to hear our advertisements, we need to send both flavors // of message. Since the version is located in the message header, this // means two messages. // // Put together and send response packets for version zero, but only if the // transport index corresponds to TRANSPORT_TCP since that was the only // possibility in version zero and keeping in mind that we aren't going to // send version zero messages over our newly defined "quiet" mechanism. // if (transportIndex == TRANSPORT_INDEX_TCP && quietly == false && (type & TRANSMIT_V0)) { // // Keep track of how many messages we actually send in order to get all of // the advertisements out. // uint32_t nSent = 0; // // The header will tie the whole protocol message together. By setting the // timer, we are asking for everyone who hears the message to remember the // advertisements for that number of seconds. If we are exiting, then we // set the timer to zero, which means that the name is no longer valid. // NSPacket nspacket; nspacket->SetSource(source); // // We understand all messages from version zero to version one, and we // are sending a version zero message. The whole point of sending a // version zero message is that can be understood by down-level code // so we can't use the new versioning scheme. // nspacket->SetVersion(0, 0); nspacket->SetTimer(exiting ? 0 : m_tDuration); IsAt isAt; isAt.SetVersion(0, 0); // // We don't actually send the transport mask in version zero packets // but we make a note to ourselves to let us know on behalf of what // transport we will be sending. // isAt.SetTransportMask(MaskFromIndex(transportIndex)); // // The Complete Flag tells the other side that the message it recieves // contains the complete list of well-known names advertised by the // source. We don't know that we fit them all in yet, so this must be // initialized to false. // isAt.SetCompleteFlag(false); // // We have to use some sneaky way to tell an in-the know version one // client that the packet is from a version one client and that is // through the setting of the UDP flag. TCP transports are the only // possibility for version zero packets and it always sets the TCP // flag, of course. // isAt.SetTcpFlag(true); isAt.SetUdpFlag(true); isAt.SetGuid(m_guid); // // The only possibility in version zero is that the port is the IPv4 // reliable port. // isAt.SetPort(0); QCC_DbgPrintf(("IpNameServiceImpl::Retransmit(): Loop through advertised names")); // // Loop through the list of names we are advertising, constructing as many // protocol messages as it takes to get our list of advertisements out. // // Note that the number of packets that can go out in any given amount of // time is effectively throttled in SendProtocolMessage() by a random delay. // A user can consume all available resources here by flooding us with // advertisements but she will only be shooting herself in the foot. // for (set::iterator i = m_advertised[transportIndex].begin(); i != m_advertised[transportIndex].end(); ++i) { QCC_DbgPrintf(("IpNameServiceImpl::Retransmit(): Accumulating \"%s\"", (*i).c_str())); // // It is possible that we have accumulated more advertisements than will // fit in a UDP IpNameServiceImpl packet. A name service is-at message is going // to consist of a header and its answer section, which is made from an // IsAt object. We first ask both of these objects to return their size // so we know how much space is committed already. Note that we ask the // header for its max possible size since the header may be modified to // add actual IPv4 and IPv6 addresses when it is sent. // size_t currentSize = nspacket->GetSerializedSize() + isAt.GetSerializedSize(); // // This isn't terribly elegant, but we don't know the IP address(es) // over which the message will be sent. These are added in the loop // that actually does the packet sends, with the interface addresses // dynamically added onto the message. We have no clue here if an IPv4 // or IPv6 or both flavors of address will exist on a given interface, // nor how many interfaces there are. All we can do here is to assume // the worst case for the size (both exist) and add the 20 bytes (four // for IPv4, sixteen for IPv6) that the addresses may consume in the // final packet. // currentSize += 20; // // We cheat a little in order to avoid a string copy and use our // knowledge that names are stored as a byte count followed by the // string bytes. If the current name won't fit into the currently // assembled message, we need to flush the current message and start // again. // if (currentSize + 1 + (*i).size() > NS_MESSAGE_MAX) { QCC_DbgPrintf(("IpNameServiceImpl::Retransmit(): Message is full")); // // The current message cannot hold another name. We need to send it // out before continuing. // QCC_DbgPrintf(("IpNameServiceImpl::Retransmit(): Sending partial list")); nspacket->AddAnswer(isAt); if (quietly) { nspacket->SetDestination(destination); SendOutboundMessageQuietly(Packet::cast(nspacket)); } else { nspacket->ClearDestination(); if (interfaceIndex != -1) { nspacket->SetInterfaceIndex(interfaceIndex); } else { nspacket->ClearInterfaceIndex(); } if (family != qcc::QCC_AF_UNSPEC) { nspacket->SetAddressFamily(family); } else { nspacket->ClearAddressFamily(); } if (source.addr != IPAddress("0.0.0.0")) { SendOutboundMessageActively(Packet::cast(nspacket), source.addr); } else { SendOutboundMessageActively(Packet::cast(nspacket)); } } ++nSent; // // The full message is now on the way out. Now, we remove all of // the entries in the IsAt object, reset the header, which clears // out the existing is-at, and start accumulating new names again. // QCC_DbgPrintf(("IpNameServiceImpl::Retransmit(): Resetting current list")); nspacket->Reset(); isAt.Reset(); isAt.AddName(*i); } else { QCC_DbgPrintf(("IpNameServiceImpl::Retransmit(): Message has room. Adding \"%s\"", (*i).c_str())); isAt.AddName(*i); } } // // We most likely have a partially full message waiting to go out. If we // haven't sent a message, then the one message holds all of the names that // are being advertised. In this case, we set the complete flag to indicate // that this packet describes the full extent of advertised well known // names. // if (nSent == 0) { QCC_DbgPrintf(("IpNameServiceImpl::Retransmit(): Single complete message ")); isAt.SetCompleteFlag(true); } QCC_DbgPrintf(("IpNameServiceImpl::Retransmit(): Sending final version zero message ")); nspacket->AddAnswer(isAt); nspacket->ClearDestination(); if (interfaceIndex != -1) { nspacket->SetInterfaceIndex(interfaceIndex); } else { nspacket->ClearInterfaceIndex(); } if (family != qcc::QCC_AF_UNSPEC) { nspacket->SetAddressFamily(family); } else { nspacket->ClearAddressFamily(); } if (source.addr != IPAddress("0.0.0.0")) { SendOutboundMessageActively(Packet::cast(nspacket), source.addr); } else { SendOutboundMessageActively(Packet::cast(nspacket)); } } // // Put together and send response packets for version one. // if ((transportIndex == TRANSPORT_INDEX_TCP) && type & TRANSMIT_V1) { // // Keep track of how many messages we actually send in order to get all of // the advertisements out. // uint32_t nSent = 0; // // The header will tie the whole protocol message together. By setting the // timer, we are asking for everyone who hears the message to remember the // advertisements for that number of seconds. If we are exiting, then we // set the timer to zero, which means that the name is no longer valid. // NSPacket nspacket; nspacket->SetSource(source); // // We understand all messages from version zero to version one, and we // are sending a version one message; // nspacket->SetVersion(1, 1); nspacket->SetTimer(exiting ? 0 : m_tDuration); // // The underlying protocol is capable of identifying both TCP and UDP // services. Right now, the only possibility is TCP. // IsAt isAt; // // We understand all messages from version zero to version one, and we // are sending a version one message; // isAt.SetVersion(1, 1); // // We don't know if this is going to be a complete and final list yet, // but we do know which transport we are doing this on behalf of. // isAt.SetCompleteFlag(false); isAt.SetTransportMask(MaskFromIndex(transportIndex)); // // Version one allows us to provide four possible endpoints. The address // will be rewritten on the way out with the address of the appropriate // interface. // if (!m_reliableIPv4PortMap[transportIndex].empty()) { isAt.SetReliableIPv4("", 0); } if (!m_unreliableIPv4PortMap[transportIndex].empty()) { isAt.SetUnreliableIPv4("", 0); } // This is a trick to make V2 NS ignore V1 packets. We set the IPv6 reliable bit, // that tells version two capable NS that a version two message will follow, and // to ignore the version one messages. isAt.SetReliableIPv6("", m_reliableIPv6Port[transportIndex]); if (m_unreliableIPv6Port[transportIndex]) { isAt.SetUnreliableIPv6("", m_unreliableIPv6Port[transportIndex]); } isAt.SetGuid(m_guid); QCC_DbgPrintf(("IpNameServiceImpl::Retransmit(): Loop through advertised names")); // // Loop through the list of names we are advertising, constructing as many // protocol messages as it takes to get our list of advertisements out. // // Note that the number of packets that can go out in any given amount of // time is effectively throttled in SendProtocolMessage() by a random delay. // A user can consume all available resources here by flooding us with // advertisements but she will only be shooting herself in the foot. // for (set::iterator i = m_advertised[transportIndex].begin(); i != m_advertised[transportIndex].end(); ++i) { //Do not send non-matching names if replying quietly if (quietly) { bool ignore = true; for (vector::iterator itWkn = wkns.begin(); itWkn != wkns.end(); itWkn++) { //Do not send non-matching names if replying quietly if (!(WildcardMatch((*i), (*itWkn)))) { ignore = false; break; } } if (ignore) { continue; } } QCC_DbgPrintf(("IpNameServiceImpl::Retransmit(): Accumulating \"%s\"", (*i).c_str())); // // It is possible that we have accumulated more advertisements than will // fit in a UDP IpNameServiceImpl packet. A name service is-at message is going // to consist of a header and its answer section, which is made from an // IsAt object. We first ask both of these objects to return their size // so we know how much space is committed already. Note that we ask the // header for its max possible size since the header may be modified to // add actual IPv4 and IPv6 addresses when it is sent. // size_t currentSize = nspacket->GetSerializedSize() + isAt.GetSerializedSize(); // // This isn't terribly elegant, but we don't know the IP address(es) // over which the message will be sent. These are added in the loop // that actually does the packet sends, with the interface addresses // dynamically added onto the message. We have no clue here if an IPv4 // or IPv6 or both flavors of address will exist on a given interface, // nor how many interfaces there are. All we can do here is to assume // the worst case for the size (both exist) and add the 20 bytes (four // for IPv4, sixteen for IPv6) that the addresses may consume in the // final packet. // currentSize += 20; // // We cheat a little in order to avoid a string copy and use our // knowledge that names are stored as a byte count followed by the // string bytes. If the current name won't fit into the currently // assembled message, we need to flush the current message and start // again. // if (currentSize + 1 + (*i).size() > NS_MESSAGE_MAX) { QCC_DbgPrintf(("IpNameServiceImpl::Retransmit(): Message is full")); // // The current message cannot hold another name. We need to send it // out before continuing. // QCC_DbgPrintf(("IpNameServiceImpl::Retransmit(): Sending partial list")); nspacket->AddAnswer(isAt); if (quietly) { nspacket->SetDestination(destination); SendOutboundMessageQuietly(Packet::cast(nspacket)); } else { nspacket->ClearDestination(); if (interfaceIndex != -1) { nspacket->SetInterfaceIndex(interfaceIndex); } else { nspacket->ClearInterfaceIndex(); } if (family != qcc::QCC_AF_UNSPEC) { nspacket->SetAddressFamily(family); } else { nspacket->ClearAddressFamily(); } if (source.addr != IPAddress("0.0.0.0")) { SendOutboundMessageActively(Packet::cast(nspacket), source.addr); } else { SendOutboundMessageActively(Packet::cast(nspacket)); } } ++nSent; // // The full message is now on the way out. Now, we remove all of // the entries in the IsAt object, reset the header, which clears // out the existing is-at, and start accumulating new names again. // QCC_DbgPrintf(("IpNameServiceImpl::Retransmit(): Resetting current list")); nspacket->Reset(); isAt.Reset(); isAt.AddName(*i); } else { QCC_DbgPrintf(("IpNameServiceImpl::Retransmit(): Message has room. Adding \"%s\"", (*i).c_str())); isAt.AddName(*i); } } if (quietly) { for (set::iterator i = m_advertised_quietly[transportIndex].begin(); i != m_advertised_quietly[transportIndex].end(); ++i) { if (quietly) { bool ignore = true; for (vector::iterator itWkn = wkns.begin(); itWkn != wkns.end(); itWkn++) { //Do not send non-matching names if replying quietly if (!(WildcardMatch((*i), (*itWkn)))) { ignore = false; break; } } if (ignore) { continue; } } QCC_DbgPrintf(("IpNameServiceImpl::Retransmit(): Accumulating (quiet) \"%s\"", (*i).c_str())); size_t currentSize = nspacket->GetSerializedSize() + isAt.GetSerializedSize(); currentSize += 20; if (currentSize + 1 + (*i).size() > NS_MESSAGE_MAX) { QCC_DbgPrintf(("IpNameServiceImpl::Retransmit(): Message is full")); QCC_DbgPrintf(("IpNameServiceImpl::Retransmit(): Sending partial list")); nspacket->AddAnswer(isAt); if (quietly) { nspacket->SetDestination(destination); SendOutboundMessageQuietly(Packet::cast(nspacket)); } else { nspacket->ClearDestination(); SendOutboundMessageActively(Packet::cast(nspacket)); } ++nSent; QCC_DbgPrintf(("IpNameServiceImpl::Retransmit(): Resetting current list")); nspacket->Reset(); isAt.Reset(); isAt.AddName(*i); } else { QCC_DbgPrintf(("IpNameServiceImpl::Retransmit(): Message has room. Adding (quiet) \"%s\"", (*i).c_str())); isAt.AddName(*i); } } } // // We most likely have a partially full message waiting to go out. If we // haven't sent a message, then the one message holds all of the names that // are being advertised. In this case, we set the complete flag to indicate // that this packet describes the full extent of advertised well known // names. // if (nSent == 0) { QCC_DbgPrintf(("IpNameServiceImpl::Retransmit(): Single complete message ")); isAt.SetCompleteFlag(true); } QCC_DbgPrintf(("IpNameServiceImpl::Retransmit(): Sending final message ")); nspacket->AddAnswer(isAt); if (quietly) { nspacket->SetDestination(destination); SendOutboundMessageQuietly(Packet::cast(nspacket)); } else { nspacket->ClearDestination(); if (interfaceIndex != -1) { nspacket->SetInterfaceIndex(interfaceIndex); } else { nspacket->ClearInterfaceIndex(); } if (family != qcc::QCC_AF_UNSPEC) { nspacket->SetAddressFamily(family); } else { nspacket->ClearAddressFamily(); } if (source.addr != IPAddress("0.0.0.0")) { SendOutboundMessageActively(Packet::cast(nspacket), source.addr); } else { SendOutboundMessageActively(Packet::cast(nspacket)); } } } if (type & TRANSMIT_V2) { // // Keep track of how many messages we actually send in order to get all of // the advertisements out. // uint32_t nSent = 0; //version two int32_t id = IncrementAndFetch(&INCREMENTAL_PACKET_ID); MDNSHeader mdnsHeader(id, MDNSHeader::MDNS_RESPONSE); MDNSAdvertiseRData* advRData = new MDNSAdvertiseRData(); MDNSResourceRecord advertiseRecord("advertise." + m_guid + ".local.", MDNSResourceRecord::TXT, MDNSResourceRecord::INTERNET, exiting ? 0 : m_tDuration, advRData); delete advRData; MDNSSenderRData* refRData = new MDNSSenderRData(); refRData->SetSearchID(id); MDNSResourceRecord refRecord("sender-info." + m_guid + ".local.", MDNSResourceRecord::TXT, MDNSResourceRecord::INTERNET, exiting ? 0 : m_tDuration, refRData); delete refRData; MDNSARData* addrRData = new MDNSARData(); MDNSResourceRecord aRecord(m_guid + ".local.", MDNSResourceRecord::A, MDNSResourceRecord::INTERNET, exiting ? 0 : m_tDuration, addrRData); delete addrRData; MDNSPacket mdnsPacket; mdnsPacket->SetHeader(mdnsHeader); mdnsPacket->SetSource(source); QCC_DbgPrintf(("IpNameServiceImpl::::Retransmit(): Current priority is %d", GetCurrentPriority())); if ((completeTransportMask & TRANSPORT_TCP) && (!m_reliableIPv4PortMap[TRANSPORT_INDEX_TCP].empty() || m_reliableIPv6Port[TRANSPORT_INDEX_TCP])) { MDNSPtrRData* ptrRDataTcp = new MDNSPtrRData(); ptrRDataTcp->SetPtrDName(m_guid + "._alljoyn._tcp.local."); MDNSResourceRecord ptrRecordTcp("_alljoyn._tcp.local.", MDNSResourceRecord::PTR, MDNSResourceRecord::INTERNET, exiting ? 0 : m_tDuration, ptrRDataTcp); delete ptrRDataTcp; MDNSSrvRData* srvRDataTcp = new MDNSSrvRData(GetCurrentPriority(), 0 /* weight */, 0 /* port */, m_guid + ".local." /* target */); MDNSResourceRecord srvRecordTcp(m_guid + "._alljoyn._tcp.local.", MDNSResourceRecord::SRV, MDNSResourceRecord::INTERNET, exiting ? 0 : m_tDuration, srvRDataTcp); delete srvRDataTcp; MDNSTextRData* txtRDataTcp = new MDNSTextRData(); if (m_reliableIPv6Port[TRANSPORT_INDEX_TCP]) { txtRDataTcp->SetValue("r6port", U32ToString(m_reliableIPv6Port[TRANSPORT_INDEX_TCP])); } MDNSResourceRecord txtRecordTcp(m_guid + "._alljoyn._tcp.local.", MDNSResourceRecord::TXT, MDNSResourceRecord::INTERNET, exiting ? 0 : m_tDuration, txtRDataTcp); delete txtRDataTcp; mdnsPacket->AddAnswer(ptrRecordTcp); mdnsPacket->AddAnswer(srvRecordTcp); mdnsPacket->AddAnswer(txtRecordTcp); } if ((completeTransportMask & TRANSPORT_UDP) && (!m_unreliableIPv4PortMap[TRANSPORT_INDEX_UDP].empty() || m_unreliableIPv6Port[TRANSPORT_INDEX_UDP])) { MDNSPtrRData* ptrRDataUdp = new MDNSPtrRData(); ptrRDataUdp->SetPtrDName(m_guid + "._alljoyn._udp.local."); MDNSResourceRecord ptrRecordUdp("_alljoyn._udp.local.", MDNSResourceRecord::PTR, MDNSResourceRecord::INTERNET, exiting ? 0 : m_tDuration, ptrRDataUdp); delete ptrRDataUdp; MDNSSrvRData* srvRDataUdp = new MDNSSrvRData(GetCurrentPriority(), 0 /* weight */, 0 /* port */, m_guid + ".local." /* target */); MDNSResourceRecord srvRecordUdp(m_guid + "._alljoyn._udp.local.", MDNSResourceRecord::SRV, MDNSResourceRecord::INTERNET, exiting ? 0 : m_tDuration, srvRDataUdp); delete srvRDataUdp; MDNSTextRData* txtRDataUdp = new MDNSTextRData(); if (m_unreliableIPv6Port[TRANSPORT_INDEX_UDP]) { txtRDataUdp->SetValue("u6port", U32ToString(m_unreliableIPv6Port[TRANSPORT_INDEX_UDP])); } MDNSResourceRecord txtRecordUdp(m_guid + "._alljoyn._udp.local.", MDNSResourceRecord::TXT, MDNSResourceRecord::INTERNET, exiting ? 0 : m_tDuration, txtRDataUdp); delete txtRDataUdp; mdnsPacket->AddAnswer(ptrRecordUdp); mdnsPacket->AddAnswer(srvRecordUdp); mdnsPacket->AddAnswer(txtRecordUdp); } mdnsPacket->AddAdditionalRecord(advertiseRecord); mdnsPacket->AddAdditionalRecord(refRecord); mdnsPacket->AddAdditionalRecord(aRecord); mdnsPacket->SetVersion(2, 2); MDNSResourceRecord* advRecord; mdnsPacket->GetAdditionalRecord("advertise.*", MDNSResourceRecord::TXT, MDNSTextRData::TXTVERS, &advRecord); advRData = static_cast(advRecord->GetRData()); MDNSResourceRecord* refRecord1; mdnsPacket->GetAdditionalRecord("sender-info.*", MDNSResourceRecord::TXT, MDNSTextRData::TXTVERS, &refRecord1); refRData = static_cast(refRecord1->GetRData()); TransportMask transportMaskArr[3] = { TRANSPORT_TCP, TRANSPORT_UDP, TRANSPORT_TCP | TRANSPORT_UDP }; for (int i = 0; i < 3; i++) { TransportMask tm = transportMaskArr[i]; set advertising = GetAdvertising(tm); set advertising_quietly = GetAdvertisingQuietly(tm); //Insert the transport mask if there are any active or quiet advertisements we are sending out. if (!advertising.empty() || (quietly && !advertising_quietly.empty())) { advRData->SetTransport(tm); } for (set::iterator it = advertising.begin(); it != advertising.end(); ++it) { //Do not send non-matching names if requestor has set send_matching_only i.e. wkns.size() > 0 if (wkns.size() > 0) { bool ignore = true; for (vector::iterator itWkn = wkns.begin(); itWkn != wkns.end(); itWkn++) { //Do not send non-matching names if requestor has set send_matching_only i.e. wkns.size() > 0 if (!(WildcardMatch((*it), (*itWkn)))) { ignore = false; break; } } if (ignore) { continue; } } QCC_DbgPrintf(("IpNameServiceImpl::Retransmit(): Accumulating \"%s\"", (*it).c_str())); // // It is possible that we have accumulated more advertisements than will // fit in a UDP IpNameServiceImpl packet. A name service is-at message is going // to consist of a header and its answer section, which is made from an // IsAt object. We first ask both of these objects to return their size // so we know how much space is committed already. Note that we ask the // header for its max possible size since the header may be modified to // add actual IPv4 and IPv6 addresses when it is sent. // size_t currentSize = mdnsPacket->GetSerializedSize(); // // This isn't terribly elegant, but we don't know the IP address(es) // over which the message will be sent. These are added in the loop // that actually does the packet sends, with the interface addresses // dynamically added onto the message. We have no clue here if an IPv4 // or IPv6 or both flavors of address will exist on a given interface, // nor how many interfaces there are. All we can do here is to assume // the worst case for the size (both exist) and add the 20 bytes (four // for IPv4, sixteen for IPv6) that the addresses may consume in the // final packet. // currentSize += 100; // // We cheat a little in order to avoid a string copy and use our // knowledge that names are stored as a byte count followed by the // string bytes. If the current name won't fit into the currently // assembled message, we need to flush the current message and start // again. // if (currentSize + 1 + (*it).size() > NS_MESSAGE_MAX) { QCC_DbgPrintf(("IpNameServiceImpl::Retransmit(): Message is full")); // // The current message cannot hold another name. We need to send it // out before continuing. // QCC_DbgPrintf(("IpNameServiceImpl::Retransmit(): Sending partial list")); // Use "exiting" to find out whether to send the response by unicast // or multicast. // For TRANSMIT_V2, there are 2 calls into Retransmit(). // 1. HandleSearchQuery will call into Retransmit with // exiting = false and respondQuietly=true or false depending on whether // a quiet name matches or not. Irrespective of whether respondQuietly is // true or false, we need to send the response over unicast. // 2. IpNameServiceImpl::Run will call into Retransmit with exiting = true // and respondQuietly = false when the thread is shut down. In this case, // we need to send only the actively advertised names over multicast. if (!exiting) { mdnsPacket->SetDestination(destination); SendOutboundMessageQuietly(Packet::cast(mdnsPacket)); } else { mdnsPacket->ClearDestination(); SendOutboundMessageActively(Packet::cast(mdnsPacket)); } ++nSent; // // The full message is now on the way out. Now, we remove all of // the entries in the IsAt object, reset the header, which clears // out the existing is-at, and start accumulating new names again. // QCC_DbgPrintf(("IpNameServiceImpl::Retransmit(): Resetting current list")); advRData->Reset(); advRData->SetTransport(tm); advRData->SetValue("name", *it); id = IncrementAndFetch(&INCREMENTAL_PACKET_ID); refRData->SetSearchID(id); } else { QCC_DbgPrintf(("IpNameServiceImpl::Retransmit(): Message has room. Adding \"%s\"", (*it).c_str())); advRData->SetValue("name", *it); } } if (quietly) { for (set::iterator it = advertising_quietly.begin(); it != advertising_quietly.end(); ++it) { //Do not send non-matching names if requestor has set send_matching_only i.e. wkns.size() > 0 if (wkns.size() > 0) { bool ignore = true; for (vector::iterator itWkn = wkns.begin(); itWkn != wkns.end(); itWkn++) { //Do not send non-matching names if requestor has set send_matching_only i.e. wkns.size() > 0 if (!(WildcardMatch((*it), (*itWkn)))) { ignore = false; break; } } if (ignore) { continue; } } QCC_DbgPrintf(("IpNameServiceImpl::Retransmit(): Accumulating (quiet) \"%s\"", (*it).c_str())); size_t currentSize = mdnsPacket->GetSerializedSize(); currentSize += 100; if (currentSize + 1 + (*it).size() > NS_MESSAGE_MAX) { QCC_DbgPrintf(("IpNameServiceImpl::Retransmit(): Message is full")); QCC_DbgPrintf(("IpNameServiceImpl::Retransmit(): Sending partial list")); mdnsPacket->SetDestination(destination); SendOutboundMessageQuietly(Packet::cast(mdnsPacket)); ++nSent; QCC_DbgPrintf(("IpNameServiceImpl::Retransmit(): Resetting current list")); advRData->Reset(); advRData->SetTransport(tm); advRData->SetValue("name", *it); id = IncrementAndFetch(&INCREMENTAL_PACKET_ID); refRData->SetSearchID(id); } else { QCC_DbgPrintf(("IpNameServiceImpl::Retransmit(): Message has room. Adding (quiet) \"%s\"", (*it).c_str())); advRData->SetValue("name", *it); } } } } // // We most likely have a partially full message waiting to go out. If we // haven't sent a message, then the one message holds all of the names that // are being advertised. In this case, we set the complete flag to indicate // that this packet describes the full extent of advertised well known // names. // if (nSent == 0) { QCC_DbgPrintf(("IpNameServiceImpl::Retransmit(): Single complete message ")); } QCC_DbgPrintf(("IpNameServiceImpl::Retransmit(): Sending final message ")); // Use "exiting" to find out whether to send the response by unicast // or multicast. // For TRANSMIT_V2, there are 2 calls into Retransmit(). // 1. HandleSearchQuery will call into Retransmit with // exiting = false and respondQuietly=true or false depending on whether // a quiet name matches or not. Irrespective of whether respondQuietly is // true or false, we need to send the response over unicast. // 2. IpNameServiceImpl::Run will call into Retransmit with exiting = true // and respondQuietly = false when the thread is shut down. In this case, // we need to send only the actively advertised names over multicast. if (!exiting) { mdnsPacket->SetDestination(destination); SendOutboundMessageQuietly(Packet::cast(mdnsPacket)); } else { mdnsPacket->ClearDestination(); SendOutboundMessageActively(Packet::cast(mdnsPacket)); } } m_mutex.Unlock(); } // Note: this function assumes the mutex is locked bool IpNameServiceImpl::IsPeriodicMaintenanceTimerNeeded(void) const { // // The timer is needed when we're in the midst of handling a terminal message, // we have an outbound message queued, or we're counting down to send the // queued advertisement (in V1 config). // if (m_terminal || (m_outbound.size() > 0) || (m_enableV1 && (m_timer > 0))) { return true; } else { return false; } } void IpNameServiceImpl::DoPeriodicMaintenance(void) { #if HAPPY_WANDERER Wander(); #endif m_mutex.Lock(); // // If we have something exported, we will have a retransmit timer value // set. If not, this value will be zero and there's nothing to be done. // if (m_timer) { --m_timer; if (m_timer == m_tRetransmit) { QCC_DbgPrintf(("IpNameServiceImpl::DoPeriodicMaintenance(): Retransmit()")); for (uint32_t index = 0; index < N_TRANSPORTS; ++index) { vector empty; Retransmit(index, false, false, qcc::IPEndpoint("0.0.0.0", 0), qcc::IPEndpoint("0.0.0.0", 0), TRANSMIT_V0_V1, MaskFromIndex(index), empty); } m_timer = m_tDuration; } } m_mutex.Unlock(); } void IpNameServiceImpl::HandleProtocolQuestion(WhoHas whoHas, const qcc::IPEndpoint& remote, int32_t interfaceIndex, const qcc::IPEndpoint& local) { QCC_DbgPrintf(("IpNameServiceImpl::HandleProtocolQuestion(%s)", remote.ToString().c_str())); // // There are at least two threads wandering through the advertised list. // m_mutex.Lock(); // // We check the version of WhoHas packet // If it is version 0 that we got from a routing node capable of sending a // version 1 WhoHas then we drop this packet. This reduces the number of // IS-AT packets that we send over the wire // uint32_t nsVersion, msgVersion; whoHas.GetVersion(nsVersion, msgVersion); if (nsVersion == 0 && msgVersion == 0) { if (whoHas.GetUdpFlag()) { QCC_DbgPrintf(("IpNameServiceImpl::HandleProtocolQuestion(): Ignoring version zero message from version one peer")); m_mutex.Unlock(); return; } } if (nsVersion == 1 && msgVersion == 1) { if (whoHas.GetUdpFlag()) { QCC_DbgPrintf(("IpNameServiceImpl::HandleProtocolQuestion(): Ignoring version one message from version two peer")); m_mutex.Unlock(); return; } } vector wkns; // // The who-has message doesn't specify which transport is doing the asking. // This is an oversight and should be fixed in a subsequent version. The // only reasonable thing to do is to return name matches found in all of // the advertising transports. // for (uint32_t index = 0; index < N_TRANSPORTS; ++index) { // // If there are no names being advertised by the transport identified by // its index (actively or quietly), there is nothing to do. // if (m_advertised[index].empty() && m_advertised_quietly[index].empty()) { continue; } // // Loop through the names we are being asked about, and if we have // advertised any of them, we are going to need to respond to this // question. Keep track of whether or not any of our corresponding // advertisements are quiet, since we want to respond quietly to a // question about a quiet advertisements. That is, if any of the names // the client is asking about corresponds to a quiet advertisement we // respond directly to the client and do not multicast the response. // The only way we multicast a response is if the client does not ask // about any of our quietly advertised names. // // Becuse of this requirement, we loop through all of the names in the // who-has message to see if any of them correspond to quiet // advertisements. We don't just break out and respond if we find any // old match since it may be the case that the last name is the quiet // one. // bool respond = false; bool respondQuietly = false; for (uint32_t i = 0; i < whoHas.GetNumberNames(); ++i) { qcc::String wkn = whoHas.GetName(i); wkns.push_back(wkn); // // Zero length strings are unmatchable. If you want to do a wildcard // match, you've got to send a wildcard character. // if (wkn.size() == 0) { continue; } // // Check to see if this name on the list of names we actively // advertise. // // If V1 is not enabled we only respond to queries for quiet names // from V1 to support legacy thin core leaf nodes looking for router // nodes. // for (set::iterator j = m_advertised[index].begin(); m_enableV1 && (j != m_advertised[index].end()); ++j) { // // The requested name comes in from the WhoHas message and we // allow wildcards there. // if (WildcardMatch((*j), wkn)) { QCC_DbgPrintf(("IpNameServiceImpl::HandleProtocolQuestion(): request for %s does not match my %s", wkn.c_str(), (*j).c_str())); continue; } else { respond = true; break; } } // // Check to see if this name on the list of names we quietly advertise. // for (set::iterator j = m_advertised_quietly[index].begin(); j != m_advertised_quietly[index].end(); ++j) { // // The requested name comes in from the WhoHas message and we // allow wildcards there. // if (WildcardMatch((*j), wkn)) { QCC_DbgPrintf(("IpNameServiceImpl::HandleProtocolQuestion(): request for %s does not match my %s", wkn.c_str(), (*j).c_str())); continue; } else { respond = true; respondQuietly = true; break; } } } // // Since any response we send must include all of the advertisements we // are exporting; this just means to retransmit all of our advertisements. // if (respond) { m_mutex.Unlock(); qcc::AddressFamily family = qcc::QCC_AF_UNSPEC; if (remote.GetAddress().IsIPv4()) { family = QCC_AF_INET; } if (remote.GetAddress().IsIPv6()) { family = QCC_AF_INET6; } if (nsVersion == 0 && msgVersion == 0) { vector empty; Retransmit(index, false, respondQuietly, remote, local, TRANSMIT_V0, MaskFromIndex(index), empty, interfaceIndex, family); } if (nsVersion == 1 && msgVersion == 1) { Retransmit(index, false, respondQuietly, remote, local, TRANSMIT_V1, MaskFromIndex(index), wkns, interfaceIndex, family); } m_mutex.Lock(); } } m_mutex.Unlock(); } void IpNameServiceImpl::HandleProtocolAnswer(IsAt isAt, uint32_t timer, const qcc::IPEndpoint& remote, int32_t interfaceIndex) { QCC_DbgPrintf(("IpNameServiceImpl::HandleProtocolAnswer(%s)", remote.ToString().c_str())); // Get IPv4 address of interface for this message (message may have been // received on the IPv6 address). This will be used as a sanity check later // against the connect spec in the message. String ifName; int32_t ifIndexV4 = -1; if (interfaceIndex != -1) { for (uint32_t i = 0; i < m_liveInterfaces.size(); ++i) { if ((uint32_t)interfaceIndex == m_liveInterfaces[i].m_index) { ifName = m_liveInterfaces[i].m_interfaceName; if (m_liveInterfaces[i].m_address.IsIPv4()) { ifIndexV4 = i; break; } } } } // // We have to determine where the transport mask is going to come // from. For version zero messages, we infer it as TRANSPORT_TCP // since that was the only possibility. For version one and greater // messages the transport mask is included in the message. // TransportMask transportMask; uint32_t transportIndex; uint32_t nsVersion, msgVersion; isAt.GetVersion(nsVersion, msgVersion); if (msgVersion == 0) { transportMask = TRANSPORT_TCP; transportIndex = TRANSPORT_INDEX_TCP; } else { transportMask = isAt.GetTransportMask(); if (CountOnes(transportMask) != 1) { QCC_LogError(ER_BAD_TRANSPORT_MASK, ("IpNameServiceImpl::HandleProtocolAnswer(): Bad transport mask")); return; } transportIndex = IndexFromBit(transportMask); assert(transportIndex < 16 && "IpNameServiceImpl::HandleProtocolAnswer(): Bad callback index"); if (transportIndex >= 16) { return; } } // // We need protection since other threads can call in and change the // callback out from under us if we do not use protection. // We want to have a contract that says we won't ever send out a // callback after it is cleared. Taking a lock // and holding it during the callback is a bit dangerous, so we grab the lock, // set m_protect_callback to true and then release the lock before making the // callback. We therefore do expect that callbacks won't do // something silly like call back and cancel callbacks or make some other // call back into this class from another direction. // m_mutex.Lock(); // // If there is no callback for the provided transport, we can't tell the // user anything about what is going on the net, so it's pointless to go any // further. // if (m_callback[transportIndex] == NULL) { QCC_DbgPrintf(("IpNameServiceImpl::HandleProtocolAnswer(): No callback for transport, so nothing to do")); m_mutex.Unlock(); return; } // // For version zero messages from version one transports, we need to // disregard the name service messages sent out in compatibility mode // (version zero messages). We know that a version one name service will be // following up with a version one packet, so a version zero compatibility // message provides incomplete information -- we drop such messages here. // The indication that this is the case is both versions being zero with a // UDP flag being true. // if (nsVersion == 0 && msgVersion == 0) { if (isAt.GetUdpFlag()) { QCC_DbgPrintf(("IpNameServiceImpl::HandleProtocolAnswer(): Ignoring version zero message from version one/version two peer")); m_mutex.Unlock(); return; } } // // For version one messages from version two transports, we need to // disregard the name service messages sent out in compatibility mode // (version one messages). We know that a version two name service will be // following up with a version two packet, so a version one compatibility // message provides incomplete information -- we drop such messages here. // The indication that this is the case is both versions being one with a // IPv6 flag being true. // if (nsVersion == 1 && msgVersion == 1) { if (isAt.GetReliableIPv6Flag()) { QCC_DbgPrintf(("IpNameServiceImpl::HandleProtocolAnswer(): Ignoring version one message from version two peer")); m_mutex.Unlock(); return; } } vector wkn; for (uint8_t i = 0; i < isAt.GetNumberNames(); ++i) { wkn.push_back(isAt.GetName(i)); } // // Life is easier if we keep these things sorted. Don't rely on the source // (even though it is really us) to do so. // sort(wkn.begin(), wkn.end()); qcc::String guid = isAt.GetGuid(); QCC_DbgPrintf(("IpNameServiceImpl::HandleProtocolAnswer(): Got GUID %s", guid.c_str())); // // How we infer addresses is different between version zero of the protocol // and version one. In version zero, if there are no IP addresses present // in the received message, we take the IP address found in the received // packet. This allowed us to optimize out the address in some cases. We // do not do this in version one messages. The advertised addresses must // always be present in the message. // isAt.GetVersion(nsVersion, msgVersion); if (msgVersion == 0) { // // We always get an address from the system since we got the message // over a call to recvfrom(). This will either be an IPv4 or an IPv6 // address in the case of legacy daemons or only from IPv6 in new // daemons. We can also get an IPv4 or an IPv6 address in the protocol. // So we have from one to three addresses of possibly different flavors // that we need to communicate back to the daemon. We have to be very // careful to play by the old rules when appropriate to make sure we // have backward compatibility. // // Note that there is no such thing as a TCP transport that is capable // of listening on an IPv6 address, so we filter those out here. // // It is convenient for the daemon to get these addresses in the form of // a "listen-spec". This is a string starting with the transport name, // followed by private (to the transport) name=value pairs. In version // zero of the protocol, there was only one possible transport that used // the IP name service, and that was the TCP transport. We used to be // integrated into the TCP transport, so, for us here and now these // listen specs look like, "tcp:r4addr=x,r4port=y". The daemon is going // to keep track of unique instances of these and must be able to handle // multiple identical reports since we will be getting keepalives. What // we need to do then is to send a callback with a listen-spec for every // address we find. If we get all three addresses, we'll do three // callbacks with different listen-specs. This completely changes in // version one, BTW. // qcc::String ipv4address, ipv6address; QCC_DbgPrintf(("IpNameServiceImpl::HandleProtocolAnswer(): Got IP %s from recvfrom", remote.addr.ToString().c_str())); if (isAt.GetIPv4Flag()) { ipv4address = isAt.GetIPv4(); QCC_DbgPrintf(("IpNameServiceImpl::HandleProtocolAnswer(): Got IPv4 %s from message", ipv4address.c_str())); } if (isAt.GetIPv6Flag()) { ipv6address = isAt.GetIPv6(); QCC_DbgPrintf(("IpNameServiceImpl::HandleProtocolAnswer(): Got IPv6 %s from message", ipv6address.c_str())); } uint16_t port = isAt.GetPort(); QCC_DbgPrintf(("IpNameServiceImpl::HandleProtocolAnswer(): Got port %d from message", port)); // // // Since version zero had no transport mask, the only transport that can // provide a version zero message is tcp. So, the longest bus address // we can generate is going to be the larger of an IPv4 or IPv6 address: // // "addr=255.255.255.255,port=65535" // "addr=ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff,port=65535" // // or 56 characters long including the trailing '\0' // char addrbuf[64]; // // Call back with the address we got via recvfrom unless it is // overridden by the address in the message. An ipv4 address in the // message overrides an ipv4 recvfrom address, an ipv6 address in the // message overrides an ipv6 recvfrom address. // // Note that we no longer prepend the transport name ("tcp:") since we // got broken out of the TCP transport. We expect the transport to do // that now. // if ((remote.addr.IsIPv4() && !ipv4address.size())) { ipv4address = remote.addr.ToString(); } // // If we received an IPv4 address in the message, call back with that // one. // if (ipv4address.size()) { if (ifIndexV4 != -1 && SameNetwork(m_liveInterfaces[ifIndexV4].m_prefixlen, m_liveInterfaces[ifIndexV4].m_address, ipv4address)) { snprintf(addrbuf, sizeof(addrbuf), "addr=%s,port=%d", ipv4address.c_str(), port); qcc::String busAddress(addrbuf); if (transportIndex == TRANSPORT_INDEX_TCP && m_callback[transportIndex]) { m_protect_callback = true; m_mutex.Unlock(); QCC_DbgPrintf(("IpNameServiceImpl::HandleProtocolAnswer(): Calling back with %s", addrbuf)); (*m_callback[transportIndex])(busAddress, guid, wkn, timer); m_mutex.Lock(); m_protect_callback = false; } } else { // // We expect that a v4 addr may be sent via a v6 link local address. However // if a v4 addr is sent via a v4 address then someone is misbehaving, so log // a warning. // if (remote.addr.IsIPv4()) { QCC_LogError(ER_WARNING, ("Ignoring advertisement from %s for %s received on %s", remote.addr.ToString().c_str(), ipv4address.c_str(), ifName.c_str())); } } } // // If we received an IPv6 address in the message, call back with that // one. // if (ipv6address.size()) { snprintf(addrbuf, sizeof(addrbuf), "r6addr=%s,r6port=%d", ipv6address.c_str(), port); qcc::String busAddress(addrbuf); if (transportIndex == TRANSPORT_INDEX_TCP && m_callback[transportIndex]) { m_protect_callback = true; m_mutex.Unlock(); QCC_DbgPrintf(("IpNameServiceImpl::HandleProtocolAnswer(): Calling back with %s", addrbuf)); (*m_callback[transportIndex])(busAddress, guid, wkn, timer); m_mutex.Lock(); m_protect_callback = false; } } } else if (msgVersion == 1) { // // In the version one protocol, the maximum size static buffer for the // longest bus address we can generate corresponds to two fully occupied // IPv4 addresses and two fully occupied IPV6 addresses. So, we figure // that we need 31 bytes for the IPv4 endpoint information, // 55 bytes for the IPv6 endpoint information and one extra // comma: // // "addr=192.168.100.101,port=65535," // "addr=ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff,port=65535" // // Adding a byte for the trailing '\0' we come up with 88 bytes of bus // address. C++ purists will object to using the C stdio routines but // they are simpler and faster since there are no memory allocations or // reallocations. // // Note that we do not prepend the bus address with the transport name, // i.e. "tcp:" since we assume that the transport knows its own name. // char reliableAddrBuf[88]; char unreliableAddrBuf[88]; reliableAddrBuf[0] = '\0'; unreliableAddrBuf[0] = '\0'; char reliableAddr6Buf[60]; char unreliableAddr6Buf[60]; bool needComma = false; if (isAt.GetReliableIPv4Flag()) { snprintf(reliableAddrBuf, sizeof(reliableAddrBuf), "addr=%s,port=%d", isAt.GetReliableIPv4Address().c_str(), isAt.GetReliableIPv4Port()); needComma = true; } if (isAt.GetUnreliableIPv4Flag()) { snprintf(unreliableAddrBuf, sizeof(unreliableAddrBuf), ",addr=%s,port=%d", isAt.GetUnreliableIPv4Address().c_str(), isAt.GetUnreliableIPv4Port()); needComma = true; } if (isAt.GetReliableIPv6Flag()) { snprintf(reliableAddr6Buf, sizeof(reliableAddr6Buf), ",addr=%s,port=%d", isAt.GetReliableIPv6Address().c_str(), isAt.GetReliableIPv6Port()); if (needComma) { strncat(reliableAddrBuf, &reliableAddr6Buf[0], sizeof(reliableAddr6Buf)); } else { strncat(reliableAddrBuf, &reliableAddr6Buf[1], sizeof(reliableAddr6Buf)); } } if (isAt.GetUnreliableIPv6Flag()) { snprintf(unreliableAddr6Buf, sizeof(unreliableAddr6Buf), ",addr=%s,port=%d", isAt.GetUnreliableIPv6Address().c_str(), isAt.GetUnreliableIPv6Port()); if (needComma) { strncat(unreliableAddrBuf, &unreliableAddr6Buf[0], sizeof(unreliableAddr6Buf)); } else { strncat(unreliableAddrBuf, &unreliableAddr6Buf[1], sizeof(unreliableAddr6Buf)); } } if (!isAt.GetReliableIPv4Flag() || (ifIndexV4 != -1 && SameNetwork(m_liveInterfaces[ifIndexV4].m_prefixlen, m_liveInterfaces[ifIndexV4].m_address, isAt.GetReliableIPv4Address()))) { // // In version one of the protocol, we always call back with the // addresses we find in the message. We don't bother with the address // we got in recvfrom. // qcc::String busAddress; if (transportIndex == TRANSPORT_INDEX_TCP) { busAddress = qcc::String(reliableAddrBuf); } else if (transportIndex == TRANSPORT_INDEX_UDP) { busAddress = qcc::String(unreliableAddrBuf); } if ((transportIndex == TRANSPORT_INDEX_TCP || transportIndex == TRANSPORT_INDEX_UDP) && m_callback[transportIndex]) { m_protect_callback = true; m_mutex.Unlock(); QCC_DbgPrintf(("IpNameServiceImpl::HandleProtocolAnswer(): Calling back with %s", busAddress.c_str())); (*m_callback[transportIndex])(busAddress, guid, wkn, timer); m_mutex.Lock(); m_protect_callback = false; } } else { // // We expect that a v4 addr may be sent via a v6 link local address. However // if a v4 addr is sent via a v4 address then someone is misbehaving, so log // a warning. // if (isAt.GetReliableIPv4Flag() && remote.addr.IsIPv4()) { QCC_LogError(ER_WARNING, ("Ignoring advertisement from %s for %s received on %s", remote.addr.ToString().c_str(), isAt.GetReliableIPv4Address().c_str(), ifName.c_str())); } } } m_mutex.Unlock(); } void IpNameServiceImpl::HandleProtocolMessage(uint8_t const* buffer, uint32_t nbytes, const qcc::IPEndpoint& remote, const qcc::IPEndpoint& local, int32_t interfaceIndex) { QCC_DbgPrintf(("IpNameServiceImpl::HandleProtocolMessage(0x%x, %d, %s)", buffer, nbytes, remote.ToString().c_str())); #if HAPPY_WANDERER if (Wander() == false) { QCC_LogError(ER_FAIL, ("IpNameServiceImpl::HandleProtocolMessage(): Wander(): out of range")); return; } else { QCC_LogError(ER_FAIL, ("IpNameServiceImpl::HandleProtocolMessage(): Wander(): in range")); } #endif // Any messages received on port 9956 are version zero or version one messages. if (local.port == 9956) { NSPacket nsPacket; size_t bytesRead = nsPacket->Deserialize(buffer, nbytes); if (bytesRead != nbytes) { QCC_DbgPrintf(("IpNameServiceImpl::HandleProtocolMessage(): Deserialize(): Error")); return; } // // We only understand version zero and one messages. // uint32_t nsVersion, msgVersion; nsPacket->GetVersion(nsVersion, msgVersion); if (msgVersion != 0 && msgVersion != 1) { QCC_DbgPrintf(("IpNameServiceImpl::HandleProtocolMessage(): Unknown version: Error")); return; } // // If the received packet contains questions, see if we can answer them. // We have the underlying device in loopback mode so we can get receive // our own questions. We usually don't have an answer and so we don't // reply, but if we do have the requested names, we answer ourselves // to pass on this information to other interested bystanders. // for (uint8_t i = 0; i < nsPacket->GetNumberQuestions(); ++i) { HandleProtocolQuestion(nsPacket->GetQuestion(i), remote, interfaceIndex, local); } // // Only questions are handled if V1 is not enabled since we are only // responding to queries for quiet names from V1 to support legacy thin // core leaf nodes looking for router nodes. // if (!m_enableV1) { return; } // // If the received packet contains answers, see if they are answers to // questions we think are interesting. Make sure we are not talking to // ourselves unless we are told to for debugging purposes // for (uint8_t i = 0; i < nsPacket->GetNumberAnswers(); ++i) { IsAt isAt = nsPacket->GetAnswer(i); // // The version isn't actually carried in the is-at message since that // would be redundant, so we have to set it from the nsPacket version // before passing it off. // uint32_t nsVersion, msgVersion; nsPacket->GetVersion(nsVersion, msgVersion); isAt.SetVersion(nsVersion, msgVersion); if (m_loopback || (isAt.GetGuid() != m_guid)) { HandleProtocolAnswer(isAt, nsPacket->GetTimer(), remote, interfaceIndex); } } } else { // Messages not received on port 9956 are version two messages. MDNSPacket mdnsPacket; size_t bytesRead = mdnsPacket->Deserialize(buffer, nbytes); if (bytesRead != nbytes) { QCC_DbgPrintf(("IpNameServiceImpl::HandleProtocolMessage(): Deserialize(): Error.")); return; } if (mdnsPacket->GetHeader().GetQRType() == MDNSHeader::MDNS_QUERY) { HandleProtocolQuery(mdnsPacket, remote, local); } else { HandleProtocolResponse(mdnsPacket, remote, local, interfaceIndex); } } } qcc::String IpNameServiceImpl::PeerInfo::ToString(const qcc::String& guid) const { String s; s += "guid=" + guid + "/" + GUID128(guid).ToShortString(); s += ",ip=" + unicastInfo.ToString(); return s; } void IpNameServiceImpl::PrintPeerInfoMap() { for (std::unordered_map, Hash, Equal>::iterator it = m_peerInfoMap.begin(); it != m_peerInfoMap.end(); ++it) { for (std::set::iterator pit = it->second.begin(); pit != it->second.end(); ++pit) { QCC_DbgHLPrintf((" %s", pit->ToString(it->first).c_str())); } } } bool IpNameServiceImpl::AddToPeerInfoMap(const qcc::String& guid, const qcc::IPEndpoint& ipEndpoint) { if (ipEndpoint.GetPort() == 0 || ipEndpoint.GetAddress() == IPAddress()) { return false; } m_mutex.Lock(); std::unordered_map, Hash, Equal>::iterator it = m_peerInfoMap.find(guid); if (it != m_peerInfoMap.end()) { bool foundEntry = false; for (std::set::iterator pit = it->second.begin(); !foundEntry && pit != it->second.end(); ++pit) { if (pit->unicastInfo == ipEndpoint) { foundEntry = true; Timespec now; GetTimeNow(&now); (*pit).lastResponseTimeStamp = now; } } if (!foundEntry) { PeerInfo peerInfo(ipEndpoint); it->second.insert(peerInfo); QCC_DbgHLPrintf(("Add to peer info map: %s", peerInfo.ToString(it->first).c_str())); } } else { PeerInfo peerInfo(ipEndpoint); std::set peerInfoList; peerInfoList.insert(peerInfo); m_peerInfoMap.insert(std::pair >(guid, peerInfoList)); QCC_DbgHLPrintf(("Add to peer info map: %s", peerInfo.ToString(guid).c_str())); } m_mutex.Unlock(); return true; } bool IpNameServiceImpl::RemoveFromPeerInfoMap(const qcc::String& guid) { m_mutex.Lock(); std::unordered_map, Hash, Equal>::iterator it = m_peerInfoMap.find(guid); if (it != m_peerInfoMap.end()) { for (std::set::iterator pit = it->second.begin(); pit != it->second.end(); ++pit) { QCC_DbgHLPrintf(("Remove from peer info map: %s", pit->ToString(guid).c_str())); } QCC_DbgHLPrintf(("Erase from peer info map: guid=%s", guid.c_str())); m_peerInfoMap.erase(guid); unordered_map, MDNSPacketTrackerEntry, HashPacketTracker, EqualPacketTracker>::iterator it1 = m_mdnsPacketTracker.begin(); while (it1 != m_mdnsPacketTracker.end()) { if (it1->first.first == guid) { m_mdnsPacketTracker.erase(it1++); } else { it1++; } } m_mutex.Unlock(); return true; } m_mutex.Unlock(); return false; } const uint32_t MDNS_PACKET_TRACKER_PURGE_TIMEOUT = 5 * 1000; /* 5 seconds */ void IpNameServiceImpl::PurgeMDNSPacketTracker() { Timespec now; GetTimeNow(&now); m_mutex.Lock(); unordered_map, MDNSPacketTrackerEntry, HashPacketTracker, EqualPacketTracker>::iterator it = m_mdnsPacketTracker.begin(); while (it != m_mdnsPacketTracker.end()) { if ((now - it->second.timeStamp) >= MDNS_PACKET_TRACKER_PURGE_TIMEOUT) { m_mdnsPacketTracker.erase(it++); } else { it++; } } m_mutex.Unlock(); } bool IpNameServiceImpl::IsMDNSPacketTrackerEmpty() { m_mutex.Lock(); bool isEmpty = m_mdnsPacketTracker.empty(); m_mutex.Unlock(); return isEmpty; } bool IpNameServiceImpl::UpdateMDNSPacketTracker(qcc::String guid, const qcc::IPEndpoint& endpoint, uint16_t burstId) { //QCC_DbgPrintf(("IpNameServiceImpl::UpdateMDNSPacketTracker(%s, %s,%d)", guid.c_str(), endpoint.ToString().c_str(), burstId)); // // We check for the entry in MDNSPacketTracker // If we find it we return false since that implies that we have seen a packet from this burst // If we do not find it we return true that implies that we have not seen a packet from this burst. // We add/update the guid with this burst id // pair key(guid, endpoint); unordered_map, MDNSPacketTrackerEntry, HashPacketTracker, EqualPacketTracker>::iterator it = m_mdnsPacketTracker.find(key); // Check if the GUID is present in the Map // If Yes check if the incoming burst id is same or lower if (it != m_mdnsPacketTracker.end()) { // Drop the packet if burst id is lower or same if (it->second.burstId >= burstId) { return false; } // Update the last seen burst id from this guid MDNSPacketTrackerEntry entry(burstId); it->second = entry; } else { MDNSPacketTrackerEntry entry(burstId); bool wasEmpty = m_mdnsPacketTracker.empty(); // GUID is not present in the Map so we add the entry m_mdnsPacketTracker[key] = entry; if (wasEmpty) { m_packetScheduler.Alert(); } } return true; } void IpNameServiceImpl::HandleProtocolResponse(MDNSPacket mdnsPacket, const qcc::IPEndpoint& remote, const qcc::IPEndpoint& local, int32_t interfaceIndex) { // Get IPv4 address of interface for this message (message may have been // received on the IPv6 address). This will be used as a sanity check later // against the connect spec in the message. String ifName; int32_t ifIndexV4 = -1; if (interfaceIndex != -1) { for (uint32_t i = 0; i < m_liveInterfaces.size(); ++i) { if ((uint32_t)interfaceIndex == m_liveInterfaces[i].m_index) { ifName = m_liveInterfaces[i].m_interfaceName; if (m_liveInterfaces[i].m_address.IsIPv4()) { ifIndexV4 = i; break; } } } } // Check if someone is providing info. about an alljoyn service. MDNSResourceRecord* answerTcp; MDNSResourceRecord* answerUdp; TransportMask transportMask = TRANSPORT_NONE; bool isAllJoynResponse = false; if (mdnsPacket->GetAnswer("_alljoyn._tcp.local.", MDNSResourceRecord::PTR, &answerTcp)) { transportMask |= TRANSPORT_TCP; isAllJoynResponse = true; } if (mdnsPacket->GetAnswer("_alljoyn._udp.local.", MDNSResourceRecord::PTR, &answerUdp)) { transportMask |= TRANSPORT_UDP; isAllJoynResponse = true; } if (!isAllJoynResponse) { QCC_DbgPrintf(("IpNameServiceImpl::HandleProtocolResponse Ignoring Non-AllJoyn related response")); return; } MDNSResourceRecord* refRecord; if (!mdnsPacket->GetAdditionalRecord("sender-info.*", MDNSResourceRecord::TXT, MDNSTextRData::TXTVERS, &refRecord)) { QCC_DbgPrintf(("Ignoring response without sender-info")); return; } MDNSSenderRData* refRData = static_cast(refRecord->GetRData()); if (!refRData) { QCC_DbgPrintf(("Ignoring response with invalid sender-info")); return; } String guid = refRecord->GetDomainName().substr(sizeof("sender-info.") - 1, 32); if (guid == m_guid) { QCC_DbgPrintf(("Ignoring my own response")); return; } IPEndpoint r4, r6; IPEndpoint u4, u6; IPEndpoint ns4; ns4.port = refRData->GetIPV4ResponsePort(); if (transportMask & TRANSPORT_TCP) { MDNSPtrRData* ptrRDataTcp = static_cast(answerTcp->GetRData()); if (!ptrRDataTcp) { QCC_DbgPrintf(("Ignoring response with invalid sender-info")); return; } MDNSResourceRecord* srvAnswerTcp; if (!mdnsPacket->GetAnswer(ptrRDataTcp->GetPtrDName(), MDNSResourceRecord::SRV, &srvAnswerTcp)) { QCC_DbgPrintf(("Ignoring response without srv")); return; } MDNSSrvRData* srvRDataTcp = static_cast(srvAnswerTcp->GetRData()); if (!srvRDataTcp) { QCC_DbgPrintf(("Ignoring response with invalid srv")); return; } r4.port = srvRDataTcp->GetPort(); MDNSResourceRecord* txtAnswerTcp; if (mdnsPacket->GetAnswer(ptrRDataTcp->GetPtrDName(), MDNSResourceRecord::TXT, MDNSTextRData::TXTVERS, &txtAnswerTcp)) { MDNSTextRData* txtRDataTcp = static_cast(txtAnswerTcp->GetRData()); if (!txtRDataTcp) { QCC_DbgPrintf(("Ignoring response with invalid txt")); return; } r6.port = StringToU32(txtRDataTcp->GetValue("r6port")); } MDNSResourceRecord* aRecord; if (mdnsPacket->GetAdditionalRecord(srvRDataTcp->GetTarget(), MDNSResourceRecord::A, &aRecord)) { MDNSARData* aRData = static_cast(aRecord->GetRData()); if (!aRData) { QCC_DbgPrintf(("Ignoring response with invalid ipv4 address")); return; } r4.addr = aRData->GetAddr(); ns4.addr = aRData->GetAddr(); } MDNSResourceRecord* aaaaRecord; if (mdnsPacket->GetAdditionalRecord(srvRDataTcp->GetTarget(), MDNSResourceRecord::AAAA, &aaaaRecord)) { MDNSAAAARData* aaaaRData = static_cast(aaaaRecord->GetRData()); if (!aaaaRData) { QCC_DbgPrintf(("Ignoring response with invalid ipv6 address")); return; } r6.addr = aaaaRData->GetAddr(); } } if (transportMask & TRANSPORT_UDP) { MDNSPtrRData* ptrRDataUdp = static_cast(answerUdp->GetRData()); if (!ptrRDataUdp) { QCC_DbgPrintf(("Ignoring response with invalid sender-info")); return; } MDNSResourceRecord* srvAnswerUdp; if (!mdnsPacket->GetAnswer(ptrRDataUdp->GetPtrDName(), MDNSResourceRecord::SRV, &srvAnswerUdp)) { QCC_DbgPrintf(("Ignoring response without srv")); return; } MDNSSrvRData* srvRDataUdp = static_cast(srvAnswerUdp->GetRData()); if (!srvRDataUdp) { QCC_DbgPrintf(("Ignoring response with invalid srv")); return; } u4.port = srvRDataUdp->GetPort(); MDNSResourceRecord* txtAnswerUdp; if (mdnsPacket->GetAnswer(ptrRDataUdp->GetPtrDName(), MDNSResourceRecord::TXT, MDNSTextRData::TXTVERS, &txtAnswerUdp)) { MDNSTextRData* txtRDataUdp = static_cast(txtAnswerUdp->GetRData()); if (!txtRDataUdp) { QCC_DbgPrintf(("Ignoring response with invalid txt")); return; } u6.port = StringToU32(txtRDataUdp->GetValue("u6port")); } MDNSResourceRecord* aRecord; if (mdnsPacket->GetAdditionalRecord(srvRDataUdp->GetTarget(), MDNSResourceRecord::A, &aRecord)) { MDNSARData* aRData = static_cast(aRecord->GetRData()); if (!aRData) { QCC_DbgPrintf(("Ignoring response with invalid ipv4 address")); return; } u4.addr = aRData->GetAddr(); ns4.addr = aRData->GetAddr(); } MDNSResourceRecord* aaaaRecord; if (mdnsPacket->GetAdditionalRecord(srvRDataUdp->GetTarget(), MDNSResourceRecord::AAAA, &aaaaRecord)) { MDNSAAAARData* aaaaRData = static_cast(aaaaRecord->GetRData()); if (!aaaaRData) { QCC_DbgPrintf(("Ignoring response with invalid ipv6 address")); return; } u6.addr = aaaaRData->GetAddr(); } } m_mutex.Lock(); // // We first check if this packet was received over MDNS multicast port 5353 // If Yes, only then are we interested in keeping track of the burst ID. // We check if we have seen this packet with burst id from this GUID // If Yes, we do not process this packet // If No, we process this packet // If No, This is a unicast response in which case we need not keep track of Burst IDs // if (local.port == MULTICAST_MDNS_PORT) { // We need to check if this packet is from a burst which we have seen before in which case we will ignore it if (!UpdateMDNSPacketTracker(guid, ns4, refRData->GetSearchID())) { QCC_DbgPrintf(("Ignoring response with duplicate burst ID")); m_mutex.Unlock(); return; } } if (r4.addr.IsIPv4() && (ifIndexV4 == -1 || !SameNetwork(m_liveInterfaces[ifIndexV4].m_prefixlen, m_liveInterfaces[ifIndexV4].m_address, r4.addr))) { // // We expect that a v4 addr may be sent via a v6 link local address. However // if a v4 addr is sent via a v4 address then someone is misbehaving, so log // a warning. // if (remote.addr.IsIPv4()) { QCC_DbgPrintf(("Ignoring advertisement from %s for %s received on %s", remote.addr.ToString().c_str(), r4.addr.ToString().c_str(), ifName.c_str())); } m_mutex.Unlock(); return; } // // Handle the advertised names first in case one of the registered response // handlers triggers an action that requires the name to be in the name // table (e.g. JoinSession). // HandleAdvertiseResponse(mdnsPacket, guid, ns4, r4, r6, u4, u6); m_protectListeners = true; m_mutex.Unlock(); bool handled = false; for (list::iterator it = m_listeners.begin(); !handled && it != m_listeners.end(); ++it) { handled = (*it)->ResponseHandler(transportMask, mdnsPacket, local.port); } m_mutex.Lock(); m_protectListeners = false; m_mutex.Unlock(); } bool IpNameServiceImpl::HandleAdvertiseResponse(MDNSPacket mdnsPacket, const qcc::String& guid, const qcc::IPEndpoint& ns4, const qcc::IPEndpoint& r4, const qcc::IPEndpoint& r6, const qcc::IPEndpoint& u4, const qcc::IPEndpoint& u6) { uint32_t numMatches = mdnsPacket->GetNumMatches("advertise.*", MDNSResourceRecord::TXT, MDNSTextRData::TXTVERS); for (uint32_t match = 0; match < numMatches; match++) { MDNSResourceRecord* advRecord; if (!mdnsPacket->GetAdditionalRecordAt("advertise.*", MDNSResourceRecord::TXT, MDNSTextRData::TXTVERS, match, &advRecord)) { return false; } MDNSAdvertiseRData* advRData = static_cast(advRecord->GetRData()); if (!advRData) { QCC_DbgPrintf(("Ignoring response with invalid advertisement info")); return true; } uint32_t ttl = advRecord->GetRRttl(); // // We need to populate our structure that keeps track of unicast ports of // services so that they can be polled for presence // if (ttl != 0) { AddToPeerInfoMap(guid, ns4); } vector namesTcp; vector namesUdp; for (uint8_t i = 0; i < advRData->GetNumNames(TRANSPORT_TCP | TRANSPORT_UDP); ++i) { String temp = advRData->GetNameAt(TRANSPORT_TCP | TRANSPORT_UDP, i); namesTcp.push_back(temp); namesUdp.push_back(temp); } for (uint8_t i = 0; i < advRData->GetNumNames(TRANSPORT_TCP); ++i) { String temp = advRData->GetNameAt(TRANSPORT_TCP, i); namesTcp.push_back(temp); } for (uint8_t i = 0; i < advRData->GetNumNames(TRANSPORT_UDP); ++i) { String temp = advRData->GetNameAt(TRANSPORT_UDP, i); namesUdp.push_back(temp); } // // Life is easier if we keep these things sorted. Don't rely on the source // (even though it is really us) to do so. // sort(namesTcp.begin(), namesTcp.end()); sort(namesUdp.begin(), namesUdp.end()); // // In the version two protocol, the maximum size static buffer for the // longest bus address we can generate corresponds to two fully occupied // IPv4 addresses and two fully occupied IPV6 addresses. So, we figure // that we need 31 bytes for the IPv4 endpoint information, // 55 bytes for the IPv6 endpoint information and one extra // comma: // // "addr=192.168.100.101,port=65535," // "addr=ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff,port=65535" // // Adding a byte for the trailing '\0' we come up with 88 bytes of bus // address. C++ purists will object to using the C stdio routines but // they are simpler and faster since there are no memory allocations or // reallocations. // // Note that we do not prepend the bus address with the transport name, // i.e. "tcp:" since we assume that the transport knows its own name. // char busAddressTcp[88]; char busAddressUdp[88]; busAddressTcp[0] = '\0'; busAddressUdp[0] = '\0'; char addr6buf[60]; addr6buf[0] = '\0'; bool needComma = false; if (r4.port != 0 && r4.addr != IPAddress()) { snprintf(busAddressTcp, sizeof(busAddressTcp), "addr=%s,port=%d", r4.addr.ToString().c_str(), r4.port); needComma = true; } if (r6.port != 0 && r6.addr != IPAddress()) { if (needComma) { snprintf(addr6buf, sizeof(addr6buf), ",addr=%s,port=%d", r6.addr.ToString().c_str(), r6.port); } else { snprintf(addr6buf, sizeof(addr6buf), "addr=%s,port=%d", r6.addr.ToString().c_str(), r6.port); } strncat(busAddressTcp, &addr6buf[0], sizeof(addr6buf)); } needComma = false; if (u4.port != 0 && u4.addr != IPAddress()) { snprintf(busAddressUdp, sizeof(busAddressUdp), "addr=%s,port=%d", u4.addr.ToString().c_str(), u4.port); needComma = true; } if (u6.port != 0 && u6.addr != IPAddress()) { if (needComma) { snprintf(addr6buf, sizeof(addr6buf), ",addr=%s,port=%d", u6.addr.ToString().c_str(), u6.port); } else { snprintf(addr6buf, sizeof(addr6buf), "addr=%s,port=%d", u6.addr.ToString().c_str(), u6.port); } strncat(busAddressUdp, &addr6buf[0], sizeof(addr6buf)); } if ((namesUdp.size() > 0) && m_callback[TRANSPORT_INDEX_UDP]) { m_protect_callback = true; m_mutex.Unlock(); (*m_callback[TRANSPORT_INDEX_UDP])(busAddressUdp, guid, namesUdp, ttl); m_mutex.Lock(); m_protect_callback = false; } if ((namesTcp.size() > 0) && m_callback[TRANSPORT_INDEX_TCP]) { m_protect_callback = true; m_mutex.Unlock(); (*m_callback[TRANSPORT_INDEX_TCP])(busAddressTcp, guid, namesTcp, ttl); m_mutex.Lock(); m_protect_callback = false; } } return true; } void IpNameServiceImpl::HandleProtocolQuery(MDNSPacket mdnsPacket, const qcc::IPEndpoint& remote, const qcc::IPEndpoint& local) { QCC_UNUSED(remote); bool isAllJoynQuery = true; // Check if someone is asking about an alljoyn service. MDNSQuestion* questionTcp; MDNSQuestion* questionUdp; TransportMask completeTransportMask = TRANSPORT_NONE; if (mdnsPacket->GetQuestion("_alljoyn._tcp.local.", &questionTcp)) { isAllJoynQuery = true; completeTransportMask |= TRANSPORT_TCP; } if (mdnsPacket->GetQuestion("_alljoyn._udp.local.", &questionUdp)) { isAllJoynQuery = true; completeTransportMask |= TRANSPORT_UDP; } if (!isAllJoynQuery) { QCC_DbgPrintf(("IpNameServiceImpl::HandleProtocolQuery Ignoring Non-AllJoyn related query")); return; } MDNSResourceRecord* refRecord; if (!mdnsPacket->GetAdditionalRecord("sender-info.*", MDNSResourceRecord::TXT, MDNSTextRData::TXTVERS, &refRecord)) { QCC_DbgPrintf(("Ignoring query without sender info")); return; } MDNSSenderRData* refRData = static_cast(refRecord->GetRData()); if (!refRData) { QCC_DbgPrintf(("Ignoring query with invalid sender info")); return; } IPEndpoint dst(refRData->GetIPV4ResponseAddr(), refRData->GetIPV4ResponsePort()); String guid = refRecord->GetDomainName().substr(sizeof("sender-info.") - 1, 32); if (guid == m_guid) { QCC_DbgPrintf(("Ignoring my own query")); return; } m_mutex.Lock(); // // We first check if this packet was received over MDNS multicast port 5353 // If Yes, only then are we interested in keeping track of the burst ID. // We check if we have seen this packet with burst id from this GUID // If Yes, we do not process this packet // If No, we process this packet // If No, This is a unicast response in which case we need not keep track of Burst IDs // if (local.port == MULTICAST_MDNS_PORT) { // We need to check if this packet is from a burst which we have seen before in which case we will ignore it if (!UpdateMDNSPacketTracker(guid, dst, refRData->GetSearchID())) { QCC_DbgPrintf(("Ignoring query with duplicate burst ID")); m_mutex.Unlock(); return; } } m_protectListeners = true; m_mutex.Unlock(); bool handled = false; for (list::iterator it = m_listeners.begin(); !handled && it != m_listeners.end(); ++it) { handled = (*it)->QueryHandler(completeTransportMask, mdnsPacket, local, dst); } m_mutex.Lock(); m_protectListeners = false; if (handled) { m_mutex.Unlock(); return; } HandleSearchQuery(completeTransportMask, mdnsPacket, local, guid, dst); m_mutex.Unlock(); } bool IpNameServiceImpl::HandleSearchQuery(TransportMask completeTransportMask, MDNSPacket mdnsPacket, const qcc::IPEndpoint& src, const qcc::String& guid, const qcc::IPEndpoint& dst) { QCC_UNUSED(guid); QCC_DbgPrintf(("IpNameServiceImpl::HandleSearchQuery")); MDNSResourceRecord* searchRecord; if (!mdnsPacket->GetAdditionalRecord("search.*", MDNSResourceRecord::TXT, MDNSTextRData::TXTVERS, &searchRecord)) { return false; } MDNSSearchRData* searchRData = static_cast(searchRecord->GetRData()); if (!searchRData) { QCC_DbgPrintf(("Ignoring query with invalid search info")); return true; } vector wkns; // // The who-has message doesn't specify which transport is doing the asking. // This is an oversight and should be fixed in a subsequent version. The // only reasonable thing to do is to return name matches found in all of // the advertising transports. // for (uint32_t index = 0; index < N_TRANSPORTS; ++index) { // // If there are no names being advertised by the transport identified by // its index (actively or quietly), there is nothing to do. // if (m_advertised[index].empty() && m_advertised_quietly[index].empty()) { continue; } // // Loop through the names we are being asked about, and if we have // advertised any of them, we are going to need to respond to this // question. Keep track of whether or not any of our corresponding // advertisements are quiet, since we want to respond quietly to a // question about a quiet advertisements. That is, if any of the names // the client is asking about corresponds to a quiet advertisement we // respond directly to the client and do not multicast the response. // The only way we multicast a response is if the client does not ask // about any of our quietly advertised names. // // Becuse of this requirement, we loop through all of the names in the // who-has message to see if any of them correspond to quiet // advertisements. We don't just break out and respond if we find any // old match since it may be the case that the last name is the quiet // one. // bool respond = false; bool respondQuietly = false; for (int i = 0; i < searchRData->GetNumNames(); ++i) { String wkn = searchRData->GetNameAt(i); if (searchRData->SendMatchOnly()) { wkns.push_back(wkn); } // // Zero length strings are unmatchable. If you want to do a wildcard // match, you've got to send a wildcard character. // if (wkn.size() == 0) { continue; } // // Check to see if this name on the list of names we actively advertise. // for (set::iterator j = m_advertised[index].begin(); j != m_advertised[index].end(); ++j) { // // The requested name comes in from the WhoHas message and we // allow wildcards there. // if (WildcardMatch((*j), wkn)) { QCC_DbgPrintf(("IpNameServiceImpl::HandleSearchQuery(): request for %s does not match my %s", wkn.c_str(), (*j).c_str())); continue; } else { respond = true; break; } } // // Check to see if this name on the list of names we quietly advertise. // for (set::iterator j = m_advertised_quietly[index].begin(); j != m_advertised_quietly[index].end(); ++j) { // // The requested name comes in from the WhoHas message and we // allow wildcards there. // if (WildcardMatch((*j), wkn)) { QCC_DbgPrintf(("IpNameServiceImpl::HandleSearchQuery(): request for %s does not match my %s", wkn.c_str(), (*j).c_str())); continue; } else { respond = true; respondQuietly = true; break; } } } // // Since any response we send must include all of the advertisements we // are exporting; this just means to retransmit all of our advertisements. // if (respond) { m_mutex.Unlock(); if (dst.GetAddress().IsIPv4()) { Retransmit(index, false, respondQuietly, dst, src, TRANSMIT_V2, completeTransportMask, wkns); } m_mutex.Lock(); } } return true; } QStatus IpNameServiceImpl::Start(void* arg, qcc::ThreadListener* listener) { QCC_UNUSED(arg); QCC_DbgPrintf(("IpNameServiceImpl::Start()")); m_mutex.Lock(); assert(IsRunning() == false); m_state = IMPL_RUNNING; QCC_DbgPrintf(("IpNameServiceImpl::Start(): Starting thread")); QStatus status = Thread::Start(this, listener); QCC_DbgPrintf(("IpNameServiceImpl::Start(): Started")); m_mutex.Unlock(); m_packetScheduler.Start(); return status; } bool IpNameServiceImpl::Started() { return IsRunning(); } QStatus IpNameServiceImpl::Stop() { QCC_DbgPrintf(("IpNameServiceImpl::Stop()")); m_mutex.Lock(); if (m_state != IMPL_SHUTDOWN) { m_state = IMPL_STOPPING; } QCC_DbgPrintf(("IpNameServiceImpl::Stop(): Stopping thread")); QStatus status = Thread::Stop(); QCC_DbgPrintf(("IpNameServiceImpl::Stop(): Stopped")); m_packetScheduler.Stop(); m_mutex.Unlock(); return status; } QStatus IpNameServiceImpl::Join() { m_packetScheduler.Join(); QCC_DbgPrintf(("IpNameServiceImpl::Join()")); assert(m_state == IMPL_STOPPING || m_state == IMPL_SHUTDOWN); QCC_DbgPrintf(("IpNameServiceImpl::Join(): Joining thread")); QStatus status = Thread::Join(); QCC_DbgPrintf(("IpNameServiceImpl::Join(): Joined")); m_state = IMPL_SHUTDOWN; return status; } // // Count the number of bits set in a 32-bit word using one of the many // well-known high-performance algorithms for calculating Population Count while // determining Hamming Distance. It's completely obscure and mostly // incomprehensible at first glance. Google hamming distance or popcount if you // dare. // // This is a well-investigated operation so similar code snippets are widely // available on the web and are in the public domain. // // We use this method in the process of ensuring that only one bit is set in a // TransportMask. This is because there must be a one-to-one correspondence // between a transport mask bit and a transport. // uint32_t IpNameServiceImpl::CountOnes(uint32_t data) { QCC_DbgPrintf(("IpNameServiceImpl::CountOnes(0x%x)", data)); data = data - ((data >> 1) & 0x55555555); data = (data & 0x33333333) + ((data >> 2) & 0x33333333); uint32_t result = (((data + (data >> 4)) & 0x0F0F0F0F) * 0x01010101) >> 24; QCC_DbgPrintf(("IpNameServiceImpl::CountOnes(): %d bits are set", result)); return result; } // // Convert a data word with one bit set to an index into a table corresponding // to that bit. This uses one of the many well-known high performance // algorithms for counting the number of consecutive trailing zero bits in an // integer. This is similar to finding log base two of the data word. Google // consecutive trailing zero bits if you dare. // // This is a well-investigated operation so similar code snippets are widely // available on the web and are in the public domain. // // We use this method to convert from a transport mask to an index into a table // corresponding to some property of the transport that is using the name service. // We assume that the data has been verified to contain one bit set in the low // order word. // uint32_t IpNameServiceImpl::IndexFromBit(uint32_t data) { QCC_DbgPrintf(("IpNameServiceImpl::IndexFromBit(0x%x)", data)); uint32_t c = 32; data &= -signed(data); if (data) { --c; } if (data & 0x0000ffff) { c -= 16; } if (data & 0x00ff00ff) { c -= 8; } if (data & 0x0f0f0f0f) { c -= 4; } if (data & 0x33333333) { c -= 2; } if (data & 0x55555555) { c -= 1; } // // If the number of trailing bits that are set to zero is count, then the // first set bit must be at position count + 1. Since array indices are // zero-based, the index into an array corresponding to the first set bit // is count (index == number of trailing zero bits). // QCC_DbgPrintf(("IpNameServiceImpl::IndexFromBit(): Index is %d.", c)); assert(c < 16 && "IpNameServiceImpl::IndexFromBit(): Bad transport index"); return c; } // // Convert a data word with one bit set to an index into a table corresponding // to that bit. This uses one of the many well-known high performance // algorithms for counting the number of consecutive trailing zero bits in an // integer. This is similar to finding log base two of the data word. Google // consecutive trailing zero bits if you dare. // // This is a well-investigated operation so similar code snippets are widely // available on the web and are in the public domain. // // We use this method to convert from a transport mask to an index into a table // corresponding to some property of the transport that is using the name service. // We assume that the data has been verified to contain one bit set in the low // order word. // TransportMask IpNameServiceImpl::MaskFromIndex(uint32_t index) { QCC_DbgPrintf(("IpNameServiceImpl::MaskFromIndex(%d.)", index)); uint32_t result = 1 << index; QCC_DbgPrintf(("IpNameServiceImpl::MaskFromIndex(): Bit is 0x%x", result)); return result; } set IpNameServiceImpl::GetAdvertising(TransportMask transportMask) { set set_common, set_return; std::set empty; set_intersection(m_advertised[TRANSPORT_INDEX_TCP].begin(), m_advertised[TRANSPORT_INDEX_TCP].end(), m_advertised[TRANSPORT_INDEX_UDP].begin(), m_advertised[TRANSPORT_INDEX_UDP].end(), std::inserter(set_common, set_common.end())); if (transportMask == TRANSPORT_TCP || transportMask == TRANSPORT_UDP) { uint32_t transportIndex = IndexFromBit(transportMask); if (transportIndex >= 16) { return empty; } set_difference(m_advertised[transportIndex].begin(), m_advertised[transportIndex].end(), set_common.begin(), set_common.end(), std::inserter(set_return, set_return.end())); return set_return; } if (transportMask == (TRANSPORT_TCP | TRANSPORT_UDP)) { return set_common; } return empty; } set IpNameServiceImpl::GetAdvertisingQuietly(TransportMask transportMask) { set set_common, set_return; std::set empty; set_intersection(m_advertised_quietly[TRANSPORT_INDEX_TCP].begin(), m_advertised_quietly[TRANSPORT_INDEX_TCP].end(), m_advertised_quietly[TRANSPORT_INDEX_UDP].begin(), m_advertised_quietly[TRANSPORT_INDEX_UDP].end(), std::inserter(set_common, set_common.end())); if (transportMask == TRANSPORT_TCP || transportMask == TRANSPORT_UDP) { uint32_t transportIndex = IndexFromBit(transportMask); if (transportIndex >= 16) { return empty; } set_difference(m_advertised_quietly[transportIndex].begin(), m_advertised_quietly[transportIndex].end(), set_common.begin(), set_common.end(), std::inserter(set_return, set_return.end())); return set_return; } if (transportMask == (TRANSPORT_TCP | TRANSPORT_UDP)) { return set_common; } return empty; } bool IpNameServiceImpl::PurgeAndUpdatePacket(MDNSPacket mdnspacket, bool updateSid) { MDNSResourceRecord* refRecord; mdnspacket->GetAdditionalRecord("sender-info.*", MDNSResourceRecord::TXT, MDNSTextRData::TXTVERS, &refRecord); MDNSSenderRData* refRData = static_cast(refRecord->GetRData()); int32_t id = IncrementAndFetch(&INCREMENTAL_PACKET_ID); if (updateSid) { refRData->SetSearchID(id); } if (mdnspacket->GetHeader().GetQRType() == MDNSHeader::MDNS_QUERY) { MDNSResourceRecord* searchRecord; mdnspacket->GetAdditionalRecord("search.*", MDNSResourceRecord::TXT, MDNSTextRData::TXTVERS, &searchRecord); MDNSSearchRData* searchRData = static_cast(searchRecord->GetRData()); set set_union_tcp_udp; set_union(m_v2_queries[TRANSPORT_INDEX_TCP].begin(), m_v2_queries[TRANSPORT_INDEX_TCP].end(), m_v2_queries[TRANSPORT_INDEX_UDP].begin(), m_v2_queries[TRANSPORT_INDEX_UDP].end(), std::inserter(set_union_tcp_udp, set_union_tcp_udp.end())); uint32_t numSearch = searchRData->GetNumSearchCriteria(); for (uint32_t k = 0; k < numSearch; k++) { String crit = searchRData->GetSearchCriterion(k); if (std::find(set_union_tcp_udp.begin(), set_union_tcp_udp.end(), crit) == set_union_tcp_udp.end()) { searchRData->RemoveSearchCriterion(k); k--; numSearch = searchRData->GetNumSearchCriteria(); } } if (m_v2_queries[TRANSPORT_INDEX_TCP].size() == 0) { //Remove TCP PTR/SRV/TXT records MDNSResourceRecord* ptrRecord; if (mdnspacket->GetAnswer("_alljoyn._tcp.local.", MDNSResourceRecord::PTR, &ptrRecord)) { MDNSPtrRData* ptrRData = static_cast(ptrRecord->GetRData()); String name = ptrRData->GetPtrDName(); mdnspacket->RemoveAnswer(name, MDNSResourceRecord::SRV); mdnspacket->RemoveAnswer(name, MDNSResourceRecord::TXT); mdnspacket->RemoveAnswer("_alljoyn._tcp.local.", MDNSResourceRecord::PTR); } } if (m_v2_queries[TRANSPORT_INDEX_UDP].size() == 0) { //Remove UDP PTR/SRV/TXT records MDNSResourceRecord* ptrRecord; if (mdnspacket->GetAnswer("_alljoyn._udp.local.", MDNSResourceRecord::PTR, &ptrRecord)) { MDNSPtrRData* ptrRData = static_cast(ptrRecord->GetRData()); String name = ptrRData->GetPtrDName(); mdnspacket->RemoveAnswer(name, MDNSResourceRecord::SRV); mdnspacket->RemoveAnswer(name, MDNSResourceRecord::TXT); mdnspacket->RemoveAnswer("_alljoyn._udp.local.", MDNSResourceRecord::PTR); } } return (numSearch > 0); } else { MDNSResourceRecord* advRecord; mdnspacket->GetAdditionalRecord("advertise.*", MDNSResourceRecord::TXT, MDNSTextRData::TXTVERS, &advRecord); MDNSAdvertiseRData* advRData = static_cast(advRecord->GetRData()); TransportMask transportMaskArr[3] = { TRANSPORT_TCP, TRANSPORT_UDP, TRANSPORT_TCP | TRANSPORT_UDP }; uint32_t numNamesTotal = 0; uint32_t ttl = advRecord->GetRRttl(); uint32_t numNames[3]; for (int i = 0; i < 3; i++) { TransportMask tm = transportMaskArr[i]; set advertising = GetAdvertising(tm); numNames[i] = advRData->GetNumNames(tm); for (uint32_t k = 0; k < numNames[i]; k++) { if (ttl == 0) { //If this is a packet with ttl == 0, ensure that we are NOT advertising the names mentioned in the packet. if (std::find(advertising.begin(), advertising.end(), advRData->GetNameAt(tm, k)) != advertising.end()) { advRData->RemoveNameAt(tm, k); // a name has been removed from the IsAt response header make // sure the numNames used in the for loop is updated to reflect // the removal of that name. k = k - 1; numNames[i] = advRData->GetNumNames(tm); } } else { //If this is a packet with ttl >0, ensure that we are still advertising all the names mentioned in the packet. // If only one of the transports has been enabled because the interface specified for the other transport // is yet to be IFF_UP, then restrict the search space to only the transport that is enabled. if ((tm == (TRANSPORT_TCP | TRANSPORT_UDP)) && m_enabledReliableIPv4[TRANSPORT_INDEX_TCP] && !m_enabledUnreliableIPv4[TRANSPORT_INDEX_UDP]) { advertising = GetAdvertising(TRANSPORT_TCP); } if ((tm == (TRANSPORT_TCP | TRANSPORT_UDP)) && !m_enabledReliableIPv4[TRANSPORT_INDEX_TCP] && m_enabledUnreliableIPv4[TRANSPORT_INDEX_UDP]) { advertising = GetAdvertising(TRANSPORT_UDP); } if (std::find(advertising.begin(), advertising.end(), advRData->GetNameAt(tm, k)) == advertising.end()) { advRData->RemoveNameAt(tm, k); // a name has been removed from the IsAt response header make // sure the numNames used in the for loop is updated to reflect // the removal of that name. k = k - 1; numNames[i] = advRData->GetNumNames(tm); } } } numNamesTotal += numNames[i]; } if (numNames[0] == 0 && numNames[2] == 0) { //Remove TCP PTR/SRV/TXT records MDNSResourceRecord* ptrRecord; if (mdnspacket->GetAnswer("_alljoyn._tcp.local.", MDNSResourceRecord::PTR, &ptrRecord)) { MDNSPtrRData* ptrRData = static_cast(ptrRecord->GetRData()); String name = ptrRData->GetPtrDName(); mdnspacket->RemoveAnswer(name, MDNSResourceRecord::SRV); mdnspacket->RemoveAnswer(name, MDNSResourceRecord::TXT); mdnspacket->RemoveAnswer("_alljoyn._tcp.local.", MDNSResourceRecord::PTR); } } if (numNames[1] == 0 && numNames[2] == 0) { //Remove UDP PTR/SRV/TXT records MDNSResourceRecord* ptrRecord; if (mdnspacket->GetAnswer("_alljoyn._udp.local.", MDNSResourceRecord::PTR, &ptrRecord)) { MDNSPtrRData* ptrRData = static_cast(ptrRecord->GetRData()); String name = ptrRData->GetPtrDName(); mdnspacket->RemoveAnswer(name, MDNSResourceRecord::SRV); mdnspacket->RemoveAnswer(name, MDNSResourceRecord::TXT); mdnspacket->RemoveAnswer("_alljoyn._udp.local.", MDNSResourceRecord::PTR); } } return (numNamesTotal > 0); } return false; } ThreadReturn STDCALL IpNameServiceImpl::PacketScheduler::Run(void* arg) { QCC_UNUSED(arg); m_impl.m_mutex.Lock(); while (!IsStopping()) { Timespec now; GetTimeNow(&now); uint32_t timeToSleep = (uint32_t)Event::WAIT_FOREVER; //Step 1: Collect all packets std::list subsequentBurstpackets; std::list initialBurstPackets; subsequentBurstpackets.clear(); initialBurstPackets.clear(); // If doAnyNetworkCallback is true, then one of the transports // is waiting for us to supply the list of live interfaces so // it can get things started. We only want to provide the // sub-set of live interfaces that have been requested by // each transport (by name or addr) when the callback is invoked. bool doAnyNetworkCallback = false; for (uint32_t transportIndex = 0; transportIndex < N_TRANSPORTS; transportIndex++) { if (m_impl.m_doNetworkCallback[transportIndex]) { doAnyNetworkCallback = true; break; } } if (doAnyNetworkCallback) { std::map ifMap; for (uint32_t i = 0; (m_impl.m_state == IMPL_RUNNING) && (i < m_impl.m_liveInterfaces.size()); ++i) { if (m_impl.m_liveInterfaces[i].m_address.IsIPv4()) { ifMap[m_impl.m_liveInterfaces[i].m_interfaceName] = m_impl.m_liveInterfaces[i].m_address; } } if (!ifMap.empty()) { for (uint32_t transportIndex = 0; transportIndex < N_TRANSPORTS; transportIndex++) { if (m_impl.m_networkEventCallback[transportIndex] && m_impl.m_doNetworkCallback[transportIndex]) { std::map transportIfMap; for (uint32_t j = 0; j < m_impl.m_requestedInterfaces[transportIndex].size(); j++) { for (std::map::iterator it = ifMap.begin(); it != ifMap.end(); it++) { qcc::String name = it->first; qcc::IPAddress addr = it->second; if (m_impl.m_requestedInterfaces[transportIndex][j].m_interfaceName == name || m_impl.m_requestedInterfaces[transportIndex][j].m_interfaceAddr == addr) { transportIfMap[name] = addr; } } } if (m_impl.m_any[transportIndex]) { transportIfMap = ifMap; } if (!transportIfMap.empty()) { m_impl.m_protect_net_callback = true; m_impl.m_mutex.Unlock(); (*m_impl.m_networkEventCallback[transportIndex])(ifMap); m_impl.m_mutex.Lock(); m_impl.m_protect_net_callback = false; } } m_impl.m_doNetworkCallback[transportIndex] = false; } } } //Collect network change burst packets if ((m_impl.m_networkChangeScheduleCount <= m_impl.m_retries) && ((m_impl.m_networkChangeScheduleCount == 0) || ((m_impl.m_networkChangeTimeStamp - now) < PACKET_TIME_ACCURACY_MS))) { #ifndef QCC_OS_GROUP_WINDOWS if (!m_impl.m_networkEvents.empty()) { for (std::set::const_iterator iter = m_impl.m_networkEvents.begin(); iter != m_impl.m_networkEvents.end(); iter++) { qcc::AddressFamily family = qcc::QCC_AF_UNSPEC; int32_t interfaceIndex = -1; if (NETWORK_EVENT_IF_FAMILY(*iter) == qcc::QCC_AF_INET_INDEX) { family = qcc::QCC_AF_INET; } if (NETWORK_EVENT_IF_FAMILY(*iter) == qcc::QCC_AF_INET6_INDEX) { family = qcc::QCC_AF_INET6; } interfaceIndex = NETWORK_EVENT_IF_INDEX(*iter); #if defined(QCC_OS_LINUX) // If this is a loopback interface and we have an event for IPv6 // address change, we also add an event for the IPv4 address of // the loopback interface as we don't get an event for IPv4 // address changes on ifdown/up on loopback interfaces unless // the IPv4 address is also removed. for (uint32_t i = 0; (m_impl.m_state == IMPL_RUNNING) && (i < m_impl.m_liveInterfaces.size()); ++i) { int currentIndex = m_impl.m_liveInterfaces[i].m_index; if (currentIndex == interfaceIndex && (m_impl.m_liveInterfaces[i].m_flags & qcc::IfConfigEntry::LOOPBACK)) { family = qcc::QCC_AF_UNSPEC; break; } } #endif m_impl.GetResponsePackets(subsequentBurstpackets, false, qcc::IPEndpoint("0.0.0.0", 0), TRANSMIT_V2, (TRANSPORT_TCP | TRANSPORT_UDP), interfaceIndex, family); m_impl.GetQueryPackets(subsequentBurstpackets, (TRANSMIT_V0_V1 | TRANSMIT_V2), interfaceIndex, family); } } #else m_impl.GetResponsePackets(subsequentBurstpackets); m_impl.GetQueryPackets(subsequentBurstpackets); #endif if (m_impl.m_networkChangeScheduleCount == 0) { m_impl.m_networkChangeTimeStamp = now + RETRY_INTERVALS[0] * 1000; std::map ifMap; #ifndef QCC_OS_GROUP_WINDOWS // For the transport callbacks, we want to include only the // interfaces that have changed their IPv4 addresses or the // loopback interfaces as these retain their IPv4 addresses // on interface down events on Linux. // In addition, we want to include the interfaces with IPv4 // addresses that have changed on platforms where we do not // have information about the address family that changed. // We also want to include all interfaces with IPv4 addresses // on platforms where we do not have information about which // interface index/address family has changed. for (std::set::const_iterator it = m_impl.m_networkEvents.begin(); it != m_impl.m_networkEvents.end(); it++) { for (uint32_t i = 0; (m_impl.m_state == IMPL_RUNNING) && (i < m_impl.m_liveInterfaces.size()); ++i) { bool sameInterfaceIndex = (m_impl.m_liveInterfaces[i].m_index == NETWORK_EVENT_IF_INDEX(*it)); bool interfaceAddrIsIPv4 = m_impl.m_liveInterfaces[i].m_address.IsIPv4(); bool ipv4OrUnspecifiedEvent = (NETWORK_EVENT_IF_FAMILY(*it) == qcc::QCC_AF_INET_INDEX || NETWORK_EVENT_IF_FAMILY(*it) == qcc::QCC_AF_UNSPEC_INDEX); bool loopbackInterface = ((m_impl.m_liveInterfaces[i].m_flags & qcc::IfConfigEntry::LOOPBACK) != 0); if (sameInterfaceIndex && interfaceAddrIsIPv4 && (ipv4OrUnspecifiedEvent || loopbackInterface)) { ifMap[m_impl.m_liveInterfaces[i].m_interfaceName] = m_impl.m_liveInterfaces[i].m_address; break; } } } #else for (uint32_t i = 0; (m_impl.m_state == IMPL_RUNNING) && (i < m_impl.m_liveInterfaces.size()); ++i) { if (m_impl.m_liveInterfaces[i].m_address.IsIPv4()) { ifMap[m_impl.m_liveInterfaces[i].m_interfaceName] = m_impl.m_liveInterfaces[i].m_address; } } #endif if (!ifMap.empty()) { for (uint32_t transportIndex = 0; transportIndex < N_TRANSPORTS; transportIndex++) { if (m_impl.m_networkEventCallback[transportIndex]) { std::map transportIfMap; for (uint32_t j = 0; j < m_impl.m_requestedInterfaces[transportIndex].size(); j++) { for (std::map::iterator it = ifMap.begin(); it != ifMap.end(); it++) { qcc::String name = it->first; qcc::IPAddress addr = it->second; if (m_impl.m_requestedInterfaces[transportIndex][j].m_interfaceName == name || m_impl.m_requestedInterfaces[transportIndex][j].m_interfaceAddr == addr) { transportIfMap[name] = addr; } } } if (m_impl.m_any[transportIndex]) { transportIfMap = ifMap; } if (!transportIfMap.empty()) { m_impl.m_protect_net_callback = true; m_impl.m_mutex.Unlock(); (*m_impl.m_networkEventCallback[transportIndex])(ifMap); m_impl.m_mutex.Lock(); m_impl.m_protect_net_callback = false; } } } } } else if (m_impl.m_networkChangeScheduleCount < m_impl.m_retries) { //adjust m_networkChangeTimeStamp assert(m_impl.m_networkChangeScheduleCount < ArraySize(RETRY_INTERVALS)); m_impl.m_networkChangeTimeStamp += RETRY_INTERVALS[m_impl.m_networkChangeScheduleCount] * 1000 + (BURST_RESPONSE_RETRIES) *BURST_RESPONSE_INTERVAL; } else { m_impl.m_networkEvents.clear(); } if (now < m_impl.m_networkChangeTimeStamp) { uint32_t delay = m_impl.m_networkChangeTimeStamp - now; if (timeToSleep > delay) { timeToSleep = delay; } } else { timeToSleep = 0; } m_impl.m_networkChangeScheduleCount++; } //Collect unsolicited Advertise/CancelAdvertise/FindAdvertisement burst packets std::list::iterator it = m_impl.m_burstQueue.begin(); it = m_impl.m_burstQueue.begin(); while (it != m_impl.m_burstQueue.end()) { if (((*it).nextScheduleTime - now) < PACKET_TIME_ACCURACY_MS) { uint32_t nsVersion; uint32_t msgVersion; (*it).packet->GetVersion(nsVersion, msgVersion); if (msgVersion == 2) { MDNSPacket mdnspacket = MDNSPacket::cast((*it).packet); //PurgeAndUpdatePacket will remove any names that have changed - not being advertised/discovered // and also update the burst ID in the packet. if (!m_impl.PurgeAndUpdatePacket(mdnspacket, (*it).scheduleCount != 0)) { //No names found, remove this packet m_impl.m_burstQueue.erase(it++); continue; } } if ((*it).scheduleCount == 0) { initialBurstPackets.push_back((*it).packet); (*it).nextScheduleTime += RETRY_INTERVALS[(*it).scheduleCount] * 1000 - BURST_RESPONSE_INTERVAL; } else if ((*it).scheduleCount < m_impl.m_retries) { subsequentBurstpackets.push_back((*it).packet); assert((*it).scheduleCount < ArraySize(RETRY_INTERVALS)); (*it).nextScheduleTime += RETRY_INTERVALS[(*it).scheduleCount] * 1000 + (BURST_RESPONSE_RETRIES) *BURST_RESPONSE_INTERVAL; } else { subsequentBurstpackets.push_back((*it).packet); // scheduleCount has reached max_retries, get rid of entry and advance iterator. m_impl.m_burstQueue.erase(it++); continue; } (*it).scheduleCount++; } if (now < (*it).nextScheduleTime) { uint32_t delay = (*it).nextScheduleTime - now; if (timeToSleep > delay) { timeToSleep = delay; } } else { timeToSleep = 0; } it++; } m_impl.m_mutex.Unlock(); //Step 2: Burst the packets uint32_t burstIndex = 0; while (burstIndex < BURST_RESPONSE_RETRIES && (!subsequentBurstpackets.empty() || !initialBurstPackets.empty()) && !IsStopping()) { //If this is the first burst in the schedule, queue one less packet, first one is queued by TriggerTransmission if (burstIndex != BURST_RESPONSE_RETRIES - 1) { for (std::list::const_iterator i = initialBurstPackets.begin(); i != initialBurstPackets.end(); i++) { Packet packet = *i; uint32_t nsVersion; uint32_t msgVersion; packet->GetVersion(nsVersion, msgVersion); if (msgVersion == 2) { m_impl.QueueProtocolMessage(*i); } } } for (std::list::const_iterator i = subsequentBurstpackets.begin(); i != subsequentBurstpackets.end(); i++) { Packet packet = *i; uint32_t nsVersion; uint32_t msgVersion; packet->GetVersion(nsVersion, msgVersion); if ((msgVersion == 2) || (burstIndex == 0)) { m_impl.QueueProtocolMessage(*i); } } // Wait for burst interval = BURST_RESPONSE_INTERVAL Event::Wait(Event::neverSet, BURST_RESPONSE_INTERVAL); GetStopEvent().ResetEvent(); burstIndex++; } m_impl.m_mutex.Lock(); //Step 3: Wait for a specific amount of time if (!IsStopping()) { if ((timeToSleep == Event::WAIT_FOREVER) && !m_impl.IsMDNSPacketTrackerEmpty()) { timeToSleep = MDNS_PACKET_TRACKER_PURGE_TIMEOUT; } m_impl.m_mutex.Unlock(); Event::Wait(Event::neverSet, timeToSleep); m_impl.PurgeMDNSPacketTracker(); GetStopEvent().ResetEvent(); m_impl.m_mutex.Lock(); } } m_impl.m_burstQueue.clear(); m_impl.m_mutex.Unlock(); return 0; } } // namespace ajn alljoyn-15.04b/alljoyn_core/router/ns/IpNameServiceImpl.h000066400000000000000000002051631255700255500234570ustar00rootroot00000000000000/** * @file * Data structures used for the AllJoyn IP Name Service */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _IP_NAME_SERVICE_IMPL_H #define _IP_NAME_SERVICE_IMPL_H #ifndef __cplusplus #error Only include IpNameService.h in C++ code. #endif #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include "IpNsProtocol.h" #include "IpNameService.h" #include "ConfigDB.h" namespace ajn { /** * @brief API to provide an implementation dependent IP (Layer 3) Name Service * for AllJoyn. * * The basic goal of this class is to provide a way for AllJoyn daemons, clients * and services to find an IP address and socket to use when connecting to * other daemons, clients and services. * * To first approximation, what we want is to allow a user of AllJoyn to search * for IP addresses and ports of daemons that provide some AllJoyn service, as * defined by a well-known or bus name. * * For example, a client may come up and ask, "where is an AllJoyn daemon that * implements the org.freedesktop.yadda bus name? The name service may * respond, for example, "one is at IP address 10.0.0.1, listening on port * 9955 and another is at IP address 10.0.0.2, listening on port 9955". The * client can then do a TCP connect to one of those addresses and ports. */ class IpNameServiceImpl : public qcc::Thread { public: class PacketScheduler : public qcc::Thread { public: PacketScheduler(IpNameServiceImpl& impl) : m_impl(impl) { }; virtual qcc::ThreadReturn STDCALL Run(void* arg); private: IpNameServiceImpl& m_impl; }; friend class PacketScheduler; static const TransportMask TRANSPORT_FIRST_OF_PAIR = TRANSPORT_TCP; static const TransportMask TRANSPORT_SECOND_OF_PAIR = TRANSPORT_UDP; uint32_t TRANSPORT_INDEX_TCP; uint32_t TRANSPORT_INDEX_UDP; /** * @brief The property value used to specify the wildcard interface name. */ static const char* INTERFACES_WILDCARD; /** * @brief The maximum size of a name, in general. */ static const uint32_t MAX_NAME_SIZE = 255; /** * @brief The default time for which an advertisement is valid, in seconds. */ static const uint32_t DEFAULT_DURATION = (120); /** * @brief The time at which an advertising daemon will retransmit its * advertisements. The advertising daemon should retransmit three * times during a default advertisement lifetime. The 2/3 is really * two thirds. This means that when the countdown time reaches two thirds * of the default duration value, one third of the time has expired and we * will retransmit. This, in turn, means we retransmit twice before a * remote daemon times out an entry since the timer is set to back to * DEFAULT_DURATION after every retransmission. Units are seconds. */ static const uint32_t RETRANSMIT_TIME = (DEFAULT_DURATION * 2 / 3); /** * @brief The time at which a daemon using an advertisement begins to think * that a remote daemon may be history. The remote daemon is supposed to * retransmit its well-known names periodically. If we don't receive one * of those keepalives, we will start to poke the remote daemon for a * keepalive. Units are seconds. */ static const uint32_t QUESTION_TIME = (DEFAULT_DURATION / 4); /** * @brief The interval at which the local service will ask a remote daemon * if it is alive. * * When */ static const uint32_t QUESTION_MODULUS = 10; /** * @brief The number of times we resend WhoHas requests with the time * between each request. * * Legacy 802.11 MACs do not do backoff and retransmission of packets * destined for multicast addresses. Therefore if there is a collision * on the air, a multicast packet will be silently dropped. We get * no indication of this at all up at the Socket level. To avoid this * unfortunately common occurrence, which would force a user to wait * for the next successful retransmission of exported names, we resend * each Locate request multiple times. * * The number of retries is based on the size of the RETRY_INTERVALS array. * The time between each Locate retries is the number of seconds indicated. * * If the array is { 1, 2, 6, 18 } * the first retry will occure in 1 second, second retry 3 seconds later, and * so on up till all intervals have been tried. * * RETRY_INTERVALS is set to { 1, 2, 6, 18 } by default */ static const uint32_t RETRY_INTERVALS[]; /** * The modulus indicating the minimum time between interface lazy updates. * Units are seconds. */ static const uint32_t LAZY_UPDATE_MIN_INTERVAL = 5; /** * The modulus indicating the maximum time between interface lazy updates. * Units are seconds. */ static const uint32_t LAZY_UPDATE_MAX_INTERVAL = 15; /** * @brief The time value indicating an advertisement is valid forever. */ static const uint32_t DURATION_INFINITE = 255; /** * The modulus indicating minimum time interval between the initial burst of * unsolicited IS-AT packets. Units are in mill-seconds. */ static const uint32_t BURST_RESPONSE_INTERVAL = 100; /** * The number burst responses sent each time the burst response is sent. * The BURST_RESPONSE_RETRIES must be greater than or equal 1 */ static const uint32_t BURST_RESPONSE_RETRIES = 3; /** * @brief The maximum size of the payload of a name service message. * * An easy choice for this number would be 64K - 8 bytes (the max size of * a UDP payload). The problem is we need to allocate a buffer of that * size on the receiver, and we really expect that payloads will be quite * small. * * Another option is to look at the maximum (or minimum) MTUs of the * interfaces over which we will send messages. This leads to possibly * confusing behaviors as different combinations of MTUs in different * machines can successfully support different numbers of names at * different times based on different configurations. * * It seems better to have a hard limit that can be easily worked around * than a possibly confusing limit that implies flakiness. We can always * support 1500 bytes through UDP fragmentation, and we will be using * IP and multicast-capable devices, so we expect an MTU of 1500 in the * typical case. So we just work with that as a compromise. We then take * the typical MTU and subtrace UDP, IP and Ethernet Type II overhead. * * 1500 - 8 -20 - 18 = 1454 * * TODO: This should probably end up a configurable item for a daemon in * case we underestimated the numbers and sizes of exported names. */ static const size_t NS_MESSAGE_MAX = (1454); /** * @brief Which protocol is of interest. When making discovery calls, the * client must choose whether it is interested in IPv4 or IPv6 addresses. * Use these constants to specify which is desired. */ enum Protocol { UNSPEC = 0, /** Unspecified */ IPV4 = 1, /**< Return the address in IPv4 suitable form */ IPV6 = 2 /**< Return the address in IPv6 suitable form */ }; const static uint8_t TRANSMIT_V0 = 1; const static uint8_t TRANSMIT_V1 = 2; const static uint8_t TRANSMIT_V2 = 4; const static uint8_t TRANSMIT_V0_V1 = (TRANSMIT_V0 | TRANSMIT_V1); static const char* const ALLJOYN_DEFAULT_ROUTER_ADVERTISEMENT_PREFIX; static const char* const ALLJOYN_DEFAULT_ROUTER_POWER_SOURCE; static const char* const ALLJOYN_DEFAULT_ROUTER_MOBILITY; static const char* const ALLJOYN_DEFAULT_ROUTER_AVAILABILITY; static const char* const ALLJOYN_DEFAULT_ROUTER_NODE_TYPE; const static uint32_t ROUTER_POWER_SOURCE_MIN = 900; const static uint32_t ROUTER_POWER_SOURCE_MAX = 2700; const static uint32_t ROUTER_MOBILITY_MIN = 2025; const static uint32_t ROUTER_MOBILITY_MAX = 8100; const static uint32_t ROUTER_AVAILABILITY_MIN = 1012; const static uint32_t ROUTER_AVAILABILITY_MAX = 8100; const static uint32_t ROUTER_NODE_CONNECTION_MIN = 4050; const static uint32_t ROUTER_NODE_CONNECTION_MAX = 8100; /** * This is the minimum number of connections we must * have available before we respond to requests from * thin clients. */ const static uint8_t LOW_CONNECTION_WATERMARK = 1; /** * @internal * * @brief Construct an IP name service object. */ IpNameServiceImpl(); /** * @internal * * @brief Destroy an IP name service object. */ virtual ~IpNameServiceImpl(); /** * @brief Initialize the name service. * * Some operations relating to initializing the name service and * arranging the communication with an underlying network can fail. * These operations are broken out into an Init method so we can * return an error condition. You may be able to try and Init() * at a later time if an error is returned. * * @param guid The daemon guid of the daemon using this service. * @param loopback If true, receive our own advertisements. * Typically used for test programs to listen to themselves talk. * * @return Status of the operation. Returns ER_OK on success. * * @see OpenInterface() */ QStatus Init(const qcc::String& guid, bool loopback = false); /** * @brief Start any required name service threads. * * @param arg Parameter not used (defaults to NULL). * @param listener Listener to be informed of Thread events (defaults to NULL). * * @return Indication of whether creation of the thread succeeded or not. */ QStatus Start(void* arg = NULL, qcc::ThreadListener* listener = NULL); /** * @brief return true if name service threads are running */ bool Started(); /** * @brief Stop any name service threads. */ QStatus Stop(); /** * @brief Join any name service threads. */ QStatus Join(); /** * @brief Provide parameters to define the general operation of the protocol. * * @warning Calling this method is not recommended unless for testing. */ void SetCriticalParameters(uint32_t tDuration, uint32_t tRetransmit, uint32_t tQuestion, uint32_t modulus, uint32_t retries); /** * @brief Creat a virtual network interface. In normal cases WiFi-Direct * creates a soft-AP for a temporary network. In some OSs like WinRT, there is * no API to detect the presence of the soft-AP. Thus we need to manually create * a virtual network interface for it. * * @param entry Contains the network interface parameters * * @return Status of the operation. Returns ER_OK on success. * * @see qcc::IfConfig() * @see qcc::IfConfigEntry */ QStatus CreateVirtualInterface(const qcc::IfConfigEntry& entry); QStatus CreateUnicastSocket(); /** * @brief Delete a virtual network interface. In normal cases WiFi-Direct * creates a soft-AP for a temporary network. Once the P2P keep-alive connection is * terminated, we delete the virtual network interface that represents the * soft-AP. * * @param ifceName The virtual network interface name * * @return Status of the operation. Returns ER_OK on success. * */ QStatus DeleteVirtualInterface(const qcc::String& ifceName); /** * @brief Tell the name service to begin listening and transmitting * on the provided network interface. * * There may be a choice of network interfaces available to run the name * service protocol over. A user of the name service can find these * interfaces and explore their characteristics using qcc::IfConfig(). * When it is decided to actually use one of the interfaces, one can pass * the m_name (interface name) variable provided in the selected * qcc::IfConfigEntry into this method to enable the name service for that * interface (or pass a configured name). * * If the interface is not IFF_UP, the name service will periodically * check to see if one comes up and will begin to use it whenever it * can. * * @param transportMask A bitmask containing the transport requesting the * advertisements. * @param name The interface name of the interface to start talking to * and listening on (e.g., eth1 or wlan0). * * @return Status of the operation. Returns ER_OK on success. * * @see qcc::IfConfig() * @see qcc::IfConfigEntry */ QStatus OpenInterface(TransportMask transportMask, const qcc::String& name); /** * @brief Tell the name service to begin listening and transmitting * on the provided network interface. * * There may be a choice of network interfaces available to run the name * service protocol over. A user of the name service can find these * interfaces and explore their characteristics using qcc::IfConfig(). * When it is decided to actually use one of the interfaces, pass an * IPAddress constructed using the m_addr (interface address) variable * provided in the selected qcc::IfConfigEntry into this method to enable * the name service for that address. * * If there is no interface that is IFF_UP with the specific address * the name service will periodically check to see if one comes up * and will begin to use it whenever it can. * * @param transportMask A bitmask containing the transport requesting the * advertisements. * @param name The interface name of the interface to start talking to * and listening on (e.g., eth1 or wlan0). * * @return Status of the operation. Returns ER_OK on success. * * @see qcc::IfConfig() * @see qcc::IfConfigEntry */ QStatus OpenInterface(TransportMask transportMask, const qcc::IPAddress& address); /** * @brief Tell the name service to stop listening and transmitting * on the provided network interface. * * @param transportMask A bitmask containing the transport requesting the * advertisements. * @param address The interface name of the interface to stop talking * to and listening on. * * @return Status of the operation. Returns ER_OK on success. * * @see OpenInterface */ QStatus CloseInterface(TransportMask transportMask, const qcc::String& name); /** * @brief Tell the name service to stop listening and transmitting * on the provided network interface. * * @param transportMask A bitmask containing the transport requesting the * advertisements. * @param address The IP address the interface to stop talking * to and listening on. * * @return Status of the operation. Returns ER_OK on success. * * @see OpenInterface */ QStatus CloseInterface(TransportMask transportMask, const qcc::IPAddress& address); /** * @brief Notify the name service that that there is or is not a listener on * the specified endpoints. * * The IpNameService is shared among several transports. In order to * advertise the presence of a network endpoint managed by a transport, the * transports need to advise us of the IP addresses and ports on which it * can be contacted. Each transport may use a different set of addresses * and ports, and so each transport must identify itself to the name * service. This is done using the TransportMask. There is a bit in the * TransportMask for each transport in the system. * * A transport is defined as a module that provides reliable and/or * unreliable data transfer over IPv4 and/or IPv6. Support for reliable and * unreliable modes is optional, as is support for IPv4 and IPv6. Port * numbers for reliable, unreliable, IPv4 and IPv6 may also differ. An * enable bit is conceptually required since support for each endpoint type * is optional. This makes for thirteen parameters. * * transportMask, * enableReliableIPv4, reliableIPv4Addr, reliableIPv4Port * enableReliableIPv6, reliableIPv6Addr, reliableIPv6Port * enableUnreliableIPv4, unreliableIPv4Addr, unreliableIPv4Port * enableUnReliableIPv6, unreliableIPv6Addr, unreliableIPv6Port * * It turns out that since AllJoyn lives in a mobile environment, the * transport must listen on the "any" address. This is because an IP * address assigned to a given network interface cannot generally be * predicted in advance. * * The mechanism used to "control" which network interfaces can accept * incoming connections, is the presence of outgoing advertisements on those * interfaces. If a transport desires to accept connections over an * interface, it performs an OpenInterface() on that interface which begins * the process of sending advertisements. The IP (V4 and or V6) address of * the interface is added to advertisements and sent out over the network. * This which provides the receiver of the advertisements with an IP address * and port to connect to. The advertising transport, since it is listening * on the "any" address, will respond to all connect requests coming from * clients on the associated network. If the transport wants to filter * further on source IP addresses, it certainly can; but this is not a * concern of the name service. * * This all means that we do not need to specify the IP addresses on which * the reliable and unreliable protocols are listening. This means that * there are nine required parameters to this call instead of thirteen: * * transportMask, * reliableIPv4Port, reliableIPv6Port, * unreliableIPv4Port, unreliableIPv6Port, * enableReliableIPv4, enableReliableIPv6, * enableUnreliableIPv4, enableUnreliableIPv6 * * In many cases, the transports will not support all combinations. For * example, the tcp transport currently only supports reliable IPv4 * connections, and so the call for this transport might be: * * Enable(TRANSPORT_TCP, 9955, 0, 0, 0, true, false, false, false); * * The Android Compatibility Test Suite demands that an Android phone may * not hold an open socket in the quiescent state. Since we provide a * native daemon that always runs on the phone, and the daemon has * transports that want to listen on sockets, there must be a way to close * those sockets (and the multicast sockets in the name service) and not * use them at all when there are no advertisements or discovery operations * in progress. This also helps with power consumption. * * Enable() communicates the fact that there is or is not a listener for the * specified transport port and this, in turn, implies whether or not * advertisements should be sent and received over the interfaces opened by * the given transport. * * @param transportMask A bitmask containing the transport handling the specified * endpoints. * @param reliableIPv4PortMap Indicates a map of interfaces to port numbers * of a server listening for connections if enableReliableIPv4 is true * @param reliableIPv6Port Indicates the port number of a server listening for * connections if enableUnreliableIPv6 is true * @param unreliableIPv4Port Indicates a map of interfaces to port numbers * of a server listening for connections if enableUnreliableIPv4 is true * @param unreliableIPv6Port Indicates the port number of a server listening for * connections if enableUnreliableIPv6 is true. * @param enableReliableIPv4 * - true indicates this protocol is enabled. * - false indicates this protocol is not enabled. * @param enableReliableIPv6 * - true indicates this protocol is enabled. * - false indicates this protocol is not enabled. * @param enableUnreliableIPv4 * - true indicates this protocol is enabled. * - false indicates this protocol is not enabled. * @param enableUnreliableIPv4 * - true indicates this protocol is enabled. * - false indicates this protocol is not enabled. */ QStatus Enable(TransportMask transportMask, const std::map& reliableIPv4PortMap, uint16_t reliableIPv6Port, const std::map& unreliableIPv4PortMap, uint16_t unreliableIPv6Port, bool enableReliableIPv4, bool enableReliableIPv6, bool enableUnreliableIPv4, bool enableUnreliableIPv6); static uint32_t LoadParam(const ConfigDB* config, const qcc::String param); void LoadStaticRouterParams(const ConfigDB* config); static uint16_t ComputePriority(uint32_t staticScore, uint32_t dynamicScore); static uint32_t ComputeStaticScore(uint32_t powerSource, uint32_t mobility, uint32_t availability, uint32_t nodeConnection); static uint32_t ComputeDynamicScore(uint32_t availableTcpConnections, uint32_t maximumTcpConnections, uint32_t availableUdpConnections, uint32_t maximumUdpConnections, uint32_t availableTcpRemoteClients, uint32_t maximumTcpRemoteClients); static qcc::String ToLowerCase(const qcc::String& str); uint16_t GetCurrentPriority(); QStatus UpdateDynamicScore(TransportMask transportMask, uint32_t availableTransportConnections, uint32_t maximumTransportConnections, uint32_t availableTransportRemoteClients, uint32_t maximumTransportRemoteClients); /** * @brief Ask the name service whether or not it thinks there is or is not a * listener on the specified ports for the given transport. * * @param transportMask A bitmask containing the transport handling the specified * endpoints. * @param reliableIPv4PortMap If empty, indicates this protocol is not enabled. If * not empty, indicates the interfaces/port numbers of a server listening for connections. * @param reliableIPv6Port If zero, indicates this protocol is not enabled. If * non-zero, indicates the port number of a server listening for connections. * @param unreliableIPv4PortMap If empty, indicates this protocol is not enabled. If * not empty, indicates the interfaces/port numbers of a server listening for connections. * @param unreliableIPv6Port If zero, indicates this protocol is not enabled. If * non-zero, indicates the port number of a server listening for connections. */ QStatus Enabled(TransportMask transportMask, std::map& reliableIPv4PortMap, uint16_t& reliableIPv6Port, std::map& unreliableIPv4PortMap, uint16_t& unreliableIPv6Port); /** * Allow a user to select what kind of retry policy should be used when * trying to locate names. There really isn't one obvious policy. Consider * what happens if the question is locate well-known name N from local * daemon L. If the locate is transmitted and all remote daemons having N * hear the WHO-HAS and respond, we certainly do not need to retransmit. * If all but one remote daemons that have N hear the question, and respond, * is it okay to decide not to ping the remaining daemon? We cannot * possibly know that this situation has happened. To try and ping a * remote daemon that could have missed our request, we would necessarily * have to just continue retrying. One can imagine the case where a * single response from any remote daemon would satisfy a user "enough" to * satisfy an end-user. One could imagine a situation where one of a * list of names would be satisfactory (several services that accomplish * basically the same thing). One could imagine a situation where the * entire list must be found to do the useful thing. * * To avoid trying to make a single pronouncement on the best way to do * things, we provide a selectable policy. */ enum LocatePolicy { ALWAYS_RETRY = 1, /**< Always send the default number of retries */ RETRY_UNTIL_PARTIAL, /**< Retry until we get at least one of the names, or run out of retries */ RETRY_UNTIL_COMPLETE /**< Retry until we get all of the names, or run out of retries */ }; /** * @brief Express an interest in locating instances of AllJoyn daemons * which support the provided well-known name. * * Calling this method will result in a name resolution request being * multicast to the local subnet. Other instances of the name service that * know about daemons that match the constraints will respond to this * request. * * Responses to this request will be filtered after the first response from * each remote daemon. If, for some reason, the local daemon wants to be * re-notified of remote names, it can call this method. In that case, all * state information regarding previous notifications will be dropped and * the daemon will get a single repeat notification for each remote name. * * If users of the name service are interested in being notified of these * of services, they are expected to set the Found callback function using * SetFoundCallback(). * * @see SetFoundCallback() * * There is also a corresponding Lost callback used to be notified when * services vanish off the net. * * @see SetLostCallback() * @see LocatePolicy * * @param[in] transportMask A bitmask containing the transport requesting the * discovery operation. * @param[in] matching The Key, value match criteria that the caller wants * to be notified of (via signal) when a remote Bus instance is found * with an advertisement that matches the criteria. * @param[in] policy The retransmission policy for this Locate event. * * @return Status of the operation. Returns ER_OK on success. */ QStatus FindAdvertisement(TransportMask transportMask, const qcc::String& matching, LocatePolicy policy, TransportMask completeTransportMask); /** * @brief Cancel an interest in locating instances of AllJoyn daemons * which support the provided well-known name. * * If an AllJoyn daemon wants to cancel an interest in locating instances * of AllJoyn daemons which support the provided well-known name * it calls this function. * * @param[in] transportMask A bitmask containing the transport * @param[in] matching The Key, value match criteria that the caller wants * no longer be notified of (via signal) when a remote Bus instance is * found with an advertisement that matches the criteria. * @param[in] policy The retransmission policy for the Locate event * to be cancelled. * * @return Status of the operation. Returns ER_OK on success. */ QStatus CancelFindAdvertisement(TransportMask transportMask, const qcc::String& matching, LocatePolicy policy, TransportMask completeTransportMask); /** * @brief Refresh the cache of names that we have seen and maintain the * updated state of PeerInfoMap * @param[in] guid Guid for which Cache refresh has been initiated * @param[in] matchingStr The name for which we are sending the cache refresh * @param[in] policy Policy for refresh */ QStatus RefreshCache(TransportMask transportMask, const qcc::String& guid, const qcc::String& matchingStr, LocatePolicy policy = ALWAYS_RETRY, bool ping = false); /** * @brief Set the Callback for notification of discovery events. * * When using an asynchronous service discovery process, a caller will * need to specify how to called back when a service appears, disappears * or reaffirms its existence on the network. This method provides the * mechanism for specifying the callback. * * The method signature for the Callback method must be: * * @code * void Found(const qcc::String &, const qcc::String &, std::vector &, uint32_t); * @endcode * * The first parameter is the address and port of the found service, * formatted as a bus address the way AllJoyn likes, for example, * "tcp:addr=192.168.0.1,port=9955". The second parameter is the daemon * guid string exported by the remote daemon service, or the empty string * if that daemon didn't bother to export the string. The third parameter * is a vector of qcc::String that represent the well-known names that the * remote daemon is referring to, for example, "org.freedesktop.Yadda". * The fourth parameter is the timer value. A timer value of zero indicates * that the names provided in the vectoror qcc::String are no longer * available. A timer value of 255 indicates that the names provided should * be interpreted as always available, to the extent that is possible. * A timer value between 0 and 255 indicates the number of seconds that the * name is expected to be valid. There will be keepalive messages provided * which may extend this time periodically. * * The typical idiom for using the callback facility is to define a method * to receive a found callback in your class and instantiate your class * (and this one) somewhere: * * @code * class MyClass: * public: * void Found(const qcc::String &s, const qcc::String &g, std::vector& wkn, uint32_t timer) {} * } * * ... * * MyClass myClass; * IpNameServiceImpl nameService; * @endcode * * The callback is connected using the SetCallback() method of this * class. * * @code * nameService.SetCallback(new CallbackImpl, uint32_t>(MyClass, myclass)); * @endcode * * From this point forward, all changes to services specified by the * Locate() call will be set to you through the callback mechanism. * * To stop notifications, set the callback (cb) to the pointer value 0. * * @warning The callback will be in the context of a different thread than * your thread, so your Found callback code must be multithread safe (or aware * at least). * * @warning Services may come and go constantly during real network operation. * Just because a service was found on the network it does not mean that there * will be a service waiting on the provided IP address and port. This * service may be gone by the time you connect; and this is a perfectly * legal and reasonable situation. * * @param[in] cb the Callback pointer. * * @return Status of the operation. Returns ER_OK on success. */ QStatus SetCallback(TransportMask transportMask, Callback&, uint32_t>* cb); /** * @brief Set the Callback for notification of network interface events. * */ QStatus SetNetworkEventCallback(TransportMask transportMask, Callback&>* cb); /** * @brief Clear the callbacks for all transports. * * Used during the shutdown of the IpNameService singleton to make sure that * no more callbacks escape from the implementation. */ void ClearCallbacks(void); /** * @brief Clear the network interface event callbacks for all transports. * */ void ClearNetworkEventCallbacks(void); /** * @brief Advertise an AllJoyn daemon service. * * If an AllJoyn daemon wants to advertise the presence of a well-known name * on the local subnet(s) it calls this function. It must have previously * provided an appropriately formatted address in presentation format (IPV4 or * IPV6) and port over which it may be contacted. * * This method allows the caller to specify a single well-known interface * name supported by the exporting AllJoyn. If the AllJoyn supports multiple * interfaces, it is more efficient to call the overloaded method which * takes a vector of string. * * @see SetEndpoints() * * @param[in] transportMask A bitmask containing the transport requesting the * advertisement. * @param[in] wkn The AllJoyn interface (e.g., "org.freedesktop.Sensor"). * @param[in] quietly The quietly parameter, if true, specifies to not do * gratuitous advertisements (send periodic is-at messages indicating we * have the provided name available) but do respond to who-has requests * for the name. * * @return Status of the operation. Returns ER_OK on success. */ QStatus AdvertiseName(TransportMask transportMask, const qcc::String& wkn, bool quietly, TransportMask completeTransportMask); /** * @brief Cancel an AllJoyn daemon service advertisement. * * If an AllJoyn daemon wants to cancel an advertisement of a well-known name * on the local subnet(s) it calls this function. * * @param[in] wkn The AllJoyn interface (e.g., "org.freedesktop.Sensor"). * * @return Status of the operation. Returns ER_OK on success. */ QStatus CancelAdvertiseName(TransportMask transportMask, const qcc::String& wkn, TransportMask completeTransportMask); /** * @internal * @brief Advertise an AllJoyn daemon service. * * If an AllJoyn daemon wants to advertise the presence of a well-known name * on the local subnet(s) it calls this function. It must have previously * provided an appropriately formatted address in presentation format (IPV4 or * IPV6) and port over which it may be contacted. * * This method allows the caller to specify multiple well-known interface * name supported by the exporting AllJoyn. If the AllJoyn supports multiple * interfaces, this is the preferred method. * * @see SetEndpoints() * * @param[in] transportMask A bitmask containing the transport requesting the * advertisement. * @param[in] wkn A vector of AllJoyn well-known names (e.g., "org.freedesktop.Sensor"). * * @return Status of the operation. Returns ER_OK on success. */ QStatus AdvertiseName(TransportMask transportMask, std::vector& wkn, bool quietly, TransportMask completeTransportMask); /** * @brief Cancel an AllJoyn daemon service advertisement. * * If an AllJoyn daemon wants to cancel an advertisement of a well-known name * on the local subnet(s) it calls this function. * * @param[in] transportMask A bitmask containing the transport requesting the * advertisement be canceled. * @param[in] wkn A vector of AllJoyn well-known names (e.g., "org.freedesktop.Sensor"). * * @return Status of the operation. Returns ER_OK on success. */ QStatus CancelAdvertiseName(TransportMask transportMask, std::vector& wkn, TransportMask completeTransportMask); /** * @brief Returns a count of the number of names currently being advertised * * @param[in] transportMask A bitmask containing the transport requesting the * advertisement be canceled. * * @return Returns the number of names currently being advertised */ size_t NumAdvertisements(TransportMask transportMask); /** * @brief Handle the suspending event of the process. Release exclusive held socket file descriptor and port. */ QStatus OnProcSuspend(); /** * @brief Handle the resuming event of the process. Re-acquire exclusive held socket file descriptor and port. */ QStatus OnProcResume(); void RegisterListener(IpNameServiceListener& listener); void UnregisterListener(IpNameServiceListener& listener); QStatus Ping(TransportMask transportMask, const qcc::String& guid, const qcc::String& name); QStatus Query(TransportMask transportMask, MDNSPacket mdnsPacket); QStatus Response(TransportMask transportMask, uint32_t ttl, MDNSPacket mdnsPacket); /** * @internal * @brief Update the AddToPeerInfoMap * */ bool AddToPeerInfoMap(const qcc::String& guid, const qcc::IPEndpoint& ipEndpoint); /** * @internal * @brief Remove an entry from the PeerInfoMap * This will be useful during a cache refresh expiry for a guid * */ bool RemoveFromPeerInfoMap(const qcc::String& guid); private: /** * @brief Copying an IpNameServiceImpl object is forbidden. */ IpNameServiceImpl(const IpNameServiceImpl& other); /** * @brief Assigning an IpNameServiceImpl object is forbidden. */ IpNameServiceImpl& operator =(const IpNameServiceImpl& other); /** * @brief The number of transports that can be represented in a 16-bit * transport mask. */ static const uint32_t N_TRANSPORTS = 16; /** * @brief The temporary IPv4 multicast address for the multicast name * service. */ static const char* IPV4_MULTICAST_GROUP; /** * @brief The IANA assigned IPv4 multicast address for the multicast name * service. * * @see IPv4 Multicast Address space Registry IANA */ static const char* IPV4_ALLJOYN_MULTICAST_GROUP; /** * @brief The temporary IPv6 multicast address for the multicast name * service. * * @see IPv4 Multicast Address space Registry IANA */ static const char* IPV6_MULTICAST_GROUP; /** * @brief The IANA assigned IPv6 multicast address for the multicast name * service. * * @see IPv4 Multicast Address space Registry IANA */ static const char* IPV6_ALLJOYN_MULTICAST_GROUP; /** * @brief The IANA assigned IPv4 multicast address for the MDNS * service. * * @see IPv4 Multicast Address space Registry IANA */ static const char* IPV4_MDNS_MULTICAST_GROUP; /** * @brief The IANA assigned IPv6 multicast address for the MDNS * service. * * @see IPv4 Multicast Address space Registry IANA */ static const char* IPV6_MDNS_MULTICAST_GROUP; /** * @brief The port number for the multicast name service. * Should eventually be registered with IANA. * * @see IPv4 Multicast Address space Registry IANA */ static const uint16_t MULTICAST_PORT; /** * @brief The port number for the broadcast name service packets. * Typically the same port as the multicast case, but can be made * different (with a little work). */ static const uint16_t BROADCAST_PORT; /** * @brief The port number for the MDNS name service. * * @see IPv4 Multicast Address space Registry IANA */ static const uint16_t MULTICAST_MDNS_PORT; /** * @brief The port number for the broadcast MDNS name service packets. * Typically the same port as the multicast case, but can be made * different (with a litle work). */ static const uint16_t BROADCAST_MDNS_PORT; /** * @brief * Private notion of what state the implementation object is in. */ enum State { IMPL_INVALID, /**< Should never be seen on a constructed object */ IMPL_SHUTDOWN, /**< Nothing is running and object may be destroyed */ IMPL_INITIALIZING, /**< Object is in the process of coming up and may be inconsistent */ IMPL_RUNNING, /**< Object is running and ready to go */ IMPL_STOPPING, /**< Object is stopping */ }; /** * @internal * @brief State variable to indicate what the implementation is doing or is * capable of doing. */ State m_state; /** * @internal * @brief State variable to indicate whether the OS is suspending the process. */ bool m_isProcSuspending; /** * @internal * @brief State variable to indicate that the name service is in the process * of sending its terminal is-at messages indicating that any currently * advertised names are becoming invalid. */ bool m_terminal; class InterfaceSpecifier { public: TransportMask m_transportMask; /**< The transport mask that identifies the transport talking to the interface */ qcc::String m_interfaceName; /**< The interface (cf. eth0) we want to talk to */ qcc::IPAddress m_interfaceAddr; /**< The address (cf. 1.2.3.4) we want to talk to */ }; class LiveInterface : public InterfaceSpecifier { public: qcc::IPAddress m_address; /**< The address of the interface we are talking to */ uint16_t m_multicastPort; /**< The multicast port we are using to talk */ uint16_t m_unicastPort; /**< The unicast port we are using to talk */ uint16_t m_multicastMDNSPort; /**< The multicast MDNS port we are using to talk */ uint32_t m_prefixlen; /**< The address prefix (cf netmask) of the interface we are talking to */ qcc::SocketFd m_multicastsockFd; /**< The multicast socket we are using to talk over */ qcc::SocketFd m_multicastMDNSsockFd; /**< The multicast MDNS socket we are using to talk over */ qcc::Event* m_multicastevent; /**< The event for the multicast socket we use to get read notifications over */ qcc::Event* m_multicastMDNSevent; /**< The event for the multicast MDNS socket we use to get read notifications over */ uint32_t m_mtu; /**< The MTU of the protocol/device we are using */ uint32_t m_index; /**< The interface index of the protocol/device we are using if IPv6 */ uint32_t m_flags; /**< The flags we found during the qcc::IfConfig() that originally discovered this iface */ bool m_messageSent; /**< True if this interface has already been used to send a particular protocol message */ }; /** * @internal * @brief A vector of information specifying any interfaces we have manual created */ std::vector m_virtualInterfaces; /** * @internal * @brief A vector of information specifying any interfaces we may want to * send or receive multicast packets over for a particular transport. * Interfaces in this vector may be up or down, or may be completely * unrelated to any interface in the actual host system. These are what the * user is telling us to use. */ std::vector m_requestedInterfaces[N_TRANSPORTS]; /** * @internal * @brief A vector of information specifying any interfaces we have actually * decided to send or receive multicast packets over. Interfaces in this * must have been up when they were added, but may have since gone down. * These are interfaces we decided to use based on what the user told us * to use. */ std::vector m_liveInterfaces; /** * @internal * @brief Mutex object used to protect various lists that may be accessed * by multiple threads. */ qcc::Mutex m_mutex; /** * @internal * @brief Variable used to indicate that callbacks are currently in use and * may not be deleted. */ bool m_protect_callback; /** * @internal * @brief Variable used to indicate that network event callbacks are currently * in use and may not be deleted. */ bool m_protect_net_callback; /** * Send outbound name service messages out the current live interfaces. */ void SendOutboundMessages(void); /** * Send outbound name service messages over unicast, out the network * interfaces implied by the destination address in the header. */ void SendOutboundMessageQuietly(Packet packet); /** * Send outbound name service messages over multicast, out the list of live * interfaces implied by the transport masks in the message. */ void SendOutboundMessageActively(Packet packet, const qcc::IPAddress& localAddress = qcc::IPAddress("0.0.0.0")); /** * Main thread entry point. * * @param arg Unused thread entry arg. */ qcc::ThreadReturn STDCALL Run(void* arg); /** * @internal * @brief Queue a protocol message for transmission out on the multicast * group. */ void QueueProtocolMessage(Packet packet); /** * @internal * @brief Trigger transmission of a particular packet at a defined schedule. * group. */ void TriggerTransmission(Packet packet); /** * @internal * @brief Send a protocol message out on the multicast group. * * @param sockFd The socket FD that is used to send and receive to and from * the life interface to which the name service message will be sent. * @param interfaceAddress The IPV4 address of the interface which is used * as a template for constructing a subnet directed broadcast address. * This address provides the network number part of the broadcast * address. Only useful if sockFd is of family QCC_AF_INET. * @param interfaceAddressPrefixLen The network prefix length of the * networkd which is used to determine which part of * contains the network part of the address. * @param flags The flags (IFF_*) bits from the network interface. Used * to decide if the network is broadcast- or multicast-capable. * @param sockFdIsIPv4 Used to tell what address family sockFd has been * initialized to and therefore what kind of multicast needs to be done * or whether or not broadcast is meaningful. * @param interfaceIndex The index into the live interfaces array * corresponding to the interface we're going to send to. Really just * used for debugging. */ void SendProtocolMessage( qcc::SocketFd sockFd, qcc::IPAddress interfaceAddress, uint32_t interfaceAddressPrefixLen, uint32_t flags, bool sockFdIsIPv4, Packet packet, uint32_t interfaceIndex, const qcc::IPAddress& localAddress = qcc::IPAddress("0.0.0.0")); /** * @internal * @brief Is the interface specified by the liveIndex an interface requested * to be opened by the transport specified by the transportIndex. * * @param transportIndex An index into the per-transport data structures * derived from the transport mask of the transport under consideration. * @param liveIndex An index into the list of live interfaces specifying the * index under consideration. */ bool InterfaceRequested(uint32_t transportIndex, uint32_t liveIndex); /** * @internal * @brief Rewrite (set) the IPv4 and IPv6 addresses of the provided is-at message * respecting the version of the message as specified by msgVersion. * * @param msgVersion The version of the message that is being constructed. * @param isAt A pointer to the is-at message that is to be rewritten. * @param haveIPv4address If true, the provided ipv4Address is valid and * should be used. * @param iPv4address The qcc::IPAddress of the IPv4 interface for which * the is-at message is eventually destined. * @param haveIPv6address If true, the provided ipv6Address is valid and * should be used. * @param iPv6address The qcc::IPAddress of the IPv6 interface for which * the is-at message is eventually destined. * @param iPv4port The port that the daemon is listening to of the IPv4 * interface for which the is-at message is eventually destined. * @param iPv6port The port that the daemon is listening to of the IPv6 * interface for which the is-at message is eventually destined. * @param interface The network interface name over which the message * is to be sent. */ void RewriteVersionSpecific(uint32_t msgVersion, Packet packet, bool haveIPv4address, qcc::IPAddress ipv4address, bool haveIPv6Address, qcc::IPAddress ipv6address, uint16_t unicastIpv4Port = 0, const qcc::String& interface = qcc::String(), const uint16_t reliableTransportPort = 0, const uint16_t unreliableTransportPort = 0); /** * @internal * @brief Are the provided IP Addresses on the same network? * * Take a look at the network number part of the two IP addresses (as * determined by the prefix length) and compare them. If the two networks * both appear to be on the same network, then return true. * * @warning This method does not take the interface index of an IP address * into account, so two network interfaces, both connected to a private * network address (192.168.x.x) may be erroneously identified as belonging * to the same network. In this case, it might result in a name service * packet being unintentionally sent to the "duplicate" network as well as * the "correct" network. * * @param interfaceAddressPrefixLen The network prefix length of both * networks. * @param addressA The qcc::IPAddress of the first of the two networks. * @param addressB The qcc::IPAddress of the first of the two networks. */ bool SameNetwork(uint32_t interfaceAddressPrefixLen, qcc::IPAddress addressA, qcc::IPAddress addressB); /** * @internal * @brief Do something with a received protocol message. */ void HandleProtocolMessage(uint8_t const* const buffer, uint32_t nbytes, const qcc::IPEndpoint& remove, const qcc::IPEndpoint& local, int32_t interfaceIndex); /** * @internal * @brief Do something with a received protocol question. */ void HandleProtocolQuestion(WhoHas whoHas, const qcc::IPEndpoint& remote, int32_t interfaceIndex, const qcc::IPEndpoint& locals); /** * @internal * @brief Do something with a received protocol answer. */ void HandleProtocolAnswer(IsAt isAt, uint32_t timer, const qcc::IPEndpoint& remote, int32_t interfaceIndex); /** * @internal * @brief Do something with a received MDNS protocol query. */ void HandleProtocolQuery(MDNSPacket mdnsPacket, const qcc::IPEndpoint& remote, const qcc::IPEndpoint& local); /** * @internal * @brief Do something with a received MDNS protocol response. */ void HandleProtocolResponse(MDNSPacket mdnsPacket, const qcc::IPEndpoint& remote, const qcc::IPEndpoint& local, int32_t interfaceIndex); /** * @internal * @brief Update the MDNSPacketTracker which is useful for keep track of burst and * not responding to each packet of a burst */ bool UpdateMDNSPacketTracker(qcc::String guid, const qcc::IPEndpoint& endpoint, uint16_t burstId); /** * One possible callback for each of the corresponding transport masks in a * sixteen-bit word. */ Callback&, uint32_t>* m_callback[N_TRANSPORTS]; Callback&>* m_networkEventCallback[N_TRANSPORTS]; /** * @internal @brief A vector of list of all of the names that the various * transports have actively advertised. */ std::set m_advertised[N_TRANSPORTS]; /** * @internal @brief A vector of set of all of the v2 match strings that the various * transports have active queries for. */ std::set m_v2_queries[N_TRANSPORTS]; /** * @internal @brief A vector of set of all of the v1 names that the various * transports have active queries for. */ std::set m_v0_v1_queries[N_TRANSPORTS]; /** * @internal @brief A vector of list of all of the names that the various * transports have quietly advertised. */ std::set m_advertised_quietly[N_TRANSPORTS]; /** * @internal * @brief The daemon GUID string of the daemon assoicated with this instance * of the name service. */ qcc::String m_guid; /** * @internal @brief The IPv4 address of the transports on this daemon that * are listening for reliable (TCP) inbound connections. Not defined if the * corresponding port is zero. */ qcc::String m_reliableIPv4Address[N_TRANSPORTS]; /** * @internal * @brief Whether the ports on this daemon that are listening for reliable (TCP) * inbound connections over IPv4. */ bool m_enabledReliableIPv4[N_TRANSPORTS]; /** * @internal * @brief A map of network interfaces to ports on this daemon that are listening * for reliable (TCP) inbound connections over IPv4. */ std::map m_reliableIPv4PortMap[N_TRANSPORTS]; std::map m_priorReliableIPv4PortMap[N_TRANSPORTS]; /** * @internal * @brief The IPv4 address of the transports on this daemon that are listening for * unreliable (UDP) inbound connections. Not defined if the corresponding port is * zero. */ qcc::String m_unreliableIPv4Address[N_TRANSPORTS]; /** * @internal * @brief Whether the ports on this daemon that are listening for unreliable (UDP) * inbound connections over IPv4. */ bool m_enabledUnreliableIPv4[N_TRANSPORTS]; /** * @internal * @brief A map of network interfaces to ports on this daemon that are listening * for unreliable (UDP) inbound connections over IPv4. */ std::map m_unreliableIPv4PortMap[N_TRANSPORTS]; std::map m_priorUnreliableIPv4PortMap[N_TRANSPORTS]; /** * @internal * @brief The IPv6 address of the transports on this daemon that are listening for * reliable (TCP) inbound connections. Not defined if the corresponding port is * zero. */ qcc::String m_reliableIPv6Address[N_TRANSPORTS]; /** * @internal * @brief Whether the ports on this daemon that are listening for reliable (TCP) * inbound connections over IPv6. */ bool m_enabledReliableIPv6[N_TRANSPORTS]; /** * @internal * @brief The port on this daemon that are listening for reliable (TCP) * inbound connections over IPv6. */ uint16_t m_reliableIPv6Port[N_TRANSPORTS]; /** * @internal * @brief The IPv6 address of the transports on this daemon that are listening for * unreliable (UDP) inbound connections. Not defined if the corresponding port is * zero. */ qcc::String m_unreliableIPv6Address[N_TRANSPORTS]; /** * @internal * @brief Whether the ports on this daemon that are listening for reliable (UDP) * inbound connections over IPv6. */ bool m_enabledUnreliableIPv6[N_TRANSPORTS]; /** * @internal * @brief The port on this daemon that is listening for unreliable (UDP) * inbound connections over IPv6. */ uint16_t m_unreliableIPv6Port[N_TRANSPORTS]; /** * @internal * @brief The time remaining before a set of advertisements must be * retransmitted over the multicast link. */ uint32_t m_timer; /** * @internal * @brief Check to see if the periodic timer needs to be scheduled. */ bool IsPeriodicMaintenanceTimerNeeded(void) const; /** * @internal * @brief Perform periodic protocol maintenance. Called once per second * from the main listener loop. */ void DoPeriodicMaintenance(void); /** * @internal * @brief Retransmit exported advertisements. */ void Retransmit(uint32_t index, bool exiting, bool quietly, const qcc::IPEndpoint& destination, const qcc::IPEndpoint& source, uint8_t type, TransportMask transportMask, std::vector& wkns, const int32_t interfaceIndex = -1, const qcc::AddressFamily family = qcc::QCC_AF_UNSPEC); void GetResponsePackets(std::list& packets, bool quietly = false, const qcc::IPEndpoint destination = qcc::IPEndpoint("0.0.0.0", 0), uint8_t type = TRANSMIT_V2, TransportMask transportMask = (TRANSPORT_TCP | TRANSPORT_UDP), const int32_t interfaceIndex = -1, const qcc::AddressFamily family = qcc::QCC_AF_UNSPEC); void GetQueryPackets(std::list& packets, const uint8_t type = TRANSMIT_V0_V1 | TRANSMIT_V2, const int32_t interfaceIndex = -1, const qcc::AddressFamily family = qcc::QCC_AF_UNSPEC); /** * @internal * @brief Retry locate requests. */ void Retry(void); uint32_t m_tDuration; uint32_t m_tRetransmit; uint32_t m_tQuestion; uint32_t m_modulus; uint32_t m_retries; /** * @internal * @brief Listen to our own advertisements if true. */ bool m_loopback; /** * @internal * @brief Send name service packets via IPv4 subnet directed broadcast if * true. */ bool m_broadcast; /** * @internal * @brief Advertise and listen over IPv4 if true. */ bool m_enableIPv4; /** * @internal * @brief Advertise and listen over IPv6 if true. */ bool m_enableIPv6; /** * @internal * @brief True if v0 and v1 versions of the protocol are enabled. */ bool m_enableV1; /** * @internal * @brief Advertise IPv4 address assigned to this interface when multicasting * over IPv6 sockets in m_overrideIpv6 mode. Used to compensate for broken * Android phones that don't support IPv4 multicast. */ qcc::String m_overrideInterface; /** * @internal @brief Set to true if a given transpot has indicated that it * wants to use all available interfaces whenever they may be up if true. * Think INADDR_ANY or in6addr_any. this is typically what most transports * want to do. */ bool m_any[N_TRANSPORTS]; /** * @internal * @brief Event used to wake up the main name service thread and tell it * that a message has been queued on the outbound message list. */ qcc::Event m_wakeEvent; /** * @internal * @brief Set to true to force a lazy update cycle if the open interfaces * change. */ bool m_forceLazyUpdate; /** * @internal * @brief Set to true to force a refresh of advertisements/queries if one or * more new interfaces are detected. */ bool m_refreshAdvertisements; /** * @internal * @brief A list of name service messages queued for transmission out on * the multicast group. */ std::list m_outbound; #if defined(QCC_OS_GROUP_WINDOWS) /** * @internal @brief A socket to hold to keep winsock initialized * as long as the name service is alive. */ qcc::SocketFd m_refSockFd; #endif /** * @internal * @brief Tear down all live interfaces and remove them from the * corresponding list. */ void ClearLiveInterfaces(void); /** * @internal * @brief Make sure that we have socket open to talk and listen to as many * of our desired interfaces as possible. */ void LazyUpdateInterfaces(const qcc::NetworkEventSet& networkEvents = qcc::NetworkEventSet()); /** * @internal * @brief Count the number of bits that are sent in the provided integer. * Methods to count the number of set bits in a data word are used to in the * process of calculating the Hamming Distance between two binary strings. * We use this "population count" function to count the numbr of set bits in * a TransportMask in order to enforce the one-to-one correspondence between * a transport and its one and only mask bit in our API. */ uint32_t CountOnes(uint32_t data); /** * @internal * @brief Return the bit position corresponding to the guaranteed single bit * set in the provided data word. * * Used to convert a transport mask to an index into a table corresponding * to the transport mask. */ uint32_t IndexFromBit(uint32_t data); /** * @internal * @brief Return the TransportMask implied by the index in the data word. * * Used to convert an index into a table corresponding to the transport mask * back into the original transport mask. */ TransportMask MaskFromIndex(uint32_t data); /** * @internal * @brief If true, allow the name service to communicate with the outside * world. If false, ensure that no packets are sent and no sockets are * listening for connections. For Android Compatibility Test Suite (CTS) * conformance. */ bool m_enabled; /** * @internal * @brief If true, invoke the transport network event callbacks. */ bool m_processTransport[N_TRANSPORTS]; /** * @internal * @brief If set to true, request the name service run thread to enable * communication with the outside world. */ bool m_doEnable; /** * @internal * @brief If set to true, request the name service run thread to disable * communication with the outside world. */ bool m_doDisable; /** * The BurstResponceHeader struct holds a copy of the header that will be * sent using the burst response. The struct also tracks how many times the * header had been added to the outbound queue. */ typedef struct _BurstResponseHeader { _BurstResponseHeader(Packet packet) : packet(packet), scheduleCount(0) { } ~_BurstResponseHeader() { } Packet packet; uint32_t scheduleCount; qcc::Timespec nextScheduleTime; }BurstResponseHeader; qcc::SocketFd m_ipv6QuietSockFd; qcc::SocketFd m_ipv4UnicastSockFd; qcc::Event* m_unicastEvent; std::list m_burstQueue; /** * Hash functor */ struct Hash { inline size_t operator()(const qcc::String& s) const { return qcc::hash_string(s.c_str()); } }; struct Equal { inline bool operator()(const qcc::String& s1, const qcc::String& s2) const { return s1 == s2; } }; struct MDNSPacketTrackerEntry { uint16_t burstId; qcc::Timespec timeStamp; MDNSPacketTrackerEntry(uint16_t burstId = 0) : burstId(burstId) { GetTimeNow(&timeStamp); }; }; /** * Hash functor for PacketTracker Key */ struct HashPacketTracker { inline size_t operator()(const std::pair& s) const { qcc::String str = s.first + s.second.ToString(); return qcc::hash_string(str.c_str()); } }; struct EqualPacketTracker { inline bool operator()(const std::pair& s1, const std::pair& s2) const { return (s1.first == s2.first) && (s1.second == s2.second); } }; std::unordered_map, MDNSPacketTrackerEntry, HashPacketTracker, EqualPacketTracker> m_mdnsPacketTracker; /* * PeerInfo holds the information about a peer for which we know the unicast address * The timestamp field is used for cache refresh */ struct PeerInfo { qcc::IPEndpoint unicastInfo; mutable qcc::Timespec lastQueryTimeStamp; mutable qcc::Timespec lastResponseTimeStamp; PeerInfo(const qcc::IPEndpoint& ipEndpoint) : unicastInfo(ipEndpoint) { } qcc::String ToString(const qcc::String& guid) const; bool operator<(const PeerInfo& other) const { return unicastInfo.ToString() < other.unicastInfo.ToString(); } bool operator==(const PeerInfo& other) const { return unicastInfo.ToString() == other.unicastInfo.ToString(); } }; std::unordered_map, Hash, Equal> m_peerInfoMap; void PrintPeerInfoMap(); class BurstExpiryHandler; BurstExpiryHandler* burstExpiryHandler; bool HandleSearchQuery(TransportMask transport, MDNSPacket mdnsPacket, const qcc::IPEndpoint& src, const qcc::String& guid, const qcc::IPEndpoint& dst); bool HandleAdvertiseResponse(MDNSPacket mdnsPacket, const qcc::String& guid, const qcc::IPEndpoint& ns4, const qcc::IPEndpoint& r4, const qcc::IPEndpoint& r6, const qcc::IPEndpoint& u4, const qcc::IPEndpoint& u6); std::set GetAdvertising(TransportMask transport); std::set GetAdvertisingQuietly(TransportMask transport); std::list m_listeners; bool m_protectListeners; PacketScheduler m_packetScheduler; uint32_t m_networkChangeScheduleCount; bool m_doNetworkCallback[N_TRANSPORTS]; qcc::NetworkEventSet m_networkEvents; qcc::Timespec m_networkChangeTimeStamp; uint32_t m_staticScore; uint32_t m_dynamicScore; uint16_t m_priority; uint32_t m_powerSource; uint32_t m_mobility; uint32_t m_availability; uint32_t m_nodeConnection; struct DynamicParams { uint32_t availableTransportConnections; uint32_t availableTransportRemoteClients; uint32_t maximumTransportConnections; uint32_t maximumTransportRemoteClients; }; DynamicParams m_dynamicParams[N_TRANSPORTS]; bool PurgeAndUpdatePacket(MDNSPacket mdnspacket, bool updateSid); void PurgeMDNSPacketTracker(); bool IsMDNSPacketTrackerEmpty(); }; } // namespace ajn #endif // _IP_NAME_SERVICE_IMPL_H alljoyn-15.04b/alljoyn_core/router/ns/IpNsProtocol.cc000066400000000000000000003060171255700255500226740ustar00rootroot00000000000000/** * @file * The simple name service protocol implementation */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #include "IpNsProtocol.h" #define QCC_MODULE "NS" // // Strangely, Android doesn't define the IPV4 presentation format string length // even though it does define the IPv6 version. // #ifndef INET_ADDRSTRLEN #define INET_ADDRSTRLEN 16 #endif using namespace std; using namespace qcc; namespace ajn { _Packet::_Packet() : m_timer(0), m_destination("0.0.0.0", 0), m_destinationSet(false), m_interfaceIndex((uint32_t)-1), m_interfaceIndexSet(false), m_addressFamily(qcc::QCC_AF_UNSPEC), m_addressFamilySet(false), m_retries(0), m_tick(0), m_version(0) { } _Packet::~_Packet() { } StringData::StringData() : m_size(0) { } StringData::~StringData() { } void StringData::Set(qcc::String string) { m_size = string.size(); m_string = string; } qcc::String StringData::Get(void) const { return m_string; } size_t StringData::GetSerializedSize(void) const { return 1 + m_size; } size_t StringData::Serialize(uint8_t* buffer) const { QCC_DbgPrintf(("StringData::Serialize(): %s to buffer 0x%x", m_string.c_str(), buffer)); assert(m_size == m_string.size()); buffer[0] = static_cast(m_size); memcpy(reinterpret_cast(&buffer[1]), const_cast(reinterpret_cast(m_string.c_str())), m_size); return 1 + m_size; } size_t StringData::Deserialize(uint8_t const* buffer, uint32_t bufsize) { QCC_DbgPrintf(("StringData::Deserialize()")); // // If there's not enough data in the buffer to even get the string size out // then bail. // if (bufsize < 1) { QCC_DbgPrintf(("StringData::Deserialize(): Insufficient bufsize %d", bufsize)); return 0; } m_size = buffer[0]; --bufsize; // // If there's not enough data in the buffer then bail. // if (bufsize < m_size) { QCC_DbgPrintf(("StringData::Deserialize(): Insufficient bufsize %d", bufsize)); m_size = 0; return 0; } if (m_size > 0) { m_string.assign(reinterpret_cast(buffer + 1), m_size); } else { m_string.clear(); } QCC_DbgPrintf(("StringData::Deserialize(): %s from buffer", m_string.c_str())); return 1 + m_size; } IsAt::IsAt() : m_version(0), m_flagG(false), m_flagC(false), m_flagT(false), m_flagU(false), m_flagS(false), m_flagF(false), m_flagR4(false), m_flagU4(false), m_flagR6(false), m_flagU6(false), m_port(0), m_reliableIPv4Port(0), m_unreliableIPv4Port(0), m_reliableIPv6Port(0), m_unreliableIPv6Port(0) { } IsAt::~IsAt() { } void IsAt::SetGuid(const qcc::String& guid) { m_guid = guid; m_flagG = true; } qcc::String IsAt::GetGuid(void) const { return m_guid; } void IsAt::SetPort(uint16_t port) { m_port = port; } uint16_t IsAt::GetPort(void) const { return m_port; } void IsAt::ClearIPv4(void) { m_ipv4.clear(); m_flagF = false; } void IsAt::SetIPv4(qcc::String ipv4) { m_ipv4 = ipv4; m_flagF = true; } qcc::String IsAt::GetIPv4(void) const { return m_ipv4; } void IsAt::ClearIPv6(void) { m_ipv6.clear(); m_flagS = false; } void IsAt::SetIPv6(qcc::String ipv6) { m_ipv6 = ipv6; m_flagS = true; } qcc::String IsAt::GetIPv6(void) const { return m_ipv6; } void IsAt::ClearReliableIPv4(void) { m_reliableIPv4Address.clear(); m_reliableIPv4Port = 0; m_flagR4 = false; } void IsAt::SetReliableIPv4(qcc::String addr, uint16_t port) { m_reliableIPv4Address = addr; m_reliableIPv4Port = port; m_flagR4 = true; } qcc::String IsAt::GetReliableIPv4Address(void) const { return m_reliableIPv4Address; } uint16_t IsAt::GetReliableIPv4Port(void) const { return m_reliableIPv4Port; } void IsAt::ClearUnreliableIPv4(void) { m_unreliableIPv4Address.clear(); m_unreliableIPv4Port = 0; m_flagU4 = false; } void IsAt::SetUnreliableIPv4(qcc::String addr, uint16_t port) { m_unreliableIPv4Address = addr; m_unreliableIPv4Port = port; m_flagU4 = true; } qcc::String IsAt::GetUnreliableIPv4Address(void) const { return m_unreliableIPv4Address; } uint16_t IsAt::GetUnreliableIPv4Port(void) const { return m_unreliableIPv4Port; } void IsAt::ClearReliableIPv6(void) { m_reliableIPv6Address.clear(); m_reliableIPv6Port = 0; m_flagR6 = false; } void IsAt::SetReliableIPv6(qcc::String addr, uint16_t port) { m_reliableIPv6Address = addr; m_reliableIPv6Port = port; m_flagR6 = true; } qcc::String IsAt::GetReliableIPv6Address(void) const { return m_reliableIPv6Address; } uint16_t IsAt::GetReliableIPv6Port(void) const { return m_reliableIPv6Port; } void IsAt::ClearUnreliableIPv6(void) { m_unreliableIPv6Address.clear(); m_unreliableIPv6Port = 0; m_flagU6 = false; } void IsAt::SetUnreliableIPv6(qcc::String addr, uint16_t port) { m_unreliableIPv6Address = addr; m_unreliableIPv6Port = port; m_flagU6 = true; } qcc::String IsAt::GetUnreliableIPv6Address(void) const { return m_unreliableIPv6Address; } uint16_t IsAt::GetUnreliableIPv6Port(void) const { return m_unreliableIPv6Port; } void IsAt::Reset(void) { m_names.clear(); } void IsAt::AddName(qcc::String name) { m_names.push_back(name); } void IsAt::RemoveName(uint32_t index) { if (index < m_names.size()) { m_names.erase(m_names.begin() + index); } } uint32_t IsAt::GetNumberNames(void) const { return m_names.size(); } qcc::String IsAt::GetName(uint32_t index) const { assert(index < m_names.size()); return m_names[index]; } size_t IsAt::GetSerializedSize(void) const { size_t size; // // The message version is in the least significant nibble of the version. // We don't care about the peer name service protocol version which is // meta-data about the other side and is in the most significant nibble. // switch (m_version & 0xf) { case 0: // // We have one octet for type and flags, one octet for count and // two octets for port. Four octets to start. // size = 4; // // If the F bit is set, we are going to include an IPv4 address // which is 32 bits long; // if (m_flagF) { size += 32 / 8; } // // If the S bit is set, we are going to include an IPv6 address // which is 128 bits long; // if (m_flagS) { size += 128 / 8; } // // Let the string data decide for themselves how long the rest of the // message will be. The rest of the message will be a possible GUID // string and the names. // if (m_flagG) { StringData s; s.Set(m_guid); size += s.GetSerializedSize(); } for (uint32_t i = 0; i < m_names.size(); ++i) { StringData s; s.Set(m_names[i]); size += s.GetSerializedSize(); } break; case 1: // // We have one octet for type and flags, one octet for count and // two octets for the transport mask. Four octets to start. // size = 4; // // If the R4 bit is set, we are going to include an IPv4 address // which is 32 bits long and a port which is 16 bits long. // if (m_flagR4) { size += 6; } // // If the U4 bit is set, we are going to include an IPv4 address // which is 32 bits long and a port which is 16 bits long. // if (m_flagU4) { size += 6; } // // If the R6 bit is set, we are going to include an IPv6 address // which is 128 bits long and a port which is 16 bits long. // if (m_flagR6) { size += 18; } // // If the U6 bit is set, we are going to include an IPv6 address // which is 32 bits long and a port which is 16 bits long. // if (m_flagU6) { size += 18; } // // Let the string data decide for themselves how long the rest of the // message will be. The rest of the message will be a possible GUID // string and the names. // if (m_flagG) { StringData s; s.Set(m_guid); size += s.GetSerializedSize(); } for (uint32_t i = 0; i < m_names.size(); ++i) { StringData s; s.Set(m_names[i]); size += s.GetSerializedSize(); } break; default: assert(false && "IsAt::GetSerializedSize(): Unexpected version"); QCC_LogError(ER_WARNING, ("IsAt::GetSerializedSize(): Unexpected version %d", m_version & 0xf)); size = 0; break; } return size; } size_t IsAt::Serialize(uint8_t* buffer) const { QCC_DbgPrintf(("IsAt::Serialize(): to buffer 0x%x", buffer)); // // We keep track of the size so testers can check coherence between // GetSerializedSize() and Serialize() and Deserialize(). // size_t size = 0; uint8_t typeAndFlags; uint8_t* p = NULL; // // The message version is in the least significant nibble of the version. // We don't care about the peer name service protocol version which is // meta-data about the other side and is in the most significant nibble. // switch (m_version & 0xf) { case 0: // // The first octet is type (M = 1) and flags. // typeAndFlags = 1 << 6; if (m_flagG) { QCC_DbgPrintf(("IsAt::Serialize(): G flag")); typeAndFlags |= 0x20; } if (m_flagC) { QCC_DbgPrintf(("IsAt::Serialize(): C flag")); typeAndFlags |= 0x10; } if (m_flagT) { QCC_DbgPrintf(("IsAt::Serialize(): T flag")); typeAndFlags |= 0x8; } if (m_flagU) { QCC_DbgPrintf(("IsAt::Serialize(): U flag")); typeAndFlags |= 0x4; } if (m_flagS) { QCC_DbgPrintf(("IsAt::Serialize(): S flag")); typeAndFlags |= 0x2; } if (m_flagF) { QCC_DbgPrintf(("IsAt::Serialize(): F flag")); typeAndFlags |= 0x1; } buffer[0] = typeAndFlags; size += 1; // // The second octet is the count of bus names. // assert(m_names.size() < 256); buffer[1] = static_cast(m_names.size()); QCC_DbgPrintf(("IsAt::Serialize(): Count %d", m_names.size())); size += 1; // // The following two octets are the port number in network byte // order (big endian, or most significant byte first). // buffer[2] = static_cast(m_port >> 8); buffer[3] = static_cast(m_port); QCC_DbgPrintf(("IsAt::Serialize(): Port %d", m_port)); size += 2; // // From this point on, things are not at fixed addresses // p = &buffer[4]; // // If the F bit is set, we need to include the IPv4 address. // if (m_flagF) { qcc::IPAddress::StringToIPv4(m_ipv4, p, 4); QCC_DbgPrintf(("IsAt::Serialize(): IPv4: %s", m_ipv4.c_str())); p += 4; size += 4; } // // If the S bit is set, we need to include the IPv6 address. // if (m_flagS) { qcc::IPAddress::StringToIPv6(m_ipv6, p, 16); QCC_DbgPrintf(("IsAt::Serialize(): IPv6: %s", m_ipv6.c_str())); p += 16; size += 16; } // // Let the string data decide for themselves how long the rest of the // message will be. If the G bit is set, we need to include the GUID // string. // if (m_flagG) { StringData stringData; stringData.Set(m_guid); QCC_DbgPrintf(("IsAt::Serialize(): GUID %s", m_guid.c_str())); size_t stringSize = stringData.Serialize(p); size += stringSize; p += stringSize; } for (uint32_t i = 0; i < m_names.size(); ++i) { StringData stringData; stringData.Set(m_names[i]); QCC_DbgPrintf(("IsAt::Serialize(): name %s", m_names[i].c_str())); size_t stringSize = stringData.Serialize(p); size += stringSize; p += stringSize; } break; case 1: // // The first octet is type (M = 1) and flags. // typeAndFlags = 1 << 6; if (m_flagG) { QCC_DbgPrintf(("IsAt::Serialize(): G flag")); typeAndFlags |= 0x20; } if (m_flagC) { QCC_DbgPrintf(("IsAt::Serialize(): C flag")); typeAndFlags |= 0x10; } if (m_flagR4) { QCC_DbgPrintf(("IsAt::Serialize(): R4 flag")); typeAndFlags |= 0x8; } if (m_flagU4) { QCC_DbgPrintf(("IsAt::Serialize(): U4 flag")); typeAndFlags |= 0x4; } if (m_flagR6) { QCC_DbgPrintf(("IsAt::Serialize(): R6 flag")); typeAndFlags |= 0x2; } if (m_flagU6) { QCC_DbgPrintf(("IsAt::Serialize(): U6 flag")); typeAndFlags |= 0x1; } buffer[0] = typeAndFlags; size += 1; // // The second octet is the count of bus names. // assert(m_names.size() < 256); buffer[1] = static_cast(m_names.size()); QCC_DbgPrintf(("IsAt::Serialize(): Count %d", m_names.size())); size += 1; // // The following two octets are the transport mask in network byte // order (big endian, or most significant byte first). // buffer[2] = static_cast(m_transportMask >> 8); buffer[3] = static_cast(m_transportMask); QCC_DbgPrintf(("IsAt::Serialize(): TransportMask 0x%x", m_transportMask)); size += 2; // // From this point on, things are not at fixed addresses // p = &buffer[4]; // // If the R4 bit is set, we need to include the reliable IPv4 address // and port. // if (m_flagR4) { qcc::IPAddress::StringToIPv4(m_reliableIPv4Address, p, 4); QCC_DbgPrintf(("IsAt::Serialize(): Reliable IPv4: %s", m_reliableIPv4Address.c_str())); p += 4; size += 4; *p++ = static_cast(m_reliableIPv4Port >> 8); *p++ = static_cast(m_reliableIPv4Port); QCC_DbgPrintf(("IsAt::Serialize(): Reliable IPv4 port %d", m_reliableIPv4Port)); size += 2; } // // If the U4 bit is set, we need to include the unreliable IPv4 address // and port. // if (m_flagU4) { qcc::IPAddress::StringToIPv4(m_unreliableIPv4Address, p, 4); QCC_DbgPrintf(("IsAt::Serialize(): Unreliable IPv4: %s", m_unreliableIPv4Address.c_str())); p += 4; size += 4; *p++ = static_cast(m_unreliableIPv4Port >> 8); *p++ = static_cast(m_unreliableIPv4Port); QCC_DbgPrintf(("IsAt::Serialize(): Unreliable IPv4 port %d", m_unreliableIPv4Port)); size += 2; } // // If the R6 bit is set, we need to include the reliable IPv6 address // and port. // if (m_flagR6) { qcc::IPAddress::StringToIPv6(m_reliableIPv6Address, p, 16); QCC_DbgPrintf(("IsAt::Serialize(): Reliable IPv6: %s", m_reliableIPv6Address.c_str())); p += 16; size += 16; *p++ = static_cast(m_reliableIPv6Port >> 8); *p++ = static_cast(m_reliableIPv6Port); QCC_DbgPrintf(("IsAt::Serialize(): Reliable IPv6 port %d", m_reliableIPv6Port)); size += 2; } // // If the U6 bit is set, we need to include the unreliable IPv6 address // and port. // if (m_flagU6) { qcc::IPAddress::StringToIPv6(m_unreliableIPv6Address, p, 16); QCC_DbgPrintf(("IsAt::Serialize(): Unreliable IPv6: %s", m_unreliableIPv6Address.c_str())); p += 16; size += 16; *p++ = static_cast(m_unreliableIPv6Port >> 8); *p++ = static_cast(m_unreliableIPv6Port); QCC_DbgPrintf(("IsAt::Serialize(): Unreliable IPv6 port %d", m_unreliableIPv6Port)); size += 2; } // // Let the string data decide for themselves how long the rest of the // message will be. If the G bit is set, we need to include the GUID // string. // if (m_flagG) { StringData stringData; stringData.Set(m_guid); QCC_DbgPrintf(("IsAt::Serialize(): GUID %s", m_guid.c_str())); size_t stringSize = stringData.Serialize(p); size += stringSize; p += stringSize; } for (uint32_t i = 0; i < m_names.size(); ++i) { StringData stringData; stringData.Set(m_names[i]); QCC_DbgPrintf(("IsAt::Serialize(): name %s", m_names[i].c_str())); size_t stringSize = stringData.Serialize(p); size += stringSize; p += stringSize; } break; default: assert(false && "IsAt::Serialize(): Unexpected version"); break; } return size; } size_t IsAt::Deserialize(uint8_t const* buffer, uint32_t bufsize) { QCC_DbgPrintf(("IsAt::Deserialize()")); // // We keep track of the size (the size of the buffer we read) so testers // can check coherence between GetSerializedSize() and Serialize() and // Deserialize(). // size_t size = 0; uint8_t typeAndFlags = 0; uint8_t const* p = NULL; uint8_t numberNames = 0; // // The message version is in the least significant nibble of the version. // We don't care about the peer name service protocol version which is // meta-data about the other side and is in the most significant nibble. // switch (m_version & 0xf) { case 0: // // If there's not enough room in the buffer to get the fixed part out then // bail (one byte of type and flags, one byte of name count and two bytes // of port). // if (bufsize < 4) { QCC_DbgPrintf(("IsAt::Deserialize(): Insufficient bufsize %d", bufsize)); return 0; } size = 0; // // The first octet is type (1) and flags. // typeAndFlags = buffer[0]; size += 1; // // This had better be an IsAt message we're working on // if ((typeAndFlags & 0xc0) != 1 << 6) { QCC_DbgPrintf(("IsAt::Deserialize(): Incorrect type %d", typeAndFlags & 0xc0)); return 0; } m_flagG = (typeAndFlags & 0x20) != 0; QCC_DbgPrintf(("IsAt::Deserialize(): G flag %d", m_flagG)); m_flagC = (typeAndFlags & 0x10) != 0; QCC_DbgPrintf(("IsAt::Deserialize(): C flag %d", m_flagC)); m_flagT = (typeAndFlags & 0x8) != 0; QCC_DbgPrintf(("IsAt::Deserialize(): T flag %d", m_flagT)); m_flagU = (typeAndFlags & 0x4) != 0; QCC_DbgPrintf(("IsAt::Deserialize(): U flag %d", m_flagU)); m_flagS = (typeAndFlags & 0x2) != 0; QCC_DbgPrintf(("IsAt::Deserialize(): S flag %d", m_flagS)); m_flagF = (typeAndFlags & 0x1) != 0; QCC_DbgPrintf(("IsAt::Deserialize(): F flag %d", m_flagF)); // // The second octet is the count of bus names. // numberNames = buffer[1]; QCC_DbgPrintf(("IsAt::Deserialize(): Count %d", numberNames)); size += 1; // // The following two octets are the port number in network byte // order (big endian, or most significant byte first). // m_port = (static_cast(buffer[2]) << 8) | (static_cast(buffer[3]) & 0xff); QCC_DbgPrintf(("IsAt::Deserialize(): Port %d", m_port)); size += 2; // // From this point on, things are not at fixed addresses // p = &buffer[4]; bufsize -= 4; // // If the F bit is set, we need to read off an IPv4 address; and we'd better // have enough buffer to read it out of. // if (m_flagF) { if (bufsize < 4) { QCC_DbgPrintf(("IsAt::Deserialize(): Insufficient bufsize %d", bufsize)); return 0; } m_ipv4 = qcc::IPAddress::IPv4ToString(p); QCC_DbgPrintf(("IsAt::Deserialize(): IPv4: %s", m_ipv4.c_str())); p += 4; size += 4; bufsize -= 4; } // // If the S bit is set, we need to read off an IPv6 address; and we'd better // have enough buffer to read it out of. // if (m_flagS) { if (bufsize < 16) { QCC_DbgPrintf(("IsAt::Deserialize(): Insufficient bufsize %d", bufsize)); return 0; } m_ipv6 = qcc::IPAddress::IPv6ToString(p); QCC_DbgPrintf(("IsAt::Deserialize(): IPv6: %s", m_ipv6.c_str())); p += 16; size += 16; bufsize -= 16; } // // If the G bit is set, we need to read off a GUID string. // if (m_flagG) { QCC_DbgPrintf(("IsAt::Deserialize(): StringData::Deserialize() GUID")); StringData stringData; // // Tell the string to read itself out. If there's not enough buffer // it will complain by returning 0. We pass the complaint on up. // size_t stringSize = stringData.Deserialize(p, bufsize); if (stringSize == 0) { QCC_DbgPrintf(("IsAt::Deserialize(): StringData::Deserialize(): Error")); return 0; } SetGuid(stringData.Get()); size += stringSize; p += stringSize; bufsize -= stringSize; } // // Now we need to read out names that the packet has told us // will be there. // for (uint32_t i = 0; i < numberNames; ++i) { QCC_DbgPrintf(("IsAt::Deserialize(): StringData::Deserialize() name %d", i)); StringData stringData; // // Tell the string to read itself out. If there's not enough buffer // it will complain by returning 0. We pass the complaint on up. // size_t stringSize = stringData.Deserialize(p, bufsize); if (stringSize == 0) { QCC_DbgPrintf(("IsAt::Deserialize(): StringData::Deserialize(): Error")); return 0; } AddName(stringData.Get()); size += stringSize; p += stringSize; bufsize -= stringSize; } break; case 1: // // If there's not enough room in the buffer to get the fixed part out then // bail (one byte of type and flags, one byte of name count) // if (bufsize < 4) { QCC_DbgPrintf(("IsAt::Deserialize(): Insufficient bufsize %d", bufsize)); return 0; } // // We keep track of the size (the size of the buffer we read) so testers // can check coherence between GetSerializedSize() and Serialize() and // Deserialize(). // size = 0; // // The first octet is type (1) and flags. // typeAndFlags = buffer[0]; size += 1; // // This had better be an IsAt message we're working on // if ((typeAndFlags & 0xc0) != 1 << 6) { QCC_DbgPrintf(("IsAt::Deserialize(): Incorrect type %d", typeAndFlags & 0xc0)); return 0; } m_flagG = (typeAndFlags & 0x20) != 0; QCC_DbgPrintf(("IsAt::Deserialize(): G flag %d", m_flagG)); m_flagC = (typeAndFlags & 0x10) != 0; QCC_DbgPrintf(("IsAt::Deserialize(): C flag %d", m_flagC)); m_flagR4 = (typeAndFlags & 0x8) != 0; QCC_DbgPrintf(("IsAt::Deserialize(): R4 flag %d", m_flagR4)); m_flagU4 = (typeAndFlags & 0x4) != 0; QCC_DbgPrintf(("IsAt::Deserialize(): U4 flag %d", m_flagU4)); m_flagR6 = (typeAndFlags & 0x2) != 0; QCC_DbgPrintf(("IsAt::Deserialize(): R6 flag %d", m_flagR6)); m_flagU6 = (typeAndFlags & 0x1) != 0; QCC_DbgPrintf(("IsAt::Deserialize(): F flag %d", m_flagU6)); // // The second octet is the count of bus names. // numberNames = buffer[1]; QCC_DbgPrintf(("IsAt::Deserialize(): Count %d", numberNames)); size += 1; m_transportMask = (static_cast(buffer[2]) << 8) | (static_cast(buffer[3]) & 0xff); QCC_DbgPrintf(("IsAt::Serialize(): TransportMask 0x%x", m_transportMask)); size += 2; // // From this point on, things are not at fixed addresses // p = &buffer[4]; bufsize -= 4; // // If the R4 bit is set, we need to read off an IPv4 address and port; // and we'd better have enough buffer to read it out of. // if (m_flagR4) { if (bufsize < 6) { QCC_DbgPrintf(("IsAt::Deserialize(): Insufficient bufsize %d", bufsize)); return 0; } m_reliableIPv4Address = qcc::IPAddress::IPv4ToString(p); QCC_DbgPrintf(("IsAt::Deserialize(): Reliable IPv4: %s", m_reliableIPv4Address.c_str())); p += 4; size += 4; bufsize -= 4; m_reliableIPv4Port = (static_cast(p[0]) << 8) | (static_cast(p[1]) & 0xff); QCC_DbgPrintf(("IsAt::Deserialize(): Reliable IPv4 port %d", m_reliableIPv4Port)); p += 2; size += 2; bufsize -= 2; } // // If the R4 bit is set, we need to read off an IPv4 address and port; // and we'd better have enough buffer to read it out of. // if (m_flagU4) { if (bufsize < 6) { QCC_DbgPrintf(("IsAt::Deserialize(): Insufficient bufsize %d", bufsize)); return 0; } m_unreliableIPv4Address = qcc::IPAddress::IPv4ToString(p); QCC_DbgPrintf(("IsAt::Deserialize(): Unreliable IPv4: %s", m_unreliableIPv4Address.c_str())); p += 4; size += 4; bufsize -= 4; m_unreliableIPv4Port = (static_cast(p[0]) << 8) | (static_cast(p[1]) & 0xff); QCC_DbgPrintf(("IsAt::Deserialize(): Unreliable IPv4 port %d", m_unreliableIPv4Port)); p += 2; size += 2; bufsize -= 2; } // // If the R6 bit is set, we need to read off an IPv6 address and port; and we'd better // have enough buffer to read it out of. // if (m_flagR6) { if (bufsize < 18) { QCC_DbgPrintf(("IsAt::Deserialize(): Insufficient bufsize %d", bufsize)); return 0; } m_reliableIPv6Address = qcc::IPAddress::IPv6ToString(p); QCC_DbgPrintf(("IsAt::Deserialize(): Reliable IPv6: %s", m_reliableIPv6Address.c_str())); p += 16; size += 16; bufsize -= 16; m_reliableIPv6Port = (static_cast(p[0]) << 8) | (static_cast(p[1]) & 0xff); QCC_DbgPrintf(("IsAt::Deserialize(): Reliable IPv6 port %d", m_reliableIPv6Port)); p += 2; size += 2; bufsize -= 2; } // // If the U6 bit is set, we need to read off an IPv6 address and port; and we'd better // have enough buffer to read it out of. // if (m_flagU6) { if (bufsize < 18) { QCC_DbgPrintf(("IsAt::Deserialize(): Insufficient bufsize %d", bufsize)); return 0; } m_unreliableIPv6Address = qcc::IPAddress::IPv6ToString(p); QCC_DbgPrintf(("IsAt::Deserialize(): Unreliable IPv6: %s", m_unreliableIPv6Address.c_str())); p += 16; size += 16; bufsize -= 16; m_unreliableIPv6Port = (static_cast(p[0]) << 8) | (static_cast(p[1]) & 0xff); QCC_DbgPrintf(("IsAt::Deserialize(): Unreliable IPv6 port %d", m_unreliableIPv6Port)); p += 2; size += 2; bufsize -= 2; } // // If the G bit is set, we need to read off a GUID string. // if (m_flagG) { QCC_DbgPrintf(("IsAt::Deserialize(): StringData::Deserialize() GUID")); StringData stringData; // // Tell the string to read itself out. If there's not enough buffer // it will complain by returning 0. We pass the complaint on up. // size_t stringSize = stringData.Deserialize(p, bufsize); if (stringSize == 0) { QCC_DbgPrintf(("IsAt::Deserialize(): StringData::Deserialize(): Error")); return 0; } SetGuid(stringData.Get()); size += stringSize; p += stringSize; bufsize -= stringSize; } // // Now we need to read out names that the packet has told us // will be there. // for (uint32_t i = 0; i < numberNames; ++i) { QCC_DbgPrintf(("IsAt::Deserialize(): StringData::Deserialize() name %d", i)); StringData stringData; // // Tell the string to read itself out. If there's not enough buffer // it will complain by returning 0. We pass the complaint on up. // size_t stringSize = stringData.Deserialize(p, bufsize); if (stringSize == 0) { QCC_DbgPrintf(("IsAt::Deserialize(): StringData::Deserialize(): Error")); return 0; } AddName(stringData.Get()); size += stringSize; p += stringSize; bufsize -= stringSize; } break; default: assert(false && "IsAt::Deserialize(): Unexpected version"); break; } return size; } WhoHas::WhoHas() : m_version(0), m_transportMask(TRANSPORT_NONE), m_flagT(false), m_flagU(false), m_flagS(false), m_flagF(false) { } WhoHas::~WhoHas() { } void WhoHas::Reset(void) { m_names.clear(); } void WhoHas::AddName(qcc::String name) { m_names.push_back(name); } uint32_t WhoHas::GetNumberNames(void) const { return m_names.size(); } qcc::String WhoHas::GetName(uint32_t index) const { assert(index < m_names.size()); return m_names[index]; } size_t WhoHas::GetSerializedSize(void) const { // // Version zero and one are identical with the exeption of the definition // of the flags, so the size is the same. // size_t size = 0; // // The message version is in the least significant nibble of the version. // We don't care about the peer name service protocol version which is // meta-data about the other side and is in the most significant nibble. // switch (m_version & 0xf) { case 0: case 1: // // We have one octet for type and flags and one octet for count. // Two octets to start. // size = 2; // // Let the string data decide for themselves how long the rest // of the message will be. // for (uint32_t i = 0; i < m_names.size(); ++i) { StringData s; s.Set(m_names[i]); size += s.GetSerializedSize(); } break; default: assert(false && "WhoHas::GetSerializedSize(): Unexpected version"); break; } return size; } size_t WhoHas::Serialize(uint8_t* buffer) const { QCC_DbgPrintf(("WhoHas::Serialize(): to buffer 0x%x", buffer)); // // We keep track of the size so testers can check coherence between // GetSerializedSize() and Serialize() and Deserialize(). // size_t size = 0; // // The first octet is type (M = 2) and flags. // uint8_t typeAndFlags = 2 << 6; // // The only difference between version zero and one is that in version one // the flags are deprecated and revert to reserved. So we just don't // serialize them if we are writing a version one object. // // The message version is in the least significant nibble of the version. // We don't care about the peer name service protocol version which is // meta-data about the other side and is in the most significant nibble. // if ((m_version & 0xf) == 0) { if (m_flagT) { QCC_DbgPrintf(("WhoHas::Serialize(): T flag")); typeAndFlags |= 0x8; } if (m_flagU) { QCC_DbgPrintf(("WhoHas::Serialize(): U flag")); typeAndFlags |= 0x4; } if (m_flagS) { QCC_DbgPrintf(("WhoHas::Serialize(): S flag")); typeAndFlags |= 0x2; } if (m_flagF) { QCC_DbgPrintf(("WhoHas::Serialize(): F flag")); typeAndFlags |= 0x1; } } else { typeAndFlags |= 0x4; } buffer[0] = typeAndFlags; size += 1; // // The second octet is the count of bus names. // assert(m_names.size() < 256); buffer[1] = static_cast(m_names.size()); QCC_DbgPrintf(("WhoHas::Serialize(): Count %d", m_names.size())); size += 1; // // From this point on, things are not at fixed addresses // uint8_t* p = &buffer[2]; // // Let the string data decide for themselves how long the rest // of the message will be. // for (uint32_t i = 0; i < m_names.size(); ++i) { StringData stringData; stringData.Set(m_names[i]); QCC_DbgPrintf(("Whohas::Serialize(): name %s", m_names[i].c_str())); size_t stringSize = stringData.Serialize(p); size += stringSize; p += stringSize; } return size; } size_t WhoHas::Deserialize(uint8_t const* buffer, uint32_t bufsize) { QCC_DbgPrintf(("WhoHas::Deserialize()")); // // If there's not enough room in the buffer to get the fixed part out then // bail (one byte of type and flags, one byte of name count). // if (bufsize < 2) { QCC_DbgPrintf(("WhoHas::Deserialize(): Insufficient bufsize %d", bufsize)); return 0; } // // We keep track of the size so testers can check coherence between // GetSerializedSize() and Serialize() and Deserialize(). // size_t size = 0; // // The first octet is type (1) and flags. // uint8_t typeAndFlags = buffer[0]; size += 1; // // This had better be an WhoHas message we're working on // if ((typeAndFlags & 0xc0) != 2 << 6) { QCC_DbgPrintf(("WhoHas::Deserialize(): Incorrect type %d", typeAndFlags & 0xc0)); return 0; } // // Due to an oversight, the transport mask was not actually serialized, // so we initialize it to 0, which means no transport. // m_transportMask = TRANSPORT_NONE; // // The only difference between the version zero and version one protocols // is that the flags are deprecated in version one. In the case of // deserializing a version one object, we just don't set the old flags. // // The message version is in the least significant nibble of the version. // We don't care about the peer name service protocol version which is // meta-data about the other side and is in the most significant nibble. // switch (m_version & 0xf) { case 0: m_flagT = (typeAndFlags & 0x8) != 0; QCC_DbgPrintf(("WhoHas::Deserialize(): T flag %d", m_flagT)); m_flagU = (typeAndFlags & 0x4) != 0; QCC_DbgPrintf(("WhoHas::Deserialize(): U flag %d", m_flagU)); m_flagS = (typeAndFlags & 0x2) != 0; QCC_DbgPrintf(("WhoHas::Deserialize(): S flag %d", m_flagS)); m_flagF = (typeAndFlags & 0x1) != 0; QCC_DbgPrintf(("WhoHas::Deserialize(): F flag %d", m_flagF)); break; case 1: m_flagU = (typeAndFlags & 0x4) != 0; m_flagT = m_flagS = m_flagF = false; break; default: assert(false && "WhoHas::Deserialize(): Unexpected version"); break; } // // The second octet is the count of bus names. // uint8_t numberNames = buffer[1]; QCC_DbgPrintf(("WhoHas::Deserialize(): Count %d", numberNames)); size += 1; // // From this point on, things are not at fixed addresses // uint8_t const* p = &buffer[2]; bufsize -= 2; // // Now we need to read out names that the packet has told us // will be there. // for (uint32_t i = 0; i < numberNames; ++i) { QCC_DbgPrintf(("WhoHas::Deserialize(): StringData::Deserialize() name %d", i)); StringData stringData; // // Tell the string to read itself out. If there's not enough buffer // it will complain by returning 0. We pass the complaint on up. // size_t stringSize = stringData.Deserialize(p, bufsize); if (stringSize == 0) { QCC_DbgPrintf(("WhoHas::Deserialize(): StringData::Deserialize(): Error")); return 0; } AddName(stringData.Get()); size += stringSize; p += stringSize; bufsize -= stringSize; } return size; } _NSPacket::_NSPacket() { } _NSPacket::~_NSPacket() { } void _Packet::SetTimer(uint8_t timer) { m_timer = timer; } uint8_t _Packet::GetTimer(void) const { return m_timer; } void _NSPacket::Reset(void) { m_questions.clear(); m_answers.clear(); } void _NSPacket::AddQuestion(WhoHas question) { m_questions.push_back(question); } uint32_t _NSPacket::GetNumberQuestions(void) const { return m_questions.size(); } WhoHas _NSPacket::GetQuestion(uint32_t index) const { assert(index < m_questions.size()); return m_questions[index]; } void _NSPacket::GetQuestion(uint32_t index, WhoHas** question) { assert(index < m_questions.size()); *question = &m_questions[index]; } void _NSPacket::AddAnswer(IsAt answer) { m_answers.push_back(answer); } void _NSPacket::RemoveAnswer(uint32_t index) { if (index < m_answers.size()) { m_answers.erase(m_answers.begin() + index); } } uint32_t _NSPacket::GetNumberAnswers(void) const { return m_answers.size(); } IsAt _NSPacket::GetAnswer(uint32_t index) const { assert(index < m_answers.size()); return m_answers[index]; } void _NSPacket::GetAnswer(uint32_t index, IsAt** answer) { assert(index < m_answers.size()); *answer = &m_answers[index]; } size_t _NSPacket::GetSerializedSize(void) const { // // We have one octet for version, one four question count, one for answer // count and one for timer. Four octets to start. // size_t size = 4; // // Let the questions data decide for themselves how long the question part // of the message will be. // for (uint32_t i = 0; i < m_questions.size(); ++i) { WhoHas whoHas = m_questions[i]; size += whoHas.GetSerializedSize(); } // // Let the answers decide for themselves how long the answer part // of the message will be. // for (uint32_t i = 0; i < m_answers.size(); ++i) { IsAt isAt = m_answers[i]; size += isAt.GetSerializedSize(); } return size; } size_t _NSPacket::Serialize(uint8_t* buffer) const { QCC_DbgPrintf(("NSPacket::Serialize(): to buffer 0x%x", buffer)); // // We keep track of the size so testers can check coherence between // GetSerializedSize() and Serialize() and Deserialize(). // size_t size = 0; // // The first octet is version // buffer[0] = m_version; QCC_DbgPrintf(("NSPacket::Serialize(): version = %d", m_version)); size += 1; // // The second octet is the count of questions. // buffer[1] = static_cast(m_questions.size()); QCC_DbgPrintf(("NSPacket::Serialize(): QCount = %d", m_questions.size())); size += 1; // // The third octet is the count of answers. // buffer[2] = static_cast(m_answers.size()); QCC_DbgPrintf(("NSPacket::Serialize(): ACount = %d", m_answers.size())); size += 1; // // The fourth octet is the timer for the answers. // buffer[3] = GetTimer(); QCC_DbgPrintf(("NSPacket::Serialize(): timer = %d", GetTimer())); size += 1; // // From this point on, things are not at fixed addresses // uint8_t* p = &buffer[4]; // // Let the questions push themselves out. // for (uint32_t i = 0; i < m_questions.size(); ++i) { QCC_DbgPrintf(("NSPacket::Serialize(): WhoHas::Serialize() question %d", i)); WhoHas whoHas = m_questions[i]; size_t questionSize = whoHas.Serialize(p); size += questionSize; p += questionSize; } // // Let the answers push themselves out. // for (uint32_t i = 0; i < m_answers.size(); ++i) { QCC_DbgPrintf(("NSPacket::Serialize(): IsAt::Serialize() answer %d", i)); IsAt isAt = m_answers[i]; size_t answerSize = isAt.Serialize(p); size += answerSize; p += answerSize; } return size; } size_t _NSPacket::Deserialize(uint8_t const* buffer, uint32_t bufsize) { // // If there's not enough room in the buffer to get the fixed part out then // bail (one byte of version, one byte of question count, one byte of answer // count and one byte of timer). // if (bufsize < 4) { QCC_DbgPrintf(("NSPacket::Deserialize(): Insufficient bufsize %d", bufsize)); return 0; } // // We keep track of the size so testers can check coherence between // GetSerializedSize() and Serialize() and Deserialize(). // size_t size = 0; // // The first octet is version. We need to filter out bogus versions here // since we are going to promptly set this version in the included who-has // and is-at messages and they will assert that the versions we set actually // make sense. // uint8_t msgVersion; msgVersion = buffer[0] & 0xf; if (msgVersion != 0 && msgVersion != 1) { QCC_DbgPrintf(("Header::Deserialize(): Bad message version %d", msgVersion)); return 0; } m_version = buffer[0]; size += 1; // // The second octet is the count of questions. // uint8_t qCount = buffer[1]; size += 1; // // The third octet is the count of answers. // uint8_t aCount = buffer[2]; size += 1; // // The fourth octet is the timer for the answers. // SetTimer(buffer[3]); size += 1; // // From this point on, things are not at fixed addresses // uint8_t const* p = &buffer[4]; bufsize -= 4; // // Now we need to read out questions that the packet has told us // will be there. // for (uint8_t i = 0; i < qCount; ++i) { QCC_DbgPrintf(("NSPacket::Deserialize(): WhoHas::Deserialize() question %d", i)); WhoHas whoHas; whoHas.SetVersion(m_version >> 4, m_version & 0xf); // // Tell the question to read itself out. If there's not enough buffer // it will complain by returning 0. We pass the complaint on up. // size_t qSize = whoHas.Deserialize(p, bufsize); if (qSize == 0) { QCC_DbgPrintf(("NSPacket::Deserialize(): WhoHas::Deserialize(): Error")); return 0; } m_questions.push_back(whoHas); size += qSize; p += qSize; bufsize -= qSize; } // // Now we need to read out answers that the packet has told us // will be there. // for (uint8_t i = 0; i < aCount; ++i) { QCC_DbgPrintf(("NSPacket::Deserialize(): IsAt::Deserialize() answer %d", i)); IsAt isAt; isAt.SetVersion(m_version >> 4, m_version & 0xf); // // Tell the answer to read itself out. If there's not enough buffer // it will complain by returning 0. We pass the complaint on up. // size_t aSize = isAt.Deserialize(p, bufsize); if (aSize == 0) { QCC_DbgPrintf(("NSPacket::Deserialize(): IsAt::Deserialize(): Error")); return 0; } m_answers.push_back(isAt); size += aSize; p += aSize; bufsize -= aSize; } return size; } //MDNSDomainName void MDNSDomainName::SetName(String name) { m_name = name; } String MDNSDomainName::GetName() const { return m_name; } MDNSDomainName::MDNSDomainName() { } MDNSDomainName::~MDNSDomainName() { } size_t MDNSDomainName::GetSerializedSize(std::map& offsets) const { size_t size = 0; String name = m_name; for (;;) { if (name.empty()) { size++; break; } else if (offsets.find(name) != offsets.end()) { size++; size++; break; } else { offsets[name] = 0; /* 0 is used as a placeholder so that the serialized size is computed correctly */ size_t newPos = name.find_first_of('.'); String temp = name.substr(0, newPos); size++; size += temp.length(); size_t pos = (newPos == String::npos) ? String::npos : (newPos + 1); name = name.substr(pos); } } return size; } size_t MDNSDomainName::Serialize(uint8_t* buffer, std::map& offsets, uint32_t headerOffset) const { size_t size = 0; String name = m_name; for (;;) { if (name.empty()) { buffer[size++] = 0; break; } else if (offsets.find(name) != offsets.end()) { buffer[size++] = 0xc0 | ((offsets[name] & 0xFF00) >> 8); buffer[size++] = (offsets[name] & 0xFF); break; } else { offsets[name] = size + headerOffset; size_t newPos = name.find_first_of('.'); String temp = name.substr(0, newPos); buffer[size++] = temp.length(); memcpy(reinterpret_cast(&buffer[size]), const_cast(reinterpret_cast(temp.c_str())), temp.size()); size += temp.length(); size_t pos = (newPos == String::npos) ? String::npos : (newPos + 1); name = name.substr(pos); } } return size; } size_t MDNSDomainName::Deserialize(uint8_t const* buffer, uint32_t bufsize, std::map& compressedOffsets, uint32_t headerOffset) { m_name.clear(); size_t size = 0; if (bufsize < 1) { QCC_DbgPrintf(("MDNSDomainName::Deserialize(): Insufficient bufsize %d", bufsize)); return 0; } vector offsets; while (bufsize > 0) { if (((buffer[size] & 0xc0) >> 6) == 3 && bufsize > 1) { uint32_t pointer = ((buffer[size] << 8 | buffer[size + 1]) & 0x3FFF); if (compressedOffsets.find(pointer) != compressedOffsets.end()) { if (m_name.length() > 0) { m_name.append('.'); } m_name.append(compressedOffsets[pointer]); size += 2; break; } else { return 0; } } size_t temp_size = buffer[size++]; bufsize--; // // If there's not enough data in the buffer then bail. // if (bufsize < temp_size) { QCC_DbgPrintf(("MDNSDomainName::Deserialize(): Insufficient bufsize %d", bufsize)); return 0; } if (m_name.length() > 0) { m_name.append('.'); } if (temp_size > 0) { offsets.push_back(headerOffset + size - 1); m_name.append(reinterpret_cast(buffer + size), temp_size); bufsize -= temp_size; size += temp_size; } else { break; } } for (uint32_t i = 0; i < offsets.size(); ++i) { compressedOffsets[offsets[i]] = m_name.substr(offsets[i] - headerOffset); } return size; } //MDNSQuestion MDNSQuestion::MDNSQuestion(qcc::String qName, uint16_t qType, uint16_t qClass) : m_qType(qType), m_qClass(qClass | QU_BIT) { m_qName.SetName(qName); } void MDNSQuestion::SetQName(String qName) { m_qName.SetName(qName); } String MDNSQuestion::GetQName() { return m_qName.GetName(); } void MDNSQuestion::SetQType(uint16_t qType) { m_qType = qType; } uint16_t MDNSQuestion::GetQType() { return m_qType; } void MDNSQuestion::SetQClass(uint16_t qClass) { m_qClass = qClass | QU_BIT; QCC_DbgPrintf(("%X %X ", qClass, m_qClass)); } uint16_t MDNSQuestion::GetQClass() { return m_qClass & ~QU_BIT; } size_t MDNSQuestion::GetSerializedSize(std::map& offsets) const { return m_qName.GetSerializedSize(offsets) + 4; } size_t MDNSQuestion::Serialize(uint8_t* buffer, std::map& offsets, uint32_t headerOffset) const { // Serialize the QNAME first size_t size = m_qName.Serialize(buffer, offsets, headerOffset); //Next two octets are QTYPE buffer[size] = (m_qType & 0xFF00) >> 8; buffer[size + 1] = (m_qType & 0xFF); //Next two octets are QCLASS buffer[size + 2] = (m_qClass & 0xFF00) >> 8; buffer[size + 3] = (m_qClass & 0xFF); QCC_DbgPrintf(("Set %X %X", buffer[size + 2], buffer[size + 3])); return size + 4; } size_t MDNSQuestion::Deserialize(uint8_t const* buffer, uint32_t bufsize, std::map& compressedOffsets, uint32_t headerOffset) { // Deserialize the QNAME first size_t size = m_qName.Deserialize(buffer, bufsize, compressedOffsets, headerOffset); if (size >= bufsize) { return 0; } bufsize -= size; if (size == 0 || bufsize < 4) { //Error while deserializing QNAME or insufficient buffer size QCC_DbgPrintf(("MDNSQuestion::Deserialize Error while deserializing QName")); return 0; } //Next two octets are QTYPE m_qType = (buffer[size] << 8) | buffer[size + 1]; size += 2; //Next two octets are QCLASS m_qClass = (buffer[size] << 8) | buffer[size + 1]; size += 2; return size; } MDNSRData::~MDNSRData() { } //MDNSResourceRecord MDNSResourceRecord::MDNSResourceRecord() : m_rdata(NULL) { } MDNSResourceRecord::MDNSResourceRecord(qcc::String domainName, RRType rrType, RRClass rrClass, uint16_t ttl, MDNSRData* rdata) : m_rrType(rrType), m_rrClass(rrClass), m_rrTTL(ttl) { m_rrDomainName.SetName(domainName); m_rdata = rdata->GetDeepCopy(); } MDNSResourceRecord::MDNSResourceRecord(const MDNSResourceRecord& r) : m_rrDomainName(r.m_rrDomainName), m_rrType(r.m_rrType), m_rrClass(r.m_rrClass), m_rrTTL(r.m_rrTTL) { m_rdata = r.m_rdata->GetDeepCopy(); } MDNSResourceRecord& MDNSResourceRecord::operator=(const MDNSResourceRecord& r) { if (this != &r) { m_rrDomainName = r.m_rrDomainName; m_rrType = r.m_rrType; m_rrClass = r.m_rrClass; m_rrTTL = r.m_rrTTL; if (m_rdata) { delete m_rdata; } m_rdata = r.m_rdata->GetDeepCopy(); } return *this; } MDNSResourceRecord::~MDNSResourceRecord() { if (m_rdata) { delete m_rdata; m_rdata = NULL; } } size_t MDNSResourceRecord::GetSerializedSize(std::map& offsets) const { assert(m_rdata); size_t size = m_rrDomainName.GetSerializedSize(offsets); size += 8; size += m_rdata->GetSerializedSize(offsets); return size; } size_t MDNSResourceRecord::Serialize(uint8_t* buffer, std::map& offsets, uint32_t headerOffset) const { assert(m_rdata); // // Serialize the NAME first // size_t size = m_rrDomainName.Serialize(buffer, offsets, headerOffset); //Next two octets are TYPE buffer[size] = (m_rrType & 0xFF00) >> 8; buffer[size + 1] = (m_rrType & 0xFF); //Next two octets are CLASS buffer[size + 2] = (m_rrClass & 0xFF00) >> 8; buffer[size + 3] = (m_rrClass & 0xFF); //Next four octets are TTL buffer[size + 4] = (m_rrTTL & 0xFF000000) >> 24; buffer[size + 5] = (m_rrTTL & 0xFF0000) >> 16; buffer[size + 6] = (m_rrTTL & 0xFF00) >> 8; buffer[size + 7] = (m_rrTTL & 0xFF); size += 8; uint8_t* p = &buffer[size]; size += m_rdata->Serialize(p, offsets, headerOffset + size); return size; } size_t MDNSResourceRecord::Deserialize(uint8_t const* buffer, uint32_t bufsize, std::map& compressedOffsets, uint32_t headerOffset) { if (m_rdata) { delete m_rdata; m_rdata = NULL; } // // Deserialize the NAME first // size_t size = m_rrDomainName.Deserialize(buffer, bufsize, compressedOffsets, headerOffset); if (size == 0 || bufsize < 8) { //error QCC_DbgPrintf((" MDNSResourceRecord::Deserialize() Error occured while deserializing domain name or insufficient buffer")); return 0; } //Next two octets are TYPE if (size > bufsize || ((size + 8) > bufsize)) { return 0; } m_rrType = (RRType)((buffer[size] << 8) | buffer[size + 1]); switch (m_rrType) { case A: m_rdata = new MDNSARData(); break; case NS: case MD: case MF: case CNAME: case MB: case MG: case MR: case PTR: m_rdata = new MDNSPtrRData(); break; case RNULL: m_rdata = new MDNSDefaultRData(); break; case HINFO: case TXT: m_rdata = new MDNSTextRData(); break; case AAAA: m_rdata = new MDNSAAAARData(); break; case SRV: m_rdata = new MDNSSrvRData(); break; default: m_rdata = new MDNSDefaultRData(); QCC_DbgPrintf(("Ignoring unrecognized rrtype %d", m_rrType)); break; } if (!m_rdata) { return 0; } //Next two octets are CLASS m_rrClass = (RRClass)((buffer[size + 2] << 8) | buffer[size + 3]); //Next four octets are TTL m_rrTTL = (buffer[size + 4] << 24) | (buffer[size + 5] << 16) | (buffer[size + 6] << 8) | buffer[size + 7]; bufsize -= (size + 8); size += 8; headerOffset += size; uint8_t const* p = &buffer[size]; size_t processed = m_rdata->Deserialize(p, bufsize, compressedOffsets, headerOffset); if (!processed) { QCC_DbgPrintf(("MDNSResourceRecord::Deserialize() Error occured while deserializing resource data")); return 0; } size += processed; return size; } void MDNSResourceRecord::SetDomainName(qcc::String domainName) { m_rrDomainName.SetName(domainName); } qcc::String MDNSResourceRecord::GetDomainName() const { return m_rrDomainName.GetName(); } void MDNSResourceRecord::SetRRType(RRType rrtype) { m_rrType = rrtype; } MDNSResourceRecord::RRType MDNSResourceRecord::GetRRType() const { return m_rrType; } void MDNSResourceRecord::SetRRClass(RRClass rrclass) { m_rrClass = rrclass; } MDNSResourceRecord::RRClass MDNSResourceRecord::GetRRClass() const { return m_rrClass; } void MDNSResourceRecord::SetRRttl(uint16_t ttl) { m_rrTTL = ttl; } uint16_t MDNSResourceRecord::GetRRttl() const { return m_rrTTL; } void MDNSResourceRecord::SetRData(MDNSRData* rdata) { if (m_rdata) { delete m_rdata; m_rdata = NULL; } m_rdata = rdata; } MDNSRData* MDNSResourceRecord::GetRData() { return m_rdata; } //MDNSDefaultRData size_t MDNSDefaultRData::GetSerializedSize(std::map& offsets) const { QCC_UNUSED(offsets); return 0; } size_t MDNSDefaultRData::Serialize(uint8_t* buffer, std::map& offsets, uint32_t headerOffset) const { QCC_UNUSED(buffer); QCC_UNUSED(offsets); QCC_UNUSED(headerOffset); return 0; } size_t MDNSDefaultRData::Deserialize(uint8_t const* buffer, uint32_t bufsize, std::map& compressedOffsets, uint32_t headerOffset) { QCC_UNUSED(compressedOffsets); QCC_UNUSED(headerOffset); // // If there's not enough data in the buffer to even get the string size out // then bail. // if (bufsize < 2) { QCC_DbgPrintf(("MDNSDefaultRData::Deserialize(): Insufficient bufsize %d", bufsize)); return 0; } uint16_t rdlen = buffer[0] << 8 | buffer[1]; bufsize -= 2; if (bufsize < rdlen) { QCC_DbgPrintf(("MDNSDefaultRData::Deserialize(): Insufficient bufsize %d", bufsize)); return 0; } return rdlen + 2; } //MDNSTextRData const uint16_t MDNSTextRData::TXTVERS = 0; MDNSTextRData::MDNSTextRData(uint16_t version, bool uniquifyKeys) : version(version), uniquifier(uniquifyKeys ? 1 : 0) { m_fields["txtvers"] = U32ToString(version); } void MDNSTextRData::SetUniqueCount(uint16_t count) { uniquifier = count; } uint16_t MDNSTextRData::GetUniqueCount() { return uniquifier; } void MDNSTextRData::Reset() { m_fields.clear(); m_fields["txtvers"] = U32ToString(version); if (uniquifier) { uniquifier = 1; } } void MDNSTextRData::RemoveEntry(qcc::String key) { m_fields.erase(key); } void MDNSTextRData::SetValue(String key, String value, bool shared) { if (uniquifier && !shared) { key += "_" + U32ToString(uniquifier++); } m_fields[key] = value; } void MDNSTextRData::SetValue(String key, bool shared) { if (uniquifier && !shared) { key += "_" + U32ToString(uniquifier++); } m_fields[key] = String(); } String MDNSTextRData::GetValue(String key) { if (m_fields.find(key) != m_fields.end()) { return m_fields[key]; } else { return ""; } } bool MDNSTextRData::HasKey(qcc::String key) { if (m_fields.find(key) != m_fields.end()) { return true; } else { return false; } } uint16_t MDNSTextRData::GetU16Value(String key) { if (m_fields.find(key) != m_fields.end()) { return StringToU32(m_fields[key]); } else { return 0; } } uint16_t MDNSTextRData::GetNumFields(String key) { key += "_"; uint16_t numNames = 0; for (Fields::const_iterator it = m_fields.begin(); it != m_fields.end(); ++it) { if (it->first.find(key) == 0) { ++numNames; } } return numNames; } qcc::String MDNSTextRData::GetFieldAt(String key, int i) { key += "_"; Fields::const_iterator it; for (it = m_fields.begin(); it != m_fields.end(); ++it) { if (it->first.find(key) == 0 && (i-- == 0)) { break; } } if (it != m_fields.end()) { return it->second; } else { return String(); } } void MDNSTextRData::RemoveFieldAt(String key, int i) { key += "_"; Fields::const_iterator it; for (it = m_fields.begin(); it != m_fields.end(); ++it) { if (it->first.find(key) == 0 && (i-- == 0)) { break; } } if (it != m_fields.end()) { MDNSTextRData::RemoveEntry(it->first); } } size_t MDNSTextRData::GetSerializedSize(std::map& offsets) const { QCC_UNUSED(offsets); size_t rdlen = 0; Fields::const_iterator it = m_fields.begin(); while (it != m_fields.end()) { String str = it->first; if (!it->second.empty()) { str += "=" + it->second; } rdlen += str.length() + 1; it++; } return rdlen + 2; } size_t MDNSTextRData::Serialize(uint8_t* buffer, std::map& offsets, uint32_t headerOffset) const { QCC_UNUSED(offsets); QCC_UNUSED(headerOffset); size_t rdlen = 0; uint8_t* p = &buffer[2]; // // txtvers must appear first in the record // Fields::const_iterator txtvers = m_fields.find("txtvers"); assert(txtvers != m_fields.end()); String str = txtvers->first + "=" + txtvers->second; *p++ = str.length(); memcpy(reinterpret_cast(p), const_cast(reinterpret_cast(str.c_str())), str.length()); p += str.length(); rdlen += str.length() + 1; // // Then we rely on the Fields comparison object so make sure things are // serialized in the proper order // for (Fields::const_iterator it = m_fields.begin(); it != m_fields.end(); ++it) { if (it == txtvers) { continue; } String str = it->first; if (!it->second.empty()) { str += "=" + it->second; } *p++ = str.length(); memcpy(reinterpret_cast(p), const_cast(reinterpret_cast(str.c_str())), str.length()); p += str.length(); rdlen += str.length() + 1; } buffer[0] = (rdlen & 0xFF00) >> 8; buffer[1] = (rdlen & 0xFF); return rdlen + 2; } size_t MDNSTextRData::Deserialize(uint8_t const* buffer, uint32_t bufsize, std::map& compressedOffsets, uint32_t headerOffset) { QCC_UNUSED(compressedOffsets); QCC_UNUSED(headerOffset); // // If there's not enough data in the buffer to even get the string size out // then bail. // if (bufsize < 2) { QCC_DbgPrintf(("MDNSTextRecord::Deserialize(): Insufficient bufsize %d", bufsize)); return 0; } uint16_t rdlen = buffer[0] << 8 | buffer[1]; bufsize -= 2; size_t size = 2 + rdlen; // // If there's not enough data in the buffer then bail. // if (bufsize < rdlen) { QCC_DbgPrintf(("MDNSTextRecord::Deserialize(): Insufficient bufsize %d", bufsize)); return 0; } uint8_t const* p = &buffer[2]; while (rdlen > 0 && bufsize > 0) { uint8_t sz = *p++; String str; bufsize--; if (bufsize < sz) { QCC_DbgPrintf(("MDNSTextRecord::Deserialize(): Insufficient bufsize %d", bufsize)); return 0; } if (sz) { str.assign(reinterpret_cast(p), sz); } size_t eqPos = str.find_first_of('=', 0); if (eqPos != String::npos) { m_fields[str.substr(0, eqPos)] = str.substr(eqPos + 1); } else { m_fields[str.substr(0, eqPos)] = String(); } p += sz; rdlen -= sz + 1; bufsize -= sz; } if (rdlen != 0) { QCC_DbgPrintf(("MDNSTextRecord::Deserialize(): Mismatched RDLength")); return 0; } return size; } //MDNSARecord void MDNSARData::SetAddr(qcc::String ipAddr) { m_ipv4Addr = ipAddr; } qcc::String MDNSARData::GetAddr() { return m_ipv4Addr; } size_t MDNSARData::GetSerializedSize(std::map& offsets) const { QCC_UNUSED(offsets); //4 bytes for address, 2 bytes length return 4 + 2; } size_t MDNSARData::Serialize(uint8_t* buffer, std::map& offsets, uint32_t headerOffset) const { QCC_UNUSED(offsets); QCC_UNUSED(headerOffset); buffer[0] = 0; buffer[1] = 4; uint8_t* p = &buffer[2]; QStatus status = qcc::IPAddress::StringToIPv4(m_ipv4Addr, p, 4); if (status != ER_OK) { QCC_DbgPrintf(("MDNSARData::Serialize Error occured during conversion of String to IPv4 address")); return 0; } return 6; } size_t MDNSARData::Deserialize(uint8_t const* buffer, uint32_t bufsize, std::map& compressedOffsets, uint32_t headerOffset) { QCC_UNUSED(compressedOffsets); QCC_UNUSED(headerOffset); if (bufsize < 6) { QCC_DbgPrintf(("MDNSTextRecord::Deserialize(): Insufficient bufsize %d", bufsize)); return 0; } if (buffer[0] != 0 || buffer[1] != 4) { QCC_DbgPrintf(("MDNSTextRecord::Deserialize(): Invalid RDLength")); return 0; } uint8_t const* p = &buffer[2]; m_ipv4Addr = qcc::IPAddress::IPv4ToString(p); bufsize -= 6; return 6; } //MDNSAAAARecord void MDNSAAAARData::SetAddr(qcc::String ipAddr) { m_ipv6Addr = ipAddr; } qcc::String MDNSAAAARData::GetAddr() const { return m_ipv6Addr; } size_t MDNSAAAARData::GetSerializedSize(std::map& offsets) const { QCC_UNUSED(offsets); //16 bytes for address, 2 bytes length return 16 + 2; } size_t MDNSAAAARData::Serialize(uint8_t* buffer, std::map& offsets, uint32_t headerOffset) const { QCC_UNUSED(offsets); QCC_UNUSED(headerOffset); buffer[0] = 0; buffer[1] = 16; uint8_t* p = &buffer[2]; qcc::IPAddress::StringToIPv6(m_ipv6Addr, p, 16); return 18; } size_t MDNSAAAARData::Deserialize(uint8_t const* buffer, uint32_t bufsize, std::map& compressedOffsets, uint32_t headerOffset) { QCC_UNUSED(compressedOffsets); QCC_UNUSED(headerOffset); if (bufsize < 18) { QCC_DbgPrintf(("MDNSTextRecord::Deserialize(): Insufficient bufsize %d", bufsize)); return 0; } if (buffer[0] != 0 || buffer[1] != 16) { QCC_DbgPrintf(("MDNSTextRecord::Deserialize(): Invalid RDLength")); return 0; } uint8_t const* p = &buffer[2]; m_ipv6Addr = qcc::IPAddress::IPv6ToString(p); bufsize -= 18; return 18; } //MDNSPtrRData void MDNSPtrRData::SetPtrDName(qcc::String rdataStr) { m_rdataStr = rdataStr; } qcc::String MDNSPtrRData::GetPtrDName() const { return m_rdataStr; } size_t MDNSPtrRData::GetSerializedSize(std::map& offsets) const { size_t size = 2; String name = m_rdataStr; for (;;) { if (name.empty()) { size++; break; } else if (offsets.find(name) != offsets.end()) { size++; size++; break; } else { offsets[name] = 0; /* 0 is used as a placeholder so that the serialized size is computed correctly */ size_t newPos = name.find_first_of('.'); String temp = name.substr(0, newPos); size++; size += temp.length(); size_t pos = (newPos == String::npos) ? String::npos : (newPos + 1); name = name.substr(pos); } } return size; } size_t MDNSPtrRData::Serialize(uint8_t* buffer, std::map& offsets, uint32_t headerOffset) const { size_t size = 2; String name = m_rdataStr; for (;;) { if (name.empty()) { buffer[size++] = 0; break; } else if (offsets.find(name) != offsets.end()) { buffer[size++] = 0xc0 | ((offsets[name] & 0xFF00) >> 8); buffer[size++] = (offsets[name] & 0xFF); break; } else { offsets[name] = size + headerOffset; size_t newPos = name.find_first_of('.'); String temp = name.substr(0, newPos); buffer[size++] = temp.length(); memcpy(reinterpret_cast(&buffer[size]), const_cast(reinterpret_cast(temp.c_str())), temp.size()); size += temp.length(); size_t pos = (newPos == String::npos) ? String::npos : (newPos + 1); name = name.substr(pos); } } buffer[0] = ((size - 2) & 0xFF00) >> 8; buffer[1] = ((size - 2) & 0xFF); return size; } size_t MDNSPtrRData::Deserialize(uint8_t const* buffer, uint32_t bufsize, std::map& compressedOffsets, uint32_t headerOffset) { m_rdataStr.clear(); // // If there's not enough data in the buffer to even get the string size out // then bail. // if (bufsize < 2) { QCC_DbgPrintf(("MDNSPtrRecord::Deserialize(): Insufficient bufsize %d", bufsize)); return 0; } uint16_t szStr = buffer[0] << 8 | buffer[1]; bufsize -= 2; size_t size = 2; vector offsets; // If there's not enough data in the buffer then bail. // if (bufsize < szStr) { QCC_DbgPrintf(("MDNSPtrRecord::Deserialize(): Insufficient bufsize %d", bufsize)); return 0; } while (bufsize > 0) { if (((buffer[size] & 0xc0) >> 6) == 3 && bufsize > 1) { uint32_t pointer = ((buffer[size] << 8 | buffer[size + 1]) & 0x3FFF); if (compressedOffsets.find(pointer) != compressedOffsets.end()) { if (m_rdataStr.length() > 0) { m_rdataStr.append('.'); } m_rdataStr.append(compressedOffsets[pointer]); size += 2; break; } else { return 0; } } size_t temp_size = buffer[size++]; bufsize--; // // If there's not enough data in the buffer then bail. // if (bufsize < temp_size) { QCC_DbgPrintf(("MDNSPtrRecord::Deserialize(): Insufficient bufsize %d", bufsize)); return 0; } if (m_rdataStr.length() > 0) { m_rdataStr.append('.'); } if (temp_size > 0) { offsets.push_back(headerOffset + size - 1); m_rdataStr.append(reinterpret_cast(buffer + size), temp_size); bufsize -= temp_size; size += temp_size; } else { break; } } for (uint32_t i = 0; i < offsets.size(); ++i) { compressedOffsets[offsets[i]] = m_rdataStr.substr(offsets[i] - 2 - headerOffset); } return size; } //MDNSSrvRData MDNSSrvRData::MDNSSrvRData(uint16_t priority, uint16_t weight, uint16_t port, qcc::String target) : m_priority(priority), m_weight(weight), m_port(port) { m_target.SetName(target); } void MDNSSrvRData::SetPriority(uint16_t priority) { m_priority = priority; } uint16_t MDNSSrvRData::GetPriority() const { return m_priority; } void MDNSSrvRData::SetWeight(uint16_t weight) { m_weight = weight; } uint16_t MDNSSrvRData::GetWeight() const { return m_weight; } void MDNSSrvRData::SetPort(uint16_t port) { m_port = port; } uint16_t MDNSSrvRData::GetPort() const { return m_port; } void MDNSSrvRData::SetTarget(qcc::String target) { m_target.SetName(target); } qcc::String MDNSSrvRData::GetTarget() const { return m_target.GetName(); } size_t MDNSSrvRData::GetSerializedSize(std::map& offsets) const { //2 bytes length return 2 + 6 + m_target.GetSerializedSize(offsets); } size_t MDNSSrvRData::Serialize(uint8_t* buffer, std::map& offsets, uint32_t headerOffset) const { //length filled in after we know it below //priority buffer[2] = (m_priority & 0xFF00) >> 8; buffer[3] = (m_priority & 0xFF); //weight buffer[4] = (m_weight & 0xFF00) >> 8; buffer[5] = (m_weight & 0xFF); //port buffer[6] = (m_port & 0xFF00) >> 8; buffer[7] = (m_port & 0xFF); size_t size = 2 + 6; uint8_t* p = &buffer[size]; size += m_target.Serialize(p, offsets, headerOffset + size); uint16_t length = size - 2; buffer[0] = (length & 0xFF00) >> 8; buffer[1] = (length & 0xFF); return size; } size_t MDNSSrvRData::Deserialize(uint8_t const* buffer, uint32_t bufsize, std::map& compressedOffsets, uint32_t headerOffset) { // // If there's not enough data in the buffer to even get the string size out // then bail. // if (bufsize < 2) { QCC_DbgPrintf(("MDNSSrvRecord::Deserialize(): Insufficient bufsize %d", bufsize)); return 0; } uint16_t length = buffer[0] << 8 | buffer[1]; bufsize -= 2; if (bufsize < length || length < 6) { QCC_DbgPrintf(("MDNSSrvRecord::Deserialize(): Insufficient bufsize %d or invalid length %d", bufsize, length)); return 0; } m_priority = buffer[2] << 8 | buffer[3]; bufsize -= 2; m_weight = buffer[4] << 8 | buffer[5]; bufsize -= 2; m_port = buffer[6] << 8 | buffer[7]; bufsize -= 2; size_t size = 8; headerOffset += 8; uint8_t const* p = &buffer[size]; size += m_target.Deserialize(p, bufsize, compressedOffsets, headerOffset); return size; } //MDNSAdvertiseRecord void MDNSAdvertiseRData::Reset() { MDNSTextRData::Reset(); } void MDNSAdvertiseRData::SetTransport(TransportMask tm) { MDNSTextRData::SetValue("t", U32ToString(tm, 16)); } void MDNSAdvertiseRData::AddName(qcc::String name) { MDNSTextRData::SetValue("n", name); } void MDNSAdvertiseRData::SetValue(String key, String value) { // // Commonly used keys name and implements get abbreviated over the air. // if (key == "name") { MDNSTextRData::SetValue("n", value); } else if (key == "transport") { MDNSTextRData::SetValue("t", value); } else if (key == "implements") { MDNSTextRData::SetValue("i", value); } else { MDNSTextRData::SetValue(key, value); } } void MDNSAdvertiseRData::SetValue(String key) { MDNSTextRData::SetValue(key); } uint16_t MDNSAdvertiseRData::GetNumFields() { return m_fields.size(); } uint16_t MDNSAdvertiseRData::GetNumNames(TransportMask transportMask) { uint16_t numNames = 0; Fields::const_iterator it; for (it = m_fields.begin(); it != m_fields.end(); ++it) { if (it->first.find("t_") != String::npos && (StringToU32(it->second, 16) == transportMask)) { it++; while (it != m_fields.end() && it->first.find("t_") == String::npos) { if (it->first.find("n_") != String::npos) { numNames++; } it++; } break; } } return numNames; } qcc::String MDNSAdvertiseRData::GetNameAt(TransportMask transportMask, int index) { Fields::const_iterator it; for (it = m_fields.begin(); it != m_fields.end(); ++it) { if (it->first.find("t_") != String::npos && (StringToU32(it->second, 16) == transportMask)) { it++; while (it != m_fields.end() && it->first.find("t_") == String::npos) { if (it->first.find("n_") != String::npos && index-- == 0) { return it->second; } it++; } break; } } return ""; } void MDNSAdvertiseRData::RemoveNameAt(TransportMask transportMask, int index) { Fields::const_iterator it; for (it = m_fields.begin(); it != m_fields.end(); ++it) { if (it->first.find("t_") != String::npos && (StringToU32(it->second, 16) == transportMask)) { uint32_t numNames = 0; Fields::const_iterator trans = it; it++; while (it != m_fields.end() && it->first.find("t_") == String::npos) { Fields::const_iterator nxt = it; nxt++; if (it->first.find("n_") != String::npos) { if (index-- == 0) { MDNSTextRData::RemoveEntry(it->first); } else { numNames++; } } it = nxt; } if (!numNames) { MDNSTextRData::RemoveEntry(trans->first); } break; } } } std::pair MDNSAdvertiseRData::GetFieldAt(int i) { Fields::const_iterator it = m_fields.begin(); while (i-- && it != m_fields.end()) { ++it; } if (it == m_fields.end()) { return pair("", ""); } String key = it->first; key = key.substr(0, key.find_last_of('_')); if (key == "n") { key = "name"; } else if (key == "i") { key = "implements"; } else if (key == "t") { key = "transport"; } return pair(key, it->second); } //MDNSSearchRecord MDNSSearchRData::MDNSSearchRData(qcc::String name, uint16_t version) : MDNSTextRData(version, true) { MDNSTextRData::SetValue("n", name); } void MDNSSearchRData::SetValue(String key, String value) { // // Commonly used keys name and implements get abbreviated over the air. // if (key == "name") { MDNSTextRData::SetValue("n", value); } else if (key == "implements") { MDNSTextRData::SetValue("i", value); } else if (key == "send_match_only" || key == "m") { MDNSTextRData::SetValue("m", value, true); } else { MDNSTextRData::SetValue(key, value); } } void MDNSSearchRData::SetValue(String key) { MDNSTextRData::SetValue(key); } bool MDNSSearchRData::SendMatchOnly() { return MDNSTextRData::HasKey("m"); } uint16_t MDNSSearchRData::GetNumFields() { return m_fields.size(); } uint16_t MDNSSearchRData::GetNumSearchCriteria() { int numEntries = GetNumFields() - 1 /*txtvers*/; return (numEntries > 0) ? (MDNSTextRData::GetNumFields(";") + 1) : 0; } String MDNSSearchRData::GetSearchCriterion(int index) { Fields::const_iterator it = m_fields.begin(); String ret = ""; while (it != m_fields.end()) { String key = it->first; key = key.substr(0, key.find_last_of('_')); if (key == ";") { if (index-- == 0) { break; } ret = ""; } else if (key != "txtvers") { if (key == "n") { key = "name"; } else if (key == "i") { key = "implements"; } if (!ret.empty()) { ret += ","; } ret += key + "='" + it->second + "'"; } ++it; } return ret; } void MDNSSearchRData::RemoveSearchCriterion(int index) { Fields::iterator it = m_fields.begin(); String ret = ""; while (it != m_fields.end() && index > 0) { String key = it->first; key = key.substr(0, key.find_last_of('_')); if (key == ";") { if (--index == 0) { it++; break; } ret = ""; } else if (key != "txtvers") { if (key == "n") { key = "name"; } else if (key == "i") { key = "implements"; } if (!ret.empty()) { ret += ","; } ret += key + "='" + it->second + "'"; } ++it; } if (it != m_fields.end()) { while (it != m_fields.end()) { String key = it->first; key = key.substr(0, key.find_last_of('_')); if (key == ";") { m_fields.erase(it); break; } else if (key == "txtvers") { it++; } else { m_fields.erase(it++); } } } } std::pair MDNSSearchRData::GetFieldAt(int i) { Fields::const_iterator it = m_fields.begin(); while (i-- && it != m_fields.end()) { ++it; } if (it == m_fields.end()) { return pair("", ""); } String key = it->first; key = key.substr(0, key.find_last_of('_')); if (key == "n") { key = "name"; } else if (key == "i") { key = "implements"; } return pair(key, it->second); } //MDNSPingRecord MDNSPingRData::MDNSPingRData(qcc::String name, uint16_t version) : MDNSTextRData(version) { MDNSTextRData::SetValue("n", name); } String MDNSPingRData::GetWellKnownName() { return MDNSTextRData::GetValue("n"); } void MDNSPingRData::SetWellKnownName(qcc::String name) { MDNSTextRData::SetValue("n", name); } //MDNSPingReplyRecord MDNSPingReplyRData::MDNSPingReplyRData(qcc::String name, uint16_t version) : MDNSTextRData(version) { MDNSTextRData::SetValue("n", name); } String MDNSPingReplyRData::GetWellKnownName() { return MDNSTextRData::GetValue("n"); } void MDNSPingReplyRData::SetWellKnownName(qcc::String name) { MDNSTextRData::SetValue("n", name); } String MDNSPingReplyRData::GetReplyCode() { return MDNSTextRData::GetValue("replycode"); } void MDNSPingReplyRData::SetReplyCode(qcc::String replyCode) { MDNSTextRData::SetValue("replycode", replyCode); } //MDNSSenderRData MDNSSenderRData::MDNSSenderRData(uint16_t version) : MDNSTextRData(version) { MDNSTextRData::SetValue("pv", U32ToString(NS_VERSION)); MDNSTextRData::SetValue("ajpv", U32ToString(ALLJOYN_PROTOCOL_VERSION)); } uint16_t MDNSSenderRData::GetSearchID() { return MDNSTextRData::GetU16Value("sid"); } void MDNSSenderRData::SetSearchID(uint16_t searchId) { MDNSTextRData::SetValue("sid", U32ToString(searchId)); } uint16_t MDNSSenderRData::GetIPV4ResponsePort() { return MDNSTextRData::GetU16Value("upcv4"); } void MDNSSenderRData::SetIPV4ResponsePort(uint16_t ipv4Port) { MDNSTextRData::SetValue("upcv4", U32ToString(ipv4Port)); } qcc::String MDNSSenderRData::GetIPV4ResponseAddr() { return MDNSTextRData::GetValue("ipv4"); } void MDNSSenderRData::SetIPV4ResponseAddr(qcc::String ipv4Addr) { MDNSTextRData::SetValue("ipv4", ipv4Addr); } //MDNSHeader MDNSHeader::MDNSHeader() : m_queryId(0), m_qrType(0), m_authAnswer(0), m_rCode(NOT_ERROR), m_qdCount(0), m_anCount(0), m_nsCount(0), m_arCount(0) { } MDNSHeader::MDNSHeader(uint16_t id, bool qrType, uint16_t qdCount, uint16_t anCount, uint16_t nsCount, uint16_t arCount) : m_queryId(id), m_qrType(qrType), m_authAnswer(0), m_rCode(NOT_ERROR), m_qdCount(qdCount), m_anCount(anCount), m_nsCount(nsCount), m_arCount(arCount) { } MDNSHeader::MDNSHeader(uint16_t id, bool qrType) : m_queryId(id), m_qrType(qrType), m_authAnswer(0), m_rCode(NOT_ERROR), m_qdCount(0), m_anCount(0), m_nsCount(0), m_arCount(0) { } MDNSHeader::~MDNSHeader() { } void MDNSHeader::SetId(uint16_t id) { m_queryId = id; } uint16_t MDNSHeader::GetId() { return m_queryId; } void MDNSHeader::SetQRType(bool qrType) { m_qrType = qrType; } bool MDNSHeader::GetQRType() { return m_qrType; } void MDNSHeader::SetQDCount(uint16_t qdCount) { m_qdCount = qdCount; } uint16_t MDNSHeader::GetQDCount() { return m_qdCount; } void MDNSHeader::SetANCount(uint16_t anCount) { m_anCount = anCount; } uint16_t MDNSHeader::GetANCount() { return m_anCount; } void MDNSHeader::SetNSCount(uint16_t nsCount) { m_nsCount = nsCount; } uint16_t MDNSHeader::GetNSCount() { return m_nsCount; } void MDNSHeader::SetARCount(uint16_t arCount) { m_arCount = arCount; } uint16_t MDNSHeader::GetARCount() { return m_arCount; } size_t MDNSHeader::Serialize(uint8_t* buffer) const { QCC_DbgPrintf(("MDNSHeader::Serialize(): to buffer 0x%x", buffer)); // // We keep track of the size so testers can check coherence between // GetSerializedSize() and Serialize() and Deserialize(). // size_t size = 0; // // The first two octets are ID // buffer[0] = (m_queryId & 0xFF00) >> 8; buffer[1] = (m_queryId & 0xFF); size += 2; // // The third octet is |QR| Opcode |AA|TC|RD|RA| // // QR = packet type Query/Response. // Opcode = 0 a standard query (QUERY) // AA = 0 for now // TC = 0 for now // RD = 0 for now // RA = 0 for now buffer[2] = m_qrType << 7; QCC_DbgPrintf(("Header::Serialize(): Third octet = %x", buffer[2])); size += 1; // // The fourth octet is | Z | RCODE | // Z = reserved for future use. Must be zero. buffer[3] = m_rCode; QCC_DbgPrintf(("Header::Serialize(): RCode = %d", buffer[3])); size += 1; // // The next two octets are QDCOUNT // //assert((m_qdCount == 0) || (m_qdCount == 1)); buffer[4] = 0; buffer[5] = m_qdCount; QCC_DbgPrintf(("Header::Serialize(): QDCOUNT = %d", buffer[5])); size += 2; // // The next two octets are ANCOUNT // //assert((m_anCount == 0) || (m_anCount == 1)); buffer[6] = 0; buffer[7] = m_anCount; QCC_DbgPrintf(("Header::Serialize(): ANCOUNT = %d", buffer[7])); size += 2; // // The next two octets are NSCOUNT // buffer[8] = m_nsCount >> 8; buffer[9] = m_nsCount & 0xFF; QCC_DbgPrintf(("Header::Serialize(): NSCOUNT = %d", m_nsCount)); size += 2; // // The next two octets are ARCOUNT // buffer[10] = m_arCount >> 8; buffer[11] = m_arCount & 0xFF; QCC_DbgPrintf(("Header::Serialize(): ARCOUNT = %d", m_arCount)); size += 2; return size; } size_t MDNSHeader::Deserialize(uint8_t const* buffer, uint32_t bufsize) { // // If there's not enough room in the buffer to get the fixed part out then // bail (one byte of version, one byte of question count, one byte of answer // count and one byte of timer). // if (bufsize < 12) { QCC_DbgPrintf(("Header::Deserialize(): Insufficient bufsize %d", bufsize)); return 0; } // // We keep track of the size so testers can check coherence between // GetSerializedSize() and Serialize() and Deserialize(). // size_t size = 0; // // The first two octets are ID // m_queryId = (buffer[0] << 8) | buffer[1]; size += 2; // // The third octet is |QR| Opcode |AA|TC|RD|RA| // // QR = packet type Query/Response. // Opcode = 0 a standard query (QUERY) // AA = 0 for now // TC = 0 for now // RD = 0 for now // RA = 0 for now // Extract QR type m_qrType = buffer[2] >> 7; size += 1; // // The fourth octet is | Z | RCODE | // Z = reserved for future use. Must be zero. // Extract RCode. m_rCode = (RCodeType)(buffer[3] & 0x0F); size += 1; // // The next two octets are QDCOUNT // m_qdCount = buffer[5]; //assert((m_qdCount == 0) || (m_qdCount == 1)); size += 2; // // The next two octets are ANCOUNT // m_anCount = (buffer[6] << 8) | buffer[7]; //assert((m_anCount == 0) || (m_anCount == 1)); size += 2; // // The next two octets are NSCOUNT // m_nsCount = (buffer[8] << 8) | buffer[9]; QCC_DbgPrintf(("Header::Deserialize(): NSCOUNT = %d", m_nsCount)); size += 2; // // The next two octets are ARCOUNT // m_arCount = (buffer[10] << 8) | buffer[11]; size += 2; bufsize -= 12; return size; } size_t MDNSHeader::GetSerializedSize(void) const { // // We have 12 octets in the header. // return 12; } //MDNSPacket _MDNSPacket::_MDNSPacket() { m_questions.reserve(MIN_RESERVE); m_answers.reserve(MIN_RESERVE); m_authority.reserve(MIN_RESERVE); m_additional.reserve(MIN_RESERVE); } _MDNSPacket::~_MDNSPacket() { } void _MDNSPacket::Clear() { m_questions.clear(); m_answers.clear(); m_authority.clear(); m_additional.clear(); } void _MDNSPacket::SetHeader(MDNSHeader header) { m_header = header; } MDNSHeader _MDNSPacket::GetHeader() { return m_header; } void _MDNSPacket::AddQuestion(MDNSQuestion question) { m_questions.push_back(question); assert(m_questions.size() <= MIN_RESERVE); m_header.SetQDCount(m_questions.size()); } bool _MDNSPacket::GetQuestionAt(uint32_t i, MDNSQuestion** question) { if (i >= m_questions.size()) { return false; } *question = &m_questions[i]; return true; } bool _MDNSPacket::GetQuestion(qcc::String str, MDNSQuestion** question) { std::vector::iterator it1 = m_questions.begin(); while (it1 != m_questions.end()) { if (((*it1).GetQName() == str)) { *question = &(*it1); return true; } it1++; } return false; } uint16_t _MDNSPacket::GetNumQuestions() { return m_questions.size(); } void _MDNSPacket::AddAdditionalRecord(MDNSResourceRecord record) { m_additional.push_back(record); assert(m_additional.size() <= MIN_RESERVE); m_header.SetARCount(m_additional.size()); } bool _MDNSPacket::GetAdditionalRecordAt(uint32_t i, MDNSResourceRecord** additional) { if (i >= m_additional.size()) { return false; } *additional = &m_additional[i]; return true; } uint16_t _MDNSPacket::GetNumAdditionalRecords() { return m_additional.size(); } void _MDNSPacket::RemoveAdditionalRecord(qcc::String str, MDNSResourceRecord::RRType type) { std::vector::iterator it1 = m_additional.begin(); while (it1 != m_additional.end()) { if (((*it1).GetDomainName() == str) && ((*it1).GetRRType() == type)) { m_additional.erase(it1++); m_header.SetARCount(m_additional.size()); return; } it1++; } } bool _MDNSPacket::GetAdditionalRecord(qcc::String str, MDNSResourceRecord::RRType type, MDNSResourceRecord** additional) { size_t starPos = str.find_last_of('*'); String name = str.substr(0, starPos); std::vector::iterator it1 = m_additional.begin(); while (it1 != m_additional.end()) { String dname = (*it1).GetDomainName(); bool nameMatches = (starPos == String::npos) ? (dname == name) : (dname.find(name) == 0); if (nameMatches && ((*it1).GetRRType() == type)) { *additional = &(*it1); return true; } it1++; } return false; } bool _MDNSPacket::GetAdditionalRecord(qcc::String str, MDNSResourceRecord::RRType type, uint16_t version, MDNSResourceRecord** additional) { if (type != MDNSResourceRecord::TXT) { return false; } size_t starPos = str.find_last_of('*'); String name = str.substr(0, starPos); std::vector::iterator it1 = m_additional.begin(); while (it1 != m_additional.end()) { String dname = (*it1).GetDomainName(); bool nameMatches = (starPos == String::npos) ? (dname == name) : (dname.find(name) == 0); if (nameMatches && ((*it1).GetRRType() == type) && (static_cast((*it1).GetRData())->GetU16Value("txtvers") == version)) { *additional = &(*it1); return true; } it1++; } return false; } uint32_t _MDNSPacket::GetNumMatches(qcc::String str, MDNSResourceRecord::RRType type, uint16_t version) { if (type != MDNSResourceRecord::TXT) { return false; } uint32_t numMatches = 0; size_t starPos = str.find_last_of('*'); String name = str.substr(0, starPos); std::vector::iterator it1 = m_additional.begin(); while (it1 != m_additional.end()) { String dname = (*it1).GetDomainName(); bool nameMatches = (starPos == String::npos) ? (dname == name) : (dname.find(name) == 0); if (nameMatches && ((*it1).GetRRType() == type) && (static_cast((*it1).GetRData())->GetU16Value("txtvers") == version)) { numMatches++; } it1++; } return numMatches; } bool _MDNSPacket::GetAdditionalRecordAt(qcc::String str, MDNSResourceRecord::RRType type, uint16_t version, uint32_t index, MDNSResourceRecord** additional) { if (type != MDNSResourceRecord::TXT) { return false; } size_t starPos = str.find_last_of('*'); String name = str.substr(0, starPos); uint32_t i = 0; std::vector::iterator it1 = m_additional.begin(); while (it1 != m_additional.end()) { String dname = (*it1).GetDomainName(); bool nameMatches = (starPos == String::npos) ? (dname == name) : (dname.find(name) == 0); if (nameMatches && ((*it1).GetRRType() == type) && (static_cast((*it1).GetRData())->GetU16Value("txtvers") == version)) { if (i++ == index) { *additional = &(*it1); return true; } } it1++; } return false; } bool _MDNSPacket::GetAnswer(qcc::String str, MDNSResourceRecord::RRType type, MDNSResourceRecord** answer) { std::vector::iterator it1 = m_answers.begin(); while (it1 != m_answers.end()) { if (((*it1).GetDomainName() == str) && ((*it1).GetRRType() == type)) { *answer = &(*it1); return true; } it1++; } return false; } bool _MDNSPacket::GetAnswer(qcc::String str, MDNSResourceRecord::RRType type, uint16_t version, MDNSResourceRecord** answer) { if (type != MDNSResourceRecord::TXT) { return false; } std::vector::iterator it1 = m_answers.begin(); while (it1 != m_answers.end()) { if (((*it1).GetDomainName() == str) && ((*it1).GetRRType() == type) && (static_cast((*it1).GetRData())->GetU16Value("txtvers") == version)) { *answer = &(*it1); return true; } it1++; } return false; } void _MDNSPacket::AddAnswer(MDNSResourceRecord record) { m_answers.push_back(record); assert(m_answers.size() <= MIN_RESERVE); m_header.SetANCount(m_answers.size()); } bool _MDNSPacket::GetAnswerAt(uint32_t i, MDNSResourceRecord** answer) { if (i >= m_answers.size()) { return false; } *answer = &m_answers[i]; return true; } uint16_t _MDNSPacket::GetNumAnswers() { return m_answers.size(); } size_t _MDNSPacket::GetSerializedSize(void) const { std::map offsets; size_t ret; size_t size = m_header.GetSerializedSize(); std::vector::const_iterator it = m_questions.begin(); while (it != m_questions.end()) { ret = (*it).GetSerializedSize(offsets); size += ret; it++; } std::vector::const_iterator it1 = m_answers.begin(); while (it1 != m_answers.end()) { ret = (*it1).GetSerializedSize(offsets); size += ret; it1++; } it1 = m_authority.begin(); while (it1 != m_authority.end()) { ret = (*it1).GetSerializedSize(offsets); size += ret; it1++; } it1 = m_additional.begin(); while (it1 != m_additional.end()) { ret = (*it1).GetSerializedSize(offsets); size += ret; it1++; } return size; } size_t _MDNSPacket::Serialize(uint8_t* buffer) const { std::map offsets; size_t ret; size_t size = m_header.Serialize(buffer); size_t headerOffset = size; uint8_t* p = &buffer[size]; std::vector::const_iterator it = m_questions.begin(); while (it != m_questions.end()) { ret = (*it).Serialize(p, offsets, headerOffset); size += ret; headerOffset += ret; p += ret; it++; } std::vector::const_iterator it1 = m_answers.begin(); while (it1 != m_answers.end()) { ret = (*it1).Serialize(p, offsets, headerOffset); size += ret; headerOffset += ret; p += ret; it1++; } it1 = m_authority.begin(); while (it1 != m_authority.end()) { ret = (*it1).Serialize(p, offsets, headerOffset); size += ret; headerOffset += ret; p += ret; it1++; } it1 = m_additional.begin(); while (it1 != m_additional.end()) { ret = (*it1).Serialize(p, offsets, headerOffset); size += ret; headerOffset += ret; p += ret; it1++; } return size; } size_t _MDNSPacket::Deserialize(uint8_t const* buffer, uint32_t bufsize) { Clear(); std::map compressedOffsets; size_t size = m_header.Deserialize(buffer, bufsize); size_t ret; if (size == 0) { QCC_DbgPrintf(("Error occured while deserializing header")); return size; } if (m_header.GetQRType() == MDNSHeader::MDNS_QUERY && m_header.GetQDCount() == 0) { //QRType = 0 and QDCount = 0. Invalid return 0; } if (size >= bufsize) { return 0; } bufsize -= size; uint8_t const* p = &buffer[size]; size_t headerOffset = size; for (int i = 0; i < m_header.GetQDCount(); i++) { MDNSQuestion q; ret = q.Deserialize(p, bufsize, compressedOffsets, headerOffset); if (ret == 0 || ret > bufsize) { QCC_DbgPrintf(("Error while deserializing question")); return 0; } size += ret; bufsize -= ret; p += ret; headerOffset += ret; m_questions.push_back(q); } for (int i = 0; i < m_header.GetANCount(); i++) { MDNSResourceRecord r; ret = r.Deserialize(p, bufsize, compressedOffsets, headerOffset); if (ret == 0 || ret > bufsize) { QCC_DbgPrintf(("Error while deserializing answer")); return 0; } size += ret; bufsize -= ret; p += ret; headerOffset += ret; m_answers.push_back(r); } for (int i = 0; i < m_header.GetNSCount(); i++) { MDNSResourceRecord r; ret = r.Deserialize(p, bufsize, compressedOffsets, headerOffset); if (ret == 0 || ret > bufsize) { QCC_DbgPrintf(("Error while deserializing NS")); return 0; } size += ret; bufsize -= ret; p += ret; headerOffset += ret; m_authority.push_back(r); } for (int i = 0; i < m_header.GetARCount(); i++) { MDNSResourceRecord r; ret = r.Deserialize(p, bufsize, compressedOffsets, headerOffset); if (ret == 0 || ret > bufsize) { QCC_DbgPrintf(("Error while deserializing additional")); return 0; } size += ret; bufsize -= ret; p += ret; headerOffset += ret; m_additional.push_back(r); } return size; } TransportMask _MDNSPacket::GetTransportMask() { TransportMask transportMask = TRANSPORT_NONE; if (GetHeader().GetQRType() == MDNSHeader::MDNS_QUERY) { MDNSQuestion* question; if (GetQuestion("_alljoyn._tcp.local.", &question)) { transportMask |= TRANSPORT_TCP; } if (GetQuestion("_alljoyn._udp.local.", &question)) { transportMask |= TRANSPORT_UDP; } } else { MDNSResourceRecord* answer; if (GetAnswer("_alljoyn._tcp.local.", MDNSResourceRecord::PTR, &answer)) { transportMask |= TRANSPORT_TCP; } if (GetAnswer("_alljoyn._udp.local.", MDNSResourceRecord::PTR, &answer)) { transportMask |= TRANSPORT_UDP; } } return transportMask; } void _MDNSPacket::RemoveAnswer(qcc::String str, MDNSResourceRecord::RRType type) { std::vector::iterator it1 = m_answers.begin(); while (it1 != m_answers.end()) { if (((*it1).GetDomainName() == str) && ((*it1).GetRRType() == type)) { m_answers.erase(it1++); m_header.SetANCount(m_answers.size()); return; } it1++; } } void _MDNSPacket::RemoveQuestion(qcc::String str) { std::vector::iterator it1 = m_questions.begin(); while (it1 != m_questions.end()) { if (((*it1).GetQName() == str)) { m_questions.erase(it1); m_header.SetQDCount(m_questions.size()); return; } it1++; } } } // namespace ajn alljoyn-15.04b/alljoyn_core/router/ns/IpNsProtocol.h000066400000000000000000004211011255700255500225260ustar00rootroot00000000000000/** * @file * @internal * Data structures used for a lightweight service protocol. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _NS_PROTOCOL_H #define _NS_PROTOCOL_H #ifndef __cplusplus #error Only include IpNsProtocol.h in C++ code. #endif #include #include #include #include #include #include #include #include namespace ajn { /** * @defgroup name_service_protocol Name Service Protocol * @{ * Introduction * * One goal of AllJoyn is to allow clients of the bus to make Remote Procedure Calls * (RPC) or receive Signals from physically remote obejcts connected to the * bus as if they were local. Collections of RCP and Signal signatures, * typically called interfaces. Bus attachments are collections of interface * implementations and are described by so-called well-known or bus names. * Groups of one or more bus attachments are coordinated by AllJoyn daemon * processes that run on each host. Physically or logically distributed AllJoyn * daemons may be merged into a single virtual bus. * * One of the fundamental issues in distributing processes across different * hosts is the discovering the address and port of a given service. In the * case of AllJoyn, the communication endpoints of the various daemon processes * must be located so communication paths may be established. This lightweight * name service protocol provides a definition of a protocol for such a * process. * * Transport * * Name service protocol messages are expected to be transported * over UDP, typically over a well-known multicast group and port. A * UDP datagram carrying a name service message would appear like, * * @verbatim * 0 1 2 3 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * | Source Port | Destination Port | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * | Length | Checksum | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * | Name Service Packet | * ~ ~ * | | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * @endverbatim * * Strings * * Since well-known names are strings, one of the fundamental objects in * the protocol is the StringData object. Strings are encoded an octet * giving the length of the string, followed by some number UTF-8 characters. * (no terminating zero is required) For example, the string "STRING" * would be encoded as follows. The single octet length means that the * longest string possible is 255 characters. This should not prove to * be a problem since it is the same maximum length as a domain name, on * which bus names are modeled. * * @verbatim * 0 1 2 3 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * | 6 | S | T | R | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | * | I | N | G | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * @endverbatim * * IS-AT Message * * The IS-AT message is an "answer" message used to advertise the existence * of a number of bus names on a given AllJoyn daemon. IS-AT messages can * be sent as part of a response to a question, or they can be sent * gratuitously when an AllJoyn daemon decides to export the fact that it * supports some number of bus names. * * Version 0 * * Version zero of the protocol includes the following fields: * * @verbatim * 0 1 2 3 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * |F S U T C G| M | Count | Port | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * | IPv4Address present if 'F' bit is set | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * | | * | IPv6Address present if 'S' bit is set | * | | * | | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * | | * ~ Daemon GUID StringData present if 'G' bit is set ~ * | | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * | | * ~ Variable Number of StringData Records ~ * | | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * @endverbatim * * @li @c M The message type of the IS-AT message. Defined to be '01' (1). * @li @c G If '1' indicates that a variable length daemon GUID string is present. * @li @c C If '1' indicates that the list of StringData records is a complete * list of all well-known names exported by the responding daemon. * @li @c T If '1' indicates that the responding daemon is listening on TCP. * @li @c U If '1' indicates that the responding daemon is listening on UDP. * @li @c S If '1' indicates that the responding daemon is listening on an IPv6 * address and that an IPv6 address is present in the message. If '0' * indicates is no IPv6 address present. * @li @c F If '1' indicates that the responding daemon is listening on an IPv4 * address and that an IPv4 address is present in the message. If '0' * indicates is no IPv4 address present. * @li @c Count The number of StringData items that follow. Each StringData item * describes one well-known bus name supported by the responding daemon. * @li @c Port The port on which the responding daemon is listening. * @li @c IPv4Address The IPv4 address on which the responding daemon is listening. * Present if the 'F' bit is set to '1'. * @li @c IPv6Address The IPv6 address on which the responding daemon is listening. * Present if the 'S' bit is set to '1'. * * Version 1 * * Version one of the protocol extends version zero to include the type of the * transport that is doing the advertisement and admit the possibility of * reliable and unreliable transports over both IPv4 and IPv6. * * The most general form of an advertisement containing this information includes * Four address/port pairs: * * R4: IPv4 address, port of a TCP-based endpoint present; * U4: IPv4 address, port of a UDP-based endpoint present; * R6: IPv6 address, port of a TCP-based endpoint present; * U6: IPv6 address, port of a UDP-based endpoint present. * * One can contemplate various optimizations which would allow us to elide * addresses in some case, but the complexity of managing such optimizations is * such that we do the simple thing and send a complete endpoint description for * every endpoint. It is the most general case and if we were able to optimize * all four addresses out we are talking about forty bytes. The code complexity * just doesn't seem worth it; and so the four cases above replace the F, S, U, * T bits of the version zero protocol. * * Since the port is now associated to the provided addresses, the port field in the version * zero is-at message becomes a TransportMask which indicates the AllJoyn transport that is making the * advertisement. * * @verbatim * 0 1 2 3 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * |U R U R C G| M | Count | TransportMask | * |6 6 4 4 | | | | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * | R4 IPv4Address present if 'R4' bit is set | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * | R4 Port if 'R4' bit is set | U4 Ipv4Address present if | * |-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * | 'U4' bit is set | U4 Port if 'U4' bit is set | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * | | * | R6 IPv6Address present if 'R6' bit is set | * | | * | | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * | R6 Port if 'R6' bit is set | | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | * | | * | U6 IPv6Address present if 'U6' bit is set | * | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * | | U6 Port if 'U6' bit is set | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * | | * ~ Daemon GUID StringData present if 'G' bit is set ~ * | | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * | | * ~ Variable Number of StringData Records ~ * | | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * @endverbatim * * @li @c M The message type of the IS-AT message. Defined to be '01' (1). * @li @c G If '1' indicates that a variable length daemon GUID string is present. * @li @c C If '1' indicates that the list of StringData records is a complete * list of all well-known names exported by the responding daemon. * @li @c R4 If '1' indicates that the IPv4 endpoint of a reliable method (TCP) * transport (IP address and port) is present * @li @c U4 If '1' indicates that the IPv4 endpoint of an unreliable method (UDP) * transport (IP address and port) is present * @li @c R6 If '1' indicates that the IPv6 endpoint of a reliable method (TCP) * transport (IP address and port) is present * @li @c U6 If '1' indicates that the IPv6 endpoint of an unreliable method (UDP) * transport (IP address and port) is present * @li @c Count The number of StringData items that follow. Each StringData item * describes one well-known bus name supported by the responding daemon. * @li @c TransportMask The bit mask of transport identifiers that indicates which * AllJoyn transport is making the advertisement. * * WHO-HAS Message * * The WHO-HAS message is a "question" message used to ask AllJoyn daemons if * they support one or more bus names. * * Version 0 * * Version zero of the protocol includes the following fields: * * @verbatim * 0 1 2 3 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * |F S U T R R| M | Count | | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | * | | * ~ Variable Number of StringData Records ~ * | | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * @endverbatim * * @li @c M The message type of the WHO-HAS message. Defined to be '10' (2) * @li @c R Reserved bit. * @li @c T If '1' indicates that the requesting daemon wants to connect using * TCP. * @li @c U If '1' indicates that the requesting daemon wants to connect using * UDP. * @li @c S If '1' indicates that the responding daemon is interested in receiving * information about services accessible via IPv6 addressing. * @li @c F If '1' indicates that the responding daemon is interested in receiving * information about services accessible via IPv4 addressing. * @li @c Count The number of StringData items that follow. Each StringData item * describes one well-known bus name that the querying daemon is interested in. * * Version 1 * * Version one of the protocol removes the T, U, S and F bits; converting them to * reserved bits. The rationale is that passive observers of name service packets * could be interested in all available configurations and artificially limiting * responses could mislead those observers. * * Version one of the protocol includes the following fields: * * @verbatim * 0 1 2 3 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * |R R R R R R| M | Count | | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | * | | * ~ Variable Number of StringData Records ~ * | | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * @endverbatim * * @li @c M The message type of the WHO-HAS message. Defined to be '10' (2) * @li @c R Reserved bit. * @li @c Count The number of StringData items that follow. Each StringData item * describes one well-known bus name that the querying daemon is interested in. * * Messages * * A name service message consists of a header, followed by a variable * number of question (Q) messages (for example, WHO-HAS) followed by a variable * number of answer(A) messages (for example, IS-AT). All messages are packed * to octet boundaries. * * Name Service Header * * @verbatim * 0 1 2 3 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * | SVer | MVer | QCount | ACount | Timer | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * @endverbatim * * @li @c SVer The version (0...15) of the sender's latest implemented protocol. * @li @c MVer The version (0...15) of the actual message. * @li @c QCount The number of question messages that follow the header. * @li @c ACount The number of question messages that follow the question * messages. * @li @c Timer A count of seconds for which any answers should be considered * valid. A zero in this field means that the sending daemon is * withdrawing the advertisements. A value of 255 in this field means * "forever," or at least until withdrawn * * Example * * It is expected that when an AllJoyn daemon comes up, it will want to advertise * the fact that it is up and supports some number of bus names. It may also * be the case that the AllJoyn daemon already knows that it will need to find * some remote bus names when it comes up. In this case, it can send an initial * message that both announces its bus names, and asks for any other AllJoyn * daemons that support what it wants. * * Consider a daemon that is capable of dealing with IPv4 addresses, and is * listening on Port 9955 of IPv4 address "192.168.10.10" for incoming * connections. If the daemon is interested in locating another daemons that * supports the bus name "org.yadda.foo" and wants to export the fact that it * supports the bus name, "org.yadda.bar", and will support than name forever, * it might send a packet that combines WHO-HAS and IS-AT messages and that * looks something like * * @verbatim * 0 1 2 3 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * |SVer= 1|MVer= 1| Q Count = 1 | A Count = 1 | Timer = 255 | (A) * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * | WHO-HAS | Count = 1 | Count = 13 | 'o' | (B) (C) * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | * | 'r' 'g' '.' 'y' | * | | * | 'a' 'd' 'd' 'a' | * | | * | '.' 'f' 'o' 'o' | * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * | IS-AT | Count = 1 | 192 | 168 | (D) * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * | 10 10 | 9955 | Count = 13 | (E) * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * | 'o' 'r' 'g' '.' | * | | * | 'y' 'a' 'd' 'd' | * | | * | 'a' '.' 'b' 'a' | * | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * | 'r' | * +-+-+-+-+-+-+-+-+ * @endverbatim * * The notation (A) indicates the name service header. This header tells * us the Sender and message versions are one, there is one question and * one answer message following, and that the timeout value of any answer * messages present in this message is set to be 255 (infinite). * * The (B) section shows one question, which is a WHO-HAS message. The * flags present in the WHO-HAS message are not shown here. What follows * is the count of bus names present in this message (1). The bus name * shown here is "org.yadda.foo" (C). This name is contained in a * serialized SDATA (string data) message. The length of the string is * thirteen bytes, and the characters of the string follow. This ends * the question section of the messge since there was only one question * present as indicated by the header. * * Next, the (D) notation shows the single answer message described in * the header. Answer messages are called IS-AT messages. There is a * count of one bus name in the IS-AT messsage which, the message is * telling us, can be found at IPv4 address 192.168.10.10 port 9955. * The single SDATA record (E) with a count of 13 indicates that the * sending daemon supports the bus name "org.yadda.bar" at that address * and port. * @} End of "defgroup name_service_protocol" */ /** * @internal * @brief An abstract data type defining the operations that each element * of a name service protocol must implement. * * Every instance of a piece of the name service protocol must * have the capability of being serialized into a datagram and deserialized * from a datagram. It is also useful to be able to query an existing * object for how much buffer space it and its children will need in order * to be successfully serialized. * * This ADT class "enforces" the signatures of these functions. * * @ingroup name_service_protocol */ class ProtocolElement { public: /** * Virtual destructor for derivable class. */ virtual ~ProtocolElement() { } /** * @internal * @brief Get the size of a buffer that will allow the object and all of * its children to be successfully serialized * * @return The size of the buffer required to serialize the object */ virtual size_t GetSerializedSize(void) const = 0; /** * @internal * @brief Serialize this object and all of its children to the provided * buffer. * * @warning The buffer should be at least as large as the size returned * by GetSerializedSize(). * * @return The number of octets written to the buffer. */ virtual size_t Serialize(uint8_t* buffer) const = 0; /** * @internal * @brief Deserialize this object and all of its children from the provided * buffer. * * An object implementing this method will attempt to read its wire * representation and construct an object representation. If there are * insuffucient bits in the buffer to do so, it will return a count of * zero bytes read. There is very little redundancy in a wire representation * to provide information for error checking, so if the UDP checksum of * the containing datagram indicates a successfully received message, a * protocol error will typically be reported through a zero return count * here. * * @param buffer The buffer to read the bytes from. * @param bufsize The number of bytes available in the buffer. * * @return The number of octets read from the buffer, or zero if an error * occurred. */ virtual size_t Deserialize(uint8_t const* buffer, uint32_t bufsize) = 0; }; /** * @internal * @brief A class representing a name service StringData object. * * Since well-known names are strings, one of the fundamental objects in * the protocol is the StringData object. Strings are encoded an octet * giving the length of the string, followed by some number UTF-8 characters. * (no terminating zero is required) For example, the string "STRING" * would be encoded as follows. The single octet length means that the * longest string possible is 255 characters. This should not prove to * be a problem since it is the same maximum length as a domain name, on * which bus names are modeled. * * @ingroup name_service_protocol */ class StringData : public ProtocolElement { public: /** * @internal * @brief Construct a StringData object. The size of the string represented * by the object is initialized to 0 -- the null string. */ StringData(); /** * @internal * @brief Destroy a StringData object. */ ~StringData(); /** * @internal * @brief Set the string represented by this StringData object to the * provided string. * * @param string The well-known or bus name to be represented by this object. */ void Set(qcc::String string); /** * @internal * @brief Get the string represented by this StringData object. * * @return The well-known or bus name to represented by this object. */ qcc::String Get(void) const; /** * @internal * @brief Get the size of a buffer that will allow the object to be * successfully serialized * * @return The size of the buffer required to serialize the object */ size_t GetSerializedSize(void) const; /** * @internal * @brief Serialize this string to the provided buffer. * * @warning The buffer should be at least as large as the size returned * by GetSerializedSize(). * * @return The number of octets written to the buffer. */ size_t Serialize(uint8_t* buffer) const; /** * @internal * @brief Deserialize this string from the provided buffer. * * @see ProtocolElement::Deserialize() * * @param buffer The buffer to read the bytes from. * @param bufsize The number of bytes available in the buffer. * * @return The number of octets read from the buffer, or zero if an error * occurred. */ size_t Deserialize(uint8_t const* buffer, uint32_t bufsize); private: /** * @internal * @brief The in-memory representation of the StringData object. */ qcc::String m_string; /** * @internal * @brief The size of the represented StringData object. */ size_t m_size; }; /** * @internal * @brief A class representing an authoritative answer in the name service * protocol. * * The IS-AT message is an answer message used to advertise the existence * of a number of bus names on a given AllJoyn daemon. IS-AT messages can * be sent as part of a response to a direct question, or they can be sent * gratuitously when an AllJoyn daemon decides to export the fact that it * supports some number of bus names. * * @ingroup name_service_protocol */ class IsAt : public ProtocolElement { public: /** * @internal * @brief Construct an in-memory object representation of an on-the-wire * name service protocol answer. */ IsAt(); /** * @internal * @brief Destroy a name service protocol answer object. */ ~IsAt(); /** * @internal * @brief Set the wire protocol version that the object will use. * * The name service protocol is versioned. For backward compatibility, we * need to be able to get down-version messages to "old" daemons and current * version messages to "new" daemons. The first thing to observe is that, * like most protocols, the wire protocol is versioned, not extensible. * This means that in order to support multiple versions, we will need to * send multiple messages. This introduces ambiguitiy in the receiver of * the messages since it cannot know whether or not "new" messages will * appear after 'old" ones. To resolve this ambiguity, the wire protocol * version is constructed of two versions: a message version and a sender * protocol version. * * If a new version of the protocol is defined, new senders will be modified * to generate the new version, and new receivers will be able to receive * new messages. The message version tells a receiver what the absolute * format of the current message is; and the sender protocol version * provides a context shared between the sender and the receiver that can * indicate more, or better, information may be forthcoming. * * The message version tells "this" object which version of the wire * protocol to use when serializing the bits and which version to expect * when deserializing the bits. The sender protocol version is meta-data * for higher level code. * * The version is found in the Header, so we will know for sure what version * the overall packet will take. Objects of class IsAt support all versions * known at the time of compilation. If the version of the wire protocol * read does not provide a value for a given field, a default value will be * provided. Objects of class IsAt can support writing down-version packets * for compatibility. * * It is up to higher levels to understand the contextual implications, if any, * of writing or reading down-version packets. * * @param nsVersion The version (0 .. 15) of the sender's latest implemented protocol. * @param msgVersion The version (0 .. 15) of the actual message. */ void SetVersion(uint32_t nsVersion, uint32_t msgVersion) { m_version = nsVersion << 4 | msgVersion; } /** * @internal * @brief Get the wire protocol version that the object will use. * * @param nsVersion Gets the version (0 .. 15) of the sender's latest implemented protocol. * @param msgVersion Gets the version (0 .. 15) of the actual message. * * @see SetVersion() */ void GetVersion(uint32_t& nsVersion, uint32_t& msgVersion) { nsVersion = m_version >> 4; msgVersion = m_version & 0xf; } /** * @internal * @brief Set the transport mask of the transport sending the advertisement * * The IP name service protocol can be used by a number of different AllJoyn * transports. These transports may need to build a wall around their own * advertisements so we provide the name service with a way to plumb the * advertisements from end-to-end according to transport. * * It is up to higher levels to understand the contextual implications, if any, * of peeking at other transports' advertisements or discovery requests. * * @param mask The transport mask of the object. */ void SetTransportMask(TransportMask mask) { m_transportMask = mask; } /** * @internal * @brief Get the transport mask of the transport that is sending the message. * * @return The transport mask of the transport that is sending the message. * * @see SetVersion() */ TransportMask GetTransportMask(void) { return m_transportMask; } /** * @internal * @brief Set the protocol flag indicating that the daemon generating * this answer is providing its entire well-known name list. * * @param flag True if the daemon is providing the entire well-known name * list. */ void SetCompleteFlag(bool flag) { m_flagC = flag; } /** * @internal * @brief Set the protocol flag indicating that the daemon generating * this answer is providing its entire well-known name list. * * @return True if the daemon is providing the entire well-known name * list. */ bool GetCompleteFlag(void) const { return m_flagC; } /** * @internal * @brief Set the protocol flag indicating that the daemon generating * this answer is listening on a TCP socket. * * @param flag True if the daemon is listening on TCP. * * @warning Useful for version zero objects only. */ void SetTcpFlag(bool flag) { m_flagT = flag; } /** * @internal * @brief Get the protocol flag indicating that the daemon generating * this answer is listening on a TCP socket. * * @return True if the daemon is listening on TCP. * * @warning Useful for version zero objects only. */ bool GetTcpFlag(void) const { return m_flagT; } /** * @internal * @brief Set the protocol flag indicating that the daemon generating * this answer is listening on a UDP socket. * * @param flag True if the daemon is listening on UDP. * * @warning Useful for version zero objects only. */ void SetUdpFlag(bool flag) { m_flagU = flag; } /** * @internal * @brief Get the protocol flag indicating that the daemon generating * this answer is listening on a UDP socket. * * @return True if the daemon is listening on UDP. * * @warning Useful for version zero objects only. */ bool GetUdpFlag(void) const { return m_flagU; } /** * @internal * @brief Get the protocol flag indicating that the daemon generating * this answer is listening on a reliable IPv4 endpoint and has provided * a reliable IPv4 IP address and port. * * @return True if the daemon is listening on a reliable IPv4 endpoint. * * @warning Useful for version one objects only. */ bool GetReliableIPv4Flag(void) const { return m_flagR4; } /** * @internal * @brief Get the protocol flag indicating that the daemon generating * this answer is listening on an unreliable IPv4 endpoint and has provided * an unreliable IPv4 IP address and port. * * @return True if the daemon is listening on an unreliable IPv4 endpoint. * * @warning Useful for version one objects only. */ bool GetUnreliableIPv4Flag(void) const { return m_flagU4; } /** * @internal * @brief Get the protocol flag indicating that the daemon generating * this answer is listening on a reliable IPv6 endpoint and has provided * a reliable IPv6 IP address and port. * * @return True if the daemon is listening on a reliable IPv6 endpoint. * * @warning Useful for version one objects only. */ bool GetReliableIPv6Flag(void) const { return m_flagR6; } /** * @internal * @brief Get the protocol flag indicating that the daemon generating * this answer is listening on an unreliable IPv6 endpoint and has provided * an unreliable IPv6 IP address and port. * * @return True if the daemon is listening on an unreliable IPv6 endpoint. * * @warning Useful for version one objects only. */ bool GetUnreliableIPv6Flag(void) const { return m_flagU6; } /** * @internal * @brief Get the protocol flag indicating that the daemon generating * this answer has provided a GUID string. * * This flag is set to true by the SetGuid() call (or deserializing * a message for which the flag was set) and indicates that a daemon * GUID is provided in the message. * * @return True if the daemon has provided a GUID. */ bool GetGuidFlag(void) const { return m_flagG; } /** * @internal * @brief Get the protocol flag indicating that the daemon generating * this answer is listening on an IPv6 address. * * This flag is set to true by the SetIPv6() call (or deserializing * a message for which the flag was set) and indicates that an IPv6 * address is provided in the message. * * @return True if the daemon is listening on IPv6. * * @warning Useful for version zero objects only. */ bool GetIPv6Flag(void) const { return m_flagS; } /** * @internal * @brief Get the protocol flag indicating that the daemon generating * this answer is listening on an IPv4 address. * * This flag is set to true by the SetIPv4() call (or deserializing * a message for which the flag was set) and indicates that an IPv4 * address is provided in the message. * * @return True if the daemon is listening on IPv4. * * @warning Useful for version zero objects only. */ bool GetIPv4Flag(void) const { return m_flagF; } /** * @internal * @brief Set the GUID string for the responding name service. * * This method takes a string with the name service guid in "presentation" format * and arranges for it to be written out in the protocol message. Although * this is typically a string representation of a GUID, the string is not * interpreted by the protocol and can be used to carry any global (not * related to an individual well-known name) information related to the * generating daemon. * * @param guid The name service GUID string of the responding name service. */ void SetGuid(const qcc::String& guid); /** * @internal * @brief Get the name service GUID string for the responding daemon. * * This method returns a string with the guid in "presentation" format. * Although this is typically a string representation of a GUID, the string * is not interpreted by the protocol and can be used to carry any global * (not related to an infividual well-known name) information related to the * generating daemon. * * @return The GUID string of the responding name service. */ qcc::String GetGuid(void) const; /** * @internal * @brief Set the port on which the daemon generating this answer is * listening. * * @param port The port on which the daemon is listening. * * @warning Useful for version zero objects only. */ void SetPort(uint16_t port); /** * @internal * @brief Get the port on which the daemon generating this answer is * listening. * * @return The port on which the daemon is listening. * * @warning Useful for version zero objects only. */ uint16_t GetPort(void) const; /** * @internal * @brief Clear the IPv4 address. * * @warning Useful for version zero objects only. */ void ClearIPv4(void); /** * @internal * @brief Set the IPv4 address on which the daemon generating this answer * is listening. * * This method takes an IPv4 address string in presentation format and * arranges for it to be written out in the protocol message in network * format (32-bits, big endian). It also has the side-effect of setting * the IPv4 flag. * * @param ipv4Addr The IPv4 address on which the daemon is listening. * * @warning Useful for version zero objects only. */ void SetIPv4(qcc::String ipv4Addr); /** * @internal * @brief Get the IPv4 address on which the daemon generating this answer * is listening. * * This method returns an IPv4 address string in presentation format. * If the IPv4 flag is not set, the results are undefined. * * @return The IPv4 address on which the daemon is listening. * * @warning Useful for version zero objects only. */ qcc::String GetIPv4(void) const; /** * @internal * @brief Clear the IPv6 address. * @warning Useful for version zero objects only. */ void ClearIPv6(void); /** * @internal * @brief Set the IPv6 address on which the daemon generating this answer * is listening. * * This method takes an IPv6 address string in presentation format and * arranges for it to be written out in the protocol message in network * format (128-bits, big endian). It also has the side-effect of setting * the IPv6 flag. * * @param ipv6Addr The IPv6 address on which the daemon is listening. * * @warning Useful for version zero objects only. */ void SetIPv6(qcc::String ipv6Addr); /** * @internal * @brief Get the IPv6 address on which the daemon generating this answer * is listening. * * This method returns an IPv6 address string in presentation format. * If the IPv6 flag is not set, the results are undefined. * * @return The IPv6 address on which the daemon is listening. * * @warning Useful for version zero objects only. */ qcc::String GetIPv6(void) const; /** * @internal * @brief Clear the ReliableIPv4 address and port * * @warning Useful for version one objects only. */ void ClearReliableIPv4(void); /** * @internal * @brief Set the reliable IPv4 address and port * * This method takes an IPv4 address string in presentation format and * arranges for it to be written out in the protocol message in network * format (32-bits, big endian). It also takes a port number and arranges * for it to be written out in network format (16-bits, big endian). This * method has the side-effect of setting the reliableIPv4 flag. * * @param addr The reliable method IPv4 address on which the daemon can be * contacted. * @param port The port on which the daemon is listening for connections. * * @warning Useful for version one objects only. */ void SetReliableIPv4(qcc::String addr, uint16_t port); /** * @internal * @brief Get the reliable IPv4 address * * This method returns an IPv4 address string in presentation format. * If the reliableIPv4 flag is not set, the results are undefined. * * @return The reliable IPv4 address on which the daemon is listening. * * @warning Useful for version one objects only. */ qcc::String GetReliableIPv4Address(void) const; /** * @internal * @brief Get the reliable IPv4 port * * This method returns an IPv4 port. If the reliableIPv4 flag is not set, * the results are undefined. * * @return The reliable IPv4 port on which the daemon is listening. * * @warning Useful for version one objects only. */ uint16_t GetReliableIPv4Port(void) const; /** * @internal * @brief Clear the UnreliableIPv4 address and port * * @warning Useful for version one objects only. */ void ClearUnreliableIPv4(void); /** * @internal * @brief Set the unreliable IPv4 address and port * * This method takes an IPv4 address string in presentation format and * arranges for it to be written out in the protocol message in network * format (32-bits, big endian). It also takes a port number and arranges * for it to be written out in network format (16-bits, big endian). This * method has the side-effect of setting the unreliableIPv4 flag. * * @param addr The unreliable method IPv4 address on which the daemon can be * contacted. * @param port The port on which the daemon is listening for connections. * * @warning Useful for version one objects only. */ void SetUnreliableIPv4(qcc::String addr, uint16_t port); /** * @internal * @brief Get the unreliable IPv4 address * * This method returns an IPv4 address string in presentation format. * If the unreliableIPv4 flag is not set, the results are undefined. * * @return The unreliable IPv4 address on which the daemon is listening. * * @warning Useful for version one objects only. */ qcc::String GetUnreliableIPv4Address(void) const; /** * @internal * @brief Get the unreliable IPv4 port * * This method returns an IPv4 port. If the unreliableIPv4 flag is not set, * the results are undefined. * * @return The unreliable IPv4 port on which the daemon is listening. * * @warning Useful for version one objects only. */ uint16_t GetUnreliableIPv4Port(void) const; /** * @internal * @brief Clear the ReliableIPv6 address and port * * @warning Useful for version one objects only. */ void ClearReliableIPv6(void); /** * @internal * @brief Set the reliable IPv6 address and port * * This method takes an IPv6 address string in presentation format and * arranges for it to be written out in the protocol message in network * format (128-bits, big endian). It also takes a port number and arranges * for it to be written out in network format (16-bits, big endian). This * method has the side-effect of setting the reliableIPv6 flag. * * @param addr The reliable method IPv6 address on which the daemon can be * contacted. * @param port The port on which the daemon is listening for connections. * * @warning Useful for version one objects only. */ void SetReliableIPv6(qcc::String addr, uint16_t port); /** * @internal * @brief Get the reliable IPv6 address * * This method returns an IPv6 address string in presentation format. * If the reliableIPv6 flag is not set, the results are undefined. * * @return The reliable IPv6 address on which the daemon is listening. * * @warning Useful for version one objects only. */ qcc::String GetReliableIPv6Address(void) const; /** * @internal * @brief Get the reliable IPv6 port * * This method returns an IPv6 port. If the reliableIPv6 flag is not set, * the results are undefined. * * @return The reliable IPv6 port on which the daemon is listening. * * @warning Useful for version one objects only. */ uint16_t GetReliableIPv6Port(void) const; /** * @internal * @brief Clear the UnreliableIPv6 address and port * * @warning Useful for version one objects only. */ void ClearUnreliableIPv6(void); /** * @internal * @brief Set the unreliable IPv6 address and port * * This method takes an IPv6 address string in presentation format and * arranges for it to be written out in the protocol message in network * format (128-bits, big endian). It also takes a port number and arranges * for it to be written out in network format (16-bits, big endian). This * method has the side-effect of setting the unreliableIPv6 flag. * * @param addr The unreliable method IPv6 address on which the daemon can be * contacted. * @param port The port on which the daemon is listening for connections. * * @warning Useful for version one objects only. */ void SetUnreliableIPv6(qcc::String addr, uint16_t port); /** * @internal * @brief Get the unreliable IPv6 address * * This method returns an IPv6 address string in presentation format. * If the unreliableIPv6 flag is not set, the results are undefined. * * @return The unreliable IPv6 address on which the daemon is listening. * * @warning Useful for version one objects only. */ qcc::String GetUnreliableIPv6Address(void) const; /** * @internal * @brief Get the unreliable IPv6 port * * This method returns an IPv6 port. If the unreliableIPv6 flag is not set, * the results are undefined. * * @return The unreliable IPv6 port on which the daemon is listening. * * @warning Useful for version one objects only. */ uint16_t GetUnreliableIPv6Port(void) const; /** * @internal @brief Clear any objects from the list names, effectively * resetting the object. */ void Reset(void); /** * @internal * @brief Add a string representing a well-known or bus name to the answer. * * This method adds a well-known or bus name and adds it to an internal * list of authoritative answers regarding the names supported by the * calling daemon. These names will be serialized to an answer message * as StringData objects. * * @param name A well-known or bus name which the daemon supports. */ void AddName(qcc::String name); /** * @internal * Remove the well-known or bus name from the answer. * * This method removed a well-known name or bus name from the list of answers * regarding the names supported by the calling daemon. * * @note complexity constant time plus the number of element after the last * element deleted * * @param index the index value for the name to be removed */ void RemoveName(uint32_t index); /** * @internal * @brief Get the number of well-known or bus names represented by this * object. * * This method returns the number of well-known bus names from the internal * list of authoritative answers regarding the names supported by the * responding daemon. These names are typically deserialized from an * answer received over the network. * * @see GetName() * * @return The number of well-known names represented by this answer * object. */ uint32_t GetNumberNames(void) const; /** * @internal * @brief Get a string representing a well-known or bus name. * * This method returns one of the well-known or bus names from the internal * list of authoritative answers regarding the names supported by the * responding daemon. These names are typically deserialized from an answer * received over the network. * * The number of entries in the list (used to determine legal values for the * index) is found by calling GetNumberNames() * * @see GetNumberNames() * * @param name The index of the name to retrieve. * * @return The well-known or bus name at the provided index. */ qcc::String GetName(uint32_t index) const; /** * @internal * @brief Get the size of a buffer that will allow the answer object and * all of its children StringData objects to be successfully serialized. * * @return The size of the buffer required to serialize the object */ size_t GetSerializedSize(void) const; /** * @internal * @brief Serialize this answer and all of its children StringData objects * to the provided buffer. * * @warning The buffer should be at least as large as the size returned * by GetSerializedSize(). * * @return The number of octets written to the buffer. */ size_t Serialize(uint8_t* buffer) const; /** * @internal * @brief Deserialize this answer from the provided buffer. * * @see ProtocolElement::Deserialize() * * @param buffer The buffer to read the bytes from. * @param bufsize The number of bytes available in the buffer. * * @return The number of octets read from the buffer, or zero if an error * occurred. */ size_t Deserialize(uint8_t const* buffer, uint32_t bufsize); private: uint8_t m_version; TransportMask m_transportMask; /**< Version one only */ bool m_flagG; bool m_flagC; bool m_flagT; /**< Version zero only */ bool m_flagU; /**< Version zero only */ bool m_flagS; /**< Version zero only */ bool m_flagF; /**< Version zero only */ bool m_flagR4; /**< Version one only */ bool m_flagU4; /**< Version one only */ bool m_flagR6; /**< Version one only */ bool m_flagU6; /**< Version one only */ uint16_t m_port; /**< Version zero only */ qcc::String m_ipv4; /**< Version zero only */ qcc::String m_ipv6; /**< Version zero only */ qcc::String m_reliableIPv4Address; /**< Version one only */ uint16_t m_reliableIPv4Port; /**< Version one only */ qcc::String m_unreliableIPv4Address; /**< Version one only */ uint16_t m_unreliableIPv4Port; /**< Version one only */ qcc::String m_reliableIPv6Address; /**< Version one only */ uint16_t m_reliableIPv6Port; /**< Version one only */ qcc::String m_unreliableIPv6Address; /**< Version one only */ uint16_t m_unreliableIPv6Port; /**< Version one only */ qcc::String m_guid; std::vector m_names; }; /** * @internal * @brief A class representing a question in the name service protocol. * * The WHO-HAS message is a question message used to ask AllJoyn daemons if they * support one or more bus names. * * @ingroup name_service_protocol */ class WhoHas : public ProtocolElement { public: /** * @internal * @brief Construct an in-memory object representation of an on-the-wire * name service protocol question. */ WhoHas(); /** * @internal * @brief Destroy a name service protocol answer object. */ ~WhoHas(); /** * @internal * @brief Set the wire protocol version that the object will use. * * The name service protocol is versioned. For backward compatibility, we * need to be able to get down-version messages to "old" daemons and current * version messages to "new" daemons. The first thing to observe is that, * like most protocols, the wire protocol is versioned, not extensible. * This means that in order to support multiple versions, we will need to * send multiple messages. This introduces ambiguitiy in the receiver of * the messages since it cannot know whether or not "new" messages will * appear after 'old" ones. To resolve this ambiguity, the wire protocol * version is constructed of two versions: a message version and a sender * protocol version. * * If a new version of the protocol is defined, new senders will be modified * to generate the new version, and new receivers will be able to receive * new messages. The message version tells a receiver what the absolute * format of the current message is; and the sender protocol version * provides a context shared between the sender and the receiver that can * indicate more, or better, information may be forthcoming. * * The message version tells "this" object which version of the wire * protocol to use when serializing the bits and which version to expect * when deserializing the bits. The sender protocol version is meta-data * for higher level code. * * The version is found in the Header, so we will know for sure what version * the overall packet will take. Objects of class IsAt support all versions * known at the time of compilation. If the version of the wire protocol * read does not provide a value for a given field, a default value will be * provided. Objects of class IsAt can support writing down-version packets * for compatibility. * * It is up to higher levels to understand the contextual implications, if any, * of writing or reading down-version packets. * * @param nsVersion The version (0 .. 15) of the sender's latest implemented protocol. * @param msgVersion The version (0 .. 15) of the actual message. */ void SetVersion(uint32_t nsVersion, uint32_t msgVersion) { m_version = nsVersion << 4 | msgVersion; } /** * @internal * @brief Get the wire protocol version that the object will use. * * @param nsVersion Gets the version (0 .. 15) of the sender's latest implemented protocol. * @param msgVersion Gets the version (0 .. 15) of the actual message. * * @see SetVersion() */ void GetVersion(uint32_t& nsVersion, uint32_t& msgVersion) { nsVersion = m_version >> 4; msgVersion = m_version & 0xf; } /** * @internal * @brief Set the transport mask of the transport sending the advertisement * * The IP name service protocol can be used by a number of different AllJoyn * transports. These transports may need to build a wall around their own * advertisements so we provide the name service with a way to plumb the * advertisements from end-to-end according to transport. * * It is up to higher levels to understand the contextual implications, if any, * of peeking at other transports' advertisements or discovery requests. * * @param mask The transport mask of the object. * * @warning Due to an oversight, the transport mask is not actually sent in * a version one who-has message. The transport mask is carried around internally * in outgoing messages, but is set to zero for incoming messages. */ void SetTransportMask(TransportMask mask) { m_transportMask = mask; } /** * @internal * @brief Get the transport mask of the transport that is sending the message. * * @return The transport mask of the transport that is sending the message. * * @see SetTransportMask() * * @warning Due to an oversight, the transport mask is not actually sent in * a version one who-has message. The transport mask is carried around internally * in outgoing messages, but is set to zero for incoming messages. */ TransportMask GetTransportMask(void) { return m_transportMask; } /** * @internal * @brief Set the protocol flag indicating that the daemon generating * this question is interested in hearing about daemons listening on a TCP * socket. * * @param flag True if the daemon is interested in TCP. */ void SetTcpFlag(bool flag) { m_flagT = flag; } /** * @internal * @brief Get the protocol flag indicating that the daemon generating * this question is interested in hearing about daemons listening on a TCP * socket. * * @return True if the daemon ways it is interested in TCP. */ bool GetTcpFlag(void) const { return m_flagT; } /** * @internal * @brief Set the protocol flag indicating that the daemon generating * this question is interested in hearing about daemons listening on a UDP * socket. * * @param flag True if the daemon is interested in UDP. */ void SetUdpFlag(bool flag) { m_flagU = flag; } /** * @internal * @brief Get the protocol flag indicating that the daemon generating * this question is interested in hearing about daemons listening on a UDP * socket. * * @return True if the daemon ways it is interested in UDP. */ bool GetUdpFlag(void) const { return m_flagU; } /** * @internal * @brief Set the protocol flag indicating that the daemon generating * this question is interested in IPv6 addresses. * * @param flag True if the daemon is interested on IPv6. */ void SetIPv6Flag(bool flag) { m_flagS = flag; } /** * @internal * @brief Get the protocol flag indicating that the daemon generating * this question is interested in IPv6 addresses. * * @return True if the daemon is interested on IPv6. */ bool GetIPv6Flag(void) const { return m_flagS; } /** * @internal * @brief Set the protocol flag indicating that the daemon generating * this question is interested in IPv4 addresses. * * @param flag True if the daemon is interested on IPv4. */ void SetIPv4Flag(bool flag) { m_flagF = flag; } /** * @internal * @brief Get the protocol flag indicating that the daemon generating * this question is interested in IPv4 addresses. * * @return True if the daemon is interested on IPv4. */ bool GetIPv4Flag(void) const { return m_flagF; } /** * @internal @brief Clear any objects from the list names, effectively * resetting the object. */ void Reset(void); /** * @internal * @brief Add a string representing a well-known or bus name to the * question. * * This method adds a well-known or bus name to an internal list of names * in which the calling daemon is interested. These names will be * serialized to a question message as StringData objects. * * @param name The well-known or bus name which the daemon is interested. */ void AddName(qcc::String name); /** * @internal * @brief Get the number of well-known or bus names represented by this * object. * * This method returns the number of well-known or bus names from the * internal list names that the questioning daemon is interested in. * These names are typically deserialized from a question received over the * network. * * @see GetName() * * @return The number of well-known interfaces represented by this question * object. */ uint32_t GetNumberNames(void) const; /** * @internal * @brief Get a string representing a well-known or bus name. * * This method returns one of the well-known or bus names from the internal * list of names in which questioning daemon is interested. These names * are typically deserialized from a question received over the network. * * The number of entries in the list (used to determine legal values for the * index) is found by calling GetNumberNames() * * @see GetNumberNames() * * @param name The index of the name to retrieve. * * @return The well-known or bus name at the provided index. */ qcc::String GetName(uint32_t index) const; /** * @internal * @brief Get the size of a buffer that will allow the question object and * all of its children StringData objects to be successfully serialized. * * @return The size of the buffer required to serialize the object */ size_t GetSerializedSize(void) const; /** * @internal * @brief Serialize this question and all of its children StringData objects * to the provided buffer. * * @warning The buffer should be at least as large as the size returned * by GetSerializedSize(). * * @return The number of octets written to the buffer. */ size_t Serialize(uint8_t* buffer) const; /** * @internal * @brief Deserialize a question wire-representation from the provided * buffer. * * @see ProtocolElement::Deserialize() * * @param buffer The buffer to read the bytes from. * @param bufsize The number of bytes available in the buffer. * * @return The number of octets read from the buffer, or zero if an error * occurred. */ size_t Deserialize(uint8_t const* buffer, uint32_t bufsize); private: uint8_t m_version; TransportMask m_transportMask; bool m_flagT; bool m_flagU; bool m_flagS; bool m_flagF; std::vector m_names; }; /** * @internal * @brief A class representing name service packets. * * This is an abstract class, derived by NSPacket(version 0 and 1) and MDNSPacket(version 2) * */ class _Packet : public ProtocolElement { public: _Packet(); virtual ~_Packet(); /** * @internal * @brief Set the optional destination address for the message corresponding * to this header. This is not a perfect place for this information, but it * is a very convenient place. This information is not part of the wire * protocol. * * @param destination The destination IP address of the corresponding message. */ void SetDestination(qcc::IPEndpoint destination) { m_destination = destination; m_destinationSet = true; } void SetSource(qcc::IPEndpoint source) { m_source = source; } void SetInterfaceIndex(uint32_t interfaceIndex) { m_interfaceIndex = interfaceIndex; m_interfaceIndexSet = true; } void SetAddressFamily(qcc::AddressFamily addressFamily) { m_addressFamily = addressFamily; m_addressFamilySet = true; } /** * @internal * @brief Get the optional destination address for the message corresponding * to this header. If the destination has not been set, the result is not * defined. This is not a perfect place for this information, but it is a * very convenient place. This information is not part of the wire * protocol. * * @return The destination IP address of the corresponding message. */ qcc::IPEndpoint GetDestination(void) { return m_destination; } qcc::IPEndpoint GetSource(void) { return m_source; } uint32_t GetInterfaceIndex(void) { return m_interfaceIndex; } int32_t GetAddressFamily(void) { return m_addressFamily; } /** * @internal * @brief Set the optional destination address for the message corresponding * to this header. This is not a perfect place for this information, but it * is a very convenient place. This information is not part of the wire * protocol. * * @return The destination IP address of the corresponding message. */ bool DestinationSet(void) { return m_destinationSet; } bool InterfaceIndexSet(void) { return m_interfaceIndexSet; } bool AddressFamilySet(void) { return m_addressFamilySet; } /** * @internal * @brief Set the optional destination address for the message corresponding * to this header. This is not a perfect place for this information, but it * is a very convenient place. This information is not part of the wire * protocol. */ void ClearDestination() { m_destinationSet = false; } void ClearInterfaceIndex() { m_interfaceIndexSet = false; } void ClearAddressFamily() { m_addressFamily = qcc::QCC_AF_UNSPEC; m_addressFamilySet = false; } /** * @internal * @brief Set the number of times this header has been sent on the wire. * This is not a perfect place for this information, but it is a very * convenient place. This information is not part of the wire protocol. * * @param retries The number of times the header has been sent on the wire. */ void SetRetries(uint32_t retries) { m_retries = retries; } /** * @internal * @brief Set the number of times this header has been sent on the wire. * This is not a perfect place for this information, but it is a very * convenient place. This information is not part of the wire protocol. * * @return The number of times the header has been sent on the wire. */ uint32_t GetRetries(void) { return m_retries; } /** * @internal * @brief Get the tick value representing the last time this header was sent * on the wire. This is not a perfect place for this information, but it * is a very convenient place. This information is not part of the wire * protocol. * * @param tick The last time the header was sent on the wire. */ void SetRetryTick(uint32_t tick) { m_tick = tick; } /** * @internal * @brief Set the tick value representing the last time this header was sent * on the wire. This is not a perfect place for this information, but it * is a very convenient place. This information is not part of the wire * protocol. * * @return The last time the header was been sent on the wire. */ uint32_t GetRetryTick(void) { return m_tick; } /** * @internal * @brief Set the timer value for all answers present in the protocol * message. * * The timer value is typcally used to encode whether or not included * answer (IS-AT) messages indicate the establishment or withdrawal * of service advertisements. A timer value of zero indicates that * the included answers are valid for zero seconds. This implies * that the advertisements are no longer valid and should be withdrawn. * * A timer value of 255 indicates that the advertisements included in * the following IS-AT messages should be considered valid until they * are explicitly withdrawn. * * Other timer values indicate that the advertisements included are * are ephemeral and should not be considered valid for longer than * the number of seconds after which the message datagram containing * the header is received. * * @param timer The timer value (0 .. 255) for included answers. */ void SetTimer(uint8_t timer); /** * @internal * @brief Get the timer value for all answers present in the protocol * message. * * @see SetTimer() * * @return The timer value (0 .. 255) for included answers. */ uint8_t GetTimer(void) const; /** * @internal * @brief Set the wire protocol version that the object will use. * * The name service protocol is versioned. For backward compatibility, we * need to be able to get down-version messages to "old" daemons and current * version messages to "new" daemons. The first thing to observe is that, * like most protocols, the wire protocol is versioned, not extensible. * This means that in order to support multiple versions, we will need to * send multiple messages. This introduces ambiguitiy in the receiver of * the messages since it cannot know whether or not "new" messages will * appear after 'old" ones. To resolve this ambiguity, the wire protocol * version is constructed of two versions: a message version and a sender * protocol version. * * If a new version of the protocol is defined, new senders will be modified * to generate the new version, and new receivers will be able to receive * new messages. The message version tells a receiver what the absolute * format of the current message is; and the sender protocol version * provides a context shared between the sender and the receiver that can * indicate more, or better, information may be forthcoming. * * The message version tells "this" object which version of the wire * protocol to use when serializing the bits and which version to expect * when deserializing the bits. The sender protocol version is meta-data * for higher level code. * * The version is found in the Header, so we will know for sure what version * the overall packet will take. Objects of class IsAt support all versions * known at the time of compilation. If the version of the wire protocol * read does not provide a value for a given field, a default value will be * provided. Objects of class IsAt can support writing down-version packets * for compatibility. * * It is up to higher levels to understand the contextual implications, if any, * of writing or reading down-version packets. * * @param nsVersion The version (0 .. 15) of the sender's latest implemented protocol. * @param msgVersion The version (0 .. 15) of the actual message. */ void SetVersion(uint32_t nsVersion, uint32_t msgVersion) { m_version = nsVersion << 4 | msgVersion; } /** * @internal * @brief Get the wire protocol version that the object will use. * * @param nsVersion Gets the version (0 .. 15) of the sender's latest implemented protocol. * @param msgVersion Gets the version (0 .. 15) of the actual message. * * @see SetVersion() */ void GetVersion(uint32_t& nsVersion, uint32_t& msgVersion) { nsVersion = m_version >> 4; msgVersion = m_version & 0xf; } /** * @internal * @brief Get the size of a buffer that will allow the header object and * all of its children questions and answer objects to be successfully * serialized. * * @return The size of the buffer required to serialize the object */ virtual size_t GetSerializedSize(void) const = 0; /** * @internal * @brief Serialize this header and all of its children question and * answer objects to the provided buffer. * * @warning The buffer should be at least as large as the size returned * by GetSerializedSize(). * * @return The number of octets written to the buffer. */ virtual size_t Serialize(uint8_t* buffer) const = 0; /** * @internal * @brief Deserialize a header wire-representation and all of its children * questinos and answers from the provided buffer. * * @see ProtocolElement::Deserialize() * * @param buffer The buffer to read the bytes from. * @param bufsize The number of bytes available in the buffer. * * @return The number of octets read from the buffer, or zero if an error * occurred. */ virtual size_t Deserialize(uint8_t const* buffer, uint32_t bufsize) = 0; private: uint8_t m_timer; qcc::IPEndpoint m_destination; qcc::IPEndpoint m_source; bool m_destinationSet; uint32_t m_interfaceIndex; bool m_interfaceIndexSet; qcc::AddressFamily m_addressFamily; bool m_addressFamilySet; uint32_t m_retries; uint32_t m_tick; protected: uint8_t m_version; }; /** * @internal * @brief A class representing a message in the name service protocol. * * A name service message consists of a header, followed by a variable * number of question (Q) messages (for example, WHO-HAS) followed by a variable * number of answer(A) messages (for example, IS-AT). All messages are packed * to octet boundaries. * * @ingroup name_service_protocol */ class _NSPacket : public _Packet { public: /** * @internal * @brief Construct an in-memory object representation of an on-the-wire * name service protocol header. */ _NSPacket(); /** * @internal * @brief Destroy a name service protocol header object. */ ~_NSPacket(); /** * @internal * @brief Clear any objects from the lists of questions and answers, * effectively resetting the header. */ void Reset(void); /** * @internal * @brief Add a question object to the list of questions represented by * this header. * * This method adds a question (WhoHas) object to an internal list of * questions the calling daemon is asking. These questions will be * serialized to on-the-wire question objects when the header is * serialized. * * @see class WhoHas * * @param whoHas The question object to add to the protocol message. */ void AddQuestion(WhoHas whoHas); /** * @internal * @brief Get the number of question objects represented by this object. * * @see GetQuestion() * * @return The number of question objects represented by this header object. */ uint32_t GetNumberQuestions(void) const; /** * @internal * @brief Get a Question object represented by this header object. * * This method returns one of the question objects from the internal list * of questions asked by a questioning daemon. These questions are * typically automatically deserialized from a header received over the * network. * * The number of entries in the list (used to determine legal values for the * index) is found by calling GetNumberQuestions() * * @see GetNumberQuestions() * * @param name The index of the question to retrieve. * * @return The question object at the provided index. */ WhoHas GetQuestion(uint32_t index) const; /** * @internal * @brief Get a pointer to an answer object represented by this header object. * * This method returns a pointer. This is typically used if one needs to * rewrite the contents of a question object. We can't just return the pointer * since C++ doesn't consider return types in overload resolution, so we have * to return it indirectly. * * @see GetQuestion() * * @param name The index of the question to retrieve. * @param answer A pointer to the returned pointer to the question object at * the provided index. */ void GetQuestion(uint32_t index, WhoHas** question); /** * @internal * @brief Add an answer object to the list of answers represented by * this header. * * This method adds an answer (IsAt) object to an internal list of * answers the calling daemon is providing. These answers will be * serialized to on-the-wire answer objects when the header is * serialized. * * @see class IsAt * * @param isAt The answer object to add to the protocol message. */ void AddAnswer(IsAt isAt); /** * @internal * Remove an answer object from the list of answers represented by this header. * * This method removed an answer (IsAt) object from an internal list of answers * the calling daemon is providing. * * @note complexity is constant time plus the number of elements after the * deleted element. * * @param index the index value of the answer to be removed */ void RemoveAnswer(uint32_t index); /** * @internal * @brief Get the number of answer objects represented by this object. * * @see GetAnswer() * * @return The number of answer objects represented by this header object. */ uint32_t GetNumberAnswers(void) const; /** * @internal * @brief Get an answer object represented by this header object. * * This method returns one of the answer objects from the internal list * of answers provided by a responding daemon. These answers are typically * automatically deserialized from a header received over the network. * * The number of entries in the list (used to determine legal values for the * index) is found by calling GetNumberAnswers() * * @see GetNumberAnswers() * * @param name The index of the answer to retrieve. * * @return The answer object at the provided index. */ IsAt GetAnswer(uint32_t index) const; /** * @internal * @brief Get a pointer to an answer object represented by this header object. * * This method returns a pointer. This is typically used if one needs to * rewrite the contents of an answer object. We can't just return the pointer * since C++ doesn't consider return types in overload resolution, so we have * to return it indirectly. * * @see GetAnswer() * * @param name The index of the answer to retrieve. * @param answer A pointer to the returned pointer to the answer object at * the provided index. */ void GetAnswer(uint32_t index, IsAt** answer); /** * @internal * @brief Get the size of a buffer that will allow the header object and * all of its children questions and answer objects to be successfully * serialized. * * @return The size of the buffer required to serialize the object */ size_t GetSerializedSize(void) const; /** * @internal * @brief Serialize this header and all of its children question and * answer objects to the provided buffer. * * @warning The buffer should be at least as large as the size returned * by GetSerializedSize(). * * @return The number of octets written to the buffer. */ size_t Serialize(uint8_t* buffer) const; /** * @internal * @brief Deserialize a header wire-representation and all of its children * questinos and answers from the provided buffer. * * @see ProtocolElement::Deserialize() * * @param buffer The buffer to read the bytes from. * @param bufsize The number of bytes available in the buffer. * * @return The number of octets read from the buffer, or zero if an error * occurred. */ size_t Deserialize(uint8_t const* buffer, uint32_t bufsize); private: std::vector m_questions; std::vector m_answers; }; /** * @internal * @brief A class representing an MDNSRData. * This is an abstract class. */ class MDNSRData { public: /** * @internal * @brief Construct an in-memory object representation of an on-the-wire * MDNS RData. */ MDNSRData() { } /** * @internal * @brief Destructor for MDNSRData. */ virtual ~MDNSRData(); /** * @internal * @brief Get the size of a buffer that will allow the Resource Record object * and all of its children fields and data objects to be successfully * serialized. * * @return The size of the buffer required to serialize the object */ virtual size_t GetSerializedSize(std::map& offsets) const = 0; /** * @internal * @brief Serialize this resource record all of its children fields and * data objects to the provided buffer. * * @warning The buffer should be at least as large as the size returned * by GetSerializedSize(). * * @return The number of octets written to the buffer. */ virtual size_t Serialize(uint8_t* buffer, std::map& offsets, uint32_t headerOffset) const = 0; /** * @internal * @brief Deserialize a header wire-representation and all of its fields * from the provided buffer with support for compression. * * @see ProtocolElement::Deserialize() * * @param buffer The buffer to read the bytes from. * @param bufsize The number of bytes available in the buffer. * * @return The number of octets read from the buffer, or zero if an error * occurred. */ virtual size_t Deserialize(uint8_t const* buffer, uint32_t bufsize, std::map& compressedOffsets, uint32_t headerOffset) = 0; /** * @internal * @brief returns a deep copy of this object. * @return A deep copy of the MDNSRData */ virtual MDNSRData* GetDeepCopy() = 0; }; /** * @internal * @brief A class representing an unknown RData type to this version of NS. * It just calculates the RDLength and skips the specified number of bytes during deserialization. * Serialization of this RData does not add any bytes. */ class MDNSDefaultRData : public MDNSRData { public: /** * @internal * @brief Construct an in-memory object representation of an on-the-wire * MDNS Default RData. */ MDNSDefaultRData() { } /** * @internal * @brief Destructor for MDNSDefaultRData. */ virtual ~MDNSDefaultRData() { } /** * @internal * @brief returns a deep copy of this object. * @return A deep copy of this MDNSDefaultRData */ virtual MDNSRData* GetDeepCopy() { return new MDNSDefaultRData(*this); } /** * @internal * @brief Get the size of a buffer that will allow the Resource Record object * and all of its children fields and data objects to be successfully * serialized. * * @return The size of the buffer required to serialize the object */ virtual size_t GetSerializedSize(std::map& offsets) const; /** * @internal * @brief Serialize this resource record all of its children fields and * data objects to the provided buffer. * * @warning The buffer should be at least as large as the size returned * by GetSerializedSize(). * * @return The number of octets written to the buffer. */ virtual size_t Serialize(uint8_t* buffer, std::map& offsets, uint32_t headerOffset) const; /** * @internal * @brief Deserialize a header wire-representation and all of its fields * from the provided buffer with support for compression. * * @see ProtocolElement::Deserialize() * * @param buffer The buffer to read the bytes from. * @param bufsize The number of bytes available in the buffer. * * @return The number of octets read from the buffer, or zero if an error * occurred. */ virtual size_t Deserialize(uint8_t const* buffer, uint32_t bufsize, std::map& compressedOffsets, uint32_t headerOffset); }; /** * @internal * @brief A class representing an MDNSTextRData. * An MDNSTextRData a set of key value pairs. * For e.g. guid=guid1,upcv4=9000 will be in the following format: * 0 1 2 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 * +--+--+-+-+-+-+-+-+-+-+-+-+--+-+-+-+-+-+-+-+-+-+-+ * |22|10|g u i d = g u i d 1|10|u p c v 4 = 9 0 0 0| * +--+--+-+-+-+-+-+-+-+-+-+-+--+-+-+-+-+-+-+-+-+-+-+ */ class MDNSTextRData : public MDNSRData { public: struct Compare { inline bool operator()(const qcc::String& s1, const qcc::String& s2) const { size_t u1Pos = s1.find_last_of('_'); size_t u2Pos = s2.find_last_of('_'); if (u1Pos == qcc::String::npos || u2Pos == qcc::String::npos) { return s1 < s2; } else { uint32_t n1 = (u1Pos == qcc::String::npos) ? 0 : qcc::StringToU32(s1.substr(u1Pos + 1)); uint32_t n2 = (u2Pos == qcc::String::npos) ? 0 : qcc::StringToU32(s2.substr(u2Pos + 1)); return n1 < n2; } } }; typedef std::map Fields; /** * @brief The TXT record version supported by the MDNS name service. */ static const uint16_t TXTVERS; /** * @internal * @brief Construct an in-memory object representation of an on-the-wire * MDNS Text RData. */ MDNSTextRData(uint16_t version = TXTVERS, bool uniquifyKeys = false); /** * @internal * @brief Destructor for MDNSTextRData. */ virtual ~MDNSTextRData() { } /** * @internal * @brief returns a deep copy of this object. * @return A deep copy of this MDNSTextRData */ virtual MDNSRData* GetDeepCopy() { return new MDNSTextRData(*this); } /** * @internal * @brief returns the uniquifier value. */ uint16_t GetUniqueCount(); /** * @internal * @brief sets the uniquifier value. */ void SetUniqueCount(uint16_t count); /** * @internal * @brief reset the m_fields map */ void Reset(); /** * @internal * @brief Add/Set a key value pair. * @param key The key to set. * @param value The value to set. * @param shared Is this a shared key for the entire record. */ void SetValue(qcc::String key, qcc::String value, bool shared = false); /** * @internal * @brief Add/Set a key pair. * @param key The key to set. * @param shared Is this a shared key for the entire record. */ void SetValue(qcc::String key, bool shared = false); /** * @internal * @brief Get the value corresponding to a particular key in the map. * @param key The key to get the value for. * @return The value in the map corresponding to the key. */ qcc::String GetValue(qcc::String key); /** * @internal * @brief Is this key present in the map. * @param key The key to search. * @return true if key is present in the map. */ bool HasKey(qcc::String key); /** * @internal * @brief Get the value corresponding to a particular key in the map. * @param key The key to get the value for. * @return The value in the map corresponding to the key. */ uint16_t GetU16Value(qcc::String key); /** * @internal * @brief Remove a key value pair from the map. * @param key The key to remove */ void RemoveEntry(qcc::String key); /** * @internal * @brief Get the size of a buffer that will allow the Resource Record object * and all of its children fields and data objects to be successfully * serialized. * * @return The size of the buffer required to serialize the object */ virtual size_t GetSerializedSize(std::map& offsets) const; /** * @internal * @brief This will overestimate the size of the buffer required * since name compression is applied during serialization. * * @return The size of the buffer required to serialize the object */ virtual size_t GetSerializedSize() const { std::map offsets; return GetSerializedSize(offsets); } /** * @internal * @brief Serialize this resource record all of its children fields and * data objects to the provided buffer. * * @warning The buffer should be at least as large as the size returned * by GetSerializedSize(). * * @return The number of octets written to the buffer. */ virtual size_t Serialize(uint8_t* buffer, std::map& offsets, uint32_t headerOffset) const; /** * @internal * @brief Deserialize a header wire-representation and all of its fields * from the provided buffer with support for compression. * * @see ProtocolElement::Deserialize() * * @param buffer The buffer to read the bytes from. * @param bufsize The number of bytes available in the buffer. * * @return The number of octets read from the buffer, or zero if an error * occurred. */ virtual size_t Deserialize(uint8_t const* buffer, uint32_t bufsize, std::map& compressedOffsets, uint32_t headerOffset); private: uint16_t version; uint16_t uniquifier; protected: Fields m_fields; /** * @internal * @brief Get the number of fields beginning with key in this Text RData. * This is only useful when uniquifyKeys is true. * * @param key The key to get the count for. * @return The number of fields in this Text RData. */ uint16_t GetNumFields(qcc::String key); /** * @internal * @brief Get the value of the field beginning with the key at the particular index. * This is only useful when uniquifyKeys is true. * * @param key The key to get the value for. * @param index The index to get the field at * @return The value at the desired index in this Text RData. */ qcc::String GetFieldAt(qcc::String key, int index); /** * @internal * @brief Remove a field from this Text RData. * This is only useful when uniquifyKeys is true. * * @param key The key to get the value for. * @param index The index to remove the field at */ void RemoveFieldAt(qcc::String key, int index); }; /** * @internal * @brief A class representing an MDNSARData. * * An MDNSARData in wire format contains the length(value 4) in 2 bytes * followed by a 4 byte IPv4 address. */ class MDNSARData : public MDNSRData { public: /** * @internal * @brief Construct an in-memory object representation of an on-the-wire * MDNS A RData representing an IPV4 address. */ MDNSARData() { } /** * @internal * @brief Destructor for MDNSARData. */ virtual ~MDNSARData() { } /** * @internal * @brief returns a deep copy of this object. * @return A deep copy of this MDNSARData */ virtual MDNSRData* GetDeepCopy() { return new MDNSARData(*this); } /** * @internal * @brief Set the IPV4 address. * @param ipAddr the IPV4 address to set. */ void SetAddr(qcc::String ipAddr); /** * @internal * @brief Get the IPV4 address. * @return The IPV4 address contained in this A RData. */ qcc::String GetAddr(); /** * @internal * @brief Get the size of a buffer that will allow the Resource Record object * and all of its children fields and data objects to be successfully * serialized. * * @return The size of the buffer required to serialize the object */ virtual size_t GetSerializedSize(std::map& offsets) const; /** * @internal * @brief Serialize this resource record all of its children fields and * data objects to the provided buffer. * * @warning The buffer should be at least as large as the size returned * by GetSerializedSize(). * * @return The number of octets written to the buffer. */ virtual size_t Serialize(uint8_t* buffer, std::map& offsets, uint32_t headerOffset) const; /** * @internal * @brief Deserialize a header wire-representation and all of its fields * from the provided buffer with support for compression. * * @see ProtocolElement::Deserialize() * * @param buffer The buffer to read the bytes from. * @param bufsize The number of bytes available in the buffer. * * @return The number of octets read from the buffer, or zero if an error * occurred. */ virtual size_t Deserialize(uint8_t const* buffer, uint32_t bufsize, std::map& compressedOffsets, uint32_t headerOffset); private: qcc::String m_ipv4Addr; }; /** * @internal * @brief A class representing an MDNSAAAARData. * * An MDNSAAAARData in wire format contains the length(value 16) in 2 bytes * followed by a 16 byte IPv6 address. */ class MDNSAAAARData : public MDNSRData { public: /** * @internal * @brief Construct an in-memory object representation of an on-the-wire * MDNS AAAA RData representing an IPV6 address. */ MDNSAAAARData() { } /** * @internal * @brief Destructor for MDNSAAAARData. */ virtual ~MDNSAAAARData() { } /** * @internal * @brief returns a deep copy of this object. * @return A deep copy of this MDNSAAAARData */ virtual MDNSRData* GetDeepCopy() { return new MDNSAAAARData(*this); } /** * @internal * @brief Set the IPV6 address. * @param ipAddr the IPV6 address to set. */ void SetAddr(qcc::String ipAddr); /** * @internal * @brief Get the IPV6 address. * @return The IPV6 address contained in this AAAA RData. */ qcc::String GetAddr() const; /** * @internal * @brief Get the size of a buffer that will allow the Resource Record object * and all of its children fields and data objects to be successfully * serialized. * * @return The size of the buffer required to serialize the object */ virtual size_t GetSerializedSize(std::map& offsets) const; /** * @internal * @brief Serialize this resource record all of its children fields and * data objects to the provided buffer. * * @warning The buffer should be at least as large as the size returned * by GetSerializedSize(). * * @return The number of octets written to the buffer. */ virtual size_t Serialize(uint8_t* buffer, std::map& offsets, uint32_t headerOffset) const; /** * @internal * @brief Deserialize a header wire-representation and all of its fields * from the provided buffer with support for compression. * * @see ProtocolElement::Deserialize() * * @param buffer The buffer to read the bytes from. * @param bufsize The number of bytes available in the buffer. * * @return The number of octets read from the buffer, or zero if an error * occurred. */ virtual size_t Deserialize(uint8_t const* buffer, uint32_t bufsize, std::map& compressedOffsets, uint32_t headerOffset); private: qcc::String m_ipv6Addr; }; /** * @internal * @brief A class representing an MDNSPtrRData. * * An MDNSPtrRData in wire format contains the length in 2 bytes * followed by the 'length' number of bytes containing the Ptr domain name. */ class MDNSPtrRData : public MDNSRData { public: /** * @internal * @brief Construct an in-memory object representation of an on-the-wire * MDNS PTR RData. */ MDNSPtrRData() { } /** * @internal * @brief Destructor for MDNSPtrRData. */ virtual ~MDNSPtrRData() { } /** * @internal * @brief returns a deep copy of this object. * @return A deep copy of this MDNSPtrRData */ virtual MDNSRData* GetDeepCopy() { return new MDNSPtrRData(*this); } /** * @internal * @brief Set the Ptr DName for this PTR RData. * @param dName The name to set. */ void SetPtrDName(qcc::String dName); /** * @internal * @brief Get the PTR DName. * @return The PTR DName contained in this PTR RData. */ qcc::String GetPtrDName() const; /** * @internal * @brief Get the size of a buffer that will allow the Resource Record object * and all of its children fields and data objects to be successfully * serialized. * * @return The size of the buffer required to serialize the object */ virtual size_t GetSerializedSize(std::map& offsets) const; /** * @internal * @brief Serialize this resource record all of its children fields and * data objects to the provided buffer. * * @warning The buffer should be at least as large as the size returned * by GetSerializedSize(). * * @return The number of octets written to the buffer. */ virtual size_t Serialize(uint8_t* buffer, std::map& offsets, uint32_t headerOffset) const; /** * @internal * @brief Deserialize a header wire-representation and all of its fields * from the provided buffer with support for compression. * * @see ProtocolElement::Deserialize() * * @param buffer The buffer to read the bytes from. * @param bufsize The number of bytes available in the buffer. * * @return The number of octets read from the buffer, or zero if an error * occurred. */ virtual size_t Deserialize(uint8_t const* buffer, uint32_t bufsize, std::map& compressedOffsets, uint32_t headerOffset); private: qcc::String m_rdataStr; }; /** * @internal * @brief A class representing an MDNSDomainName. * for e.g. _alljoyn._tcp.local will be represented as follows in the MDNSDomainName format: * 0 1 2 * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ * |8 _ a l l j o y n 4 _ t c p 5 l o c a l 0| * +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ */ class MDNSDomainName { public: /** * @internal * @brief Set the name for this DomainName element. * * @param name The name to set. */ void SetName(qcc::String name); /** * @internal * @brief Get the String name this object is representing. * * @return name in qcc::String format. */ qcc::String GetName() const; /** * @internal * @brief Construct an in-memory object representation of an on-the-wire * MDNS domain name. */ MDNSDomainName(); /** * @internal * @brief Destructor for MDNSDomainName */ ~MDNSDomainName(); /** * @internal * @brief Get the size of a buffer that will allow the header object and * all of its children questions and answer objects to be successfully * serialized. * * @return The size of the buffer required to serialize the object */ size_t GetSerializedSize(std::map& offsets) const; /** * @internal * @brief Serialize this header and all of its children question and * answer objects to the provided buffer. * * @warning The buffer should be at least as large as the size returned * by GetSerializedSize(). * * @return The number of octets written to the buffer. */ size_t Serialize(uint8_t* buffer, std::map& offsets, uint32_t headerOffset) const; /** * @internal * @brief Deserialize a header wire-representation and all of its children * questinos and answers from the provided buffer with support for compression. * * @see ProtocolElement::Deserialize() * * @param buffer The buffer to read the bytes from. * @param bufsize The number of bytes available in the buffer. * * @return The number of octets read from the buffer, or zero if an error * occurred. */ size_t Deserialize(uint8_t const* buffer, uint32_t bufsize, std::map& compressedOffsets, uint32_t headerOffset); private: qcc::String m_name; }; /** * @internal * @brief A class representing an MDNSSrvRData. * * An MDNSSrvRData in wire format contains the total length in 2 bytes * followed by a 2 byte priority, 2 byte weight, 2 byte port * and a variable length target field. */ class MDNSSrvRData : public MDNSRData { public: /** * @internal * @brief Construct an in-memory object representation of an on-the-wire * MDNS SRV RData. */ MDNSSrvRData() { } /** * @internal * @brief Construct an in-memory object representation of an on-the-wire * MDNS SRV RData. * @param priority the priority of the target host. * @param weight Weight for records with the same priority. * @param port TCP or UDP port that the service is listening on. * @param target The host name in MDNS domain name format. */ MDNSSrvRData(uint16_t priority, uint16_t weight, uint16_t port, qcc::String target); /** * @internal * @brief Destructor for MDNSSrvRData. */ virtual ~MDNSSrvRData() { } /** * @internal * @brief returns a deep copy of this object. * @return A deep copy of this MDNSSrvRData */ virtual MDNSRData* GetDeepCopy() { return new MDNSSrvRData(*this); } /** * @internal * @brief Set the priority for this SRV RData. * @param priority The priority to set. */ void SetPriority(uint16_t priority); /** * @internal * @brief Get the priority for this SRV RData. * @return The priority contained in this SRV RData. */ uint16_t GetPriority() const; /** * @internal * @brief Set the weight for this SRV RData. * @param weight The weight to set. */ void SetWeight(uint16_t weight); /** * @internal * @brief Get the weight for this SRV RData. * @return The weight contained in this SRV RData. */ uint16_t GetWeight() const; /** * @internal * @brief Set the port for this SRV RData. * @param port The port to set. */ void SetPort(uint16_t port); /** * @internal * @brief Get the port for this SRV RData. * @return The port contained in this SRV RData. */ uint16_t GetPort() const; /** * @internal * @brief Set the target for this SRV RData. * @param target The target to set. */ void SetTarget(qcc::String target); /** * @internal * @brief Get the target for this SRV RData. * @return The target contained in this SRV RData. */ qcc::String GetTarget() const; /** * @internal * @brief Get the size of a buffer that will allow the Resource Record object * and all of its children fields and data objects to be successfully * serialized. * * @return The size of the buffer required to serialize the object */ virtual size_t GetSerializedSize(std::map& offsets) const; /** * @internal * @brief Serialize this resource record all of its children fields and * data objects to the provided buffer. * * @warning The buffer should be at least as large as the size returned * by GetSerializedSize(). * * @return The number of octets written to the buffer. */ virtual size_t Serialize(uint8_t* buffer, std::map& offsets, uint32_t headerOffset) const; /** * @internal * @brief Deserialize a header wire-representation and all of its fields * from the provided buffer with support for compression. * * @see ProtocolElement::Deserialize() * * @param buffer The buffer to read the bytes from. * @param bufsize The number of bytes available in the buffer. * * @return The number of octets read from the buffer, or zero if an error * occurred. */ virtual size_t Deserialize(uint8_t const* buffer, uint32_t bufsize, std::map& compressedOffsets, uint32_t headerOffset); private: uint16_t m_priority; uint16_t m_weight; uint16_t m_port; MDNSDomainName m_target; }; /** * @internal * @brief A class representing an MDNSSearchRData. * * MDNSSearchRData is a specialization of MDNSTextData and contains a well-known name. */ class MDNSSearchRData : public MDNSTextRData { public: /** * @internal * @brief Construct an in-memory object representation of an on-the-wire * MDNS Search RData. */ MDNSSearchRData(uint16_t version = MDNSTextRData::TXTVERS) : MDNSTextRData(version, true) { } /** * @internal * @brief Construct an in-memory object representation of an on-the-wire * MDNS Search RData. * @param name The name to search for. */ MDNSSearchRData(qcc::String name, uint16_t version = MDNSTextRData::TXTVERS); /** * @internal * @brief Destructor for MDNSSearchRData. */ virtual ~MDNSSearchRData() { } /** * @internal * @brief returns a deep copy of this object. * @return A deep copy of this MDNSSearchRData */ virtual MDNSRData* GetDeepCopy() { return new MDNSSearchRData(*this); } /** * @internal * @brief Get the number of names in this Search RData. * @return The number of names in this Search RData. */ uint16_t GetNumNames() { return MDNSTextRData::GetNumFields("n"); } /** * @internal * @brief Get the name at the particular index. * @param index The index to get the name at * @return The name at the desired index in this Search RData. */ qcc::String GetNameAt(int index) { return MDNSTextRData::GetFieldAt("n", index); } /** * @internal * @brief Get the send_match_only option specified in the Search RData. * * @return true if only matching names need to be sent. * false if all names need to be sent. */ bool SendMatchOnly(); /** * @internal * @brief Add/Set a key value pair. * @param key The key to set. * @param value The value to set. */ void SetValue(qcc::String key, qcc::String value); /** * @internal * @brief Add/Set a key pair. * @param key The key to set. */ void SetValue(qcc::String key); /** * @internal * @brief Get the number of fields in this Search RData. * @return The number of fields in this Search RData. */ uint16_t GetNumFields(); /** * @internal * @brief Get the field at a certain index in this Search RData. * @param index The index at which the field is to be returned * @return Field at the specified index */ std::pair GetFieldAt(int index); /** * @internal * @brief Get the number of search criteria in this Search RData. * @return The number of search criteria in this Search RData. */ uint16_t GetNumSearchCriteria(); /** * @internal * @brief Get the search criterion at a certain index in this Search RData. * @param index The index at which the search criterion is to be returned * @return Search Criterion at the specified index */ qcc::String GetSearchCriterion(int index); /** * @internal * @brief Remove the search criterion at a certain index in this Search RData. * @param index The index at which the search criterion is to be removed */ void RemoveSearchCriterion(int index); }; /** * @internal * @brief A class representing an MDNSPingRData. * * MDNSPingRData is a specialization of MDNSTextData and contains a well-known name. */ class MDNSPingRData : public MDNSTextRData { public: /** * @internal * @brief Construct an in-memory object representation of an on-the-wire * MDNS Ping RData. */ MDNSPingRData(uint16_t version = MDNSTextRData::TXTVERS) : MDNSTextRData(version) { } /** * @internal * @brief Construct an in-memory object representation of an on-the-wire * MDNS Ping RData. * @param name The name to search for. */ MDNSPingRData(qcc::String name, uint16_t version = MDNSTextRData::TXTVERS); /** * @internal * @brief Destructor for MDNSPingRData. */ virtual ~MDNSPingRData() { } /** * @internal * @brief returns a deep copy of this object. * @return A deep copy of this MDNSPingRData */ virtual MDNSRData* GetDeepCopy() { return new MDNSPingRData(*this); } /** * @internal * @brief Set the well known name for this Search RData. * @param name The well known name to set. */ void SetWellKnownName(qcc::String name); /** * @internal * @brief Get the wellknown name for this Ping RData. * @return The well known name contained in this Ping RData. */ qcc::String GetWellKnownName(); }; /** * @internal * @brief A class representing an MDNSPingRData. * * MDNSPingRData is a specialization of MDNSTextData and contains a well-known name. */ class MDNSPingReplyRData : public MDNSTextRData { public: /** * @internal * @brief Construct an in-memory object representation of an on-the-wire * MDNS Ping RData. */ MDNSPingReplyRData(uint16_t version = MDNSTextRData::TXTVERS) : MDNSTextRData(version) { } /** * @internal * @brief Construct an in-memory object representation of an on-the-wire * MDNS Ping RData. * @param name The name to search for. */ MDNSPingReplyRData(qcc::String name, uint16_t version = MDNSTextRData::TXTVERS); /** * @internal * @brief Destructor for MDNSPingRData. */ virtual ~MDNSPingReplyRData() { } /** * @internal * @brief returns a deep copy of this object. * @return A deep copy of this MDNSPingRData */ virtual MDNSRData* GetDeepCopy() { return new MDNSPingReplyRData(*this); } /** * @internal * @brief Set the well known name for this Search RData. * @param name The well known name to set. */ void SetWellKnownName(qcc::String name); /** * @internal * @brief Get the wellknown name for this Ping RData. * @return The well known name contained in this Ping RData. */ qcc::String GetWellKnownName(); qcc::String GetReplyCode(); void SetReplyCode(qcc::String replyCode); }; /** * @internal * @brief A class representing an MDNSAdvertiseRData. * * MDNSAdvertiseRData is a specialization of MDNSTextData and contains a list of * names being advertised by the service. */ class MDNSAdvertiseRData : public MDNSTextRData { public: /** * @internal * @brief Construct an in-memory object representation of an on-the-wire * MDNS Advertise RData. */ MDNSAdvertiseRData(uint16_t version = MDNSTextRData::TXTVERS) : MDNSTextRData(version, true) { } /** * @internal * @brief Destructor for MDNSAdvertiseRData. */ virtual ~MDNSAdvertiseRData() { } /** * @internal * @brief returns a deep copy of this object. * @return A deep copy of this MDNSAdvertiseRData */ virtual MDNSRData* GetDeepCopy() { return new MDNSAdvertiseRData(*this); } /** * @internal * @brief Remove all the accumulated names */ void Reset(); /** * @internal * @brief Get the number of names in this Advertise RData. * @return The number of names in this Advertise RData. */ uint16_t GetNumTransports() { return MDNSTextRData::GetNumFields("t"); } /** * @internal * @brief Get the name at the particular index. * @param index The index to get the name at * @return The name at the desired index in this Advertise RData. */ qcc::String GetNameAt(TransportMask transportMask, int index); void SetTransport(TransportMask tm); void RemoveNameAt(TransportMask transportMask, int index); /** * @internal * @brief Get the name at the particular index. * @param index The index to get the name at * @return The name at the desired index in this Advertise RData. */ qcc::String GetNameAt(int index) { return MDNSTextRData::GetFieldAt("n", index); } /** * @internal * @brief Add a name for this Advertise RData. * @param name The name to add. */ void AddName(qcc::String name); /** * @internal * @brief Remove a name from this Advertise RData. * @param name The name to remove. */ void RemoveNameAt(int index) { return MDNSTextRData::RemoveFieldAt("n", index); } /** * @internal * @brief Get the number of names in this Advertise RData. * @return The number of names in this Advertise RData. */ uint16_t GetNumNames(TransportMask transportMask); /** * @internal * @brief Get the number of names in this Advertise RData. * @return The number of names in this Advertise RData. */ uint16_t GetNumNames() { return MDNSTextRData::GetNumFields("n"); } /** * @internal * @brief Add/Set a key value pair. * @param key The key to set. * @param value The value to set. */ void SetValue(qcc::String key, qcc::String value); /** * @internal * @brief Add/Set a key pair. * @param key The key to set. */ void SetValue(qcc::String key); /** * @internal * @brief Get the number of fields in this Advertise RData. * @return The number of fields in this Advertise RData. */ uint16_t GetNumFields(); /** * @internal * @brief Get the number of fields in this Advertise RData. * @return The number of fields in this Advertise RData. */ std::pair GetFieldAt(int index); }; /** * @internal * @brief A class representing an MDNSSenderRData. * * MDNSSenderRData is a specialization of MDNSTextData and contains the search ID, * protocol version, ipv4 unicast port that the NS is listening on, * ipv6 NS unicast port that the NS is listening on, transport mask for the query/response, * guid of the NS router and ipv4 and ipv6 addresses in case of a query. * Note: In case of a response the ipv4 and ipv6 addresses are included as * A and AAAA additionalrecords. */ class MDNSSenderRData : public MDNSTextRData { public: /* * The current version of the MDNS nameservice */ static const uint32_t NS_VERSION = 2; /** * @internal * @brief Construct an in-memory object representation of an on-the-wire * MDNS Sender RData. */ MDNSSenderRData(uint16_t version = MDNSTextRData::TXTVERS); /** * @internal * @brief Destructor for MDNSSenderRData. */ virtual ~MDNSSenderRData() { } /** * @internal * @brief returns a deep copy of this object. * @return A deep copy of this MDNSSenderRData */ virtual MDNSRData* GetDeepCopy() { return new MDNSSenderRData(*this); } /** * @internal * @brief Set the search ID for this Sender RData. * @param searchId The search ID to set. */ void SetSearchID(uint16_t searchId); /** * @internal * @brief Get the search ID for this Sender RData. * @return The search ID contained in this Sender RData. */ uint16_t GetSearchID(); /** * @internal * @brief Set the ipv4Port for this Sender RData. * @param ipv4Port The ipv4Port to set. */ void SetIPV4ResponsePort(uint16_t ipv4Port); /** * @internal * @brief Get the ipv4Port for this Sender RData. * @return The ipv4Port contained in this Sender RData. */ uint16_t GetIPV4ResponsePort(); /** * @internal * @brief Set the ipv4Addr for this Sender RData. * @param ipv4Addr The ipv4Addr to set. */ void SetIPV4ResponseAddr(qcc::String ipv4Addr); /** * @internal * @brief Get the ipv4Addr for this Sender RData. * @return The ipv4Addr contained in this Sender RData. */ qcc::String GetIPV4ResponseAddr(); }; /** * @internal * @brief A class representing an MDNSResourceRecord. * * An MDNSResourceRecord in wire format contains a name(MDNSDomainName format), * followed by an MDNSResourceRecord::RRType(2 byte), * followed by an MDNSResourceRecord::RRClass(2 byte), * followed by a 4 byte unsigned integer - ttl * followed by a 2 byte RDLength * followed by RDLength number of bytes in a format defined by the RRType and RRClass. */ class MDNSResourceRecord { public: enum RRType { A = 1, //Host IPv4 Address NS = 2, //Authoritative name server MD = 3, //Mail destination MF = 4, //Mail forwarder CNAME = 5, //Canonical name for an alias SOA = 6, //Marks the start zone of an authority MB = 7, //Mailbox domain name MG = 8, //Mail group member MR = 9, //Mail rename domain RNULL = 10, //Null RR WKS = 11, //Well known service description PTR = 12, //Domain name pointer HINFO = 13, //Host information MINFO = 14, //Mailbox info MX = 15, //Mail Exchange TXT = 16, //Text strings AAAA = 28, //Host IPv6 Address SRV = 33, //SRV record OPT = 41, //OPT record NSEC = 47 //NSEC record }; enum RRClass { INTERNET = 1, //Internet CS = 2, //CSNET class CH = 3, //CHAOS class HS = 4 //Hesoid }; /** * @internal * @brief Construct an in-memory object representatin of an on-the-wire * mDNS resource record */ MDNSResourceRecord(); /** * @internal * @brief Construct an in-memory object representatin of an on-the-wire * mDNS resource record * @param domainName Name for this Resource record. * @param rrtype Type of Resource record. * @param rrclass Class of Resource record. * @param ttl Time to live for this resource record. * @param rdata Pointer to an MDNSRData. */ MDNSResourceRecord(qcc::String domainName, RRType rrtype, RRClass rrclass, uint16_t ttl, MDNSRData* rdata); /** * @internal * @brief Copy constructor for the MDNSResourceRecord * @param mdnsResourceRecord The MDNSResourceRecord to copy from. */ MDNSResourceRecord(const MDNSResourceRecord& mdnsResourceRecord); /** * @internal * @brief Assignment operator * @param other The MDNSResourceRecord to copy from. */ MDNSResourceRecord& operator=(const MDNSResourceRecord& other); /** * @internal * @brief Destroy a mDNS resource record */ ~MDNSResourceRecord(); /** * @internal * @brief Set the domain name for the resource record. * @param domainName The domain name to set. */ void SetDomainName(qcc::String domainName); /** * @internal * @brief Get the domain name for the resource record. * @return The domain name of this resource record. */ qcc::String GetDomainName() const; /** * @internal * @brief Set the type for the resource record. * @param rrtype The type to set. */ void SetRRType(RRType rrtype); /** * @internal * @brief Get the type for the resource record. * @return The type of this resource record. */ RRType GetRRType() const; /** * @internal * @brief Set the class for the resource record. * @param rrclass The class to set. */ void SetRRClass(RRClass rrclass); /** * @internal * @brief Get the class for the resource record. * @return The class of this resource record. */ RRClass GetRRClass() const; /** * @internal * @brief Set the ttl for the resource record. * @param ttl The TTL to set. */ void SetRRttl(uint16_t ttl); /** * @internal * @brief Get the ttl for the resource record. * @return The TTL of this resource record. */ uint16_t GetRRttl() const; /** * @internal * @brief Set the rdata for the resource record. * @param rdata The RData to set. */ void SetRData(MDNSRData* rdata); /** * @internal * @brief Get the rdata for the resource record. * @return A pointer to the RData of this resource record. */ MDNSRData* GetRData(); /** * @internal * @brief Get the size of a buffer that will allow the Resource Record object * and all of its children fields and data objects to be successfully * serialized. * * @return The size of the buffer required to serialize the object */ size_t GetSerializedSize(std::map& offsets) const; /** * @internal * @brief This will overestimate the size of the buffer required * since name compression is applied during serialization. * * @return The size of the buffer required to serialize the object */ size_t GetSerializedSize() const { std::map offsets; return GetSerializedSize(offsets); } /** * @internal * @brief Serialize this resource record all of its children fields and * data objects to the provided buffer. * * @warning The buffer should be at least as large as the size returned * by GetSerializedSize(). * * @return The number of octets written to the buffer. */ size_t Serialize(uint8_t* buffer, std::map& offsets, uint32_t headerOffset) const; /** * @internal * @brief Deserialize a header wire-representation and all of its fields * from the provided buffer with support for compression. * * @see ProtocolElement::Deserialize() * * @param buffer The buffer to read the bytes from. * @param bufsize The number of bytes available in the buffer. * * @return The number of octets read from the buffer, or zero if an error * occurred. */ size_t Deserialize(uint8_t const* buffer, uint32_t bufsize, std::map& compressedOffsets, uint32_t headerOffset); private: MDNSDomainName m_rrDomainName; RRType m_rrType; RRClass m_rrClass; uint32_t m_rrTTL; MDNSRData*m_rdata; }; /** * @internal * @brief A class representing an MDNSQuestion. * * MDNSQuestion wire format contains a QName in MDNSDomainName format, * followed by a 2 byte QType(MDNSResourceRecord::RRType), * followed by a 2 byte QClass(MDNSResourceRecord::RRClass). */ class MDNSQuestion { public: static const uint16_t QU_BIT = 0x8000; /** * @internal * @brief Construct an in-memory object representation of an on-the-wire * MDNS question. */ MDNSQuestion() { } /** * @internal * @brief Construct an in-memory object representation of an on-the-wire * MDNS question. * @param qName The QName to set. * @param qType The QType to set. * @param qClass The QClass to set. */ MDNSQuestion(qcc::String qName, uint16_t qtype, uint16_t qClass); /** * @internal * @brief Destructor for MDNSQuestion */ ~MDNSQuestion() { } /** * @internal * @brief Set the value for the QName field in the question. * * @param name The QName to set. */ void SetQName(qcc::String qName); /** * @internal * @brief Get the QName field value in the question. * * @return The QName field value. */ qcc::String GetQName(); /** * @internal * @brief Set the value for the QType field in the question. * * @param name The QType to set. */ void SetQType(uint16_t qType); /** * @internal * @brief Get the QType field value in the question. * * @return The QType field value. */ uint16_t GetQType(); /** * @internal * @brief Set the value for the QClass field in the question. * * @param name The QClass to set. */ void SetQClass(uint16_t qClass); /** * @internal * @brief Get the QClass field value in the question. * * @return The QClass field value. */ uint16_t GetQClass(); /** * @internal * @brief Get the size of a buffer that will allow the header object and * all of its children questions and answer objects to be successfully * serialized. * * @return The size of the buffer required to serialize the object */ size_t GetSerializedSize(std::map& offsets) const; /** * @internal * @brief Serialize this header and all of its children question and * answer objects to the provided buffer. * * @warning The buffer should be at least as large as the size returned * by GetSerializedSize(). * * @return The number of octets written to the buffer. */ size_t Serialize(uint8_t* buffer, std::map& offsets, uint32_t headerOffset) const; /** * @internal * @brief Deserialize a header wire-representation and all of its children * questinos and answers from the provided buffer with support for compression. * * @see ProtocolElement::Deserialize() * * @param buffer The buffer to read the bytes from. * @param bufsize The number of bytes available in the buffer. * * @return The number of octets read from the buffer, or zero if an error * occurred. */ size_t Deserialize(uint8_t const* buffer, uint32_t bufsize, std::map& compressedOffsets, uint32_t headerOffset); private: MDNSDomainName m_qName; uint16_t m_qType; uint16_t m_qClass; }; /** * @internal * @brief A class representing an MDNSHeader. * * MDNSHeader contains the Id, QRType(Query/Response), QDCount(number of questions to follow), * ANCount(number of answers to follow), NSCount(number of authoritative records to follow) and * ARCount(number of additional records to follow). */ class MDNSHeader { public: static const uint16_t MDNS_QUERY = 0; static const uint16_t MDNS_RESPONSE = 1; /** * @internal * @brief Construct an in-memory object representation of an on-the-wire * MDNS protocol header. */ MDNSHeader(); /** * @internal * @brief Destroy a MDNS protocol header object. */ ~MDNSHeader(); MDNSHeader(uint16_t id, bool qrType, uint16_t qdCount, uint16_t anCount, uint16_t nsCount, uint16_t arCount); MDNSHeader(uint16_t id, bool qrType); /** * @internal * @brief Set the value for the Id field in the header. * * @param name The Id to set. */ void SetId(uint16_t id); /** * @internal * @brief Get the Id field value in the header. * * @return The Id field value. */ uint16_t GetId(); /** * @internal * @brief Set the value for the QRType field in the header. * * @param name The QRType to set. */ void SetQRType(bool qrType); /** * @internal * @brief Get the Type field value in the header. * * @return The Type field value. */ bool GetQRType(); /** * @internal * @brief Set the value for the QDCount field in the header. * * @param name The QDCount to set. */ void SetQDCount(uint16_t qdCount); /** * @internal * @brief Get the QDCount field value in the header. * * @return The QDCount field value. */ uint16_t GetQDCount(); /** * @internal * @brief Set the value for the ANCount field in the header. * * @param name The ANCount to set. */ void SetANCount(uint16_t anCount); /** * @internal * @brief Get the ANCount field value in the header. * * @return The ANCount field value. */ uint16_t GetANCount(); /** * @internal * @brief Set the value for the NSCount field in the header. * * @param name The NSCount to set. */ void SetNSCount(uint16_t nsCount); /** * @internal * @brief Get the NSCount field value in the header. * * @return The NSCount field value. */ uint16_t GetNSCount(); /** * @internal * @brief Set the value for the ARCount field in the header. * * @param name The ARCount to set. */ void SetARCount(uint16_t arCount); /** * @internal * @brief Get the ARCount field value in the header. * * @return The ARCount field value. */ uint16_t GetARCount(); /** * @internal * @brief Get the size of a buffer that will allow the header object and * all of its children questions and answer objects to be successfully * serialized. * * @return The size of the buffer required to serialize the object */ size_t GetSerializedSize(void) const; /** * @internal * @brief Serialize this header and all of its children question and * answer objects to the provided buffer. * * @warning The buffer should be at least as large as the size returned * by GetSerializedSize(). * * @return The number of octets written to the buffer. */ size_t Serialize(uint8_t* buffer) const; /** * @internal * @brief Deserialize a header wire-representation and all of its children * questinos and answers from the provided buffer. * * @see ProtocolElement::Deserialize() * * @param buffer The buffer to read the bytes from. * @param bufsize The number of bytes available in the buffer. * * @return The number of octets read from the buffer, or zero if an error * occurred. */ size_t Deserialize(uint8_t const* buffer, uint32_t bufsize); private: uint16_t m_queryId; bool m_qrType; bool m_authAnswer; enum RCodeType { NOT_ERROR = 0, FORMAT_ERROR = 1, SERVER_FAILURE = 2, NAME_ERROR = 3, NOT_IMPLEMENTED = 4, REFUSED = 5 }; RCodeType m_rCode; uint16_t m_qdCount; uint16_t m_anCount; uint16_t m_nsCount; uint16_t m_arCount; }; /** * @internal * @brief A class representing an MDNSPacket. * * MDNSPacket contains an MDNSHeader, * followed by a variable number of questions(as indicated in the header) * followed by a variable number of answers(as indicated in the header) * followed by a variable number of authoritative records(as indicated in the header). * followed by a variable number of additional records(as indicated in the header). */ class _MDNSPacket : public _Packet { public: _MDNSPacket(); ~_MDNSPacket(); /** * @internal * @brief Clear the internal state of this MDNSPacket. */ void Clear(); /** * @internal * @brief Set the Header for this packet. * * @param header The header to set for this packet. */ void SetHeader(MDNSHeader header); MDNSHeader GetHeader(); /** * @internal * @brief Add a question to this packet. * * @param question The question to add to this packet. */ void AddQuestion(MDNSQuestion question); /** * @internal * @brief Get the number of questions contained in this packet. * * @return Number of questions in this packet. */ uint16_t GetNumQuestions(); /** * @internal * @brief Get the question at the particular index. * @param index The index to get the question at. * @return The MDNSQuestion at the desired index in this MDNS packet. */ bool GetQuestionAt(uint32_t i, MDNSQuestion** question); bool GetQuestion(qcc::String str, MDNSQuestion** question); /** * @internal * @brief Add an answer record to this packet * * @param record The answer record to add to this packet. */ void AddAnswer(MDNSResourceRecord record); /** * @internal * @brief Get the number of answer records contained in this packet. * * @return Number of answer records in this packet. */ uint16_t GetNumAnswers(); /** * @internal * @brief Get the answer at the particular index. * @param index The index to get the answer at. * @param answer[out] The MDNSResourceRecord into which the answer record will be filled. * * @return true if the name and type were found, false otherwise. */ bool GetAnswerAt(uint32_t i, MDNSResourceRecord** answer); /** * @internal * @brief Get the answer with a particular name and type. * * @param str The desired name. * @param type The desired RRtype. * @param answer[out] The MDNSResourceRecord into which the answer record will be filled. * * @return true if the name and type were found, false otherwise. */ bool GetAnswer(qcc::String str, MDNSResourceRecord::RRType type, MDNSResourceRecord** answer); /** * @internal * @brief Get the answer with a particular name, type, and rdata version. * * @param str The desired name. * @param type The desired RRtype. * @param version The desired version. * @param answer[out] The MDNSResourceRecord into which the answer record will be filled. * * @return true if the name and type were found, false otherwise. */ bool GetAnswer(qcc::String str, MDNSResourceRecord::RRType type, uint16_t version, MDNSResourceRecord** answer); /** * @internal * @brief Add an additional record to this packet * * @param record The additional record to add to this packet. */ void AddAdditionalRecord(MDNSResourceRecord record); /** * @internal * @brief Get the number of additional records contained in this packet. * * @return Number of additional records in this packet. */ uint16_t GetNumAdditionalRecords(); /** * @internal * @brief Get the additional record at the particular index. * @param index The index to get the additional record at. * @param additional[out] The MDNSResourceRecord into which the additional record will be filled. * * @return true if the name and type were found, false otherwise. */ bool GetAdditionalRecordAt(uint32_t i, MDNSResourceRecord** additional); /** * @internal * @brief Get the additional record with a particular name and type. * * @param str The desired name. This may be appended with a '*' to get the first * additional record with the matching prefix. * @param type The desired RRtype. * @param additional[out] The MDNSResourceRecord into which the additional record will be filled. * * @return true if the name and type were found, false otherwise. */ bool GetAdditionalRecord(qcc::String str, MDNSResourceRecord::RRType type, MDNSResourceRecord** additional); /** * @internal * @brief Get the additional record with a particular name, type, and rdata version. * * @param str The desired name. * @param type The desired RRtype. * @param version The desired version * @param additional[out] The MDNSResourceRecord into which the additional record will be filled. * * @return true if the name and type were found, false otherwise. */ bool GetAdditionalRecord(qcc::String str, MDNSResourceRecord::RRType type, uint16_t version, MDNSResourceRecord** additional); /** * @internal * @brief Get the additional record with a particular name, type, rdata version and particular index. * * @param str The desired name. * @param type The desired RRtype. * @param version The desired version * @param index The index to obtain in case of multiple matches * @param additional[out] The MDNSResourceRecord into which the additional record will be filled. * * @return true if the name and type were found, false otherwise. */ bool GetAdditionalRecordAt(qcc::String str, MDNSResourceRecord::RRType type, uint16_t version, uint32_t index, MDNSResourceRecord** additional); /** * @internal * @brief Get number additional records matching a particular name, type, and rdata version. * * @param str The desired name. * @param type The desired RRtype. * @param version The desired version * * @return number of matches. */ uint32_t GetNumMatches(qcc::String str, MDNSResourceRecord::RRType type, uint16_t version); TransportMask GetTransportMask(); /** * @internal * @brief Remove an additional record from this MDNS packet. * * @param str The name of the additional record to remove. * @param type The type of the additional record to remove. */ void RemoveAdditionalRecord(qcc::String str, MDNSResourceRecord::RRType type); void RemoveAnswer(qcc::String str, MDNSResourceRecord::RRType type); void RemoveQuestion(qcc::String str); /** * @internal * @brief Get the size of a buffer that will allow the header object and * all of its children questions and answer objects to be successfully * serialized. * * @return The size of the buffer required to serialize the object */ virtual size_t GetSerializedSize(void) const; /** * @internal * @brief Serialize this header and all of its children question and * answer objects to the provided buffer. * * @warning The buffer should be at least as large as the size returned * by GetSerializedSize(). * * @return The number of octets written to the buffer. */ virtual size_t Serialize(uint8_t* buffer) const; /** * @internal * @brief Deserialize a header wire-representation and all of its children * questinos and answers from the provided buffer. * * @see ProtocolElement::Deserialize() * * @param buffer The buffer to read the bytes from. * @param bufsize The number of bytes available in the buffer. * * @return The number of octets read from the buffer, or zero if an error * occurred. */ virtual size_t Deserialize(uint8_t const* buffer, uint32_t bufsize); /** * @internal * The minimum initial capacity reserved for each of the MDNS fields. */ static const uint32_t MIN_RESERVE = 8; private: MDNSHeader m_header; std::vector m_questions; std::vector m_answers; std::vector m_authority; std::vector m_additional; }; /** * Managed object type that wrap packets */ typedef qcc::ManagedObj<_Packet> Packet; typedef qcc::ManagedObj<_NSPacket> NSPacket; typedef qcc::ManagedObj<_MDNSPacket> MDNSPacket; } // namespace ajn #endif // _NS_PROTOCOL_H alljoyn-15.04b/alljoyn_core/router/ns/SConscript000066400000000000000000000015731255700255500220030ustar00rootroot00000000000000# Copyright AllSeen Alliance. All rights reserved. # # Permission to use, copy, modify, and/or distribute this software for any # purpose with or without fee is hereby granted, provided that the above # copyright notice and this permission notice appear in all copies. # # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. # Import('router_env') objs = router_env.Object(router_env.Glob('*.cc')) Return('objs') alljoyn-15.04b/alljoyn_core/router/policydb/000077500000000000000000000000001255700255500211505ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/router/policydb/PolicyDB.cc000066400000000000000000001040741255700255500231320ustar00rootroot00000000000000/** * @file * AllJoyn-Daemon Policy database class */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #if !defined(NDEBUG) || defined(QCC_OS_GROUP_WINDOWS) #include #endif #include "PolicyDB.h" #define QCC_MODULE "POLICYDB" using namespace ajn; using namespace qcc; using namespace std; /* * The whole design of the PolicyDB is based around the idea that integers are * more efficient to compare than strings. Just about everything related to * applying policy rules involves comparing strings. With a lot of rules, * this can get to be quite expensive computationally. * * To make these comparisons more efficient, a dictionary of all the strings * found in all the rules is created where each string is assigned a unique ID * number. Strings that appear more than once in the rules will use the same * ID since they are the same. * * Now, when messages are to be routed to endpoints, the strings in the header * fields are converted to their unique IDs using the dictionary that was * setup while parsing the policy rule table. Not all strings seen in message * headers will appear in the dictionary. In such a case, a special value * will be used that indicates the string is not in the dictionary. * * A small complicating factor is that an endpoint may have more than one bus * name. In such a case, an endpoint would have its unique name plus one or * more aliases (aka well-known-names). It is very unlikely for a rule to * specify a unique name, but highly likely to specifiy an alias. Such rules * apply to the endpoint that sent/received the message and not only the name * of the endpoint that appears in the message. Since the bus name that * appears in the message could be either the unique name or any of that * endpoint's aliases, all of those names need to be treated as equals. To * accomplish this the PolicyDB code maintains its own name table. This name * table maps all names to the set of all their aliases. The set of aliases * is kept as a table of string IDs for efficiency purposes. */ /* Policy Groups */ #define RULE_UNKNOWN (0x0) #define RULE_OWN (0x1 << 0) #define RULE_SEND (0x1 << 1) #define RULE_RECEIVE (0x1 << 2) #define RULE_CONNECT (0x1 << 3) #if !defined(NDEBUG) || defined(QCC_OS_GROUP_WINDOWS) static String IDSet2String(const _PolicyDB::IDSet& idset) { String ids; std::unordered_set::const_iterator it = idset->begin(); while (it != idset->end()) { ids += I32ToString(*it); ++it; if (it != idset->end()) { ids += ", "; } } return ids; } #endif static bool MsgTypeStrToEnum(const String& str, AllJoynMessageType& type) { bool success = true; if (str == "*") { type = MESSAGE_INVALID; } else if (str == "method_call") { type = MESSAGE_METHOD_CALL; } else if (str == "method_return") { type = MESSAGE_METHOD_RET; } else if (str == "signal") { type = MESSAGE_SIGNAL; } else if (str == "error") { type = MESSAGE_ERROR; } else { Log(LOG_ERR, "Invalid type for policy rule: \"%s\"\n", str.c_str()); success = false; } return success; } StringID _PolicyDB::UpdateDictionary(const String& key) { StringID id; if (key.empty()) { /* A rule that specifies an empty string will never match anything. */ id = NIL_MATCH; } else { lock.WRLock(); StringIDMap::const_iterator it = dictionary.find(key); if (it == dictionary.end()) { /* New string found; assign it an ID. */ id = dictionary.size(); pair p(key, id); dictionary.insert(p); } else { /* The string already has an ID. */ id = it->second; } lock.Unlock(); } return id; } StringID _PolicyDB::LookupStringID(const char* key) const { StringID id = ID_NOT_FOUND; if (key && (key[0] != '\0')) { lock.RDLock(); StringIDMap::const_iterator it = dictionary.find(key); if (it != dictionary.end()) { id = it->second; } lock.Unlock(); } return id; } const _PolicyDB::IDSet _PolicyDB::LookupStringIDPrefix(const char* idStr, char sep) const { assert(idStr); assert(sep != '\0'); IDSet ret; char* prefix = strdup(idStr); // duplicate idStr since we are modifying it /* * If prefix is NULL, then the program is out of memory. While it may be * considered reasonable to rework the design of this function to return * an error, in this case an out-of-memory condition, we do not for the * following reasons. One, it should never happen in real-life, and two, * it is more likely just a small symptom of a much bigger problem that * will quickly manifest itself in other ways. To keep this function * simple and its usage simple, an empty IDSet will be returned in such an * unlikely condition. */ if (prefix) { while (*prefix) { StringID id = LookupStringID(prefix); if ((id != ID_NOT_FOUND) && (id != WILDCARD)) { /* * We only add ID's that are found in the string ID table. By * not keeping prefixes that are known to not be specifed by * the policy rules, we keep the size of the possible matches * to a minimum and save time by not adding useless * information to an unordered_set<>. */ ret->insert(id); } char* p = strrchr(prefix, sep); if (p) { *p = '\0'; // Shorten the string to the next separator. } else { *prefix = '\0'; // All done. } } free(prefix); } return ret; } const _PolicyDB::IDSet _PolicyDB::LookupBusNameID(const char* busName) const { IDSet ret; if (busName && (busName[0] != '\0')) { lock.RDLock(); BusNameIDMap::const_iterator it = busNameIDMap.find(busName); if (it != busNameIDMap.end()) { /* * We need to make a local copy of the set of aliases for the * given bus name so that we can safely release the lock and allow * NameOwnerChanged() to possibly modify the set without causing * interference. While it is very unlikely that * NameOwnerChanged() would be called while another message is * begin processed, this measure follows the priciple of better * safe than sorry. */ ret = IDSet(it->second, true); // deep copy } lock.Unlock(); } return ret; } _PolicyDB::_PolicyDB() { // Prefill the string ID table with the wildcard character - used when applying rules. dictionary[""] = WILDCARD; dictionary["*"] = WILDCARD; } bool _PolicyDB::AddRule(PolicyRuleList& ownList, PolicyRuleList& connectList, PolicyRuleList& sendList, PolicyRuleList& receiveList, policydb::PolicyPermission permission, const map& ruleAttrs) { std::map::const_iterator attr; bool success = true; bool skip = false; // Get's set to true if any component of a rule is guaranteed to not match. PolicyRule rule(permission); uint32_t prevPolicyGroup = RULE_UNKNOWN; uint32_t policyGroup = RULE_UNKNOWN; QCC_DEBUG_ONLY(rule.ruleString = (permission == policydb::POLICY_ALLOW) ? "first; const String& attrVal = attr->second; QCC_DEBUG_ONLY(rule.ruleString += " " + attrStr + "=\"" + attrVal); if (attrStr.compare(0, sizeof("send_") - 1, "send_") == 0) { policyGroup = RULE_SEND; } else if (attrStr.compare(0, sizeof("receive_") - 1, "receive_") == 0) { policyGroup = RULE_RECEIVE; } if (policyGroup & (RULE_SEND | RULE_RECEIVE)) { // Trim off "send_"/"receive_" for a shorter/simpler comparisons below. attrStr = attrStr.substr(attrStr.find_first_of('_') + 1); if (attrStr == "type") { success = MsgTypeStrToEnum(attrVal, rule.type); } else { StringID strID = UpdateDictionary(attrVal); skip |= (strID == NIL_MATCH); QCC_DEBUG_ONLY(rule.ruleString += "{" + I32ToString(strID) + "}"); if (attrStr == "interface") { rule.interface = strID; } else if (attrStr == "member") { rule.member = strID; } else if (attrStr == "error") { rule.error = strID; } else if (attrStr == "path") { rule.path = strID; } else if (attrStr == "path_prefix") { rule.pathPrefix = strID; } else if (attr->first == "send_destination") { rule.busName = strID; } else if (attr->first == "receive_sender") { rule.busName = strID; } else if (attrStr == "group") { if (attrVal == "*") { rule.groupAny = true; } else { rule.group = GetUsersGid(attrVal.c_str()); skip |= (rule.group == static_cast(-1)); } rule.groupSet = true; } else if (attrStr == "user") { if (attrVal == "*") { rule.userAny = true; } else { rule.user = GetUsersUid(attrVal.c_str()); skip |= (rule.user == static_cast(-1)); } rule.userSet = true; } else if (attrStr == "same_user") { if (attrVal == "true") { rule.usersEqual = true; } else { rule.usersEqual = false; } rule.usersEqualSet = true; } else { Log(LOG_ERR, "Unknown policy attribute: \"%s\"\n", attr->first.c_str()); success = false; } } } else { if (attrStr == "own") { policyGroup = RULE_OWN; rule.own = UpdateDictionary(attrVal); skip |= (rule.own == NIL_MATCH); } else if (attrStr == "own_prefix") { policyGroup = RULE_OWN; rule.ownPrefix = UpdateDictionary(attrVal); skip |= (rule.ownPrefix == NIL_MATCH); } else if (attrStr == "user") { policyGroup = RULE_CONNECT; if (attrVal == "*") { rule.userAny = true; } else { rule.user = GetUsersUid(attrVal.c_str()); skip |= (rule.user == static_cast(-1)); } rule.userSet = true; } else if (attrStr == "group") { policyGroup = RULE_CONNECT; if (attrVal == "*") { rule.groupAny = true; } else { rule.group = GetUsersGid(attrVal.c_str()); skip |= (rule.group == static_cast(-1)); } rule.groupSet = true; } else { Log(LOG_ERR, "Unknown policy attribute: \"%s\"\n", attr->first.c_str()); success = false; } } QCC_DEBUG_ONLY(rule.ruleString += "\""); if ((prevPolicyGroup != RULE_UNKNOWN) && (policyGroup != prevPolicyGroup)) { // Invalid rule spec mixed different policy group attributes. success = false; } prevPolicyGroup = policyGroup; if (!success) { break; } } QCC_DEBUG_ONLY(rule.ruleString += "/>"); if (success && !skip) { assert(policyGroup != RULE_UNKNOWN); if (policyGroup & RULE_SEND) { sendList.push_back(rule); } if (policyGroup & RULE_RECEIVE) { receiveList.push_back(rule); } if (policyGroup & RULE_OWN) { ownList.push_back(rule); } if (policyGroup & RULE_CONNECT) { connectList.push_back(rule); } } #if !defined(NDEBUG) || defined(QCC_OS_GROUP_WINDOWS) if (!success && (policyGroup != RULE_UNKNOWN)) { Log(LOG_ERR, "Invalid attribute \"%s\" in \"%s\".\n", attr->first.c_str(), rule.ruleString.c_str()); } #endif return success; } bool _PolicyDB::AddRule(const String& cat, const String& catValue, const String& permStr, const map& ruleAttrs) { bool success = false; policydb::PolicyPermission permission; if (permStr == "allow") { permission = policydb::POLICY_ALLOW; } else if (permStr == "deny") { permission = policydb::POLICY_DENY; } else { // Invalid policy. return false; } if (cat == "context") { if (catValue == "default") { // success = AddRule(ownRS.defaultRules, connectRS.defaultRules, sendRS.defaultRules, receiveRS.defaultRules, permission, ruleAttrs); } else if (catValue == "mandatory") { // success = AddRule(ownRS.mandatoryRules, connectRS.mandatoryRules, sendRS.mandatoryRules, receiveRS.mandatoryRules, permission, ruleAttrs); } } else if (cat == "user") { // uint32_t uid = GetUsersUid(catValue.c_str()); if (uid != static_cast(-1)) { success = AddRule(ownRS.userRules[uid], connectRS.userRules[uid], sendRS.userRules[uid], receiveRS.userRules[uid], permission, ruleAttrs); } else { Log(LOG_WARNING, "Ignoring policy rules for invalid user: %s", catValue.c_str()); success = true; } } else if (cat == "group") { // uint32_t gid = GetUsersGid(catValue.c_str()); if (gid != static_cast(-1)) { success = AddRule(ownRS.groupRules[gid], connectRS.groupRules[gid], sendRS.groupRules[gid], receiveRS.groupRules[gid], permission, ruleAttrs); } else { Log(LOG_WARNING, "Ignoring policy rules for invalid group: %s", catValue.c_str()); success = true; } } return success; } void _PolicyDB::AddAlias(const String& alias, const String& name) { // We assume the write lock is already held. StringID nameID = ID_NOT_FOUND; /* * Can't call LookupStringID() since it would try to get a read lock while * we already have a write lock. That would cause a nice assert fail. * Since the write lock trumps read locks, we'll just lookup the string ID * directly. */ StringIDMap::const_iterator sit = dictionary.find(alias); if (sit != dictionary.end()) { nameID = sit->second; } IDSet bnids; BusNameIDMap::iterator it = busNameIDMap.find(name); if (it != busNameIDMap.end()) { bnids = it->second; } if (nameID != ID_NOT_FOUND) { QCC_DbgPrintf(("Add %s{%d} to table for %s", alias.c_str(), nameID, name.c_str())); bnids->insert(nameID); } pair p(alias, bnids); busNameIDMap.insert(p); } void _PolicyDB::Finalize(Bus* bus) { if (bus) { /* * If the config was reloaded while the bus is operating, then the * internal map of bus names and aliases has been wiped out. We need * to regenerate that map from the information in the NameTable. * Since the NameTable only provides vectors of Strings, the only * thing we can do is iterate over those vectors and convert them to * StringIDs. */ vector nameList; vector::const_iterator nlit; vector > > aliasMap; vector > >::const_iterator amit; DaemonRouter& router(reinterpret_cast(bus->GetInternal().GetRouter())); /* * Need to hold the name table lock for the entire duration of * processing the bus names even though we get a separate copy of * those names. This is to prevent a race condition where a * NameOwnerChanged event happens while we are processing the bus * names from the name table. We can't acquire the write lock before * the name table lock due to a dead lock risk. This forces use to * hold onto the name table lock for the entire duration of processing * bus names. */ router.LockNameTable(); lock.WRLock(); router.GetBusNames(nameList); router.GetUniqueNamesAndAliases(aliasMap); for (nlit = nameList.begin(); nlit != nameList.end(); ++nlit) { const String& name = *nlit; if (name[0] == ':') { // Only handle unique names right now, aliases will be handled below. AddAlias(name, name); } } for (amit = aliasMap.begin(); amit != aliasMap.end(); ++amit) { const String& unique = amit->first; const vector& aliases = amit->second; vector::const_iterator ait; for (ait = aliases.begin(); ait != aliases.end(); ++ait) { AddAlias(*ait, unique); } } lock.Unlock(); router.UnlockNameTable(); } #ifndef NDEBUG QCC_DbgPrintf(("Dictionary:")); for (StringIDMap::const_iterator it = dictionary.begin(); it != dictionary.end(); ++it) { QCC_DbgPrintf((" \"%s\" = %u", it->first.c_str(), it->second)); } QCC_DbgPrintf(("Name Table:")); for (unordered_map::const_iterator it = busNameIDMap.begin(); it != busNameIDMap.end(); ++it) { QCC_DbgPrintf((" \"%s\" = {%s}", it->first.c_str(), IDSet2String(it->second).c_str())); } #endif #if defined(QCC_OS_GROUP_WINDOWS) // hack to work around windows build error C4505 in release mode. _PolicyDB::IDSet dummy; IDSet2String(dummy); #endif } #if defined(QCC_OS_GROUP_WINDOWS) /* Disabling warning C 4100. Function doesnt use all passed in parameters */ #pragma warning(push) #pragma warning(disable: 4100) #endif void _PolicyDB::NameOwnerChanged(const String& alias, const qcc::String* oldOwner, SessionOpts::NameTransferType oldOwnerNameTransfer, const qcc::String* newOwner, SessionOpts::NameTransferType newOwnerNameTransfer) { /* When newOwner and oldOwner are the same, only the name transfer changed. */ if (newOwner == oldOwner) { return; } /* * Bus name matching rules must treat all aliases (well known names) they * resolve to as thesame, otherwise it would be relatively trivial to * bypass a rule specified with one alias by sending to either the * unique name or a different alias owned by the same owner with a * matching rule. Thus, we must keep track of who owns what * aliases. * * Because messages coming though will include either well known names or * unique names in the source or destination fields, we need to map each * unique name and alias to the set of equivalent aliases (plus unique * name). * * Here we take advantage of the fact that IDSet is a MangedObj and that * there is just one underlying instance. When a new node joins the bus * (alias == *newOwner), a new IDSet is created with the unique name of * the new node and that unique name is mapped to that new IDSet. When a * node gains ownership of an alias, the IDSet for the owner is updated * with the new alias and a mapping is created from the alias to that * IDSet. When a node loses ownership of an alias, that alias is removed * from the owner's IDSet and the mapping from that alias to the IDSet is * removed. When a node leaves (alias == *oldOwner), the unique name is * removed from the assiciated IDSet and the mapping from the unique name * to the IDSet is removed. Due to the nature of ManagedObj and that all * names are map keys to shared IDSets, it does not matter in what order * aliases/nodes are added or removed. */ StringID aliasID = LookupStringID(alias.c_str()); lock.WRLock(); if (oldOwner) { BusNameIDMap::iterator it = busNameIDMap.find(alias); if (it != busNameIDMap.end()) { QCC_DbgPrintf(("Remove %s{%d} from table for %s", alias.c_str(), aliasID, oldOwner->c_str())); it->second->erase(aliasID); busNameIDMap.erase(it); } else { QCC_LogError(ER_FAIL, ("Alias '%s' not in busNameIDMap", alias.c_str())); } } if (newOwner) { IDSet bnids; BusNameIDMap::iterator it = busNameIDMap.find(*newOwner); if (it != busNameIDMap.end()) { assert(alias != *newOwner); bnids = it->second; } if ((aliasID != ID_NOT_FOUND) && (aliasID != WILDCARD)) { QCC_DbgPrintf(("Add %s{%d} to table for %s", alias.c_str(), aliasID, newOwner->c_str())); bnids->insert(aliasID); } pair p(alias, bnids); busNameIDMap.insert(p); } lock.Unlock(); } #if defined(QCC_OS_GROUP_WINDOWS) #pragma warning(pop) #endif /** * Rule check macros. The rule check functions all operate in the same way * with the only difference being the arguments they take and what they check. * This macro is the simplest way to put all the boilerplate code into one * place. This is a case where macros work better than C++ templates and * varargs while avoiding a cumbersome callback mechanism. This is truely a * macro and not a macro that has function-like semantics. * * @param[out] _allow Whether the rule is an ALLOW or DENY rule * @param _rl The ruleList to iterate over * @param _it The name of the iterator variable to use (e.g. "it") * @param _checks The checks to perform * (e.g. "(it->CheckUser(uid) && it->CheckGroup(gid))") */ #ifndef NDEBUG #define RULE_CHECKS(_allow, _rl, _it, _checks) \ PolicyRuleList::const_reverse_iterator _it; \ bool ruleMatch = false; \ policydb::PolicyPermission permission = policydb::POLICY_DENY; \ size_t rc = 0; \ for (_it = _rl.rbegin(); !ruleMatch && (_it != _rl.rend()); ++_it) { \ ruleMatch = _checks; \ permission = _it->permission; \ QCC_DbgPrintf((" checking rule (%u/%u): %s - %s", \ _rl.size() - rc++, \ _rl.size(), \ _it->ruleString.c_str(), \ ruleMatch ? "MATCH" : "no match")); \ } \ if (ruleMatch) { \ _allow = (permission == policydb::POLICY_ALLOW); \ } \ return ruleMatch #else #define RULE_CHECKS(_allow, _rl, _it, _checks) \ PolicyRuleList::const_reverse_iterator _it; \ bool ruleMatch = false; \ policydb::PolicyPermission permission = policydb::POLICY_DENY; \ for (_it = _rl.rbegin(); !ruleMatch && (_it != _rl.rend()); ++_it) { \ ruleMatch = _checks; \ permission = _it->permission; \ } \ if (ruleMatch) { \ _allow = (permission == policydb::POLICY_ALLOW); \ } \ return ruleMatch #endif bool _PolicyDB::CheckConnect(bool& allow, const PolicyRuleList& ruleList, uint32_t uid, uint32_t gid) { RULE_CHECKS(allow, ruleList, it, (it->CheckUser(uid) && it->CheckGroup(gid))); } bool _PolicyDB::CheckOwn(bool& allow, const PolicyRuleList& ruleList, StringID bnid, const IDSet& prefixes) { RULE_CHECKS(allow, ruleList, it, it->CheckOwn(bnid, prefixes)); } bool _PolicyDB::CheckMessage(bool& allow, const PolicyRuleList& ruleList, const NormalizedMsgHdr& nmh, const IDSet& bnIDSet, uint32_t userId, uint32_t userId2, uint32_t groupId) { RULE_CHECKS(allow, ruleList, it, (it->CheckType(nmh.type) && it->CheckInterface(nmh.ifcID) && it->CheckMember(nmh.memberID) && it->CheckPath(nmh.pathID, nmh.pathIDSet) && it->CheckError(nmh.errorID) && it->CheckBusName(bnIDSet) && it->CheckUser(userId, userId2) && it->CheckGroup(groupId))); } bool _PolicyDB::OKToConnect(uint32_t uid, uint32_t gid) const { /* Implicitly default to allow any endpoint to connect. */ bool allow = true; bool ruleMatch = false; QCC_DbgPrintf(("Check if OK for endpoint with UserID %u and GroupID %u to connect", uid, gid)); if (!connectRS.mandatoryRules.empty()) { QCC_DbgPrintf((" checking mandatory connect rules")); ruleMatch = CheckConnect(allow, connectRS.mandatoryRules, uid, gid); } if (!ruleMatch) { IDRuleMap::const_iterator it = connectRS.userRules.find(uid); if (it != connectRS.userRules.end()) { QCC_DbgPrintf((" checking user=%u connect rules", uid)); ruleMatch = CheckConnect(allow, it->second, uid, gid); } } if (!ruleMatch) { IDRuleMap::const_iterator it = connectRS.groupRules.find(gid); if (it != connectRS.groupRules.end()) { QCC_DbgPrintf((" checking group=%u connect rules", gid)); ruleMatch = CheckConnect(allow, it->second, uid, gid); } } if (!ruleMatch) { QCC_DbgPrintf((" checking default connect rules")); ruleMatch = CheckConnect(allow, connectRS.defaultRules, uid, gid); } return allow; } bool _PolicyDB::OKToOwn(const char* busName, BusEndpoint& ep) const { if (!busName || busName[0] == '\0' || busName[0] == ':') { /* Can't claim ownership of a unique name, empty name, or a NULL pointer */ return false; } QCC_DbgPrintf(("Check if OK for endpoint %s to own %s{%d}", ep->GetUniqueName().c_str(), busName, LookupStringID(busName))); /* Implicitly default to allow any endpoint to own any name. */ bool allow = true; bool ruleMatch = false; StringID busNameID = LookupStringID(busName); IDSet prefixes = LookupStringIDPrefix(busName, '.'); if (!ownRS.mandatoryRules.empty()) { QCC_DbgPrintf((" checking mandatory own rules")); ruleMatch = CheckOwn(allow, ownRS.mandatoryRules, busNameID, prefixes); } if (!ruleMatch && !ownRS.userRules.empty()) { uint32_t uid = ep->GetUserId(); IDRuleMap::const_iterator it = ownRS.userRules.find(uid); if (it != ownRS.userRules.end()) { QCC_DbgPrintf((" checking user=%u own rules", uid)); ruleMatch = CheckOwn(allow, it->second, busNameID, prefixes); } } if (!ruleMatch && !ownRS.groupRules.empty()) { uint32_t gid = ep->GetGroupId(); IDRuleMap::const_iterator it = ownRS.groupRules.find(gid); if (it != ownRS.groupRules.end()) { QCC_DbgPrintf((" checking group=%u own rules", gid)); ruleMatch = CheckOwn(allow, it->second, busNameID, prefixes); } } if (!ruleMatch) { QCC_DbgPrintf((" checking default own rules")); ruleMatch = CheckOwn(allow, ownRS.defaultRules, busNameID, prefixes); } return allow; } bool _PolicyDB::OKToReceive(const NormalizedMsgHdr& nmh, BusEndpoint& dest) const { /* Implicitly default to allow all messages to be received. */ bool allow = true; bool ruleMatch = false; if (nmh.destIDSet->empty()) { /* * Broadcast/multicast signal - need to re-check send rules for each * destination. */ const IDSet destIDSet = LookupBusNameID(dest->GetUniqueName().c_str()); allow = OKToSend(nmh, dest, &destIDSet); if (!allow) { return false; } } QCC_DbgPrintf(("Check if OK for endpoint %s to receive %s (%s{%s} --> %s{%s})", dest->GetUniqueName().c_str(), nmh.msg->Description().c_str(), nmh.msg->GetSender(), IDSet2String(nmh.senderIDSet).c_str(), nmh.msg->GetDestination(), IDSet2String(nmh.destIDSet).c_str())); uint32_t senderUid = nmh.sender->GetUserId(); uint32_t senderGid = nmh.sender->GetGroupId(); uint32_t destUid = dest->GetUserId(); if (!receiveRS.mandatoryRules.empty()) { QCC_DbgPrintf((" checking mandatory receive rules")); ruleMatch = CheckMessage(allow, receiveRS.mandatoryRules, nmh, nmh.senderIDSet, senderUid, destUid, senderGid); } if (!ruleMatch && !receiveRS.userRules.empty()) { IDRuleMap::const_iterator it = receiveRS.userRules.find(destUid); if (it != receiveRS.userRules.end()) { QCC_DbgPrintf((" checking user=%u receive rules", destUid)); ruleMatch = CheckMessage(allow, it->second, nmh, nmh.senderIDSet, senderUid, destUid, senderGid); } } uint32_t gid = dest->GetGroupId(); if (!ruleMatch && !receiveRS.groupRules.empty()) { IDRuleMap::const_iterator it = receiveRS.groupRules.find(gid); if (it != receiveRS.groupRules.end()) { QCC_DbgPrintf((" checking group=%u receive rules", gid)); ruleMatch = CheckMessage(allow, it->second, nmh, nmh.senderIDSet, senderUid, destUid, senderGid); } } if (!ruleMatch) { QCC_DbgPrintf((" checking default receive rules")); ruleMatch = CheckMessage(allow, receiveRS.defaultRules, nmh, nmh.senderIDSet, senderUid, destUid, senderGid); } return allow; } bool _PolicyDB::OKToSend(const NormalizedMsgHdr& nmh, BusEndpoint& dest, const IDSet* destIDSet) const { /* Implicitly default to allow messages to be sent. */ bool allow = true; bool ruleMatch = false; if (!destIDSet) { destIDSet = &nmh.destIDSet; } QCC_DbgPrintf(("Check if OK for endpoint %s to send %s to destination %s (%s{%s} --> %s{%s})", nmh.sender->GetUniqueName().c_str(), nmh.msg->Description().c_str(), (dest->IsValid() ? dest->GetUniqueName().c_str() : ""), nmh.msg->GetSender(), IDSet2String(nmh.senderIDSet).c_str(), nmh.msg->GetDestination(), IDSet2String(*destIDSet).c_str())); uint32_t destUid = ((uint32_t)-1); uint32_t destGid = ((uint32_t)-1); if (dest->IsValid()) { destUid = dest->GetUserId(); destGid = dest->GetGroupId(); } uint32_t senderUid = nmh.sender->GetUserId(); if (!sendRS.mandatoryRules.empty()) { QCC_DbgPrintf((" checking mandatory send rules")); ruleMatch = CheckMessage(allow, sendRS.mandatoryRules, nmh, *destIDSet, destUid, senderUid, destGid); } if (!ruleMatch && !sendRS.userRules.empty()) { IDRuleMap::const_iterator it = sendRS.userRules.find(senderUid); if (it != sendRS.userRules.end()) { QCC_DbgPrintf((" checking user=%u send rules", senderUid)); ruleMatch = CheckMessage(allow, it->second, nmh, *destIDSet, destUid, senderUid, destGid); } } if (!ruleMatch && !sendRS.groupRules.empty()) { uint32_t gid = nmh.sender->GetGroupId(); IDRuleMap::const_iterator it = sendRS.groupRules.find(gid); if (it != sendRS.groupRules.end()) { QCC_DbgPrintf((" checking group=%u send rules", gid)); ruleMatch = CheckMessage(allow, it->second, nmh, *destIDSet, destUid, senderUid, destGid); } } if (!ruleMatch) { QCC_DbgPrintf((" checking default send rules")); ruleMatch = CheckMessage(allow, sendRS.defaultRules, nmh, *destIDSet, destUid, senderUid, destGid); } return allow; } alljoyn-15.04b/alljoyn_core/router/policydb/PolicyDB.h000066400000000000000000000505461255700255500230000ustar00rootroot00000000000000/** * @file * AllJoyn-Daemon Policy database class */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _POLICYDB_H #define _POLICYDB_H #include #include #include #include #include #include #include #include #include "Bus.h" #include "BusEndpoint.h" #include "NameTable.h" namespace ajn { namespace policydb { /** Enumeration of different types of policy groups */ enum PolicyCategory { POLICY_CONTEXT, /**< Policy group for either default or mandatory policies */ POLICY_USER, /**< Policy group that applies to specific users */ POLICY_GROUP /**< Policy group that applies to specific groups */ }; /** Enumeration of allow or deny policy rules */ enum PolicyPermission { POLICY_DENY, /**< Deny policy rule */ POLICY_ALLOW /**< Allow policy rule */ }; } class _PolicyDB; class NormalizedMsgHdr; /** * Managed object wrapper for policy database class. */ typedef qcc::ManagedObj<_PolicyDB> PolicyDB; /** * Normalized string ID type. */ typedef uint32_t StringID; /** * Real policy database class. */ class _PolicyDB { public: typedef qcc::ManagedObj > IDSet; /** * Constructor. */ _PolicyDB(); /** * Determine if the remote application running as the specified user and * group is allowed connect to the bus. * * @param uid Numeric user id * @param gid Numeric group id * * @return true = connection allowed, false = connection denied. */ bool OKToConnect(uint32_t uid, uint32_t gid) const; /** * Determine if the remote application is allowed to own the specified bus * name. * * @param busName Bus name requested * @param ep BusEndpoint requesting to own the busName * * @return true = ownership allowed, false = ownership denied. */ bool OKToOwn(const char* busName, BusEndpoint& ep) const; /** * Determine if the destination is allowed to receive the specified * message. * * @param nmh Normalized message header * @param dest BusEndpoint where the router intends to send the message * * @return true = receive allowed, false = receive denied. */ bool OKToReceive(const NormalizedMsgHdr& nmh, BusEndpoint& dest) const; /** * Determine if the sender is allowed to send the specified message. * * @param nmh Normalized message header * @param dest BusEndpoint where the router intends to send the message * @param destIDSet Alternate destination ID set (internal use only) * * @return true = send allowed, false = send denied. */ bool OKToSend(const NormalizedMsgHdr& nmh, BusEndpoint& dest, const IDSet* destIDSet = NULL) const; /** * Convert a string to a normalized form. * * @param key The string to be converted to a normalized form. * * @return Normalized ID of string. */ StringID LookupStringID(const char* key) const; /** * Generate a set of normalized prefixes for the given string. * * @param idStr The string to be converted to a set of normalized prefixes. * @param sep Separator character between prefix segments * * @return Set of normalized prefix IDs of the string. */ const IDSet LookupStringIDPrefix(const char* idStr, char sep) const; /** * Convert a bus name to a normalized form. * * @param busName The bus name to be converted to a normalized form. * * @return Set of equivalent bus name IDs */ const IDSet LookupBusNameID(const char* busName) const; void NameOwnerChanged(const qcc::String& alias, const qcc::String* oldOwner, SessionOpts::NameTransferType oldOwnerNameTransfer, const qcc::String* newOwner, SessionOpts::NameTransferType newOwnerNameTransfer); /** * Adds a rule to the Policy database. * * @param cat Policy category * @param catValue Policy category differentiator (possible values depend on category) * @param permstr Either "allow" or "deny" * @param ruleAttrs Set of Key-Value pairs defining rule match criteria * * @return true = rule added successfully, false = failed to add rule */ bool AddRule(const qcc::String& cat, const qcc::String& catValue, const qcc::String& permStr, const std::map& ruleAttrs); /** * Helper function to Finalize() for repopulating busNameIDMap. * * @param alias Bus name alias * @param name Bus name */ void AddAlias(const qcc::String& alias, const qcc::String& name); /** * This performs final policy setup after all of the rules have been * added. It ensures that the Bus Name ID Map gets pre-populated based on * the contents of the NameTable in the event that the configuration was * reloaded some time after startup. */ void Finalize(Bus* bus); private: static const StringID ID_NOT_FOUND = 0xffffffff; /**< constant for string not found */ static const StringID NIL_MATCH = 0xfffffffe; /**< unmatchable string id */ static const StringID WILDCARD = 0x0; /**< match everything string id */ /** * Container for all the matching criteria for a rule. */ class PolicyRule { public: policydb::PolicyPermission permission; /**< allow or deny rule */ StringID interface; /**< normalized interface name */ StringID member; /**< normalized member name */ StringID error; /**< normalized error name */ StringID busName; /**< normalized well known bus name */ AllJoynMessageType type; /**< message type */ StringID path; /**< normalized object path */ StringID pathPrefix; /**< normalized object path prefix */ StringID own; /**< normalized well known bus name for ownership purposes */ StringID ownPrefix; /**< normalized well known bus name prefix for ownership purposes */ bool userSet; /**< indicates if user has been set */ bool userAny; /**< indicates if user has been set to "*" */ bool usersEqualSet; /**< indicates if we should compare the sender and receiver users instead of to a static user ID */ bool usersEqual; /**< indicates if the rule should apply when users are equal or when they are not equal */ uint32_t user; /**< numeric user id */ bool groupSet; /**< indicates if group has been set */ bool groupAny; /**< indicates if group has been set to "*" */ uint32_t group; /**< numeric group id */ #if !defined(NDEBUG) || defined(QCC_OS_GROUP_WINDOWS) qcc::String ruleString; /**< regenerated xml rule string for debugging purposes */ #endif /** * Constructor. * * @param permission Allow or deny permission for the rule being created */ PolicyRule(policydb::PolicyPermission permission) : permission(permission), interface(WILDCARD), member(WILDCARD), error(WILDCARD), busName(WILDCARD), type(MESSAGE_INVALID), path(WILDCARD), pathPrefix(WILDCARD), own(WILDCARD), ownPrefix(WILDCARD), userSet(false), userAny(false), usersEqualSet(false), usersEqual(false), user(((uint32_t)-1)), groupSet(false), groupAny(false), group(((uint32_t)-1)) { } /** * Check if interface name matches. * * @param other Normalized interface name for comparision * * @return true = matches, false = does not match */ inline bool CheckInterface(StringID other) const { /* Interface names are optional in messages and the documentation * of dbus-daemon suggests that such messages always match where * the interface is concerned; thus '(other == WILDCARD)' returns * 'true'. */ return ((interface == WILDCARD) || (other == WILDCARD) || (interface == other)); } /** * Check if member name matches. * * @param other Normalized member name for comparision * * @return true = matches, false = does not match */ inline bool CheckMember(StringID other) const { return ((member == WILDCARD) || (member == other)); } /** * Check if error name matches. * * @param other Normalized error name for comparision * * @return true = matches, false = does not match */ inline bool CheckError(StringID other) const { return ((error == WILDCARD) || (error == other)); } /** * Check if bus name matches. * * @param other Normalized bus name for comparision * * @return true = matches, false = does not match */ inline bool CheckBusName(const IDSet& bnIDSet) const { return ((busName == WILDCARD) || (bnIDSet->find(busName) != bnIDSet->end())); } /** * Check if type matches. * * @param other Normalized type for comparision * * @return true = matches, false = does not match */ inline bool CheckType(AllJoynMessageType other) const { return ((type == MESSAGE_INVALID) || (type == other)); } /** * Check if object path matches. * * @param other Normalized object path for comparision * * @return true = matches, false = does not match */ inline bool CheckPath(StringID other, const _PolicyDB::IDSet& prefixes) const { return (((path == WILDCARD) || (path == other)) && ((pathPrefix == WILDCARD) || (prefixes->find(pathPrefix) != prefixes->end()))); } /** * Check if bus name matches for ownership rule. * * @param other Normalized bus name for comparision * @param prefixes Normalized bus name prefixes for comparision * * @return true = matches, false = does not match */ inline bool CheckOwn(StringID other, const _PolicyDB::IDSet& prefixes) const { return (((own == WILDCARD) || (own == other)) && ((ownPrefix == WILDCARD) || (prefixes->find(ownPrefix) != prefixes->end()))); } /** * Check if user ID matches. * * @param user1 Numerical user id for comparision * @param user2 Numerical user id of the second user for a usersEqual comparison * * @return true = matches, false = does not match */ inline bool CheckUser(StringID user1, StringID user2 = static_cast(-1)) const { if (userSet == true) { return userAny || (user == user1); } else if (usersEqualSet == true) { return (user1 == user2) == usersEqual; } else { return true; } } /** * Check if group ID matches. * * @param other Numerical group id for comparision * * @return true = matches, false = does not match */ inline bool CheckGroup(StringID other) const { return (!groupSet || groupAny || (group == other)); } }; typedef std::list PolicyRuleList; /**< Policy rule list typedef */ typedef std::unordered_map IDRuleMap; /**< UID/GID Rule map typedef */ /** * Collection of policy rules for each category. */ struct PolicyRuleListSet { PolicyRuleList defaultRules; /**< default rules */ IDRuleMap groupRules; /**< group rules on a per group id basis */ IDRuleMap userRules; /**< user rules on a per user id basis */ PolicyRuleList mandatoryRules; /**< mandatory rules */ }; /** typedef for mapping a string to a numerical value for normalization */ typedef std::unordered_map StringIDMap; /** typedef for mapping a string to a numerical value for normalization */ typedef std::unordered_map BusNameIDMap; /** * Adds rules to specific rule sets. Called by public AddRule to add * rules to rulesets from the appropriate policy category. * * @param ownList [OUT] ownership rule set to be filled * @param sendList [OUT] sender rule set to be filled * @param receiveList [OUT] receiver rule set to be filled * @param connectList [OUT] connection rule set to be filled * @param permission allow or deny rule * @param ruleAttrs Set of Key-Value pairs defining rule match criteria */ bool AddRule(PolicyRuleList& ownList, PolicyRuleList& connectList, PolicyRuleList& sendList, PolicyRuleList& receiveList, policydb::PolicyPermission permission, const std::map& ruleAttrs); /** * Get a normalized string ID for the specified string. If string is * empty, the returned ID will be NIL_MATCH. If the string is not empty * and has not been seen before a new ID number will be assigned to that * string. If the string is not empty and has been seen before, the ID * previously assigned to that string will be returned. * * @param key string to be normalized into an ID number * * @return The strings normalization ID number. */ StringID UpdateDictionary(const qcc::String& key); /** * Check rule list for rule about connecting. * * @param allow [OUT] true for "allow" rule, false for "deny" rule * @param ruleList rule list to search for match * @param uid numeric user ID * @param gid numeric group ID * * @return true if match found, false if match not found */ static bool CheckConnect(bool& allow, const PolicyRuleList& ruleList, uint32_t uid, uint32_t gid); /** * Check rule list for rule about owning a bus name. * * @param allow [OUT] true for "allow" rule, false for "deny" rule * @param ruleList rule list to search for match * @param bnid normalized bus name ID * @param prefixes normalized set of bus name prefix IDs * * @return true if match found, false if match not found */ static bool CheckOwn(bool& allow, const PolicyRuleList& ruleList, StringID bnid, const IDSet& prefixes); /** * Check rule list for rule about message. * * @param allow [OUT] true for "allow" rule, false for "deny" rule * @param ruleList rule list to search for match * @param nmh normalized message header * @param bnIDSet set of normalized bus names * * @return true if match found, false if match not found */ static bool CheckMessage(bool& allow, const PolicyRuleList& ruleList, const NormalizedMsgHdr& nmh, const IDSet& bnIDSet, uint32_t userId, uint32_t userId2, uint32_t groupId); PolicyRuleListSet ownRS; /**< bus name ownership policy rule sets */ PolicyRuleListSet sendRS; /**< sender message policy rule sets */ PolicyRuleListSet receiveRS; /**< receiver message policy rule sets */ PolicyRuleListSet connectRS; /**< bus connect policy rule sets */ StringIDMap dictionary; /**< mapping of strings to normalized IDs */ BusNameIDMap busNameIDMap; /**< mapping of bus names to a set of equivalent IDs */ mutable qcc::RWLock lock; /**< rwlock to protect R/W contention */ friend class NormalizedMsgHdr; }; /** * This class converts and stores a message's header information in a form * that allows for very fast lookup in unordered_map<>'s. */ class NormalizedMsgHdr { public: /** * This constructor converts a message header into a normalized form * based on information in the policy rules for very fast lookup. * * @param msg Reference to the message to be normalized * @param policy Pointer to the PolicyDB */ NormalizedMsgHdr(const Message& msg, const PolicyDB& policy, BusEndpoint& sender) : #if !defined(NDEBUG) || defined(QCC_OS_GROUP_WINDOWS) msg(msg), #endif ifcID(policy->LookupStringID(msg->GetInterface())), memberID(policy->LookupStringID(msg->GetMemberName())), errorID(policy->LookupStringID(msg->GetErrorName())), pathID(policy->LookupStringID(msg->GetObjectPath())), pathIDSet(policy->LookupStringIDPrefix(msg->GetObjectPath(), '/')), destIDSet(policy->LookupBusNameID(msg->GetDestination())), senderIDSet(policy->LookupBusNameID(msg->GetSender())), type(msg->GetType()), sender(sender) { if (destIDSet->empty()) { const char* destStr = msg->GetDestination(); // GetDestination() will return an empty string if there is no destination if (destStr[0] != '\0') { StringID nid = policy->LookupStringID(destStr); if (nid != _PolicyDB::ID_NOT_FOUND) { destIDSet->insert(nid); } } } if (senderIDSet->empty()) { const char* senderStr = msg->GetSender(); // GetSender() will return an empty string if there is no sender if (senderStr[0] != '\0') { StringID nid = policy->LookupStringID(senderStr); if (nid != _PolicyDB::ID_NOT_FOUND) { senderIDSet->insert(nid); } } } } private: friend class _PolicyDB; /**< Give PolicyDB access to the internals */ /* private copy constructor */ NormalizedMsgHdr(const NormalizedMsgHdr&); /* private assignment operator */ NormalizedMsgHdr operator=(const NormalizedMsgHdr&); #if !defined(NDEBUG) || defined(QCC_OS_GROUP_WINDOWS) const Message msg; /**< Reference to original message for debug purposes */ #endif StringID ifcID; /**< normalized interface name */ StringID memberID; /**< normalized member name */ StringID errorID; /**< normalized error name */ StringID pathID; /**< normalized object path */ const _PolicyDB::IDSet pathIDSet; /**< set of normalized object path prefixes */ _PolicyDB::IDSet destIDSet; /**< set of normalized well known bus name destinations */ _PolicyDB::IDSet senderIDSet; /**< set of normalized well known bus name senders */ AllJoynMessageType type; /**< message type */ BusEndpoint& sender; /**< sender bus endpoint */ }; } #endif alljoyn-15.04b/alljoyn_core/router/posix/000077500000000000000000000000001255700255500205055ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/router/posix/DaemonTransportPosix.cc000066400000000000000000000307611255700255500251660ustar00rootroot00000000000000/** * @file * UnixTransport is an implementation of Transport that listens * on an AF_UNIX socket. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #include #include #include "BusInternal.h" #include "ConfigDB.h" #include "RemoteEndpoint.h" #include "Router.h" #include "DaemonTransport.h" #ifdef ENABLE_POLICYDB #include "PolicyDB.h" #endif #define QCC_MODULE "ALLJOYN" using namespace std; using namespace qcc; namespace ajn { const char* DaemonTransport::TransportName = "unix"; class _DaemonEndpoint; typedef qcc::ManagedObj<_DaemonEndpoint> DaemonEndpoint; /* * An endpoint class to handle the details of authenticating a connection in * the Unix Domain Sockets way. */ class _DaemonEndpoint : public _RemoteEndpoint { public: _DaemonEndpoint(DaemonTransport* transport, BusAttachment& bus, bool incoming, const qcc::String connectSpec, SocketFd sock) : _RemoteEndpoint(bus, incoming, connectSpec, &stream, DaemonTransport::TransportName), m_transport(transport), processId(-1), stream(sock) { } ~_DaemonEndpoint() { } /** * Set the process id of the endpoint. * * @param processId Process ID number. */ void SetProcessId(uint32_t processId) { this->processId = processId; } /** * Return the process id of the endpoint. * * @return Process ID number. */ uint32_t GetProcessId() const { return processId; } /** * Indicates if the endpoint supports reporting UNIX style user, group, and process IDs. * * @return 'true' if UNIX IDs supported, 'false' if not supported. */ bool SupportsUnixIDs() const { return true; } QStatus SetIdleTimeouts(uint32_t& reqIdleTimeout, uint32_t& reqProbeTimeout) { uint32_t maxIdleProbes = m_transport->m_numHbeatProbes; /* If reqProbeTimeout == 0, Make no change to Probe timeout. */ if (reqProbeTimeout == 0) { reqProbeTimeout = _RemoteEndpoint::GetProbeTimeout(); } else if (reqProbeTimeout > m_transport->m_maxHbeatProbeTimeout) { /* Max allowed Probe timeout is m_maxHbeatProbeTimeout */ reqProbeTimeout = m_transport->m_maxHbeatProbeTimeout; } /* If reqIdleTimeout == 0, Make no change to Idle timeout. */ if (reqIdleTimeout == 0) { reqIdleTimeout = _RemoteEndpoint::GetIdleTimeout(); } /* Requested link timeout must be >= m_minHbeatIdleTimeout */ if (reqIdleTimeout < m_transport->m_minHbeatIdleTimeout) { reqIdleTimeout = m_transport->m_minHbeatIdleTimeout; } /* Requested link timeout must be <= m_maxHbeatIdleTimeout */ if (reqIdleTimeout > m_transport->m_maxHbeatIdleTimeout) { reqIdleTimeout = m_transport->m_maxHbeatIdleTimeout; } return _RemoteEndpoint::SetIdleTimeouts(reqIdleTimeout, reqProbeTimeout, maxIdleProbes); } private: DaemonTransport* m_transport; /**< The DaemonTransport holding the connection */ uint32_t processId; SocketStream stream; }; static const int CRED_TIMEOUT = 5000; /**< Times out credentials exchange to avoid denial of service attack */ static QStatus GetSocketCreds(SocketFd sockFd, uid_t* uid, gid_t* gid, pid_t* pid) { QStatus status = ER_OK; #if defined(QCC_OS_DARWIN) *pid = 0; int ret = getpeereid(sockFd, uid, gid); if (ret == -1) { status = ER_OS_ERROR; qcc::Close(sockFd); } #else int enableCred = 1; int ret = setsockopt(sockFd, SOL_SOCKET, SO_PASSCRED, &enableCred, sizeof(enableCred)); if (ret == -1) { status = ER_OS_ERROR; qcc::Close(sockFd); } if (status == ER_OK) { qcc::String authName; ssize_t ret; char nulbuf = 255; struct cmsghdr* cmsg; struct iovec iov[] = { { &nulbuf, sizeof(nulbuf) } }; struct msghdr msg; char cbuf[CMSG_SPACE(sizeof(struct ucred))]; msg.msg_name = NULL; msg.msg_namelen = 0; msg.msg_iov = iov; msg.msg_iovlen = ArraySize(iov); msg.msg_flags = 0; msg.msg_control = cbuf; msg.msg_controllen = CMSG_LEN(sizeof(struct ucred)); while (true) { ret = recvmsg(sockFd, &msg, 0); if (ret == -1) { if (errno == EWOULDBLOCK) { qcc::Event event(sockFd, qcc::Event::IO_READ); status = Event::Wait(event, CRED_TIMEOUT); if (status != ER_OK) { QCC_LogError(status, ("Credentials exhange timeout")); break; } } else { break; } } else { break; } } if ((ret != 1) && (nulbuf != 0)) { qcc::Close(sockFd); status = ER_READ_ERROR; } if (status == ER_OK) { for (cmsg = CMSG_FIRSTHDR(&msg); cmsg != NULL; cmsg = CMSG_NXTHDR(&msg, cmsg)) { if ((cmsg->cmsg_level == SOL_SOCKET) && (cmsg->cmsg_type == SCM_CREDENTIALS)) { struct ucred* cred = reinterpret_cast(CMSG_DATA(cmsg)); *uid = cred->uid; *gid = cred->gid; *pid = cred->pid; QCC_DbgHLPrintf(("Received UID: %u GID: %u PID %u", cred->uid, cred->gid, cred->pid)); } } } } #endif return status; } void* DaemonTransport::Run(void* arg) { SocketFd listenFd = (SocketFd)(ptrdiff_t)arg; QStatus status = ER_OK; Event listenEvent(listenFd, Event::IO_READ); while (!IsStopping()) { status = Event::Wait(listenEvent); if (status != ER_OK) { if (status != ER_STOPPING_THREAD) { QCC_LogError(status, ("Event::Wait failed")); } break; } SocketFd newSock; status = Accept(listenFd, newSock); uid_t uid = -1; // Initialize to suppress compiler warnings. gid_t gid = -1; pid_t pid = -1; if (status == ER_OK) { status = GetSocketCreds(newSock, &uid, &gid, &pid); } #ifdef ENABLE_POLICYDB PolicyDB policyDB = ConfigDB::GetConfigDB()->GetPolicyDB(); if (status == ER_OK && !policyDB->OKToConnect(uid, gid)) { Close(newSock); status = ER_BUS_POLICY_VIOLATION; } #endif if (status == ER_OK) { qcc::String authName; qcc::String redirection; static const bool truthiness = true; DaemonTransport* trans = this; DaemonEndpoint conn = DaemonEndpoint(trans, bus, truthiness, DaemonTransport::TransportName, newSock); conn->SetUserId(uid); conn->SetGroupId(gid); conn->SetProcessId(pid); /* Initialized the features for this endpoint */ conn->GetFeatures().isBusToBus = false; conn->GetFeatures().allowRemote = false; conn->GetFeatures().handlePassing = true; endpointListLock.Lock(MUTEX_CONTEXT); endpointList.push_back(RemoteEndpoint::cast(conn)); endpointListLock.Unlock(MUTEX_CONTEXT); status = conn->Establish("EXTERNAL", authName, redirection); if (status == ER_OK) { conn->SetListener(this); status = conn->Start(m_defaultHbeatIdleTimeout, m_defaultHbeatProbeTimeout, m_numHbeatProbes, m_maxHbeatProbeTimeout); } if (status != ER_OK) { QCC_LogError(status, ("Error starting RemoteEndpoint")); endpointListLock.Lock(MUTEX_CONTEXT); list::iterator ei = find(endpointList.begin(), endpointList.end(), RemoteEndpoint::cast(conn)); if (ei != endpointList.end()) { endpointList.erase(ei); } endpointListLock.Unlock(MUTEX_CONTEXT); } } else if (ER_WOULDBLOCK == status || ER_READ_ERROR == status) { status = ER_OK; } if (status != ER_OK) { QCC_LogError(status, ("Error accepting new connection. Ignoring...")); } } qcc::Close(listenFd); QCC_DbgPrintf(("DaemonTransport::Run is exiting status=%s\n", QCC_StatusText(status))); return (void*) status; } QStatus DaemonTransport::NormalizeTransportSpec(const char* inSpec, qcc::String& outSpec, map& argMap) const { QStatus status = ParseArguments(DaemonTransport::TransportName, inSpec, argMap); qcc::String path = Trim(argMap["path"]); qcc::String abstract = Trim(argMap["abstract"]); if (status == ER_OK) { outSpec = "unix:"; if (!path.empty()) { outSpec.append("path="); outSpec.append(path); argMap["_spec"] = path; } else if (!abstract.empty()) { outSpec.append("abstract="); outSpec.append(abstract); argMap["_spec"] = qcc::String("@") + abstract; } else { status = ER_BUS_BAD_TRANSPORT_ARGS; } } return status; } static QStatus ListenFd(map& serverArgs, SocketFd& listenFd) { QStatus status = Socket(QCC_AF_UNIX, QCC_SOCK_STREAM, listenFd); if (status != ER_OK) { QCC_LogError(status, ("DaemonTransport::ListenFd(): Socket() failed")); return status; } /* Calculate bindAddr */ qcc::String bindAddr; if (status == ER_OK) { if (!serverArgs["path"].empty()) { bindAddr = serverArgs["path"]; } else if (!serverArgs["abstract"].empty()) { bindAddr = qcc::String("@") + serverArgs["abstract"]; } else { status = ER_BUS_BAD_TRANSPORT_ARGS; QCC_LogError(status, ("DaemonTransport::ListenFd(): Invalid listen spec for unix transport")); return status; } } /* * Bind the socket to the listen address and start listening for incoming * connections on it. */ status = Bind(listenFd, bindAddr.c_str()); if (status != ER_OK) { QCC_LogError(status, ("DaemonTransport::ListenFd(): Bind() failed")); } else { status = qcc::Listen(listenFd, 0); if (status == ER_OK) { QCC_DbgPrintf(("DaemonTransport::ListenFd(): Listening on %s", bindAddr.c_str())); } else { QCC_LogError(status, ("DaemonTransport::ListenFd(): Listen failed")); } } return status; } QStatus DaemonTransport::StartListen(const char* listenSpec) { if (stopping == true) { return ER_BUS_TRANSPORT_NOT_STARTED; } if (IsRunning()) { return ER_BUS_ALREADY_LISTENING; } /* Normalize the listen spec. */ QStatus status; qcc::String normSpec; map serverArgs; status = NormalizeTransportSpec(listenSpec, normSpec, serverArgs); if (status != ER_OK) { QCC_LogError(status, ("DaemonTransport::StartListen(): Invalid Unix listen spec \"%s\"", listenSpec)); return status; } SocketFd listenFd = qcc::INVALID_SOCKET_FD; status = ListenFd(serverArgs, listenFd); if (status == ER_OK) { status = Thread::Start((void*)(intptr_t)listenFd); } if ((listenFd != qcc::INVALID_SOCKET_FD) && (status != ER_OK)) { qcc::Close(listenFd); } return status; } QStatus DaemonTransport::StopListen(const char* listenSpec) { return Thread::Stop(); } } // namespace ajn alljoyn-15.04b/alljoyn_core/router/posix/PermissionMgrPosix.cc000066400000000000000000000032251255700255500246370ustar00rootroot00000000000000/** * @file * This class is to manage the permission of an endpoint on using transports or invoking method/signal calls on another peer */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include "PermissionMgr.h" #include #define QCC_MODULE "PERMISSION_MGR" namespace ajn { QStatus TransportPermission::FilterTransports(BusEndpoint& srcEp, const qcc::String& sender, TransportMask& transports, const char* callerName) { return ER_OK; } uint32_t PermissionMgr::AddAliasUnixUser(BusEndpoint& srcEp, qcc::String& sender, uint32_t origUID, uint32_t aliasUID) { return ALLJOYN_ALIASUNIXUSER_REPLY_NO_SUPPORT; } QStatus PermissionMgr::CleanPermissionCache(BusEndpoint& endpoint) { return ER_OK; } } // namespace ajn { alljoyn-15.04b/alljoyn_core/router/posix/SConscript000066400000000000000000000031661255700255500225250ustar00rootroot00000000000000# Copyright AllSeen Alliance. All rights reserved. # # Permission to use, copy, modify, and/or distribute this software for any # purpose with or without fee is hereby granted, provided that the above # copyright notice and this permission notice appear in all copies. # # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. # Import('router_env', 'router_objs', 'srobj') # Build the posix daemon and service launcher helper. if router_env['OS'] != 'darwin': daemon_env = router_env.Clone() if daemon_env['OS'] != 'android': daemon_env.Append(LIBS = 'cap') daemon = daemon_env.Program('alljoyn-daemon', ['daemon-main.cc'] + srobj + router_objs) else: daemon = [] # # On Android, build a static library that can be linked into a JNI dynamic # library to implement the daemon as a Service # if router_env['OS'] == 'android': libenv = router_env.Clone(CCFLAGS = '-DROUTER_LIB') libenv.Object(target = 'alljoyn-daemon', source = 'daemon-main.cc') libdaemon = libenv.StaticLibrary(['alljoyn-daemon'] + srobj + router_objs) dlibs = libenv.Install('$CPP_DISTDIR/lib', libdaemon) #progs = daemon + servicehelper progs = daemon Return('progs') alljoyn-15.04b/alljoyn_core/router/posix/ScatterGatherList.h000066400000000000000000000412611255700255500242560ustar00rootroot00000000000000/** * @file * * Define a scatter-gather list class. */ /****************************************************************************** * * * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _QCC_SCATTERGATHERLIST_H #define _QCC_SCATTERGATHERLIST_H #include #include #include #include #include #include #include #include #define QCC_MODULE "NETWORK" namespace qcc { /** * Classes that need to add an internal buffer to a scatter-gather list should * inherit this class and implement the interface functions. */ class ScatterGatherList { public: /// Define the type of dereferenced iterators. typedef IOVec type_value; /// iterator typedef. typedef std::list::iterator iterator; /// const_iterator typedef. typedef std::list::const_iterator const_iterator; private: std::list sg; ///< Collection of buffers and associated buffer lengths. size_t maxDataSize; ///< Maximum data that can be held in the SG buffers. size_t dataSize; ///< Amount of data currently held in the SG buffers. public: ScatterGatherList(void) : maxDataSize(0), dataSize(0) { } /** * Copy constructor. Note: this only copies the pointers to the buffers * and buffer lengths; it does not copy the data in the buffers. * * @param other The ScatterGatherList to intialize from. */ ScatterGatherList(const ScatterGatherList& other) : sg(other.sg), maxDataSize(other.maxDataSize), dataSize(other.dataSize) { } /** * Assignment operator. Note: this only copies the pointers to the buffers * and buffer lengths; it does not copy the data in the buffers. * * @param other The ScatterGatherList to intialize from. * * @return Reference to *this. */ ScatterGatherList& operator=(const ScatterGatherList& other) { QCC_DbgTrace(("ScatterGatherList::operator=(other) [maxDataSize = %u dataSize = %u]", other.maxDataSize, other.dataSize)); sg = other.sg; maxDataSize = other.maxDataSize; dataSize = other.dataSize; return *this; } /** * Add a buffer to the scatter-gather list. * * @param buffer Buffer to be added to the list. * @param length Length of the buffer. */ void AddBuffer(void* buffer, size_t length) { maxDataSize += length; QCC_DbgTrace(("ScatterGatherList::AddBuffer(buffer, length = %u) [maxDataSize = %u]", length, maxDataSize)); if (Size() == 0) { IOVec iov; iov.buf = buffer; iov.len = length; sg.push_back(iov); } else { if (!sg.empty()) { IOVec& last = sg.back(); if (reinterpret_cast(last.buf) + last.len == buffer) { last.len += length; } else { IOVec iov; iov.buf = buffer; iov.len = length; sg.push_back(iov); } } else { IOVec iov; iov.buf = buffer; iov.len = length; sg.push_back(iov); } } } /** * @overload * The underlying C structure is used for both const and non-const SG * lists so this version casts away the const-ness. Be careful to not mix * up sending and receiving. * * @param buffer Buffer to be added to the list. * @param length Length of the buffer. */ void AddBuffer(const void* buffer, size_t length) { AddBuffer(const_cast(buffer), length); } /** * Add the entries from one list to this list. * * @param other The SG list to get entries from. */ void AddSG(const ScatterGatherList& other) { AddSG(other.Begin(), other.End()); } /** * @overload * This version takes const iterators an so can be used to add just a * subset of another SG list. * * @param begin Beginning of the SG list to get buffers from. * @param end End of the SG list to get buffers from. */ void AddSG(const_iterator begin, const_iterator end) { const_iterator iter; for (iter = begin; iter != end; ++iter) { AddBuffer(iter->buf, iter->len); } } /** * Get an interator referencing the beginning of the scatter-gather list. * * @return An interator referencing the beginning of the scatter-gather list. */ iterator Begin(void) { return sg.begin(); } /** * Get a const interator referencing the beginning of the scatter-gather * list. * * @return A const interator referencing the beginning of the * scatter-gather list. */ const_iterator Begin(void) const { return sg.begin(); } /** * Get an interator referencing the end of the scatter-gather list. * * @return An interator referencing the end of the scatter-gather list. */ iterator End(void) { return sg.end(); } /** * Get a const interator referencing the end of the scatter-gather list. * * @return A const interator referencing the end of the scatter-gather list. */ const_iterator End(void) const { return sg.end(); } /** * This removes the specifed entry from the scatter-gather list. * * @param i Iterator referencing the element to be removed. */ void Erase(iterator& i) { maxDataSize -= i->len; dataSize -= (std::min)(dataSize, (size_t)(i->len)); sg.erase(i); } /** * Clear out the list of SG entries. */ void Clear(void) { QCC_DbgTrace(("ScatterGatherList::Clear()")); sg.clear(); maxDataSize = 0; dataSize = 0; } /** * Return the number of entries in the scatter-gather list. * * @return Number of elements in the scatter-gather list. */ size_t Size(void) const { return sg.size(); } /** * Get the amount of space used among the buffers in the SG list. This * value is only valid if SetDataSize was used or the data was copied from * a source with a known data size. * * @return Number of octets of actual data in the SG list. */ size_t DataSize(void) const { return dataSize; } /** * Get the amount of space available among the buffers in the SG list. * * @return Number of octets of available space in the SG list. */ size_t MaxDataSize(void) const { return maxDataSize; } /** * Sets the amount of space used by data in the SG List. The copy * operations depend on this value being accurate. * * @param newSize Number of octets used. */ void SetDataSize(size_t newSize) { QCC_DbgTrace(("ScatterGatherList::SetDataSize(newSize = %u)", newSize)); dataSize = newSize; } /** * Increments the amount of space used by data in the SG List. The copy * operations depend on this value being accurate. * * @param newSize Number of octets used. */ void IncDataSize(size_t increment) { QCC_DbgTrace(("ScatterGatherList::IncDataSize(increment = %u)", increment)); dataSize += increment; } /** * Copies the data from another SG list into this list. The underlying * implementation uses memmove to avoid problems with overlapping memory. * Only the lesser of this->DataSize() or other.DataSize() bytes will be * copied. * * @param other The SG list to copy data from; * @param limit [optional] Limits the number octets to copy (default is all). * * @return Number of octets copied. */ size_t CopyDataFrom(const ScatterGatherList& other, size_t limit = ~0) { return CopyDataFrom(other.Begin(), other.End(), (std::min)(limit, other.DataSize())); } /** * @overload * This version uses iterators instead of a SG list. * * @param begin Beginig of the SG list to copy. * @param end End of the SG list to copy. * @param limit This limits the amount of data to be copied (defaults to all data). * * @return Number of octets copied. */ size_t CopyDataFrom(const_iterator begin, const_iterator end, size_t limit = ~0) { if (sg.empty() || (begin == end)) { return 0; } iterator dest(sg.begin()); const_iterator src(begin); uint8_t* srcBuf = reinterpret_cast(src->buf); uint8_t* destBuf = reinterpret_cast(dest->buf); size_t srcLen = src->len; size_t destLen = dest->len; size_t copyCnt = 0; size_t copyLimit = std::min(maxDataSize, limit); QCC_DbgTrace(("ScatterGatherList::CopyDataFrom(begin, end, limit = %u)", limit)); QCC_DbgPrintf(("srcLen = %u destLen = %u copyLimit = %u", srcLen, destLen, copyLimit)); while (copyLimit > 0 && dest != sg.end() && src != end) { size_t copyLen = std::min(copyLimit, std::min(destLen, srcLen)); QCC_DbgPrintf(("srcLen = %u destLen = %u copyLimit = %u copyLen = %u", srcLen, destLen, copyLimit, copyLen)); memmove(destBuf, srcBuf, copyLen); copyCnt += copyLen; copyLimit -= copyLen; if (copyLen == destLen) { ++dest; if (dest != sg.end()) { destBuf = reinterpret_cast(dest->buf); destLen = dest->len; } } else { destBuf += copyLen; destLen -= copyLen; } if (copyLen == srcLen) { ++src; if (src != end) { srcBuf = reinterpret_cast(src->buf); srcLen = src->len; } } else { srcBuf += copyLen; srcLen -= copyLen; } } dataSize = copyCnt; return copyCnt; } /** * Copies data from the SG list to a buffer. It will copy at most bufSize * or this->DataSize() octets. * * @param buf Buffer where data will be copied to. * @param bufSize Size of the buffer. * * @return Number of octets copied. */ size_t CopyToBuffer(void* buf, size_t bufSize) const { const_iterator src(sg.begin()); uint8_t* pos = reinterpret_cast(buf); size_t copyCnt = (std::min)(bufSize, dataSize); QCC_DbgTrace(("ScatterGatherList::CopyToBuffer(*buf, bufSize = %u)", bufSize)); QCC_DbgPrintf(("bufSize = %u dataSize = %u copyCnt = %u", bufSize, dataSize, copyCnt)); assert(buf != NULL); while (copyCnt > 0 && src != sg.end()) { size_t copyLen = (std::min)(copyCnt, (size_t)(src->len)); memmove(pos, src->buf, copyLen); if (copyLen == src->len) { ++src; } copyCnt -= copyLen; QCC_DbgPrintf(("Copied %u bytes (%u left)", copyLen, copyCnt)); QCC_DbgLocalData(pos, copyLen); pos += copyLen; } return (std::min)(bufSize, dataSize); } /** * Copies data to the SG list from a buffer. It will copy at most bufSize * or this->DataSize() octets. * * @param buf Buffer where data will be copied from. * @param bufSize Size of the buffer. * * @return Number of octets copied. */ size_t CopyFromBuffer(const void* buf, size_t bufSize) { iterator dest(sg.begin()); const uint8_t* pos = reinterpret_cast(buf); size_t copyCnt = (std::min)(bufSize, maxDataSize); QCC_DbgTrace(("ScatterGatherList::CopyFromBuffer(*buf, bufSize = %u)", bufSize)); QCC_DbgPrintf(("bufSize = %u maxDataSize = %u copyCnt = %u", bufSize, maxDataSize, copyCnt)); assert(buf != NULL); while (copyCnt > 0 && dest != sg.end()) { size_t copyLen = (std::min)(copyCnt, static_cast(dest->len)); memmove(dest->buf, pos, copyLen); if (copyLen == dest->len) { ++dest; } copyCnt -= copyLen; QCC_DbgPrintf(("Copied %u bytes (%u left)", copyLen, copyCnt)); pos += copyLen; } dataSize = static_cast(pos - reinterpret_cast(buf)); return dataSize; } /** * This alters the SG list by removing buffers and/or adjusting the * pointer to the resulting first buffer such that the MaxDataSize will be * reduced by the specifed amount. * * @param trim Number of octets to remove from the begining of the SG list. * * @return Number of octets that could not be trimmed. */ size_t TrimFromBegining(size_t trim) { size_t orig = trim; maxDataSize -= (std::min)(maxDataSize, trim); dataSize -= (std::min)(dataSize, trim); QCC_DbgTrace(("ScatterGatherList::TrimFromBegining(trim = %u) [maxDataSize = %u dataSize = %u]", trim, maxDataSize, dataSize)); while (trim > 0 && sg.begin() != sg.end()) { if (trim >= sg.begin()->len) { trim -= sg.begin()->len; sg.erase(sg.begin()); } else { sg.begin()->buf = reinterpret_cast(sg.begin()->buf) + trim; sg.begin()->len -= (uint32_t)trim; trim = 0; } } return (orig - trim); } }; /** * Send a collection of buffers from a scatter-gather list to a remote host on a socket. * * @param sockfd Socket descriptor. * @param sg A scatter-gather list refering to the data to be sent. * @param sent OUT: Number of octets sent. * @param flags SendMsgFlags to underlying sockets call (see sendmsg() in sockets API) * * @return Indication of success of failure. */ QStatus SendSG(SocketFd sockfd, const ScatterGatherList& sg, size_t& sent, SendMsgFlags flags = QCC_MSG_NONE); /** * Send a collection of buffers from a scatter-gather list to a remote host on a socket. * * @param sockfd Socket descriptor. * @param remoteAddr IP Address of remote host. * @param remotePort IP Port on remote host. * @param sg A scatter-gather list refering to the data to be sent. * @param sent OUT: Number of octets sent. * @param flags SendMsgFlags to underlying sockets call (see sendmsg() in sockets API) * * @return Indication of success of failure. */ QStatus SendToSG(SocketFd sockfd, IPAddress& remoteAddr, uint16_t remotePort, const ScatterGatherList& sg, size_t& sent, SendMsgFlags flags = QCC_MSG_NONE); /** * Receive data into a collection of buffers in a scatter-gather list from a * host on a socket. * * @param sockfd Socket descriptor. * @param sg A scatter-gather list refering to buffers where received * data will be stored. * @param received OUT: Number of octets received. * * @return Indication of success of failure. */ QStatus RecvSG(SocketFd sockfd, ScatterGatherList& sg, size_t& received); /** * Receive data into a collection of buffers in a scatter-gather list from a * host on a socket. * * @param sockfd Socket descriptor. * @param remoteAddr IP Address of remote host. * @param remotePort IP Port on remote host. * @param sg A scatter-gather list refering to buffers where received * data will be stored. * @param received OUT: Number of octets received. * * @return Indication of success of failure. */ QStatus RecvFromSG(SocketFd sockfd, IPAddress& remoteAddr, uint16_t& remotePort, ScatterGatherList& sg, size_t& received); } #undef QCC_MODULE #endif alljoyn-15.04b/alljoyn_core/router/posix/Socket.cc000066400000000000000000000153731255700255500222550ustar00rootroot00000000000000/** * @file * * Define the abstracted socket interface for Linux */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #if defined(QCC_OS_DARWIN) #include #endif #include #include "ScatterGatherList.h" #include #include #include #define QCC_MODULE "NETWORK" #if defined(QCC_OS_DARWIN) #define MSG_NOSIGNAL 0 #endif namespace qcc { extern QStatus MakeSockAddr(const char* path, struct sockaddr_storage* addrBuf, socklen_t& addrSize); extern QStatus MakeSockAddr(const IPAddress& addr, uint16_t port, struct sockaddr_storage* addrBuf, socklen_t& addrSize); extern QStatus GetSockAddr(const sockaddr_storage* addrBuf, socklen_t addrSize, IPAddress& addr, uint16_t& port); static QStatus SendSGCommon(SocketFd sockfd, struct sockaddr_storage* addr, socklen_t addrLen, const ScatterGatherList& sg, size_t& sent, SendMsgFlags flags) { QStatus status = ER_OK; ssize_t ret; struct msghdr msg; size_t index; struct iovec* iov; ScatterGatherList::const_iterator iter; QCC_DbgTrace(("SendSGCommon(sockfd = %d, *addr, addrLen, sg[%u:%u/%u], sent = <>, flags = 0x%x)", sockfd, sg.Size(), sg.DataSize(), sg.MaxDataSize(), (int)flags)); iov = new struct iovec[sg.Size()]; for (index = 0, iter = sg.Begin(); iter != sg.End(); ++index, ++iter) { iov[index].iov_base = iter->buf; iov[index].iov_len = iter->len; QCC_DbgLocalData(iov[index].iov_base, iov[index].iov_len); } msg.msg_name = addr; msg.msg_namelen = addrLen; msg.msg_iov = iov; msg.msg_iovlen = sg.Size(); msg.msg_control = NULL; msg.msg_controllen = 0; msg.msg_flags = 0; ret = sendmsg(static_cast(sockfd), &msg, (int)flags | MSG_NOSIGNAL); if (ret == -1) { if (errno == EAGAIN || errno == EINTR || errno == EWOULDBLOCK) { status = ER_WOULDBLOCK; } else { status = ER_OS_ERROR; QCC_LogError(status, ("SendSGCommon (sockfd = %u): %d - %s", sockfd, errno, strerror(errno))); } } else { sent = static_cast(ret); } delete[] iov; return status; } QStatus SendSG(SocketFd sockfd, const ScatterGatherList& sg, size_t& sent, SendMsgFlags flags) { QCC_DbgTrace(("SendSG(sockfd = %d, sg[%u:%u/%u], sent = <>, flags = 0x%x)", sockfd, sg.Size(), sg.DataSize(), sg.MaxDataSize(), flags)); return SendSGCommon(sockfd, NULL, 0, sg, sent, flags); } QStatus SendToSG(SocketFd sockfd, IPAddress& remoteAddr, uint16_t remotePort, const ScatterGatherList& sg, size_t& sent, SendMsgFlags flags) { struct sockaddr_storage addr; socklen_t addrLen = sizeof(addr); QCC_DbgTrace(("SendToSG(sockfd = %d, remoteAddr = %s, remotePort = %u, sg[%u:%u/%u], sent = <>, flags - 0x%x)", sockfd, remoteAddr.ToString().c_str(), remotePort, sg.Size(), sg.DataSize(), sg.MaxDataSize(), flags)); QStatus status = MakeSockAddr(remoteAddr, remotePort, &addr, addrLen); if (status != ER_OK) { return status; } return SendSGCommon(sockfd, &addr, addrLen, sg, sent, flags); } static QStatus RecvSGCommon(SocketFd sockfd, struct sockaddr_storage* addr, socklen_t* addrLen, ScatterGatherList& sg, size_t& received) { QStatus status = ER_OK; ssize_t ret; struct msghdr msg; size_t index; struct iovec* iov; ScatterGatherList::const_iterator iter; QCC_DbgTrace(("RecvSGCommon(sockfd = &d, addr, addrLen, sg = <>, received = <>)", sockfd)); iov = new struct iovec[sg.Size()]; for (index = 0, iter = sg.Begin(); iter != sg.End(); ++index, ++iter) { iov[index].iov_base = iter->buf; iov[index].iov_len = iter->len; } msg.msg_name = addr; msg.msg_namelen = *addrLen; msg.msg_iov = iov; msg.msg_iovlen = sg.Size(); msg.msg_control = NULL; msg.msg_controllen = 0; msg.msg_flags = 0; ret = recvmsg(static_cast(sockfd), &msg, 0); if (ret == -1) { status = ER_OS_ERROR; QCC_DbgHLPrintf(("RecvSGCommon (sockfd = %u): %d - %s", sockfd, errno, strerror(errno))); } else { received = static_cast(ret); sg.SetDataSize(static_cast(ret)); *addrLen = msg.msg_namelen; } delete[] iov; #if !defined(NDEBUG) if (1) { size_t rxcnt = received; QCC_DbgPrintf(("Received %u bytes", received)); for (iter = sg.Begin(); rxcnt > 0 && iter != sg.End(); ++iter) { QCC_DbgRemoteData(iter->buf, std::min(rxcnt, iter->len)); rxcnt -= std::min(rxcnt, iter->len); } } #endif return status; } QStatus RecvSG(SocketFd sockfd, ScatterGatherList& sg, size_t& received) { socklen_t addrLen = 0; QCC_DbgTrace(("RecvSG(sockfd = %d, sg = <>, received = <>)", sockfd)); return RecvSGCommon(sockfd, NULL, &addrLen, sg, received); } QStatus RecvFromSG(SocketFd sockfd, IPAddress& remoteAddr, uint16_t& remotePort, ScatterGatherList& sg, size_t& received) { QStatus status; struct sockaddr_storage addr; socklen_t addrLen = sizeof(addr); status = RecvSGCommon(sockfd, &addr, &addrLen, sg, received); if (ER_OK == status) { GetSockAddr(&addr, addrLen, remoteAddr, remotePort); QCC_DbgTrace(("RecvFromSG(sockfd = %d, remoteAddr = %s, remotePort = %u, sg = <>, sent = <>)", sockfd, remoteAddr.ToString().c_str(), remotePort)); } return status; } } // namespace qcc alljoyn-15.04b/alljoyn_core/router/posix/daemon-main.cc000066400000000000000000000646631255700255500232200ustar00rootroot00000000000000/** * @file * AllJoyn-Daemon - POSIX version */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #ifndef QCC_OS_ANDROID #include #endif #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include "Transport.h" #include "TCPTransport.h" #include "UDPTransport.h" #include "DaemonTransport.h" #if defined(QCC_OS_LINUX) #include "DaemonSLAPTransport.h" #endif #include "Bus.h" #include "BusController.h" #include "ConfigDB.h" #if !defined(ROUTER_LIB) #if defined(QCC_OS_LINUX) #include #include #elif defined(QCC_OS_ANDROID) #include extern "C" { extern int capset(cap_user_header_t hdrp, const cap_user_data_t datap); } #endif #endif #define DAEMON_EXIT_OK 0 #define DAEMON_EXIT_OPTION_ERROR 1 #define DAEMON_EXIT_CONFIG_ERROR 2 #define DAEMON_EXIT_STARTUP_ERROR 3 #define DAEMON_EXIT_FORK_ERROR 4 #define DAEMON_EXIT_IO_ERROR 5 #define DAEMON_EXIT_SESSION_ERROR 6 #define DAEMON_EXIT_CHDIR_ERROR 7 #define DAEMON_EXIT_CAP_ERROR 8 using namespace ajn; using namespace qcc; using namespace std; static volatile sig_atomic_t reload; static volatile sig_atomic_t quit; /* * Simple config to provide some non-default limits for the daemon tcp/udp transport. */ #if defined(QCC_OS_ANDROID) static const char defaultConfig[] = "" " 20000" " 16" " 32" " 0" " 0" " true" ""; #else static const char defaultConfig[] = "" " 20000" " 16" " 32" " 16" " 0" " Battery powered and chargeable" " Intermediate mobility" " 3-6 hr" " Wireless" " false" ""; #endif /* * Router Power Source * Always AC powered * Battery powered and chargeable * Battery powered and not chargeable * * Router Mobility * Always Stationary * Low mobility * Intermediate mobility * High mobility * * Router Availability * 0-3 hr * 3-6 hr * 6-9 hr * 9-12 hr * 12-15 hr * 15-18 hr * 18-21 hr * 21-24 hr * * Router Node Connection * Access Point * Wired * Wireless * */ static const char internalConfig[] = "" " alljoyn" " unix:abstract=alljoyn" #if defined(QCC_OS_DARWIN) " launchd:env=DBUS_LAUNCHD_SESSION_BUS_SOCKET" #endif " tcp:iface=*,port=9955" " udp:iface=*,port=9955" ""; static const char versionPreamble[] = "AllJoyn Message Bus Daemon version: %s\n" "Copyright AllSeen Alliance.\n" "\n" "Build: %s\n"; void SignalHandler(int sig) { switch (sig) { case SIGHUP: if (!reload) { reload = 1; } break; case SIGINT: case SIGTERM: quit = 1; break; } } class OptParse { public: enum ParseResultCode { PR_OK, PR_EXIT_NO_ERROR, PR_OPTION_CONFLICT, PR_INVALID_OPTION, PR_MISSING_OPTION }; OptParse(int argc, char** argv) : argc(argc), argv(argv), fork(false), noFork(false), noSLAP(false), noTCP(false), noUDP(false), #if defined(QCC_OS_DARWIN) noLaunchd(false), #endif noSwitchUser(false), printAddressFd(-1), printPidFd(-1), internal(false), configService(false), verbosity(LOG_WARNING) { } ParseResultCode ParseResult(); String GetConfigFile() const { return configFile; } bool GetFork() const { return fork; } bool GetNoFork() const { return noFork; } bool GetNoSLAP() const { return noSLAP; } bool GetNoTCP() const { return noTCP; } bool GetNoUDP() const { return noUDP; } #if defined(QCC_OS_DARWIN) bool GetNoLaunchd() const { return noLaunchd; } #endif bool GetNoSwitchUser() const { return noSwitchUser; } int GetPrintAddressFd() const { return printAddressFd; } int GetPrintPidFd() const { return printPidFd; } int GetVerbosity() const { return verbosity; } bool GetInternalConfig() const { return internal; } bool GetServiceConfig() const { return configService; } private: int argc; char** argv; String configFile; bool fork; bool noFork; bool noSLAP; bool noTCP; bool noUDP; #if defined(QCC_OS_DARWIN) bool noLaunchd; #endif bool noSwitchUser; int printAddressFd; int printPidFd; bool internal; bool configService; int verbosity; void PrintUsage(); }; void OptParse::PrintUsage() { String cmd = argv[0]; cmd = cmd.substr(cmd.find_last_of('/') + 1); fprintf( stderr, "%s [--session | --system | --internal | --config-file=FILE" #if defined(QCC_OS_ANDROID) && defined(ROUTER_LIB) " | --config-service" #endif "]\n" "%*s [--print-address[=DESCRIPTOR]] [--print-pid[=DESCRIPTOR]]\n" "%*s [--fork | --nofork] " "[--no-slap] [--no-tcp] [--no-udp] " #if defined(QCC_OS_DARWIN) "[--no-launchd]" #endif "\n%*s [--no-switch-user] [--verbosity=LEVEL] [--version]\n\n" " --session\n" " Use the standard configuration for the per-login-session message bus.\n\n" " --system\n" " Use the standard configuration for the system message bus.\n\n" " --internal\n" " Use a basic internally defined message bus for AllJoyn.\n\n" #if defined(QCC_OS_ANDROID) && defined(ROUTER_LIB) " --config-service\n" " Use a configuration passed from the calling service.\n\n" #endif " --config-file=FILE\n" " Use the specified configuration file.\n\n" " --print-address[=DESCRIPTOR]\n" " Print the socket address to stdout or the specified descriptor\n\n" " --print-pid[=DESCRIPTOR]\n" " Print the process ID to stdout or the specified descriptor\n\n" " --fork\n" " Force the daemon to fork and run in the background.\n\n" " --nofork\n" " Force the daemon to only run in the foreground (override config file\n" " setting).\n\n" " --no-slap\n" " Disable the SLAP transport (override config file setting).\n\n" " --no-tcp\n" " Disable the TCP transport (override config file setting).\n\n" " --no-udp\n" " Disable the UDP transport (override config file setting).\n\n" #if defined(QCC_OS_DARWIN) " --no-launchd\n" " Disable the Launchd transport (override config file setting).\n\n" #endif #if defined(QCC_OS_LINUX) " --no-switch-user\n" " Don't switch from root to the user specified in the config file.\n\n" #endif " --verbosity=LEVEL\n" " Set the logging level to LEVEL.\n\n" " --version\n" " Print the version and copyright string, and exit.\n", cmd.c_str(), static_cast (cmd.size()), "", static_cast (cmd.size()), "", static_cast (cmd.size()), ""); } OptParse::ParseResultCode OptParse::ParseResult() { ParseResultCode result = PR_OK; int i = 0; if (argc == 1) { goto exit; } for (i = 1; i < argc; ++i) { String arg(argv[i]); if (arg.compare("--version") == 0) { printf(versionPreamble, GetVersion(), GetBuildInfo()); result = PR_EXIT_NO_ERROR; goto exit; } else if (arg.compare("--session") == 0) { if (!configFile.empty() || internal) { result = PR_OPTION_CONFLICT; goto exit; } configFile = "/etc/dbus-1/session.conf"; } else if (arg.compare("--system") == 0) { if (!configFile.empty() || internal) { result = PR_OPTION_CONFLICT; goto exit; } configFile = "/etc/dbus-1/system.conf"; } else if (arg.compare("--internal") == 0) { if (!configFile.empty()) { result = PR_OPTION_CONFLICT; goto exit; } internal = true; } else if (arg.compare("--config-file") == 0) { if (!configFile.empty() || internal) { result = PR_OPTION_CONFLICT; goto exit; } ++i; if (i == argc) { result = PR_MISSING_OPTION; goto exit; } configFile = argv[i]; } else if (arg.compare(0, sizeof("--config-file") - 1, "--config-file") == 0) { if (!configFile.empty() || internal) { result = PR_OPTION_CONFLICT; goto exit; } configFile = arg.substr(sizeof("--config-file")); #if defined(QCC_OS_ANDROID) && defined(ROUTER_LIB) } else if (arg.compare(0, sizeof("--config-service") - 1, "--config-service") == 0) { if (!configFile.empty() || internal) { result = PR_OPTION_CONFLICT; goto exit; } configService = true; #endif } else if (arg.compare(0, sizeof("--print-address") - 1, "--print-address") == 0) { if (arg[sizeof("--print-address") - 1] == '=') { printAddressFd = StringToI32(arg.substr( sizeof("--print-address")), 10, -2); } else { if (((i + 1) == argc) || ((argv[i + 1][0] == '-') && (argv[i + 1][1] == '-'))) { printAddressFd = STDERR_FILENO; } else { ++i; printAddressFd = StringToI32(argv[i], 10, -2); } } if (printAddressFd < -1) { result = PR_INVALID_OPTION; goto exit; } } else if (arg.substr(0, sizeof("--print-pid") - 1).compare( "--print-pid") == 0) { if (arg[sizeof("--print-pid") - 1] == '=') { printPidFd = StringToI32(arg.substr(sizeof("--print-pid")), 10, -2); } else { if (((i + 1) == argc) || ((argv[i + 1][0] == '-') && (argv[i + 1][1] == '-'))) { printPidFd = STDERR_FILENO; } else { ++i; printPidFd = StringToI32(argv[i], 10, -2); } } if (printPidFd < -1) { result = PR_INVALID_OPTION; goto exit; } } else if (arg.compare("--fork") == 0) { if (noFork) { result = PR_OPTION_CONFLICT; goto exit; } fork = true; } else if (arg.compare("--nofork") == 0) { if (fork) { result = PR_OPTION_CONFLICT; goto exit; } noFork = true; } else if (arg.compare("--no-bt") == 0) { // Obsolete - kept for backwards compatibility } else if (arg.compare("--no-slap") == 0) { noSLAP = true; } else if (arg.compare("--no-tcp") == 0) { noTCP = true; } else if (arg.compare("--no-udp") == 0) { noUDP = true; #if defined(QCC_OS_DARWIN) } else if (arg.compare("--no-launchd") == 0) { noLaunchd = true; #endif } else if (arg.compare("--no-switch-user") == 0) { noSwitchUser = true; } else if (arg.substr(0, sizeof("--verbosity") - 1).compare( "--verbosity") == 0) { verbosity = StringToI32(arg.substr(sizeof("--verbosity"))); } else if ((arg.compare("--help") == 0) || (arg.compare("-h") == 0)) { PrintUsage(); result = PR_EXIT_NO_ERROR; goto exit; } else { result = PR_INVALID_OPTION; goto exit; } } exit: internal = configFile.empty(); switch (result) { case PR_OPTION_CONFLICT: fprintf(stderr, "Option \"%s\" is in conflict with a previous option.\n", argv[i]); break; case PR_INVALID_OPTION: fprintf(stderr, "Invalid option: \"%s\"\n", argv[i]); break; case PR_MISSING_OPTION: fprintf(stderr, "No config file specified.\n"); PrintUsage(); break; default: break; } return result; } int daemon(OptParse& opts) { struct sigaction act, oldact; sigset_t sigmask, waitmask; ConfigDB* config = ConfigDB::GetConfigDB(); // block all signals by default for all threads sigfillset(&sigmask); sigdelset(&sigmask, SIGSEGV); pthread_sigmask(SIG_BLOCK, &sigmask, NULL); act.sa_handler = SignalHandler; sigemptyset(&act.sa_mask); act.sa_flags = SA_SIGINFO | SA_RESTART; sigaction(SIGHUP, &act, &oldact); sigaction(SIGINT, &act, &oldact); sigaction(SIGTERM, &act, &oldact); /* * Extract the listen specs */ const ConfigDB::ListenList listenList = config->GetListen(); String listenSpecs; for (ConfigDB::_ListenList::const_iterator it = listenList->begin(); it != listenList->end(); ++it) { String addrStr = *it; bool skip = false; if (addrStr.compare(0, sizeof("unix:") - 1, "unix:") == 0) { if (addrStr.compare(sizeof("unix:") - 1, sizeof("tmpdir=") - 1, "tmpdir=") == 0) { // Process tmpdir specially. String randStr = addrStr.substr(sizeof("unix:tmpdir=") - 1) + "/alljoyn-"; addrStr = ("unix:abstract=" + RandomString(randStr.c_str())); } if (config->GetType() == "system") { // Add the system bus unix address to the app's environment. Environ* env = Environ::GetAppEnviron(); const String var("DBUS_SYSTEM_BUS_ADDRESS"); env->Add(var, addrStr); } #if defined(QCC_OS_DARWIN) } else if (addrStr.compare(0, sizeof("launchd:") - 1, "launchd:") == 0) { skip = opts.GetNoLaunchd(); #endif } else if (addrStr.compare(0, sizeof("tcp:") - 1, "tcp:") == 0) { skip = opts.GetNoTCP(); } else if (addrStr.compare(0, sizeof("udp:") - 1, "udp:") == 0) { skip = opts.GetNoUDP(); } else if (addrStr.compare(0, sizeof("slap:") - 1, "slap:") == 0) { skip = opts.GetNoSLAP(); } else { Log(LOG_ERR, "Unsupported listen address: %s (ignoring)\n", addrStr.c_str()); continue; } if (skip) { Log(LOG_INFO, "Skipping transport for address: %s\n", addrStr.c_str()); } else { Log(LOG_INFO, "Setting up transport for address: %s\n", addrStr.c_str()); if (!listenSpecs.empty()) { listenSpecs.append(';'); } listenSpecs.append(addrStr); } } if (listenSpecs.empty()) { Log(LOG_ERR, "No listen address specified. Aborting...\n"); return DAEMON_EXIT_CONFIG_ERROR; } // Do the real AllJoyn work here QStatus status; TransportFactoryContainer cntr; cntr.Add(new TransportFactory(DaemonTransport::TransportName, false)); cntr.Add(new TransportFactory(TCPTransport::TransportName, false)); cntr.Add(new TransportFactory(UDPTransport::TransportName, false)); #if defined(QCC_OS_LINUX) cntr.Add(new TransportFactory(DaemonSLAPTransport::TransportName, false)); #endif Bus ajBus("alljoyn-daemon", cntr, listenSpecs.c_str()); /* * Check we have at least one authentication mechanism registered. */ if (!config->GetAuth().empty()) { if (ajBus.GetInternal().FilterAuthMechanisms(config->GetAuth()) == 0) { Log(LOG_ERR, "No supported authentication mechanisms. Aborting...\n"); return DAEMON_EXIT_STARTUP_ERROR; } } /* * Create the bus controller use it to initialize and start the bus. */ BusController ajBusController(ajBus); status = ajBusController.Init(listenSpecs); if (ER_OK != status) { Log(LOG_ERR, "Failed to initialize BusController: %s\n", QCC_StatusText(status)); return DAEMON_EXIT_STARTUP_ERROR; } int fd; String pidfn = config->GetPidfile(); fd = opts.GetPrintAddressFd(); if (fd >= 0) { String localAddrs(ajBus.GetLocalAddresses()); localAddrs += "\n"; int ret = write(fd, localAddrs.c_str(), localAddrs.size()); if (ret == -1) { Log(LOG_ERR, "Failed to print address string: %s\n", strerror(errno)); } } sigfillset(&waitmask); sigdelset(&waitmask, SIGHUP); sigdelset(&waitmask, SIGINT); sigdelset(&waitmask, SIGTERM); quit = 0; while (!quit) { reload = 0; sigsuspend(&waitmask); if (reload && !opts.GetInternalConfig()) { if (!config->LoadConfig(&ajBus)) { Log(LOG_ERR, "Failed to load the configuration - problem with %s.\n", opts.GetConfigFile().c_str()); } } } Log(LOG_INFO, "Terminating.\n"); ajBus.StopListen(listenSpecs.c_str()); return DAEMON_EXIT_OK; } // // This code can be run as a native executable, in which case the linker arranges to // call main(), or it can be run as an Android Service. In this case, the daemon // is implemented as a static library which is linked into a JNI dynamic library and // called from the Java service code. // #if defined(ROUTER_LIB) int DaemonMain(int argc, char** argv, char* serviceConfig) #else int CDECL_CALL main(int argc, char** argv, char** env) #endif { if (AllJoynInit() != ER_OK) { return DAEMON_EXIT_STARTUP_ERROR; } if (AllJoynRouterInit() != ER_OK) { AllJoynShutdown(); return DAEMON_EXIT_STARTUP_ERROR; } #if defined(QCC_OS_ANDROID) && !defined(ROUTER_LIB) // // Initialize the environment for Android if we use the command line to // run the daemon. If we are using the Android service launcher, there is // no environment there, so we use arguments and a passed-in config file // which we deal with in a bit. // environ = env; #endif int ret = 0; String configStr; ConfigDB* config = NULL; LoggerSetting* loggerSettings = LoggerSetting::GetLoggerSetting(argv[0], LOG_WARNING, true, NULL); OptParse opts(argc, argv); OptParse::ParseResultCode parseCode = opts.ParseResult(); switch (parseCode) { case OptParse::PR_OK: break; case OptParse::PR_EXIT_NO_ERROR: ret = DAEMON_EXIT_OK; goto exit; default: ret = DAEMON_EXIT_OPTION_ERROR; goto exit; } loggerSettings->SetLevel(opts.GetVerbosity()); if (opts.GetNoFork()) { // Presumably the user wants logging to go to stderr. loggerSettings->SetSyslog(false); loggerSettings->SetFile(stderr); } configStr = defaultConfig; #if defined(QCC_OS_ANDROID) && defined(ROUTER_LIB) configStr.append(opts.GetServiceConfig() ? serviceConfig : internalConfig); #else if (opts.GetInternalConfig()) { configStr.append(internalConfig); } #endif config = new ConfigDB(configStr, opts.GetConfigFile()); if (!config->LoadConfig()) { const char* errsrc; if (opts.GetInternalConfig()) { errsrc = "internal default config"; } else { errsrc = opts.GetConfigFile().c_str(); } Log(LOG_ERR, "Failed to load the configuration - problem with %s.\n", errsrc); ret = DAEMON_EXIT_CONFIG_ERROR; goto exit; } loggerSettings->SetSyslog(config->GetSyslog()); loggerSettings->SetFile((opts.GetFork() || (config->GetFork() && !opts.GetNoFork())) ? NULL : stderr); if (opts.GetFork() || (config->GetFork() && !opts.GetNoFork())) { pid_t pid = fork(); if (pid == -1) { Log(LOG_ERR, "Failed to fork(): %s\n", strerror(errno)); ret = DAEMON_EXIT_FORK_ERROR; goto exit; } else if (pid > 0) { String pidfn = config->GetPidfile(); int fd = opts.GetPrintPidFd(); String pidStr(U32ToString(pid)); pidStr += "\n"; if (fd > 0) { int ret = write(fd, pidStr.c_str(), pidStr.size()); if (ret == -1) { Log(LOG_ERR, "Failed to print pid: %s\n", strerror(errno)); } } if (!pidfn.empty()) { FileSink pidfile(pidfn); size_t sent; pidfile.PushBytes(pidStr.c_str(), pidStr.size(), sent); } // Unneeded parent process, just exit. _exit(DAEMON_EXIT_OK); } else { /* * We forked and are running as a daemon, so close STDIN, STDOUT, and * STDERR as appropriate. */ LoggerSetting::GetLoggerSetting()->SetFile(NULL); // block logging to stdout/stderr close(STDIN_FILENO); close(STDOUT_FILENO); close(STDERR_FILENO); #if !defined(ROUTER_LIB) && defined(QCC_OS_LINUX) uid_t curr = getuid(); if (!opts.GetNoSwitchUser() && (curr == 0)) { String user = config->GetUser(); if (!user.empty()) { static const cap_value_t needed_caps[] = { CAP_NET_RAW, CAP_NET_ADMIN, CAP_NET_BIND_SERVICE }; cap_t caps = cap_get_proc(); if (cap_clear(caps) || cap_set_flag(caps, CAP_PERMITTED, ArraySize(needed_caps), needed_caps, CAP_SET) || cap_set_flag(caps, CAP_EFFECTIVE, ArraySize(needed_caps), needed_caps, CAP_SET)) { Log(LOG_ERR, "Failed to set capabilities.\n"); ret = DAEMON_EXIT_CAP_ERROR; goto exit; } // Keep all capabilities before switching users if (prctl(PR_SET_KEEPCAPS, 1, 0, 0, 0)) { Log(LOG_ERR, "Failed to persist capabilities before switching user.\n"); ret = DAEMON_EXIT_CAP_ERROR; goto exit; } // drop root privileges if is specified. struct passwd* pwent; setpwent(); while ((pwent = getpwent())) { if (user.compare(pwent->pw_name) == 0) { if (setuid(pwent->pw_uid) == 0) { Log(LOG_INFO, "Dropping root privileges (running as %s)\n", pwent->pw_name); } else { Log(LOG_ERR, "Failed to drop root privileges - set userid failed: %s\n", user.c_str()); endpwent(); ret = DAEMON_EXIT_CONFIG_ERROR; goto exit; } break; } } endpwent(); if (!pwent) { Log(LOG_ERR, "Failed to drop root privileges - userid does not exist: %s\n", user.c_str()); ret = DAEMON_EXIT_CONFIG_ERROR; goto exit; } } } #endif Log(LOG_INFO, "Running with effective userid %d\n", geteuid()); // create new session ID pid_t sid = setsid(); if (sid < 0) { Log(LOG_ERR, "Failed to set session ID: %s\n", strerror(errno)); ret = DAEMON_EXIT_SESSION_ERROR; goto exit; } if (chdir("/tmp") == -1) { Log(LOG_ERR, "Failed to change directory: %s\n", strerror(errno)); ret = DAEMON_EXIT_CHDIR_ERROR; goto exit; } } } Log(LOG_NOTICE, versionPreamble, GetVersion(), GetBuildInfo()); ret = daemon(opts); exit: delete config; AllJoynRouterShutdown(); AllJoynShutdown(); return ret; } alljoyn-15.04b/alljoyn_core/router/posix/servicehelper-main.cc000066400000000000000000000112371255700255500246020ustar00rootroot00000000000000/** * @file * AllJoyn-Daemon service launcher helper - POSIX version */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #ifndef QCC_OS_ANDROID #include #endif #include #include #include #include #include #include #include #include #include #include #include #include #include #include "../BusController.h" #include "../ConfigDB.h" #include "../ServiceDB.h" #define dbg(_fmt, _args ...) fprintf(stderr, "DBG %s %s[%u]: " _fmt "\n", __FILE__, __PRETTY_FUNCTION__, __LINE__, ## _args) #ifndef dbg #define dbg(_fmt, _args ...) do { } while (0) #endif #ifndef SYSTEM_CONF // Default location of the system.conf file - the dbus-daemon-launch-helper has this path hard coded. #define SYSTEM_CONF "/etc/dbus-1/system.conf" #endif #define DAEMON_EXIT_OK 0 #define DAEMON_EXIT_OPTION_ERROR 1 #define DAEMON_EXIT_CONFIG_ERROR 2 #define DAEMON_EXIT_LAUNCH_ERROR 3 using namespace ajn; using namespace qcc; using namespace std; class OptParse { public: enum ParseResultCode { PR_OK, PR_EXIT_NO_ERROR, PR_TOO_MANY_ARGS, PR_MISSING_OPTION }; OptParse(int argc, char** argv) : argc(0), argv(NULL) { } ParseResultCode ParseResult(); qcc::String GetConfigFile() const { return SYSTEM_CONF; } qcc::String GetServiceName() const { return serviceName; } private: int argc; char** argv; qcc::String serviceName; void PrintUsage(); }; void OptParse::PrintUsage() { fprintf(stderr, "%s \n\n", argv[0]); } OptParse::ParseResultCode OptParse::ParseResult() { ParseResultCode result(PR_OK); if (argc == 1) { result = PR_MISSING_OPTION; } else if (argc > 2) { result = PR_TOO_MANY_ARGS; } else { qcc::String arg(argv[1]); if (arg.compare("--version") == 0) { printf("AllJoyn Message Bus Daemon service launcher helper version: %s\n" "Copyright AllSeen Alliance.\n" "\n" "\n" "Build: %s\n", GetVersion(), GetBuildInfo()); result = PR_EXIT_NO_ERROR; } else { serviceName = arg; } } switch (result) { case PR_TOO_MANY_ARGS: fprintf(stderr, "Too many args\n"); PrintUsage(); break; case PR_MISSING_OPTION: fprintf(stderr, "No service to activate specified.\n"); PrintUsage(); break; default: break; } return result; } int CDECL_CALL main(int argc, char** argv, char** env) { #ifdef QCC_OS_ANDROID // Initialize the environment for Andriod environ = env; #endif LoggerSetting* loggerSettings(LoggerSetting::GetLoggerSetting(argv[0], LOG_WARNING, true, NULL)); loggerSettings->SetSyslog(false); loggerSettings->SetFile(stdout); OptParse opts(argc, argv); OptParse::ParseResultCode parseCode(opts.ParseResult()); ConfigDB* config(ConfigDB::GetConfigDB()); QStatus status; switch (parseCode) { case OptParse::PR_OK: break; case OptParse::PR_EXIT_NO_ERROR: delete config; return DAEMON_EXIT_OK; default: delete config; return DAEMON_EXIT_OPTION_ERROR; } config->SetConfigFile(opts.GetConfigFile()); if (!config->LoadConfigFile()) { delete config; return DAEMON_EXIT_CONFIG_ERROR; } ServiceDB serviceDB(config->GetServiceDB()); status = serviceDB->BusStartService(opts.GetServiceName().c_str()); delete config; return (status == ER_OK) ? DAEMON_EXIT_OK : DAEMON_EXIT_LAUNCH_ERROR; } alljoyn-15.04b/alljoyn_core/router/standalone/000077500000000000000000000000001255700255500214735ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/router/standalone/SConscript000066400000000000000000000016061255700255500235100ustar00rootroot00000000000000# Copyright AllSeen Alliance. All rights reserved. # # Permission to use, copy, modify, and/or distribute this software for any # purpose with or without fee is hereby granted, provided that the above # copyright notice and this permission notice appear in all copies. # # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. # Import('router_env') src = router_env.Glob('*.cc') obj = router_env.Object(src) Return('obj') alljoyn-15.04b/alljoyn_core/router/standalone/StandaloneRouterInit.cc000066400000000000000000000036111255700255500261200ustar00rootroot00000000000000/** * @file * Static global creation and destruction */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include "RouterGlobals.h" extern "C" { static uint32_t allJoynRouterInitCount = 0; static qcc::Mutex allJoynRouterInitLock; QStatus AJ_CALL AllJoynRouterInit(void) { allJoynRouterInitLock.Lock(); if (allJoynRouterInitCount == 0) { ajn::RouterGlobals::Init(); allJoynRouterInitCount = 1; } else if (allJoynRouterInitCount < 0xFFFFFFFF) { allJoynRouterInitCount++; } allJoynRouterInitLock.Unlock(); return ER_OK; } QStatus AJ_CALL AllJoynRouterShutdown(void) { allJoynRouterInitLock.Lock(); if (allJoynRouterInitCount > 0) { allJoynRouterInitCount--; if (allJoynRouterInitCount == 0) { ajn::RouterGlobals::Shutdown(); } } allJoynRouterInitLock.Unlock(); return ER_OK; } } alljoyn-15.04b/alljoyn_core/router/test/000077500000000000000000000000001255700255500203225ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/router/test/SConscript000066400000000000000000000025451255700255500223420ustar00rootroot00000000000000# Copyright AllSeen Alliance. All rights reserved. # # Permission to use, copy, modify, and/or distribute this software for any # purpose with or without fee is hereby granted, provided that the above # copyright notice and this permission notice appear in all copies. # # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. # Import('router_env', 'router_objs', 'srobj') from os.path import basename # Test Programs progs = [ router_env.Program('advtunnel', ['advtunnel.cc'] + srobj + router_objs), router_env.Program('ns', ['ns.cc'] + srobj + router_objs) ] if router_env['OS'] in ['android', 'linux', 'win7']: progs.append(router_env.Program('bbdaemon', ['bbdaemon.cc'] + srobj + router_objs)) progs.append(router_env.Program('ardp', ['ardp.cc'] + srobj + router_objs)) progs.append(router_env.Program('ardptest', ['ardptest.cc'] + srobj + router_objs)) Return('progs') alljoyn-15.04b/alljoyn_core/router/test/advtunnel.cc000066400000000000000000000351421255700255500226360ustar00rootroot00000000000000/** * @file * Bi-directional tunnel for forwarding alljoyn advertisements between subnets via TCP */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #define QCC_MODULE "ALLJOYN" using namespace ajn; static IpNameServiceImpl* g_ns; /* * If true sniffs advertisements but doesn't send them. */ static bool sniffMode = false; /* * Name service configuration parameters. These need to match up with the ones used by AllJoyn. */ const char* IPV4_MULTICAST_GROUP = "239.255.37.41"; const char* IPV6_MULTICAST_GROUP = "ff03::efff:2529"; /* Default tunnel port, override with the -p option */ const uint16_t TUNNEL_PORT = 9973; /** Signal handler */ static void CDECL_CALL SigIntHandler(int sig) { QCC_UNUSED(sig); if (g_ns) { IpNameServiceImpl* ns = g_ns; g_ns = NULL; ns->Stop(); } } class AdvTunnel { public: AdvTunnel() : stream(NULL) { } static const uint16_t ADV_VERSION = 1; static const uint32_t ADV_ID = 0xBEBE0000; QStatus VersionExchange(); QStatus Connect(qcc::String address, uint16_t port); QStatus Listen(uint16_t port); QStatus RelayAdv(); void Found(const qcc::String& busAddr, const qcc::String& guid, std::vector& nameList, uint32_t timer); QStatus PullString(qcc::String& str) { char buffer[256]; char* buf = buffer; size_t pulled; uint8_t len; QStatus status = stream->PullBytes(&len, 1, pulled); while ((status == ER_OK) && len) { status = stream->PullBytes(buf, len, pulled); if (status == ER_OK) { str.append(buf, pulled); buf += pulled; len -= pulled; } } return status; } QStatus PullInt(uint32_t& num) { qcc::String val; QStatus status = PullString(val); if (status == ER_OK) { num = qcc::StringToU32(val, 10, (uint32_t)-1); if (num == (uint32_t)-1) { status = ER_INVALID_DATA; } } return status; } QStatus PushString(const qcc::String& str) { size_t pushed; uint8_t len = str.size(); QStatus status = stream->PushBytes(&len, 1, pushed); if (status == ER_OK) { status = stream->PushBytes(str.c_str(), len, pushed); } return status; } QStatus PushInt(uint32_t num) { qcc::String val = qcc::U32ToString(num, 10); return PushString(val); } qcc::SocketStream* stream; /* * Maps from guid to name service */ std::map nsRelay; }; QStatus AdvTunnel::VersionExchange() { QStatus status = PushInt(ADV_VERSION | ADV_ID); if (status == ER_OK) { uint32_t version; status = PullInt(version); if (status == ER_OK) { if (version != (ADV_VERSION | ADV_ID)) { printf("version mismatch expected %d got %d\n", version, version & ~ADV_ID); status = ER_INVALID_DATA; } } } return status; } QStatus AdvTunnel::Connect(qcc::String address, uint16_t port) { qcc::IPAddress addr(address); qcc::SocketFd sock; QStatus status = qcc::Socket(qcc::QCC_AF_INET, qcc::QCC_SOCK_STREAM, sock); if (status != ER_OK) { QCC_LogError(status, ("Failed to create connect socket")); return status; } while (status == ER_OK) { status = qcc::Connect(sock, addr, port); if (status == ER_OK) { break; } if (status == ER_CONN_REFUSED) { qcc::Sleep(5); status = ER_OK; } } if (status == ER_OK) { printf("Connected to advertisement relay\n"); stream = new qcc::SocketStream(sock); status = VersionExchange(); if (status != ER_OK) { delete stream; stream = NULL; } } else { qcc::Close(sock); } return status; } QStatus AdvTunnel::Listen(uint16_t port) { qcc::IPAddress wildcard("0.0.0.0"); qcc::SocketFd listenSock; qcc::SocketFd sock; QStatus status = qcc::Socket(qcc::QCC_AF_INET, qcc::QCC_SOCK_STREAM, listenSock); if (status != ER_OK) { QCC_LogError(status, ("Failed to create listen socket")); return status; } /* Allow reuse of the same port */ status = qcc::SetReusePort(listenSock, true); if (status != ER_OK) { QCC_LogError(status, ("AdvTunnel::Listen(): SetReuse() failed")); qcc::Close(listenSock); return status; } status = qcc::Bind(listenSock, wildcard, port); if (status != ER_OK) { QCC_LogError(status, ("Failed bind listen socket")); qcc::Close(listenSock); return status; } status = qcc::Listen(listenSock, 0); if (status == ER_OK) { status = qcc::SetBlocking(listenSock, false); } if (status == ER_OK) { qcc::IPAddress addr; status = qcc::Accept(listenSock, addr, port, sock); if (status == ER_WOULDBLOCK) { qcc::Event ev(listenSock, qcc::Event::IO_READ); status = qcc::Event::Wait(ev, qcc::Event::WAIT_FOREVER); if (ER_OK == status) { status = qcc::Accept(listenSock, addr, port, sock); } } if (status == ER_OK) { printf("Accepted advertisement relay\n"); stream = new qcc::SocketStream(sock); status = VersionExchange(); if (status != ER_OK) { delete stream; stream = NULL; } } else { qcc::Close(sock); } } qcc::Close(listenSock); return status; } QStatus AdvTunnel::RelayAdv() { QStatus status; qcc::String busAddr; status = PullString(busAddr); if (status != ER_OK) { return status; } qcc::String guid; status = PullString(guid); if (status != ER_OK) { return status; } uint32_t count = 0; status = PullInt(count); std::vector nameList; for (size_t i = 0; (status == ER_OK) && (i < count); ++i) { qcc::String name; status = PullString(name); if (status == ER_OK) { nameList.push_back(name); } } if (status != ER_OK) { return status; } uint32_t timer; status = PullInt(timer); if (status != ER_OK) { return status; } printf("Relaying %d names at %s timer=%d\n", (int)nameList.size(), busAddr.c_str(), timer); for (size_t i = 0; i < nameList.size(); ++i) { printf(" %s\n", nameList[i].c_str()); } /* * Lookup or create a name service for relaying advertisements for this quid */ IpNameServiceImpl* ns; if (nsRelay.count(guid) == 0) { ns = new IpNameServiceImpl(); status = ns->Init(guid); if (status != ER_OK) { delete ns; return status; } status = ns->Start(); if (status != ER_OK) { delete ns; return status; } nsRelay[guid] = ns; /* * Parse out the port of the reliable TCP transport mechanism and set it * on the name service */ std::map argMap; QStatus status = Transport::ParseArguments("tcp", busAddr.c_str(), argMap); if (status == ER_OK) { uint16_t port = static_cast(qcc::StringToU32(argMap["r4port"])); std::map portMap; portMap["*"] = (uint16_t)port; status = ns->Enable(TRANSPORT_TCP, portMap, 0, std::map(), 0, true, false, false, false); if (status == ER_OK) { ns->OpenInterface(TRANSPORT_TCP, "*"); } } } else { ns = nsRelay[guid]; } if (timer) { status = ns->AdvertiseName(TRANSPORT_TCP, nameList, false, TRANSPORT_TCP); if (status != ER_OK) { QCC_LogError(status, ("Failed to advertise relayed names")); } } else { status = ns->CancelAdvertiseName(TRANSPORT_TCP, nameList, TRANSPORT_TCP); if (status != ER_OK) { QCC_LogError(status, ("Failed to cancel relayed names")); } } /* * If nothing is being advertised for this guid we don't need this name service any more. */ if (ns->NumAdvertisements(TRANSPORT_TCP) == 0) { printf("Removing unused name server\n"); nsRelay.erase(guid); delete ns; } return status; } void AdvTunnel::Found(const qcc::String& busAddr, const qcc::String& guid, std::vector& nameList, uint32_t timer) { QStatus status; /* * We don't want to re-relay names that we are advertising. */ if (nsRelay.count(guid) != 0) { return; } printf("Found %d names at %s timer=%d\n", (int)nameList.size(), busAddr.c_str(), timer); for (size_t i = 0; i < nameList.size(); ++i) { printf(" %s\n", nameList[i].c_str()); } if (sniffMode) { status = ER_OK; goto Exit; } status = PushString(busAddr); if (status != ER_OK) { goto Exit; } status = PushString(guid); if (status != ER_OK) { goto Exit; } status = PushInt((uint32_t)nameList.size()); for (size_t i = 0; i < nameList.size(); ++i) { status = PushString(nameList[i]); } if (status != ER_OK) { goto Exit; } status = PushInt(timer); Exit: if (status != ER_OK) { printf("Failed to push found names into socket stream\n"); if (g_ns) { g_ns->Stop(); } } } static void usage(void) { printf("Usage: advtunnel [-p ] ([-h] -l | -c )\n\n"); printf("Options:\n"); printf(" -h = Print this help message\n"); printf(" -s = Sniff mode\n"); printf(" -p = Port to connect or listen on\n"); printf(" -l = Listen mode\n"); printf(" -c = Connect mode and address to connect to\n"); } int CDECL_CALL main(int argc, char** argv) { if (AllJoynInit() != ER_OK) { return 1; } if (AllJoynRouterInit() != ER_OK) { AllJoynShutdown(); return 1; } QStatus status; IpNameServiceImpl ns; AdvTunnel tunnel; bool listen = false; qcc::String addr; uint16_t port = TUNNEL_PORT; qcc::String guid = "0000000000000000000000000000"; /* Install SIGINT handler */ signal(SIGINT, SigIntHandler); for (int i = 1; i < argc; ++i) { if (strcmp(argv[i], "-l") == 0) { listen = true; continue; } if (strcmp(argv[i], "-s") == 0) { sniffMode = true; continue; } if (strcmp(argv[i], "-p") == 0) { if (++i == argc) { printf("Missing port number\n"); usage(); exit(1); } port = (uint16_t) qcc::StringToU32(argv[i]); continue; } if (strcmp(argv[i], "-c") == 0) { if (++i == argc) { printf("Missing connect address\n"); usage(); exit(1); } addr = argv[i]; continue; } if (strcmp(argv[i], "-h") == 0) { usage(); continue; } printf("Unknown option\n"); usage(); exit(1); } if (!sniffMode && ((!listen && (addr.size() == 0)) || (listen && (addr.size() != 0)))) { usage(); exit(1); } g_ns = &ns; ns.SetCallback(TRANSPORT_TCP, new CallbackImpl&, uint32_t> (&tunnel, &AdvTunnel::Found)); std::map portMap; portMap["*"] = port; ns.Enable(TRANSPORT_TCP, portMap, 0, std::map(), 0, true, false, false, false); /* * In sniffMode we just report advertisements */ if (sniffMode) { ns.Init(guid); ns.Start(); ns.OpenInterface(TRANSPORT_TCP, "*"); ns.FindAdvertisement(TRANSPORT_TCP, "name='*'", IpNameServiceImpl::ALWAYS_RETRY, TRANSPORT_TCP); printf("Started sniffing for advertised names\n"); qcc::Sleep(10000000); ns.Stop(); ns.Join(); } while (g_ns) { if (listen) { status = tunnel.Listen(port); } else { status = tunnel.Connect(addr, port); } if (status != ER_OK) { printf("Failed to establish relay: %s\n", QCC_StatusText(status)); } else { printf("Relay established\n"); ns.Init(guid); ns.Start(); ns.OpenInterface(TRANSPORT_TCP, "*"); ns.FindAdvertisement(TRANSPORT_TCP, "name='*'", IpNameServiceImpl::ALWAYS_RETRY, TRANSPORT_TCP); printf("Start relay\n"); /* * Loop reading and rebroadcasting advertisements. */ while (status == ER_OK) { status = tunnel.RelayAdv(); } ns.Stop(); ns.Join(); } } ns.Join(); AllJoynRouterShutdown(); AllJoynShutdown(); return 0; } alljoyn-15.04b/alljoyn_core/router/test/ardp.cc000066400000000000000000000274211255700255500215650ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. * ******************************************************************************/ #include #include #include #include #include #include #ifdef _WIN32 #include #define random() rand() #else #include #include #include #endif #include #include #include #include #include #include #include #include #include #include #define QCC_MODULE "ARDP" using namespace ajn; const uint32_t UDP_CONNECT_TIMEOUT = 1000; /**< How long before we expect a connection to complete */ const uint32_t UDP_CONNECT_RETRIES = 10; /**< How many times do we retry a connection before giving up */ const uint32_t UDP_INITIAL_DATA_TIMEOUT = 1000; /**< Initial value for how long do we wait before retrying sending data */ const uint32_t UDP_TOTAL_DATA_RETRY_TIMEOUT = 5000; /**< Total amount of time to try and send data before giving up */ const uint32_t UDP_MIN_DATA_RETRIES = 5; /**< Minimum number of times to try and send data before giving up */ const uint32_t UDP_PERSIST_INTERVAL = 1000; /**< How long do we wait before pinging the other side due to a zero window */ const uint32_t UDP_TOTAL_APP_TIMEOUT = 30000; /**< How long to we try to ping for window opening before deciding app is not pulling data */ const uint32_t UDP_LINK_TIMEOUT = 30000; /**< How long before we decide a link is down (with no reponses to keepalive probes */ const uint32_t UDP_KEEPALIVE_RETRIES = 5; /**< How many times do we try to probe on an idle link before terminating the connection */ const uint32_t UDP_FAST_RETRANSMIT_ACK_COUNTER = 1; /**< How many duplicate acknowledgements to we need to trigger a data retransmission */ const uint32_t UDP_DELAYED_ACK_TIMEOUT = 100; /**< How long do we wait until acknowledging received segments */ const uint32_t UDP_TIMEWAIT = 1000; /**< How long do we stay in TIMWAIT state before releasing the per-connection resources */ const uint32_t UDP_SEGBMAX = 65507; /**< Maximum size of an ARDP message (for receive buffer sizing) */ const uint32_t UDP_SEGMAX = 50; /**< Maximum number of ARDP messages in-flight (bandwidth-delay product sizing) */ bool g_user = false; char const* g_localport = "9954"; char const* g_foreignport = "9955"; char const* g_address = "127.0.0.1"; char const* g_ajnConnString = "AUTH ANONIMOUS; BEGIN; Bus Hello"; char const* g_ajnAcceptString = "OK 123455678; Hello"; static volatile sig_atomic_t g_interrupt = false; static void CDECL_CALL SigIntHandler(int sig) { QCC_UNUSED(sig); g_interrupt = true; } bool AcceptCb(ArdpHandle* handle, qcc::IPAddress ipAddr, uint16_t ipPort, ArdpConnRecord* conn, uint8_t* buf, uint16_t len, QStatus status) { QCC_UNUSED(ipAddr); QCC_UNUSED(ipPort); QCC_UNUSED(buf); QCC_UNUSED(len); QCC_DbgTrace(("AcceptCb(handle=%p, ipAddr=\"%s\", foreign=%d, conn=%p, buf=%p(\"%s\"), len=%d, status=%s)", handle, ipAddr.ToString().c_str(), ipPort, conn, buf, (char*) buf, len, QCC_StatusText(status))); uint16_t length = random() % UDP_SEGBMAX; uint8_t* buffer = new uint8_t[length]; status = ARDP_Accept(handle, conn, UDP_SEGMAX, UDP_SEGBMAX, buffer, length); if (status != ER_OK) { QCC_DbgPrintf(("AcceptCb(): ARDP_Accept failed with %s", QCC_StatusText(status))); } return true; } void ConnectCb(ArdpHandle* handle, ArdpConnRecord* conn, bool passive, uint8_t* buf, uint16_t len, QStatus status) { QCC_UNUSED(buf); QCC_UNUSED(len); QCC_DbgTrace(("ConnectCb(handle=%p, conn=%p, passive=%s, buf=%p, len=%d, status=%s)", handle, conn, (passive) ? "true" : "false", buf, len, QCC_StatusText(status))); if (status == ER_OK) { if (!passive) { QCC_DbgPrintf(("ConnectCb: response string \"%s\"", (char*)buf)); } uint16_t length = random() % UDP_SEGBMAX; uint8_t* buffer = new uint8_t[length]; QCC_DbgPrintf(("ConnectCb(): ARDP_Send(handle=%p, conn=%p, buffer=%p, length=%d)", handle, conn, buffer, length)); status = ARDP_Send(handle, conn, buffer, length, 0); if (status != ER_OK) { QCC_DbgPrintf(("ConnectCb(): ARDP_Send failed with %s", QCC_StatusText(status))); } } else { QCC_DbgPrintf(("Connect establishment failed")); } } void DisconnectCb(ArdpHandle* handle, ArdpConnRecord* conn, QStatus status) { QCC_UNUSED(handle); QCC_UNUSED(conn); QCC_UNUSED(status); QCC_DbgTrace(("DisconnectCb(handle=%p, conn=%p, status=%s)", handle, conn, QCC_StatusText(status))); } void RecvCb(ArdpHandle* handle, ArdpConnRecord* conn, ArdpRcvBuf* rcv, QStatus status) { QCC_UNUSED(status); ArdpRcvBuf* buf = rcv; uint32_t len = 0; uint16_t cnt = rcv->fcnt; QCC_DbgTrace(("RecvCb(handle=%p, conn=%p, rcv=%p, status=%s)", handle, conn, rcv, QCC_StatusText(status))); /* Consume data buffers */ for (uint16_t i = 0; i < cnt; i++) { QCC_DbgPrintf(("RecvCb(): got %d bytes of data", buf->datalen)); len += buf->datalen; buf = buf->next; } QCC_DbgPrintf(("RecvCb(): got TOTAL %d bytes of data", len)); ARDP_RecvReady(handle, conn, rcv); } void SendCb(ArdpHandle* handle, ArdpConnRecord* conn, uint8_t* buf, uint32_t len, QStatus status) { QCC_DbgTrace(("SendCb(handle=%p, conn=%p, buf=%p, len=%d, status=%s)", handle, conn, buf, len, QCC_StatusText(status))); delete buf; len = 0; uint16_t length = random() % UDP_SEGBMAX; uint8_t* buffer = new uint8_t[length]; QCC_DbgTrace(("SendCb(): ARDP_Send(handle=%p, conn=%p, buffer=%p, length=%d.)", handle, conn, buffer, length)); status = ARDP_Send(handle, conn, buffer, length, 0); if (status != ER_OK) { QCC_DbgPrintf(("SendCb(): ARDP_Send failed with %s", QCC_StatusText(status))); } } void SendWindowCb(ArdpHandle* handle, ArdpConnRecord* conn, uint16_t window, QStatus status) { QCC_UNUSED(handle); QCC_UNUSED(conn); QCC_UNUSED(window); QCC_UNUSED(status); QCC_DbgTrace(("SendWindowCb(handle=%p, conn=%p, window=%d, status=%s)", handle, conn, window, QCC_StatusText(status))); } class Test : public qcc::Thread { public: QStatus TestStart(); qcc::ThreadReturn STDCALL Run(void* arg); }; QStatus Test::TestStart() { QCC_DbgTrace(("Test::Start()")); return Thread::Start(this); } void* Test::Run(void* arg) { QCC_UNUSED(arg); qcc::SocketFd sock; QStatus status = qcc::Socket(qcc::QCC_AF_INET, qcc::QCC_SOCK_DGRAM, sock); if (status != ER_OK) { QCC_LogError(status, ("Test::Run(): Socket(): Failed")); return 0; } status = qcc::SetBlocking(sock, false); if (status != ER_OK) { QCC_LogError(status, ("Test::Run(): SetBlocking(): Failed")); return 0; } status = qcc::Bind(sock, qcc::IPAddress("0.0.0.0"), atoi(g_localport)); if (status != ER_OK) { QCC_LogError(status, ("Test::Run(): Bind(): Failed")); return 0; } ArdpGlobalConfig config; config.connectTimeout = UDP_CONNECT_TIMEOUT; config.connectRetries = UDP_CONNECT_RETRIES; config.initialDataTimeout = UDP_INITIAL_DATA_TIMEOUT; config.totalDataRetryTimeout = UDP_TOTAL_DATA_RETRY_TIMEOUT; config.minDataRetries = UDP_MIN_DATA_RETRIES; config.persistInterval = UDP_PERSIST_INTERVAL; config.totalAppTimeout = UDP_TOTAL_APP_TIMEOUT; config.linkTimeout = UDP_LINK_TIMEOUT; config.keepaliveRetries = UDP_KEEPALIVE_RETRIES; config.fastRetransmitAckCounter = UDP_FAST_RETRANSMIT_ACK_COUNTER; config.delayedAckTimeout = UDP_DELAYED_ACK_TIMEOUT; config.timewait = UDP_TIMEWAIT; config.segbmax = UDP_SEGBMAX; config.segmax = UDP_SEGMAX; ArdpHandle* handle = ARDP_AllocHandle(&config); ARDP_SetAcceptCb(handle, AcceptCb); ARDP_SetConnectCb(handle, ConnectCb); ARDP_SetDisconnectCb(handle, DisconnectCb); ARDP_SetRecvCb(handle, RecvCb); ARDP_SetSendCb(handle, SendCb); ARDP_SetSendWindowCb(handle, SendWindowCb); ARDP_StartPassive(handle); qcc::Event* sockEvent = new qcc::Event(sock, qcc::Event::IO_READ); qcc::Event timerEvent(1000, 1000); bool connectSent = false; while (IsRunning()) { std::vector checkEvents, signaledEvents; checkEvents.push_back(&stopEvent); checkEvents.push_back(&timerEvent); checkEvents.push_back(sockEvent); QStatus status = qcc::Event::Wait(checkEvents, signaledEvents); if (status != ER_OK && status != ER_TIMEOUT) { QCC_LogError(status, ("Test::Run(): Event::Wait(): Failed")); break; } for (std::vector::iterator i = signaledEvents.begin(); i != signaledEvents.end(); ++i) { if (*i == &stopEvent) { QCC_DbgPrintf(("Test::Run(): Stop event fired")); stopEvent.ResetEvent(); } else if (*i == &timerEvent) { if (g_user) { if (connectSent == false) { connectSent = true; ArdpConnRecord* conn; ARDP_Connect(handle, sock, qcc::IPAddress(g_address), atoi(g_foreignport), UDP_SEGMAX, UDP_SEGBMAX, &conn, (uint8_t* )g_ajnConnString, strlen(g_ajnConnString) + 1, NULL); continue; } } } else { QCC_DbgPrintf(("Test::Run(): Socket event fired")); uint32_t ms; ARDP_Run(handle, sock, true, false, &ms); } } } ARDP_FreeHandle(handle); return 0; } int CDECL_CALL main(int argc, char** argv) { if (AllJoynInit() != ER_OK) { return 1; } if (AllJoynRouterInit() != ER_OK) { AllJoynShutdown(); return 1; } printf("%s main()\n", argv[0]); for (int i = 1; i < argc; ++i) { if (0 == strcmp("-l", argv[i])) { g_localport = argv[i + 1]; i += 1; } else if (0 == strcmp("-f", argv[i])) { g_foreignport = argv[i + 1]; i += 1; } else if (0 == strcmp("-a", argv[i])) { g_address = argv[i + 1]; i += 1; } else if (0 == strcmp("-u", argv[i])) { g_user = true; } else { printf("Unknown option %s\n", argv[i]); exit(0); } } printf("g_user == %d.\n", g_user); printf("g_localport == %s\n", g_localport); printf("g_foreignport == %s\n", g_foreignport); printf("g_addresss == %s\n", g_address); signal(SIGINT, SigIntHandler); Test* test = new Test(); test->TestStart(); while (g_interrupt == false) { qcc::Sleep(100); } test->Stop(); test->Join(); delete test; AllJoynRouterShutdown(); AllJoynShutdown(); exit(0); } alljoyn-15.04b/alljoyn_core/router/test/ardptest.cc000066400000000000000000000456621255700255500224740ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. * ******************************************************************************/ #include #include #include #include #include #include #ifdef _WIN32 #include #define random() rand() #else #include #include #include #endif #include #include #include #include #include #include #include #include #include #include #include #include #define QCC_MODULE "ARDP" using namespace std; using namespace qcc; using namespace ajn; const uint32_t UDP_CONNECT_TIMEOUT = 1000; /**< How long before we expect a connection to complete */ const uint32_t UDP_CONNECT_RETRIES = 10; /**< How many times do we retry a connection before giving up */ const uint32_t UDP_INITIAL_DATA_TIMEOUT = 1000; /**< Initial value for how long do we wait before retrying sending data */ const uint32_t UDP_TOTAL_DATA_RETRY_TIMEOUT = 5000; /**< Total amount of time to try and send data before giving up */ const uint32_t UDP_MIN_DATA_RETRIES = 5; /**< Minimum number of times to try and send data before giving up */ const uint32_t UDP_PERSIST_INTERVAL = 1000; /**< How long do we wait before pinging the other side due to a zero window */ const uint32_t UDP_TOTAL_APP_TIMEOUT = 30000; /**< How long to we try to ping for window opening before deciding app is not pulling data */ const uint32_t UDP_LINK_TIMEOUT = 30000; /**< How long before we decide a link is down (with no reponses to keepalive probes */ const uint32_t UDP_KEEPALIVE_RETRIES = 5; /**< How many times do we try to probe on an idle link before terminating the connection */ const uint32_t UDP_FAST_RETRANSMIT_ACK_COUNTER = 1; /**< How many duplicate acknowledgements to we need to trigger a data retransmission */ const uint32_t UDP_DELAYED_ACK_TIMEOUT = 100; /**< How long do we wait until acknowledging received segments */ const uint32_t UDP_TIMEWAIT = 1000; /**< How long do we stay in TIMWAIT state before releasing the per-connection resources */ const uint32_t UDP_SEGBMAX = 65507; /**< Maximum size of an ARDP message (for receive buffer sizing) */ const uint32_t UDP_SEGMAX = 50; /**< Maximum number of ARDP messages in-flight (bandwidth-delay product sizing) */ char const* g_local_port = "9954"; char const* g_foreign_port = "9955"; char const* g_local_address = "127.0.0.1"; char const* g_foreign_address = "127.0.0.1"; char const* g_ajnConnString = "AUTH ANONYMOUS; BEGIN THE CONNECTION; Bus Hello; Bellevue"; char const* g_ajnAcceptString = "OK 123455678; Hello; Redmond"; std::map > RecvMapQueue; std::map connList; static int g_conn = 0; static volatile sig_atomic_t g_interrupt = false; static void CDECL_CALL SigIntHandler(int sig) { QCC_UNUSED(sig); g_interrupt = true; } char* get_line(char*str, size_t num, FILE*fp) { char*p = fgets(str, num, fp); // fgets will capture the '\n' character if the string entered is shorter than // num. Remove the '\n' from the end of the line and replace it with nul '\0'. if (p != NULL) { size_t last = strlen(str) - 1; if (str[last] == '\n') { str[last] = '\0'; } } return p; } static String NextTok(String& inStr) { String ret; size_t off = inStr.find_first_of(' '); if (off == String::npos) { ret = inStr; inStr.clear(); } else { ret = inStr.substr(0, off); inStr = Trim(inStr.substr(off)); } return Trim(ret); } static void RemoveConn(ArdpConnRecord*conn) { std::map::iterator it = connList.begin(); while (it != connList.end()) { if (conn == it->second) { connList.erase(it++); } else { ++it; } } } static bool FindConn(uint32_t number) { std::map::iterator it = connList.begin(); it = connList.find(number); if (it != connList.end()) { return true; } else { return false; } } void GetData(ArdpRcvBuf* rcv) { ArdpRcvBuf* buf = rcv; uint32_t len = 0; uint16_t count = rcv->fcnt; /* Consume data buffers */ for (uint16_t i = 0; i < count; i++) { printf("RecvCb(): got %d bytes of data \n", buf->datalen); len += buf->datalen; buf = buf->next; } } bool AcceptCb(ArdpHandle* handle, qcc::IPAddress ipAddr, uint16_t ipPort, ArdpConnRecord* conn, uint8_t* buf, uint16_t len, QStatus status) { QCC_UNUSED(handle); QCC_UNUSED(len); printf("Inside Accept callback, we received a SYN from %s:%d, the message is \"%s\", status %s \n", ipAddr.ToString().c_str(), ipPort, (char*)buf, QCC_StatusText(status)); printf("Connection no is %d, conn pointer is %p \n", g_conn, conn); connList[g_conn] = conn; g_conn++; //int option=0; //printf("Do you want to accept(1) it or not? "); //scanf("%d",&option); //if(option==1) { // printf("Returning true..\n"); // return true; //} else { // printf("Returning false..\n"); // return false; //} return true; } void ConnectCb(ArdpHandle* handle, ArdpConnRecord* conn, bool passive, uint8_t* buf, uint16_t len, QStatus status) { QCC_UNUSED(handle); printf("Looks like I have connected... conn=%p is passive=%s , the message(len = %d) is \"%s\", status is %s \n", conn, (passive) ? "true" : "false", len, (char*)buf, QCC_StatusText(status)); if (!passive) { printf("Connection no is %d, conn pointer is %p \n", g_conn, conn); connList[g_conn] = conn; g_conn++; } } void DisconnectCb(ArdpHandle* handle, ArdpConnRecord* conn, QStatus status) { QCC_UNUSED(handle); printf("Looks like I have disconnected conn = %p, reason = %s\n", conn, QCC_StatusText(status)); RecvMapQueue.erase(conn); RemoveConn(conn); } void RecvCb(ArdpHandle* handle, ArdpConnRecord* conn, ArdpRcvBuf* rcv, QStatus status) { QCC_UNUSED(handle); QCC_UNUSED(status); printf("RECV- %u conn = %p \n", rcv->seq, conn); RecvMapQueue[conn].push(rcv); } void SendCb(ArdpHandle* handle, ArdpConnRecord* conn, uint8_t* buf, uint32_t len, QStatus status) { QCC_UNUSED(handle); QCC_UNUSED(buf); QCC_UNUSED(status); printf("SENT- %u, conn = %p \n", len, conn); } void SendWindowCb(ArdpHandle* handle, ArdpConnRecord* conn, uint16_t window, QStatus status) { QCC_UNUSED(handle); QCC_UNUSED(status); printf("WINDOW RECEIVED- %u, conn = %p \n", window, conn); } class ThreadClass : public Thread { public: ThreadClass(char*name, ArdpHandle* handle, qcc::SocketFd sock) : Thread(name) { m_handle = handle; m_sock = sock; } protected: qcc::ThreadReturn STDCALL Run(void* arg) { QCC_UNUSED(arg); while ((!g_interrupt) && (IsRunning())) { uint32_t ms; ARDP_Run(m_handle, m_sock, true, false, &ms); //qcc::Sleep(1000); } return this; } private: ArdpHandle* m_handle; qcc::SocketFd m_sock; }; static void Print_Conn() { std::map::iterator it; printf("===================================================== \n"); for (it = connList.begin(); it != connList.end(); ++it) printf("%u %p \n", it->first, it->second); printf("===================================================== \n"); } static void usage() { printf("connect \n"); printf("accept \n"); printf("send # \n"); printf("recv #connection number \n"); printf("recvall #connection number \n"); printf("sendall #connection number \n"); printf("disconnect #connection number \n"); printf("exit \n"); printf("help \n"); printf("list \n"); } int CDECL_CALL main(int argc, char** argv) { if (AllJoynInit() != ER_OK) { return 1; } if (AllJoynRouterInit() != ER_OK) { AllJoynShutdown(); return 1; } QStatus status = ER_OK; for (int i = 1; i < argc; ++i) { if (0 == strcmp("-lp", argv[i])) { g_local_port = argv[i + 1]; i++; } else if (0 == strcmp("-fp", argv[i])) { g_foreign_port = argv[i + 1]; i++; } else if (0 == strcmp("-la", argv[i])) { g_local_address = argv[i + 1]; i++; } else if (0 == strcmp("-fa", argv[i])) { g_foreign_address = argv[i + 1]; i++; } else { printf("Unknown option %s\n", argv[i]); exit(0); } } printf("g_local_port == %s\n", g_local_port); printf("g_foreign_port == %s\n", g_foreign_port); printf("g_local_address == %s\n", g_local_address); printf("g_foreign_address == %s\n", g_foreign_address); signal(SIGINT, SigIntHandler); //One time activity- Create a socket, set to blocking, bind it to local port, local address qcc::SocketFd sock; status = qcc::Socket(qcc::QCC_AF_INET, qcc::QCC_SOCK_DGRAM, sock); if (status != ER_OK) { QCC_LogError(status, ("Test::Run(): Socket(): Failed")); return 0; } status = qcc::SetBlocking(sock, false); if (status != ER_OK) { QCC_LogError(status, ("Test::Run(): SetBlocking(): Failed")); return 0; } status = qcc::Bind(sock, qcc::IPAddress(g_local_address), atoi(g_local_port)); if (status != ER_OK) { QCC_LogError(status, ("Test::Run(): Bind(): Failed")); return 0; } //Populate default values for timers, couters, etc. ArdpGlobalConfig config; config.connectTimeout = UDP_CONNECT_TIMEOUT; config.connectRetries = UDP_CONNECT_RETRIES; config.initialDataTimeout = UDP_INITIAL_DATA_TIMEOUT; config.totalDataRetryTimeout = UDP_TOTAL_DATA_RETRY_TIMEOUT; config.minDataRetries = UDP_MIN_DATA_RETRIES; config.persistInterval = UDP_PERSIST_INTERVAL; config.totalAppTimeout = UDP_TOTAL_APP_TIMEOUT; config.linkTimeout = UDP_LINK_TIMEOUT; config.keepaliveRetries = UDP_KEEPALIVE_RETRIES; config.fastRetransmitAckCounter = UDP_FAST_RETRANSMIT_ACK_COUNTER; config.delayedAckTimeout = UDP_DELAYED_ACK_TIMEOUT; config.timewait = UDP_TIMEWAIT; config.segbmax = UDP_SEGBMAX; config.segmax = UDP_SEGMAX; //Allocate a handle (ARDP protocol instance). ArdpHandle* handle = ARDP_AllocHandle(&config); //Set the callbacks- accept, connect, disconnectcb, recv, send, sendwindow ARDP_SetAcceptCb(handle, AcceptCb); ARDP_SetConnectCb(handle, ConnectCb); ARDP_SetDisconnectCb(handle, DisconnectCb); ARDP_SetRecvCb(handle, RecvCb); ARDP_SetSendCb(handle, SendCb); ARDP_SetSendWindowCb(handle, SendWindowCb); ArdpConnRecord* conn; //The side can behave as a server or client. Teach it to behave as a server. // This API is only for server side. ARDP_StartPassive(handle); ThreadClass* t1 = new ThreadClass((char*)"t1", handle, sock); t1->Start(); while (!g_interrupt) { char option[100]; get_line(option, 100, stdin); String line(option); String cmd = NextTok(line); if (strcmp(cmd.c_str(), "connect") == 0) { char foreign_port[10]; char foreign_address[20]; printf("Enter the foreign port.. \n"); if (scanf("%s", foreign_port) != 1) { printf("Error reading foreign port\n"); } else { printf("Enter the foreign address.. \n"); if (scanf("%s", foreign_address) != 1) { printf("Error reading foreign address\n"); } else { status = ARDP_Connect(handle, sock, qcc::IPAddress(foreign_address), atoi(foreign_port), UDP_SEGMAX, UDP_SEGBMAX, &conn, (uint8_t*)g_ajnConnString, strlen(g_ajnConnString) + 1, NULL); if (status != ER_OK) { printf("Error while calling ARDP_Connect.. %s \n", QCC_StatusText(status)); } } } } if (strcmp(cmd.c_str(), "send") == 0) { String connno = NextTok(line); if (connno.empty()) { printf("Usage: send #connection\n"); } else { uint32_t t_connno = StringToU32(connno, 0, 0); if (FindConn(t_connno)) { uint32_t length = StringToU32(NextTok(line), 0, random() % 135000); uint32_t ttl = StringToU32(NextTok(line), 0, 0); uint8_t* buffer = new uint8_t[length]; status = ARDP_Send(handle, connList[t_connno], buffer, length, ttl); if (status != ER_OK) { printf("Error while ARDP_Send.. %s \n", QCC_StatusText(status)); } else { printf("ARDP_Send successful on %p data[%u] = %u \n", connList[t_connno], length - 1, buffer[length - 1]); } delete [] buffer; } else { printf("Invalid connection \n"); } } } if (strcmp(cmd.c_str(), "recv") == 0) { String connno = NextTok(line); if (connno.empty()) { printf("Usage: recv #connection\n"); } else { uint32_t t_connno = StringToU32(connno, 0, 0); if (FindConn(t_connno)) { if (RecvMapQueue[connList[t_connno]].empty()) { printf("Nothing to release. \n"); } else { ArdpRcvBuf*rcv = NULL; rcv = RecvMapQueue[connList[t_connno]].front(); GetData(rcv); RecvMapQueue[connList[t_connno]].pop(); printf("ARDP_RecvReady about to be called on %p \n", connList[t_connno]); status = ARDP_RecvReady(handle, connList[t_connno], rcv); if (status != ER_OK) { printf("Error while ARDP_Recv.. %s \n", QCC_StatusText(status)); } else { printf("ARDP_RecvReady successful on %p \n", connList[t_connno]); } } } else { printf("Invalid connection \n"); } } } if (strcmp(cmd.c_str(), "accept") == 0) { status = ARDP_Accept(handle, connList[g_conn - 1], UDP_SEGMAX, UDP_SEGBMAX, (uint8_t* )g_ajnAcceptString, strlen(g_ajnAcceptString) + 1); if (status != ER_OK) { printf("Error while ARDP_Accept.. %s \n", QCC_StatusText(status)); } } if (strcmp(cmd.c_str(), "disconnect") == 0) { String connno = NextTok(line); if (connno.empty()) { printf("Usage: disconnect #connection\n"); } else { uint32_t t_connno = StringToU32(connno, 0, 0); if (FindConn(t_connno)) { status = ARDP_Disconnect(handle, connList[t_connno]); if (status != ER_OK) { printf("Error while ARDP_Disconnect.. %s \n", QCC_StatusText(status)); } } else { printf("Invalid connection \n"); } } } if (strcmp(cmd.c_str(), "recvall") == 0) { String connno = NextTok(line); if (connno.empty()) { printf("Usage: recvall #connection\n"); } else { uint32_t t_connno = StringToU32(connno, 0, 0); if (FindConn(t_connno)) { while (!RecvMapQueue[connList[t_connno]].empty()) { ArdpRcvBuf*rcv = NULL; rcv = RecvMapQueue[connList[t_connno]].front(); GetData(rcv); RecvMapQueue[connList[t_connno]].pop(); printf("ARDP_RecvReady about to be called on %p \n", connList[t_connno]); status = ARDP_RecvReady(handle, connList[t_connno], rcv); if (status != ER_OK) { printf("Error while ARDP_Recv.. %s \n", QCC_StatusText(status)); break; } else { printf("ARDP_RecvReady successful on %p \n", connList[t_connno]); } } printf("OK \n"); } else { printf("Invalid connection \n"); } } } if (strcmp(cmd.c_str(), "sendall") == 0) { String connno = NextTok(line); if (connno.empty()) { printf("Usage: sendall #connection\n"); } else { uint32_t t_connno = StringToU32(connno, 0, 0); if (FindConn(t_connno)) { for (;;) { uint32_t length = random() % (135000); uint8_t* buffer = new uint8_t[length]; status = ARDP_Send(handle, connList[t_connno], buffer, length, 0); if (status != ER_OK) { printf("Error while ARDP_Send.. %s \n", QCC_StatusText(status)); break; } else { printf("ARDP_Send successful on %p data[%u] = %u \n", connList[t_connno], length - 1, buffer[length - 1]); } delete [] buffer; } } else { printf("Invalid connection \n"); } } } if (strcmp(cmd.c_str(), "help") == 0) { usage(); } if (strcmp(cmd.c_str(), "exit") == 0) { break; } if (strcmp(cmd.c_str(), "list") == 0) { Print_Conn(); } } t1->Stop(); t1->Join(); delete t1; AllJoynRouterShutdown(); AllJoynShutdown(); return 0; } alljoyn-15.04b/alljoyn_core/router/test/bbdaemon.cc000066400000000000000000000436201255700255500224050ustar00rootroot00000000000000/** * @file * Message Bus Client */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include "UDPTransport.h" #include "TCPTransport.h" #include "DaemonTransport.h" #include "Bus.h" #include "BusController.h" #include "ConfigDB.h" #include "Transport.h" #include "TransportList.h" #define QCC_MODULE "ALLJOYN" using namespace qcc; using namespace std; using namespace ajn; /* * Simple config to * to provide some non-default limits for the daemon tcp transport. */ static const char daemonConfig[] = "" " alljoyn" " 20000" " 16" " 32" " 16" " false" " *" ""; /** Static top level message bus object */ static qcc::String serverArgs; static volatile sig_atomic_t g_interrupt = false; static void CDECL_CALL SigIntHandler(int sig) { QCC_UNUSED(sig); g_interrupt = true; } namespace org { namespace alljoyn { namespace alljoyn_test { const char* InterfaceName = "org.alljoyn.alljoyn_test"; const char* WellKnownName = "org.alljoyn.alljoyn_test"; const char* ObjectPath = "/org/alljoyn/alljoyn_test"; namespace values { const char* InterfaceName = "org.alljoyn.alljoyn_test.values"; } } } } class LocalTestObject : public BusObject { public: LocalTestObject(BusAttachment& bus, const char* path, unsigned long reportInterval) : BusObject(path), reportInterval(reportInterval), prop_str_val("hello world"), prop_ro_str("I cannot be written"), prop_int_val(100) { QStatus status; /* Add the test interface to this object */ const InterfaceDescription* regTestIntf = bus.GetInterface(::org::alljoyn::alljoyn_test::InterfaceName); assert(regTestIntf); AddInterface(*regTestIntf); /* Add the values interface to this object */ const InterfaceDescription* valuesIntf = bus.GetInterface(::org::alljoyn::alljoyn_test::values::InterfaceName); AddInterface(*valuesIntf); /* Register the signal handler with the bus */ const InterfaceDescription::Member* member = regTestIntf->GetMember("my_signal"); status = bus.RegisterSignalHandler(this, static_cast(&LocalTestObject::SignalHandler), member, NULL); if (ER_OK != status) { QCC_LogError(status, ("Failed to register signal handler")); } /* Register the method handlers with the object */ const MethodEntry methodEntries[] = { { regTestIntf->GetMember("my_ping"), static_cast(&LocalTestObject::Ping) } }; status = AddMethodHandlers(methodEntries, ArraySize(methodEntries)); if (ER_OK != status) { QCC_LogError(status, ("Failed to register method handlers for LocalTestObject")); } } void ObjectRegistered(void) { BusObject::ObjectRegistered(); assert(bus); /* Request a well-known name */ /* Note that you cannot make a blocking method call here */ const ProxyBusObject& dbusObj = bus->GetDBusProxyObj(); MsgArg args[2]; args[0].Set("s", ::org::alljoyn::alljoyn_test::WellKnownName); args[1].Set("u", 6); QStatus status = dbusObj.MethodCallAsync(::ajn::org::freedesktop::DBus::InterfaceName, "RequestName", this, static_cast(&LocalTestObject::NameAcquiredCB), args, ArraySize(args)); if (ER_OK != status) { QCC_LogError(status, ("Failed to request name %s", ::org::alljoyn::alljoyn_test::WellKnownName)); } } void NameAcquiredCB(Message& msg, void* context) { QCC_UNUSED(msg); QCC_UNUSED(context); /* Advertise the new name */ } void SignalHandler(const InterfaceDescription::Member* member, const char* sourcePath, Message& msg) { QCC_UNUSED(member); QCC_UNUSED(msg); map::const_iterator it; ++rxCounts[sourcePath]; if ((rxCounts[sourcePath] % reportInterval) == 0) { for (it = rxCounts.begin(); it != rxCounts.end(); ++it) { QCC_SyncPrintf("RxSignal: %s - %u\n", it->first.c_str(), it->second); } } } void Ping(const InterfaceDescription::Member* member, Message& msg) { QCC_UNUSED(member); /* Reply with same string that was sent to us */ MsgArg arg(*(msg->GetArg(0))); printf("Pinged with: %s\n", msg->GetArg(0)->ToString().c_str()); QStatus status = MethodReply(msg, &arg, 1); if (ER_OK != status) { QCC_LogError(status, ("Ping: Error sending reply")); } } QStatus Get(const char* ifcName, const char* propName, MsgArg& val) { QCC_UNUSED(ifcName); QStatus status = ER_OK; if (0 == strcmp("int_val", propName)) { // val.Set("i", prop_int_val); val.typeId = ALLJOYN_INT32; val.v_int32 = prop_int_val; } else if (0 == strcmp("str_val", propName)) { // val.Set("s", prop_str_val.c_str()); val.typeId = ALLJOYN_STRING; val.v_string.str = prop_str_val.c_str(); val.v_string.len = prop_str_val.size(); } else if (0 == strcmp("ro_str", propName)) { // val.Set("s", prop_ro_str_val.c_str()); val.typeId = ALLJOYN_STRING; val.v_string.str = prop_ro_str.c_str(); val.v_string.len = prop_ro_str.size(); } else { status = ER_BUS_NO_SUCH_PROPERTY; } return status; } QStatus Set(const char* ifcName, const char* propName, MsgArg& val) { QCC_UNUSED(ifcName); QStatus status = ER_OK; if ((0 == strcmp("int_val", propName)) && (val.typeId == ALLJOYN_INT32)) { prop_int_val = val.v_int32; } else if ((0 == strcmp("str_val", propName)) && (val.typeId == ALLJOYN_STRING)) { prop_str_val = val.v_string.str; } else if (0 == strcmp("ro_str", propName)) { status = ER_BUS_PROPERTY_ACCESS_DENIED; } else { status = ER_BUS_NO_SUCH_PROPERTY; } return status; } map rxCounts; unsigned long signalDelay; unsigned long reportInterval; qcc::String prop_str_val; qcc::String prop_ro_str; int32_t prop_int_val; }; class MyAuthListener : public AuthListener { bool RequestCredentials(const char* authMechanism, const char* authPeer, uint16_t authCount, const char* userId, uint16_t credMask, Credentials& creds) { QCC_UNUSED(authPeer); QCC_UNUSED(authCount); if (strcmp(authMechanism, "ALLJOYN_SRP_KEYX") == 0) { if (credMask & AuthListener::CRED_PASSWORD) { creds.SetPassword("123456"); printf("AuthListener returning fixed pin \"%s\" for %s\n", creds.GetPassword().c_str(), authMechanism); } return true; } if (strcmp(authMechanism, "ALLJOYN_SRP_LOGON") == 0) { if (!userId) { return false; } printf("Attemping to logon user %s\n", userId); if (strcmp(userId, "happy") == 0) { if (credMask & AuthListener::CRED_PASSWORD) { creds.SetPassword("123456"); return true; } } if (strcmp(userId, "sleepy") == 0) { if (credMask & AuthListener::CRED_PASSWORD) { creds.SetPassword("123456"); return true; } } if (strcmp(userId, "sneezy") == 0) { if (credMask & AuthListener::CRED_PASSWORD) { creds.SetPassword("123456"); return true; } } } return false; } void AuthenticationComplete(const char* authMechanism, const char* authPeer, bool success) { QCC_UNUSED(authPeer); printf("Authentication %s %s\n", authMechanism, success ? "succesful" : "failed"); } void SecurityViolation(QStatus status, const Message& msg) { printf("Security violation %s with message:\n%s\n", QCC_StatusText(status), msg->ToString().c_str()); } }; static void usage(void) { printf("Usage: bbdaemon [-h] [-m] [-b]\n\n"); printf("Options:\n"); printf(" -h = Print this help message\n"); printf(" -m = Mimic behavior of bbservice within daemon\n"); printf(" -be = Send messages as big endian\n"); printf(" -le = Send messages as little endian\n"); } // // This code can be run as a native executable, in which case the linker arranges to // call main(), or it can be run as an Android Service. In this case, the daemon // is implemented as a static library which is linked into a JNI dynamic library and // called from the service code. // #if defined(ROUTER_LIB) extern "C" int DaemonMain(int argc, char** argv) #else int CDECL_CALL main(int argc, char** argv) #endif { if (AllJoynInit() != ER_OK) { return 1; } if (AllJoynRouterInit() != ER_OK) { AllJoynShutdown(); return 1; } #if defined(NDEBUG) && defined(QCC_OS_ANDROID) LoggerSetting::GetLoggerSetting("bbdaemon", LOG_ERR, true, NULL); #else LoggerSetting::GetLoggerSetting("bbdaemon", LOG_DEBUG, false, stdout); #endif QStatus status = ER_OK; qcc::GUID128 guid; bool mimicBbservice = false; ConfigDB* config = new ConfigDB(daemonConfig); printf("AllJoyn Library version: %s\n", ajn::GetVersion()); printf("AllJoyn Library build info: %s\n", ajn::GetBuildInfo()); if (!config->LoadConfig()) { printf("Failed to load the internal config.\n"); exit(1); } /* Install SIGINT handler */ signal(SIGINT, SigIntHandler); /* Parse command line args */ for (int i = 1; i < argc; ++i) { if (0 == strcmp("-h", argv[i])) { usage(); exit(0); } else if (0 == strcmp("-m", argv[i])) { mimicBbservice = true; } else if (0 == strcmp("-le", argv[i])) { _Message::SetEndianess(ALLJOYN_LITTLE_ENDIAN); } else if (0 == strcmp("-be", argv[i])) { _Message::SetEndianess(ALLJOYN_BIG_ENDIAN); } else { status = ER_FAIL; printf("Unknown option %s\n", argv[i]); usage(); exit(1); } } /* Get env vars */ Environ* env = Environ::GetAppEnviron(); /* * The transport support matrix is getting a bit too complicated to interleave * all of the CPP macros, so we just break them out explicitly. */ #if defined(QCC_OS_GROUP_WINDOWS) /* * Windows uses the localhost transport as the local transport, uses the TCP * transport with defaults. */ serverArgs = env->Find("BUS_SERVER_ADDRESSES", "tcp:;udp:u4addr=0.0.0.0,u4port=9955"); #endif #if defined(QCC_OS_ANDROID) #if defined(ROUTER_LIB) /* * If the daemon is being built as a daemon library, it implies that the * library is going to be used by an Android APK that is responsible for * implementing a daemon. * * The daemon lib version of the Android-based daemon supports the unix * transport as the local transport, uses the TCP transport with defaults as * the remote transport, UDP. */ serverArgs = env->Find("BUS_SERVER_ADDRESSES", "unix:abstract=alljoyn;tcp:;udp:u4addr=0.0.0.0,u4port=9955"); #else /* !defined(ROUTER_LIB) */ /* * The native or bundled version of the Android-based daemon supports the * unix transport as the local transport, uses the TCP transport with * defaults as the remote transport, UDP. */ serverArgs = env->Find("BUS_SERVER_ADDRESSES", "unix:abstract=alljoyn;tcp:;udp:u4addr=0.0.0.0,u4port=9955"); #endif /* !defined(ROUTER_LIB) */ #endif /* defined(QCC_OS_ANDROID) */ #if defined(QCC_OS_DARWIN) /* * Darwin uses the unix transport as the local transport, uses the TCP * transport for the remote transport, UDP. */ serverArgs = env->Find("BUS_SERVER_ADDRESSES", "unix:abstract=alljoyn;tcp:;udp:u4addr=0.0.0.0,u4port=9955"); #endif /* defined(QCC_OS_DARWIN) */ #if !defined(QCC_OS_GROUP_WINDOWS) && !defined(QCC_OS_ANDROID) && !defined(QCC_OS_DARWIN) /* * Assume that any other platform uses the unix transport as the local * transport and uses the TCP or UDP transports for the remote transport. */ serverArgs = env->Find("BUS_SERVER_ADDRESSES", "unix:abstract=alljoyn;tcp:;udp:u4addr=0.0.0.0,u4port=9955"); #endif /* !defined(QCC_OS_GROUP_WINDOWS) && !defined(QCC_OS_ANDROID) && !defined(QCC_OS_DARWIN) */ printf("serverArgs: %s\n", serverArgs.c_str()); /* * Teach the transport list how to make transports it may see referred to in * the serverArgs above. The daemon transport is created by default (the * isDefault parameter is "true") because it is always required. The other * transport(s) are only created if specified in the environment as * indicated in serverArgs. */ TransportFactoryContainer cntr; cntr.Add(new TransportFactory(DaemonTransport::TransportName, true)); cntr.Add(new TransportFactory(TCPTransport::TransportName, false)); cntr.Add(new TransportFactory(UDPTransport::TransportName, false)); /* Create message bus with support for alternate transports */ Bus* bus = new Bus("bbdaemon", cntr, serverArgs.c_str()); BusController* controller = new BusController(*bus); if (mimicBbservice) { /* Add org.alljoyn.alljoyn_test interface */ InterfaceDescription* testIntf = NULL; status = bus->CreateInterface(::org::alljoyn::alljoyn_test::InterfaceName, testIntf); if (ER_OK == status) { testIntf->AddSignal("my_signal", NULL, NULL, 0); testIntf->AddMethod("my_ping", "s", "s", "outStr,inStr", 0); testIntf->Activate(); } else { QCC_LogError(status, ("Failed to create interface %s", ::org::alljoyn::alljoyn_test::InterfaceName)); } /* Add org.alljoyn.alljoyn_test.values interface */ if (ER_OK == status) { InterfaceDescription* valuesIntf = NULL; status = bus->CreateInterface(::org::alljoyn::alljoyn_test::values::InterfaceName, valuesIntf); if (ER_OK == status) { valuesIntf->AddProperty("int_val", "i", PROP_ACCESS_RW); valuesIntf->AddProperty("str_val", "s", PROP_ACCESS_RW); valuesIntf->AddProperty("ro_str", "s", PROP_ACCESS_READ); valuesIntf->Activate(); } else { QCC_LogError(status, ("Failed to create interface %s", ::org::alljoyn::alljoyn_test::values::InterfaceName)); } } } if (ER_OK == status) { /* Start the bus controller */ status = controller->Init(serverArgs); if (ER_OK == status) { LocalTestObject* testObj = NULL; if (mimicBbservice) { bus->EnablePeerSecurity("ALLJOYN_SRP_KEYX ALLJOYN_SRP_LOGON", new MyAuthListener()); testObj = new LocalTestObject(*bus, ::org::alljoyn::alljoyn_test::ObjectPath, 10); bus->RegisterBusObject(*testObj); } printf("AllJoyn Daemon PID = %d\n", GetPid()); fflush(stdout); if (ER_OK == status) { while (g_interrupt == false) { qcc::Sleep(100); } bus->StopListen(serverArgs.c_str()); } if (mimicBbservice) { bus->UnregisterBusObject(*testObj); delete testObj; } } else { QCC_LogError(status, ("Bus::Start failed")); } } else { QCC_LogError(status, ("BusController initialization failed")); } delete controller; delete bus; delete config; AllJoynRouterShutdown(); AllJoynShutdown(); return (int) status; } alljoyn-15.04b/alljoyn_core/router/test/conf/000077500000000000000000000000001255700255500212475ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/router/test/conf/sample.conf000066400000000000000000000066371255700255500234130ustar00rootroot00000000000000 unix:abstract=alljoyn launchd:env=DBUS_LAUNCHD_SESSION_BUS_SOCKET slap:type=uart,dev=/dev/ttyUSB0,baud=115200 tcp:iface=*,port=9955 tcp:addr=0.0.0.0,port=9955 udp:iface=*,port=9955 udp:addr=0.0.0.0,port=9955 tcp:iface=lo,port=9955 tcp:addr=127.0.0.1,port=9955 udp:iface=lo,port=9955 udp:addr=127.0.0.1,port=9955 tcp:iface=eth0,port=9955 tcp:addr=10.4.108.34,port=9955 udp:iface=eth0,port=9955 udp:addr=10.4.108.34,port=9955 20000 16 32 0 0 true Battery powered and chargeable Intermediate mobility 3-6 hr Wireless org.alljoyn.BusNode. alljoyn-15.04b/alljoyn_core/router/test/mcmd.cc000066400000000000000000001054151255700255500215570ustar00rootroot00000000000000/** * @file * "Simple" tool for sending method call commands to the bus. * * NOTE: This tool (ab)uses some AllJoyn interfaces in inappropriate ways and * contains some bad programing constructs (i.e., known memory leaks, etc.). * The code in this tool should not be used as an example of how to use the * AllJoyn API. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #if !defined(QCC_OS_DARWIN) #include "BTTransport.h" #endif #include "Bus.h" #include "SignatureUtils.h" #include #define QCC_MODULE "ALLJOYN" using namespace std; using namespace qcc; using namespace ajn; class Token { public: enum Type { ARGUMENT, GROUPING }; Token(Type t, qcc::String a) : type(t), arg(a) { } Type GetType() const { return type; } const qcc::String& GetArg() const { return arg; } private: Type type; qcc::String arg; }; enum Actions { NO_ACTION, LIST, LIST_ALL, LIST_OBJECTS, INTROSPECT, METHOD_CALL, METHOD_CALL_INTROSPECT }; enum GroupType { GT_NONE, GT_ARRAY, GT_DICT, GT_STRUCT }; static Actions action; static qcc::String busAddr; static qcc::String dest; static qcc::String objPath; static qcc::String method; static qcc::String signature; static int callArgc; static char** callArgv; #if !defined(QCC_OS_GROUP_WINDOWS) && !defined(QCC_OS_DARWIN) static BTTransport* btTrans; #endif class AutoConnect : public TransportListener { public: AutoConnect(BusAttachment& bus, Transport& transport) : bus(bus), transport(transport) { } void FoundBus(const qcc::String& busAddr, const vector& names); QStatus Wait(uint32_t timeout = 30000); private: BusAttachment& bus; Transport& transport; Event found; QStatus status; }; void AutoConnect::FoundBus(const qcc::String& busAddr, const vector& names) { printf("Connecting to discovered bus: %s\n", busAddr.c_str()); status = bus.Connect(busAddr.c_str()); if (status != ER_OK) { QCC_LogError(status, ("Failed to connect")); } found.SetEvent(); } QStatus AutoConnect::Wait(uint32_t timeout) { QStatus s = Event::Wait(found, timeout); if (s != ER_OK) { transport.DisableDiscovery("I am broken"); } else { s = status; } return s; } struct BNComp { bool operator()(const qcc::String& lhs, const qcc::String& rhs) const { int count = 0; if (lhs == rhs) { return false; } else if ((lhs[0] == ':') && (rhs[0] != ':')) { return false; } else if ((lhs[0] != ':') && (rhs[0] == ':')) { return true; } else if ((lhs[0] != ':') && (rhs[0] != ':')) { return lhs < rhs; } else { size_t lstart(1), lend(1); size_t rstart(1), rend(1); while ((lstart < lhs.size()) && (rstart < rhs.size())) { lend = lhs.find_first_of('.', lstart); rend = rhs.find_first_of('.', rstart); static const uint64_t INVALID(static_cast(-1)); uint64_t ln = StringToU64(lhs.substr(lstart, min(lend - lstart, sizeof(uint64_t))), 0, INVALID); uint64_t rn = StringToU64(rhs.substr(rstart, min(rend - rstart, sizeof(uint64_t))), 0, INVALID); if (ln == INVALID) { ln = StringToU64(lhs.substr(lstart, min(lend - lstart, sizeof(uint64_t))), 16, INVALID); } if (rn == INVALID) { rn = StringToU64(rhs.substr(rstart, min(rend - rstart, sizeof(uint64_t))), 16, INVALID); } if (++count > 100) { printf("BusName comparison overflow.\n"); exit(1); } if (ln != rn) { return ln < rn; } lstart = lend + ((lend == qcc::String::npos) ? 0 : 1); rstart = rend + ((rend == qcc::String::npos) ? 0 : 1); } return (lstart == qcc::String::npos); } } }; typedef map BusNameMap; static QStatus ListBusNames(BusAttachment& bus, BusNameMap& names) { QStatus status; ProxyBusObject robj(bus, "org.freedesktop.DBus", "/org/freedesktop/DBus", 0); const InterfaceDescription* ifc = bus.GetInterface(org::freedesktop::DBus::InterfaceName); const InterfaceDescription::Member* listNames = ifc ? ifc->GetMember("ListNames") : NULL; const InterfaceDescription::Member* getNameOwner = ifc ? ifc->GetMember("GetNameOwner") : NULL; Message rsp(bus); if (!listNames || !getNameOwner) { return ER_FAIL; } robj.AddInterface(org::freedesktop::DBus::InterfaceName); robj.AddInterface(org::freedesktop::DBus::Introspectable::InterfaceName); status = robj.MethodCall(*listNames, NULL, 0, rsp); if (status == ER_OK) { const MsgArg* array = rsp->GetArg(0); const MsgArg* nameArray = array->v_array.GetElements(); for (size_t i = 0; (status == ER_OK) && (i < array->v_array.GetNumElements()); ++i, ++nameArray) { const char* name = nameArray->v_string.str; if (name[0] == ':') { if (names.find(name) == names.end()) { names[name] = ""; } } else { if (strcmp(name, "org.freedesktop.DBus") == 0) { names["----"] = name; } else { Message rsp(bus); MsgArg arg("s", name); ProxyBusObject dbusObj(bus.GetDBusProxyObj()); dbusObj.AddInterface(org::freedesktop::DBus::InterfaceName); dbusObj.AddInterface(org::freedesktop::DBus::Introspectable::InterfaceName); status = dbusObj.MethodCall(*getNameOwner, &arg, 1, rsp); if (status == ER_OK) { names[rsp->GetArg(0)->v_string.str] = name; } } } } } else { printf("Error:\n%s\n", rsp->ToString().c_str()); } return status; } static QStatus ListObjectPaths(BusAttachment& bus, ProxyBusObject& robj) { QStatus status = robj.IntrospectRemoteObject(); if (status == ER_OK) { size_t numChildren = robj.GetChildren(); ProxyBusObject** children = new ProxyBusObject*[numChildren]; robj.GetChildren(children, numChildren); Message rsp(bus); QStatus istatus = ER_OK; const InterfaceDescription* ifc = bus.GetInterface(org::freedesktop::DBus::Introspectable::InterfaceName); if (ifc == NULL) { istatus = ER_BUS_NO_SUCH_INTERFACE; QCC_LogError(istatus, ("Failed to get Introspect interface")); } if (istatus == ER_OK) { const InterfaceDescription::Member* member = ifc->GetMember("Introspect"); istatus = robj.MethodCall(*member, NULL, 0, rsp); } if (istatus == ER_OK) { const MsgArg* data = rsp->GetArg(0); const qcc::String s(data->v_string.str); if (s.find("& sigTokens, deque& argTokens, GroupType groupType = GT_NONE); static MsgArg* ProcessArray(deque& sigTokens, deque& argTokens) { const Token* token; deque sigTokensCopy; vector args; MsgArg* arg = NULL; qcc::String sig; do { sigTokensCopy = sigTokens; arg = ParseCallArgToken(sigTokensCopy, argTokens, GT_ARRAY); if (arg) { args.push_back(arg); } if (argTokens.size() == 0) { printf("Missing ']' grouping token for array.\n"); exit(1); } token = argTokens.front(); } while ((token->GetType() != Token::GROUPING) || (token->GetArg() != "]")); for (size_t i = 0; i < (sigTokens.size() - sigTokensCopy.size()); ++i) { sig += sigTokens[i]; } argTokens.pop_front(); sigTokens = sigTokensCopy; MsgArg* elements = new MsgArg[args.size()]; for (size_t i = 0; i < args.size(); ++i) { MsgArg* arg = args[i]; args[i] = NULL; elements[i] = *arg; delete arg; } arg = new MsgArg(ALLJOYN_ARRAY); arg->v_array.SetElements(sig.c_str(), args.size(), elements); return arg; } static MsgArg* ParseCallArgToken(deque& sigTokens, deque& argTokens, GroupType groupType) { MsgArg* arg = NULL; if (sigTokens.empty()) { printf("Too few tokens for signature.\n"); exit(1); } AllJoynTypeId sig = sigTokens.front(); if (argTokens.empty()) { printf("Too few tokens for signature.\n"); exit(1); } if (((groupType != GT_STRUCT) && (sig == ALLJOYN_STRUCT_CLOSE)) || ((groupType != GT_DICT) && (sig == ALLJOYN_DICT_ENTRY_CLOSE))) { printf("Unbalanced '%c' signature token encountered.\n", sig); exit(1); } const Token& token = *argTokens.front(); bool typeOK = false; sigTokens.pop_front(); argTokens.pop_front(); switch (sig) { case ALLJOYN_BOOLEAN: case ALLJOYN_BYTE: case ALLJOYN_DOUBLE: case ALLJOYN_INT16: case ALLJOYN_INT32: case ALLJOYN_INT64: case ALLJOYN_OBJECT_PATH: case ALLJOYN_SIGNATURE: case ALLJOYN_STRING: case ALLJOYN_UINT16: case ALLJOYN_UINT32: case ALLJOYN_UINT64: case ALLJOYN_VARIANT: typeOK = token.GetType() == Token::ARGUMENT; break; case ALLJOYN_ARRAY: case ALLJOYN_DICT_ENTRY_OPEN: case ALLJOYN_DICT_ENTRY_CLOSE: case ALLJOYN_STRUCT_OPEN: case ALLJOYN_STRUCT_CLOSE: typeOK = token.GetType() == Token::GROUPING; break; case ALLJOYN_INVALID: printf("Invalid signature element: '\\0' (NUL terminator is invalid).\n"); exit(1); case ALLJOYN_DICT_ENTRY: printf("Invalid signature element: 'e' (use '{' and '}' for dict entries).\n"); exit(1); case ALLJOYN_STRUCT: printf("Invalid signature element: 'r' (use '(' and ')' for struct entries).\n"); exit(1); default: assert(sig < 256); // should be impossible for the parser to allow this to happen } if (!typeOK) { switch (token.GetType()) { case Token::ARGUMENT: printf("Expected grouping token ('[' or ']') instead of '%s'\n", token.GetArg().c_str()); break; case Token::GROUPING: printf("Expected call argument value token instead of grouping token '%s'\n", token.GetArg().c_str()); break; default: printf("Unknown token type: %d\n", token.GetType()); break; } exit(1); } if ((token.GetType() == Token::GROUPING) && (token.GetArg() == "]")) { if (groupType == GT_NONE) { printf("Unbalanced ']' grouping token encountered.\n"); exit(1); } else if (groupType == GT_ARRAY) { return NULL; } } switch (sig) { case ALLJOYN_BOOLEAN: arg = new MsgArg(sig); if (strcmp(token.GetArg().c_str(), "false") == 0) { arg->v_bool = false; } else if (strcmp(token.GetArg().c_str(), "true") == 0) { arg->v_bool = true; } else { arg->v_bool = static_cast(StringToU32(token.GetArg(), 0, 1)); } break; case ALLJOYN_BYTE: arg = new MsgArg(sig); arg->v_byte = static_cast(StringToU32(token.GetArg())); break; case ALLJOYN_INT16: arg = new MsgArg(sig); arg->v_int16 = static_cast(StringToI32(token.GetArg())); break; case ALLJOYN_UINT16: arg = new MsgArg(sig); arg->v_uint16 = static_cast(StringToU32(token.GetArg())); break; case ALLJOYN_INT32: arg = new MsgArg(sig); arg->v_int32 = StringToI32(token.GetArg()); break; case ALLJOYN_UINT32: arg = new MsgArg(sig); arg->v_uint32 = StringToU32(token.GetArg()); break; case ALLJOYN_INT64: arg = new MsgArg(sig); arg->v_int64 = StringToI64(token.GetArg()); break; case ALLJOYN_UINT64: arg = new MsgArg(sig); arg->v_uint64 = StringToU64(token.GetArg()); break; case ALLJOYN_DOUBLE: arg = new MsgArg(sig); arg->v_double = StringToDouble(token.GetArg()); break; case ALLJOYN_STRING: arg = new MsgArg("s", token.GetArg().c_str()); break; case ALLJOYN_OBJECT_PATH: arg = new MsgArg("o", token.GetArg().c_str()); break; case ALLJOYN_SIGNATURE: arg = new MsgArg("g", token.GetArg().c_str()); break; case ALLJOYN_ARRAY: if (token.GetArg() == "[") { arg = ProcessArray(sigTokens, argTokens); } else { printf("Missing expected '[' grouping token.\n"); exit(1); } break; case ALLJOYN_DICT_ENTRY_OPEN: if (token.GetArg() == "[") { arg = new MsgArg(ALLJOYN_DICT_ENTRY); arg->v_dictEntry.key = ParseCallArgToken(sigTokens, argTokens, GT_DICT); arg->v_dictEntry.val = ParseCallArgToken(sigTokens, argTokens, GT_DICT); // Verify and eat the closing ']' if (sigTokens.empty() || (sigTokens.front() != ALLJOYN_DICT_ENTRY_CLOSE) || (ParseCallArgToken(sigTokens, argTokens, GT_DICT) != NULL)) { printf("A dict entry type may only have 2 complete types.\n"); exit(1); } } else { printf("Missing expected '[' grouping token for dict entry.\n"); exit(1); } break; case ALLJOYN_DICT_ENTRY_CLOSE: if (token.GetArg() != "]") { printf("Expected ']' grouping token for end of dict entry (got \"%s\").\n", token.GetArg().c_str()); exit(1); } break; case ALLJOYN_STRUCT_OPEN: if (token.GetArg() == "[") { qcc::String ts("("); while (((ts.size() - 1) < sigTokens.size()) && (SignatureUtils::CountCompleteTypes(ts.c_str()) == 0)) { ts += sigTokens[ts.size() - 1]; } if (SignatureUtils::CountCompleteTypes(ts.c_str()) == 1) { qcc::String structSig(ts.substr(1, ts.size() - 2)); size_t numMembers = SignatureUtils::CountCompleteTypes(structSig.c_str()); arg = new MsgArg(ALLJOYN_STRUCT); arg->v_struct.numMembers = numMembers; arg->v_struct.members = new MsgArg[numMembers]; for (size_t i = 0; i < numMembers; ++i) { MsgArg* a = ParseCallArgToken(sigTokens, argTokens, GT_STRUCT); arg->v_struct.members[i] = *a; delete a; } // Verify and eat the closing ']' if (sigTokens.empty() || (sigTokens.front() != ALLJOYN_STRUCT_CLOSE) || (ParseCallArgToken(sigTokens, argTokens, GT_STRUCT) != NULL)) { printf("A dict entry type may only have 2 complete types.\n"); exit(1); } } else { printf("Could not determine number of complete types in struct (%s)\n", ts.c_str()); exit(1); } } else { printf("Missing expected '[' grouping token for struct.\n"); exit(1); } break; case ALLJOYN_STRUCT_CLOSE: if (token.GetArg() != "]") { printf("Expected ']' grouping token for end of struct (got \"%s\").\n", token.GetArg().c_str()); exit(1); } break; case ALLJOYN_VARIANT: { qcc::String vsig(token.GetArg()); if (vsig[vsig.size() - 1] == ':') { vsig.resize(vsig.size() - 1); vsig.resize(1); } if (SignatureUtils::CountCompleteTypes(vsig.c_str()) != 1) { printf("Variant parameters must resolve to a single complete type.\n"); exit(1); } deque vargTokens(argTokens.begin(), argTokens.end()); deque vsigTokens; for (qcc::String::const_iterator vs = vsig.begin(); vs != vsig.end(); ++vs) { vsigTokens.push_back(static_cast(*vs)); } arg = new MsgArg(sig); arg->v_variant.val = ParseCallArgToken(vsigTokens, vargTokens); assert(vsigTokens.empty()); while (argTokens.size() > vargTokens.size()) { argTokens.pop_front(); } break; } default: break; } return arg; } static void TokenizeCmdLineArgs(vector& tlist) { qcc::String tok; for (int i = 0; i < callArgc; ++i) { size_t argLen = strlen(callArgv[i]); bool esc = false; tok.reserve(argLen + 1); tok.clear(); for (char* t = callArgv[i]; t < (callArgv[i] + argLen); ++t) { if (esc) { esc = false; tok += *t; } else { if (*t == '\\') { esc = true; } else if (*t == '[' || *t == ']') { if (!tok.empty()) { tlist.push_back(Token(Token::ARGUMENT, tok)); tok.clear(); } tlist.push_back(Token(Token::GROUPING, qcc::String(t, 1))); } else { tok += *t; } } } if (!tok.empty() || (argLen == 0)) { tlist.push_back(Token(Token::ARGUMENT, tok)); } } } static void ParseMethodCallArgs(qcc::String signature, MsgArg* argList) { deque argTokens; deque sigTokens; vector tokenList; for (qcc::String::const_iterator sig = signature.begin(); sig != signature.end(); ++sig) { sigTokens.push_back(static_cast(*sig)); } TokenizeCmdLineArgs(tokenList); for (vector::const_iterator it = tokenList.begin(); it != tokenList.end(); ++it) { argTokens.push_back(&(*it)); } while (!sigTokens.empty()) { MsgArg* arg = ParseCallArgToken(sigTokens, argTokens); if (arg) { *argList++ = *arg; delete arg; } } if (!argTokens.empty()) { printf("%u extra token%s do%s not match up with call signature.\n", static_cast(argTokens.size()), argTokens.size() == 1 ? "" : "s", argTokens.size() == 1 ? "es" : ""); exit(1); } } static QStatus MethodCall(BusAttachment& bus, bool introspect) { QStatus status; ProxyBusObject robj(bus, dest.c_str(), objPath.c_str(), 0); const InterfaceDescription* ifc = NULL; const InterfaceDescription::Member* member; Message rsp(bus); MsgArg* argList; size_t numArgs; size_t ifcEnd = method.find_last_of('.'); qcc::String ifcStr(method.substr(0, ifcEnd)); qcc::String memberStr(method.substr(ifcEnd + 1)); robj.AddInterface(org::freedesktop::DBus::InterfaceName); robj.AddInterface(org::freedesktop::DBus::Introspectable::InterfaceName); if (introspect) { status = robj.IntrospectRemoteObject(); if (status != ER_OK) { goto exit; } ifc = robj.GetInterface(ifcStr.c_str()); if (!ifc) { printf("Failed to lookup interface %s on %s\n", ifcStr.c_str(), robj.GetPath().c_str()); status = ER_FAIL; goto exit; } } else { InterfaceDescription* newifc = NULL; status = bus.CreateInterface(ifcStr.c_str(), newifc); if ((status == ER_OK) && newifc) { newifc->AddMember(MESSAGE_METHOD_CALL, memberStr.c_str(), signature.c_str(), "*", NULL, 0); newifc->Activate(); ifc = newifc; } else { if (status == ER_BUS_IFACE_ALREADY_EXISTS) { ifc = bus.GetInterface(ifcStr.c_str()); if (ifc) { status = ER_OK; } } } if ((status != ER_OK) || !ifc) { status = (status == ER_OK) ? ER_FAIL : status; printf("Interface definition failure: %s\n", QCC_StatusText(status)); goto exit; } status = robj.AddInterface(*ifc); if (status != ER_OK) { printf("Failed to add interface %s to %s\n", ifcStr.c_str(), robj.GetPath().c_str()); goto exit; } } member = ifc->GetMember(memberStr.c_str()); if (introspect) { signature = member->signature; } if (callArgc == 0) { if (!signature.empty()) { printf("Missing parameters for call signature: \"%s\"\n", signature.c_str()); exit(1); } } else if (signature.empty()) { printf("No call signature for given parameters.\n"); exit(1); } numArgs = SignatureUtils::CountCompleteTypes(signature.c_str()); argList = new MsgArg[numArgs]; ParseMethodCallArgs(signature, argList); printf("Calling %s with:\n%s\n", method.c_str(), MsgArg::ToString(argList, numArgs).c_str()); status = robj.MethodCall(*member, argList, numArgs, rsp); if (status == ER_OK) { const MsgArg* data = rsp->GetArg(0); if (data) { printf("Reply:\n%s\n", data->ToString().c_str()); } else { printf("No reply data\n"); } } else { printf("Error:\n%s\n", rsp->ToString().c_str()); } delete [] argList; exit: return status; } static QStatus List(BusAttachment& bus) { BusNameMap names; QStatus status = ListBusNames(bus, names); map sorted; if (status == ER_OK) { BusNameMap::const_iterator it; it = names.end(); --it; size_t width = it->first.size(); for (it = names.begin(); it != names.end(); ++it) { if (!it->second.empty()) { sorted[it->second] = it->first; } } map::const_iterator sit; for (sit = sorted.begin(); sit != sorted.end(); ++sit) { printf("%-*s %s\n", static_cast(width), sit->second.c_str(), sit->first.c_str()); } } return status; } static QStatus ListAll(BusAttachment& bus) { BusNameMap names; QStatus status = ListBusNames(bus, names); if (status == ER_OK) { BusNameMap::const_iterator it; it = names.end(); --it; size_t width = it->first.size(); for (it = names.begin(); it != names.end(); ++it) { if (it->second.empty()) { printf("%s\n", it->first.c_str()); } else { printf("%-*s %s\n", static_cast(width), it->first.c_str(), it->second.c_str()); } } } return status; } static QStatus ListObjects(BusAttachment& bus) { ProxyBusObject robj(bus, dest.c_str(), "/", 0); robj.AddInterface(org::freedesktop::DBus::InterfaceName); robj.AddInterface(org::freedesktop::DBus::Introspectable::InterfaceName); return ListObjectPaths(bus, robj); } static QStatus Introspect(BusAttachment& bus) { QStatus status; ProxyBusObject robj(bus, dest.c_str(), objPath.c_str(), 0); Message rsp(bus); robj.AddInterface(org::freedesktop::DBus::InterfaceName); robj.AddInterface(org::freedesktop::DBus::Introspectable::InterfaceName); status = robj.IntrospectRemoteObject(); if (status == ER_OK) { size_t numIfaces = robj.GetInterfaces(); const InterfaceDescription** ifaces = new const InterfaceDescription*[numIfaces]; robj.GetInterfaces(ifaces, numIfaces); for (size_t i = 0; i < numIfaces; i++) { const InterfaceDescription* ifc = ifaces[i]; size_t numMembers = ifc->GetMembers(); const InterfaceDescription::Member** members = new const InterfaceDescription::Member*[numMembers]; ifc->GetMembers(members, numMembers); for (size_t m = 0; m < numMembers; m++) { if (members[m]->memberType == MESSAGE_METHOD_CALL) { const qcc::String inSig(members[m]->signature); const qcc::String outSig(members[m]->returnSignature); if (outSig.empty()) { printf("METHOD: %s.%s(%s)\n", ifc->GetName(), members[m]->name.c_str(), inSig.c_str()); } else { printf("METHOD: %s.%s(%s) -> %s\n", ifc->GetName(), members[m]->name.c_str(), inSig.c_str(), outSig.c_str()); } } } for (size_t m = 0; m < numMembers; m++) { if (members[m]->memberType == MESSAGE_SIGNAL) { const qcc::String inSig(members[m]->signature); printf("SIGNAL: %s.%s(%s)\n", ifc->GetName(), members[m]->name.c_str(), inSig.c_str()); } } if (i != (numIfaces - 1)) { printf("\n"); } } delete [] ifaces; } else { printf("Error: Failed to introspect %s at %s.\n", objPath.c_str(), dest.c_str()); } return status; } static void VersionInfo(void) { printf("AllJoyn Library version: %s\n", ajn::GetVersion()); printf("AllJoyn Library build info: %s\n", ajn::GetBuildInfo()); } static void Usage(void) { printf("Usage: mcmd [method call parameters...]\n" "\n" " -h Print this help message\n" " -v Print version information\n" " -b Use specified bus address\n" " -d Specify bus destination (i.e. well known name)\n" " -o Specify object path\n" " -l List well known names on bus\n" " -lo List objects on an endpoint (requires -d)\n" " -a List all nodes on bus\n" " -i Introspect Object\n" " -c Make method call to (requires -d and -o)\n" "\n" "Method call parameters are prefixed by the parameter signature. If the \"-i\"\n" "option is specified along with the \"-c\" option then the parameter signature\n" "must be omitted. The \"-i\" option will automatically introspect the\n" "interface for the method call. If a parameter signature includes the variant\n" "type, then the associated parameter value must be prefixed with the actual\n" "type (this applies to introspected interfaces as well). The square brackets,\n" "'[' and ']', are used for grouping arrays, structs, and dict entries. All\n" "parameters must be space separated. Spaces around grouping tokens are\n" "optional. Colons after the signatures are also optional. Parameter examples\n" "are given below:\n" "\n" "aiai: [1 2 3] [4 5 6 7 8]\n" "aai: [[1 2 3] [4 5] [6 7 8 9]]\n" "\"a((ii)i):\" [[[123 456] 789] [[111 222] 333]]\n" "\"a{si}:\" [[one 1] [two 2] [three 3]]\n" "av: [s: \"hello world\" i: 42 o: /path/to/obj]\n" "\"a{sv}:\" [[key1 s: value1] [key2 i: 123] [key3 as: [one two three]]]\n" "\n" "NOTE: Shell quoting rules apply - e.g., \"hello world\" is 1 parameter, not 2.\n" ); } static void ParseCmdLine(int argc, char** argv) { int i; for (i = 1; i < argc; ++i) { if (strcmp(argv[i], "-h") == 0) { Usage(); exit(0); } else if (strcmp(argv[i], "-v") == 0) { VersionInfo(); exit(0); } else if (strcmp(argv[i], "-b") == 0) { ++i; if (i == argc) { printf("Option \"-b\" requires a bus specification\n"); exit(1); } busAddr = argv[i]; } else if (strcmp(argv[i], "-d") == 0) { ++i; if (i == argc) { printf("Option \"-d\" requires a bus node destination\n"); exit(1); } dest = argv[i]; } else if (strcmp(argv[i], "-o") == 0) { ++i; if (i == argc) { printf("Option \"-o\" requires an object path\n"); exit(1); } objPath = argv[i]; } else if (strcmp(argv[i], "-lo") == 0) { if (action != NO_ACTION) { printf("Only one of \"-f\", \"-l\", \"-lo\", \"-a\", \"-i\", \"-c\" may be used.\n"); exit(1); } if (dest.empty()) { printf("Must specify a destination from which to list objects.\n"); exit(1); } action = LIST_OBJECTS; } else if (strcmp(argv[i], "-l") == 0) { if (action != NO_ACTION) { printf("Only one of \"-f\", \"-l\", \"-lo\", \"-a\", \"-i\", \"-c\" may be used.\n"); exit(1); } action = LIST; } else if (strcmp(argv[i], "-a") == 0) { if (action != NO_ACTION) { printf("Only one of \"-f\", \"-l\", \"-lo\", \"-a\", \"-i\", \"-c\" may be used.\n"); exit(1); } action = LIST_ALL; } else if (strcmp(argv[i], "-i") == 0) { if (action != NO_ACTION) { printf("Only one of \"-f\", \"-l\", \"-lo\", \"-a\", \"-i\", \"-c\" may be used.\n"); exit(1); } if (dest.empty()) { printf("Must specify a destination to introspect\n"); exit(1); } action = INTROSPECT; } else if (strcmp(argv[i], "-c") == 0) { if ((action != NO_ACTION) && (action != INTROSPECT)) { printf("Cannot use \"-c\" with \"-l\", \"-lo\", \"-a\".\n"); exit(1); } if (i == argc) { printf("Option \"-c\" requires an interface.method_name to call.\n"); exit(1); } if (dest.empty() || objPath.empty()) { printf("Must specify a destination and object path implementing the method to call\n"); exit(1); } ++i; method = argv[i]; ++i; if (action == INTROSPECT) { action = METHOD_CALL_INTROSPECT; } else { action = METHOD_CALL; if (i < argc) { signature = argv[i]; if (signature.find_last_of(':') == (signature.size() - 1)) { // Strip off trailing ':'. Signature will be validated later. signature.resize(signature.size() - 1); } ++i; } } callArgc = argc - i; callArgv = &argv[i]; i += callArgc; // all remaining args are hereby consumed. } else { printf("Unkown command line argument: \"%s\"\n", argv[i]); exit(1); } } } /** Main entry point */ int CDECL_CALL main(int argc, char** argv) { QStatus status = ER_OK; qcc::GUID128 guid; Environ* env; /* Parse command line args */ ParseCmdLine(argc, argv); /* Create message bus */ // Bus bus("mcmd", &BTTransportFactory); BusAttachment bus("mcmd"); #if !defined(QCC_OS_GROUP_WINDOWS) && !defined(QCC_OS_DARWIN) btTrans = new BTTransport(bus); #endif /* Get env vars */ if (busAddr.empty()) { env = Environ::GetAppEnviron(); busAddr = env->Find("DBUS_SESSION_BUS_ADDRESS", "unix:abstract=alljoyn"); } /* Start the msg bus */ status = bus.Start(); if (ER_OK != status) { QCC_LogError(status, ("BusAttachment::Start failed")); goto cleanup; } if (!busAddr.empty()) { /* Create the client-side endpoint */ status = bus.Connect(busAddr.c_str()); if (status != ER_OK) { QCC_LogError(status, ("Failed to connect")); goto cleanup; } } switch (action) { case NO_ACTION: break; case LIST: status = List(bus); break; case LIST_ALL: status = ListAll(bus); break; case LIST_OBJECTS: status = ListObjects(bus); break; case INTROSPECT: status = Introspect(bus); break; case METHOD_CALL: case METHOD_CALL_INTROSPECT: status = MethodCall(bus, action == METHOD_CALL_INTROSPECT); break; } cleanup: return (int) status; } alljoyn-15.04b/alljoyn_core/router/test/ns.cc000066400000000000000000000370701255700255500212600ustar00rootroot00000000000000/** * @file * Prototype code for accessing avahi Dbus API directly. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #include #include #include #include #include #include #include // For qcc::Sleep() #include #include #include #include #include #define QCC_MODULE "ALLJOYN" using namespace ajn; static const char config[] = "" ""; char const* g_names[] = { "org.randomteststring.A", "org.randomteststring.B", "org.randomteststring.C", "org.randomteststring.D", "org.randomteststring.E", "org.randomteststring.F", "org.randomteststring.G", "org.randomteststring.H", "org.randomteststring.I", "org.randomteststring.J", "org.randomteststring.K", "org.randomteststring.L", "org.randomteststring.M", "org.randomteststring.N", "org.randomteststring.O", "org.randomteststring.P", "org.randomteststring.Q", "org.randomteststring.R", "org.randomteststring.S", "org.randomteststring.T", "org.randomteststring.U", "org.randomteststring.V", "org.randomteststring.W", "org.randomteststring.X", "org.randomteststring.Y", "org.randomteststring.Z", }; const uint32_t g_numberNames = sizeof(g_names) / sizeof(char const*); char const* g_longnames[] = { "org.thisisaverlongnamethatisusedtotestthemultiplemessageoutputcoderandomteststring.A", "org.thisisaverlongnamethatisusedtotestthemultiplemessageoutputcoderandomteststring.B", "org.thisisaverlongnamethatisusedtotestthemultiplemessageoutputcoderandomteststring.C", "org.thisisaverlongnamethatisusedtotestthemultiplemessageoutputcoderandomteststring.D", "org.thisisaverlongnamethatisusedtotestthemultiplemessageoutputcoderandomteststring.E", "org.thisisaverlongnamethatisusedtotestthemultiplemessageoutputcoderandomteststring.F", "org.thisisaverlongnamethatisusedtotestthemultiplemessageoutputcoderandomteststring.G", "org.thisisaverlongnamethatisusedtotestthemultiplemessageoutputcoderandomteststring.H", "org.thisisaverlongnamethatisusedtotestthemultiplemessageoutputcoderandomteststring.I", "org.thisisaverlongnamethatisusedtotestthemultiplemessageoutputcoderandomteststring.J", "org.thisisaverlongnamethatisusedtotestthemultiplemessageoutputcoderandomteststring.K", "org.thisisaverlongnamethatisusedtotestthemultiplemessageoutputcoderandomteststring.L", "org.thisisaverlongnamethatisusedtotestthemultiplemessageoutputcoderandomteststring.M", "org.thisisaverlongnamethatisusedtotestthemultiplemessageoutputcoderandomteststring.N", "org.thisisaverlongnamethatisusedtotestthemultiplemessageoutputcoderandomteststring.O", "org.thisisaverlongnamethatisusedtotestthemultiplemessageoutputcoderandomteststring.P", "org.thisisaverlongnamethatisusedtotestthemultiplemessageoutputcoderandomteststring.Q", "org.thisisaverlongnamethatisusedtotestthemultiplemessageoutputcoderandomteststring.R", "org.thisisaverlongnamethatisusedtotestthemultiplemessageoutputcoderandomteststring.S", "org.thisisaverlongnamethatisusedtotestthemultiplemessageoutputcoderandomteststring.T", "org.thisisaverlongnamethatisusedtotestthemultiplemessageoutputcoderandomteststring.U", "org.thisisaverlongnamethatisusedtotestthemultiplemessageoutputcoderandomteststring.V", "org.thisisaverlongnamethatisusedtotestthemultiplemessageoutputcoderandomteststring.W", "org.thisisaverlongnamethatisusedtotestthemultiplemessageoutputcoderandomteststring.X", "org.thisisaverlongnamethatisusedtotestthemultiplemessageoutputcoderandomteststring.Y", "org.thisisaverlongnamethatisusedtotestthemultiplemessageoutputcoderandomteststring.Z", }; const uint32_t g_numberLongnames = sizeof(g_longnames) / sizeof(char const*); class Finder { public: void Callback(const qcc::String& busAddr, const qcc::String& guid, std::vector& wkn, uint32_t timer) { printf("Callback %s with guid %s and timer %d: ", busAddr.c_str(), guid.c_str(), timer); for (uint32_t i = 0; i < wkn.size(); ++i) { printf("%s ", wkn[i].c_str()); } printf("\n"); m_called = true; m_guid = guid; m_wkn = wkn; m_timer = timer; } void Reset(void) { m_called = false; m_guid.clear(); m_wkn.clear(); } bool GetCalled() { return m_called; } qcc::String GetGuid() { return m_guid; } std::vector GetWkn() { return m_wkn; } uint8_t GetTimer() { return m_timer; } private: bool m_called; qcc::String m_guid; std::vector m_wkn; uint8_t m_timer; }; static void PrintFlags(uint32_t flags) { printf("("); if (flags & qcc::IfConfigEntry::UP) { printf("UP "); } if (flags & qcc::IfConfigEntry::BROADCAST) { printf("BROADCAST "); } if (flags & qcc::IfConfigEntry::DEBUG) { printf("DEBUG "); } if (flags & qcc::IfConfigEntry::LOOPBACK) { printf("LOOPBACK "); } if (flags & qcc::IfConfigEntry::POINTOPOINT) { printf("POINTOPOINT "); } if (flags & qcc::IfConfigEntry::RUNNING) { printf("RUNNING "); } if (flags & qcc::IfConfigEntry::NOARP) { printf("NOARP "); } if (flags & qcc::IfConfigEntry::PROMISC) { printf("PROMISC "); } if (flags & qcc::IfConfigEntry::NOTRAILERS) { printf("NOTRAILERS "); } if (flags & qcc::IfConfigEntry::ALLMULTI) { printf("ALLMULTI "); } if (flags & qcc::IfConfigEntry::MASTER) { printf("MASTER "); } if (flags & qcc::IfConfigEntry::SLAVE) { printf("SLAVE "); } if (flags & qcc::IfConfigEntry::MULTICAST) { printf("MULTICAST "); } if (flags & qcc::IfConfigEntry::PORTSEL) { printf("PORTSEL "); } if (flags & qcc::IfConfigEntry::AUTOMEDIA) { printf("AUTOMEDIA "); } if (flags & qcc::IfConfigEntry::DYNAMIC) { printf("DYNAMIC "); } if (flags) { printf("\b"); } printf(")"); } #define ERROR_EXIT exit(1) int CDECL_CALL main(int argc, char** argv) { if (AllJoynInit() != ER_OK) { return 1; } if (AllJoynRouterInit() != ER_OK) { AllJoynShutdown(); return 1; } QStatus status; uint16_t port = 0; bool advertise = false; bool useEth0 = false; bool runtests = false; bool wildcard = false; bool longnames = false; for (int i = 1; i < argc; ++i) { if (strcmp("-a", argv[i]) == 0) { advertise = true; } else if (strcmp("-e", argv[i]) == 0) { useEth0 = true; } else if (strcmp("-l", argv[i]) == 0) { longnames = true; } else if (strcmp("-t", argv[i]) == 0) { runtests = true; } else if (strcmp("-w", argv[i]) == 0) { wildcard = true; } else { printf("Unknown option %s\n", argv[i]); ERROR_EXIT;; } } if (runtests) { exit(0); } // // Load the configuration information // ConfigDB configdb(config); if (!configdb.LoadConfig()) { printf("Failed to load the internal config.\n"); ERROR_EXIT; } // // Test code // IpNameService::Instance(); // // Create an instance of the name service implementation. This cheats // big-time and allows us to get down into the guts of the IP name // service. // IpNameServiceImpl ns; // // Initialize to a random quid, and talk to ourselves. We don't have a // daemon config, so we expect to get the defalt setting for disabling // broadcasts, which is false. // status = ns.Init(qcc::GUID128().ToString(), true); if (status != ER_OK) { QCC_LogError(status, ("Init failed")); ERROR_EXIT; } status = ns.Start(); if (status != ER_OK) { QCC_LogError(status, ("Start failed")); ERROR_EXIT; } // // Figure out which interfaces we want to enable discovery on. // std::vector entries; status = qcc::IfConfig(entries); if (status != ER_OK) { QCC_LogError(status, ("IfConfig failed")); ERROR_EXIT; } printf("Checking out interfaces ...\n"); qcc::String overrideInterface; for (uint32_t i = 0; i < entries.size(); ++i) { if (!useEth0) { if (entries[i].m_name == "eth0") { printf("******** Ignoring eth0, use \"-e\" to enable \n"); continue; } } printf(" %s: ", entries[i].m_name.c_str()); printf("0x%x = ", entries[i].m_flags); PrintFlags(entries[i].m_flags); if (entries[i].m_flags & qcc::IfConfigEntry::UP) { printf(", MTU = %d, address = %s", entries[i].m_mtu, entries[i].m_addr.c_str()); if ((entries[i].m_flags & qcc::IfConfigEntry::LOOPBACK) == 0) { printf(" <--- Let's use this one"); overrideInterface = entries[i].m_name; // // Tell the name service to talk and listen over the interface we chose // above. // status = ns.OpenInterface(TRANSPORT_TCP, entries[i].m_name); if (status != ER_OK) { QCC_LogError(status, ("OpenInterface failed")); ERROR_EXIT; } } } printf("\n"); } srand(time(0)); // // Pick a random port to advertise. This is what would normally be the // daemon TCP well-known endpoint (9955) but we just make one up. N.B. this // is not the name service multicast port. // port = rand(); printf("Picked random port %d\n", port); // // Pretend we're the TCP transport and we want to advertise reliable and // unreliable IPv4 and IPv6 ports (all the same). // std::map portMap; portMap["*"] = port; status = ns.Enable(TRANSPORT_TCP, portMap, port, portMap, port, true, true, true, true); if (status != ER_OK) { QCC_LogError(status, ("Enable failed")); ERROR_EXIT; } Finder finder; ns.SetCallback(TRANSPORT_TCP, new CallbackImpl&, uint32_t>(&finder, &Finder::Callback)); if (wildcard) { // // Enable discovery on all of the test names in one go. // printf("FindAdvertisement org.randomteststring.*\n"); status = ns.FindAdvertisement(TRANSPORT_TCP, "name='org.randomteststring.*'", IpNameServiceImpl::ALWAYS_RETRY, TRANSPORT_TCP); if (status != ER_OK) { QCC_LogError(status, ("FindAdvertisedName failed")); ERROR_EXIT; } } else { // // Enable discovery on all of the test names individually // for (uint32_t i = 0; !wildcard && i < g_numberNames; ++i) { printf("FindAdvertisement %s\n", g_names[i]); qcc::String matching = qcc::String("name='") + g_names[i] + "'"; status = ns.FindAdvertisement(TRANSPORT_TCP, matching, IpNameServiceImpl::ALWAYS_RETRY, TRANSPORT_TCP); if (status != ER_OK) { QCC_LogError(status, ("FindAdvertisedName failed")); ERROR_EXIT; } } } if (longnames) { for (uint32_t i = 0; i < g_numberLongnames; ++i) { char const* wkn = g_longnames[i]; status = ns.AdvertiseName(TRANSPORT_TCP, wkn, false, TRANSPORT_TCP); printf("Advertised %s\n", wkn); } } uint32_t suffix = rand(); qcc::String wknStr = "org.alljoyn.BusNode.abc" + qcc::U32ToString(suffix, 16); // ComputeStaticScore using power_source, mobility, availability and node_type values uint32_t powerSource = 3; uint32_t mobility = 4; uint32_t availability = 8; uint32_t nodeType = 1; uint16_t staticScore = IpNameServiceImpl::ComputeStaticScore(powerSource, mobility, availability, nodeType); printf("Static score computed from power source=%d mobility=%d availability=%d nodeType=%d is %d\n", powerSource, mobility, availability, nodeType, staticScore); // ComputeDynamicScore using tcpAvail, tcpMax, udpAvail, udpMax, tclAvail and tclMax values uint32_t tcpAvail = 5; uint32_t tcpMax = 100; uint32_t udpAvail = 16; uint32_t udpMax = 16; uint32_t tclAvail = 10; uint32_t tclMax = 50; uint16_t dynamicScore = IpNameServiceImpl::ComputeDynamicScore(tcpAvail, tcpMax, udpAvail, udpMax, tclAvail, tclMax); printf("Dynamic score computed from tcpAvail=%d tcpMax=%d udpAvail=%d udpMax=%d tclAvail=%d tclMax=%d is %d\n", tcpAvail, tcpMax, udpAvail, udpMax, tclAvail, tclMax, dynamicScore); // ComputePriority using staticRank and dynamicRank values uint16_t priorityValue = IpNameServiceImpl::ComputePriority(staticScore, dynamicScore); printf("Priority computed from static score=%d and dynamic score=%d is %d\n", staticScore, dynamicScore, priorityValue); // Update the dynamic parameters ns.UpdateDynamicScore(TRANSPORT_TCP, 5, 100, 10, 50); // Get the current priority value uint16_t priority = ns.GetCurrentPriority(); printf("Current value for priority is %d\n", priority); ns.AdvertiseName(TRANSPORT_TCP, wknStr.c_str(), true, TRANSPORT_TCP); // // Hang around and mess with advertisements for a while. // for (uint32_t i = 0; i < 200; ++i) { // // Sleep for a while -- long enough for the name service to respond and // humans to observe what is happening. // printf("Zzzzz %d\n", i); qcc::Sleep(1000); if (advertise) { uint32_t nameIndex = rand() % g_numberNames; char const* wkn = g_names[nameIndex]; status = ns.AdvertiseName(TRANSPORT_TCP, wkn, false, TRANSPORT_TCP); printf("Advertised %s\n", wkn); if (status != ER_OK) { QCC_LogError(status, ("Advertise failed")); ERROR_EXIT; } nameIndex = rand() % g_numberNames; wkn = g_names[nameIndex]; status = ns.CancelAdvertiseName(TRANSPORT_TCP, wkn, TRANSPORT_TCP); printf("Cancelled %s\n", wkn); if (status != ER_OK) { QCC_LogError(status, ("Cancel failed")); ERROR_EXIT; } } } AllJoynRouterShutdown(); AllJoynShutdown(); return 0; } alljoyn-15.04b/alljoyn_core/router/test/org.alljoyn.bus.plist000066400000000000000000000012571255700255500244320ustar00rootroot00000000000000 Label org.alljoyn.bus ProgramArguments alljoyn-daemon --nofork --internal Sockets unix_domain_listener SecureSocketWithKey DBUS_LAUNCHD_SESSION_BUS_SOCKET alljoyn-15.04b/alljoyn_core/router/unicode.h000066400000000000000000000107441255700255500211500ustar00rootroot00000000000000#ifndef _UNICODE_H #define _UNICODE_H /** * @file * * This file defines a convenience abstraction layer for ConvertUTF. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef __cplusplus #error Only include unicode.h in C++ code. #endif #include #include #include #include "ConvertUTF.h" #include /* * wstring is defined in the android NDK 8 but not defined in NDK7 * So, defining wstring in case it is not defined */ namespace std { typedef basic_string wstring; } using namespace qcc; /** @internal */ #define QCC_MODULE "CONVERT_UTF" /** * Perform a UTF conversion from a UTF-8 sequence in a String to a UTF-16 * or UTF-32 sequence in a std::wstring. Whether UTF-16 or UTF-32 is used * depends on sizeof(wchar_t). * * @param src A UTF-8 sequence in a String. * @param dest OUT: A reference to where the UTF-16/-32 sequence is to be * written. * @param strict Indicate whether src is checked for strict compliance with * the Unicode spec or not. * * @return ER_OK is conversion was successful; ER_UTF_CONVERSION_FAILED if * conversion was unsuccessful. */ inline QStatus ConvertUTF(const String src, std::wstring& dest, bool strict = false) { QStatus status = ER_OK; ConversionResult result; const UTF8*srcStart = reinterpret_cast(src.c_str()); size_t strLen = src.length(); WideUTF*tmpDest = new WideUTF[strLen]; WideUTF*tmpDestStart = tmpDest; result = ConvertUTF8ToWChar(&srcStart, srcStart + strLen, &tmpDestStart, tmpDest + strLen, strict ? strictConversion : lenientConversion); if (result != conversionOK) { status = ER_UTF_CONVERSION_FAILED; QCC_LogError(status, ("ConvertUTF string -> wstring: %d", result)); goto exit; } dest = std::wstring(reinterpret_cast(tmpDest), tmpDestStart - tmpDest); exit: delete tmpDest; return status; } /** * @overload * Perform a UTF conversion from a UTF-16 or UTF-32 sequence in a * std::wstring to a UTF-8 sequence in a String. Whether UTF-16 or * UTF-32 is used depends on sizeof(wchar_t). * * @param src A UTF-16/-32 sequence in a std::wstring. * @param dest OUT: A reference to where the UTF-8 sequence is to be * written. * @param strict Indicate whether src is checked for strict compliance with * the Unicode spec or not. * * @return ER_OK is conversion was successful; ER_UTF_CONVERSION_FAILED if * conversion was unsuccessful. */ inline QStatus ConvertUTF(const std::wstring src, String& dest, bool strict = false) { QStatus status = ER_OK; ConversionResult result; const WideUTF*srcStart = reinterpret_cast(src.data()); size_t srcStrLen = src.length(); size_t destStrLen = srcStrLen * 4; // Need extra room for multi-byte characters. UTF8*tmpDest = new UTF8[destStrLen]; UTF8*tmpDestStart = tmpDest; result = ConvertWCharToUTF8(&srcStart, srcStart + srcStrLen, &tmpDestStart, tmpDest + destStrLen, strict ? strictConversion : lenientConversion); if (result != conversionOK) { status = ER_UTF_CONVERSION_FAILED; QCC_LogError(status, ("ConvertUTF wstring -> string: %d", result)); goto exit; } dest = String(reinterpret_cast(tmpDest), tmpDestStart - tmpDest); exit: delete tmpDest; return status; } #undef QCC_MODULE #endif alljoyn-15.04b/alljoyn_core/router/windows/000077500000000000000000000000001255700255500210355ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/router/windows/DaemonLib.h000066400000000000000000000037131255700255500230440ustar00rootroot00000000000000/** * @file * DaemonLib.h */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #pragma once #include #include // The following ifdef block is the standard way of creating macros which make exporting // from a DLL simpler. All files within this DLL are compiled with the DAEMONLIBRARY_EXPORTS // symbol defined on the command line. this symbol should not be defined on any project // that uses this DLL. This way any other project whose source files include this file see // DAEMONLIBRARY_API functions as being imported from a DLL, whereas this DLL sees symbols // defined with this macro as being exported. #ifdef DAEMONLIBRARY_EXPORTS #define DAEMONLIBRARY_API __declspec(dllexport) #else #define DAEMONLIBRARY_API __declspec(dllimport) #endif extern char g_logFilePathName[]; extern bool g_isManaged; extern "C" DAEMONLIBRARY_API void DaemonMain(wchar_t* cmd); extern "C" DAEMONLIBRARY_API void SetLogFile(wchar_t* str); extern "C" DAEMONLIBRARY_API int LoadDaemon(int argc, char** argv); extern "C" DAEMONLIBRARY_API void UnloadDaemon(); alljoyn-15.04b/alljoyn_core/router/windows/DaemonResources.rc000066400000000000000000000065201255700255500244640ustar00rootroot00000000000000/** * @file * Resource file script for AllJoyn Daemon dynamic link library (Win32) */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #ifndef DEBUG #define VER_DEBUG 0 #else #define VER_DEBUG VS_FF_DEBUG #endif /****************************************************************************** * Version ******************************************************************************/ #define VER_FILEVERSION 15,4,0,98 #define VER_FILEVERSION_STR "15.04.00b\0" #define VER_PRODUCTVERSION 15,4,0,98 #define VER_PRODUCTVERSION_STR "15.04.00b\0" #define VER_PRIVATEBUILD 0 #define VER_PRERELEASE 0 #define VER_COMPANYNAME_STR "AllSeen Alliance.\0" #define VER_FILEDESCRIPTION_STR "AllJoyn Daemon dynamic link library\0" #define VER_LEGALCOPYRIGHT_STR "Copyright AllSeen Alliance.\0" #define VER_INTERNALNAME_STR "daemonlib.dll\0" #define VER_ORIGINALFILENAME_STR "daemonlib.dll\0" #define VER_PRODUCTNAME_STR "daemonlib.dll\0" VS_VERSION_INFO VERSIONINFO FILEVERSION VER_FILEVERSION PRODUCTVERSION VER_PRODUCTVERSION FILEFLAGSMASK VS_FFI_FILEFLAGSMASK FILEFLAGS (VER_PRIVATEBUILD|VER_PRERELEASE|VER_DEBUG) FILEOS VOS__WINDOWS32 FILETYPE VFT_DLL FILESUBTYPE VFT2_UNKNOWN BEGIN BLOCK "StringFileInfo" BEGIN BLOCK "040904E4" BEGIN VALUE "CompanyName", VER_COMPANYNAME_STR VALUE "FileDescription", VER_FILEDESCRIPTION_STR VALUE "FileVersion", VER_FILEVERSION_STR VALUE "InternalName", VER_INTERNALNAME_STR VALUE "LegalCopyright", VER_LEGALCOPYRIGHT_STR VALUE "OriginalFilename", VER_ORIGINALFILENAME_STR VALUE "ProductName", VER_PRODUCTNAME_STR VALUE "ProductVersion", VER_PRODUCTVERSION_STR END END BLOCK "VarFileInfo" BEGIN /* The following line should only be modified for localized versions. */ /* It consists of any number of WORD,WORD pairs, with each pair */ /* describing a language,codepage combination supported by the file. */ /* */ /* For example, a file might have values "0x409,1252" indicating that it */ /* supports English language (0x409) in the Windows ANSI codepage (1252). */ VALUE "Translation", 0x409, 1252 END END alljoyn-15.04b/alljoyn_core/router/windows/DaemonTransportWindows.cc000066400000000000000000000033541255700255500260440ustar00rootroot00000000000000/** * @file */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include "../DaemonTransport.h" #define QCC_MODULE "ALLJOYN" using namespace std; using namespace qcc; namespace ajn { const char* DaemonTransport::TransportName = ""; void* DaemonTransport::Run(void* arg) { QCC_UNUSED(arg); return NULL; } QStatus DaemonTransport::NormalizeTransportSpec(const char* inSpec, qcc::String& outSpec, map& argMap) const { QCC_UNUSED(inSpec); QCC_UNUSED(outSpec); QCC_UNUSED(argMap); return ER_OK; } QStatus DaemonTransport::StartListen(const char* listenSpec) { QCC_UNUSED(listenSpec); return ER_OK; } QStatus DaemonTransport::StopListen(const char* listenSpec) { QCC_UNUSED(listenSpec); return ER_OK; } } // namespace ajn alljoyn-15.04b/alljoyn_core/router/windows/NamedPipeDaemonTransport.cc000066400000000000000000000674271255700255500262670ustar00rootroot00000000000000/** * @file * NamedPipeDaemonTransport (Daemon Transport for named pipe) implementation for Windows */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ /* * Compile this file only for Windows version 10 or greater. */ #if (_WIN32_WINNT > 0x0603) #include #include #include #include #include #include #include #include #include #include #include #include #include #include "BusInternal.h" #include "RemoteEndpoint.h" #include "Router.h" #include "NamedPipeDaemonTransport.h" #include "unicode.h" #include "ConfigDB.h" #include #define QCC_MODULE "DAEMON_TRANSPORT" using namespace std; using namespace qcc; namespace ajn { const char* NamedPipeDaemonTransport::NamedPipeTransportName = "npipe"; /* * An endpoint class to handle the details of authenticating a connection. */ class _NamedPipeDaemonEndpoint : public _RemoteEndpoint { friend class NamedPipeDaemonTransport; public: enum AuthState { AUTH_ILLEGAL = 0, AUTH_INITIALIZED = 1, /**< Initialized but authentication has been scheduled yet */ AUTH_AUTHENTICATING = 2, /**< Authentication is in progress */ AUTH_FAILED = 3, /**< Authentication and the authentication thread is exiting immidiately */ AUTH_SUCCEEDED = 4, /**< The auth process (Establish) has succeeded and the connection is ready to be started */ AUTH_STOPPING = 5, /**< Authentication is being stopped */ AUTH_STOPPED = 6, /**< Authentication has been stopped */ }; /** * Constructor. */ _NamedPipeDaemonEndpoint(_In_ BusAttachment& bus, _In_ HANDLE pipeHandle, _In_ NamedPipeDaemonTransport* transport); /** * Destructor. */ virtual ~_NamedPipeDaemonEndpoint(); /** * Ask the endpoint to stop executing. * * @return * - ER_OK if successful. * - An error status otherwise. */ virtual QStatus Stop(); /** * Join the endpoint. * Block the caller until the endpoint is stopped. * * @return ER_OK if successful. */ virtual QStatus Join(); private: /** * Queue a thread pool work item that performs endpoint authentication. */ QStatus AuthStart(); /** * Attempt to cancel the authentication work item. When this method returns, the work item * either has never been processed, or its processing finished. */ void AuthStop(); /** * Thread pool worker that performs endpoint authentication. */ static void AuthenticationWorker(_Inout_ PTP_CALLBACK_INSTANCE instance, _Inout_opt_ PVOID context, _Inout_ PTP_WORK work); /** * Atomically compare m_authState with oldState and, if they were equal, assign value newState to m_authState. * * @param oldState Previous state. * @param newState Next state. * * @return * - true if successful. * - false if current state was not oldState. */ bool TryToChangeAuthState(_In_ AuthState oldState, _In_ AuthState newState); bool AuthSucceeded() { return (m_authState == AUTH_SUCCEEDED); } bool AuthFailed() { return (m_authState == AUTH_FAILED); } bool AuthStopped() { return (m_authState == AUTH_STOPPED); } /** * Address of the one and only named pipe transport. */ NamedPipeDaemonTransport* m_transport; /** * Stream associated with this endpoint. */ NamedPipeStream m_pipeStream; /** * Stream's associated pipe handle, using during authentication. */ HANDLE m_pipeHandle; /** * Authentication state - one of the enum AuthState values. */ uint32_t m_authState; /** * Thread pool work item used for authentication. */ PTP_WORK m_threadPoolWork; }; _NamedPipeDaemonEndpoint::_NamedPipeDaemonEndpoint(_In_ BusAttachment& bus, _In_ HANDLE pipeHandle, _In_ NamedPipeDaemonTransport* transport) : _RemoteEndpoint(bus, true, NamedPipeDaemonTransport::NamedPipeTransportName, &m_pipeStream, NamedPipeDaemonTransport::NamedPipeTransportName, false), m_transport(transport), m_pipeStream(pipeHandle), m_pipeHandle(pipeHandle), m_authState(AUTH_INITIALIZED), m_threadPoolWork(nullptr) { QCC_DbgTrace(("_NamedPipeDaemonEndpoint()")); GetFeatures().isBusToBus = false; GetFeatures().allowRemote = false; GetFeatures().handlePassing = false; } _NamedPipeDaemonEndpoint::~_NamedPipeDaemonEndpoint() { QCC_DbgTrace(("~_NamedPipeDaemonEndpoint: m_threadPoolWork = 0x%p", m_threadPoolWork)); assert(m_threadPoolWork == nullptr); } QStatus _NamedPipeDaemonEndpoint::Stop() { QCC_DbgTrace(("Stop")); AuthStop(); return _RemoteEndpoint::Stop(); } /* * Join() must be called with the endpointListLock held, to synchronize the access to m_threadPoolWork. */ QStatus _NamedPipeDaemonEndpoint::Join() { QCC_DbgTrace(("_NamedPipeDaemonEndpoint::Join: work = 0x%p", m_threadPoolWork)); if (m_threadPoolWork != nullptr) { /* * Wait for the worker if it's running already, cancel the work item it it's not running yet. */ WaitForThreadpoolWorkCallbacks(m_threadPoolWork, true); CloseThreadpoolWork(m_threadPoolWork); m_threadPoolWork = nullptr; /* * Release the reference previously added by AuthStart(). */ NamedPipeDaemonEndpoint::wrap(this).DecRef(); } return ER_OK; } QStatus _NamedPipeDaemonEndpoint::AuthStart() { QCC_DbgTrace(("AuthStart")); QStatus status = ER_OK; assert(m_threadPoolWork == nullptr); if (!TryToChangeAuthState(AUTH_INITIALIZED, AUTH_AUTHENTICATING)) { assert(m_authState == AUTH_STOPPED); QCC_DbgHLPrintf(("AuthStart: already stopped")); } else { /* * Add a reference that will be released by Join(), after the worker finished execution. */ NamedPipeDaemonEndpoint::wrap(this).IncRef(); /* * Start authentication on a thread pool thread. */ m_threadPoolWork = CreateThreadpoolWork(AuthenticationWorker, this, nullptr); if (m_threadPoolWork == nullptr) { status = ER_OS_ERROR; QCC_LogError(status, ("CreateThreadpoolWork failed with OS error %u", ::GetLastError())); NamedPipeDaemonEndpoint::wrap(this).DecRef(); } if (status == ER_OK) { SubmitThreadpoolWork(m_threadPoolWork); } else { TryToChangeAuthState(AUTH_AUTHENTICATING, AUTH_FAILED); } } return status; } void _NamedPipeDaemonEndpoint::AuthStop() { QCC_DbgTrace(("AuthStop: m_authState = %u, m_threadPoolWork = 0x%p", m_authState, m_threadPoolWork)); if (TryToChangeAuthState(AUTH_INITIALIZED, AUTH_STOPPED)) { /* * Authentication hasn't started yet, so it's stopped already. */ QCC_DbgHLPrintf(("AuthStop: SetEvent")); m_transport->m_authFinishedEvent.SetEvent(); } else { /* * Ask the auth worker to stop as soon as possible. */ TryToChangeAuthState(AUTH_AUTHENTICATING, AUTH_STOPPING); } } void _NamedPipeDaemonEndpoint::AuthenticationWorker(_Inout_ PTP_CALLBACK_INSTANCE instance, _Inout_opt_ PVOID context, _Inout_ PTP_WORK work) { _NamedPipeDaemonEndpoint* conn = reinterpret_cast<_NamedPipeDaemonEndpoint*>(context); QCC_DbgHLPrintf(("Worker: reading NUL byte")); uint8_t byte; size_t nbytes; QStatus status = conn->m_pipeStream.PullBytes(&byte, 1, nbytes, conn->m_transport->GetAuthTimeout()); if ((status != ER_OK) || (nbytes != 1) || (byte != 0)) { status = (status == ER_OK) ? ER_FAIL : status; QCC_LogError(status, ("Worker: failed to read NUL byte")); } /* * Check if AuthStop() changed the state to AUTH_STOPPING while executing PullBytes() above. */ if ((status == ER_OK) && (conn->m_authState != AUTH_AUTHENTICATING)) { assert(conn->m_authState == AUTH_STOPPING); status = ER_STOPPING_THREAD; } if (status == ER_OK) { /* * We need to determine if the connecting client is a Desktop or Universal Windows app to correctly enforce the Windows app * isolation policies. Named pipe impersonation is used to determine who the caller is and the groupId is set to the * correct group. The groupId can be used by the PolicyDB to enforce the app isolation rules. */ if (!ImpersonateNamedPipeClient(conn->m_pipeHandle)) { status = ER_OS_ERROR; QCC_LogError(status, ("Worker: ImpersonateNamedPipeClient failed, error %u", ::GetLastError())); } HANDLE hClientToken = nullptr; if ((status == ER_OK) && !OpenThreadToken(GetCurrentThread(), TOKEN_QUERY, TRUE, &hClientToken)) { status = ER_OS_ERROR; QCC_LogError(status, ("Worker: OpenThreadToken failed, error %u", ::GetLastError())); } /* * Done impersonating at this point, revert to self. Always stop impersonating, even if there was a failure. */ if (!RevertToSelf()) { status = ER_OS_ERROR; QCC_LogError(status, ("Worker: RevertToSelf failed, error %u", ::GetLastError())); /* * This thread pool thread might execute unrelated work later on, and that would be too dangerous if reverting impersonation failed. */ abort(); } DWORD isAppContainer = 0; DWORD length = sizeof(isAppContainer); if ((status == ER_OK) && !GetTokenInformation(hClientToken, TokenIsAppContainer, &isAppContainer, length, &length)) { status = ER_OS_ERROR; QCC_LogError(status, ("Worker: GetTokenInformation - TokenIsAppContainer failed, error %u", ::GetLastError())); } SECURITY_IMPERSONATION_LEVEL securityLevel; length = sizeof(securityLevel); if ((status == ER_OK) && !GetTokenInformation(hClientToken, TokenImpersonationLevel, &securityLevel, length, &length)) { status = ER_OS_ERROR; QCC_LogError(status, ("Worker: GetTokenInformation - TokenImpersonationLevel failed, error %u", ::GetLastError())); } if (securityLevel == SecurityIdentification) { /* * We've been provided an identification-level impersonation token, so we can't actually verify if this application * is an app container. Fail out as a result. */ status = ER_BUS_NOT_ALLOWED; QCC_LogError(status, ("Worker: Impersonation token was an identification-level token and can't be trusted")); } PSID appContainerSid = nullptr; PSID_AND_ATTRIBUTES sidAndAttributes = nullptr; DWORD numAppContainers = 0; bool isWhitelisted = false; length = SECURITY_MAX_SID_SIZE + sizeof(TOKEN_APPCONTAINER_INFORMATION); BYTE buffer[SECURITY_MAX_SID_SIZE + sizeof(TOKEN_APPCONTAINER_INFORMATION)]; if ((status == ER_OK) && isAppContainer == TRUE) { if (!GetTokenInformation(hClientToken, TokenAppContainerSid, buffer, length, &length)) { status = ER_OS_ERROR; QCC_LogError(status, ("Worker: GetTokenInformation - TokenAppContainerSid failed, error %u", ::GetLastError())); } } /* * If a universal Windows app is in the loopback exemption list, then we will treat it as a desktop application. This * will allow the Universal Windows app to bypass the application isolation rules. This is allowed because an app on the * loopback exemption list could start its own bundled router, so it already has permissions to talk to the system. Skip * this step if the application is already whitelisted because of the isolation bypass capability. */ PTSTR sidString = NULL; if ((status == ER_OK) && isAppContainer && !isWhitelisted) { appContainerSid = ((PTOKEN_APPCONTAINER_INFORMATION)buffer)->TokenAppContainer; if (!ConvertSidToStringSid(appContainerSid, &sidString)) { status = ER_OS_ERROR; QCC_LogError(status, ("Worker: ConvertSidToStringSid failed, error %u", ::GetLastError())); } if (status == ER_OK) { uint32_t err = NetworkIsolationGetAppContainerConfig(&numAppContainers, &sidAndAttributes); if (err != ERROR_SUCCESS) { status = ER_FAIL; QCC_LogError(status, ("Worker: NetworkIsolationGetAppContainerConfig failed, error %u", err)); } } if (status == ER_OK) { for (uint32_t i = 0; i < numAppContainers; i++) { if (EqualSid(appContainerSid, sidAndAttributes[i].Sid)) { QCC_DbgPrintf(("Worker: Connecting app with SID %s has a loopback exemption, will be treated as a Desktop application", sidString)); isAppContainer = FALSE; break; } } } if (sidAndAttributes != nullptr) { for (uint32_t i = 0; i < numAppContainers; i++) { HeapFree(GetProcessHeap(), 0, sidAndAttributes[i].Sid); } HeapFree(GetProcessHeap(), 0, sidAndAttributes); } /* * Universal Windows apps will have a unique user ID constructed for each application. This ID will be * based on the app container SID and the user SID to ensure that multiple users running the same * application will receive separate IDs. This unique user ID is required for policy rules which * ensure app isolation doesn't prevent an application with multiple busattachments from talking * to itself. */ if (status == ER_OK) { TOKEN_USER* userToken = nullptr; LPTSTR userSidString = nullptr; String appIdStringUtf8; std::wstring appIdString(sidString); if (!GetTokenInformation(hClientToken, TokenUser, nullptr, 0, &length) && (::GetLastError() == ERROR_INSUFFICIENT_BUFFER)) { userToken = (TOKEN_USER*)new BYTE[length]; if (userToken == nullptr) { status = ER_OS_ERROR; QCC_LogError(status, ("Worker: TOKEN_USER allocation failed")); } if ((status == ER_OK) && !GetTokenInformation(hClientToken, TokenUser, userToken, length, &length)) { status = ER_OS_ERROR; QCC_LogError(status, ("Worker: GetTokenInformation - TokenUser failed, error %u", ::GetLastError())); } if ((status == ER_OK) && !ConvertSidToStringSid(userToken->User.Sid, &userSidString)) { status = ER_OS_ERROR; QCC_LogError(status, ("Worker: ConvertSidToStringSid - User SID failed, error %u", ::GetLastError())); } if (status == ER_OK) { appIdString += userSidString; status = ConvertUTF(appIdString, appIdStringUtf8, false); if (status != ER_OK) { QCC_LogError(status, ("Worker: ConvertUTF failed")); } } if (status == ER_OK) { conn->SetUserId(GetUsersUid(appIdStringUtf8.c_str())); } } else { status = ER_OS_ERROR; QCC_LogError(status, ("Worker: GetTokenInformation - TokenUser buffer size failed, error %u", ::GetLastError())); } delete[] userToken; LocalFree(userSidString); } LocalFree(sidString); } if ((hClientToken != nullptr) && !CloseHandle(hClientToken)) { status = ER_OS_ERROR; QCC_LogError(status, ("Worker: CloseHandle failed, error %u", ::GetLastError())); } if (status == ER_OK) { if (isWhitelisted) { QCC_DbgPrintf(("Worker: Connecting application is a %s", WHITELISTED_APPLICATION)); conn->SetGroupId(GetUsersGid(WHITELISTED_APPLICATION)); } else if (isAppContainer == TRUE) { QCC_DbgPrintf(("Worker: Connecting application is a %s", UNIVERSAL_WINDOWS_APPLICATION)); conn->SetGroupId(GetUsersGid(UNIVERSAL_WINDOWS_APPLICATION)); } else { QCC_DbgPrintf(("Worker: Connecting application is a %s", DESKTOP_APPLICATION)); conn->SetGroupId(GetUsersGid(DESKTOP_APPLICATION)); } } if (status == ER_OK) { conn->SetListener(conn->m_transport); /* * Since Windows NamedPipeDaemonTransport enforces access control * using the security descriptors, no need to implement * UntrustedClientStart and UntrustedClientExit. */ QCC_DbgHLPrintf(("Worker: calling Establish")); qcc::String authName; qcc::String redirection; status = conn->Establish("EXTERNAL", authName, redirection, nullptr, conn->m_transport->GetAuthTimeout()); if (status != ER_OK) { QCC_LogError(status, ("Worker: failed to establish connection")); } } } if (status == ER_OK) { if (conn->TryToChangeAuthState(AUTH_AUTHENTICATING, AUTH_SUCCEEDED)) { QCC_DbgHLPrintf(("Worker: auth suceeded")); /* * Since named pipe clients/daemons do not go through version negotiations * and older clients/daemons won't connect over named pipe at all, * we are giving this end point the latest AllJoyn protocol version here. */ conn->GetFeatures().protocolVersion = ALLJOYN_PROTOCOL_VERSION; status = conn->Start(); } else if (!conn->TryToChangeAuthState(AUTH_STOPPING, AUTH_STOPPED)) { assert(false); } } else { if (conn->TryToChangeAuthState(AUTH_AUTHENTICATING, AUTH_FAILED)) { QCC_DbgHLPrintf(("Worker: auth failed")); } else if (!conn->TryToChangeAuthState(AUTH_STOPPING, AUTH_STOPPED)) { assert(false); } } QCC_DbgHLPrintf(("Worker: SetEvent")); conn->m_transport->m_authFinishedEvent.SetEvent(); } bool _NamedPipeDaemonEndpoint::TryToChangeAuthState(_In_ AuthState oldState, _In_ AuthState newState) { bool success = (InterlockedCompareExchange((LONG volatile*)&m_authState, newState, oldState) == oldState); QCC_DbgPrintf(("TryToChangeAuthState: from %u to %u - %s", (uint32_t)oldState, (uint32_t)newState, success ? "succeeded" : "failed")); return success; } NamedPipeDaemonTransport::NamedPipeDaemonTransport(_In_ BusAttachment& bus) : DaemonTransport(bus), m_authTimeout(ALLJOYN_AUTH_TIMEOUT_DEFAULT), m_acceptThread(*this) { QCC_DbgTrace(("NamedPipeDaemonTransport()")); /* * We know we are daemon code, so we'd better be running with a daemon router. */ assert(bus.GetInternal().GetRouter().IsDaemon()); } NamedPipeDaemonTransport::~NamedPipeDaemonTransport() { QCC_DbgTrace(("~NamedPipeDaemonTransport")); } void* NamedPipeDaemonTransport::Run(_In_ void* arg) { QCC_DbgTrace(("NamedPipeDaemonTransport::Run")); QStatus status = ER_OK; while (!IsTransportStopping()) { status = Event::Wait(m_authFinishedEvent); if (status == ER_OK) { m_authFinishedEvent.ResetEvent(); ManageAuthenticatingEndpoints(); } else { assert(IsTransportStopping()); break; } } QCC_DbgHLPrintf(("Run: exiting, status=%s", QCC_StatusText(status))); return (void*) status; } QStatus NamedPipeDaemonTransport::NormalizeTransportSpec(_In_z_ const char* inSpec, _Out_ qcc::String& outSpec, _Inout_ std::map& argMap) const { outSpec = inSpec; return ER_OK; } /* * Function used to get NamedPipe server on a new thread. */ QStatus NamedPipeDaemonTransport::StartListen(_In_z_ const char* listenSpec) { QCC_DbgTrace(("StartListen")); QStatus status = ER_OK; if (IsTransportStopping()) { status = ER_BUS_TRANSPORT_NOT_STARTED; } if (status == ER_OK && IsRunning()) { status = ER_BUS_ALREADY_LISTENING; } if (status == ER_OK) { /* * Enforce a timeout for each pipe I/O during authentication phase. */ ConfigDB* config = ConfigDB::GetConfigDB(); m_authTimeout = config->GetLimit("auth_timeout", ALLJOYN_AUTH_TIMEOUT_DEFAULT); /* * Start the transport thread, responsible for managing endpoints. */ status = Thread::Start(NULL); } if (status == ER_OK) { /* * Start the thread responsible for accepting pipe connections. */ status = m_acceptThread.Start(NULL); } return status; } QStatus NamedPipeDaemonTransport::StopListen(_In_z_ const char* listenSpec) { QCC_DbgTrace(("StopListen")); return Stop(); } QStatus NamedPipeDaemonTransport::Stop() { QCC_DbgTrace(("NamedPipeDaemonTransport::Stop")); m_acceptThread.Stop(); /* * Stop the authenticatingEndpointList. */ endpointListLock.Lock(MUTEX_CONTEXT); for (list::iterator i = authenticatingEndpointList.begin(); i != authenticatingEndpointList.end(); ++i) { (*i)->Stop(); } endpointListLock.Unlock(MUTEX_CONTEXT); /* * Base class Stop() will stop the endpointList. */ return DaemonTransport::Stop(); } QStatus NamedPipeDaemonTransport::Join() { QCC_DbgTrace(("NamedPipeDaemonTransport::Join")); QStatus status = ER_OK; status = m_acceptThread.Join(); if (status == ER_OK) { /* * Endpoints are joined before moving from authenticatingEndpointList to endpointList, so join just the remaining * authenticating endpoints here. */ endpointListLock.Lock(MUTEX_CONTEXT); for (list::iterator i = authenticatingEndpointList.begin(); i != authenticatingEndpointList.end(); ++i) { (*i)->Join(); (*i)->Invalidate(); } authenticatingEndpointList.clear(); endpointListLock.Unlock(MUTEX_CONTEXT); status = DaemonTransport::Join(); } return status; } void NamedPipeDaemonTransport::AcceptedConnection(_In_ HANDLE pipeHandle) { QCC_DbgTrace(("AcceptedConnection")); QStatus status = ER_OK; NamedPipeDaemonEndpoint endpoint(bus, pipeHandle, this); endpointListLock.Lock(MUTEX_CONTEXT); /* * Perform authentication on a separate thread. AuthStart() has to run with * the endpointListLock held, because Join() relies on the same lock to * properly wait for the auth worker to finish execution. */ status = endpoint->AuthStart(); if (status != ER_OK) { QCC_LogError(status, ("Failed to start authentication")); } else { authenticatingEndpointList.push_back(endpoint); } endpointListLock.Unlock(MUTEX_CONTEXT); } void NamedPipeDaemonTransport::ManageAuthenticatingEndpoints() { QCC_DbgTrace(("ManageAuthenticatingEndpoints")); /* * Both authenticatingEndpointList and endpointList are protected by the same lock. */ endpointListLock.Lock(MUTEX_CONTEXT); list::iterator authIterator = authenticatingEndpointList.begin(); while (authIterator != authenticatingEndpointList.end()) { if ((*authIterator)->AuthSucceeded()) { QCC_DbgHLPrintf(("ManageAuthenticatingEndpoints: moving endpoint to active list")); list::iterator movedIterator = authIterator; authIterator++; (*movedIterator)->Join(); NamedPipeDaemonEndpoint movedEndpoint = *movedIterator; authenticatingEndpointList.erase(movedIterator); endpointList.push_back(RemoteEndpoint::cast(movedEndpoint)); } else if ((*authIterator)->AuthFailed() || (*authIterator)->AuthStopped()) { QCC_DbgHLPrintf(("ManageAuthenticatingEndpoints: removing failed or stopped endpoint")); list::iterator erasedIterator = authIterator; authIterator++; (*erasedIterator)->Join(); (*erasedIterator)->Invalidate(); authenticatingEndpointList.erase(erasedIterator); } else { authIterator++; } } endpointListLock.Unlock(MUTEX_CONTEXT); } void* NamedPipeAcceptThread::Run(_In_ void* arg) { QStatus status = ER_OK; /* * Accept client connections and connect those clients to the bus, in a loop. */ while (!IsStopping()) { /* * Creating a new instance of the named pipe. */ static const uint32_t BUFSIZE = 128 * 1024; HANDLE pipeHandle = AllJoynCreateBus(BUFSIZE, BUFSIZE, nullptr); if (pipeHandle == INVALID_HANDLE_VALUE) { status = ER_OS_ERROR; QCC_LogError(status, ("NamedPipeAcceptThread: AllJoynCreateBus failed, error %u", ::GetLastError())); break; } /* * AllJoynAcceptBusConnection accepts a named pipe connection, then sets the pipe mode to PIPE_NOWAIT. * AllJoynAcceptBusConnection returns ERROR_OPERATION_ABORTED when the stopEvent gets signaled - i.e. * when this transport should stop its execution. */ QCC_DbgHLPrintf(("NamedPipeAcceptThread: Waiting for connection on pipeHandle = 0x%p", pipeHandle)); DWORD acceptResult = AllJoynAcceptBusConnection(pipeHandle, stopEvent.GetHandle()); if (acceptResult == ERROR_SUCCESS) { QCC_DbgHLPrintf(("NamedPipeAcceptThread: Accepted client connection on pipeHandle 0x%p", pipeHandle)); } else { if (acceptResult == ERROR_OPERATION_ABORTED) { assert(IsStopping()); QCC_DbgHLPrintf(("NamedPipeAcceptThread: transport is stopping")); status = ER_STOPPING_THREAD; } else { QCC_LogError(status, ("NamedPipeAcceptThread: AllJoynAcceptBusConnection failed, error %u", acceptResult)); status = ER_OS_ERROR; } BOOL success = AllJoynCloseBusHandle(pipeHandle); assert(success); } if (status == ER_OK) { /* * Transfer ownership of the connected pipe handle to the transport object. */ m_transport.AcceptedConnection(pipeHandle); } } QCC_DbgHLPrintf(("NamedPipeAcceptThread: exiting, status=%s", QCC_StatusText(status))); return (void*) status; } } // namespace ajn #endif // #if (_WIN32_WINNT > 0x0603) alljoyn-15.04b/alljoyn_core/router/windows/NamedPipeDaemonTransport.h000066400000000000000000000162041255700255500261140ustar00rootroot00000000000000/** * @file * NamedPipeDaemonTransport is a specialization of class Transport for communication between an AllJoyn * client application and the daemon over named pipe for Windows. This is the daemon's counterpart * to ClientTransport. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ALLJOYN_NAMEDPIPE_DAEMON_TRANSPORT_H #define _ALLJOYN_NAMEDPIPE_DAEMON_TRANSPORT_H #ifndef __cplusplus #error Only include NamedPipeDaemonTransport.h in C++ code. #endif #include #include #include #include #include #include #include "Transport.h" #include "RemoteEndpoint.h" #include "DaemonTransport.h" namespace ajn { class NamedPipeDaemonTransport; class _NamedPipeDaemonEndpoint; typedef qcc::ManagedObj<_NamedPipeDaemonEndpoint> NamedPipeDaemonEndpoint; class NamedPipeAcceptThread : public qcc::Thread { public: NamedPipeAcceptThread(_In_ NamedPipeDaemonTransport& transport) : m_transport(transport) { }; /** * @brief Thread entry point. * * @param arg Thread entry arg. */ qcc::ThreadReturn STDCALL Run(_In_ void* arg); private: NamedPipeDaemonTransport& m_transport; }; /** * @brief A class for the daemon end of the client transport * * The NamedPipeDaemonTransport class has different incarnations depending on the platform. */ class NamedPipeDaemonTransport : public DaemonTransport { friend class _NamedPipeDaemonEndpoint; friend class NamedPipeAcceptThread; public: /** * Create a transport to receive incoming connections from AllJoyn application. * * @param bus The bus associated with this transport. */ NamedPipeDaemonTransport(_In_ BusAttachment& bus); /** * Destructor */ virtual ~NamedPipeDaemonTransport(); /** * @internal * @brief Normalize a transport specification. * * Given a transport specification, convert it into a form which is guaranteed to * have a one-to-one relationship with a connection instance. * * @param inSpec Input transport connect spec. * @param outSpec Output transport connect spec. * @param argMap Parsed parameter map. * * @return ER_OK if successful. */ QStatus NormalizeTransportSpec(_In_z_ const char* inSpec, _Out_ qcc::String& outSpec, _Inout_ std::map& argMap) const; /** * Start listening for incoming connections on a specified bus address. * * @param listenSpec Transport specific key/value arguments that specify the physical interface to listen on. * * @return * - ER_OK if successful. * - an error status otherwise. */ QStatus StartListen(_In_z_ const char* listenSpec); /** * @brief Stop listening for incoming connections on a specified bus address. * * This method cancels a StartListen request. Therefore, the listenSpec must * match previous call to StartListen(). * * @param listenSpec Transport specific key/value arguments that specify the physical interface to listen on. * * @return ER_OK if successful. */ QStatus StopListen(_In_z_ const char* listenSpec); /** * Stop the transport. * * @return ER_OK if successful. */ QStatus Stop(); /** * Pend the caller until the transport stops. * @return ER_OK if successful. */ QStatus Join(); /** * Return the name of this transport. */ const char* GetTransportName() const { return NamedPipeTransportName; } /** * Name of transport used in transport specs. */ static const char* NamedPipeTransportName; private: /** * @internal * @brief Thread entry point. * * @param arg Thread entry arg. */ qcc::ThreadReturn STDCALL Run(_In_ void* arg); /** * @internal * @brief Called by the NamedPipeAcceptThread immediately after accepting a connection. */ void AcceptedConnection(_In_ HANDLE pipeHandle); /** * @internal * @brief Called by the main transport thread after an endpoint finished authentication. */ void ManageAuthenticatingEndpoints(); /** * @internal * @brief Return the client authentication timeout. */ uint32_t GetAuthTimeout() { return m_authTimeout; } /** * @internal * @brief The default timeout for client authentication. * * The authentication process can be used as the basis of a denial of * service attack by simply stopping in mid-authentication. If an endpoint * I/O takes longer than this number of milliseconds, the transport * disconnects and removes that endpoind. This value can be overridden in * the daemon config file by setting "auth_timeout". */ static const uint32_t ALLJOYN_AUTH_TIMEOUT_DEFAULT = 20000; /* * @internal * @brief Timeout for each pipe I/O during client authentication. * * If a client doesn't respond during this time, the daemon treats it as * denier of service and closes the connection. */ uint32_t m_authTimeout; /* * @internal * @brief Thread responsible for accepting pipe connections. * * This has to be separate from the main transport thread because it has to perform * endpoint list maintenance every once in a while. Main thread is not appropriate * for calling AllJoynAcceptBusConnection, because that call that would block the * aformentioned maintenance. */ NamedPipeAcceptThread m_acceptThread; /* * @internal * @brief List of endpoints that are being authenticated. * * When authentication ends successfully, the endpoint is moved from this list to the * separate endpointList. Both authenticatingEndpointList and endpointList are protected * by endpointListLock. */ std::list authenticatingEndpointList; /* * @internal * @brief Event signaled when an endpoint authentication is completed. * * The main transport thread waits for this event, then performs maintenance for * endpointListLock and endpointList. */ qcc::Event m_authFinishedEvent; }; } // namespace ajn #endif // _ALLJOYN_NAMEDPIPE_DAEMON_TRANSPORT_H alljoyn-15.04b/alljoyn_core/router/windows/PermissionMgrWindows.cc000066400000000000000000000035701255700255500255220ustar00rootroot00000000000000/** * @file * This class is to manage the permission of an endpoint on using transports or invoking method/signal calls on another peer */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include "PermissionMgr.h" #include #define QCC_MODULE "PERMISSION_MGR" namespace ajn { QStatus TransportPermission::FilterTransports(BusEndpoint& srcEp, const qcc::String& sender, TransportMask& transports, const char* callerName) { QCC_UNUSED(srcEp); QCC_UNUSED(sender); QCC_UNUSED(transports); QCC_UNUSED(callerName); return ER_OK; } uint32_t PermissionMgr::AddAliasUnixUser(BusEndpoint& srcEp, qcc::String& sender, uint32_t origUID, uint32_t aliasUID) { QCC_UNUSED(srcEp); QCC_UNUSED(sender); QCC_UNUSED(origUID); QCC_UNUSED(aliasUID); return ALLJOYN_ALIASUNIXUSER_REPLY_NO_SUPPORT; } QStatus PermissionMgr::CleanPermissionCache(BusEndpoint& endpoint) { QCC_UNUSED(endpoint); return ER_OK; } } // namespace ajn { alljoyn-15.04b/alljoyn_core/router/windows/SConscript000077500000000000000000000035031255700255500230530ustar00rootroot00000000000000# Copyright AllSeen Alliance. All rights reserved. # # Permission to use, copy, modify, and/or distribute this software for any # purpose with or without fee is hereby granted, provided that the above # copyright notice and this permission notice appear in all copies. # # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. # Import('router_env', 'router_objs', 'srobj') # Build the resources for the dll rsc = router_env.RES('DaemonResources.rc') daemon_static_lib = []; daemon_shared_lib = []; # Build the Windows daemon. router_libs = router_env.SharedLibrary('daemonlib', ['daemon-service.cc', 'daemon-main.cc'] + srobj + router_objs + rsc) # the variable router_libs contains the file nodes for the static library and the # shared library however it may contain more files such as .pdb files on windows. # Search through the list and assign the static library to daemon_static_lib and # the shared library to daemon_shared_lib variable. for x in router_libs: if router_env['LIBSUFFIX'] in str(x): daemon_static_lib = x; if router_env['SHLIBSUFFIX'] in str(x): daemon_shared_lib = x; router_env.Install('$CPP_DISTDIR/lib', daemon_static_lib) #put the *.lib file in the lib folder env2 = router_env.Clone(); env2.Append(LIBS = ['daemonlib']) daemon = [] progs = [daemon, daemon_shared_lib] # daemonlibs.dll will be returned Return('progs') alljoyn-15.04b/alljoyn_core/router/windows/ScatterGatherList.h000066400000000000000000000414561255700255500246140ustar00rootroot00000000000000/** * @file * * Define a scatter-gather list class. */ /****************************************************************************** * * * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _QCC_SCATTERGATHERLIST_H #define _QCC_SCATTERGATHERLIST_H #include #include #include #include #include #include #include #include #define QCC_MODULE "NETWORK" namespace qcc { /** * Classes that need to add an internal buffer to a scatter-gather list should * inherit this class and implement the interface functions. */ class ScatterGatherList { public: /// Define the type of dereferenced iterators. typedef IOVec type_value; /// iterator typedef. typedef std::list::iterator iterator; /// const_iterator typedef. typedef std::list::const_iterator const_iterator; private: std::list sg; ///< Collection of buffers and associated buffer lengths. size_t maxDataSize; ///< Maximum data that can be held in the SG buffers. size_t dataSize; ///< Amount of data currently held in the SG buffers. public: ScatterGatherList(void) : maxDataSize(0), dataSize(0) { } /** * Copy constructor. Note: this only copies the pointers to the buffers * and buffer lengths; it does not copy the data in the buffers. * * @param other The ScatterGatherList to intialize from. */ ScatterGatherList(const ScatterGatherList& other) : sg(other.sg), maxDataSize(other.maxDataSize), dataSize(other.dataSize) { } /** * Assignment operator. Note: this only copies the pointers to the buffers * and buffer lengths; it does not copy the data in the buffers. * * @param other The ScatterGatherList to intialize from. * * @return Reference to *this. */ ScatterGatherList& operator=(const ScatterGatherList& other) { QCC_DbgTrace(("ScatterGatherList::operator=(other) [maxDataSize = %u dataSize = %u]", other.maxDataSize, other.dataSize)); sg = other.sg; maxDataSize = other.maxDataSize; dataSize = other.dataSize; return *this; } /** * Add a buffer to the scatter-gather list. * * @param buffer Buffer to be added to the list. * @param length Length of the buffer. */ void AddBuffer(void* buffer, size_t length) { maxDataSize += length; QCC_DbgTrace(("ScatterGatherList::AddBuffer(buffer, length = %u) [maxDataSize = %u]", length, maxDataSize)); if (Size() == 0) { IOVec iov; iov.buf = reinterpret_cast(buffer); iov.len = (uint32_t)length; sg.push_back(iov); } else { if (!sg.empty()) { IOVec& last = sg.back(); if (reinterpret_cast(last.buf) + last.len == buffer) { last.len += (uint32_t)length; } else { IOVec iov; iov.buf = reinterpret_cast(buffer); iov.len = (uint32_t)length; sg.push_back(iov); } } else { IOVec iov; iov.buf = reinterpret_cast(buffer); iov.len = (uint32_t)length; sg.push_back(iov); } } } /** * @overload * The underlying C structure is used for both const and non-const SG * lists so this version casts away the const-ness. Be careful to not mix * up sending and receiving. * * @param buffer Buffer to be added to the list. * @param length Length of the buffer. */ void AddBuffer(const void* buffer, size_t length) { AddBuffer(const_cast(buffer), length); } /** * Add the entries from one list to this list. * * @param other The SG list to get entries from. */ void AddSG(const ScatterGatherList& other) { AddSG(other.Begin(), other.End()); } /** * @overload * This version takes const iterators an so can be used to add just a * subset of another SG list. * * @param begin Beginning of the SG list to get buffers from. * @param end End of the SG list to get buffers from. */ void AddSG(const_iterator begin, const_iterator end) { const_iterator iter; for (iter = begin; iter != end; ++iter) { AddBuffer(iter->buf, iter->len); } } /** * Get an interator referencing the beginning of the scatter-gather list. * * @return An interator referencing the beginning of the scatter-gather list. */ iterator Begin(void) { return sg.begin(); } /** * Get a const interator referencing the beginning of the scatter-gather * list. * * @return A const interator referencing the beginning of the * scatter-gather list. */ const_iterator Begin(void) const { return sg.begin(); } /** * Get an interator referencing the end of the scatter-gather list. * * @return An interator referencing the end of the scatter-gather list. */ iterator End(void) { return sg.end(); } /** * Get a const interator referencing the end of the scatter-gather list. * * @return A const interator referencing the end of the scatter-gather list. */ const_iterator End(void) const { return sg.end(); } /** * This removes the specifed entry from the scatter-gather list. * * @param i Iterator referencing the element to be removed. */ void Erase(iterator& i) { maxDataSize -= i->len; dataSize -= (std::min)(dataSize, (size_t)(i->len)); sg.erase(i); } /** * Clear out the list of SG entries. */ void Clear(void) { QCC_DbgTrace(("ScatterGatherList::Clear()")); sg.clear(); maxDataSize = 0; dataSize = 0; } /** * Return the number of entries in the scatter-gather list. * * @return Number of elements in the scatter-gather list. */ size_t Size(void) const { return sg.size(); } /** * Get the amount of space used among the buffers in the SG list. This * value is only valid if SetDataSize was used or the data was copied from * a source with a known data size. * * @return Number of octets of actual data in the SG list. */ size_t DataSize(void) const { return dataSize; } /** * Get the amount of space available among the buffers in the SG list. * * @return Number of octets of available space in the SG list. */ size_t MaxDataSize(void) const { return maxDataSize; } /** * Sets the amount of space used by data in the SG List. The copy * operations depend on this value being accurate. * * @param newSize Number of octets used. */ void SetDataSize(size_t newSize) { QCC_DbgTrace(("ScatterGatherList::SetDataSize(newSize = %u)", newSize)); dataSize = newSize; } /** * Increments the amount of space used by data in the SG List. The copy * operations depend on this value being accurate. * * @param newSize Number of octets used. */ void IncDataSize(size_t increment) { QCC_DbgTrace(("ScatterGatherList::IncDataSize(increment = %u)", increment)); dataSize += increment; } /** * Copies the data from another SG list into this list. The underlying * implementation uses memmove to avoid problems with overlapping memory. * Only the lesser of this->DataSize() or other.DataSize() bytes will be * copied. * * @param other The SG list to copy data from; * @param limit [optional] Limits the number octets to copy (default is all). * * @return Number of octets copied. */ size_t CopyDataFrom(const ScatterGatherList& other, size_t limit = ~0) { return CopyDataFrom(other.Begin(), other.End(), (std::min)(limit, other.DataSize())); } /** * @overload * This version uses iterators instead of a SG list. * * @param begin Beginig of the SG list to copy. * @param end End of the SG list to copy. * @param limit This limits the amount of data to be copied (defaults to all data). * * @return Number of octets copied. */ size_t CopyDataFrom(const_iterator begin, const_iterator end, size_t limit = ~0) { if (sg.empty() || (begin == end)) { return 0; } iterator dest(sg.begin()); const_iterator src(begin); uint8_t* srcBuf = reinterpret_cast(src->buf); uint8_t* destBuf = reinterpret_cast(dest->buf); size_t srcLen = src->len; size_t destLen = dest->len; size_t copyCnt = 0; size_t copyLimit = std::min(maxDataSize, limit); QCC_DbgTrace(("ScatterGatherList::CopyDataFrom(begin, end, limit = %u)", limit)); QCC_DbgPrintf(("srcLen = %u destLen = %u copyLimit = %u", srcLen, destLen, copyLimit)); while (copyLimit > 0 && dest != sg.end() && src != end) { size_t copyLen = std::min(copyLimit, std::min(destLen, srcLen)); QCC_DbgPrintf(("srcLen = %u destLen = %u copyLimit = %u copyLen = %u", srcLen, destLen, copyLimit, copyLen)); memmove(destBuf, srcBuf, copyLen); copyCnt += copyLen; copyLimit -= copyLen; if (copyLen == destLen) { ++dest; if (dest != sg.end()) { destBuf = reinterpret_cast(dest->buf); destLen = dest->len; } } else { destBuf += copyLen; destLen -= copyLen; } if (copyLen == srcLen) { ++src; if (src != end) { srcBuf = reinterpret_cast(src->buf); srcLen = src->len; } } else { srcBuf += copyLen; srcLen -= copyLen; } } dataSize = copyCnt; return copyCnt; } /** * Copies data from the SG list to a buffer. It will copy at most bufSize * or this->DataSize() octets. * * @param buf Buffer where data will be copied to. * @param bufSize Size of the buffer. * * @return Number of octets copied. */ size_t CopyToBuffer(void* buf, size_t bufSize) const { const_iterator src(sg.begin()); uint8_t* pos = reinterpret_cast(buf); size_t copyCnt = (std::min)(bufSize, dataSize); QCC_DbgTrace(("ScatterGatherList::CopyToBuffer(*buf, bufSize = %u)", bufSize)); QCC_DbgPrintf(("bufSize = %u dataSize = %u copyCnt = %u", bufSize, dataSize, copyCnt)); assert(buf != NULL); while (copyCnt > 0 && src != sg.end()) { size_t copyLen = (std::min)(copyCnt, (size_t)(src->len)); memmove(pos, src->buf, copyLen); if (copyLen == src->len) { ++src; } copyCnt -= copyLen; QCC_DbgPrintf(("Copied %u bytes (%u left)", copyLen, copyCnt)); QCC_DbgLocalData(pos, copyLen); pos += copyLen; } return (std::min)(bufSize, dataSize); } /** * Copies data to the SG list from a buffer. It will copy at most bufSize * or this->DataSize() octets. * * @param buf Buffer where data will be copied from. * @param bufSize Size of the buffer. * * @return Number of octets copied. */ size_t CopyFromBuffer(const void* buf, size_t bufSize) { iterator dest(sg.begin()); const uint8_t* pos = reinterpret_cast(buf); size_t copyCnt = (std::min)(bufSize, maxDataSize); QCC_DbgTrace(("ScatterGatherList::CopyFromBuffer(*buf, bufSize = %u)", bufSize)); QCC_DbgPrintf(("bufSize = %u maxDataSize = %u copyCnt = %u", bufSize, maxDataSize, copyCnt)); assert(buf != NULL); while (copyCnt > 0 && dest != sg.end()) { size_t copyLen = (std::min)(copyCnt, static_cast(dest->len)); memmove(dest->buf, pos, copyLen); if (copyLen == dest->len) { ++dest; } copyCnt -= copyLen; QCC_DbgPrintf(("Copied %u bytes (%u left)", copyLen, copyCnt)); pos += copyLen; } dataSize = static_cast(pos - reinterpret_cast(buf)); return dataSize; } /** * This alters the SG list by removing buffers and/or adjusting the * pointer to the resulting first buffer such that the MaxDataSize will be * reduced by the specifed amount. * * @param trim Number of octets to remove from the begining of the SG list. * * @return Number of octets that could not be trimmed. */ size_t TrimFromBegining(size_t trim) { size_t orig = trim; maxDataSize -= (std::min)(maxDataSize, trim); dataSize -= (std::min)(dataSize, trim); QCC_DbgTrace(("ScatterGatherList::TrimFromBegining(trim = %u) [maxDataSize = %u dataSize = %u]", trim, maxDataSize, dataSize)); while (trim > 0 && sg.begin() != sg.end()) { if (trim >= sg.begin()->len) { trim -= sg.begin()->len; sg.erase(sg.begin()); } else { sg.begin()->buf = reinterpret_cast(sg.begin()->buf) + trim; sg.begin()->len -= (uint32_t)trim; trim = 0; } } return (orig - trim); } }; /** * Send a collection of buffers from a scatter-gather list to a remote host on a socket. * * @param sockfd Socket descriptor. * @param sg A scatter-gather list refering to the data to be sent. * @param sent OUT: Number of octets sent. * @param flags SendMsgFlags to underlying sockets call (see sendmsg() in sockets API) * * @return Indication of success of failure. */ QStatus SendSG(SocketFd sockfd, const ScatterGatherList& sg, size_t& sent, SendMsgFlags flags = QCC_MSG_NONE); /** * Send a collection of buffers from a scatter-gather list to a remote host on a socket. * * @param sockfd Socket descriptor. * @param remoteAddr IP Address of remote host. * @param remotePort IP Port on remote host. * @param sg A scatter-gather list refering to the data to be sent. * @param sent OUT: Number of octets sent. * @param flags SendMsgFlags to underlying sockets call (see sendmsg() in sockets API) * * @return Indication of success of failure. */ QStatus SendToSG(SocketFd sockfd, IPAddress& remoteAddr, uint16_t remotePort, const ScatterGatherList& sg, size_t& sent, SendMsgFlags flags = QCC_MSG_NONE); /** * Receive data into a collection of buffers in a scatter-gather list from a * host on a socket. * * @param sockfd Socket descriptor. * @param sg A scatter-gather list refering to buffers where received * data will be stored. * @param received OUT: Number of octets received. * * @return Indication of success of failure. */ QStatus RecvSG(SocketFd sockfd, ScatterGatherList& sg, size_t& received); /** * Receive data into a collection of buffers in a scatter-gather list from a * host on a socket. * * @param sockfd Socket descriptor. * @param remoteAddr IP Address of remote host. * @param remotePort IP Port on remote host. * @param sg A scatter-gather list refering to buffers where received * data will be stored. * @param received OUT: Number of octets received. * * @return Indication of success of failure. */ QStatus RecvFromSG(SocketFd sockfd, IPAddress& remoteAddr, uint16_t& remotePort, ScatterGatherList& sg, size_t& received); } #undef QCC_MODULE #endif alljoyn-15.04b/alljoyn_core/router/windows/Socket.cc000066400000000000000000000226171255700255500226040ustar00rootroot00000000000000/** * @file * * Define the abstracted socket interface for Windows */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include // Do not change the order of these includes; they are order dependent. #include #include #include #include #include #include #include #include #include #include #include "ScatterGatherList.h" #include #define QCC_MODULE "NETWORK" /* Scatter gather is only supported on Vista and later */ #if !defined (NTDDI_VERSION) || !defined (NTDDI_VISTA) || (NTDDI_VERSION < NTDDI_VISTA) #define QCC_USE_SCATTER_GATHER 0 #else #define QCC_USE_SCATTER_GATHER 1 #endif namespace qcc { extern String GetLastErrorString(); extern void MakeSockAddr(const IPAddress& addr, uint16_t port, SOCKADDR_STORAGE* addrBuf, socklen_t& addrSize); extern QStatus GetSockAddr(const SOCKADDR_STORAGE* addrBuf, socklen_t addrSize, IPAddress& addr, uint16_t& port); #if QCC_USE_SCATTER_GATHER static QStatus SendSGCommon(SocketFd sockfd, SOCKADDR_STORAGE* addr, socklen_t addrLen, const ScatterGatherList& sg, size_t& sent, SendMsgFlags flags) { QStatus status = ER_OK; QCC_DbgTrace(("SendSGCommon(sockfd = %d, *addr, addrLen, sg, sent = <>, flags = 0x%x)", sockfd, (int)flags)); /* * We will usually avoid the memory allocation */ WSABUF iovAuto[8]; WSABUF* iov = sg.Size() <= ArraySize(iovAuto) ? iovAuto : new WSABUF[sg.Size()]; ScatterGatherList::const_iterator iter = sg.Begin(); for (size_t index = 0; iter != sg.End(); ++index, ++iter) { iov[index].buf = iter->buf; iov[index].len = iter->len; QCC_DbgLocalData(iov[index].buf, iov[index].len); } WSAMSG msg; memset(&msg, 0, sizeof(msg)); msg.name = reinterpret_cast(addr); msg.namelen = addrLen; msg.lpBuffers = iov; msg.dwBufferCount = sg.Size(); DWORD dwsent; DWORD ret = WSASendMsg(static_cast(sockfd), &msg, (int)flags, &dwsent, NULL, NULL); DWORD err; if (ret == SOCKET_ERROR && (err = WSAGetLastError()) != WSA_IO_PENDING) { if (err == WSAEWOULDBLOCK || err == WSAEINPROGRESS || err == WSAEINTR) { status = ER_WOULDBLOCK; sent = 0; } else { status = ER_OS_ERROR; QCC_LogError(status, ("Send: %s", GetLastErrorString().c_str())); } } QCC_DbgPrintf(("Sent %u bytes", dwsent)); sent = dwsent; if (iov != iovAuto) { delete[] iov; } return status; } QStatus SendSG(SocketFd sockfd, const ScatterGatherList& sg, size_t& sent, SendMsgFlags flags) { QCC_DbgTrace(("SendSG(sockfd = %d, sg, sent = <>, flags = 0x%x)", sockfd, (int) flags)); return SendSGCommon(sockfd, NULL, 0, sg, sent, flags); } QStatus SendToSG(SocketFd sockfd, IPAddress& remoteAddr, uint16_t remotePort, const ScatterGatherList& sg, size_t& sent, SendMsgFlags flags) { SOCKADDR_STORAGE addr; socklen_t addrLen = sizeof(addr); QCC_DbgTrace(("SendToSG(sockfd = %d, remoteAddr = %s, remotePort = %u, sg, sent = <>, flags = 0x%x)", sockfd, remoteAddr.ToString().c_str(), remotePort, flags)); MakeSockAddr(remoteAddr, remotePort, &addr, addrLen); return SendSGCommon(sockfd, &addr, addrLen, sg, sent, flags); } #else QStatus SendSG(SocketFd sockfd, const ScatterGatherList& sg, size_t& sent, SendMsgFlags flags) { QCC_UNUSED(flags); QStatus status; uint8_t* tmpBuf = new uint8_t[sg.MaxDataSize()]; sg.CopyToBuffer(tmpBuf, sg.MaxDataSize()); status = Send(sockfd, tmpBuf, sg.DataSize(), sent); delete[] tmpBuf; return status; } QStatus SendToSG(SocketFd sockfd, IPAddress& remoteAddr, uint16_t remotePort, const ScatterGatherList& sg, size_t& sent, SemdMsgFlags flags) { QCC_UNUSED(flags); QStatus status; uint8_t* tmpBuf = new uint8_t[sg.MaxDataSize()]; sg.CopyToBuffer(tmpBuf, sg.MaxDataSize()); status = SendTo(sockfd, remoteAddr, remotePort, tmpBuf, sg.DataSize(), sent); delete[] tmpBuf; return status; } #endif #if QCC_USE_SCATTER_GATHER static QStatus RecvSGCommon(SocketFd sockfd, SOCKADDR_STORAGE* addr, socklen_t& addrLen, ScatterGatherList& sg, size_t& received) { static LPFN_WSARECVMSG WSARecvMsg = NULL; QStatus status = ER_OK; DWORD dwRecv; DWORD ret; QCC_DbgTrace(("RecvSGCommon(sockfd = %d, addr, addrLen, sg = <>, received = <>)", sockfd)); /* * Get extension function pointer */ if (!WSARecvMsg) { GUID guid = WSAID_WSARECVMSG; ret = WSAIoctl(static_cast(sockfd), SIO_GET_EXTENSION_FUNCTION_POINTER, &guid, sizeof(guid), &WSARecvMsg, sizeof(WSARecvMsg), &dwRecv, NULL, NULL); if (ret == SOCKET_ERROR) { status = ER_OS_ERROR; QCC_LogError(status, ("Receive: %s", GetLastErrorString().c_str())); return status; } } /* * We will usually avoid the memory allocation */ WSABUF iovAuto[8]; WSABUF* iov = sg.Size() <= ArraySize(iovAuto) ? iovAuto : new WSABUF[sg.Size()]; ScatterGatherList::const_iterator iter = sg.Begin(); for (size_t index = 0; iter != sg.End(); ++index, ++iter) { iov[index].buf = iter->buf; iov[index].len = iter->len; } WSAMSG msg; memset(&msg, 0, sizeof(msg)); msg.name = reinterpret_cast(addr); msg.namelen = addrLen; msg.lpBuffers = iov; msg.dwBufferCount = sg.Size(); ret = WSARecvMsg(static_cast(sockfd), &msg, &dwRecv, NULL, NULL); if (ret == SOCKET_ERROR) { if (WSAGetLastError() == WSAEWOULDBLOCK) { received = 0; status = ER_WOULDBLOCK; } else { status = ER_OS_ERROR; QCC_LogError(status, ("Receive: %s", GetLastErrorString().c_str())); } } else { sg.SetDataSize(received); addrLen = msg.namelen; received = dwRecv; } #if !defined(NDEBUG) QCC_DbgPrintf(("Received %u bytes", received)); for (iter = sg.Begin(); iter != sg.End(); ++iter) { QCC_DbgRemoteData(iter->buf, iter->len); } #endif if (iov != iovAuto) { delete[] iov; } return status; } QStatus RecvSG(SocketFd sockfd, ScatterGatherList& sg, size_t& received) { socklen_t addrLen = 0; QCC_DbgTrace(("RecvSG(sockfd = %d, sg = <>, received = <>)", sockfd)); return RecvSGCommon(sockfd, NULL, addrLen, sg, received); } QStatus RecvFromSG(SocketFd sockfd, IPAddress& remoteAddr, uint16_t& remotePort, ScatterGatherList& sg, size_t& received) { QStatus status; SOCKADDR_STORAGE addr; socklen_t addrLen = sizeof(addr); status = RecvSGCommon(sockfd, &addr, addrLen, sg, received); if (ER_OK == status) { GetSockAddr(&addr, addrLen, remoteAddr, remotePort); QCC_DbgTrace(("RecvFromSG(sockfd = %d, remoteAddr = %s, remotePort = %u, sg = <>, rcvd = %u)", sockfd, remoteAddr.ToString().c_str(), remotePort, received)); } return status; } #else QStatus RecvSG(SocketFd sockfd, ScatterGatherList& sg, size_t& received) { QStatus status = ER_OK; uint8_t* tmpBuf = new uint8_t[sg.MaxDataSize()]; QCC_DbgTrace(("RecvSG(sockfd = %d, sg = <>, received = <>)", sockfd)); status = Recv(sockfd, tmpBuf, sg.MaxDataSize(), received); if (ER_OK == status) { sg.CopyFromBuffer(tmpBuf, received); } QCC_DbgPrintf(("Received %u bytes", received)); delete[] tmpBuf; return status; } QStatus RecvFromSG(SocketFd sockfd, IPAddress& remoteAddr, uint16_t& remotePort, ScatterGatherList& sg, size_t& received) { QStatus status = ER_OK; uint8_t* tmpBuf = new uint8_t[sg.MaxDataSize()]; QCC_DbgTrace(("RecvToSG(sockfd = %d, remoteAddr = %s, remotePort = %u, sg = <>, sent = <>)", sockfd, remoteAddr.ToString().c_str(), remotePort)); status = RecvFrom(sockfd, remoteAddr, remotePort, tmpBuf, sg.MaxDataSize(), received); if (ER_OK == status) { sg.CopyFromBuffer(tmpBuf, received); } QCC_DbgPrintf(("Received %u bytes", received)); delete[] tmpBuf; return status; } #endif } alljoyn-15.04b/alljoyn_core/router/windows/daemon-main.cc000066400000000000000000000302321255700255500235310ustar00rootroot00000000000000/** * @file * AllJoyn-Daemon - Windows version */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include "Transport.h" #include "TCPTransport.h" #include "UDPTransport.h" #include "DaemonTransport.h" #include "Bus.h" #include "BusController.h" #include "ConfigDB.h" #include "BusInternal.h" #define DAEMONLIBRARY_EXPORTS #include "DaemonLib.h" #include #define DAEMON_EXIT_OK 0 #define DAEMON_EXIT_OPTION_ERROR 1 #define DAEMON_EXIT_CONFIG_ERROR 2 #define DAEMON_EXIT_STARTUP_ERROR 3 #define DAEMON_EXIT_FORK_ERROR 4 #define DAEMON_EXIT_IO_ERROR 5 #define DAEMON_EXIT_SESSION_ERROR 6 using namespace ajn; using namespace qcc; using namespace std; static const char defaultConfig[] = "" " 20000" " 16" " 64" " 48" " 0" " Battery powered and chargeable" " Intermediate mobility" " 3-6 hr" " Wireless" " false" ""; /* * Router Power Source * Always AC powered * Battery powered and chargeable * Battery powered and not chargeable * * Router Mobility * Always Stationary * Low mobility * Intermediate mobility * High mobility * * Router Availability * 0-3 hr * 3-6 hr * 6-9 hr * 9-12 hr * 12-15 hr * 15-18 hr * 18-21 hr * 21-24 hr * * Router Node Connection * Access Point * Wired * Wireless * */ static const char internalConfig[] = "" " alljoyn" " tcp:iface=*,port=9955" " udp:iface=*,u4port=9955" ""; static volatile sig_atomic_t g_interrupt = false; static void CDECL_CALL SignalHandler(int sig) { QCC_UNUSED(sig); g_interrupt = true; } class OptParse { public: enum ParseResultCode { PR_OK, PR_EXIT_NO_ERROR, PR_OPTION_CONFLICT, PR_INVALID_OPTION, PR_MISSING_OPTION }; OptParse(int argc, char** argv) : argc(argc), argv(argv), useInternalConfig(true), printAddress(false), verbosity(LOG_WARNING) { configFile.clear(); } ParseResultCode ParseResult(); qcc::String GetConfigFile() const { return configFile; } bool UseInternalConfig() const { return useInternalConfig; } bool PrintAddress() const { return printAddress; } int GetVerbosity() const { return verbosity; } private: int argc; char** argv; qcc::String configFile; bool useInternalConfig; bool printAddress; int verbosity; void PrintUsage(); }; void OptParse::PrintUsage() { printf("%s [--config-file=FILE] [--print-address] [--verbosity=LEVEL] [--no-bt] [--version]\n\n" " --config-file=FILE\n" " Use the specified configuration file.\n\n" " --print-address\n" " Print the socket address to STDOUT\n\n" " --verbosity=LEVEL\n" " Set the logging level to LEVEL.\n" " LEVEL can take one of the following values\n" " 0 LOG_EMERG system is unusable\n" " 1 LOG_ALERT action must be taken immediately\n" " 2 LOG_CRIT critical conditions\n" " 3 LOG_ERR error conditions\n" " 4 LOG_WARNING warning conditions\n" " 5 LOG_NOTICE normal but significant condition\n" " 6 LOG_INFO informational\n" " 7 LOG_DEBUG debug-level messages\n\n" " --version\n" " Print the version and copyright string, and exit.\n", argv[0]); } OptParse::ParseResultCode OptParse::ParseResult() { ParseResultCode result(PR_OK); int i; for (i = 1; i < argc; ++i) { qcc::String arg(argv[i]); if (arg.compare("--version") == 0) { printf("AllJoyn Message Bus Daemon version: %s\n" "Copyright AllSeen Alliance.\n" "\n" "\n" "Build: %s\n", ajn::GetVersion(), GetBuildInfo()); result = PR_EXIT_NO_ERROR; goto exit; } else if (arg.compare("--config-file") == 0) { if (!configFile.empty()) { result = PR_OPTION_CONFLICT; goto exit; } ++i; if (i == argc) { result = PR_MISSING_OPTION; goto exit; } configFile = argv[i]; useInternalConfig = false; } else if (arg.compare(0, sizeof("--config-file") - 1, "--config-file") == 0) { if (!configFile.empty()) { result = PR_OPTION_CONFLICT; goto exit; } configFile = arg.substr(sizeof("--config-file")); useInternalConfig = false; } else if (arg.compare("--print-address") == 0) { printAddress = true; } else if (arg.substr(0, sizeof("--verbosity") - 1).compare("--verbosity") == 0) { verbosity = StringToI32(arg.substr(sizeof("--verbosity"))); } else if ((arg.compare("--help") == 0) || (arg.compare("-h") == 0)) { PrintUsage(); result = PR_EXIT_NO_ERROR; goto exit; } else { PrintUsage(); result = PR_INVALID_OPTION; goto exit; } } exit: switch (result) { case PR_OPTION_CONFLICT: fprintf(stderr, "Option \"%s\" is in conflict with a previous option.\n", argv[i]); break; case PR_INVALID_OPTION: fprintf(stderr, "Invalid option: \"%s\"\n", argv[i]); break; case PR_MISSING_OPTION: fprintf(stderr, "No config file specified.\n"); PrintUsage(); break; default: break; } return result; } int daemon(OptParse& opts) { ConfigDB* config = ConfigDB::GetConfigDB(); signal(SIGTERM, SignalHandler); signal(SIGINT, SignalHandler); /* * Extract the listen specs */ const ConfigDB::ListenList& listenList = config->GetListen(); String listenSpecs; for (ConfigDB::_ListenList::const_iterator it = listenList->begin(); it != listenList->end(); ++it) { String addrStr = *it; bool skip = false; if (addrStr.compare(0, sizeof("tcp:") - 1, "tcp:") == 0) { // No special processing needed for TCP. } else if (addrStr.compare(0, sizeof("udp:") - 1, "udp:") == 0) { // No special processing needed for UDP. } else { Log(LOG_ERR, "Unsupported listen address: %s (ignoring)\n", it->c_str()); continue; } if (skip) { Log(LOG_INFO, "Skipping transport for address: %s\n", it->c_str()); } else { Log(LOG_INFO, "Setting up transport for address: %s\n", it->c_str()); if (!listenSpecs.empty()) { listenSpecs.append(';'); } listenSpecs.append(*it); } } if (listenSpecs.empty()) { Log(LOG_ERR, "No listen address specified. Aborting...\n"); return DAEMON_EXIT_CONFIG_ERROR; } // Do the real AllJoyn work here QStatus status; // // Teach the transport list how to make the transports that we support. If // specified in the listen spec, they will be instantiated. // TransportFactoryContainer cntr; cntr.Add(new TransportFactory(DaemonTransport::TransportName, false)); cntr.Add(new TransportFactory(TCPTransport::TransportName, false)); cntr.Add(new TransportFactory(UDPTransport::TransportName, false)); Bus ajBus("alljoyn-daemon", cntr, listenSpecs.c_str()); /* * Check we have at least one authentication mechanism registered. */ if (!config->GetAuth().empty()) { if (ajBus.GetInternal().FilterAuthMechanisms(config->GetAuth()) == 0) { Log(LOG_ERR, "No supported authentication mechanisms. Aborting...\n"); return DAEMON_EXIT_STARTUP_ERROR; } } /* * Create the bus controller and initialize and start the bus. */ BusController ajBusController(ajBus); status = ajBusController.Init(listenSpecs); if (ER_OK != status) { Log(LOG_ERR, "Failed to initialize BusController: %s\n", QCC_StatusText(status)); return DAEMON_EXIT_STARTUP_ERROR; } if (opts.PrintAddress()) { qcc::String addrStr(listenSpecs); addrStr += "\n"; printf("%s", addrStr.c_str()); } /* * Wait until we find a Control-C happening. */ while (g_interrupt == false) { qcc::Sleep(100); } /* * We are shutting down, relying on the C++ scoping rules to cause the * destructor for the ajBus to be run and the bus to be shut down in * an orderly fashion. */ return DAEMON_EXIT_OK; } DAEMONLIBRARY_API int LoadDaemon(int argc, char** argv) { if (AllJoynInit() != ER_OK) { return DAEMON_EXIT_STARTUP_ERROR; } if (AllJoynRouterInit() != ER_OK) { AllJoynShutdown(); return DAEMON_EXIT_STARTUP_ERROR; } LoggerSetting* loggerSettings(LoggerSetting::GetLoggerSetting(argv[0], LOG_WARNING)); loggerSettings->SetSyslog(false); if (g_isManaged) { FILE* pFile = _fsopen(g_logFilePathName, "a+", _SH_DENYNO); if (pFile == NULL) { return 911; } loggerSettings->SetFile(pFile); } else { loggerSettings->SetFile(stdout); } OptParse opts(argc, argv); OptParse::ParseResultCode parseCode(opts.ParseResult()); switch (parseCode) { case OptParse::PR_OK: break; case OptParse::PR_EXIT_NO_ERROR: return DAEMON_EXIT_OK; default: return DAEMON_EXIT_OPTION_ERROR; } loggerSettings->SetLevel(opts.GetVerbosity()); String configStr = defaultConfig; if (opts.UseInternalConfig()) { configStr.append(internalConfig); } ConfigDB config(configStr, opts.GetConfigFile()); if (!config.LoadConfig()) { const char* errsrc; if (opts.UseInternalConfig()) { errsrc = "internal default config"; } else { errsrc = opts.GetConfigFile().c_str(); } Log(LOG_ERR, "Failed to load the configuration - problem with %s.\n", errsrc); return DAEMON_EXIT_CONFIG_ERROR; } int ret = daemon(opts); AllJoynRouterShutdown(); AllJoynShutdown(); return ret; } DAEMONLIBRARY_API void UnloadDaemon() { g_interrupt = true; return; } alljoyn-15.04b/alljoyn_core/router/windows/daemon-service.cc000066400000000000000000000075311255700255500242530ustar00rootroot00000000000000/** * @file * daemon-service - Wrapper to allow daemon to be built as a DLL */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #define DAEMONLIBRARY_EXPORTS #include "DaemonLib.h" // Standard Windows DLL entry point BOOL APIENTRY DllMain(HMODULE hModule, DWORD ul_reason_for_call, LPVOID lpReserved ) { QCC_UNUSED(hModule); QCC_UNUSED(lpReserved); switch (ul_reason_for_call) { case DLL_PROCESS_ATTACH: case DLL_THREAD_ATTACH: case DLL_THREAD_DETACH: case DLL_PROCESS_DETACH: break; } return TRUE; } // Global buffer to hold log file path when started as a Windows Service char g_logFilePathName[MAX_PATH]; bool g_isManaged = false; // forward reference bool IsWhiteSpace(char c) { if ((c == ' ') || (c == '\t') || (c == '\n') || (c == '\r')) { return true; } return false; } // convert string passed to DaemonMain into argc, argv that can be passed to the // LoadDaemon function to start the daemon. DAEMONLIBRARY_API void DaemonMain(wchar_t* cmd) { if (!cmd || !*cmd || wcslen(cmd) >= 2000) { // make sure it fits printf("Bad command string\n"); return; } char cmdLine[2000]; // on the stack char* tempPtrs[20]; // arbitrary limit of 20! sprintf_s(cmdLine, 2000, "%S", cmd); char* src = cmdLine; int i = 0; // count the arguments char workingBuffer[MAX_PATH]; // on the stack int cnt = (int)strlen(cmdLine); // parse the first 20 arguments while (cnt > 0 && i < 20) { char* dest = workingBuffer; while (*src && !IsWhiteSpace(*src)) { // The largest any single argument can be is MAX_PATH characters any // thing larger is an error. if (dest - workingBuffer == MAX_PATH) { printf("Bad command string\n"); return; } *dest++ = *src++; cnt--; } *dest = (char)0; // terminate current arg size_t len = strlen(workingBuffer) + 1; tempPtrs[i] = new char[len]; memcpy((void*)tempPtrs[i], (const void*)workingBuffer, len); while (*src && IsWhiteSpace(*src)) { // skip white space src++; cnt--; } i++; } if (!i) { printf("Empty command string\n"); return; } // the code can only parse 20 arguments and arguments were left unparsed. if (cnt > 0 && i == 20) { printf("Too many command arguments\n"); return; } // now create argc and argv char** argv = new char*[i]; for (int ii = 0; ii < i; ii++) argv[ii] = tempPtrs[ii]; LoadDaemon(i, argv); for (int ii = 0; ii < i; ii++) delete[] argv[ii]; delete[] argv; } DAEMONLIBRARY_API void SetLogFile(wchar_t* str) { sprintf_s(g_logFilePathName, MAX_PATH, "%S", str); g_isManaged = true; } alljoyn-15.04b/alljoyn_core/router/windows/daemon-shell.cc000066400000000000000000000021411255700255500237120ustar00rootroot00000000000000/** * @file * daemon-shell.cc */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include "DaemonLib.h" int CDECL_CALL main(int argc, char* argv[]) { return LoadDaemon(argc, argv); } alljoyn-15.04b/alljoyn_core/samples/000077500000000000000000000000001255700255500174675ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/samples/README.android.txt000066400000000000000000000011031255700255500225770ustar00rootroot00000000000000AllJoyn C++ Samples for Android README -------------------------------------- This directory contains the following AllJoyn C++ API samples: simple - This sample shows how to connect to a local AllJoyn daemon in order to publish an AllJoyn object that implements a very simple interface. The sample also shows how to connect to the local daemon in order to execute a method on the published object. chat - This sample shows how to use AllJoyn's C++ API to discover and connect with other AllJoyn enabled devices. alljoyn-15.04b/alljoyn_core/samples/README.linux.txt000066400000000000000000000021211255700255500223170ustar00rootroot00000000000000AllJoyn C++ Samples for Linux README ------------------------------------ This directory contains the following AllJoyn C++ API samples: basic - Contains a set of samples that show how to advertise, discover, connect and communicate over AllJoyn using the C++ AllJoyn API. chat - This sample shows how to use AllJoyn's C++ API to discover and connect with other AllJoyn enabled devices implementing a specific kind of peer service. In particular this sample demonstrates the use of Signal as the basis for the peer-to-peer communiation. TrustedTLSampleRN - This sample provides a bundled AllJoyn Routing Node, primaily to demonstrate how provide credentials that enable thin library applications to form a trusted connection. Additionally, the sample can be passed a name via the command-line to be quietly advertised. This demonstrates how a thin library applications may be "bound" to a specific Routing Node bu using the initial Thin Library Routing Node discovery process. alljoyn-15.04b/alljoyn_core/samples/README.windows.txt000066400000000000000000000023571255700255500226650ustar00rootroot00000000000000AllJoyn C++ Samples for Windows README -------------------------------------- This directory contains the following AllJoyn C++ API samples using a simple command line UI: basic - Contains a set of samples that show how to advertise, discover, connect and communicate over AllJoyn using the C++ AllJoyn API. chat - This sample shows how to use AllJoyn's C++ API to discover and connect with other AllJoyn enabled devices implementing a specific kind of peer service. In particular this sample demonstrates the use of Signal as the basis for the peer-to-peer communiation. secure - This sample shows how to use AllJoyn's C++ API to set up encryption for the remote connection. TrustedTLSampleRN - This sample provides a bundled AllJoyn Routing Node, primaily to demonstrate how provide credentials that enable thin library applications to form a trusted connection. Additionally, the sample can be passed a name via the command-line to be quietly advertised. This demonstrates how a thin library applications may be "bound" to a specific Routing Node bu using the initial Thin Library Routing Node discovery process. alljoyn-15.04b/alljoyn_core/samples/SConscript000066400000000000000000000043761255700255500215130ustar00rootroot00000000000000# Copyright AllSeen Alliance. All rights reserved. # # Permission to use, copy, modify, and/or distribute this software for any # purpose with or without fee is hereby granted, provided that the above # copyright notice and this permission notice appear in all copies. # # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. # Import('env') samples_env = env.Clone() if samples_env['BR'] == 'on': # Build apps with bundled daemon support samples_env.Prepend(LIBS = [samples_env['ajrlib']]) # About feature sample programs samples_env.SConscript('about/SConscript', exports = {'env': samples_env}) # AboutListener sample program samples_env.SConscript('aboutlistener/SConscript', exports = {'env': samples_env}) # Basic Sample programs samples_env.SConscript('basic/SConscript', exports = {'env': samples_env}) # Simple Sample programs samples_env.SConscript('simple/SConscript', exports = {'env': samples_env}) # Security Sample programs samples_env.SConscript('secure/SConscript', exports = {'env': samples_env}) # Chat Sample program samples_env.SConscript('chat/SConscript', exports = {'env': samples_env}) # Trusted Thin Library Sample Routing Node program samples_env.SConscript('TrustedTLSampleRN/SConscript', exports = {'env': samples_env}) # Event and Action Sample program samples_env.SConscript('eventaction/SConscript', exports = {'env': samples_env}) # Observer Sample program samples_env.SConscript('observer/SConscript', exports = {'env': samples_env}) # Install readme if env['OS_CONF'] == 'windows': env.InstallAs('$CPP_DISTDIR/samples/README.txt', 'README.windows.txt') elif env['OS_CONF'] == 'android': env.InstallAs('$CPP_DISTDIR/samples/README.txt', 'README.android.txt') elif env['OS_CONF'] == 'linux': env.InstallAs('$CPP_DISTDIR/samples/README.txt', 'README.linux.txt') alljoyn-15.04b/alljoyn_core/samples/TrustedTLSampleRN/000077500000000000000000000000001255700255500227635ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/samples/TrustedTLSampleRN/SConscript000066400000000000000000000026531255700255500250030ustar00rootroot00000000000000# Copyright AllSeen Alliance. All rights reserved. # # Permission to use, copy, modify, and/or distribute this software for any # purpose with or without fee is hereby granted, provided that the above # copyright notice and this permission notice appear in all copies. # # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. # Import('env') clientDistDir = '$DISTDIR/cpp/samples/TrustedTLSampleRN' # Program binary prog = [ env.Program('TrustedTLSampleRN', 'TrustedTLSampleRN.cc') ] # The Trusted Thin Library Sample Routing Node binary is intended to be used # by thin library apps and is packaged with the Thin Library SDK (Win7/Linux). # It sets credentials so that thin library apps may connect to it in a trusted # manner. The fact that the program sets credentials implies a bundled router # configuration. if env['BR'] == 'on' and env['OS'] in ['linux', 'win7']: env.Install('$DISTDIR/cpp/bin/samples', prog ) env.Install(clientDistDir, env.Glob('*.cc')) alljoyn-15.04b/alljoyn_core/samples/TrustedTLSampleRN/TrustedTLSampleRN.cc000066400000000000000000000115431255700255500265720ustar00rootroot00000000000000/** * @file * TrustedTLSampleRN is a sample Routing Node that provides credentials allowing * trusted thin client applications connect. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #include #include #include #include #include #include #include #define QCC_MODULE "TRUSTED_TL_SAMPLE_RN" using namespace ajn; using namespace qcc; using namespace std; namespace org { namespace alljoyn { namespace TrustedTLSampleRN { const char* DefaultRNBusName = "org.alljoyn.BusNode.TestingPurposesOnly"; const char* ThinClientAuthMechanism = "ANONYMOUS"; const char* ThinClientDefaultBusPwd = ""; } } } static volatile sig_atomic_t g_interrupted = false; static void CDECL_CALL SigIntHandler(int sig) { QCC_UNUSED(sig); g_interrupted = true; } static void usage(void) { printf("Usage: TrustedTLSampleRN [-h] [-n ]\n\n"); printf("Options:\n"); printf(" -h = Print this help message\n"); printf(" -n = Well-known bus name advertised by Routing Node\n"); printf("\n"); } int CDECL_CALL main(int argc, char** argv) { if (AllJoynInit() != ER_OK) { return 1; } #ifdef ROUTER if (AllJoynRouterInit() != ER_OK) { AllJoynShutdown(); return 1; } #endif printf("AllJoyn Library version: %s\n", ajn::GetVersion()); printf("AllJoyn Library build info: %s\n", ajn::GetBuildInfo()); // Register SIGNT (Ctrl-C) handler signal(SIGINT, SigIntHandler); String nameToAdvertise = ::org::alljoyn::TrustedTLSampleRN::DefaultRNBusName; // Parse command line arguments, if any for (int i = 1; i < argc; i++) { if (0 == strcmp("-h", argv[i])) { usage(); exit(0); } else if (0 == strcmp("-n", argv[i])) { if (argc == ++i) { printf("option %s requires a parameter\n", argv[i - 1]); usage(); exit(1); } else { nameToAdvertise = argv[i]; } } else { printf("Unknown option %s\n", argv[i]); usage(); exit(1); } } BusAttachment* msgBus = new BusAttachment("TrustedTLSampleRN", true); QStatus status = ER_FAIL; status = msgBus->Start(); if (ER_OK == status) { // Set the credential that thin clients have to offer to connect // to this TrustedTLSampleRN in a trusted manner. PasswordManager::SetCredentials( ::org::alljoyn::TrustedTLSampleRN::ThinClientAuthMechanism, ::org::alljoyn::TrustedTLSampleRN::ThinClientDefaultBusPwd ); // Force connecting to bundled router (i.e. null transport) to ensure // that credentials are correctly set. // // NOTE: The above SetCredentials call doesn't take effect // when connecting to a RN. status = msgBus->Connect("null:"); if (ER_OK == status) { // Quietly advertise the name to be discovered by thin clients only // over the TCP Transport since they currently only support that // mechanism. nameToAdvertise = "quiet@" + nameToAdvertise; status = msgBus->AdvertiseName(nameToAdvertise.c_str(), TRANSPORT_TCP); if (ER_OK != status) { QCC_LogError(status, ("Unable to quietly advertise the name %s", nameToAdvertise.c_str())); } } } // Wait for Ctrl-C to exit while (!g_interrupted) { qcc::Sleep(100); } delete msgBus; printf("%s exiting with status %u (%s)\n", argv[0], status, QCC_StatusText(status)); #ifdef ROUTER AllJoynRouterShutdown(); #endif AllJoynShutdown(); return (int) status; } alljoyn-15.04b/alljoyn_core/samples/about/000077500000000000000000000000001255700255500206015ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/samples/about/AboutClient.cc000066400000000000000000000265061255700255500233320ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #include #include #include #include /* * Note the removal of almost all Error handling to make the sample code more * straight forward to read. This is only used here for demonstration actual * programs should check the return values of all method calls. */ using namespace ajn; static volatile sig_atomic_t s_interrupt = false; // The interface name should be the only thing required to find and form a // connection between the service and the client using the about feature. static const char* INTERFACE_NAME = "com.example.about.feature.interface.sample"; static void CDECL_CALL SigIntHandler(int sig) { QCC_UNUSED(sig); s_interrupt = true; } BusAttachment* g_bus = NULL; class MySessionListener : public SessionListener { void SessionLost(SessionId sessionId, SessionLostReason reason) { printf("SessionLost sessionId = %u, Reason = %d\n", sessionId, reason); } }; // Print out the fields found in the AboutData. Only fields with known signatures // are printed out. All others will be treated as an unknown field. void printAboutData(AboutData& aboutData, const char* language, int tabNum) { size_t count = aboutData.GetFields(); const char** fields = new const char*[count]; aboutData.GetFields(fields, count); for (size_t i = 0; i < count; ++i) { for (int j = 0; j < tabNum; ++j) { printf("\t"); } printf("Key: %s", fields[i]); MsgArg* tmp; aboutData.GetField(fields[i], tmp, language); printf("\t"); if (tmp->Signature() == "s") { const char* tmp_s; tmp->Get("s", &tmp_s); printf("%s", tmp_s); } else if (tmp->Signature() == "as") { size_t las; MsgArg* as_arg; tmp->Get("as", &las, &as_arg); for (size_t j = 0; j < las; ++j) { const char* tmp_s; as_arg[j].Get("s", &tmp_s); printf("%s ", tmp_s); } } else if (tmp->Signature() == "ay") { size_t lay; uint8_t* pay; tmp->Get("ay", &lay, &pay); for (size_t j = 0; j < lay; ++j) { printf("%02x ", pay[j]); } } else { printf("User Defined Value\tSignature: %s", tmp->Signature().c_str()); } printf("\n"); } delete [] fields; } class MyAboutListener : public AboutListener { void Announced(const char* busName, uint16_t version, SessionPort port, const MsgArg& objectDescriptionArg, const MsgArg& aboutDataArg) { AboutObjectDescription objectDescription; objectDescription.CreateFromMsgArg(objectDescriptionArg); printf("*********************************************************************************\n"); printf("Announce signal discovered\n"); printf("\tFrom bus %s\n", busName); printf("\tAbout version %hu\n", version); printf("\tSessionPort %hu\n", port); printf("\tObjectDescription:\n"); AboutObjectDescription aod(objectDescriptionArg); size_t path_num = aod.GetPaths(NULL, 0); const char** paths = new const char*[path_num]; aod.GetPaths(paths, path_num); for (size_t i = 0; i < path_num; ++i) { printf("\t\t%s\n", paths[i]); size_t intf_num = aod.GetInterfaces(paths[i], NULL, 0); const char** intfs = new const char*[intf_num]; aod.GetInterfaces(paths[i], intfs, intf_num); for (size_t j = 0; j < intf_num; ++j) { printf("\t\t\t%s\n", intfs[j]); } delete [] intfs; } delete [] paths; printf("\tAboutData:\n"); AboutData aboutData(aboutDataArg); printAboutData(aboutData, NULL, 2); printf("*********************************************************************************\n"); QStatus status; if (g_bus != NULL) { SessionId sessionId; SessionOpts opts(SessionOpts::TRAFFIC_MESSAGES, false, SessionOpts::PROXIMITY_ANY, TRANSPORT_ANY); g_bus->EnableConcurrentCallbacks(); status = g_bus->JoinSession(busName, port, &sessionListener, sessionId, opts); printf("SessionJoined sessionId = %u, status = %s\n", sessionId, QCC_StatusText(status)); if (ER_OK == status && 0 != sessionId) { AboutProxy aboutProxy(*g_bus, busName, sessionId); MsgArg objArg; aboutProxy.GetObjectDescription(objArg); printf("*********************************************************************************\n"); printf("AboutProxy.GetObjectDescription:\n"); AboutObjectDescription aod(objArg); size_t path_num = aod.GetPaths(NULL, 0); const char** paths = new const char*[path_num]; aod.GetPaths(paths, path_num); for (size_t i = 0; i < path_num; ++i) { printf("\t%s\n", paths[i]); size_t intf_num = aod.GetInterfaces(paths[i], NULL, 0); const char** intfs = new const char*[intf_num]; aod.GetInterfaces(paths[i], intfs, intf_num); for (size_t j = 0; j < intf_num; ++j) { printf("\t\t%s\n", intfs[j]); } delete [] intfs; } delete [] paths; MsgArg aArg; aboutProxy.GetAboutData("en", aArg); printf("*********************************************************************************\n"); printf("AboutProxy.GetAboutData: (Default Language)\n"); AboutData aboutData(aArg); printAboutData(aboutData, NULL, 1); size_t lang_num; lang_num = aboutData.GetSupportedLanguages(); // If the lang_num == 1 we only have a default language if (lang_num > 1) { const char** langs = new const char*[lang_num]; aboutData.GetSupportedLanguages(langs, lang_num); char* defaultLanguage; aboutData.GetDefaultLanguage(&defaultLanguage); // print out the AboutData for every language but the // default it has already been printed. for (size_t i = 0; i < lang_num; ++i) { if (strcmp(defaultLanguage, langs[i]) != 0) { status = aboutProxy.GetAboutData(langs[i], aArg); if (ER_OK == status) { aboutData.CreatefromMsgArg(aArg, langs[i]); printf("AboutProxy.GetAboutData: (%s)\n", langs[i]); printAboutData(aboutData, langs[i], 1); } } } delete [] langs; } uint16_t ver; aboutProxy.GetVersion(ver); printf("*********************************************************************************\n"); printf("AboutProxy.GetVersion %hd\n", ver); printf("*********************************************************************************\n"); const char* path; objectDescription.GetInterfacePaths(INTERFACE_NAME, &path, 1); printf("Calling %s/%s\n", path, INTERFACE_NAME); ProxyBusObject proxyObject(*g_bus, busName, path, sessionId); status = proxyObject.IntrospectRemoteObject(); if (status != ER_OK) { printf("Failed to introspect remote object.\n"); } MsgArg arg("s", "ECHO Echo echo...\n"); Message replyMsg(*g_bus); status = proxyObject.MethodCall(INTERFACE_NAME, "Echo", &arg, 1, replyMsg); if (status != ER_OK) { printf("Failed to call Echo method.\n"); return; } char* echoReply; status = replyMsg->GetArg(0)->Get("s", &echoReply); if (status != ER_OK) { printf("Failed to read Echo method reply.\n"); } printf("Echo method reply: %s\n", echoReply); } } else { printf("BusAttachment is NULL\n"); } } MySessionListener sessionListener; }; int CDECL_CALL main(int argc, char** argv) { QCC_UNUSED(argc); QCC_UNUSED(argv); if (AllJoynInit() != ER_OK) { return 1; } #ifdef ROUTER if (AllJoynRouterInit() != ER_OK) { AllJoynShutdown(); return 1; } #endif /* Install SIGINT handler so Ctrl + C deallocates memory properly */ signal(SIGINT, SigIntHandler); QStatus status; g_bus = new BusAttachment("AboutServiceTest", true); status = g_bus->Start(); if (ER_OK == status) { printf("BusAttachment started.\n"); } else { printf("FAILED to start BusAttachment (%s)\n", QCC_StatusText(status)); exit(1); } status = g_bus->Connect(); if (ER_OK == status) { printf("BusAttachment connect succeeded.\n"); } else { printf("FAILED to connect to router node (%s)\n", QCC_StatusText(status)); exit(1); } MyAboutListener aboutListener; g_bus->RegisterAboutListener(aboutListener); const char* interfaces[] = { INTERFACE_NAME }; status = g_bus->WhoImplements(interfaces, sizeof(interfaces) / sizeof(interfaces[0])); if (ER_OK == status) { printf("WhoImplements called.\n"); } else { printf("WhoImplements call FAILED with status %s\n", QCC_StatusText(status)); exit(1); } /* Perform the service asynchronously until the user signals for an exit. */ if (ER_OK == status) { while (s_interrupt == false) { #ifdef _WIN32 Sleep(100); #else usleep(100 * 1000); #endif } } g_bus->UnregisterAboutListener(aboutListener); delete g_bus; #ifdef ROUTER AllJoynRouterShutdown(); #endif AllJoynShutdown(); return 0; } alljoyn-15.04b/alljoyn_core/samples/about/AboutService.cc000066400000000000000000000204461255700255500235110ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #include using namespace ajn; static volatile sig_atomic_t s_interrupt = false; static void CDECL_CALL SigIntHandler(int sig) { QCC_UNUSED(sig); s_interrupt = true; } static SessionPort ASSIGNED_SESSION_PORT = 900; static const char* INTERFACE_NAME = "com.example.about.feature.interface.sample"; class MySessionPortListener : public SessionPortListener { bool AcceptSessionJoiner(ajn::SessionPort sessionPort, const char* joiner, const ajn::SessionOpts& opts) { QCC_UNUSED(joiner); QCC_UNUSED(opts); if (sessionPort != ASSIGNED_SESSION_PORT) { printf("Rejecting join attempt on unexpected session port %d\n", sessionPort); return false; } return true; } void SessionJoined(SessionPort sessionPort, SessionId id, const char* joiner) { QCC_UNUSED(sessionPort); QCC_UNUSED(joiner); printf("Session Joined SessionId = %u\n", id); } }; class MyBusObject : public BusObject { public: MyBusObject(BusAttachment& bus, const char* path) : BusObject(path) { QStatus status; const InterfaceDescription* iface = bus.GetInterface(INTERFACE_NAME); assert(iface != NULL); // Here the value ANNOUNCED tells AllJoyn that this interface // should be announced status = AddInterface(*iface, ANNOUNCED); if (status != ER_OK) { printf("Failed to add %s interface to the BusObject\n", INTERFACE_NAME); } /* Register the method handlers with the object */ const MethodEntry methodEntries[] = { { iface->GetMember("Echo"), static_cast(&MyBusObject::Echo) } }; AddMethodHandlers(methodEntries, sizeof(methodEntries) / sizeof(methodEntries[0])); } // Respond to remote method call `Echo` by returning the string back to the // sender. void Echo(const InterfaceDescription::Member* member, Message& msg) { QCC_UNUSED(member); printf("Echo method called: %s", msg->GetArg(0)->v_string.str); const MsgArg* arg((msg->GetArg(0))); QStatus status = MethodReply(msg, arg, 1); if (status != ER_OK) { printf("Failed to created MethodReply.\n"); } } }; /** Main entry point */ int CDECL_CALL main(int argc, char** argv) { QCC_UNUSED(argc); QCC_UNUSED(argv); if (AllJoynInit() != ER_OK) { return 1; } #ifdef ROUTER if (AllJoynRouterInit() != ER_OK) { AllJoynShutdown(); return 1; } #endif /* Install SIGINT handler so Ctrl + C deallocates memory properly */ signal(SIGINT, SigIntHandler); QStatus status; BusAttachment* bus = new BusAttachment("About Service Example", true); status = bus->Start(); if (ER_OK == status) { printf("BusAttachment started.\n"); } else { printf("FAILED to start BusAttachment (%s)\n", QCC_StatusText(status)); exit(1); } status = bus->Connect(); if (ER_OK == status) { printf("BusAttachment connect succeeded. BusName %s\n", bus->GetUniqueName().c_str()); } else { printf("FAILED to connect to router node (%s)\n", QCC_StatusText(status)); exit(1); } SessionOpts opts(SessionOpts::TRAFFIC_MESSAGES, false, SessionOpts::PROXIMITY_ANY, TRANSPORT_ANY); SessionPort sessionPort = ASSIGNED_SESSION_PORT; MySessionPortListener sessionPortListener; status = bus->BindSessionPort(sessionPort, opts, sessionPortListener); if (ER_OK != status) { printf("Failed to BindSessionPort (%s)", QCC_StatusText(status)); exit(1); } // Setup the about data // The default language is specified in the constructor. If the default language // is not specified any Field that should be localized will return an error AboutData aboutData("en"); //AppId is a 128bit uuid uint8_t appId[] = { 0x01, 0xB3, 0xBA, 0x14, 0x1E, 0x82, 0x11, 0xE4, 0x86, 0x51, 0xD1, 0x56, 0x1D, 0x5D, 0x46, 0xB0 }; status = aboutData.SetAppId(appId, 16); status = aboutData.SetDeviceName("My Device Name"); //DeviceId is a string encoded 128bit UUID status = aboutData.SetDeviceId("93c06771-c725-48c2-b1ff-6a2a59d445b8"); status = aboutData.SetAppName("Application"); status = aboutData.SetManufacturer("Manufacturer"); status = aboutData.SetModelNumber("123456"); status = aboutData.SetDescription("A poetic description of this application"); status = aboutData.SetDateOfManufacture("2014-03-24"); status = aboutData.SetSoftwareVersion("0.1.2"); status = aboutData.SetHardwareVersion("0.0.1"); status = aboutData.SetSupportUrl("http://www.example.org"); // The default language is automatically added to the `SupportedLanguages` // Users don't have to specify the AJSoftwareVersion its automatically added // to the AboutData // Adding Spanish Localization values to the AboutData. All strings MUST be // UTF-8 encoded. status = aboutData.SetDeviceName("Mi dispositivo Nombre", "es"); status = aboutData.SetAppName("aplicación", "es"); status = aboutData.SetManufacturer("fabricante", "es"); status = aboutData.SetDescription("Una descripción poética de esta aplicación", "es"); // Check to see if the aboutData is valid before sending the About Announcement if (!aboutData.IsValid()) { printf("failed to setup about data.\n"); } qcc::String iface = "" "" " " " " " " " " "" ""; status = bus->CreateInterfacesFromXml(iface.c_str()); if (ER_OK != status) { printf("Failed to parse the xml interface definition (%s)", QCC_StatusText(status)); exit(1); } MyBusObject* busObject = new MyBusObject(*bus, "/example/path"); status = bus->RegisterBusObject(*busObject); if (ER_OK != status) { printf("Failed to register BusObject (%s)", QCC_StatusText(status)); exit(1); } // Announce about signal AboutObj* aboutObj = new AboutObj(*bus); // Note the ObjectDescription that is part of the Announce signal is found // automatically by introspecting the BusObjects registered with the bus // attachment. status = aboutObj->Announce(sessionPort, aboutData); if (ER_OK == status) { printf("AboutObj Announce Succeeded.\n"); } else { printf("AboutObj Announce failed (%s)\n", QCC_StatusText(status)); exit(1); } /* Perform the service asynchronously until the user signals for an exit. */ if (ER_OK == status) { while (s_interrupt == false) { #ifdef _WIN32 Sleep(100); #else usleep(100 * 1000); #endif } } delete aboutObj; delete busObject; delete bus; #ifdef ROUTER AllJoynRouterShutdown(); #endif AllJoynShutdown(); return 0; } alljoyn-15.04b/alljoyn_core/samples/about/SConscript000066400000000000000000000021771255700255500226220ustar00rootroot00000000000000# Copyright AllSeen Alliance. All rights reserved. # # Permission to use, copy, modify, and/or distribute this software for any # purpose with or without fee is hereby granted, provided that the above # copyright notice and this permission notice appear in all copies. # # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. # Import('env') clientDistDir = '$CPP_DISTDIR/samples/about' # Sample Programs progs = [ env.Program('AboutService', ['AboutService.cc']), env.Program('AboutClient', ['AboutClient.cc']) ] if env['OS_GROUP'] in ['windows', 'posix']: env.Install('$CPP_DISTDIR/bin/samples', progs ) env.Install(clientDistDir, env.Glob('*.cc'))alljoyn-15.04b/alljoyn_core/samples/aboutlistener/000077500000000000000000000000001255700255500223475ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/samples/aboutlistener/AboutListener.cc000066400000000000000000000244611255700255500254450ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #include #include #include #include /* * Note the removal of almost all error handling to make the sample code more * straightforward to read. This is only used here for demonstration; actual * programs should check the return values of all method calls. */ using namespace ajn; static volatile sig_atomic_t s_interrupt = false; static void CDECL_CALL SigIntHandler(int sig) { QCC_UNUSED(sig); s_interrupt = true; } BusAttachment* g_bus = NULL; class MySessionListener : public SessionListener { void SessionLost(SessionId sessionId, SessionLostReason reason) { printf("SessionLost sessionId = %u, Reason = %d\n", sessionId, reason); } }; /* * Print out the fields found in the AboutData. Only fields with known signatures * are printed out. All others will be treated as an unknown field. */ void printAboutData(AboutData& aboutData, const char* language, int tabCount) { size_t fieldCount = aboutData.GetFields(); const char** fields = new const char*[fieldCount]; aboutData.GetFields(fields, fieldCount); for (size_t i = 0; i < fieldCount; ++i) { for (int j = 0; j < tabCount; ++j) { printf("\t"); } printf("Key: %s", fields[i]); MsgArg* tmp; aboutData.GetField(fields[i], tmp, language); printf("\t"); if (tmp->Signature() == "s") { const char* tmp_s; tmp->Get("s", &tmp_s); printf("%s", tmp_s); } else if (tmp->Signature() == "as") { size_t las; MsgArg* as_arg; tmp->Get("as", &las, &as_arg); for (size_t j = 0; j < las; ++j) { const char* tmp_s; as_arg[j].Get("s", &tmp_s); printf("%s ", tmp_s); } } else if (tmp->Signature() == "ay") { size_t lay; uint8_t* pay; tmp->Get("ay", &lay, &pay); for (size_t j = 0; j < lay; ++j) { printf("%02x ", pay[j]); } } else { printf("User Defined Value\tSignature: %s", tmp->Signature().c_str()); } printf("\n"); } delete [] fields; } class MyAboutListener : public AboutListener { void Announced(const char* busName, uint16_t version, SessionPort port, const MsgArg& objectDescriptionArg, const MsgArg& aboutDataArg) { AboutObjectDescription objectDescription; objectDescription.CreateFromMsgArg(objectDescriptionArg); printf("*********************************************************************************\n"); printf("Announce signal discovered\n"); printf("\tFrom bus %s\n", busName); printf("\tAbout version %hu\n", version); printf("\tSessionPort %hu\n", port); printf("\tObjectDescription:\n"); AboutObjectDescription aod(objectDescriptionArg); size_t pathCount = aod.GetPaths(NULL, 0); const char** paths = new const char*[pathCount]; aod.GetPaths(paths, pathCount); for (size_t i = 0; i < pathCount; ++i) { printf("\t\t%s\n", paths[i]); size_t interfaceCount = aod.GetInterfaces(paths[i], NULL, 0); const char** interfaces = new const char*[interfaceCount]; aod.GetInterfaces(paths[i], interfaces, interfaceCount); for (size_t j = 0; j < interfaceCount; ++j) { printf("\t\t\t%s\n", interfaces[j]); } delete [] interfaces; } delete [] paths; printf("\tAboutData:\n"); AboutData aboutData(aboutDataArg); printAboutData(aboutData, NULL, 2); printf("*********************************************************************************\n"); QStatus status; if (g_bus != NULL) { SessionId sessionId; SessionOpts opts(SessionOpts::TRAFFIC_MESSAGES, false, SessionOpts::PROXIMITY_ANY, TRANSPORT_ANY); g_bus->EnableConcurrentCallbacks(); status = g_bus->JoinSession(busName, port, &sessionListener, sessionId, opts); printf("SessionJoined sessionId = %u, status = %s\n", sessionId, QCC_StatusText(status)); if (ER_OK == status && 0 != sessionId) { AboutProxy aboutProxy(*g_bus, busName, sessionId); MsgArg objArg; aboutProxy.GetObjectDescription(objArg); printf("*********************************************************************************\n"); printf("AboutProxy.GetObjectDescription:\n"); AboutObjectDescription aod(objArg); size_t pathCount = aod.GetPaths(NULL, 0); const char** paths = new const char*[pathCount]; aod.GetPaths(paths, pathCount); for (size_t i = 0; i < pathCount; ++i) { printf("\t%s\n", paths[i]); size_t interfaceCount = aod.GetInterfaces(paths[i], NULL, 0); const char** interfaces = new const char*[interfaceCount]; aod.GetInterfaces(paths[i], interfaces, interfaceCount); for (size_t j = 0; j < interfaceCount; ++j) { printf("\t\t%s\n", interfaces[j]); } delete [] interfaces; } delete [] paths; MsgArg aArg; aboutProxy.GetAboutData("en", aArg); printf("*********************************************************************************\n"); printf("AboutProxy.GetAboutData: (Default Language)\n"); AboutData aboutData(aArg); printAboutData(aboutData, NULL, 1); size_t languageCount; languageCount = aboutData.GetSupportedLanguages(); /* If the languageCount == 1 we only have a default language */ if (languageCount > 1) { const char** langs = new const char*[languageCount]; aboutData.GetSupportedLanguages(langs, languageCount); char* defaultLanguage; aboutData.GetDefaultLanguage(&defaultLanguage); /* * Print out the AboutData for every language but the * default; it has already been printed. */ for (size_t i = 0; i < languageCount; ++i) { if (strcmp(defaultLanguage, langs[i]) != 0) { status = aboutProxy.GetAboutData(langs[i], aArg); if (ER_OK == status) { aboutData.CreatefromMsgArg(aArg, langs[i]); printf("AboutProxy.GetAboutData: (%s)\n", langs[i]); printAboutData(aboutData, langs[i], 1); } } } delete [] langs; } uint16_t ver; aboutProxy.GetVersion(ver); printf("*********************************************************************************\n"); printf("AboutProxy.GetVersion %hd\n", ver); printf("*********************************************************************************\n"); } } else { printf("BusAttachment is NULL\n"); } } MySessionListener sessionListener; }; int CDECL_CALL main(int argc, char** argv) { QCC_UNUSED(argc); QCC_UNUSED(argv); if (AllJoynInit() != ER_OK) { return 1; } #ifdef ROUTER if (AllJoynRouterInit() != ER_OK) { AllJoynShutdown(); return 1; } #endif /* Install SIGINT handler so Ctrl + C deallocates memory properly */ signal(SIGINT, SigIntHandler); QStatus status; g_bus = new BusAttachment("AboutListener", true); status = g_bus->Start(); if (ER_OK == status) { printf("BusAttachment started.\n"); } else { printf("FAILED to start BusAttachment (%s)\n", QCC_StatusText(status)); exit(1); } status = g_bus->Connect(); if (ER_OK == status) { printf("BusAttachment connect succeeded.\n"); } else { printf("FAILED to connect to router node (%s)\n", QCC_StatusText(status)); exit(1); } MyAboutListener* aboutListener = new MyAboutListener(); g_bus->RegisterAboutListener(*aboutListener); /* Passing NULL into WhoImplements will listen for all About announcements */ status = g_bus->WhoImplements(NULL); if (ER_OK == status) { printf("WhoImplements NULL called.\n"); } else { printf("WhoImplements call FAILED with status %s\n", QCC_StatusText(status)); exit(1); } /* Perform the service asynchronously until the user signals for an exit. */ if (ER_OK == status) { while (s_interrupt == false) { #ifdef _WIN32 Sleep(100); #else usleep(100 * 1000); #endif } } g_bus->UnregisterAboutListener(*aboutListener); delete aboutListener; delete g_bus; #ifdef ROUTER AllJoynRouterShutdown(); #endif AllJoynShutdown(); return 0; } alljoyn-15.04b/alljoyn_core/samples/aboutlistener/SConscript000066400000000000000000000021241255700255500243600ustar00rootroot00000000000000# Copyright AllSeen Alliance. All rights reserved. # # Permission to use, copy, modify, and/or distribute this software for any # purpose with or without fee is hereby granted, provided that the above # copyright notice and this permission notice appear in all copies. # # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. # Import('env') clientDistDir = '$CPP_DISTDIR/samples/aboutlistener' # Sample Programs progs = [ env.Program('AboutListener', ['AboutListener.cc']), ] if env['OS_GROUP'] in ['windows', 'posix']: env.Install('$CPP_DISTDIR/bin/samples', progs ) env.Install(clientDistDir, env.Glob('*.cc'))alljoyn-15.04b/alljoyn_core/samples/basic/000077500000000000000000000000001255700255500205505ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/samples/basic/Makefile000066400000000000000000000074421255700255500222170ustar00rootroot00000000000000# Copyright AllSeen Alliance. All rights reserved. # # Permission to use, copy, modify, and/or distribute this software for any # purpose with or without fee is hereby granted, provided that the above # copyright notice and this permission notice appear in all copies. # # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. # returns current working directory TOP := $(dir $(CURDIR)/$(word $(words $(MAKEFILE_LIST)),$(MAKEFILE_LIST))) ALLJOYN_DIST := ../.. # for use by AllJoyn developers. Code built from alljoyn_core #ALLJOYN_DIST := ../../build/linux/x86/debug/dist #ALLJOYN_DIST := ../../build/linux/x86/release/dist #ALLJOYN_DIST := ../../build/linux/x86_64/debug/dist #ALLJOYN_DIST := ../../build/linux/x86_64/release/dist # for use by AllJoyn developers. Code built from master #ALLJOYN_DIST := ../../../build/linux/x86/debug/dist #ALLJOYN_DIST := ../../../build/linux/x86/release/dist #ALLJOYN_DIST := ../../../build/linux/x86_64/debug/dist #ALLJOYN_DIST := ../../../build/linux/x86_64/release/dist OBJ_DIR := obj BIN_DIR := bin ALLJOYN_LIB := $(ALLJOYN_DIST)/lib/liballjoyn.a CXXFLAGS = -Wall -pipe -std=c++98 -fno-rtti -fno-exceptions -Wno-long-long -Wno-deprecated -g -DQCC_OS_LINUX -DQCC_OS_GROUP_POSIX -DQCC_CPU_X86 LIBS = -lstdc++ -lcrypto -lpthread -lrt .PHONY: default clean default: all all: basic_client basic_service nameChange_client signal_service signalConsumer_client basic_client: basic_client.o $(ALLJOYN_LIB) mkdir -p $(BIN_DIR) $(CXX) -o $(BIN_DIR)/$@ $(OBJ_DIR)/basic_client.o $(TOP)$(ALLJOYN_LIB) $(LIBS) basic_client.o: basic_client.cc $(ALLJOYN_LIB) mkdir -p $(OBJ_DIR) $(CXX) -c $(CXXFLAGS) -I$(ALLJOYN_DIST)/inc -o $(OBJ_DIR)/$@ basic_client.cc basic_service: basic_service.o $(ALLJOYN_LIB) $(CXX) -o $(BIN_DIR)/$@ $(OBJ_DIR)/basic_service.o $(TOP)$(ALLJOYN_LIB) $(LIBS) basic_service.o: basic_service.cc $(ALLJOYN_LIB) $(CXX) -c $(CXXFLAGS) -I$(ALLJOYN_DIST)/inc -o $(OBJ_DIR)/$@ basic_service.cc nameChange_client: nameChange_client.o $(ALLJOYN_LIB) $(CXX) -o $(BIN_DIR)/$@ $(OBJ_DIR)/nameChange_client.o $(TOP)$(ALLJOYN_LIB) $(LIBS) nameChange_client.o: nameChange_client.cc $(ALLJOYN_LIB) $(CXX) -c $(CXXFLAGS) -I$(ALLJOYN_DIST)/inc -o $(OBJ_DIR)/$@ nameChange_client.cc signal_service: signal_service.o $(ALLJOYN_LIB) $(CXX) -o $(BIN_DIR)/$@ $(OBJ_DIR)/signal_service.o $(TOP)$(ALLJOYN_LIB) $(LIBS) signal_service.o: signal_service.cc $(ALLJOYN_LIB) $(CXX) -c $(CXXFLAGS) -I$(ALLJOYN_DIST)/inc -o $(OBJ_DIR)/$@ signal_service.cc signalConsumer_client: signalConsumer_client.o $(ALLJOYN_LIB) $(CXX) -o $(BIN_DIR)/$@ $(OBJ_DIR)/signalConsumer_client.o $(TOP)$(ALLJOYN_LIB) $(LIBS) signalConsumer_client.o: signalConsumer_client.cc $(ALLJOYN_LIB) $(CXX) -c $(CXXFLAGS) -I$(ALLJOYN_DIST)/inc -o $(OBJ_DIR)/$@ signalConsumer_client.cc clean: clean_basic_client clean_basic_service clean_nameChange_client clean_signal_service clean_signalConsumer_client rmdir $(OBJ_DIR) rmdir $(BIN_DIR) clean_basic_client: rm -f $(OBJ_DIR)/basic_client.o $(BIN_DIR)/basic_client clean_basic_service: rm -f $(OBJ_DIR)/basic_service.o $(BIN_DIR)/basic_service clean_nameChange_client: rm -f $(OBJ_DIR)/nameChange_client.o $(BIN_DIR)/nameChange_client clean_signal_service: rm -f $(OBJ_DIR)/signal_service.o $(BIN_DIR)/signal_service clean_signalConsumer_client: rm -f $(OBJ_DIR)/signalConsumer_client.o $(BIN_DIR)/signalConsumer_client alljoyn-15.04b/alljoyn_core/samples/basic/README.txt000066400000000000000000000055151255700255500222540ustar00rootroot00000000000000As the samples are built with the builtin router, you do not need to have the daemon running. The following are samples of a basic service and client. +basic_service.cc +basic_client.cc basic_service.cc: will create a service that will join the bus and request the name 'com.sample.test' it will create a single method called 'cat' that will concatenate two strings together and return the resulting string to the client. basic_client.cc: will connect to the bus discover the interface of 'com.sample.test' then it will make a call to the 'cat' method. Example output $ ./basic_service & AllJoyn Library version: v1.2.1 AllJoyn Library build info: AllJoyn Library v1.2.1 (Built Mon Apr 19 18:44:15 UTC 2010 on ubuntu ... $ ./basic_client AllJoyn Library version: v1.2.1 AllJoyn Library build info: AllJoyn Library v1.2.1 (Built Mon Apr 19 18:44:15 UTC 2010 on ubuntu ... org.alljoyn.method_sample.cat ( path=/org/alljoyn) returned "Hello World!" basic client exiting with status 0 (ER_OK) The following show an example of how to emit and subscribe to an AllJoyn signal. +signal_service.cc +signalConsumer_client.cc +nameChange_client.cc signal_service.cc: will create a service that will join the bus and request the name 'org.alljoyn.signal_sample'. this service will have a property 'name' the name can be changed using Get and Set methods. when the value for 'name' is changed a 'nameChanged' signal will be sent with the new name assigned to the 'name' property. signalConsumer_client.cc: will connect to the bus and subscribe to the 'nameChanged' signal. When the name has been changed it will print out a message indicating it has received the signal and indicate the new name. nameChange_client.cc: will accept a text string as one of its command line arguments. The string will be sent to the 'org.alljoyn.signal_sample' object and will be used as the new 'name' property using the 'set' method. Example output: $ ./signal_service & AllJoyn Library version: v1.2.1 $ ./signalConsumer_client & AllJoyn Library version: v1.2.1 $ ./nameChange_client "Hello World" AllJoyn Library version: v1.2.1 --==## signalConsumer: Name Changed signal Received ##==-- New name: Hello World name Change client exiting with status 0 (ER_OK) $ ./nameChange_client foo AllJoyn Library version: v1.2.1 --==## signalConsumer: Name Changed signal Received ##==-- New name: foo name Change client exiting with status 0 (ER_OK) $ ./nameChange_client bar AllJoyn Library version: v1.2.1 --==## signalConsumer: Name Changed signal Received ##==-- New name: bar name Change client exiting with status 0 (ER_OK) alljoyn-15.04b/alljoyn_core/samples/basic/README.windows.txt000066400000000000000000000163461255700255500237510ustar00rootroot00000000000000The following are samples of a basic service and client that will use the already existing AllJoyn Service to transfer messages. +basic_service.cc +basic_client.cc basic_service.cc: Will create a service that will join the bus and request the name 'org.alljoyn.Bus.sample' it will create a single method called 'cat' that will concatenate two strings together and return the resulting string to the client. Example output: basic_service AllJoyn Library version: v3.3.0. AllJoyn Library build info: AllJoyn Library v3.3.0 (Built Mon Jul 08 21:22:32 UTC 2013 by User). Interface created. BusAttachment started. RegisterBusObject succeeded. Initialized winsock ObjectRegistered has been called. Connect to 'null:' succeeded. RequestName('org.alljoyn.Bus.sample') succeeded. NameOwnerChanged: name=org.alljoyn.Bus.sample, oldOwner=, newOwner=:kr2UKQ9n.2. BindSessionPort succeeded. Advertisement of the service name 'org.alljoyn.Bus.sample' succeeded. Accepting join session request from :APzsgCvo.2 (opts.proximity=ff, opts.traffic=1, opts.transports=4). basic_client.cc: Will connect to the bus discover the interface of 'org.alljoyn.Bus.sample' then it will make a call to the 'cat' method. Example output: basic_client AllJoyn Library version: v3.3.0. AllJoyn Library build info: AllJoyn Library v3.3.0 (Built Mon Jul 08 21:22:32 UTC 2013 by User). Interface 'org.alljoyn.Bus.sample' created. BusAttachment started. Initialized winsock BusAttachment connected to 'null:'. BusListener Registered. org.alljoyn.Bus.FindAdvertisedName ('org.alljoyn.Bus.sample') succeeded. Waited 0 seconds for JoinSession completion. FoundAdvertisedName(name='org.alljoyn.Bus.sample', prefix='org.alljoyn.Bus.sample') NameOwnerChanged: name='org.alljoyn.Bus.sample', oldOwner='', newOwner=':kr2UKQ9n.2'. JoinSession SUCCESS (Session id=736495887). 'org.alljoyn.Bus.sample.cat' (path='/sample') returned 'Hello World!'. Basic client exiting with status 0x0000 (ER_OK). The following show an example of how to emit and subscribe to an AllJoyn signal. +signal_service.cc +signalConsumer_client.cc +nameChange_client.cc signal_service.cc: Will create a service that will join the bus and request the name 'org.alljoyn.signal_sample'. This service will have a property 'name' the name can be changed using Get and Set methods. When the value for 'name' is changed a 'nameChanged' signal will be sent with the new name assigned to the 'name' property. signalConsumer_client.cc: Will connect to the bus and subscribe to the 'nameChanged' signal. When the name has been changed it will print out a message indicating it has received the signal and indicate the new name. nameChange_client.cc: Will accept a text string as one of its command line arguments. The string will be sent to the 'org.alljoyn.signal_sample' object and will be used as the new 'name' property using the 'set' method. Example output (three different command prompts): signal_service AllJoyn Library version: v3.3.0. AllJoyn Library build info: AllJoyn Library v3.3.0 (Built Mon Jul 08 21:22:32 UTC 2013 by User). BusAttachment started. Registering the bus object. Initialized winsock Connected to 'null:'. RequestName('org.alljoyn.Bus.signal_sample') succeeded. NameOwnerChanged: name=org.alljoyn.Bus.signal_sample, oldOwner=, newOwner=:d3Ydq-gI.2 BindSessionPort succeeded. Advertisement of the service name 'org.alljoyn.Bus.signal_sample' succeeded. Accepting join session request from :kfmTanbu.2 (opts.proximity=ff, opts.traffic=1, opts.transports=4) Accepting join session request from :cuBOXz15.2 (opts.proximity=ff, opts.traffic=1, opts.transports=4) Set 'name' property was called changing name to Hello World Emiting Name Changed Signal. Sending NameChanged signal without a session id Accepting join session request from :X7yTi8Hv.2 (opts.proximity=ff, opts.traffic=1, opts.transports=4) Set 'name' property was called changing name to foo Emiting Name Changed Signal. Sending NameChanged signal without a session id signalConsumer_client AllJoyn Library version: v3.3.0. AllJoyn Library build info: AllJoyn Library v3.3.0 (Built Mon Jul 08 21:22:32 UTC 2013 by User). BusAttachment started. Interface created successfully. Interface successfully added to the bus. Registered signal handler for org.alljoyn.Bus.signal_sample.nameChanged. Registering the bus object. Initialized winsock Connected to 'null:'. BusListener registered. org.alljoyn.Bus.FindAdvertisedName ('org.alljoyn.Bus.signal_sample') succeeded. Waited 0 seconds for JoinSession completion. FoundAdvertisedName(name='org.alljoyn.Bus.signal_sample', prefix='org.alljoyn.Bus.signal_sample') NameOwnerChanged: name='org.alljoyn.Bus.signal_sample', oldOwner='', newOwner=':d3Ydq-gI.2'. JoinSession SUCCESS (Session id=1054893573). Successfully subscribed to the name changed signal. --==## signalConsumer: Name Changed signal Received ##==-- New name: 'Hello World'. --==## signalConsumer: Name Changed signal Received ##==-- New name: 'foo'. nameChange_client "Hello World" AllJoyn Library version: v3.3.0. AllJoyn Library build info: AllJoyn Library v3.3.0 (Built Mon Jul 08 21:22:32 UTC 2013 by User). BusAttachment started. Initialized winsock BusAttachment connected to 'null:'. BusListener registered. org.alljoyn.Bus.FindAdvertisedName ('org.alljoyn.Bus.signal_sample') succeeded. Waited 0 seconds for JoinSession completion. FoundAdvertisedName(name='org.alljoyn.Bus.signal_sample', prefix='org.alljoyn.Bus.signal_sample') NameOwnerChanged: name='org.alljoyn.Bus.signal_sample', oldOwner='', newOwner=':d3Ydq-gI.2'. JoinSession SUCCESS (Session id=665747451). SetProperty to change the 'name' property to 'Hello World' was successful. Name change client exiting with status 0x0000 (ER_OK). nameChange_client.exe foo AllJoyn Library version: v3.3.0. AllJoyn Library build info: AllJoyn Library v3.3.0 (Built Mon Jul 08 21:22:32 UTC 2013 by User). BusAttachment started. Initialized winsock BusAttachment connected to 'null:'. BusListener registered. org.alljoyn.Bus.FindAdvertisedName ('org.alljoyn.Bus.signal_sample') succeeded. Waited 0 seconds for JoinSession completion. FoundAdvertisedName(name='org.alljoyn.Bus.signal_sample', prefix='org.alljoyn.Bus.signal_sample') NameOwnerChanged: name='org.alljoyn.Bus.signal_sample', oldOwner='', newOwner=':d3Ydq-gI.2'. JoinSession SUCCESS (Session id=90361483). SetProperty to change the 'name' property to 'foo' was successful. Name change client exiting with status 0x0000 (ER_OK).alljoyn-15.04b/alljoyn_core/samples/basic/SConscript000066400000000000000000000044341255700255500225670ustar00rootroot00000000000000# Copyright AllSeen Alliance. All rights reserved. # # Permission to use, copy, modify, and/or distribute this software for any # purpose with or without fee is hereby granted, provided that the above # copyright notice and this permission notice appear in all copies. # # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. # Import('env') clientDistDir = '$CPP_DISTDIR/samples/basic' # Sample Programs progs = [ env.Program('basic_service', ['basic_service.cc']), env.Program('basic_client', ['basic_client.cc']), env.Program('signal_service', ['signal_service.cc']), env.Program('nameChange_client', ['nameChange_client.cc']), env.Program('signalConsumer_client', ['signalConsumer_client.cc']), ] if env['OS'] in ['linux', 'darwin']: env.Install('$CPP_DISTDIR/bin/samples', progs ) env.Install(clientDistDir, env.Glob('*.cc')) env.Install(clientDistDir, 'Makefile') env.Install(clientDistDir, 'README.txt') elif env['OS_GROUP'] == 'windows': env.Install('$CPP_DISTDIR/bin/samples', progs ) env.Install(clientDistDir, env.Glob('*.cc')) env.InstallAs(clientDistDir + '/README.txt', 'README.windows.txt') #install Visual Studio solution files env.Install(clientDistDir+'/VC2008Win7', 'VC2008Win7/VC2008Win7.sln') env.Install(clientDistDir+'/VC2008Win7/basic_client', 'VC2008Win7/basic_client/basic_client.vcproj') env.Install(clientDistDir+'/VC2008Win7/basic_service', 'VC2008Win7/basic_service/basic_service.vcproj') env.Install(clientDistDir+'/VC2008Win7/nameChange_client', 'VC2008Win7/nameChange_client/nameChange_client.vcproj') env.Install(clientDistDir+'/VC2008Win7/signal_service', 'VC2008Win7/signal_service/signal_service.vcproj') env.Install(clientDistDir+'/VC2008Win7/signalConsumer_client', 'VC2008Win7/signalConsumer_client/signalConsumer_client.vcproj') alljoyn-15.04b/alljoyn_core/samples/basic/VC2008Win7/000077500000000000000000000000001255700255500221375ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/samples/basic/VC2008Win7/VC2008Win7.sln000066400000000000000000000103611255700255500242450ustar00rootroot00000000000000 Microsoft Visual Studio Solution File, Format Version 10.00 # Visual Studio 2008 Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "basic_service", "basic_service\basic_service.vcproj", "{DF15F3DB-EB39-47A4-B9AB-2734DB04B514}" EndProject Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "basic_client", "basic_client\basic_client.vcproj", "{9F0DF068-030B-437A-BF61-2A26B20E2523}" EndProject Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "nameChange_client", "nameChange_client\nameChange_client.vcproj", "{4320A176-CC57-4773-97CF-F946FE07CCB6}" EndProject Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "signal_service", "signal_service\signal_service.vcproj", "{B670DBF4-2366-4CA7-94C5-875D5BBA7547}" EndProject Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "signalConsumer_client", "signalConsumer_client\signalConsumer_client.vcproj", "{6C4C6049-27A5-4B68-AD39-8510B4A01378}" EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Win32 = Debug|Win32 Debug|x64 = Debug|x64 Release|Win32 = Release|Win32 Release|x64 = Release|x64 EndGlobalSection GlobalSection(ProjectConfigurationPlatforms) = postSolution {DF15F3DB-EB39-47A4-B9AB-2734DB04B514}.Debug|Win32.ActiveCfg = Debug|Win32 {DF15F3DB-EB39-47A4-B9AB-2734DB04B514}.Debug|Win32.Build.0 = Debug|Win32 {DF15F3DB-EB39-47A4-B9AB-2734DB04B514}.Debug|x64.ActiveCfg = Debug|x64 {DF15F3DB-EB39-47A4-B9AB-2734DB04B514}.Debug|x64.Build.0 = Debug|x64 {DF15F3DB-EB39-47A4-B9AB-2734DB04B514}.Release|Win32.ActiveCfg = Release|Win32 {DF15F3DB-EB39-47A4-B9AB-2734DB04B514}.Release|Win32.Build.0 = Release|Win32 {DF15F3DB-EB39-47A4-B9AB-2734DB04B514}.Release|x64.ActiveCfg = Release|x64 {DF15F3DB-EB39-47A4-B9AB-2734DB04B514}.Release|x64.Build.0 = Release|x64 {9F0DF068-030B-437A-BF61-2A26B20E2523}.Debug|Win32.ActiveCfg = Debug|Win32 {9F0DF068-030B-437A-BF61-2A26B20E2523}.Debug|Win32.Build.0 = Debug|Win32 {9F0DF068-030B-437A-BF61-2A26B20E2523}.Debug|x64.ActiveCfg = Debug|x64 {9F0DF068-030B-437A-BF61-2A26B20E2523}.Debug|x64.Build.0 = Debug|x64 {9F0DF068-030B-437A-BF61-2A26B20E2523}.Release|Win32.ActiveCfg = Release|Win32 {9F0DF068-030B-437A-BF61-2A26B20E2523}.Release|Win32.Build.0 = Release|Win32 {9F0DF068-030B-437A-BF61-2A26B20E2523}.Release|x64.ActiveCfg = Release|x64 {9F0DF068-030B-437A-BF61-2A26B20E2523}.Release|x64.Build.0 = Release|x64 {4320A176-CC57-4773-97CF-F946FE07CCB6}.Debug|Win32.ActiveCfg = Debug|Win32 {4320A176-CC57-4773-97CF-F946FE07CCB6}.Debug|Win32.Build.0 = Debug|Win32 {4320A176-CC57-4773-97CF-F946FE07CCB6}.Debug|x64.ActiveCfg = Debug|x64 {4320A176-CC57-4773-97CF-F946FE07CCB6}.Debug|x64.Build.0 = Debug|x64 {4320A176-CC57-4773-97CF-F946FE07CCB6}.Release|Win32.ActiveCfg = Release|Win32 {4320A176-CC57-4773-97CF-F946FE07CCB6}.Release|Win32.Build.0 = Release|Win32 {4320A176-CC57-4773-97CF-F946FE07CCB6}.Release|x64.ActiveCfg = Release|x64 {4320A176-CC57-4773-97CF-F946FE07CCB6}.Release|x64.Build.0 = Release|x64 {B670DBF4-2366-4CA7-94C5-875D5BBA7547}.Debug|Win32.ActiveCfg = Debug|Win32 {B670DBF4-2366-4CA7-94C5-875D5BBA7547}.Debug|Win32.Build.0 = Debug|Win32 {B670DBF4-2366-4CA7-94C5-875D5BBA7547}.Debug|x64.ActiveCfg = Debug|x64 {B670DBF4-2366-4CA7-94C5-875D5BBA7547}.Debug|x64.Build.0 = Debug|x64 {B670DBF4-2366-4CA7-94C5-875D5BBA7547}.Release|Win32.ActiveCfg = Release|Win32 {B670DBF4-2366-4CA7-94C5-875D5BBA7547}.Release|Win32.Build.0 = Release|Win32 {B670DBF4-2366-4CA7-94C5-875D5BBA7547}.Release|x64.ActiveCfg = Release|x64 {B670DBF4-2366-4CA7-94C5-875D5BBA7547}.Release|x64.Build.0 = Release|x64 {6C4C6049-27A5-4B68-AD39-8510B4A01378}.Debug|Win32.ActiveCfg = Debug|Win32 {6C4C6049-27A5-4B68-AD39-8510B4A01378}.Debug|Win32.Build.0 = Debug|Win32 {6C4C6049-27A5-4B68-AD39-8510B4A01378}.Debug|x64.ActiveCfg = Debug|x64 {6C4C6049-27A5-4B68-AD39-8510B4A01378}.Debug|x64.Build.0 = Debug|x64 {6C4C6049-27A5-4B68-AD39-8510B4A01378}.Release|Win32.ActiveCfg = Release|Win32 {6C4C6049-27A5-4B68-AD39-8510B4A01378}.Release|Win32.Build.0 = Release|Win32 {6C4C6049-27A5-4B68-AD39-8510B4A01378}.Release|x64.ActiveCfg = Release|x64 {6C4C6049-27A5-4B68-AD39-8510B4A01378}.Release|x64.Build.0 = Release|x64 EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE EndGlobalSection EndGlobal alljoyn-15.04b/alljoyn_core/samples/basic/VC2008Win7/basic_client/000077500000000000000000000000001255700255500245565ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/samples/basic/VC2008Win7/basic_client/basic_client.vcproj000066400000000000000000000171221255700255500304250ustar00rootroot00000000000000 alljoyn-15.04b/alljoyn_core/samples/basic/VC2008Win7/basic_service/000077500000000000000000000000001255700255500247405ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/samples/basic/VC2008Win7/basic_service/basic_service.vcproj000066400000000000000000000173411255700255500307740ustar00rootroot00000000000000 alljoyn-15.04b/alljoyn_core/samples/basic/VC2008Win7/nameChange_client/000077500000000000000000000000001255700255500255235ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/samples/basic/VC2008Win7/nameChange_client/nameChange_client.vcproj000066400000000000000000000171411255700255500323400ustar00rootroot00000000000000 alljoyn-15.04b/alljoyn_core/samples/basic/VC2008Win7/signalConsumer_client/000077500000000000000000000000001255700255500264665ustar00rootroot00000000000000signalConsumer_client.vcproj000066400000000000000000000171551255700255500341740ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/samples/basic/VC2008Win7/signalConsumer_client alljoyn-15.04b/alljoyn_core/samples/basic/VC2008Win7/signal_service/000077500000000000000000000000001255700255500251345ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/samples/basic/VC2008Win7/signal_service/signal_service.vcproj000066400000000000000000000171301255700255500313600ustar00rootroot00000000000000 alljoyn-15.04b/alljoyn_core/samples/basic/basic_client.cc000066400000000000000000000211461255700255500235020ustar00rootroot00000000000000/** * @file * @brief Sample implementation of an AllJoyn client. */ /****************************************************************************** * * * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #include #include #include #include #include using namespace std; using namespace qcc; using namespace ajn; /** Static top level message bus object */ static BusAttachment* g_msgBus = NULL; /*constants*/ static const char* INTERFACE_NAME = "org.alljoyn.Bus.sample"; static const char* SERVICE_NAME = "org.alljoyn.Bus.sample"; static const char* SERVICE_PATH = "/sample"; static const SessionPort SERVICE_PORT = 25; static bool s_joinComplete = false; static String s_sessionHost; static SessionId s_sessionId = 0; static volatile sig_atomic_t s_interrupt = false; static void CDECL_CALL SigIntHandler(int sig) { QCC_UNUSED(sig); s_interrupt = true; } /** AllJoynListener receives discovery events from AllJoyn */ class MyBusListener : public BusListener, public SessionListener { public: void FoundAdvertisedName(const char* name, TransportMask transport, const char* namePrefix) { if (0 == strcmp(name, SERVICE_NAME) && s_sessionHost.empty()) { printf("FoundAdvertisedName(name='%s', transport = 0x%x, prefix='%s')\n", name, transport, namePrefix); /* We found a remote bus that is advertising basic service's well-known name so connect to it. */ /* Since we are in a callback we must enable concurrent callbacks before calling a synchronous method. */ s_sessionHost = name; g_msgBus->EnableConcurrentCallbacks(); SessionOpts opts(SessionOpts::TRAFFIC_MESSAGES, false, SessionOpts::PROXIMITY_ANY, TRANSPORT_ANY); QStatus status = g_msgBus->JoinSession(name, SERVICE_PORT, this, s_sessionId, opts); if (ER_OK == status) { printf("JoinSession SUCCESS (Session id=%d).\n", s_sessionId); } else { printf("JoinSession failed (status=%s).\n", QCC_StatusText(status)); } s_joinComplete = true; } } void NameOwnerChanged(const char* busName, const char* previousOwner, const char* newOwner) { if (newOwner && (0 == strcmp(busName, SERVICE_NAME))) { printf("NameOwnerChanged: name='%s', oldOwner='%s', newOwner='%s'.\n", busName, previousOwner ? previousOwner : "", newOwner ? newOwner : ""); } } }; /** Create the interface, report the result to stdout, and return the result status. */ QStatus CreateInterface(void) { /* Add org.alljoyn.Bus.method_sample interface */ InterfaceDescription* testIntf = NULL; QStatus status = g_msgBus->CreateInterface(INTERFACE_NAME, testIntf); if (status == ER_OK) { printf("Interface '%s' created.\n", INTERFACE_NAME); testIntf->AddMethod("cat", "ss", "s", "inStr1,inStr2,outStr", 0); testIntf->Activate(); } else { printf("Failed to create interface '%s'.\n", INTERFACE_NAME); } return status; } /** Start the message bus, report the result to stdout, and return the result status. */ QStatus StartMessageBus(void) { QStatus status = g_msgBus->Start(); if (ER_OK == status) { printf("BusAttachment started.\n"); } else { printf("BusAttachment::Start failed.\n"); } return status; } /** Handle the connection to the bus, report the result to stdout, and return the result status. */ QStatus ConnectToBus(void) { QStatus status = g_msgBus->Connect(); if (ER_OK == status) { printf("BusAttachment connected to '%s'.\n", g_msgBus->GetConnectSpec().c_str()); } else { printf("BusAttachment::Connect('%s') failed.\n", g_msgBus->GetConnectSpec().c_str()); } return status; } /** Register a bus listener in order to get discovery indications and report the event to stdout. */ void RegisterBusListener(void) { /* Static bus listener */ static MyBusListener s_busListener; g_msgBus->RegisterBusListener(s_busListener); printf("BusListener Registered.\n"); } /** Begin discovery on the well-known name of the service to be called, report the result to stdout, and return the result status. */ QStatus FindAdvertisedName(void) { /* Begin discovery on the well-known name of the service to be called */ QStatus status = g_msgBus->FindAdvertisedName(SERVICE_NAME); if (status == ER_OK) { printf("org.alljoyn.Bus.FindAdvertisedName ('%s') succeeded.\n", SERVICE_NAME); } else { printf("org.alljoyn.Bus.FindAdvertisedName ('%s') failed (%s).\n", SERVICE_NAME, QCC_StatusText(status)); } return status; } /** Wait for join session to complete, report the event to stdout, and return the result status. */ QStatus WaitForJoinSessionCompletion(void) { unsigned int count = 0; while (!s_joinComplete && !s_interrupt) { if (0 == (count++ % 10)) { printf("Waited %u seconds for JoinSession completion.\n", count / 10); } #ifdef _WIN32 Sleep(100); #else usleep(100 * 1000); #endif } return s_joinComplete && !s_interrupt ? ER_OK : ER_ALLJOYN_JOINSESSION_REPLY_CONNECT_FAILED; } /** Do a method call, report the result to stdout, and return the result status. */ QStatus MakeMethodCall(void) { ProxyBusObject remoteObj(*g_msgBus, SERVICE_NAME, SERVICE_PATH, s_sessionId); const InterfaceDescription* alljoynTestIntf = g_msgBus->GetInterface(INTERFACE_NAME); assert(alljoynTestIntf); remoteObj.AddInterface(*alljoynTestIntf); Message reply(*g_msgBus); MsgArg inputs[2]; inputs[0].Set("s", "Hello "); inputs[1].Set("s", "World!"); QStatus status = remoteObj.MethodCall(INTERFACE_NAME, "cat", inputs, 2, reply, 5000); if (ER_OK == status) { printf("'%s.%s' (path='%s') returned '%s'.\n", SERVICE_NAME, "cat", SERVICE_PATH, reply->GetArg(0)->v_string.str); } else { printf("MethodCall on '%s.%s' failed.", SERVICE_NAME, "cat"); } return status; } /** Main entry point */ int CDECL_CALL main(int argc, char** argv, char** envArg) { QCC_UNUSED(argc); QCC_UNUSED(argv); QCC_UNUSED(envArg); if (AllJoynInit() != ER_OK) { return 1; } #ifdef ROUTER if (AllJoynRouterInit() != ER_OK) { AllJoynShutdown(); return 1; } #endif printf("AllJoyn Library version: %s.\n", ajn::GetVersion()); printf("AllJoyn Library build info: %s.\n", ajn::GetBuildInfo()); /* Install SIGINT handler. */ signal(SIGINT, SigIntHandler); QStatus status = ER_OK; /* Create message bus. */ g_msgBus = new BusAttachment("myApp", true); /* This test for NULL is only required if new() behavior is to return NULL * instead of throwing an exception upon an out of memory failure. */ if (!g_msgBus) { status = ER_OUT_OF_MEMORY; } if (ER_OK == status) { status = CreateInterface(); } if (ER_OK == status) { status = StartMessageBus(); } if (ER_OK == status) { status = ConnectToBus(); } if (ER_OK == status) { RegisterBusListener(); status = FindAdvertisedName(); } if (ER_OK == status) { status = WaitForJoinSessionCompletion(); } if (ER_OK == status) { status = MakeMethodCall(); } /* Deallocate bus */ delete g_msgBus; g_msgBus = NULL; printf("Basic client exiting with status 0x%04x (%s).\n", status, QCC_StatusText(status)); #ifdef ROUTER AllJoynRouterShutdown(); #endif AllJoynShutdown(); return (int) status; } alljoyn-15.04b/alljoyn_core/samples/basic/basic_service.cc000066400000000000000000000245441255700255500236710ustar00rootroot00000000000000/** * @file * @brief Sample implementation of an AllJoyn service. * * This sample will show how to set up an AllJoyn service that will registered with the * wellknown name 'org.alljoyn.Bus.method_sample'. The service will register a method call * with the name 'cat' this method will take two input strings and return a * Concatenated version of the two strings. * */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #include #include #include #include #include #include #include #include using namespace std; using namespace qcc; using namespace ajn; /*constants*/ static const char* INTERFACE_NAME = "org.alljoyn.Bus.sample"; static const char* SERVICE_NAME = "org.alljoyn.Bus.sample"; static const char* SERVICE_PATH = "/sample"; static const SessionPort SERVICE_PORT = 25; static volatile sig_atomic_t s_interrupt = false; static void CDECL_CALL SigIntHandler(int sig) { QCC_UNUSED(sig); s_interrupt = true; } class BasicSampleObject : public BusObject { public: BasicSampleObject(BusAttachment& bus, const char* path) : BusObject(path) { /** Add the test interface to this object */ const InterfaceDescription* exampleIntf = bus.GetInterface(INTERFACE_NAME); assert(exampleIntf); AddInterface(*exampleIntf); /** Register the method handlers with the object */ const MethodEntry methodEntries[] = { { exampleIntf->GetMember("cat"), static_cast(&BasicSampleObject::Cat) } }; QStatus status = AddMethodHandlers(methodEntries, sizeof(methodEntries) / sizeof(methodEntries[0])); if (ER_OK != status) { printf("Failed to register method handlers for BasicSampleObject.\n"); } } void ObjectRegistered() { BusObject::ObjectRegistered(); printf("ObjectRegistered has been called.\n"); } void Cat(const InterfaceDescription::Member* member, Message& msg) { QCC_UNUSED(member); /* Concatenate the two input strings and reply with the result. */ qcc::String inStr1 = msg->GetArg(0)->v_string.str; qcc::String inStr2 = msg->GetArg(1)->v_string.str; qcc::String outStr = inStr1 + inStr2; MsgArg outArg("s", outStr.c_str()); QStatus status = MethodReply(msg, &outArg, 1); if (ER_OK != status) { printf("Ping: Error sending reply.\n"); } } }; class MyBusListener : public BusListener, public SessionPortListener { void NameOwnerChanged(const char* busName, const char* previousOwner, const char* newOwner) { if (newOwner && (0 == strcmp(busName, SERVICE_NAME))) { printf("NameOwnerChanged: name=%s, oldOwner=%s, newOwner=%s.\n", busName, previousOwner ? previousOwner : "", newOwner ? newOwner : ""); } } bool AcceptSessionJoiner(SessionPort sessionPort, const char* joiner, const SessionOpts& opts) { if (sessionPort != SERVICE_PORT) { printf("Rejecting join attempt on unexpected session port %d.\n", sessionPort); return false; } printf("Accepting join session request from %s (opts.proximity=%x, opts.traffic=%x, opts.transports=%x).\n", joiner, opts.proximity, opts.traffic, opts.transports); return true; } }; /** The bus listener object. */ static MyBusListener s_busListener; /** Top level message bus object. */ static BusAttachment* s_msgBus = NULL; /** Create the interface, report the result to stdout, and return the result status. */ QStatus CreateInterface(void) { /* Add org.alljoyn.Bus.method_sample interface */ InterfaceDescription* testIntf = NULL; QStatus status = s_msgBus->CreateInterface(INTERFACE_NAME, testIntf); if (status == ER_OK) { printf("Interface created.\n"); testIntf->AddMethod("cat", "ss", "s", "inStr1,inStr2,outStr", 0); testIntf->Activate(); } else { printf("Failed to create interface '%s'.\n", INTERFACE_NAME); } return status; } /** Register the bus object and connect, report the result to stdout, and return the status code. */ QStatus RegisterBusObject(BasicSampleObject* obj) { QStatus status = s_msgBus->RegisterBusObject(*obj); if (ER_OK == status) { printf("RegisterBusObject succeeded.\n"); } else { printf("RegisterBusObject failed (%s).\n", QCC_StatusText(status)); } return status; } /** Connect, report the result to stdout, and return the status code. */ QStatus ConnectBusAttachment(void) { QStatus status = s_msgBus->Connect(); if (ER_OK == status) { printf("Connect to '%s' succeeded.\n", s_msgBus->GetConnectSpec().c_str()); } else { printf("Failed to connect to '%s' (%s).\n", s_msgBus->GetConnectSpec().c_str(), QCC_StatusText(status)); } return status; } /** Start the message bus, report the result to stdout, and return the status code. */ QStatus StartMessageBus(void) { QStatus status = s_msgBus->Start(); if (ER_OK == status) { printf("BusAttachment started.\n"); } else { printf("Start of BusAttachment failed (%s).\n", QCC_StatusText(status)); } return status; } /** Create the session, report the result to stdout, and return the status code. */ QStatus CreateSession(TransportMask mask) { SessionOpts opts(SessionOpts::TRAFFIC_MESSAGES, false, SessionOpts::PROXIMITY_ANY, mask); SessionPort sp = SERVICE_PORT; QStatus status = s_msgBus->BindSessionPort(sp, opts, s_busListener); if (ER_OK == status) { printf("BindSessionPort succeeded.\n"); } else { printf("BindSessionPort failed (%s).\n", QCC_StatusText(status)); } return status; } /** Advertise the service name, report the result to stdout, and return the status code. */ QStatus AdvertiseName(TransportMask mask) { QStatus status = s_msgBus->AdvertiseName(SERVICE_NAME, mask); if (ER_OK == status) { printf("Advertisement of the service name '%s' succeeded.\n", SERVICE_NAME); } else { printf("Failed to advertise name '%s' (%s).\n", SERVICE_NAME, QCC_StatusText(status)); } return status; } /** Request the service name, report the result to stdout, and return the status code. */ QStatus RequestName(void) { const uint32_t flags = DBUS_NAME_FLAG_REPLACE_EXISTING | DBUS_NAME_FLAG_DO_NOT_QUEUE; QStatus status = s_msgBus->RequestName(SERVICE_NAME, flags); if (ER_OK == status) { printf("RequestName('%s') succeeded.\n", SERVICE_NAME); } else { printf("RequestName('%s') failed (status=%s).\n", SERVICE_NAME, QCC_StatusText(status)); } return status; } /** Wait for SIGINT before continuing. */ void WaitForSigInt(void) { while (s_interrupt == false) { #ifdef _WIN32 Sleep(100); #else usleep(100 * 1000); #endif } } /** Main entry point */ int CDECL_CALL main(int argc, char** argv, char** envArg) { QCC_UNUSED(argc); QCC_UNUSED(argv); QCC_UNUSED(envArg); if (AllJoynInit() != ER_OK) { return 1; } #ifdef ROUTER if (AllJoynRouterInit() != ER_OK) { AllJoynShutdown(); return 1; } #endif printf("AllJoyn Library version: %s.\n", ajn::GetVersion()); printf("AllJoyn Library build info: %s.\n", ajn::GetBuildInfo()); /* Install SIGINT handler */ signal(SIGINT, SigIntHandler); QStatus status = ER_OK; BasicSampleObject* testObj = NULL; /* Create message bus */ s_msgBus = new BusAttachment("myApp", true); if (s_msgBus) { if (ER_OK == status) { status = CreateInterface(); } if (ER_OK == status) { s_msgBus->RegisterBusListener(s_busListener); } if (ER_OK == status) { status = StartMessageBus(); } testObj = new BasicSampleObject(*s_msgBus, SERVICE_PATH); if (ER_OK == status) { status = RegisterBusObject(testObj); } if (ER_OK == status) { status = ConnectBusAttachment(); } /* * Advertise this service on the bus. * There are three steps to advertising this service on the bus. * 1) Request a well-known name that will be used by the client to discover * this service. * 2) Create a session. * 3) Advertise the well-known name. */ if (ER_OK == status) { status = RequestName(); } const TransportMask SERVICE_TRANSPORT_TYPE = TRANSPORT_ANY; if (ER_OK == status) { status = CreateSession(SERVICE_TRANSPORT_TYPE); } if (ER_OK == status) { status = AdvertiseName(SERVICE_TRANSPORT_TYPE); } /* Perform the service asynchronously until the user signals for an exit. */ if (ER_OK == status) { WaitForSigInt(); } } else { status = ER_OUT_OF_MEMORY; } /* Clean up */ delete s_msgBus; s_msgBus = NULL; delete testObj; testObj = NULL; printf("Basic service exiting with status 0x%04x (%s).\n", status, QCC_StatusText(status)); #ifdef ROUTER AllJoynRouterShutdown(); #endif AllJoynShutdown(); return (int) status; } alljoyn-15.04b/alljoyn_core/samples/basic/nameChange_client.cc000066400000000000000000000203511255700255500244440ustar00rootroot00000000000000/** * @file * @brief Sample implementation of an AllJoyn client. * * This is a simple client that will run and change the 'name' property of the * 'org.alljoyn.Bus.signal_sample' service then exit. */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #include #include #include #include #include using namespace std; using namespace qcc; using namespace ajn; /** Static top level message bus object */ static BusAttachment* s_msgBus = NULL; static const char* INTERFACE_NAME = "org.alljoyn.Bus.signal_sample"; static const char* SERVICE_NAME = "org.alljoyn.Bus.signal_sample"; static const char* SERVICE_PATH = "/"; static const SessionPort SERVICE_PORT = 25; static bool s_joinComplete = false; static String s_sessionHost; static SessionId s_sessionId = 0; static volatile sig_atomic_t s_interrupt = false; static void CDECL_CALL SigIntHandler(int sig) { QCC_UNUSED(sig); s_interrupt = true; } /** AllJoynListener receives discovery events from AllJoyn */ class MyBusListener : public BusListener { public: void FoundAdvertisedName(const char* name, TransportMask transport, const char* namePrefix) { if (0 == strcmp(name, SERVICE_NAME) && s_sessionHost.empty()) { printf("FoundAdvertisedName(name='%s', transport = 0x%x, prefix='%s')\n", name, transport, namePrefix); /* We found a remote bus that is advertising basic service's well-known name so connect to it. */ /* Since we are in a callback we must enable concurrent callbacks before calling a synchronous method. */ s_sessionHost = name; s_msgBus->EnableConcurrentCallbacks(); SessionOpts opts(SessionOpts::TRAFFIC_MESSAGES, false, SessionOpts::PROXIMITY_ANY, TRANSPORT_ANY); QStatus status = s_msgBus->JoinSession(name, SERVICE_PORT, NULL, s_sessionId, opts); if (ER_OK == status) { printf("JoinSession SUCCESS (Session id=%d).\n", s_sessionId); } else { printf("JoinSession failed (status=%s).\n", QCC_StatusText(status)); } s_joinComplete = true; } } void NameOwnerChanged(const char* busName, const char* previousOwner, const char* newOwner) { if (newOwner && (0 == strcmp(busName, SERVICE_NAME))) { printf("NameOwnerChanged: name='%s', oldOwner='%s', newOwner='%s'.\n", busName, previousOwner ? previousOwner : "", newOwner ? newOwner : ""); } } }; /** Start the message bus, report the result to stdout, and return the result status. */ QStatus StartMessageBus(void) { QStatus status = s_msgBus->Start(); if (ER_OK == status) { printf("BusAttachment started.\n"); } else { printf("BusAttachment::Start failed.\n"); } return status; } /** Handle the connection to the bus, report the result to stdout, and return the result status. */ QStatus ConnectToBus(void) { QStatus status = s_msgBus->Connect(); if (ER_OK == status) { printf("BusAttachment connected to '%s'.\n", s_msgBus->GetConnectSpec().c_str()); } else { printf("BusAttachment::Connect('%s') failed.\n", s_msgBus->GetConnectSpec().c_str()); } return status; } /** Register a bus listener in order to get discovery indications and report the event to stdout. */ void RegisterBusListener(void) { /* Static bus listener */ static MyBusListener s_busListener; s_msgBus->RegisterBusListener(s_busListener); printf("BusListener registered.\n"); } /** Begin discovery on the well-known name of the service to be called, report the result to * stdout, and return the result status. */ QStatus FindAdvertisedName(void) { /* Begin discovery on the well-known name of the service to be called */ QStatus status = s_msgBus->FindAdvertisedName(SERVICE_NAME); if (status == ER_OK) { printf("org.alljoyn.Bus.FindAdvertisedName ('%s') succeeded.\n", SERVICE_NAME); } else { printf("org.alljoyn.Bus.FindAdvertisedName ('%s') failed (%s).\n", SERVICE_NAME, QCC_StatusText(status)); } return status; } /** Wait for join session to complete, report the event to stdout, and return the result status. */ QStatus WaitForJoinSessionCompletion(void) { unsigned int count = 0; while (!s_joinComplete && !s_interrupt) { if (0 == (count++ % 10)) { printf("Waited %u seconds for JoinSession completion.\n", count / 10); } #ifdef _WIN32 Sleep(100); #else usleep(100 * 1000); #endif } return s_joinComplete && !s_interrupt ? ER_OK : ER_ALLJOYN_JOINSESSION_REPLY_CONNECT_FAILED; } /** Introspect the remote object, change the 'name' property, report the result to stdout, and return * the result status. */ QStatus DoNameChange(char* newName) { ProxyBusObject remoteObj(*s_msgBus, SERVICE_NAME, SERVICE_PATH, s_sessionId); QStatus status = remoteObj.IntrospectRemoteObject(); if (ER_OK == status) { if (newName) { status = remoteObj.SetProperty(INTERFACE_NAME, "name", newName); if (ER_OK == status) { printf("SetProperty to change the 'name' property to '%s' was successful.\n", newName); } else { printf("Error calling SetProperty to change the 'name' property.\n"); } } else { status = ER_END_OF_DATA; printf("Error new name not given: nameChange_client [new name].\n"); } } else { printf("Introspection of '%s' (path='%s') failed.\n", SERVICE_NAME, SERVICE_PATH); printf("Make sure the service is running before launching the client.\n"); } return status; } /** Main entry point */ int CDECL_CALL main(int argc, char** argv, char** envArg) { QCC_UNUSED(envArg); if (AllJoynInit() != ER_OK) { return 1; } #ifdef ROUTER if (AllJoynRouterInit() != ER_OK) { AllJoynShutdown(); return 1; } #endif printf("AllJoyn Library version: %s.\n", ajn::GetVersion()); printf("AllJoyn Library build info: %s.\n", ajn::GetBuildInfo()); /* Install SIGINT handler */ signal(SIGINT, SigIntHandler); QStatus status = ER_OK; /* Create message bus */ s_msgBus = new BusAttachment("myApp", true); /* This test for NULL is only required if new() behavior is to return NULL * instead of throwing an exception upon an out of memory failure. */ if (!s_msgBus) { status = ER_OUT_OF_MEMORY; } if (ER_OK == status) { status = StartMessageBus(); } if (ER_OK == status) { status = ConnectToBus(); } if (ER_OK == status) { RegisterBusListener(); status = FindAdvertisedName(); } if (ER_OK == status) { status = WaitForJoinSessionCompletion(); } if (ER_OK == status) { status = DoNameChange(argc > 1 ? argv[1] : NULL); } /* Deallocate bus */ delete s_msgBus; s_msgBus = NULL; printf("Name change client exiting with status 0x%04x (%s).\n", status, QCC_StatusText(status)); #ifdef ROUTER AllJoynRouterShutdown(); #endif AllJoynShutdown(); return (int) status; } alljoyn-15.04b/alljoyn_core/samples/basic/signalConsumer_client.cc000066400000000000000000000254551255700255500254210ustar00rootroot00000000000000/** * @file * @brief Sample implementation of an AllJoyn client. * * This client will subscribe to the nameChanged signal sent from the 'org.alljoyn.Bus.signal_sample' * service. When a name change signal is sent this will print out the new value for the * 'name' property that was sent by the service. * */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #include #include #include #include #include #include #ifdef _WIN32 #include #else #include #endif #define QCC_MODULE "ALLJOYN" using namespace std; using namespace qcc; using namespace ajn; /*constants*/ static const char* INTERFACE_NAME = "org.alljoyn.Bus.signal_sample"; static const char* SERVICE_NAME = "org.alljoyn.Bus.signal_sample"; static const char* SERVICE_PATH = "/"; static const SessionPort SERVICE_PORT = 25; /** Static top level message bus object */ static BusAttachment* s_msgBus = NULL; static bool s_joinComplete = false; static String s_sessionHost; static SessionId s_sessionId = 0; static volatile sig_atomic_t s_interrupt = false; static void CDECL_CALL SigIntHandler(int sig) { QCC_UNUSED(sig); s_interrupt = true; } /** AllJoynListener receives discovery events from AllJoyn */ class MyBusListener : public BusListener { public: void FoundAdvertisedName(const char* name, TransportMask transport, const char* namePrefix) { if (0 == strcmp(name, SERVICE_NAME) && s_sessionHost.empty()) { printf("FoundAdvertisedName(name='%s', transport = 0x%x, prefix='%s')\n", name, transport, namePrefix); /* We found a remote bus that is advertising basic service's well-known name so connect to it. */ /* Since we are in a callback we must enable concurrent callbacks before calling a synchronous method. */ s_sessionHost = name; s_msgBus->EnableConcurrentCallbacks(); SessionOpts opts(SessionOpts::TRAFFIC_MESSAGES, true, SessionOpts::PROXIMITY_ANY, TRANSPORT_ANY); QStatus status = s_msgBus->JoinSession(name, SERVICE_PORT, NULL, s_sessionId, opts); if (ER_OK == status) { printf("JoinSession SUCCESS (Session id=%d).\n", s_sessionId); } else { printf("JoinSession failed (status=%s).\n", QCC_StatusText(status)); } s_joinComplete = true; } } void NameOwnerChanged(const char* busName, const char* previousOwner, const char* newOwner) { if (newOwner && (0 == strcmp(busName, SERVICE_NAME))) { printf("NameOwnerChanged: name='%s', oldOwner='%s', newOwner='%s'.\n", busName, previousOwner ? previousOwner : "", newOwner ? newOwner : ""); } } }; class SignalListeningObject : public BusObject { public: SignalListeningObject(BusAttachment& bus, const char* path) : BusObject(path), nameChangedMember(NULL) { /* Add org.alljoyn.Bus.signal_sample interface */ InterfaceDescription* intf = NULL; QStatus status = bus.CreateInterface(INTERFACE_NAME, intf); if (status == ER_OK) { printf("Interface created successfully.\n"); intf->AddSignal("nameChanged", "s", "newName", 0); intf->AddProperty("name", "s", PROP_ACCESS_RW); intf->Activate(); } else { printf("Failed to create interface %s\n", INTERFACE_NAME); } status = AddInterface(*intf); if (status == ER_OK) { printf("Interface successfully added to the bus.\n"); /* Register the signal handler 'nameChanged' with the bus*/ nameChangedMember = intf->GetMember("nameChanged"); assert(nameChangedMember); } else { printf("Failed to Add interface: %s.", INTERFACE_NAME); } /* register the signal handler for the the 'nameChanged' signal */ status = bus.RegisterSignalHandler(this, static_cast(&SignalListeningObject::NameChangedSignalHandler), nameChangedMember, NULL); if (status != ER_OK) { printf("Failed to register signal handler for %s.nameChanged.\n", SERVICE_NAME); } else { printf("Registered signal handler for %s.nameChanged.\n", SERVICE_NAME); } } QStatus SubscribeNameChangedSignal(void) { assert(bus); return bus->AddMatch("type='signal',interface='org.alljoyn.Bus.signal_sample',member='nameChanged'"); } void NameChangedSignalHandler(const InterfaceDescription::Member* member, const char* sourcePath, Message& msg) { QCC_UNUSED(member); QCC_UNUSED(sourcePath); printf("--==## signalConsumer: Name Changed signal Received ##==--\n"); printf("\tNew name: '%s'.\n", msg->GetArg(0)->v_string.str); } private: const InterfaceDescription::Member* nameChangedMember; }; /** Start the message bus, report the result to stdout, and return the result status. */ QStatus StartMessageBus(void) { QStatus status = s_msgBus->Start(); if (ER_OK == status) { printf("BusAttachment started.\n"); } else { printf("BusAttachment::Start failed.\n"); } return status; } /** Register the bus object and connect, report the result to stdout, and return the status code. */ QStatus RegisterBusObjectAndConnect(SignalListeningObject* obj) { printf("Registering the bus object.\n"); s_msgBus->RegisterBusObject(*obj); QStatus status = s_msgBus->Connect(); if (ER_OK == status) { printf("Connected to '%s'.\n", s_msgBus->GetConnectSpec().c_str()); } else { printf("Failed to connect to '%s'.\n", s_msgBus->GetConnectSpec().c_str()); } return status; } /** Register a bus listener in order to get discovery indications and report the event to stdout. */ void RegisterBusListener(void) { /* Static bus listener */ static MyBusListener s_busListener; s_msgBus->RegisterBusListener(s_busListener); printf("BusListener registered.\n"); } /** Find the advertised name, report the result to stdout, and return the status code. */ QStatus FindAdvertisedName(void) { QStatus status = s_msgBus->FindAdvertisedName(SERVICE_NAME); if (ER_OK == status) { printf("org.alljoyn.Bus.FindAdvertisedName ('%s') succeeded.\n", SERVICE_NAME); } else { printf("org.alljoyn.Bus.FindAdvertisedName ('%s') failed (%s))\n", SERVICE_NAME, QCC_StatusText(status)); } return status; } /** Wait for join session to complete, report the event to stdout, and return the result status. */ QStatus WaitForJoinSessionCompletion(void) { unsigned int count = 0; while (!s_joinComplete && !s_interrupt) { if (0 == (count++ % 10)) { printf("Waited %u seconds for JoinSession completion.\n", count / 10); } #ifdef _WIN32 Sleep(100); #else usleep(100 * 1000); #endif } return s_joinComplete && !s_interrupt ? ER_OK : ER_ALLJOYN_JOINSESSION_REPLY_CONNECT_FAILED; } /** Subscribe to the name changed signal, report the result to stdout, and return the status code. */ QStatus SubscribeToNameChangedSignal(SignalListeningObject* object) { QStatus status = object->SubscribeNameChangedSignal(); if (ER_OK == status) { printf("Successfully subscribed to the name changed signal.\n"); } else { printf("Failed to subscribe to the name changed signal.\n"); } return status; } /** Wait for SIGINT before continuing. */ void WaitForSigInt(void) { while (s_interrupt == false) { #ifdef _WIN32 Sleep(100); #else usleep(100 * 1000); #endif } } /** Main entry point */ int CDECL_CALL main(int argc, char** argv, char** envArg) { QCC_UNUSED(argc); QCC_UNUSED(argv); QCC_UNUSED(envArg); if (AllJoynInit() != ER_OK) { return 1; } #ifdef ROUTER if (AllJoynRouterInit() != ER_OK) { AllJoynShutdown(); return 1; } #endif printf("AllJoyn Library version: %s.\n", ajn::GetVersion()); printf("AllJoyn Library build info: %s.\n", ajn::GetBuildInfo()); /* Install SIGINT handler */ signal(SIGINT, SigIntHandler); QStatus status = ER_OK; SignalListeningObject* object = NULL; /* Create message bus */ s_msgBus = new BusAttachment("myApp", true); /* This test for NULL is only required if new() behavior is to return NULL * instead of throwing an exception upon an out of memory failure. */ if (s_msgBus) { if (ER_OK == status) { status = StartMessageBus(); } object = new SignalListeningObject(*s_msgBus, SERVICE_PATH); if (ER_OK == status) { status = RegisterBusObjectAndConnect(object); } if (ER_OK == status) { RegisterBusListener(); status = FindAdvertisedName(); } if (ER_OK == status) { status = WaitForJoinSessionCompletion(); } if (ER_OK == status) { status = SubscribeToNameChangedSignal(object); } /* Wait for the name changes until the user signals for an exit. */ if (ER_OK == status) { WaitForSigInt(); } } else { status = ER_OUT_OF_MEMORY; } /* Clean up */ delete s_msgBus; s_msgBus = NULL; delete object; object = NULL; printf("Signal consumer client exiting with status 0x%04x (%s).\n", status, QCC_StatusText(status)); #ifdef ROUTER AllJoynRouterShutdown(); #endif AllJoynShutdown(); return (int) status; } alljoyn-15.04b/alljoyn_core/samples/basic/signal_service.cc000066400000000000000000000315631255700255500240640ustar00rootroot00000000000000/** * @file * @brief Sample implementation of an AllJoyn service. * * This sample will show how to set up an AllJoyn service that will registered with the * well-known name 'org.alljoyn.Bus.signal_sample'. The service will register a signal method 'nameChanged' * as well as a property 'name'. * * When the property 'sampleName' is changed by any client this service will emit the new name using * the 'nameChanged' signal. * */ /****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #include #include #include #include #include #include #include #include using namespace std; using namespace qcc; using namespace ajn; /** Static top level message bus object */ static BusAttachment* s_msgBus = NULL; static SessionId s_sessionId = 0; static const char* INTERFACE_NAME = "org.alljoyn.Bus.signal_sample"; static const char* SERVICE_NAME = "org.alljoyn.Bus.signal_sample"; static const char* SERVICE_PATH = "/"; static const SessionPort SERVICE_PORT = 25; static volatile sig_atomic_t s_interrupt = false; static void CDECL_CALL SigIntHandler(int sig) { QCC_UNUSED(sig); s_interrupt = true; } static const char* tags[] = { "en", "de" }; static const char* objId = "obj"; static const char* objDescription[] = { "This is the object", "DE: This is the object" }; static const char* ifcId = "ifc"; static const char* ifcDescription[] = { "This is the interface", "DE: This is the interface" }; static const char* nameChangedId = "nameChanged"; static const char* nameChangedDescription[] = { "Emitted when the name changes", "DE: Emitted whent he name changes" }; static const char* argId = "arg"; static const char* nameChangedArgDescription[] = { "This is the new name", "DE: This is the new name" }; static const char* propId = "prop"; static const char* namePropDescription[] = { "This is the actual name", "DE: This is the actual name" }; class MyTranslator : public Translator { public: virtual ~MyTranslator() { } virtual size_t NumTargetLanguages() { return 2; } virtual void GetTargetLanguage(size_t index, qcc::String& ret) { ret.assign(tags[index]); } virtual const char* Translate(const char* sourceLanguage, const char* targetLanguage, const char* source) { QCC_UNUSED(sourceLanguage); size_t i = 0; if (targetLanguage && (0 == strcmp(targetLanguage, "de"))) { i = 1; } if (0 == strcmp(source, objId)) { return objDescription[i]; } if (0 == strcmp(source, ifcId)) { return ifcDescription[i]; } if (0 == strcmp(source, nameChangedId)) { return nameChangedDescription[i]; } if (0 == strcmp(source, argId)) { return nameChangedArgDescription[i]; } if (0 == strcmp(source, propId)) { return namePropDescription[i]; } return NULL; } }; class BasicSampleObject : public BusObject { public: BasicSampleObject(BusAttachment& bus, const char* path) : BusObject(path), nameChangedMember(NULL), prop_name("Default name") { /* Add org.alljoyn.Bus.signal_sample interface */ InterfaceDescription* intf = NULL; QStatus status = bus.CreateInterface(INTERFACE_NAME, intf); if (status == ER_OK) { intf->AddSignal("nameChanged", "s", "newName", 0); intf->AddProperty("name", "s", PROP_ACCESS_RW); intf->SetDescriptionLanguage(""); intf->SetDescription(ifcId); intf->SetMemberDescription("nameChanged", nameChangedId); intf->SetArgDescription("nameChanged", "newName", argId); intf->SetPropertyDescription("name", propId); intf->SetDescriptionTranslator(&translator); intf->Activate(); } else { printf("Failed to create interface %s\n", INTERFACE_NAME); } status = AddInterface(*intf); if (status == ER_OK) { /* Register the signal handler 'nameChanged' with the bus*/ nameChangedMember = intf->GetMember("nameChanged"); assert(nameChangedMember); } else { printf("Failed to Add interface: %s", INTERFACE_NAME); } SetDescription("", objId); SetDescriptionTranslator(&translator); } QStatus EmitNameChangedSignal(qcc::String newName) { printf("Emiting Name Changed Signal.\n"); assert(nameChangedMember); if (0 == s_sessionId) { printf("Sending NameChanged signal without a session id\n"); } MsgArg arg("s", newName.c_str()); uint8_t flags = ALLJOYN_FLAG_GLOBAL_BROADCAST; QStatus status = Signal(NULL, 0, *nameChangedMember, &arg, 1, 0, flags); return status; } QStatus Get(const char* ifcName, const char* propName, MsgArg& val) { QCC_UNUSED(ifcName); printf("Get 'name' property was called returning: %s\n", prop_name.c_str()); QStatus status = ER_OK; if (0 == strcmp("name", propName)) { val.typeId = ALLJOYN_STRING; val.v_string.str = prop_name.c_str(); val.v_string.len = prop_name.length(); } else { status = ER_BUS_NO_SUCH_PROPERTY; } return status; } QStatus Set(const char* ifcName, const char* propName, MsgArg& val) { QCC_UNUSED(ifcName); QStatus status = ER_OK; if ((0 == strcmp("name", propName)) && (val.typeId == ALLJOYN_STRING)) { printf("Set 'name' property was called changing name to %s\n", val.v_string.str); prop_name = val.v_string.str; EmitNameChangedSignal(prop_name); } else { status = ER_BUS_NO_SUCH_PROPERTY; } return status; } private: const InterfaceDescription::Member* nameChangedMember; qcc::String prop_name; MyTranslator translator; }; class MyBusListener : public BusListener, public SessionPortListener { void NameOwnerChanged(const char* busName, const char* previousOwner, const char* newOwner) { if (newOwner && (0 == strcmp(busName, SERVICE_NAME))) { printf("NameOwnerChanged: name=%s, oldOwner=%s, newOwner=%s\n", busName, previousOwner ? previousOwner : "", newOwner ? newOwner : ""); } } bool AcceptSessionJoiner(SessionPort sessionPort, const char* joiner, const SessionOpts& opts) { if (sessionPort != SERVICE_PORT) { printf("Rejecting join attempt on unexpected session port %d\n", sessionPort); return false; } printf("Accepting join session request from %s (opts.proximity=%x, opts.traffic=%x, opts.transports=%x)\n", joiner, opts.proximity, opts.traffic, opts.transports); return true; } }; static MyBusListener s_busListener; /** Start the message bus, report the result to stdout, and return the status code. */ QStatus StartMessageBus(void) { QStatus status = s_msgBus->Start(); if (ER_OK == status) { printf("BusAttachment started.\n"); } else { printf("Start of BusAttachment failed (%s).\n", QCC_StatusText(status)); } return status; } /** Register the bus object and connect, report the result to stdout, and return the status code. */ QStatus RegisterBusObjectAndConnect(BasicSampleObject* obj) { printf("Registering the bus object.\n"); s_msgBus->RegisterBusObject(*obj); QStatus status = s_msgBus->Connect(); if (ER_OK == status) { printf("Connected to '%s'.\n", s_msgBus->GetConnectSpec().c_str()); } else { printf("Failed to connect to '%s'.\n", s_msgBus->GetConnectSpec().c_str()); } return status; } /** Request the service name, report the result to stdout, and return the status code. */ QStatus RequestName(void) { const uint32_t flags = DBUS_NAME_FLAG_REPLACE_EXISTING | DBUS_NAME_FLAG_DO_NOT_QUEUE; QStatus status = s_msgBus->RequestName(SERVICE_NAME, flags); if (ER_OK == status) { printf("RequestName('%s') succeeded.\n", SERVICE_NAME); } else { printf("RequestName('%s') failed (status=%s).\n", SERVICE_NAME, QCC_StatusText(status)); } return status; } /** Create the session, report the result to stdout, and return the status code. */ QStatus CreateSession(TransportMask mask) { SessionOpts opts(SessionOpts::TRAFFIC_MESSAGES, false, SessionOpts::PROXIMITY_ANY, mask); SessionPort sp = SERVICE_PORT; QStatus status = s_msgBus->BindSessionPort(sp, opts, s_busListener); if (ER_OK == status) { printf("BindSessionPort succeeded.\n"); } else { printf("BindSessionPort failed (%s).\n", QCC_StatusText(status)); } return status; } /** Advertise the service name, report the result to stdout, and return the status code. */ QStatus AdvertiseName(TransportMask mask) { QStatus status = s_msgBus->AdvertiseName(SERVICE_NAME, mask); if (ER_OK == status) { printf("Advertisement of the service name '%s' succeeded.\n", SERVICE_NAME); } else { printf("Failed to advertise name '%s' (%s).\n", SERVICE_NAME, QCC_StatusText(status)); } return status; } /** Wait for SIGINT before continuing. */ void WaitForSigInt(void) { while (s_interrupt == false) { #ifdef _WIN32 Sleep(100); #else usleep(100 * 1000); #endif } } /** Main entry point */ int CDECL_CALL main(int argc, char** argv, char** envArg) { QCC_UNUSED(argc); QCC_UNUSED(argv); QCC_UNUSED(envArg); if (AllJoynInit() != ER_OK) { return 1; } #ifdef ROUTER if (AllJoynRouterInit() != ER_OK) { AllJoynShutdown(); return 1; } #endif printf("AllJoyn Library version: %s.\n", ajn::GetVersion()); printf("AllJoyn Library build info: %s.\n", ajn::GetBuildInfo()); /* Install SIGINT handler */ signal(SIGINT, SigIntHandler); QStatus status = ER_OK; BasicSampleObject* testObj = NULL; /* Create message bus */ s_msgBus = new BusAttachment("myApp", true); /* This test for NULL is only required if new() behavior is to return NULL * instead of throwing an exception upon an out of memory failure. */ if (s_msgBus) { /* Register a bus listener */ if (ER_OK == status) { s_msgBus->RegisterBusListener(s_busListener); } if (ER_OK == status) { status = StartMessageBus(); } testObj = new BasicSampleObject(*s_msgBus, SERVICE_PATH); if (ER_OK == status) { status = RegisterBusObjectAndConnect(testObj); } /* * Advertise this service on the bus. * There are three steps to advertising this service on the bus. * 1) Request a well-known name that will be used by the client to discover * this service. * 2) Create a session. * 3) Advertise the well-known name. */ if (ER_OK == status) { status = RequestName(); } const TransportMask SERVICE_TRANSPORT_TYPE = TRANSPORT_ANY; if (ER_OK == status) { status = CreateSession(SERVICE_TRANSPORT_TYPE); } if (ER_OK == status) { status = AdvertiseName(SERVICE_TRANSPORT_TYPE); } /* Perform the service asynchronously until the user signals for an exit. */ if (ER_OK == status) { WaitForSigInt(); } } else { status = ER_OUT_OF_MEMORY; } /* Clean up */ delete s_msgBus; s_msgBus = NULL; delete testObj; testObj = NULL; printf("Signal service exiting with status 0x%04x (%s).\n", status, QCC_StatusText(status)); #ifdef ROUTER AllJoynRouterShutdown(); #endif AllJoynShutdown(); return (int) status; } alljoyn-15.04b/alljoyn_core/samples/chat/000077500000000000000000000000001255700255500204065ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/samples/chat/SConscript000066400000000000000000000037241255700255500224260ustar00rootroot00000000000000# Copyright AllSeen Alliance. All rights reserved. # # Permission to use, copy, modify, and/or distribute this software for any # purpose with or without fee is hereby granted, provided that the above # copyright notice and this permission notice appear in all copies. # # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. # Import('env') # Install sample source clientDistDir = '$CPP_DISTDIR/samples/chat' if env['OS'] == 'android': env.Install(clientDistDir, 'android/AndroidManifest.xml') env.Install(clientDistDir, 'android/.classpath') env.Install(clientDistDir, 'android/.project') env.Install(clientDistDir, 'android/default.properties') env.Install(clientDistDir, env.Dir('android/jni').srcnode()) env.Install(clientDistDir, env.Dir('android/src').srcnode()) env.Install(clientDistDir, env.Dir('android/res').srcnode()) elif env['OS'] in ['linux', 'darwin']: env.Program('chat', ['linux/chat.cc']) env.Install('$CPP_DISTDIR/bin/samples', ['chat']) env.Install(clientDistDir, env.Glob('linux/*.cc')) env.Install(clientDistDir, env.Glob('linux/Make*')) elif env['OS_GROUP'] == 'windows': env.Program('chat', ['linux/chat.cc']) env.Install('$CPP_DISTDIR/bin/samples', ['chat.exe']) env.Install(clientDistDir, env.Glob('linux/*.cc')) #install Visual Studio solution files env.Install(clientDistDir+'/VC2008Win7', 'linux/VC2008Win7/VC2008Win7.sln') env.Install(clientDistDir+'/VC2008Win7/chatsample', 'linux/VC2008Win7/chatsample/chatsample.vcproj') alljoyn-15.04b/alljoyn_core/samples/chat/android/000077500000000000000000000000001255700255500220265ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/samples/chat/android/.classpath000066400000000000000000000007421255700255500240140ustar00rootroot00000000000000 alljoyn-15.04b/alljoyn_core/samples/chat/android/.gitignore000066400000000000000000000000211255700255500240070ustar00rootroot00000000000000bin gen libs obj alljoyn-15.04b/alljoyn_core/samples/chat/android/.project000066400000000000000000000026071255700255500235020ustar00rootroot00000000000000 Chat org.eclipse.cdt.managedbuilder.core.genmakebuilder clean,full,incremental, com.android.ide.eclipse.adt.ResourceManagerBuilder com.android.ide.eclipse.adt.PreCompilerBuilder org.eclipse.jdt.core.javabuilder com.android.ide.eclipse.adt.ApkBuilder org.eclipse.cdt.managedbuilder.core.ScannerConfigBuilder full,incremental, com.android.ide.eclipse.adt.AndroidNature org.eclipse.jdt.core.javanature org.eclipse.cdt.core.cnature org.eclipse.cdt.core.ccnature org.eclipse.cdt.managedbuilder.core.managedBuildNature org.eclipse.cdt.managedbuilder.core.ScannerConfigNature alljoyn-15.04b/alljoyn_core/samples/chat/android/AndroidManifest.xml000066400000000000000000000020231255700255500256140ustar00rootroot00000000000000 alljoyn-15.04b/alljoyn_core/samples/chat/android/default.properties000066400000000000000000000005551255700255500255750ustar00rootroot00000000000000# This file is automatically generated by Android Tools. # Do not modify this file -- YOUR CHANGES WILL BE ERASED! # # This file must be checked in Version Control Systems. # # To customize properties used by the Ant build system use, # "build.properties", and override values to adapt the script to your # project structure. # Project target. target=android-16 alljoyn-15.04b/alljoyn_core/samples/chat/android/jni/000077500000000000000000000000001255700255500226065ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/samples/chat/android/jni/Android.mk000077500000000000000000000115101255700255500245200ustar00rootroot00000000000000# An Android.mk file must begin with the definition of the LOCAL_PATH # variable. It is used to locate source files in the development tree. Here # the macro function 'my-dir', provided by the build system, is used to return # the path of the current directory. # LOCAL_PATH := $(call my-dir) # AllJoyn specifics #ALLJOYN_DIST := ../../../../build/android/arm/$(APP_OPTIM)/dist ALLJOYN_DIST := ../../ # The CLEAR_VARS variable is provided by the build system and points to a # special GNU Makefile that will clear many LOCAL_XXX variables for you # (e.g. LOCAL_MODULE, LOCAL_SRC_FILES, LOCAL_STATIC_LIBRARIES, etc...), # with the exception of LOCAL_PATH. This is needed because all build # control files are parsed in a single GNU Make execution context where # all variables are global. # include $(CLEAR_VARS) # The LOCAL_MODULE variable must be defined to identify each module you # describe in your Android.mk. The name must be *unique* and not contain # any spaces. Note that the build system will automatically add proper # prefix and suffix to the corresponding generated file. In other words, # a shared library module named 'foo' will generate 'libfoo.so'. # LOCAL_MODULE := Chat # The TARGET_PLATFORM defines the targetted Android Platform API level TARGET_PLATFORM := android-16 # An optional list of paths, relative to the NDK *root* directory, # which will be appended to the include search path when compiling # all sources (C, C++ and Assembly). These are placed before any # corresponding inclusion flag in LOCAL_CFLAGS / LOCAL_CPPFLAGS. # # The path for NDK r8 and below is: # $(NDK_ROOT)/sources/cxx-stl/gnu-libstdc++/include \ # $(NDK_ROOT)/sources/cxx-stl/gnu-libstdc++/libs/armeabi/include \ # The path for NDK r8b is: # $(NDK_ROOT)/sources/cxx-stl/gnu-libstdc++/4.6/include \ # $(NDK_ROOT)/sources/cxx-stl/gnu-libstdc++/4.6/libs/armeabi/include LOCAL_C_INCLUDES := \ $(MYDROID_PATH)/external/openssl/include \ $(ALLJOYN_DIST)/inc \ $(NDK_PLATFORMS_ROOT)/$(TARGET_PLATFORM)/arch-arm/usr/include \ $(NDK_ROOT)/sources/cxx-stl/gnu-libstdc++/include \ $(NDK_ROOT)/sources/cxx-stl/gnu-libstdc++/libs/armeabi/include \ $(NDK_ROOT)/sources/cxx-stl/gnu-libstdc++/4.6/include \ $(NDK_ROOT)/sources/cxx-stl/gnu-libstdc++/4.6/libs/armeabi/include # An optional set of compiler flags that will be passed when building # C ***AND*** C++ source files. # # NOTE1: flag "-Wno-psabi" removes warning about GCC 4.4 va_list warning # NOTE2: flag "-Wno-write-strings" removes warning about deprecated conversion # from string constant to �char*� # LOCAL_CFLAGS := -Wno-psabi -Wno-write-strings -DANDROID_NDK -DTARGET_ANDROID -DLINUX -DQCC_OS_GROUP_POSIX -DQCC_OS_ANDROID -DQCC_CPU_ARM -DANDROID # The following line is just for reference here (thus commented out) # as it is unnecessary because the default extension for C++ source # files is '.cpp'. # LOCAL_DEFAULT_CPP_EXTENSION := cc # The LOCAL_SRC_FILES variables must contain a list of C and/or C++ source # files that will be built and assembled into a module. Note that you should # not list header and included files here, because the build system will # compute dependencies automatically for you; just list the source files # that will be passed directly to a compiler, and you should be good. # LOCAL_SRC_FILES := \ Chat_jni.cpp # The list of additional linker flags to be used when building your # module. This is useful to pass the name of specific system libraries # with the "-l" prefix and library paths with the "-L" prefix. # # NOTE: linking with libgcc.a is necessary due to some strangely missing # symbols such as "__aeabi_f2uiz" present in libgcc.a. It has to be linked # as the very last library. # # The path for NDK r8 and below is: # -L$(NDK_ROOT)/sources/cxx-stl/gnu-libstdc++/libs/armeabi \ # The path for NDK r8b is: # -L$(NDK_ROOT)/sources/cxx-stl/gnu-libstdc++/4.6/libs/armeabi \ LOCAL_LDLIBS := \ -L$(NDK_PLATFORMS_ROOT)/$(TARGET_PLATFORM)/arch-arm/usr/lib -L$(ALLJOYN_DIST)/lib \ -L$(NDK_ROOT)/sources/cxx-stl/gnu-libstdc++/libs/armeabi \ -L$(NDK_ROOT)/sources/cxx-stl/gnu-libstdc++/4.6/libs/armeabi \ -L./libs \ -lajrouter -lalljoyn -llog -lz -ldl -lssl -lcrypto -lm -lc -lstdc++ -lgcc -lgnustl_static # By default, ARM target binaries will be generated in 'thumb' mode, where # each instruction are 16-bit wide. You can define this variable to 'arm' # if you want to force the generation of the module's object files in # 'arm' (32-bit instructions) mode # LOCAL_ARM_MODE := arm # The BUILD_SHARED_LIBRARY is a variable provided by the build system that # points to a GNU Makefile script that is in charge of collecting all the # information you defined in LOCAL_XXX variables since the latest # 'include $(CLEAR_VARS)' and determine what to build, and how to do it # exactly. There is also BUILD_STATIC_LIBRARY to generate a static library. # include $(BUILD_SHARED_LIBRARY) alljoyn-15.04b/alljoyn_core/samples/chat/android/jni/Application.mk000077500000000000000000000000751255700255500254070ustar00rootroot00000000000000VARIANT ?= debug APP_OPTIM := $(VARIANT) APP_ABI := armeabi alljoyn-15.04b/alljoyn_core/samples/chat/android/jni/Chat_jni.cpp000066400000000000000000000405771255700255500250460ustar00rootroot00000000000000/* * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ #include "org_alljoyn_bus_samples_chat_Chat.h" #include #include #include #include #include #include #include #include #include #include #include #include #define LOG_TAG "AllJoynChat" /* Missing (from NDK) log macros (cutils/log.h) */ #ifndef LOGD #define LOGD(...) (__android_log_print(ANDROID_LOG_DEBUG, LOG_TAG, __VA_ARGS__)) #endif #ifndef LOGI #define LOGI(...) (__android_log_print(ANDROID_LOG_INFO, LOG_TAG, __VA_ARGS__)) #endif #ifndef LOGE #define LOGE(...) (__android_log_print(ANDROID_LOG_ERROR, LOG_TAG, __VA_ARGS__)) #endif using namespace ajn; /* constants */ static const char* CHAT_SERVICE_INTERFACE_NAME = "org.alljoyn.bus.samples.chat"; static const char* CHAT_SERVICE_WELL_KNOWN_NAME = "org.alljoyn.bus.samples.chat"; static const char* CHAT_SERVICE_OBJECT_PATH = "/chatService"; static const char* NAME_PREFIX = "org.alljoyn.bus.samples.chat"; static const int CHAT_PORT = 27; /* Forward declaration */ class ChatObject; class MyBusListener; /* Static data */ static BusAttachment* s_bus = NULL; static ChatObject* s_chatObj = NULL; static qcc::String s_advertisedName; static MyBusListener* s_busListener = NULL; static qcc::String s_sessionHost; static SessionId s_sessionId = 0; class MyBusListener : public BusListener, public SessionPortListener, public SessionListener { public: void FoundAdvertisedName(const char* name, TransportMask transport, const char* namePrefix) { printf("FoundAdvertisedName(name='%s', transport = 0x%x, prefix='%s')\n", name, transport, namePrefix); if (s_sessionHost.empty()) { const char* convName = name + strlen(NAME_PREFIX); LOGD("Discovered chat conversation: %s \n", name); /* Enable Concurrency since JoinSession can block */ s_sessionHost = name; s_bus->EnableConcurrentCallbacks(); /* Join the conversation */ SessionOpts opts(SessionOpts::TRAFFIC_MESSAGES, true, SessionOpts::PROXIMITY_ANY, TRANSPORT_ANY); QStatus status = s_bus->JoinSession(name, CHAT_PORT, NULL, s_sessionId, opts); if (ER_OK == status) { LOGD("Joined conversation \"%s\"\n", name); } else { LOGD("JoinSession failed status=%s\n", QCC_StatusText(status)); } } } /* Accept an incoming JoinSession request */ bool AcceptSessionJoiner(SessionPort sessionPort, const char* joiner, const SessionOpts& opts) { if (sessionPort != CHAT_PORT) { LOGE("Rejecting join attempt on non-chat session port %d\n", sessionPort); return false; } LOGD("Accepting join session request from %s (opts.proximity=%x, opts.traffic=%x, opts.transports=%x)\n", joiner, opts.proximity, opts.traffic, opts.transports); return true; } void SessionJoined(SessionPort sessionPort, SessionId id, const char* joiner) { s_sessionId = id; LOGD("SessionJoined with %s (id=%u)\n", joiner, id); } void NameOwnerChanged(const char* busName, const char* previousOwner, const char* newOwner) { } }; /* Bus object */ class ChatObject : public BusObject { public: ChatObject(BusAttachment& bus, const char* path, JavaVM* vm, jobject jobj) : BusObject(bus, path), vm(vm), jobj(jobj) { QStatus status; /* Add the chat interface to this object */ const InterfaceDescription* chatIntf = bus.GetInterface(CHAT_SERVICE_INTERFACE_NAME); assert(chatIntf); AddInterface(*chatIntf); /* Store the Chat signal member away so it can be quickly looked up when signals are sent */ chatSignalMember = chatIntf->GetMember("Chat"); assert(chatSignalMember); /* Register signal handler */ status = bus.RegisterSignalHandler(this, static_cast(&ChatObject::ChatSignalHandler), chatSignalMember, NULL); if (ER_OK != status) { LOGE("Failed to register s_advertisedNamesignal handler for ChatObject::Chat (%s)", QCC_StatusText(status)); } } ~ChatObject() { JNIEnv* env; jint jret = vm->GetEnv((void**)&env, JNI_VERSION_1_2); assert(JNI_OK == jret); env->DeleteGlobalRef(jobj); } /** Send a Chat signal */ QStatus SendChatSignal(const char* msg) { MsgArg chatArg("s", msg); uint8_t flags = 0; return Signal(NULL, s_sessionId, *chatSignalMember, &chatArg, 1, 0, flags); } /** Receive a signal from another Chat client */ void ChatSignalHandler(const InterfaceDescription::Member* member, const char* srcPath, Message& msg) { /* Inform Java GUI of this message */ JNIEnv* env; jint jret = vm->GetEnv((void**)&env, JNI_VERSION_1_2); if (JNI_EDETACHED == jret) { vm->AttachCurrentThread(&env, NULL); } jclass jcls = env->GetObjectClass(jobj); jmethodID mid = env->GetMethodID(jcls, "ChatCallback", "(Ljava/lang/String;Ljava/lang/String;)V"); if (mid == 0) { LOGE("Failed to get Java ChatCallback"); } else { jstring jSender = env->NewStringUTF(msg->GetSender()); if (!jSender) { LOGE("NewStringUTF failed"); return; } jstring jChatStr = env->NewStringUTF(msg->GetArg(0)->v_string.str); if (!jChatStr) { LOGE("NewStringUTF failed"); return; } env->CallVoidMethod(jobj, mid, jSender, jChatStr); if (env->ExceptionCheck()) { env->ExceptionClear(); } } if (JNI_EDETACHED == jret) { vm->DetachCurrentThread(); } } void ObjectRegistered(void) { LOGD("\n Object registered \n"); } /** Release the well-known name if it was acquired */ void ReleaseName() { if (s_bus) { uint32_t disposition = 0; const ProxyBusObject& dbusObj = s_bus->GetDBusProxyObj(); Message reply(*s_bus); MsgArg arg; arg.Set("s", s_advertisedName.c_str()); QStatus status = dbusObj.MethodCall(org::freedesktop::DBus::InterfaceName, "ReleaseName", &arg, 1, reply, 5000); if (ER_OK == status) { disposition = reply->GetArg(0)->v_uint32; } if ((ER_OK != status) || (disposition != DBUS_RELEASE_NAME_REPLY_RELEASED)) { LOGE("Failed to release name %s (%s, disposition=%d)", s_advertisedName.c_str(), QCC_StatusText(status), disposition); } } } private: JavaVM* vm; jobject jobj; const InterfaceDescription::Member* chatSignalMember; }; #ifdef __cplusplus extern "C" { #endif /** * Initialize AllJoyn and connect to local daemon. */ JNIEXPORT jint JNICALL Java_org_alljoyn_bus_samples_chat_Chat_jniOnCreate(JNIEnv* env, jobject jobj, jstring packageNameStrObj) { QStatus status = ER_OK; const char* packageNameStr = NULL; InterfaceDescription* chatIntf = NULL; const char* daemonAddr = "unix:abstract=alljoyn"; JavaVM* vm; jobject jglobalObj = NULL; packageNameStr = env->GetStringUTFChars(packageNameStrObj, NULL); if (!packageNameStr) { LOGE("GetStringUTFChars failed"); status = ER_FAIL; goto exit; } /* Create message bus */ s_bus = new BusAttachment(packageNameStr, true); if (!s_bus) { LOGE("new BusAttachment failed"); status = ER_FAIL; goto exit; } /* Create org.alljoyn.bus.samples.chat interface */ status = s_bus->CreateInterface(CHAT_SERVICE_INTERFACE_NAME, chatIntf); if (ER_OK != status) { LOGE("Failed to create interface \"%s\" (%s)", CHAT_SERVICE_INTERFACE_NAME, QCC_StatusText(status)); goto exit; } status = chatIntf->AddSignal("Chat", "s", "str", 0); if (ER_OK != status) { LOGE("Failed to AddSignal \"Chat\" (%s)", QCC_StatusText(status)); goto exit; } chatIntf->Activate(); /* Start the msg bus */ status = s_bus->Start(); if (ER_OK != status) { LOGE("BusAttachment::Start failed (%s)", QCC_StatusText(status)); goto exit; } /* Connect to the daemon */ status = s_bus->Connect(daemonAddr); if (ER_OK != status) { LOGE("BusAttachment::Connect(\"%s\") failed (%s)", daemonAddr, QCC_StatusText(status)); goto exit; } /* Create and register the bus object that will be used to send out signals */ if (0 != env->GetJavaVM(&vm)) { LOGE("GetJavaVM failed"); status = ER_FAIL; goto exit; } jglobalObj = env->NewGlobalRef(jobj); if (!jglobalObj) { LOGE("NewGlobalRef failed"); status = ER_FAIL; goto exit; } s_chatObj = new ChatObject(*s_bus, CHAT_SERVICE_OBJECT_PATH, vm, jglobalObj); if (!s_chatObj) { LOGE("new ChatObject failed"); status = ER_FAIL; goto exit; } jglobalObj = NULL; /* ChatObject owns global reference now */ status = s_bus->RegisterBusObject(*s_chatObj); if (ER_OK != status) { LOGE("BusAttachment::RegisterBusObject() failed (%s)", QCC_StatusText(status)); goto exit; } LOGD("\n Bus Object created and registered \n"); /* Register a bus listener in order to get discovery indications */ s_busListener = new MyBusListener(); if (!s_busListener) { LOGE("new BusListener failed"); status = ER_FAIL; goto exit; } s_bus->RegisterBusListener(*s_busListener); exit: if (ER_OK != status) { delete s_bus; s_bus = NULL; delete s_chatObj; s_chatObj = NULL; delete s_busListener; s_busListener = NULL; if (jglobalObj) { env->DeleteGlobalRef(jglobalObj); } } if (packageNameStr) { env->ReleaseStringUTFChars(packageNameStrObj, packageNameStr); } return (jint) status; } JNIEXPORT jboolean JNICALL Java_org_alljoyn_bus_samples_chat_Chat_advertise(JNIEnv* env, jobject jobj, jstring advertiseStrObj) { const char* advertisedNameStr = NULL; QStatus status; SessionOpts opts(SessionOpts::TRAFFIC_MESSAGES, true, SessionOpts::PROXIMITY_ANY, TRANSPORT_ANY); SessionPort sp = CHAT_PORT; s_advertisedName = ""; advertisedNameStr = env->GetStringUTFChars(advertiseStrObj, NULL); if (!advertisedNameStr) { LOGE("GetStringUTFChars failed"); status = ER_FAIL; goto exit; } s_advertisedName += NAME_PREFIX; s_advertisedName += "."; s_advertisedName += advertisedNameStr; /* Request name */ status = s_bus->RequestName(s_advertisedName.c_str(), DBUS_NAME_FLAG_DO_NOT_QUEUE); if (ER_OK != status) { LOGE("RequestName(%s) failed (status=%s)\n", s_advertisedName.c_str(), QCC_StatusText(status)); goto exit; } LOGD("\n Request Name was successful"); /* Bind the session port*/ status = s_bus->BindSessionPort(sp, opts, *s_busListener); if (ER_OK != status) { LOGE("BindSessionPort failed (%s)\n", QCC_StatusText(status)); goto exit; } LOGD("\n Bind Session Port to %u was successful \n", CHAT_PORT); /* Advertise the name */ status = s_bus->AdvertiseName(s_advertisedName.c_str(), opts.transports); if (status != ER_OK) { LOGD("Failed to advertise name %s (%s) \n", s_advertisedName.c_str(), QCC_StatusText(status)); goto exit; } LOGD("\n Name %s was successfully advertised", s_advertisedName.c_str()); exit: if (ER_OK != status) { s_bus->CancelAdvertiseName(s_advertisedName.c_str(), opts.transports); s_bus->UnbindSessionPort(sp); s_bus->ReleaseName(s_advertisedName.c_str()); } if (advertisedNameStr) { env->ReleaseStringUTFChars(advertiseStrObj, advertisedNameStr); } return (jboolean) (ER_OK == status); } JNIEXPORT jboolean JNICALL Java_org_alljoyn_bus_samples_chat_Chat_joinSession(JNIEnv* env, jobject jobj, jstring joinSessionObj) { const char* sessionNameStr = NULL; qcc::String sessionName; QStatus status = ER_OK; LOGD("\n Inside Join session"); sessionNameStr = env->GetStringUTFChars(joinSessionObj, NULL); if (!sessionNameStr) { LOGE("GetStringUTFChars failed"); status = ER_FAIL; goto exit; } sessionName = ""; sessionName += NAME_PREFIX; sessionName += "."; sessionName += sessionNameStr; LOGD("\n Name of the session to be joined %s ", sessionName.c_str()); /* Call joinSession method since we have the name */ status = s_bus->FindAdvertisedName(sessionName.c_str()); if (ER_OK != status) { LOGE("\n Error while calling FindAdvertisedName \n"); goto exit; } exit: if (sessionNameStr) { env->ReleaseStringUTFChars(joinSessionObj, sessionNameStr); } return (jboolean) (ER_OK == status); } /** * Called when SimpleClient Java application exits. Performs AllJoyn cleanup. */ JNIEXPORT void JNICALL Java_org_alljoyn_bus_samples_chat_Chat_jniOnDestroy(JNIEnv* env, jobject jobj) { /* Deallocate bus */ delete s_bus; s_bus = NULL; /* Deregister the ServiceObject. */ delete s_chatObj; s_chatObj = NULL; delete s_busListener; s_busListener = NULL; } /** * Send a broadcast ping message to all handlers registered for org.codeauora.alljoyn.samples.chat.Chat signal. */ JNIEXPORT jint JNICALL Java_org_alljoyn_bus_samples_chat_Chat_sendChatMsg(JNIEnv* env, jobject jobj, jstring chatMsgObj) { const char* chatMsg = NULL; QStatus status = ER_OK; /* Send a signal */ chatMsg = env->GetStringUTFChars(chatMsgObj, NULL); if (!chatMsg) { LOGE("GetStringUTFChars failed"); status = ER_FAIL; goto exit; } status = s_chatObj->SendChatSignal(chatMsg); if (ER_OK != status) { LOGE("Chat", "Sending signal failed (%s)", QCC_StatusText(status)); goto exit; } exit: if (chatMsg) { env->ReleaseStringUTFChars(chatMsgObj, chatMsg); } return (jint) status; } JNIEXPORT jint JNICALL JNI_OnLoad(JavaVM* vm, void* reserved) { if (AllJoynInit() != ER_OK) { return 1; } if (AllJoynRouterInit() != ER_OK) { AllJoynShutdown(); return 1; } /* Set AllJoyn logging */ //QCC_SetLogLevels("ALLJOYN=7;ALL=1"); QCC_UseOSLogging(true); return JNI_VERSION_1_2; } JNIEXPORT void JNI_OnUnload(JavaVM* vm, void* reserved) { AllJoynRouterShutdown(); AllJoynShutdown(); } #ifdef __cplusplus } #endif alljoyn-15.04b/alljoyn_core/samples/chat/android/jni/org_alljoyn_bus_samples_chat_Chat.h000066400000000000000000000053051255700255500316340ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. * ******************************************************************************/ /* DO NOT EDIT THIS FILE - it is machine generated */ #include /* Header for class org_alljoyn_bus_samples_chat_Chat */ #ifndef _Included_org_alljoyn_bus_samples_chat_Chat #define _Included_org_alljoyn_bus_samples_chat_Chat #ifdef __cplusplus extern "C" { #endif #undef org_alljoyn_bus_samples_chat_Chat_DIALOG_CONNECT #define org_alljoyn_bus_samples_chat_Chat_DIALOG_CONNECT 1L #undef org_alljoyn_bus_samples_chat_Chat_DIALOG_ADVERTISE #define org_alljoyn_bus_samples_chat_Chat_DIALOG_ADVERTISE 2L #undef org_alljoyn_bus_samples_chat_Chat_DIALOG_JOIN_SESSION #define org_alljoyn_bus_samples_chat_Chat_DIALOG_JOIN_SESSION 3L /* * Class: org_alljoyn_bus_samples_chat_Chat * Method: jniOnCreate * Signature: (Ljava/lang/String;)I */ JNIEXPORT jint JNICALL Java_org_alljoyn_bus_samples_chat_Chat_jniOnCreate (JNIEnv *, jobject, jstring); /* * Class: org_alljoyn_bus_samples_chat_Chat * Method: jniOnDestroy * Signature: ()V */ JNIEXPORT void JNICALL Java_org_alljoyn_bus_samples_chat_Chat_jniOnDestroy (JNIEnv *, jobject); /* * Class: org_alljoyn_bus_samples_chat_Chat * Method: sendChatMsg * Signature: (Ljava/lang/String;)I */ JNIEXPORT jint JNICALL Java_org_alljoyn_bus_samples_chat_Chat_sendChatMsg (JNIEnv *, jobject, jstring); /* * Class: org_alljoyn_bus_samples_chat_Chat * Method: advertise * Signature: (Ljava/lang/String;)Z */ JNIEXPORT jboolean JNICALL Java_org_alljoyn_bus_samples_chat_Chat_advertise (JNIEnv *, jobject, jstring); /* * Class: org_alljoyn_bus_samples_chat_Chat * Method: joinSession * Signature: (Ljava/lang/String;)Z */ JNIEXPORT jboolean JNICALL Java_org_alljoyn_bus_samples_chat_Chat_joinSession (JNIEnv *, jobject, jstring); #ifdef __cplusplus } #endif #endif alljoyn-15.04b/alljoyn_core/samples/chat/android/res/000077500000000000000000000000001255700255500226175ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/samples/chat/android/res/drawable-hdpi/000077500000000000000000000000001255700255500253225ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/samples/chat/android/res/drawable-hdpi/icon.png000066400000000000000000000107661255700255500267720ustar00rootroot00000000000000PNG  IHDRHHUGtEXtSoftwareAdobe ImageReadyqe<"iTXtXML:com.adobe.xmp Z:0jIDATx\kl>wf^ر!!$PBlhAU$UÏ%/ZD-5UBJ Qڪi͆gd Pju"^1;s3;;uGH+]ٙ;9y0 X "sc<يM; XB%,aS?TFY'*ӉVm% C`ڇ`E{ 6$0AKl5kS`D ى@U g#6;e;`A/> 79wrck8>*k`)\N\e6 Np/$mڮRgjDeoq ԏK̟8hzqDAQ2He i m{?II6`t6n]+BA*R+Կz- xύy^0Hh/6su Ǩa (W!WNAaޱqSA<ť,Itk -W'o kLdz>SG]VBpBPTfE\RX(iǿW&}bY<*lMA@/<$sAR9-7y5>&:=R -zH{1LQk4~o=$w_F#B7ձP˗R:CRoZvOïAܐzhC@$(KF*иy\[[!&noZf9YU0`=O?7-IZn#.0"OC壂hL$D4Ksc+ތ3@?HSd_kT|󖢲4Ta+;mt,Hf]@{6> |k玔 Eg=l4"dka*R%, xt)4oxnϚ/irtoUR|dƱJ`xD%`V/ c1UN`3*됨A]O>RF܇a (Ubc+epY,{9oGHIJ$!FCMFZ m +k0Lۘꂺ_:,06/kģ(  0|/n؍K%`f)Zy .og;8[~(NYQZKN?H^TY؋%WC濓"!fLa4!ΣK8-s2ʏ8|\qP/_d-{-p{&/9aZbWI|L`qL$9 e ՗[Ps̟rkƥ=o}ݾҊϨP^D5"0d VD%gpT Aɝ*@H)rK@Z$q)BЫJhe}/ PH p˖5x:,賗4 AXv$p*/qyWT;i] y@SN֪^lEPR#JMPՐm,#0=s,G}?]:Cs PjR.t. k I_H"@*5q5?kqxGȬo!sBŎy>I-Ym}6>c<ם9ybFG]ymun'@Wb1RBͿ6LDF;IUeR=;>Sm6阶JHG]୐244h/.~lCͿ=&U!j-UR'N^ tȺѧs[IIJ*&0bc&Ed8"viqE|0[:Em}V0|qO88Gk^볛p)=k#ssر祤$J}y$έsyR]r'{Ũ`Ir@nTvIKϷB 2(7x!a+:\(ŨMeI:N.A ; ,#h-.IENDB`alljoyn-15.04b/alljoyn_core/samples/chat/android/res/drawable-ldpi/000077500000000000000000000000001255700255500253265ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/samples/chat/android/res/drawable-ldpi/icon.png000066400000000000000000000061211255700255500267640ustar00rootroot00000000000000PNG  IHDR00WtEXtSoftwareAdobe ImageReadyqe<"iTXtXML:com.adobe.xmp MIDATxY]lW>w~ϱSIT% Jօ lPx~SB PJB @@B}C@NH*B%6i5&%qu;w8zwǻnW=ιw8܄!ĆZ ,`givO="~}wnb#&>4]ѓ=a }m_S)֗gej B+nl볊 h_A 7srv^~׶K/QrOϒ4f11ޔ gU:~O$KWaZӞL!0G5:ma"G4ȺDmds)CUfV|^ 8VUEG?y ;GdjTۤ t~P"`Oɏb X9b' #NE92D84@]%PW>0f/SS|[E>s*//~VNgJwF1,ShpL1'Hl ̓<4]0E)ܨ5gbe#jصJq#DPrIEc{I@8CZ 0Htr`oOaYXJh*O^d1HQw> փ{0ق}c̽;Ț["dQK!@T '偨ɸIa@I+1G 2v/Za8yDFwscYP)/eۈuEA .@ ah-dŒ,;}d*{@>Kd) =YFCSTp.ʶ,isDDKJ1eXNw"1`|ߐ䀞;lbjGkl@9KE;*エL,L 8k,;0@.;huڂ 4eEVQy'eB}@>&szIzdQOq@lk픓;( ]em /.P% sgژeN}Y p" @Kd@{3hox(U*恢 |b~f,@-l[R1a Y= v)uEfdNgUPބjs`uɶ-)&_[1o,-ba].bT&:reUB|t'V&ρVo4Yk9tK /ٹ*1 8L%|6u.f6&N"jf%NЉ#J RÕ]$1W. #gxrg6e_hmmOPw-u|*SqW4yX"`*yEt_hcüVAQu2&뛓$M^_ǘ[,Ha ۧHK|ͻcx\Lj$OzQ=$ݟqmzgsbxA3uO+ٳ'|Z#khР2fb#:_@Sʃ?&{>8F q_-i=A'0+DT^oz;ߣ<"S|^RTMp[?jչGA% l7)f#>wϩ@T`~o3A5\U8uWUR7BޏwI՜;&iyTDǪ7C>js%yϤ̨9Q%)ﾊ R;Wm3aؠMi`Ο%IENDB`alljoyn-15.04b/alljoyn_core/samples/chat/android/res/drawable-mdpi/000077500000000000000000000000001255700255500253275ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/samples/chat/android/res/drawable-mdpi/icon.png000066400000000000000000000044631255700255500267740ustar00rootroot00000000000000PNG  IHDR$$tEXtSoftwareAdobe ImageReadyqe<"iTXtXML:com.adobe.xmp Za:IDATx̘OEǿ{{p\ hFc{0)76Ԩo F}c41G|MQ6h1!bۚPY-;@vowgY^k'|;<19RQƊ{+ 1ZdѬ!*BAܕb%D bvRًP6U8~?oXIӢ0`:N v#\#0J??8;`^~ڊ$a]?F $ԀW:`wJ敻 ptTK> @q`gPK hiǠ5ցU ,_,gɫ=d%m#;7A&$u}#m!U#`z$6RQ%J}?/o68̿Od%P*d وWIQ'<~$JYۊ(=vIx ڞж!s6L ,WO0uoba^=кe;NT =.Z9JYIa^%wo# ١ Sr5j`aYPM1`nڴ |J6W&"F8tv(AGJ;} ]P$Z'8VEPv ОCN=)H7T)q ,C(fEe">ˑWSK6G KtbOр<`MT5.PYg! E*və~<Ѭ눰qUN2H7Nm"_m:u+Mv g;vkOP)rt/W,G #R& sD: D%Hujɳ*",|Ÿq !|(A6-E4i|xt#h1aRޘ rA:|ǨKEԐu')&l ]Xsgrr2e!'y]K-bQ[k?' xnIENDB`alljoyn-15.04b/alljoyn_core/samples/chat/android/res/layout/000077500000000000000000000000001255700255500241345ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/samples/chat/android/res/layout/advertise.xml000066400000000000000000000015751255700255500266540ustar00rootroot00000000000000 alljoyn-15.04b/alljoyn_core/samples/chat/android/res/layout/choice.xml000066400000000000000000000013731255700255500261140ustar00rootroot00000000000000 alljoyn-15.04b/alljoyn_core/samples/chat/android/res/layout/joinsession.xml000066400000000000000000000016161255700255500272250ustar00rootroot00000000000000 alljoyn-15.04b/alljoyn_core/samples/chat/android/res/layout/main.xml000066400000000000000000000015321255700255500256030ustar00rootroot00000000000000 alljoyn-15.04b/alljoyn_core/samples/chat/android/res/layout/message.xml000066400000000000000000000003101255700255500262740ustar00rootroot00000000000000 alljoyn-15.04b/alljoyn_core/samples/chat/android/res/menu/000077500000000000000000000000001255700255500235635ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/samples/chat/android/res/menu/mainmenu.xml000066400000000000000000000002601255700255500261140ustar00rootroot00000000000000 alljoyn-15.04b/alljoyn_core/samples/chat/android/res/values/000077500000000000000000000000001255700255500241165ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/samples/chat/android/res/values/strings.xml000066400000000000000000000002621255700255500263310ustar00rootroot00000000000000 AllJoyn Chat Enter message alljoyn-15.04b/alljoyn_core/samples/chat/android/src/000077500000000000000000000000001255700255500226155ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/samples/chat/android/src/org/000077500000000000000000000000001255700255500234045ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/samples/chat/android/src/org/alljoyn/000077500000000000000000000000001255700255500250545ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/samples/chat/android/src/org/alljoyn/bus/000077500000000000000000000000001255700255500256455ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/samples/chat/android/src/org/alljoyn/bus/samples/000077500000000000000000000000001255700255500273115ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/samples/chat/android/src/org/alljoyn/bus/samples/chat/000077500000000000000000000000001255700255500302305ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/samples/chat/android/src/org/alljoyn/bus/samples/chat/Chat.java000066400000000000000000000274351255700255500317650ustar00rootroot00000000000000/* * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ package org.alljoyn.bus.samples.chat; import android.app.Activity; import android.app.Dialog; import android.content.res.Configuration; import android.os.Bundle; import android.os.Handler; import android.os.HandlerThread; import android.os.Looper; import android.os.Message; import android.util.Log; import android.view.KeyEvent; import android.view.Menu; import android.view.MenuInflater; import android.view.MenuItem; import android.view.View; import android.view.View.OnClickListener; import android.view.inputmethod.EditorInfo; import android.widget.ArrayAdapter; import android.widget.Button; import android.widget.EditText; import android.widget.ListView; import android.widget.RadioButton; import android.widget.TextView; import android.widget.Toast; public class Chat extends Activity { private EditText editText; private ArrayAdapter listViewArrayAdapter; private ListView listView; private Menu menu; static final int DIALOG_CONNECT = 1; static final int DIALOG_ADVERTISE = 2; static final int DIALOG_JOIN_SESSION = 3; private static final int INCOMINGMESSAGE = 1; private static final int SESSIONCREATEFAILED = 2; private static final int SENDCHATFAILED = 3; /** Called when activity's onCreate is called */ private native int jniOnCreate(String packageName); /** Called when activity's onDestroy is called */ private native void jniOnDestroy(); /** Called when activity UI sends a chat message */ private native int sendChatMsg(String str); /** Called when user enters a name to be "Advertised" " */ private native boolean advertise(String wellKnownName); /** Called when user wants to join a session */ private native boolean joinSession(String sessionName); /** Handler used to post messages from C++ into UI thread */ private Handler handler = new Handler() { @Override public void handleMessage(Message msg) { switch (msg.what) { case INCOMINGMESSAGE: listViewArrayAdapter.add((String)msg.obj); break; case SESSIONCREATEFAILED: Toast.makeText(Chat.this, "jniOnCreate failed with " + msg.arg1, Toast.LENGTH_LONG).show(); finish(); break; case SENDCHATFAILED: Log.v("AllJoynChat", String.format("sendChatMsg(%s) failed (%d)", msg.obj, msg.arg1)); break; } } }; private BusHandler bus_handler; /* Prevent orientation changes */ @Override public void onConfigurationChanged(Configuration newConfig) { super.onConfigurationChanged(newConfig); } /** Called when the activity is first created. */ @Override public void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.choice); // Ask what would you like to do Advertise a session or join one final RadioButton radio_create_seesion = (RadioButton) findViewById(R.id.radio_create_session); final RadioButton radio_join_session = (RadioButton) findViewById(R.id.radio_join_session); radio_create_seesion.setOnClickListener(radio_listener); radio_join_session.setOnClickListener(radio_listener); setConnectedState(false); HandlerThread bus_thread = new HandlerThread("BusHandler"); bus_thread.start(); bus_handler = new BusHandler(bus_thread.getLooper(), this); bus_handler.sendMessage(bus_handler.obtainMessage(BusHandler.ONCREATE, getPackageName())); } @Override protected void onDestroy() { //jniOnDestroy(); bus_handler.sendEmptyMessage(BusHandler.ONDESTROY); super.onDestroy(); } private OnClickListener radio_listener = new OnClickListener() { public void onClick(View v) { // Perform action on clicks RadioButton rb = (RadioButton) v; if(rb.getId() == R.id.radio_create_session){ Toast.makeText(Chat.this, "You selected " + rb.getText(), Toast.LENGTH_LONG).show(); showDialog(DIALOG_ADVERTISE); } else if (rb.getId() == R.id.radio_join_session){ Toast.makeText(Chat.this, "You selected " + rb.getText(), Toast.LENGTH_LONG).show(); showDialog(DIALOG_JOIN_SESSION); } } }; // Send a message to all connected chat clients private void chat(String message) { // Send the AllJoyn signal to other connected chat clients bus_handler.sendMessage(bus_handler.obtainMessage(BusHandler.SENDCHATMSG, message)); listViewArrayAdapter.add("Me: " + message); } @Override public boolean onCreateOptionsMenu(Menu menu) { MenuInflater inflater = getMenuInflater(); inflater.inflate(R.menu.mainmenu, menu); this.menu = menu; return true; } @Override public boolean onOptionsItemSelected(MenuItem item) { // Handle item selection switch (item.getItemId()) { case R.id.quit: finish(); return true; default: return super.onOptionsItemSelected(item); } } public void ChatCallback(String sender, String chatStr) { Message msg = handler.obtainMessage(INCOMINGMESSAGE); msg.obj = String.format("%s: \"%s\"", sender.substring(sender.length() - 10), chatStr); handler.sendMessage(msg); } @Override protected Dialog onCreateDialog(int id) { Dialog dialog; switch (id) { case DIALOG_ADVERTISE: dialog = new Dialog(Chat.this); dialog.setContentView(R.layout.advertise); dialog.setTitle("Name to be advertised:"); Button okButton = (Button) dialog.findViewById(R.id.AdvertiseOk); okButton.setOnClickListener(new OnClickListener() { public void onClick(View v) { View r = v.getRootView(); TextView text = (TextView) r.findViewById(R.id.AdvertiseText); bus_handler.sendMessage(bus_handler.obtainMessage(BusHandler.ADVERTISE, text.getText().toString())); listViewArrayAdapter.add("CHAT SESSION \"" + text.getText().toString() + "\""); Toast.makeText(getApplicationContext(), text.getText().toString(), Toast.LENGTH_LONG).show(); dismissDialog(DIALOG_ADVERTISE); //setContentView(R.layout.main); } }); Button cancelButton = (Button) dialog.findViewById(R.id.AdvertiseCancel); cancelButton.setOnClickListener(new OnClickListener() { public void onClick(View v) { dismissDialog(DIALOG_ADVERTISE); finish(); } }); break; case DIALOG_JOIN_SESSION: dialog = new Dialog(Chat.this); dialog.setContentView(R.layout.joinsession); dialog.setTitle("Name of session you want to join:"); Button joinokButton = (Button) dialog.findViewById(R.id.JoinSessionOk); joinokButton.setOnClickListener(new OnClickListener() { public void onClick(View v) { View r = v.getRootView(); TextView text = (TextView) r.findViewById(R.id.JoinSessionText); bus_handler.sendMessage(bus_handler.obtainMessage(BusHandler.JOINSESSION, text.getText().toString())); listViewArrayAdapter.add("CHAT SESSION \"" + text.getText().toString() + "\""); Toast.makeText(getApplicationContext(), text.getText().toString(), Toast.LENGTH_LONG).show(); dismissDialog(DIALOG_JOIN_SESSION); //setContentView(R.layout.main); } }); Button joinCancelButton = (Button) dialog.findViewById(R.id.JoinSessionCancel); joinCancelButton.setOnClickListener(new OnClickListener() { public void onClick(View v) { dismissDialog(DIALOG_JOIN_SESSION); finish(); } }); break; default: dialog = null; break; } setContentView(R.layout.main); listViewArrayAdapter = new ArrayAdapter(this, R.layout.message); listView = (ListView) findViewById(R.id.ListView); listView.setAdapter(listViewArrayAdapter); editText = (EditText) findViewById(R.id.EditText); editText.setOnEditorActionListener(new TextView.OnEditorActionListener() { public boolean onEditorAction(TextView view, int actionId, KeyEvent event) { if (actionId == EditorInfo.IME_NULL && event.getAction() == KeyEvent.ACTION_UP) { String message = view.getText().toString(); chat(message); view.setText(""); } return true; } }); return dialog; } private void setConnectedState(boolean isConnected) { if (null != menu) { menu.getItem(0).setEnabled(!isConnected); menu.getItem(1).setEnabled(isConnected); } } private static class BusHandler extends Handler { static final int ONCREATE = 1; static final int ONDESTROY = 2; static final int SENDCHATMSG = 3; static final int ADVERTISE = 4; static final int JOINSESSION = 5; Chat chat; BusHandler(Looper looper, Chat chat) { super(looper); this.chat = chat; } @Override public void handleMessage(Message msg) { switch (msg.what) { case ONCREATE: { int ret = chat.jniOnCreate((String) msg.obj); if (ret != 0) { Message responseMsg = chat.bus_handler.obtainMessage(SESSIONCREATEFAILED); responseMsg.arg1 = ret; chat.handler.sendMessage(responseMsg); } break; } case ONDESTROY: chat.jniOnDestroy(); break; case SENDCHATMSG: { int ret = chat.sendChatMsg((String) msg.obj); if (ret != 0) { Message responseMsg = chat.bus_handler.obtainMessage(SENDCHATFAILED); responseMsg.obj = msg.obj; responseMsg.arg1 = ret; chat.handler.sendMessage(responseMsg); } break; } case ADVERTISE: // ignore return value chat.advertise((String) msg.obj); break; case JOINSESSION: // ignore return value chat.joinSession((String) msg.obj); break; default: break; } } } static { System.loadLibrary("Chat"); } }alljoyn-15.04b/alljoyn_core/samples/chat/linux/000077500000000000000000000000001255700255500215455ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/samples/chat/linux/.gitignore000066400000000000000000000000131255700255500235270ustar00rootroot00000000000000chat chat.oalljoyn-15.04b/alljoyn_core/samples/chat/linux/Makefile000066400000000000000000000025201255700255500232040ustar00rootroot00000000000000# Copyright AllSeen Alliance. All rights reserved. # # Permission to use, copy, modify, and/or distribute this software for any # purpose with or without fee is hereby granted, provided that the above # copyright notice and this permission notice appear in all copies. # # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ALLJOYN_DIST := ../.. #ALLJOYN_DIST := ../../../build/linux/x86/debug/dist ALLJOYN_LIB := $(ALLJOYN_DIST)/lib/liballjoyn.a CXXFLAGS = -Wall -pipe -std=c++98 -fno-rtti -fno-exceptions -Wno-long-long -Wno-deprecated -g -DQCC_OS_LINUX -DQCC_OS_GROUP_POSIX -DQCC_CPU_X86 LIBS = -lalljoyn -lstdc++ -lcrypto -lpthread -lrt .PHONY: default clean default: chat clean: rm -f chat.o chat chat: chat.o $(ALLJOYN_LIB) $(CXX) -o $@ chat.o -L$(ALLJOYN_DIST)/lib $(LIBS) chat.o: chat.cc $(ALLJOYN_LIB) $(CXX) -c $(CXXFLAGS) -I$(ALLJOYN_DIST)/inc -o $@ chat.cc alljoyn-15.04b/alljoyn_core/samples/chat/linux/VC2008Win7/000077500000000000000000000000001255700255500231345ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/samples/chat/linux/VC2008Win7/VC2008Win7.sln000066400000000000000000000023101255700255500252350ustar00rootroot00000000000000 Microsoft Visual Studio Solution File, Format Version 10.00 # Visual Studio 2008 Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "chatsample", "chatsample\chatsample.vcproj", "{D1D8EC18-0964-4377-A569-2579D6BE39F7}" EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution Debug|Win32 = Debug|Win32 Debug|x64 = Debug|x64 Release|Win32 = Release|Win32 Release|x64 = Release|x64 EndGlobalSection GlobalSection(ProjectConfigurationPlatforms) = postSolution {D1D8EC18-0964-4377-A569-2579D6BE39F7}.Debug|Win32.ActiveCfg = Debug|Win32 {D1D8EC18-0964-4377-A569-2579D6BE39F7}.Debug|Win32.Build.0 = Debug|Win32 {D1D8EC18-0964-4377-A569-2579D6BE39F7}.Debug|x64.ActiveCfg = Debug|x64 {D1D8EC18-0964-4377-A569-2579D6BE39F7}.Debug|x64.Build.0 = Debug|x64 {D1D8EC18-0964-4377-A569-2579D6BE39F7}.Release|Win32.ActiveCfg = Release|Win32 {D1D8EC18-0964-4377-A569-2579D6BE39F7}.Release|Win32.Build.0 = Release|Win32 {D1D8EC18-0964-4377-A569-2579D6BE39F7}.Release|x64.ActiveCfg = Release|x64 {D1D8EC18-0964-4377-A569-2579D6BE39F7}.Release|x64.Build.0 = Release|x64 EndGlobalSection GlobalSection(SolutionProperties) = preSolution HideSolutionNode = FALSE EndGlobalSection EndGlobal alljoyn-15.04b/alljoyn_core/samples/chat/linux/VC2008Win7/chatsample/000077500000000000000000000000001255700255500252555ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/samples/chat/linux/VC2008Win7/chatsample/chatsample.vcproj000066400000000000000000000171061255700255500306300ustar00rootroot00000000000000 alljoyn-15.04b/alljoyn_core/samples/chat/linux/chat.cc000066400000000000000000000404011255700255500227720ustar00rootroot00000000000000/* * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. */ #include #include #include #include #include #include #include #include #include #include #include #include #include using namespace ajn; /* constants. */ static const char* CHAT_SERVICE_INTERFACE_NAME = "org.alljoyn.bus.samples.chat"; static const char* NAME_PREFIX = "org.alljoyn.bus.samples.chat."; static const char* CHAT_SERVICE_OBJECT_PATH = "/chatService"; static const SessionPort CHAT_PORT = 27; /* static data. */ static ajn::BusAttachment* s_bus = NULL; static qcc::String s_advertisedName; static qcc::String s_joinName; static qcc::String s_sessionHost; static SessionId s_sessionId = 0; static bool s_joinComplete = false; static volatile sig_atomic_t s_interrupt = false; static void CDECL_CALL SigIntHandler(int sig) { QCC_UNUSED(sig); s_interrupt = true; } /* * get a line of input from the the file pointer (most likely stdin). * This will capture the the num-1 characters or till a newline character is * entered. * * @param[out] str a pointer to a character array that will hold the user input * @param[in] num the size of the character array 'str' * @param[in] fp the file pointer the sting will be read from. (most likely stdin) * * @return returns the same string as 'str' if there has been a read error a null * pointer will be returned and 'str' will remain unchanged. */ char*get_line(char*str, size_t num, FILE*fp) { char*p = fgets(str, num, fp); // fgets will capture the '\n' character if the string entered is shorter than // num. Remove the '\n' from the end of the line and replace it with nul '\0'. if (p != NULL) { size_t last = strlen(str) - 1; if (str[last] == '\n') { str[last] = '\0'; } } return s_interrupt ? NULL : p; } /* Bus object */ class ChatObject : public BusObject { public: ChatObject(BusAttachment& bus, const char* path) : BusObject(path), chatSignalMember(NULL) { QStatus status; /* Add the chat interface to this object */ const InterfaceDescription* chatIntf = bus.GetInterface(CHAT_SERVICE_INTERFACE_NAME); assert(chatIntf); AddInterface(*chatIntf); /* Store the Chat signal member away so it can be quickly looked up when signals are sent */ chatSignalMember = chatIntf->GetMember("Chat"); assert(chatSignalMember); /* Register signal handler */ status = bus.RegisterSignalHandler(this, static_cast(&ChatObject::ChatSignalHandler), chatSignalMember, NULL); if (ER_OK != status) { printf("Failed to register signal handler for ChatObject::Chat (%s)\n", QCC_StatusText(status)); } } /** Send a Chat signal */ QStatus SendChatSignal(const char* msg) { MsgArg chatArg("s", msg); uint8_t flags = 0; if (0 == s_sessionId) { printf("Sending Chat signal without a session id\n"); } return Signal(NULL, s_sessionId, *chatSignalMember, &chatArg, 1, 0, flags); } /** Receive a signal from another Chat client */ void ChatSignalHandler(const InterfaceDescription::Member* member, const char* srcPath, Message& msg) { QCC_UNUSED(member); QCC_UNUSED(srcPath); printf("%s: %s\n", msg->GetSender(), msg->GetArg(0)->v_string.str); } private: const InterfaceDescription::Member* chatSignalMember; }; class MyBusListener : public BusListener, public SessionPortListener, public SessionListener { void FoundAdvertisedName(const char* name, TransportMask transport, const char* namePrefix) { printf("FoundAdvertisedName(name='%s', transport = 0x%x, prefix='%s')\n", name, transport, namePrefix); if (s_sessionHost.empty()) { const char* convName = name + strlen(NAME_PREFIX); printf("Discovered chat conversation: \"%s\"\n", convName); /* Join the conversation */ /* Since we are in a callback we must enable concurrent callbacks before calling a synchronous method. */ s_sessionHost = name; s_bus->EnableConcurrentCallbacks(); SessionOpts opts(SessionOpts::TRAFFIC_MESSAGES, true, SessionOpts::PROXIMITY_ANY, TRANSPORT_ANY); QStatus status = s_bus->JoinSession(name, CHAT_PORT, this, s_sessionId, opts); if (ER_OK == status) { printf("Joined conversation \"%s\"\n", convName); } else { printf("JoinSession failed (status=%s)\n", QCC_StatusText(status)); } uint32_t timeout = 20; status = s_bus->SetLinkTimeout(s_sessionId, timeout); if (ER_OK == status) { printf("Set link timeout to %d\n", timeout); } else { printf("Set link timeout failed\n"); } s_joinComplete = true; } } void LostAdvertisedName(const char* name, TransportMask transport, const char* namePrefix) { QCC_UNUSED(namePrefix); printf("Got LostAdvertisedName for %s from transport 0x%x\n", name, transport); } void NameOwnerChanged(const char* busName, const char* previousOwner, const char* newOwner) { printf("NameOwnerChanged: name=%s, oldOwner=%s, newOwner=%s\n", busName, previousOwner ? previousOwner : "", newOwner ? newOwner : ""); } bool AcceptSessionJoiner(SessionPort sessionPort, const char* joiner, const SessionOpts& opts) { if (sessionPort != CHAT_PORT) { printf("Rejecting join attempt on non-chat session port %d\n", sessionPort); return false; } printf("Accepting join session request from %s (opts.proximity=%x, opts.traffic=%x, opts.transports=%x)\n", joiner, opts.proximity, opts.traffic, opts.transports); return true; } void SessionJoined(SessionPort sessionPort, SessionId id, const char* joiner) { QCC_UNUSED(sessionPort); s_sessionId = id; printf("SessionJoined with %s (id=%d)\n", joiner, id); s_bus->EnableConcurrentCallbacks(); uint32_t timeout = 20; QStatus status = s_bus->SetLinkTimeout(s_sessionId, timeout); if (ER_OK == status) { printf("Set link timeout to %d\n", timeout); } else { printf("Set link timeout failed\n"); } } }; /* More static data. */ static ChatObject* s_chatObj = NULL; static MyBusListener s_busListener; #ifdef __cplusplus extern "C" { #endif /** Send usage information to stdout and exit with EXIT_FAILURE. */ static void Usage() { printf("Usage: chat [-h] [-s ] | [-j ]\n"); exit(EXIT_FAILURE); } /** Parse the the command line arguments. If a problem occurs exit via Usage(). */ static void ParseCommandLine(int argc, char** argv) { /* Parse command line args */ for (int i = 1; i < argc; ++i) { if (0 == ::strcmp("-s", argv[i])) { if ((++i < argc) && (argv[i][0] != '-')) { s_advertisedName = NAME_PREFIX; s_advertisedName += argv[i]; } else { printf("Missing parameter for \"-s\" option\n"); Usage(); } } else if (0 == ::strcmp("-j", argv[i])) { if ((++i < argc) && (argv[i][0] != '-')) { s_joinName = NAME_PREFIX; s_joinName += argv[i]; } else { printf("Missing parameter for \"-j\" option\n"); Usage(); } } else if (0 == ::strcmp("-h", argv[i])) { Usage(); } else { printf("Unknown argument \"%s\"\n", argv[i]); Usage(); } } } /** Validate the data obtained from the command line. If invalid exit via Usage(). */ void ValidateCommandLine() { /* Validate command line */ if (s_advertisedName.empty() && s_joinName.empty()) { printf("Must specify either -s or -j\n"); Usage(); } else if (!s_advertisedName.empty() && !s_joinName.empty()) { printf("Cannot specify both -s and -j\n"); Usage(); } } /** Create the interface, report the result to stdout, and return the result status. */ QStatus CreateInterface(void) { /* Create org.alljoyn.bus.samples.chat interface */ InterfaceDescription* chatIntf = NULL; QStatus status = s_bus->CreateInterface(CHAT_SERVICE_INTERFACE_NAME, chatIntf); if (ER_OK == status) { chatIntf->AddSignal("Chat", "s", "str", 0); chatIntf->Activate(); } else { printf("Failed to create interface \"%s\" (%s)\n", CHAT_SERVICE_INTERFACE_NAME, QCC_StatusText(status)); } return status; } /** Start the message bus, report the result to stdout, and return the status code. */ QStatus StartMessageBus(void) { QStatus status = s_bus->Start(); if (ER_OK == status) { printf("BusAttachment started.\n"); } else { printf("Start of BusAttachment failed (%s).\n", QCC_StatusText(status)); } return status; } /** Register the bus object and connect, report the result to stdout, and return the status code. */ QStatus RegisterBusObject(void) { QStatus status = s_bus->RegisterBusObject(*s_chatObj); if (ER_OK == status) { printf("RegisterBusObject succeeded.\n"); } else { printf("RegisterBusObject failed (%s).\n", QCC_StatusText(status)); } return status; } /** Connect, report the result to stdout, and return the status code. */ QStatus ConnectBusAttachment(void) { QStatus status = s_bus->Connect(); if (ER_OK == status) { printf("Connect to '%s' succeeded.\n", s_bus->GetConnectSpec().c_str()); } else { printf("Failed to connect to '%s' (%s).\n", s_bus->GetConnectSpec().c_str(), QCC_StatusText(status)); } return status; } /** Request the service name, report the result to stdout, and return the status code. */ QStatus RequestName(void) { QStatus status = s_bus->RequestName(s_advertisedName.c_str(), DBUS_NAME_FLAG_DO_NOT_QUEUE); if (ER_OK == status) { printf("RequestName('%s') succeeded.\n", s_advertisedName.c_str()); } else { printf("RequestName('%s') failed (status=%s).\n", s_advertisedName.c_str(), QCC_StatusText(status)); } return status; } /** Create the session, report the result to stdout, and return the status code. */ QStatus CreateSession(TransportMask mask) { SessionOpts opts(SessionOpts::TRAFFIC_MESSAGES, true, SessionOpts::PROXIMITY_ANY, mask); SessionPort sp = CHAT_PORT; QStatus status = s_bus->BindSessionPort(sp, opts, s_busListener); if (ER_OK == status) { printf("BindSessionPort succeeded.\n"); } else { printf("BindSessionPort failed (%s).\n", QCC_StatusText(status)); } return status; } /** Advertise the service name, report the result to stdout, and return the status code. */ QStatus AdvertiseName(TransportMask mask) { QStatus status = s_bus->AdvertiseName(s_advertisedName.c_str(), mask); if (ER_OK == status) { printf("Advertisement of the service name '%s' succeeded.\n", s_advertisedName.c_str()); } else { printf("Failed to advertise name '%s' (%s).\n", s_advertisedName.c_str(), QCC_StatusText(status)); } return status; } /** Begin discovery on the well-known name of the service to be called, report the result to stdout, and return the result status. */ QStatus FindAdvertisedName(void) { /* Begin discovery on the well-known name of the service to be called */ QStatus status = s_bus->FindAdvertisedName(s_joinName.c_str()); if (status == ER_OK) { printf("org.alljoyn.Bus.FindAdvertisedName ('%s') succeeded.\n", s_joinName.c_str()); } else { printf("org.alljoyn.Bus.FindAdvertisedName ('%s') failed (%s).\n", s_joinName.c_str(), QCC_StatusText(status)); } return status; } /** Wait for join session to complete, report the event to stdout, and return the result status. */ QStatus WaitForJoinSessionCompletion(void) { unsigned int count = 0; while (!s_joinComplete && !s_interrupt) { if (0 == (count++ % 100)) { printf("Waited %u seconds for JoinSession completion.\n", count / 100); } #ifdef _WIN32 Sleep(10); #else usleep(10 * 1000); #endif } return s_joinComplete && !s_interrupt ? ER_OK : ER_ALLJOYN_JOINSESSION_REPLY_CONNECT_FAILED; } /** Take input from stdin and send it as a chat message, continue until an error or * SIGINT occurs, return the result status. */ QStatus DoTheChat(void) { const int bufSize = 1024; char buf[bufSize]; QStatus status = ER_OK; while ((ER_OK == status) && (get_line(buf, bufSize, stdin))) { status = s_chatObj->SendChatSignal(buf); } return status; } int CDECL_CALL main(int argc, char** argv) { if (AllJoynInit() != ER_OK) { return 1; } #ifdef ROUTER if (AllJoynRouterInit() != ER_OK) { AllJoynShutdown(); return 1; } #endif /* Install SIGINT handler. */ signal(SIGINT, SigIntHandler); ParseCommandLine(argc, argv); ValidateCommandLine(); QStatus status = ER_OK; /* Create message bus */ s_bus = new BusAttachment("chat", true); if (s_bus) { if (ER_OK == status) { status = CreateInterface(); } if (ER_OK == status) { s_bus->RegisterBusListener(s_busListener); } if (ER_OK == status) { status = StartMessageBus(); } /* Create the bus object that will be used to send and receive signals */ ChatObject chatObj(*s_bus, CHAT_SERVICE_OBJECT_PATH); s_chatObj = &chatObj; if (ER_OK == status) { status = RegisterBusObject(); } if (ER_OK == status) { status = ConnectBusAttachment(); } /* Advertise or discover based on command line options */ if (!s_advertisedName.empty()) { /* * Advertise this service on the bus. * There are three steps to advertising this service on the bus. * 1) Request a well-known name that will be used by the client to discover * this service. * 2) Create a session. * 3) Advertise the well-known name. */ if (ER_OK == status) { status = RequestName(); } const TransportMask SERVICE_TRANSPORT_TYPE = TRANSPORT_ANY; if (ER_OK == status) { status = CreateSession(SERVICE_TRANSPORT_TYPE); } if (ER_OK == status) { status = AdvertiseName(SERVICE_TRANSPORT_TYPE); } } else { if (ER_OK == status) { status = FindAdvertisedName(); } if (ER_OK == status) { status = WaitForJoinSessionCompletion(); } } if (ER_OK == status) { status = DoTheChat(); } } else { status = ER_OUT_OF_MEMORY; } /* Cleanup */ delete s_bus; s_bus = NULL; printf("Chat exiting with status 0x%04x (%s).\n", status, QCC_StatusText(status)); #ifdef ROUTER AllJoynRouterShutdown(); #endif AllJoynShutdown(); return (int) status; } #ifdef __cplusplus } #endif alljoyn-15.04b/alljoyn_core/samples/eventaction/000077500000000000000000000000001255700255500220065ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/samples/eventaction/Android/000077500000000000000000000000001255700255500233665ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/samples/eventaction/Android/.classpath000066400000000000000000000007221255700255500253520ustar00rootroot00000000000000 alljoyn-15.04b/alljoyn_core/samples/eventaction/Android/.gitignore000066400000000000000000000000211255700255500253470ustar00rootroot00000000000000bin gen libs obj alljoyn-15.04b/alljoyn_core/samples/eventaction/Android/.project000066400000000000000000000026271255700255500250440ustar00rootroot00000000000000 Event_Action_Browser org.eclipse.cdt.managedbuilder.core.genmakebuilder clean,full,incremental, com.android.ide.eclipse.adt.ResourceManagerBuilder com.android.ide.eclipse.adt.PreCompilerBuilder org.eclipse.jdt.core.javabuilder com.android.ide.eclipse.adt.ApkBuilder org.eclipse.cdt.managedbuilder.core.ScannerConfigBuilder full,incremental, com.android.ide.eclipse.adt.AndroidNature org.eclipse.jdt.core.javanature org.eclipse.cdt.core.cnature org.eclipse.cdt.core.ccnature org.eclipse.cdt.managedbuilder.core.managedBuildNature org.eclipse.cdt.managedbuilder.core.ScannerConfigNature alljoyn-15.04b/alljoyn_core/samples/eventaction/Android/AndroidManifest.xml000066400000000000000000000046711255700255500271670ustar00rootroot00000000000000 alljoyn-15.04b/alljoyn_core/samples/eventaction/Android/jni/000077500000000000000000000000001255700255500241465ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/samples/eventaction/Android/jni/Android.mk000066400000000000000000000024231255700255500260600ustar00rootroot00000000000000LOCAL_PATH := $(call my-dir) # AllJoyn specifics ALLJOYN_DIST := ../../../../ include $(CLEAR_VARS) LOCAL_MODULE := MyAllJoynCode TARGET_PLATFORM := android-16 LOCAL_C_INCLUDES := \ $(ALLJOYN_DIST)/cpp/inc \ $(ALLJOYN_DIST)/cpp/inc/alljoyn \ $(ALLJOYN_DIST)/about/inc \ $(NDK_PLATFORMS_ROOT)/$(TARGET_PLATFORM)/arch-arm/usr/include \ $(NDK_ROOT)/sources/cxx-stl/gnu-libstdc++/include \ $(NDK_ROOT)/sources/cxx-stl/gnu-libstdc++/libs/armeabi/include \ $(NDK_ROOT)/sources/cxx-stl/gnu-libstdc++/4.6/include \ $(NDK_ROOT)/sources/cxx-stl/gnu-libstdc++/4.6/libs/armeabi/include LOCAL_CFLAGS := -Wno-psabi -Wno-write-strings -DANDROID_NDK -DTARGET_ANDROID -DLINUX -DQCC_OS_GROUP_POSIX -DQCC_OS_ANDROID -DQCC_CPU_ARM -DANDROID LOCAL_CPP_EXTENSION := .cc LOCAL_SRC_FILES := \ event/AndroidJNIBridge.cc \ event/PresenceDetection.cc \ event/MyEventCode.cc LOCAL_LDLIBS := \ -L$(NDK_PLATFORMS_ROOT)/$(TARGET_PLATFORM)/arch-arm/usr/lib \ -L$(ALLJOYN_DIST)/cpp/lib \ -L$(ALLJOYN_DIST)/about/lib \ -L$(NDK_ROOT)/sources/cxx-stl/gnu-libstdc++/libs/armeabi \ -L$(NDK_ROOT)/sources/cxx-stl/gnu-libstdc++/4.6/libs/armeabi \ -lajrouter -lalljoyn -llog -ldl -lssl -lcrypto -lm -lc -lstdc++ -lgcc -lgnustl_shared -lalljoyn_about LOCAL_ARM_MODE := arm include $(BUILD_SHARED_LIBRARY) alljoyn-15.04b/alljoyn_core/samples/eventaction/Android/jni/Application.mk000066400000000000000000000000301255700255500267330ustar00rootroot00000000000000APP_STL := gnustl_sharedalljoyn-15.04b/alljoyn_core/samples/eventaction/Android/jni/Constants.h000066400000000000000000000030231255700255500262710ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _CONSTANTS_ #define _CONSTANTS_ #include #include #include #include #include #include #include #include #ifndef LOGTHIS #if TARGET_ANDROID #include #include #define LOG_TAG "JNI_EventActionBrowser" #define LOGTHIS(...) (__android_log_print(ANDROID_LOG_DEBUG, LOG_TAG, __VA_ARGS__)) #else #define LOGTHIS(...) #endif #endif #define ARRAY_SIZE(x) (sizeof(x) / sizeof((x)[0])) #endif //_CONSTANTS alljoyn-15.04b/alljoyn_core/samples/eventaction/Android/jni/event/000077500000000000000000000000001255700255500252675ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/samples/eventaction/Android/jni/event/ActionInfo.h000066400000000000000000000044061255700255500274750ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _ACTION_INFO_ #define _ACTION_INFO_ #include class ActionInfo { public: ActionInfo(const char* uniqueName, const char* path, const char* iface, const char* member, const char* sig) : mUniqueName(uniqueName), mPath(path), mIfaceName(iface), mMember(member), mSignature(sig), mDeviceId(qcc::String::Empty), mAppId(qcc::String::Empty) { }; virtual ~ActionInfo() { }; void setSenderInfo(qcc::String deviceId, qcc::String appId) { mDeviceId = deviceId; mAppId = appId; } virtual qcc::String toString() { qcc::String ret = ""; ret.append(mUniqueName); ret.append(","); ret.append(mPath); ret.append(","); ret.append(mIfaceName); ret.append(","); ret.append(mMember); ret.append(","); ret.append(mSignature); ret.append(","); ret.append(mDeviceId); ret.append(","); ret.append(mAppId); ret.append(","); return ret; } //private: qcc::String mUniqueName; qcc::String mPath; qcc::String mIfaceName; qcc::String mMember; qcc::String mSignature; qcc::String mDeviceId; qcc::String mAppId; }; #endif //_ACTION_INFO_ alljoyn-15.04b/alljoyn_core/samples/eventaction/Android/jni/event/AndroidJNIBridge.cc000066400000000000000000000145161255700255500306430ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #include #include "MyEventCode.h" /* Static data */ static MyEventCode* myEventCode = NULL; #ifdef __cplusplus extern "C" { #endif JNIEXPORT jint JNICALL JNI_OnLoad(JavaVM* vm, void* reserved) { if (AllJoynInit() != ER_OK) { return 1; } if (AllJoynRouterInit() != ER_OK) { AllJoynShutdown(); return 1; } QCC_UseOSLogging(true); return JNI_VERSION_1_2; } JNIEXPORT void JNI_OnUnload(JavaVM* vm, void* reserved) { AllJoynRouterShutdown(); AllJoynShutdown(); } /* * Class: org_allseen_sample_event_tester_BusHandler * Method: initialize * Signature: (Ljava/lang/String;)V */ JNIEXPORT void JNICALL Java_org_allseen_sample_event_tester_BusHandler_initialize(JNIEnv* env, jobject jobj, jstring packageNameStrObj) { if (myEventCode == NULL) { JavaVM* vm; env->GetJavaVM(&vm); jobject gjobj = env->NewGlobalRef(jobj); myEventCode = new MyEventCode(vm, gjobj); } jboolean iscopy; const char* packageNameStr = env->GetStringUTFChars(packageNameStrObj, &iscopy); myEventCode->initialize(packageNameStr); env->ReleaseStringUTFChars(packageNameStrObj, packageNameStr); } /* * Class: org_allseen_sample_event_tester_BusHandler * Method: dointrospection * Signature: (Ljava/lang/String;Ljava/lang/String;I)Ljava/langString; */ JNIEXPORT jstring JNICALL Java_org_allseen_sample_event_tester_BusHandler_doIntrospection(JNIEnv* env, jobject jobj, jstring jname, jstring jpath, jint sessionId) { jboolean iscopy; jboolean iscopy2; const char* sessionName = env->GetStringUTFChars(jname, &iscopy); const char* path = env->GetStringUTFChars(jpath, &iscopy2); char* xml = myEventCode->introspectWithDescriptions(sessionName, path, sessionId); env->ReleaseStringUTFChars(jname, sessionName); env->ReleaseStringUTFChars(jpath, path); jstring ret = env->NewStringUTF(xml); delete xml; return ret; } JNIEXPORT void JNICALL Java_org_allseen_sample_event_tester_BusHandler_introspectionDone(JNIEnv* env, jobject jobj, jint sessionId) { myEventCode->leaveSession(sessionId); } JNIEXPORT jboolean JNICALL Java_org_allseen_sample_event_tester_BusHandler_enableEvent(JNIEnv*env, jobject jobj, //event jstring jEUniqueName, jstring jEPath, jstring jEIface, jstring jEMember, jstring jESig) { jboolean iscopy; const char* eUniqueName = env->GetStringUTFChars(jEUniqueName, &iscopy); const char* ePath = env->GetStringUTFChars(jEPath, &iscopy); const char* eIface = env->GetStringUTFChars(jEIface, &iscopy); const char* eMember = env->GetStringUTFChars(jEMember, &iscopy); const char* eSig = env->GetStringUTFChars(jESig, &iscopy); EventInfo* event = new EventInfo(eUniqueName, ePath, eIface, eMember, eSig); LOGTHIS("enabling an event on %s::%s", eIface, eMember); bool ret = myEventCode->enableEvent(event); delete event; env->ReleaseStringUTFChars(jEUniqueName, eUniqueName); env->ReleaseStringUTFChars(jEPath, ePath); env->ReleaseStringUTFChars(jEIface, eIface); env->ReleaseStringUTFChars(jEMember, eMember); env->ReleaseStringUTFChars(jESig, eSig); return ret == true ? JNI_TRUE : JNI_FALSE; } JNIEXPORT void JNICALL Java_org_allseen_sample_event_tester_BusHandler_callAction(JNIEnv*env, jobject jobj, //action jstring jAUniqueName, jstring jAPath, jstring jAIface, jstring jAMember, jstring jASig) { jboolean iscopy; const char* aUniqueName = env->GetStringUTFChars(jAUniqueName, &iscopy); const char* aPath = env->GetStringUTFChars(jAPath, &iscopy); const char* aIface = env->GetStringUTFChars(jAIface, &iscopy); const char* aMember = env->GetStringUTFChars(jAMember, &iscopy); const char* aSig = env->GetStringUTFChars(jASig, &iscopy); ActionInfo* action = new ActionInfo(aUniqueName, aPath, aIface, aMember, aSig); LOGTHIS("Calling an action on %s", aUniqueName); myEventCode->callAction(action); delete action; env->ReleaseStringUTFChars(jAUniqueName, aUniqueName); env->ReleaseStringUTFChars(jAPath, aPath); env->ReleaseStringUTFChars(jAIface, aIface); env->ReleaseStringUTFChars(jAMember, aMember); env->ReleaseStringUTFChars(jASig, aSig); } /* * Class: org_allseen_sample_event_tester_BusHandler * Method: shutdown * Signature: ()V */ JNIEXPORT void JNICALL Java_org_allseen_sample_event_tester_BusHandler_shutdown(JNIEnv* env, jobject jobj) { // if(myEventCode) // myEventCode->shutdown(); // delete MyEventCode; // MyEventCode = NULL; } #ifdef __cplusplus } #endif alljoyn-15.04b/alljoyn_core/samples/eventaction/Android/jni/event/EventInfo.h000066400000000000000000000043771255700255500273500ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #ifndef _EVENT_INFO_ #define _EVENT_INFO_ #include class EventInfo { public: EventInfo(const char* uniqueName, const char* path, const char* iface, const char* member, const char* sig) : mUniqueName(uniqueName), mPath(path), mIfaceName(iface), mMember(member), mSignature(sig), mDeviceId(qcc::String::Empty), mAppId(qcc::String::Empty) { }; virtual ~EventInfo() { }; void setSenderInfo(qcc::String deviceId, qcc::String appId) { mDeviceId = deviceId; mAppId = appId; } virtual qcc::String toString() { qcc::String ret = ""; ret.append(mUniqueName); ret.append(","); ret.append(mPath); ret.append(","); ret.append(mIfaceName); ret.append(","); ret.append(mMember); ret.append(","); ret.append(mSignature); ret.append(","); ret.append(mDeviceId); ret.append(","); ret.append(mAppId); ret.append(","); return ret; } //private: qcc::String mUniqueName; qcc::String mPath; qcc::String mIfaceName; qcc::String mMember; qcc::String mSignature; qcc::String mDeviceId; qcc::String mAppId; }; #endif //_EVENT_INFO_ alljoyn-15.04b/alljoyn_core/samples/eventaction/Android/jni/event/MyEventCode.cc000066400000000000000000000351661255700255500277730ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include "MyEventCode.h" using namespace std; using namespace ajn; using namespace qcc; void MyEventCode::initialize(const char* packageName) { QStatus status = ER_OK; /* Initialize AllJoyn only once */ if (!mBusAttachment) { QCC_SetLogLevels("ALLJOYN_OBJ=7"); QCC_SetLogLevels("ER_DEBUG_ALLJOYN_OBJ=7"); QCC_SetDebugLevel("MyEventCode", 15); QCC_UseOSLogging(true); /* * All communication through AllJoyn begins with a BusAttachment. * * A BusAttachment needs a name. The actual name is unimportant except for internal * security. As a default we use the class name as the name. * * By default AllJoyn does not allow communication between devices (i.e. bus to bus * communication). The second argument must be set to Receive to allow * communication between devices. */ mBusAttachment = new BusAttachment(packageName, true); /* Start the msg bus */ if (ER_OK == status) { status = mBusAttachment->Start(); } else { LOGTHIS("BusAttachment::Start failed"); } /* Connect to the daemon */ if (ER_OK == status) { status = mBusAttachment->Connect(); if (ER_OK != status) { LOGTHIS("BusAttachment Connect failed."); } } LOGTHIS("Created BusAttachment and connected"); mPresenceDetection = new PresenceDetection(mBusAttachment, vm, jobj); mBusAttachment->RegisterAboutListener(*this); /* Add the match so we receive sessionless signals */ status = mBusAttachment->AddMatch("sessionless='t'"); if (ER_OK != status) { LOGTHIS("Failed to addMatch for sessionless signals: %s\n", QCC_StatusText(status)); } } } void MyEventCode::Announced(const char* busName, uint16_t version, SessionPort port, const MsgArg& objectDescriptionArg, const MsgArg& aboutDataArg) { LOGTHIS("-----Found about application with busName, port %s, %d", busName, port); AboutData aboutData(aboutDataArg); size_t count = aboutData.GetFields(); const char** fields = new const char*[count]; aboutData.GetFields(fields, count); for (size_t i = 0; i < count; ++i) { MsgArg* tmp; aboutData.GetField(fields[i], tmp, "en"); if (tmp->Signature() == "s") { const char* tmp_s; tmp->Get("s", &tmp_s); if (strcmp(fields[i], "DeviceName") == 0) { mBusFriendlyMap.insert(std::pair(busName, tmp_s)); mBusPortMap.insert(std::pair(busName, port)); LOGTHIS("Friendly Name: %s (%s)", tmp_s, busName); } } } delete [] fields; /* For now lets just assume everything has events and actions and join */ joinSession(busName, port); mPresenceDetection->StartPing(busName, port); } void MyEventCode::joinSession(const char* sessionName, short port) { SessionOpts opts(SessionOpts::TRAFFIC_MESSAGES, false, SessionOpts::PROXIMITY_ANY, TRANSPORT_ANY); QStatus status = mBusAttachment->JoinSessionAsync(sessionName, port, this, opts, this, ::strdup(sessionName)); LOGTHIS("JoinSessionAsync status: %d\n", status); } void MyEventCode::JoinSessionCB(QStatus status, SessionId sessionId, const SessionOpts& opts, void* context) { if (status == ER_OK || status == ER_ALLJOYN_JOINSESSION_REPLY_ALREADY_JOINED) { //cast context to a char* then check sessionName to save off correct sessionId value char* sessionName = (char*)context; LOGTHIS("Joined the sesssion %s have sessionId %d\n", sessionName, sessionId); mBusSessionMap.insert(std::pair(sessionName, sessionId)); JNIEnv* env; jint jret = vm->GetEnv((void**)&env, JNI_VERSION_1_2); if (JNI_EDETACHED == jret) { vm->AttachCurrentThread(&env, NULL); } jclass jcls = env->GetObjectClass(jobj); jmethodID mid = env->GetMethodID(jcls, "foundEventActionApplication", "(Ljava/lang/String;ILjava/lang/String;)V"); if (mid == 0) { LOGTHIS("Failed to get Java foundEventActionApplication"); } else { jstring jName = env->NewStringUTF(sessionName); jstring jFriendly = env->NewStringUTF(mBusFriendlyMap[sessionName].c_str()); env->CallVoidMethod(jobj, mid, jName, sessionId, jFriendly); env->DeleteLocalRef(jName); env->DeleteLocalRef(jFriendly); } if (JNI_EDETACHED == jret) { vm->DetachCurrentThread(); } } else { LOGTHIS("Error joining %s status %d", (char*)context, status); if (status == ER_ALLJOYN_JOINSESSION_REPLY_FAILED) { JNIEnv* env; jint jret = vm->GetEnv((void**)&env, JNI_VERSION_1_2); if (JNI_EDETACHED == jret) { vm->AttachCurrentThread(&env, NULL); } jclass jcls = env->GetObjectClass(jobj); jmethodID mid = env->GetMethodID(jcls, "failedJoinEventActionApplication", "(Ljava/lang/String;)V"); if (mid == 0) { LOGTHIS("Failed to get Java foundEventEventActionApplication"); } else { jstring jName = env->NewStringUTF((char*)context); env->CallVoidMethod(jobj, mid, jName); env->DeleteLocalRef(jName); } if (JNI_EDETACHED == jret) { vm->DetachCurrentThread(); } } } } void MyEventCode::InformFound(char* sessionName, int sessionId, char* friendly) { JNIEnv* env; jint jret = vm->GetEnv((void**)&env, JNI_VERSION_1_2); if (JNI_EDETACHED == jret) { vm->AttachCurrentThread(&env, NULL); } jclass jcls = env->GetObjectClass(jobj); jmethodID mid = env->GetMethodID(jcls, "foundEventActionApplication", "(Ljava/lang/String;ILjava/lang/String;)V"); if (mid == 0) { LOGTHIS("Failed to get Java foundEventActionApplication"); } else { jstring jName = env->NewStringUTF(sessionName); jstring jFriendly = env->NewStringUTF(friendly); env->CallVoidMethod(jobj, mid, jName, sessionId, jFriendly); env->DeleteLocalRef(jName); env->DeleteLocalRef(jFriendly); } if (JNI_EDETACHED == jret) { vm->DetachCurrentThread(); } } char* MyEventCode::introspectWithDescriptions(const char* sessionName, const char* path, int sessionId) { LOGTHIS("introspectWithDescriptions the sesssion %s, path %s, id %d\n", sessionName, path, sessionId); ProxyBusObject remoteObj(*mBusAttachment, sessionName, path, sessionId); QStatus status = ER_OK; const char* ifcName = org::allseen::Introspectable::InterfaceName; const InterfaceDescription* introIntf = remoteObj.GetInterface(ifcName); if (!introIntf) { introIntf = mBusAttachment->GetInterface(ifcName); assert(introIntf); remoteObj.AddInterface(*introIntf); } /* Attempt to retrieve introspection from the remote object using sync call */ Message reply(*mBusAttachment); const InterfaceDescription::Member* introMember = introIntf->GetMember("IntrospectWithDescription"); assert(introMember); MsgArg inputs[1]; inputs[0].Set("s", "en"); status = remoteObj.MethodCall(*introMember, inputs, 1, reply, 30000); /* Parse the XML reply */ if (status != ER_OK) { LOGTHIS("Introspection error: %d", status); mBusAttachment->LeaveSession(sessionId); return NULL; } //Go ahead and tell AllJoyn to set the interfaces now and save us an Introspection request later remoteObj.ParseXml(reply->GetArg(0)->v_string.str); return ::strdup(reply->GetArg(0)->v_string.str); } void MyEventCode::callAction(ActionInfo* action) { ajn::ProxyBusObject* actionObject; ajn::SessionId mSessionId; QStatus status = ER_OK; short port = mBusPortMap[action->mUniqueName]; LOGTHIS("callAction on %s, port %d\n", action->mUniqueName.c_str(), port); SessionOpts opts(SessionOpts::TRAFFIC_MESSAGES, false, SessionOpts::PROXIMITY_ANY, TRANSPORT_ANY); status = mBusAttachment->JoinSession(action->mUniqueName.c_str(), port, this, mSessionId, opts); if ((ER_OK == status || ER_ALLJOYN_JOINSESSION_REPLY_ALREADY_JOINED == status)) { LOGTHIS("Creating ProxyBusObject with SessionId: %d", mSessionId); actionObject = new ProxyBusObject(*mBusAttachment, action->mUniqueName.c_str(), action->mPath.c_str(), mSessionId); //actionObject = new ProxyBusObject(*mBusAttachment, action->mUniqueName.c_str(), action->mPath.c_str(), 0); const InterfaceDescription* actionIntf = mBusAttachment->GetInterface(action->mIfaceName.c_str()); if (actionIntf) { actionObject->AddInterface(*actionIntf); } else { status = actionObject->IntrospectRemoteObject(); LOGTHIS("Introspect Object called, %s(%x)", QCC_StatusText(status), status); } actionIntf = mBusAttachment->GetInterface(action->mIfaceName.c_str()); if (actionIntf && actionObject) { LOGTHIS("Calling device(%s) action %s::%s(%s)", action->mUniqueName.c_str(), action->mIfaceName.c_str(), action->mMember.c_str(), action->mSignature.c_str()); //status = actionObject->MethodCall(action->mIfaceName.c_str(), action->mMember.c_str(), NULL, 0, ); Message reply(*mBusAttachment); const InterfaceDescription::Member* methodMember = actionIntf->GetMember(action->mMember.c_str()); status = actionObject->MethodCall(*methodMember, NULL, 0, reply); LOGTHIS("MethodCall status: %s(%x)", QCC_StatusText(status), status); } else { LOGTHIS("Failed MethodCall status: %s(%x)", QCC_StatusText(status), status); } mBusAttachment->LeaveSession(mSessionId); } else { LOGTHIS("Failed to join session status: %s(%x)", QCC_StatusText(status), status); } } bool MyEventCode::enableEvent(EventInfo* event) { QStatus status = ER_OK; const ajn::InterfaceDescription::Member* eventMember = NULL; bool ret = false; qcc::String matchRule = "type='signal',interface='"; matchRule.append(event->mIfaceName); matchRule.append("',member='"); matchRule.append(event->mMember); matchRule.append("'"); LOGTHIS("Going to setup a handler for the event: %s", matchRule.c_str()); const InterfaceDescription* existingIntf = mBusAttachment->GetInterface(event->mIfaceName.c_str()); if (existingIntf) { eventMember = existingIntf->GetMember(event->mMember.c_str()); } if (eventMember) { status = mBusAttachment->RegisterSignalHandler(this, static_cast(&MyEventCode::EventHandler), eventMember, NULL); if (status == ER_OK) { status = mBusAttachment->AddMatch(matchRule.c_str()); ret = true; } else { LOGTHIS("Error registering the signal handler: %s(%d)", QCC_StatusText(status), status); } } else { LOGTHIS("Event Member is null, get interface status %s(%d)", QCC_StatusText(status), status); } return ret; } void MyEventCode::EventHandler(const ajn::InterfaceDescription::Member* member, const char* srcPath, ajn::Message& msg) { JNIEnv* env; jint jret = vm->GetEnv((void**)&env, JNI_VERSION_1_2); if (JNI_EDETACHED == jret) { vm->AttachCurrentThread(&env, NULL); } jclass jcls = env->GetObjectClass(jobj); jmethodID mid = env->GetMethodID(jcls, "onEventReceived", "(Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;)V"); if (mid == 0) { LOGTHIS("Failed to get Java onEventReceived"); } else { jstring jFrom = env->NewStringUTF(msg->GetSender()); jstring jPath = env->NewStringUTF(srcPath); jstring jIFace = env->NewStringUTF(member->iface->GetName()); jstring jMember = env->NewStringUTF(member->name.c_str()); jstring jSig = env->NewStringUTF(member->signature.c_str()); env->CallVoidMethod(jobj, mid, jFrom, jPath, jIFace, jMember, jSig); env->DeleteLocalRef(jFrom); env->DeleteLocalRef(jPath); env->DeleteLocalRef(jIFace); env->DeleteLocalRef(jMember); env->DeleteLocalRef(jSig); } if (JNI_EDETACHED == jret) { vm->DetachCurrentThread(); } } void MyEventCode::leaveSession(int sessionId) { QStatus status = mBusAttachment->LeaveSession(sessionId); if (ER_OK != status) { LOGTHIS("LeaveSession failed"); } else { LOGTHIS("LeaveSession successful"); } } void MyEventCode::shutdown() { /* Cancel the advertisement */ /* Unregister the Bus Listener */ mBusAttachment->UnregisterBusListener(*((BusListener*)this)); /* Deallocate the BusAttachment */ if (mBusAttachment) { delete mBusAttachment; mBusAttachment = NULL; } } void MyEventCode::AsyncCallReplyHandler(Message& msg, void* context) { size_t numArgs; const MsgArg* args; msg->GetArgs(numArgs, args); if (MESSAGE_METHOD_RET != msg->GetType()) { LOGTHIS("Failed MethodCall message return type: %d", msg->GetType()); LOGTHIS("Failed MethodCall message Error name: %s", msg->GetErrorDescription().c_str()); } else { LOGTHIS("Action should have been executed"); } } /* From SessionListener */ void MyEventCode::SessionLost(ajn::SessionId sessionId, ajn::SessionListener::SessionLostReason reason) { } alljoyn-15.04b/alljoyn_core/samples/eventaction/Android/jni/event/MyEventCode.h000066400000000000000000000105231255700255500276230ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #include #include #include #include #include #include #include "../Constants.h" #include "EventInfo.h" #include "ActionInfo.h" #include "PresenceDetection.h" #include #include #include #include #ifndef _MY_EVENT_CODE_ #define _MY_EVENT_CODE_ class MyEventCode; class MyEventCode : public ajn::AboutListener, public ajn::BusAttachment::JoinSessionAsyncCB, public ajn::MessageReceiver, public ajn::SessionListener { public: /** * Construct a MyEventCode object * */ MyEventCode(JavaVM* vm, jobject jobj) : vm(vm), jobj(jobj), mPresenceDetection(NULL), mBusAttachment(NULL) { }; /** * Destructor */ virtual ~MyEventCode() { shutdown(); }; /** * Setup AllJoyn, creating the objects needed and registering listeners. * * @param packageName This value is provided to the BusAttachment constructor to name the application * */ void initialize(const char* packageName); /** * Join an AllJoyn session. * * @param sessionName The busName/Wellknown name to join * @param port The port value that the remote side has bound a session * */ void joinSession(const char* sessionName, short port); /** * Leave an AllJoyn session. * * @param sessionId The ID of the session to leave * */ void leaveSession(int sessionId); /** * Perform an IntrospectionWithDescription request over AllJoyn * * @param sessionName The busName/Wellknown name to introspect * @param path introspect this specific path * @param sessionId The ID of the session that the is established with sessionName * * */ char* introspectWithDescriptions(const char* sessionName, const char* path, int sessionId); void callAction(ActionInfo* action); void InformFound(char* sessionName, int sessionId, char* friendly); bool enableEvent(EventInfo* event); /** * Free up and release the objects used */ void shutdown(); /* From About */ void Announced(const char* busName, uint16_t version, ajn::SessionPort port, const ajn::MsgArg& objectDescriptionArg, const ajn::MsgArg& aboutDataArg); void EventHandler(const ajn::InterfaceDescription::Member* member, const char* srcPath, ajn::Message& msg); /* For MethodCallAsync */ void AsyncCallReplyHandler(ajn::Message& msg, void* context); /* From SessionListener */ virtual void SessionLost(ajn::SessionId sessionId, ajn::SessionListener::SessionLostReason reason); /** JoinSessionAsync callback */ virtual void JoinSessionCB(QStatus status, ajn::SessionId sessionId, const ajn::SessionOpts& opts, void* context); private: JavaVM* vm; jobject jobj; std::map mBusFriendlyMap; std::map mBusSessionMap; std::map mBusPortMap; PresenceDetection* mPresenceDetection; ajn::BusAttachment* mBusAttachment; }; #endif //_MY_EVENT_CODE_ alljoyn-15.04b/alljoyn_core/samples/eventaction/Android/jni/event/PresenceDetection.cc000066400000000000000000000132751255700255500312110ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include "PresenceDetection.h" #define PING_WAIT_TIME 5000 using namespace ajn; using namespace qcc; PresenceDetection::PresenceDetection(ajn::BusAttachment* busAttachment, JavaVM* vm, jobject jobj) : mBusAttachment(busAttachment), vm(vm), jobj(jobj) { pthread_mutex_init(&mLock, NULL); pthread_create(&mThread, NULL, PingThreadLoop, this); } PresenceDetection::~PresenceDetection() { Stop(); } void PresenceDetection::StartPing(qcc::String bus, SessionPort p) { PingContext* newCtx = new PingContext(bus, p); PingContext* ctx; newCtx->isFound = true; pthread_mutex_lock(&mLock); bool isDuplicate = false; std::vector::const_iterator it = mPingList.begin(); while (it != mPingList.end()) { ctx = *it++; if (ctx->busName.compare(bus) == 0) { isDuplicate = true; break; } } if (!isDuplicate) { mPingList.push_back(newCtx); } pthread_mutex_unlock(&mLock); } void PresenceDetection::Stop() { pthread_mutex_lock(&mLock); pthread_join(mThread, NULL); pthread_mutex_unlock(&mLock); pthread_mutex_destroy(&mLock); } void* PresenceDetection::PingThreadLoop(void* context) { PresenceDetection* pd = (PresenceDetection*)context; PingContext* ctx; while (1) { pthread_mutex_lock(&pd->mLock); std::vector::const_iterator it = pd->mPingList.begin(); while (it != pd->mPingList.end()) { ctx = *it++; LOGTHIS("Calling PingAsync BusName = %s\n", ctx->busName.c_str()); QStatus status = pd->mBusAttachment->PingAsync(ctx->busName.c_str(), PING_WAIT_TIME, pd, ctx); /* * The PingAsync call failed make sure pointers are cleaned up so no memory * leaks occur. */ if (ER_OK != status) { LOGTHIS("Unable to ping %s reason reported: %s", ctx->busName.c_str(), QCC_StatusText(status)); } } pthread_mutex_unlock(&pd->mLock); sleep(5); } return 0; } void PresenceDetection::PingCB(QStatus status, void* context) { PingContext* ctx = (PingContext*)context; //If we didn't get a successful Ping then the device is gone //We keep it in the list to continue to check for presence if (ER_OK == status && !ctx->isFound) { ctx->isFound = true; //Device is detected so it is back //If we get About Signal again then the logic will not end up re-adding //a duplicate entry but will update the previous data updated JNIEnv* env; jint jret = vm->GetEnv((void**)&env, JNI_VERSION_1_2); if (JNI_EDETACHED == jret) { vm->AttachCurrentThread(&env, NULL); } jclass jcls = env->GetObjectClass(jobj); jmethodID mid = env->GetMethodID(jcls, "returnedEventActionApplication", "(Ljava/lang/String;)V"); if (mid == 0) { LOGTHIS("Failed to get Java returnedEventActionApplication"); } else { jstring jBusName = env->NewStringUTF(ctx->busName.c_str()); env->CallVoidMethod(jobj, mid, jBusName); env->DeleteLocalRef(jBusName); } if (JNI_EDETACHED == jret) { vm->DetachCurrentThread(); } } if (ER_ALLJOYN_PING_REPLY_INCOMPATIBLE_REMOTE_ROUTING_NODE == status) { //This device does not support PING so stop LOGTHIS("Sorry BusName = %s does not support BusAttachment::Ping\n", ctx->busName.c_str()); pthread_mutex_lock(&mLock); std::vector::const_iterator it = mPingList.begin(); int index = 0; while (it != mPingList.end()) { if ((*it++)->busName.compare(ctx->busName) == 0) { mPingList.erase(mPingList.begin() + index); break; } ++index; } pthread_mutex_unlock(&mLock); } else if (ER_OK != status && ctx->isFound) { ctx->isFound = false; //Device is no longer detected LOGTHIS("Lost BusName = %s\n", ctx->busName.c_str()); JNIEnv* env; jint jret = vm->GetEnv((void**)&env, JNI_VERSION_1_2); if (JNI_EDETACHED == jret) { vm->AttachCurrentThread(&env, NULL); } jclass jcls = env->GetObjectClass(jobj); jmethodID mid = env->GetMethodID(jcls, "lostEventActionApplication", "(Ljava/lang/String;)V"); if (mid == 0) { LOGTHIS("Failed to get Java lostEventActionApplication"); } else { jstring jBusName = env->NewStringUTF(ctx->busName.c_str()); env->CallVoidMethod(jobj, mid, jBusName); env->DeleteLocalRef(jBusName); } if (JNI_EDETACHED == jret) { vm->DetachCurrentThread(); } } } alljoyn-15.04b/alljoyn_core/samples/eventaction/Android/jni/event/PresenceDetection.h000066400000000000000000000042501255700255500310440ustar00rootroot00000000000000/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ #include #include #include #include #include #include #include #include #include #include #include "../Constants.h" #include #include #ifndef _PRESENCE_DETECTION_H_ #define _PRESENCE_DETECTION_H_ class PresenceDetection : public ajn::BusAttachment::PingAsyncCB { public: PresenceDetection(ajn::BusAttachment* busAttachment, JavaVM* vm, jobject jobj); ~PresenceDetection(); void StartPing(qcc::String bus, ajn::SessionPort p); void Stop(); private: struct PingContext { qcc::String busName; ajn::SessionPort port; bool isFound; PingContext(qcc::String bus, ajn::SessionPort p) : busName(bus), port(p), isFound(0) { } }; static void* PingThreadLoop(void* context); void PingCB(QStatus status, void* context); pthread_t mThread; pthread_mutex_t mLock; std::vector mPingList; ajn::BusAttachment* mBusAttachment; JavaVM* vm; jobject jobj; }; #endif /* _PRESENCE_DETECTION_H_ */ org_allseen_sample_event_tester_BusHandler.h000066400000000000000000000050641255700255500361170ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/samples/eventaction/Android/jni/event/****************************************************************************** * Copyright AllSeen Alliance. All rights reserved. * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above * copyright notice and this permission notice appear in all copies. * * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ******************************************************************************/ /* DO NOT EDIT THIS FILE - it is machine generated */ #include /* Header for class org_allseen_sample_event_tester_BusHandler */ #ifndef _Included_org_allseen_sample_event_tester_BusHandler #define _Included_org_allseen_sample_event_tester_BusHandler #ifdef __cplusplus extern "C" { #endif /* * Class: org_allseen_sample_event_tester_BusHandler * Method: initialize * Signature: (Ljava/lang/String;)V */ JNIEXPORT void JNICALL Java_org_allseen_sample_event_tester_BusHandler_initialize (JNIEnv *, jobject, jstring); JNIEXPORT void JNICALL Java_org_allseen_sample_event_tester_BusHandler_startRuleEngine (JNIEnv *, jobject); /* * Class: org_allseen_sample_event_tester_BusHandler * Method: dointrospection * Signature: (Ljava/lang/String;Ljava/lang/String;I)Ljava/langString; */ JNIEXPORT jstring JNICALL Java_org_allseen_sample_event_tester_BusHandler_doIntrospection (JNIEnv *, jobject, jstring, jstring, jint); JNIEXPORT void JNICALL Java_org_allseen_sample_event_tester_BusHandler_introspectionDone (JNIEnv *, jobject, jint); JNIEXPORT jboolean JNICALL Java_org_allseen_sample_event_tester_BusHandler_enableEvent (JNIEnv *, jobject, jstring, jstring, jstring, jstring, jstring); JNIEXPORT void JNICALL Java_org_allseen_sample_event_tester_BusHandler_callAction (JNIEnv *, jobject, jstring, jstring, jstring, jstring, jstring); /* * Class: org_allseen_sample_event_tester_BusHandler * Method: shutdown * Signature: ()V */ JNIEXPORT void JNICALL Java_org_allseen_sample_event_tester_BusHandler_shutdown (JNIEnv *, jobject); #ifdef __cplusplus } #endif #endif alljoyn-15.04b/alljoyn_core/samples/eventaction/Android/project.properties000066400000000000000000000010631255700255500271520ustar00rootroot00000000000000# This file is automatically generated by Android Tools. # Do not modify this file -- YOUR CHANGES WILL BE ERASED! # # This file must be checked in Version Control Systems. # # To customize properties used by the Ant build system edit # "ant.properties", and override values to adapt the script to your # project structure. # # To enable ProGuard to shrink and obfuscate your code, uncomment this (available properties: sdk.dir, user.home): #proguard.config=${sdk.dir}/tools/proguard/proguard-android.txt:proguard-project.txt # Project target. target=android-16 alljoyn-15.04b/alljoyn_core/samples/eventaction/Android/res/000077500000000000000000000000001255700255500241575ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/samples/eventaction/Android/res/drawable-hdpi/000077500000000000000000000000001255700255500266625ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/samples/eventaction/Android/res/drawable-hdpi/ic_launcher.png000066400000000000000000000117441255700255500316530ustar00rootroot00000000000000PNG  IHDRHHUGIDATx[xTUI}l4 % mZUUuE_Wݍ&3̤'4ФzT!m^2%߾߹30 r|̜{g9{soTq/8HvQ|5H]ł%XFMO5mƙx3x }R_0#b+jZnDŽX̵v.!=4a&+?֩T򮬋< qYz}JgRr<8#* ^GE ߞÖH'Osژ~J`~ uu$u*祎dKOdXq~urdӌ!CI!Q=C\8x (\㡆:/N|(Erzf!wQpG 'Q|A 8"<;c'Řw,zpdUfXSƓ*$opwMN&_vE>"j@ABj)W"kô ޷/mT.C1P ]FR.B'zq1oB $jr^*ȓ^u9MɮCLUEJαƘ`a 'yl Ic$yM[( _^J#'jMK[]e=Rg!D)}[ROMmU›뇓wszQ69?\/nDҕdc*9M#?RV#XKXs)Wmz! RtB=<)ZO;7y^ xr \M!4{Q +A\ 7\&r>>O/ϋD;XwЊ5pM{oD9"c\ WRpo yF#WaWgR%((VM;0ѻ(zp }iB\]rjjݰkϮę@ i:cp 2qd";y'l!A_J_¾ w r3}!9zo.9;B;$XHߢm LGfSpkkT_Op=<MqHW8*=H㗮%ǐY0Xf?tKQg ȿv?yF%ϧk]\5#R*%wZIߊK#-f$$n7Xҥ Repg{qU$Q}:d S`Nϊ7| vo(' .Pe6/pa"I sa:+ 6 NԾi|v2W9MMfgvBTCeJw !voz7 *p'y"ػpȓs[3~6vi H=K-sN$SA麼 b~ _Lgs \ &muS7 @a [] 0BG؅[W^`"a> R E?NߧaouU+j4|.仂<67;ۧL=Ǖp킫}*p²Aj|T?3\9ŶE#{~O$rYB'i "MļGxFLc6 !؋B5 ƒhȃ{Q\eL7#Sk*Yj(울O@5]s:KXu^#,KA;} Ar`G=IQ,9RI[{ɕS&BL~>r\ϕD=Ȳ.Ƣk{\4vy0K1[_CU"?H N^Q#B _#2{j[w.FdŃ2+b`TK鑧usm?^VL(@tP"QxQd}1/_?B?q~iJovr3 Ȼ5dV*l)D:??FA5?+^@Bm4Y'*eP)!,e KŨ“'갳 P]BQ-DG%y+NP[Qs /k U+ JEDiڝ$=$]"1 .Wv%9ĶUmbJEX 0No.1 lS6|ɚAdÞ㝳]!t*xƂL!9SH.wN#o߳zvr4uIɃF@$"=? :,`zimBa|hQrbr\˅&l);QsyXL2, D)w˄|!KH /rJWߤE5FI_&Ģ4* (987Bx{a"x8C " $~3nbg1oslDn"I5l1eBn#yV |Qlxo} wVE(Z]BI\\BQ +@MҕX鰬H%97sbA` g' T{ žv}>|+s~Y#碑 >ƤoITI]xZd!F4X T=T8ophʜbO| 9(X&bi/4^&T:;xJE@\s3]܍ƤAA9$ݐk`mŢ%@:kg7.?8kz=!ŚÛK,`Y D$(=oay^*)f}FW. "Ox Uؓ.n(ML#fwHߪ2ΪL Şq#řn(feߊAO9~0[=<3'[=HmdۼYˀc ^c{> LmT.mka}Ȫy5?^̏v܏\>؛*SGmk553,.4y梜οI6‹m]&^]id0W((mۄ8 kronjpñ_gW/P{|Vךnl "s3qhjGhikפ]{ȋ~'N%Դ vIs_mLֿSJSƧM4,Le[]hmua_MJK4h8'= Dݘ#TuꌗpT'W-ѐ~ҵ^ꒌi=M18jٛN (%Q*ګNi5uƘdޖqNmLNN̸C/COnk/R:ͽ]X06NFߏ+9)CKHOj3;Μ6:jX=%&6L09uhی,yC1Ec_OC:u#EB?/ͪsNcm5jc%}-3=Lj#JI4.«vܘ` Pj/4/JQ`R4UIRZ_M?( ܇{e=A3#kuUcj]g M踜;g H)ILƨ&'fѿwfoLk CoόkVp(ϣ'gfԭD+" Z~Й^0U.?9^gS !T?&C@ 'jƍg Hx͉tvnjbݑf |X2A`Ѷ' ~jpCţtH_ D}J#gh%/ &yjㅉȹ0/h-htbdg0&Cĸs/0@<1ntp"#FIZm4E81o5'2/c!̉- X$`c5&Ze һ@Lv }.ʪWD=ۈgERbH E>$1np y'h{)]s\CQ0!^fI֯[)7u]dL05 *Kg73{Tt I"+UG&9#YX<%%A߇K%X -L:(a@&˿O8bL1)$4vdCɮd(| Q)cSpc5* ewVU(!bX2_WsU[ڃpW:8^ [k|zW7(_uk>C옉F!֪[AN’mKw!p,|F[.x?K xB+xr_Rӫ U*Q],\hXNP{ &| &?m<%;жlBgh+ k!\u!_ȚL7tpo/j&> wVÝ~r<,:#!x?-YT7d'B'EDA{egxlqvZVpVj V_4!,9qzBX emxG`ivB`IǗ]U 6Xv =ٜ4~>Kxc%powz("­N%B-g:howAN\%@XVҸзKHڂ2K pEӼ:E}a٣Z1{J#@D+Qu_߈󈴶)@+]Mdu`,?@^1 MGٕ(3ABk"Df Vka)ϬRB%Hw~br ʀp"4 Mk@Vspp5UZB.E',Bfu X|P- ϟ,M.L)|d;w SJ(ߦ/q{!'Z2.xWāِu.vi>K8t ү{?.+cYРE kgv% hse4(xk'ǂ8s>41]9*od#?PfUkBppeo;gi pcO,RȗX^麑+X "̏ȩp fQDmK?knegwR+}B;GN\Hk}Ng=HbvKA~D1k3JtZ8J9Z9gj$>@kgGY ΪGCA%:DZQ W+pFi}VuK7oj`D"%V8x+9@cIIb}Y^Z/,t|{IOgg%t̡sF>F(!U stbЛ2+TqLq? =o' 6(*d>B8.c@J~JsnX_V,A>!e䜑*,vMr:{3+ qJ3~xFT.mvoE߉(*f`V3D'ZVT&әtiHFǍ%'ac%q454}>ctjbp19uWJf!,D~ZޔtL'cرJ8u;lH2qJy%%̚zb"9wup`?3JIENDB`alljoyn-15.04b/alljoyn_core/samples/eventaction/Android/res/drawable-xhdpi/000077500000000000000000000000001255700255500270525ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/samples/eventaction/Android/res/drawable-xhdpi/ic_launcher.png000066400000000000000000000166371255700255500320510ustar00rootroot00000000000000PNG  IHDR``w8fIDATx\xTe֞uID,L@IDUquuuu^]Um̄4BoB*-;saUl{&s̽==9߽P40Fh a4:2MM)F/bsL8|Sއs)F#5ځ8buߊРX~|=SotyFc쏄F& V䝦۪CcMƹE`4 t~g&|݄Q~c72*_oU[bӐfELB#9pƂ3p~o-k +>?5}1wк~&#F1V9Ѝ*zq 26s(Ay[:AA.γ@ǻ r B<05S&VaHMѹ9]%OoĞ^b9lOV9.: *Gv[ s\xB,9WbfᆫD9SE"l2 SC=> ,i@l; Zs3j4q9|4!!| ;ANMbt"F/c'I!0ZCf\SpGp|Oxl18i0*ր'I$n;WpzQU fWO+\KG>u8_!p)^f;E2Qx+Sx$$[>פ(]Pӵ^ 4ֵ5ph배1),O/?m.q"p {0lۋX@60w¼\߭=yKW6RKA,w0dt{<T s`l.!O2p ]HEK|w!xfv4t`J'Wܺf%) sHv`Iy.|Hbt׻b>Y(7Q9zoGOh,ߟX.󟆁élI xfa#K5ca(}@ {_.g }!]y']=۪9 0+ϙGр$$ &6T=ւbT(NV;,oB8 !+# _M|4 A ǃh~<Ӱ~8lܺpefIrXRe5|KVK*N߱ Tذ ܑ gw!b4F|=k>ؾƯ1=?o u q9`L}> l((G9h-X B\05:35JWO6=iHYj*dV`qoSLTcQd^ p'p`C`TN=b4#e>zu9׀#}1t3=]?"Oڲ#Az4f9 1[:DU AxOn<4юZb4 J8N[!(: Dр4ۅ<'sg&2g~up.1v8@ 0NAA#8V`yx,&Aڀd)PHu)4-1n.`~~8XD\ب= xdl|nJx1L'8]/%E~s*DCxʃTZ_mRGmM#ZL2Qb+DN0B? AӨm~8? <*9rk"%B 81!oGA1 3i/X{Ol߬[-M aA >5/?KQJN[,NDT$7ѪPpz!p} R(*W)EÚR$L`Qp/DŽe(ߞVUb fmUpaح#>gƠOYJ 1 \71FHhl(A+3Uy1q`DOw>y}q\xy&jusviT=As"w2kx{<D3=vbfjSh|)hGӶF@'DEGJ{ U{VpO4Q+c*OMEjTeUu'c;& QvDf(_ ٬Xd9P8ǬeYՎFT9X)U!5ywWq(> hs6UA-zB@6w~;ļNFd9e(S-'(p zo_gbyƨrϗa; oGps'u2 Bhz=l\ &vDCI{.ʶ~6sx0*3/V[ n6oT&aI>$ljn7soa8ɘ<5ioZ %fP]y7A@ʠqe,&4j[۵Ҷ~2o)K`Zi*;ュ 9H¬T@wTAOIi<6֐@հc(# U%[=o'D3/oQ@4FmfSFa$"izUgN+ 7Ir@/}=T<ԯ-{B_ AXZmAdLm 5QJ$LQBYޗ9'yU /iD9M/"buSk17ά*}G J8k)Pof͑@P \SQ6N!@o"dZs! EI^p?&#g)WޖWGs \|l0i 2B s6Mtk%TwJȖ>sk͔b'53r!+&WqL@Ѿܠp>^$G@ $sνBgn16ɻ+Tծf2"hal VCTc;-9GZ⌢MH;+r|QQRXm n`swD I O"ȄX_c U'bBPX$IRZRћ2 O%JϢ=$T!A5r]\{_ש;d]O{f*UzS:IϞT_ӳ]zg;ڵiJM/u|>B<lh*Ĭv)HmqiG Č{HQiFɴHSj{Q\C,W}rZ2_6>`<5Ay?1sP$R|ٲ{uӶIEL$"`415$/s)K>`?2Re@2Wۋp>r%ċ)*rh/>O251sybUOݓiym݂xJR%M>n:6U;? ϙ#nק|^=s7Ieش,UrTi'v\rȨhlF] HGeO":K n_ S< ]Gb4,fKIqB=(-#; 6"ZLrAi?.NĀۃ^1zJəS?9YN,deIzԕ+ G$%O&ݗ)\yTqoD>O5MӒ29~{wMH^Oj)_ ir!ũ$y25cUoqaqBř,@./, NRJBJ޵j@k-9I7%&W&y=ԯI6ˢMi]@o:KEIjθ}s(nA\.?tI)n`^;Hg>Vi^9^R?[O"/&;s20|aI Hc&S˻{fu ܆piZIU`Ddy%)W9Yy$c4u! ]Mq<1ox=6Hšg1jo4e^xbc#8W(R3^$ϐWSs A[K_RT5+l q9GW7A,Br߇T98WøAmcDYeR40Fh a\7Qk@hIENDB`alljoyn-15.04b/alljoyn_core/samples/eventaction/Android/res/drawable-xxhdpi/000077500000000000000000000000001255700255500272425ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/samples/eventaction/Android/res/drawable-xxhdpi/ic_launcher.png000066400000000000000000000331371255700255500322330ustar00rootroot00000000000000PNG  IHDRF6&IDATx]XTW&Ya,ib&Q@mzIͦS6uDAA[l{=h߹3WAy{snTִ5iMkZӚִ5iMkZӚִ5i-*Yl-cL(XbHKiYT6*18%&;EgYibNgyQ)1JTEIiPo+nl_id%4~*g%iI(&âĤJ@c):ؤWtgރiibeXTz3:E8O;a2A_ 'lXɪ$tK)>ejR3.6Blpqt{F31<L0\-˩_'+rYSjxu%zNidf9kTOnkTc)RmԽ a<\8+w$9BfzNqERF.B]d>,֙M4*<%<[ `p@x3V yo>넧zkz]~AYȻG [zc?ai\-sڢs:;l&m$Aixd7 ك —NrZpQb>^/읆 {r|n6HJcbL]'HiD_N&a &hL%ʊ r_ME")<]#H_s-Η2༙kE"(O^RaO&lm bJ%\GmOS3u?z^(Jv?S?|DB2#i$ u[7rfetKp>?Y8]6*ScQB.6ҧ>Ө(*l'vԏtNUmb \$ZD,.aG-ik~z}_xjp<6CL$u˿JAR\HU(@ԭ0Ji1jB]VKGRmOaPOKtl5[rӡM8H"JL㑟\$]oꅓ4XxmE&fP*V.xxiEQF,%&+8.mԏ.qY|$ J QpNw^nYBo޴d>\vHEEl oܟ'-Bncx?gVwdkFXC:<-1T;"vG?'NRSDt<L-JwY#ė^x/q;I$&<8;–842_ Lk̓qO*TmƵʹL 8ASe>SkEo)zi!mJwE6{z{Sɂց07ܟc0Hxb+?I!vz|Ʀ{ˢ)u&60'n˄V^/!i~a#vc/o3WBx],cvצ ?"~ظ9L?.Ge]䢛%;jBx+مgZgW|27RP#Ԧ}mE1DZNQ>qkfL_Hsya(rDmG,&&:,\䔆MҽVQ\rd\B,vLO'IR.;:ֶeBv}_am՟fk7?0[1vSMoRjb 1.&|Y(Jla{`p~4M75Dɲ};l"0myR3Z \2]k6^'c& ^QHwЭ#R{2SD`c23y-%:3.qlӘz343jMl1OXo+ DpaQxO,xzwg K竅EqځHg,SӳFhpcP|UmzjJfLӆ\zWK6+Dp៹]x ap~?U“X{ lG Ob2{mzsFD%k;k@WZ%dFƮb¢G *uͯXoF[=[SHo<33H^%m៽]/ʬzDl$"wRap~7Y$-󯟅'g1Xrb&ۇD`1ЮbMob}xxLa>RqJcc!5JY*fHJo@0 WKʹJ^מB|1Ij̧,uātUu2NymNyop{:d9vXG W3wpw/}h3J_!/ akGhp36:H@)+gěwJL>/'DGW^ͺGԒ\xDiklp~0Ex3W=VQvN"`&|i,'vIEV L 9C~=up;C%S(Qඣ0>* Z㈳ɲ؈'ApSn(YxER%7x' %ߐ&2frspg6 $8TEk:I w. 01+c6bQf2-J*"l Z*< ϐe'ܱ;{W|w|g9W!'w`͚O(ĊKǕ(f y9Ez]_au8Նd+CE$yK 88s@=ź6dD0M O"jF<һD a)Ǖ9Wx.Q ]ND} ى_Cl雅r 6BLFl'!ۇ>K8OcTV\# q:G( 9B4O]CՌϽOcIn,y8`MKW"A,y@ ߬ $_‡>s+;q_'<#WS-~H9dL3Y_wJr|(ޘ&;E`}JPS7 ߄udVF(ݯ -&P7XKOaP]@ V%GKf2]w+صv7e,%Jb&*yxpK6 A_Ga6I+rHl;,J~="; vŻ0ؤDTcIbAIۅ|i$!YkmqhrFe\s.6+u6~a0apbc=e*rY*{D1裣"H03b}LjafR[Er)d(A@SeM R l8BSE.:Nmfq,3.9B`Qiumqcckt!i!qDbA$ J[dA; \pwGlXNf2[0ʽD0R6GlsprtljЄ" Nܷ͊Q= ?sUfyln%PLM4F÷fup`ڝ=BQX&S9heqk# 1M{pDߊ*󥰆YY'|1"GW cxZ6l݆)Y2sAkg>B W .O#!J'0g9͠sʘ'G=;'W1r<4CqӌȾO1KO  xFYet9p}h.-qkY! 3p'/S`!6gd|F»3{m{Hpě9gq*{\9EɚkXvL?$HaB% pZS;M[JO+ !C 2$SKX !%xBB{Q"'"D .;X--St|NdV;6Yk5h1aOFWG4h0tP- mW;*Unˏ{*}}S,`"/!V#R}M@ٍKV(MDŽ8*LX ;8S`E;hj%zk6]Ոv>>N8_ =4gu`25,FƆaFq/ @)1lsX8i؏2xH;W~vߑ-ϙ;g+ rE3<҃6v%̤ x3yhlƊNRo:: i_+;Eڻy9iC:쟶i,9]ʥUYjI=R66hܔ3Dwr#LX_bΉ,nv1e> 15AؓjM;xr yw x^Q9A7| hI f .}A86B~AdnX8qKwb]!Qc|p~M韓dq-I'.9 V)$X$=Xr/D@<8O9DJ9t z 6 Bzb>)3,<XrbHgdYv6`)eY"6vc{ym>D3yQtXkE;>U7-9 D05>r ;Fh͡V}XRd>LtgEN?Kf$?x<;cRykǼ2P9VjYjan;J[\3!!Km7.9}a٫:` GK̩;s{x``PrN<kE uEgL/jqW^[{cSnr-t59#0S]V&ra=[!hM!&'Mr{w#fjQ[4pdEh}q z,sc6_g !HHFqK6OTO:Lg1ҁË~bv)mSMoF5fiVi=>w9>X3R18oa1Xs!,n!挙XAPFz!/'͗3M!q\q96yO>>p,oFɭq&bxQ Y]l c Gqp LB,:UziO$ǯxS2!O;vJP0`@!t\X(Œy{Ipt5u~CY {_7񟦦` Ƌ<~}*ٙX&6X4塕 O:8iBT:d^#3ͩZi,ゅi``"ާda)Q|F,~)X>w@ryseRY |uXz]r},9EJ\ SߒjX0g1xa)J*C&kg"m"1߄ y.cSuίɕyF k4!\k#\iܔ oϓII3*?T +e &SDxw\ѿ$Q0xyWd"!0VUxW ;m #ReE5&!'Z {+ӇԚ+w*.Df؊UwQ;C1'rzAk527MGprQ.3.Dq9g\^V1  zXeJ6FH%҃C&Aml+e[ipS#-SDe\5VP\cQW <ԞQwE(Ӳ[Tنy@p8 ^\-kẒ=_PtSʺHT4WMe (@ߟdyC1ޠQe(SXOΫ4M>^:A͕&KWٯD6*L}D8OCf շND])U#V)^5s(%W{|p_ : <(UM6m"E:S+ 8sYaHUikj<$vjX7]֯VR[.3Bz\~Gg,"s uEQ}n4d",ƹjKy+Co9df\zK5WfVLp/c84$Ĥ?9.S#N&nZ>5zmNEEG5Ԏu| k4c| +Cj8u&6 SX&9bfŹ:KkPt"\o9{AS"'f,Wb-:ӿ]#H`c g_wIϜsM慍7cAҚ8fK)Sj8\6gڤȄRc*,Pq6@F#psWoLVUh^[JLX3=Yt47);^9S8K=2vq1pF? ̡'-}l1QN tMdNWEU7Q"]]QYW1;Wz,Fy4յtN#KPI NCp$6"g!#ɞk`'xpM{]mI8&b$»SO ۊcL,c*5b_q8VwfWڣdyڈ40(QJCE)oTO'K#DMhPlK|}uOX EZӚִ5iMkZӚִ5iMk5m uM!9~R?X[;;`شMKڒOI3|,1WlR|Ot[7㸉'')!mQ ?,ܽGH9_'5H5tIM-|o$vKLз?ё h n'i/kVlb9Iq#ԝ oOlC?JM)VSB1g@mkHsRN;ΐǭܯ6jh` +`0}))/*&?3IS: NO~\M-f6H ɱi@qqb @&KjzQ$Ʀ-A@^x晖@d~Kjz^ܡC%I3.pŭ +CwBsyLl]?W~8j mlB܋sJiھ}z3|{|ʥؖ>7?'=?gAEj$AkX3Fu@q:6ɋ}wɺ{>)'{uO+`NE\j{5v ix7x#)ְA?oG6Z Z4NlkxN|=z1.UW\\a3 c+OhaW^Qv~ocNJJ8"]CIIX2,p]cz~#1{>y&9>mz\$vcOֱ-ymCڡmZxC*O:ua?Kz}Pq=ݞ=P;IMF66: _JmJemv>Kb9)S?WAy\}nP/d=Hv'&Ax=nw(V)鈡 mC|Z'DEBZDM qLmފI i^ah>mC*- ;4YڥУ%>wzUU3XD=A_!|Z ' =z¶a 5R0舺3?MB!=4C:Kz #Ɠ8j?-qx"eGCqi%YN7]ރ%MK"=- d0-%q=D{U~`6҉ bT=Y xJ@U\2a`kT袜o5Y8#}6|HFi%5K_!W5nUQ}^GV:?L6l֟@Kxֆ @R "o''ť~f$Di)XTA w$&_'+[kxM*S$'CN+< B1.F4<MwJmzܘptUcmV+*Ba "y&Ttw8댧022?JO}R ;QS&v oG>A-JA%׊:.1J)jp^|86-SK ZT)2޸` Ggd طa%?Ui $2^^1D_24I$/(K$_kMO ĿN K؟.Һְh ERI{z]ֲ υ1m3cB4'J;Xcnr>]0!)#׿Us*CZEO@DOk8PE[Yh^zVr.r./ b 9]!]O "ߒz g;^RHV\B곸Ћ?UɅCOcXU&p ppjbLjB^28ƭR.w=nVqM1n;++ (K팿R'jZ2gxwxEPCI_PZޚo_/KZCL`_:@q ѫ_xӥISǹ8>?$|%e+=\Y W.m6ݮЅtNZm)ev)3dCQ&9֘ZݤCauSK0ۃ\':Ŧ#V[XkYNV&S ?7ԾGNiMkZӚִ5iMkZӚִ5iMkZkzw_cIENDB`alljoyn-15.04b/alljoyn_core/samples/eventaction/Android/res/drawable/000077500000000000000000000000001255700255500257405ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/samples/eventaction/Android/res/drawable/selection.xml000066400000000000000000000021561255700255500304530ustar00rootroot00000000000000 alljoyn-15.04b/alljoyn_core/samples/eventaction/Android/res/drawable/selection_close.png000066400000000000000000000050561255700255500316260ustar00rootroot00000000000000PNG  IHDRc$iCCPICC Profile8UoT>oR? XGůUS[IJ*$:7鶪O{7@Hkk?<kktq݋m6nƶد-mR;`zv x#=\% oYRڱ#&?>ҹЪn_;j;$}*}+(}'}/LtY"$].9｟%{_a݊]hk5'SN{<_ t jM{-4%TńtY۟R6#v\喊x:'HO3^&0::m,L%3:qVE t]~Iv6Wٯ) |ʸ2]G4(6w‹$"AEv m[D;Vh[}چN|3HS:KtxU'D;77;_"e?Yqxl+ pHYsgRIDATH VoU?~|]-@ ѲS1$<xG^j4F1bl !P԰ }Ǥe:ݦowx2w~gt=EM4qn]=w_l)eb/;v+;J::h"'+Zߺ>a[b܉%bEaurC]@f|a[.ڦM!kiicjx,Fy!2HC iҶ,6=[7vw~h$"uݚ%uu!^0!\k?DցfZY<.o^!Ï''I1"噤Rg B/HIA |n Xaz}}EKy}bN eFXQur$. _Hdg&I;RŠiTLEQb)}oR? XGůUS[IJ*$:7鶪O{7@Hkk?<kktq݋m6nƶد-mR;`zv x#=\% oYRڱ#&?>ҹЪn_;j;$}*}+(}'}/LtY"$].9｟%{_a݊]hk5'SN{<_ t jM{-4%TńtY۟R6#v\喊x:'HO3^&0::m,L%3:qVE t]~Iv6Wٯ) |ʸ2]G4(6w‹$"AEv m[D;Vh[}چN|3HS:KtxU'D;77;_"e?Yqxl+ pHYsgRIDATH UoSU~=޶kٺQ2(!1fB6c"!јH2HL?!ED% Ft| j۵>ｽP'={{}9юY+X:49|EWPrE?ع6Iw|o w- k79vtݮu.Ǵ-E&aC߰@}}.j aYl\"$""RR6SoLZ!`sV&E9t `pfQmu1fZ'oCÁ?뗦ty2kтe -(<Ъ9K2UM7*f#_T5Yv9ìHU q<*^pJ*.tx%zi2gۭK .HD*[UCWC[b7mQ<҃M/-ybxfnnɲl!TBJEqBYQMSoj9K655}ns$ݘ&CuU öiqc{@(@u6@G&{f_{%C+bMÆF%Ic vҨDZ6P8E󩪊y=QTc#ukbHOS )b;[.GRɕЯ׮ -L!SLB1+xn#u|A^@ ľ'`orƙ?N䍡S'& SQZjD'zEr9ONRG$ł)Ͼ{. ?~iTHz8"B {Q J&UBN8Qo"ïalڡ#sW Ͷ%optq\GTWG>}Þ/ijLqeڀW%w`7di8|vǟc2_S~1כO/x^B=a:[͹op{J*X):q/|;qƟg^ wnXۿj鲁<E;'BF9t̎7Zw p (biQxCTGnXT*ݝtnt$;lCjokzjQrVu8wA]5xV^g;,=.`^ >9IENDB`alljoyn-15.04b/alljoyn_core/samples/eventaction/Android/res/layout-land/000077500000000000000000000000001255700255500264105ustar00rootroot00000000000000alljoyn-15.04b/alljoyn_core/samples/eventaction/Android/res/layout-land/rulesassigner_main.xml000066400000000000000000000105211255700255500330230ustar00rootroot00000000000000