mcs/class/corlib/System.Diagnostics.Tracing/EventSource.cs

   1 //
   2 // EventSource.cs
   3 //
   4 // Authors:
   5 //      Marek Safar  <marek.safar@gmail.com>
   6 //      Frederik Carlier <frederik.carlier@quamotion.mobi>
   7 //
   8 // Copyright (C) 2014 Xamarin Inc (http://www.xamarin.com)
   9 // Copyrithg (C) 2015 Quamotion (http://quamotion.mobi)
  10 //
  11 // Permission is hereby granted, free of charge, to any person obtaining
  12 // a copy of this software and associated documentation files (the
  13 // "Software"), to deal in the Software without restriction, including
  14 // without limitation the rights to use, copy, modify, merge, publish,
  15 // distribute, sublicense, and/or sell copies of the Software, and to
  16 // permit persons to whom the Software is furnished to do so, subject to
  17 // the following conditions:
  18 //
  19 // The above copyright notice and this permission notice shall be
  20 // included in all copies or substantial portions of the Software.
  21 //
  22 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  23 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  24 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  25 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  26 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  27 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  28 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  29 //
  30
  31 using System.Collections.Generic;
  32
  33 namespace System.Diagnostics.Tracing
  34 {
  35         public class EventSource : IDisposable
  36         {
  37                 protected internal struct EventData
  38                 {
  39                         public IntPtr DataPointer { get; set; }
  40                         public int Size { get; set; }
  41                         internal int Reserved { get; set; }
  42                 }
  43
  44                 protected EventSource ()
  45                 {
  46                         this.Name = this.GetType().Name;
  47                 }
  48
  49                 protected EventSource (bool throwOnEventWriteErrors)
  50                         : this ()
  51                 {
  52                 }
  53
  54                 protected EventSource (EventSourceSettings settings)
  55                         : this ()
  56                 {
  57                         this.Settings = settings;
  58                 }
  59
  60                 protected EventSource (EventSourceSettings settings, params string[] traits)
  61                         : this (settings)
  62                 {
  63                 }
  64
  65                 public EventSource (string eventSourceName)
  66                 {
  67                         this.Name = eventSourceName;
  68                 }
  69
  70                 public EventSource (string eventSourceName, EventSourceSettings config)
  71                         : this (eventSourceName)
  72                 {
  73                         this.Settings = config;
  74                 }
  75
  76                 public EventSource (string eventSourceName, EventSourceSettings config, params string[] traits)
  77                         : this (eventSourceName, config)
  78                 {
  79                 }
  80
  81                 internal EventSource (Guid eventSourceGuid, string eventSourceName)
  82                         : this (eventSourceName)
  83                 {
  84                 }
  85
  86                 ~EventSource ()
  87                 {
  88                         Dispose (false);
  89                 }
  90
  91                 public Exception ConstructionException
  92                 {
  93                         get { return null; }
  94                 }
  95
  96                 public static Guid CurrentThreadActivityId
  97                 {
  98                         get { return Guid.Empty; }
  99                 }
 100
 101                 public Guid Guid
 102                 {
 103                         get { return Guid.Empty; }
 104                 }
 105
 106                 public string Name
 107                 {
 108                         get;
 109                         private set;
 110                 }
 111
 112                 public EventSourceSettings Settings
 113                 {
 114                         get;
 115                         private set;
 116                 }
 117
 118                 public bool IsEnabled ()
 119                 {
 120                         return false;
 121                 }
 122
 123                 public bool IsEnabled (EventLevel level, EventKeywords keywords)
 124                 {
 125                         return false;
 126                 }
 127
 128                 public bool IsEnabled (EventLevel level, EventKeywords keywords, EventChannel channel)
 129                 {
 130                         return false;
 131                 }
 132
 133                 public void Dispose ()
 134                 {
 135                         Dispose (true);
 136                         GC.SuppressFinalize (this);
 137                 }
 138
 139                 public string GetTrait (string key)
 140                 {
 141                         return null;
 142                 }
 143
 144                 public void Write (string eventName)
 145                 {
 146                 }
 147
 148                 public void Write (string eventName, EventSourceOptions options)
 149                 {
 150                 }
 151
 152                 public void Write<T> (string eventName, T data)
 153                 {
 154                 }
 155
 156                 public void Write<T> (string eventName, EventSourceOptions options, T data)
 157                 {
 158                 }
 159
 160                 [CLSCompliant (false)]
 161                 public void Write<T> (string eventName, ref EventSourceOptions options, ref T data)
 162                 {
 163                 }
 164
 165                 public void Write<T> (string eventName, ref EventSourceOptions options, ref Guid activityId, ref Guid relatedActivityId, ref T data)
 166                 {
 167                 }
 168
 169                 protected virtual void Dispose (bool disposing)
 170                 {
 171                 }
 172
 173                 protected virtual void OnEventCommand (EventCommandEventArgs command)
 174                 {
 175                 }
 176
 177                 internal void ReportOutOfBandMessage (string msg, bool flush)
 178                 {
 179                 }
 180
 181                 protected void WriteEvent (int eventId)
 182                 {
 183                         WriteEvent (eventId, new object[] { } );
 184                 }
 185
 186                 protected void WriteEvent (int eventId, byte[] arg1)
 187                 {
 188                         WriteEvent (eventId, new object[] { arg1 } );
 189                 }
 190
 191                 protected void WriteEvent (int eventId, int arg1)
 192                 {
 193                         WriteEvent (eventId, new object[] { arg1 } );
 194                 }
 195
 196                 protected void WriteEvent (int eventId, string arg1)
 197                 {
 198                         WriteEvent (eventId, new object[] { arg1 } );
 199                 }
 200
 201                 protected void WriteEvent (int eventId, int arg1, int arg2)
 202                 {
 203                         WriteEvent (eventId, new object[] { arg1, arg2 } );
 204                 }
 205
 206                 protected void WriteEvent (int eventId, int arg1, int arg2, int arg3)
 207                 {
 208                         WriteEvent (eventId, new object[] { arg1, arg2, arg3 } );
 209                 }
 210
 211                 protected void WriteEvent (int eventId, int arg1, string arg2)
 212                 {
 213                         WriteEvent (eventId, new object[] { arg1, arg2 } );
 214                 }
 215
 216                 protected void WriteEvent (int eventId, long arg1)
 217                 {
 218                         WriteEvent (eventId, new object[] { arg1 } );
 219                 }
 220
 221                 protected void WriteEvent (int eventId, long arg1, byte[] arg2)
 222                 {
 223                         WriteEvent (eventId, new object[] { arg1, arg2 } );
 224                 }
 225
 226                 protected void WriteEvent (int eventId, long arg1, long arg2)
 227                 {
 228                         WriteEvent (eventId, new object[] { arg1, arg2 } );
 229                 }
 230
 231                 protected void WriteEvent (int eventId, long arg1, long arg2, long arg3)
 232                 {
 233                         WriteEvent (eventId, new object[] { arg1, arg2, arg3 } );
 234                 }
 235
 236                 protected void WriteEvent (int eventId, long arg1, string arg2)
 237                 {
 238                         WriteEvent (eventId, new object[] { arg1, arg2 } );
 239                 }
 240
 241                 protected void WriteEvent (int eventId, params object[] args)
 242                 {
 243                 }
 244
 245                 protected void WriteEvent (int eventId, string arg1, int arg2)
 246                 {
 247                         WriteEvent (eventId, new object[] { arg1, arg2 } );
 248                 }
 249
 250                 protected void WriteEvent (int eventId, string arg1, int arg2, int arg3)
 251                 {
 252                         WriteEvent (eventId, new object[] { arg1, arg2, arg3 } );
 253                 }
 254
 255                 protected void WriteEvent (int eventId, string arg1, long arg2)
 256                 {
 257                         WriteEvent (eventId, new object[] { arg1, arg2 } );
 258                 }
 259
 260                 protected void WriteEvent (int eventId, string arg1, string arg2)
 261                 {
 262                         WriteEvent (eventId, new object[] { arg1, arg2 } );
 263                 }
 264
 265                 protected void WriteEvent (int eventId, string arg1, string arg2, string arg3)
 266                 {
 267                         WriteEvent (eventId, new object[] { arg1, arg2, arg3 } );
 268                 }
 269
 270                 [CLSCompliant (false)]
 271                 protected unsafe void WriteEventCore (int eventId, int eventDataCount, EventData* data)
 272                 {
 273                 }
 274
 275                 protected unsafe void WriteEventWithRelatedActivityId (int eventId, Guid relatedActivityId, params object[] args)
 276                 {
 277                 }
 278
 279                 [CLSCompliant (false)]
 280                 protected unsafe void WriteEventWithRelatedActivityIdCore (int eventId, Guid* relatedActivityId, int eventDataCount, EventSource.EventData* data)
 281                 {
 282                 }
 283
 284 //              [MonoTODO]
 285                 public event EventHandler<EventCommandEventArgs> EventCommandExecuted
 286                 {
 287                         add { throw new NotImplementedException (); }
 288                         remove { throw new NotImplementedException (); }
 289                 }
 290
 291 //              [MonoTODO]
 292                 public static string GenerateManifest (Type eventSourceType, string assemblyPathToIncludeInManifest)
 293                 {
 294                         throw new NotImplementedException ();
 295                 }
 296
 297 //              [MonoTODO]
 298                 public static string GenerateManifest (Type eventSourceType, string assemblyPathToIncludeInManifest, EventManifestOptions flags)
 299                 {
 300                         throw new NotImplementedException ();
 301                 }
 302
 303 //              [MonoTODO]
 304                 public static Guid GetGuid (Type eventSourceType)
 305                 {
 306                         throw new NotImplementedException ();
 307                 }
 308
 309 //              [MonoTODO]
 310                 public static string GetName (Type eventSourceType)
 311                 {
 312                         throw new NotImplementedException ();
 313                 }
 314
 315 //              [MonoTODO]
 316                 public static IEnumerable<EventSource> GetSources ()
 317                 {
 318                         throw new NotImplementedException ();
 319                 }
 320
 321 //              [MonoTODO]
 322                 public static void SendCommand (EventSource eventSource, EventCommand command, IDictionary<string, string> commandArguments)
 323                 {
 324                         throw new NotImplementedException ();
 325                 }
 326
 327 //              [MonoTODO]
 328                 public static void SetCurrentThreadActivityId (Guid activityId)
 329                 {
 330                         throw new NotImplementedException ();
 331                 }
 332
 333 //              [MonoTODO]
 334                 public static void SetCurrentThreadActivityId (Guid activityId, out Guid oldActivityThatWillContinue)
 335                 {
 336                         throw new NotImplementedException ();
 337                 }
 338         }
 339 }
 340