fnet_telnet.h

/**************************************************************************
*
* Copyright 2008-2018 by Andrey Butok. FNET Community.
*
***************************************************************************
*
*  Licensed under the Apache License, Version 2.0 (the "License"); you may
*  not use this file except in compliance with the License.
*  You may obtain a copy of the License at
*
*  http://www.apache.org/licenses/LICENSE-2.0
*
*  Unless required by applicable law or agreed to in writing, software
*  distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
*  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*  See the License for the specific language governing permissions and
*  limitations under the License.
*
***************************************************************************
*
*  FNET Telnet Server API.
*
***************************************************************************/

#ifndef _FNET_TELNET_H_

#define _FNET_TELNET_H_

#if FNET_CFG_TELNET || defined(__DOXYGEN__)

/**************************************************************************/ 
typedef struct
{
    struct fnet_sockaddr address;    
    const fnet_shell_t *shell;     
} fnet_telnet_params_t;

/**************************************************************************/ 
typedef void *fnet_telnet_desc_t;

#if defined(__cplusplus)
extern "C" {
#endif

/***************************************************************************/ 
fnet_telnet_desc_t fnet_telnet_init( fnet_telnet_params_t *params);

/***************************************************************************/ 
void fnet_telnet_release(fnet_telnet_desc_t desc);

/***************************************************************************/ 
void fnet_telnet_close_session(fnet_telnet_desc_t desc);

/***************************************************************************/ 
fnet_bool_t fnet_telnet_is_enabled(fnet_telnet_desc_t desc);

#if defined(__cplusplus)
}
#endif

#endif  /* FNET_CFG_TELNET */

#endif  /* _FNET_TELNET_H_ */