lib/libsysdecode/sysdecode_sctp_sinfo_flags.3

   1 .\"
   2 .\" Copyright (c) 2018 Michael Tuexen <tuexen@FreeBSD.org>
   3 .\" All rights reserved.
   4 .\"
   5 .\" Redistribution and use in source and binary forms, with or without
   6 .\" modification, are permitted provided that the following conditions
   7 .\" are met:
   8 .\" 1. Redistributions of source code must retain the above copyright
   9 .\"    notice, this list of conditions and the following disclaimer.
  10 .\" 2. Redistributions in binary form must reproduce the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer in the
  12 .\"    documentation and/or other materials provided with the distribution.
  13 .\"
  14 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24 .\" SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD$
  27 .\"
  28 .Dd January 14, 2018
  29 .Dt sysdecode_sctp_sinfo_flags 3
  30 .Os
  31 .Sh NAME
  32 .Nm sysdecode_sctp_sinfo_flags
  33 .Nd output textual description of the sinfo_flags field of struct sctp_sndrcvinfo
  34 .Sh LIBRARY
  35 .Lb libsysdecode
  36 .Sh SYNOPSIS
  37 .In sys/types.h
  38 .In stdbool.h
  39 .In stdio.h
  40 .In sysdecode.h
  41 .Ft void
  42 .Fn sysdecode_sctp_sinfo_flags "FILE *fp" "int sinfo_flags"
  43 .Sh DESCRIPTION
  44 The
  45 .Fn sysdecode_sctp_sinfo_flags
  46 function outputs a textual description of the
  47 .Fa sinfo_flags
  48 member of a
  49 .Vt struct sctp_sndrcvinfo
  50 to the stream
  51 .Fa fp .
  52 In particular, the embedded PR-SCTP policies are handled.
  53 .Sh SEE ALSO
  54 .Xr sysdecode 3
  55 .Xr sysdecode_sctp_pr_policy 3