LXR linux/net/tipc/server.h

   1/*
   2 * net/tipc/server.h: Include file for TIPC server code
   3 *
   4 * Copyright (c) 2012-2013, Wind River Systems
   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 are met:
   9 *
  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 * 3. Neither the names of the copyright holders nor the names of its
  16 *    contributors may be used to endorse or promote products derived from
  17 *    this software without specific prior written permission.
  18 *
  19 * Alternatively, this software may be distributed under the terms of the
  20 * GNU General Public License ("GPL") version 2 as published by the Free
  21 * Software Foundation.
  22 *
  23 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
  24 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  25 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  26 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE
  27 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  28 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  29 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  30 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  31 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  32 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  33 * POSSIBILITY OF SUCH DAMAGE.
  34 */
  35
  36#ifndef _TIPC_SERVER_H
  37#define _TIPC_SERVER_H
  38
  39#include "core.h"
  40
  41#define TIPC_SERVER_NAME_LEN    32
  42
  43/**
  44 * struct tipc_server - TIPC server structure
  45 * @conn_idr: identifier set of connection
  46 * @idr_lock: protect the connection identifier set
  47 * @idr_in_use: amount of allocated identifier entry
  48 * @rcvbuf_cache: memory cache of server receive buffer
  49 * @rcv_wq: receive workqueue
  50 * @send_wq: send workqueue
  51 * @max_rcvbuf_size: maximum permitted receive message length
  52 * @tipc_conn_new: callback will be called when new connection is incoming
  53 * @tipc_conn_shutdown: callback will be called when connection is shut down
  54 * @tipc_conn_recvmsg: callback will be called when message arrives
  55 * @saddr: TIPC server address
  56 * @name: server name
  57 * @imp: message importance
  58 * @type: socket type
  59 * @enabled: identify whether server is launched or not
  60 */
  61struct tipc_server {
  62        struct idr conn_idr;
  63        spinlock_t idr_lock;
  64        int idr_in_use;
  65        struct kmem_cache *rcvbuf_cache;
  66        struct workqueue_struct *rcv_wq;
  67        struct workqueue_struct *send_wq;
  68        int max_rcvbuf_size;
  69        void *(*tipc_conn_new) (int conid);
  70        void (*tipc_conn_shutdown) (int conid, void *usr_data);
  71        void (*tipc_conn_recvmsg) (int conid, struct sockaddr_tipc *addr,
  72                                   void *usr_data, void *buf, size_t len);
  73        struct sockaddr_tipc *saddr;
  74        const char name[TIPC_SERVER_NAME_LEN];
  75        int imp;
  76        int type;
  77        int enabled;
  78};
  79
  80int tipc_conn_sendmsg(struct tipc_server *s, int conid,
  81                      struct sockaddr_tipc *addr, void *data, size_t len);
  82
  83/**
  84 * tipc_conn_terminate - terminate connection with server
  85 *
  86 * Note: Must call it in process context since it might sleep
  87 */
  88void tipc_conn_terminate(struct tipc_server *s, int conid);
  89
  90int tipc_server_start(struct tipc_server *s);
  91
  92void tipc_server_stop(struct tipc_server *s);
  93
  94#endif
  95