src/helper/natblaster_helper.h

   1 /*****************************************************************************
   2  * Copyright 2005 Daniel Ferullo                                             *
   3  *                                                                           *
   4  * Licensed under the Apache License, Version 2.0 (the "License");           *
   5  * you may not use this file except in compliance with the License.          *
   6  * You may obtain a copy of the License at                                   *
   7  *                                                                           *
   8  *    http://www.apache.org/licenses/LICENSE-2.0                             *
   9  *                                                                           *
  10  * Unless required by applicable law or agreed to in writing, software       *
  11  * distributed under the License is distributed on an "AS IS" BASIS,         *
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  *
  13  * See the License for the specific language governing permissions and       *
  14  * limitations under the License.                                            *
  15  *                                                                           *
  16  *****************************************************************************/
  17
  18 /**
  19  * @file natblaster_helper.h
  20  * @author Daniel Ferullo (ferullo@cmu.edu)
  21  *
  22  * @brief prototype for helper natblaster entrypoint
  23  */
  24
  25 #ifndef __NATBLASTER_HELPER_H__
  26 #define __NATBlASTER_HELPER_H__
  27
  28 #include "def.h"
  29
  30 /**
  31  * @brief the single function to start a helper application
  32  *
  33  * Does not return on success!
  34  *
  35  * @param listen_port the port to act as a thrid party server on
  36  *
  37  * @return Never returns on success, errorcode on failure.
  38  */
  39 int natblaster_server(port_t listen_port);
  40
  41 #endif /* __NATBLASTER_HELPER_H__ */
  42