Generated from ibmcgrp.h with ROBODoc v3.2.3 on Sun Apr 11 12:20:49 2004
TABLE OF CONTENTS
- Multicast Group App/Ibmcgrp
- Multicast Group App/ibmcgrp_action
- Multicast Group App/ibmcgrp_bind
- Multicast Group App/ibmcgrp_destroy
- Multicast Group App/ibmcgrp_init
- Multicast Group App/ibmcgrp_opt_t
- Multicast Group App/ibmcgrp_run
- Multicast Group App/ibmcgrp_t
NAME
Ibmcgrp
DESCRIPTION
The Ibmcgrp object create/join and leave multicast group.
AUTHOR
Eitan Zahavi, Mellanox.
NAME
ibmcgrp_action
DESCRIPTION
Enumerates the possible Action modes.
SYNOPSIS
#define IBMCGRP_NOACT 0
#define IBMCGRP_CREATE 1
#define IBMCGRP_JOIN 2
#define IBMCGRP_LEAVE 3
NAME
ibmcgrp_bind
DESCRIPTION
Binds ibmcgrp to a local port.
SYNOPSIS
/
ib_api_status_t ibmcgrp_bind( IN ibmcgrp_t * p_ibmcgrp );
PARAMETERS
p_ibmcgrp
[in] Pointer to an ibmcgrp_t object.
RETURN VALUES
IB_SUCCESS if OK
NOTES
SEE ALSO
NAME
ibmcgrp_destroy
DESCRIPTION
The ibmcgrp_destroy function destroys an ibmcgrp object, releasing
all resources.
SYNOPSIS
/
void ibmcgrp_destroy( IN ibmcgrp_t * p_ibmcgrp );
PARAMETERS
p_ibmcgrp
[in] Pointer to a Multicast Group App object to destroy.
RETURN VALUE
This function does not return a value.
NOTES
Performs any necessary cleanup of the specified Multicast Group App object.
Further operations should not be attempted on the destroyed object.
This function should only be called after a call to ibmcgrp_init.
SEE ALSO
ibmcgrp_init
NAME
ibmcgrp_init
DESCRIPTION
The ibmcgrp_init function initializes a Multicast Group App object for use.
SYNOPSIS
/
ib_api_status_t ibmcgrp_init( IN ibmcgrp_t * const p_ibmcgrp,
IN ibmcgrp_opt_t * const p_opt,
IN const osm_log_level_t log_flags
);
PARAMETERS
p_ibmcgrp
[in] Pointer to an ibmcgrp_t object to initialize.
p_opt
[in] Pointer to the options structure.
log_flags
[in] Log level flags to set.
RETURN VALUES
IB_SUCCESS if the Multicast Group App object was initialized successfully.
NOTES
Allows calling other Multicast Group App methods.
SEE ALSO
ibmcgrp object, ibmcgrp_construct, ibmcgrp_destroy
NAME
ibmcgrp_opt_t
DESCRIPTION
Ibmcgrp options structure. This structure contains the various
specific configuration parameters for ibmcgrp.
SYNOPSIS
/
typedef struct _ibmcgrp_opt
{
ib_gid_t mgid;
uint16_t port_num;
uint16_t rate;
uint16_t mtu;
uint32_t transaction_timeout;
boolean_t force_log_flush;
uint32_t retry_count;
uint8_t action;
char *log_file;
} ibmcgrp_opt_t;
FIELDS
SEE ALSO
NAME
ibmcgrp_run
DESCRIPTION
Runs the ibmcgrp action: create, join, leave
SYNOPSIS
/
ib_api_status_t ibmcgrp_run( IN ibmcgrp_t * const p_ibmcgrp );
PARAMETERS
p_ibmcgrp
[in] Pointer to an ibmcgrp_t object.
RETURN VALUES
IB_SUCCESS on success
NOTES
SEE ALSO
NAME
ibmcgrp_t
DESCRIPTION
Ibmcgrp structure.
This object should be treated as opaque and should
be manipulated only through the provided functions.
SYNOPSIS
/
typedef struct _ibmcgrp
{
osm_log_t *p_log;
struct _osm_vendor *p_vendor;
osm_bind_handle_t h_bind;
osm_mad_pool_t mad_pool;
ibmcgrp_opt_t *p_opt;
ib_net64_t port_guid;
} ibmcgrp_t;
FIELDS
p_log
Log facility used by all Ibmcgrp components.
p_vendor
Pointer to the vendor transport layer.
h_bind
The bind handle obtained by osm_vendor_sa_api/osmv_bind_sa
mad_pool
The mad pool provided for teh vendor layer to allocate mad wrappers in
p_opt
ibmcgrp options structure
guid
guid for the port over which ibmcgrp is running.
SEE ALSO