Program Listing for File ecal_callback.h

↰ Return to documentation for file (ecal/core/include/ecal/ecal_callback.h)

/* ========================= eCAL LICENSE =================================
 *
 * Copyright (C) 2016 - 2019 Continental Corporation
 *
 * 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.
 *
 * ========================= eCAL LICENSE =================================
*/

#pragma once

#include <ecal/ecal_deprecate.h>
#include <ecal/cimpl/ecal_callback_cimpl.h>
#include <ecal/ecal_types.h>

#include <functional>
#include <string>

namespace eCAL
{
  struct SReceiveCallbackData
  {
    void*     buf   = nullptr;
    long      size  = 0;
    long long id    = 0;
    long long time  = 0;
    long long clock = 0;
  };

  struct SPubEventCallbackData
  {
    SPubEventCallbackData()
    {
      type  = pub_event_none;
      time  = 0;
      clock = 0;
    };
    eCAL_Publisher_Event type;
    long long            time;
    long long            clock;
    std::string          tid;
    ECAL_DEPRECATE_SINCE_5_13("Use the separate infos encoding and type in member tdatatype instead of ttype.")
    std::string          ttype;
    ECAL_DEPRECATE_SINCE_5_13("Use the tdatatype.descriptor instead of tdesc.")
    std::string          tdesc;
    SDataTypeInformation tdatatype;
  };

  struct SSubEventCallbackData
  {
    SSubEventCallbackData()
    {
      type  = sub_event_none;
      time  = 0;
      clock = 0;
    };
    eCAL_Subscriber_Event type;
    long long             time;
    long long             clock;
    std::string           tid;
    ECAL_DEPRECATE_SINCE_5_13("Use the separate infos encoding and type in member tdatatype instead of ttype.")
    std::string           ttype;
    ECAL_DEPRECATE_SINCE_5_13("Use the tdatatype.descriptor instead of tdesc.")
    std::string           tdesc;
    SDataTypeInformation  tdatatype;
  };

  struct SServiceAttr
  {
    std::string    key;
    std::string    hname;
    std::string    pname;
    std::string    uname;
    std::string    sname;
    std::string    sid;
    int            pid         = 0;

    // internal protocol specifics
    unsigned int   version     = 0;
    unsigned short tcp_port_v0 = 0;
    unsigned short tcp_port_v1 = 0;
  };

  struct SClientEventCallbackData
  {
    eCAL_Client_Event type = client_event_none;
    long long         time = 0;
    SServiceAttr      attr;
  };

  struct SClientAttr
  {
    std::string    key;
    std::string    hname;
    std::string    pname;
    std::string    uname;
    std::string    sname;
    std::string    sid;
    int            pid = 0;

    unsigned int   version = 0;
  };

  struct SServerEventCallbackData
  {
    eCAL_Server_Event type = server_event_none;
    long long         time = 0;
  };

  using ReceiveCallbackT = std::function<void (const char *, const struct SReceiveCallbackData *)>;

  using TimerCallbackT = std::function<void ()>;

  using RegistrationCallbackT = std::function<void (const char *, int)>;

  using PubEventCallbackT = std::function<void (const char *, const struct SPubEventCallbackData *)>;

  using SubEventCallbackT = std::function<void (const char *, const struct SSubEventCallbackData *)>;

  using ClientEventCallbackT = std::function<void (const char *, const struct SClientEventCallbackData *)>;

  using ServerEventCallbackT = std::function<void (const char *, const struct SServerEventCallbackData *)>;
}