12063 Convert free_rtn(9S) to mandoc
1 .\" Copyright 2018, Joyent, Inc. 2 .\" Copyright (c) 2000, Sun Microsystems, Inc. All Rights Reserved. 3 .\" Copyright 1989 AT&T 4 .\" The contents of this file are subject to the terms of the 5 .\" Common Development and Distribution License (the "License"). 6 .\" You may not use this file except in compliance with the License. 7 .\" 8 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE 9 .\" or http://www.opensolaris.org/os/licensing. 10 .\" See the License for the specific language governing permissions 11 .\" and limitations under the License. 12 .\" 13 .\" When distributing Covered Code, include this CDDL HEADER in each 14 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE. 15 .\" If applicable, add the following below this CDDL HEADER, with the 16 .\" fields enclosed by brackets "[]" replaced with your own identifying 17 .\" information: Portions Copyright [yyyy] [name of copyright owner] 18 .Dd July 9, 2018 19 .Dt FREE_RTN 9S 20 .Os 21 .Sh NAME 22 .Nm free_rtn 23 .Nd structure that specifies a driver's message-freeing routine 24 .Sh SYNOPSIS 25 .In sys/stream.h 26 .Sh INTERFACE LEVEL 27 Architecture independent level 1 (DDI/DKI). 28 .Sh DESCRIPTION 29 The 30 .Vt free_rtn 31 structure is referenced by the 32 .Vt datab 33 structure. 34 When 35 .Xr freeb 9F 36 is called to free the message, the driver's message-freeing 37 routine (referenced through the 38 .Vt free_rtn 39 structure) is called, with arguments, to free the data buffer. 40 .Sh STRUCTURE MEMBERS 41 .Bd -literal -offset 2n 42 void (*free_func)() /* user's freeing routine */ 43 char *free_arg /* arguments to free_func() */ 44 .Ed 45 .Pp 46 The 47 .Vt free_rtn 48 structure is defined as type 49 .Vt frtn_t . 50 .Sh SEE ALSO 51 .Xr esballoc 9F , 52 .Xr freeb 9F , 53 .Xr datab 9S 54 .Rs 55 .%T STREAMS Programming Guide 56 .Re --- EOF ---