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_CLIENT_H_
#define RDMNET_CLIENT_H_
 
#include <stdbool.h>
#include <stdint.h>
#include "etcpal/inet.h"
#include "etcpal/uuid.h"
#include "rdm/uid.h"
#include "rdmnet/common.h"
 
typedef int rdmnet_client_scope_t;
#define RDMNET_CLIENT_SCOPE_INVALID -1
 
typedef enum
{
  kRdmnetClientListAppend = VECTOR_BROKER_CLIENT_ADD,
  kRdmnetClientListRemove = VECTOR_BROKER_CLIENT_REMOVE,
  kRdmnetClientListUpdate = VECTOR_BROKER_CLIENT_ENTRY_CHANGE,
  kRdmnetClientListReplace = VECTOR_BROKER_CONNECTED_CLIENT_LIST
} client_list_action_t;
 
typedef struct RdmnetSourceAddr
{
  uint16_t source_endpoint;
  RdmUid rdm_source_uid;
  uint16_t subdevice;
} RdmnetSourceAddr;
 
typedef struct RdmnetDestinationAddr
{
  RdmUid rdmnet_uid;
  uint16_t endpoint;
  RdmUid rdm_uid;
  uint16_t subdevice;
} RdmnetDestinationAddr;
 
#define RDMNET_ADDR_TO_DEFAULT_RESPONDER(manu_id, dev_id)               \
  {                                                                     \
    {(manu_id), (dev_id)}, E133_NULL_ENDPOINT, {(manu_id), (dev_id)}, 0 \
  }
 
#define RDMNET_ADDR_TO_DEFAULT_RESPONDER_SUBDEV(manu_id, dev_id, subdevice)       \
  {                                                                               \
    {(manu_id), (dev_id)}, E133_NULL_ENDPOINT, {(manu_id), (dev_id)}, (subdevice) \
  }
 
#define RDMNET_ADDR_TO_SUB_RESPONDER(rdmnet_manu, rdmnet_dev, endpoint, rdm_manu, rdm_dev) \
  {                                                                                        \
    {(rdmnet_manu), (rdmnet_dev)}, (endpoint), {(rdm_manu), (rdm_dev)}, 0                  \
  }
 
#define RDMNET_ADDR_TO_SUB_RESPONDER_SUBDEV(rdmnet_manu, rdmnet_dev, endpoint, rdm_manu, rdm_dev, subdevice) \
  {                                                                                                          \
    {(rdmnet_manu), (rdmnet_dev)}, (endpoint), {(rdm_manu), (rdm_dev)}, (subdevice)                          \
  }
 
typedef struct RdmnetClientConnectedInfo
{
  EtcPalSockAddr broker_addr;
  const char* broker_name;
  EtcPalUuid broker_cid;
  RdmUid broker_uid;
} RdmnetClientConnectedInfo;
 
typedef struct RdmnetClientConnectFailedInfo
{
  rdmnet_connect_fail_event_t event;
  etcpal_error_t socket_err;
  rdmnet_connect_status_t rdmnet_reason;
  bool will_retry;
} RdmnetClientConnectFailedInfo;
 
typedef struct RdmnetClientDisconnectedInfo
{
  rdmnet_disconnect_event_t event;
  etcpal_error_t socket_err;
  rdmnet_disconnect_reason_t rdmnet_reason;
  bool will_retry;
} RdmnetClientDisconnectedInfo;
 
typedef struct RdmnetScopeConfig
{
  const char* scope;
  EtcPalSockAddr static_broker_addr;
} RdmnetScopeConfig;
 
#define RDMNET_SCOPE_CONFIG_DEFAULT_INIT              \
  {                                                   \
    E133_DEFAULT_SCOPE, { 0, ETCPAL_IP_INVALID_INIT } \
  }
 
#define RDMNET_CLIENT_SET_SCOPE(configptr, scope_str)           \
  if (configptr)                                                \
  {                                                             \
    (configptr)->scope = scope_str;                             \
    ETCPAL_IP_SET_INVALID(&(configptr)->static_broker_addr.ip); \
  }
 
#define RDMNET_CLIENT_SET_DEFAULT_SCOPE(configptr)              \
  if (configptr)                                                \
  {                                                             \
    (configptr)->scope = E133_DEFAULT_SCOPE;                    \
    ETCPAL_IP_SET_INVALID(&(configptr)->static_broker_addr.ip); \
  }
 
#define RDMNET_CLIENT_SET_STATIC_SCOPE(configptr, scope_str, broker_addr) \
  if (configptr)                                                          \
  {                                                                       \
    (configptr)->scope = (scope_str);                                     \
    (configptr)->static_broker_addr = (broker_addr);                      \
  }
 
#define RDMNET_CLIENT_SET_STATIC_DEFAULT_SCOPE(configptr, broker_addr) \
  if (configptr)                                                       \
  {                                                                    \
    (configptr)->scope = E133_DEFAULT_SCOPE;                           \
    (configptr)->static_broker_addr = (broker_addr);                   \
  }
 
#endif /* RDMNET_CLIENT_H_ */