/*********************************************************************************
 * PROJECT: MiMic
 * --------------------------------------------------------------------------------
 *
 * This file is part of MiMic
 * Copyright (C)2011 Ryo Iizuka
 *
 * MiMic is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published
 * by　the Free Software Foundation, either version 3 of the　License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * For further information please contact.
 *	http://nyatla.jp/
 *	<airmail(at)ebony.plala.or.jp> or <nyatla(at)nyatla.jp>
 *
 *
 * Parts of this file were leveraged from uIP:
 *
 * Copyright (c) 2001-2003, Adam Dunkels.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. The name of the author may not be used to endorse or promote
 *    products derived from this software without specific prior
 *    written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */
#ifndef NyLPC_TcUipService_H_
#define NyLPC_TcUipService_H_


/**********************************************************************
 * Heder files
 **********************************************************************/

#include "NyLPC_cTcpSocket.h"
#include "NyLPC_cTcpListener.h"
#include "NyLPC_cIPv4IComp.h"
#include "NyLPC_cIPv4Arp.h"
#include "NyLPC_cIPv4.h"

#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */

/**********************************************************************
 *
 * NyLPC_TcUipService class
 *
 **********************************************************************/
/**
 * uipタスクを管理する、サービスクラスです。
 */
typedef struct NyLPC_TcUipService NyLPC_TcUipService_t;


/** サービスタスクスタックサイズ
 *  LPCXpressonなら256バイトで動くけど、Mbedだと256+96
 */
#define NyLPC_TcUipService_config_STACK_SIZE (256+96)
/** 登録できるリスナの最大数*/
#define NyLPC_TcUipService_config_MAX_LISTENER 4




/**
 * \param i_mac_addr
 * システムで唯一のUIPサービスを初期化します。1度だけ実行できます。
 */
NyLPC_TBool NyLPC_cUipService_initialize(void);

/**
 * 処理を開始します。
 * この関数はリエントラントではありません。複数のタスクから共有するときには、排他ロックを掛けてください。
 * @param i_ref_config
 * このコンフィギュレーションは、stopを実行するまでの間、インスタンスから参照します。外部で保持してください。
 */
void NyLPC_cUipService_start(const NyLPC_TcIPv4Config_t* i_ref_config);

/**
 * UIP処理を停止します。
 * この関数はリエントラントではありません。複数のタスクから共有するときには、排他ロックを掛けてください。
 * 関数を使用する前に、全ての非同期ソケット操作を停止してください。
 */
void NyLPC_cUipService_stop(void);

/**
 * イーサネットデバイスの名前を返します。
 * この関数は、サービスが開始されているときのみ、動作します。
 */
const char* NyLPC_cUipService_refDeviceName(void);
const NyLPC_TcIPv4Config_t* NyLPC_cUipService_refCurrentConfig(void);

#ifdef __cplusplus
}
#endif /* __cplusplus */

#endif
