File status.h

Unified Communication Services.

Date

2014-2019

Copyright

Mellanox Technologies Ltd. All rights reserved.

Copyright

The University of Tennessee and the University of Tennessee research foundation. All rights reserved.

Defines

UCS_IS_ENDPOINT_ERROR(_code)
UCS_PTR_IS_ERR(_ptr)
UCS_PTR_IS_PTR(_ptr)
UCS_PTR_RAW_STATUS(_ptr)
UCS_PTR_STATUS(_ptr)
UCS_STATUS_PTR(_status)
UCS_STATUS_IS_ERR(_status)

Typedefs

typedef void *ucs_status_ptr_t

Status pointer.

A pointer can represent one of these values:

  • NULL / UCS_OK

  • Error code pointer (UCS_ERR_xx)

  • Valid pointer

Enums

enum ucs_status_t

Status codes.

Note

In order to evaluate the necessary steps to recover from a certain error, all error codes which can be returned by the external API are grouped by the largest entity permanently effected by the error. Each group ranges between its UCS_ERR_FIRST_<name> and UCS_ERR_LAST_<name> enum values. For example, if a link fails it may be sufficient to destroy (and possibly replace) it, in contrast to an endpoint-level error.

Values:

enumerator UCS_OK
enumerator UCS_INPROGRESS
enumerator UCS_ERR_NO_MESSAGE
enumerator UCS_ERR_NO_RESOURCE
enumerator UCS_ERR_IO_ERROR
enumerator UCS_ERR_NO_MEMORY
enumerator UCS_ERR_INVALID_PARAM
enumerator UCS_ERR_UNREACHABLE
enumerator UCS_ERR_INVALID_ADDR
enumerator UCS_ERR_NOT_IMPLEMENTED
enumerator UCS_ERR_MESSAGE_TRUNCATED
enumerator UCS_ERR_NO_PROGRESS
enumerator UCS_ERR_BUFFER_TOO_SMALL
enumerator UCS_ERR_NO_ELEM
enumerator UCS_ERR_SOME_CONNECTS_FAILED
enumerator UCS_ERR_NO_DEVICE
enumerator UCS_ERR_BUSY
enumerator UCS_ERR_CANCELED
enumerator UCS_ERR_SHMEM_SEGMENT
enumerator UCS_ERR_ALREADY_EXISTS
enumerator UCS_ERR_OUT_OF_RANGE
enumerator UCS_ERR_TIMED_OUT
enumerator UCS_ERR_EXCEEDS_LIMIT
enumerator UCS_ERR_UNSUPPORTED
enumerator UCS_ERR_REJECTED
enumerator UCS_ERR_NOT_CONNECTED
enumerator UCS_ERR_CONNECTION_RESET
enumerator UCS_ERR_FIRST_LINK_FAILURE
enumerator UCS_ERR_LAST_LINK_FAILURE
enumerator UCS_ERR_FIRST_ENDPOINT_FAILURE
enumerator UCS_ERR_ENDPOINT_TIMEOUT
enumerator UCS_ERR_LAST_ENDPOINT_FAILURE
enumerator UCS_ERR_LAST

Functions

const char *ucs_status_string(ucs_status_t status)
Parameters

status – UCS status code.

Returns

Verbose status message.