ZmqLogger.cpp
Go to the documentation of this file.
/**
* @file
* @brief Source file for ZeroMQ-based Logger class
* @author Jonathan Thomas <jonathan@openshot.org>
*
* @ref License
*/
/* LICENSE
*
* Copyright (c) 2008-2019 OpenShot Studios, LLC
* <http://www.openshotstudios.com/>. This file is part of
* OpenShot Library (libopenshot), an open-source project dedicated to
* delivering high quality video editing and animation solutions to the
* world. For more information visit <http://www.openshot.org/>.
*
* OpenShot Library (libopenshot) 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 3 of the
* License, or (at your option) any later version.
*
* OpenShot Library (libopenshot) 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 OpenShot Library. If not, see <http://www.gnu.org/licenses/>.
*/
#include "../include/ZmqLogger.h"
#if USE_RESVG == 1
#include "ResvgQt.h"
#endif
using namespace std;
using namespace openshot;
// Global reference to logger
ZmqLogger *ZmqLogger::m_pInstance = NULL;
// Create or Get an instance of the logger singleton
ZmqLogger *ZmqLogger::Instance()
{
if (!m_pInstance) {
// Create the actual instance of logger only once
m_pInstance = new ZmqLogger;
// init ZMQ variables
m_pInstance->context = NULL;
m_pInstance->publisher = NULL;
m_pInstance->connection = "";
// Default connection
m_pInstance->Connection("tcp://*:5556");
// Init enabled to False (force user to call Enable())
m_pInstance->enabled = false;
#if USE_RESVG == 1
// Init resvg logging (if needed)
// This can only happen 1 time or it will crash
ResvgRenderer::initLog();
#endif
}
return m_pInstance;
}
// Set the connection for this logger
void ZmqLogger::Connection(string new_connection)
{
// Create a scoped lock, allowing only a single thread to run the following code at one time
const GenericScopedLock<CriticalSection> lock(loggerCriticalSection);
// Does anything need to happen?
if (new_connection == connection)
return;
else
// Set new connection
connection = new_connection;
if (context == NULL) {
// Create ZMQ Context
context = new zmq::context_t(1);
}
if (publisher != NULL) {
// Close an existing bound publisher socket
publisher->close();
publisher = NULL;
}
// Create new publisher instance
publisher = new zmq::socket_t(*context, ZMQ_PUB);
// Bind to the socket
try {
publisher->bind(connection.c_str());
} catch (zmq::error_t &e) {
cout << "ZmqLogger::Connection - Error binding to " << connection << ". Switching to an available port." << endl;
connection = "tcp://*:*";
publisher->bind(connection.c_str());
}
// Sleeping to allow connection to wake up (0.25 seconds)
usleep(250000);
}
void ZmqLogger::Log(string message)
{
if (!enabled)
// Don't do anything
return;
// Create a scoped lock, allowing only a single thread to run the following code at one time
const GenericScopedLock<CriticalSection> lock(loggerCriticalSection);
// Send message over socket (ZeroMQ)
zmq::message_t reply (message.length());
memcpy (reply.data(), message.c_str(), message.length());
publisher->send(reply);
// Write to log file (if opened, and force it to write to disk in case of a crash)
if (log_file.is_open())
log_file << message << std::flush;
}
// Log message to a file (if path set)
void ZmqLogger::LogToFile(string message)
{
// Write to log file (if opened, and force it to write to disk in case of a crash)
if (log_file.is_open())
log_file << message << std::flush;
}
void ZmqLogger::Path(string new_path)
{
// Update path
file_path = new_path;
// Close file (if already open)
if (log_file.is_open())
log_file.close();
// Open file (write + append)
log_file.open (file_path.c_str(), ios::out | ios::app);
// Get current time and log first message
time_t now = time(0);
tm* localtm = localtime(&now);
log_file << "------------------------------------------" << endl;
log_file << "libopenshot logging: " << asctime(localtm);
log_file << "------------------------------------------" << endl;
}
void ZmqLogger::Close()
{
// Disable logger as it no longer needed
enabled = false;
// Close file (if already open)
if (log_file.is_open())
log_file.close();
// Close socket (if any)
if (publisher != NULL) {
// Close an existing bound publisher socket
publisher->close();
publisher = NULL;
}
}
// Append debug information
void ZmqLogger::AppendDebugMethod(string method_name,
string arg1_name, float arg1_value,
string arg2_name, float arg2_value,
string arg3_name, float arg3_value,
string arg4_name, float arg4_value,
string arg5_name, float arg5_value,
string arg6_name, float arg6_value)
{
if (!enabled)
// Don't do anything
return;
{
// Create a scoped lock, allowing only a single thread to run the following code at one time
const GenericScopedLock<CriticalSection> lock(loggerCriticalSection);
stringstream message;
message << fixed << setprecision(4);
message << method_name << " (";
// Add attributes to method JSON
if (arg1_name.length() > 0)
message << arg1_name << "=" << arg1_value;
if (arg2_name.length() > 0)
message << ", " << arg2_name << "=" << arg2_value;
if (arg3_name.length() > 0)
message << ", " << arg3_name << "=" << arg3_value;
if (arg4_name.length() > 0)
message << ", " << arg4_name << "=" << arg4_value;
if (arg5_name.length() > 0)
message << ", " << arg5_name << "=" << arg5_value;
if (arg6_name.length() > 0)
message << ", " << arg6_name << "=" << arg6_value;
// Output to standard output
message << ")" << endl;
// Send message through ZMQ
Log(message.str());
}
}
openshot::ZmqLogger
This class is used for logging and sending those logs over a ZemoMQ socket to a listener.
Definition: ZmqLogger.h:56
openshot
This namespace is the default namespace for all code in the openshot library.
Definition: AudioBufferSource.h:39