You.i Engine
CYINetworkLogFiltering Class Reference

Detailed Description

This class provides an interface for logging network calls with customized settings.

#include <network/YiNetworkLogFiltering.h>

Public Types

enum  Properties : uint8_t {
  Properties::Disabled = 0x00,
  Properties::Enabled = 0x01,
  Properties::Successes = 0x02,
  Properties::Failures = 0x04,
  Properties::Requests = 0x08,
  Properties::Responses = 0x10,
  Properties::Cached = 0x20,
  Properties::ObfuscateUrls = 0x40
}
 

Static Public Member Functions

static CYIString ObfuscateUrlAsString (const CYIUrl &url)
 
static void SetProperties (Properties properties)
 
static Properties GetProperties ()
 
static bool IsPropertySet (Properties properties)
 

Member Enumeration Documentation

enum CYINetworkLogFiltering::Properties : uint8_t
strong

An enum representing whether logging is enabled, which types of logs are enabled for logging, and the format in which urls are shown

Enumerator
Disabled 
Enabled 
Successes 
Failures 
Requests 
Responses 
Cached 
ObfuscateUrls 

Member Function Documentation

static Properties CYINetworkLogFiltering::GetProperties ( )
static

Returns the logger's properties

static bool CYINetworkLogFiltering::IsPropertySet ( Properties  properties)
static

Returns whether the passed LoggingProperty (or multiple Properties) is/are contained in the logger's properties. All passed properties must be set in the logger's properties AND Properties::Enabled must be set for this to resolve to true. Other Properties not included in logger's properties can be set as well for this to resolve to true.

static CYIString CYINetworkLogFiltering::ObfuscateUrlAsString ( const CYIUrl url)
static

Returns a string representation of the passed url if obfuscation is disabled. If obfuscation is enabled, url will only contain the scheme and the host of the url, omitting the username, password, path, port, query, and fragment.

static void CYINetworkLogFiltering::SetProperties ( Properties  properties)
static

Sets the logger's properties equal to the provided properties


The documentation for this class was generated from the following file: