Clarify the value returned in the event status field. Signed-off-by: Sean Hefty <[email protected]> --- man/rdma_get_cm_event.3 | 14 +++++++++++--- 1 files changed, 11 insertions(+), 3 deletions(-)
diff --git a/man/rdma_get_cm_event.3 b/man/rdma_get_cm_event.3 index 2ea1b56..b0c4970 100644 --- a/man/rdma_get_cm_event.3 +++ b/man/rdma_get_cm_event.3 @@ -41,7 +41,10 @@ Specifies the type of communication event which occurred. See EVENT TYPES below. .IP "status" 12 Returns any asynchronous error information associated with an event. The -status is zero unless the corresponding operation failed. +status is zero if the operation was successful, otherwise the status value +is non-zero and is either set to an errno or a transport specific value. +For details on transport specific status values, see the event type information +below. .IP "param" 12 Provides additional details based on the type of event. Users should select the conn or ud subfields based on the rdma_port_space of the @@ -126,10 +129,15 @@ Indicates that an error has occurred trying to establish or a connection. May be generated on the active or passive side of a connection. .IP RDMA_CM_EVENT_UNREACHABLE Generated on the active side to notify the user that the remote server is -not reachable or unable to respond to a connection request. +not reachable or unable to respond to a connection request. If this event +is generated in response to a UD QP resolution request over InfiniBand, +the event status field will contain an errno, if negative, or the status +result carried in the IB CM SIDR REP message. .IP RDMA_CM_EVENT_REJECTED Indicates that a connection request or response was rejected by the remote -end point. +end point. The event status field will contain the transport specific +reject reason if available. Under InfiniBand, this is the reject reason +carried in the IB CM REJ message. .IP RDMA_CM_EVENT_ESTABLISHED Indicates that a connection has been established with the remote end point. .IP RDMA_CM_EVENT_DISCONNECTED -- To unsubscribe from this list: send the line "unsubscribe linux-rdma" in the body of a message to [email protected] More majordomo info at http://vger.kernel.org/majordomo-info.html
