.\" Man page generated from reStructuredText
.\" by the Docutils 0.23 manpage writer.
.
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.TH "PMIX_LINK_STATE_T" "5" "Sep 27, 2026" "" "OpenPMIx"
.sp
\fIpmix_link_state_t\fP — Describes the state of a fabric device port
.SH SYNTAX
.SS C Syntax
.INDENT 0.0
.INDENT 3.5
.sp
.EX
#include <pmix_common.h>

typedef uint8_t pmix_link_state_t;

#define PMIX_LINK_STATE_UNKNOWN     0
#define PMIX_LINK_DOWN              1
#define PMIX_LINK_UP                2
.EE
.UNINDENT
.UNINDENT
.SH DESCRIPTION
.sp
The \fIpmix_link_state_t\fP type is an 8\-bit unsigned integer describing the last
available physical port state of a fabric device. It takes one of the
following values:
.INDENT 0.0
.TP
.B \fBPMIX_LINK_STATE_UNKNOWN\fP (0)
The port state is unknown or not applicable.
.TP
.B \fBPMIX_LINK_DOWN\fP (1)
The port is inactive.
.TP
.B \fBPMIX_LINK_UP\fP (2)
The port is active.
.UNINDENT
.sp
A link state is conveyed, for example, via the \fBPMIX_FABRIC_DEVICE_STATE\fP
attribute. The
PMIx_Link_state_string(3) \%<#\:man3-pmix-link-state-string> function
returns a string representation of a \fIpmix_link_state_t\fP value.
.sp
\fBSee also:\fP
.INDENT 0.0
.INDENT 3.5
PMIx_Link_state_string(3) \%<#\:man3-pmix-link-state-string>,
PMIx_Fabric_register(3) \%<#\:man3-pmix-fabric-register>,
pmix_info_t(5) \%<#\:man5-pmix-info-t>
.UNINDENT
.UNINDENT
.SH Copyright
2014-2026, OpenPMIx Community
.\" End of generated man page.
