Subversion Repositories HelenOS

Rev

Rev 3912 | Go to most recent revision | Blame | Compare with Previous | Last modification | View Log | Download | RSS feed

  1. /*
  2.  * Copyright (c) 2009 Lukas Mejdrech
  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.  *
  9.  * - Redistributions of source code must retain the above copyright
  10.  *   notice, this list of conditions and the following disclaimer.
  11.  * - Redistributions in binary form must reproduce the above copyright
  12.  *   notice, this list of conditions and the following disclaimer in the
  13.  *   documentation and/or other materials provided with the distribution.
  14.  * - The name of the author may not be used to endorse or promote products
  15.  *   derived from this software without specific prior written permission.
  16.  *
  17.  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18.  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20.  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21.  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22.  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23.  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24.  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26.  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27.  */
  28.  
  29. /** @addtogroup packet
  30.  *  @{
  31.  */
  32.  
  33. /** @file
  34.  *  Packet server.
  35.  *  The hosting module has to be compiled with both the packet.c and the packet_server.c source files.
  36.  *  To function correctly, initialization of the packet map by the pm_init() function has to happen at the first place.
  37.  *  Then the packet messages have to be processed by the packet_server_message() function.
  38.  *  The packet map should be released by the pm_destroy() function during the module termination.
  39.  *  @see IS_NET_PACKET_MESSAGE()
  40.  */
  41.  
  42. #ifndef __NET_PACKET_SERVER_H__
  43. #define __NET_PACKET_SERVER_H__
  44.  
  45. #include <ipc/ipc.h>
  46.  
  47. /** Processes the packet server message.
  48.  *  @param callid The message identifier. Input parameter.
  49.  *  @param call The message parameters. Input parameter.
  50.  *  @param answer The message answer parameters. Output parameter.
  51.  *  @param answer_count The last parameter for the actual answer in the answer parameter. Output parameter.
  52.  *  @returns EOK on success.
  53.  *  @returns ENOMEM if there is not enough memory left.
  54.  *  @returns ENOENT if there is no such packet as in the packet message parameter..
  55.  *  @returns ENOTSUP if the message is not known.
  56.  *  @returns Other error codes as defined for the packet_release_wrapper() function.
  57.  */
  58. int packet_server_message( ipc_callid_t callid, ipc_call_t * call, ipc_call_t * answer, int * answer_count );
  59.  
  60. #endif
  61.  
  62. /** @}
  63.  */
  64.