ept_client.h

Go to the documentation of this file.

/******************************************************************************
 * Copyright 2020 ETC Inc.
 *
 * 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.
 ******************************************************************************
 * This file is a part of RDMnet. For more information, go to:
 * https://github.com/ETCLabs/RDMnet
 *****************************************************************************/
 
#ifndef RDMNET_EPT_CLIENT_H_
#define RDMNET_EPT_CLIENT_H_
 
#include "etcpal/uuid.h"
#include "rdmnet/client.h"
#include "rdmnet/common.h"
#include "rdmnet/message.h"
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef int rdmnet_ept_client_t;
#define RDMNET_EPT_CLIENT_INVALID -1
 
typedef void (*RdmnetEptClientConnectedCallback)(rdmnet_ept_client_t              client_handle,
                                                 rdmnet_client_scope_t            scope_handle,
                                                 const RdmnetClientConnectedInfo* info,
                                                 void*                            context);
 
typedef void (*RdmnetEptClientConnectFailedCallback)(rdmnet_ept_client_t                  client_handle,
                                                     rdmnet_client_scope_t                scope_handle,
                                                     const RdmnetClientConnectFailedInfo* info,
                                                     void*                                context);
 
typedef void (*RdmnetEptClientDisconnectedCallback)(rdmnet_ept_client_t                 client_handle,
                                                    rdmnet_client_scope_t               scope_handle,
                                                    const RdmnetClientDisconnectedInfo* info,
                                                    void*                               context);
 
typedef void (*RdmnetEptClientClientListUpdateReceivedCallback)(rdmnet_ept_client_t        client_handle,
                                                                rdmnet_client_scope_t      scope_handle,
                                                                client_list_action_t       list_action,
                                                                const RdmnetEptClientList* client_list,
                                                                void*                      context);
 
typedef void (*RdmnetEptClientDataReceivedCallback)(rdmnet_ept_client_t    client_handle,
                                                    rdmnet_client_scope_t  scope_handle,
                                                    const RdmnetEptData*   data,
                                                    RdmnetSyncEptResponse* response,
                                                    void*                  context);
 
typedef void (*RdmnetEptClientStatusReceivedCallback)(rdmnet_ept_client_t    client_handle,
                                                      rdmnet_client_scope_t  scope_handle,
                                                      const RdmnetEptStatus* status,
                                                      void*                  context);
 
typedef struct RdmnetEptClientCallbacks
{
  RdmnetEptClientConnectedCallback                connected;                   
  RdmnetEptClientConnectFailedCallback            connect_failed;              
  RdmnetEptClientDisconnectedCallback             disconnected;                
  RdmnetEptClientClientListUpdateReceivedCallback client_list_update_received; 
  RdmnetEptClientDataReceivedCallback             data_received;               
  RdmnetEptClientStatusReceivedCallback           status_received;             
  void* context; 
} RdmnetEptClientCallbacks;
 
typedef struct RdmnetEptClientConfig
{
  /************************************************************************************************
   * Required Values
   ***********************************************************************************************/
 
  EtcPalUuid cid;
  RdmnetEptClientCallbacks callbacks;
  const RdmnetEptSubProtocol* protocols;
  size_t num_protocols;
 
  /************************************************************************************************
   * Optional Values
   ***********************************************************************************************/
 
  uint8_t* response_buf;
 
  const char* search_domain;
} RdmnetEptClientConfig;
 
#define RDMNET_EPT_CLIENT_CONFIG_DEFAULT_INIT                              \
  {                                                                        \
    {{0}}, {NULL, NULL, NULL, NULL, NULL, NULL, NULL}, NULL, 0, NULL, NULL \
  }
 
void rdmnet_ept_client_config_init(RdmnetEptClientConfig* config);
void rdmnet_ept_client_set_callbacks(RdmnetEptClientConfig*                          config,
                                     RdmnetEptClientConnectedCallback                connected,
                                     RdmnetEptClientConnectFailedCallback            connect_failed,
                                     RdmnetEptClientDisconnectedCallback             disconnected,
                                     RdmnetEptClientClientListUpdateReceivedCallback client_list_update_received,
                                     RdmnetEptClientDataReceivedCallback             data_received,
                                     RdmnetEptClientStatusReceivedCallback           status_received,
                                     void*                                           context);
 
etcpal_error_t rdmnet_ept_client_create(const RdmnetEptClientConfig* config, rdmnet_ept_client_t* handle);
etcpal_error_t rdmnet_ept_client_destroy(rdmnet_ept_client_t        client_handle,
                                         rdmnet_disconnect_reason_t disconnect_reason);
 
etcpal_error_t rdmnet_ept_client_add_scope(rdmnet_ept_client_t      client_handle,
                                           const RdmnetScopeConfig* scope_config,
                                           rdmnet_client_scope_t*   scope_handle);
etcpal_error_t rdmnet_ept_client_add_default_scope(rdmnet_ept_client_t    client_handle,
                                                   rdmnet_client_scope_t* scope_handle);
etcpal_error_t rdmnet_ept_client_remove_scope(rdmnet_ept_client_t        client_handle,
                                              rdmnet_client_scope_t      scope_handle,
                                              rdmnet_disconnect_reason_t disconnect_reason);
etcpal_error_t rdmnet_ept_client_change_scope(rdmnet_ept_client_t        client_handle,
                                              rdmnet_client_scope_t      scope_handle,
                                              const RdmnetScopeConfig*   new_scope_config,
                                              rdmnet_disconnect_reason_t disconnect_reason);
etcpal_error_t rdmnet_ept_client_get_scope(rdmnet_ept_client_t   client_handle,
                                           rdmnet_client_scope_t scope_handle,
                                           char*                 scope_str_buf,
                                           EtcPalSockAddr*       static_broker_addr);
 
etcpal_error_t rdmnet_ept_client_request_client_list(rdmnet_ept_client_t   client_handle,
                                                     rdmnet_client_scope_t scope_handle);
 
etcpal_error_t rdmnet_ept_client_send_data(rdmnet_ept_client_t   client_handle,
                                           rdmnet_client_scope_t scope_handle,
                                           const EtcPalUuid*     dest_cid,
                                           uint16_t              manufacturer_id,
                                           uint16_t              protocol_id,
                                           const uint8_t*        data,
                                           size_t                data_len);
etcpal_error_t rdmnet_ept_client_send_status(rdmnet_ept_client_t   client_handle,
                                             rdmnet_client_scope_t scope_handle,
                                             const EtcPalUuid*     dest_cid,
                                             ept_status_code_t     status_code,
                                             const char*           status_string);
 
#ifdef __cplusplus
};
#endif
 
#endif /* RDMNET_EPT_CLIENT_H_ */