/*----------------------------------------------------------------------------
 * Copyright IBM Corp. 2015, 2015 All Rights Reserved
 * 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.
 * ---------------------------------------------------------------------------
 */

/*============================================================================
 DD-MMM-2014    eranr      Initial implementation as sChannel.
                           Introducing wrapping structures.
 20-Jun-2014    evgenyl    Switching to SBus. Code refactoring.
                           Simplifying API. Removing business logic.
 ===========================================================================*/

#ifndef schannel_h
#define schannel_h

/*======================= API declarations =================================*/

/*----------------------------------------------------------------------------
 * start/halt logging
 */
extern void sbus_start_logger( const char* str_log_level,  const char* container_id);
extern void sbus_stop_logger(  void );

/*----------------------------------------------------------------------------
 * sbus_create
 * create an instance of SBus object
 * returns -1 on error, SBus handler on success
 */
extern int sbus_create( const char* str_sbus_path );

/*----------------------------------------------------------------------------
 * sbus_listen
 * Suspend the
 * returns -1 on error, 0 on success
 */
extern int sbus_listen( int n_sbus_handle );

/*----------------------------------------------------------------------------
 * sbus_recv_msg
 * reads the data, allocates memory for the necessary buffers
 * See sbus_send_msg for the extended description of arguments
 *
 * Caller shall clean up the buffers to avoid memory leaks
 */
extern int sbus_recv_msg( int    n_sbus_handler,
                          int**  pp_files,
                          int*   pn_files,
                          char** pstr_files_metadata,
                          int*   pn_files_metadata_len,
                          char** pstr_msg_data,
                          int*   pn_msg_len );

/*----------------------------------------------------------------------------
 * sbus_send_msg
 * sends the message in predefined format
 *
 * arguments:
 * str_sbus_path        - SBus path
 * p_files              - array of actual system file descriptors, and...
 * n_files              - its length
 * str_files_metadata   - JSON-encoded string with the metadata
 *                        for the previous array, and
 * n_files_metadata_len - string length
 * str_msg_data         - the message, JSON-encoded string
 * n_msg_len            - length of the above
 */
extern int sbus_send_msg( const char* str_sbus_path,
                          const int*  p_files,
                          int         n_files,
                          const char* str_files_metadata,
                          int         n_files_metadata_len,
                          const char* str_msg_data,
                          int         n_msg_len );

#endif
/*========================= END OF FILE ======================================*/