OpenMPI  0.1.1
oob.h File Reference

Contains the internal functions and typedefs for the use of the oob. More...

#include "orte_config.h"
#include "orte/types.h"
#include "opal/mca/mca.h"
#include "orte/mca/rml/rml.h"
#include "opal/mca/crs/crs.h"
#include "opal/mca/crs/base/base.h"

Go to the source code of this file.

Data Structures

struct  mca_oob_base_component_2_0_0_t
 
struct  mca_oob_1_0_0_t
 OOB Module. More...
 

Macros

#define MCA_OOB_BASE_VERSION_2_0_0
 Macro for use in components that are of type oob. More...
 

Typedefs

typedef struct mca_oob_1_0_0_t mca_oob_1_0_0_t
 
typedef struct mca_oob_1_0_0_t mca_oob_t
 
typedef mca_oob_t *(* mca_oob_base_component_init_fn_t )(int *priority)
 
typedef struct
mca_oob_base_component_2_0_0_t 
mca_oob_base_component_2_0_0_t
 
typedef
mca_oob_base_component_2_0_0_t 
mca_oob_base_component_t
 
typedef char *(* mca_oob_base_module_get_addr_fn_t )(void)
 
typedef int(* mca_oob_base_module_set_addr_fn_t )(const orte_process_name_t *peer, const char *uri)
 
typedef int(* mca_oob_base_module_ping_fn_t )(const orte_process_name_t *, const char *uri, const struct timeval *tv)
 Implementation of mca_oob_ping(). More...
 
typedef int(* mca_oob_base_module_send_nb_fn_t )(orte_process_name_t *target, orte_process_name_t *origin, struct iovec *msg, int count, int tag, int flags, orte_rml_callback_fn_t cbfunc, void *cbdata)
 Send an oob message. More...
 
typedef int(* mca_oob_base_module_recv_nb_fn_t )(orte_process_name_t *peer, struct iovec *msg, int count, int tag, int flags, orte_rml_callback_fn_t cbfunc, void *cbdata)
 Implementation of mca_oob_recv_nb(). More...
 
typedef int(* mca_oob_base_module_recv_cancel_fn_t )(orte_process_name_t *peer, int tag)
 Implementation of mca_oob_recv_cancel(). More...
 
typedef int(* mca_oob_base_module_init_fn_t )(void)
 Hook function called by mca_oob_base_register to allow the oob component a chance to register contact information.
 
typedef int(* mca_oob_base_module_fini_fn_t )(void)
 Cleanup during finalize.
 
typedef int(* mca_oob_base_module_ft_event_fn_t )(int state)
 

Variables

ORTE_DECLSPEC mca_oob_t mca_oob
 

Detailed Description

Contains the internal functions and typedefs for the use of the oob.

Macro Definition Documentation

#define MCA_OOB_BASE_VERSION_2_0_0
Value:
MCA_BASE_VERSION_2_0_0, \
"oob", 2, 0, 0

Macro for use in components that are of type oob.

Typedef Documentation

typedef int(* mca_oob_base_module_ping_fn_t)(const orte_process_name_t *, const char *uri, const struct timeval *tv)

Implementation of mca_oob_ping().

Parameters
peer(IN) Opaque name of peer process.
tv(IN) Timeout to wait in connection response.
Returns
OMPI error code (<0) or ORTE_SUCCESS
typedef int(* mca_oob_base_module_recv_cancel_fn_t)(orte_process_name_t *peer, int tag)

Implementation of mca_oob_recv_cancel().

Parameters
peer(IN) Opaque name of peer process or ORTE_NAME_WILDCARD for wildcard receive.
tag(IN) User defined tag for matching send/recv.
Returns
OMPI error code (<0) on error or number of bytes actually received.
typedef int(* mca_oob_base_module_recv_nb_fn_t)(orte_process_name_t *peer, struct iovec *msg, int count, int tag, int flags, orte_rml_callback_fn_t cbfunc, void *cbdata)

Implementation of mca_oob_recv_nb().

Parameters
peer(IN) Opaque name of peer process or ORTE_NAME_WILDCARD for wildcard receive.
msg(IN) Array of iovecs describing user buffers and lengths.
count(IN) Number of elements in iovec array.
tag(IN) User defined tag for matching send/recv.
flags(IN) May be MCA_OOB_PEEK to return up to size bytes of msg w/out removing it from the queue,
cbfunc(IN) Callback function on recv completion.
cbdata(IN) User data that is passed to callback function.
Returns
OMPI error code (<0) on error or number of bytes actually received.
typedef int(* mca_oob_base_module_send_nb_fn_t)(orte_process_name_t *target, orte_process_name_t *origin, struct iovec *msg, int count, int tag, int flags, orte_rml_callback_fn_t cbfunc, void *cbdata)

Send an oob message.

Send an oob message. All oob sends are non-blocking, and cbfunc will be called when the message has been sent. When cbfunc is called, message has been injected into the network but no guarantee is made about whether the target has received the message.

Parameters
[in]targetDestination process name
[in]originOrigin process for the message, for the purposes of message matching. This can be different from the process calling send().
[in]msgArray of iovecs describing user buffers and lengths.
[in]countNumber of elements in iovec array.
[in]tagUser defined tag for matching send/recv.
[in]flagsCurrently unused.
[in]cbfuncCallback function on send completion.
[in]cbdataUser data that is passed to callback function.
Returns
OMPI error code (<0) on error number of bytes actually sent.