/// <summary>
/// Serializes a given object. Note: if you want to save and persist an object to Speckle Transport or Server, please use any of the "Send" methods. See <see cref="Send(Base, List{Transports.ITransport}, bool, Action{System.Collections.Concurrent.ConcurrentDictionary{string, int}}, Action{string, Exception})"/>.
/// </summary>
/// <param name="object"></param>
/// <param name="cancellationToken">Propagates notification that operations should be canceled.</param>
/// <returns>A json string representation of the object.</returns>
public static string Serialize(Base @object, CancellationToken cancellationToken, SerializerVersion serializerVersion = SerializerVersion.V2)
{
if (serializerVersion == SerializerVersion.V1)
{
var(serializer, settings) = GetSerializerInstance();
serializer.CancellationToken = cancellationToken;
return(JsonConvert.SerializeObject(@object, settings));
}
else
{
var serializer = new BaseObjectSerializerV2();
serializer.CancellationToken = cancellationToken;
return(serializer.Serialize(@object));
}
}
/// <summary>
/// Sends an object via the provided transports. Defaults to the local cache.
/// </summary>
/// <param name="object">The object you want to send.</param>
/// <param name="cancellationToken">A cancellation token that can be used by other objects or threads to send notice of cancellation.</param>
/// <param name="transports">Where you want to send them.</param>
/// <param name="useDefaultCache">Toggle for the default cache. If set to false, it will only send to the provided transports.</param>
/// <param name="onProgressAction">Action that gets triggered on every progress tick (keeps track of all transports).</param>
/// <param name="onErrorAction">Use this to capture and handle any errors from within the transports.</param>
/// <returns>The id (hash) of the object.</returns>
public static async Task <string> Send(Base @object, CancellationToken cancellationToken, List <ITransport> transports = null, bool useDefaultCache = true, Action <ConcurrentDictionary <string, int> > onProgressAction = null, Action <string, Exception> onErrorAction = null, bool disposeTransports = false, SerializerVersion serializerVersion = SerializerVersion.V2)
{
Log.AddBreadcrumb("Send");
if (transports == null)
{
transports = new List <ITransport>();
}
if (transports.Count == 0 && useDefaultCache == false)
{
throw new SpeckleException($"You need to provide at least one transport: cannot send with an empty transport list and no default cache.", level: SentryLevel.Error);
}
if (useDefaultCache)
{
transports.Insert(0, new SQLiteTransport()
{
TransportName = "LC"
});
}
BaseObjectSerializer serializer = null;
JsonSerializerSettings settings = null;
BaseObjectSerializerV2 serializerV2 = null;
if (serializerVersion == SerializerVersion.V1)
{
(serializer, settings) = GetSerializerInstance();
}
else
{
serializerV2 = new BaseObjectSerializerV2();
}
var localProgressDict = new ConcurrentDictionary <string, int>();
var internalProgressAction = Operations.GetInternalProgressAction(localProgressDict, onProgressAction);
if (serializerVersion == SerializerVersion.V1)
{
serializer.OnProgressAction = internalProgressAction;
serializer.CancellationToken = cancellationToken;
serializer.OnErrorAction = onErrorAction;
}
else
{
serializerV2.OnProgressAction = internalProgressAction;
serializerV2.CancellationToken = cancellationToken;
serializerV2.OnErrorAction = onErrorAction;
}
foreach (var t in transports)
{
t.OnProgressAction = internalProgressAction;
t.CancellationToken = cancellationToken;
t.OnErrorAction = onErrorAction;
t.BeginWrite();
if (serializerVersion == SerializerVersion.V1)
{
serializer.WriteTransports.Add(t);
}
else
{
serializerV2.WriteTransports.Add(t);
}
}
string obj;
List <Task> transportAwaits;
if (serializerVersion == SerializerVersion.V1)
{
obj = JsonConvert.SerializeObject(@object, settings);
transportAwaits = serializer.WriteTransports.Select(t => t.WriteComplete()).ToList();
}
else
{
obj = serializerV2.Serialize(@object);
transportAwaits = serializerV2.WriteTransports.Select(t => t.WriteComplete()).ToList();
}
if (cancellationToken.IsCancellationRequested)
{
return(null);
}
await Task.WhenAll(transportAwaits).ConfigureAwait(false);
foreach (var t in transports)
{
t.EndWrite();
if (useDefaultCache && t is SQLiteTransport lc && lc.TransportName == "LC")
{
lc.Dispose(); continue;
}
if (disposeTransports && t is IDisposable disp)
{
disp.Dispose();
}
}
if (cancellationToken.IsCancellationRequested)
{
return(null);
}
var hash = JObject.Parse(obj).GetValue("id").ToString();
return(hash);
}
