contrib/ofed/librdmacm/man/rdma_migrate_id.3

   1 .\" Licensed under the OpenIB.org BSD license (FreeBSD Variant) - See COPYING.md
   2 .TH "RDMA_MIGRATE_ID" 3 "2007-11-13" "librdmacm" "Librdmacm Programmer's Manual" librdmacm
   3 .SH NAME
   4 rdma_migrate_id \- Move a communication identifier to a different event channel.
   5 .SH SYNOPSIS
   6 .B "#include <rdma/rdma_cma.h>"
   7 .P
   8 .B "int" rdma_migrate_id
   9 .BI "(struct rdma_cm_id *" id ","
  10 .BI "struct rdma_event_channel *" channel ");"
  11 .SH ARGUMENTS
  12 .IP "id" 12
  13 An existing communication identifier to migrate.
  14 .IP "channel" 12
  15 The communication channel that events associated with the
  16 allocated rdma_cm_id will be reported on.  May be NULL.
  17 .SH "DESCRIPTION"
  18 Migrates a communication identifier to a different event channel.
  19 .SH "RETURN VALUE"
  20 Returns 0 on success, or -1 on error.  If an error occurs, errno will be
  21 set to indicate the failure reason.
  22 .SH "NOTES"
  23 This routine migrates a communication identifier to the specified event
  24 channel and moves any pending events associated with the rdma_cm_id
  25 to the new channel.  Users should not poll for events on the
  26 rdma_cm_id's current event channel or invoke other routines on the
  27 rdma_cm_id while migrating between channels.  This call will block while
  28 there are any unacknowledged events on the current event channel.
  29 .P
  30 If the channel parameter is NULL, the specified rdma_cm_id will be
  31 placed into synchronous operation mode.  All calls on the id
  32 will block until the operation completes.
  33 .SH "SEE ALSO"
  34 rdma_cm(7), rdma_create_event_channel(3), rdma_create_id(3),
  35 rdma_get_cm_event(3)