root/orte/mca/rml/base/rml_contact.h

/* [<][>][^][v][top][bottom][index][help] */

INCLUDED FROM

   1 /*
   2  * Copyright (c) 2007      Los Alamos National Security, LLC.  All rights
   3  *                         reserved.
   4  * Copyright (c) 2017      Intel, Inc. All rights reserved.
   5  * $COPYRIGHT$
   6  *
   7  * Additional copyrights may follow
   8  *
   9  * $HEADER$
  10  */
  11 
  12 /**
  13  * @file
  14  *
  15  * Interface for manipulating how the RML receives contact information
  16  *
  17  * Interface for manipulating how the RML receives contact
  18  * information.  These functions are generally used during orte_init
  19  * and orte_finalize.
  20  */
  21 
  22 
  23 #include "orte_config.h"
  24 #include "orte/types.h"
  25 
  26 #include "opal/dss/dss_types.h"
  27 
  28 BEGIN_C_DECLS
  29 
  30 /**
  31  * Parse a contact information string
  32  *
  33  * Parse a contact infromation string, such as that returned by
  34  * orte_rml.get_contact_info().  Generally used to extract the peer
  35  * name from a contact information string.  It can also be used to
  36  * extract the contact URI strings, although this is slightly less
  37  * useful as the URIs may be RML componenent specific and not have
  38  * general meaning.
  39  *
  40  * @param[in] contact_info  Contact information string for peer
  41  * @param[out] peer         Peer name in contact_info
  42  * @param[out] uris         URI strings for peer.  May be NULL if
  43  *                          information is not needed
  44  *
  45  * @retval ORTE_SUCCESS     Information successfully extraced
  46  * @retval ORTE_ERR_BAD_PARAM The contact_info was not a valid string
  47  * @retval ORTE_ERROR       An unspecified error occurred
  48  */
  49 ORTE_DECLSPEC int orte_rml_base_parse_uris(const char* contact_inf,
  50                                            orte_process_name_t* peer,
  51                                            char*** uris);
  52 
  53 END_C_DECLS
/* [<][>][^][v][top][bottom][index][help] */