contrib/ofed/libibverbs/man/ibv_create_ah_from_wc.3

   1 .\" -*- nroff -*-
   2 .\"
   3 .TH IBV_CREATE_AH_FROM_WC 3 2006-10-31 libibverbs "Libibverbs Programmer's Manual"
   4 .SH "NAME"
   5 ibv_init_ah_from_wc, ibv_create_ah_from_wc \- initialize or create an
   6 address handle (AH) from a work completion
   7 .SH "SYNOPSIS"
   8 .nf
   9 .B #include <infiniband/verbs.h>
  10 .sp
  11 .BI "int ibv_init_ah_from_wc(struct ibv_context " "*context" ", uint8_t " "port_num" ,
  12 .BI "                        struct ibv_wc " "*wc" ", struct ibv_grh " "*grh" ,
  13 .BI "                        struct ibv_ah_attr " "*ah_attr" );
  14 .sp
  15 .BI "struct ibv_ah *ibv_create_ah_from_wc(struct ibv_pd " "*pd" ,
  16 .BI "                                     struct ibv_wc " "*wc" ,
  17 .BI "                                     struct ibv_grh " "*grh" ,
  18 .BI "                                     uint8_t " "port_num" );
  19 .fi
  20 .SH "DESCRIPTION"
  21 .B ibv_init_ah_from_wc()
  22 initializes the address handle (AH) attribute structure
  23 .I ah_attr
  24 for the RDMA device context
  25 .I context
  26 using the port number
  27 .I port_num\fR,
  28 using attributes from the work completion
  29 .I wc
  30 and the Global Routing Header (GRH) structure
  31 .I grh\fR.
  32 .PP
  33 .B ibv_create_ah_from_wc()
  34 creates an AH associated with the protection domain
  35 .I pd
  36 using the port number
  37 .I port_num\fR,
  38 using attributes from the work completion
  39 .I wc
  40 and the Global Routing Header (GRH) structure
  41 .I grh\fR.
  42 .SH "RETURN VALUE"
  43 .B ibv_init_ah_from_wc()
  44 returns 0 on success, and \-1 on error.
  45 .PP
  46 .B ibv_create_ah_from_wc()
  47 returns a pointer to the created AH, or NULL if the request fails.
  48 .SH "NOTES"
  49 The filled structure
  50 .I ah_attr
  51 returned from
  52 .B ibv_init_ah_from_wc()
  53 can be used to create a new AH using
  54 .B ibv_create_ah()\fR.
  55 .SH "SEE ALSO"
  56 .BR ibv_open_device (3),
  57 .BR ibv_alloc_pd (3),
  58 .BR ibv_create_ah (3),
  59 .BR ibv_destroy_ah (3),
  60 .BR ibv_poll_cq (3)
  61 .SH "AUTHORS"
  62 .TP
  63 Dotan Barak <dotanb@mellanox.co.il>