StreamingClient.h

Go to the documentation of this file.

/*
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 *
 * StreamingClient.h
 * Interface to the Streaming Client class.
 * Copyright (C) 2005 Simon Newton
 */
#ifndef INCLUDE_OLA_CLIENT_STREAMINGCLIENT_H_
#define INCLUDE_OLA_CLIENT_STREAMINGCLIENT_H_

#include <ola/Constants.h>
#include <ola/DmxBuffer.h>
#include <ola/base/Macro.h>
#include <ola/dmx/SourcePriorities.h>

namespace ola {

namespace io { class SelectServer; }
namespace network { class TCPSocket; }
namespace proto { class OlaServerService_Stub; }
namespace rpc {
class RpcChannel;
class RpcSession;
}

namespace client {

class StreamingClientInterface {
 public:
  class SendArgs {
   public:
    uint8_t priority;

    SendArgs() : priority(ola::dmx::SOURCE_PRIORITY_DEFAULT) {}
  };

  virtual ~StreamingClientInterface() {}

  virtual bool Setup() = 0;

  virtual void Stop() = 0;

  virtual bool SendDmx(unsigned int universe, const DmxBuffer &data) = 0;

  virtual bool SendDMX(unsigned int universe,
                       const DmxBuffer &data,
                       const SendArgs &args) = 0;
};

class StreamingClient : public StreamingClientInterface {
 public:
  class Options {
   public:
    Options() : auto_start(true), server_port(OLA_DEFAULT_PORT) {}

    bool auto_start;

    uint16_t server_port;
  };

  explicit StreamingClient(bool auto_start = true);

  explicit StreamingClient(const Options &options);

  ~StreamingClient();

  bool Setup();

  void Stop();

  bool SendDmx(unsigned int universe, const DmxBuffer &data);

  bool SendDMX(unsigned int universe,
               const DmxBuffer &data,
               const SendArgs &args);

  void ChannelClosed(ola::rpc::RpcSession *session);

 private:
  bool m_auto_start;
  uint16_t m_server_port;
  ola::network::TCPSocket *m_socket;
  ola::io::SelectServer *m_ss;
  class ola::rpc::RpcChannel *m_channel;
  class ola::proto::OlaServerService_Stub *m_stub;
  bool m_socket_closed;

  bool Send(unsigned int universe, uint8_t priority, const DmxBuffer &data);

  DISALLOW_COPY_AND_ASSIGN(StreamingClient);
};
}  // namespace client
}  // namespace ola
#endif  // INCLUDE_OLA_CLIENT_STREAMINGCLIENT_H_