/// <summary>
/// Called by derived classes when a complete JSON string has been received.
/// </summary>
/// <param name="json">The JSON string.</param>
protected void onData(string json)
{
JSONdn data = new JSONdn(json);
if (data.has("status"))
{
if (data.has("tick"))
{
// Ignore ticks
}
else switch (data.getStringVal("status"))
{
case "failure":
case "error":
onError(data.getStringVal("message"));
break;
case "warning":
onWarning(data.getStringVal("message"));
break;
default:
onWarning("Unhandled status message: \"" + data.getStringVal("status") + "\"");
break;
}
}
else if (data.has("hash"))
{
// The data contains a hash so the connection is consuming
// multiple streams.
if (data.has("data.deleted"))
{
m_event_handler.onDeleted(this, new Interaction(data.getJVal("data")), data.getStringVal("hash"));
}
else
{
m_event_handler.onInteraction(this, new Interaction(data.getJVal("data")), data.getStringVal("hash"));
}
}
else if (data.has("interaction"))
{
// The data does not contain a hash so the connection is
// consuming a single stream. Use the first element in
// the hashes array as the hash for the callback.
if (data.has("deleted"))
{
m_event_handler.onDeleted(this, new Interaction(data.getJVal()), m_hashes[0]);
}
else
{
m_event_handler.onInteraction(this, new Interaction(data.getJVal()), m_hashes[0]);
}
}
else
{
// Hitting this means the data structure did not have any of
// the expected elements.
onError("Unhandled data received: " + json);
}
}
/// <summary>
/// Prepare this Historics query.
/// </summary>
public void prepare()
{
if (isDeleted())
{
throw new InvalidDataException("Cannot set the name of a deleted Historics query");
}
if (m_playback_id.Length > 0)
{
throw new InvalidDataException("This Historics query has already been prepared");
}
Dictionary <string, string> parameters = new Dictionary <string, string>();
parameters.Add("hash", m_stream_hash);
parameters.Add("start", Utils.DateTimeToUnixTimestamp(m_start_date).ToString());
parameters.Add("end", Utils.DateTimeToUnixTimestamp(m_end_date).ToString());
parameters.Add("name", m_name);
parameters.Add("sources", string.Join(",", m_sources.ToArray()));
try
{
JSONdn res = m_user.callApi("historics/prepare", parameters);
if (!res.has("id"))
{
throw new InvalidDataException("Prepared successfully but no playback ID in the response");
}
m_playback_id = res.getStringVal("id");
if (!res.has("dpus"))
{
throw new InvalidDataException("Prepared successfully but no DPU cost in the response");
}
m_dpus = res.getDoubleVal("dpus");
if (!res.has("availability"))
{
throw new InvalidDataException("Prepared successfully but no availability in the response");
}
m_availability = new HistoricDataAvailability(new JSONdn(res.getJVal("availability")));
}
catch (ApiException e)
{
// 400 = Missing or bad parameters.
// 404 = Historics query not found.
if (e.Code == 400 || e.Code == 404)
{
throw new InvalidDataException(e.Message);
}
throw new ApiException("Unexpected API response code: " + e.Code.ToString() + " " + e.Message);
}
// Update our data.
reloadData();
}
/// <summary>
/// Recursive method to parse a tree in JSON into the flat
/// dot-notation parameters used by the API.
/// </summary>
/// <param name="json">The JSON object.</param>
/// <param name="key_prefix">The current key prefix.</param>
protected void setOutputParams(JSONdn json, string key_prefix)
{
foreach (string key in json.getKeys())
{
string full_key = (key_prefix.Length == 0 ? "" : key_prefix + ".") + key;
if (json.hasChildren(key))
{
setOutputParams(new JSONdn(json.getJVal(key)), full_key);
}
else
{
set(full_key, json.getStringVal(key));
}
}
}
/// <summary>
/// Send the CSDL to DataSift for compilation.
/// </summary>
public void compile()
{
// We must have some CSDL in order to compile the CSDL!
if (m_csdl.Length == 0)
{
throw new InvalidDataException("Cannot compile an empty definition");
}
try
{
Dictionary <string, string> parameters = new Dictionary <string, string>();
parameters.Add("csdl", m_csdl);
JSONdn res = m_user.callApi("compile", parameters);
if (!res.has("hash"))
{
throw new CompileFailedException("Compiled successfully but no hash in the response");
}
m_hash = res.getStringVal("hash");
if (!res.has("created_at"))
{
throw new CompileFailedException("Compiled successfully but no created_at in the response");
}
m_created_at = res.getDateTimeVal("created_at", "yyyy-MM-dd HH:mm:ss");
if (!res.has("dpu"))
{
throw new CompileFailedException("Compiled successfully but no DPU in the response");
}
m_total_dpu = res.getDoubleVal("dpu");
}
catch (ApiException e)
{
clearHash();
if (e.Code == 400)
{
throw new CompileFailedException(e.Message);
}
throw new CompileFailedException("Unexpected API response code: " + e.Code.ToString() + " " + e.Message);
}
}
/// <summary>
/// Constructor from a JSON object.
/// </summary>
/// <param name="json">The JSON object.</param>
public PushLogEntry(JSONdn json)
: this(json.getStringVal("subscription_id"), Utils.UnixTimestampToDateTime(json.getLongVal("request_time")), json.getBoolVal("success"), json.has("message") ? json.getStringVal("message") : "")
{
}
/// <summary>
/// Initialise this object from teh data in a JSON object.
/// </summary>
/// <param name="data">The JSON object.</param>
public void init(JSONdn data)
{
if (!data.has("id"))
{
throw new ApiException("No playback ID in the response");
}
if (m_playback_id.Length > 0 && m_playback_id.CompareTo(data.getStringVal("id")) != 0)
{
throw new ApiException("Incorrect playback ID in the response");
}
m_playback_id = data.getStringVal("id");
if (!data.has("definition_id"))
{
throw new ApiException("No definition hash in the response");
}
m_stream_hash = data.getStringVal("definition_id");
if (!data.has("name"))
{
throw new ApiException("No name in the response");
}
m_name = data.getStringVal("name");
if (!data.has("start"))
{
throw new ApiException("No start timestamp in the response");
}
m_start_date = data.getDateTimeFromLongVal("start");
if (!data.has("end"))
{
throw new ApiException("No end timestamp in the response");
}
m_end_date = data.getDateTimeFromLongVal("end");
if (!data.has("created_at"))
{
throw new ApiException("No created at timestamp in the response");
}
m_created_at = data.getDateTimeFromLongVal("created_at");
if (!data.has("status"))
{
throw new ApiException("No status in the response");
}
m_status = data.getStringVal("status");
if (!data.has("progress"))
{
throw new ApiException("No progress in the response");
}
m_progress = data.getIntVal("progress");
if (!data.has("sources"))
{
throw new ApiException("No sources in the response");
}
m_sources.Clear();
foreach (JToken source in data.getJVal("sources"))
{
m_sources.Add(source.ToString());
}
if (!data.has("sample"))
{
throw new ApiException("No sample in the response");
}
m_sample = data.getDoubleVal("sample");
}
/// <summary>
/// Called by the base class when it wants the consumer to start.
/// </summary>
/// <param name="auto_reconnect">True to reconnect should the connection get dropped.</param>
protected override void onStart(bool auto_reconnect = true)
{
bool firstConnection = true;
int connectionDelay = 0;
while ((firstConnection || auto_reconnect) && isRunning(true))
{
firstConnection = false;
// Do we need to wait before trying to reconnect?
if (connectionDelay > 0)
{
Thread.Sleep(connectionDelay * 1000);
}
byte[] buffer = new byte[65536];
HttpWebResponse response;
// TODO: check status in exception handler to treat timeouts differently if needed
WebExceptionStatus status;
try
{
// Build the request.
HttpWebRequest request = (HttpWebRequest)WebRequest.Create(getUrl());
request.Timeout = 65000;
request.ReadWriteTimeout = 65000;
request.Headers["Auth"] = getAuthHeader();
request.UserAgent = getUserAgent();
// Get the response.
response = (HttpWebResponse)request.GetResponse();
}
catch (WebException e)
{
// An error occurred, but we handle the response with the same code below.
response = (HttpWebResponse)e.Response;
status = e.Status;
}
catch (Exception e)
{
// Have we exhausted the recommended retries?
if (connectionDelay < 16)
{
// No. Increment the retry delay by a second and tell the user about the problem.
connectionDelay += 1;
onWarning("Connection failed (" + e.Message + "), retrying in " + connectionDelay + " second" + (connectionDelay == 1 ? "" : "s"));
// Try again.
continue;
}
// No more retries. Tell the user and break out of the reconnect loop.
onWarning("Connection failed (" + e.Message + "), no more retries");
break;
}
int statusCode = (response == null ? -1 : (int)response.StatusCode);
if (statusCode == 200)
{
// Yay, connected. Reset the delay, tell the user we're connected and start reading the stream.
connectionDelay = 0;
onConnect();
readStream(new StreamReader(response.GetResponseStream()));
}
else if (statusCode == 404)
{
// Unknown hash.
onError("Hash not found");
break;
}
else if (statusCode >= 400 && statusCode < 500 && statusCode != 420)
{
// A 4xx (excluding 420) response should contain an error message in JSON.
StreamReader response_stream = new StreamReader(response.GetResponseStream());
string json_data = "init";
while (json_data.Length <= 4)
{
json_data = response_stream.ReadLine();
}
JSONdn json = new JSONdn(json_data);
if (json.has("message"))
{
onError(json.getStringVal("message"));
}
else
{
onError("Unhandled error code: " + statusCode.ToString() + " " + json_data);
}
// Break out of the reconnect loop.
break;
}
else
{
// All other response codes follow the recommended retry pattern for server-side errors.
if (connectionDelay == 0)
{
connectionDelay = 10;
}
else if (connectionDelay < 320)
{
connectionDelay *= 2;
}
else
{
// We've hit the retry limit, tell the user and break out of the reconnect loop.
onError((statusCode == -1 ? "Connection failed" : "Received " + statusCode.ToString() + " response") + ", no more retries");
break;
}
// Tell the user that we're retrying.
onWarning((statusCode == -1 ? "Connection failed" : "Received " + statusCode.ToString() + " response") + ", retrying in " + connectionDelay + " seconds");
}
}
// Tell the user we've disconnected.
onDisconnect();
}
/// <summary>
/// Extract data from a JSON object.
/// </summary>
/// <param name="json">The JSON object.</param>
protected void init(JSONdn json)
{
if (!json.has("id"))
{
throw new InvalidDataException("No ID found");
}
m_id = json.getStringVal("id");
if (!json.has("name"))
{
throw new InvalidDataException("No name found");
}
m_name = json.getStringVal("name");
if (!json.has("created_at"))
{
throw new InvalidDataException("No created at date found");
}
m_created_at = Utils.UnixTimestampToDateTime(json.getLongVal("created_at"));
if (!json.has("status"))
{
throw new InvalidDataException("No status found");
}
m_status = json.getStringVal("status");
if (!json.has("hash_type"))
{
throw new InvalidDataException("No hash_type found");
}
m_hash_type = json.getStringVal("hash_type");
if (!json.has("hash"))
{
throw new InvalidDataException("No hash found");
}
m_hash = json.getStringVal("hash");
if (!json.has("last_request"))
{
throw new InvalidDataException("No last request date found");
}
try
{
m_last_request = Utils.UnixTimestampToDateTime(json.getLongVal("last_request"));
}
catch (Exception)
{
m_last_request = DateTime.MinValue;
}
if (!json.has("last_success"))
{
throw new InvalidDataException("No last success date found");
}
try
{
m_last_success = Utils.UnixTimestampToDateTime(json.getLongVal("last_success"));
}
catch (Exception)
{
m_last_success = DateTime.MinValue;
}
if (!json.has("output_type"))
{
throw new InvalidDataException("No output type found");
}
m_output_type = json.getStringVal("output_type");
if (!json.has("id"))
{
throw new InvalidDataException("No ID found");
}
m_output_params.Clear();
m_output_params.parse(new JSONdn(json.getJVal("output_params")));
}
/// <summary>
/// Constructor from a JSON object.
/// </summary>
/// <param name="json">The JSON object.</param>
public PushLogEntry(JSONdn json)
: this(json.getStringVal("subscription_id"), Utils.UnixTimestampToDateTime(json.getLongVal("request_time")), json.getBoolVal("success"), json.has("message") ? json.getStringVal("message") : "")
{
}
/// <summary>
/// Called by the base class when it wants the consumer to start.
/// </summary>
/// <param name="auto_reconnect">True to reconnect should the connection get dropped.</param>
protected override void onStart(bool auto_reconnect = true)
{
bool firstConnection = true;
int connectionDelay = 0;
while ((firstConnection || auto_reconnect) && isRunning(true))
{
firstConnection = false;
// Do we need to wait before trying to reconnect?
if (connectionDelay > 0)
{
Thread.Sleep(connectionDelay * 1000);
}
byte[] buffer = new byte[65536];
HttpWebResponse response;
// TODO: check status in exception handler to treat timeouts differently if needed
WebExceptionStatus status;
try
{
// Build the request.
HttpWebRequest request = (HttpWebRequest)WebRequest.Create(getUrl());
request.Timeout = 65000;
request.ReadWriteTimeout = 65000;
request.Headers["Auth"] = getAuthHeader();
request.UserAgent = getUserAgent();
// Get the response.
response = (HttpWebResponse)request.GetResponse();
}
catch (WebException e)
{
// An error occurred, but we handle the response with the same code below.
response = (HttpWebResponse)e.Response;
status = e.Status;
}
catch (Exception e)
{
// Have we exhausted the recommended retries?
if (connectionDelay < 16)
{
// No. Increment the retry delay by a second and tell the user about the problem.
connectionDelay += 1;
onWarning("Connection failed (" + e.Message + "), retrying in " + connectionDelay + " second" + (connectionDelay == 1 ? "" : "s"));
// Try again.
continue;
}
// No more retries. Tell the user and break out of the reconnect loop.
onWarning("Connection failed (" + e.Message + "), no more retries");
break;
}
int statusCode = (response == null ? -1 : (int)response.StatusCode);
if (statusCode == 200)
{
// Yay, connected. Reset the delay, tell the user we're connected and start reading the stream.
connectionDelay = 0;
onConnect();
readStream(new StreamReader(response.GetResponseStream()));
}
else if (statusCode == 404)
{
// Unknown hash.
onError("Hash not found");
break;
}
else if (statusCode >= 400 && statusCode < 500 && statusCode != 420)
{
// A 4xx (excluding 420) response should contain an error message in JSON.
StreamReader response_stream = new StreamReader(response.GetResponseStream());
string json_data = "init";
while (json_data.Length <= 4)
{
json_data = response_stream.ReadLine();
}
JSONdn json = new JSONdn(json_data);
if (json.has("message"))
{
onError(json.getStringVal("message"));
}
else
{
onError("Unhandled error code: " + statusCode.ToString() + " " + json_data);
}
// Break out of the reconnect loop.
break;
}
else
{
// All other response codes follow the recommended retry pattern for server-side errors.
if (connectionDelay == 0)
{
connectionDelay = 10;
}
else if (connectionDelay < 320)
{
connectionDelay *= 2;
}
else
{
// We've hit the retry limit, tell the user and break out of the reconnect loop.
onError((statusCode == -1 ? "Connection failed" : "Received " + statusCode.ToString() + " response") + ", no more retries");
break;
}
// Tell the user that we're retrying.
onWarning((statusCode == -1 ? "Connection failed" : "Received " + statusCode.ToString() + " response") + ", retrying in " + connectionDelay + " seconds");
}
}
// Tell the user we've disconnected.
onDisconnect();
}
/// <summary>
/// Extract data from a JSON object.
/// </summary>
/// <param name="json">The JSON object.</param>
protected void init(JSONdn json)
{
if (!json.has("id"))
{
throw new InvalidDataException("No ID found");
}
m_id = json.getStringVal("id");
if (!json.has("name"))
{
throw new InvalidDataException("No name found");
}
m_name = json.getStringVal("name");
if (!json.has("created_at"))
{
throw new InvalidDataException("No created at date found");
}
m_created_at = Utils.UnixTimestampToDateTime(json.getLongVal("created_at"));
if (!json.has("status"))
{
throw new InvalidDataException("No status found");
}
m_status = json.getStringVal("status");
if (!json.has("hash_type"))
{
throw new InvalidDataException("No hash_type found");
}
m_hash_type = json.getStringVal("hash_type");
if (!json.has("hash"))
{
throw new InvalidDataException("No hash found");
}
m_hash = json.getStringVal("hash");
if (!json.has("last_request"))
{
throw new InvalidDataException("No last request date found");
}
try
{
m_last_request = Utils.UnixTimestampToDateTime(json.getLongVal("last_request"));
}
catch (Exception)
{
m_last_request = DateTime.MinValue;
}
if (!json.has("last_success"))
{
throw new InvalidDataException("No last success date found");
}
try
{
m_last_success = Utils.UnixTimestampToDateTime(json.getLongVal("last_success"));
}
catch (Exception)
{
m_last_success = DateTime.MinValue;
}
if (!json.has("output_type"))
{
throw new InvalidDataException("No output type found");
}
m_output_type = json.getStringVal("output_type");
if (!json.has("id"))
{
throw new InvalidDataException("No ID found");
}
m_output_params.Clear();
m_output_params.parse(new JSONdn(json.getJVal("output_params")));
}
/// <summary>
/// Initialise this object from teh data in a JSON object.
/// </summary>
/// <param name="data">The JSON object.</param>
public void init(JSONdn data)
{
if (!data.has("id"))
{
throw new ApiException("No playback ID in the response");
}
if (m_playback_id.Length > 0 && m_playback_id.CompareTo(data.getStringVal("id")) != 0)
{
throw new ApiException("Incorrect playback ID in the response");
}
m_playback_id = data.getStringVal("id");
if (!data.has("definition_id"))
{
throw new ApiException("No definition hash in the response");
}
m_stream_hash = data.getStringVal("definition_id");
if (!data.has("name"))
{
throw new ApiException("No name in the response");
}
m_name = data.getStringVal("name");
if (!data.has("start"))
{
throw new ApiException("No start timestamp in the response");
}
m_start_date = data.getDateTimeFromLongVal("start");
if (!data.has("end"))
{
throw new ApiException("No end timestamp in the response");
}
m_end_date = data.getDateTimeFromLongVal("end");
if (!data.has("created_at"))
{
throw new ApiException("No created at timestamp in the response");
}
m_created_at = data.getDateTimeFromLongVal("created_at");
if (!data.has("status"))
{
throw new ApiException("No status in the response");
}
m_status = data.getStringVal("status");
if (!data.has("progress"))
{
throw new ApiException("No progress in the response");
}
m_progress = data.getIntVal("progress");
if (!data.has("sources"))
{
throw new ApiException("No sources in the response");
}
m_sources.Clear();
foreach (JToken source in data.getJVal("sources"))
{
m_sources.Add(source.ToString());
}
if (!data.has("sample"))
{
throw new ApiException("No sample in the response");
}
m_sample = data.getDoubleVal("sample");
}
