Where Online Learning is simpler!

The C and C++ Include Header Files

/usr/include/ntirpc/rpc/svc_rqst.h


$ cat -n /usr/include/ntirpc/rpc/svc_rqst.h

     1	/*
     2	 * Copyright (c) 2012 Linux Box Corporation.
     3	 * Copyright (c) 2013-2015 CohortFS, LLC.
     4	 * Copyright (c) 2017 Red Hat, Inc.
     5	 * All rights reserved.
     6	 *
     7	 * Redistribution and use in source and binary forms, with or without
     8	 * modification, are permitted provided that the following conditions
     9	 * are met:
    10	 * 1. Redistributions of source code must retain the above copyright
    11	 *    notice, this list of conditions and the following disclaimer.
    12	 * 2. Redistributions in binary form must reproduce the above copyright
    13	 *    notice, this list of conditions and the following disclaimer in the
    14	 *    documentation and/or other materials provided with the distribution.
    15	 *
    16	 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR `AS IS'' AND ANY EXPRESS OR
    17	 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
    18	 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
    19	 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
    20	 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
    21	 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
    22	 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
    23	 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
    24	 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
    25	 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    26	 */
    27	
    28	/**
    29	 * @file svc_rqst.h
    30	 * @contributeur William Allen Simpson <bill@cohortfs.com>
    31	 * @brief Multi-channel event signal package
    32	 *
    33	 * @section DESCRIPTION
    34	 *
    35	 * Maintains a list of all extant transports by event (channel) id.
    36	 *
    37	 *  svc_rqst_init -- init module; usually called by svc_init()
    38	 *  svc_rqst_new_evchan -- create event channel
    39	 *  svc_rqst_evchan_reg -- set {xprt, dispatcher} mapping
    40	 *  svc_rqst_foreach_xprt -- scan registered xprts at id (or 0 for all)
    41	 *  svc_rqst_thrd_signal -- request thread to run a callout function
    42	 *			 (which can cause the thread to return)
    43	 *  svc_rqst_shutdown -- cause all threads to return
    44	 */
    45	
    46	#ifndef TIRPC_SVC_RQST_H
    47	#define TIRPC_SVC_RQST_H
    48	
    49	#include <rpc/svc.h>
    50	
    51	#define SVC_RQST_FLAG_NONE		SVC_XPRT_FLAG_NONE
    52	/* uint16_t actually used */
    53	#define SVC_RQST_FLAG_SHUTDOWN		SVC_XPRT_FLAG_DESTROYING
    54	#define SVC_RQST_FLAG_XPRT_UREG		SVC_XPRT_FLAG_UREG
    55	#define SVC_RQST_FLAG_CHAN_AFFINITY	0x1000 /* bind conn to parent chan */
    56	#define SVC_RQST_FLAG_MASK (SVC_RQST_FLAG_CHAN_AFFINITY)
    57	
    58	/* uint32_t instructions */
    59	#define SVC_RQST_FLAG_LOCKED		SVC_XPRT_FLAG_LOCKED
    60	#define SVC_RQST_FLAG_UNLOCK		SVC_XPRT_FLAG_UNLOCK
    61	#define SVC_RQST_FLAG_EPOLL		0x00080000
    62	
    63	void svc_rqst_init(uint32_t);
    64	int svc_rqst_new_evchan(uint32_t *chan_id /* OUT */ , void *u_data,
    65				uint32_t flags);
    66	int svc_rqst_evchan_reg(uint32_t chan_id, SVCXPRT *xprt, uint32_t flags);
    67	
    68	int svc_rqst_thrd_signal(uint32_t chan_id, uint32_t flags);
    69	void svc_rqst_shutdown(void);
    70	
    71	/* iterator callback prototype */
    72	typedef void (*svc_rqst_xprt_each_func_t) (uint32_t chan_id, SVCXPRT *xprt,
    73						   void *arg);
    74	int svc_rqst_foreach_xprt(uint32_t chan_id, svc_rqst_xprt_each_func_t each_f,
    75				  void *arg);
    76	
    77	
    78	#endif				/* TIRPC_SVC_RQST_H */