xref: /freebsd/lib/librpcsec_gss/rpc_gss_svc_max_data_length.3 (revision 2008043f386721d58158e37e0d7e50df8095942d)
1.\" Copyright (c) 2008 Isilon Inc http://www.isilon.com/
2.\" Authors: Doug Rabson <dfr@rabson.org>
3.\" Developed with Red Inc: Alfred Perlstein <alfred@FreeBSD.org>
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.Dd January 26, 2010
26.Dt RPC_GSS_SVC_MAX_DATA_LENGTH 3
27.Os
28.Sh NAME
29.Nm rpc_gss_svc_max_data_length
30.Nd "calculate maximum data size"
31.Sh LIBRARY
32.Lb librpcsec_gss
33.Sh SYNOPSIS
34.In rpc/rpcsec_gss.h
35.Ft int
36.Fn rpc_gss_svc_max_data_length "struct svc_req *req" "int max_tp_unit_len"
37.Sh DESCRIPTION
38Calculate the maximum message size that will fit into a packet of size
39.Fa max_tp_unit_len ,
40given the current service and QoP setting.
41.Sh PARAMETERS
42.Bl -tag -width ".It max_tp_unit_len"
43.It req
44An RPC request
45.It max_tp_unit_len
46Maximum packet size of the underlying transport protocol
47.El
48.Sh RETURN VALUES
49The maximum message size that can be encoded
50.Sh SEE ALSO
51.Xr gssapi 3 ,
52.Xr rpc 3 ,
53.Xr rpcsec_gss 3
54.Sh HISTORY
55The
56.Nm
57function first appeared in
58.Fx 8.0 .
59.Sh AUTHORS
60This
61manual page was written by
62.An Doug Rabson Aq Mt dfr@FreeBSD.org .
63