commit ff001263c59c1fdf4a3b53fbe22832e3906b8603 Author: faker <1784913417@qq.com> Date: Mon May 8 16:30:03 2023 +0800 添加项目文件。 diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..1ff0c42 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,63 @@ +############################################################################### +# Set default behavior to automatically normalize line endings. +############################################################################### +* text=auto + +############################################################################### +# Set default behavior for command prompt diff. +# +# This is need for earlier builds of msysgit that does not have it on by +# default for csharp files. +# Note: This is only used by command line +############################################################################### +#*.cs diff=csharp + +############################################################################### +# Set the merge driver for project and solution files +# +# Merging from the command prompt will add diff markers to the files if there +# are conflicts (Merging from VS is not affected by the settings below, in VS +# the diff markers are never inserted). Diff markers may cause the following +# file extensions to fail to load in VS. An alternative would be to treat +# these files as binary and thus will always conflict and require user +# intervention with every merge. To do so, just uncomment the entries below +############################################################################### +#*.sln merge=binary +#*.csproj merge=binary +#*.vbproj merge=binary +#*.vcxproj merge=binary +#*.vcproj merge=binary +#*.dbproj merge=binary +#*.fsproj merge=binary +#*.lsproj merge=binary +#*.wixproj merge=binary +#*.modelproj merge=binary +#*.sqlproj merge=binary +#*.wwaproj merge=binary + +############################################################################### +# behavior for image files +# +# image files are treated as binary by default. +############################################################################### +#*.jpg binary +#*.png binary +#*.gif binary + +############################################################################### +# diff behavior for common document formats +# +# Convert binary document formats to text before diffing them. This feature +# is only available from the command line. Turn it on by uncommenting the +# entries below. +############################################################################### +#*.doc diff=astextplain +#*.DOC diff=astextplain +#*.docx diff=astextplain +#*.DOCX diff=astextplain +#*.dot diff=astextplain +#*.DOT diff=astextplain +#*.pdf diff=astextplain +#*.PDF diff=astextplain +#*.rtf diff=astextplain +#*.RTF diff=astextplain diff --git a/.gitee/ISSUE_TEMPLATE.zh-CN.md b/.gitee/ISSUE_TEMPLATE.zh-CN.md new file mode 100644 index 0000000..f09d98d --- /dev/null +++ b/.gitee/ISSUE_TEMPLATE.zh-CN.md @@ -0,0 +1,13 @@ +### 该问题是怎么引起的? + + + +### 重现步骤 + + + +### 报错信息 + + + + diff --git a/.gitee/PULL_REQUEST_TEMPLATE.zh-CN.md b/.gitee/PULL_REQUEST_TEMPLATE.zh-CN.md new file mode 100644 index 0000000..1e5b8d3 --- /dev/null +++ b/.gitee/PULL_REQUEST_TEMPLATE.zh-CN.md @@ -0,0 +1,15 @@ +### 相关的Issue + + +### 原因(目的、解决的问题等) + + +### 描述(做了什么,变更了什么) + + +### 测试用例 + + + + + diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..3e8a155 --- /dev/null +++ b/.gitignore @@ -0,0 +1,341 @@ +## Ignore Visual Studio temporary files, build results, and +## files generated by popular Visual Studio add-ons. +## +## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore + +# User-specific files +*.rsuser +*.suo +*.user +*.userosscache +*.sln.docstates + +# User-specific files (MonoDevelop/Xamarin Studio) +*.userprefs + +# Build results +[Dd]ebug/ +[Dd]ebugPublic/ +[Rr]elease/ +[Rr]eleases/ +x64/ +x86/ +[Aa][Rr][Mm]/ +[Aa][Rr][Mm]64/ +bld/ +[Bb]in/ +[Oo]bj/ +[Ll]og/ + +# Visual Studio 2015/2017 cache/options directory +.vs/ +# Uncomment if you have tasks that create the project's static files in wwwroot +#wwwroot/ + +# Visual Studio 2017 auto generated files +Generated\ Files/ + +# MSTest test Results +[Tt]est[Rr]esult*/ +[Bb]uild[Ll]og.* + +# NUNIT +*.VisualState.xml +TestResult.xml + +# Build Results of an ATL Project +[Dd]ebugPS/ +[Rr]eleasePS/ +dlldata.c + +# Benchmark Results +BenchmarkDotNet.Artifacts/ + +# .NET Core +project.lock.json +project.fragment.lock.json +artifacts/ + +# StyleCop +StyleCopReport.xml + +# Files built by Visual Studio +*_i.c +*_p.c +*_h.h +*.ilk +*.meta +*.obj +*.iobj +*.pch +*.pdb +*.ipdb +*.pgc +*.pgd +*.rsp +*.sbr +*.tlb +*.tli +*.tlh +*.tmp +*.tmp_proj +*_wpftmp.csproj +*.log +*.vspscc +*.vssscc +.builds +*.pidb +*.svclog +*.scc + +# Chutzpah Test files +_Chutzpah* + +# Visual C++ cache files +ipch/ +*.aps +*.ncb +*.opendb +*.opensdf +*.sdf +*.cachefile +*.VC.db +*.VC.VC.opendb + +# Visual Studio profiler +*.psess +*.vsp +*.vspx +*.sap + +# Visual Studio Trace Files +*.e2e + +# TFS 2012 Local Workspace +$tf/ + +# Guidance Automation Toolkit +*.gpState + +# ReSharper is a .NET coding add-in +_ReSharper*/ +*.[Rr]e[Ss]harper +*.DotSettings.user + +# JustCode is a .NET coding add-in +.JustCode + +# TeamCity is a build add-in +_TeamCity* + +# DotCover is a Code Coverage Tool +*.dotCover + +# AxoCover is a Code Coverage Tool +.axoCover/* +!.axoCover/settings.json + +# Visual Studio code coverage results +*.coverage +*.coveragexml + +# NCrunch +_NCrunch_* +.*crunch*.local.xml +nCrunchTemp_* + +# MightyMoose +*.mm.* +AutoTest.Net/ + +# Web workbench (sass) +.sass-cache/ + +# Installshield output folder +[Ee]xpress/ + +# DocProject is a documentation generator add-in +DocProject/buildhelp/ +DocProject/Help/*.HxT +DocProject/Help/*.HxC +DocProject/Help/*.hhc +DocProject/Help/*.hhk +DocProject/Help/*.hhp +DocProject/Help/Html2 +DocProject/Help/html + +# Click-Once directory +publish/ + +# Publish Web Output +*.[Pp]ublish.xml +*.azurePubxml +# Note: Comment the next line if you want to checkin your web deploy settings, +# but database connection strings (with potential passwords) will be unencrypted +*.pubxml +*.publishproj + +# Microsoft Azure Web App publish settings. Comment the next line if you want to +# checkin your Azure Web App publish settings, but sensitive information contained +# in these scripts will be unencrypted +PublishScripts/ + +# NuGet Packages +*.nupkg +# The packages folder can be ignored because of Package Restore +**/[Pp]ackages/* +# except build/, which is used as an MSBuild target. +!**/[Pp]ackages/build/ +# Uncomment if necessary however generally it will be regenerated when needed +#!**/[Pp]ackages/repositories.config +# NuGet v3's project.json files produces more ignorable files +*.nuget.props +*.nuget.targets + +# Microsoft Azure Build Output +csx/ +*.build.csdef + +# Microsoft Azure Emulator +ecf/ +rcf/ + +# Windows Store app package directories and files +AppPackages/ +BundleArtifacts/ +Package.StoreAssociation.xml +_pkginfo.txt +*.appx + +# Visual Studio cache files +# files ending in .cache can be ignored +*.[Cc]ache +# but keep track of directories ending in .cache +!?*.[Cc]ache/ + +# Others +ClientBin/ +~$* +*~ +*.dbmdl +*.dbproj.schemaview +*.jfm +*.pfx +*.publishsettings +orleans.codegen.cs + +# Including strong name files can present a security risk +# (https://github.com/github/gitignore/pull/2483#issue-259490424) +#*.snk + +# Since there are multiple workflows, uncomment next line to ignore bower_components +# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) +#bower_components/ +# ASP.NET Core default setup: bower directory is configured as wwwroot/lib/ and bower restore is true +**/wwwroot/lib/ + +# RIA/Silverlight projects +Generated_Code/ + +# Backup & report files from converting an old project file +# to a newer Visual Studio version. Backup files are not needed, +# because we have git ;-) +_UpgradeReport_Files/ +Backup*/ +UpgradeLog*.XML +UpgradeLog*.htm +ServiceFabricBackup/ +*.rptproj.bak + +# SQL Server files +*.mdf +*.ldf +*.ndf + +# Business Intelligence projects +*.rdl.data +*.bim.layout +*.bim_*.settings +*.rptproj.rsuser + +# Microsoft Fakes +FakesAssemblies/ + +# GhostDoc plugin setting file +*.GhostDoc.xml + +# Node.js Tools for Visual Studio +.ntvs_analysis.dat +node_modules/ + +# Visual Studio 6 build log +*.plg + +# Visual Studio 6 workspace options file +*.opt + +# Visual Studio 6 auto-generated workspace file (contains which files were open etc.) +*.vbw + +# Visual Studio LightSwitch build output +**/*.HTMLClient/GeneratedArtifacts +**/*.DesktopClient/GeneratedArtifacts +**/*.DesktopClient/ModelManifest.xml +**/*.Server/GeneratedArtifacts +**/*.Server/ModelManifest.xml +_Pvt_Extensions + +# Paket dependency manager +.paket/paket.exe +paket-files/ + +# FAKE - F# Make +.fake/ + +# JetBrains Rider +.idea/ +*.sln.iml + +# CodeRush personal settings +.cr/personal + +# Python Tools for Visual Studio (PTVS) +__pycache__/ +*.pyc + +# Cake - Uncomment if you are using it +# tools/** +# !tools/packages.config + +# Tabs Studio +*.tss + +# Telerik's JustMock configuration file +*.jmconfig + +# BizTalk build output +*.btp.cs +*.btm.cs +*.odx.cs +*.xsd.cs + +# OpenCover UI analysis results +OpenCover/ + +# Azure Stream Analytics local run output +ASALocalRun/ + +# MSBuild Binary and Structured Log +*.binlog + +# NVidia Nsight GPU debugger configuration file +*.nvuser + +# MFractors (Xamarin productivity tool) working folder +.mfractor/ + +# Local History for Visual Studio +.localhistory/ + +# BeatPulse healthcheck temp database +healthchecksdb diff --git a/GPSBusiness/BBGPSStandard/BBGPSStandardService.cs b/GPSBusiness/BBGPSStandard/BBGPSStandardService.cs new file mode 100644 index 0000000..41ac737 --- /dev/null +++ b/GPSBusiness/BBGPSStandard/BBGPSStandardService.cs @@ -0,0 +1,160 @@ +using System; +using GPSBusiness.Enum; +using GPSBusiness.Helper; +using GPSBusiness.GPSStandard; +using Newtonsoft.Json; + +namespace GPSBusiness.BBGPSStandard +{ + public static class BbGpsStandardService + { + /// + /// 获取返回给设备的数据 + /// + /// + /// + /// + /// + /// + public static GPSResponseData GetGpsResponseDataForEqu(byte[] bytes, + IStandardToCarGPSHandler standardToCarGpsHandler, IntPtr conid, string mdtText) + { + byte[] byteDataId = new byte[2]; + //反转义 + byte[] buffer = ByteConvert.Fzy(bytes); + Array.Copy(buffer, 1, byteDataId, 0, 2); + Array.Reverse(byteDataId); + UInt16 uint16DataId = BitConverter.ToUInt16(byteDataId, 0); + string dataId = uint16DataId.ToString("X2").PadLeft(4, '0'); + string terminalNo = ByteConvert.ByteArrayToHexStr(buffer).Substring(11, 11);//设备号 + + "NO".Log().Debug(ByteConvert.ByteArrayToHexStr(buffer).ToString()); + DataHead dataHead = new DataHead(); + dataHead.Frombytes(dataHead, buffer); + "GetGpsResponseDataForEqu".Log().DebugFormat(" >terminalNo={0},uint16DataId=0x{1}", terminalNo, dataId); + //"GetGpsResponseDataForEqu".Log().DebugFormat(" >dataHead={0}", JsonConvert.SerializeObject(dataHead)); + //接收信息(分类) + #region 0x0002,终端心跳 + if (uint16DataId == 0x0002) + { + //平台通用应答 + var responds = CommonResponse(dataHead); + //确定该心跳是否为沃瑞特的gps,是则后续进行:gps在线状态更新。MyGpsServer.UpdateGpsRealTimeGpsStateWrt(gpsModel); + //var vehicle = standardToCarGpsHandler.GetGps(bytes, terminalNo, conid, true); + //if (vehicle != null && vehicle.TerminalType == TerminalTypeEnum.C12.ToEnumInt()) + //{ + // responds.GpsInfo = vehicle; + //} + + return responds; + } + #endregion + #region 0x0100,终端注册 0x0100 + if (uint16DataId == 0x0100) + { + //注册消息 + var model = new Data_0100(); + model.FromBytes(model, dataHead.DataContent); + //应答消息 + var model2 = new Data_8100 + { + Mdt_SerialNo = dataHead.DataSerialNo, + Result = 0x00, + AuthorizationCode = "regist123" + }; + //0:成功;1:车辆已被注册;2:数据库中无该车辆;3:终端已被注册;4:数据库中无该终端 + var dataHeadModel = new DataHead + { + DataID = 0x8100, + CenterID = dataHead.CenterID, + MdtID = dataHead.MdtID + }; + return new GPSResponseData() + { + ReturnData = model2.GetBytes(dataHeadModel), + }; + } + #endregion + #region 0x0102,终端鉴权,鉴权7-8次不成功,终端为再次注册 + if (uint16DataId == 0x0102) + { + return CommonResponse(dataHead); + } + #endregion + #region 0x0200,位置数据0x0200 + if (uint16DataId == 0x0200) + { + var responds = CommonResponse(dataHead); + responds.GpsInfo = standardToCarGpsHandler.GetGps(bytes, terminalNo, conid, false); + "GetGpsResponseDataForEqu".Log().DebugFormat(" >GpsInfo={0}", JsonConvert.SerializeObject(responds.GpsInfo)); + return responds; + } + #endregion + #region 0x0704,定位数据批量上传--0x0704,(沃瑞特:盲区补传) + if (uint16DataId == 0x0704) + { + //处理gps批量数据。然后通用回复。 + return CommonResponse(dataHead) ; + } + #endregion + #region 0xA003,请求服务器时间0xA003,回应:0xB003。//沃瑞特gps + if (uint16DataId == 0xA003) + { + var now = DateTime.Now; + int year = Convert.ToInt32(now.Year.ToString().Substring(2, 2)); + byte rYear = ByteConvert.IntToBcd(year); + byte rMonth = ByteConvert.IntToBcd(now.Month); + byte rDay = ByteConvert.IntToBcd(now.Day); + byte rHour = ByteConvert.IntToBcd(now.Hour); + byte rMinute = ByteConvert.IntToBcd(now.Minute); + byte rSecond = ByteConvert.IntToBcd(now.Second); + byte[] times = { rYear, rMonth, rDay, rHour, rMinute, rSecond }; + + var model = new Data_B003 + { + Mdt_SerialNo = dataHead.DataSerialNo, + SysTime = times + }; + var dataHeadModel = new DataHead + { + DataID = 0xB003, + CenterID = dataHead.CenterID, + MdtID = dataHead.MdtID, + }; + return new GPSResponseData() + { + ReturnData = model.GetBytes(dataHeadModel), + }; + } + #endregion + //0x8001,平台通用应答 + return CommonResponse(dataHead); + } + + /// + /// 通用回复 + /// + /// + /// + private static GPSResponseData CommonResponse(DataHead dataHead) + { + var model2 = new Data_8001 + { + Mdt_SerialNo = dataHead.DataSerialNo, + Mdt_DataID = dataHead.DataID, + Result = 0x00 + }; + var dataHeadModel = new DataHead + { + DataID = 0x8001, + CenterID = dataHead.CenterID, + MdtID = dataHead.MdtID + }; + var responds = new GPSResponseData() + { + ReturnData = model2.GetBytes(dataHeadModel) + }; + return responds; + } + } +} \ No newline at end of file diff --git a/GPSBusiness/BBGPSStandard/DataHead.cs b/GPSBusiness/BBGPSStandard/DataHead.cs new file mode 100644 index 0000000..e225fde --- /dev/null +++ b/GPSBusiness/BBGPSStandard/DataHead.cs @@ -0,0 +1,77 @@ +using System; +using GPSBusiness.Helper; +namespace GPSBusiness.BBGPSStandard +{ + public class DataHead + { + public static int intSerialNo = 0; + /// + /// ȡˮ + /// + /// + public int GetSerialNo() + { + if (intSerialNo >= 255) + { + intSerialNo = 0; + } + intSerialNo++; + return intSerialNo; + } + /// + /// ϢID + /// + public UInt16 DataID; + /// + /// Ϣ + /// + public UInt16 DataAttribute; + /// + /// նֻ=centerid+mdtid + /// + public UInt16 CenterID; + public byte[] MdtID; + /// + /// Ϣˮ + /// + public UInt16 DataSerialNo; + /// + /// Ϣ + /// + public byte[] DataContent; + public byte[] GetBytes() + { + this.DataAttribute = (UInt16)this.DataContent.Length; + ByteBuilder bb = new ByteBuilder(); + bb.Append(ByteConvert.ToBytes(this.DataID)); + bb.Append(ByteConvert.ToBytes(this.DataAttribute)); + bb.Append(ByteConvert.ToBytes(this.CenterID)); + bb.Append(this.MdtID); + bb.Append(ByteConvert.ToBytes(this.DataSerialNo)); + if (this.DataContent.Length > 0) + { + bb.Append(this.DataContent); + } + byte Crc = ByteConvert.GetCRC(bb.GetBytes(), 0, bb.GetBytes().Length); + ByteBuilder bb2 = new ByteBuilder(); + bb2.Append(0x7e); + bb2.Append(bb.GetBytes()); + bb2.Append(Crc); + bb2.Append(0x7e); + return bb2.GetBytes(); + } + public void Frombytes(DataHead model, byte[] buffer) + { + model.DataID = ByteConvert.ToUInt16(buffer, 1); + model.DataAttribute = ByteConvert.ToUInt16(buffer, 3);//buffer.Length - 15 + model.CenterID = ByteConvert.ToUInt16(buffer, 5); + model.MdtID = ByteConvert.ToBytes(buffer, 7, 4); + model.DataSerialNo = ByteConvert.ToUInt16(buffer, 11); + if (buffer.Length > 15) + { + //Ϣ ݶΪϢ峤 + model.DataContent = ByteConvert.ToBytes(buffer, 13, this.DataAttribute); + } + } + } +} diff --git a/GPSBusiness/BBGPSStandard/Data_0001.cs b/GPSBusiness/BBGPSStandard/Data_0001.cs new file mode 100644 index 0000000..f7064be --- /dev/null +++ b/GPSBusiness/BBGPSStandard/Data_0001.cs @@ -0,0 +1,29 @@ +using System; +using GPSBusiness.Helper; +namespace GPSBusiness.BBGPSStandard +{ + /// + /// նͨӦ + /// + public class Data_0001 + { + /// + /// Ӧˮ--Ӧƽ̨Ϣˮ + /// + public UInt16 PT_SerialNo; + /// + /// ӦID--Ӧƽ̨ϢID + /// + public UInt16 PT_DataID; + /// + /// --0ɹ/ȷϣ1ʧܣ2Ϣ3֧ + /// + public byte Result; + public void FromBytes(Data_0001 model, byte[] buffer) + { + model.PT_SerialNo = ByteConvert.ToUInt16(buffer, 0); + model.PT_DataID = ByteConvert.ToUInt16(buffer, 2); + model.Result = buffer[4]; + } + } +} diff --git a/GPSBusiness/BBGPSStandard/Data_0100.cs b/GPSBusiness/BBGPSStandard/Data_0100.cs new file mode 100644 index 0000000..7e87381 --- /dev/null +++ b/GPSBusiness/BBGPSStandard/Data_0100.cs @@ -0,0 +1,49 @@ +using System; +using GPSBusiness.Helper; +namespace GPSBusiness.BBGPSStandard +{ + /// + /// նע + /// + public class Data_0100 + { + /// + /// ʡID + /// + public UInt16 ProvinceID; + /// + /// ID + /// + public UInt16 CityID; + /// + /// ID + /// + public byte[] Factory; + /// + /// նͺ + /// + public byte[] MdtType; + /// + /// նID + /// + public byte[] MdtID; + /// + /// ɫ + /// + public byte NumberColor; + /// + /// + /// + public string Number; + public void FromBytes(Data_0100 model, byte[] buffer) + { + model.ProvinceID = ByteConvert.ToUInt16(buffer, 0); + model.CityID = ByteConvert.ToUInt16(buffer, 2); + model.Factory = ByteConvert.ToBytes(buffer, 4, 5); + model.MdtType = ByteConvert.ToBytes(buffer, 9, 8); + model.MdtID = ByteConvert.ToBytes(buffer, 17, 7); + model.NumberColor = buffer[24]; + model.Number = ByteConvert.ToString(buffer, 25, buffer.Length - 25); + } + } +} diff --git a/GPSBusiness/BBGPSStandard/Data_0102.cs b/GPSBusiness/BBGPSStandard/Data_0102.cs new file mode 100644 index 0000000..1d08001 --- /dev/null +++ b/GPSBusiness/BBGPSStandard/Data_0102.cs @@ -0,0 +1,20 @@ +using GPSBusiness.Helper; +namespace GPSBusiness.BBGPSStandard +{ + /// + /// ն˼Ȩ + /// + public class Data_0102 + { + /// + /// Ȩ + /// + public string AuthorizationCode; + public void FromBytes(Data_0102 model, byte[] buffer) + { + int length = buffer.Length; + if (length > 0) + model.AuthorizationCode = ByteConvert.ToString(buffer, 0, length); + } + } +} diff --git a/GPSBusiness/BBGPSStandard/Data_0104.cs b/GPSBusiness/BBGPSStandard/Data_0104.cs new file mode 100644 index 0000000..b9bc071 --- /dev/null +++ b/GPSBusiness/BBGPSStandard/Data_0104.cs @@ -0,0 +1,29 @@ +using System; +using GPSBusiness.Helper; +namespace GPSBusiness.BBGPSStandard +{ + /// + /// ѯն˲Ӧ + /// + public class Data_0104 + { + /// + /// Ӧˮ + /// + public UInt16 PT_SerialNo; + /// + /// Ӧ + /// + public byte ReturnSum; + /// + /// Ӧֵ + /// + public byte[] RetrunValue; + public void FromBytes(Data_0104 model, byte[] buffer) + { + model.PT_SerialNo = ByteConvert.ToUInt16(buffer, 0); + model.ReturnSum = buffer[2]; + model.RetrunValue = ByteConvert.ToBytes(buffer, 3, buffer.Length - 3); + } + } +} diff --git a/GPSBusiness/BBGPSStandard/Data_0301.cs b/GPSBusiness/BBGPSStandard/Data_0301.cs new file mode 100644 index 0000000..6f32fe8 --- /dev/null +++ b/GPSBusiness/BBGPSStandard/Data_0301.cs @@ -0,0 +1,14 @@ +namespace GPSBusiness.BBGPSStandard +{ + /// + /// ¼ + /// + public class Data_0301 + { + public byte SetID; + public void FromBytes(Data_0301 model, byte[] buffer) + { + model.SetID = buffer[0]; + } + } +} diff --git a/GPSBusiness/BBGPSStandard/Data_0302.cs b/GPSBusiness/BBGPSStandard/Data_0302.cs new file mode 100644 index 0000000..1700f5a --- /dev/null +++ b/GPSBusiness/BBGPSStandard/Data_0302.cs @@ -0,0 +1,18 @@ +using System; +using GPSBusiness.Helper; +namespace GPSBusiness.BBGPSStandard +{ + /// + /// Ӧ + /// + public class Data_0302 + { + public UInt16 PT_SerialNo; + public byte Answer; + public void FromBytes(Data_0302 model, byte[] buffer) + { + model.PT_SerialNo = ByteConvert.ToUInt16(buffer, 0); + model.Answer = buffer[2]; + } + } +} diff --git a/GPSBusiness/BBGPSStandard/Data_0303.cs b/GPSBusiness/BBGPSStandard/Data_0303.cs new file mode 100644 index 0000000..1c25a2f --- /dev/null +++ b/GPSBusiness/BBGPSStandard/Data_0303.cs @@ -0,0 +1,16 @@ +namespace GPSBusiness.BBGPSStandard +{ + /// + /// Ϣ㲥/ȡ + /// + public class Data_0303 + { + public byte DataType; + public byte SetSign; + public void FromBytes(Data_0303 model, byte[] buffer) + { + model.DataType = buffer[0]; + model.SetSign = buffer[1]; + } + } +} diff --git a/GPSBusiness/BBGPSStandard/Data_0500.cs b/GPSBusiness/BBGPSStandard/Data_0500.cs new file mode 100644 index 0000000..2815b7d --- /dev/null +++ b/GPSBusiness/BBGPSStandard/Data_0500.cs @@ -0,0 +1,24 @@ +using System; +using GPSBusiness.Helper; +namespace GPSBusiness.BBGPSStandard +{ + /// + /// Ӧ + /// + public class Data_0500 + { + /// + /// Ӧˮ + /// + public UInt16 PT_SerialNo; + /// + /// λϢ㱨Ϣ + /// + public byte[] GPS_Data; + public void FromBytes(Data_0500 model, byte[] buffer) + { + model.PT_SerialNo = ByteConvert.ToUInt16(buffer, 0); + model.GPS_Data = ByteConvert.ToBytes(buffer, 1, buffer.Length - 1); + } + } +} diff --git a/GPSBusiness/BBGPSStandard/Data_8001.cs b/GPSBusiness/BBGPSStandard/Data_8001.cs new file mode 100644 index 0000000..00fdff7 --- /dev/null +++ b/GPSBusiness/BBGPSStandard/Data_8001.cs @@ -0,0 +1,33 @@ +using System; +using GPSBusiness.Helper; +namespace GPSBusiness.BBGPSStandard +{ + /// + /// ƽ̨ͨӦ + /// + public class Data_8001 + { + /// + /// Ӧˮ--ӦնϢˮ + /// + public UInt16 Mdt_SerialNo; + /// + /// ӦID--ӦնϢID + /// + public UInt16 Mdt_DataID; + /// + /// --0ɹ/ȷϣ1ʧܣ2Ϣ3֧֣4ȷ + /// + public byte Result; + public byte[] GetBytes(DataHead model) + { + ByteBuilder bb = new ByteBuilder(); + bb.Append(ByteConvert.ToBytes(this.Mdt_SerialNo)); + bb.Append(ByteConvert.ToBytes(this.Mdt_DataID)); + bb.Append(this.Result); + model.DataContent = bb.GetBytes(); + byte[] bModel = ByteConvert.Zy(model.GetBytes()); + return bModel; + } + } +} diff --git a/GPSBusiness/BBGPSStandard/Data_8100.cs b/GPSBusiness/BBGPSStandard/Data_8100.cs new file mode 100644 index 0000000..2b0eabe --- /dev/null +++ b/GPSBusiness/BBGPSStandard/Data_8100.cs @@ -0,0 +1,36 @@ +using System; +using GPSBusiness.Helper; +namespace GPSBusiness.BBGPSStandard +{ + /// + /// նעӦ + /// + public class Data_8100 + { + /// + /// Ӧˮ--ӦնעϢˮ + /// + public UInt16 Mdt_SerialNo; + /// + /// --0ɹ1ѱע᣻2ݿ޸ó3նѱע᣻4ݿ޸ն + /// + public byte Result; + /// + /// Ȩ--ֻڳɹиֶ + /// + public string AuthorizationCode; + public byte[] GetBytes(DataHead model) + { + ByteBuilder bb = new ByteBuilder(); + bb.Append(ByteConvert.ToBytes(this.Mdt_SerialNo)); + bb.Append(this.Result); + if (this.Result == 0x00) + { + bb.Append(ByteConvert.ToBytes(this.AuthorizationCode)); + } + model.DataContent = bb.GetBytes(); + byte[] bModel = ByteConvert.Zy(model.GetBytes()); + return bModel; + } + } +} diff --git a/GPSBusiness/BBGPSStandard/Data_8103.cs b/GPSBusiness/BBGPSStandard/Data_8103.cs new file mode 100644 index 0000000..8ffd34c --- /dev/null +++ b/GPSBusiness/BBGPSStandard/Data_8103.cs @@ -0,0 +1,38 @@ +using System; +using GPSBusiness.Helper; +namespace GPSBusiness.BBGPSStandard +{ + /// + /// ն˲ + /// + public class Data_8103 + { + /// + /// + /// + public byte ParameterSum; + /// + /// ID + /// + public UInt16 ParameterID; + /// + /// + /// + public byte ParameterLength; + /// + /// ֵ + /// + public UInt16 ParameterValue; + public byte[] GetBytes(DataHead model) + { + ByteBuilder bb = new ByteBuilder(); + bb.Append(this.ParameterSum); + bb.Append(ByteConvert.ToBytes(this.ParameterID)); + bb.Append(ByteConvert.ToBytes(this.ParameterLength)); + bb.Append(ByteConvert.ToBytes(this.ParameterValue)); + model.DataContent = bb.GetBytes(); + byte[] bModel = ByteConvert.Zy(model.GetBytes()); + return bModel; + } + } +} diff --git a/GPSBusiness/BBGPSStandard/Data_8105.cs b/GPSBusiness/BBGPSStandard/Data_8105.cs new file mode 100644 index 0000000..cbc6fbc --- /dev/null +++ b/GPSBusiness/BBGPSStandard/Data_8105.cs @@ -0,0 +1,10 @@ +namespace GPSBusiness.BBGPSStandard +{ + /// + /// ն˿ + /// + public class Data_8105 + { + public byte Command; + } +} diff --git a/GPSBusiness/BBGPSStandard/Data_8201.cs b/GPSBusiness/BBGPSStandard/Data_8201.cs new file mode 100644 index 0000000..5243ac4 --- /dev/null +++ b/GPSBusiness/BBGPSStandard/Data_8201.cs @@ -0,0 +1,15 @@ +using GPSBusiness.Helper; +namespace GPSBusiness.BBGPSStandard +{ + /// + /// λϢѯ + /// + public class Data_8201 + { + public byte[] GetBytes(DataHead model) + { + byte[] bModel = ByteConvert.Zy(model.GetBytes()); + return bModel; + } + } +} diff --git a/GPSBusiness/BBGPSStandard/Data_8202.cs b/GPSBusiness/BBGPSStandard/Data_8202.cs new file mode 100644 index 0000000..229de59 --- /dev/null +++ b/GPSBusiness/BBGPSStandard/Data_8202.cs @@ -0,0 +1,28 @@ +using System; +using GPSBusiness.Helper; +namespace GPSBusiness.BBGPSStandard +{ + /// + /// ʱλøٿ + /// + public class Data_8202 + { + /// + /// ʱ + /// + public UInt16 TimeIntermission; + /// + /// λøЧ + /// + public UInt32 TimeValid; + public byte[] GetBytes(DataHead model) + { + ByteBuilder bb = new ByteBuilder(); + bb.Append(ByteConvert.ToBytes(this.TimeIntermission)); + bb.Append(ByteConvert.ToBytes(this.TimeValid)); + model.DataContent = bb.GetBytes(); + byte[] bModel = ByteConvert.Zy(model.GetBytes()); + return bModel; + } + } +} diff --git a/GPSBusiness/BBGPSStandard/Data_8300.cs b/GPSBusiness/BBGPSStandard/Data_8300.cs new file mode 100644 index 0000000..a3fc16a --- /dev/null +++ b/GPSBusiness/BBGPSStandard/Data_8300.cs @@ -0,0 +1,27 @@ +using GPSBusiness.Helper; +namespace GPSBusiness.BBGPSStandard +{ + /// + /// ıϢ· + /// + public class Data_8300 + { + /// + /// ־ + /// + public byte TextSign; + /// + /// ıϢ + /// + public string TextInformation; + public byte[] GetBytes(DataHead model) + { + ByteBuilder bb = new ByteBuilder(); + bb.Append(this.TextSign); + bb.Append(ByteConvert.ToBytes(this.TextInformation)); + model.DataContent = bb.GetBytes(); + byte[] bModel = ByteConvert.Zy(model.GetBytes()); + return bModel; + } + } +} diff --git a/GPSBusiness/BBGPSStandard/Data_8301.cs b/GPSBusiness/BBGPSStandard/Data_8301.cs new file mode 100644 index 0000000..59e5589 --- /dev/null +++ b/GPSBusiness/BBGPSStandard/Data_8301.cs @@ -0,0 +1,42 @@ +using GPSBusiness.Helper; +namespace GPSBusiness.BBGPSStandard +{ + /// + /// ¼ + /// + public class Data_8301 + { + /// + /// + /// + public byte SetType; + /// + /// + /// + public byte SetSum; + /// + /// ¼ID + /// + public byte SetID; + /// + /// ¼ݳ + /// + public byte Setength; + /// + /// ¼ + /// + public string SetContent; + public byte[] GetBytes(DataHead model) + { + ByteBuilder bb = new ByteBuilder(); + bb.Append(this.SetType); + bb.Append(this.SetSum); + bb.Append(this.SetID); + bb.Append(this.Setength); + bb.Append(ByteConvert.ToBytes(this.SetContent)); + model.DataContent = bb.GetBytes(); + byte[] bModel = ByteConvert.Zy(model.GetBytes()); + return bModel; + } + } +} diff --git a/GPSBusiness/BBGPSStandard/Data_8302.cs b/GPSBusiness/BBGPSStandard/Data_8302.cs new file mode 100644 index 0000000..ab26f05 --- /dev/null +++ b/GPSBusiness/BBGPSStandard/Data_8302.cs @@ -0,0 +1,32 @@ +using GPSBusiness.Helper; +namespace GPSBusiness.BBGPSStandard +{ + /// + /// · + /// + public class Data_8302 + { + /// + /// ־ + /// + public byte QuestionSign; + /// + /// ݳ + /// + public byte QuestionLength; + /// + /// + /// + public string QuestionContent; + public byte[] GetBytes(DataHead model) + { + ByteBuilder bb = new ByteBuilder(); + bb.Append(this.QuestionSign); + bb.Append(this.QuestionLength); + bb.Append(ByteConvert.ToBytes(this.QuestionContent)); + model.DataContent = bb.GetBytes(); + byte[] bModel = ByteConvert.Zy(model.GetBytes()); + return bModel; + } + } +} diff --git a/GPSBusiness/BBGPSStandard/Data_8303.cs b/GPSBusiness/BBGPSStandard/Data_8303.cs new file mode 100644 index 0000000..5dcf4fc --- /dev/null +++ b/GPSBusiness/BBGPSStandard/Data_8303.cs @@ -0,0 +1,48 @@ +using System; +using GPSBusiness.Helper; +namespace GPSBusiness.BBGPSStandard +{ + /// + /// Ϣ㲥˵ + /// + public class Data_8303 + { + /// + /// + /// + public byte SetType; + /// + /// Ϣ + /// + public byte DataSum; + /// + /// Ϣ + /// + public byte PacketSum; + /// + /// Ϣ + /// + public byte DataType; + /// + /// ϢƳ + /// + public UInt16 DataNameLength; + /// + /// Ϣ + /// + public string DataName; + public byte[] GetBytes(DataHead model) + { + ByteBuilder bb = new ByteBuilder(); + bb.Append(this.SetType); + bb.Append(this.DataSum); + bb.Append(this.PacketSum); + bb.Append(this.DataType); + bb.Append(ByteConvert.ToBytes(this.DataNameLength)); + bb.Append(ByteConvert.ToBytes(this.DataName)); + model.DataContent = bb.GetBytes(); + byte[] bModel = ByteConvert.Zy(model.GetBytes()); + return bModel; + } + } +} diff --git a/GPSBusiness/BBGPSStandard/Data_8304.cs b/GPSBusiness/BBGPSStandard/Data_8304.cs new file mode 100644 index 0000000..d1181b8 --- /dev/null +++ b/GPSBusiness/BBGPSStandard/Data_8304.cs @@ -0,0 +1,33 @@ +using System; +using GPSBusiness.Helper; +namespace GPSBusiness.BBGPSStandard +{ + /// + /// Ϣ + /// + public class Data_8304 + { + /// + /// Ϣ + /// + public byte DataType; + /// + /// Ϣ + /// + public UInt16 DataLength; + /// + /// Ϣ + /// + public string DataContent; + public byte[] GetBytes(DataHead model) + { + ByteBuilder bb = new ByteBuilder(); + bb.Append(this.DataType); + bb.Append(ByteConvert.ToBytes(this.DataLength)); + bb.Append(ByteConvert.ToBytes(this.DataContent)); + model.DataContent = bb.GetBytes(); + byte[] bModel = ByteConvert.Zy(model.GetBytes()); + return bModel; + } + } +} diff --git a/GPSBusiness/BBGPSStandard/Data_8400.cs b/GPSBusiness/BBGPSStandard/Data_8400.cs new file mode 100644 index 0000000..01a3053 --- /dev/null +++ b/GPSBusiness/BBGPSStandard/Data_8400.cs @@ -0,0 +1,27 @@ +using GPSBusiness.Helper; +namespace GPSBusiness.BBGPSStandard +{ + /// + /// 绰ز + /// + public class Data_8400 + { + /// + /// ־ + /// + public byte PhoneSign; + /// + /// 绰 + /// + public string PhoneNumber; + public byte[] GetBytes(DataHead model) + { + ByteBuilder bb = new ByteBuilder(); + bb.Append(this.PhoneSign); + bb.Append(ByteConvert.ToBytes(this.PhoneNumber)); + model.DataContent = bb.GetBytes(); + byte[] bModel = ByteConvert.Zy(model.GetBytes()); + return bModel; + } + } +} diff --git a/GPSBusiness/BBGPSStandard/Data_8401.cs b/GPSBusiness/BBGPSStandard/Data_8401.cs new file mode 100644 index 0000000..9ae275e --- /dev/null +++ b/GPSBusiness/BBGPSStandard/Data_8401.cs @@ -0,0 +1,52 @@ +using GPSBusiness.Helper; +namespace GPSBusiness.BBGPSStandard +{ + /// + /// õ绰 + /// + public class Data_8401 + { + /// + /// + /// + public byte SetType; + /// + /// ϵ + /// + public byte ContactPeopleSum; + /// + /// ־ + /// + public byte Sign; + /// + /// 볤 + /// + public byte PhoneLength; + /// + /// 绰 + /// + public string PhoneNumber; + /// + /// ϵ˳ + /// + public byte ContactPeopleLength; + /// + /// ϵ + /// + public string ContactPeople; + public byte[] GetBytes(DataHead model) + { + ByteBuilder bb = new ByteBuilder(); + bb.Append(this.SetType); + bb.Append(this.ContactPeopleSum); + bb.Append(this.Sign); + bb.Append(this.PhoneLength); + bb.Append(ByteConvert.ToBytes(this.PhoneNumber)); + bb.Append(this.ContactPeopleLength); + bb.Append(ByteConvert.ToBytes(this.ContactPeople)); + model.DataContent = bb.GetBytes(); + byte[] bModel = ByteConvert.Zy(model.GetBytes()); + return bModel; + } + } +} diff --git a/GPSBusiness/BBGPSStandard/Data_8500.cs b/GPSBusiness/BBGPSStandard/Data_8500.cs new file mode 100644 index 0000000..08069a5 --- /dev/null +++ b/GPSBusiness/BBGPSStandard/Data_8500.cs @@ -0,0 +1,22 @@ +using GPSBusiness.Helper; +namespace GPSBusiness.BBGPSStandard +{ + /// + /// + /// + public class Data_8500 + { + /// + /// Ʊ־ + /// + public byte ControlSign; + public byte[] GetBytes(DataHead model) + { + ByteBuilder bb = new ByteBuilder(); + bb.Append(this.ControlSign); + model.DataContent = bb.GetBytes(); + byte[] bModel = ByteConvert.Zy(model.GetBytes()); + return bModel; + } + } +} diff --git a/GPSBusiness/BBGPSStandard/Data_8900.cs b/GPSBusiness/BBGPSStandard/Data_8900.cs new file mode 100644 index 0000000..489892c --- /dev/null +++ b/GPSBusiness/BBGPSStandard/Data_8900.cs @@ -0,0 +1,24 @@ +using System; +using GPSBusiness.Helper; +namespace GPSBusiness.BBGPSStandard +{ + /// + /// ͻƽ̨·LEDʾͨ͸ָ0x8900· + /// + public class Data_8900 + { + /// + /// ҪʾϢ + /// + public byte[] data; + public byte[] GetBytes(DataHead model) + { + ByteBuilder bb = new ByteBuilder(); + bb.Append(ByteConvert.HexStringToByte("7E")); + bb.Append(data); + model.DataContent = bb.GetBytes(); + byte[] bModel = ByteConvert.Zy(model.GetBytes()); + return bModel; + } + } +} diff --git a/GPSBusiness/BBGPSStandard/Data_B003.cs b/GPSBusiness/BBGPSStandard/Data_B003.cs new file mode 100644 index 0000000..9a32198 --- /dev/null +++ b/GPSBusiness/BBGPSStandard/Data_B003.cs @@ -0,0 +1,28 @@ +using System; +using GPSBusiness.Helper; +namespace GPSBusiness.BBGPSStandard +{ + /// + /// gpsʱӦ + /// + public class Data_B003 + { + /// + /// Ӧˮ--ӦնעϢˮ + /// + public UInt16 Mdt_SerialNo; + /// + /// ϵͳʱ + /// + public byte[] SysTime; + public byte[] GetBytes(DataHead model) + { + ByteBuilder bb = new ByteBuilder(); + bb.Append(ByteConvert.ToBytes(this.Mdt_SerialNo)); + bb.Append(this.SysTime); + model.DataContent = bb.GetBytes(); + byte[] bModel = ByteConvert.Zy(model.GetBytes()); + return bModel; + } + } +} diff --git a/GPSBusiness/BaiDu/BaiduGPSServercs.cs b/GPSBusiness/BaiDu/BaiduGPSServercs.cs new file mode 100644 index 0000000..4b0f71c --- /dev/null +++ b/GPSBusiness/BaiDu/BaiduGPSServercs.cs @@ -0,0 +1,158 @@ +using log4net; +using Newtonsoft.Json; +using System; +using System.Collections.Generic; +using System.Configuration; +using System.Text; +using GpsModels; + +namespace GPSBusiness.BaiDu +{ + public class BaiduGpsServercs + { + public static ILog log = LogManager.GetLogger(""); + private static string BaiduApiUrl = ConfigurationSettings.AppSettings["BaiduApiUrl"]; + private static string BaiduAk = ConfigurationSettings.AppSettings["BaiduAk"]; + /// + /// 批量转换百度坐标(单次最大100) + /// + public static List Changes100(List list) + { + try + { + var reList = new List(); + string url = BaiduApiUrl + "/geoconv/v1/?coords="; + foreach (var item in list) + { + url += item.Longitude + "," + item.Latitude + ";"; + } + url = url.Remove(url.Length - 1) + "&from=1&to=5&ak=" + BaiduAk; + System.Net.WebRequest wReq = System.Net.WebRequest.Create(url); + System.Net.WebResponse wResp = wReq.GetResponse(); + System.IO.Stream respStream = wResp.GetResponseStream(); + using (System.IO.StreamReader reader = new System.IO.StreamReader(respStream, Encoding.UTF8)) + { + string value = reader.ReadToEnd(); + if (!string.IsNullOrEmpty(value)) + { + BaiduApiResult result = JsonConvert.DeserializeObject(value); + if (result.status == 0) + { + List xy = JsonConvert.DeserializeObject>(result.result.ToString()); + for (int i = 0; i < xy.Count; i++) + { + if (xy[i] != null) + { + list[i].Longitude = xy[i].x; + list[i].Latitude = xy[i].y; + reList.Add(list[i]); + } + } + } + } + } + return reList; + } + catch (Exception e) + { + log.Error("百度坐标转换 Exception:" + e.Message + e.StackTrace); + return null; + } + } + /// + /// 批量坐标转地址(单次最大20) + /// + public static List AddressChanges20(List list) + { + try + { + var reList = new List(); + string url = BaiduApiUrl + "/geocoder/v2/?callback=renderReverse&location="; + var count = 0; + var multy = 0; + foreach (var item in list) + { + url += item.Latitude + "," + item.Longitude + "|"; + count++; + if (count % 20 == 0) + { + url = url.Remove(url.Length - 1) + "&batch=true&pois=0&extensions_road=true&extensions_town=true&latest_admin=1&output=json&pois=1&ak=" + BaiduAk; + System.Net.WebRequest wReq = System.Net.WebRequest.Create(url); + System.Net.WebResponse wResp = wReq.GetResponse(); + System.IO.Stream respStream = wResp.GetResponseStream(); + using (System.IO.StreamReader reader = new System.IO.StreamReader(respStream, Encoding.UTF8)) + { + string value = reader.ReadToEnd(); + if (!string.IsNullOrEmpty(value)) + { + BaiduAddressApiResult result = JsonConvert.DeserializeObject(value); + if (result.status == 0) + { + List add = JsonConvert.DeserializeObject>(result.areas.ToString()); + + for (int i = 0; i < add.Count; i++) + { + if (add[i] != null) + { + list[i + multy*20].Address = add[i].city + add[i].district + add[i].town; + reList.Add(list[i]); + } + } + } + } + } + url = BaiduApiUrl + "/geocoder/v2/?callback=renderReverse&location="; + } + } + return reList; + } + catch (Exception e) + { + log.Error("百度坐标转换 Exception:" + e.Message + e.StackTrace); + return list; + } + } + } + /// + /// ApiResult + /// + public class BaiduApiResult + { + public int status { get; set; } + public string message { get; set; } + public object result { get; set; } + } + /// + /// 坐标 + /// + public class coordinate + { + /// + /// 纬度 + /// + public decimal x { get; set; } + /// + /// 经度 + /// + public decimal y { get; set; } + } + /// + /// BaiduAddressApiResult + /// + public class BaiduAddressApiResult + { + public int status { get; set; } + public object areas { get; set; } + } + /// + /// 坐标 + /// + public class addresss + { + public string country { get; set; } + public string province { get; set; } + public string city { get; set; } + public string district { get; set; } + public string town { get; set; } + } +} diff --git a/GPSBusiness/Core/Compression/Snappy/lib/win/snappy32.dll b/GPSBusiness/Core/Compression/Snappy/lib/win/snappy32.dll new file mode 100644 index 0000000..afc82ca Binary files /dev/null and b/GPSBusiness/Core/Compression/Snappy/lib/win/snappy32.dll differ diff --git a/GPSBusiness/Core/Compression/Snappy/lib/win/snappy64.dll b/GPSBusiness/Core/Compression/Snappy/lib/win/snappy64.dll new file mode 100644 index 0000000..36cd5fe Binary files /dev/null and b/GPSBusiness/Core/Compression/Snappy/lib/win/snappy64.dll differ diff --git a/GPSBusiness/Core/Compression/Zstandard/lib/win/libzstd.dll b/GPSBusiness/Core/Compression/Zstandard/lib/win/libzstd.dll new file mode 100644 index 0000000..e669123 Binary files /dev/null and b/GPSBusiness/Core/Compression/Zstandard/lib/win/libzstd.dll differ diff --git a/GPSBusiness/Enum/EnumExtension.cs b/GPSBusiness/Enum/EnumExtension.cs new file mode 100644 index 0000000..ea039f0 --- /dev/null +++ b/GPSBusiness/Enum/EnumExtension.cs @@ -0,0 +1,10 @@ +namespace GPSBusiness.Enum +{ + public static class EnumExtension + { + public static int ToEnumInt(this TerminalTypeEnum sucEnum) + { + return (int)sucEnum; + } + } +} diff --git a/GPSBusiness/Enum/GpsBrandEnum.cs b/GPSBusiness/Enum/GpsBrandEnum.cs new file mode 100644 index 0000000..7a25f2b --- /dev/null +++ b/GPSBusiness/Enum/GpsBrandEnum.cs @@ -0,0 +1,18 @@ +using System.ComponentModel; + +namespace GPSBusiness.Enum +{ + /// + /// 1 博实结KM02-2线 + + /// + public enum TerminalTypeEnum + { + /// + /// 博实结KG_M08四线 + /// + [Description("博实结KG_M08四线")] + BSJKGM_08 = 1, + + } +} diff --git a/GPSBusiness/Enum/RedisPrefixEnum.cs b/GPSBusiness/Enum/RedisPrefixEnum.cs new file mode 100644 index 0000000..426fbd0 --- /dev/null +++ b/GPSBusiness/Enum/RedisPrefixEnum.cs @@ -0,0 +1,26 @@ +using System; +using System.Collections.Generic; +using System.ComponentModel; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace GPSBusiness.Enum +{ + /// + /// Redis表前缀 + /// + public class RedisPrefixEnum + { + /// + /// Acc前缀 + /// + [Description("Acc前缀")] + public static string FirstAcc = "FirstAcc_"; + /// + /// 作业状态前缀 + /// + [Description("作业状态前缀")] + public static string FirstWork = "FirstWork_"; + } +} diff --git a/GPSBusiness/Enum/StatusEnum.cs b/GPSBusiness/Enum/StatusEnum.cs new file mode 100644 index 0000000..0145f20 --- /dev/null +++ b/GPSBusiness/Enum/StatusEnum.cs @@ -0,0 +1,26 @@ +using System; +using System.Collections.Generic; +using System.ComponentModel; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace GPSBusiness.Enum +{ + /// + /// 状态 1Acc 2作业状态 + /// + public enum StatusEnum + { + /// + /// Acc状态 + /// + [Description("Acc")] + Acc = 1, + /// + /// 作业状态 + /// + [Description("作业状态")] + Work = 2, + } +} diff --git a/GPSBusiness/GPSBusiness.csproj b/GPSBusiness/GPSBusiness.csproj new file mode 100644 index 0000000..d996231 --- /dev/null +++ b/GPSBusiness/GPSBusiness.csproj @@ -0,0 +1,227 @@ + + + + + Debug + AnyCPU + {5699F908-5B5C-4228-9EB7-6113B2B3992D} + Library + Properties + GPSBusiness + GPSBusiness + v4.7.2 + 512 + + + + + + true + full + false + ..\bin\x64\Debug\ + DEBUG;TRACE + prompt + 4 + x64 + false + + + pdbonly + true + bin\Release\ + TRACE + prompt + 4 + false + + + + ..\packages\DnsClient.1.4.0\lib\net471\DnsClient.dll + + + ..\lib\log4net.dll + + + ..\packages\MongoDB.Bson.2.13.1\lib\net452\MongoDB.Bson.dll + + + ..\packages\MongoDB.Driver.2.13.1\lib\net452\MongoDB.Driver.dll + + + ..\packages\MongoDB.Driver.Core.2.13.1\lib\net452\MongoDB.Driver.Core.dll + + + ..\packages\MongoDB.Libmongocrypt.1.2.3\lib\net472\MongoDB.Libmongocrypt.dll + + + ..\packages\MySql.Data.6.7.9\lib\net45\MySql.Data.dll + + + ..\lib\Newtonsoft.Json.dll + + + ..\packages\SharpCompress.0.23.0\lib\net45\SharpCompress.dll + + + False + ..\lib\StackExchange.Redis.dll + + + + ..\packages\System.Buffers.4.5.1\lib\net461\System.Buffers.dll + + + + + + + ..\packages\System.IO.4.3.0\lib\net462\System.IO.dll + True + True + + + ..\packages\System.Net.Http.4.3.4\lib\net46\System.Net.Http.dll + True + True + + + ..\packages\System.Runtime.4.3.0\lib\net462\System.Runtime.dll + True + True + + + + ..\packages\System.Runtime.CompilerServices.Unsafe.5.0.0\lib\net45\System.Runtime.CompilerServices.Unsafe.dll + + + ..\packages\System.Runtime.InteropServices.RuntimeInformation.4.3.0\lib\net45\System.Runtime.InteropServices.RuntimeInformation.dll + True + True + + + ..\packages\System.Security.Cryptography.Algorithms.4.3.0\lib\net463\System.Security.Cryptography.Algorithms.dll + True + True + + + ..\packages\System.Security.Cryptography.Encoding.4.3.0\lib\net46\System.Security.Cryptography.Encoding.dll + True + True + + + ..\packages\System.Security.Cryptography.Primitives.4.3.0\lib\net46\System.Security.Cryptography.Primitives.dll + True + True + + + ..\packages\System.Security.Cryptography.X509Certificates.4.3.0\lib\net461\System.Security.Cryptography.X509Certificates.dll + True + True + + + ..\packages\System.ValueTuple.4.5.0\lib\net47\System.ValueTuple.dll + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + {275fe3f1-11a3-46f5-8320-493926113c9e} + GpsModels + + + {dfa935e2-cf37-4e26-b697-d7f3dee19dd8} + HPSocketCS + + + + + + + + + + + + + + + + + + 这台计算机上缺少此项目引用的 NuGet 程序包。使用“NuGet 程序包还原”可下载这些程序包。有关更多信息,请参见 http://go.microsoft.com/fwlink/?LinkID=322105。缺少的文件是 {0}。 + + + + + + + + \ No newline at end of file diff --git a/GPSBusiness/GPSStandard/BBStandardToCarGPSHandler.cs b/GPSBusiness/GPSStandard/BBStandardToCarGPSHandler.cs new file mode 100644 index 0000000..45c4130 --- /dev/null +++ b/GPSBusiness/GPSStandard/BBStandardToCarGPSHandler.cs @@ -0,0 +1,332 @@ +using System; +using System.Text; +using GpsModels; +using GPSBusiness.Helper; +using Newtonsoft.Json; +using GPSBusiness.Redis; +using GPSBuSiness.Util; + +namespace GPSBusiness.GPSStandard +{ + /// + /// 车辆GPS数据处理器 + /// + public class BbStandardToCarGpsHandler : IStandardToCarGPSHandler + { + private static ICarService _service; + + public BbStandardToCarGpsHandler(ICarService service) + { + _service = service; + } + + /// + /// 获取gps数据 + /// + /// + /// + /// + /// + /// + public GpsModel GetGps(byte[] buffer, string terminalNo, IntPtr conid, bool isHeartBeat) + { + + try + { + var gpsModel = new GpsModel(); + var vehicleModel = _service.Get(terminalNo); + if (vehicleModel == null) return null; + gpsModel.VehicleId = vehicleModel.Id; + gpsModel.VehicleCode = vehicleModel.VehicleCode; + gpsModel.VehiclePlate = vehicleModel.VehiclePlate; + gpsModel.SimNo = vehicleModel.SimNo; + gpsModel.CompanyId = vehicleModel.CompanyId; + gpsModel.Status = vehicleModel.Status; + gpsModel.TerminalType = vehicleModel.TerminalType; + gpsModel.Acc = -1; + gpsModel.Work = -1; + gpsModel.GpsTime = gpsModel.RecTime = DateTime.Now; + if (isHeartBeat) return gpsModel; + //转译,转换为str + var data = ByteConvert.Fzy(buffer); + var dataStr = ByteConvert.ByteArrayToHexStr(data); + //判断GPS解析结果,长度小于55认为异常GPS信息予以过滤 + if (dataStr.Length > 55) + { + #region 获取,报警标识、状态 + try + { + + + //报警 + var BJ = dataStr.Substring(26, 8); + + // 欠压 + gpsModel.GpsAlert = Convert.ToInt32(BJ.Substring(6)); + + // 掉电 + gpsModel.Useing = Convert.ToInt32(BJ.Substring(7)); + + + //定位状态:0未定位,1有定位; + gpsModel.GpsState = Convert.ToInt32(dataStr.Substring(34, 8), 16); + //转成2进制字符串 + string stateTo2 = Convert.ToString(gpsModel.GpsState, 2).PadLeft(32, '0'); + //===获取gps是否定位 + gpsModel.LocationStatus = stateTo2.Substring((stateTo2.Length - 2), 1) == "1" ? 1 : 0; + //Acc状态(0关,1开) + gpsModel.Acc = stateTo2.Substring((stateTo2.Length - 1), 1) == "1" ? 1 : 0; + //作业状态(0关,1开) + gpsModel.Work = stateTo2.Substring((stateTo2.Length - 25), 1) == "1" ? 1 : 0; + //if (gpsModel.LocationStatus == 0) return gpsModel; + //===获取gps油电状态。 + var oilElectricState = stateTo2.Substring((stateTo2.Length - 31), 1) == "1" ? 1 : 0; + ////===获取gps防拆报警开关状态 + //var breakToogle = stateTo2.Substring((stateTo2.Length - 32), 1) == "1" ? 1 : 0; + + //string alertTo2 = Convert.ToString(gpsModel.GpsAlert, 2).PadLeft(32, '0'); //转成2进制字符串 + ////===获取gps超速报警 + //var speedAlert = alertTo2.Substring((alertTo2.Length - 2), 1) == "1" ? 1 : 0; + ////===获取gps被拆卸报警 + //var breakAlert = alertTo2.Substring((alertTo2.Length - 18), 1) == "1" ? 1 : 0; + + this.Log().DebugFormat("{0}-gps是否定位【{1}】,[VehicleId:{2}],[dataStr:{3}]", + gpsModel.VehicleId, gpsModel.LocationStatus, gpsModel.VehicleId, dataStr); + } + catch (Exception ex) + { + gpsModel.Acc = 0; + gpsModel.Work = 0; + //00000000 40000003 + //7E 02000036 91850002 4576017A 00000000 40000003 0160B672 06C24DD5 000C0000 00001902 22110213 01040000 03443001 6431010A FF0C01CC 00000000 25250000 EFC7DE 7E + this.Log().ErrorFormat("BB_GetTGps=定位状态报警状态Acc,dataStr=【{3}】,ex.Message={0},ex.InnerException={1},ex.StackTrace={2}", + ex.Message, ex.InnerException, ex.StackTrace, dataStr); + } + #endregion + #region 获取,经纬度 + try + { + + gpsModel.Longitude = 0; + gpsModel.Latitude = 0; + // gpsModel.GpsMode = 1; + if (gpsModel.LocationStatus == 0 && dataStr.Length > 184) //未定位进行基站解析 + { + //int mcc = Convert.ToInt32(dataStr.Substring(166, 4), 16); + //int mnc = Convert.ToInt32(dataStr.Substring(170, 2), 16); + //int lac = Convert.ToInt32(dataStr.Substring(172, 4), 16); + //int cellid = Convert.ToInt32(dataStr.Substring(176, 8), 16); + + //var baseStation = MapHelper.GetBaseStation(mcc, mnc, lac, cellid); + ////基站解析失败调用卫星经纬度 + //if (baseStation.infocode == 10000 && baseStation.result.location != null) + //{ + // var location = baseStation.result.location.Split(','); + // gpsModel.Longitude = Convert.ToDecimal(location[0]); + // gpsModel.Latitude = Convert.ToDecimal(location[1]); + // // gpsModel.GpsMode = 2; + //} + //else + //{ + // //获取经度纬度 + // var lati = Convert.ToUInt32(dataStr.Substring(42, 8), 16).ToString(); + // var longti = Convert.ToUInt32(dataStr.Substring(50, 8), 16).ToString(); + // //经度 + // if (longti.Length > 3) + // { + // string strLongti1 = longti.Substring(0, 3); + // string strLongti2 = longti.Substring(3); + // if (Convert.ToInt32(strLongti1) > 135) + // { + // strLongti1 = longti.Substring(0, 2); + // strLongti2 = longti.Substring(2); + // } + // decimal dbLongti = decimal.Parse(strLongti1 + "." + strLongti2); + // gpsModel.Longitude = dbLongti; + // } + // //纬度 + // if (lati.Length > 2) + // { + // string strLati1 = lati.Substring(0, 2); + // string strLati2 = lati.Substring(2); + // decimal dbLati = decimal.Parse(strLati1 + "." + strLati2); + // gpsModel.Latitude = dbLati; + // } + + //} + this.Log().InfoFormat($"基站定位,车辆Id:{gpsModel.VehicleId}"); + } + else + { + //获取经度纬度 + var lati = Convert.ToUInt32(dataStr.Substring(42, 8), 16).ToString(); + var longti = Convert.ToUInt32(dataStr.Substring(50, 8), 16).ToString(); + //经度 + if (longti.Length > 3) + { + string strLongti1 = longti.Substring(0, 3); + string strLongti2 = longti.Substring(3); + if (Convert.ToInt32(strLongti1) > 135) + { + strLongti1 = longti.Substring(0, 2); + strLongti2 = longti.Substring(2); + } + decimal dbLongti = decimal.Parse(strLongti1 + "." + strLongti2); + gpsModel.Longitude = dbLongti; + } + //纬度 + if (lati.Length > 2) + { + string strLati1 = lati.Substring(0, 2); + string strLati2 = lati.Substring(2); + decimal dbLati = decimal.Parse(strLati1 + "." + strLati2); + gpsModel.Latitude = dbLati; + } + //if (longti.Length <= 3 || lati.Length <= 2) + //{ + // this.Log().ErrorFormat("BB_GetTGps=经纬度解析异常,经度值或纬度值异常,dataStr=【{0}】", dataStr); + //} + //高德 + // gpsModel.Address = MapHelper.GetLocationByLngLat(gpsModel.Longitude, gpsModel.Latitude); + //腾讯 + // gpsModel.Address = MapHelper.GetTXLocationByLngLat(gpsModel.Longitude, gpsModel.Latitude); + } + + + } + catch (Exception ex) + { + //0160B672 和 06C24DD5 + //7E 02000036 91850002 4576017A 00000000 40000003 0160B672 06C24DD5 000C0000 00001902 22110213 01040000 03443001 6431010A FF0C01CC 00000000 25250000 EFC7DE 7E + this.Log().ErrorFormat("BB_GetTGps=经纬度解析异常,dataStr=【{3}】,ex.Message={0},ex.InnerException={1},ex.StackTrace={2}", + ex.Message, ex.InnerException, ex.StackTrace, dataStr); + } + #endregion + #region 获取,高程速度方向 + try + { + int speed = 0; + int direct = 0; + + //定位模式为基站 + if (gpsModel.LocationStatus == 0) + { + //取出上一个时间节点的经纬度 + var LastGpsTime = RedisRepository.GetLastGpsTime(gpsModel); + + var LastGpsTimeRepeatCount = RedisRepository.GetLastGpsTimeRepeatCount(gpsModel); + if (LastGpsTime != null) + { + var distance = GPSUtil.GetDistance(Convert.ToDouble(LastGpsTime.Latitude), Convert.ToDouble(LastGpsTime.Longitude), Convert.ToDouble(gpsModel.Latitude), Convert.ToDouble(gpsModel.Longitude)); + //移动 + if (distance != 0) + { + speed = Convert.ToInt32(distance / 10); + if (speed < 15 || speed > 85) + { + speed = new Random().Next(10, 37); + } + //清空 + RedisRepository.SetLastGpsTimeRepeatCount(gpsModel); + } + //未移动 + else + { + if (LastGpsTime.Speed > 5&& LastGpsTimeRepeatCount<3) + { + speed = new Random().Next(10, 37); + RedisRepository.IncrementLastGpsTimeRepeatCount(gpsModel); + } + + } + + direct = Convert.ToInt32(GPSUtil.GetAngle(Convert.ToDouble(LastGpsTime.Longitude), Convert.ToDouble(LastGpsTime.Latitude), Convert.ToDouble(gpsModel.Longitude), Convert.ToDouble(gpsModel.Latitude))); + if (direct > 360 || direct < 0) + { + direct = new Random().Next(120, 355); + } + + gpsModel.Direct = direct; + gpsModel.Speed = speed; + } + else + { + gpsModel.Speed = 0; + gpsModel.Direct = 0; + } + + + } + else + { + ////高程 + //int tall = Convert.ToInt32(dataStr.Substring(58, 4), 16); + //速度 + speed = Convert.ToInt32(Convert.ToInt32(dataStr.Substring(62, 4), 16) / 10); + gpsModel.Speed = speed; + //方向 + direct = Convert.ToInt32(dataStr.Substring(66, 4), 16); + gpsModel.Direct = direct; + } + //当GPS速度小于5时,默认为静态飘逸,修改速度及其状态 + if(speed<5) + { + gpsModel.Speed = 0; + gpsModel.GpsState = 3; + } + + + + } + catch (Exception ex) + { + //000C0000 0000 + //7E 02000036 91850002 4576017A 00000000 40000003 0160B672 06C24DD5 000C0000 00001902 22110213 01040000 03443001 6431010A FF0C01CC 00000000 25250000 EFC7DE 7E + this.Log().ErrorFormat("BB_GetTGps=高程速度方向获取dataStr=【{3}】,,ex.Message={0},ex.InnerException={1},ex.StackTrace={2}", + ex.Message, ex.InnerException, ex.StackTrace, dataStr); + } + + //存储这一次的信息 + RedisRepository.SetLastGpsTime(gpsModel); + #endregion + #region 获取时间 + StringBuilder sb = new StringBuilder(); + try + { + sb.Append("20"); + sb.Append(dataStr.Substring(70, 2)); + sb.Append("-"); + sb.Append(dataStr.Substring(72, 2)); + sb.Append("-"); + sb.Append(dataStr.Substring(74, 2)); + sb.Append(" "); + sb.Append(dataStr.Substring(76, 2)); + sb.Append(":"); + sb.Append(dataStr.Substring(78, 2)); + sb.Append(":"); + sb.Append(dataStr.Substring(80, 2)); + gpsModel.GpsTime = Convert.ToDateTime(sb.ToString()); + gpsModel.RecTime = DateTime.Now; + //00001902 22110213==>190222110213 + //7E 02000036 91850002 4576017A 00000000 40000003 0160B672 06C24DD5 000C0000 00001902 22110213 01040000 03443001 6431010A FF0C01CC 00000000 25250000 EFC7DE 7E + } //7E 02000040 01415005 727304C0 00000000 0000000301587E + catch (Exception ex) + { + gpsModel.GpsTime = gpsModel.RecTime = DateTime.Now; + this.Log().ErrorFormat("BB_GetTGps=gps时间获取【{3}】,dataStr=【{4}】,ex.Message={0},ex.InnerException={1},ex.StackTrace={2}", + ex.Message, ex.InnerException, ex.StackTrace, sb, dataStr); + } + #endregion + } + return gpsModel; + } + catch (Exception ex) + { + this.Log().ErrorFormat("BB_GetTGps=报错=,ex.Message={0},ex.InnerException={1},ex.StackTrace={2}", + ex.Message, ex.InnerException, ex.StackTrace); + return null; + } + } + + } +} diff --git a/GPSBusiness/GPSStandard/GPSResponseData.cs b/GPSBusiness/GPSStandard/GPSResponseData.cs new file mode 100644 index 0000000..88631b8 --- /dev/null +++ b/GPSBusiness/GPSStandard/GPSResponseData.cs @@ -0,0 +1,16 @@ +using GpsModels; + +namespace GPSBusiness.GPSStandard +{ + public class GPSResponseData + { + /// + /// 返回设备数数据,部标才会有 + /// + public byte[] ReturnData { get; set; } + /// + /// 车辆gps信息 + /// + public GpsModel GpsInfo { get; set; } + } +} diff --git a/GPSBusiness/GPSStandard/GPSStandardHelper.cs b/GPSBusiness/GPSStandard/GPSStandardHelper.cs new file mode 100644 index 0000000..128ed4d --- /dev/null +++ b/GPSBusiness/GPSStandard/GPSStandardHelper.cs @@ -0,0 +1,102 @@ +using System.Collections.Generic; +using GPSBusiness.BBGPSStandard; +using System.Linq; +using GPSBusiness.Helper; +using System; +using System.Text.RegularExpressions; + +namespace GPSBusiness.GPSStandard +{ + /// + /// gps协议帮帮助类 + /// + public static class GpsStandardHelper + { + public static IStandardToCarGPSHandler BBStandardToCarGPSHandler; + private static bool gege = true; + + /// + /// 处理粘包问题 + /// + /// + /// + /// + /// + public static List GetGpsStandardData(byte[] bytes, IntPtr conid, string mdtStr) + { + + try + { + var gpsResponseDatas = new List(); + string packet = ByteConvert.ByteArrayToHexStr(bytes); + //"GetGpsStandardData".Log().DebugFormat(" > [部标协议tcp请求]: {0}", packet); + //部标协议 + //以7E开头,7E结尾,中间没有其他&7E(表示没有粘包) + if (bytes[0] == 0x7E && bytes[bytes.Length - 1] == 0x7E && bytes.Count(u => u == 0x7E) == 2 && gege) + { + if (bytes.Length >= 15) + { + var responseData = BbGpsStandardService.GetGpsResponseDataForEqu(bytes, + BBStandardToCarGPSHandler, conid, mdtStr); + gpsResponseDatas.Add(responseData); + } + } + //部标粘包处理 + else if (bytes.Count(u => u == 0x7E) >= 2 && gege) + { + var list = GetSlxkValue(packet, "7E", "7E"); + foreach (var item in list) + { + //"GetGpsStandardData".Log().DebugFormat(" > [部标粘包处理item]: {0}", item); + byte[] by = ByteConvert.HexStringToByte(item); + gpsResponseDatas.Add(BbGpsStandardService.GetGpsResponseDataForEqu(by, BBStandardToCarGPSHandler, conid, mdtStr)); + } + } + //无法解释的协议,暂时不处理 + else + { + if (packet == "1B5B317E") gege = true; + if (packet == "1B5B347E") gege = false; + "GetGpsStandardData".Log().DebugFormat(" > [未知协议 tcp 请求]: " + packet + gege.ToString()); + } + return gpsResponseDatas; + } + catch (Exception) + { + throw; + } + } + //拿出符合要求的数据包 + public static List GetSlxkValue(string str, string s, string e) + { + Regex rg = new Regex("(?<=(" + s + "))((?!" + s + "|" + e + ").)*?(?=(" + e + "))", RegexOptions.Multiline | RegexOptions.Singleline); + var list = rg.Matches(str); + var result = new List(); + foreach (var item in list) + { + string packet = item.ToString(); + if (packet.Length > 0) + { + result.Add(string.Format("{0}{1}{2}", s, item, e)); + } + } + return result; + } + //拿出符合要求的数据包---这是旧的 + public static List GetValue(string str, string s, string e) + { + Regex rg = new Regex("(?<=(" + s + "))((?!" + s + "|" + e + ").)*?(?=(" + e + "))", RegexOptions.Multiline | RegexOptions.Singleline); + var list = rg.Matches(str); + var result = new List(); + foreach (var item in list) + { + string packet = item.ToString(); + if (packet.Length >= 78 && packet.Substring(packet.Length - 2) == "7E") + { + result.Add(string.Format("{0}{1}", s, item)); + } + } + return result; + } + } +} diff --git a/GPSBusiness/GPSStandard/ICarService.cs b/GPSBusiness/GPSStandard/ICarService.cs new file mode 100644 index 0000000..b572531 --- /dev/null +++ b/GPSBusiness/GPSStandard/ICarService.cs @@ -0,0 +1,17 @@ +using GpsModels; + +namespace GPSBusiness.GPSStandard +{ + /// + /// 车辆信息获取接口 + /// + public interface ICarService + { + /// + /// 通过mdt获取车辆信息 + /// + /// 设备码 + /// + VehicleModel Get(string mdt); + } +} diff --git a/GPSBusiness/GPSStandard/IStandardToCarGPSHandler.cs b/GPSBusiness/GPSStandard/IStandardToCarGPSHandler.cs new file mode 100644 index 0000000..d36580d --- /dev/null +++ b/GPSBusiness/GPSStandard/IStandardToCarGPSHandler.cs @@ -0,0 +1,10 @@ +using System; +using GpsModels; + +namespace GPSBusiness.GPSStandard +{ + public interface IStandardToCarGPSHandler + { + GpsModel GetGps(byte[] buffer, string mdt,IntPtr conid,bool isHeartBeat); + } +} diff --git a/GPSBusiness/Helper/ByteBuilder.cs b/GPSBusiness/Helper/ByteBuilder.cs new file mode 100644 index 0000000..ca65898 --- /dev/null +++ b/GPSBusiness/Helper/ByteBuilder.cs @@ -0,0 +1,150 @@ +using System; +using System.Collections.Generic; +namespace GPSBusiness.Helper +{ + /// + /// ֽIJ + /// + public class ByteBuilder + { + private byte[] _buffer = null; + private int _currentLength = 0; + public int Length + { + get + { + return _currentLength; + } + } + public ByteBuilder() + { + _buffer = new byte[0]; + } + public ByteBuilder(int length) + { + _buffer = new byte[length]; + } + public ByteBuilder(byte[] buffer) + { + _buffer = buffer; + } + /// + /// ֽ鳤 + /// + private void AppendBufferLength(int length) + { + _currentLength += length; + if (_currentLength > this._buffer.Length) + { + byte[] newbyte = new byte[_currentLength]; + this._buffer.CopyTo(newbyte, 0); + this._buffer = newbyte; + } + } + public void Append(byte value) + { + AppendBufferLength(1); + this._buffer.SetValue(value, this._currentLength - 1); + } + public void Append(byte[] buffer) + { + AppendBufferLength(buffer.Length); + Array.Copy(buffer, 0, this._buffer, _currentLength - buffer.Length, buffer.Length); + } + public void Append(byte[] buffer, int index, int length) + { + byte[] newbyte = new byte[length]; + Array.Copy(buffer, index, newbyte, 0, Math.Min(length, buffer.Length)); + this.Append(newbyte); + } + public void Insert(int index, byte[] buffer) + { + _currentLength += buffer.Length; + byte[] newbyte = null; + if (_currentLength > this._buffer.Length) + { + newbyte = new byte[_currentLength]; + } + else + { + newbyte = new byte[this._buffer.Length]; + } + Array.Copy(this._buffer, 0, newbyte, 0, index); + Array.Copy(buffer, index, newbyte, index, buffer.Length); + Array.Copy(this._buffer, index, newbyte, index + buffer.Length, _currentLength - index - buffer.Length); + this._buffer = newbyte; + } + public void Insert(int index, byte value) + { + this.Insert(index, new byte[1] { value }); + } + public byte GetByte(int index) + { + return (byte)BitConverter.ToChar(_buffer, index); + } + public byte[] GetBytes() + { + return _buffer; + } + public byte[] GetBytes(int index, int length) + { + byte[] buffer = new byte[length]; + Array.Copy(_buffer, index, buffer, 0, length); + return buffer; + } + public void Clear() + { + this._buffer = new byte[0]; + } + public List Splite(byte value) + { + return Splite(value, 0, -1); + } + public List Splite(byte value, int start, int length) + { + List list = new List(); + if (length == -1) + { + length = this._buffer.Length; + } + else + { + length = Math.Min(length, this._buffer.Length); + } + int index = start; + for (int i = start; i < length; i++) + { + byte b = _buffer[i]; + if (b == value) + { + int len = i - index; + byte[] buffer = new byte[len]; + if (len > 0) + { + Array.Copy(_buffer, index, buffer, 0, len); + } + list.Add(buffer); + if (list.Count > 0) + { + index = i + 1; + } + else + { + index = i; + } + } + } + int len2 = _buffer.Length - index; + if (len2 >= 0) + { + byte[] buffer = new byte[len2]; + if (len2 > 0) + { + Array.Copy(_buffer, index, buffer, 0, len2); + } + list.Add(buffer); + } + return list; + } + } +} diff --git a/GPSBusiness/Helper/ByteConvert.cs b/GPSBusiness/Helper/ByteConvert.cs new file mode 100644 index 0000000..c429bc9 --- /dev/null +++ b/GPSBusiness/Helper/ByteConvert.cs @@ -0,0 +1,367 @@ +using System; +using System.Collections.Generic; +using System.Runtime.InteropServices; +using System.Text; +namespace GPSBusiness.Helper +{ + public class ByteConvert + { + public static System.Text.Encoding GB2312 = System.Text.Encoding.GetEncoding("gb2312"); + public static string ToString(byte[] buffer) + { + return GB2312.GetString(buffer); + } + public static string ToString(byte[] buffer, int index, int length) + { + return GB2312.GetString(ToBytes(buffer, index, length)); + } + public static Int16 ToInt16(byte[] buffer, int index) + { + byte[] newbyte = ToBytes(buffer, index, 2); + Array.Reverse(newbyte); + return BitConverter.ToInt16(newbyte, 0); + } + public static UInt16 ToUInt16(byte[] buffer, int index) + { + byte[] newbyte = ToBytes(buffer, index, 2); + Array.Reverse(newbyte); + return BitConverter.ToUInt16(newbyte, 0); + } + public static Int32 ToInt32(byte[] buffer, int index) + { + byte[] newbyte = ToBytes(buffer, index, 4); + Array.Reverse(newbyte); + return BitConverter.ToInt32(newbyte, 0); + } + public static UInt32 ToUInt32(byte[] buffer, int index) + { + byte[] newbyte = ToBytes(buffer, index, 4); + Array.Reverse(newbyte); + return BitConverter.ToUInt32(newbyte, 0); + } + public static byte[] ToBytes(byte[] buffer, int index, int length) + { + try + { + byte[] newbyte = new byte[length]; + Array.Copy(buffer, index, newbyte, 0, length); + return newbyte; + } + catch (Exception E) + { + return null; + } + } + public static byte[] ToBytes(byte[] buffer, int length) + { + int index = 0; + if (buffer.Length < length) + { + index = length - buffer.Length; + } + return ToBytes(buffer, index, length); + } + public static byte[] ToBytes(string value) + { + return GB2312.GetBytes(value); + } + public static byte[] ToBytes(string value, int index, int length) + { + if (value == null) value = string.Empty; + string strValue = value.PadRight(length, '0'); + return GB2312.GetBytes(strValue.ToCharArray(), index, length); + } + public static byte[] ToBytes(string value, int length) + { + return ToBytes(value, 0, length); + } + public static byte[] ToBytes(Int32 value) + { + byte[] buffer = BitConverter.GetBytes(value); + Array.Reverse(buffer); + return buffer; + } + public static byte[] ToBytes(UInt32 value) + { + byte[] buffer = BitConverter.GetBytes(value); + Array.Reverse(buffer); + return buffer; + } + public static byte[] ToBytes(Int16 value) + { + byte[] buffer = BitConverter.GetBytes(value); + Array.Reverse(buffer); + return buffer; + } + public static byte[] ToBytes(UInt16 value) + { + byte[] buffer = BitConverter.GetBytes(value); + Array.Reverse(buffer); + return buffer; + } + public static UInt32 GetMdt(byte[] buffer) + { + byte[] byte_Simid = new byte[6]; + Array.Copy(buffer, 0, byte_Simid, 0, 4); + string str_Simid = ""; + for (int j = 0; j < 4; j++) + { + int chu = byte_Simid[j] / 16; + int yu = byte_Simid[j] % 16; + string chuStr = chu.ToString("X"); + string yuStr = yu.ToString("X"); + string retStr = chuStr + yuStr; + str_Simid += retStr; + } + return Convert.ToUInt32(str_Simid, 16); + } + public static byte GetCRC(byte[] buffer, int index, int length) + { + byte value = buffer[index]; + for (int i = index + 1; i < length + index; i++) + { + value = (byte)(value ^ buffer[i]); + } + return value; + } + /// + /// תȥʶλ0x7e,0x7d 0x01תΪ0x7d0x7d 0x02תΪ0x7e + /// + /// + /// + public static byte[] Fzy(byte[] buffer) + { + int length = buffer.Length; + List list = new List(); + list.Add(0x7e); + for (int i = 1; i < length - 1; i++) + { + if (i > length) + { + continue; + } + if (buffer[i] == 0x7d) + { + byte bn = buffer[i + 1]; + if (bn == 0x01) + { + list.Add(0x7d); + i++; + } + else if (bn == 0x02) + { + list.Add(0x7e); + i++; + } + else + { + list.Add(buffer[i]); + } + } + else + { + list.Add(buffer[i]); + if (i + 5 < length) + { + if (buffer[i] == 0x7e && buffer[i + 1] == 0x00 && buffer[i + 2] == 0x00 && buffer[i + 3] == 0x00) + { + return list.ToArray(); + } + } + } + } + list.Add(0x7e); + return list.ToArray(); + } + public static byte[] Zy(byte[] buffer) + { + int length = buffer.Length; + List list = new List(); + list.Add(0x7e); + for (int i = 1; i < length - 1; i++) + { + if (i > length) + { + continue; + } + if (buffer[i] == 0x7e) + { + list.Add(0x7d); + list.Add(0x02); + } + else if (buffer[i] == 0x7d) + { + list.Add(0x7d); + list.Add(0x01); + } + else + { + list.Add(buffer[i]); + } + } + list.Add(0x7e); + return list.ToArray(); + } + /// + /// ֽתʮַ + /// + /// Ҫתֽ + /// + public static string ByteArrayToHexStr(byte[] byteArray) + { + if (byteArray == null) return ""; + int capacity = byteArray.Length * 2; + StringBuilder sb = new StringBuilder(capacity); + if (byteArray != null) + { + for (int i = 0; i < byteArray.Length; i++) + { + sb.Append(byteArray[i].ToString("X2")); + } + } + return sb.ToString(); + } + /// + /// תʮַ + /// + // public static final String bytesToHexString(byte[] bArray) { + // StringBuffer sb = new StringBuffer(bArray.length); + // String sTemp; + // for (int i = 0; i < bArray.length; i++) { + // sTemp = Integer.toHexString(0xFF & bArray[i]); + // if (sTemp.length() < 2) + // sb.append(0); + // sb.append(sTemp.toUpperCase()); + // } + // return sb.toString(); + // } + //public static String toHexString1(byte[] b) + //{ + // StringBuffer buffer = new StringBuffer(); + // for (int i = 0; i < b.length; ++i) + // { + // buffer.append(toHexString1(b[i])); + // } + // return buffer.toString(); + //} + //public static String toHexString1(byte b) + //{ + // String s = Integer.toHexString(b & 0xFF); + // if (s.length() == 1) + // { + // return "0" + s; + // } + // else + // { + // return s; + // } + //} + /// + /// 16ַתbyte + /// + //public static byte[] HexStringToByte2(string hex) + //{ + // int len = (hex.Length / 2); + // byte[] result = new byte[len]; + // char[] achar = hex.ToCharArray(); + // for (int i = 0; i < len; i++) + // { + // int pos = i * 2; + // result[i] = (byte)(Convert.ToByte(achar[pos]) << 4 | Convert.ToByte(achar[pos + 1])); + // } + // return result; + //} + /// + /// 16ַתֽ + /// + public static byte[] HexStringToByte(string hex) + { + int len = (hex.Length / 2); + byte[] result = new byte[len]; + char[] achar = hex.ToCharArray(); + for (int i = 0; i < len; i++) + { + int pos = i * 2; + result[i] = (byte)(ToByte(achar[pos]) << 4 | ToByte(achar[pos + 1])); + } + return result; + } + private static int ToByte(char c) + { + byte b = (byte)"0123456789ABCDEF".IndexOf(c); + return b; + } + //byte[]תʮַ2 + public static byte[] GetSendBuffer(byte[] headerBytes, byte[] bodyBytes) + { + IntPtr ptr = IntPtr.Zero; + try + { + int bufferSize = headerBytes.Length + bodyBytes.Length; + ptr = Marshal.AllocHGlobal(bufferSize); + // ͷײ + Marshal.Copy(headerBytes, 0, ptr, headerBytes.Length); + // 嵽ʣಿ + Marshal.Copy(bodyBytes, 0, ptr + headerBytes.Length, bodyBytes.Length); + byte[] bytes = new byte[bufferSize]; + Marshal.Copy(ptr, bytes, 0, bufferSize); + return bytes; + } + finally + { + if (ptr != IntPtr.Zero) + { + Marshal.FreeHGlobal(ptr); + } + } + } + /// + /// ַת16ֽ + /// + /// + /// + public static byte[] StrToToHexByte(string hexString) + { + hexString = hexString.Replace(" ", ""); + if ((hexString.Length % 2) != 0) + hexString = hexString.Insert(hexString.Length - 1, 0.ToString()); + byte[] returnBytes = new byte[hexString.Length / 2]; + for (int i = 0; i < returnBytes.Length; i++) + returnBytes[i] = Convert.ToByte(hexString.Substring(i * 2, 2), 16); + return returnBytes; + } + + public static byte IntToBcd(int n) + { + // extract each digit from the input number n + byte d1 = (byte) (n / 10); + byte d2 = (byte) (n % 10); + // combine the decimal digits into a BCD number + return (byte) ((d1 << 4) | d2); + } + + public static byte ConvertBcd(byte b)//byteתΪBCD + { + //λ + byte b1 = (byte)(b / 10); + //λ + byte b2 = (byte)(b % 10); + return (byte)((b1 << 4) | b2); + } + + /// + /// BCDһֽתbyte ʮ + /// + /// ֽ + /// תBCD + public static byte ConvertBcdToInt(byte b) + { + //λ + byte b1 = (byte)((b >> 4) & 0xF); + //λ + byte b2 = (byte)(b & 0xF); + return (byte)(b1 * 10 + b2); + } + + } +} diff --git a/GPSBusiness/Helper/CacheManager.cs b/GPSBusiness/Helper/CacheManager.cs new file mode 100644 index 0000000..f51f2d3 --- /dev/null +++ b/GPSBusiness/Helper/CacheManager.cs @@ -0,0 +1,65 @@ +using System; +using System.Collections.Concurrent; +using System.Collections.Generic; +using System.ComponentModel; +using System.Linq; +using System.Runtime.Caching; +using System.Runtime.InteropServices; +using System.Text; +namespace GPSBusiness.Helper +{ + public class CacheManager + { + private MemoryCache my = new MemoryCache("my"); + /// + /// 添加项 + /// + /// + /// + public void Add(string key, object value) + { + my.Set(key, value, new CacheItemPolicy() { }); + } + /// + /// 添加项,加过期时间 + /// + /// + /// + public void Add(string key, object value, TimeSpan timeSpan) + { + my.Set(key, value, new CacheItemPolicy() { SlidingExpiration = timeSpan }); + } + /// + /// 移除项 + /// + /// + public void Remove(string key) + { + my.Remove(key); + } + /// + /// 获取 + /// + /// + public object Get(string key) + { + return my.Get(key); + } + /// + /// 获取 + /// + /// + public T Get(string key) + { + try + { + var v = (T)my.Get(key); + return v; + } + catch (Exception) + { + return default(T); + } + } + } +} diff --git a/GPSBusiness/Helper/CalculationGpsHelper.cs b/GPSBusiness/Helper/CalculationGpsHelper.cs new file mode 100644 index 0000000..3fd1507 --- /dev/null +++ b/GPSBusiness/Helper/CalculationGpsHelper.cs @@ -0,0 +1,113 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; +namespace GPSServer.Helper +{ + public class CalculationGpsHelper + { + /// + /// 地球的半径 + /// + private const double EarthRadius = 6378137.0;//地球半径(米) + /// + /// 角度数转换为弧度公式 + /// + /// + /// + private static double Radians(double d) + { + return d * Math.PI / 180.0; + } + /// + /// 弧度转换为角度数公式 + /// + /// + /// + private static double Degrees(double d) + { + return d * (180 / Math.PI); + } + // 计算2个经纬度距离 + public static int GetDistance(double lng1, double lat1, double lng2, double lat2) + { + //最东端 东经135度2分30秒 黑龙江和乌苏里江交汇处 + //最西端 东经73度40分 帕米尔高原乌兹别里山口(乌恰县) + //最南端 北纬3度52分 南沙群岛曾母暗沙 + //最北端 北纬53度33分 漠河以北黑龙江主航道(漠河) + try + { + if (lng1 > 73 && lat1 > 3 && lng2 > 73 && lat2 > 3) + { + decimal proDecimal = (decimal)CalculationDistance(lng1, lat1, lng2, lat2); + return Convert.ToInt32(proDecimal); + } + return 0; + } + catch (Exception) + { + return 0; + } + } + /// + /// 计算坐标点的距离 + /// + /// 开始的经度 + /// 开始的纬度 + /// 结束的经度 + /// 结束的纬度 + /// 距离(米) + public static double CalculationDistance(double long1, double lat1, double long2, double lat2) + { + double a, b, R; + R = EarthRadius; //地球半径 + lat1 = Radians(lat1); + lat2 = Radians(lat2); + a = lat1 - lat2; + b = Radians(long1-long2); + double d, sa2, sb2; + sa2 = Math.Sin(a / 2.0); + sb2 = Math.Sin(b / 2.0); + d = 2 * R * Math.Asin(Math.Sqrt(sa2 * sa2 + Math.Cos(lat1) * Math.Cos(lat2) * sb2 * sb2)); + return d; + } + + + /// + /// 时间差格式转换 + /// + /// 时间差 + /// 精确度,默认为2 + /// + public static string TimeSpanFormat(TimeSpan ts, int Accuracy = 2) + { + StringBuilder sb = new StringBuilder(); + int idx = 0; + if (ts.Days != 0 && idx < Accuracy) + { + sb.Append(ts.Days + "天"); + idx++; + } + if (ts.Hours != 0 && idx < Accuracy) + { + sb.Append(ts.Hours + "小时"); + idx++; + } + if (ts.Minutes != 0 && idx < Accuracy) + { + sb.Append(ts.Minutes + "分"); + idx++; + } + if (ts.Seconds != 0 && idx < Accuracy) + { + sb.Append(ts.Seconds + "秒"); + } + if (ts.Days == 0 && ts.Hours == 0 && ts.Minutes == 0 && ts.Seconds == 0) + { + sb.Append("0秒"); + } + return sb.ToString(); + } + } +} diff --git a/GPSBusiness/Helper/ConvertGps.cs b/GPSBusiness/Helper/ConvertGps.cs new file mode 100644 index 0000000..18bfcdb --- /dev/null +++ b/GPSBusiness/Helper/ConvertGps.cs @@ -0,0 +1,142 @@ +using System; +using GpsModels; + +namespace GPSBusiness.Helper +{ + //===高德谷歌使用:火星坐标系 (GCJ-02)===百度使用:(BD-09)坐标系为前者的加密=== + //===部标Gps一般采用:WGS84坐标系。 + public static class ConvertGps + { + private static double pi = 3.1415926535897932384626; + private static double a = 6378245.0; + private static double ee = 0.00669342162296594323; + private static double bd_pi = 3.14159265358979324 * 3000.0 / 180.0; + static Boolean OutOfChina(double lat, double lon) + { + if (lon < 72.004 || lon > 137.8347) + return true; + if (lat < 0.8293 || lat > 55.8271) + return true; + return false; + } + static double TransformLat(double x, double y) + { + double ret = -100.0 + 2.0 * x + 3.0 * y + 0.2 * y * y + 0.1 * x * y + + 0.2 * Math.Sqrt(Math.Abs(x)); + ret += (20.0 * Math.Sin(6.0 * x * pi) + 20.0 * Math.Sin(2.0 * x * pi)) * 2.0 / 3.0; + ret += (20.0 * Math.Sin(y * pi) + 40.0 * Math.Sin(y / 3.0 * pi)) * 2.0 / 3.0; + ret += (160.0 * Math.Sin(y / 12.0 * pi) + 320 * Math.Sin(y * pi / 30.0)) * 2.0 / 3.0; + return ret; + } + static double TransformLon(double x, double y) + { + double ret = 300.0 + x + 2.0 * y + 0.1 * x * x + 0.1 * x * y + 0.1 + * Math.Sqrt(Math.Abs(x)); + ret += (20.0 * Math.Sin(6.0 * x * pi) + 20.0 * Math.Sin(2.0 * x * pi)) * 2.0 / 3.0; + ret += (20.0 * Math.Sin(x * pi) + 40.0 * Math.Sin(x / 3.0 * pi)) * 2.0 / 3.0; + ret += (150.0 * Math.Sin(x / 12.0 * pi) + 300.0 * Math.Sin(x / 30.0 + * pi)) * 2.0 / 3.0; + return ret; + } + + // 【84】-->【GCJ-02】 + public static PointLatLng Gps84ToGcj02(PointLatLng gpoint) + { + if (OutOfChina(gpoint.Lat, gpoint.Lng)) + { + return new PointLatLng(0, 0); + } + double dLat = TransformLat(gpoint.Lng - 105.0, gpoint.Lat - 35.0); + double dLon = TransformLon(gpoint.Lng - 105.0, gpoint.Lat - 35.0); + double radLat = gpoint.Lat / 180.0 * pi; + double magic = Math.Sin(radLat); + magic = 1 - ee * magic * magic; + double sqrtMagic = Math.Sqrt(magic); + dLat = (dLat * 180.0) / ((a * (1 - ee)) / (magic * sqrtMagic) * pi); + dLon = (dLon * 180.0) / (a / sqrtMagic * Math.Cos(radLat) * pi); + double mgLat = gpoint.Lat + dLat; + double mgLon = gpoint.Lng + dLon; + return new PointLatLng(mgLat, mgLon); + } + + // 【GCJ-02】-->【84】 + public static PointLatLng Gcj02ToGps84(PointLatLng gpoint) + { + PointLatLng gps = Transform(gpoint); + double lontitude = gpoint.Lng * 2 - gps.Lng; + double latitude = gpoint.Lat * 2 - gps.Lat; + return new PointLatLng(latitude, lontitude); + } + + // 【GCJ-02】-->【BD-09】 + public static PointLatLng Gcj02ToBd09(PointLatLng gpoint) + { + double x = gpoint.Lng, y = gpoint.Lat; + double z = Math.Sqrt(x * x + y * y) + 0.00002 * Math.Sin(y * bd_pi); + double theta = Math.Atan2(y, x) + 0.000003 * Math.Cos(x * bd_pi); + double bd_lon = z * Math.Cos(theta) + 0.0065; + double bd_lat = z * Math.Sin(theta) + 0.006; + return new PointLatLng(bd_lat, bd_lon); + } + + // 【BD-09】-->【GCJ-02】 + public static PointLatLng Bd09ToGcj02(PointLatLng bdPoint) + { + double x = bdPoint.Lng - 0.0065, y = bdPoint.Lat - 0.006; + double z = Math.Sqrt(x * x + y * y) - 0.00002 * Math.Sin(y * bd_pi); + double theta = Math.Atan2(y, x) - 0.000003 * Math.Cos(x * bd_pi); + double gg_lon = z * Math.Cos(theta); + double gg_lat = z * Math.Sin(theta); + return new PointLatLng(gg_lat, gg_lon); + } + + // 【BD-09】-->【84】 + public static PointLatLng Bd09ToGps84(PointLatLng bdPoint) + { + PointLatLng gcj02 = Bd09ToGcj02(bdPoint); + PointLatLng map84 = Gcj02ToGps84(gcj02); + //保留小数点后六位 + //map84.Lat = Retain6(map84.Lat); + //map84.Lng = Retain6(map84.Lng); + return map84; + } + + //【84】-->【BD-09】 + public static PointLatLng Gps84ToBd09(PointLatLng gpsPoint) + { + PointLatLng gcj02 = Gps84ToGcj02(gpsPoint); + PointLatLng bd09 = Gcj02ToBd09(gcj02); + return bd09; + } + + static PointLatLng Transform(PointLatLng gpoint) + { + if (OutOfChina(gpoint.Lat, gpoint.Lng)) + { + return new PointLatLng(gpoint.Lat, gpoint.Lng); + } + double dLat = TransformLat(gpoint.Lng - 105.0, gpoint.Lat - 35.0); + double dLon = TransformLon(gpoint.Lng - 105.0, gpoint.Lat - 35.0); + double radLat = gpoint.Lat / 180.0 * pi; + double magic = Math.Sin(radLat); + magic = 1 - ee * magic * magic; + double sqrtMagic = Math.Sqrt(magic); + dLat = (dLat * 180.0) / ((a * (1 - ee)) / (magic * sqrtMagic) * pi); + dLon = (dLon * 180.0) / (a / sqrtMagic * Math.Cos(radLat) * pi); + double mgLat = gpoint.Lat + dLat; + double mgLon = gpoint.Lng + dLon; + return new PointLatLng(mgLat, mgLon); + } + + /// + /// 保留小数点后六位 + /// + /// + /// + private static double Retain6(double num) + { + String result = String.Format("%.6f", num); + return Double.Parse(result); + } + } +} diff --git a/GPSBusiness/Helper/ConvertHelp.cs b/GPSBusiness/Helper/ConvertHelp.cs new file mode 100644 index 0000000..e65c0d9 --- /dev/null +++ b/GPSBusiness/Helper/ConvertHelp.cs @@ -0,0 +1,81 @@ +using System; +using System.Collections.Generic; +using System.ComponentModel; +using System.Data; +using System.Linq; +using System.Reflection; +using System.Text; +using System.Threading.Tasks; +namespace GPSBusiness.Helper +{ + /// + /// 利用反射和泛型 + /// + public class ConvertHelp where T : new() + { + /// + /// tb转list + /// + public static List ConvertToList(DataTable dt) + { + // 定义集合 + List ts = new List(); + // 获得此模型的类型 + Type type = typeof(T); + //定义一个临时变量 + string tempName = string.Empty; + //遍历DataTable中所有的数据行 + foreach (DataRow dr in dt.Rows) + { + T t = new T(); + // 获得此模型的公共属性 + PropertyInfo[] propertys = t.GetType().GetProperties(); + //遍历该对象的所有属性 + foreach (PropertyInfo pi in propertys) + { + tempName = pi.Name;//将属性名称赋值给临时变量 + //检查DataTable是否包含此列(列名==对象的属性名) + if (dt.Columns.Contains(tempName)) + { + // 判断此属性是否有Setter + if (!pi.CanWrite) continue;//该属性不可写,直接跳出 + //取值 + object value = dr[tempName]; + //如果非空,则赋给对象的属性 + if (value != DBNull.Value) + pi.SetValue(t, value, null); + } + } + //对象添加到泛型集合中 + ts.Add(t); + } + return ts; + } + } + public static class DTHelper + { + /// + /// 将List转换成DataTable + /// + public static DataTable ConvertToTable(this IList data) + { + PropertyDescriptorCollection properties = TypeDescriptor.GetProperties(typeof(T)); + DataTable dt = new DataTable(); + for (int i = 0; i < properties.Count; i++) + { + PropertyDescriptor property = properties[i]; + dt.Columns.Add(property.Name, property.PropertyType); + } + object[] values = new object[properties.Count]; + foreach (T item in data) + { + for (int i = 0; i < values.Length; i++) + { + values[i] = properties[i].GetValue(item); + } + dt.Rows.Add(values); + } + return dt; + } + } +} diff --git a/GPSBusiness/Helper/MapHelper.cs b/GPSBusiness/Helper/MapHelper.cs new file mode 100644 index 0000000..d3aecda --- /dev/null +++ b/GPSBusiness/Helper/MapHelper.cs @@ -0,0 +1,434 @@ +using GPSBusiness.Model; +using Newtonsoft.Json.Linq; +using System; +using System.Collections.Generic; +using System.IO; +using System.Linq; +using System.Net; +using System.Text; +using System.Threading.Tasks; + +namespace GPSBusiness.Helper +{ + public static class MapHelper + { + private const string key = "89981abaf32ae94b09a639c54845e089"; //高德 + private const string ak = "gxoEbH7Fj52wc1LVwRsGGOC5"; //百度 + private const string txkey = "WANBZ-6C56D-6P34Y-HWNMG-YHAH7-BJFP5"; //腾讯 + + /// + /// 传入经度纬度 + /// + /// 经度 + /// 纬度 + public static string GetLonLatUrl(string lat, string lon) + { + string LonLat = ""; + string url = "http://api.map.baidu.com/ag/coord/convert?from=0&to=4&x=" + lon + "&y=" + lat + ""; + + System.Net.HttpWebRequest requst = (System.Net.HttpWebRequest)System.Net.HttpWebRequest.Create(url);//http传输协议 + System.Net.HttpWebResponse respone = (System.Net.HttpWebResponse)requst.GetResponse();//活的http的网络资源 + System.IO.Stream stream = respone.GetResponseStream();//转换成字节流 + System.IO.StreamReader sr = new System.IO.StreamReader(stream, Encoding.GetEncoding("utf-8"));//已utf-8模式读取数据 + string responestr = sr.ReadToEnd(); + sr.Close(); + sr.Dispose();//释放资源 + string[] responeArr = responestr.Split('\"'); + if (responeArr.Length >= 11) + { + LonLat = GetbyBase64("utf-8", responeArr[5]) + "," + GetbyBase64("utf-8", responeArr[9]); + } + + return LonLat; + } + + /// + /// 解析base64信息数据 + /// + /// 解析编码格式 + /// 传入的base64位值 + /// + public static string GetbyBase64(string code_type, string code) + { + string decode = ""; + byte[] bytes = Convert.FromBase64String(code); + try + { + decode = Encoding.GetEncoding(code_type).GetString(bytes); + } + catch + { + decode = code; + } + return decode; + } + + /// + /// 根据经纬度获取地图信息(高德) + /// + /// 超时时间默认10秒 + /// 经纬度字符串 + /// 失败返回"" + public static MapLocation GetMapLocation(string strLatLng, int timeout = 10000) + { + try + { + string url = + string.Format("http://restapi.amap.com/v3/geocode/regeo?key={0}&batch=true&location={1}", + key, strLatLng); + + string apiText = HttpGet(url, timeout); + return JObject.Parse(apiText).ToObject(); + } + catch (Exception) + { + return new MapLocation(); + } + } + + /// + /// 根据经纬度获取地图信息(腾讯) + /// + /// 超时时间默认10秒 + /// 经纬度字符串 + /// 失败返回"" + public static TXMapLocation GetTXMapLocation(string strLatLng, int timeout = 10000) + { + try + { + string url = + + + string.Format("https://apis.map.qq.com/ws/place/v1/search?boundary=nearby({0},1000)&key={1}",strLatLng, txkey); + + //string.Format("https://apis.map.qq.com/ws/geocoder/v1/?location={0}&key={1}&get_poi=0", + // strLatLng, txkey); + + string apiText = HttpGet(url, timeout); + return JObject.Parse(apiText).ToObject(); + } + catch (Exception) + { + return new TXMapLocation(); + } + } + + + /// + /// 根据经纬度获取地址,多个 + /// + /// 超时时间默认10秒 + /// 经纬度数组 + /// 1、获取详细地址2、获取市跟区 + /// 失败返回"" + public static List GetLocationByLngLat(List lngLatList, int timeout = 10000, int type = 1) + { + int idx = 0; + List lstAddress = new List(); + List listLatLng = new List(); + try + { + for (int i = 0; i < lngLatList.Count; i++) + { + LocationModel item = lngLatList[i]; + if (idx < 20 && i < lngLatList.Count - 1) + { + listLatLng.Add(item.LngLatStr); + idx++; + } + else + { + if (i == lngLatList.Count - 1) + { + listLatLng.Add(item.LngLatStr); + } + + if (i < lngLatList.Count - 1) + { + i--; //请求地址时,i递增的话会导致每次请求遗漏1个地址 + } + + idx = 0; + string strLatLng = string.Join("|", listLatLng); + MapLocation mapLocation = GetMapLocation(strLatLng); + if (Convert.ToInt32(mapLocation.Status) == 1) + { + switch (type) + { + case 2: + lstAddress.AddRange( + mapLocation.Regeocodes.Select( + x => + x.AddressComponent.City.ToString().Replace("[]", "").Replace("市", "") + + ( + !string.IsNullOrWhiteSpace( + x.AddressComponent.District.ToString().Replace("[]", "")) + ? x.AddressComponent.District.ToString().Replace("[]", "") + : x.AddressComponent.Township.ToString().Replace("[]", "")) + + "|" + x.AddressComponent.Adcode)); + break; + + default: + lstAddress.AddRange( + mapLocation.Regeocodes.Select( + x => x.FormattedAddress.ToString().Replace("[]", ""))); + break; + } + } + else + { + //TODO 当第一个经纬度错误的时候会失败,之后有空回来解决这个问题 + for (int j = 0; j < listLatLng.Count - 1; j++) + { + lstAddress.Add(""); + } + } + listLatLng = new List(); + } + } + } + catch (Exception) + { + lstAddress = new List { "未知" }; + } + + return lstAddress; + } + + /// + /// 根据经纬度获取地址,一个 + /// + /// + /// + /// 超时时间默认10秒 + /// + /// 失败返回"" + public static string GetLocationByLngLat(decimal longitude = 0, decimal latitude = 0, int type = 1, int timeout = 10000) + { + string address = ""; + try + { + string strLatLng = longitude + "," + latitude; + + MapLocation mapLocation = GetMapLocation(strLatLng); + + if (Convert.ToInt32(mapLocation.Status) == 1) + { + Regeocode map = mapLocation.Regeocodes.First(); + switch (type) + { + case 2: + address = map.AddressComponent.City.ToString().Replace("[]", "").Replace("市", "") + + (!string.IsNullOrWhiteSpace(map.AddressComponent.District.ToString() + .Replace("[]", "")) + ? map.AddressComponent.District.ToString().Replace("[]", "") + : map.AddressComponent.Township.ToString().Replace("[]", "")) + + "|" + map.AddressComponent.Adcode; + + break; + + default: + address = map.FormattedAddress.ToString().Replace("[]", ""); + break; + } + } + if (Convert.ToInt32(mapLocation.Status) == 0) + { + + } + } + catch (Exception) + { + address = ""; + } + + return address; + } + + /// + /// 根据经纬度获取地址,一个(腾讯) + /// + /// + /// + /// 超时时间默认10秒 + /// + /// 失败返回"" + public static string GetTXLocationByLngLat(decimal longitude = 0, decimal latitude = 0, int type = 1, int timeout = 10000) + { + string address = ""; + try + { + string strLatLng = latitude + "," + longitude; + TXMapLocation mapLocation = GetTXMapLocation(strLatLng); + + if (Convert.ToInt32(mapLocation.Status) == 0) + { + address = mapLocation.Data[0].Address.ToString(); + } + if (Convert.ToInt32(mapLocation.Status) == 1) + { + + } + } + catch (Exception) + { + address = ""; + } + + return address; + } + + /// + /// 根据经纬度获取区域代码 + /// + /// 纬度 + /// 经度 + /// 超时秒数 + /// + public static int GetRegionCodeByLatLng(decimal lat, decimal lng, int timeout = 10000) + { + try + { + int regionCode = 0; + string strLatLng = lat + "," + lng; + string url = + string.Format( + "http://api.map.baidu.com/geocoder/v2/?location={0}&latest_admin=1&output=json&pois=1&ak={1}", + strLatLng, ak); + string apiText = HttpGet(url, timeout); + JObject jsonObj = JObject.Parse(apiText); + if ((int)(jsonObj["status"]) == 0)//成功返回0 + { + regionCode = Convert.ToInt32(jsonObj["result"]["addressComponent"]["adcode"]); + } + return regionCode; + } + catch (Exception) + { + return 0; + } + } + + /// + /// 获取路径规划路线 + /// + /// 起点经度 + /// 起点纬度 + /// 终点经度 + /// 终点纬度 + /// 超时时间默认10秒 + /// 失败返回"" + public static List GetRouteList(decimal startLongitude, decimal startLatitude, decimal endLongitude, decimal endLatitude, int timeout = 10000) + { + try + { + string origin = startLongitude + "," + startLatitude; + + string destination = endLongitude + "," + endLatitude; + + PathPlanning pathPlanning = GetPathPlanning(origin, destination); + + List list = new List(); + + if (Convert.ToInt32(pathPlanning.Status) == 1) + { + Model.Path path = pathPlanning.Routes.Paths.FirstOrDefault(); + if (path != null) + { + string[] lineList = string.Join(";", path.Steps.Select(x => x.Polyline)).Split(';'); + + list.AddRange( + lineList.Select( + x => + new PointLatLng + (Convert.ToDouble(x.Split(',')[1]), Convert.ToDouble(x.Split(',')[0])))); + } + return list; + } + } + catch (Exception) + { + return new List(); + } + + return new List(); + } + + /// + /// 根据起点终点经纬度获取路径规划(步行)(高德) + /// + /// 终点经纬度 + /// 超时时间默认10秒 + /// 起点经纬度 + /// 失败返回"" + public static PathPlanning GetPathPlanning(string origin, string destination, int timeout = 10000) + { + try + { + string url = + string.Format("https://restapi.amap.com/v3/direction/walking?key={0}&origin={1}&destination={2}", + key, origin, destination); + + string apiText = HttpGet(url, timeout); + return JObject.Parse(apiText).ToObject(); + } + catch (Exception) + { + return new PathPlanning(); + } + } + + public static string HttpGet(string url, int timeout) + { + HttpWebRequest req = WebRequest.Create(url) as HttpWebRequest; + req.ContentType = "multipart/form-data"; + req.Accept = "*/*"; + req.UserAgent = ""; + req.Timeout = timeout; + req.Method = "GET"; + req.KeepAlive = true; + HttpWebResponse response = req.GetResponse() as HttpWebResponse; + string apiText = ""; + using (StreamReader sr = new StreamReader(response.GetResponseStream(), Encoding.UTF8)) + { + apiText = sr.ReadToEnd(); + } + return apiText; + } + + + + public static GDPointLatLng Gps84ToGD(double lat,double lng, int timeout = 10000) + { + try + { + string url = + string.Format("https://restapi.amap.com/v3/assistant/coordinate/convert?key=82c0ac5c67dc9b13a3bb5b8fd4813996&locations={0}&coordsys=gps", + lng + "," + lat); + string apiText = HttpGet(url,timeout); + return JObject.Parse(apiText).ToObject(); + } + catch (Exception) + { + return new GDPointLatLng() ; + } + } + + public static GpsModels.BaseStationModel GetBaseStation(int mcc, int mnc, long lac, long cellid) + { + try + { + string url = + string.Format("http://apilocate.amap.com/position?accesstype=0&cdma=0&bts={0},{1},{2},{3},50&output=json&key={4}", + mcc, mnc, lac, cellid, key); + string apiText = HttpGet(url, 10000); + return JObject.Parse(apiText).ToObject(); + } + catch (Exception) + { + return new GpsModels.BaseStationModel(); + } + } + } +} + diff --git a/GPSBusiness/LogExtensions.cs b/GPSBusiness/LogExtensions.cs new file mode 100644 index 0000000..f187e40 --- /dev/null +++ b/GPSBusiness/LogExtensions.cs @@ -0,0 +1,54 @@ +// ============================================================================== +// +// RealDimensions Software, LLC - Copyright © 2012 - Present - Released under the Apache 2.0 License +// +// Copyright 2007-2008 The Apache Software Foundation. +// +// Licensed under the Apache License, Version 2.0 (the "License"); you may not use +// this file except in compliance with the License. You may obtain a copy of the +// License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software distributed +// under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR +// CONDITIONS OF ANY KIND, either express or implied. See the License for the +// specific language governing permissions and limitations under the License. +// ============================================================================== +using System.Collections.Concurrent; +using System.ComponentModel; +using log4net; +using log4net.Core; +namespace GPSBusiness +{ + /// + /// Extensions to help make logging awesome - this should be installed into the root namespace of your application + /// + public static class LogExtensions + { + /// + /// Gets the logger for . + /// + /// + /// The type to get the logger for. + /// Instance of a logger for the object. + public static ILog Log(this T type) + { + //string objectName = typeof(T).FullName; + return LogManager.GetLogger(typeof(T)); + } + /// + /// Gets the logger for the specified object name. + /// + /// Either use the fully qualified object name or the short. If used with Log<T>() you must use the fully qualified object name"/> + /// Instance of a logger for the object. + //public static ILog Log(this string objectName) + //{ + // return _dictionary.GetOrAdd(objectName, LoggingExtensions.Logging.Log.GetLoggerFor); + //} + public static ILog Log(this string objectName) + { + return LogManager.GetLogger(objectName); + } + } +} \ No newline at end of file diff --git a/GPSBusiness/Model/GDPointLatLng.cs b/GPSBusiness/Model/GDPointLatLng.cs new file mode 100644 index 0000000..0cdff4a --- /dev/null +++ b/GPSBusiness/Model/GDPointLatLng.cs @@ -0,0 +1,17 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace GPSBusiness.Model +{ + public class GDPointLatLng + { + public string status { get; set; } + public string info { get; set; } + public string infocode { get; set; } + public string locations { get; set; } = "0,0"; + + } +} \ No newline at end of file diff --git a/GPSBusiness/Model/LocationModel.cs b/GPSBusiness/Model/LocationModel.cs new file mode 100644 index 0000000..bfd87f5 --- /dev/null +++ b/GPSBusiness/Model/LocationModel.cs @@ -0,0 +1,26 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace GPSBusiness.Model +{ + public class LocationModel + { + public LocationModel() + { + } + + public LocationModel(decimal longitude, decimal latitude) + { + Latitude = latitude; + Longitude = longitude; + } + + public decimal Latitude { get; set; } + public decimal Longitude { get; set; } + + public string LngLatStr => Longitude + "," + Latitude; + } +} \ No newline at end of file diff --git a/GPSBusiness/Model/MapLocation.cs b/GPSBusiness/Model/MapLocation.cs new file mode 100644 index 0000000..6c0b83e --- /dev/null +++ b/GPSBusiness/Model/MapLocation.cs @@ -0,0 +1,84 @@ +using Newtonsoft.Json; +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace GPSBusiness.Model +{ + public class MapLocation + { + [JsonProperty("status")] + public object Status { get; set; } + + [JsonProperty("info")] + public object Info { get; set; } + + [JsonProperty("infocode")] + public object Infocode { get; set; } + + [JsonProperty("regeocodes")] + public List Regeocodes { get; set; } + + [JsonProperty("regeocode")] + public Regeocode Regeocode { get; set; } + } + + public class Regeocode + { + [JsonProperty("formatted_address")] + public object FormattedAddress { get; set; } + + [JsonProperty("addressComponent")] + public AddressComponent AddressComponent { get; set; } + } + + public class AddressComponent + { + [JsonProperty("country")] + public object Country { get; set; } + + [JsonProperty("province")] + public object Province { get; set; } + + [JsonProperty("city")] + public object City { get; set; } + + [JsonProperty("citycode")] + public object Citycode { get; set; } + + [JsonProperty("district")] + public object District { get; set; } + + [JsonProperty("adcode")] + public object Adcode { get; set; } + + [JsonProperty("township")] + public object Township { get; set; } + + [JsonProperty("townCode")] + public object TownCode { get; set; } + + [JsonProperty("streetNumber")] + public StreetNumber StreetNumber { get; set; } + } + + public class StreetNumber + { + [JsonProperty("street")] + public object Street { get; set; } + + [JsonProperty("number")] + public object Number { get; set; } + + [JsonProperty("location")] + public object Location { get; set; } + + [JsonProperty("direction")] + public object Direction { get; set; } + + [JsonProperty("distance")] + public object Distance { get; set; } + } +} \ No newline at end of file diff --git a/GPSBusiness/Model/PathPlanning.cs b/GPSBusiness/Model/PathPlanning.cs new file mode 100644 index 0000000..b40232c --- /dev/null +++ b/GPSBusiness/Model/PathPlanning.cs @@ -0,0 +1,124 @@ +using Newtonsoft.Json; +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace GPSBusiness.Model +{ + /// + /// 路径规划实体 + /// + public class PathPlanning + { + /// + /// 返回状态 + /// 值为0或1 1:成功;0:失败 + /// + [JsonProperty("status")] + public object Status { get; set; } + + /// + /// 返回的状态信息 + /// status为0时,info返回错误原;否则返回“OK”。详情参阅info状态表 + /// + [JsonProperty("info")] + public object Info { get; set; } + + /// + /// 返回结果总数目 + /// + [JsonProperty("count")] + public object Count { get; set; } + + /// + /// 路线信息列表 + /// + [JsonProperty("route")] + public Route Routes { get; set; } + } + + public class Route + { + /// + /// 起点坐标 + /// + [JsonProperty("origin")] + public object Origin { get; set; } + + /// + /// 终点坐标 + /// + [JsonProperty("destination")] + public object Destination { get; set; } + + /// + /// 步行方案 + /// + [JsonProperty("paths")] + public List Paths { get; set; } + } + + public class Path + { + /// + /// 起点和终点的步行距离 + /// 单位:米 + /// + [JsonProperty("distance")] + public object Distance { get; set; } + + /// + /// 步行时间预计 + /// 单位:秒 + /// + [JsonProperty("duration")] + public object Duration { get; set; } + + /// + /// 返回步行结果列表 + /// + [JsonProperty("steps")] + public List Steps { get; set; } + } + + public class Step + { + /// + /// 每段步行方案 + /// + [JsonProperty("instruction")] + public object Instruction { get; set; } + + /// + /// 方向 + /// + [JsonProperty("orientation")] + public object Orientation { get; set; } + + /// + /// 道路名称 + /// + [JsonProperty("road")] + public object Road { get; set; } + + /// + /// 此路段距离 + /// + [JsonProperty("distance")] + public object Distance { get; set; } + + /// + /// 此路段预计步行时间 + /// + [JsonProperty("duration")] + public object Duration { get; set; } + + /// + /// 此路段坐标点 + /// + [JsonProperty("polyline")] + public object Polyline { get; set; } + } +} \ No newline at end of file diff --git a/GPSBusiness/Model/PointLatLng.cs b/GPSBusiness/Model/PointLatLng.cs new file mode 100644 index 0000000..ad7fa17 --- /dev/null +++ b/GPSBusiness/Model/PointLatLng.cs @@ -0,0 +1,24 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace GPSBusiness.Model +{ + public class PointLatLng + { + public PointLatLng() + { + } + + public PointLatLng(double lat, double lng) + { + Lat = lat; + Lng = lng; + } + + public double Lat { get; set; } + public double Lng { get; set; } + } +} \ No newline at end of file diff --git a/GPSBusiness/Model/TXMapLocation.cs b/GPSBusiness/Model/TXMapLocation.cs new file mode 100644 index 0000000..426d9ea --- /dev/null +++ b/GPSBusiness/Model/TXMapLocation.cs @@ -0,0 +1,129 @@ +using Newtonsoft.Json; +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace GPSBusiness.Model +{ + public class TXMapLocation + { + /// + /// 状态码,0为正常,其它为异常 + /// + [JsonProperty("status")] + public int Status { get; set; } + + /// + /// 状态说明 + /// + [JsonProperty("message")] + public string Message { get; set; } + + /// + /// 本次请求的唯一标识 + /// + [JsonProperty("request_id")] + public string Request_Id { get; set; } + + /// + /// 解析结果 + /// + [JsonProperty("data")] + public List Data { get; set; } + } + + public class Data + { + + /// + /// 以行政区划+道路+门牌号等信息组成的标准格式化地址 + /// + [JsonProperty("id")] + public string Id { get; set; } + + /// + /// 以行政区划+道路+门牌号等信息组成的标准格式化地址 + /// + [JsonProperty("address")] + public string Address { get; set; } + + + + + /// + /// 以行政区划+道路+门牌号等信息组成的标准格式化地址 + /// + [JsonProperty("category")] + public string category { get; set; } + + ///// + ///// 结合知名地点形成的描述性地址,更具人性化特点 + ///// + //[JsonProperty("formatted_addresses")] + //public Formatted_Addresses Formatted_Addresses { get; set; } + + ///// + ///// 地址部件,address不满足需求时可自行拼接 + ///// + //[JsonProperty("address_component")] + //public Address_Component Address_Component { get; set; } + } + + public class Formatted_Addresses + { + /// + /// 地址描述 + /// + [JsonProperty("recommend")] + public string Recommend { get; set; } + + /// + /// 粗略位置描述 + /// + [JsonProperty("rough")] + public string Rough { get; set; } + } + + + public class Address_Component + { + /// + /// 国家 + /// + [JsonProperty(" nation")] + public string Nation { get; set; } + + /// + /// 省 + /// + [JsonProperty("province")] + public string Province { get; set; } + + /// + /// 市 + /// + [JsonProperty("city")] + public string City { get; set; } + + /// + /// 区,可能为空字串 + /// + [JsonProperty("district")] + public string District { get; set; } + + /// + /// 街道,可能为空字串 + /// + [JsonProperty("street")] + public string Street { get; set; } + + /// + /// 门牌,可能为空字串 + /// + [JsonProperty("street_number")] + public string Street_Number { get; set; } + } + +} diff --git a/GPSBusiness/MyGPSServer.cs b/GPSBusiness/MyGPSServer.cs new file mode 100644 index 0000000..2190816 --- /dev/null +++ b/GPSBusiness/MyGPSServer.cs @@ -0,0 +1,203 @@ +using GpsModels; +using log4net; +using System; +using System.Data; +using System.Data.SqlClient; +using GPSBusiness.Sql; +using GPSServer.Helper; + +namespace GPSBusiness +{ + public class MyGpsServer + { + public static ILog Log = LogManager.GetLogger(""); + + //请查看Mongo的GpsRealTImeRepository + ///// + ///// 更新Gps实时数据 + ///// + //public static void UpdateGpsRealTime(GpsModel model) + //{ + // try + // { + // Log.InfoFormat( + // "UpdateGpsRealTime:VehicleId={0},GpsTime={1},RecTime={2},Longitude={3},Latitude={4},Direct={5},Speed={6},Acc={7},ModifiedTime={8}", + // model.VehicleId, model.GpsTime, model.RecTime, model.Longitude, model.Latitude, model.Direct, model.Speed, model.Acc, DateTime.Now); + // string sql = @"UpdateGpsRealTime"; + // SqlParameter[] parameters = + // { + // new SqlParameter("@VehicleId", SqlDbType.Int), + // new SqlParameter("@GpsTime", SqlDbType.DateTime), + // new SqlParameter("@RecTime",SqlDbType.DateTime), + // new SqlParameter("@Longitude", SqlDbType.Decimal, 18), + // new SqlParameter("@Latitude", SqlDbType.Decimal, 18), + // new SqlParameter("@Direct", SqlDbType.Int), + // new SqlParameter("@Speed", SqlDbType.Int), + // new SqlParameter("@Acc", SqlDbType.Int), + // new SqlParameter("@Address",SqlDbType.VarChar, 200), + // new SqlParameter("@ModifiedTime", SqlDbType.DateTime), + // }; + // parameters[0].Value = model.VehicleId; + // parameters[1].Value = model.GpsTime; + // parameters[2].Value = model.RecTime; + // parameters[3].Value = model.Longitude; + // parameters[4].Value = model.Latitude; + // parameters[5].Value = model.Direct; + // parameters[6].Value = model.Speed; + // parameters[7].Value = model.Acc; + // parameters[8].Value = model.Address ?? ""; + // parameters[9].Value = DateTime.Now; + // SqlHelp.ExecSPCommand(sql, parameters); + // } + // catch (Exception ex) + // { + // Log.ErrorFormat("UpdateGpsRealTime=报错=,ex.Message={0},ex.InnerException={1},ex.StackTrace={2}", + // ex.Message, ex.InnerException, ex.StackTrace); + // } + //} + + ///// + ///// 更新车辆gps状态: + ///// + //public static void UpdateGpsRealTimeGpsState(VehicleModel vehicle, int gpsState, string durationTime, string AccDurationTime) + //{ + // try + // { + // Log.InfoFormat( + // "UpdateGpsRealTimeGpsState:VehicleId={0},GpsState={1},DurationTime={2},AccDurationTime={3}", + // vehicle.VehicleId, gpsState, durationTime, AccDurationTime); + // string sql = @"UpdateGpsRealTimeState"; + // SqlParameter[] parameters = + // { + // new SqlParameter("@VehicleId", SqlDbType.Int), + // new SqlParameter("@GpsState", SqlDbType.Int), + // new SqlParameter("@DurationTime",SqlDbType.VarChar, 20), + // new SqlParameter("@AccDurationTime",SqlDbType.VarChar, 20), + // new SqlParameter("@ModifiedTime", SqlDbType.DateTime), + // }; + // parameters[0].Value = vehicle.VehicleId; + // parameters[1].Value = gpsState; + // parameters[2].Value = durationTime; + // parameters[3].Value = AccDurationTime; + // parameters[4].Value = DateTime.Now; + // SqlHelp.ExecSPCommand(sql, parameters); + // } + // catch (Exception ex) + // { + // Log.ErrorFormat( + // "UpdateGpsRealTimeGpsState=报错=,ex.Message={0},ex.InnerException={1},ex.StackTrace={2}", + // ex.Message, ex.InnerException, ex.StackTrace); + // } + //} + + ///// + ///// 更新车辆gps状态,沃瑞特在线车辆。此更新,只在沃瑞特心跳时进行更新。 + ///// + //public static void UpdateGpsRealTimeGpsStateWrt(GpsModel gpsModel) + //{ + // try + // { + // var time = DateTime.Now.ToString("yyyy-MM-dd HH:mm:ss"); + // Log.InfoFormat( + // "UpdateGpsRealTimeGpsStateWrt:VehicleId={0},GpsState={1},GpsTime、RecTime、ModifiedTime={2},DurationTime={3},AccDurationTime={5}", + // gpsModel.VehicleId, gpsModel.GpsState, time, gpsModel.DurationTime, gpsModel.AccDurationTime); + // string sql = @"UpdateGpsRealTimeStateWrt"; + // SqlParameter[] parameters = + // { + // new SqlParameter("@VehicleId", SqlDbType.Int), + // new SqlParameter("@GpsState", SqlDbType.Int), + // new SqlParameter("@GpsTime",SqlDbType.DateTime), + // new SqlParameter("@RecTime",SqlDbType.DateTime), + // new SqlParameter("@DurationTime",SqlDbType.VarChar, 20), + // new SqlParameter("@AccDurationTime",SqlDbType.VarChar, 20), + // new SqlParameter("@ModifiedTime", SqlDbType.DateTime), + // }; + // parameters[0].Value = gpsModel.VehicleId; + // parameters[1].Value = gpsModel.GpsState; + // parameters[2].Value = time; + // parameters[3].Value = time; + // parameters[4].Value = gpsModel.DurationTime ?? ""; + // parameters[5].Value = gpsModel.AccDurationTime ?? ""; + // parameters[6].Value = time; + // SqlHelp.ExecSPCommand(sql, parameters); + // } + // catch (Exception ex) + // { + // Log.ErrorFormat( + // "UpdateGpsRealTimeGpsStateWrt=报错=,ex.Message={0},ex.InnerException={1},ex.StackTrace={2}", + // ex.Message, ex.InnerException, ex.StackTrace); + // } + //} + + /// + /// 更新订单状态: + /// + public static void UpdateOrderState(long orderId, int state, DateTime time) + { + try + { + Log.InfoFormat("UpdateOrderState:Id={0},State={1},Time={2:yyyy-MM-dd HH:mm:ss}", + orderId, state, time); + string sql = @"UpdateOrderState"; + SqlParameter[] parameters = + { + new SqlParameter("@Id", SqlDbType.Int), + new SqlParameter("@State", SqlDbType.Int), + new SqlParameter("@Time",SqlDbType.DateTime), + }; + parameters[0].Value = orderId; + parameters[1].Value = state; + parameters[2].Value = time; + SqlHelp.ExecSPCommand(sql, parameters); + } + catch (Exception ex) + { + Log.ErrorFormat( + "UpdateOrderState=报错=,ex.Message={0},ex.InnerException={1},ex.StackTrace={2}", + ex.Message, ex.InnerException, ex.StackTrace); + } + } + + ///// + ///// 新增Acc持续时长记录 + ///// + //public static void AddGpsCarAccDuration(int carId, int companyId, string code, string vehicleName, int AccState, DateTime beginTime, DateTime endTime) + //{ + // try + // { + // Log.InfoFormat("AddGpsCarAccDuration:VehicleId={0},CompanyId={1}", + // carId, companyId); + // var time = endTime - beginTime; + // var AccDurationTime = CalculationGpsHelper.TimeSpanFormat(time); + // string sql = @"AddGpsCarAccDuration"; + // SqlParameter[] parameters = + // { + // new SqlParameter("@VehicleId", SqlDbType.Int), + // new SqlParameter("@CompanyId", SqlDbType.Int), + // new SqlParameter("@Code",SqlDbType.VarChar, 20), + // new SqlParameter("@VehicleName",SqlDbType.VarChar, 20), + // new SqlParameter("@AccState",SqlDbType.Int), + // new SqlParameter("@AccDurationTime",SqlDbType.VarChar, 20), + // new SqlParameter("@TimeBegin",SqlDbType.DateTime), + // new SqlParameter("@TimeEnd",SqlDbType.DateTime), + // }; + // parameters[0].Value = carId; + // parameters[1].Value = companyId; + // parameters[2].Value = code; + // parameters[3].Value = vehicleName; + // parameters[4].Value = AccState; + // parameters[5].Value = AccDurationTime; + // parameters[6].Value = beginTime; + // parameters[7].Value = endTime; + // SqlHelp.ExecSPCommand(sql, parameters); + + // } + // catch (Exception ex) + // { + // Log.ErrorFormat( + // "AddGpsCarAccDuration=报错=,ex.Message={0},ex.InnerException={1},ex.StackTrace={2}", + // ex.Message, ex.InnerException, ex.StackTrace); + // } + //} + } +} diff --git a/GPSBusiness/PkgHeader.cs b/GPSBusiness/PkgHeader.cs new file mode 100644 index 0000000..e6a056e --- /dev/null +++ b/GPSBusiness/PkgHeader.cs @@ -0,0 +1,25 @@ +using System; +using System.Runtime.InteropServices; +namespace GPSBusiness +{ + [StructLayout(LayoutKind.Sequential)] + public class ClientInfo + { + public IntPtr ConnId { get; set; } + public string IpAddress { get; set; } + public ushort Port { get; set; } + public PkgInfo PkgInfo { get; set; } + } + [StructLayout(LayoutKind.Sequential)] + public class PkgHeader + { + public int Id; + public int BodySize; + } + [StructLayout(LayoutKind.Sequential)] + public class PkgInfo + { + public bool IsHeader; + public int Length; + } +} diff --git a/GPSBusiness/Properties/AssemblyInfo.cs b/GPSBusiness/Properties/AssemblyInfo.cs new file mode 100644 index 0000000..2fd5677 --- /dev/null +++ b/GPSBusiness/Properties/AssemblyInfo.cs @@ -0,0 +1,33 @@ +using System.Reflection; +using System.Runtime.CompilerServices; +using System.Runtime.InteropServices; +// 有关程序集的常规信息通过以下 +// 特性集控制。更改这些特性值可修改 +// 与程序集关联的信息。 +[assembly: AssemblyTitle("GPSBusiness")] +[assembly: AssemblyDescription("")] +[assembly: AssemblyConfiguration("")] +[assembly: AssemblyCompany("Microsoft")] +[assembly: AssemblyProduct("GPSBusiness")] +[assembly: AssemblyCopyright("Copyright © Microsoft 2016")] +[assembly: AssemblyTrademark("")] +[assembly: AssemblyCulture("")] +// 将 ComVisible 设置为 false 使此程序集中的类型 +// 对 COM 组件不可见。如果需要从 COM 访问此程序集中的类型, +// 则将该类型上的 ComVisible 特性设置为 true。 +[assembly: ComVisible(false)] +// 如果此项目向 COM 公开,则下列 GUID 用于类型库的 ID +[assembly: Guid("7ba5987d-4a46-4fdc-9522-fab54964d80f")] +// 程序集的版本信息由下面四个值组成: +// +// 主版本 +// 次版本 +// 生成号 +// 修订号 +// +// 可以指定所有这些值,也可以使用“生成号”和“修订号”的默认值, +// 方法是按如下所示使用“*”: +// [assembly: AssemblyVersion("1.0.*")] +[assembly: AssemblyVersion("1.0.0.0")] +[assembly: AssemblyFileVersion("1.0.0.0")] +[assembly: log4net.Config.XmlConfigurator(ConfigFile = "./log4net.config", ConfigFileExtension = "config", Watch = true)] diff --git a/GPSBusiness/Redis/RedisContext.cs b/GPSBusiness/Redis/RedisContext.cs new file mode 100644 index 0000000..b3d2657 --- /dev/null +++ b/GPSBusiness/Redis/RedisContext.cs @@ -0,0 +1,34 @@ +namespace GPSBusiness.Redis +{ + public class RedisContext + { + private static RedisHelper _server; + + public static RedisHelper Server + { + get + { + if (_server == null) + { + return _server = new RedisHelper(); + } + return _server; + } + } + //private static RedisHelper _datasServer; + + //public static RedisHelper DatasServer + //{ + // get + // { + // if (_datasServer == null) + // { + // var connectionString = ConfigurationManager.ConnectionStrings["RedisConnectionString"].ConnectionString; + // var redisAnalysisDb = int.Parse(ConfigurationManager.AppSettings["RedisAnalysisDb"]); + // return _datasServer = new RedisHelper(connectionString, redisAnalysisDb); + // } + // return _datasServer; + // } + //} + } +} diff --git a/GPSBusiness/Redis/RedisHelper.cs b/GPSBusiness/Redis/RedisHelper.cs new file mode 100644 index 0000000..4d29000 --- /dev/null +++ b/GPSBusiness/Redis/RedisHelper.cs @@ -0,0 +1,254 @@ +using System; +using System.Configuration; +using System.Text; +using System.Threading.Tasks; +using Newtonsoft.Json; +using StackExchange.Redis; + +namespace GPSBusiness.Redis +{ + /// + /// Redis 操作类 + /// + public class RedisHelper : IDisposable + { + /// + /// 连接字符串 + /// + private static readonly string ConnectionString = ConfigurationManager.AppSettings["RedisConnectionString"]; + private static readonly int RedisAnalysisDb = int.Parse(ConfigurationManager.AppSettings["RedisAnalysisDb"]); + + /// + /// 锁 + /// + private readonly object _lock = new object(); + /// + /// 连接对象 + /// + private volatile IConnectionMultiplexer _connection; + /// + /// 数据库 + /// + private readonly IDatabase _db; + public RedisHelper() + { + _connection = + ConnectionMultiplexer.Connect(string.Format( + "{0},allowAdmin=true,syncTimeout=60000,connectTimeout=30000", ConnectionString)); + _db = GetDatabase(RedisAnalysisDb); + } + public RedisHelper(string connectStr,int dataDb) + { + _connection = + ConnectionMultiplexer.Connect(string.Format( + "{0},allowAdmin=true,syncTimeout=60000,connectTimeout=60000", connectStr)); + _db = GetDatabase(dataDb); + } + /// + /// 获取连接 + /// + /// + protected IConnectionMultiplexer GetConnection() + { + if (_connection != null && _connection.IsConnected) + { + return _connection; + } + lock (_lock) + { + if (_connection != null && _connection.IsConnected) + { + return _connection; + } + + if (_connection != null) + { + _connection.Dispose(); + } + _connection = ConnectionMultiplexer.Connect(ConnectionString); + } + + return _connection; + } + /// + /// 获取数据库 + /// + /// + /// + public IDatabase GetDatabase(int? db = null) + { + return GetConnection().GetDatabase(db ?? -1); + } + /// + /// 设置 + /// + /// 键 + /// 值 + /// 时间-分钟 + public virtual void SetOfBytes(string key, object data, int cacheTime) + { + if (data == null) + { + return; + } + var entryBytes = SerializeToBytes(data); + TimeSpan? expiresIn = null; + if(cacheTime != -1) + expiresIn = TimeSpan.FromMinutes(cacheTime); + + _db.StringSet(key, entryBytes, expiresIn); + } + /// + /// 设置 + /// + /// 键 + /// 值 + /// 时间-分钟 + public virtual void SetOfJson(string key, object data, int cacheTime) + { + if (data == null) return; + var serializedValue = SerializeToJson(data); + TimeSpan? expiresIn = null; + if(cacheTime != -1) + expiresIn = TimeSpan.FromMinutes(cacheTime); + + _db.StringSet(key, serializedValue, expiresIn); + } + /// + /// 根据键获取值 + /// + /// + /// + /// + public virtual T GetFromBytes(string key) + { + var rValue = _db.StringGet(key); + if (!rValue.HasValue) + { + return default(T); + } + + var result = DeserializeBytes(rValue); + + return result; + } + /// + /// 根据键获取值 + /// + /// + /// + /// + public virtual T GetFromJson(string key) + { + var rValue = _db.StringGet(key); + if (!rValue.HasValue) + { + return default(T); + } + + var result = DeserializeJson(rValue); + + return result; + } + + /// + /// 根据键获取值 + /// + /// + /// + /// + public virtual async Task GetFromJsonAsync(string key) + { + var rValue =await _db.StringGetAsync(key); + if (!rValue.HasValue) + { + return default(T); + } + + var result = DeserializeJson(rValue); + + return result; + } + /// + /// 序列化 + /// + /// + /// byte[] + private byte[] SerializeToBytes(object data) + { + var json = JsonConvert.SerializeObject(data); + return Encoding.UTF8.GetBytes(json); + } + /// + /// 序列化 + /// + /// + /// byte[] + private string SerializeToJson(object data) + { + return JsonConvert.SerializeObject(data); + } + /// + /// 反序列化 + /// + /// + /// + /// + protected virtual T DeserializeBytes(byte[] serializedObject) + { + if (serializedObject == null) + { + return default(T); + } + var json = Encoding.UTF8.GetString(serializedObject); + return JsonConvert.DeserializeObject(json); + } + /// + /// 反序列化 + /// + /// + /// + /// + protected virtual T DeserializeJson(string serializedObject) + { + if (serializedObject == null) + { + return default(T); + } + return JsonConvert.DeserializeObject(serializedObject); + } + /// + /// 判断是否已经设置 + /// + /// + /// + public virtual bool IsSet(string key) + { + return _db.KeyExists(key); + } + /// + /// 根据key删除 + /// + /// + /// + public virtual bool Remove(string key) + { + return _db.KeyDelete(key); + } + + public void Dispose() + { + throw new NotImplementedException(); + } + + /// + /// 自增 + /// + /// + /// + public virtual long StringIncrement(string key) + { + return _db.StringIncrement(key); + } + } +} diff --git a/GPSBusiness/Redis/RedisRepository.cs b/GPSBusiness/Redis/RedisRepository.cs new file mode 100644 index 0000000..2387553 --- /dev/null +++ b/GPSBusiness/Redis/RedisRepository.cs @@ -0,0 +1,244 @@ +using System; +using GPSBusiness.Enum; +using GpsModels; +using log4net; + +namespace GPSBusiness.Redis +{ + public static class RedisRepository + { + public static ILog Log = LogManager.GetLogger(""); + + #region 车辆最后存在速度的GPS时间 + /// + /// 更新车辆最后存在速度的GPS时间 + /// + public static void SetLastHaveSpeed(GpsModel model) + { + if (model.CompanyId == 0) return; + if (model.VehicleId == 0) return; + var cmpId = model.CompanyId; + var key = "LastHaveSpeed" + "_" + cmpId + "_" + model.VehicleId; + try + { + RedisContext.Server.SetOfJson(key, model, -1); + } + catch (Exception ex) + { + var aa = 0; + throw; + } + } + + /// + /// 获取车辆最后存在速度的GPS时间 + /// + public static GpsModel GetLastHaveSpeed(GpsModel model) + { + try + { + if (model.CompanyId == 0) return null; + if (model.VehicleId == 0) return null; + var cmpId = model.CompanyId; + var key = "LastHaveSpeed" + "_" + cmpId + "_" + model.VehicleId; + return RedisContext.Server.GetFromJson(key); + } + catch (Exception ex) + { + Log.ErrorFormat("GetLastHaveSpeed=报错=,ex.Message={0},ex.InnerException={1},ex.StackTrace={2}", ex.Message, ex.InnerException, ex.StackTrace); + throw; + } + } + /// + /// 是否已设置车辆最后存在速度的GPS时间 + /// + public static bool IsSetLastHaveSpeed(GpsModel model) + { + if (model.CompanyId == 0) return false; + if (model.VehicleId == 0) return false; + var cmpId = model.CompanyId; + var key = "LastHaveSpeed" + "_" + cmpId + "_" + model.VehicleId; + return RedisContext.Server.IsSet(key); + } + #endregion + + #region 车辆Acc/作业状态第一次开启的时间 + /// + /// 更新Acc/作业状态第一次开启的时间 + /// + /// + /// 1Acc,2Work + public static void SetFirstStatus(GpsModel model,int type) + { + if (model.CompanyId == 0) return; + if (model.VehicleId == 0) return; + var cmpId = model.CompanyId; + var key = (type == (int)StatusEnum.Acc ? RedisPrefixEnum.FirstAcc : RedisPrefixEnum.FirstWork) + cmpId + "_" + model.VehicleId; + RedisContext.Server.SetOfJson(key, model, -1); + } + + /// + /// 获取Acc/作业状态第一次开启的时间 + /// + /// + /// 1Acc,2Work + public static GpsModel GetFirstStatus(GpsModel model, int type) + { + try + { + if (model.CompanyId == 0) return null; + if (model.VehicleId == 0) return null; + var cmpId = model.CompanyId; + var key = (type == (int)StatusEnum.Acc ? RedisPrefixEnum.FirstAcc : RedisPrefixEnum.FirstWork) + cmpId + "_" + model.VehicleId; + return RedisContext.Server.GetFromJson(key); + } + catch (Exception ex) + { + Log.ErrorFormat("GetLastHaveSpeed=报错=,ex.Message={0},ex.InnerException={1},ex.StackTrace={2}", ex.Message, ex.InnerException, ex.StackTrace); + throw; + } + } + /// + /// 是否已设置Acc/作业状态第一次开启的时间 + /// + /// + /// 1Acc,2Work + public static bool IsSetFirstStatus(GpsModel model, int type) + { + if (model.CompanyId == 0) return false; + if (model.VehicleId == 0) return false; + var cmpId = model.CompanyId; + var key = (type == 1 ? RedisPrefixEnum.FirstAcc : RedisPrefixEnum.FirstWork) + cmpId + "_" + model.VehicleId; + return RedisContext.Server.IsSet(key); + } + #endregion + + //#region 车辆最后GPS时间 + ///// + ///// 更新车辆最后GPS时间 + ///// + //public static void SetLastGpsTime(GpsModel model) + //{ + // if (model.CompanyId == 0) return; + // if (model.VehicleId == 0) return; + // var cmpId = 500000 + model.CompanyId; + // var key = "LastGpsTime" + "_" + cmpId + "_" + model.VehicleId; + // RedisContext.Server.SetOfJson(key, model, -1); + //} + + ///// + ///// 获取车辆最后GPS时间 + ///// + //public static GpsModel GetLastGpsTime(GpsModel model) + //{ + // try + // { + // if (model.CompanyId == 0) return null; + // if (model.VehicleId == 0) return null; + // var cmpId = 500000 + model.CompanyId; + // var key = "LastGpsTime" + "_" + cmpId + "_" + model.VehicleId; + // return RedisContext.Server.GetFromJson(key); + // } + // catch (Exception ex) + // { + // Log.ErrorFormat("GetLastGpsTime=报错=,ex.Message={0},ex.InnerException={1},ex.StackTrace={2}", ex.Message, ex.InnerException, ex.StackTrace); + // throw; + // } + //} + ///// + ///// 是否已设置车辆最后GPS时间 + ///// + //public static bool IsSetLastGpsTime(GpsModel model) + //{ + // if (model.CompanyId == 0) return false; + // if (model.VehicleId == 0) return false; + // var cmpId = 500000 + model.CompanyId; + // var key = "LastGpsTime" + "_" + cmpId + "_" + model.VehicleId; + // return RedisContext.Server.IsSet(key); + //} + //#endregion + + #region + + + /// + /// 更新车辆最后GPS时间 + /// + public static void SetLastGpsTime(GpsModel model) + { + if (model.VehicleId == 0) return; + var key = "LastGpsTime" + "_" + model.VehicleId; + RedisContext.Server.SetOfJson(key, model,1); + } + + /// + /// 获取车辆最后GPS时间 + /// + public static GpsModel GetLastGpsTime(GpsModel model) + { + try + { + if (model.VehicleId == 0) return null; + var key = "LastGpsTime" + "_" + model.VehicleId; + return RedisContext.Server.GetFromJson(key); + } + catch (Exception ex) + { + Log.ErrorFormat("GetLastGpsTime=报错=,ex.Message={0},ex.InnerException={1},ex.StackTrace={2}", ex.Message, ex.InnerException, ex.StackTrace); + throw; + } + } + /// + /// 是否已设置车辆最后GPS时间 + /// + public static bool IsSetLastGpsTime(GpsModel model) + { + if (model.VehicleId == 0) return false; + var key = "LastGpsTime"+ "_" + model.VehicleId; + return RedisContext.Server.IsSet(key); + } + + + + /// + /// 自增车辆最后GPS时间 + /// + public static long IncrementLastGpsTimeRepeatCount(GpsModel model) + { + if (model.VehicleId == 0) return 0; + var key = "LastGpsTimeRepeatCount" + "_" + model.VehicleId; + return RedisContext.Server.StringIncrement(key); + } + + /// + /// 更新车辆最后GPS时间 + /// + public static void SetLastGpsTimeRepeatCount(GpsModel model) + { + if (model.VehicleId == 0) return; + var key = "LastGpsTimeRepeatCount" + "_" + model.VehicleId; + RedisContext.Server.SetOfJson(key,0,-1); + } + + /// + /// 获取车辆最后GPS时间 + /// + public static long GetLastGpsTimeRepeatCount(GpsModel model) + { + try + { + if (model.VehicleId == 0) return 0; + var key = "LastGpsTimeRepeatCount" + "_" + model.VehicleId; + return RedisContext.Server.GetFromJson(key); + } + catch (Exception ex) + { + Log.ErrorFormat("GetLastGpsTime=报错=,ex.Message={0},ex.InnerException={1},ex.StackTrace={2}", ex.Message, ex.InnerException, ex.StackTrace); + throw; + } + } + + } + #endregion +} + diff --git a/GPSBusiness/Sql/SqlHelp.cs b/GPSBusiness/Sql/SqlHelp.cs new file mode 100644 index 0000000..cfa8f28 --- /dev/null +++ b/GPSBusiness/Sql/SqlHelp.cs @@ -0,0 +1,282 @@ +using System; +using System.Collections.Generic; +using System.Data; +using System.Data.SqlClient; +using System.Linq; +using System.Configuration; +using log4net; +using System.ComponentModel; +using MySql.Data.MySqlClient; + +namespace GPSBusiness.Sql +{ + public class SqlHelp + { + //"Data Source=数据库地址;Initial Catalog=数据库名称;Persist Security Info=True;User ID=帐号;Password=密码"; + public static string ConnectionString = ConfigurationManager.ConnectionStrings["ZNYCProjectGps"].ToString(); + //根据sql语句返回一个DataSet + #region GetDataSet + public static DataSet GetDataSet(string sql) + { + MySqlCommand sqlcom = new MySqlCommand(); + using (MySqlConnection conn = new MySqlConnection(ConnectionString)) + { + PrepareCommand(sqlcom, conn, CommandType.Text, sql); + MySqlDataAdapter sda = new MySqlDataAdapter(); + sda.SelectCommand = sqlcom; + DataSet ds = new DataSet(); + sda.Fill(ds); + sqlcom.Parameters.Clear(); + return ds; + } + } + #endregion + //根据sql语句返回一个MySqlDataAdapter + #region ExecMySqlDataAdapter + public static MySqlDataReader ExecMySqlDataAdapter(string sql) + { + MySqlCommand sqlcom = new MySqlCommand(); + MySqlConnection conn = new MySqlConnection(ConnectionString); + try + { + PrepareCommand(sqlcom, conn, CommandType.Text, sql); + MySqlDataReader sdr = sqlcom.ExecuteReader(CommandBehavior.CloseConnection); + sqlcom.Parameters.Clear(); + return sdr; + } + catch (Exception ex) + { + conn.Close(); + throw ex; + } + } + #endregion + //执行sql语句,返回影响行数 + #region ExecCommand + public static int ExecCommand(string sql) + { + MySqlCommand sqlcom = new MySqlCommand(); + using (MySqlConnection conn = new MySqlConnection(ConnectionString)) + { + PrepareCommand(sqlcom, conn, CommandType.Text, sql); + int rtn = sqlcom.ExecuteNonQuery(); + sqlcom.Parameters.Clear(); + return rtn; + } + } + #endregion + //执行SQL语句,无返回值 + #region ExecNon + public static void ExecNon(string sql) + { + MySqlCommand sqlcom = new MySqlCommand(); + using (MySqlConnection conn = new MySqlConnection(ConnectionString)) + { + PrepareCommand(sqlcom, conn, CommandType.Text, sql); + sqlcom.ExecuteNonQuery(); + sqlcom.Parameters.Clear(); + } + } + #endregion + //根据sql语句返回查询结果的第一行 + #region ExecuteScalar + public static object ExecuteScalar(string sql) + { + MySqlCommand sqlcom = new MySqlCommand(); + using (MySqlConnection conn = new MySqlConnection(ConnectionString)) + { + PrepareCommand(sqlcom, conn, CommandType.Text, sql); + object rtn = sqlcom.ExecuteScalar(); + sqlcom.Parameters.Clear(); + return rtn; + } + } + #endregion + //执行存储过程无返回值,SQL语句含有参数 + #region ExecSPCommand + public static void ExecSPCommand(string sql, System.Data.IDataParameter[] paramers) + { + MySqlCommand sqlcom = new MySqlCommand(); + using (MySqlConnection conn = new MySqlConnection(ConnectionString)) + { + PrepareCommand(sqlcom, conn, CommandType.StoredProcedure, sql); + foreach (System.Data.IDataParameter paramer in paramers) + { + sqlcom.Parameters.Add(paramer); + } + sqlcom.ExecuteNonQuery(); + sqlcom.Parameters.Clear(); + } + } + #endregion + //执行存储过程无返回值,SQL语句不含有参数 + #region ExecSPCommand2 + public static void ExecSPCommand2(string sql) + { + MySqlCommand sqlcom = new MySqlCommand(); + using (MySqlConnection conn = new MySqlConnection(ConnectionString)) + { + PrepareCommand(sqlcom, conn, CommandType.StoredProcedure, sql); + sqlcom.ExecuteNonQuery(); + sqlcom.Parameters.Clear(); + } + } + #endregion + //执行存储过程,返回MySqlDataAdapter,SQL语句含有参数 + #region ExecSPMySqlDataAdapter + public static MySqlDataReader ExecSPMySqlDataAdapter(string sql, System.Data.IDataParameter[] paramers) + { + MySqlConnection conn = new MySqlConnection(ConnectionString); + MySqlCommand sqlcom = new MySqlCommand(); + try + { + PrepareCommand(sqlcom, conn, CommandType.StoredProcedure, sql); + foreach (System.Data.IDataParameter paramer in paramers) + { + sqlcom.Parameters.Add(paramer); + } + + MySqlDataReader sdr = sqlcom.ExecuteReader(CommandBehavior.CloseConnection); + sqlcom.Parameters.Clear(); + return sdr; + } + catch (Exception ex) + { + conn.Close(); + throw ex; + } + } + #endregion + //执行存储过程,SQL语句含有参数 + #region ExecSPSqlExecuteNonQuery + public static int ExecSPSqlExecuteNonQuery(string sql, System.Data.IDataParameter[] paramers) + { + MySqlConnection conn = new MySqlConnection(ConnectionString); + MySqlCommand sqlcom = new MySqlCommand(); + try + { + PrepareCommand(sqlcom, conn, CommandType.StoredProcedure, sql); + foreach (System.Data.IDataParameter paramer in paramers) + { + sqlcom.Parameters.Add(paramer); + } + sqlcom.ExecuteNonQuery(); + return Convert.ToInt32(sqlcom.Parameters["@Id"].Value); + } + catch (Exception ex) + { + conn.Close(); + throw ex; + } + } + #endregion + //执行存储过程,返回MySqlDataAdapter,SQL语句不含有参数 + #region ExecSPMySqlDataAdapter2 + public static MySqlDataReader ExecSPMySqlDataAdapter2(string sql) + { + MySqlConnection conn = new MySqlConnection(ConnectionString); + MySqlCommand sqlcom = new MySqlCommand(); + try + { + PrepareCommand(sqlcom, conn, CommandType.StoredProcedure, sql); + MySqlDataReader sdr = sqlcom.ExecuteReader(CommandBehavior.CloseConnection); + sqlcom.Parameters.Clear(); + return sdr; + } + catch (Exception ex) + { + conn.Close(); + throw ex; + } + } + #endregion + //执行存储过程返回DataSet类型,SQL语句含有参数 + #region ExecSPDataSet + public static DataSet ExecSPDataSet(string sql, System.Data.IDataParameter[] paramers) + { + MySqlCommand sqlcom = new MySqlCommand(); + using (MySqlConnection conn = new MySqlConnection(ConnectionString)) + { + PrepareCommand(sqlcom, conn, CommandType.StoredProcedure, sql); + foreach (System.Data.IDataParameter paramer in paramers) + { + sqlcom.Parameters.Add(paramer); + } + MySqlDataAdapter sda = new MySqlDataAdapter(); + sda.SelectCommand = sqlcom; + DataSet ds = new DataSet(); + sda.Fill(ds); + sqlcom.Parameters.Clear(); + return ds; + } + } + #endregion + //执行存储过程返回DataSet类型,SQL语句不含有参数 + #region ExecSPDataSet2 + public static DataSet ExecSPDataSet2(string sql) + { + MySqlCommand sqlcom = new MySqlCommand(); + using (MySqlConnection conn = new MySqlConnection(ConnectionString)) + { + PrepareCommand(sqlcom, conn, CommandType.StoredProcedure, sql); + MySqlDataAdapter sda = new MySqlDataAdapter + { + SelectCommand = sqlcom + }; + DataSet ds = new DataSet(); + sda.Fill(ds); + sqlcom.Parameters.Clear(); + return ds; + } + } + #endregion + // + // 执行存储过程返回DataSet类型,SQL语句含有参数 + #region PrepareCommand + /// + /// 执行存储过程返回DataSet类型,SQL语句含有参数 + /// + /// + /// + /// + /// + private static void PrepareCommand(MySqlCommand cmd, MySqlConnection conn, CommandType cmdType, string cmdText) + { + if (conn.State != ConnectionState.Open) + conn.Open(); + cmd.Connection = conn; + cmd.CommandText = cmdText; + cmd.CommandType = cmdType; + } + #endregion + // 批量入库 + public static bool BulkInsert(string tableName, IList list) + { + using (var bulkCopy = new SqlBulkCopy(ConnectionString)) + { + bulkCopy.BatchSize = list.Count; + bulkCopy.DestinationTableName = tableName; + var table = new DataTable(); + var props = TypeDescriptor.GetProperties(typeof(T), new Attribute[] { }) + .Cast() + .ToArray(); + foreach (var propertyInfo in props) + { + bulkCopy.ColumnMappings.Add(propertyInfo.Name, propertyInfo.Name); + table.Columns.Add(propertyInfo.Name, Nullable.GetUnderlyingType(propertyInfo.PropertyType) ?? propertyInfo.PropertyType); + } + var values = new object[props.Length]; + foreach (var item in list) + { + for (var i = 0; i < values.Length; i++) + { + values[i] = props[i].GetValue(item); + } + table.Rows.Add(values); + } + bulkCopy.WriteToServer(table); + } + return true; + } + } +} diff --git a/GPSBusiness/Sql/SqlRepository.cs b/GPSBusiness/Sql/SqlRepository.cs new file mode 100644 index 0000000..9b289cd --- /dev/null +++ b/GPSBusiness/Sql/SqlRepository.cs @@ -0,0 +1,139 @@ +using System; +using System.Collections.Generic; +using System.Data; +using System.Data.SqlClient; +using GpsModels; +using GPSBusiness.GPSStandard; +using log4net; +using MySql.Data.MySqlClient; + +namespace GPSBusiness.Sql +{ + /// + /// 车辆信息获取接口 + /// + public class SqlRepository : ICarService + { + /// + /// 开启了gps分析的公司:其实是根据gps分析订单状态:已出发,已到达,作业中 + /// + public static List Companys; + /// + /// 开启gps的所有车辆。 + /// + public static List Cars; + /// + /// 任务中(1,2,3,6,7)的订单,状态:(0未指派、1已指派、2已接单、3已出发、4已完成、5已删除、6已到达、7作业中、8已作废、9已撤销) + /// + public static List Orders; + //public static Stopwatch Watch = new Stopwatch(); + public static ILog Log = LogManager.GetLogger(""); + + /// + /// 通过协议卡号获取车辆信息 + /// + /// 卡号 + /// + public VehicleModel Get(string terminalNo) + { + var car = Cars.Find(x => x.TerminalNo == terminalNo); + return car; + } + + /// + /// 加载所有车辆信息 + /// + public void Init() + { + try + { + Cars = new List(); + string sql = "SELECT Id,CompanyId,VehicleCode,VehiclePlate,SimNo,TerminalNo,TerminalType,IsActivate,IsGps,Acc,Work,GpsTime from dc_vehicle "; + var dt = SqlHelp.GetDataSet(sql).Tables[0]; + for (int i = 0; i < dt.Rows.Count; i++) + { + var model = new VehicleModel + { + Id = Convert.ToInt64(dt.Rows[i]["Id"]), + CompanyId = Convert.ToInt64(dt.Rows[i]["CompanyId"]), + VehicleCode = Convert.ToString(dt.Rows[i]["VehicleCode"]), + VehiclePlate = Convert.ToString(dt.Rows[i]["VehiclePlate"]), + SimNo = dt.Rows[i]["SimNo"].ToString(), + TerminalNo = dt.Rows[i]["TerminalNo"].ToString(), + TerminalType = Convert.ToInt32(dt.Rows[i]["TerminalType"]), + }; + Cars.Add(model); + } + } + catch (Exception ex) + { + Log.ErrorFormat("Init=报错=,ex.Message={0},ex.InnerException={1},ex.StackTrace={2}", ex.Message, ex.InnerException, ex.StackTrace); + } + } + /// + /// 加载所有公司信息,IsAnalyses为1的才会加载这些公司。 + /// + public void InitCompany() + { + try + { + Companys = new List(); + string sql = "SELECT Id, CompanyName, Longitude, Latitude from dc_company"; + var dt = SqlHelp.GetDataSet(sql).Tables[0]; + for (int i = 0; i < dt.Rows.Count; i++) + { + var model = new CompanyModel + { + Id = Convert.ToInt64(dt.Rows[i]["Id"]), + CompanyName = Convert.ToString(dt.Rows[i]["CompanyName"]), + Longitude = Convert.ToDouble(dt.Rows[i]["Longitude"]), + Latitude = Convert.ToDouble(dt.Rows[i]["Latitude"]), + }; + Companys.Add(model); + } + } + catch (Exception ex) + { + Log.ErrorFormat("Init=报错=,ex.Message={0},ex.InnerException={1},ex.StackTrace={2}", ex.Message, ex.InnerException, ex.StackTrace); + } + } + /// + /// 加载所有车辆订单信息 + /// + public void InitOrders() + { + try + { + Orders = new List(); + string sql = "SELECT Id, Status, VehicleId, Longitude,Latitude,ArriveDate from dc_order"; + var dt = SqlHelp.GetDataSet(sql).Tables[0]; + for (var i = 0; i < dt.Rows.Count; i++) + { + var model = new OrderModel + { + Id = Convert.ToInt64(dt.Rows[i]["Id"]), + State = Convert.ToInt32(dt.Rows[i]["Status"]), + VehicleId = Convert.ToInt64(dt.Rows[i]["VehicleId"]), + Longitude = Convert.ToInt32(dt.Rows[i]["Longitude"]), + Latitude = Convert.ToInt32(dt.Rows[i]["Latitude"]), + ArriveTime = Convert.ToDateTime(dt.Rows[i]["ArriveDate"]) + }; + //订单状态 + Orders.Add(model); + } + } + catch (Exception ex) + { + Log.ErrorFormat("InitCarOrders=报错=,ex.Message={0},ex.InnerException={1},ex.StackTrace={2}", ex.Message, ex.InnerException, ex.StackTrace); + } + } + + public bool ExistThisStateOrder(long orderId,int state) + { + var sql = string.Format("select Id from tc.[Order] where Id={0} and [State]={1}", orderId, state); + var result = SqlHelp.ExecuteScalar(sql); + var id = Convert.ToInt32(result); + return id != 0; + } + } +} diff --git a/GPSBusiness/Util/GpsUtil.cs b/GPSBusiness/Util/GpsUtil.cs new file mode 100644 index 0000000..ce04883 --- /dev/null +++ b/GPSBusiness/Util/GpsUtil.cs @@ -0,0 +1,190 @@ +using System; + +namespace GPSBuSiness.Util +{ + + public static class GPSUtil + { + + public static double pi = 3.1415926535897932384626; + public static double x_pi = 3.14159265358979324 * 3000.0 / 180.0; + public static double a = 6378245.0; + public static double ee = 0.00669342162296594323; + private static double EARTH_RADIUS = 6378.137; + private static double rad(double d) + { + return d * Math.PI / 180.0; + } + public static double transformLat(double x, double y) + { + double ret = -100.0 + 2.0 * x + 3.0 * y + 0.2 * y * y + 0.1 * x * y + + 0.2 * Math.Sqrt(Math.Abs(x)); + ret += (20.0 * Math.Sin(6.0 * x * pi) + 20.0 * Math.Sin(2.0 * x * pi)) * 2.0 / 3.0; + ret += (20.0 * Math.Sin(y * pi) + 40.0 * Math.Sin(y / 3.0 * pi)) * 2.0 / 3.0; + ret += (160.0 * Math.Sin(y / 12.0 * pi) + 320 * Math.Sin(y * pi / 30.0)) * 2.0 / 3.0; + return ret; + } + + public static double transformLon(double x, double y) + { + double ret = 300.0 + x + 2.0 * y + 0.1 * x * x + 0.1 * x * y + 0.1 + * Math.Sqrt(Math.Abs(x)); + ret += (20.0 * Math.Sin(6.0 * x * pi) + 20.0 * Math.Sin(2.0 * x * pi)) * 2.0 / 3.0; + ret += (20.0 * Math.Sin(x * pi) + 40.0 * Math.Sin(x / 3.0 * pi)) * 2.0 / 3.0; + ret += (150.0 * Math.Sin(x / 12.0 * pi) + 300.0 * Math.Sin(x / 30.0 + * pi)) * 2.0 / 3.0; + return ret; + } + + public static Boolean outOfChina(double lat, double lon) + { + if (lon < 72.004 || lon > 137.8347) + return true; + if (lat < 0.8293 || lat > 55.8271) + return true; + return false; + } + /** + * 84 to 火星坐标系 (GCJ-02) World Geodetic System ==> Mars Geodetic System + * + * @param lat + * @param lon + * @return + */ + public static double[] gps84_To_Gcj02(double lat, double lon) + { + if (outOfChina(lat, lon)) + { + return new double[] { lat, lon }; + } + double dLat = transformLat(lon - 105.0, lat - 35.0); + double dLon = transformLon(lon - 105.0, lat - 35.0); + double radLat = lat / 180.0 * pi; + double magic = Math.Sin(radLat); + magic = 1 - ee * magic * magic; + double SqrtMagic = Math.Sqrt(magic); + dLat = (dLat * 180.0) / ((a * (1 - ee)) / (magic * SqrtMagic) * pi); + dLon = (dLon * 180.0) / (a / SqrtMagic * Math.Cos(radLat) * pi); + double mgLat = lat + dLat; + double mgLon = lon + dLon; + return new double[] { mgLat, mgLon }; + } + + /** + * * 火星坐标系 (GCJ-02) to 84 * * @param lon * @param lat * @return + * */ + public static double[] gcj02_To_Gps84(double lat, double lon) + { + double[] gps = gps84_To_Gcj02(lat, lon); + double lontitude = lon * 2 - gps[1]; + double latitude = lat * 2 - gps[0]; + return new double[] { latitude, lontitude }; + } + /** + * 火星坐标系 (GCJ-02) 与百度坐标系 (BD-09) 的转换算法 将 GCJ-02 坐标转换成 BD-09 坐标 + * + * @param lat + * @param lon + */ + public static double[] gcj02_To_Bd09(double lat, double lon) + { + double x = lon, y = lat; + double z = Math.Sqrt(x * x + y * y) + 0.00002 * Math.Sin(y * x_pi); + double theta = Math.Atan2(y, x) + 0.000003 * Math.Cos(x * x_pi); + double tempLon = z * Math.Cos(theta) + 0.0065; + double tempLat = z * Math.Sin(theta) + 0.006; + double[] gps = { tempLat, tempLon }; + return gps; + } + + /** + * * 火星坐标系 (GCJ-02) 与百度坐标系 (BD-09) 的转换算法 * * 将 BD-09 坐标转换成GCJ-02 坐标 * * @param + * bd_lat * @param bd_lon * @return + */ + public static double[] bd09_To_Gcj02(double lat, double lon) + { + double x = lon - 0.0065, y = lat - 0.006; + double z = Math.Sqrt(x * x + y * y) - 0.00002 * Math.Sin(y * x_pi); + double theta = Math.Atan2(y, x) - 0.000003 * Math.Cos(x * x_pi); + double tempLon = z * Math.Cos(theta); + double tempLat = z * Math.Sin(theta); + double[] gps = { tempLat, tempLon }; + return gps; + } + + /**将gps84转为bd09 + * @param lat + * @param lon + * @return + */ + public static double[] gps84_To_bd09(double lat, double lon) + { + double[] gcj02 = gps84_To_Gcj02(lat, lon); + double[] bd09 = gcj02_To_Bd09(gcj02[0], gcj02[1]); + return bd09; + } + public static double[] bd09_To_gps84(double lat, double lon) + { + double[] gcj02 = bd09_To_Gcj02(lat, lon); + double[] gps84 = gcj02_To_Gps84(gcj02[0], gcj02[1]); + //保留小数点后六位 + gps84[0] = retain6(gps84[0]); + gps84[1] = retain6(gps84[1]); + return gps84; + } + + /**保留小数点后六位 + * @param num + * @return + */ + private static double retain6(double num) + { + String result = String.Format("%.6f", num); + return double.Parse(result); + } + + + + /** + * 计算两个经纬度之间的距离 + * @param lat1 + * @param lng1 + * @param lat2 + * @param lng2 + * @return + */ + public static double GetDistance(double lat1, double lng1, double lat2, double lng2) + { + double radLat1 = rad(lat1); + double radLat2 = rad(lat2); + double a = radLat1 - radLat2; + double b = rad(lng1) - rad(lng2); + double s = 2 * Math.Asin(Math.Sqrt(Math.Pow(Math.Sin(a / 2), 2) + + Math.Cos(radLat1) * Math.Cos(radLat2) * Math.Pow(Math.Sin(b / 2), 2))); + s = s * EARTH_RADIUS; + s = Math.Round(s * 1000); + return s; + } + + /** + *算角度 + * @param lat_a 纬度1 + * @param lng_a 经度1 + * @param lat_b 纬度2 + * @param lng_b 经度2 + * @return + */ + public static double GetAngle(double lng_a, double lat_a, double lng_b, double lat_b) + { + + double y = Math.Sin(lng_b - lng_a) * Math.Cos(lat_b); + double x = Math.Cos(lat_a) * Math.Sin(lat_b) - Math.Sin(lat_a) * Math.Cos(lat_b) * Math.Cos(lng_b - lng_a); + double brng = Math.Atan2(y, x); + if (brng < 0) + brng = brng + 360; + return brng; + + } + } + +} \ No newline at end of file diff --git a/GPSBusiness/app.config b/GPSBusiness/app.config new file mode 100644 index 0000000..79f46fd --- /dev/null +++ b/GPSBusiness/app.config @@ -0,0 +1,9 @@ + + + + + + + + + diff --git a/GPSBusiness/libmongocrypt.dylib b/GPSBusiness/libmongocrypt.dylib new file mode 100644 index 0000000..6953c78 Binary files /dev/null and b/GPSBusiness/libmongocrypt.dylib differ diff --git a/GPSBusiness/libmongocrypt.so b/GPSBusiness/libmongocrypt.so new file mode 100644 index 0000000..9bcfbf0 Binary files /dev/null and b/GPSBusiness/libmongocrypt.so differ diff --git a/GPSBusiness/mongocrypt.dll b/GPSBusiness/mongocrypt.dll new file mode 100644 index 0000000..ebbb7cc Binary files /dev/null and b/GPSBusiness/mongocrypt.dll differ diff --git a/GPSBusiness/packages.config b/GPSBusiness/packages.config new file mode 100644 index 0000000..6cd272e --- /dev/null +++ b/GPSBusiness/packages.config @@ -0,0 +1,24 @@ + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/GPSServer.sln b/GPSServer.sln new file mode 100644 index 0000000..83c0669 --- /dev/null +++ b/GPSServer.sln @@ -0,0 +1,139 @@ + +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio Version 16 +VisualStudioVersion = 16.0.31205.134 +MinimumVisualStudioVersion = 10.0.40219.1 +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "GPSServer", "GPSServer\GPSServer.csproj", "{75D60900-0E40-4BA4-8656-E956BBE7895A}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "HPSocketCS", "HPSocketCS\HPSocketCS.csproj", "{DFA935E2-CF37-4E26-B697-D7F3DEE19DD8}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "GPSBusiness", "GPSBusiness\GPSBusiness.csproj", "{5699F908-5B5C-4228-9EB7-6113B2B3992D}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Toogps.Mongo", "Toogps.Mongo\Toogps.Mongo.csproj", "{92893153-C7F1-42DF-8002-B7AE94829DB6}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Toogps.Mongo.Repository", "Toogps.PGProject.Repository.Mongo\Toogps.Mongo.Repository.csproj", "{AA9C8C9B-D724-48CB-9E6E-400B456ADA5A}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "GpsModels", "GpsModel\GpsModels.csproj", "{275FE3F1-11A3-46F5-8320-493926113C9E}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + CD_ROM|Any CPU = CD_ROM|Any CPU + CD_ROM|x64 = CD_ROM|x64 + Debug|Any CPU = Debug|Any CPU + Debug|x64 = Debug|x64 + DVD-5|Any CPU = DVD-5|Any CPU + DVD-5|x64 = DVD-5|x64 + Release|Any CPU = Release|Any CPU + Release|x64 = Release|x64 + SingleImage|Any CPU = SingleImage|Any CPU + SingleImage|x64 = SingleImage|x64 + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {75D60900-0E40-4BA4-8656-E956BBE7895A}.CD_ROM|Any CPU.ActiveCfg = Release|Any CPU + {75D60900-0E40-4BA4-8656-E956BBE7895A}.CD_ROM|Any CPU.Build.0 = Release|Any CPU + {75D60900-0E40-4BA4-8656-E956BBE7895A}.CD_ROM|x64.ActiveCfg = Release|Any CPU + {75D60900-0E40-4BA4-8656-E956BBE7895A}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {75D60900-0E40-4BA4-8656-E956BBE7895A}.Debug|Any CPU.Build.0 = Debug|Any CPU + {75D60900-0E40-4BA4-8656-E956BBE7895A}.Debug|x64.ActiveCfg = Debug|Any CPU + {75D60900-0E40-4BA4-8656-E956BBE7895A}.Debug|x64.Build.0 = Debug|Any CPU + {75D60900-0E40-4BA4-8656-E956BBE7895A}.DVD-5|Any CPU.ActiveCfg = Debug|Any CPU + {75D60900-0E40-4BA4-8656-E956BBE7895A}.DVD-5|Any CPU.Build.0 = Debug|Any CPU + {75D60900-0E40-4BA4-8656-E956BBE7895A}.DVD-5|x64.ActiveCfg = Debug|Any CPU + {75D60900-0E40-4BA4-8656-E956BBE7895A}.Release|Any CPU.ActiveCfg = Release|Any CPU + {75D60900-0E40-4BA4-8656-E956BBE7895A}.Release|Any CPU.Build.0 = Release|Any CPU + {75D60900-0E40-4BA4-8656-E956BBE7895A}.Release|x64.ActiveCfg = Release|Any CPU + {75D60900-0E40-4BA4-8656-E956BBE7895A}.SingleImage|Any CPU.ActiveCfg = Release|Any CPU + {75D60900-0E40-4BA4-8656-E956BBE7895A}.SingleImage|Any CPU.Build.0 = Release|Any CPU + {75D60900-0E40-4BA4-8656-E956BBE7895A}.SingleImage|x64.ActiveCfg = Release|Any CPU + {DFA935E2-CF37-4E26-B697-D7F3DEE19DD8}.CD_ROM|Any CPU.ActiveCfg = Release|Any CPU + {DFA935E2-CF37-4E26-B697-D7F3DEE19DD8}.CD_ROM|Any CPU.Build.0 = Release|Any CPU + {DFA935E2-CF37-4E26-B697-D7F3DEE19DD8}.CD_ROM|x64.ActiveCfg = Release|x64 + {DFA935E2-CF37-4E26-B697-D7F3DEE19DD8}.CD_ROM|x64.Build.0 = Release|x64 + {DFA935E2-CF37-4E26-B697-D7F3DEE19DD8}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {DFA935E2-CF37-4E26-B697-D7F3DEE19DD8}.Debug|Any CPU.Build.0 = Debug|Any CPU + {DFA935E2-CF37-4E26-B697-D7F3DEE19DD8}.Debug|x64.ActiveCfg = Debug|Any CPU + {DFA935E2-CF37-4E26-B697-D7F3DEE19DD8}.Debug|x64.Build.0 = Debug|Any CPU + {DFA935E2-CF37-4E26-B697-D7F3DEE19DD8}.DVD-5|Any CPU.ActiveCfg = Debug|Any CPU + {DFA935E2-CF37-4E26-B697-D7F3DEE19DD8}.DVD-5|Any CPU.Build.0 = Debug|Any CPU + {DFA935E2-CF37-4E26-B697-D7F3DEE19DD8}.DVD-5|x64.ActiveCfg = Debug|x64 + {DFA935E2-CF37-4E26-B697-D7F3DEE19DD8}.DVD-5|x64.Build.0 = Debug|x64 + {DFA935E2-CF37-4E26-B697-D7F3DEE19DD8}.Release|Any CPU.ActiveCfg = Release|Any CPU + {DFA935E2-CF37-4E26-B697-D7F3DEE19DD8}.Release|Any CPU.Build.0 = Release|Any CPU + {DFA935E2-CF37-4E26-B697-D7F3DEE19DD8}.Release|x64.ActiveCfg = Release|x64 + {DFA935E2-CF37-4E26-B697-D7F3DEE19DD8}.Release|x64.Build.0 = Release|x64 + {DFA935E2-CF37-4E26-B697-D7F3DEE19DD8}.SingleImage|Any CPU.ActiveCfg = Release|Any CPU + {DFA935E2-CF37-4E26-B697-D7F3DEE19DD8}.SingleImage|Any CPU.Build.0 = Release|Any CPU + {DFA935E2-CF37-4E26-B697-D7F3DEE19DD8}.SingleImage|x64.ActiveCfg = Release|x64 + {DFA935E2-CF37-4E26-B697-D7F3DEE19DD8}.SingleImage|x64.Build.0 = Release|x64 + {5699F908-5B5C-4228-9EB7-6113B2B3992D}.CD_ROM|Any CPU.ActiveCfg = Release|Any CPU + {5699F908-5B5C-4228-9EB7-6113B2B3992D}.CD_ROM|Any CPU.Build.0 = Release|Any CPU + {5699F908-5B5C-4228-9EB7-6113B2B3992D}.CD_ROM|x64.ActiveCfg = Release|Any CPU + {5699F908-5B5C-4228-9EB7-6113B2B3992D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {5699F908-5B5C-4228-9EB7-6113B2B3992D}.Debug|Any CPU.Build.0 = Debug|Any CPU + {5699F908-5B5C-4228-9EB7-6113B2B3992D}.Debug|x64.ActiveCfg = Debug|Any CPU + {5699F908-5B5C-4228-9EB7-6113B2B3992D}.Debug|x64.Build.0 = Debug|Any CPU + {5699F908-5B5C-4228-9EB7-6113B2B3992D}.DVD-5|Any CPU.ActiveCfg = Debug|Any CPU + {5699F908-5B5C-4228-9EB7-6113B2B3992D}.DVD-5|Any CPU.Build.0 = Debug|Any CPU + {5699F908-5B5C-4228-9EB7-6113B2B3992D}.DVD-5|x64.ActiveCfg = Debug|Any CPU + {5699F908-5B5C-4228-9EB7-6113B2B3992D}.Release|Any CPU.ActiveCfg = Release|Any CPU + {5699F908-5B5C-4228-9EB7-6113B2B3992D}.Release|Any CPU.Build.0 = Release|Any CPU + {5699F908-5B5C-4228-9EB7-6113B2B3992D}.Release|x64.ActiveCfg = Release|Any CPU + {5699F908-5B5C-4228-9EB7-6113B2B3992D}.SingleImage|Any CPU.ActiveCfg = Release|Any CPU + {5699F908-5B5C-4228-9EB7-6113B2B3992D}.SingleImage|Any CPU.Build.0 = Release|Any CPU + {5699F908-5B5C-4228-9EB7-6113B2B3992D}.SingleImage|x64.ActiveCfg = Release|Any CPU + {92893153-C7F1-42DF-8002-B7AE94829DB6}.CD_ROM|Any CPU.ActiveCfg = Release|Any CPU + {92893153-C7F1-42DF-8002-B7AE94829DB6}.CD_ROM|Any CPU.Build.0 = Release|Any CPU + {92893153-C7F1-42DF-8002-B7AE94829DB6}.CD_ROM|x64.ActiveCfg = Release|Any CPU + {92893153-C7F1-42DF-8002-B7AE94829DB6}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {92893153-C7F1-42DF-8002-B7AE94829DB6}.Debug|Any CPU.Build.0 = Debug|Any CPU + {92893153-C7F1-42DF-8002-B7AE94829DB6}.Debug|x64.ActiveCfg = Debug|Any CPU + {92893153-C7F1-42DF-8002-B7AE94829DB6}.Debug|x64.Build.0 = Debug|Any CPU + {92893153-C7F1-42DF-8002-B7AE94829DB6}.DVD-5|Any CPU.ActiveCfg = Debug|Any CPU + {92893153-C7F1-42DF-8002-B7AE94829DB6}.DVD-5|Any CPU.Build.0 = Debug|Any CPU + {92893153-C7F1-42DF-8002-B7AE94829DB6}.DVD-5|x64.ActiveCfg = Debug|Any CPU + {92893153-C7F1-42DF-8002-B7AE94829DB6}.Release|Any CPU.ActiveCfg = Release|Any CPU + {92893153-C7F1-42DF-8002-B7AE94829DB6}.Release|Any CPU.Build.0 = Release|Any CPU + {92893153-C7F1-42DF-8002-B7AE94829DB6}.Release|x64.ActiveCfg = Release|Any CPU + {92893153-C7F1-42DF-8002-B7AE94829DB6}.SingleImage|Any CPU.ActiveCfg = Release|Any CPU + {92893153-C7F1-42DF-8002-B7AE94829DB6}.SingleImage|Any CPU.Build.0 = Release|Any CPU + {92893153-C7F1-42DF-8002-B7AE94829DB6}.SingleImage|x64.ActiveCfg = Release|Any CPU + {AA9C8C9B-D724-48CB-9E6E-400B456ADA5A}.CD_ROM|Any CPU.ActiveCfg = Release|Any CPU + {AA9C8C9B-D724-48CB-9E6E-400B456ADA5A}.CD_ROM|Any CPU.Build.0 = Release|Any CPU + {AA9C8C9B-D724-48CB-9E6E-400B456ADA5A}.CD_ROM|x64.ActiveCfg = Release|Any CPU + {AA9C8C9B-D724-48CB-9E6E-400B456ADA5A}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {AA9C8C9B-D724-48CB-9E6E-400B456ADA5A}.Debug|Any CPU.Build.0 = Debug|Any CPU + {AA9C8C9B-D724-48CB-9E6E-400B456ADA5A}.Debug|x64.ActiveCfg = Debug|Any CPU + {AA9C8C9B-D724-48CB-9E6E-400B456ADA5A}.Debug|x64.Build.0 = Debug|Any CPU + {AA9C8C9B-D724-48CB-9E6E-400B456ADA5A}.DVD-5|Any CPU.ActiveCfg = Debug|Any CPU + {AA9C8C9B-D724-48CB-9E6E-400B456ADA5A}.DVD-5|Any CPU.Build.0 = Debug|Any CPU + {AA9C8C9B-D724-48CB-9E6E-400B456ADA5A}.DVD-5|x64.ActiveCfg = Debug|Any CPU + {AA9C8C9B-D724-48CB-9E6E-400B456ADA5A}.Release|Any CPU.ActiveCfg = Release|Any CPU + {AA9C8C9B-D724-48CB-9E6E-400B456ADA5A}.Release|Any CPU.Build.0 = Release|Any CPU + {AA9C8C9B-D724-48CB-9E6E-400B456ADA5A}.Release|x64.ActiveCfg = Release|Any CPU + {AA9C8C9B-D724-48CB-9E6E-400B456ADA5A}.SingleImage|Any CPU.ActiveCfg = Release|Any CPU + {AA9C8C9B-D724-48CB-9E6E-400B456ADA5A}.SingleImage|Any CPU.Build.0 = Release|Any CPU + {AA9C8C9B-D724-48CB-9E6E-400B456ADA5A}.SingleImage|x64.ActiveCfg = Release|Any CPU + {275FE3F1-11A3-46F5-8320-493926113C9E}.CD_ROM|Any CPU.ActiveCfg = Release|Any CPU + {275FE3F1-11A3-46F5-8320-493926113C9E}.CD_ROM|Any CPU.Build.0 = Release|Any CPU + {275FE3F1-11A3-46F5-8320-493926113C9E}.CD_ROM|x64.ActiveCfg = Release|Any CPU + {275FE3F1-11A3-46F5-8320-493926113C9E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {275FE3F1-11A3-46F5-8320-493926113C9E}.Debug|Any CPU.Build.0 = Debug|Any CPU + {275FE3F1-11A3-46F5-8320-493926113C9E}.Debug|x64.ActiveCfg = Debug|Any CPU + {275FE3F1-11A3-46F5-8320-493926113C9E}.Debug|x64.Build.0 = Debug|Any CPU + {275FE3F1-11A3-46F5-8320-493926113C9E}.DVD-5|Any CPU.ActiveCfg = Debug|Any CPU + {275FE3F1-11A3-46F5-8320-493926113C9E}.DVD-5|Any CPU.Build.0 = Debug|Any CPU + {275FE3F1-11A3-46F5-8320-493926113C9E}.DVD-5|x64.ActiveCfg = Debug|Any CPU + {275FE3F1-11A3-46F5-8320-493926113C9E}.Release|Any CPU.ActiveCfg = Release|Any CPU + {275FE3F1-11A3-46F5-8320-493926113C9E}.Release|Any CPU.Build.0 = Release|Any CPU + {275FE3F1-11A3-46F5-8320-493926113C9E}.Release|x64.ActiveCfg = Release|Any CPU + {275FE3F1-11A3-46F5-8320-493926113C9E}.SingleImage|Any CPU.ActiveCfg = Release|Any CPU + {275FE3F1-11A3-46F5-8320-493926113C9E}.SingleImage|Any CPU.Build.0 = Release|Any CPU + {275FE3F1-11A3-46F5-8320-493926113C9E}.SingleImage|x64.ActiveCfg = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection + GlobalSection(ExtensibilityGlobals) = postSolution + SolutionGuid = {4DC58900-600F-4ADE-9873-1DC6E7F3873B} + EndGlobalSection +EndGlobal diff --git a/GPSServer/GPSServer.csproj b/GPSServer/GPSServer.csproj new file mode 100644 index 0000000..76a58ba --- /dev/null +++ b/GPSServer/GPSServer.csproj @@ -0,0 +1,173 @@ + + + + + Debug + AnyCPU + {75D60900-0E40-4BA4-8656-E956BBE7895A} + WinExe + Properties + GPSServer + GPSServer + v4.7.2 + 512 + + false + D:\Release\GPServer\ + true + Disk + false + Foreground + 7 + Days + false + false + true + http://localhost/GPSServer/ + 13 + 1.0.0.%2a + false + true + true + + + x64 + true + full + false + ..\bin\x64\Debug\ + DEBUG;TRACE + prompt + 4 + false + + + AnyCPU + pdbonly + true + bin\Release\ + TRACE + prompt + 4 + false + + + + + + + CD000D386F7A0036FBB1B94BFA06BF3A6E3146D8 + + + GPSServer_TemporaryKey.pfx + + + true + + + false + + + + ..\lib\log4net.dll + + + ..\lib\Newtonsoft.Json.dll + + + + + + + + + + + + + + + + + Form + + + Main.cs + + + + + Main.cs + + + ResXFileCodeGenerator + Resources.Designer.cs + Designer + + + True + Resources.resx + True + + + Designer + + + Always + Designer + + + + SettingsSingleFileGenerator + Settings.Designer.cs + + + True + Settings.settings + True + + + + + {5699f908-5b5c-4228-9eb7-6113b2b3992d} + GPSBusiness + + + {275fe3f1-11a3-46f5-8320-493926113c9e} + GpsModels + + + {dfa935e2-cf37-4e26-b697-d7f3dee19dd8} + HPSocketCS + + + {aa9c8c9b-d724-48cb-9e6e-400b456ada5a} + Toogps.Mongo.Repository + + + + + False + Microsoft .NET Framework 4.5 %28x86 和 x64%29 + true + + + False + .NET Framework 3.5 SP1 Client Profile + false + + + False + .NET Framework 3.5 SP1 + false + + + + + \ No newline at end of file diff --git a/GPSServer/Helper/MApplication.cs b/GPSServer/Helper/MApplication.cs new file mode 100644 index 0000000..88d6502 --- /dev/null +++ b/GPSServer/Helper/MApplication.cs @@ -0,0 +1,19 @@ +using System.Collections.Concurrent; +using GpsModels; + +namespace GPSServer.Helper +{ + public class MApplication + { + /// + /// 待处理到RealTime的数据-列队线程安全的列队字典 + /// + public static ConcurrentDictionary> ConcurrentQueues = new ConcurrentDictionary>(); + + /// + /// 待持久化gps数据的列队字典(car) + /// + public static ConcurrentDictionary> CarConcurrentQueues = new ConcurrentDictionary>(); + + } +} diff --git a/GPSServer/Main.Designer.cs b/GPSServer/Main.Designer.cs new file mode 100644 index 0000000..e7a7393 --- /dev/null +++ b/GPSServer/Main.Designer.cs @@ -0,0 +1,246 @@ +namespace GPSServer +{ + partial class Main + { + /// + /// Required designer variable. + /// + private System.ComponentModel.IContainer components = null; + /// + /// Clean up any resources being used. + /// + /// true if managed resources should be disposed; otherwise, false. + protected override void Dispose(bool disposing) + { + if (disposing && (components != null)) + { + components.Dispose(); + } + base.Dispose(disposing); + } + #region Windows Form Designer generated code + /// + /// Required method for Designer support - do not modify + /// the contents of this method with the code editor. + /// + private void InitializeComponent() + { + this.components = new System.ComponentModel.Container(); + this.label1 = new System.Windows.Forms.Label(); + this.label2 = new System.Windows.Forms.Label(); + this.label3 = new System.Windows.Forms.Label(); + this.label4 = new System.Windows.Forms.Label(); + this.label5 = new System.Windows.Forms.Label(); + this.btnStart = new System.Windows.Forms.Button(); + this.btnStop = new System.Windows.Forms.Button(); + this.txtResIpAddress = new System.Windows.Forms.TextBox(); + this.txtResPort = new System.Windows.Forms.TextBox(); + this.timer1 = new System.Windows.Forms.Timer(this.components); + this.timer2 = new System.Windows.Forms.Timer(this.components); + this.timer3 = new System.Windows.Forms.Timer(this.components); + this.timer4 = new System.Windows.Forms.Timer(this.components); + this.lbCJH = new System.Windows.Forms.Label(); + this.lbDL = new System.Windows.Forms.Label(); + this.lbZD = new System.Windows.Forms.Label(); + this.label6 = new System.Windows.Forms.Label(); + this.label7 = new System.Windows.Forms.Label(); + this.SuspendLayout(); + // + // label1 + // + this.label1.AutoSize = true; + this.label1.Location = new System.Drawing.Point(57, 35); + this.label1.Name = "label1"; + this.label1.Size = new System.Drawing.Size(41, 12); + this.label1.TabIndex = 0; + this.label1.Text = "监听IP"; + // + // label2 + // + this.label2.AutoSize = true; + this.label2.Location = new System.Drawing.Point(57, 98); + this.label2.Name = "label2"; + this.label2.Size = new System.Drawing.Size(77, 12); + this.label2.TabIndex = 1; + this.label2.Text = "终端连接数:"; + // + // label3 + // + this.label3.AutoSize = true; + this.label3.Location = new System.Drawing.Point(55, 135); + this.label3.Name = "label3"; + this.label3.Size = new System.Drawing.Size(113, 12); + this.label3.TabIndex = 2; + this.label3.Text = "实时队列中的数据:"; + // + // label4 + // + this.label4.AutoSize = true; + this.label4.Location = new System.Drawing.Point(57, 176); + this.label4.Name = "label4"; + this.label4.Size = new System.Drawing.Size(101, 12); + this.label4.TabIndex = 3; + this.label4.Text = "持久化队列数据:"; + // + // label5 + // + this.label5.AutoSize = true; + this.label5.Location = new System.Drawing.Point(301, 35); + this.label5.Name = "label5"; + this.label5.Size = new System.Drawing.Size(41, 12); + this.label5.TabIndex = 4; + this.label5.Text = "端口:"; + // + // btnStart + // + this.btnStart.Location = new System.Drawing.Point(120, 276); + this.btnStart.Name = "btnStart"; + this.btnStart.Size = new System.Drawing.Size(75, 23); + this.btnStart.TabIndex = 6; + this.btnStart.Text = "Start"; + this.btnStart.UseVisualStyleBackColor = true; + this.btnStart.Click += new System.EventHandler(this.btnStart_Click); + // + // btnStop + // + this.btnStop.Location = new System.Drawing.Point(255, 276); + this.btnStop.Name = "btnStop"; + this.btnStop.Size = new System.Drawing.Size(75, 23); + this.btnStop.TabIndex = 7; + this.btnStop.Text = "Stop"; + this.btnStop.UseVisualStyleBackColor = true; + this.btnStop.Click += new System.EventHandler(this.btnStop_Click); + // + // txtResIpAddress + // + this.txtResIpAddress.Location = new System.Drawing.Point(104, 32); + this.txtResIpAddress.Name = "txtResIpAddress"; + this.txtResIpAddress.Size = new System.Drawing.Size(174, 21); + this.txtResIpAddress.TabIndex = 8; + this.txtResIpAddress.Text = "0.0.0.0"; + // + // txtResPort + // + this.txtResPort.Location = new System.Drawing.Point(348, 32); + this.txtResPort.Name = "txtResPort"; + this.txtResPort.Size = new System.Drawing.Size(54, 21); + this.txtResPort.TabIndex = 9; + this.txtResPort.Text = "9668"; + + // + // timer1 + // + this.timer1.Enabled = true; + this.timer1.Interval = 300000; + this.timer1.Tick += new System.EventHandler(this.timer1_Tick); + // + // timer2 + // + this.timer2.Enabled = true; + this.timer2.Interval = 1000; + this.timer2.Tick += new System.EventHandler(this.timer2_Tick); + // + // timer3 + // + this.timer3.Enabled = true; + this.timer3.Interval = 1000; + this.timer3.Tick += new System.EventHandler(this.timer3_Tick); + // + // timer4 + // + this.timer4.Enabled = true; + this.timer4.Interval = 3000; + this.timer4.Tick += new System.EventHandler(this.timer4_Tick); + // + // lbCJH + // + this.lbCJH.AutoSize = true; + this.lbCJH.Location = new System.Drawing.Point(193, 176); + this.lbCJH.Name = "lbCJH"; + this.lbCJH.Size = new System.Drawing.Size(11, 12); + this.lbCJH.TabIndex = 12; + this.lbCJH.Text = "0"; + // + // lbDL + // + this.lbDL.AutoSize = true; + this.lbDL.Location = new System.Drawing.Point(193, 135); + this.lbDL.Name = "lbDL"; + this.lbDL.Size = new System.Drawing.Size(11, 12); + this.lbDL.TabIndex = 11; + this.lbDL.Text = "0"; + // + // lbZD + // + this.lbZD.AutoSize = true; + this.lbZD.Location = new System.Drawing.Point(193, 98); + this.lbZD.Name = "lbZD"; + this.lbZD.Size = new System.Drawing.Size(11, 12); + this.lbZD.TabIndex = 10; + this.lbZD.Text = "0"; + // + // label6 + // + this.label6.AutoSize = true; + this.label6.Location = new System.Drawing.Point(57, 213); + this.label6.Name = "label6"; + this.label6.Size = new System.Drawing.Size(113, 12); + this.label6.TabIndex = 13; + this.label6.Text = "完成持久化的数据:"; + // + // label7 + // + this.label7.AutoSize = true; + this.label7.Location = new System.Drawing.Point(193, 213); + this.label7.Name = "label7"; + this.label7.Size = new System.Drawing.Size(11, 12); + this.label7.TabIndex = 14; + this.label7.Text = "0"; + // + // Main + // + this.AutoScaleDimensions = new System.Drawing.SizeF(6F, 12F); + this.AutoScaleMode = System.Windows.Forms.AutoScaleMode.Font; + this.ClientSize = new System.Drawing.Size(478, 334); + this.Controls.Add(this.label7); + this.Controls.Add(this.label6); + this.Controls.Add(this.lbCJH); + this.Controls.Add(this.lbDL); + this.Controls.Add(this.lbZD); + this.Controls.Add(this.txtResPort); + this.Controls.Add(this.txtResIpAddress); + this.Controls.Add(this.btnStop); + this.Controls.Add(this.btnStart); + this.Controls.Add(this.label5); + this.Controls.Add(this.label4); + this.Controls.Add(this.label3); + this.Controls.Add(this.label2); + this.Controls.Add(this.label1); + this.Name = "Main"; + this.Text = "GPS服务程序"; + this.Load += new System.EventHandler(this.Main_Load); + this.ResumeLayout(false); + this.PerformLayout(); + + } + #endregion + private System.Windows.Forms.Label label1; + private System.Windows.Forms.Label label2; + private System.Windows.Forms.Label label3; + private System.Windows.Forms.Label label4; + private System.Windows.Forms.Label label5; + private System.Windows.Forms.Button btnStart; + private System.Windows.Forms.Button btnStop; + private System.Windows.Forms.TextBox txtResIpAddress; + private System.Windows.Forms.TextBox txtResPort; + private System.Windows.Forms.Timer timer1; + private System.Windows.Forms.Timer timer2; + private System.Windows.Forms.Timer timer3; + private System.Windows.Forms.Timer timer4; + private System.Windows.Forms.Label lbCJH; + private System.Windows.Forms.Label lbDL; + private System.Windows.Forms.Label lbZD; + private System.Windows.Forms.Label label6; + private System.Windows.Forms.Label label7; + } +} \ No newline at end of file diff --git a/GPSServer/Main.cs b/GPSServer/Main.cs new file mode 100644 index 0000000..22e7c15 --- /dev/null +++ b/GPSServer/Main.cs @@ -0,0 +1,789 @@ +using GpsModels; +using GPSBusiness; +using GPSBusiness.GPSStandard; +using GPSServer.Helper; +using HPSocketCS; +using Newtonsoft.Json; +using System; +using System.Collections.Concurrent; +using System.Collections.Generic; +using System.Configuration; +using System.Linq; +using System.Runtime.InteropServices; +using System.Threading; +using System.Windows.Forms; +using GPSBusiness.BBGPSStandard; +using GPSBusiness.Enum; +using GPSBusiness.Helper; +using GPSBusiness.Redis; +using GPSBusiness.Sql; +using Toogps.Mongo.Repository; +using GPSBusiness.Model; +using GPSBuSiness.Util; + +namespace GPSServer +{ + public partial class Main : Form + { + #region 显示消息 + + private delegate void ShowMsg(string msg); + + private ShowMsg _addMsgLabel; + private ShowMsg _addMsgLabel1; + private ShowMsg _addMsgLabel2; + private ShowMsg _addMsgLabel3; + + // 显示消息:终端连接数 + void AddMsg(string msg) + { + if (this.lbZD.InvokeRequired) + { + this.lbZD.Invoke(_addMsgLabel, msg); + } + else + { + this.lbZD.Text = msg; + } + } + + // 显示消息:实时队列中的数据 + void AddMsg1(string msg) + { + if (this.lbDL.InvokeRequired) + { + this.lbDL.Invoke(_addMsgLabel1, msg); + } + else + { + this.lbDL.Text = msg; + } + } + + // 显示消息:持久化队列数据 + void AddMsg2(string msg) + { + if (this.lbCJH.InvokeRequired) + { + this.lbCJH.Invoke(_addMsgLabel2, msg); + } + else + { + this.lbCJH.Text = msg; + } + } + + // 显示消息:完成持久化的数据 + void AddMsg3(string msg) + { + if (this.label7.InvokeRequired) + { + this.label7.Invoke(_addMsgLabel3, msg); + } + else + { + this.label7.Text = msg; + } + } + + #endregion + + /// + /// 应用状态 + /// + private AppState _appState = AppState.Stoped; + /// + /// gps设备tcp服务 + /// + private readonly TcpServer _gpsEquServer = new TcpServer(); + public static SqlRepository CarService = new SqlRepository(); + private static int _persistenceGpsNo = 0; + private static int _persistenceCarGpsNo = 0; + private static long _savePsNo = 0; + + /// + /// 出发厂区半径 + /// + private static int _setOutRadius; + + /// + /// 到达工地半径 + /// + private static int _arriveRadius; + + public Main() + { + InitializeComponent(); + } + + private void Main_Load(object sender, EventArgs e) + { + this.Log().Info("程序启动"); + _setOutRadius = int.Parse(ConfigurationManager.AppSettings["SetOutRadius"]); + _arriveRadius = int.Parse(ConfigurationManager.AppSettings["ArriveRadius"]); + _addMsgLabel += AddMsg; + _addMsgLabel1 += AddMsg1; + _addMsgLabel2 += AddMsg2; + _addMsgLabel3 += AddMsg3; + GpsStandardHelper.BBStandardToCarGPSHandler = new BbStandardToCarGpsHandler(CarService); + _gpsEquServer.OnPrepareListen += new TcpServerEvent.OnPrepareListenEventHandler(OnGpsEquServerPrepareListen); + _gpsEquServer.OnAccept += new TcpServerEvent.OnAcceptEventHandler(OnGpsEquServerAccept); + _gpsEquServer.OnSend += new TcpServerEvent.OnSendEventHandler(OnGPSEquServerSend); + _gpsEquServer.OnClose += new TcpServerEvent.OnCloseEventHandler(OnGpsEquServerClose); + _gpsEquServer.OnError += new TcpServerEvent.OnErrorEventHandler(OnGpsEquServerError); + _gpsEquServer.OnReceive += new TcpServerEvent.OnReceiveEventHandler(OnGpsEquServerReceive); + _gpsEquServer.OnShutdown += new TcpServerEvent.OnShutdownEventHandler(OnGpsEquServerShutdown); + + CarService.Init(); + CarService.InitCompany(); + CarService.InitOrders(); + SetAppState(AppState.Stoped); +// var list = CarGpsRepository.MongoGetListDemo(); + } + + #region GPSEquService Handle + + private HandleResult OnGpsEquServerPrepareListen(IntPtr soListen) + { + return HandleResult.Ok; + } + + private HandleResult OnGpsEquServerAccept(IntPtr connId, IntPtr pClient) + { + AddMsg(_gpsEquServer.ConnectionCount.ToString()); + return HandleResult.Ok; + } + + private HandleResult OnGPSEquServerSend(IntPtr connId, IntPtr pData, int length) + { + return HandleResult.Ok; + } + + private HandleResult OnGpsEquServerClose(IntPtr connId) + { + AddMsg((_gpsEquServer.ConnectionCount - 1).ToString()); + return HandleResult.Ok; + } + + private HandleResult OnGpsEquServerError(IntPtr connId, SocketOperation enOperation, int errorCode) + { + return OnGpsEquServerClose(connId); + } + + /// + /// 接收设备发来的数据 + /// + /// + /// + /// + /// + private HandleResult OnGpsEquServerReceive(IntPtr intPtr, IntPtr pData, int length) + { + + + try + { + byte[] bytes = new byte[length]; + string mdtStr = ""; + Marshal.Copy(pData, bytes, 0, length); + var gpsResponseDatas = GpsStandardHelper.GetGpsStandardData(bytes, intPtr, mdtStr); + foreach (var gpsResponseData in gpsResponseDatas) + { + if (gpsResponseData.GpsInfo != null) + { + var gpsModel = gpsResponseData.GpsInfo; + if (gpsModel == null) continue; + if (gpsModel.Acc == -1 )//沃瑞特心跳或者博实结未定位 + { + gpsModel.GpsState = GpsStateEnum.Motionless.ToInt(); //默认静止 + gpsModel.DurationTime = ""; + gpsModel.AccDurationTime = ""; + #region 先处理沃瑞特心跳在线实时的时间===沃瑞特gps心跳时间间隔:2分钟一次。 + var haveSpeedModel = RedisRepository.GetLastHaveSpeed(gpsModel); + if (haveSpeedModel != null) + { + var time2 = DateTime.Now - haveSpeedModel.GpsTime; + gpsModel.DurationTime = CalculationGpsHelper.TimeSpanFormat(time2); + if (time2.TotalSeconds < 31) + { + gpsModel.GpsState = GpsStateEnum.Moving.ToInt(); + gpsModel.Speed = haveSpeedModel.Speed; + gpsModel.DurationTime = ""; + } + } + + FirstStatusCacheService(gpsModel, (int)StatusEnum.Acc); + + //分析Acc持续时长 + var firstAccModel = RedisRepository.GetFirstStatus(gpsModel, (int)StatusEnum.Acc); + if (firstAccModel != null) + { + if (firstAccModel.Acc != -1) + { + var time3 = DateTime.Now - firstAccModel.GpsTime; + if (time3.TotalMilliseconds > 0) + gpsModel.AccDurationTime = CalculationGpsHelper.TimeSpanFormat(time3); + } + } + + FirstStatusCacheService(gpsModel, (int)StatusEnum.Work); + + //分析作业持续时长 + var firstWorkModel = RedisRepository.GetFirstStatus(gpsModel, (int)StatusEnum.Work); + if (firstWorkModel != null) + { + if (firstWorkModel.Work != -1) + { + var time3 = DateTime.Now - firstWorkModel.GpsTime; + if (time3.TotalMilliseconds > 0) + gpsModel.WorkDurationTime = CalculationGpsHelper.TimeSpanFormat(time3); + } + } + + + "bytes".Log().DebugFormat("GpsRealTimeRepository"); + + + + //MyGpsServer.UpdateGpsRealTimeGpsStateWrt(gpsModel); + GpsRealTimeRepository.UpdateGpsRealTimeGpsStateWrt(gpsModel); + #endregion + } + else//有gps数据信息,则加入到队列。 + { + //加入队列 + ConcurrentQueue concurrentQueues; + if (MApplication.ConcurrentQueues.TryGetValue(1, out concurrentQueues) == false) + { + //三次失败就不再尝试了 + concurrentQueues = new ConcurrentQueue(); + if (MApplication.ConcurrentQueues.TryAdd(1, concurrentQueues) == false) + { + if (MApplication.ConcurrentQueues.TryAdd(1, concurrentQueues) == false) + { + if (MApplication.ConcurrentQueues.TryAdd(1, concurrentQueues) == false) + { + this.Log().Error("TryAdd(model.SiteId, ConcurrentQueues) false"); + } + } + } + } + + //转成高德地图坐标点 + //var tgGps = + // MapHelper.Gps84ToGD((double)gpsModel.Latitude, + // (double)gpsModel.Longitude); + + + //基站定位不做多余解析 + if (gpsModel.LocationStatus != 0) + { + var gdGps = GPSUtil.gps84_To_Gcj02((double)gpsModel.Latitude, + (double)gpsModel.Longitude); + if (gdGps.Length > 0) + { + gpsModel.Latitude = Convert.ToDecimal(gdGps[0]); + gpsModel.Longitude = Convert.ToDecimal(gdGps[1]); + } + } + gpsModel.Address = MapHelper.GetLocationByLngLat(gpsModel.Longitude, gpsModel.Latitude); + + // this.Log().InfoFormat("GPS数据对比,tgGps={0},gdGps={1},gdGps={2}", JsonConvert.SerializeObject(tgGps),gdGps[0], gdGps[1]); + + + + + this.Log().InfoFormat(gpsModel.Address); + concurrentQueues.Enqueue(gpsModel); + _persistenceGpsNo++; + this.Log().InfoFormat("添加一条Gps位置信息到队列,共{0}条,model={1}", _persistenceGpsNo, + JsonConvert.SerializeObject(gpsModel)); + } + } + //应答数据不为null,应答设备联接 + if (gpsResponseData.ReturnData != null) + { + _gpsEquServer.Send(intPtr, gpsResponseData.ReturnData, gpsResponseData.ReturnData.Length); + } + } + AddMsg1(_persistenceGpsNo.ToString()); + } + catch (Exception ex) + { + this.Log().ErrorFormat("OnGPSEquServerReceive=报错=,ex.Message={0},ex.InnerException={1},ex.StackTrace={2}", + ex.Message, ex.InnerException, ex.StackTrace); + } + return HandleResult.Ok; + } + + private HandleResult OnGpsEquServerShutdown() + { + AddMsg((_gpsEquServer.ConnectionCount - 1).ToString()); + return HandleResult.Ok; + } + + #endregion + + private void btnStart_Click(object sender, EventArgs e) + { + SetAppState(AppState.Starting); + StartGpsEquServer(); + } + + private void StartGpsEquServer() + { + try + { + _gpsEquServer.IpAddress = this.txtResIpAddress.Text.Trim(); + _gpsEquServer.Port = ushort.Parse(this.txtResPort.Text.Trim()); + // 启动接收服务 + if (_gpsEquServer.Start()) + { + this.Text = string.Format("{2} - ({0}:{1})", this.txtResIpAddress.Text, this.txtResPort.Text, + "GPS服务程序"); + SetAppState(AppState.Started); + } + else + { + SetAppState(AppState.Stoped); + throw new Exception(string.Format("$ receive Server Start Error -> {0}({1})", + _gpsEquServer.ErrorMessage, + _gpsEquServer.ErrorCode)); + } + } + catch (Exception ex) + { + this.Log().ErrorFormat("StartGpsEquServer=报错=,ex.Message={0},ex.InnerException={1},ex.StackTrace={2}", + ex.Message, ex.InnerException, ex.StackTrace); + } + } + + // 设置程序状态 + private void SetAppState(AppState state) + { + _appState = state; + this.btnStart.Enabled = (_appState == AppState.Stoped); + this.btnStop.Enabled = (_appState == AppState.Started); + this.txtResIpAddress.Enabled = (_appState == AppState.Stoped); + this.txtResPort.Enabled = (_appState == AppState.Stoped); + } + + private void btnStop_Click(object sender, EventArgs e) + { + try + { + SetAppState(AppState.Stoping); + // 停止服务 + if (_gpsEquServer.Stop()) + { + this.Text = "GPS服务程序"; + SetAppState(AppState.Stoped); + } + else + { + this.Log().Error(string.Format("btnStop_Click Error -> {0}({1})", + _gpsEquServer.ErrorMessage, _gpsEquServer.ErrorCode)); + } + } + catch (Exception ex) + { + this.Log().ErrorFormat("btnStop_Click=报错=,ex.Message={0},ex.InnerException={1},ex.StackTrace={2}", + ex.Message, ex.InnerException, ex.StackTrace); + } + } + + // 更新车辆、公司、订单信息 + private void timer1_Tick(object sender, EventArgs e) + { + if (_appState != AppState.Started) return; + CarService.Init(); + CarService.InitCompany(); + CarService.InitOrders(); + } + + // 定时器:PersistenceGpsRealTime + private void timer2_Tick(object sender, EventArgs e) + { + if (_appState != AppState.Started) return; + PersistenceGpsRealTime(); + } + + //更新车辆实时位置,更新Redis相关的Gps信息:1、车辆最后GPS时间。2、最后存在速度的GPS时间。3、Acc第一次开启的时间 + private void PersistenceGpsRealTime() + { + try + { + foreach (var concurrentQueue in MApplication.ConcurrentQueues) + { + try + { + if (concurrentQueue.Value.Count == 0) continue; + var models = new List(); + for (var i = 0; i < Convert.ToInt32(_gpsEquServer.ConnectionCount); ) + { + GpsModel model; + if (concurrentQueue.Value.TryDequeue(out model)) + { + models.Add(model); + i++; + _persistenceGpsNo--; + } + else + { + break; + } + } + + if (models.Count == 0) continue; + foreach (var item in models) + { + var gpsModel = item; + //=======================更新车辆实时==位置========================== + //MyGpsServer.UpdateGpsRealTime(gpsModel); + //当有GPS数据时再更新主表 + if (gpsModel.Latitude > 0 && gpsModel.Longitude > 0) + { + GpsRealTimeRepository.UpdateGpsRealTime(gpsModel); + } + else + { + this.Log().ErrorFormat("gpsModel.Latitude=0:{2}", + gpsModel.VehicleId); + } + //=======================更新车辆实时==位置========================== + //有速度的最后定位时间 到Redis + LastHaveSpeedCacheService(gpsModel); + //更新Acc 到Redis + FirstStatusCacheService(gpsModel, (int)StatusEnum.Acc); + //更新Work 到Redis + FirstStatusCacheService(gpsModel, (int)StatusEnum.Work); + //=======================更新车辆实时==状态========================== + AnalysesGpsState(gpsModel);//TODO:逻辑检查,判断上两句存储在Redis的数据,是否会符合业务逻辑。是否会影响 + //=======================更新车辆实时==状态========================== + + //入列到待持久化队列中 + ConcurrentQueue carConcurrentQueues; + if (MApplication.CarConcurrentQueues.TryGetValue(gpsModel.VehicleId, out carConcurrentQueues) == false) + { + //三次失败就不再尝试了 + carConcurrentQueues = new ConcurrentQueue(); + if (MApplication.CarConcurrentQueues.TryAdd(gpsModel.VehicleId, carConcurrentQueues) == false) + { + if (MApplication.CarConcurrentQueues.TryAdd(gpsModel.VehicleId, carConcurrentQueues) == false) + { + if (MApplication.CarConcurrentQueues.TryAdd(gpsModel.VehicleId, carConcurrentQueues) == false) + { + this.Log().Error("TryAdd(model.VehicleId, ConcurrentQueues) false"); + } + } + } + } + carConcurrentQueues.Enqueue(gpsModel); + _persistenceCarGpsNo++; + } + } + catch (Exception ex) + { + this.Log().ErrorFormat("PersistenceGpsRealTime=concurrentQueue.Key={3}=报错=,ex.Message={0},ex.InnerException={1},ex.StackTrace={2}", + ex.Message, ex.InnerException, ex.StackTrace, concurrentQueue.Key); + } + } + AddMsg1(_persistenceGpsNo.ToString()); + AddMsg2(_persistenceCarGpsNo.ToString()); + } + catch (Exception ex) + { + this.Log().ErrorFormat("timer2_Tick=报错=,ex.Message={0},ex.InnerException={1},ex.StackTrace={2}", + ex.Message, ex.InnerException, ex.StackTrace); + } + } + + // 定时器:持久化gps数据到轨迹表。 + private void timer3_Tick(object sender, EventArgs e) + { + if (_appState != AppState.Started) return; + PersistenceCarGps(); + } + + // 定时器:分析Gps离线后关闭车辆Acc开关。 + private void timer4_Tick(object sender, EventArgs e) + { + if (_appState != AppState.Started) return; + UpdateGpsRealTimeAccState(); + } + /// + /// 离线时关闭车辆的Acc状态 + /// + public void UpdateGpsRealTimeAccState() + { + try + { + var list = GpsRealTimeRepository.GetOffLineGpsRealTime(); + if(!list.Any()) return; + + var offLineList = list.ConvertAll(x => new GpsModel + { + Acc = 0, + Work = 0, + // VehicleId =x.VehicleId, + // SimNo = x.SimNo, + // CompanyId = x.CompanyId , + // Longitude = x.Longitude, + // Latitude = x.Latitude, + // Speed = x.Speed, + // Direct = x.Direct, + GpsState = 0, + //GpsTime = x.GpsTime, + // RecTime = x.RecTime, + //Address = x.Address, + DurationTime = "", + AccDurationTime = "", + WorkDurationTime = "", + }); + offLineList.ForEach(x => + { + FirstStatusCacheService(x,(int)StatusEnum.Acc); + FirstStatusCacheService(x, (int)StatusEnum.Work); + GpsRealTimeRepository.UpdateGpsRealTimeGpsStateWrt(x); + }); + this.Log().InfoFormat("更改Acc状态,更新车辆{0}辆", offLineList.Count); + } + catch (Exception ex) + { + this.Log().ErrorFormat("UpdateGpsRealTimeAccState=报错=,ex.Message={0},ex.InnerException={1},ex.StackTrace={2}", + ex.Message, ex.InnerException, ex.StackTrace); + } + } + + // 持久化gps数据到轨迹表。 + private void PersistenceCarGps() + { + + + this.Log().Debug("PersistenceCarGps"); + try + { + foreach (var concurrentQueue in MApplication.CarConcurrentQueues) + { + try + { + if (concurrentQueue.Value.Count == 0) continue; + var models = new List(); + while (true) + { + GpsModel model; + if (concurrentQueue.Value.TryDequeue(out model)) + { + models.Add(model); + _persistenceCarGpsNo--; + } + else + { + break; + } + } + string tableName = "Car_" + concurrentQueue.Key + "_" + DateTime.Now.ToString("yyyyMM"); + //string tableName = "CarGps_" + concurrentQueue.Key + "_test2_" + DateTime.Now.ToString("yyyyMM"); + //测试 + //插入数据到mongodb中。 + CarGpsRepository.InsertCarGpsList(models, tableName); + _savePsNo += models.Count; + } + catch (Exception ex) + { + this.Log().ErrorFormat("PersistenceCarGps持久化gps数据到Car表异常=concurrentQueue.Key={3}=报错=,ex.Message={0},ex.InnerException={1},ex.StackTrace={2}", + ex.Message, ex.InnerException, ex.StackTrace, concurrentQueue.Key); + } + } + AddMsg2(_persistenceCarGpsNo.ToString()); + AddMsg3(_savePsNo.ToString()); + } + catch (Exception ex) + { + this.Log().ErrorFormat("PersistenceCarGps=报错=,ex.Message={0},ex.InnerException={1},ex.StackTrace={2}", + ex.Message, ex.InnerException, ex.StackTrace); + } + } + + //分析车辆任务状态 + //分析车辆状态:0:离线,1:移动[在线],2:短停[在线],3:长停[在线] + //分析车辆长停短停离线持续时间。 + //分析订单状态是否【已出发】【已到达】【作业中】,有开启gps分析才会分析这个。订单状态:0未指派、1已指派、2已接单、3已出发、4已完成、5已删除、6已到达、7作业中、8已作废、9已撤销 + private void AnalysesGpsState(GpsModel lastModel) + { + var car = SqlRepository.Cars.FirstOrDefault(s => s.Id == lastModel.VehicleId); + if(car == null) return; + var gpsState = GpsStateEnum.OffLine.ToInt(); //Gps时间>15min则表示离线 + var durationTime = ""; //gps持续时长 + //int Acc = 0; //Acc状态 + var AccDurationTime = ""; //Acc持续时长 + var workDurationTime = ""; //Acc持续时长 + var time = DateTime.Now - lastModel.GpsTime; + durationTime = CalculationGpsHelper.TimeSpanFormat(time);//持续时长,长停短停的。//默认为离线持续时长 + AccDurationTime = durationTime; //默认跟gps时长一致。 + if (time.TotalMinutes <= 15)//表示在线 + { + gpsState = GpsStateEnum.Motionless.ToInt();//静止 + if (lastModel.Speed > 0) + { + gpsState = GpsStateEnum.Moving.ToInt();//移动 + durationTime = ""; + } + else + { + var haveSpeedModel = RedisRepository.GetLastHaveSpeed(lastModel); + if (haveSpeedModel != null) + { + var time2 = DateTime.Now - haveSpeedModel.GpsTime; + durationTime = CalculationGpsHelper.TimeSpanFormat(time2); + } + } + //分析Acc持续时长 + var firstAccModel = RedisRepository.GetFirstStatus(lastModel, (int) StatusEnum.Acc); + if (firstAccModel != null) + { + var time3 = DateTime.Now - firstAccModel.GpsTime; + AccDurationTime = CalculationGpsHelper.TimeSpanFormat(time3); + } + //分析作业持续时长 + var firstWorkModel = RedisRepository.GetFirstStatus(lastModel, (int)StatusEnum.Work); + if (firstWorkModel != null) + { + var time3 = DateTime.Now - firstWorkModel.GpsTime; + workDurationTime = CalculationGpsHelper.TimeSpanFormat(time3); + } + } + //=======================更新车辆实时状态========================== + //MyGpsServer.UpdateGpsRealTimeGpsState(car, gpsState, durationTime, AccDurationTime); + GpsRealTimeRepository.UpdateGpsRealTimeGpsState(car, gpsState, durationTime, AccDurationTime, + workDurationTime); + //=======================更新车辆实时状态========================== + + //========分析订单状态(公司已开启订单分析),更改订单的State:已出发,已到达,作业中================= + //找到此车辆所属公司 + var company = SqlRepository.Companys.Find(s => s.Id == 99999); + if (company != null) + { + //找到此车辆所有订单 + var ods = SqlRepository.Orders.FindAll(s => s.VehicleId == car.Id); + if (ods.Any()) + { + foreach (var odModel in ods) + { + //分析:已出发//已接单的才能进行此分析。 + var flag1 = odModel.State == ViOrderStateEnum.Accepted.ToInt(); + var flag3 = odModel.State == ViOrderStateEnum.SetOut.ToInt(); + if (flag1) + { + var distance = CalculationGpsHelper.GetDistance((double)lastModel.Longitude, (double)lastModel.Latitude, + company.Longitude, company.Latitude); + if (distance > _setOutRadius && !ods.Exists(s => s.Id != odModel.Id && s.State != 1)) + { + if (CarService.ExistThisStateOrder(odModel.Id, ViOrderStateEnum.SetOut.ToInt())) + MyGpsServer.UpdateOrderState(odModel.Id, ViOrderStateEnum.SetOut.ToInt(), DateTime.Now); + } + } + //分析:已到达//已接单或已出发才能进行此分析。 + if (flag1 || flag3) + { + var distance2 = CalculationGpsHelper.GetDistance((double)lastModel.Longitude, (double)lastModel.Latitude, + (double)odModel.Longitude, (double)odModel.Latitude); + if (distance2 < _arriveRadius) + { + if (CarService.ExistThisStateOrder(odModel.Id, ViOrderStateEnum.Arrive.ToInt())) + MyGpsServer.UpdateOrderState(odModel.Id, ViOrderStateEnum.Arrive.ToInt(), DateTime.Now); + } + } + var flag5 = odModel.State == ViOrderStateEnum.Arrive.ToInt(); + //分析:作业中//已到达且到达时间大于5分钟,则为工作中 + if (flag5 && odModel.ArriveTime.Year > 1900) + { + var ts = DateTime.Now - odModel.ArriveTime; + if (ts.Minutes > 5) + { + if (CarService.ExistThisStateOrder(odModel.Id, ViOrderStateEnum.Working.ToInt())) + MyGpsServer.UpdateOrderState(odModel.Id, ViOrderStateEnum.Working.ToInt(), DateTime.Now); + } + } + } + } + } + } + + /// + /// 车辆最后存在速度的GPS时间 + /// + /// + /// + public void LastHaveSpeedCacheService(GpsModel model) + { + if (RedisRepository.IsSetLastHaveSpeed(model) && model.Speed <= 0) return; + RedisRepository.SetLastHaveSpeed(model); + } + + /// + /// 车辆Acc/作业状态第一次开启的时间 + /// + /// + /// 1Acc,2Work + /// + public void FirstStatusCacheService(GpsModel model,int type) + { + if (type == (int)StatusEnum.Acc && model.Acc == -1) return; + if (type == (int)StatusEnum.Work && model.Work == -1) return; + + if (!RedisRepository.IsSetFirstStatus(model, type)) + { + RedisRepository.SetFirstStatus(model, type); + } + else + { + + var redisModel = RedisRepository.GetFirstStatus(model, type); + switch (type) + { + case (int) StatusEnum.Acc: + { + if (redisModel == null || redisModel.Acc == model.Acc) return; + break; + } + + case (int)StatusEnum.Work: + { + if (redisModel == null || redisModel.Work == model.Work) return; + break; + } + } + + RedisRepository.SetFirstStatus(model, type); + + var entity = new GpsCarStatusDurationModel + { + VehicleId = model.VehicleId, + CompanyId = model.CompanyId, + Code = model.VehicleCode, + VehicleName = model.VehiclePlate, + State = type == (int) StatusEnum.Acc ? model.Acc : model.Work, + DurationTime = CalculationGpsHelper.TimeSpanFormat(model.GpsTime - redisModel.GpsTime), + TimeBegin = redisModel.GpsTime, + TimeEnd = model.GpsTime, + CreatedTime = DateTime.Now, + ModifiedTime = DateTime.Now, + Type = type + }; + + //Acc变更,则保存Acc持续时长 + GpsRealTimeRepository.AddGpsCarStatusDuration(entity); + + + + } + } + + + } + public enum AppState + { + Starting, Started, Stoping, Stoped, Error + } +} diff --git a/GPSServer/Main.resx b/GPSServer/Main.resx new file mode 100644 index 0000000..27565c8 --- /dev/null +++ b/GPSServer/Main.resx @@ -0,0 +1,132 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + text/microsoft-resx + + + 2.0 + + + System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + + System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + + 104, 17 + + + 191, 17 + + + 278, 17 + + + 17, 17 + + \ No newline at end of file diff --git a/GPSServer/Program.cs b/GPSServer/Program.cs new file mode 100644 index 0000000..53c1bf8 --- /dev/null +++ b/GPSServer/Program.cs @@ -0,0 +1,22 @@ +using System; +using System.IO; +using System.Windows.Forms; +namespace GPSServer +{ + static class Program + { + // public static SqlCarService carService = new SqlCarService(); + /// + /// 应用程序的主入口点。 + /// + [STAThread] + static void Main() + { + var configName = System.AppDomain.CurrentDomain.BaseDirectory + @"log4net.config"; + log4net.Config.XmlConfigurator.ConfigureAndWatch(new FileInfo(configName)); + Application.EnableVisualStyles(); + Application.SetCompatibleTextRenderingDefault(false); + Application.Run(new Main()); + } + } +} diff --git a/GPSServer/Properties/AssemblyInfo.cs b/GPSServer/Properties/AssemblyInfo.cs new file mode 100644 index 0000000..7fe4806 --- /dev/null +++ b/GPSServer/Properties/AssemblyInfo.cs @@ -0,0 +1,33 @@ +using System.Reflection; +using System.Runtime.CompilerServices; +using System.Runtime.InteropServices; +// 有关程序集的常规信息通过以下 +// 特性集控制。更改这些特性值可修改 +// 与程序集关联的信息。 +[assembly: AssemblyTitle("GPSServer")] +[assembly: AssemblyDescription("")] +[assembly: AssemblyConfiguration("")] +[assembly: AssemblyCompany("China")] +[assembly: AssemblyProduct("GPSServer")] +[assembly: AssemblyCopyright("Copyright © China 2017")] +[assembly: AssemblyTrademark("")] +[assembly: AssemblyCulture("")] +// 将 ComVisible 设置为 false 使此程序集中的类型 +// 对 COM 组件不可见。如果需要从 COM 访问此程序集中的类型, +// 则将该类型上的 ComVisible 特性设置为 true。 +[assembly: ComVisible(false)] +// 如果此项目向 COM 公开,则下列 GUID 用于类型库的 ID +[assembly: Guid("c3cddb9d-fbc0-451f-bf46-5bf0b5ab5010")] +// 程序集的版本信息由下面四个值组成: +// +// 主版本 +// 次版本 +// 生成号 +// 修订号 +// +// 可以指定所有这些值,也可以使用“生成号”和“修订号”的默认值, +// 方法是按如下所示使用“*”: +// [assembly: AssemblyVersion("1.0.*")] +[assembly: AssemblyVersion("1.0.0.0")] +[assembly: AssemblyFileVersion("1.0.0.0")] +[assembly: log4net.Config.XmlConfigurator(ConfigFile = "./log4net.config", ConfigFileExtension = "config", Watch = true)] diff --git a/GPSServer/Properties/Resources.Designer.cs b/GPSServer/Properties/Resources.Designer.cs new file mode 100644 index 0000000..c77d708 --- /dev/null +++ b/GPSServer/Properties/Resources.Designer.cs @@ -0,0 +1,63 @@ +//------------------------------------------------------------------------------ +// +// 此代码由工具生成。 +// 运行时版本:4.0.30319.42000 +// +// 对此文件的更改可能会导致不正确的行为,并且如果 +// 重新生成代码,这些更改将会丢失。 +// +//------------------------------------------------------------------------------ + +namespace GPSServer.Properties { + using System; + + + /// + /// 一个强类型的资源类,用于查找本地化的字符串等。 + /// + // 此类是由 StronglyTypedResourceBuilder + // 类通过类似于 ResGen 或 Visual Studio 的工具自动生成的。 + // 若要添加或移除成员,请编辑 .ResX 文件,然后重新运行 ResGen + // (以 /str 作为命令选项),或重新生成 VS 项目。 + [global::System.CodeDom.Compiler.GeneratedCodeAttribute("System.Resources.Tools.StronglyTypedResourceBuilder", "16.0.0.0")] + [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] + [global::System.Runtime.CompilerServices.CompilerGeneratedAttribute()] + internal class Resources { + + private static global::System.Resources.ResourceManager resourceMan; + + private static global::System.Globalization.CultureInfo resourceCulture; + + [global::System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("Microsoft.Performance", "CA1811:AvoidUncalledPrivateCode")] + internal Resources() { + } + + /// + /// 返回此类使用的缓存的 ResourceManager 实例。 + /// + [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] + internal static global::System.Resources.ResourceManager ResourceManager { + get { + if (object.ReferenceEquals(resourceMan, null)) { + global::System.Resources.ResourceManager temp = new global::System.Resources.ResourceManager("GPSServer.Properties.Resources", typeof(Resources).Assembly); + resourceMan = temp; + } + return resourceMan; + } + } + + /// + /// 重写当前线程的 CurrentUICulture 属性,对 + /// 使用此强类型资源类的所有资源查找执行重写。 + /// + [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] + internal static global::System.Globalization.CultureInfo Culture { + get { + return resourceCulture; + } + set { + resourceCulture = value; + } + } + } +} diff --git a/GPSServer/Properties/Resources.resx b/GPSServer/Properties/Resources.resx new file mode 100644 index 0000000..2288f9c --- /dev/null +++ b/GPSServer/Properties/Resources.resx @@ -0,0 +1,106 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + text/microsoft-resx + + + 2.0 + + + System.Resources.ResXResourceReader, System.Windows.Forms, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + + System.Resources.ResXResourceWriter, System.Windows.Forms, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + \ No newline at end of file diff --git a/GPSServer/Properties/Settings.Designer.cs b/GPSServer/Properties/Settings.Designer.cs new file mode 100644 index 0000000..adb6ebf --- /dev/null +++ b/GPSServer/Properties/Settings.Designer.cs @@ -0,0 +1,26 @@ +//------------------------------------------------------------------------------ +// +// 此代码由工具生成。 +// 运行时版本:4.0.30319.42000 +// +// 对此文件的更改可能会导致不正确的行为,并且如果 +// 重新生成代码,这些更改将会丢失。 +// +//------------------------------------------------------------------------------ + +namespace GPSServer.Properties { + + + [global::System.Runtime.CompilerServices.CompilerGeneratedAttribute()] + [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.VisualStudio.Editors.SettingsDesigner.SettingsSingleFileGenerator", "16.10.0.0")] + internal sealed partial class Settings : global::System.Configuration.ApplicationSettingsBase { + + private static Settings defaultInstance = ((Settings)(global::System.Configuration.ApplicationSettingsBase.Synchronized(new Settings()))); + + public static Settings Default { + get { + return defaultInstance; + } + } + } +} diff --git a/GPSServer/Properties/Settings.settings b/GPSServer/Properties/Settings.settings new file mode 100644 index 0000000..3964565 --- /dev/null +++ b/GPSServer/Properties/Settings.settings @@ -0,0 +1,7 @@ + + + + + + + diff --git a/GPSServer/app.config b/GPSServer/app.config new file mode 100644 index 0000000..70e9182 --- /dev/null +++ b/GPSServer/app.config @@ -0,0 +1,30 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/GPSServer/log4net.config b/GPSServer/log4net.config new file mode 100644 index 0000000..40ffe81 --- /dev/null +++ b/GPSServer/log4net.config @@ -0,0 +1,106 @@ + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/GpsModel/BaseStationModel.cs b/GpsModel/BaseStationModel.cs new file mode 100644 index 0000000..994cfb3 --- /dev/null +++ b/GpsModel/BaseStationModel.cs @@ -0,0 +1,21 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace GpsModels +{ + public class BaseStationModel + { + public int infocode { get; set; } + + public Result result { get; set; } + + } + + public class Result + { + public string location { get; set; } + } +} diff --git a/GpsModel/CarGpsModel.cs b/GpsModel/CarGpsModel.cs new file mode 100644 index 0000000..a434d27 --- /dev/null +++ b/GpsModel/CarGpsModel.cs @@ -0,0 +1,74 @@ +using System; + +namespace GpsModels +{ + public class CarGpsModel + { + /// + /// 车辆id + /// + public long VehicleId { get; set; } + /// + /// 车辆id + /// + public long CompanyId { get; set; } + /// + /// 通讯SIM卡号 + /// + public string SimNo { get; set; } + /// + /// 车牌号 + /// + public string VehiclePlate { get; set; } + /// + /// 车辆编号 + /// + public string VehicleCode { get; set; } + /// + /// 经度 + /// + public decimal Longitude { get; set; } + /// + /// 纬度 + /// + public decimal Latitude { get; set; } + /// + /// 速度 + /// + public int Speed { get; set; } + /// + /// 方向 + /// + public int Direct { get; set; } + /// + /// 位置基本信息状态位,后期派工易用来做车辆的gps状态:GPS在线情况(0:离线,1:移动[在线],2:短停[在线],3:长停[在线]) + /// + public int GpsState { get; set; } + /// + /// Gps数据产生时间 + /// + public DateTime GpsTime { get; set; } + /// + /// Gps数据接收时间 + /// + public DateTime RecTime { get; set; } + /// + /// Acc状态(震动,判断是否点火) + /// + public int Acc { get; set; } + /// + /// 作业状态(通电判断是否作业) + /// + public int Work { get; set; } + + /// + /// 地址 + /// + public string Address { get; set; } + + /// + /// Gps信号模式 1 GPS,2 基站 + /// + public int GpsMode { get; set; } + } +} diff --git a/GpsModel/CompanyModel.cs b/GpsModel/CompanyModel.cs new file mode 100644 index 0000000..2eeffb5 --- /dev/null +++ b/GpsModel/CompanyModel.cs @@ -0,0 +1,10 @@ +namespace GpsModels +{ + public class CompanyModel + { + public long Id { get; set; } + public string CompanyName { get; set; } + public double Longitude { get; set; } + public double Latitude { get; set; } + } +} diff --git a/GpsModel/EnumExtension.cs b/GpsModel/EnumExtension.cs new file mode 100644 index 0000000..0f33840 --- /dev/null +++ b/GpsModel/EnumExtension.cs @@ -0,0 +1,15 @@ +namespace GpsModels +{ + + public static class EnumExtension + { + public static int ToInt(this ViOrderStateEnum sucEnum) + { + return (int)sucEnum; + } + public static int ToInt(this GpsStateEnum sucEnum) + { + return (int)sucEnum; + } + } +} diff --git a/GpsModel/GpsCarAccDurationModel.cs b/GpsModel/GpsCarAccDurationModel.cs new file mode 100644 index 0000000..bb6ad85 --- /dev/null +++ b/GpsModel/GpsCarAccDurationModel.cs @@ -0,0 +1,33 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; +using MongoDB.Bson.Serialization.Attributes; + +namespace GpsModels +{ + [BsonIgnoreExtraElements] + public class GpsCarStatusDurationModel + { + public long VehicleId { get; set; } + public long CompanyId { get; set; } + public string Code { get; set; } + public string VehicleName { get; set; } + public int State { get; set; } + public string DurationTime { get; set; } + /// + /// 状态 1Acc 2作业状态 + /// + public int Type { get; set; } + [BsonDateTimeOptions(Kind = DateTimeKind.Unspecified)] + public DateTime TimeBegin { get; set; } + [BsonDateTimeOptions(Kind = DateTimeKind.Unspecified)] + public DateTime TimeEnd { get; set; } + public string Record { get; set; } + [BsonDateTimeOptions(Kind = DateTimeKind.Unspecified)] + public DateTime ModifiedTime { get; set; } + [BsonDateTimeOptions(Kind = DateTimeKind.Unspecified)] + public DateTime CreatedTime { get; set; } + } +} diff --git a/GpsModel/GpsModel.cs b/GpsModel/GpsModel.cs new file mode 100644 index 0000000..e6a6b35 --- /dev/null +++ b/GpsModel/GpsModel.cs @@ -0,0 +1,56 @@ +namespace GpsModels +{ + public class GpsModel:CarGpsModel + { + /// + /// 车辆启用状态0:启用,1启用。-->车辆在地图的状态,后面分析GpsState:(0:休-停用中;1:闲-可执行;2:忙-任务中)。 + /// + public int Status { get; set; } + + /// + /// 司机联系人 + /// + public string ContactPerson { get; set; } + /// + /// 司机联系电话 + /// + public string ContactPhone { get; set; } + /// + /// 文本地址 + /// + public string Address { get; set; } + /// + /// 停留时长,这个后期再查询时,根据与gps当前时间进行比较。 + /// + public string DurationTime { get; set; } + /// + /// Acc持续时长,开启或关闭的持续时长 + /// + public string AccDurationTime { get; set; } + /// + /// 作业持续时长,开启或关闭的持续时长 + /// + public string WorkDurationTime { get; set; } + /// + /// --欠压 + /// + public int GpsAlert { get; set; } + /// + /// 掉电 + /// + public int Useing { get; set; } + + /// + /// gps品牌 + /// 1 博实结KM02-2线 + /// 2 速联星空-点烟器 + /// 3 博实结KM02-4线 + /// 4 沃瑞特C12 + /// + public int TerminalType { get; set; } + /// + /// 定位状态 0未定位,1已定位 + /// + public int LocationStatus{ get; set; } + } +} diff --git a/GpsModel/GpsModels.csproj b/GpsModel/GpsModels.csproj new file mode 100644 index 0000000..05b59c3 --- /dev/null +++ b/GpsModel/GpsModels.csproj @@ -0,0 +1,74 @@ + + + + + Debug + AnyCPU + {275FE3F1-11A3-46F5-8320-493926113C9E} + Library + Properties + GpsModels + GpsModels + v4.7.2 + 512 + + + + true + full + false + bin\Debug\ + DEBUG;TRACE + prompt + 4 + + + pdbonly + true + bin\Release\ + TRACE + prompt + 4 + + + + ..\lib\MongoDB.Bson.dll + + + ..\lib\MongoDB.Driver.dll + + + ..\lib\MongoDB.Driver.Core.dll + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/GpsModel/GpsRealTimeModel.cs b/GpsModel/GpsRealTimeModel.cs new file mode 100644 index 0000000..443d90e --- /dev/null +++ b/GpsModel/GpsRealTimeModel.cs @@ -0,0 +1,131 @@ +using System; +using MongoDB.Bson.Serialization.Attributes; +namespace GpsModels +{ + [BsonIgnoreExtraElements] + public class GpsRealTimeModel + { + /// + /// + /// + public long VehicleId { get; set; } + + /// + /// + /// + public string VehicleCode { get; set; } + + /// + /// + /// + public string VehiclePlate { get; set; } + + /// + /// + /// + public long VehicleDriver { get; set; } + + /// + /// + /// + public string DriverPhone { get; set; } + + + /// + /// + /// + public int Status { get; set; } + + /// + /// + /// + public int GpsState { get; set; } + + /// + /// + /// + [BsonDateTimeOptions(Kind = DateTimeKind.Unspecified)] + public DateTime GpsTime { get; set; } + + /// + /// + /// + [BsonDateTimeOptions(Kind = DateTimeKind.Unspecified)] + public DateTime RecTime { get; set; } + + /// + /// + /// + public decimal Longitude { get; set; } + /// + /// + /// + public decimal Latitude { get; set; } + /// + /// + /// + public int Direct { get; set; } + /// + /// + /// + public int Speed { get; set; } + /// + /// + /// + public string DurationTime { get; set; } + /// + /// + /// + public int Acc { get; set; } + /// + /// + /// + public string AccDurationTime { get; set; } + /// + /// + /// + public int Work { get; set; } + /// + /// + /// + public string WorkDurationTime { get; set; } + /// + /// + /// + public string Address { get; set; } + /// + /// + /// + public string SimNo { get; set; } + /// + /// + /// + public long CompanyId { get; set; } + /// + /// + /// + [BsonDateTimeOptions(Kind = DateTimeKind.Unspecified)] + public DateTime ModifiedTime { get; set; } + /// + /// + /// + [BsonDateTimeOptions(Kind = DateTimeKind.Unspecified)] + public DateTime CreatedTime { get; set; } + + /// + /// Gps信号模式 1 GPS,2 基站 + /// + public int GpsMode { get; set; } + + /// + /// 欠压 + /// + public int GpsAlert { get; set; } + + /// + /// 掉电 + /// + public int Useing { get; set; } + + } +} \ No newline at end of file diff --git a/GpsModel/GpsStateEnum.cs b/GpsModel/GpsStateEnum.cs new file mode 100644 index 0000000..8e4235a --- /dev/null +++ b/GpsModel/GpsStateEnum.cs @@ -0,0 +1,27 @@ +using System.ComponentModel; + +namespace GpsModels +{ + /// + /// 车辆定位状态,地图监控列表显示:移动,静止,离线。 + /// + public enum GpsStateEnum + { + /// + /// 0离线 + /// + [Description("离线")] + OffLine = 0, + /// + /// 1移动 + /// + [Description("移动")] + Moving = 1, + + /// + /// 2静止 + /// + [Description("静止")] + Motionless = 2, + } +} diff --git a/GpsModel/OrderModel.cs b/GpsModel/OrderModel.cs new file mode 100644 index 0000000..51001e5 --- /dev/null +++ b/GpsModel/OrderModel.cs @@ -0,0 +1,32 @@ +using System; + +namespace GpsModels +{ + public class OrderModel + { + /// + /// 车辆id + /// + public long Id { get; set; } + /// + /// 订单状态:(0未指派、1已指派、2已接单、3已出发、4已完成、5已删除、6已到达、7作业中、8已作废、9已撤销) + /// + public int State { get; set; } + /// + /// 执行车辆id + /// + public long VehicleId { get; set; } + /// + /// 工地经度 + /// + public decimal Longitude { get; set; } + /// + /// 工地纬度 + /// + public decimal Latitude { get; set; } + /// + /// 到达时间 + /// + public DateTime ArriveTime { get; set; } + } +} diff --git a/GpsModel/PointLatLng.cs b/GpsModel/PointLatLng.cs new file mode 100644 index 0000000..741f108 --- /dev/null +++ b/GpsModel/PointLatLng.cs @@ -0,0 +1,13 @@ +namespace GpsModels +{ + public class PointLatLng + { + public PointLatLng(double lat, double lng) + { + Lat = lat; + Lng = lng; + } + public double Lat { get; set; } + public double Lng { get; set; } + } +} diff --git a/GpsModel/Properties/AssemblyInfo.cs b/GpsModel/Properties/AssemblyInfo.cs new file mode 100644 index 0000000..7d2a533 --- /dev/null +++ b/GpsModel/Properties/AssemblyInfo.cs @@ -0,0 +1,36 @@ +using System.Reflection; +using System.Runtime.CompilerServices; +using System.Runtime.InteropServices; + +// 有关程序集的常规信息通过以下 +// 特性集控制。更改这些特性值可修改 +// 与程序集关联的信息。 +[assembly: AssemblyTitle("GpsModel")] +[assembly: AssemblyDescription("")] +[assembly: AssemblyConfiguration("")] +[assembly: AssemblyCompany("Microsoft")] +[assembly: AssemblyProduct("GpsModel")] +[assembly: AssemblyCopyright("Copyright © Microsoft 2018")] +[assembly: AssemblyTrademark("")] +[assembly: AssemblyCulture("")] + +// 将 ComVisible 设置为 false 使此程序集中的类型 +// 对 COM 组件不可见。 如果需要从 COM 访问此程序集中的类型, +// 则将该类型上的 ComVisible 特性设置为 true。 +[assembly: ComVisible(false)] + +// 如果此项目向 COM 公开,则下列 GUID 用于类型库的 ID +[assembly: Guid("28fd03bd-9d6e-4639-ae10-6f79642fba8f")] + +// 程序集的版本信息由下面四个值组成: +// +// 主版本 +// 次版本 +// 生成号 +// 修订号 +// +// 可以指定所有这些值,也可以使用“生成号”和“修订号”的默认值, +// 方法是按如下所示使用“*”: +// [assembly: AssemblyVersion("1.0.*")] +[assembly: AssemblyVersion("1.0.0.0")] +[assembly: AssemblyFileVersion("1.0.0.0")] diff --git a/GpsModel/VehicleModel.cs b/GpsModel/VehicleModel.cs new file mode 100644 index 0000000..c791f58 --- /dev/null +++ b/GpsModel/VehicleModel.cs @@ -0,0 +1,47 @@ +namespace GpsModels +{ + public class VehicleModel + { + /// + /// 车辆id + /// + public long Id { get; set; } + + /// + /// 公司ID + /// + public long CompanyId { get; set; } + + /// + /// 车辆编号 + /// + public string VehicleCode { get; set; } + + /// + /// 车牌号 + /// + public string VehiclePlate { get; set; } + + /// + /// 车辆启用状态0:停用,1:启用。-->车辆在地图的状态,后面分析GpsState:(0:休-停用中;1:闲-可执行;2:忙-任务中)。 + /// + public int Status { get; set; } + + /// + /// 通讯SIM卡号 + /// + public string SimNo { get; set; } + + /// + /// gps品牌 + /// 1 博实结 + /// 2 深圳 + /// + public int TerminalType { get; set; } + + /// + /// 设备号 + /// + public string TerminalNo { get; set; } + } +} \ No newline at end of file diff --git a/GpsModel/ViOrderStateEnum.cs b/GpsModel/ViOrderStateEnum.cs new file mode 100644 index 0000000..37c71c3 --- /dev/null +++ b/GpsModel/ViOrderStateEnum.cs @@ -0,0 +1,70 @@ +using System.ComponentModel; + +namespace GpsModels +{ + /// + /// 车辆派工订单状态 + /// + public enum ViOrderStateEnum + { + // 订单状态(0未指派、1已指派、2已接单、3已出发、4已完成、5已删除、6已到达、7作业中、8已作废、9已撤销) + /// + /// 未指派0 + /// + [Description("未指派")] + UnAssign = 0, + + /// + /// 1已指派 + /// + [Description("已指派")] + Assigned = 1, + + /// + /// 2已接单 + /// + [Description("已接单")] + Accepted = 2, + + /// + /// 3已出发 + /// + [Description("已出发")] + SetOut = 3, + + /// + /// 4已完成 + /// + [Description("已完成")] + Finished = 4, + + /// + /// 5已删除 + /// + [Description("已删除")] + Delete = 5, + + /// + /// 6已到达 + /// + [Description("已到达")] + Arrive = 6, + + /// + /// 7作业中 + /// + [Description("作业中")] + Working = 7, + + /// + /// 8已作废 + /// + [Description("已作废")] + Abandon = 8, + /// + /// 9已撤销 + /// + [Description("已撤销")] + Cancled = 9 + } +} diff --git a/HPSocketCS/HPSocketCS.csproj b/HPSocketCS/HPSocketCS.csproj new file mode 100644 index 0000000..c3756e0 --- /dev/null +++ b/HPSocketCS/HPSocketCS.csproj @@ -0,0 +1,95 @@ + + + + Debug + AnyCPU + 8.0.30703 + 2.0 + {DFA935E2-CF37-4E26-B697-D7F3DEE19DD8} + Library + Properties + HPSocketCS + HPSocketCS + v4.7.2 + 512 + + + + true + full + false + ..\bin\x64\Debug\ + DEBUG;TRACE + prompt + 4 + true + AnyCPU + false + + + pdbonly + true + ..\bin\x86\Release\ + TRACE + prompt + 4 + false + + + true + ..\bin\x64\Debug\ + DEBUG;TRACE + full + x64 + ..\bin\Debug\HPSocketCS.dll.CodeAnalysisLog.xml + true + GlobalSuppressions.cs + prompt + MinimumRecommendedRules.ruleset + ;D:\Program Files\Microsoft Visual Studio 10.0\Team Tools\Static Analysis Tools\\Rule Sets + ;D:\Program Files\Microsoft Visual Studio 10.0\Team Tools\Static Analysis Tools\FxCop\\Rules + false + + + ..\bin\x64\Release\ + TRACE + true + pdbonly + x64 + ..\bin\Release\HPSocketCS.dll.CodeAnalysisLog.xml + true + GlobalSuppressions.cs + prompt + MinimumRecommendedRules.ruleset + ;D:\Program Files\Microsoft Visual Studio 10.0\Team Tools\Static Analysis Tools\\Rule Sets + ;D:\Program Files\Microsoft Visual Studio 10.0\Team Tools\Static Analysis Tools\FxCop\\Rules + false + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/HPSocketCS/Properties/AssemblyInfo.cs b/HPSocketCS/Properties/AssemblyInfo.cs new file mode 100644 index 0000000..3377c63 --- /dev/null +++ b/HPSocketCS/Properties/AssemblyInfo.cs @@ -0,0 +1,32 @@ +using System.Reflection; +using System.Runtime.CompilerServices; +using System.Runtime.InteropServices; +// 有关程序集的常规信息通过以下 +// 特性集控制。更改这些特性值可修改 +// 与程序集关联的信息。 +[assembly: AssemblyTitle("HPSocketCS")] +[assembly: AssemblyDescription("HP-Socket for C#")] +[assembly: AssemblyConfiguration("")] +[assembly: AssemblyCompany("JessMA Open Source")] +[assembly: AssemblyProduct("HPSocketCS")] +[assembly: AssemblyCopyright("Copyright © 2014")] +[assembly: AssemblyTrademark("")] +[assembly: AssemblyCulture("")] +// 将 ComVisible 设置为 false 使此程序集中的类型 +// 对 COM 组件不可见。如果需要从 COM 访问此程序集中的类型, +// 则将该类型上的 ComVisible 特性设置为 true。 +[assembly: ComVisible(false)] +// 如果此项目向 COM 公开,则下列 GUID 用于类型库的 ID +[assembly: Guid("f54bd34d-cd0c-40dc-8c50-73c3ead0a894")] +// 程序集的版本信息由下面四个值组成: +// +// 主版本 +// 次版本 +// 内部版本号 +// 修订号 +// +// 可以指定所有这些值,也可以使用“内部版本号”和“修订号”的默认值, +// 方法是按如下所示使用“*”: +// [assembly: AssemblyVersion("1.0.*")] +[assembly: AssemblyVersion("3.2.3")] +[assembly: AssemblyFileVersion("3.2.3")] diff --git a/HPSocketCS/Sdk.cs b/HPSocketCS/Sdk.cs new file mode 100644 index 0000000..370e99e --- /dev/null +++ b/HPSocketCS/Sdk.cs @@ -0,0 +1,1864 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Runtime.InteropServices; +using HPSocketCS; +namespace HPSocketCS +{ + /// + /// 通信组件服务状态,用程序可以通过通信组件的 GetState() 方法获取组件当前服务状态 + /// + public enum ServiceState + { + /// + /// 正在启动 + /// + Starting = 0, + /// + /// 已经启动 + /// + Started = 1, + /// + /// 正在停止 + /// + Stoping = 2, + /// + /// 已经启动 + /// + Stoped = 3, + } + /// + /// Socket 操作类型,应用程序的 OnErrror() 事件中通过该参数标识是哪种操作导致的错误 + /// + public enum SocketOperation + { + Unknown = 0, // Unknown + Acccept = 1, // Acccept + Connnect = 2, // Connnect + Send = 3, // Send + Receive = 4, // Receive + }; + /// + /// 事件通知处理结果,事件通知的返回值,不同的返回值会影响通信组件的后续行为 + /// + public enum HandleResult + { + /// + /// 成功 + /// + Ok = 0, + /// + /// 忽略 + /// + Ignore = 1, + /// + /// 错误 + /// + Error = 2, + }; + /// + /// 名称:操作结果代码 + /// 描述:组件 Start() / Stop() 方法执行失败时,可通过 GetLastError() 获取错误代码 + /// + public enum SocketError + { + /// + /// 成功 + /// + Ok = 0, + /// + /// 当前状态不允许操作 + /// + IllegalState = 1, + /// + /// 非法参数 + /// + InvalidParam = 2, + /// + /// 创建 SOCKET 失败 + /// + SocketCreate = 3, + /// + /// 绑定 SOCKET 失败 + /// + SocketBind = 4, + /// + /// 设置 SOCKET 失败 + /// + SocketPrepare = 5, + /// + /// 监听 SOCKET 失败 + /// + SocketListen = 6, + /// + /// 创建完成端口失败 + /// + CPCreate = 7, + /// + /// 创建工作线程失败 + /// + WorkerThreadCreate = 8, + /// + /// 创建监测线程失败 + /// + DetectThreadCreate = 9, + /// + /// 绑定完成端口失败 + /// + SocketAttachToCP = 10, + /// + /// 连接服务器失败 + /// + ConnectServer = 11, + /// + /// 网络错误 + /// + Network = 12, + /// + /// 数据处理错误 + /// + DataProc = 13, + /// + /// 数据发送失败 + /// + DataSend = 14, + }; + /// + /// 数据抓取结果,数据抓取操作的返回值 + /// + public enum FetchResult + { + /// + /// 成功 + /// + Ok = 0, + /// + /// 抓取长度过大 + /// + LengthTooLong = 1, + /// + /// 找不到 ConnID 对应的数据 + /// + DataNotFound = 2, + }; + /// + /// 发送策略 + /// + public enum SendPolicy + { + /// + /// 打包模式(默认) + /// + Pack = 0, + /// + /// 安全模式 + /// + Safe = 1, + /// + /// 直接模式 + /// + Direct = 2, + }; + /// + /// 接收策略 + /// + public enum RecvPolicy + { + /// + /// 串行模式(默认) + /// + Serial = 0, + /// + /// 并行模式 + /// + Parallel = 1, + }; + /****************************************************/ + /************** sockaddr结构体,udp服务器时OnAccept最后个参数可转化 **************/ + [StructLayout(LayoutKind.Sequential)] + public struct in_addr + { + public ulong S_addr; + } + //[StructLayout(LayoutKind.Sequential)] + //public struct in_addr + //{ + // public byte s_b1, s_b2, s_b3, s_b4; + //} + [StructLayout(LayoutKind.Sequential)] + public struct sockaddr_in + { + public short sin_family; + public ushort sin_port; + public in_addr sin_addr; + [MarshalAs(UnmanagedType.ByValArray, SizeConst = 8)] + public byte[] sLibNamesin_zero; + } + /****************************************************/ + [StructLayout(LayoutKind.Sequential)] + public struct WSABUF + { + public int Length; + public IntPtr Buffer; + } +} +namespace HPSocketCS.SDK +{ + /// + /// Unicode版本 + /// + public class HPSocketSdk + { + /// + /// HPSocket的文件路径 + /// + //#if DEBUG + // private const string SOCKET_DLL_PATH = "HPSocket4C_UD.dll"; + //#else + private const string SOCKET_DLL_PATH = "HPSocket4C_U.dll"; + //#endif + /*****************************************************************************************************/ + /******************************************** 公共类、接口 ********************************************/ + /*****************************************************************************************************/ + /****************************************************/ + /************** HPSocket4C.dll 回调函数 **************/ + /* Agent & Server & Clent */ + public delegate HandleResult OnSend(IntPtr connId, IntPtr pData, int length); + public delegate HandleResult OnReceive(IntPtr connId, IntPtr pData, int length); + public delegate HandleResult OnPullReceive(IntPtr connId, int length); + public delegate HandleResult OnClose(IntPtr connId); + public delegate HandleResult OnError(IntPtr connId, SocketOperation enOperation, int errorCode); + /* Agent & Server */ + public delegate HandleResult OnShutdown(); + /* Agent & Client */ + public delegate HandleResult OnPrepareConnect(IntPtr connId /* IntPtr pClient */, uint socket); + public delegate HandleResult OnConnect(IntPtr connId /* IntPtr pClient */); + /* Server */ + public delegate HandleResult OnPrepareListen(IntPtr soListen); + public delegate HandleResult OnAccept(IntPtr connId, IntPtr pClient); + /****************************************************/ + /************** HPSocket4C.dll 导出函数 **************/ + /// + /// 创建 TcpServer 对象 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern IntPtr Create_HP_TcpServer(IntPtr pListener); + /// + /// 创建 TcpClient 对象 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern IntPtr Create_HP_TcpClient(IntPtr pListener); + /// + /// 创建 TcpAgent 对象 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern IntPtr Create_HP_TcpAgent(IntPtr pListener); + /// + /// 创建 TcpPullServer 对象 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern IntPtr Create_HP_TcpPullServer(IntPtr pListener); + /// + /// 创建 TcpPullClient 对象 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern IntPtr Create_HP_TcpPullClient(IntPtr pListener); + /// + /// 创建 TcpPullAgent 对象 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern IntPtr Create_HP_TcpPullAgent(IntPtr pListener); + /// + /// 创建 UdpServer 对象 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern IntPtr Create_HP_UdpServer(IntPtr pListener); + /// + /// 创建 UdpClient 对象 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern IntPtr Create_HP_UdpClient(IntPtr pListener); + /// + /// 销毁 TcpServer 对象 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void Destroy_HP_TcpServer(IntPtr pServer); + /// + /// 销毁 TcpClient 对象 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void Destroy_HP_TcpClient(IntPtr pClient); + /// + /// 销毁 TcpAgent 对象 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void Destroy_HP_TcpAgent(IntPtr pAgent); + /// + /// 销毁 TcpPullServer 对象 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void Destroy_HP_TcpPullServer(IntPtr pServer); + /// + /// 销毁 TcpPullClient 对象 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void Destroy_HP_TcpPullClient(IntPtr pClient); + /// + /// 销毁 TcpPullAgent 对象 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void Destroy_HP_TcpPullAgent(IntPtr pAgent); + /// + /// 销毁 UdpServer 对象 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void Destroy_HP_UdpServer(IntPtr pServer); + /// + /// 销毁 UdpClient 对象 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void Destroy_HP_UdpClient(IntPtr pClient); + /// + /// 创建 TcpServerListener 对象 + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern IntPtr Create_HP_TcpServerListener(); + /// + /// 创建 TcpClientListener 对象 + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern IntPtr Create_HP_TcpClientListener(); + /// + /// 创建 TcpAgentListener 对象 + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern IntPtr Create_HP_TcpAgentListener(); + /// + /// 创建 TcpPullServerListener 对象 + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern IntPtr Create_HP_TcpPullServerListener(); + /// + /// 创建 TcpPullClientListener 对象 + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern IntPtr Create_HP_TcpPullClientListener(); + /// + /// 创建 TcpPullAgentListener 对象 + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern IntPtr Create_HP_TcpPullAgentListener(); + /// + /// 创建 UdpServerListener 对象 + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern IntPtr Create_HP_UdpServerListener(); + /// + /// 创建 UdpClientListener 对象 + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern IntPtr Create_HP_UdpClientListener(); + /// + /// 销毁 TcpServerListener 对象 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void Destroy_HP_TcpServerListener(IntPtr pListener); + /// + /// 销毁 TcpClientListener 对象 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void Destroy_HP_TcpClientListener(IntPtr pListener); + /// + /// 销毁 TcpAgentListener 对象 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void Destroy_HP_TcpAgentListener(IntPtr pListener); + /// + /// 销毁 TcpPullServerListener 对象 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void Destroy_HP_TcpPullServerListener(IntPtr pListener); + /// + /// 销毁 TcpPullClientListener 对象 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void Destroy_HP_TcpPullClientListener(IntPtr pListener); + /// + /// 销毁 TcpPullAgentListener 对象 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void Destroy_HP_TcpPullAgentListener(IntPtr pListener); + /// + /// 销毁 UdpServerListener 对象 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void Destroy_HP_UdpServerListener(IntPtr pListener); + /// + /// 销毁 UdpClientListener 对象 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void Destroy_HP_UdpClientListener(IntPtr pListener); + /**********************************************************************************/ + /***************************** Server 回调函数设置方法 *****************************/ + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_Set_FN_Server_OnPrepareListen(IntPtr pListener, OnPrepareListen fn); + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_Set_FN_Server_OnAccept(IntPtr pListener, OnAccept fn); + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_Set_FN_Server_OnSend(IntPtr pListener, OnSend fn); + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_Set_FN_Server_OnReceive(IntPtr pListener, OnReceive fn); + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_Set_FN_Server_OnPullReceive(IntPtr pListener, OnPullReceive fn); + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_Set_FN_Server_OnClose(IntPtr pListener, OnClose fn); + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_Set_FN_Server_OnError(IntPtr pListener, OnError fn); + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_Set_FN_Server_OnShutdown(IntPtr pListener, OnShutdown fn); + /**********************************************************************************/ + /***************************** Client 回调函数设置方法 *****************************/ + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_Set_FN_Client_OnPrepareConnect(IntPtr pListener, OnPrepareConnect fn); + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_Set_FN_Client_OnConnect(IntPtr pListener, OnConnect fn); + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_Set_FN_Client_OnSend(IntPtr pListener, OnSend fn); + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_Set_FN_Client_OnReceive(IntPtr pListener, OnReceive fn); + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_Set_FN_Client_OnPullReceive(IntPtr pListener, OnPullReceive fn); + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_Set_FN_Client_OnClose(IntPtr pListener, OnClose fn); + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_Set_FN_Client_OnError(IntPtr pListener, OnError fn); + /**********************************************************************************/ + /****************************** Agent 回调函数设置方法 *****************************/ + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_Set_FN_Agent_OnPrepareConnect(IntPtr pListener, OnPrepareConnect fn); + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_Set_FN_Agent_OnConnect(IntPtr pListener, OnConnect fn); + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_Set_FN_Agent_OnSend(IntPtr pListener, OnSend fn); + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_Set_FN_Agent_OnReceive(IntPtr pListener, OnReceive fn); + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_Set_FN_Agent_OnPullReceive(IntPtr pListener, OnPullReceive fn); + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_Set_FN_Agent_OnClose(IntPtr pListener, OnClose fn); + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_Set_FN_Agent_OnError(IntPtr pListener, OnError fn); + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_Set_FN_Agent_OnShutdown(IntPtr pListener, OnShutdown fn); + /**************************************************************************/ + /***************************** Server 操作方法 *****************************/ + /// + /// 名称:启动通信组件 + /// 描述:启动服务端通信组件,启动完成后可开始接收客户端连接并收发数据 + /// + /// + /// 监听地址 + /// 监听端口 + /// 失败,可通过 GetLastError() 获取错误代码 + [DllImport(SOCKET_DLL_PATH, CharSet = CharSet.Unicode)] + public static extern bool HP_Server_Start(IntPtr pServer, String pszBindAddress, ushort usPort); + /// + /// 关闭服务端通信组件,关闭完成后断开所有客户端连接并释放所有资源 + /// + /// + /// 失败,可通过 GetLastError() 获取错误代码 + [DllImport(SOCKET_DLL_PATH)] + public static extern bool HP_Server_Stop(IntPtr pServer); + /// + /// 用户通过该方法向指定客户端发送数据 + /// + /// + /// 连接 ID + /// 发送数据长度 + /// 发送数据长度 + /// + [DllImport(SOCKET_DLL_PATH, CharSet = CharSet.Ansi, SetLastError = true)] + public static extern bool HP_Server_Send(IntPtr pServer, IntPtr connId, byte[] pBuffer, int length); + /// + /// 用户通过该方法向指定客户端发送数据 + /// + /// + /// 连接 ID + /// 发送数据长度 + /// 发送数据长度 + /// + [DllImport(SOCKET_DLL_PATH, SetLastError = true)] + public static extern bool HP_Server_Send(IntPtr pServer, IntPtr connId, IntPtr pBuffer, int length); + /// + /// 用户通过该方法向指定客户端发送数据 + /// + /// + /// + /// + /// + /// 针对pBuffer的偏移 + /// + [DllImport(SOCKET_DLL_PATH, CharSet = CharSet.Ansi, SetLastError = true)] + public static extern bool HP_Server_SendPart(IntPtr pServer, IntPtr connId, byte[] pBuffer, int length, int iOffset); + /// + /// 用户通过该方法向指定客户端发送数据 + /// + /// + /// + /// + /// + /// 针对pBuffer的偏移 + /// + [DllImport(SOCKET_DLL_PATH, SetLastError = true)] + public static extern bool HP_Server_SendPart(IntPtr pServer, IntPtr connId, IntPtr pBuffer, int length, int iOffset); + /// + /// 发送多组数据 + /// 向指定连接发送多组数据 + /// TCP - 顺序发送所有数据包 + /// UDP - 把所有数据包组合成一个数据包发送(数据包的总长度不能大于设置的 UDP 包最大长度) + /// + /// + /// 连接 ID + /// 发送缓冲区数组 + /// 发送缓冲区数目 + /// TRUE.成功,FALSE.失败,可通过 Windows API 函数 ::GetLastError() 获取 Windows 错误代码 + [DllImport(SOCKET_DLL_PATH, SetLastError = true)] + public static extern bool HP_Server_SendPackets(IntPtr pServer, IntPtr connId, WSABUF[] pBuffers, int iCount); + /// + /// 断开与某个客户端的连接 + /// + /// + /// 连接 ID + /// 是否强制断开连接 + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern bool HP_Server_Disconnect(IntPtr pServer, IntPtr connId, bool bForce); + /// + /// 断开超过指定时长的连接 + /// + /// + /// 时长(毫秒) + /// 是否强制断开连接 + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern bool HP_Server_DisconnectLongConnections(IntPtr pServer, uint dwPeriod, bool bForce); + /// + /// 断开超过指定时长的静默连接 + /// + /// + /// 时长(毫秒) + /// 是否强制断开连接 + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern bool HP_Server_DisconnectSilenceConnections(IntPtr pServer, uint dwPeriod, bool bForce); + /******************************************************************************/ + /***************************** Server 属性访问方法 *****************************/ + /// + /// 设置数据发送策略 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_Server_SetSendPolicy(IntPtr pServer, SendPolicy enSendPolicy); + /// + /// 获取数据发送策略 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern SendPolicy HP_Server_GetSendPolicy(IntPtr pServer); + /// + /// 设置数据接受策略 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_Server_SetRecvPolicy(IntPtr pServer, RecvPolicy enSendPolicy); + /// + /// 获取数据接收策略 + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern RecvPolicy HP_Server_GetRecvPolicy(IntPtr pServer); + /// + /// 设置连接的附加数据 + /// 是否为连接绑定附加数据或者绑定什么样的数据,均由应用程序只身决定 + /// + /// + /// 连接 ID + /// + /// 若返回 false 失败则为(无效的连接 ID) + [DllImport(SOCKET_DLL_PATH)] + public static extern bool HP_Server_SetConnectionExtra(IntPtr pServer, IntPtr connId, IntPtr pExtra); + /// + /// 获取连接的附加数据 + /// 是否为连接绑定附加数据或者绑定什么样的数据,均由应用程序只身决定 + /// + /// + /// 连接 ID + /// 数据指针 + /// 若返回 false 失败则为(无效的连接 ID) + [DllImport(SOCKET_DLL_PATH)] + public static extern bool HP_Server_GetConnectionExtra(IntPtr pServer, IntPtr connId, ref IntPtr pExtra); + /// + /// 检查通信组件是否已启动 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern bool HP_Server_HasStarted(IntPtr pServer); + /// + /// 查看通信组件当前状态 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern ServiceState HP_Server_GetState(IntPtr pServer); + /// + /// 获取最近一次失败操作的错误代码 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern SocketError HP_Server_GetLastError(IntPtr pServer); + /// + /// 获取最近一次失败操作的错误描述 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern IntPtr HP_Server_GetLastErrorDesc(IntPtr pServer); + /// + /// 获取连接中未发出数据的长度 + /// + /// + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern bool HP_Server_GetPendingDataLength(IntPtr pServer, IntPtr connId, ref int piPending); + /// + /// 获取客户端连接数 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern uint HP_Server_GetConnectionCount(IntPtr pServer); + /// + /// 获取所有连接的 CONNID + /// + /// + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern bool HP_Server_GetAllConnectionIDs(IntPtr pServer, IntPtr[] pIDs, ref uint pdwCount); + /// + /// 获取某个客户端连接时长(毫秒) + /// + /// + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern bool HP_Server_GetConnectPeriod(IntPtr pServer, IntPtr connId, ref uint pdwPeriod); + /// + /// 获取某个连接静默时间(毫秒) + /// + /// + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern bool HP_Server_GetSilencePeriod(IntPtr pServer, IntPtr connId, ref uint pdwPeriod); + /// + /// 获取监听 Socket 的地址信息 + /// + /// + /// + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern bool HP_Server_GetListenAddress(IntPtr pServer, [MarshalAs(UnmanagedType.LPWStr)] StringBuilder lpszAddress, ref int piAddressLen, ref ushort pusPort); + /// + /// 获取某个客户端连接的地址信息 + /// + /// + /// + /// + /// 传入传出值,大小最好在222.222.222.222的长度以上 + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern bool HP_Server_GetRemoteAddress(IntPtr pServer, IntPtr connId, [MarshalAs(UnmanagedType.LPWStr)] StringBuilder lpszAddress, ref int piAddressLen, ref ushort pusPort); + /// + /// 设置 Socket 缓存对象锁定时间(毫秒,在锁定期间该 Socket 缓存对象不能被获取使用) + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_Server_SetFreeSocketObjLockTime(IntPtr pServer, uint dwFreeSocketObjLockTime); + /// + /// 设置 Socket 缓存池大小(通常设置为平均并发连接数量的 1/3 - 1/2) + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_Server_SetFreeSocketObjPool(IntPtr pServer, uint dwFreeSocketObjPool); + /// + /// 设置内存块缓存池大小(通常设置为 Socket 缓存池大小的 2 - 3 倍) + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_Server_SetFreeBufferObjPool(IntPtr pServer, uint dwFreeBufferObjPool); + /// + /// 设置 Socket 缓存池回收阀值(通常设置为 Socket 缓存池大小的 3 倍) + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_Server_SetFreeSocketObjHold(IntPtr pServer, uint dwFreeSocketObjHold); + /// + /// 设置内存块缓存池回收阀值(通常设置为内存块缓存池大小的 3 倍) + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_Server_SetFreeBufferObjHold(IntPtr pServer, uint dwFreeBufferObjHold); + /// + /// 设置工作线程数量(通常设置为 2 * CPU + 2) + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_Server_SetWorkerThreadCount(IntPtr pServer, uint dwWorkerThreadCount); + /// + /// 设置关闭服务前等待连接关闭的最长时限(毫秒,0 则不等待) + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_Server_SetMaxShutdownWaitTime(IntPtr pServer, uint dwMaxShutdownWaitTime); + /// + /// 设置是否标记静默时间(设置为 TRUE 时 DisconnectSilenceConnections() 和 GetSilencePeriod() 才有效,默认:FALSE) + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_Server_SetMarkSilence(IntPtr pServer, bool bMarkSilence); + /// + /// 获取 Socket 缓存对象锁定时间 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern uint HP_Server_GetFreeSocketObjLockTime(IntPtr pServer); + /// + /// 获取 Socket 缓存池大小 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern uint HP_Server_GetFreeSocketObjPool(IntPtr pServer); + /// + /// 获取内存块缓存池大小 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern uint HP_Server_GetFreeBufferObjPool(IntPtr pServer); + /// + /// 获取 Socket 缓存池回收阀值 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern uint HP_Server_GetFreeSocketObjHold(IntPtr pServer); + /// + /// 获取内存块缓存池回收阀值 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern uint HP_Server_GetFreeBufferObjHold(IntPtr pServer); + /// + /// 获取工作线程数量 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern uint HP_Server_GetWorkerThreadCount(IntPtr pServer); + /// + /// 获取关闭服务前等待连接关闭的最长时限 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern uint HP_Server_GetMaxShutdownWaitTime(IntPtr pServer); + /// + /// 检测是否标记静默时间 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern bool HP_Server_IsMarkSilence(IntPtr pServer); + /**********************************************************************************/ + /***************************** TCP Server 操作方法 *****************************/ + /// + /// 名称:发送小文件 + /// 描述:向指定连接发送 4096 KB 以下的小文件 + /// + /// + /// 连接 ID + /// 文件路径 + /// 头部附加数据 + /// 尾部附加数据 + /// TRUE.成功 FALSE -- 失败,可通过 Windows API 函数 ::GetLastError() 获取 Windows 错误代码 + [DllImport(SOCKET_DLL_PATH, CharSet = CharSet.Unicode, SetLastError = true)] + public static extern bool HP_TcpServer_SendSmallFile(IntPtr pServer, IntPtr connId, string lpszFileName, ref WSABUF pHead, ref WSABUF pTail); + /**********************************************************************************/ + /***************************** TCP Server 属性访问方法 *****************************/ + /// + /// 设置 Accept 预投递数量(根据负载调整设置,Accept 预投递数量越大则支持的并发连接请求越多) + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_TcpServer_SetAcceptSocketCount(IntPtr pServer, uint dwAcceptSocketCount); + /// + /// 设置通信数据缓冲区大小(根据平均通信数据包大小调整设置,通常设置为 1024 的倍数) + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_TcpServer_SetSocketBufferSize(IntPtr pServer, uint dwSocketBufferSize); + /// + /// 设置监听 Socket 的等候队列大小(根据并发连接数量调整设置) + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_TcpServer_SetSocketListenQueue(IntPtr pServer, uint dwSocketListenQueue); + /// + /// 设置心跳包间隔(毫秒,0 则不发送心跳包) + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_TcpServer_SetKeepAliveTime(IntPtr pServer, uint dwKeepAliveTime); + /// + /// 设置心跳确认包检测间隔(毫秒,0 不发送心跳包,如果超过若干次 [默认:WinXP 5 次, Win7 10 次] 检测不到心跳确认包则认为已断线) + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_TcpServer_SetKeepAliveInterval(IntPtr pServer, uint dwKeepAliveInterval); + /// + /// 获取 Accept 预投递数量 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern uint HP_TcpServer_GetAcceptSocketCount(IntPtr pServer); + /// + /// 获取通信数据缓冲区大小 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern uint HP_TcpServer_GetSocketBufferSize(IntPtr pServer); + /// + /// 获取监听 Socket 的等候队列大小 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern uint HP_TcpServer_GetSocketListenQueue(IntPtr pServer); + /// + /// 获取心跳检查次数 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern uint HP_TcpServer_GetKeepAliveTime(IntPtr pServer); + /// + /// 获取心跳检查间隔 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern uint HP_TcpServer_GetKeepAliveInterval(IntPtr pServer); + /**********************************************************************************/ + /***************************** UDP Server 属性访问方法 *****************************/ + /// + /// 设置数据报文最大长度(建议在局域网环境下不超过 1472 字节,在广域网环境下不超过 548 字节) + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_UdpServer_SetMaxDatagramSize(IntPtr pServer, uint dwMaxDatagramSize); + /// + /// 获取数据报文最大长度 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern uint HP_UdpServer_GetMaxDatagramSize(IntPtr pServer); + /// + /// 设置 Receive 预投递数量(根据负载调整设置,Receive 预投递数量越大则丢包概率越小) + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_UdpServer_SetPostReceiveCount(IntPtr pServer, uint dwPostReceiveCount); + /// + /// 获取 Receive 预投递数量 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern uint HP_UdpServer_GetPostReceiveCount(IntPtr pServer); + /// + /// 设置监测包尝试次数(0 则不发送监测跳包,如果超过最大尝试次数则认为已断线) + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_UdpServer_SetDetectAttempts(IntPtr pServer, uint dwMaxDatagramSize); + /// + /// 设置监测包发送间隔(秒,0 不发送监测包) + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_UdpServer_SetDetectInterval(IntPtr pServer, uint dwMaxDatagramSize); + /// + /// 获取心跳检查次数 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern uint HP_UdpServer_GetDetectAttempts(IntPtr pServer); + /// + /// 获取心跳检查间隔 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern uint HP_UdpServer_GetDetectInterval(IntPtr pServer); + /******************************************************************************/ + /***************************** Client 组件操作方法 *****************************/ + /// + /// 启动客户端通信组件并连接服务端,启动完成后可开始收发数据 + /// + /// + /// 服务端地址 + /// 服务端端口 + /// 是否采用异步 Connnect + /// 失败,可通过 GetLastError() 获取错误代码 + [DllImport(SOCKET_DLL_PATH, CharSet = CharSet.Unicode)] + public static extern bool HP_Client_Start(IntPtr pClient, string pszRemoteAddress, ushort usPort, bool bAsyncConnect); + /// + /// 关闭客户端通信组件,关闭完成后断开与服务端的连接并释放所有资源 + /// + /// + /// 失败,可通过 GetLastError() 获取错误代码 + [DllImport(SOCKET_DLL_PATH)] + public static extern bool HP_Client_Stop(IntPtr pClient); + /// + /// 用户通过该方法向服务端发送数据 + /// + /// + /// 连接 ID(保留参数,目前该参数并未使用) + /// 发送数据缓冲区 + /// 发送数据长度 + /// 失败,可通过 GetLastError() 获取错误代码 + [DllImport(SOCKET_DLL_PATH, CharSet = CharSet.Ansi, SetLastError = true)] + public static extern bool HP_Client_Send(IntPtr pClient, byte[] pBuffer, int length); + /// + /// 用户通过该方法向服务端发送数据 + /// + /// + /// 连接 ID(保留参数,目前该参数并未使用) + /// 发送数据缓冲区 + /// 发送数据长度 + /// 失败,可通过 GetLastError() 获取错误代码 + [DllImport(SOCKET_DLL_PATH, SetLastError = true)] + public static extern bool HP_Client_Send(IntPtr pClient, IntPtr pBuffer, int length); + /// + /// 用户通过该方法向服务端发送数据 + /// + /// + /// + /// + /// 针对pBuffer的偏移 + /// + [DllImport(SOCKET_DLL_PATH, CharSet = CharSet.Ansi, SetLastError = true)] + public static extern bool HP_Client_SendPart(IntPtr pClient, byte[] pBuffer, int length, int iOffset); + /// + /// 用户通过该方法向服务端发送数据 + /// + /// + /// + /// + /// 针对pBuffer的偏移 + /// + [DllImport(SOCKET_DLL_PATH, SetLastError = true)] + public static extern bool HP_Client_SendPart(IntPtr pClient, IntPtr pBuffer, int length, int iOffset); + /// + /// 发送多组数据 + /// 向服务端发送多组数据 + /// TCP - 顺序发送所有数据包 + /// UDP - 把所有数据包组合成一个数据包发送(数据包的总长度不能大于设置的 UDP 包最大长度) + /// + /// + /// 发送缓冲区数组 + /// 发送缓冲区数目 + /// TRUE.成功,FALSE.失败,可通过 Windows API 函数 ::GetLastError() 获取 Windows 错误代码 + [DllImport(SOCKET_DLL_PATH, SetLastError = true)] + public static extern bool HP_Client_SendPackets(IntPtr pClient, WSABUF[] pBuffers, int iCount); + /******************************************************************************/ + /***************************** Client 属性访问方法 *****************************/ + /// + /// 设置连接的附加数据 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_Client_SetExtra(IntPtr pClient, IntPtr pExtra); + /// + /// 获取连接的附加数据 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern IntPtr HP_Client_GetExtra(IntPtr pClient); + /// + /// 检查通信组件是否已启动 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern bool HP_Client_HasStarted(IntPtr pClient); + /// + /// 查看通信组件当前状态 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern ServiceState HP_Client_GetState(IntPtr pClient); + /// + /// 获取最近一次失败操作的错误代码 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern SocketError HP_Client_GetLastError(IntPtr pClient); + /// + /// 获取最近一次失败操作的错误描述 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern IntPtr HP_Client_GetLastErrorDesc(IntPtr pClient); + /// + /// 获取该组件对象的连接 ID + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern IntPtr HP_Client_GetConnectionID(IntPtr pClient); + /// + /// 获取 Client Socket 的地址信息 + /// + /// + /// + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern bool HP_Client_GetLocalAddress(IntPtr pClient, [MarshalAs(UnmanagedType.LPWStr)] StringBuilder lpszAddress, ref int piAddressLen, ref ushort pusPort); + /// + /// 获取连接中未发出数据的长度 + /// + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern bool HP_Client_GetPendingDataLength(IntPtr pClient, ref int piPending); + /// + /// 设置内存块缓存池大小(通常设置为 -> PUSH 模型:5 - 10;PULL 模型:10 - 20 ) + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_Client_SetFreeBufferPoolSize(IntPtr pClient, uint dwFreeBufferPoolSize); + /// + /// 设置内存块缓存池回收阀值(通常设置为内存块缓存池大小的 3 倍) + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_Client_SetFreeBufferPoolHold(IntPtr pClient, uint dwFreeBufferPoolHold); + /// + /// 获取内存块缓存池大小 + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern uint HP_Client_GetFreeBufferPoolSize(IntPtr pClient); + /// + /// 获取内存块缓存池回收阀值 + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern uint HP_Client_GetFreeBufferPoolHold(IntPtr pClient); + /**********************************************************************************/ + /***************************** TCP Client 操作方法 *****************************/ + /// + /// 名称:发送小文件 + /// 描述:向指定连接发送 4096 KB 以下的小文件 + /// + /// + /// 文件路径 + /// 头部附加数据 + /// 尾部附加数据 + /// TRUE.成功 FALSE -- 失败,可通过 Windows API 函数 ::GetLastError() 获取 Windows 错误代码 + [DllImport(SOCKET_DLL_PATH, CharSet = CharSet.Unicode, SetLastError = true)] + public static extern bool HP_TcpClient_SendSmallFile(IntPtr pClient, string lpszFileName, ref WSABUF pHead, ref WSABUF pTail); + /**********************************************************************************/ + /***************************** TCP Client 属性访问方法 *****************************/ + /// + /// 设置通信数据缓冲区大小(根据平均通信数据包大小调整设置,通常设置为:(N * 1024) - sizeof(TBufferObj)) + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_TcpClient_SetSocketBufferSize(IntPtr pClient, uint dwSocketBufferSize); + /// + /// 设置心跳包间隔(毫秒,0 则不发送心跳包) + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_TcpClient_SetKeepAliveTime(IntPtr pClient, uint dwKeepAliveTime); + /// + /// 设置心跳确认包检测间隔(毫秒,0 不发送心跳包,如果超过若干次 [默认:WinXP 5 次, Win7 10 次] 检测不到心跳确认包则认为已断线) + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_TcpClient_SetKeepAliveInterval(IntPtr pClient, uint dwKeepAliveInterval); + /// + /// 获取通信数据缓冲区大小 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern uint HP_TcpClient_GetSocketBufferSize(IntPtr pClient); + /// + /// 获取心跳检查次数 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern uint HP_TcpClient_GetKeepAliveTime(IntPtr pClient); + /// + /// 获取心跳检查间隔 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern uint HP_TcpClient_GetKeepAliveInterval(IntPtr pClient); + /**********************************************************************************/ + /***************************** UDP Client 属性访问方法 *****************************/ + /// + /// 设置数据报文最大长度(建议在局域网环境下不超过 1472 字节,在广域网环境下不超过 548 字节) + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_UdpClient_SetMaxDatagramSize(IntPtr pClient, uint dwMaxDatagramSize); + /// + /// 获取数据报文最大长度 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern uint HP_UdpClient_GetMaxDatagramSize(IntPtr pClient); + /// + /// 设置监测包尝试次数(0 则不发送监测跳包,如果超过最大尝试次数则认为已断线 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_UdpClient_SetDetectAttempts(IntPtr pClient, uint dwDetectAttempts); + /// + /// 设置监测包发送间隔(秒,0 不发送监测包) + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_UdpClient_SetDetectInterval(IntPtr pClient, uint dwDetectInterval); + /// + /// 获取心跳检查次数 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern uint HP_UdpClient_GetDetectAttempts(IntPtr pClient); + /// + /// 获取心跳检查间隔 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern uint HP_UdpClient_GetDetectInterval(IntPtr pClient); + /**************************************************************************/ + /***************************** Agent 操作方法 *****************************/ + /// + /// 启动通信组件 + /// 启动通信代理组件,启动完成后可开始连接远程服务器 + /// + /// + /// 监听地址 + /// 是否采用异步 Connect + /// 失败,可通过 GetLastError() 获取错误代码 + [DllImport(SOCKET_DLL_PATH, CharSet = CharSet.Unicode)] + public static extern bool HP_Agent_Start(IntPtr pAgent, String pszBindAddress, bool bAsyncConnect); + /// + /// 关闭通信组件 + /// 关闭通信组件,关闭完成后断开所有连接并释放所有资源 + /// + /// + /// -- 失败,可通过 GetLastError() 获取错误代码 + [DllImport(SOCKET_DLL_PATH)] + public static extern bool HP_Agent_Stop(IntPtr pAgent); + /// + /// 连接服务器 + /// 连接服务器,连接成功后 IAgentListener 会接收到 OnConnect() 事件 + /// + /// + /// 服务端地址 + /// 服务端端口 + /// 传出连接 ID + /// 失败,可通过 SYS_GetLastError() 获取 Windows 错误代码 + [DllImport(SOCKET_DLL_PATH, CharSet = CharSet.Unicode, SetLastError = true)] + public static extern bool HP_Agent_Connect(IntPtr pAgent, String pszBindAddress, ushort usPort, ref IntPtr pconnId); + /// + /// 发送数据 + /// 用户通过该方法向指定连接发送数据 + /// + /// + /// 连接 ID + /// 发送数据缓冲区 + /// 发送数据长度 + /// + [DllImport(SOCKET_DLL_PATH, CharSet = CharSet.Ansi, SetLastError = true)] + public static extern bool HP_Agent_Send(IntPtr pAgent, IntPtr connId, byte[] pBuffer, int length); + /// + /// 发送数据 + /// 用户通过该方法向指定连接发送数据 + /// + /// + /// 连接 ID + /// 发送数据缓冲区 + /// 发送数据长度 + /// + [DllImport(SOCKET_DLL_PATH, SetLastError = true)] + public static extern bool HP_Agent_Send(IntPtr pAgent, IntPtr connId, IntPtr pBuffer, int length); + /// + /// 发送数据 + /// 用户通过该方法向指定连接发送数据 + /// + /// + /// + /// + /// + /// 针对pBuffer的偏移 + /// + [DllImport(SOCKET_DLL_PATH, SetLastError = true)] + public static extern bool HP_Agent_SendPart(IntPtr pAgent, IntPtr connId, byte[] pBuffer, int length, int iOffset); + /// + /// 发送数据 + /// 用户通过该方法向指定连接发送数据 + /// + /// + /// + /// + /// + /// 针对pBuffer的偏移 + /// + [DllImport(SOCKET_DLL_PATH, SetLastError = true)] + public static extern bool HP_Agent_SendPart(IntPtr pAgent, IntPtr connId, IntPtr pBuffer, int length, int iOffset); + /// + /// 发送多组数据 + /// 向指定连接发送多组数据 + /// TCP - 顺序发送所有数据包 + /// UDP - 把所有数据包组合成一个数据包发送(数据包的总长度不能大于设置的 UDP 包最大长度) + /// + /// + /// 连接 ID + /// 发送缓冲区数组 + /// 发送缓冲区数目 + /// TRUE.成功,FALSE .失败,可通过 Windows API 函数 ::GetLastError() 获取 Windows 错误代码 + [DllImport(SOCKET_DLL_PATH, SetLastError = true)] + public static extern bool HP_Agent_SendPackets(IntPtr pAgent, IntPtr connId, WSABUF[] pBuffers, int iCount); + /// + /// 断开某个连接 + /// + /// + /// 连接 ID + /// 是否强制断开连接 + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern bool HP_Agent_Disconnect(IntPtr pAgent, IntPtr connId, bool bForce); + /// + /// 断开超过指定时长的连接 + /// + /// + /// 时长(毫秒) + /// 是否强制断开连接 + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern bool HP_Agent_DisconnectLongConnections(IntPtr pAgent, uint dwPeriod, bool bForce); + /// + /// 断开超过指定时长的静默连接 + /// + /// + /// 时长(毫秒) + /// 是否强制断开连接 + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern bool HP_Agent_DisconnectSilenceConnections(IntPtr pAgent, uint dwPeriod, bool bForce); + /******************************************************************************/ + /***************************** Agent 操作方法 *****************************/ + /// + /// 名称:发送小文件 + /// 描述:向指定连接发送 4096 KB 以下的小文件 + /// + /// + /// 连接 ID + /// 文件路径 + /// 头部附加数据 + /// 尾部附加数据 + /// TRUE.成功 FALSE -- 失败,可通过 Windows API 函数 ::GetLastError() 获取 Windows 错误代码 + [DllImport(SOCKET_DLL_PATH, CharSet = CharSet.Unicode, SetLastError = true)] + public static extern bool HP_TcpAgent_SendSmallFile(IntPtr pAgent, IntPtr connId, string lpszFileName, ref WSABUF pHead, ref WSABUF pTail); + /******************************************************************************/ + /***************************** Agent 属性访问方法 *****************************/ + /// + /// 设置数据发送策略 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_Agent_SetSendPolicy(IntPtr pAgent, SendPolicy enSendPolicy); + /// + /// 获取数据发送策略 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern SendPolicy HP_Agent_GetSendPolicy(IntPtr pAgent); + /// + /// 获取数据接收策略 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern RecvPolicy HP_Agent_GetRecvPolicy(IntPtr pAgent); + /// + /// 设置数据接收策略 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_Agent_SetRecvPolicy(IntPtr pAgent, RecvPolicy enRecvPolicy); + /// + /// 设置连接的附加数据 + /// 是否为连接绑定附加数据或者绑定什么样的数据,均由应用程序只身决定 + /// + /// + /// 连接 ID + /// 数据 + /// FALSE -- 失败(无效的连接 ID) + [DllImport(SOCKET_DLL_PATH)] + public static extern bool HP_Agent_SetConnectionExtra(IntPtr pAgent, IntPtr connId, IntPtr pExtra); + /// + /// 获取连接的附加数据 + /// 是否为连接绑定附加数据或者绑定什么样的数据,均由应用程序只身决定 + /// + /// + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern bool HP_Agent_GetConnectionExtra(IntPtr pAgent, IntPtr connId, ref IntPtr pExtra); + /// + /// 检查通信组件是否已启动 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern bool HP_Agent_HasStarted(IntPtr pAgent); + /// + /// 查看通信组件当前状态 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern ServiceState HP_Agent_GetState(IntPtr pAgent); + /// + /// 获取连接数 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern uint HP_Agent_GetConnectionCount(IntPtr pAgent); + /// + /// 获取所有连接的 CONNID + /// + /// + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern bool HP_Agent_GetAllConnectionIDs(IntPtr pAgent, IntPtr[] pIDs, ref uint pdwCount); + /// + /// 获取某个连接时长(毫秒) + /// + /// + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern bool HP_Agent_GetConnectPeriod(IntPtr pAgent, IntPtr connId, ref uint pdwPeriod); + /// + /// 获取某个连接静默时间(毫秒) + /// + /// + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern bool HP_Agent_GetSilencePeriod(IntPtr pAgent, IntPtr connId, ref uint pdwPeriod); + /// + /// 获取监听 Socket 的地址信息 + /// + /// + /// + /// + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern bool HP_Agent_GetLocalAddress(IntPtr pAgent, IntPtr connId, [MarshalAs(UnmanagedType.LPWStr)] StringBuilder lpszAddress, ref int piAddressLen, ref ushort pusPort); + /// + /// 获取某个连接的地址信息 + /// + /// + /// + /// + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern bool HP_Agent_GetRemoteAddress(IntPtr pAgent, IntPtr connId, [MarshalAs(UnmanagedType.LPWStr)] StringBuilder lpszAddress, ref int piAddressLen, ref ushort pusPort); + /// + /// 获取最近一次失败操作的错误代码 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern SocketError HP_Agent_GetLastError(IntPtr pAgent); + /// + /// 获取最近一次失败操作的错误描述 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern IntPtr HP_Agent_GetLastErrorDesc(IntPtr pAgent); + /// + /// 获取连接中未发出数据的长度 + /// + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern bool HP_Agent_GetPendingDataLength(IntPtr pAgent, IntPtr connId, ref int piPending); + /// + /// 设置 Socket 缓存对象锁定时间(毫秒,在锁定期间该 Socket 缓存对象不能被获取使用) + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_Agent_SetFreeSocketObjLockTime(IntPtr pAgent, uint dwFreeSocketObjLockTime); + /// + /// 设置 Socket 缓存池大小(通常设置为平均并发连接数量的 1/3 - 1/2) + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_Agent_SetFreeSocketObjPool(IntPtr pAgent, uint dwFreeSocketObjPool); + /// + /// 设置内存块缓存池大小(通常设置为 Socket 缓存池大小的 2 - 3 倍) + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_Agent_SetFreeBufferObjPool(IntPtr pAgent, uint dwFreeBufferObjPool); + /// + /// 设置 Socket 缓存池回收阀值(通常设置为 Socket 缓存池大小的 3 倍) + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_Agent_SetFreeSocketObjHold(IntPtr pAgent, uint dwFreeSocketObjHold); + /// + /// 设置内存块缓存池回收阀值(通常设置为内存块缓存池大小的 3 倍) + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_Agent_SetFreeBufferObjHold(IntPtr pAgent, uint dwFreeBufferObjHold); + /// + /// 设置工作线程数量(通常设置为 2 * CPU + 2) + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_Agent_SetWorkerThreadCount(IntPtr pAgent, uint dwWorkerThreadCount); + /// + /// 设置关闭组件前等待连接关闭的最长时限(毫秒,0 则不等待) + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_Agent_SetMaxShutdownWaitTime(IntPtr pAgent, uint dwMaxShutdownWaitTime); + /// + /// 设置是否标记静默时间(设置为 TRUE 时 DisconnectSilenceConnections() 和 GetSilencePeriod() 才有效,默认:FALSE) + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_Agent_SetMarkSilence(IntPtr pAgent, bool bMarkSilence); + /// + /// 获取 Socket 缓存对象锁定时间 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern uint HP_Agent_GetFreeSocketObjLockTime(IntPtr pAgent); + /// + /// 获取 Socket 缓存池大小 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern uint HP_Agent_GetFreeSocketObjPool(IntPtr pAgent); + /// + /// 获取内存块缓存池大小 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern uint HP_Agent_GetFreeBufferObjPool(IntPtr pAgent); + /// + /// 获取 Socket 缓存池回收阀值 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern uint HP_Agent_GetFreeSocketObjHold(IntPtr pAgent); + /// + /// 获取内存块缓存池回收阀值 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern uint HP_Agent_GetFreeBufferObjHold(IntPtr pAgent); + /// + /// 获取工作线程数量 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern uint HP_Agent_GetWorkerThreadCount(IntPtr pAgent); + /// + /// 获取关闭组件前等待连接关闭的最长时限 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern uint HP_Agent_GetMaxShutdownWaitTime(IntPtr pAgent); + /// + /// 检测是否标记静默时间 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern bool HP_Agent_IsMarkSilence(IntPtr pAgent); + /**********************************************************************************/ + /***************************** TCP Agent 属性访问方法 *****************************/ + /// + /// 置是否启用地址重用机制(默认:不启用) + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_TcpAgent_SetReuseAddress(IntPtr pAgent, bool bReuseAddress); + /// + /// 检测是否启用地址重用机制 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern bool HP_TcpAgent_IsReuseAddress(IntPtr pAgent); + /// + /// 设置通信数据缓冲区大小(根据平均通信数据包大小调整设置,通常设置为 1024 的倍数) + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_TcpAgent_SetSocketBufferSize(IntPtr pAgent, uint dwSocketBufferSize); + /// + /// 设置心跳包间隔(毫秒,0 则不发送心跳包) + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_TcpAgent_SetKeepAliveTime(IntPtr pAgent, uint dwKeepAliveTime); + /// + /// 设置心跳确认包检测间隔(毫秒,0 不发送心跳包,如果超过若干次 [默认:WinXP 5 次, Win7 10 次] 检测不到心跳确认包则认为已断线) + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern void HP_TcpAgent_SetKeepAliveInterval(IntPtr pAgent, uint dwKeepAliveInterval); + /// + /// 获取通信数据缓冲区大小 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern uint HP_TcpAgent_GetSocketBufferSize(IntPtr pAgent); + /// + /// 获取心跳检查次数 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern uint HP_TcpAgent_GetKeepAliveTime(IntPtr pAgent); + /// + /// 获取心跳检查间隔 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern uint HP_TcpAgent_GetKeepAliveInterval(IntPtr pAgent); + /***************************************************************************************/ + /***************************** TCP Pull Server 组件操作方法 *****************************/ + /// + /// 抓取数据 + /// 用户通过该方法从 Socket 组件中抓取数据 + /// + /// + /// 连接 ID + /// 数据抓取缓冲区 + /// 抓取数据长度 + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern FetchResult HP_TcpPullServer_Fetch(IntPtr pServer, IntPtr connId, IntPtr pBuffer, int length); + /// + /// 窥探数据(不会移除缓冲区数据) + /// 描述:用户通过该方法从 Socket 组件中窥探数据 + /// + /// + /// 连接 ID + /// 窥探缓冲区 + /// 窥探数据长度 + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern FetchResult HP_TcpPullServer_Peek(IntPtr pServer, IntPtr connId, IntPtr pBuffer, int length); + /***************************************************************************************/ + /***************************** TCP Pull Server 属性访问方法 *****************************/ + /***************************************************************************************/ + /***************************** TCP Pull Client 组件操作方法 *****************************/ + /// + /// 抓取数据 + /// 用户通过该方法从 Socket 组件中抓取数据 + /// + /// + /// 连接 ID + /// 数据抓取缓冲区 + /// 抓取数据长度 + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern FetchResult HP_TcpPullClient_Fetch(IntPtr pClient, IntPtr pBuffer, int length); + /// + /// 名称:窥探数据(不会移除缓冲区数据) + /// 描述:用户通过该方法从 Socket 组件中窥探数据 + /// + /// + /// 连接 ID + /// 数据抓取缓冲区 + /// 抓取数据长度 + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern FetchResult HP_TcpPullClient_Peek(IntPtr pClient, IntPtr pBuffer, int length); + /***************************************************************************************/ + /***************************** TCP Pull Client 属性访问方法 *****************************/ + /***************************************************************************************/ + /***************************** TCP Pull Agent 组件操作方法 *****************************/ + /// + /// 抓取数据 + /// 用户通过该方法从 Socket 组件中抓取数据 + /// + /// + /// 连接 ID + /// 数据抓取缓冲区 + /// 抓取数据长度 + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern FetchResult HP_TcpPullAgent_Fetch(IntPtr pAgent, IntPtr connId, IntPtr pBuffer, int length); + /// + /// 名称:窥探数据(不会移除缓冲区数据) + /// 描述:用户通过该方法从 Socket 组件中窥探数据 + /// + /// + /// 连接 ID + /// 数据抓取缓冲区 + /// 抓取数据长度 + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern FetchResult HP_TcpPullAgent_Peek(IntPtr pAgent, IntPtr connId, IntPtr pBuffer, int length); + /***************************************************************************************/ + /***************************** TCP Pull Agent 属性访问方法 *****************************/ + /***************************************************************************************/ + /*************************************** 其它方法 ***************************************/ + /// + /// 获取错误描述文本 + /// + /// + /// + [DllImport(SOCKET_DLL_PATH)] + public static extern IntPtr HP_GetSocketErrorDesc(SocketError enCode); + /// + /// 调用系统的 ::GetLastError() 方法获取系统错误代码 + /// + /// + public static int SYS_GetLastError() + { + return Marshal.GetLastWin32Error(); + } + /// + /// 调用系统的 ::WSAGetLastError() 方法获取通信错误代码 + /// + /// + [DllImport(SOCKET_DLL_PATH, SetLastError = true)] + public static extern int SYS_WSAGetLastError(); + /// + /// 调用系统的 setsockopt() + /// + /// + /// + /// + /// + /// + /// + [DllImport(SOCKET_DLL_PATH, SetLastError = true)] + public static extern int SYS_SetSocketOption(IntPtr sock, int level, int name, IntPtr val, int len); + /// + /// 调用系统的 getsockopt() + /// + /// + /// + /// + /// + /// + /// + [DllImport(SOCKET_DLL_PATH, SetLastError = true)] + public static extern int SYS_GetSocketOption(IntPtr sock, int level, int name, IntPtr val, ref int len); + /// + /// 调用系统的 ioctlsocket() + /// + /// + /// + /// + /// + [DllImport(SOCKET_DLL_PATH, SetLastError = true)] + public static extern int SYS_IoctlSocket(IntPtr sock, long cmd, IntPtr arg); + /// + /// 调用系统的 ::WSAIoctl() + /// + /// + /// + /// + /// + /// + /// + /// + /// + [DllImport(SOCKET_DLL_PATH, SetLastError = true)] + public static extern int SYS_WSAIoctl(IntPtr sock, uint dwIoControlCode, IntPtr lpvInBuffer, uint cbInBuffer, + IntPtr lpvOutBuffer, uint cbOutBuffer, uint lpcbBytesReturned); + } +} diff --git a/HPSocketCS/TcpAgent.cs b/HPSocketCS/TcpAgent.cs new file mode 100644 index 0000000..7b3b3b1 --- /dev/null +++ b/HPSocketCS/TcpAgent.cs @@ -0,0 +1,989 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using HPSocketCS.SDK; +using System.Runtime.InteropServices; +using System.IO; +using System.Runtime.Serialization; +using System.Runtime.Serialization.Formatters.Binary; +namespace HPSocketCS +{ + public class TcpAgentEvent + { + public delegate HandleResult OnConnectEventHandler(IntPtr connId /* IntPtr pClient */); + public delegate HandleResult OnSendEventHandler(IntPtr connId, IntPtr pData, int length); + public delegate HandleResult OnReceiveEventHandler(IntPtr connId, IntPtr pData, int length); + public delegate HandleResult OnCloseEventHandler(IntPtr connId); + public delegate HandleResult OnErrorEventHandler(IntPtr connId, SocketOperation enOperation, int errorCode); + public delegate HandleResult OnShutdownEventHandler(); + public delegate HandleResult OnPrepareConnectEventHandler(IntPtr connId /* IntPtr pClient */, uint socket); + } + public class TcpAgent + { + protected IntPtr _pAgent = IntPtr.Zero; + protected IntPtr pAgent + { + get + { + //if (_pClient == IntPtr.Zero) + //{ + // throw new Exception("pClient == 0"); + //} + return _pAgent; + } + set + { + _pAgent = value; + } + } + protected IntPtr pListener = IntPtr.Zero; + /// + /// 连接事件 + /// + public TcpAgentEvent.OnConnectEventHandler OnConnect; + /// + /// 数据发送事件 + /// + public TcpAgentEvent.OnSendEventHandler OnSend; + /// + /// 准备连接事件 + /// + public TcpAgentEvent.OnPrepareConnectEventHandler OnPrepareConnect; + /// + /// 数据到达事件 + /// + public TcpAgentEvent.OnReceiveEventHandler OnReceive; + /// + /// 连接关闭事件 + /// + public TcpAgentEvent.OnCloseEventHandler OnClose; + /// + /// 连接出错事件 + /// + public TcpAgentEvent.OnErrorEventHandler OnError; + /// + /// 服务关闭事件 + /// + public TcpAgentEvent.OnShutdownEventHandler OnShutdown; + protected bool IsCreate = false; + public TcpAgent() + { + CreateListener(); + } + ~TcpAgent() + { + Destroy(); + } + /// + /// 创建socket监听&服务组件 + /// + /// 是否使用tcpAgent类默认回调函数 + /// + protected virtual bool CreateListener() + { + if (IsCreate == true || pListener != IntPtr.Zero || pAgent != IntPtr.Zero) + { + return false; + } + pListener = HPSocketSdk.Create_HP_TcpAgentListener(); + if (pListener == IntPtr.Zero) + { + return false; + } + pAgent = HPSocketSdk.Create_HP_TcpAgent(pListener); + if (pAgent == IntPtr.Zero) + { + return false; + } + IsCreate = true; + return true; + } + /// + /// 释放TcpAgent和TcpAgentListener + /// + public virtual void Destroy() + { + Stop(); + if (pAgent != IntPtr.Zero) + { + HPSocketSdk.Destroy_HP_TcpAgent(pAgent); + pAgent = IntPtr.Zero; + } + if (pListener != IntPtr.Zero) + { + HPSocketSdk.Destroy_HP_TcpAgentListener(pListener); + pListener = IntPtr.Zero; + } + IsCreate = false; + } + /// + /// 启动通讯组件 + /// 启动完成后可开始连接远程服务器 + /// + /// 绑定地址 + /// 是否异步 + /// + public bool Start(string address, bool async = false) + { + if (string.IsNullOrEmpty(address) == true) + { + throw new Exception("address is null"); + } + if (IsStarted == true) + { + return false; + } + SetCallback(); + return HPSocketSdk.HP_Agent_Start(pAgent, address, async); + } + /// + /// 停止通讯组件 + /// + /// + public bool Stop() + { + if (IsStarted == false) + { + return false; + } + return HPSocketSdk.HP_Agent_Stop(pAgent); + } + /// + /// 连接服务器,连接成功后 IAgentListener 会接收到 OnConnect() 事件 + /// + /// + /// + /// + /// + public bool Connect(string address, ushort port, ref IntPtr connId) + { + return HPSocketSdk.HP_Agent_Connect(pAgent, address, port, ref connId); + } + /// + /// 发送数据 + /// + /// + /// + /// + /// + public bool Send(IntPtr connId, byte[] bytes, int size) + { + return HPSocketSdk.HP_Agent_Send(pAgent, connId, bytes, size); + } + /// + /// 发送数据 + /// + /// + /// + /// + /// + public bool Send(IntPtr connId, T obj) + { + byte[] buffer = StructureToByte(obj); + return Send(connId, buffer, buffer.Length); + } + /// + /// 序列化对象后发送数据,序列化对象所属类必须标记[Serializable] + /// + /// + /// + /// + /// + public bool SendBySerializable(IntPtr connId, object obj) + { + byte[] buffer = ObjectToBytes(obj); + return Send(connId, buffer, buffer.Length); + } + /// + /// 发送数据 + /// + /// + /// + /// + /// + public bool Send(IntPtr connId, IntPtr bufferPtr, int size) + { + return HPSocketSdk.HP_Agent_Send(pAgent, connId, bufferPtr, size); + } + /// + /// 发送数据 + /// + /// + /// + /// 针对bytes的偏移 + /// 发多大 + /// + public bool Send(IntPtr connId, byte[] bytes, int offset, int size) + { + return HPSocketSdk.HP_Agent_SendPart(pAgent, connId, bytes, size, offset); + } + /// + /// 发送数据 + /// + /// + /// + /// 针对bufferPtr的偏移 + /// 发多大 + /// + public bool Send(IntPtr connId, IntPtr bufferPtr, int offset, int size) + { + return HPSocketSdk.HP_Agent_SendPart(pAgent, connId, bufferPtr, size, offset); + } + /// + /// 发送多组数据 + /// 向指定连接发送多组数据 + /// TCP - 顺序发送所有数据包 + /// + /// 连接 ID + /// 发送缓冲区数组 + /// 发送缓冲区数目 + /// TRUE.成功,FALSE.失败,可通过 SYSGetLastError() 获取 Windows 错误代码 + public bool SendPackets(IntPtr connId, WSABUF[] pBuffers, int count) + { + return HPSocketSdk.HP_Agent_SendPackets(pAgent, connId, pBuffers, count); + } + /// + /// 发送多组数据 + /// 向指定连接发送多组数据 + /// TCP - 顺序发送所有数据包 + /// + /// 连接 ID + /// 发送缓冲区数组 + /// 发送缓冲区数目 + /// TRUE.成功,FALSE.失败,可通过 SYSGetLastError() 获取 Windows 错误代码 + public bool SendPackets(IntPtr connId, T[] objects) + { + bool ret = false; + WSABUF[] buffer = new WSABUF[objects.Length]; + IntPtr[] ptrs = new IntPtr[buffer.Length]; + try + { + for (int i = 0; i < objects.Length; i++) + { + buffer[i].Length = Marshal.SizeOf(typeof(T)); + ptrs[i] = Marshal.AllocHGlobal(buffer[i].Length); + Marshal.StructureToPtr(objects[i], ptrs[i], true); + buffer[i].Buffer = ptrs[i]; + } + ret = SendPackets(connId, buffer, buffer.Length); + } + catch (Exception ex) + { + throw ex; + } + finally + { + for (int i = 0; i < ptrs.Length; i++) + { + if (ptrs[i] != IntPtr.Zero) + { + Marshal.FreeHGlobal(ptrs[i]); + } + } + } + return ret; + } + /// + /// 名称:发送小文件 + /// 描述:向指定连接发送 4096 KB 以下的小文件 + /// + /// + /// 文件路径 + /// 头部附加数据 + /// 尾部附加数据 + /// TRUE.成功,FALSE.失败,可通过 SYSGetLastError() 获取 Windows 错误代码 + public bool SendSmallFile(IntPtr connId, string filePath, ref WSABUF head, ref WSABUF tail) + { + return HPSocketSdk.HP_TcpAgent_SendSmallFile(pAgent, connId, filePath, ref head, ref tail); + } + /// + /// 名称:发送小文件 + /// 描述:向指定连接发送 4096 KB 以下的小文件 + /// + /// + /// 文件路径 + /// 头部附加数据,可以为null + /// 尾部附加数据,可以为null + /// TRUE.成功,FALSE.失败,可通过 SYSGetLastError() 获取 Windows 错误代码 + public bool SendSmallFile(IntPtr connId, string filePath, byte[] head, byte[] tail) + { + IntPtr pHead = IntPtr.Zero; + IntPtr pTail = IntPtr.Zero; + WSABUF wsaHead = new WSABUF() { Length = 0, Buffer = pHead }; + WSABUF wsatail = new WSABUF() { Length = 0, Buffer = pTail }; + if (head != null) + { + wsaHead.Length = head.Length; + wsaHead.Buffer = Marshal.UnsafeAddrOfPinnedArrayElement(head, 0); + } + if (tail != null) + { + wsaHead.Length = tail.Length; + wsaHead.Buffer = Marshal.UnsafeAddrOfPinnedArrayElement(tail, 0); + } + return SendSmallFile(connId, filePath, ref wsaHead, ref wsatail); + } + /// + /// 名称:发送小文件 + /// 描述:向指定连接发送 4096 KB 以下的小文件 + /// + /// + /// 文件路径 + /// 头部附加数据,可以为null + /// 尾部附加数据,可以为null + /// TRUE.成功,FALSE.失败,可通过 SYSGetLastError() 获取 Windows 错误代码 + public bool SendSmallFile(IntPtr connId, string filePath, T1 head, T2 tail) + { + byte[] headBuffer = null; + if (head != null) + { + headBuffer = StructureToByte(head); + } + byte[] tailBuffer = null; + if (tail != null) + { + StructureToByte(head); + } + return SendSmallFile(connId, filePath, headBuffer, tailBuffer); + } + /// + /// 断开某个连接 + /// + /// + /// 强制 + /// + public bool Disconnect(IntPtr connId, bool force = true) + { + return HPSocketSdk.HP_Agent_Disconnect(pAgent, connId, force); + } + /// + /// 断开超过指定时间的连接 + /// + /// 毫秒 + /// 强制 + /// + public bool DisconnectLongConnections(uint period, bool force = true) + { + return HPSocketSdk.HP_Agent_DisconnectLongConnections(pAgent, period, force); + } + /// + /// 断开超过指定时长的静默连接 + /// + /// 毫秒 + /// 强制 + /// + public bool DisconnectSilenceConnections(uint period, bool force = true) + { + return HPSocketSdk.HP_Agent_DisconnectSilenceConnections(pAgent, period, force); + } + /// + /// 设置连接的附加数据 + /// + /// + /// + /// + public bool SetConnectionExtra(IntPtr connId, object obj) + { + IntPtr ptr = IntPtr.Zero; + // 释放附加数据 + if (HPSocketSdk.HP_Agent_GetConnectionExtra(pAgent, connId, ref ptr) && ptr != IntPtr.Zero) + { + Marshal.FreeHGlobal(ptr); + ptr = IntPtr.Zero; + } + if (obj != null) + { + // 设置附加数据 + ptr = Marshal.AllocHGlobal(Marshal.SizeOf(obj)); + Marshal.StructureToPtr(obj, ptr, false); + } + return HPSocketSdk.HP_Agent_SetConnectionExtra(pAgent, connId, ptr); + } + /// + /// 获取附加数据 + /// 如设置的是个结构体/类对象,可以用 Type objA = (Type)Marshal.PtrToStructure(ptr, typeof(Type)) 获取 + /// 其中Type是结构体/类名,ptr是该方法的传出值,在该方法返回为true的时候可用 + /// + /// + /// + /// + public bool GetConnectionExtra(IntPtr connId, ref IntPtr ptr) + { + return HPSocketSdk.HP_Agent_GetConnectionExtra(pAgent, connId, ref ptr) && ptr != IntPtr.Zero; + } + /// + /// 获取错误码 + /// + public SocketError ErrorCode + { + get + { + return HPSocketSdk.HP_Agent_GetLastError(pAgent); + } + } + /// + /// 获取错误信息 + /// + public string ErrorMessage + { + get + { + IntPtr ptr = HPSocketSdk.HP_Agent_GetLastErrorDesc(pAgent); + string desc = Marshal.PtrToStringUni(ptr); + return desc; + } + } + /// + /// 获取连接中未发出数据的长度 + /// + /// + /// + /// + public bool GetPendingDataLength(IntPtr connId, ref int length) + { + return HPSocketSdk.HP_Agent_GetPendingDataLength(pAgent, connId, ref length); + } + // 是否启动 + public bool IsStarted + { + get + { + if (pAgent == IntPtr.Zero) + { + return false; + } + return HPSocketSdk.HP_Agent_HasStarted(pAgent); + } + } + /// + /// 状态 + /// + public ServiceState State + { + get + { + return HPSocketSdk.HP_Agent_GetState(pAgent); + } + } + public uint ConnectionCount + { + get + { + return HPSocketSdk.HP_Agent_GetConnectionCount(pAgent); + } + } + /// + /// 获取所有连接,未获取到连接返回null + /// + /// + public IntPtr[] GetAllConnectionIDs() + { + IntPtr[] arr = null; + do + { + uint count = ConnectionCount; + if (count == 0) + { + break; + } + arr = new IntPtr[count]; + if (HPSocketSdk.HP_Agent_GetAllConnectionIDs(pAgent, arr, ref count)) + { + if (arr.Length > count) + { + IntPtr[] newArr = new IntPtr[count]; + Array.Copy(arr, newArr, count); + arr = newArr; + } + break; + } + } while (true); + return arr; + } + /// + /// 获取监听socket的地址信息 + /// + /// + /// + /// + public bool GetLocalAddress(IntPtr connId, ref string ip, ref ushort port) + { + int ipLength = 40; + StringBuilder sb = new StringBuilder(ipLength); + bool ret = HPSocketSdk.HP_Agent_GetLocalAddress(pAgent, connId, sb, ref ipLength, ref port); + if (ret == true) + { + ip = sb.ToString(); + } + return ret; + } + /// + /// 获取该组件对象的连接Id + /// + /// + public bool GetRemoteAddress(IntPtr connId, ref string ip, ref ushort port) + { + int ipLength = 40; + StringBuilder sb = new StringBuilder(ipLength); + bool ret = HPSocketSdk.HP_Agent_GetRemoteAddress(pAgent, connId, sb, ref ipLength, ref port); + if (ret == true) + { + ip = sb.ToString(); + } + return ret; + } + /// + /// 获取指定连接的连接时长(毫秒) + /// + /// + /// + /// + public bool GetConnectPeriod(IntPtr connId, ref uint period) + { + return HPSocketSdk.HP_Agent_GetConnectPeriod(pAgent, connId, ref period); + } + /// + /// 获取某个连接静默时间(毫秒) + /// + /// + /// + /// + public bool GetSilencePeriod(IntPtr connId, ref uint period) + { + return HPSocketSdk.HP_Agent_GetSilencePeriod(pAgent, connId, ref period); + } + /////////////////////////////////////////////////////////////////////////////////////// + /// + /// 获取或设置是否启用地址重用机制(默认:不启用) + /// + public bool IsReuseAddress + { + get + { + return HPSocketSdk.HP_TcpAgent_IsReuseAddress(pAgent); + } + set + { + HPSocketSdk.HP_TcpAgent_SetReuseAddress(pAgent, value); + } + } + /// + /// 读取或设置工作线程数量(通常设置为 2 * CPU + 2) + /// + public uint WorkerThreadCount + { + get + { + return HPSocketSdk.HP_Agent_GetWorkerThreadCount(pAgent); + } + set + { + HPSocketSdk.HP_Agent_SetWorkerThreadCount(pAgent, value); + } + } + /// + /// 读取或设置通信数据缓冲区大小(根据平均通信数据包大小调整设置,通常设置为 1024 的倍数) + /// + public uint SocketBufferSize + { + get + { + return HPSocketSdk.HP_TcpAgent_GetSocketBufferSize(pAgent); + } + set + { + HPSocketSdk.HP_TcpAgent_SetSocketBufferSize(pAgent, value); + } + } + /// + /// 读取或设置 Socket 缓存对象锁定时间(毫秒,在锁定期间该 Socket 缓存对象不能被获取使用) + /// + public uint FreeSocketObjLockTime + { + get + { + return HPSocketSdk.HP_Agent_GetFreeSocketObjLockTime(pAgent); + } + set + { + HPSocketSdk.HP_Agent_SetFreeSocketObjLockTime(pAgent, value); + } + } + /// + /// 读取或设置 Socket 缓存池大小(通常设置为平均并发连接数量的 1/3 - 1/2) + /// + public uint FreeSocketObjPool + { + get + { + return HPSocketSdk.HP_Agent_GetFreeSocketObjPool(pAgent); + } + set + { + HPSocketSdk.HP_Agent_SetFreeSocketObjPool(pAgent, value); + } + } + /// + /// 读取或设置内存块缓存池大小(通常设置为 Socket 缓存池大小的 2 - 3 倍) + /// + public uint FreeBufferObjPool + { + get + { + return HPSocketSdk.HP_Agent_GetFreeBufferObjPool(pAgent); + } + set + { + HPSocketSdk.HP_Agent_SetFreeBufferObjPool(pAgent, value); + } + } + /// + /// 读取或设置 Socket 缓存池回收阀值(通常设置为 Socket 缓存池大小的 3 倍) + /// + public uint FreeSocketObjHold + { + get + { + return HPSocketSdk.HP_Agent_GetFreeSocketObjHold(pAgent); + } + set + { + HPSocketSdk.HP_Agent_SetFreeSocketObjHold(pAgent, value); + } + } + /// + /// 读取或设置内存块缓存池回收阀值(通常设置为内存块缓存池大小的 3 倍) + /// + public uint FreeBufferObjHold + { + get + { + return HPSocketSdk.HP_Agent_GetFreeBufferObjHold(pAgent); + } + set + { + HPSocketSdk.HP_Agent_SetFreeBufferObjHold(pAgent, value); + } + } + /// + /// 读取或设置心跳包间隔(毫秒,0 则不发送心跳包)) + /// + public uint KeepAliveTime + { + get + { + return HPSocketSdk.HP_TcpAgent_GetKeepAliveTime(pAgent); + } + set + { + HPSocketSdk.HP_TcpAgent_SetKeepAliveTime(pAgent, value); + } + } + /// + /// 读取或设置心跳确认包检测间隔(毫秒,0 不发送心跳包,如果超过若干次 [默认:WinXP 5 次, Win7 10 次] 检测不到心跳确认包则认为已断线) + /// + public uint KeepAliveInterval + { + get + { + return HPSocketSdk.HP_TcpAgent_GetKeepAliveInterval(pAgent); + } + set + { + HPSocketSdk.HP_TcpAgent_SetKeepAliveInterval(pAgent, value); + } + } + /// + /// 读取或设置关闭服务前等待连接关闭的最长时限(毫秒,0 则不等待) + /// + public uint MaxShutdownWaitTime + { + get + { + return HPSocketSdk.HP_Agent_GetMaxShutdownWaitTime(pAgent); + } + set + { + HPSocketSdk.HP_Agent_SetMaxShutdownWaitTime(pAgent, value); + } + } + /// + /// 读取或设置是否标记静默时间(设置为 TRUE 时 DisconnectSilenceConnections() 和 GetSilencePeriod() 才有效,默认:FALSE) + /// + public bool IsMarkSilence + { + get + { + return HPSocketSdk.HP_Agent_IsMarkSilence(pAgent); + } + set + { + HPSocketSdk.HP_Agent_SetMarkSilence(pAgent, value); + } + } + /// + /// 读取或设置数据发送策略 + /// + public SendPolicy SendPolicy + { + get + { + return HPSocketSdk.HP_Agent_GetSendPolicy(pAgent); + } + set + { + HPSocketSdk.HP_Agent_SetSendPolicy(pAgent, value); + } + } + /// + /// 读取或设置数据接收策略 + /// + public RecvPolicy RecvPolicy + { + get + { + return HPSocketSdk.HP_Agent_GetRecvPolicy(pAgent); + } + set + { + HPSocketSdk.HP_Agent_SetRecvPolicy(pAgent, value); + } + } + /// + /// 根据错误码返回错误信息 + /// + /// + /// + public string GetSocketErrorDesc(SocketError code) + { + IntPtr ptr = HPSocketSdk.HP_GetSocketErrorDesc(code); + string desc = Marshal.PtrToStringUni(ptr); + return desc; + } + /////////////////////////////////////////////////////////////////////////////////////// + HPSocketCS.SDK.HPSocketSdk.OnPrepareConnect _OnPrepareConnect = null; + HPSocketCS.SDK.HPSocketSdk.OnConnect _OnConnect = null; + HPSocketCS.SDK.HPSocketSdk.OnReceive _OnReceive = null; + HPSocketCS.SDK.HPSocketSdk.OnSend _OnSend = null; + HPSocketCS.SDK.HPSocketSdk.OnClose _OnClose = null; + HPSocketCS.SDK.HPSocketSdk.OnError _OnError = null; + HPSocketCS.SDK.HPSocketSdk.OnShutdown _OnShutdown = null; + /// + /// 设置回调函数 + /// + protected virtual void SetCallback() + { + _OnPrepareConnect = new HPSocketSdk.OnPrepareConnect(SDK_OnPrepareConnect); + _OnConnect = new HPSocketSdk.OnConnect(SDK_OnConnect); + _OnSend = new HPSocketSdk.OnSend(SDK_OnSend); + _OnReceive = new HPSocketSdk.OnReceive(SDK_OnReceive); + _OnClose = new HPSocketSdk.OnClose(SDK_OnClose); + _OnError = new HPSocketSdk.OnError(SDK_OnError); + _OnShutdown = new HPSocketSdk.OnShutdown(SDK_OnShutdown); + // 设置 Socket 监听器回调函数 + HPSocketSdk.HP_Set_FN_Agent_OnPrepareConnect(pListener, _OnPrepareConnect); + HPSocketSdk.HP_Set_FN_Agent_OnConnect(pListener, _OnConnect); + HPSocketSdk.HP_Set_FN_Server_OnSend(pListener, _OnSend); + HPSocketSdk.HP_Set_FN_Server_OnReceive(pListener, _OnReceive); + HPSocketSdk.HP_Set_FN_Server_OnError(pListener, _OnError); + HPSocketSdk.HP_Set_FN_Server_OnClose(pListener, _OnClose); + HPSocketSdk.HP_Set_FN_Agent_OnShutdown(pListener, _OnShutdown); + } + protected virtual HandleResult SDK_OnPrepareConnect(IntPtr connId, uint socket) + { + if (OnPrepareConnect != null) + { + OnPrepareConnect(connId, socket); + } + return HandleResult.Ignore; + } + protected virtual HandleResult SDK_OnConnect(IntPtr connId) + { + if (OnConnect != null) + { + OnConnect(connId); + } + return HandleResult.Ignore; + } + protected virtual HandleResult SDK_OnSend(IntPtr connId, IntPtr pData, int length) + { + if (OnSend != null) + { + OnSend(connId, pData, length); + } + return HandleResult.Ignore; + } + protected virtual HandleResult SDK_OnReceive(IntPtr connId, IntPtr pData, int length) + { + if (OnReceive != null) + { + OnReceive(connId, pData, length); + } + return HandleResult.Ignore; + } + protected virtual HandleResult SDK_OnClose(IntPtr connId) + { + if (OnClose != null) + { + OnClose(connId); + } + return HandleResult.Ignore; + } + protected virtual HandleResult SDK_OnError(IntPtr connId, SocketOperation enOperation, int errorCode) + { + if (OnError != null) + { + OnError(connId, enOperation, errorCode); + } + return HandleResult.Ignore; + } + protected virtual HandleResult SDK_OnShutdown() + { + if (OnShutdown != null) + { + OnShutdown(); + } + return HandleResult.Ignore; + } + ///////////////////////////////////////////////////////////////////////// + /// + /// 获取系统返回的错误码 + /// + /// + public int SYSGetLastError() + { + return HPSocketSdk.SYS_GetLastError(); + } + /// + /// 调用系统的 ::WSAGetLastError() 方法获取通信错误代码 + /// + /// + public int SYSWSAGetLastError() + { + return HPSocketSdk.SYS_WSAGetLastError(); + } + /// + /// 调用系统的 setsockopt() + /// + /// + /// + /// + /// + /// + /// + /// + public int SYS_SetSocketOption(IntPtr sock, int level, int name, IntPtr val, int len) + { + return HPSocketSdk.SYS_SetSocketOption(sock, level, name, val, len); + } + /// + /// 调用系统的 getsockopt() + /// + /// + /// + /// + /// + /// + /// + /// + public int SYSGetSocketOption(IntPtr sock, int level, int name, IntPtr val, ref int len) + { + return HPSocketSdk.SYS_GetSocketOption(sock, level, name, val, ref len); + } + /// + /// 调用系统的 ioctlsocket() + /// + /// + /// + /// + /// + /// + public int SYSIoctlSocket(IntPtr sock, long cmd, IntPtr arg) + { + return HPSocketSdk.SYS_IoctlSocket(sock, cmd, arg); + } + /// + /// 调用系统的 ::WSAIoctl() + /// + /// + /// + /// + /// + /// + /// + /// + /// + public int SYS_WSAIoctl(IntPtr sock, uint dwIoControlCode, IntPtr lpvInBuffer, uint cbInBuffer, + IntPtr lpvOutBuffer, uint cbOutBuffer, uint lpcbBytesReturned) + { + return HPSocketSdk.SYS_WSAIoctl(sock, dwIoControlCode, lpvInBuffer, cbInBuffer, + lpvOutBuffer, cbOutBuffer, lpcbBytesReturned); + } + /// + /// 由结构体转换为byte数组 + /// + public byte[] StructureToByte(T structure) + { + int size = Marshal.SizeOf(typeof(T)); + byte[] buffer = new byte[size]; + IntPtr bufferIntPtr = Marshal.AllocHGlobal(size); + try + { + Marshal.StructureToPtr(structure, bufferIntPtr, true); + Marshal.Copy(bufferIntPtr, buffer, 0, size); + } + finally + { + Marshal.FreeHGlobal(bufferIntPtr); + } + return buffer; + } + /// + /// 由byte数组转换为结构体 + /// + public T ByteToStructure(byte[] dataBuffer) + { + object structure = null; + int size = Marshal.SizeOf(typeof(T)); + IntPtr allocIntPtr = Marshal.AllocHGlobal(size); + try + { + Marshal.Copy(dataBuffer, 0, allocIntPtr, size); + structure = Marshal.PtrToStructure(allocIntPtr, typeof(T)); + } + finally + { + Marshal.FreeHGlobal(allocIntPtr); + } + return (T)structure; + } + /// + /// 对象序列化成byte[] + /// + /// + /// + public byte[] ObjectToBytes(object obj) + { + using (MemoryStream ms = new MemoryStream()) + { + IFormatter formatter = new BinaryFormatter(); + formatter.Serialize(ms, obj); + return ms.GetBuffer(); + } + } + /// + /// byte[]序列化成对象 + /// + /// + /// + public object BytesToObject(byte[] bytes) + { + using (MemoryStream ms = new MemoryStream(bytes)) + { + IFormatter formatter = new BinaryFormatter(); + return formatter.Deserialize(ms); + } + } + } +} diff --git a/HPSocketCS/TcpClient.cs b/HPSocketCS/TcpClient.cs new file mode 100644 index 0000000..f268df7 --- /dev/null +++ b/HPSocketCS/TcpClient.cs @@ -0,0 +1,759 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Runtime.InteropServices; +using HPSocketCS.SDK; +using System.IO; +using System.Runtime.Serialization; +using System.Runtime.Serialization.Formatters.Binary; +namespace HPSocketCS +{ + public class TcpClientEvent + { + public delegate HandleResult OnPrepareConnectEventHandler(TcpClient sender, uint socket); + public delegate HandleResult OnConnectEventHandler(TcpClient sender); + public delegate HandleResult OnSendEventHandler(TcpClient sender, IntPtr pData, int length); + public delegate HandleResult OnReceiveEventHandler(TcpClient sender, IntPtr pData, int length); + public delegate HandleResult OnCloseEventHandler(TcpClient sender); + public delegate HandleResult OnErrorEventHandler(TcpClient sender, SocketOperation enOperation, int errorCode); + } + public class TcpClient + { + protected IntPtr _pClient = IntPtr.Zero; + protected IntPtr pClient + { + get + { + return _pClient; + } + set + { + _pClient = value; + } + } + protected IntPtr pListener = IntPtr.Zero; + protected bool IsCreate = false; + /****************************************************/ + /// + /// 准备连接了事件 + /// + public event TcpClientEvent.OnPrepareConnectEventHandler OnPrepareConnect; + /// + /// 连接事件 + /// + public event TcpClientEvent.OnConnectEventHandler OnConnect; + /// + /// 数据发送事件 + /// + public event TcpClientEvent.OnSendEventHandler OnSend; + /// + /// 数据到达事件 + /// + public event TcpClientEvent.OnReceiveEventHandler OnReceive; + /// + /// 连接关闭事件 + /// + public event TcpClientEvent.OnCloseEventHandler OnClose; + /// + /// 连接发生错误事件 + /// + public event TcpClientEvent.OnErrorEventHandler OnError; + /// + /// 设置发送策略SendPolicy + /// SP_PACK : 打包策略(默认) + ///尽量把多个发送操作的数据组合在一起发送,增加传输效率 + /// SP_SAFE : 安全策略 + ///尽量把多个发送操作的数据组合在一起发送,并尽量避免缓冲区溢出 + /// SP_DIRECT : 直接策略 + ///对每一个发送操作都直接投递,适用于负载不高但要求实时性较高的场合 + /// + /// + //public void SetSendPolicy(SendPolicy sendPolicy) + //{ + // HPSocketSdk.HP_Server_SetSendPolicy(_pClient, sendPolicy); + //} + public TcpClient() + { + CreateListener(); + } + ~TcpClient() + { + Destroy(); + } + /// + /// 创建socket监听&服务组件 + /// + /// 是否使用tcpserver类默认回调函数 + /// + protected virtual bool CreateListener() + { + if (IsCreate == true || pListener != IntPtr.Zero || pClient != IntPtr.Zero) + { + return false; + } + pListener = HPSocketSdk.Create_HP_TcpClientListener(); + if (pListener == IntPtr.Zero) + { + return false; + } + pClient = HPSocketSdk.Create_HP_TcpClient(pListener); + if (pClient == IntPtr.Zero) + { + return false; + } + IsCreate = true; + return true; + } + /// + /// 释放TcpServer和TcpServerListener + /// + public virtual void Destroy() + { + Stop(); + if (pClient != IntPtr.Zero) + { + HPSocketSdk.Destroy_HP_TcpClient(pClient); + pClient = IntPtr.Zero; + } + if (pListener != IntPtr.Zero) + { + HPSocketSdk.Destroy_HP_TcpClientListener(pListener); + pListener = IntPtr.Zero; + } + IsCreate = false; + } + /// + /// 启动通讯组件并连接到服务器 + /// + /// + /// + /// 是否异步 + /// + public bool Connetion(string address, ushort port, bool async = false) + { + if (string.IsNullOrEmpty(address) == true) + { + throw new Exception("address is null"); + } + else if (port == 0) + { + throw new Exception("port is zero"); + } + if (IsStarted == true) + { + return false; + } + this.SetCallback(); + return HPSocketSdk.HP_Client_Start(pClient, address, port, async); + } + /// + /// 停止通讯组件 + /// + /// + public bool Stop() + { + if (IsStarted == false) + { + return false; + } + return HPSocketSdk.HP_Client_Stop(pClient); + } + /// + /// 发送数据 + /// + /// + /// + /// + /// + public bool Send(byte[] bytes, int size) + { + return HPSocketSdk.HP_Client_Send(pClient, bytes, size); + } + /// + /// 发送数据 + /// + /// + /// + /// + /// + public bool Send(IntPtr bufferPtr, int size) + { + return HPSocketSdk.HP_Client_Send(pClient, bufferPtr, size); + } + /// + /// 发送数据 + /// + /// + /// + /// + /// + public bool Send(T obj) + { + byte[] buffer = StructureToByte(obj); + return Send(buffer, buffer.Length); + } + /// + /// 序列化对象后发送数据,序列化对象所属类必须标记[Serializable] + /// + /// + /// + /// + /// + public bool SendBySerializable(object obj) + { + byte[] buffer = ObjectToBytes(obj); + return Send(buffer, buffer.Length); + } + /// + /// 发送数据 + /// + /// + /// + /// 针对bytes的偏移 + /// 发多大 + /// + public bool Send(byte[] bytes, int offset, int size) + { + return HPSocketSdk.HP_Client_SendPart(pClient, bytes, size, offset); + } + /// + /// 发送数据 + /// + /// + /// + /// 针对bufferPtr的偏移 + /// 发多大 + /// + public bool Send(IntPtr bufferPtr, int offset, int size) + { + return HPSocketSdk.HP_Client_SendPart(pClient, bufferPtr, size, offset); + } + /// + /// 发送多组数据 + /// 向指定连接发送多组数据 + /// TCP - 顺序发送所有数据包 + /// + /// 连接 ID + /// 发送缓冲区数组 + /// 发送缓冲区数目 + /// TRUE.成功,FALSE.失败,可通过 SYSGetLastError() 获取 Windows 错误代码 + public bool SendPackets(WSABUF[] buffers, int count) + { + return HPSocketSdk.HP_Client_SendPackets(pClient, buffers, count); + } + /// + /// 发送多组数据 + /// 向指定连接发送多组数据 + /// TCP - 顺序发送所有数据包 + /// + /// 连接 ID + /// 发送缓冲区数组 + /// 发送缓冲区数目 + /// TRUE.成功,FALSE.失败,可通过 SYSGetLastError() 获取 Windows 错误代码 + public bool SendPackets(T[] objects) + { + bool ret = false; + WSABUF[] buffer = new WSABUF[objects.Length]; + IntPtr[] ptrs = new IntPtr[buffer.Length]; + try + { + for (int i = 0; i < objects.Length; i++) + { + buffer[i].Length = Marshal.SizeOf(typeof(T)); + ptrs[i] = Marshal.AllocHGlobal(buffer[i].Length); + Marshal.StructureToPtr(objects[i], ptrs[i], true); + buffer[i].Buffer = ptrs[i]; + } + ret = SendPackets(buffer, buffer.Length); + } + catch (Exception ex) + { + throw ex; + } + finally + { + for (int i = 0; i < ptrs.Length; i++) + { + if (ptrs[i] != IntPtr.Zero) + { + Marshal.FreeHGlobal(ptrs[i]); + } + } + } + return ret; + } + /// + /// 名称:发送小文件 + /// 描述:向指定连接发送 4096 KB 以下的小文件 + /// + /// 文件路径 + /// 头部附加数据 + /// 尾部附加数据 + /// TRUE.成功,FALSE.失败,可通过 SYSGetLastError() 获取 Windows 错误代码 + public bool SendSmallFile(string filePath, ref WSABUF head, ref WSABUF tail) + { + return HPSocketSdk.HP_TcpClient_SendSmallFile(pClient, filePath, ref head, ref tail); + } + /// + /// 名称:发送小文件 + /// 描述:向指定连接发送 4096 KB 以下的小文件 + /// + /// 文件路径 + /// 头部附加数据,可以为null + /// 尾部附加数据,可以为null + /// TRUE.成功,FALSE.失败,可通过 SYSGetLastError() 获取 Windows 错误代码 + public bool SendSmallFile(string filePath, byte[] head, byte[] tail) + { + IntPtr pHead = IntPtr.Zero; + IntPtr pTail = IntPtr.Zero; + WSABUF wsaHead = new WSABUF() { Length = 0, Buffer = pHead }; + WSABUF wsatail = new WSABUF() { Length = 0, Buffer = pTail }; + if (head != null) + { + wsaHead.Length = head.Length; + wsaHead.Buffer = Marshal.UnsafeAddrOfPinnedArrayElement(head, 0); + } + if (tail != null) + { + wsaHead.Length = tail.Length; + wsaHead.Buffer = Marshal.UnsafeAddrOfPinnedArrayElement(tail, 0); + } + return SendSmallFile(filePath, ref wsaHead, ref wsatail); + } + /// + /// 名称:发送小文件 + /// 描述:向指定连接发送 4096 KB 以下的小文件 + /// + /// 文件路径 + /// 头部附加数据,可以为null + /// 尾部附加数据,可以为null + /// TRUE.成功,FALSE.失败,可通过 SYSGetLastError() 获取 Windows 错误代码 + public bool SendSmallFile(string filePath, T1 head, T2 tail) + { + byte[] headBuffer = null; + if (head != null) + { + headBuffer = StructureToByte(head); + } + byte[] tailBuffer = null; + if (tail != null) + { + StructureToByte(head); + } + return SendSmallFile(filePath, headBuffer, tailBuffer); + } + /// + /// 获取错误码 + /// + public SocketError ErrorCode + { + get + { + return HPSocketSdk.HP_Client_GetLastError(pClient); + } + } + /// + /// 获取错误信息 + /// + public string ErrorMessage + { + get + { + IntPtr ptr = HPSocketSdk.HP_Client_GetLastErrorDesc(pClient); + string desc = Marshal.PtrToStringUni(ptr); + return desc; + } + } + /// + /// + /// + /// + /// + public bool GetPendingDataLength(ref int length) + { + return HPSocketSdk.HP_Client_GetPendingDataLength(pClient, ref length); + } + /// + /// 设置连接的附加数据 + /// + /// + /// 如果为null,则为释放设置的数据 + /// + public void SetExtra(object obj) + { + // 释放附加数据 + IntPtr ptr = GetExtra(); + if (ptr != IntPtr.Zero) + { + Marshal.FreeHGlobal(ptr); + ptr = IntPtr.Zero; + } + if (obj != null) + { + // 设置附加数据 + ptr = Marshal.AllocHGlobal(Marshal.SizeOf(obj)); + Marshal.StructureToPtr(obj, ptr, false); + } + HPSocketSdk.HP_Client_SetExtra(pClient, ptr); + } + /// + /// 获取附加数据 + /// 如设置的是个结构体/类对象,可以用 Type objA = (Type)Marshal.PtrToStructure(ptr, typeof(Type)) 获取 + /// 其中Type是结构体/类名,ptr是该方法的传出值,在该方法返回为true的时候可用 + /// + /// + /// + /// + public IntPtr GetExtra() + { + return HPSocketSdk.HP_Client_GetExtra(pClient); + } + /// + /// 获取监听socket的地址信息 + /// + /// + /// + /// + /// + public bool GetListenAddress(ref string ip, ref ushort port) + { + int ipLength = 40; + StringBuilder sb = new StringBuilder(ipLength); + bool ret = HPSocketSdk.HP_Client_GetLocalAddress(pClient, sb, ref ipLength, ref port); + if (ret == true) + { + ip = sb.ToString(); + } + return ret; + } + /// + /// 是否启动 + /// + public bool IsStarted + { + get + { + if (pClient == IntPtr.Zero) + { + return false; + } + return HPSocketSdk.HP_Client_HasStarted(pClient); + } + } + /// + /// 状态 + /// + public ServiceState State + { + get + { + return HPSocketSdk.HP_Client_GetState(pClient); + } + } + /// + /// 获取该组件对象的连接Id + /// + public IntPtr ConnectionId + { + get + { + return HPSocketSdk.HP_Client_GetConnectionID(pClient); + } + } + /////////////////////////////////////////////////////////////////////////////////////// + /// + /// 读取或设置内存块缓存池大小(通常设置为 -> PUSH 模型:5 - 10;PULL 模型:10 - 20 ) + /// + public uint FreeBufferPoolSize + { + get + { + return HPSocketSdk.HP_Client_GetFreeBufferPoolSize(pClient); + } + set + { + HPSocketSdk.HP_Client_SetFreeBufferPoolSize(pClient, value); + } + } + /// + /// 读取或设置内存块缓存池回收阀值(通常设置为内存块缓存池大小的 3 倍) + /// + public uint FreeBufferPoolHold + { + get + { + return HPSocketSdk.HP_Client_GetFreeBufferPoolHold(pClient); + } + set + { + HPSocketSdk.HP_Client_SetFreeBufferPoolHold(pClient, value); + } + } + /////////////////////////////////////////////////////////////////////////////////////// + /// + /// 读取或设置通信数据缓冲区大小(根据平均通信数据包大小调整设置,通常设置为:(N * 1024) - sizeof(TBufferObj)) + /// + public uint SocketBufferSize + { + get + { + return HPSocketSdk.HP_TcpClient_GetSocketBufferSize(pClient); + } + set + { + HPSocketSdk.HP_TcpClient_SetSocketBufferSize(pClient, value); + } + } + /// + /// 读取或设置心跳包间隔(毫秒,0 则不发送心跳包) + /// + public uint KeepAliveTime + { + get + { + return HPSocketSdk.HP_TcpClient_GetKeepAliveTime(pClient); + } + set + { + HPSocketSdk.HP_TcpClient_SetKeepAliveTime(pClient, value); + } + } + /// + /// 读取或设置心跳确认包检测间隔(毫秒,0 不发送心跳包,如果超过若干次 [默认:WinXP 5 次, Win7 10 次] 检测不到心跳确认包则认为已断线) + /// + public uint KeepAliveInterval + { + get + { + return HPSocketSdk.HP_TcpClient_GetKeepAliveInterval(pClient); + } + set + { + HPSocketSdk.HP_TcpClient_SetKeepAliveInterval(pClient, value); + } + } + /// + /// 根据错误码返回错误信息 + /// + /// + /// + public string GetSocketErrorDesc(SocketError code) + { + IntPtr ptr = HPSocketSdk.HP_GetSocketErrorDesc(code); + string desc = Marshal.PtrToStringUni(ptr); + return desc; + } + /////////////////////////////////////////////////////////////////////////////////////// + HPSocketCS.SDK.HPSocketSdk.OnPrepareConnect _OnPrepareConnect = null; + HPSocketCS.SDK.HPSocketSdk.OnConnect _OnConnect = null; + HPSocketCS.SDK.HPSocketSdk.OnReceive _OnReceive = null; + HPSocketCS.SDK.HPSocketSdk.OnSend _OnSend = null; + HPSocketCS.SDK.HPSocketSdk.OnClose _OnClose = null; + HPSocketCS.SDK.HPSocketSdk.OnError _OnError = null; + /// + /// 设置回调函数 + /// + protected virtual void SetCallback() + { + // 设置 Socket 监听器回调函数 + _OnPrepareConnect = new HPSocketSdk.OnPrepareConnect(SDK_OnPrepareConnect); + _OnConnect = new HPSocketSdk.OnConnect(SDK_OnConnect); + _OnSend = new HPSocketSdk.OnSend(SDK_OnSend); + _OnReceive = new HPSocketSdk.OnReceive(SDK_OnReceive); + _OnClose = new HPSocketSdk.OnClose(SDK_OnClose); + _OnError = new HPSocketSdk.OnError(SDK_OnError); + HPSocketSdk.HP_Set_FN_Client_OnPrepareConnect(pListener, _OnPrepareConnect); + HPSocketSdk.HP_Set_FN_Client_OnConnect(pListener, _OnConnect); + HPSocketSdk.HP_Set_FN_Client_OnSend(pListener, _OnSend); + HPSocketSdk.HP_Set_FN_Client_OnReceive(pListener, _OnReceive); + HPSocketSdk.HP_Set_FN_Client_OnClose(pListener, _OnClose); + HPSocketSdk.HP_Set_FN_Client_OnError(pListener, _OnError); + } + protected HandleResult SDK_OnPrepareConnect(IntPtr pClient, uint socket) + { + if (OnPrepareConnect != null) + { + return OnPrepareConnect(this, socket); + } + return HandleResult.Ignore; + } + protected HandleResult SDK_OnConnect(IntPtr pClient) + { + if (OnConnect != null) + { + return OnConnect(this); + } + return HandleResult.Ignore; + } + protected HandleResult SDK_OnSend(IntPtr pClient, IntPtr pData, int length) + { + if (OnSend != null) + { + return OnSend(this, pData, length); + } + return HandleResult.Ignore; + } + protected HandleResult SDK_OnReceive(IntPtr pClient, IntPtr pData, int length) + { + if (OnReceive != null) + { + return OnReceive(this, pData, length); + } + return HandleResult.Ignore; + } + protected HandleResult SDK_OnClose(IntPtr pClient) + { + if (OnClose != null) + { + return OnClose(this); + } + return HandleResult.Ignore; + } + protected HandleResult SDK_OnError(IntPtr pClient, SocketOperation enOperation, int errorCode) + { + if (OnError != null) + { + return OnError(this, enOperation, errorCode); + } + return HandleResult.Ignore; + } + /////////////////////////////////////////////////////////////////////////// + /// + /// 获取系统返回的错误码 + /// + public int SYSGetLastError() + { + return HPSocketSdk.SYS_GetLastError(); + } + /// + /// 调用系统的 ::WSAGetLastError() 方法获取通信错误代码 + /// + public int SYSWSAGetLastError() + { + return HPSocketSdk.SYS_WSAGetLastError(); + } + /// + /// 调用系统的 setsockopt() + /// + /// + /// + /// + /// + /// + /// + /// + public int SYS_SetSocketOption(IntPtr sock, int level, int name, IntPtr val, int len) + { + return HPSocketSdk.SYS_SetSocketOption(sock, level, name, val, len); + } + /// + /// 调用系统的 getsockopt() + /// + /// + /// + /// + /// + /// + /// + /// + public int SYSGetSocketOption(IntPtr sock, int level, int name, IntPtr val, ref int len) + { + return HPSocketSdk.SYS_GetSocketOption(sock, level, name, val, ref len); + } + /// + /// 调用系统的 ioctlsocket() + /// + /// + /// + /// + /// + /// + public int SYSIoctlSocket(IntPtr sock, long cmd, IntPtr arg) + { + return HPSocketSdk.SYS_IoctlSocket(sock, cmd, arg); + } + /// + /// 调用系统的 ::WSAIoctl() + /// + /// + /// + /// + /// + /// + /// + /// + /// + public int SYS_WSAIoctl(IntPtr sock, uint dwIoControlCode, IntPtr lpvInBuffer, uint cbInBuffer, + IntPtr lpvOutBuffer, uint cbOutBuffer, uint lpcbBytesReturned) + { + return HPSocketSdk.SYS_WSAIoctl(sock, dwIoControlCode, lpvInBuffer, cbInBuffer, + lpvOutBuffer, cbOutBuffer, lpcbBytesReturned); + } + /// + /// 由结构体转换为byte数组 + /// + public byte[] StructureToByte(T structure) + { + int size = Marshal.SizeOf(typeof(T)); + byte[] buffer = new byte[size]; + IntPtr bufferIntPtr = Marshal.AllocHGlobal(size); + try + { + Marshal.StructureToPtr(structure, bufferIntPtr, true); + Marshal.Copy(bufferIntPtr, buffer, 0, size); + } + finally + { + Marshal.FreeHGlobal(bufferIntPtr); + } + return buffer; + } + /// + /// 由byte数组转换为结构体 + /// + public T ByteToStructure(byte[] dataBuffer) + { + object structure = null; + int size = Marshal.SizeOf(typeof(T)); + IntPtr allocIntPtr = Marshal.AllocHGlobal(size); + try + { + Marshal.Copy(dataBuffer, 0, allocIntPtr, size); + structure = Marshal.PtrToStructure(allocIntPtr, typeof(T)); + } + finally + { + Marshal.FreeHGlobal(allocIntPtr); + } + return (T)structure; + } + /// + /// 对象序列化成byte[] + /// + /// + /// + public byte[] ObjectToBytes(object obj) + { + using (MemoryStream ms = new MemoryStream()) + { + IFormatter formatter = new BinaryFormatter(); + formatter.Serialize(ms, obj); + return ms.GetBuffer(); + } + } + /// + /// byte[]序列化成对象 + /// + /// + /// + public object BytesToObject(byte[] bytes) + { + using (MemoryStream ms = new MemoryStream(bytes)) + { + IFormatter formatter = new BinaryFormatter(); + return formatter.Deserialize(ms); + } + } + } +} diff --git a/HPSocketCS/TcpPullAgent.cs b/HPSocketCS/TcpPullAgent.cs new file mode 100644 index 0000000..17f4aba --- /dev/null +++ b/HPSocketCS/TcpPullAgent.cs @@ -0,0 +1,116 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using HPSocketCS.SDK; +namespace HPSocketCS +{ + public class TcpPullAgentEvent + { + public delegate HandleResult OnReceiveEventHandler(IntPtr connId, int length); + } + public class TcpPullAgent : TcpAgent + { + protected new TcpPullAgentEvent.OnReceiveEventHandler OnReceive; + public TcpPullAgent() + { + CreateListener(); + } + ~TcpPullAgent() + { + Destroy(); + } + /// + /// 创建socket监听&服务组件 + /// + /// 是否使用tcppullAgent类默认回调函数 + /// + protected override bool CreateListener() + { + if (IsCreate == true || pListener != IntPtr.Zero || pAgent != IntPtr.Zero) + { + return false; + } + pListener = HPSocketSdk.Create_HP_TcpPullAgentListener(); + if (pListener == IntPtr.Zero) + { + return false; + } + pAgent = HPSocketSdk.Create_HP_TcpPullAgent(pListener); + if (pAgent == IntPtr.Zero) + { + return false; + } + IsCreate = true; + return true; + } + /// + /// 抓取数据 + /// 用户通过该方法从 Socket 组件中抓取数据 + /// + /// + /// + /// + /// + public FetchResult Fetch(IntPtr connId, IntPtr pBuffer, int size) + { + return HPSocketSdk.HP_TcpPullAgent_Fetch(pAgent, connId, pBuffer, size); + } + /// + /// 抓取数据 + /// 用户通过该方法从 Socket 组件中抓取数据 + /// + /// + /// + /// + /// + public FetchResult Peek(IntPtr connId, IntPtr pBuffer, int size) + { + return HPSocketSdk.HP_TcpPullAgent_Peek(pAgent, connId, pBuffer, size); + } + HPSocketCS.SDK.HPSocketSdk.OnPullReceive _OnReceive = null; + /// + /// 设置回调函数 + /// + /// + /// + /// + /// + /// + /// + /// + protected override void SetCallback() + { + _OnReceive = new HPSocketSdk.OnPullReceive(SDK_OnReceive); + // 设置 Socket 监听器回调函数 + HPSocketSdk.HP_Set_FN_Agent_OnPullReceive(pListener, _OnReceive); + base.SetCallback(); + } + protected virtual HandleResult SDK_OnReceive(IntPtr connId, int length) + { + if (OnReceive != null) + { + OnReceive(connId, length); + } + return HandleResult.Ignore; + } + /// + /// 释放TcpPullAgent和TcpPullAgentListener + /// + public override void Destroy() + { + Stop(); + if (pAgent != IntPtr.Zero) + { + HPSocketSdk.Destroy_HP_TcpPullAgent(pAgent); + pAgent = IntPtr.Zero; + } + if (pListener != IntPtr.Zero) + { + HPSocketSdk.Destroy_HP_TcpPullAgentListener(pListener); + pListener = IntPtr.Zero; + } + IsCreate = false; + } + } +} diff --git a/HPSocketCS/TcpPullClient.cs b/HPSocketCS/TcpPullClient.cs new file mode 100644 index 0000000..790ca25 --- /dev/null +++ b/HPSocketCS/TcpPullClient.cs @@ -0,0 +1,111 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using HPSocketCS.SDK; +namespace HPSocketCS +{ + public class TcpPullClientEvent + { + public delegate HandleResult OnReceiveEventHandler(TcpPullClient sender, int length); + } + public class TcpPullClient : TcpClient + { + /// + /// 数据到达事件 + /// + public new event TcpPullClientEvent.OnReceiveEventHandler OnReceive; + public TcpPullClient() + { + CreateListener(); + } + ~TcpPullClient() + { + Destroy(); + } + /// + /// 创建socket监听&服务组件 + /// + /// 是否使用tcppullclient类默认回调函数 + /// + protected override bool CreateListener() + { + if (IsCreate == true || pListener != IntPtr.Zero || pClient != IntPtr.Zero) + { + return false; + } + pListener = HPSocketSdk.Create_HP_TcpPullClientListener(); + if (pListener == IntPtr.Zero) + { + return false; + } + pClient = HPSocketSdk.Create_HP_TcpPullClient(pListener); + if (pClient == IntPtr.Zero) + { + return false; + } + IsCreate = true; + return true; + } + /// + /// 抓取数据 + /// 用户通过该方法从 Socket 组件中抓取数据 + /// + /// + /// + /// + /// + public FetchResult Fetch(IntPtr pBuffer, int size) + { + return HPSocketSdk.HP_TcpPullClient_Fetch(pClient, pBuffer, size); + } + /// + /// 抓取数据 + /// 用户通过该方法从 Socket 组件中抓取数据 + /// + /// + /// + /// + /// + public FetchResult Peek(IntPtr pBuffer, int size) + { + return HPSocketSdk.HP_TcpPullClient_Peek(pClient, pBuffer, size); + } + HPSocketCS.SDK.HPSocketSdk.OnPullReceive _OnReceive = null; + /// + /// 设置回调函数 + /// + protected override void SetCallback() + { + _OnReceive = new HPSocketSdk.OnPullReceive(SDK_OnReceive); + HPSocketSdk.HP_Set_FN_Client_OnPullReceive(pListener, _OnReceive); + base.SetCallback(); + } + protected HandleResult SDK_OnReceive(IntPtr pClient, int length) + { + if (OnReceive != null) + { + return OnReceive(this, length); + } + return HandleResult.Ignore; + } + /// + /// 释放TcpPullClient和TcpPullClientListener + /// + public override void Destroy() + { + Stop(); + if (pClient != IntPtr.Zero) + { + HPSocketSdk.Destroy_HP_TcpPullClient(pClient); + pClient = IntPtr.Zero; + } + if (pListener != IntPtr.Zero) + { + HPSocketSdk.Destroy_HP_TcpPullClientListener(pListener); + pListener = IntPtr.Zero; + } + IsCreate = false; + } + } +} diff --git a/HPSocketCS/TcpPullServer.cs b/HPSocketCS/TcpPullServer.cs new file mode 100644 index 0000000..d3a7d25 --- /dev/null +++ b/HPSocketCS/TcpPullServer.cs @@ -0,0 +1,105 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Runtime.InteropServices; +using HPSocketCS.SDK; +namespace HPSocketCS +{ + public class TcpPullServerEvent + { + public delegate HandleResult OnReceiveEventHandler(IntPtr connId, int length); + } + public class TcpPullServer : TcpServer + { + /// + /// 数据到达事件 + /// + public new event TcpPullServerEvent.OnReceiveEventHandler OnReceive; + public TcpPullServer() + { + CreateListener(); + } + /// + /// 创建socket监听&服务组件 + /// + /// 是否使用tcppullserver类默认回调函数 + /// + protected override bool CreateListener() + { + if (IsCreate == true || pListener != IntPtr.Zero || pServer != IntPtr.Zero) + { + return false; + } + pListener = HPSocketSdk.Create_HP_TcpPullServerListener(); + if (pListener == IntPtr.Zero) + { + return false; + } + pServer = HPSocketSdk.Create_HP_TcpPullServer(pListener); + if (pServer == IntPtr.Zero) + { + return false; + } + IsCreate = true; + return true; + } + HPSocketCS.SDK.HPSocketSdk.OnPullReceive _OnReceive = null; + protected override void SetCallback() + { + _OnReceive = new HPSocketSdk.OnPullReceive(SDK_OnReceive); + HPSocketSdk.HP_Set_FN_Server_OnPullReceive(pListener, _OnReceive); + base.SetCallback(); + } + protected HandleResult SDK_OnReceive(IntPtr connId, int length) + { + if (OnReceive != null) + { + return OnReceive(connId, length); + } + return HandleResult.Ignore; + } + /// + /// 抓取数据 + /// 用户通过该方法从 Socket 组件中抓取数据 + /// + /// + /// + /// + /// + public FetchResult Fetch(IntPtr connId, IntPtr pBuffer, int size) + { + return HPSocketSdk.HP_TcpPullServer_Fetch(pServer, connId, pBuffer, size); + } + /// + /// 抓取数据 + /// 用户通过该方法从 Socket 组件中抓取数据 + /// + /// + /// + /// + /// + public FetchResult Peek(IntPtr connId, IntPtr pBuffer, int size) + { + return HPSocketSdk.HP_TcpPullServer_Peek(pServer, connId, pBuffer, size); + } + /// + /// 释放TcpPullServer和TcpPullServerListener + /// + public override void Destroy() + { + Stop(); + if (pServer != IntPtr.Zero) + { + HPSocketSdk.Destroy_HP_TcpPullServer(pServer); + pServer = IntPtr.Zero; + } + if (pListener != IntPtr.Zero) + { + HPSocketSdk.Destroy_HP_TcpPullServerListener(pListener); + pListener = IntPtr.Zero; + } + IsCreate = false; + } + } +} diff --git a/HPSocketCS/TcpServer.cs b/HPSocketCS/TcpServer.cs new file mode 100644 index 0000000..88715b8 --- /dev/null +++ b/HPSocketCS/TcpServer.cs @@ -0,0 +1,995 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Runtime.InteropServices; +using HPSocketCS.SDK; +using System.IO; +using System.Runtime.Serialization.Formatters.Binary; +using System.Runtime.Serialization; +namespace HPSocketCS +{ + public class TcpServerEvent + { + public delegate HandleResult OnSendEventHandler(IntPtr connId, IntPtr pData, int length); + public delegate HandleResult OnReceiveEventHandler(IntPtr connId, IntPtr pData, int length); + public delegate HandleResult OnCloseEventHandler(IntPtr connId); + public delegate HandleResult OnErrorEventHandler(IntPtr connId, SocketOperation enOperation, int errorCode); + public delegate HandleResult OnShutdownEventHandler(); + public delegate HandleResult OnPrepareListenEventHandler(IntPtr soListen); + public delegate HandleResult OnAcceptEventHandler(IntPtr connId, IntPtr pClient); + } + public class TcpServer + { + protected IntPtr _pServer = IntPtr.Zero; + protected IntPtr pServer + { + get + { + return _pServer; + } + set + { + _pServer = value; + } + } + protected IntPtr pListener = IntPtr.Zero; + /// + /// 服务器ip + /// + public string IpAddress { get; set; } + /// + /// 服务器端口 + /// + public ushort Port { get; set; } + /// + /// 连接到达事件 + /// + public event TcpServerEvent.OnAcceptEventHandler OnAccept; + /// + /// 数据包发送事件 + /// + public event TcpServerEvent.OnSendEventHandler OnSend; + /// + /// 准备监听了事件 + /// + public event TcpServerEvent.OnPrepareListenEventHandler OnPrepareListen; + /// + /// 数据到达事件 + /// + public event TcpServerEvent.OnReceiveEventHandler OnReceive; + /// + /// 连接关闭事件 + /// + public event TcpServerEvent.OnCloseEventHandler OnClose; + /// + /// 连接发生错误事件 + /// + public event TcpServerEvent.OnErrorEventHandler OnError; + /// + /// 服务器关闭事件 + /// + public event TcpServerEvent.OnShutdownEventHandler OnShutdown; + protected bool IsCreate = false; + /// + /// tcpserver构造 + /// + public TcpServer() + { + CreateListener(); + } + ~TcpServer() + { + Destroy(); + } + /// + /// 创建socket监听&服务组件 + /// + /// 是否使用tcpserver类默认回调函数 + /// + protected virtual bool CreateListener() + { + if (IsCreate == true || pListener != IntPtr.Zero || pServer != IntPtr.Zero) + { + return false; + } + pListener = HPSocketSdk.Create_HP_TcpServerListener(); + if (pListener == IntPtr.Zero) + { + return false; + } + pServer = HPSocketSdk.Create_HP_TcpServer(pListener); + if (pServer == IntPtr.Zero) + { + return false; + } + IsCreate = true; + return true; + } + /// + /// 释放TcpServer和TcpServerListener + /// + public virtual void Destroy() + { + Stop(); + if (pServer != IntPtr.Zero) + { + HPSocketSdk.Destroy_HP_TcpServer(pServer); + pServer = IntPtr.Zero; + } + if (pListener != IntPtr.Zero) + { + HPSocketSdk.Destroy_HP_TcpServerListener(pListener); + pListener = IntPtr.Zero; + } + IsCreate = false; + } + /// + /// 启动服务 + /// + /// + /// + /// + public bool Start() + { + if (IsStarted == true) + { + return false; + } + SetCallback(); + return HPSocketSdk.HP_Server_Start(pServer, IpAddress, Port); + } + /// + /// 停止服务 + /// + /// + public bool Stop() + { + if (IsStarted == false) + { + return false; + } + return HPSocketSdk.HP_Server_Stop(pServer); + } + /// + /// 发送数据 + /// + /// + /// + /// + /// + public bool Send(IntPtr connId, byte[] bytes, int size) + { + return HPSocketSdk.HP_Server_Send(pServer, connId, bytes, size); + } + /// + /// 发送数据 + /// + /// + /// + /// + /// + public bool Send(IntPtr connId, IntPtr bufferPtr, int size) + { + return HPSocketSdk.HP_Server_Send(pServer, connId, bufferPtr, size); + } + /// + /// 发送数据 + /// + /// + /// + /// 针对bytes的偏移 + /// 发多大 + /// + public bool Send(IntPtr connId, byte[] bytes, int offset, int size) + { + return HPSocketSdk.HP_Server_SendPart(pServer, connId, bytes, size, offset); + } + /// + /// 发送数据 + /// + /// + /// + /// 针对bufferPtr的偏移 + /// 发多大 + /// + public bool Send(IntPtr connId, IntPtr bufferPtr, int offset, int size) + { + return HPSocketSdk.HP_Server_SendPart(pServer, connId, bufferPtr, size, offset); + } + /// + /// 发送数据 + /// + /// + /// + /// + /// + public bool Send(IntPtr connId, T obj) + { + byte[] buffer = StructureToByte(obj); + return Send(connId, buffer, buffer.Length); + } + /// + /// 序列化对象后发送数据,序列化对象所属类必须标记[Serializable] + /// + /// + /// + /// + /// + public bool SendBySerializable(IntPtr connId, object obj) + { + byte[] buffer = ObjectToBytes(obj); + return Send(connId, buffer, buffer.Length); + } + /// + /// 发送多组数据 + /// 向指定连接发送多组数据 + /// TCP - 顺序发送所有数据包 + /// + /// 连接 ID + /// 发送缓冲区数组 + /// 发送缓冲区数目 + /// TRUE.成功,FALSE.失败,可通过 SYSGetLastError() 获取 Windows 错误代码 + public bool SendPackets(IntPtr connId, WSABUF[] pBuffers, int count) + { + return HPSocketSdk.HP_Server_SendPackets(pServer, connId, pBuffers, count); + } + /// + /// 发送多组数据 + /// 向指定连接发送多组数据 + /// TCP - 顺序发送所有数据包 + /// + /// 连接 ID + /// 发送缓冲区数组 + /// 发送缓冲区数目 + /// TRUE.成功,FALSE.失败,可通过 SYSGetLastError() 获取 Windows 错误代码 + public bool SendPackets(IntPtr connId, T[] objects) + { + bool ret = false; + WSABUF[] buffer = new WSABUF[objects.Length]; + IntPtr[] ptrs = new IntPtr[buffer.Length]; + try + { + for (int i = 0; i < objects.Length; i++) + { + buffer[i].Length = Marshal.SizeOf(typeof(T)); + ptrs[i] = Marshal.AllocHGlobal(buffer[i].Length); + Marshal.StructureToPtr(objects[i], ptrs[i], true); + buffer[i].Buffer = ptrs[i]; + } + ret = SendPackets(connId, buffer, buffer.Length); + } + catch (Exception ex) + { + throw ex; + } + finally + { + for (int i = 0; i < ptrs.Length; i++) + { + if (ptrs[i] != IntPtr.Zero) + { + Marshal.FreeHGlobal(ptrs[i]); + } + } + } + return ret; + } + /// + /// 名称:发送小文件 + /// 描述:向指定连接发送 4096 KB 以下的小文件 + /// + /// + /// 文件路径 + /// 头部附加数据 + /// 尾部附加数据 + /// TRUE.成功,FALSE.失败,可通过 SYSGetLastError() 获取 Windows 错误代码 + public bool SendSmallFile(IntPtr connId, string filePath, ref WSABUF head, ref WSABUF tail) + { + return HPSocketSdk.HP_TcpServer_SendSmallFile(pServer, connId, filePath, ref head, ref tail); + } + /// + /// 名称:发送小文件 + /// 描述:向指定连接发送 4096 KB 以下的小文件 + /// + /// + /// 文件路径 + /// 头部附加数据,可以为null + /// 尾部附加数据,可以为null + /// TRUE.成功,FALSE.失败,可通过 SYSGetLastError() 获取 Windows 错误代码 + public bool SendSmallFile(IntPtr connId, string filePath, byte[] head, byte[] tail) + { + IntPtr pHead = IntPtr.Zero; + IntPtr pTail = IntPtr.Zero; + WSABUF wsaHead = new WSABUF() { Length = 0, Buffer = pHead }; + WSABUF wsatail = new WSABUF() { Length = 0, Buffer = pTail }; + if (head != null) + { + wsaHead.Length = head.Length; + wsaHead.Buffer = Marshal.UnsafeAddrOfPinnedArrayElement(head, 0); + } + if (tail != null) + { + wsaHead.Length = tail.Length; + wsaHead.Buffer = Marshal.UnsafeAddrOfPinnedArrayElement(tail, 0); + } + return SendSmallFile(connId, filePath, ref wsaHead, ref wsatail); + } + /// + /// 名称:发送小文件 + /// 描述:向指定连接发送 4096 KB 以下的小文件 + /// + /// + /// 文件路径 + /// 头部附加数据,可以为null + /// 尾部附加数据,可以为null + /// TRUE.成功,FALSE.失败,可通过 SYSGetLastError() 获取 Windows 错误代码 + public bool SendSmallFile(IntPtr connId, string filePath, T1 head, T2 tail) + { + byte[] headBuffer = null; + if (head != null) + { + headBuffer = StructureToByte(head); + } + byte[] tailBuffer = null; + if (tail != null) + { + StructureToByte(head); + } + return SendSmallFile(connId, filePath, headBuffer, tailBuffer); + } + /// + /// 断开与某个客户的连接 + /// + /// + /// 是否强制断开 + /// + public bool Disconnect(IntPtr connId, bool force = true) + { + return HPSocketSdk.HP_Server_Disconnect(pServer, connId, force); + } + /// + /// 断开超过指定时间的连接 + /// + /// 毫秒 + /// 强制 + /// + public bool DisconnectLongConnections(uint period, bool force = true) + { + return HPSocketSdk.HP_Server_DisconnectLongConnections(pServer, period, force); + } + /// + /// 断开超过指定时长的静默连接 + /// + /// 毫秒 + /// 强制 + /// + public bool DisconnectSilenceConnections(uint period, bool force = true) + { + return HPSocketSdk.HP_Server_DisconnectSilenceConnections(pServer, period, force); + } + /// + /// 获取某个连接的远程ip和端口 + /// + /// + /// + /// + /// + public bool GetRemoteAddress(IntPtr connId, ref string ip, ref ushort port) + { + int ipLength = 40; + StringBuilder sb = new StringBuilder(ipLength); + bool ret = HPSocketSdk.HP_Server_GetRemoteAddress(pServer, connId, sb, ref ipLength, ref port) && ipLength > 0; + if (ret == true) + { + ip = sb.ToString(); + } + return ret; + } + /// + /// 获取连接中未发出数据的长度 + /// + /// + /// + /// + public bool GetPendingDataLength(IntPtr connId, ref int length) + { + return HPSocketSdk.HP_Server_GetPendingDataLength(pServer, connId, ref length); + } + /// + /// 设置连接的附加数据 + /// + /// + /// 如果为null,则为释放设置的数据 + /// + public bool SetConnectionExtra(IntPtr connId, object obj) + { + IntPtr ptr = IntPtr.Zero; + // 释放附加数据 + if (HPSocketSdk.HP_Server_GetConnectionExtra(pServer, connId, ref ptr) && ptr != IntPtr.Zero) + { + Marshal.FreeHGlobal(ptr); + ptr = IntPtr.Zero; + } + if (obj != null) + { + // 设置附加数据 + ptr = Marshal.AllocHGlobal(Marshal.SizeOf(obj)); + Marshal.StructureToPtr(obj, ptr, false); + } + return HPSocketSdk.HP_Server_SetConnectionExtra(pServer, connId, ptr); + } + /// + /// 获取附加数据 + /// 如设置的是个结构体/类对象,可以用 Type objA = (Type)Marshal.PtrToStructure(ptr, typeof(Type)) 获取 + /// 其中Type是结构体/类名,ptr是该方法的传出值,在该方法返回为true的时候可用 + /// + /// + /// + /// + public bool GetConnectionExtra(IntPtr connId, ref IntPtr ptr) + { + return HPSocketSdk.HP_Server_GetConnectionExtra(pServer, connId, ref ptr) && ptr != IntPtr.Zero; + } + // 是否启动 + public bool IsStarted + { + get + { + if (pServer == IntPtr.Zero) + { + return false; + } + return HPSocketSdk.HP_Server_HasStarted(pServer); + } + } + /// + /// 状态 + /// + public ServiceState State + { + get + { + return HPSocketSdk.HP_Server_GetState(pServer); + } + } + /// + /// 连接数 + /// + public uint ConnectionCount + { + get + { + return HPSocketSdk.HP_Server_GetConnectionCount(pServer); + } + } + /// + /// 获取所有连接,未获取到连接返回null + /// + /// + public IntPtr[] GetAllConnectionIDs() + { + IntPtr[] arr = null; + do + { + uint count = ConnectionCount; + if (count == 0) + { + break; + } + arr = new IntPtr[count]; + if (HPSocketSdk.HP_Server_GetAllConnectionIDs(pServer, arr, ref count)) + { + if (arr.Length > count) + { + IntPtr[] newArr = new IntPtr[count]; + Array.Copy(arr, newArr, count); + arr = newArr; + } + break; + } + } while (true); + return arr; + } + /// + /// 获取监听socket的地址信息 + /// + /// + /// + /// + public bool GetListenAddress(ref string ip, ref ushort port) + { + int ipLength = 40; + StringBuilder sb = new StringBuilder(ipLength); + bool ret = HPSocketSdk.HP_Server_GetListenAddress(pServer, sb, ref ipLength, ref port); + if (ret == true) + { + ip = sb.ToString(); + } + return ret; + } + /// + /// 获取指定连接的连接时长(毫秒) + /// + /// + /// + /// + public bool GetConnectPeriod(IntPtr connId, ref uint period) + { + return HPSocketSdk.HP_Server_GetConnectPeriod(pServer, connId, ref period); + } + /// + /// 获取某个连接静默时间(毫秒) + /// + /// + /// + /// + public bool GetSilencePeriod(IntPtr connId, ref uint period) + { + return HPSocketSdk.HP_Server_GetSilencePeriod(pServer, connId, ref period); + } + /////////////////////////////////////////////////////////////////////////////////////// + /// + /// 读取或设置工作线程数量(通常设置为 2 * CPU + 2) + /// + public uint WorkerThreadCount + { + get + { + return HPSocketSdk.HP_Server_GetWorkerThreadCount(pServer); + } + set + { + HPSocketSdk.HP_Server_SetWorkerThreadCount(pServer, value); + } + } + /// + /// 读取或设置 Accept 预投递数量(根据负载调整设置,Accept 预投递数量越大则支持的并发连接请求越多) + /// + public uint AcceptSocketCount + { + get + { + return HPSocketSdk.HP_TcpServer_GetAcceptSocketCount(pServer); + } + set + { + HPSocketSdk.HP_TcpServer_SetAcceptSocketCount(pServer, value); + } + } + /// + /// 读取或设置通信数据缓冲区大小(根据平均通信数据包大小调整设置,通常设置为 1024 的倍数) + /// + public uint SocketBufferSize + { + get + { + return HPSocketSdk.HP_TcpServer_GetSocketBufferSize(pServer); + } + set + { + HPSocketSdk.HP_TcpServer_SetSocketBufferSize(pServer, value); + } + } + /// + /// 读取或设置监听 Socket 的等候队列大小(根据并发连接数量调整设置) + /// + public uint SocketListenQueue + { + get + { + return HPSocketSdk.HP_TcpServer_GetSocketListenQueue(pServer); + } + set + { + HPSocketSdk.HP_TcpServer_SetSocketListenQueue(pServer, value); + } + } + /// + /// 读取或设置 Socket 缓存对象锁定时间(毫秒,在锁定期间该 Socket 缓存对象不能被获取使用) + /// + public uint FreeSocketObjLockTime + { + get + { + return HPSocketSdk.HP_Server_GetFreeSocketObjLockTime(pServer); + } + set + { + HPSocketSdk.HP_Server_SetFreeSocketObjLockTime(pServer, value); + } + } + /// + /// 读取或设置 Socket 缓存池大小(通常设置为平均并发连接数量的 1/3 - 1/2) + /// + public uint FreeSocketObjPool + { + get + { + return HPSocketSdk.HP_Server_GetFreeSocketObjPool(pServer); + } + set + { + HPSocketSdk.HP_Server_SetFreeSocketObjPool(pServer, value); + } + } + /// + /// 读取或设置内存块缓存池大小(通常设置为 Socket 缓存池大小的 2 - 3 倍) + /// + public uint FreeBufferObjPool + { + get + { + return HPSocketSdk.HP_Server_GetFreeBufferObjPool(pServer); + } + set + { + HPSocketSdk.HP_Server_SetFreeBufferObjPool(pServer, value); + } + } + /// + /// 读取或设置内存块缓存池大小(通常设置为 Socket 缓存池大小的 2 - 3 倍) + /// + public uint FreeSocketObjHold + { + get + { + return HPSocketSdk.HP_Server_GetFreeSocketObjHold(pServer); + } + set + { + HPSocketSdk.HP_Server_SetFreeSocketObjHold(pServer, value); + } + } + /// + /// 读取或设置内存块缓存池回收阀值(通常设置为内存块缓存池大小的 3 倍) + /// + public uint FreeBufferObjHold + { + get + { + return HPSocketSdk.HP_Server_GetFreeBufferObjHold(pServer); + } + set + { + HPSocketSdk.HP_Server_SetFreeBufferObjHold(pServer, value); + } + } + /// + /// 读取或设置心跳包间隔(毫秒,0 则不发送心跳包) + /// + public uint KeepAliveTime + { + get + { + return HPSocketSdk.HP_TcpServer_GetKeepAliveTime(pServer); + } + set + { + HPSocketSdk.HP_TcpServer_SetKeepAliveTime(pServer, value); + } + } + /// + /// 读取或设置心跳确认包检测间隔(毫秒,0 不发送心跳包,如果超过若干次 [默认:WinXP 5 次, Win7 10 次] 检测不到心跳确认包则认为已断线) + /// + public uint KeepAliveInterval + { + get + { + return HPSocketSdk.HP_TcpServer_GetKeepAliveInterval(pServer); + } + set + { + HPSocketSdk.HP_TcpServer_SetKeepAliveInterval(pServer, value); + } + } + /// + /// 读取或设置关闭服务前等待连接关闭的最长时限(毫秒,0 则不等待) + /// + public uint MaxShutdownWaitTime + { + get + { + return HPSocketSdk.HP_Server_GetMaxShutdownWaitTime(pServer); + } + set + { + HPSocketSdk.HP_Server_SetMaxShutdownWaitTime(pServer, value); + } + } + /// + /// 读取或设置是否标记静默时间(设置为 TRUE 时 DisconnectSilenceConnections() 和 GetSilencePeriod() 才有效,默认:FALSE) + /// + public bool MarkSilence + { + get + { + return HPSocketSdk.HP_Server_IsMarkSilence(pServer); + } + set + { + HPSocketSdk.HP_Server_SetMarkSilence(pServer, value); + } + } + /// + /// 获取或设置数据发送策略 + /// + public SendPolicy SendPolicy + { + get + { + return HPSocketSdk.HP_Server_GetSendPolicy(pServer); + } + set + { + HPSocketSdk.HP_Server_SetSendPolicy(pServer, value); + } + } + /// + /// 获取或设置数据接收策略 + /// + public RecvPolicy RecvPolicy + { + get + { + return HPSocketSdk.HP_Server_GetRecvPolicy(pServer); + } + set + { + HPSocketSdk.HP_Server_SetRecvPolicy(pServer, value); + } + } + /////////////////////////////////////////////////////////////////////////////////////// + /// + /// 获取系统返回的错误码 + /// + public int SYSGetLastError() + { + return HPSocketSdk.SYS_GetLastError(); + } + /// + /// 调用系统的 ::WSAGetLastError() 方法获取通信错误代码 + /// + public int SYSWSAGetLastError() + { + return HPSocketSdk.SYS_WSAGetLastError(); + } + /// + /// 获取错误码 + /// + public SocketError ErrorCode + { + get + { + return HPSocketSdk.HP_Server_GetLastError(pServer); + } + } + /// + /// 获取错误信息 + /// + public string ErrorMessage + { + get + { + IntPtr ptr = HPSocketSdk.HP_Server_GetLastErrorDesc(pServer); + string desc = Marshal.PtrToStringUni(ptr); + return desc; + } + } + /////////////////////////////////////////////////////////////////////////////////////// + HPSocketCS.SDK.HPSocketSdk.OnPrepareListen _OnPrepareListen = null; + HPSocketCS.SDK.HPSocketSdk.OnAccept _OnAccept = null; + HPSocketCS.SDK.HPSocketSdk.OnReceive _OnReceive = null; + HPSocketCS.SDK.HPSocketSdk.OnSend _OnSend = null; + HPSocketCS.SDK.HPSocketSdk.OnClose _OnClose = null; + HPSocketCS.SDK.HPSocketSdk.OnError _OnError = null; + HPSocketCS.SDK.HPSocketSdk.OnShutdown _OnShutdown = null; + protected virtual void SetCallback() + { + _OnPrepareListen = new HPSocketSdk.OnPrepareListen(SDK_OnPrepareListen); + _OnAccept = new HPSocketSdk.OnAccept(SDK_OnAccept); + _OnSend = new HPSocketSdk.OnSend(SDK_OnSend); + _OnReceive = new HPSocketSdk.OnReceive(SDK_OnReceive); + _OnClose = new HPSocketSdk.OnClose(SDK_OnClose); + _OnError = new HPSocketSdk.OnError(SDK_OnError); + _OnShutdown = new HPSocketSdk.OnShutdown(SDK_OnShutdown); + HPSocketSdk.HP_Set_FN_Server_OnPrepareListen(pListener, _OnPrepareListen); + HPSocketSdk.HP_Set_FN_Server_OnAccept(pListener, _OnAccept); + HPSocketSdk.HP_Set_FN_Server_OnSend(pListener, _OnSend); + HPSocketSdk.HP_Set_FN_Server_OnReceive(pListener, _OnReceive); + HPSocketSdk.HP_Set_FN_Server_OnClose(pListener, _OnClose); + HPSocketSdk.HP_Set_FN_Server_OnError(pListener, _OnError); + HPSocketSdk.HP_Set_FN_Server_OnShutdown(pListener, _OnShutdown); + } + protected HandleResult SDK_OnPrepareListen(IntPtr soListen) + { + if (OnPrepareListen != null) + { + OnPrepareListen(soListen); + } + return HandleResult.Ignore; + } + protected HandleResult SDK_OnAccept(IntPtr connId, IntPtr pClient) + { + if (OnAccept != null) + { + OnAccept(connId, pClient); + } + return HandleResult.Ignore; + } + protected HandleResult SDK_OnSend(IntPtr connId, IntPtr pData, int length) + { + if (OnSend != null) + { + OnSend(connId, pData, length); + } + return HandleResult.Ignore; + } + protected HandleResult SDK_OnReceive(IntPtr connId, IntPtr pData, int length) + { + if (OnReceive != null) + { + OnReceive(connId, pData, length); + } + return HandleResult.Ignore; + } + protected HandleResult SDK_OnClose(IntPtr connId) + { + if (OnClose != null) + { + OnClose(connId); + } + return HandleResult.Ignore; + } + protected HandleResult SDK_OnError(IntPtr connId, SocketOperation enOperation, int errorCode) + { + if (OnError != null) + { + OnError(connId, enOperation, errorCode); + } + return HandleResult.Ignore; + } + protected HandleResult SDK_OnShutdown() + { + if (OnShutdown != null) + { + OnShutdown(); + } + return HandleResult.Ignore; + } + ///////////////////////////////////////////////////////////////////////// + /// + /// 根据错误码返回错误信息 + /// + /// + /// + public string GetSocketErrorDesc(SocketError code) + { + IntPtr ptr = HPSocketSdk.HP_GetSocketErrorDesc(code); + string desc = Marshal.PtrToStringUni(ptr); + return desc; + } + /// + /// 调用系统的 setsockopt() + /// + /// + /// + /// + /// + /// + /// + /// + public int SYS_SetSocketOption(IntPtr sock, int level, int name, IntPtr val, int len) + { + return HPSocketSdk.SYS_SetSocketOption(sock, level, name, val, len); + } + /// + /// 调用系统的 getsockopt() + /// + /// + /// + /// + /// + /// + /// + /// + public int SYSGetSocketOption(IntPtr sock, int level, int name, IntPtr val, ref int len) + { + return HPSocketSdk.SYS_GetSocketOption(sock, level, name, val, ref len); + } + /// + /// 调用系统的 ioctlsocket() + /// + /// + /// + /// + /// + /// + public int SYSIoctlSocket(IntPtr sock, long cmd, IntPtr arg) + { + return HPSocketSdk.SYS_IoctlSocket(sock, cmd, arg); + } + /// + /// 调用系统的 ::WSAIoctl() + /// + /// + /// + /// + /// + /// + /// + /// + /// + public int SYS_WSAIoctl(IntPtr sock, uint dwIoControlCode, IntPtr lpvInBuffer, uint cbInBuffer, + IntPtr lpvOutBuffer, uint cbOutBuffer, uint lpcbBytesReturned) + { + return HPSocketSdk.SYS_WSAIoctl(sock, dwIoControlCode, lpvInBuffer, cbInBuffer, + lpvOutBuffer, cbOutBuffer, lpcbBytesReturned); + } + /// + /// 由结构体转换为byte数组 + /// + public byte[] StructureToByte(T structure) + { + int size = Marshal.SizeOf(typeof(T)); + byte[] buffer = new byte[size]; + IntPtr bufferIntPtr = Marshal.AllocHGlobal(size); + try + { + Marshal.StructureToPtr(structure, bufferIntPtr, true); + Marshal.Copy(bufferIntPtr, buffer, 0, size); + } + finally + { + Marshal.FreeHGlobal(bufferIntPtr); + } + return buffer; + } + /// + /// 由byte数组转换为结构体 + /// + public T ByteToStructure(byte[] dataBuffer) + { + object structure = null; + int size = Marshal.SizeOf(typeof(T)); + IntPtr allocIntPtr = Marshal.AllocHGlobal(size); + try + { + Marshal.Copy(dataBuffer, 0, allocIntPtr, size); + structure = Marshal.PtrToStructure(allocIntPtr, typeof(T)); + } + finally + { + Marshal.FreeHGlobal(allocIntPtr); + } + return (T)structure; + } + /// + /// 对象序列化成byte[] + /// + /// + /// + public byte[] ObjectToBytes(object obj) + { + using (MemoryStream ms = new MemoryStream()) + { + IFormatter formatter = new BinaryFormatter(); + formatter.Serialize(ms, obj); + return ms.GetBuffer(); + } + } + /// + /// byte[]序列化成对象 + /// + /// + /// + public object BytesToObject(byte[] bytes) + { + using (MemoryStream ms = new MemoryStream(bytes)) + { + IFormatter formatter = new BinaryFormatter(); + return formatter.Deserialize(ms); + } + } + } +} diff --git a/README.en.md b/README.en.md new file mode 100644 index 0000000..059609d --- /dev/null +++ b/README.en.md @@ -0,0 +1,36 @@ +# PGGpsServer + +#### Description +GPS服务 + +#### Software Architecture +Software architecture description + +#### Installation + +1. xxxx +2. xxxx +3. xxxx + +#### Instructions + +1. xxxx +2. xxxx +3. xxxx + +#### Contribution + +1. Fork the repository +2. Create Feat_xxx branch +3. Commit your code +4. Create Pull Request + + +#### Gitee Feature + +1. You can use Readme\_XXX.md to support different languages, such as Readme\_en.md, Readme\_zh.md +2. Gitee blog [blog.gitee.com](https://blog.gitee.com) +3. Explore open source project [https://gitee.com/explore](https://gitee.com/explore) +4. The most valuable open source project [GVP](https://gitee.com/gvp) +5. The manual of Gitee [https://gitee.com/help](https://gitee.com/help) +6. The most popular members [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) diff --git a/README.md b/README.md new file mode 100644 index 0000000..704e7f9 --- /dev/null +++ b/README.md @@ -0,0 +1,37 @@ +# PGGpsServer + +#### 介绍 +GPS服务 + +#### 软件架构 +软件架构说明 + + +#### 安装教程 + +1. xxxx +2. xxxx +3. xxxx + +#### 使用说明 + +1. xxxx +2. xxxx +3. xxxx + +#### 参与贡献 + +1. Fork 本仓库 +2. 新建 Feat_xxx 分支 +3. 提交代码 +4. 新建 Pull Request + + +#### 码云特技 + +1. 使用 Readme\_XXX.md 来支持不同的语言,例如 Readme\_en.md, Readme\_zh.md +2. 码云官方博客 [blog.gitee.com](https://blog.gitee.com) +3. 你可以 [https://gitee.com/explore](https://gitee.com/explore) 这个地址来了解码云上的优秀开源项目 +4. [GVP](https://gitee.com/gvp) 全称是码云最有价值开源项目,是码云综合评定出的优秀开源项目 +5. 码云官方提供的使用手册 [https://gitee.com/help](https://gitee.com/help) +6. 码云封面人物是一档用来展示码云会员风采的栏目 [https://gitee.com/gitee-stars/](https://gitee.com/gitee-stars/) diff --git a/TextServer/App.config b/TextServer/App.config new file mode 100644 index 0000000..8e15646 --- /dev/null +++ b/TextServer/App.config @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/TextServer/Form1.Designer.cs b/TextServer/Form1.Designer.cs new file mode 100644 index 0000000..c3e2431 --- /dev/null +++ b/TextServer/Form1.Designer.cs @@ -0,0 +1,142 @@ +namespace TextServer +{ + partial class Form1 + { + /// + /// 必需的设计器变量。 + /// + private System.ComponentModel.IContainer components = null; + + /// + /// 清理所有正在使用的资源。 + /// + /// 如果应释放托管资源,为 true;否则为 false。 + protected override void Dispose(bool disposing) + { + if (disposing && (components != null)) + { + components.Dispose(); + } + base.Dispose(disposing); + } + + #region Windows 窗体设计器生成的代码 + + /// + /// 设计器支持所需的方法 - 不要 + /// 使用代码编辑器修改此方法的内容。 + /// + private void InitializeComponent() + { + this.btnCon = new System.Windows.Forms.Button(); + this.txtContent = new System.Windows.Forms.TextBox(); + this.btnSend = new System.Windows.Forms.Button(); + this.txtIp = new System.Windows.Forms.TextBox(); + this.txtPort = new System.Windows.Forms.TextBox(); + this.label1 = new System.Windows.Forms.Label(); + this.label2 = new System.Windows.Forms.Label(); + this.lbMsg = new System.Windows.Forms.Label(); + this.SuspendLayout(); + // + // btnCon + // + this.btnCon.Location = new System.Drawing.Point(947, 65); + this.btnCon.Name = "btnCon"; + this.btnCon.Size = new System.Drawing.Size(75, 23); + this.btnCon.TabIndex = 0; + this.btnCon.Text = "连接"; + this.btnCon.UseVisualStyleBackColor = true; + this.btnCon.Click += new System.EventHandler(this.btnCon_Click); + // + // txtContent + // + this.txtContent.Location = new System.Drawing.Point(12, 131); + this.txtContent.Multiline = true; + this.txtContent.Name = "txtContent"; + this.txtContent.Size = new System.Drawing.Size(1030, 335); + this.txtContent.TabIndex = 1; + // + // btnSend + // + this.btnSend.Location = new System.Drawing.Point(947, 494); + this.btnSend.Name = "btnSend"; + this.btnSend.Size = new System.Drawing.Size(75, 23); + this.btnSend.TabIndex = 2; + this.btnSend.Text = "发送"; + this.btnSend.UseVisualStyleBackColor = true; + this.btnSend.Click += new System.EventHandler(this.btnSend_Click); + // + // txtIp + // + this.txtIp.Location = new System.Drawing.Point(72, 63); + this.txtIp.Name = "txtIp"; + this.txtIp.Size = new System.Drawing.Size(447, 25); + this.txtIp.TabIndex = 3; + // + // txtPort + // + this.txtPort.Location = new System.Drawing.Point(707, 63); + this.txtPort.Name = "txtPort"; + this.txtPort.Size = new System.Drawing.Size(152, 25); + this.txtPort.TabIndex = 4; + // + // label1 + // + this.label1.AutoSize = true; + this.label1.Location = new System.Drawing.Point(24, 69); + this.label1.Name = "label1"; + this.label1.Size = new System.Drawing.Size(31, 15); + this.label1.TabIndex = 5; + this.label1.Text = "IP:"; + // + // label2 + // + this.label2.AutoSize = true; + this.label2.Location = new System.Drawing.Point(646, 69); + this.label2.Name = "label2"; + this.label2.Size = new System.Drawing.Size(47, 15); + this.label2.TabIndex = 6; + this.label2.Text = "PORT:"; + // + // lbMsg + // + this.lbMsg.AutoSize = true; + this.lbMsg.Location = new System.Drawing.Point(24, 498); + this.lbMsg.Name = "lbMsg"; + this.lbMsg.Size = new System.Drawing.Size(0, 15); + this.lbMsg.TabIndex = 7; + // + // Form1 + // + this.AutoScaleDimensions = new System.Drawing.SizeF(8F, 15F); + this.AutoScaleMode = System.Windows.Forms.AutoScaleMode.Font; + this.ClientSize = new System.Drawing.Size(1054, 541); + this.Controls.Add(this.lbMsg); + this.Controls.Add(this.label2); + this.Controls.Add(this.label1); + this.Controls.Add(this.txtPort); + this.Controls.Add(this.txtIp); + this.Controls.Add(this.btnSend); + this.Controls.Add(this.txtContent); + this.Controls.Add(this.btnCon); + this.Name = "Form1"; + this.Text = "测试程序"; + this.Load += new System.EventHandler(this.Form1_Load); + this.ResumeLayout(false); + this.PerformLayout(); + + } + + #endregion + + private System.Windows.Forms.Button btnCon; + private System.Windows.Forms.TextBox txtContent; + private System.Windows.Forms.Button btnSend; + private System.Windows.Forms.TextBox txtIp; + private System.Windows.Forms.TextBox txtPort; + private System.Windows.Forms.Label label1; + private System.Windows.Forms.Label label2; + private System.Windows.Forms.Label lbMsg; + } +} + diff --git a/TextServer/Form1.cs b/TextServer/Form1.cs new file mode 100644 index 0000000..398c344 --- /dev/null +++ b/TextServer/Form1.cs @@ -0,0 +1,53 @@ +using GPSBusiness.Helper; +using HPSocketCS; +using System; +using System.Collections.Generic; +using System.ComponentModel; +using System.Data; +using System.Drawing; +using System.Linq; +using System.Text; +using System.Threading.Tasks; +using System.Windows.Forms; + +namespace TextServer +{ + public partial class Form1 : Form + { + private readonly TcpClient _gpsClient = new TcpClient(); + public static bool isConnetion=false; + public Form1() + { + InitializeComponent(); + } + private void Form1_Load(object sender, EventArgs e) + { + + } + + private void btnCon_Click(object sender, EventArgs e) + { + string ip=this.txtIp.Text; + ushort port=Convert.ToUInt16(this.txtPort.Text); + if( _gpsClient.Connetion(ip, port, false)){ + isConnetion=true; + this.btnCon.Text = "已连接"; + this.btnCon.Visible = false; + + } + } + + private void btnSend_Click(object sender, EventArgs e) + { + string text=this.txtContent.Text; + if (isConnetion && !string.IsNullOrEmpty(text)) + { + byte [] bytes= ByteConvert.hexStringToByte(text); + _gpsClient.Send(bytes, bytes.Length); + this.lbMsg.Text = "发送成功"; + } + } + + + } +} diff --git a/TextServer/Form1.resx b/TextServer/Form1.resx new file mode 100644 index 0000000..1af7de1 --- /dev/null +++ b/TextServer/Form1.resx @@ -0,0 +1,120 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + text/microsoft-resx + + + 2.0 + + + System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + + System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + \ No newline at end of file diff --git a/TextServer/Program.cs b/TextServer/Program.cs new file mode 100644 index 0000000..78cb96a --- /dev/null +++ b/TextServer/Program.cs @@ -0,0 +1,22 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Threading.Tasks; +using System.Windows.Forms; + +namespace TextServer +{ + static class Program + { + /// + /// 应用程序的主入口点。 + /// + [STAThread] + static void Main() + { + Application.EnableVisualStyles(); + Application.SetCompatibleTextRenderingDefault(false); + Application.Run(new Form1()); + } + } +} diff --git a/TextServer/Properties/AssemblyInfo.cs b/TextServer/Properties/AssemblyInfo.cs new file mode 100644 index 0000000..853efb6 --- /dev/null +++ b/TextServer/Properties/AssemblyInfo.cs @@ -0,0 +1,36 @@ +using System.Reflection; +using System.Runtime.CompilerServices; +using System.Runtime.InteropServices; + +// 有关程序集的常规信息通过以下 +// 特性集控制。更改这些特性值可修改 +// 与程序集关联的信息。 +[assembly: AssemblyTitle("TextServer")] +[assembly: AssemblyDescription("")] +[assembly: AssemblyConfiguration("")] +[assembly: AssemblyCompany("")] +[assembly: AssemblyProduct("TextServer")] +[assembly: AssemblyCopyright("Copyright © 2017")] +[assembly: AssemblyTrademark("")] +[assembly: AssemblyCulture("")] + +// 将 ComVisible 设置为 false 使此程序集中的类型 +// 对 COM 组件不可见。如果需要从 COM 访问此程序集中的类型, +// 则将该类型上的 ComVisible 特性设置为 true。 +[assembly: ComVisible(false)] + +// 如果此项目向 COM 公开,则下列 GUID 用于类型库的 ID +[assembly: Guid("02164284-4976-4cfc-828e-64dacf391f15")] + +// 程序集的版本信息由下面四个值组成: +// +// 主版本 +// 次版本 +// 生成号 +// 修订号 +// +// 可以指定所有这些值,也可以使用“生成号”和“修订号”的默认值, +// 方法是按如下所示使用“*”: +// [assembly: AssemblyVersion("1.0.*")] +[assembly: AssemblyVersion("1.0.0.0")] +[assembly: AssemblyFileVersion("1.0.0.0")] diff --git a/TextServer/Properties/Resources.Designer.cs b/TextServer/Properties/Resources.Designer.cs new file mode 100644 index 0000000..cff59f5 --- /dev/null +++ b/TextServer/Properties/Resources.Designer.cs @@ -0,0 +1,71 @@ +//------------------------------------------------------------------------------ +// +// 此代码由工具生成。 +// 运行时版本: 4.0.30319.42000 +// +// 对此文件的更改可能会导致不正确的行为,并且如果 +// 重新生成代码,这些更改将丢失。 +// +//------------------------------------------------------------------------------ + +namespace TextServer.Properties +{ + + + /// + /// 一个强类型的资源类,用于查找本地化的字符串等。 + /// + // 此类是由 StronglyTypedResourceBuilder + // 类通过类似于 ResGen 或 Visual Studio 的工具自动生成的。 + // 若要添加或移除成员,请编辑 .ResX 文件,然后重新运行 ResGen + // (以 /str 作为命令选项),或重新生成 VS 项目。 + [global::System.CodeDom.Compiler.GeneratedCodeAttribute("System.Resources.Tools.StronglyTypedResourceBuilder", "4.0.0.0")] + [global::System.Diagnostics.DebuggerNonUserCodeAttribute()] + [global::System.Runtime.CompilerServices.CompilerGeneratedAttribute()] + internal class Resources + { + + private static global::System.Resources.ResourceManager resourceMan; + + private static global::System.Globalization.CultureInfo resourceCulture; + + [global::System.Diagnostics.CodeAnalysis.SuppressMessageAttribute("Microsoft.Performance", "CA1811:AvoidUncalledPrivateCode")] + internal Resources() + { + } + + /// + /// 返回此类使用的、缓存的 ResourceManager 实例。 + /// + [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] + internal static global::System.Resources.ResourceManager ResourceManager + { + get + { + if ((resourceMan == null)) + { + global::System.Resources.ResourceManager temp = new global::System.Resources.ResourceManager("TextServer.Properties.Resources", typeof(Resources).Assembly); + resourceMan = temp; + } + return resourceMan; + } + } + + /// + /// 为所有资源查找重写当前线程的 CurrentUICulture 属性, + /// 方法是使用此强类型资源类。 + /// + [global::System.ComponentModel.EditorBrowsableAttribute(global::System.ComponentModel.EditorBrowsableState.Advanced)] + internal static global::System.Globalization.CultureInfo Culture + { + get + { + return resourceCulture; + } + set + { + resourceCulture = value; + } + } + } +} diff --git a/TextServer/Properties/Resources.resx b/TextServer/Properties/Resources.resx new file mode 100644 index 0000000..af7dbeb --- /dev/null +++ b/TextServer/Properties/Resources.resx @@ -0,0 +1,117 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + text/microsoft-resx + + + 2.0 + + + System.Resources.ResXResourceReader, System.Windows.Forms, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + + System.Resources.ResXResourceWriter, System.Windows.Forms, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + \ No newline at end of file diff --git a/TextServer/Properties/Settings.Designer.cs b/TextServer/Properties/Settings.Designer.cs new file mode 100644 index 0000000..669c222 --- /dev/null +++ b/TextServer/Properties/Settings.Designer.cs @@ -0,0 +1,30 @@ +//------------------------------------------------------------------------------ +// +// This code was generated by a tool. +// Runtime Version:4.0.30319.42000 +// +// Changes to this file may cause incorrect behavior and will be lost if +// the code is regenerated. +// +//------------------------------------------------------------------------------ + +namespace TextServer.Properties +{ + + + [global::System.Runtime.CompilerServices.CompilerGeneratedAttribute()] + [global::System.CodeDom.Compiler.GeneratedCodeAttribute("Microsoft.VisualStudio.Editors.SettingsDesigner.SettingsSingleFileGenerator", "11.0.0.0")] + internal sealed partial class Settings : global::System.Configuration.ApplicationSettingsBase + { + + private static Settings defaultInstance = ((Settings)(global::System.Configuration.ApplicationSettingsBase.Synchronized(new Settings()))); + + public static Settings Default + { + get + { + return defaultInstance; + } + } + } +} diff --git a/TextServer/Properties/Settings.settings b/TextServer/Properties/Settings.settings new file mode 100644 index 0000000..3964565 --- /dev/null +++ b/TextServer/Properties/Settings.settings @@ -0,0 +1,7 @@ + + + + + + + diff --git a/TextServer/TextServer.csproj b/TextServer/TextServer.csproj new file mode 100644 index 0000000..c83431c --- /dev/null +++ b/TextServer/TextServer.csproj @@ -0,0 +1,98 @@ + + + + + Debug + AnyCPU + {D7808C01-00CF-48FB-9CDE-53DFBDE5287D} + WinExe + Properties + TextServer + TextServer + v4.5 + 512 + + + x64 + true + full + false + bin\Debug\ + DEBUG;TRACE + prompt + 4 + + + AnyCPU + pdbonly + true + bin\Release\ + TRACE + prompt + 4 + + + + + + + + + + + + + + + + Form + + + Form1.cs + + + + + Form1.cs + + + ResXFileCodeGenerator + Resources.Designer.cs + Designer + + + True + Resources.resx + + + SettingsSingleFileGenerator + Settings.Designer.cs + + + True + Settings.settings + True + + + + + + + + {5699f908-5b5c-4228-9eb7-6113b2b3992d} + GPSBusiness + + + {dfa935e2-cf37-4e26-b697-d7f3dee19dd8} + HPSocketCS + + + + + \ No newline at end of file diff --git a/Toogps.Mongo/App.config b/Toogps.Mongo/App.config new file mode 100644 index 0000000..8ecf0a8 --- /dev/null +++ b/Toogps.Mongo/App.config @@ -0,0 +1,15 @@ + + + + + + + + + + + + + + + diff --git a/Toogps.Mongo/Core/Compression/Snappy/lib/win/snappy32.dll b/Toogps.Mongo/Core/Compression/Snappy/lib/win/snappy32.dll new file mode 100644 index 0000000..afc82ca Binary files /dev/null and b/Toogps.Mongo/Core/Compression/Snappy/lib/win/snappy32.dll differ diff --git a/Toogps.Mongo/Core/Compression/Snappy/lib/win/snappy64.dll b/Toogps.Mongo/Core/Compression/Snappy/lib/win/snappy64.dll new file mode 100644 index 0000000..36cd5fe Binary files /dev/null and b/Toogps.Mongo/Core/Compression/Snappy/lib/win/snappy64.dll differ diff --git a/Toogps.Mongo/Core/Compression/Zstandard/lib/win/libzstd.dll b/Toogps.Mongo/Core/Compression/Zstandard/lib/win/libzstd.dll new file mode 100644 index 0000000..e669123 Binary files /dev/null and b/Toogps.Mongo/Core/Compression/Zstandard/lib/win/libzstd.dll differ diff --git a/Toogps.Mongo/MongoServer.cs b/Toogps.Mongo/MongoServer.cs new file mode 100644 index 0000000..bb48dc9 --- /dev/null +++ b/Toogps.Mongo/MongoServer.cs @@ -0,0 +1,553 @@ +using System; +using System.Collections.Generic; +using System.Configuration; +using log4net; +using MongoDB.Bson; +using MongoDB.Driver; + +namespace Toogps.Mongo +{ + public class MongoServer + { + /// + /// 服务器地址 + /// + private readonly string _mongodbServers; + /// + /// 数据库名称 + /// + private readonly string _mongoDbName; + /// + /// 集群名字 + /// + private readonly string _replicaSetName; + /// + /// 持久化要求 + /// + private bool _journal = false; + private MongoClient _client; + public MongoServer() + { + _mongodbServers = ConfigurationManager.AppSettings["MongoDBServers"]; + _mongoDbName = ConfigurationManager.AppSettings["MongoDBName"]; + _replicaSetName = ConfigurationManager.AppSettings["MongoDBReplicaSetName"]; + } + /// 服务器地址 + /// 数据库名称 + /// 集群名字 + public MongoServer(string replicaSetName, string mongodbServers, string mongoDbName) + { + _mongodbServers = mongodbServers; + _replicaSetName = replicaSetName; + _mongoDbName = mongoDbName; + } + public MongoClient Client + { + get + { + if (_client == null) + { + _client = InitClient(); + } + return _client; + } + } + private MongoClient InitClient() + { + ////LogManager.GetLogger(this.GetType()).Error(String.Format("InitClient ")); + ////mongodb://host1,host2,host3/?slaveOk=true + //var mongoClientSettings = new MongoClientSettings(); + //if (!string.IsNullOrWhiteSpace(_replicaSetName)) + //{ + // mongoClientSettings.ClusterConfigurator = builder => + // { + // builder.ConfigureCluster(settings => settings.With(serverSelectionTimeout: TimeSpan.FromSeconds(50))); + // }; + // mongoClientSettings.ReplicaSetName = _replicaSetName; + // mongoClientSettings.ReadPreference = new ReadPreference(ReadPreferenceMode.SecondaryPreferred); + //} + //mongoClientSettings.Servers = GetServerAddresses(); + //mongoClientSettings.MaxConnectionPoolSize = 80; + //mongoClientSettings.WaitQueueSize = 150; + ////var b = mongoClientSettings.WaitQueueSize; + ////var a = WaitQueueSize { get; set; } + //// public int MaxConnectionPoolSize { get; set; } + ////// 摘要: + ////// Gets or sets the wait queue size. + ////public int WaitQueueSize { get; set; } + ////从节点读取优先 + ////写入级别的问题文章http://kyfxbl.iteye.com/blog/1952941 + ////write concern:0(Unacknowledged),性能最好,可靠性最差,不考虑是否写入成功,会捕捉网络错误 WriteConcern.Unacknowledged; + ////write concern:1(acknowledged) 具备基本可靠性,mongodb的默认设置级别,可能在内存中的数据丢失 //WriteConcern.Acknowledged + ////write concern:1 & journal:true(Jounaled)可靠性,确保数据到硬盘中, + ////write concern:2(Replica Acknowledged)也可以同时设置journal:true或j:true,则还要等journal写入也成功后才会返回。 + ////mongoClientSettings.WriteConcern = WriteConcern.Acknowledged; + //// public WriteConcern(Optional w = null, Optional wTimeout = null, Optional fsync = null, Optional journal = null); + ////public WriteConcern(int w, Optional wTimeout = null, Optional fsync = null, Optional journal = null); + ////public WriteConcern(string mode, Optional wTimeout = null, Optional fsync = null, Optional journal = null); + //mongoClientSettings.WriteConcern = new WriteConcern(1, null, null, _journal); + ////mongoClientSettings.WriteConcern = WriteConcern.W3; + ////mongoClientSettings.WriteConcern = WriteConcern.WMajority; + ////mongoClientSettings.WriteConcern + ////var j = mongoClientSettings.WriteConcern.Journal; + //_client = new MongoClient(mongoClientSettings); + ////var a = mongoClientSettings.WriteConcern.Journal; + //// builder.ConfigureCluster(settings => settings.With(serverSelectionTimeout: TimeSpan.FromSeconds(10))); + //// } + ////});zh + ////选项 描述 + ////replicaSet=name 验证replica set的名称。 Impliesconnect=replicaSet. + ////slaveOk=true|false + ////true:在connect=direct模式下,驱动会连接第一台机器,即使这台服务器不是主。 + ////在connect=replicaSet模式下,驱动会发送所有的写请求到主并且把读取操作分布在其他从服务器。 + ////false: 在 connect=direct模式下,驱动会自动找寻主服务器. + ////在connect=replicaSet 模式下,驱动仅仅连接主服务器,并且所有的读写命令都连接到主服务器。 + ////safe=true|false + ////true: 在执行更新操作之后,驱动都会发送getLastError命令来确保更新成功。(还要参考 wtimeoutMS). + ////false: 在每次更新之后,驱动不会发送getLastError来确保更新成功。 + ////w=n 驱动添加 { w : n } 到getLastError命令. 应用于safe=true。 + ////wtimeoutMS=ms 驱动添加 { wtimeout : ms } 到 getlasterror 命令. 应用于 safe=true. + ////fsync=true|false + ////true: 驱动添加 { fsync : true } 到 getlasterror 命令.应用于 safe=true. + ////false: 驱动不会添加到getLastError命令中。 + ////journal=true|false 如果设置为 true, 同步到 journal (在提交到数据库前写入到实体中). 应用于 safe=true + ////connectTimeoutMS=ms 可以打开连接的时间。 + ////socketTimeoutMS=ms 发送和接受sockets的时间。 + + return new MongoClient(_mongodbServers); + } + public List GetServerAddresses(string mongodbServers) + { + var mongoServerAddresses = new List(); + var servers = mongodbServers.Split(','); + foreach (var server in servers) + { + var ipAndPost = server.Split(':'); + var s = new MongoServerAddress(ipAndPost[0], int.Parse(ipAndPost[1])); + mongoServerAddresses.Add(s); + } + return mongoServerAddresses; + } + private List GetServerAddresses() + { + var mongoServerAddresses = new List(); + var servers = _mongodbServers.Split(','); + foreach (var server in servers) + { + var ipAndPost = server.Split(':'); + var s = new MongoServerAddress(ipAndPost[0], int.Parse(ipAndPost[1])); + mongoServerAddresses.Add(s); + } + return mongoServerAddresses; + } + public IMongoDatabase MongoDatabase + { + get + { + //var set = new MongoDatabaseSettings(); + //set.ReadPreference = new ReadPreference(ReadPreferenceMode.SecondaryPreferred); + return Client.GetDatabase(_mongoDbName); + } + } + public bool InsertOne(T t, string collectionName) + { + try + { + var collection = MongoDatabase.GetCollection(collectionName); + var bd = t.ToBsonDocument(); + collection.InsertOne(bd); + return true; + } + catch (Exception ex) + { + LogManager.GetLogger(this.GetType()).Error(String.Format("InsertOne collectionName {0},Exception {1}", collectionName, ex.Message)); + } + return false; + } + public void InsertOneAsync(T t, string collectionName) + { + try + { + var collection = MongoDatabase.GetCollection(collectionName); + var bd = t.ToBsonDocument(); + collection.InsertOneAsync(bd); + } + catch (Exception ex) + { + LogManager.GetLogger(this.GetType()).Error(String.Format("InsertOneAsync collectionName {0},Exception {1}", collectionName, ex.Message)); + } + } + public bool InsertMany(List list, string collectionName) + { + try + { + var collection = MongoDatabase.GetCollection(collectionName); + var bsonList = new List(); + list.ForEach(t => bsonList.Add(t.ToBsonDocument())); + collection.InsertMany(bsonList); + return true; + } + catch (Exception ex) + { + LogManager.GetLogger(this.GetType()).Error(String.Format("InsertMany collectionName {0},Exception {1}", collectionName, ex.Message)); + } + return false; + } + public void InsertManyAsync(List list, string collectionName) + { + try + { + var collection = MongoDatabase.GetCollection(collectionName); + var bsonList = new List(); + list.ForEach(t => bsonList.Add(t.ToBsonDocument())); + collection.InsertManyAsync(bsonList); + } + catch (Exception ex) + { + LogManager.GetLogger(this.GetType()).Error(String.Format("InsertManyAsync collectionName {0},Exception {1}", collectionName, ex.Message)); + } + } + public void RunCommand(Command command) + { + try + { + MongoDatabase.RunCommand(command); + } + catch (Exception ex) + { + LogManager.GetLogger(this.GetType()).Error(String.Format("RunCommand command {0},Exception {1}", command, ex.Message)); + } + } + public void TouchCollection(string collectionName) + { + try + { + var command = new JsonCommand("{\"touch\":\"" + collectionName + "\",\"data\":\"true\",\"index\":\"true\"}"); + MongoDatabase.RunCommand(command); + } + catch (Exception ex) + { + LogManager.GetLogger(this.GetType()).Error(String.Format("RunCommand command {0},Exception {1}", collectionName, ex.Message)); + } + } + public bool ReplaceOne(FilterDefinition filter, T replacement, string collectionName) + { + try + { + var collection = MongoDatabase.GetCollection(collectionName); + var result = collection.ReplaceOne(filter, replacement); + return result.IsModifiedCountAvailable; + } + catch (Exception ex) + { + LogManager.GetLogger(this.GetType()).Error(String.Format("ReplaceOne collectionName {0},Exception {1}", collectionName, ex.Message)); + return false; + } + } + public T FindOneAndReplace(FilterDefinition filter, T replacement, string collectionName) + { + try + { + var collection = MongoDatabase.GetCollection(collectionName); + var result = collection.FindOneAndReplace(filter, replacement); + return result; + } + catch (Exception ex) + { + LogManager.GetLogger(this.GetType()).Error(String.Format("FindOneAndReplace collectionName {0} , Exception {1}", collectionName, ex.Message)); + return default(T); + } + } + public bool ReplaceOneAsync(FilterDefinition filter, T replacement, string collectionName) + { + try + { + var collection = MongoDatabase.GetCollection(collectionName); + collection.ReplaceOneAsync(filter, replacement); + return true; + } + catch (Exception ex) + { + LogManager.GetLogger(this.GetType()).Error(String.Format("ReplaceOne collectionName {0},Exception {1}", collectionName, ex.Message)); + return false; + } + } + /// + /// 先找出一个并替换,如找不到,再插入。 + /// + /// 原实体对象 + /// 筛选条件 + /// 如:var filter = Builders.Filter.Eq("CompanyId", id) + /// & Builders.Filter.Gt("VehicleId", 0); + /// + /// 替换的实体对象(尽量与原实体对象结构保持一致) + /// 数据集名称 + public void ReplaceOrInsertOne(FilterDefinition filter, T replacement, string collectionName) + { + try + { + var collection = MongoDatabase.GetCollection(collectionName); + var result = collection.FindOneAndReplace(filter, replacement); + if (result == null) + { + collection.InsertOneAsync(replacement); + } + } + catch (Exception ex) + { + LogManager.GetLogger(this.GetType()).Error(String.Format("ReplaceOrInsertOne collectionName {0} , Exception {1}", collectionName, ex.Message)); + } + } + public bool UpdateOne(FilterDefinition filter, UpdateDefinition updateDefinition, string collectionName) + { + try + { + var collection = MongoDatabase.GetCollection(collectionName); + var result = collection.UpdateOne(filter, updateDefinition); + return result.IsModifiedCountAvailable; + } + catch (Exception ex) + { + LogManager.GetLogger(this.GetType()).Error(String.Format("UpdateOne collectionName {0},Exception {1}", collectionName, ex.Message)); + return false; + } + } + public bool UpdateOneAsync(FilterDefinition filter, UpdateDefinition updateDefinition, string collectionName) + { + try + { + var collection = MongoDatabase.GetCollection(collectionName); + collection.UpdateOneAsync(filter, updateDefinition); + return true; + } + catch (Exception ex) + { + LogManager.GetLogger(this.GetType()).Error(String.Format("UpdateOneAsync collectionName {0},Exception {1}", collectionName, ex.Message)); + return false; + } + } + public T FindOne(FilterDefinition filter, string collectionName) + { + try + { + var collection = MongoDatabase.GetCollection(collectionName); + var t = collection.Find(filter).FirstOrDefault(); + return t; + } + catch (Exception ex) + { + LogManager.GetLogger(this.GetType()).Error(String.Format("FindOne collectionName {0},Exception {1}", collectionName, ex.Message)); + return default(T); + } + } + /// + /// 获取符合筛选条件的数据 + /// + /// 原实体对象 + /// 筛选条件 + /// 如:var filter = Builders.Filter.Eq("CompanyId", id) + /// & Builders.Filter.Gt("VehicleId", 0); + /// + /// 数据集名称 + /// + public List Find(FilterDefinition filter, string collectionName) + { + try + { + var collection = MongoDatabase.GetCollection(collectionName); + var t = collection.Find(filter).ToList(); + return t; + } + catch (Exception ex) + { + LogManager.GetLogger(this.GetType()).Error(String.Format("FindOne collectionName {0},Exception {1}", collectionName, ex.Message)); + return new List(); + } + } + /// + /// 获取符合筛选条件的数据,排序 + /// + /// 原实体对象 + /// 筛选条件 + /// 如:var filter = Builders.Filter.Eq("CompanyId", id) + /// & Builders.Filter.Gt("VehicleId", 0); + /// + /// var sort = Builders.Sort.Descending(s => s.VehicleId); + /// 数据集名称 + /// + public List Find(FilterDefinition filter, SortDefinition sort, string collectionName) + { + try + { + var collection = MongoDatabase.GetCollection(collectionName); + var t = collection.Find(filter).Sort(sort).ToList(); + return t; + } + catch (Exception ex) + { + LogManager.GetLogger(this.GetType()).Error(String.Format("Find collectionName {0},Exception {1}", collectionName, ex.Message)); + return new List(); + } + } + /// + /// 获取符合筛选条件的数据,排序,分页 + /// + /// 原实体对象 + /// 筛选条件 + /// 如:var filter = Builders.Filter.Eq("CompanyId", id) + /// & Builders.Filter.Gt("VehicleId", 0); + /// + /// 页码 + /// 记录数 + /// 数据集名称 + /// + public List FindForPage(FilterDefinition filter, int pageNumber, int pageSize, string collectionName) + { + try + { + var collection = MongoDatabase.GetCollection(collectionName); + var t = collection.Find(filter).Skip((pageNumber - 1) * pageSize).Limit(pageSize).ToList(); + return t; + } + catch (Exception ex) + { + LogManager.GetLogger(this.GetType()).Error(String.Format("Find collectionName {0},Exception {1}", collectionName, ex.Message)); + return new List(); + } + } + /// + /// 获取符合筛选条件的数据,排序,分页 + /// + /// 原实体对象 + /// 筛选条件 + /// 如:var filter = Builders.Filter.Eq("CompanyId", id) + /// & Builders.Filter.Gt("VehicleId", 0); + /// + /// var sort = Builders.Sort.Descending(s => s.VehicleId); + /// 页码 + /// 记录数 + /// 数据集名称 + /// + public List FindForPage(FilterDefinition filter, SortDefinition sort, int pageNumber, int pageSize, string collectionName) + { + try + { + var collection = MongoDatabase.GetCollection(collectionName); + var t = collection.Find(filter).Sort(sort).Skip((pageNumber - 1) * pageSize).Limit(pageSize).ToList(); + return t; + } + catch (Exception ex) + { + LogManager.GetLogger(this.GetType()).Error(String.Format("Find collectionName {0},Exception {1}", collectionName, ex.Message)); + return new List(); + } + } + /// + /// 根据需求列,获取数据 + /// + /// 原实体对象 + /// 新实体对象 + /// 筛选条件 + /// + /// 例:var pj1 =Builders.Projection.Expression(s => new {s.VehicleId, s.GpsTime, s.Longitude, s.Latitude, s.VehicleCode}); + /// 或 var pj2 = Builders.Projection.Expression(s =>new CarCarGps + /// { + /// VehicleId = s.VehicleId, + /// GpsTime = s.GpsTime, + /// Longitude = s.Longitude, + /// Latitude = s.Latitude, + /// VehicleCode = s.VehicleCode + /// }); + /// + /// 数据集名称 + /// + public List FindByProjection(FilterDefinition filter, ProjectionDefinition projectionDefinition, string collectionName) + { + try + { + var collection = MongoDatabase.GetCollection(collectionName); + var t = collection.Find(filter).Project(projectionDefinition).ToList(); + return t; + } + catch (Exception ex) + { + LogManager.GetLogger(this.GetType()).Error(String.Format("Find collectionName {0},Exception {1}", collectionName, ex.Message)); + return new List(); + } + } + /// + /// + /// + /// 原实体对象 + /// 新实体对象 + /// 筛选条件 + /// + /// 例:var pj1 =Builders.Projection.Expression(s => new {s.VehicleId, s.GpsTime, s.Longitude, s.Latitude, s.VehicleCode}); + /// 或 var pj2 = Builders.Projection.Expression(s =>new CarCarGps + /// { + /// VehicleId = s.VehicleId, + /// GpsTime = s.GpsTime, + /// Longitude = s.Longitude, + /// Latitude = s.Latitude, + /// VehicleCode = s.VehicleCode + /// }); + /// + /// var sort = Builders.Sort.Descending(s => s.VehicleId); + /// 页码 + /// 记录数 + /// 数据集名称 + /// + public List FindByProjection(FilterDefinition filter, ProjectionDefinition projectionDefinition, SortDefinition sort, int pageNumber, int pageSize, string collectionName) + { + try + { + var collection = MongoDatabase.GetCollection(collectionName); + var t = collection.Find(filter).Project(projectionDefinition).Sort(sort).Skip((pageNumber - 1) * pageSize).Limit(pageSize).ToList(); + return t; + } + catch (Exception ex) + { + LogManager.GetLogger(this.GetType()).Error(String.Format("Find collectionName {0},Exception {1}", collectionName, ex.Message)); + return new List(); + } + } + public bool DropCollection(string collectionName) + { + try + { + MongoDatabase.DropCollection(collectionName); + return true; + } + catch (Exception ex) + { + LogManager.GetLogger(this.GetType()).Error(String.Format("DropCollection {0},Exception {1}", collectionName, ex.Message)); + } + return false; + } + public bool DropCollectionAsync(string collectionName) + { + try + { + MongoDatabase.DropCollectionAsync(collectionName); + return true; + } + catch (Exception ex) + { + LogManager.GetLogger(this.GetType()).Error(String.Format("DropCollection {0},Exception {1}", collectionName, ex.Message)); + } + return false; + } + public int GetCount(string collectionName, FilterDefinition filter, out int totalCount) + { + totalCount = int.Parse(MongoDatabase.GetCollection(collectionName).Find(filter).Count().ToString()); + return totalCount; + } + public List GetListPage(string collectionName, FilterDefinition filter, out int totalCount, SortDefinition sort, int pageIndex = 1, int pageSize = 10) + { + totalCount = int.Parse(MongoDatabase.GetCollection(collectionName).Find(filter).Count().ToString()); + var collection = MongoDatabase.GetCollection(collectionName); + var t = collection.Find(filter).Sort(sort).Skip((pageIndex - 1) * pageSize).Limit(pageSize).ToList(); + return t; + } + } +} diff --git a/Toogps.Mongo/Properties/AssemblyInfo.cs b/Toogps.Mongo/Properties/AssemblyInfo.cs new file mode 100644 index 0000000..caaad5e --- /dev/null +++ b/Toogps.Mongo/Properties/AssemblyInfo.cs @@ -0,0 +1,36 @@ +using System.Reflection; +using System.Runtime.CompilerServices; +using System.Runtime.InteropServices; + +// 有关程序集的常规信息通过以下 +// 特性集控制。更改这些特性值可修改 +// 与程序集关联的信息。 +[assembly: AssemblyTitle("Toogps.Mongo")] +[assembly: AssemblyDescription("")] +[assembly: AssemblyConfiguration("")] +[assembly: AssemblyCompany("Microsoft")] +[assembly: AssemblyProduct("Toogps.Mongo")] +[assembly: AssemblyCopyright("Copyright © Microsoft 2016")] +[assembly: AssemblyTrademark("")] +[assembly: AssemblyCulture("")] + +// 将 ComVisible 设置为 false 使此程序集中的类型 +// 对 COM 组件不可见。如果需要从 COM 访问此程序集中的类型, +// 则将该类型上的 ComVisible 特性设置为 true。 +[assembly: ComVisible(false)] + +// 如果此项目向 COM 公开,则下列 GUID 用于类型库的 ID +[assembly: Guid("f35bccea-bc6e-4f91-be6d-dcc6e47783b9")] + +// 程序集的版本信息由下面四个值组成: +// +// 主版本 +// 次版本 +// 生成号 +// 修订号 +// +// 可以指定所有这些值,也可以使用“生成号”和“修订号”的默认值, +// 方法是按如下所示使用“*”: +// [assembly: AssemblyVersion("1.0.*")] +[assembly: AssemblyVersion("1.0.0.0")] +[assembly: AssemblyFileVersion("1.0.0.0")] diff --git a/Toogps.Mongo/Toogps.Mongo.csproj b/Toogps.Mongo/Toogps.Mongo.csproj new file mode 100644 index 0000000..6bad1a7 --- /dev/null +++ b/Toogps.Mongo/Toogps.Mongo.csproj @@ -0,0 +1,154 @@ + + + + + Debug + AnyCPU + {92893153-C7F1-42DF-8002-B7AE94829DB6} + Library + Properties + Toogps.Mongo + Toogps.Mongo + v4.7.2 + 512 + + + + + + true + full + false + bin\Debug\ + DEBUG;TRACE + prompt + 4 + false + + + pdbonly + true + bin\Release\ + TRACE + prompt + 4 + false + + + + ..\packages\DnsClient.1.4.0\lib\net471\DnsClient.dll + + + ..\lib\log4net.dll + + + ..\packages\MongoDB.Bson.2.13.1\lib\net452\MongoDB.Bson.dll + + + ..\packages\MongoDB.Driver.2.13.1\lib\net452\MongoDB.Driver.dll + + + ..\packages\MongoDB.Driver.Core.2.13.1\lib\net452\MongoDB.Driver.Core.dll + + + ..\packages\MongoDB.Libmongocrypt.1.2.3\lib\net472\MongoDB.Libmongocrypt.dll + + + ..\lib\Newtonsoft.Json.dll + + + ..\packages\SharpCompress.0.23.0\lib\net45\SharpCompress.dll + + + + ..\packages\System.Buffers.4.5.1\lib\net461\System.Buffers.dll + + + + + + ..\packages\System.IO.4.3.0\lib\net462\System.IO.dll + True + True + + + ..\packages\System.Net.Http.4.3.4\lib\net46\System.Net.Http.dll + True + True + + + ..\packages\System.Runtime.4.3.0\lib\net462\System.Runtime.dll + True + True + + + ..\packages\System.Runtime.CompilerServices.Unsafe.5.0.0\lib\net45\System.Runtime.CompilerServices.Unsafe.dll + + + ..\packages\System.Runtime.InteropServices.RuntimeInformation.4.3.0\lib\net45\System.Runtime.InteropServices.RuntimeInformation.dll + True + True + + + ..\packages\System.Security.Cryptography.Algorithms.4.3.0\lib\net463\System.Security.Cryptography.Algorithms.dll + True + True + + + ..\packages\System.Security.Cryptography.Encoding.4.3.0\lib\net46\System.Security.Cryptography.Encoding.dll + True + True + + + ..\packages\System.Security.Cryptography.Primitives.4.3.0\lib\net46\System.Security.Cryptography.Primitives.dll + True + True + + + ..\packages\System.Security.Cryptography.X509Certificates.4.3.0\lib\net461\System.Security.Cryptography.X509Certificates.dll + True + True + + + ..\packages\System.ValueTuple.4.5.0\lib\net47\System.ValueTuple.dll + + + + + + + + + + + + + + + + + + + + + + + + + + + 这台计算机上缺少此项目引用的 NuGet 程序包。使用“NuGet 程序包还原”可下载这些程序包。有关更多信息,请参见 http://go.microsoft.com/fwlink/?LinkID=322105。缺少的文件是 {0}。 + + + + + + + + \ No newline at end of file diff --git a/Toogps.Mongo/libmongocrypt.dylib b/Toogps.Mongo/libmongocrypt.dylib new file mode 100644 index 0000000..6953c78 Binary files /dev/null and b/Toogps.Mongo/libmongocrypt.dylib differ diff --git a/Toogps.Mongo/libmongocrypt.so b/Toogps.Mongo/libmongocrypt.so new file mode 100644 index 0000000..9bcfbf0 Binary files /dev/null and b/Toogps.Mongo/libmongocrypt.so differ diff --git a/Toogps.Mongo/mongocrypt.dll b/Toogps.Mongo/mongocrypt.dll new file mode 100644 index 0000000..ebbb7cc Binary files /dev/null and b/Toogps.Mongo/mongocrypt.dll differ diff --git a/Toogps.Mongo/packages.config b/Toogps.Mongo/packages.config new file mode 100644 index 0000000..ec193c8 --- /dev/null +++ b/Toogps.Mongo/packages.config @@ -0,0 +1,20 @@ + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/Toogps.PGProject.Repository.Mongo/CarCarGps.cs b/Toogps.PGProject.Repository.Mongo/CarCarGps.cs new file mode 100644 index 0000000..5a7928a --- /dev/null +++ b/Toogps.PGProject.Repository.Mongo/CarCarGps.cs @@ -0,0 +1,31 @@ +using System; +using MongoDB.Bson.Serialization.Attributes; + +namespace Toogps.Mongo.Repository +{ + [BsonIgnoreExtraElements] + public class CarCarGps + { + /// + /// 车辆ID + /// + public int VehicleId { get; set; } + /// + /// 车辆编号 + /// + public string VehicleCode { get; set; } + /// + /// 经度 + /// + public decimal Longitude { get; set; } + /// + /// 纬度 + /// + public decimal Latitude { get; set; } + /// + /// Gps数据产生时间 + /// + //[BsonDateTimeOptions(Kind = DateTimeKind.Unspecified)] + // public DateTime GpsTime { get; set; } + } +} diff --git a/Toogps.PGProject.Repository.Mongo/CarGpsRepository.cs b/Toogps.PGProject.Repository.Mongo/CarGpsRepository.cs new file mode 100644 index 0000000..89ae280 --- /dev/null +++ b/Toogps.PGProject.Repository.Mongo/CarGpsRepository.cs @@ -0,0 +1,87 @@ +using System; +using System.Collections.Generic; +using GpsModels; +using log4net; +using MongoDB.Bson; +using MongoDB.Driver; + +namespace Toogps.Mongo.Repository +{ + public class CarGpsRepository + { + public static ILog Log = LogManager.GetLogger(""); + //插入车辆定位数据,一般用作轨迹查询 + public static bool InsertCarGpsList(List models, string tbName) + { + var carList = new List(); + foreach (var gpsModel in models) + { + if (OutOfChina((double)gpsModel.Latitude, (double)gpsModel.Longitude)) continue; + var cargps = new CarGpsModel() + { + VehicleId = gpsModel.VehicleId, + CompanyId = gpsModel.CompanyId, + SimNo = gpsModel.SimNo, + VehiclePlate = gpsModel.VehiclePlate, + VehicleCode = gpsModel.VehicleCode, + Longitude = gpsModel.Longitude, + Latitude = gpsModel.Latitude, + Speed = gpsModel.Speed, + Direct = gpsModel.Direct, + GpsState = gpsModel.GpsState, + GpsTime = gpsModel.GpsTime, + RecTime = gpsModel.RecTime, + Acc = gpsModel.Acc, + Work = gpsModel.Work, + Address= gpsModel.Address, + //GpsMode = gpsModel.GpsMode + }; + carList.Add(cargps); + } + if (carList.Count <= 0) + { + Log.InfoFormat("InsertCarGpsList并没有插入数据:models数量={0}", models.Count); + return false; + } + return InsertCarGpsList(carList, tbName); + } + public static bool InsertCarGpsList(List models, string tbName) + { + try + { + if (models.Count <= 0) return false; + return RepositoryContext.Server.InsertMany(models, tbName); + } + catch (Exception ex) + { + return false; + } + } + public static bool InsertCarGps(CarGpsModel model, string tbName) + { + try + { + bool flag = RepositoryContext.Server.InsertOne(model, tbName); + return flag; + } + catch (Exception ex) + { + return false; + } + } + + public static bool OutOfChina(double lat, double lon) + { + if (lon < 72.004 || lon > 137.8347) + return true; + if (lat < 0.8293 || lat > 55.8271) + return true; + return false; + } + + + + + + } +} diff --git a/Toogps.PGProject.Repository.Mongo/CompanyCarGps.cs b/Toogps.PGProject.Repository.Mongo/CompanyCarGps.cs new file mode 100644 index 0000000..8658d2d --- /dev/null +++ b/Toogps.PGProject.Repository.Mongo/CompanyCarGps.cs @@ -0,0 +1,61 @@ +using System; +using MongoDB.Bson.Serialization.Attributes; + +namespace Toogps.Mongo.Repository +{ + [BsonIgnoreExtraElements] + public class CompanyCarGps + { + + /// + /// 车辆ID(来自派工易系统生成) + /// + public int VehicleId { get; set; } + /// + /// 公司ID(来至派工易系统生成) + /// + public int CompanyId { get; set; } + /// + /// SIM卡号 + /// + public string SimNumber { get; set; } + /// + /// 车牌号 + /// + public string VehiclePlate { get; set; } + /// + /// 车辆编号 + /// + public string VehicleCode { get; set; } + /// + /// 经度 + /// + public decimal Longitude { get; set; } + /// + /// 纬度 + /// + public decimal Latitude { get; set; } + /// + /// 速度 + /// + public int speed { get; set; } + /// + /// 方向 + /// + public int Direct { get; set; } + /// + /// Acc状态(1开,0关) + /// + public int GPSstate { get; set; } + /// + /// Gps数据产生时间 + /// + [BsonDateTimeOptions(Kind = DateTimeKind.Unspecified)] + public DateTime GpsTime { get; set; } + /// + /// Gps服务器接收时间 + /// + [BsonDateTimeOptions(Kind = DateTimeKind.Unspecified)] + public DateTime RecTime { get; set; } + } +} diff --git a/Toogps.PGProject.Repository.Mongo/GpsRealTimeRepository.cs b/Toogps.PGProject.Repository.Mongo/GpsRealTimeRepository.cs new file mode 100644 index 0000000..84136c7 --- /dev/null +++ b/Toogps.PGProject.Repository.Mongo/GpsRealTimeRepository.cs @@ -0,0 +1,195 @@ +using System; +using System.Collections.Generic; +using GpsModels; +using log4net; +using MongoDB.Driver; + +namespace Toogps.Mongo.Repository +{ + public class GpsRealTimeRepository + { + /// + /// MongoDB中Gps实时分析数据表的表名(MongoDB不区分生产与测试服务器),GpsRealTime为生产表名,GpsRealTime_Test为测试表名 + /// + public static string GpsRealTimeTableName = System.Configuration.ConfigurationManager.AppSettings["GpsRealTimeTableName"]; + /// + /// MongoDB中Acc/作业持续时长数据表的表名(MongoDB不区分生产与测试服务器),GpsCarStatusDuration为生产表名,GpsCarStatusDuration_Test为测试表名 + /// + public static string GpsCarStatusDurationTableName = System.Configuration.ConfigurationManager.AppSettings["GpsCarStatusDurationTableName"]; + public static ILog Log = LogManager.GetLogger(""); + + /// + /// 获取离线并且开启了Acc或者Work的车辆 + /// + /// + public static List GetOffLineGpsRealTime() + { + try + { + var datetime = DateTime.Now.AddMinutes(-15); + var filter = Builders.Filter.Lte("GpsTime", datetime); + var list = RepositoryContext.Server.Find(filter, GpsRealTimeTableName); + return list.Count > 0 ? list : new List(); + } + catch (Exception ex) + { + return new List(); + } + } + + /// + /// 更新Gps实时数据 + /// + /// + /// + public static bool UpdateGpsRealTime(GpsModel gpsModel) + { + try + { + var companyId = gpsModel.CompanyId; + var filter = Builders.Filter.Eq("CompanyId", companyId) & + Builders.Filter.Eq("VehicleId", gpsModel.VehicleId); + + var update = Builders.Update + .Set(s => s.GpsTime, gpsModel.GpsTime) + .Set(s => s.RecTime, gpsModel.RecTime) + .Set(s => s.Longitude, gpsModel.Longitude) + .Set(s => s.Latitude, gpsModel.Latitude) + .Set(s => s.Address, gpsModel.Address) + .Set(s => s.Direct, gpsModel.Direct) + .Set(s => s.Speed, gpsModel.Speed) + .Set(s => s.Acc, gpsModel.Acc) + .Set(s => s.GpsAlert, gpsModel.GpsAlert) + .Set(s => s.Work, gpsModel.Work) + .Set(s => s.Useing, gpsModel.Useing) + .Set(s => s.Address, gpsModel.Address ?? "") + .Set(s => s.ModifiedTime, DateTime.Now) + .Set(s => s.GpsMode, gpsModel.GpsMode) + .Set(s => s.SimNo, gpsModel.SimNo); + + var isSuccess = RepositoryContext.Server.UpdateOne(filter, update, GpsRealTimeTableName); + if (!isSuccess) + Log.InfoFormat( + "UpdateGpsRealTime失败:VehicleId={0},GpsTime={1},RecTime={2},Longitude={3},Latitude={4},Direct={5},Speed={6},Acc={7},ModifiedTime={8},{9}", + gpsModel.VehicleId, gpsModel.GpsTime, gpsModel.RecTime, gpsModel.Longitude, gpsModel.Latitude, + gpsModel.Direct, gpsModel.Speed, gpsModel.Acc, DateTime.Now, gpsModel.CompanyId); + return isSuccess; + + } + catch (Exception ex) + { + Log.InfoFormat(ex.StackTrace + ex.Message); + } + return true; + } + + /// + /// 更新车辆gps状态: + /// + /// + /// + /// + /// + /// + /// + public static bool UpdateGpsRealTimeGpsState(VehicleModel vehicle, int gpsState, string durationTime, string AccDurationTime, string workDurationTime) + { + // var companyId = vehicle.CompanyId ; + var filter = Builders.Filter.Eq("CompanyId", vehicle.CompanyId) & + Builders.Filter.Eq("VehicleId", vehicle.Id); + + + var update = Builders.Update + .Set(s => s.GpsState, gpsState) + .Set(s => s.DurationTime, durationTime) + .Set(s => s.AccDurationTime, AccDurationTime) + .Set(s => s.ModifiedTime, DateTime.Now) + .Set(s => s.WorkDurationTime, workDurationTime); + + var isSuccess = RepositoryContext.Server.UpdateOne(filter, update, GpsRealTimeTableName); + if (!isSuccess) + Log.InfoFormat( + "UpdateGpsRealTimeGpsState失败:VehicleId={0},GpsState={1},DurationTime={2},AccDurationTime={3}", + vehicle.Id, gpsState, durationTime, AccDurationTime); + return isSuccess; + } + /// + /// 更新车辆gps状态,使用场景,1、沃瑞特在线车辆心跳时进行更新,2、车辆未定位时数据更新。 + /// + /// + /// + public static bool UpdateGpsRealTimeGpsStateWrt(GpsModel gpsModel) + { + var now = DateTime.Now; + var companyId = gpsModel.CompanyId ; + var filter = Builders.Filter.Eq("CompanyId", companyId) & + Builders.Filter.Eq("VehicleId", gpsModel.VehicleId); + + var update = Builders.Update + .Set(s => s.GpsState, gpsModel.GpsState) + .Set(s => s.DurationTime, gpsModel.DurationTime ?? "") + .Set(s => s.AccDurationTime, gpsModel.AccDurationTime ?? "") + .Set(s => s.WorkDurationTime, gpsModel.WorkDurationTime ?? "") + .Set(s => s.Address, gpsModel.Address) + .Set(s => s.GpsMode, gpsModel.GpsMode) + .Set(s => s.ModifiedTime, now); + + if (gpsModel.Acc != -1) //车辆未定位时更新Acc状态 + update = update.Set(s => s.Acc, gpsModel.Acc); + if (gpsModel.Work != -1) //车辆未定位时更新作业状态 + update = update.Set(s => s.Work, gpsModel.Work); + if (gpsModel.GpsTime.Year > 2000) + update = update.Set(s => s.GpsTime, now).Set(s => s.RecTime, now); + + var isSuccess = RepositoryContext.Server.UpdateOne(filter, update, GpsRealTimeTableName); + if (!isSuccess) + Log.InfoFormat( + "UpdateGpsRealTimeGpsStateWrt失败:VehicleId={0},GpsState={1},GpsTime、RecTime、ModifiedTime={2:yyyy-MM-dd HH:mm:ss},DurationTime={3},AccDurationTime={4}", + gpsModel.VehicleId, gpsModel.GpsState, now, gpsModel.DurationTime, + gpsModel.AccDurationTime); + return isSuccess; + } + + /// + /// 新增Acc持续时长记录 + /// + public static bool AddGpsCarStatusDuration(GpsCarStatusDurationModel model) + { + try + { + return RepositoryContext.Server.InsertOne(model, GpsCarStatusDurationTableName); + } + catch (Exception ex) + { + Log.ErrorFormat( + "AddGpsCarStatusDuration=报错=,ex.Message={0},ex.InnerException={1},ex.StackTrace={2}", + ex.Message, ex.InnerException, ex.StackTrace); + return false; + } + } + + + /// + /// 新增Acc持续时长记录 + /// + public static bool AddGpsTime(GpsRealTimeModel model) + { + + try + { + return RepositoryContext.Server.InsertOne(model, GpsRealTimeTableName); + } + catch (Exception ex) + { + Log.ErrorFormat( + "AddGpsTime=报错=,ex.Message={0},ex.InnerException={1},ex.StackTrace={2}", + ex.Message, ex.InnerException, ex.StackTrace); + return false; + } + } + + + + + } +} diff --git a/Toogps.PGProject.Repository.Mongo/Properties/AssemblyInfo.cs b/Toogps.PGProject.Repository.Mongo/Properties/AssemblyInfo.cs new file mode 100644 index 0000000..9a86910 --- /dev/null +++ b/Toogps.PGProject.Repository.Mongo/Properties/AssemblyInfo.cs @@ -0,0 +1,36 @@ +using System.Reflection; +using System.Runtime.CompilerServices; +using System.Runtime.InteropServices; + +// 有关程序集的常规信息通过以下 +// 特性集控制。更改这些特性值可修改 +// 与程序集关联的信息。 +[assembly: AssemblyTitle("Toogps.PGProject.Repository.Mongo")] +[assembly: AssemblyDescription("")] +[assembly: AssemblyConfiguration("")] +[assembly: AssemblyCompany("Microsoft")] +[assembly: AssemblyProduct("Toogps.PGProject.Repository.Mongo")] +[assembly: AssemblyCopyright("Copyright © Microsoft 2016")] +[assembly: AssemblyTrademark("")] +[assembly: AssemblyCulture("")] + +// 将 ComVisible 设置为 false 使此程序集中的类型 +// 对 COM 组件不可见。如果需要从 COM 访问此程序集中的类型, +// 则将该类型上的 ComVisible 特性设置为 true。 +[assembly: ComVisible(false)] + +// 如果此项目向 COM 公开,则下列 GUID 用于类型库的 ID +[assembly: Guid("dac66d1b-db4a-41a6-a638-21aa79d521fa")] + +// 程序集的版本信息由下面四个值组成: +// +// 主版本 +// 次版本 +// 生成号 +// 修订号 +// +// 可以指定所有这些值,也可以使用“生成号”和“修订号”的默认值, +// 方法是按如下所示使用“*”: +// [assembly: AssemblyVersion("1.0.*")] +[assembly: AssemblyVersion("1.0.0.0")] +[assembly: AssemblyFileVersion("1.0.0.0")] diff --git a/Toogps.PGProject.Repository.Mongo/RepositoryContext.cs b/Toogps.PGProject.Repository.Mongo/RepositoryContext.cs new file mode 100644 index 0000000..d46ae68 --- /dev/null +++ b/Toogps.PGProject.Repository.Mongo/RepositoryContext.cs @@ -0,0 +1,19 @@ +namespace Toogps.Mongo.Repository +{ + public class RepositoryContext + { + private static MongoServer _mongoServer; + //一般人是不会看到这里的:一条GPS的记录,占用磁盘空间大约是:77.231Byte。 + public static MongoServer Server + { + get + { + if (_mongoServer == null) + { + return _mongoServer = new MongoServer(); + } + return _mongoServer; + } + } + } +} \ No newline at end of file diff --git a/Toogps.PGProject.Repository.Mongo/Toogps.Mongo.Repository.csproj b/Toogps.PGProject.Repository.Mongo/Toogps.Mongo.Repository.csproj new file mode 100644 index 0000000..91ac965 --- /dev/null +++ b/Toogps.PGProject.Repository.Mongo/Toogps.Mongo.Repository.csproj @@ -0,0 +1,90 @@ + + + + + Debug + AnyCPU + {AA9C8C9B-D724-48CB-9E6E-400B456ADA5A} + Library + Properties + Toogps.Mongo.Repository + Toogps.Mongo.Repository + v4.7.2 + 512 + + + + true + full + false + bin\Debug\ + DEBUG;TRACE + prompt + 4 + + + pdbonly + true + bin\Release\ + TRACE + prompt + 4 + + + + False + ..\lib\log4net.dll + + + ..\packages\MongoDB.Bson.2.2.4\lib\net45\MongoDB.Bson.dll + + + ..\packages\MongoDB.Driver.2.2.4\lib\net45\MongoDB.Driver.dll + + + ..\packages\MongoDB.Driver.Core.2.2.4\lib\net45\MongoDB.Driver.Core.dll + + + False + ..\..\..\..\003JobPGCommon\PGCommon\lib\Newtonsoft.Json.dll + + + + + + + + + + + + + + + + + + + + + + + + + {275fe3f1-11a3-46f5-8320-493926113c9e} + GpsModels + + + {92893153-c7f1-42df-8002-b7ae94829db6} + Toogps.Mongo + + + + + \ No newline at end of file diff --git a/Toogps.PGProject.Repository.Mongo/app.config b/Toogps.PGProject.Repository.Mongo/app.config new file mode 100644 index 0000000..6fba752 --- /dev/null +++ b/Toogps.PGProject.Repository.Mongo/app.config @@ -0,0 +1,11 @@ + + + + + + + + + + + diff --git a/Toogps.PGProject.Repository.Mongo/packages.config b/Toogps.PGProject.Repository.Mongo/packages.config new file mode 100644 index 0000000..0d8ab1c --- /dev/null +++ b/Toogps.PGProject.Repository.Mongo/packages.config @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/lib/HPSocket4C_U.dll b/lib/HPSocket4C_U.dll new file mode 100644 index 0000000..b6984df Binary files /dev/null and b/lib/HPSocket4C_U.dll differ diff --git a/lib/MongoDB.Bson.dll b/lib/MongoDB.Bson.dll new file mode 100644 index 0000000..687411c Binary files /dev/null and b/lib/MongoDB.Bson.dll differ diff --git a/lib/MongoDB.Driver.Core.dll b/lib/MongoDB.Driver.Core.dll new file mode 100644 index 0000000..035d66c Binary files /dev/null and b/lib/MongoDB.Driver.Core.dll differ diff --git a/lib/MongoDB.Driver.dll b/lib/MongoDB.Driver.dll new file mode 100644 index 0000000..dee857b Binary files /dev/null and b/lib/MongoDB.Driver.dll differ diff --git a/lib/Newtonsoft.Json.dll b/lib/Newtonsoft.Json.dll new file mode 100644 index 0000000..be6558d Binary files /dev/null and b/lib/Newtonsoft.Json.dll differ diff --git a/lib/Newtonsoft.Json.xml b/lib/Newtonsoft.Json.xml new file mode 100644 index 0000000..c719433 --- /dev/null +++ b/lib/Newtonsoft.Json.xml @@ -0,0 +1,9229 @@ + + + + Newtonsoft.Json + + + + + Represents a BSON Oid (object id). + + + + + Gets or sets the value of the Oid. + + The value of the Oid. + + + + Initializes a new instance of the class. + + The Oid value. + + + + Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. + + + + + Gets or sets a value indicating whether binary data reading should compatible with incorrect Json.NET 3.5 written binary. + + + true if binary data reading will be compatible with incorrect Json.NET 3.5 written binary; otherwise, false. + + + + + Gets or sets a value indicating whether the root object will be read as a JSON array. + + + true if the root object will be read as a JSON array; otherwise, false. + + + + + Gets or sets the used when reading values from BSON. + + The used when reading values from BSON. + + + + Initializes a new instance of the class. + + The stream. + + + + Initializes a new instance of the class. + + The reader. + + + + Initializes a new instance of the class. + + The stream. + if set to true the root object will be read as a JSON array. + The used when reading values from BSON. + + + + Initializes a new instance of the class. + + The reader. + if set to true the root object will be read as a JSON array. + The used when reading values from BSON. + + + + Reads the next JSON token from the stream. + + + true if the next token was read successfully; false if there are no more tokens to read. + + + + + Changes the to Closed. + + + + + Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. + + + + + Gets or sets the used when writing values to BSON. + When set to no conversion will occur. + + The used when writing values to BSON. + + + + Initializes a new instance of the class. + + The stream. + + + + Initializes a new instance of the class. + + The writer. + + + + Flushes whatever is in the buffer to the underlying streams and also flushes the underlying stream. + + + + + Writes the end. + + The token. + + + + Writes out a comment /*...*/ containing the specified text. + + Text to place inside the comment. + + + + Writes the start of a constructor with the given name. + + The name of the constructor. + + + + Writes raw JSON. + + The raw JSON to write. + + + + Writes raw JSON where a value is expected and updates the writer's state. + + The raw JSON to write. + + + + Writes the beginning of a JSON array. + + + + + Writes the beginning of a JSON object. + + + + + Writes the property name of a name/value pair on a JSON object. + + The name of the property. + + + + Closes this stream and the underlying stream. + + + + + Writes a value. + An error will raised if the value cannot be written as a single JSON token. + + The value to write. + + + + Writes a null value. + + + + + Writes an undefined value. + + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a [] value. + + The [] value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a [] value that represents a BSON object id. + + The Object ID value to write. + + + + Writes a BSON regex. + + The regex pattern. + The regex options. + + + + Specifies how constructors are used when initializing objects during deserialization by the . + + + + + First attempt to use the public default constructor, then fall back to single parameterized constructor, then the non-public default constructor. + + + + + Json.NET will use a non-public default constructor before falling back to a parameterized constructor. + + + + + Converts a binary value to and from a base 64 string value. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts a to and from JSON and BSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Create a custom object + + The object type to convert. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Creates an object which will then be populated by the serializer. + + Type of the object. + The created object. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Gets a value indicating whether this can write JSON. + + + true if this can write JSON; otherwise, false. + + + + + Converts a to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified value type. + + Type of the value. + + true if this instance can convert the specified value type; otherwise, false. + + + + + Converts a to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified value type. + + Type of the value. + + true if this instance can convert the specified value type; otherwise, false. + + + + + Provides a base class for converting a to and from JSON. + + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts a F# discriminated union type to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts an Entity Framework EntityKey to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts an ExpandoObject to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Gets a value indicating whether this can write JSON. + + + true if this can write JSON; otherwise, false. + + + + + Converts a to and from the ISO 8601 date format (e.g. 2008-04-12T12:53Z). + + + + + Gets or sets the date time styles used when converting a date to and from JSON. + + The date time styles used when converting a date to and from JSON. + + + + Gets or sets the date time format used when converting a date to and from JSON. + + The date time format used when converting a date to and from JSON. + + + + Gets or sets the culture used when converting a date to and from JSON. + + The culture used when converting a date to and from JSON. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Converts a to and from a JavaScript date constructor (e.g. new Date(52231943)). + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing property value of the JSON that is being converted. + The calling serializer. + The object value. + + + + Converts a to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts a to and from JSON and BSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts an to and from its name string value. + + + + + Gets or sets a value indicating whether the written enum text should be camel case. + + true if the written enum text will be camel case; otherwise, false. + + + + Gets or sets a value indicating whether integer values are allowed. + + true if integers are allowed; otherwise, false. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + true if the written enum text will be camel case; otherwise, false. + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts a to and from a string (e.g. "1.2.3.4"). + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing property value of the JSON that is being converted. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + Converts XML to and from JSON. + + + + + Gets or sets the name of the root element to insert when deserializing to XML if the JSON structure has produces multiple root elements. + + The name of the deserialize root element. + + + + Gets or sets a flag to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + true if the array attibute is written to the XML; otherwise, false. + + + + Gets or sets a value indicating whether to write the root JSON object. + + true if the JSON root object is omitted; otherwise, false. + + + + Writes the JSON representation of the object. + + The to write to. + The calling serializer. + The value. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Checks if the attributeName is a namespace attribute. + + Attribute name to test. + The attribute name prefix if it has one, otherwise an empty string. + true if attribute name is for a namespace attribute, otherwise false. + + + + Determines whether this instance can convert the specified value type. + + Type of the value. + + true if this instance can convert the specified value type; otherwise, false. + + + + + Specifies how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + + + + + Floating point numbers are parsed to . + + + + + Floating point numbers are parsed to . + + + + + Specifies how dates are formatted when writing JSON text. + + + + + Dates are written in the ISO 8601 format, e.g. "2012-03-21T05:40Z". + + + + + Dates are written in the Microsoft JSON format, e.g. "\/Date(1198908717056)\/". + + + + + Specifies how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON text. + + + + + Date formatted strings are not parsed to a date type and are read as strings. + + + + + Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . + + + + + Date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed to . + + + + + Specifies how to treat the time value when converting between string and . + + + + + Treat as local time. If the object represents a Coordinated Universal Time (UTC), it is converted to the local time. + + + + + Treat as a UTC. If the object represents a local time, it is converted to a UTC. + + + + + Treat as a local time if a is being converted to a string. + If a string is being converted to , convert to a local time if a time zone is specified. + + + + + Time zone information should be preserved when converting. + + + + + Specifies default value handling options for the . + + + + + + + + + Include members where the member value is the same as the member's default value when serializing objects. + Included members are written to JSON. Has no effect when deserializing. + + + + + Ignore members where the member value is the same as the member's default value when serializing objects + so that is is not written to JSON. + This option will ignore all default values (e.g. null for objects and nullable types; 0 for integers, + decimals and floating point numbers; and false for booleans). The default value ignored can be changed by + placing the on the property. + + + + + Members with a default value but no JSON will be set to their default value when deserializing. + + + + + Ignore members where the member value is the same as the member's default value when serializing objects + and sets members to their default value when deserializing. + + + + + Specifies float format handling options when writing special floating point numbers, e.g. , + and with . + + + + + Write special floating point values as strings in JSON, e.g. "NaN", "Infinity", "-Infinity". + + + + + Write special floating point values as symbols in JSON, e.g. NaN, Infinity, -Infinity. + Note that this will produce non-valid JSON. + + + + + Write special floating point values as the property's default value in JSON, e.g. 0.0 for a property, null for a property. + + + + + Specifies formatting options for the . + + + + + No special formatting is applied. This is the default. + + + + + Causes child objects to be indented according to the and settings. + + + + + Provides an interface for using pooled arrays. + + The array type content. + + + + Rent a array from the pool. This array must be returned when it is no longer needed. + + The minimum required length of the array. The returned array may be longer. + The rented array from the pool. This array must be returned when it is no longer needed. + + + + Return an array to the pool. + + The array that is being returned. + + + + Provides an interface to enable a class to return line and position information. + + + + + Gets a value indicating whether the class can return line information. + + + true if LineNumber and LinePosition can be provided; otherwise, false. + + + + + Gets the current line number. + + The current line number or 0 if no line information is available (for example, HasLineInfo returns false). + + + + Gets the current line position. + + The current line position or 0 if no line information is available (for example, HasLineInfo returns false). + + + + Instructs the how to serialize the collection. + + + + + Gets or sets a value indicating whether null items are allowed in the collection. + + true if null items are allowed in the collection; otherwise, false. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with a flag indicating whether the array can contain null items + + A flag indicating whether the array can contain null items. + + + + Initializes a new instance of the class with the specified container Id. + + The container Id. + + + + Instructs the to use the specified constructor when deserializing that object. + + + + + Instructs the how to serialize the object. + + + + + Gets or sets the id. + + The id. + + + + Gets or sets the title. + + The title. + + + + Gets or sets the description. + + The description. + + + + Gets or sets the collection's items converter. + + The collection's items converter. + + + + The parameter list to use when constructing the described by ItemConverterType. + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + [JsonContainer(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] + + + + + Gets or sets the of the . + + The of the . + + + + The parameter list to use when constructing the described by NamingStrategyType. + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + [JsonContainer(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] + + + + + Gets or sets a value that indicates whether to preserve object references. + + + true to keep object reference; otherwise, false. The default is false. + + + + + Gets or sets a value that indicates whether to preserve collection's items references. + + + true to keep collection's items object references; otherwise, false. The default is false. + + + + + Gets or sets the reference loop handling used when serializing the collection's items. + + The reference loop handling. + + + + Gets or sets the type name handling used when serializing the collection's items. + + The type name handling. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified container Id. + + The container Id. + + + + Provides methods for converting between common language runtime types and JSON types. + + + + + + + + Gets or sets a function that creates default . + Default settings are automatically used by serialization methods on , + and and on . + To serialize without using any default settings create a with + . + + + + + Represents JavaScript's boolean value true as a string. This field is read-only. + + + + + Represents JavaScript's boolean value false as a string. This field is read-only. + + + + + Represents JavaScript's null as a string. This field is read-only. + + + + + Represents JavaScript's undefined as a string. This field is read-only. + + + + + Represents JavaScript's positive infinity as a string. This field is read-only. + + + + + Represents JavaScript's negative infinity as a string. This field is read-only. + + + + + Represents JavaScript's NaN as a string. This field is read-only. + + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation using the specified. + + The value to convert. + The format the date will be converted to. + The time zone handling when the date is converted to a string. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation using the specified. + + The value to convert. + The format the date will be converted to. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + The string delimiter character. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + The string delimiter character. + The string escape handling. + A JSON string representation of the . + + + + Converts the to its JSON string representation. + + The value to convert. + A JSON string representation of the . + + + + Serializes the specified object to a JSON string. + + The object to serialize. + A JSON string representation of the object. + + + + Serializes the specified object to a JSON string using formatting. + + The object to serialize. + Indicates how the output is formatted. + + A JSON string representation of the object. + + + + + Serializes the specified object to a JSON string using a collection of . + + The object to serialize. + A collection converters used while serializing. + A JSON string representation of the object. + + + + Serializes the specified object to a JSON string using formatting and a collection of . + + The object to serialize. + Indicates how the output is formatted. + A collection converters used while serializing. + A JSON string representation of the object. + + + + Serializes the specified object to a JSON string using . + + The object to serialize. + The used to serialize the object. + If this is null, default serialization settings will be used. + + A JSON string representation of the object. + + + + + Serializes the specified object to a JSON string using a type, formatting and . + + The object to serialize. + The used to serialize the object. + If this is null, default serialization settings will be used. + + The type of the value being serialized. + This parameter is used when is Auto to write out the type name if the type of the value does not match. + Specifing the type is optional. + + + A JSON string representation of the object. + + + + + Serializes the specified object to a JSON string using formatting and . + + The object to serialize. + Indicates how the output is formatted. + The used to serialize the object. + If this is null, default serialization settings will be used. + + A JSON string representation of the object. + + + + + Serializes the specified object to a JSON string using a type, formatting and . + + The object to serialize. + Indicates how the output is formatted. + The used to serialize the object. + If this is null, default serialization settings will be used. + + The type of the value being serialized. + This parameter is used when is Auto to write out the type name if the type of the value does not match. + Specifing the type is optional. + + + A JSON string representation of the object. + + + + + Asynchronously serializes the specified object to a JSON string. + Serialization will happen on a new thread. + + The object to serialize. + + A task that represents the asynchronous serialize operation. The value of the TResult parameter contains a JSON string representation of the object. + + + + + Asynchronously serializes the specified object to a JSON string using formatting. + Serialization will happen on a new thread. + + The object to serialize. + Indicates how the output is formatted. + + A task that represents the asynchronous serialize operation. The value of the TResult parameter contains a JSON string representation of the object. + + + + + Asynchronously serializes the specified object to a JSON string using formatting and a collection of . + Serialization will happen on a new thread. + + The object to serialize. + Indicates how the output is formatted. + The used to serialize the object. + If this is null, default serialization settings will be used. + + A task that represents the asynchronous serialize operation. The value of the TResult parameter contains a JSON string representation of the object. + + + + + Deserializes the JSON to a .NET object. + + The JSON to deserialize. + The deserialized object from the JSON string. + + + + Deserializes the JSON to a .NET object using . + + The JSON to deserialize. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type. + + The JSON to deserialize. + The of object being deserialized. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type. + + The type of the object to deserialize to. + The JSON to deserialize. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the given anonymous type. + + + The anonymous type to deserialize to. This can't be specified + traditionally and must be infered from the anonymous type passed + as a parameter. + + The JSON to deserialize. + The anonymous type object. + The deserialized anonymous type from the JSON string. + + + + Deserializes the JSON to the given anonymous type using . + + + The anonymous type to deserialize to. This can't be specified + traditionally and must be infered from the anonymous type passed + as a parameter. + + The JSON to deserialize. + The anonymous type object. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized anonymous type from the JSON string. + + + + Deserializes the JSON to the specified .NET type using a collection of . + + The type of the object to deserialize to. + The JSON to deserialize. + Converters to use while deserializing. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type using . + + The type of the object to deserialize to. + The object to deserialize. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type using a collection of . + + The JSON to deserialize. + The type of the object to deserialize. + Converters to use while deserializing. + The deserialized object from the JSON string. + + + + Deserializes the JSON to the specified .NET type using . + + The JSON to deserialize. + The type of the object to deserialize to. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + The deserialized object from the JSON string. + + + + Asynchronously deserializes the JSON to the specified .NET type. + Deserialization will happen on a new thread. + + The type of the object to deserialize to. + The JSON to deserialize. + + A task that represents the asynchronous deserialize operation. The value of the TResult parameter contains the deserialized object from the JSON string. + + + + + Asynchronously deserializes the JSON to the specified .NET type using . + Deserialization will happen on a new thread. + + The type of the object to deserialize to. + The JSON to deserialize. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + + A task that represents the asynchronous deserialize operation. The value of the TResult parameter contains the deserialized object from the JSON string. + + + + + Asynchronously deserializes the JSON to the specified .NET type. + Deserialization will happen on a new thread. + + The JSON to deserialize. + + A task that represents the asynchronous deserialize operation. The value of the TResult parameter contains the deserialized object from the JSON string. + + + + + Asynchronously deserializes the JSON to the specified .NET type using . + Deserialization will happen on a new thread. + + The JSON to deserialize. + The type of the object to deserialize to. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + + A task that represents the asynchronous deserialize operation. The value of the TResult parameter contains the deserialized object from the JSON string. + + + + + Populates the object with values from the JSON string. + + The JSON to populate values from. + The target object to populate values onto. + + + + Populates the object with values from the JSON string using . + + The JSON to populate values from. + The target object to populate values onto. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + + + + Asynchronously populates the object with values from the JSON string using . + + The JSON to populate values from. + The target object to populate values onto. + + The used to deserialize the object. + If this is null, default serialization settings will be used. + + + A task that represents the asynchronous populate operation. + + + + + Serializes the XML node to a JSON string. + + The node to serialize. + A JSON string of the XmlNode. + + + + Serializes the XML node to a JSON string using formatting. + + The node to serialize. + Indicates how the output is formatted. + A JSON string of the XmlNode. + + + + Serializes the XML node to a JSON string using formatting and omits the root object if is true. + + The node to serialize. + Indicates how the output is formatted. + Omits writing the root object. + A JSON string of the XmlNode. + + + + Deserializes the XmlNode from a JSON string. + + The JSON string. + The deserialized XmlNode + + + + Deserializes the XmlNode from a JSON string nested in a root elment specified by . + + The JSON string. + The name of the root element to append when deserializing. + The deserialized XmlNode + + + + Deserializes the XmlNode from a JSON string nested in a root elment specified by + and writes a .NET array attribute for collections. + + The JSON string. + The name of the root element to append when deserializing. + + A flag to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + The deserialized XmlNode + + + + Serializes the to a JSON string. + + The node to convert to JSON. + A JSON string of the XNode. + + + + Serializes the to a JSON string using formatting. + + The node to convert to JSON. + Indicates how the output is formatted. + A JSON string of the XNode. + + + + Serializes the to a JSON string using formatting and omits the root object if is true. + + The node to serialize. + Indicates how the output is formatted. + Omits writing the root object. + A JSON string of the XNode. + + + + Deserializes the from a JSON string. + + The JSON string. + The deserialized XNode + + + + Deserializes the from a JSON string nested in a root elment specified by . + + The JSON string. + The name of the root element to append when deserializing. + The deserialized XNode + + + + Deserializes the from a JSON string nested in a root elment specified by + and writes a .NET array attribute for collections. + + The JSON string. + The name of the root element to append when deserializing. + + A flag to indicate whether to write the Json.NET array attribute. + This attribute helps preserve arrays when converting the written XML back to JSON. + + The deserialized XNode + + + + Converts an object to and from JSON. + + + + + Writes the JSON representation of the object. + + The to write to. + The value. + The calling serializer. + + + + Reads the JSON representation of the object. + + The to read from. + Type of the object. + The existing value of object being read. + The calling serializer. + The object value. + + + + Determines whether this instance can convert the specified object type. + + Type of the object. + + true if this instance can convert the specified object type; otherwise, false. + + + + + + Gets the of the JSON produced by the JsonConverter. + + + JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. + + + The of the JSON produced by the JsonConverter. + + + + Gets a value indicating whether this can read JSON. + + true if this can read JSON; otherwise, false. + + + + Gets a value indicating whether this can write JSON. + + true if this can write JSON; otherwise, false. + + + + Instructs the to use the specified when serializing the member or class. + + + + + Gets the of the . + + The of the . + + + + The parameter list to use when constructing the described by ConverterType. + If null, the default constructor is used. + + + + + Initializes a new instance of the class. + + Type of the . + + + + Initializes a new instance of the class. + + Type of the . + Parameter list to use when constructing the . Can be null. + + + + Represents a collection of . + + + + + Instructs the how to serialize the collection. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified container Id. + + The container Id. + + + + The exception thrown when an error occurs during JSON serialization or deserialization. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + Instructs the to deserialize properties with no matching class member into the specified collection + and write values during serialization. + + + + + Gets or sets a value that indicates whether to write extension data when serializing the object. + + + true to write extension data when serializing the object; otherwise, false. The default is true. + + + + + Gets or sets a value that indicates whether to read extension data when deserializing the object. + + + true to read extension data when deserializing the object; otherwise, false. The default is true. + + + + + Initializes a new instance of the class. + + + + + Instructs the not to serialize the public field or public read/write property value. + + + + + Instructs the how to serialize the object. + + + + + Gets or sets the member serialization. + + The member serialization. + + + + Gets or sets a value that indicates whether the object's properties are required. + + + A value indicating whether the object's properties are required. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified member serialization. + + The member serialization. + + + + Initializes a new instance of the class with the specified container Id. + + The container Id. + + + + Instructs the to always serialize the member with the specified name. + + + + + Gets or sets the used when serializing the property's collection items. + + The collection's items . + + + + The parameter list to use when constructing the described by ItemConverterType. + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + [JsonProperty(ItemConverterType = typeof(MyContainerConverter), ItemConverterParameters = new object[] { 123, "Four" })] + + + + + Gets or sets the of the . + + The of the . + + + + The parameter list to use when constructing the described by NamingStrategyType. + If null, the default constructor is used. + When non-null, there must be a constructor defined in the that exactly matches the number, + order, and type of these parameters. + + + [JsonProperty(NamingStrategyType = typeof(MyNamingStrategy), NamingStrategyParameters = new object[] { 123, "Four" })] + + + + + Gets or sets the null value handling used when serializing this property. + + The null value handling. + + + + Gets or sets the default value handling used when serializing this property. + + The default value handling. + + + + Gets or sets the reference loop handling used when serializing this property. + + The reference loop handling. + + + + Gets or sets the object creation handling used when deserializing this property. + + The object creation handling. + + + + Gets or sets the type name handling used when serializing this property. + + The type name handling. + + + + Gets or sets whether this property's value is serialized as a reference. + + Whether this property's value is serialized as a reference. + + + + Gets or sets the order of serialization of a member. + + The numeric order of serialization. + + + + Gets or sets a value indicating whether this property is required. + + + A value indicating whether this property is required. + + + + + Gets or sets the name of the property. + + The name of the property. + + + + Gets or sets the the reference loop handling used when serializing the property's collection items. + + The collection's items reference loop handling. + + + + Gets or sets the the type name handling used when serializing the property's collection items. + + The collection's items type name handling. + + + + Gets or sets whether this property's collection items are serialized as a reference. + + Whether this property's collection items are serialized as a reference. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class with the specified name. + + Name of the property. + + + + Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. + + + + + Specifies the state of the reader. + + + + + The Read method has not been called. + + + + + The end of the file has been reached successfully. + + + + + Reader is at a property. + + + + + Reader is at the start of an object. + + + + + Reader is in an object. + + + + + Reader is at the start of an array. + + + + + Reader is in an array. + + + + + The Close method has been called. + + + + + Reader has just read a value. + + + + + Reader is at the start of a constructor. + + + + + Reader in a constructor. + + + + + An error occurred that prevents the read operation from continuing. + + + + + The end of the file has been reached successfully. + + + + + Gets the current reader state. + + The current reader state. + + + + Gets or sets a value indicating whether the underlying stream or + should be closed when the reader is closed. + + + true to close the underlying stream or when + the reader is closed; otherwise false. The default is true. + + + + + Gets or sets a value indicating whether multiple pieces of JSON content can + be read from a continuous stream without erroring. + + + true to support reading multiple pieces of JSON content; otherwise false. The default is false. + + + + + Gets the quotation mark character used to enclose the value of a string. + + + + + Get or set how time zones are handling when reading JSON. + + + + + Get or set how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. + + + + + Get or set how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + + + + + Get or set how custom date formatted strings are parsed when reading JSON. + + + + + Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . + + + + + Gets the type of the current JSON token. + + + + + Gets the text value of the current JSON token. + + + + + Gets The Common Language Runtime (CLR) type for the current JSON token. + + + + + Gets the depth of the current token in the JSON document. + + The depth of the current token in the JSON document. + + + + Gets the path of the current JSON token. + + + + + Gets or sets the culture used when reading JSON. Defaults to . + + + + + Initializes a new instance of the class with the specified . + + + + + Reads the next JSON token from the stream. + + true if the next token was read successfully; false if there are no more tokens to read. + + + + Reads the next JSON token from the stream as a . + + A . This method will return null at the end of an array. + + + + Reads the next JSON token from the stream as a . + + A . This method will return null at the end of an array. + + + + Reads the next JSON token from the stream as a []. + + A [] or a null reference if the next JSON token is null. This method will return null at the end of an array. + + + + Reads the next JSON token from the stream as a . + + A . This method will return null at the end of an array. + + + + Reads the next JSON token from the stream as a . + + A . This method will return null at the end of an array. + + + + Reads the next JSON token from the stream as a . + + A . This method will return null at the end of an array. + + + + Reads the next JSON token from the stream as a . + + A . This method will return null at the end of an array. + + + + Reads the next JSON token from the stream as a . + + A . This method will return null at the end of an array. + + + + Skips the children of the current token. + + + + + Sets the current token. + + The new token. + + + + Sets the current token and value. + + The new token. + The value. + + + + Sets the state based on current token type. + + + + + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + + + + + Releases unmanaged and - optionally - managed resources + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Changes the to Closed. + + + + + The exception thrown when an error occurs while reading JSON text. + + + + + Gets the line number indicating where the error occurred. + + The line number indicating where the error occurred. + + + + Gets the line position indicating where the error occurred. + + The line position indicating where the error occurred. + + + + Gets the path to the JSON where the error occurred. + + The path to the JSON where the error occurred. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + Instructs the to always serialize the member, and require the member has a value. + + + + + The exception thrown when an error occurs during JSON serialization or deserialization. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + Serializes and deserializes objects into and from the JSON format. + The enables you to control how objects are encoded into JSON. + + + + + Occurs when the errors during serialization and deserialization. + + + + + Gets or sets the used by the serializer when resolving references. + + + + + Gets or sets the used by the serializer when resolving type names. + + + + + Gets or sets the used by the serializer when writing trace messages. + + The trace writer. + + + + Gets or sets the equality comparer used by the serializer when comparing references. + + The equality comparer. + + + + Gets or sets how type name writing and reading is handled by the serializer. + + + should be used with caution when your application deserializes JSON from an external source. + Incoming types should be validated with a custom + when deserializing with a value other than TypeNameHandling.None. + + + + + Gets or sets how a type name assembly is written and resolved by the serializer. + + The type name assembly format. + + + + Gets or sets how object references are preserved by the serializer. + + + + + Get or set how reference loops (e.g. a class referencing itself) is handled. + + + + + Get or set how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. + + + + + Get or set how null values are handled during serialization and deserialization. + + + + + Get or set how null default are handled during serialization and deserialization. + + + + + Gets or sets how objects are created during deserialization. + + The object creation handling. + + + + Gets or sets how constructors are used during deserialization. + + The constructor handling. + + + + Gets or sets how metadata properties are used during deserialization. + + The metadata properties handling. + + + + Gets a collection that will be used during serialization. + + Collection that will be used during serialization. + + + + Gets or sets the contract resolver used by the serializer when + serializing .NET objects to JSON and vice versa. + + + + + Gets or sets the used by the serializer when invoking serialization callback methods. + + The context. + + + + Indicates how JSON text output is formatted. + + + + + Get or set how dates are written to JSON text. + + + + + Get or set how time zones are handling during serialization and deserialization. + + + + + Get or set how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. + + + + + Get or set how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + + + + + Get or set how special floating point numbers, e.g. , + and , + are written as JSON text. + + + + + Get or set how strings are escaped when writing JSON text. + + + + + Get or set how and values are formatted when writing JSON text, and the expected date format when reading JSON text. + + + + + Gets or sets the culture used when reading JSON. Defaults to . + + + + + Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . + + + + + Gets a value indicating whether there will be a check for additional JSON content after deserializing an object. + + + true if there will be a check for additional JSON content after deserializing an object; otherwise, false. + + + + + Initializes a new instance of the class. + + + + + Creates a new instance. + The will not use default settings + from . + + + A new instance. + The will not use default settings + from . + + + + + Creates a new instance using the specified . + The will not use default settings + from . + + The settings to be applied to the . + + A new instance using the specified . + The will not use default settings + from . + + + + + Creates a new instance. + The will use default settings + from . + + + A new instance. + The will use default settings + from . + + + + + Creates a new instance using the specified . + The will use default settings + from as well as the specified . + + The settings to be applied to the . + + A new instance using the specified . + The will use default settings + from as well as the specified . + + + + + Populates the JSON values onto the target object. + + The that contains the JSON structure to reader values from. + The target object to populate values onto. + + + + Populates the JSON values onto the target object. + + The that contains the JSON structure to reader values from. + The target object to populate values onto. + + + + Deserializes the JSON structure contained by the specified . + + The that contains the JSON structure to deserialize. + The being deserialized. + + + + Deserializes the JSON structure contained by the specified + into an instance of the specified type. + + The containing the object. + The of object being deserialized. + The instance of being deserialized. + + + + Deserializes the JSON structure contained by the specified + into an instance of the specified type. + + The containing the object. + The type of the object to deserialize. + The instance of being deserialized. + + + + Deserializes the JSON structure contained by the specified + into an instance of the specified type. + + The containing the object. + The of object being deserialized. + The instance of being deserialized. + + + + Serializes the specified and writes the JSON structure + to a Stream using the specified . + + The used to write the JSON structure. + The to serialize. + + + + Serializes the specified and writes the JSON structure + to a Stream using the specified . + + The used to write the JSON structure. + The to serialize. + + The type of the value being serialized. + This parameter is used when is Auto to write out the type name if the type of the value does not match. + Specifing the type is optional. + + + + + Serializes the specified and writes the JSON structure + to a Stream using the specified . + + The used to write the JSON structure. + The to serialize. + + The type of the value being serialized. + This parameter is used when is Auto to write out the type name if the type of the value does not match. + Specifing the type is optional. + + + + + Serializes the specified and writes the JSON structure + to a Stream using the specified . + + The used to write the JSON structure. + The to serialize. + + + + Specifies the settings on a object. + + + + + Gets or sets how reference loops (e.g. a class referencing itself) is handled. + + Reference loop handling. + + + + Gets or sets how missing members (e.g. JSON contains a property that isn't a member on the object) are handled during deserialization. + + Missing member handling. + + + + Gets or sets how objects are created during deserialization. + + The object creation handling. + + + + Gets or sets how null values are handled during serialization and deserialization. + + Null value handling. + + + + Gets or sets how null default are handled during serialization and deserialization. + + The default value handling. + + + + Gets or sets a collection that will be used during serialization. + + The converters. + + + + Gets or sets how object references are preserved by the serializer. + + The preserve references handling. + + + + Gets or sets how type name writing and reading is handled by the serializer. + + + should be used with caution when your application deserializes JSON from an external source. + Incoming types should be validated with a custom + when deserializing with a value other than TypeNameHandling.None. + + The type name handling. + + + + Gets or sets how metadata properties are used during deserialization. + + The metadata properties handling. + + + + Gets or sets how a type name assembly is written and resolved by the serializer. + + The type name assembly format. + + + + Gets or sets how constructors are used during deserialization. + + The constructor handling. + + + + Gets or sets the contract resolver used by the serializer when + serializing .NET objects to JSON and vice versa. + + The contract resolver. + + + + Gets or sets the equality comparer used by the serializer when comparing references. + + The equality comparer. + + + + Gets or sets the used by the serializer when resolving references. + + The reference resolver. + + + + Gets or sets a function that creates the used by the serializer when resolving references. + + A function that creates the used by the serializer when resolving references. + + + + Gets or sets the used by the serializer when writing trace messages. + + The trace writer. + + + + Gets or sets the used by the serializer when resolving type names. + + The binder. + + + + Gets or sets the error handler called during serialization and deserialization. + + The error handler called during serialization and deserialization. + + + + Gets or sets the used by the serializer when invoking serialization callback methods. + + The context. + + + + Get or set how and values are formatted when writing JSON text, and the expected date format when reading JSON text. + + + + + Gets or sets the maximum depth allowed when reading JSON. Reading past this depth will throw a . + + + + + Indicates how JSON text output is formatted. + + + + + Get or set how dates are written to JSON text. + + + + + Get or set how time zones are handling during serialization and deserialization. + + + + + Get or set how date formatted strings, e.g. "\/Date(1198908717056)\/" and "2012-03-21T05:40Z", are parsed when reading JSON. + + + + + Get or set how special floating point numbers, e.g. , + and , + are written as JSON. + + + + + Get or set how floating point numbers, e.g. 1.0 and 9.9, are parsed when reading JSON text. + + + + + Get or set how strings are escaped when writing JSON text. + + + + + Gets or sets the culture used when reading JSON. Defaults to . + + + + + Gets a value indicating whether there will be a check for additional content after deserializing an object. + + + true if there will be a check for additional content after deserializing an object; otherwise, false. + + + + + Initializes a new instance of the class. + + + + + Represents a reader that provides fast, non-cached, forward-only access to JSON text data. + + + + + Initializes a new instance of the class with the specified . + + The TextReader containing the XML data to read. + + + + Gets or sets the reader's character buffer pool. + + + + + Reads the next JSON token from the stream. + + + true if the next token was read successfully; false if there are no more tokens to read. + + + + + Reads the next JSON token from the stream as a . + + A . This method will return null at the end of an array. + + + + Reads the next JSON token from the stream as a . + + A . This method will return null at the end of an array. + + + + Reads the next JSON token from the stream as a . + + A . This method will return null at the end of an array. + + + + Reads the next JSON token from the stream as a []. + + A [] or a null reference if the next JSON token is null. This method will return null at the end of an array. + + + + Reads the next JSON token from the stream as a . + + A . This method will return null at the end of an array. + + + + Reads the next JSON token from the stream as a . + + A . This method will return null at the end of an array. + + + + Reads the next JSON token from the stream as a . + + A . This method will return null at the end of an array. + + + + Reads the next JSON token from the stream as a . + + A . This method will return null at the end of an array. + + + + Changes the state to closed. + + + + + Gets a value indicating whether the class can return line information. + + + true if LineNumber and LinePosition can be provided; otherwise, false. + + + + + Gets the current line number. + + + The current line number or 0 if no line information is available (for example, HasLineInfo returns false). + + + + + Gets the current line position. + + + The current line position or 0 if no line information is available (for example, HasLineInfo returns false). + + + + + Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. + + + + + Gets or sets the writer's character array pool. + + + + + Gets or sets how many IndentChars to write for each level in the hierarchy when is set to Formatting.Indented. + + + + + Gets or sets which character to use to quote attribute values. + + + + + Gets or sets which character to use for indenting when is set to Formatting.Indented. + + + + + Gets or sets a value indicating whether object names will be surrounded with quotes. + + + + + Creates an instance of the JsonWriter class using the specified . + + The TextWriter to write to. + + + + Flushes whatever is in the buffer to the underlying streams and also flushes the underlying stream. + + + + + Closes this stream and the underlying stream. + + + + + Writes the beginning of a JSON object. + + + + + Writes the beginning of a JSON array. + + + + + Writes the start of a constructor with the given name. + + The name of the constructor. + + + + Writes the specified end token. + + The end token to write. + + + + Writes the property name of a name/value pair on a JSON object. + + The name of the property. + + + + Writes the property name of a name/value pair on a JSON object. + + The name of the property. + A flag to indicate whether the text should be escaped when it is written as a JSON property name. + + + + Writes indent characters. + + + + + Writes the JSON value delimiter. + + + + + Writes an indent space. + + + + + Writes a value. + An error will raised if the value cannot be written as a single JSON token. + + The value to write. + + + + Writes a null value. + + + + + Writes an undefined value. + + + + + Writes raw JSON. + + The raw JSON to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a [] value. + + The [] value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes out a comment /*...*/ containing the specified text. + + Text to place inside the comment. + + + + Writes out the given white space. + + The string of white space characters. + + + + Specifies the type of JSON token. + + + + + This is returned by the if a method has not been called. + + + + + An object start token. + + + + + An array start token. + + + + + A constructor start token. + + + + + An object property name. + + + + + A comment. + + + + + Raw JSON. + + + + + An integer. + + + + + A float. + + + + + A string. + + + + + A boolean. + + + + + A null token. + + + + + An undefined token. + + + + + An object end token. + + + + + An array end token. + + + + + A constructor end token. + + + + + A Date. + + + + + Byte data. + + + + + + Represents a reader that provides validation. + + + JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. + + + + + + Sets an event handler for receiving schema validation errors. + + + + + Gets the text value of the current JSON token. + + + + + + Gets the depth of the current token in the JSON document. + + The depth of the current token in the JSON document. + + + + Gets the path of the current JSON token. + + + + + Gets the quotation mark character used to enclose the value of a string. + + + + + + Gets the type of the current JSON token. + + + + + + Gets the Common Language Runtime (CLR) type for the current JSON token. + + + + + + Initializes a new instance of the class that + validates the content returned from the given . + + The to read from while validating. + + + + Gets or sets the schema. + + The schema. + + + + Gets the used to construct this . + + The specified in the constructor. + + + + Reads the next JSON token from the stream as a . + + A . + + + + Reads the next JSON token from the stream as a []. + + + A [] or a null reference if the next JSON token is null. + + + + + Reads the next JSON token from the stream as a . + + A . + + + + Reads the next JSON token from the stream as a . + + A . + + + + Reads the next JSON token from the stream as a . + + A . + + + + Reads the next JSON token from the stream as a . + + A . This method will return null at the end of an array. + + + + Reads the next JSON token from the stream as a . + + A . This method will return null at the end of an array. + + + + Reads the next JSON token from the stream as a . + + A . + + + + Reads the next JSON token from the stream. + + + true if the next token was read successfully; false if there are no more tokens to read. + + + + + Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. + + + + + Gets or sets a value indicating whether the underlying stream or + should be closed when the writer is closed. + + + true to close the underlying stream or when + the writer is closed; otherwise false. The default is true. + + + + + Gets the top. + + The top. + + + + Gets the state of the writer. + + + + + Gets the path of the writer. + + + + + Indicates how JSON text output is formatted. + + + + + Get or set how dates are written to JSON text. + + + + + Get or set how time zones are handling when writing JSON text. + + + + + Get or set how strings are escaped when writing JSON text. + + + + + Get or set how special floating point numbers, e.g. , + and , + are written to JSON text. + + + + + Get or set how and values are formatting when writing JSON text. + + + + + Gets or sets the culture used when writing JSON. Defaults to . + + + + + Creates an instance of the JsonWriter class. + + + + + Flushes whatever is in the buffer to the underlying streams and also flushes the underlying stream. + + + + + Closes this stream and the underlying stream. + + + + + Writes the beginning of a JSON object. + + + + + Writes the end of a JSON object. + + + + + Writes the beginning of a JSON array. + + + + + Writes the end of an array. + + + + + Writes the start of a constructor with the given name. + + The name of the constructor. + + + + Writes the end constructor. + + + + + Writes the property name of a name/value pair on a JSON object. + + The name of the property. + + + + Writes the property name of a name/value pair on a JSON object. + + The name of the property. + A flag to indicate whether the text should be escaped when it is written as a JSON property name. + + + + Writes the end of the current JSON object or array. + + + + + Writes the current token and its children. + + The to read the token from. + + + + Writes the current token. + + The to read the token from. + A flag indicating whether the current token's children should be written. + + + + Writes the token and its value. + + The to write. + + The value to write. + A value is only required for tokens that have an associated value, e.g. the property name for . + A null value can be passed to the method for token's that don't have a value, e.g. . + + + + Writes the token. + + The to write. + + + + Writes the specified end token. + + The end token to write. + + + + Writes indent characters. + + + + + Writes the JSON value delimiter. + + + + + Writes an indent space. + + + + + Writes a null value. + + + + + Writes an undefined value. + + + + + Writes raw JSON without changing the writer's state. + + The raw JSON to write. + + + + Writes raw JSON where a value is expected and updates the writer's state. + + The raw JSON to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a [] value. + + The [] value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + An error will raised if the value cannot be written as a single JSON token. + + The value to write. + + + + Writes out a comment /*...*/ containing the specified text. + + Text to place inside the comment. + + + + Writes out the given white space. + + The string of white space characters. + + + + Releases unmanaged and - optionally - managed resources + + true to release both managed and unmanaged resources; false to release only unmanaged resources. + + + + Sets the state of the JsonWriter, + + The JsonToken being written. + The value being written. + + + + The exception thrown when an error occurs while reading JSON text. + + + + + Gets the path to the JSON where the error occurred. + + The path to the JSON where the error occurred. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + Specifies how JSON comments are handled when loading JSON. + + + + + Ignore comments. + + + + + Load comments as a with type . + + + + + Specifies how line information is handled when loading JSON. + + + + + Ignore line information. + + + + + Load line information. + + + + + Contains the LINQ to JSON extension methods. + + + + + Returns a collection of tokens that contains the ancestors of every token in the source collection. + + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains the ancestors of every token in the source collection. + + + + Returns a collection of tokens that contains every token in the source collection, and the ancestors of every token in the source collection. + + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains every token in the source collection, the ancestors of every token in the source collection. + + + + Returns a collection of tokens that contains the descendants of every token in the source collection. + + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains the descendants of every token in the source collection. + + + + Returns a collection of tokens that contains every token in the source collection, and the descendants of every token in the source collection. + + The type of the objects in source, constrained to . + An of that contains the source collection. + An of that contains every token in the source collection, and the descendants of every token in the source collection. + + + + Returns a collection of child properties of every object in the source collection. + + An of that contains the source collection. + An of that contains the properties of every object in the source collection. + + + + Returns a collection of child values of every object in the source collection with the given key. + + An of that contains the source collection. + The token key. + An of that contains the values of every token in the source collection with the given key. + + + + Returns a collection of child values of every object in the source collection. + + An of that contains the source collection. + An of that contains the values of every token in the source collection. + + + + Returns a collection of converted child values of every object in the source collection with the given key. + + The type to convert the values to. + An of that contains the source collection. + The token key. + An that contains the converted values of every token in the source collection with the given key. + + + + Returns a collection of converted child values of every object in the source collection. + + The type to convert the values to. + An of that contains the source collection. + An that contains the converted values of every token in the source collection. + + + + Converts the value. + + The type to convert the value to. + A cast as a of . + A converted value. + + + + Converts the value. + + The source collection type. + The type to convert the value to. + A cast as a of . + A converted value. + + + + Returns a collection of child tokens of every array in the source collection. + + The source collection type. + An of that contains the source collection. + An of that contains the values of every token in the source collection. + + + + Returns a collection of converted child tokens of every array in the source collection. + + An of that contains the source collection. + The type to convert the values to. + The source collection type. + An that contains the converted values of every token in the source collection. + + + + Returns the input typed as . + + An of that contains the source collection. + The input typed as . + + + + Returns the input typed as . + + The source collection type. + An of that contains the source collection. + The input typed as . + + + + Represents a collection of objects. + + The type of token + + + + Gets the with the specified key. + + + + + + Represents a JSON array. + + + + + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Gets the node type for this . + + The type. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class with the specified content. + + The contents of the array. + + + + Initializes a new instance of the class with the specified content. + + The contents of the array. + + + + Loads an from a . + + A that will be read for the content of the . + A that contains the JSON that was read from the specified . + + + + Loads an from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . + + + + Load a from a string that contains JSON. + + A that contains JSON. + A populated from the string that contains JSON. + + + + + + + Load a from a string that contains JSON. + + A that contains JSON. + The used to load the JSON. + If this is null, default load settings will be used. + A populated from the string that contains JSON. + + + + + + + Creates a from an object. + + The object that will be used to create . + A with the values of the specified object + + + + Creates a from an object. + + The object that will be used to create . + The that will be used to read the object. + A with the values of the specified object + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Gets the with the specified key. + + The with the specified key. + + + + Gets or sets the at the specified index. + + + + + + Determines the index of a specific item in the . + + The object to locate in the . + + The index of if found in the list; otherwise, -1. + + + + + Inserts an item to the at the specified index. + + The zero-based index at which should be inserted. + The object to insert into the . + + is not a valid index in the . + The is read-only. + + + + Removes the item at the specified index. + + The zero-based index of the item to remove. + + is not a valid index in the . + The is read-only. + + + + Returns an enumerator that iterates through the collection. + + + A that can be used to iterate through the collection. + + + + + Adds an item to the . + + The object to add to the . + The is read-only. + + + + Removes all items from the . + + The is read-only. + + + + Determines whether the contains a specific value. + + The object to locate in the . + + true if is found in the ; otherwise, false. + + + + + Copies to. + + The array. + Index of the array. + + + + Gets a value indicating whether the is read-only. + + true if the is read-only; otherwise, false. + + + + Removes the first occurrence of a specific object from the . + + The object to remove from the . + + true if was successfully removed from the ; otherwise, false. This method also returns false if is not found in the original . + + The is read-only. + + + + Represents a JSON constructor. + + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Gets or sets the name of this constructor. + + The constructor name. + + + + Gets the node type for this . + + The type. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class with the specified name and content. + + The constructor name. + The contents of the constructor. + + + + Initializes a new instance of the class with the specified name and content. + + The constructor name. + The contents of the constructor. + + + + Initializes a new instance of the class with the specified name. + + The constructor name. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Gets the with the specified key. + + The with the specified key. + + + + Loads an from a . + + A that will be read for the content of the . + A that contains the JSON that was read from the specified . + + + + Loads an from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . + + + + Represents a token that can contain other tokens. + + + + + Occurs when the list changes or an item in the list changes. + + + + + Occurs before an item is added to the collection. + + + + + Occurs when the items list of the collection has changed, or the collection is reset. + + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Raises the event. + + The instance containing the event data. + + + + Raises the event. + + The instance containing the event data. + + + + Raises the event. + + The instance containing the event data. + + + + Gets a value indicating whether this token has child tokens. + + + true if this token has child values; otherwise, false. + + + + + Get the first child token of this token. + + + A containing the first child token of the . + + + + + Get the last child token of this token. + + + A containing the last child token of the . + + + + + Returns a collection of the child tokens of this token, in document order. + + + An of containing the child tokens of this , in document order. + + + + + Returns a collection of the child values of this token, in document order. + + The type to convert the values to. + + A containing the child values of this , in document order. + + + + + Returns a collection of the descendant tokens for this token in document order. + + An containing the descendant tokens of the . + + + + Returns a collection of the tokens that contain this token, and all descendant tokens of this token, in document order. + + An containing this token, and all the descendant tokens of the . + + + + Adds the specified content as children of this . + + The content to be added. + + + + Adds the specified content as the first children of this . + + The content to be added. + + + + Creates an that can be used to add tokens to the . + + An that is ready to have content written to it. + + + + Replaces the children nodes of this token with the specified content. + + The content. + + + + Removes the child nodes from this token. + + + + + Merge the specified content into this . + + The content to be merged. + + + + Merge the specified content into this using . + + The content to be merged. + The used to merge the content. + + + + Gets the count of child JSON tokens. + + The count of child JSON tokens + + + + Represents a collection of objects. + + The type of token + + + + An empty collection of objects. + + + + + Initializes a new instance of the struct. + + The enumerable. + + + + Returns an enumerator that iterates through the collection. + + + A that can be used to iterate through the collection. + + + + + Returns an enumerator that iterates through a collection. + + + An object that can be used to iterate through the collection. + + + + + Gets the with the specified key. + + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Determines whether the specified is equal to this instance. + + The to compare with this instance. + + true if the specified is equal to this instance; otherwise, false. + + + + + Returns a hash code for this instance. + + + A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. + + + + + Represents a JSON object. + + + + + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Occurs when a property value changes. + + + + + Occurs when a property value is changing. + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class with the specified content. + + The contents of the object. + + + + Initializes a new instance of the class with the specified content. + + The contents of the object. + + + + Gets the node type for this . + + The type. + + + + Gets an of this object's properties. + + An of this object's properties. + + + + Gets a the specified name. + + The property name. + A with the specified name or null. + + + + Gets an of this object's property values. + + An of this object's property values. + + + + Gets the with the specified key. + + The with the specified key. + + + + Gets or sets the with the specified property name. + + + + + + Loads an from a . + + A that will be read for the content of the . + A that contains the JSON that was read from the specified . + + + + Loads an from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . + + + + Load a from a string that contains JSON. + + A that contains JSON. + A populated from the string that contains JSON. + + + + + + + Load a from a string that contains JSON. + + A that contains JSON. + The used to load the JSON. + If this is null, default load settings will be used. + A populated from the string that contains JSON. + + + + + + + Creates a from an object. + + The object that will be used to create . + A with the values of the specified object + + + + Creates a from an object. + + The object that will be used to create . + The that will be used to read the object. + A with the values of the specified object + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Gets the with the specified property name. + + Name of the property. + The with the specified property name. + + + + Gets the with the specified property name. + The exact property name will be searched for first and if no matching property is found then + the will be used to match a property. + + Name of the property. + One of the enumeration values that specifies how the strings will be compared. + The with the specified property name. + + + + Tries to get the with the specified property name. + The exact property name will be searched for first and if no matching property is found then + the will be used to match a property. + + Name of the property. + The value. + One of the enumeration values that specifies how the strings will be compared. + true if a value was successfully retrieved; otherwise, false. + + + + Adds the specified property name. + + Name of the property. + The value. + + + + Removes the property with the specified name. + + Name of the property. + true if item was successfully removed; otherwise, false. + + + + Tries the get value. + + Name of the property. + The value. + true if a value was successfully retrieved; otherwise, false. + + + + Returns an enumerator that iterates through the collection. + + + A that can be used to iterate through the collection. + + + + + Raises the event with the provided arguments. + + Name of the property. + + + + Raises the event with the provided arguments. + + Name of the property. + + + + Returns the properties for this instance of a component. + + + A that represents the properties for this component instance. + + + + + Returns the properties for this instance of a component using the attribute array as a filter. + + An array of type that is used as a filter. + + A that represents the filtered properties for this component instance. + + + + + Returns a collection of custom attributes for this instance of a component. + + + An containing the attributes for this object. + + + + + Returns the class name of this instance of a component. + + + The class name of the object, or null if the class does not have a name. + + + + + Returns the name of this instance of a component. + + + The name of the object, or null if the object does not have a name. + + + + + Returns a type converter for this instance of a component. + + + A that is the converter for this object, or null if there is no for this object. + + + + + Returns the default event for this instance of a component. + + + An that represents the default event for this object, or null if this object does not have events. + + + + + Returns the default property for this instance of a component. + + + A that represents the default property for this object, or null if this object does not have properties. + + + + + Returns an editor of the specified type for this instance of a component. + + A that represents the editor for this object. + + An of the specified type that is the editor for this object, or null if the editor cannot be found. + + + + + Returns the events for this instance of a component using the specified attribute array as a filter. + + An array of type that is used as a filter. + + An that represents the filtered events for this component instance. + + + + + Returns the events for this instance of a component. + + + An that represents the events for this component instance. + + + + + Returns an object that contains the property described by the specified property descriptor. + + A that represents the property whose owner is to be found. + + An that represents the owner of the specified property. + + + + + Returns the responsible for binding operations performed on this object. + + The expression tree representation of the runtime value. + + The to bind this object. + + + + + Specifies the settings used when merging JSON. + + + + + Gets or sets the method used when merging JSON arrays. + + The method used when merging JSON arrays. + + + + Gets or sets how how null value properties are merged. + + How null value properties are merged. + + + + Represents a JSON property. + + + + + Gets the container's children tokens. + + The container's children tokens. + + + + Gets the property name. + + The property name. + + + + Gets or sets the property value. + + The property value. + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Gets the node type for this . + + The type. + + + + Initializes a new instance of the class. + + The property name. + The property content. + + + + Initializes a new instance of the class. + + The property name. + The property content. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Loads an from a . + + A that will be read for the content of the . + A that contains the JSON that was read from the specified . + + + + Loads an from a . + + A that will be read for the content of the . + The used to load the JSON. + If this is null, default load settings will be used. + A that contains the JSON that was read from the specified . + + + + Represents a view of a . + + + + + Initializes a new instance of the class. + + The name. + + + + When overridden in a derived class, returns whether resetting an object changes its value. + + + true if resetting the component changes its value; otherwise, false. + + The component to test for reset capability. + + + + When overridden in a derived class, gets the current value of the property on a component. + + + The value of a property for a given component. + + The component with the property for which to retrieve the value. + + + + + When overridden in a derived class, resets the value for this property of the component to the default value. + + The component with the property value that is to be reset to the default value. + + + + + When overridden in a derived class, sets the value of the component to a different value. + + The component with the property value that is to be set. + The new value. + + + + + When overridden in a derived class, determines a value indicating whether the value of this property needs to be persisted. + + + true if the property should be persisted; otherwise, false. + + The component with the property to be examined for persistence. + + + + When overridden in a derived class, gets the type of the component this property is bound to. + + + A that represents the type of component this property is bound to. When the or methods are invoked, the object specified might be an instance of this type. + + + + + When overridden in a derived class, gets a value indicating whether this property is read-only. + + + true if the property is read-only; otherwise, false. + + + + + When overridden in a derived class, gets the type of the property. + + + A that represents the type of the property. + + + + + Gets the hash code for the name of the member. + + + + The hash code for the name of the member. + + + + + Represents a raw JSON string. + + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class. + + The raw json. + + + + Creates an instance of with the content of the reader's current token. + + The reader. + An instance of with the content of the reader's current token. + + + + Represents an abstract JSON token. + + + + + Gets a comparer that can compare two tokens for value equality. + + A that can compare two nodes for value equality. + + + + Gets or sets the parent. + + The parent. + + + + Gets the root of this . + + The root of this . + + + + Gets the node type for this . + + The type. + + + + Gets a value indicating whether this token has child tokens. + + + true if this token has child values; otherwise, false. + + + + + Compares the values of two tokens, including the values of all descendant tokens. + + The first to compare. + The second to compare. + true if the tokens are equal; otherwise false. + + + + Gets the next sibling token of this node. + + The that contains the next sibling token. + + + + Gets the previous sibling token of this node. + + The that contains the previous sibling token. + + + + Gets the path of the JSON token. + + + + + Adds the specified content immediately after this token. + + A content object that contains simple content or a collection of content objects to be added after this token. + + + + Adds the specified content immediately before this token. + + A content object that contains simple content or a collection of content objects to be added before this token. + + + + Returns a collection of the ancestor tokens of this token. + + A collection of the ancestor tokens of this token. + + + + Returns a collection of tokens that contain this token, and the ancestors of this token. + + A collection of tokens that contain this token, and the ancestors of this token. + + + + Returns a collection of the sibling tokens after this token, in document order. + + A collection of the sibling tokens after this tokens, in document order. + + + + Returns a collection of the sibling tokens before this token, in document order. + + A collection of the sibling tokens before this token, in document order. + + + + Gets the with the specified key. + + The with the specified key. + + + + Gets the with the specified key converted to the specified type. + + The type to convert the token to. + The token key. + The converted token value. + + + + Get the first child token of this token. + + A containing the first child token of the . + + + + Get the last child token of this token. + + A containing the last child token of the . + + + + Returns a collection of the child tokens of this token, in document order. + + An of containing the child tokens of this , in document order. + + + + Returns a collection of the child tokens of this token, in document order, filtered by the specified type. + + The type to filter the child tokens on. + A containing the child tokens of this , in document order. + + + + Returns a collection of the child values of this token, in document order. + + The type to convert the values to. + A containing the child values of this , in document order. + + + + Removes this token from its parent. + + + + + Replaces this token with the specified token. + + The value. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Returns the indented JSON for this token. + + + The indented JSON for this token. + + + + + Returns the JSON for this token using the given formatting and converters. + + Indicates how the output is formatted. + A collection of which will be used when writing the token. + The JSON for this token using the given formatting and converters. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to []. + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an explicit conversion from to . + + The value. + The result of the conversion. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from [] to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Performs an implicit conversion from to . + + The value to create a from. + The initialized with the specified value. + + + + Creates an for this token. + + An that can be used to read this token and its descendants. + + + + Creates a from an object. + + The object that will be used to create . + A with the value of the specified object + + + + Creates a from an object using the specified . + + The object that will be used to create . + The that will be used when reading the object. + A with the value of the specified object + + + + Creates the specified .NET type from the . + + The object type that the token will be deserialized to. + The new object created from the JSON value. + + + + Creates the specified .NET type from the . + + The object type that the token will be deserialized to. + The new object created from the JSON value. + + + + Creates the specified .NET type from the using the specified . + + The object type that the token will be deserialized to. + The that will be used when creating the object. + The new object created from the JSON value. + + + + Creates the specified .NET type from the using the specified . + + The object type that the token will be deserialized to. + The that will be used when creating the object. + The new object created from the JSON value. + + + + Creates a from a . + + An positioned at the token to read into this . + + An that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Creates a from a . + + An positioned at the token to read into this . + The used to load the JSON. + If this is null, default load settings will be used. + + An that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Load a from a string that contains JSON. + + A that contains JSON. + A populated from the string that contains JSON. + + + + Load a from a string that contains JSON. + + A that contains JSON. + The used to load the JSON. + If this is null, default load settings will be used. + A populated from the string that contains JSON. + + + + Creates a from a . + + An positioned at the token to read into this . + The used to load the JSON. + If this is null, default load settings will be used. + + An that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Creates a from a . + + An positioned at the token to read into this . + + An that contains the token and its descendant tokens + that were read from the reader. The runtime type of the token is determined + by the token type of the first token encountered in the reader. + + + + + Selects a using a JPath expression. Selects the token that matches the object path. + + + A that contains a JPath expression. + + A , or null. + + + + Selects a using a JPath expression. Selects the token that matches the object path. + + + A that contains a JPath expression. + + A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. + A . + + + + Selects a collection of elements using a JPath expression. + + + A that contains a JPath expression. + + An that contains the selected elements. + + + + Selects a collection of elements using a JPath expression. + + + A that contains a JPath expression. + + A flag to indicate whether an error should be thrown if no tokens are found when evaluating part of the expression. + An that contains the selected elements. + + + + Returns the responsible for binding operations performed on this object. + + The expression tree representation of the runtime value. + + The to bind this object. + + + + + Returns the responsible for binding operations performed on this object. + + The expression tree representation of the runtime value. + + The to bind this object. + + + + + Creates a new instance of the . All child tokens are recursively cloned. + + A new instance of the . + + + + Adds an object to the annotation list of this . + + The annotation to add. + + + + Get the first annotation object of the specified type from this . + + The type of the annotation to retrieve. + The first annotation object that matches the specified type, or null if no annotation is of the specified type. + + + + Gets the first annotation object of the specified type from this . + + The of the annotation to retrieve. + The first annotation object that matches the specified type, or null if no annotation is of the specified type. + + + + Gets a collection of annotations of the specified type for this . + + The type of the annotations to retrieve. + An that contains the annotations for this . + + + + Gets a collection of annotations of the specified type for this . + + The of the annotations to retrieve. + An of that contains the annotations that match the specified type for this . + + + + Removes the annotations of the specified type from this . + + The type of annotations to remove. + + + + Removes the annotations of the specified type from this . + + The of annotations to remove. + + + + Compares tokens to determine whether they are equal. + + + + + Determines whether the specified objects are equal. + + The first object of type to compare. + The second object of type to compare. + + true if the specified objects are equal; otherwise, false. + + + + + Returns a hash code for the specified object. + + The for which a hash code is to be returned. + A hash code for the specified object. + The type of is a reference type and is null. + + + + Represents a reader that provides fast, non-cached, forward-only access to serialized JSON data. + + + + + Gets the at the reader's current position. + + + + + Initializes a new instance of the class. + + The token to read from. + + + + Reads the next JSON token from the stream. + + + true if the next token was read successfully; false if there are no more tokens to read. + + + + + Gets the path of the current JSON token. + + + + + Specifies the type of token. + + + + + No token type has been set. + + + + + A JSON object. + + + + + A JSON array. + + + + + A JSON constructor. + + + + + A JSON object property. + + + + + A comment. + + + + + An integer value. + + + + + A float value. + + + + + A string value. + + + + + A boolean value. + + + + + A null value. + + + + + An undefined value. + + + + + A date value. + + + + + A raw JSON value. + + + + + A collection of bytes value. + + + + + A Guid value. + + + + + A Uri value. + + + + + A TimeSpan value. + + + + + Represents a writer that provides a fast, non-cached, forward-only way of generating JSON data. + + + + + Gets the at the writer's current position. + + + + + Gets the token being writen. + + The token being writen. + + + + Initializes a new instance of the class writing to the given . + + The container being written to. + + + + Initializes a new instance of the class. + + + + + Flushes whatever is in the buffer to the underlying streams and also flushes the underlying stream. + + + + + Closes this stream and the underlying stream. + + + + + Writes the beginning of a JSON object. + + + + + Writes the beginning of a JSON array. + + + + + Writes the start of a constructor with the given name. + + The name of the constructor. + + + + Writes the end. + + The token. + + + + Writes the property name of a name/value pair on a JSON object. + + The name of the property. + + + + Writes a value. + An error will raised if the value cannot be written as a single JSON token. + + The value to write. + + + + Writes a null value. + + + + + Writes an undefined value. + + + + + Writes raw JSON. + + The raw JSON to write. + + + + Writes out a comment /*...*/ containing the specified text. + + Text to place inside the comment. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a [] value. + + The [] value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Writes a value. + + The value to write. + + + + Represents a value in JSON (string, integer, date, etc). + + + + + Initializes a new instance of the class from another object. + + A object to copy from. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Initializes a new instance of the class with the given value. + + The value. + + + + Gets a value indicating whether this token has child tokens. + + + true if this token has child values; otherwise, false. + + + + + Creates a comment with the given value. + + The value. + A comment with the given value. + + + + Creates a string with the given value. + + The value. + A string with the given value. + + + + Creates a null value. + + A null value. + + + + Creates a undefined value. + + A undefined value. + + + + Gets the node type for this . + + The type. + + + + Gets or sets the underlying token value. + + The underlying token value. + + + + Writes this token to a . + + A into which this method will write. + A collection of which will be used when writing the token. + + + + Indicates whether the current object is equal to another object of the same type. + + + true if the current object is equal to the parameter; otherwise, false. + + An object to compare with this object. + + + + Determines whether the specified is equal to the current . + + The to compare with the current . + + true if the specified is equal to the current ; otherwise, false. + + + The parameter is null. + + + + + Serves as a hash function for a particular type. + + + A hash code for the current . + + + + + Returns a that represents this instance. + + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format provider. + + A that represents this instance. + + + + + Returns a that represents this instance. + + The format. + The format provider. + + A that represents this instance. + + + + + Returns the responsible for binding operations performed on this object. + + The expression tree representation of the runtime value. + + The to bind this object. + + + + + Compares the current instance with another object of the same type and returns an integer that indicates whether the current instance precedes, follows, or occurs in the same position in the sort order as the other object. + + An object to compare with this instance. + + A 32-bit signed integer that indicates the relative order of the objects being compared. The return value has these meanings: + Value + Meaning + Less than zero + This instance is less than . + Zero + This instance is equal to . + Greater than zero + This instance is greater than . + + + is not the same type as this instance. + + + + + Specifies the settings used when loading JSON. + + + + + Gets or sets how JSON comments are handled when loading JSON. + + The JSON comment handling. + + + + Gets or sets how JSON line info is handled when loading JSON. + + The JSON line info handling. + + + + Specifies how JSON arrays are merged together. + + + + Concatenate arrays. + + + Union arrays, skipping items that already exist. + + + Replace all array items. + + + Merge array items together, matched by index. + + + + Specifies how null value properties are merged. + + + + + The content's null value properties will be ignored during merging. + + + + + The content's null value properties will be merged. + + + + + Specifies the member serialization options for the . + + + + + All public members are serialized by default. Members can be excluded using or . + This is the default member serialization mode. + + + + + Only members marked with or are serialized. + This member serialization mode can also be set by marking the class with . + + + + + All public and private fields are serialized. Members can be excluded using or . + This member serialization mode can also be set by marking the class with + and setting IgnoreSerializableAttribute on to false. + + + + + Specifies metadata property handling options for the . + + + + + Read metadata properties located at the start of a JSON object. + + + + + Read metadata properties located anywhere in a JSON object. Note that this setting will impact performance. + + + + + Do not try to read metadata properties. + + + + + Specifies missing member handling options for the . + + + + + Ignore a missing member and do not attempt to deserialize it. + + + + + Throw a when a missing member is encountered during deserialization. + + + + + Specifies null value handling options for the . + + + + + + + + + Include null values when serializing and deserializing objects. + + + + + Ignore null values when serializing and deserializing objects. + + + + + Specifies how object creation is handled by the . + + + + + Reuse existing objects, create new objects when needed. + + + + + Only reuse existing objects. + + + + + Always create new objects. + + + + + Specifies reference handling options for the . + Note that references cannot be preserved when a value is set via a non-default constructor such as types that implement ISerializable. + + + + + + + + Do not preserve references when serializing types. + + + + + Preserve references when serializing into a JSON object structure. + + + + + Preserve references when serializing into a JSON array structure. + + + + + Preserve references when serializing. + + + + + Specifies reference loop handling options for the . + + + + + Throw a when a loop is encountered. + + + + + Ignore loop references and do not serialize. + + + + + Serialize loop references. + + + + + Indicating whether a property is required. + + + + + The property is not required. The default state. + + + + + The property must be defined in JSON but can be a null value. + + + + + The property must be defined in JSON and cannot be a null value. + + + + + The property is not required but it cannot be a null value. + + + + + + Contains the JSON schema extension methods. + + + JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. + + + + + + + Determines whether the is valid. + + + JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. + + + The source to test. + The schema to test with. + + true if the specified is valid; otherwise, false. + + + + + + Determines whether the is valid. + + + JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. + + + The source to test. + The schema to test with. + When this method returns, contains any error messages generated while validating. + + true if the specified is valid; otherwise, false. + + + + + + Validates the specified . + + + JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. + + + The source to test. + The schema to test with. + + + + + Validates the specified . + + + JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. + + + The source to test. + The schema to test with. + The validation event handler. + + + + + An in-memory representation of a JSON Schema. + + + JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets or sets the id. + + + + + Gets or sets the title. + + + + + Gets or sets whether the object is required. + + + + + Gets or sets whether the object is read only. + + + + + Gets or sets whether the object is visible to users. + + + + + Gets or sets whether the object is transient. + + + + + Gets or sets the description of the object. + + + + + Gets or sets the types of values allowed by the object. + + The type. + + + + Gets or sets the pattern. + + The pattern. + + + + Gets or sets the minimum length. + + The minimum length. + + + + Gets or sets the maximum length. + + The maximum length. + + + + Gets or sets a number that the value should be divisble by. + + A number that the value should be divisble by. + + + + Gets or sets the minimum. + + The minimum. + + + + Gets or sets the maximum. + + The maximum. + + + + Gets or sets a flag indicating whether the value can not equal the number defined by the "minimum" attribute. + + A flag indicating whether the value can not equal the number defined by the "minimum" attribute. + + + + Gets or sets a flag indicating whether the value can not equal the number defined by the "maximum" attribute. + + A flag indicating whether the value can not equal the number defined by the "maximum" attribute. + + + + Gets or sets the minimum number of items. + + The minimum number of items. + + + + Gets or sets the maximum number of items. + + The maximum number of items. + + + + Gets or sets the of items. + + The of items. + + + + Gets or sets a value indicating whether items in an array are validated using the instance at their array position from . + + + true if items are validated using their array position; otherwise, false. + + + + + Gets or sets the of additional items. + + The of additional items. + + + + Gets or sets a value indicating whether additional items are allowed. + + + true if additional items are allowed; otherwise, false. + + + + + Gets or sets whether the array items must be unique. + + + + + Gets or sets the of properties. + + The of properties. + + + + Gets or sets the of additional properties. + + The of additional properties. + + + + Gets or sets the pattern properties. + + The pattern properties. + + + + Gets or sets a value indicating whether additional properties are allowed. + + + true if additional properties are allowed; otherwise, false. + + + + + Gets or sets the required property if this property is present. + + The required property if this property is present. + + + + Gets or sets the a collection of valid enum values allowed. + + A collection of valid enum values allowed. + + + + Gets or sets disallowed types. + + The disallow types. + + + + Gets or sets the default value. + + The default value. + + + + Gets or sets the collection of that this schema extends. + + The collection of that this schema extends. + + + + Gets or sets the format. + + The format. + + + + Initializes a new instance of the class. + + + + + Reads a from the specified . + + The containing the JSON Schema to read. + The object representing the JSON Schema. + + + + Reads a from the specified . + + The containing the JSON Schema to read. + The to use when resolving schema references. + The object representing the JSON Schema. + + + + Load a from a string that contains schema JSON. + + A that contains JSON. + A populated from the string that contains JSON. + + + + Parses the specified json. + + The json. + The resolver. + A populated from the string that contains JSON. + + + + Writes this schema to a . + + A into which this method will write. + + + + Writes this schema to a using the specified . + + A into which this method will write. + The resolver used. + + + + Returns a that represents the current . + + + A that represents the current . + + + + + + Returns detailed information about the schema exception. + + + JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets the line number indicating where the error occurred. + + The line number indicating where the error occurred. + + + + Gets the line position indicating where the error occurred. + + The line position indicating where the error occurred. + + + + Gets the path to the JSON where the error occurred. + + The path to the JSON where the error occurred. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class + with a specified error message. + + The error message that explains the reason for the exception. + + + + Initializes a new instance of the class + with a specified error message and a reference to the inner exception that is the cause of this exception. + + The error message that explains the reason for the exception. + The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. + + + + Initializes a new instance of the class. + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + The parameter is null. + The class name is null or is zero (0). + + + + + Generates a from a specified . + + + JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets or sets how undefined schemas are handled by the serializer. + + + + + Gets or sets the contract resolver. + + The contract resolver. + + + + Generate a from the specified type. + + The type to generate a from. + A generated from the specified type. + + + + Generate a from the specified type. + + The type to generate a from. + The used to resolve schema references. + A generated from the specified type. + + + + Generate a from the specified type. + + The type to generate a from. + Specify whether the generated root will be nullable. + A generated from the specified type. + + + + Generate a from the specified type. + + The type to generate a from. + The used to resolve schema references. + Specify whether the generated root will be nullable. + A generated from the specified type. + + + + + Resolves from an id. + + + JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets or sets the loaded schemas. + + The loaded schemas. + + + + Initializes a new instance of the class. + + + + + Gets a for the specified reference. + + The id. + A for the specified reference. + + + + + The value types allowed by the . + + + JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. + + + + + + No type specified. + + + + + String type. + + + + + Float type. + + + + + Integer type. + + + + + Boolean type. + + + + + Object type. + + + + + Array type. + + + + + Null type. + + + + + Any type. + + + + + + Specifies undefined schema Id handling options for the . + + + JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. + + + + + + Do not infer a schema Id. + + + + + Use the .NET type name as the schema Id. + + + + + Use the assembly qualified .NET type name as the schema Id. + + + + + + Returns detailed information related to the . + + + JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. + + + + + + Gets the associated with the validation error. + + The JsonSchemaException associated with the validation error. + + + + Gets the path of the JSON location where the validation error occurred. + + The path of the JSON location where the validation error occurred. + + + + Gets the text description corresponding to the validation error. + + The text description. + + + + + Represents the callback method that will handle JSON schema validation events and the . + + + JSON Schema validation has been moved to its own package. See http://www.newtonsoft.com/jsonschema for more details. + + + + + + A snake case naming strategy. + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + + + Initializes a new instance of the class. + + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + A camel case naming strategy. + + + + + Initializes a new instance of the class. + + + A flag indicating whether dictionary keys should be processed. + + + A flag indicating whether explicitly specified property names should be processed, + e.g. a property name customized with a . + + + + + Initializes a new instance of the class. + + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + Resolves member mappings for a type, camel casing property names. + + + + + Initializes a new instance of the class. + + + + + Used by to resolves a for a given . + + + + + Gets a value indicating whether members are being get and set using dynamic code generation. + This value is determined by the runtime permissions available. + + + true if using dynamic code generation; otherwise, false. + + + + + Gets or sets the default members search flags. + + The default members search flags. + + + + Gets or sets a value indicating whether compiler generated members should be serialized. + + + true if serialized compiler generated members; otherwise, false. + + + + + Gets or sets a value indicating whether to ignore the interface when serializing and deserializing types. + + + true if the interface will be ignored when serializing and deserializing types; otherwise, false. + + + + + Gets or sets a value indicating whether to ignore the attribute when serializing and deserializing types. + + + true if the attribute will be ignored when serializing and deserializing types; otherwise, false. + + + + + Gets or sets the naming strategy used to resolve how property names and dictionary keys are serialized. + + The naming strategy used to resolve how property names and dictionary keys are serialized. + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + + If set to true the will use a cached shared with other resolvers of the same type. + Sharing the cache will significantly improve performance with multiple resolver instances because expensive reflection will only + happen once. This setting can cause unexpected behavior if different instances of the resolver are suppose to produce different + results. When set to false it is highly recommended to reuse instances with the . + + + + + Resolves the contract for a given type. + + The type to resolve a contract for. + The contract for a given type. + + + + Gets the serializable members for the type. + + The type to get serializable members for. + The serializable members for the type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates the constructor parameters. + + The constructor to create properties for. + The type's member properties. + Properties for the given . + + + + Creates a for the given . + + The matching member property. + The constructor parameter. + A created for the given . + + + + Resolves the default for the contract. + + Type of the object. + The contract's default . + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Creates a for the given type. + + Type of the object. + A for the given type. + + + + Determines which contract type is created for the given type. + + Type of the object. + A for the given type. + + + + Creates properties for the given . + + The type to create properties for. + /// The member serialization mode for the type. + Properties for the given . + + + + Creates the used by the serializer to get and set values from a member. + + The member. + The used by the serializer to get and set values from a member. + + + + Creates a for the given . + + The member's parent . + The member to create a for. + A created for the given . + + + + Resolves the name of the property. + + Name of the property. + Resolved name of the property. + + + + Resolves the key of the dictionary. By default is used to resolve dictionary keys. + + Key of the dictionary. + Resolved key of the dictionary. + + + + Gets the resolved name of the property. + + Name of the property. + Name of the property. + + + + The default naming strategy. Property names and dictionary keys are unchanged. + + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + The default serialization binder used when resolving and loading classes from type names. + + + + + When overridden in a derived class, controls the binding of a serialized object to a type. + + Specifies the name of the serialized object. + Specifies the name of the serialized object. + + The type of the object the formatter creates a new instance of. + + + + + When overridden in a derived class, controls the binding of a serialized object to a type. + + The type of the object the formatter creates a new instance of. + Specifies the name of the serialized object. + Specifies the name of the serialized object. + + + + Represents a trace writer that writes to the application's instances. + + + + + Gets the that will be used to filter the trace messages passed to the writer. + For example a filter level of Info will exclude Verbose messages and include Info, + Warning and Error messages. + + + The that will be used to filter the trace messages passed to the writer. + + + + + Writes the specified trace level, message and optional exception. + + The at which to write this trace. + The trace message. + The trace exception. This parameter is optional. + + + + Get and set values for a using dynamic methods. + + + + + Initializes a new instance of the class. + + The member info. + + + + Sets the value. + + The target to set the value on. + The value to set on the target. + + + + Gets the value. + + The target to get the value from. + The value. + + + + Provides information surrounding an error. + + + + + Gets the error. + + The error. + + + + Gets the original object that caused the error. + + The original object that caused the error. + + + + Gets the member that caused the error. + + The member that caused the error. + + + + Gets the path of the JSON location where the error occurred. + + The path of the JSON location where the error occurred. + + + + Gets or sets a value indicating whether this is handled. + + true if handled; otherwise, false. + + + + Provides data for the Error event. + + + + + Gets the current object the error event is being raised against. + + The current object the error event is being raised against. + + + + Gets the error context. + + The error context. + + + + Initializes a new instance of the class. + + The current object. + The error context. + + + + Get and set values for a using dynamic methods. + + + + + Initializes a new instance of the class. + + The member info. + + + + Sets the value. + + The target to set the value on. + The value to set on the target. + + + + Gets the value. + + The target to get the value from. + The value. + + + + Provides methods to get attributes. + + + + + Returns a collection of all of the attributes, or an empty collection if there are no attributes. + + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. + + + + Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. + + The type of the attributes. + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. + + + + Used by to resolves a for a given . + + + + + + + + + Resolves the contract for a given type. + + The type to resolve a contract for. + The contract for a given type. + + + + A base class for resolving how property names and dictionary keys are serialized. + + + + + A flag indicating whether dictionary keys should be processed. + Defaults to false. + + + + + A flag indicating whether explicitly specified property names, + e.g. a property name customized with a , should be processed. + Defaults to false. + + + + + Gets the serialized name for a given property name. + + The initial property name. + A flag indicating whether the property has had a name explicitly specfied. + The serialized property name. + + + + Gets the serialized key for a given dictionary key. + + The initial dictionary key. + The serialized dictionary key. + + + + Resolves the specified property name. + + The property name to resolve. + The resolved property name. + + + + Used to resolve references when serializing and deserializing JSON by the . + + + + + Resolves a reference to its object. + + The serialization context. + The reference to resolve. + The object that + + + + Gets the reference for the sepecified object. + + The serialization context. + The object to get a reference for. + The reference to the object. + + + + Determines whether the specified object is referenced. + + The serialization context. + The object to test for a reference. + + true if the specified object is referenced; otherwise, false. + + + + + Adds a reference to the specified object. + + The serialization context. + The reference. + The object to reference. + + + + Represents a trace writer. + + + + + Gets the that will be used to filter the trace messages passed to the writer. + For example a filter level of Info will exclude Verbose messages and include Info, + Warning and Error messages. + + The that will be used to filter the trace messages passed to the writer. + + + + Writes the specified trace level, message and optional exception. + + The at which to write this trace. + The trace message. + The trace exception. This parameter is optional. + + + + Provides methods to get and set values. + + + + + Sets the value. + + The target to set the value on. + The value to set on the target. + + + + Gets the value. + + The target to get the value from. + The value. + + + + Contract details for a used by the . + + + + + Gets the of the collection items. + + The of the collection items. + + + + Gets a value indicating whether the collection type is a multidimensional array. + + true if the collection type is a multidimensional array; otherwise, false. + + + + Gets or sets the function used to create the object. When set this function will override . + + The function used to create the object. + + + + Gets a value indicating whether the creator has a parameter with the collection values. + + true if the creator has a parameter with the collection values; otherwise, false. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Gets or sets the default collection items . + + The converter. + + + + Gets or sets a value indicating whether the collection items preserve object references. + + true if collection items preserve object references; otherwise, false. + + + + Gets or sets the collection item reference loop handling. + + The reference loop handling. + + + + Gets or sets the collection item type name handling. + + The type name handling. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Handles serialization callback events. + + The object that raised the callback event. + The streaming context. + + + + Handles serialization error callback events. + + The object that raised the callback event. + The streaming context. + The error context. + + + + Sets extension data for an object during deserialization. + + The object to set extension data on. + The extension data key. + The extension data value. + + + + Gets extension data for an object during serialization. + + The object to set extension data on. + + + + Contract details for a used by the . + + + + + Gets the underlying type for the contract. + + The underlying type for the contract. + + + + Gets or sets the type created during deserialization. + + The type created during deserialization. + + + + Gets or sets whether this type contract is serialized as a reference. + + Whether this type contract is serialized as a reference. + + + + Gets or sets the default for this contract. + + The converter. + + + + Gets or sets all methods called immediately after deserialization of the object. + + The methods called immediately after deserialization of the object. + + + + Gets or sets all methods called during deserialization of the object. + + The methods called during deserialization of the object. + + + + Gets or sets all methods called after serialization of the object graph. + + The methods called after serialization of the object graph. + + + + Gets or sets all methods called before serialization of the object. + + The methods called before serialization of the object. + + + + Gets or sets all method called when an error is thrown during the serialization of the object. + + The methods called when an error is thrown during the serialization of the object. + + + + Gets or sets the method called immediately after deserialization of the object. + + The method called immediately after deserialization of the object. + + + + Gets or sets the method called during deserialization of the object. + + The method called during deserialization of the object. + + + + Gets or sets the method called after serialization of the object graph. + + The method called after serialization of the object graph. + + + + Gets or sets the method called before serialization of the object. + + The method called before serialization of the object. + + + + Gets or sets the method called when an error is thrown during the serialization of the object. + + The method called when an error is thrown during the serialization of the object. + + + + Gets or sets the default creator method used to create the object. + + The default creator method used to create the object. + + + + Gets or sets a value indicating whether the default creator is non public. + + true if the default object creator is non-public; otherwise, false. + + + + Contract details for a used by the . + + + + + Gets or sets the property name resolver. + + The property name resolver. + + + + Gets or sets the dictionary key resolver. + + The dictionary key resolver. + + + + Gets the of the dictionary keys. + + The of the dictionary keys. + + + + Gets the of the dictionary values. + + The of the dictionary values. + + + + Gets or sets the function used to create the object. When set this function will override . + + The function used to create the object. + + + + Gets a value indicating whether the creator has a parameter with the dictionary values. + + true if the creator has a parameter with the dictionary values; otherwise, false. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Gets the object's properties. + + The object's properties. + + + + Gets or sets the property name resolver. + + The property name resolver. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Gets or sets the ISerializable object constructor. + + The ISerializable object constructor. + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Gets or sets the object member serialization. + + The member object serialization. + + + + Gets or sets a value that indicates whether the object's properties are required. + + + A value indicating whether the object's properties are required. + + + + + Gets the object's properties. + + The object's properties. + + + + Gets the constructor parameters required for any non-default constructor + + + + + Gets a collection of instances that define the parameters used with . + + + + + Gets or sets the override constructor used to create the object. + This is set when a constructor is marked up using the + JsonConstructor attribute. + + The override constructor. + + + + Gets or sets the parametrized constructor used to create the object. + + The parametrized constructor. + + + + Gets or sets the function used to create the object. When set this function will override . + This function is called with a collection of arguments which are defined by the collection. + + The function used to create the object. + + + + Gets or sets the extension data setter. + + + + + Gets or sets the extension data getter. + + + + + Gets or sets the extension data value type. + + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Contract details for a used by the . + + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Maps a JSON property to a .NET member or constructor parameter. + + + + + Gets or sets the name of the property. + + The name of the property. + + + + Gets or sets the type that declared this property. + + The type that declared this property. + + + + Gets or sets the order of serialization of a member. + + The numeric order of serialization. + + + + Gets or sets the name of the underlying member or parameter. + + The name of the underlying member or parameter. + + + + Gets the that will get and set the during serialization. + + The that will get and set the during serialization. + + + + Gets or sets the for this property. + + The for this property. + + + + Gets or sets the type of the property. + + The type of the property. + + + + Gets or sets the for the property. + If set this converter takes presidence over the contract converter for the property type. + + The converter. + + + + Gets or sets the member converter. + + The member converter. + + + + Gets or sets a value indicating whether this is ignored. + + true if ignored; otherwise, false. + + + + Gets or sets a value indicating whether this is readable. + + true if readable; otherwise, false. + + + + Gets or sets a value indicating whether this is writable. + + true if writable; otherwise, false. + + + + Gets or sets a value indicating whether this has a member attribute. + + true if has a member attribute; otherwise, false. + + + + Gets the default value. + + The default value. + + + + Gets or sets a value indicating whether this is required. + + A value indicating whether this is required. + + + + Gets or sets a value indicating whether this property preserves object references. + + + true if this instance is reference; otherwise, false. + + + + + Gets or sets the property null value handling. + + The null value handling. + + + + Gets or sets the property default value handling. + + The default value handling. + + + + Gets or sets the property reference loop handling. + + The reference loop handling. + + + + Gets or sets the property object creation handling. + + The object creation handling. + + + + Gets or sets or sets the type name handling. + + The type name handling. + + + + Gets or sets a predicate used to determine whether the property should be serialize. + + A predicate used to determine whether the property should be serialize. + + + + Gets or sets a predicate used to determine whether the property should be deserialized. + + A predicate used to determine whether the property should be deserialized. + + + + Gets or sets a predicate used to determine whether the property should be serialized. + + A predicate used to determine whether the property should be serialized. + + + + Gets or sets an action used to set whether the property has been deserialized. + + An action used to set whether the property has been deserialized. + + + + Returns a that represents this instance. + + + A that represents this instance. + + + + + Gets or sets the converter used when serializing the property's collection items. + + The collection's items converter. + + + + Gets or sets whether this property's collection items are serialized as a reference. + + Whether this property's collection items are serialized as a reference. + + + + Gets or sets the the type name handling used when serializing the property's collection items. + + The collection's items type name handling. + + + + Gets or sets the the reference loop handling used when serializing the property's collection items. + + The collection's items reference loop handling. + + + + A collection of objects. + + + + + Initializes a new instance of the class. + + The type. + + + + When implemented in a derived class, extracts the key from the specified element. + + The element from which to extract the key. + The key for the specified element. + + + + Adds a object. + + The property to add to the collection. + + + + Gets the closest matching object. + First attempts to get an exact case match of propertyName and then + a case insensitive match. + + Name of the property. + A matching property if found. + + + + Gets a property by property name. + + The name of the property to get. + Type property name string comparison. + A matching property if found. + + + + Contract details for a used by the . + + + + + Initializes a new instance of the class. + + The underlying type for the contract. + + + + Lookup and create an instance of the JsonConverter type described by the argument. + + The JsonConverter type to create. + Optional arguments to pass to an initializing constructor of the JsonConverter. + If null, the default constructor is used. + + + + Represents a trace writer that writes to memory. When the trace message limit is + reached then old trace messages will be removed as new messages are added. + + + + + Gets the that will be used to filter the trace messages passed to the writer. + For example a filter level of Info will exclude Verbose messages and include Info, + Warning and Error messages. + + + The that will be used to filter the trace messages passed to the writer. + + + + + Initializes a new instance of the class. + + + + + Writes the specified trace level, message and optional exception. + + The at which to write this trace. + The trace message. + The trace exception. This parameter is optional. + + + + Returns an enumeration of the most recent trace messages. + + An enumeration of the most recent trace messages. + + + + Returns a of the most recent trace messages. + + + A of the most recent trace messages. + + + + + Represents a method that constructs an object. + + The object type to create. + + + + When applied to a method, specifies that the method is called when an error occurs serializing an object. + + + + + Provides methods to get attributes from a , , or . + + + + + Initializes a new instance of the class. + + The instance to get attributes for. This parameter should be a , , or . + + + + Returns a collection of all of the attributes, or an empty collection if there are no attributes. + + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. + + + + Returns a collection of attributes, identified by type, or an empty collection if there are no attributes. + + The type of the attributes. + When true, look up the hierarchy chain for the inherited custom attribute. + A collection of s, or an empty collection. + + + + Get and set values for a using reflection. + + + + + Initializes a new instance of the class. + + The member info. + + + + Sets the value. + + The target to set the value on. + The value to set on the target. + + + + Gets the value. + + The target to get the value from. + The value. + + + + Specifies how strings are escaped when writing JSON text. + + + + + Only control characters (e.g. newline) are escaped. + + + + + All non-ASCII and control characters (e.g. newline) are escaped. + + + + + HTML (<, >, &, ', ") and control characters (e.g. newline) are escaped. + + + + + Specifies type name handling options for the . + + + should be used with caution when your application deserializes JSON from an external source. + Incoming types should be validated with a custom + when deserializing with a value other than TypeNameHandling.None. + + + + + Do not include the .NET type name when serializing types. + + + + + Include the .NET type name when serializing into a JSON object structure. + + + + + Include the .NET type name when serializing into a JSON array structure. + + + + + Always include the .NET type name when serializing. + + + + + Include the .NET type name when the type of the object being serialized is not the same as its declared type. + + + + + Determines whether the collection is null or empty. + + The collection. + + true if the collection is null or empty; otherwise, false. + + + + + Adds the elements of the specified collection to the specified generic IList. + + The list to add to. + The collection of elements to add. + + + + Converts the value to the specified type. If the value is unable to be converted, the + value is checked whether it assignable to the specified type. + + The value to convert. + The culture to use when converting. + The type to convert or cast the value to. + + The converted type. If conversion was unsuccessful, the initial value + is returned if assignable to the target type. + + + + + Helper method for generating a MetaObject which calls a + specific method on Dynamic that returns a result + + + + + Helper method for generating a MetaObject which calls a + specific method on Dynamic, but uses one of the arguments for + the result. + + + + + Helper method for generating a MetaObject which calls a + specific method on Dynamic, but uses one of the arguments for + the result. + + + + + Returns a Restrictions object which includes our current restrictions merged + with a restriction limiting our type + + + + + Gets a dictionary of the names and values of an Enum type. + + + + + + Gets a dictionary of the names and values of an Enum type. + + The enum type to get names and values for. + + + + + Gets the type of the typed collection's items. + + The type. + The type of the typed collection's items. + + + + Gets the member's underlying type. + + The member. + The underlying type of the member. + + + + Determines whether the member is an indexed property. + + The member. + + true if the member is an indexed property; otherwise, false. + + + + + Determines whether the property is an indexed property. + + The property. + + true if the property is an indexed property; otherwise, false. + + + + + Gets the member's value on the object. + + The member. + The target object. + The member's value on the object. + + + + Sets the member's value on the target object. + + The member. + The target. + The value. + + + + Determines whether the specified MemberInfo can be read. + + The MemberInfo to determine whether can be read. + /// if set to true then allow the member to be gotten non-publicly. + + true if the specified MemberInfo can be read; otherwise, false. + + + + + Determines whether the specified MemberInfo can be set. + + The MemberInfo to determine whether can be set. + if set to true then allow the member to be set non-publicly. + if set to true then allow the member to be set if read-only. + + true if the specified MemberInfo can be set; otherwise, false. + + + + + Builds a string. Unlike StringBuilder this class lets you reuse it's internal buffer. + + + + + Determines whether the string is all white space. Empty string will return false. + + The string to test whether it is all white space. + + true if the string is all white space; otherwise, false. + + + + + Specifies the state of the . + + + + + An exception has been thrown, which has left the in an invalid state. + You may call the method to put the in the Closed state. + Any other method calls results in an being thrown. + + + + + The method has been called. + + + + + An object is being written. + + + + + A array is being written. + + + + + A constructor is being written. + + + + + A property is being written. + + + + + A write method has not been called. + + + + diff --git a/lib/StackExchange.Redis.dll b/lib/StackExchange.Redis.dll new file mode 100644 index 0000000..af79dfc Binary files /dev/null and b/lib/StackExchange.Redis.dll differ diff --git a/lib/log4net.dll b/lib/log4net.dll new file mode 100644 index 0000000..47cd9ad Binary files /dev/null and b/lib/log4net.dll differ diff --git a/lib/log4net.xml b/lib/log4net.xml new file mode 100644 index 0000000..0697552 --- /dev/null +++ b/lib/log4net.xml @@ -0,0 +1,31128 @@ + + + + log4net + + + + + Appender that logs to a database. + + + + appends logging events to a table within a + database. The appender can be configured to specify the connection + string by setting the property. + The connection type (provider) can be specified by setting the + property. For more information on database connection strings for + your specific database see http://www.connectionstrings.com/. + + + Records are written into the database either using a prepared + statement or a stored procedure. The property + is set to (System.Data.CommandType.Text) to specify a prepared statement + or to (System.Data.CommandType.StoredProcedure) to specify a stored + procedure. + + + The prepared statement text or the name of the stored procedure + must be set in the property. + + + The prepared statement or stored procedure can take a number + of parameters. Parameters are added using the + method. This adds a single to the + ordered list of parameters. The + type may be subclassed if required to provide database specific + functionality. The specifies + the parameter name, database type, size, and how the value should + be generated using a . + + + + An example of a SQL Server table that could be logged to: + + CREATE TABLE [dbo].[Log] ( + [ID] [int] IDENTITY (1, 1) NOT NULL , + [Date] [datetime] NOT NULL , + [Thread] [varchar] (255) NOT NULL , + [Level] [varchar] (20) NOT NULL , + [Logger] [varchar] (255) NOT NULL , + [Message] [varchar] (4000) NOT NULL + ) ON [PRIMARY] + + + + An example configuration to log to the above table: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Julian Biddle + Nicko Cadell + Gert Driesen + Lance Nehring + + + + Abstract base class implementation of that + buffers events in a fixed size buffer. + + + + This base class should be used by appenders that need to buffer a + number of events before logging them. For example the + buffers events and then submits the entire contents of the buffer to + the underlying database in one go. + + + Subclasses should override the + method to deliver the buffered events. + + The BufferingAppenderSkeleton maintains a fixed size cyclic + buffer of events. The size of the buffer is set using + the property. + + A is used to inspect + each event as it arrives in the appender. If the + triggers, then the current buffer is sent immediately + (see ). Otherwise the event + is stored in the buffer. For example, an evaluator can be used to + deliver the events immediately when an ERROR event arrives. + + + The buffering appender can be configured in a mode. + By default the appender is NOT lossy. When the buffer is full all + the buffered events are sent with . + If the property is set to true then the + buffer will not be sent when it is full, and new events arriving + in the appender will overwrite the oldest event in the buffer. + In lossy mode the buffer will only be sent when the + triggers. This can be useful behavior when you need to know about + ERROR events but not about events with a lower level, configure an + evaluator that will trigger when an ERROR event arrives, the whole + buffer will be sent which gives a history of events leading up to + the ERROR event. + + + Nicko Cadell + Gert Driesen + + + + Abstract base class implementation of . + + + + This class provides the code for common functionality, such + as support for threshold filtering and support for general filters. + + + Appenders can also implement the interface. Therefore + they would require that the method + be called after the appenders properties have been configured. + + + Nicko Cadell + Gert Driesen + + + + Implement this interface for your own strategies for printing log statements. + + + + Implementors should consider extending the + class which provides a default implementation of this interface. + + + Appenders can also implement the interface. Therefore + they would require that the method + be called after the appenders properties have been configured. + + + Nicko Cadell + Gert Driesen + + + + Closes the appender and releases resources. + + + + Releases any resources allocated within the appender such as file handles, + network connections, etc. + + + It is a programming error to append to a closed appender. + + + + + + Log the logging event in Appender specific way. + + The event to log + + + This method is called to log a message into this appender. + + + + + + Gets or sets the name of this appender. + + The name of the appender. + + The name uniquely identifies the appender. + + + + + Interface for appenders that support bulk logging. + + + + This interface extends the interface to + support bulk logging of objects. Appenders + should only implement this interface if they can bulk log efficiently. + + + Nicko Cadell + + + + Log the array of logging events in Appender specific way. + + The events to log + + + This method is called to log an array of events into this appender. + + + + + + Interface used to delay activate a configured object. + + + + This allows an object to defer activation of its options until all + options have been set. This is required for components which have + related options that remain ambiguous until all are set. + + + If a component implements this interface then the method + must be called by the container after its all the configured properties have been set + and before the component can be used. + + + Nicko Cadell + + + + Activate the options that were previously set with calls to properties. + + + + This allows an object to defer activation of its options until all + options have been set. This is required for components which have + related options that remain ambiguous until all are set. + + + If a component implements this interface then this method must be called + after its properties have been set before the component can be used. + + + + + + Initial buffer size + + + + + Maximum buffer size before it is recycled + + + + + Default constructor + + + Empty default constructor + + + + + Finalizes this appender by calling the implementation's + method. + + + + If this appender has not been closed then the Finalize method + will call . + + + + + + Initialize the appender based on the options set + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + + + + Closes the appender and release resources. + + + + Release any resources allocated within the appender such as file handles, + network connections, etc. + + + It is a programming error to append to a closed appender. + + + This method cannot be overridden by subclasses. This method + delegates the closing of the appender to the + method which must be overridden in the subclass. + + + + + + Performs threshold checks and invokes filters before + delegating actual logging to the subclasses specific + method. + + The event to log. + + + This method cannot be overridden by derived classes. A + derived class should override the method + which is called by this method. + + + The implementation of this method is as follows: + + + + + + Checks that the severity of the + is greater than or equal to the of this + appender. + + + + Checks that the chain accepts the + . + + + + + Calls and checks that + it returns true. + + + + + If all of the above steps succeed then the + will be passed to the abstract method. + + + + + + Performs threshold checks and invokes filters before + delegating actual logging to the subclasses specific + method. + + The array of events to log. + + + This method cannot be overridden by derived classes. A + derived class should override the method + which is called by this method. + + + The implementation of this method is as follows: + + + + + + Checks that the severity of the + is greater than or equal to the of this + appender. + + + + Checks that the chain accepts the + . + + + + + Calls and checks that + it returns true. + + + + + If all of the above steps succeed then the + will be passed to the method. + + + + + + Test if the logging event should we output by this appender + + the event to test + true if the event should be output, false if the event should be ignored + + + This method checks the logging event against the threshold level set + on this appender and also against the filters specified on this + appender. + + + The implementation of this method is as follows: + + + + + + Checks that the severity of the + is greater than or equal to the of this + appender. + + + + Checks that the chain accepts the + . + + + + + + + + + Adds a filter to the end of the filter chain. + + the filter to add to this appender + + + The Filters are organized in a linked list. + + + Setting this property causes the new filter to be pushed onto the + back of the filter chain. + + + + + + Clears the filter list for this appender. + + + + Clears the filter list for this appender. + + + + + + Checks if the message level is below this appender's threshold. + + to test against. + + + If there is no threshold set, then the return value is always true. + + + + true if the meets the + requirements of this appender. + + + + + Is called when the appender is closed. Derived classes should override + this method if resources need to be released. + + + + Releases any resources allocated within the appender such as file handles, + network connections, etc. + + + It is a programming error to append to a closed appender. + + + + + + Subclasses of should implement this method + to perform actual logging. + + The event to append. + + + A subclass must implement this method to perform + logging of the . + + This method will be called by + if all the conditions listed for that method are met. + + + To restrict the logging of events in the appender + override the method. + + + + + + Append a bulk array of logging events. + + the array of logging events + + + This base class implementation calls the + method for each element in the bulk array. + + + A sub class that can better process a bulk array of events should + override this method in addition to . + + + + + + Called before as a precondition. + + + + This method is called by + before the call to the abstract method. + + + This method can be overridden in a subclass to extend the checks + made before the event is passed to the method. + + + A subclass should ensure that they delegate this call to + this base class if it is overridden. + + + true if the call to should proceed. + + + + Renders the to a string. + + The event to render. + The event rendered as a string. + + + Helper method to render a to + a string. This appender must have a + set to render the to + a string. + + If there is exception data in the logging event and + the layout does not process the exception, this method + will append the exception text to the rendered string. + + + Where possible use the alternative version of this method + . + That method streams the rendering onto an existing Writer + which can give better performance if the caller already has + a open and ready for writing. + + + + + + Renders the to a string. + + The event to render. + The TextWriter to write the formatted event to + + + Helper method to render a to + a string. This appender must have a + set to render the to + a string. + + If there is exception data in the logging event and + the layout does not process the exception, this method + will append the exception text to the rendered string. + + + Use this method in preference to + where possible. If, however, the caller needs to render the event + to a string then does + provide an efficient mechanism for doing so. + + + + + + The layout of this appender. + + + See for more information. + + + + + The name of this appender. + + + See for more information. + + + + + The level threshold of this appender. + + + + There is no level threshold filtering by default. + + + See for more information. + + + + + + It is assumed and enforced that errorHandler is never null. + + + + It is assumed and enforced that errorHandler is never null. + + + See for more information. + + + + + + The first filter in the filter chain. + + + + Set to null initially. + + + See for more information. + + + + + + The last filter in the filter chain. + + + See for more information. + + + + + Flag indicating if this appender is closed. + + + See for more information. + + + + + The guard prevents an appender from repeatedly calling its own DoAppend method + + + + + StringWriter used to render events + + + + + The fully qualified type of the AppenderSkeleton class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Gets or sets the threshold of this appender. + + + The threshold of the appender. + + + + All log events with lower level than the threshold level are ignored + by the appender. + + + In configuration files this option is specified by setting the + value of the option to a level + string, such as "DEBUG", "INFO" and so on. + + + + + + Gets or sets the for this appender. + + The of the appender + + + The provides a default + implementation for the property. + + + + + + The filter chain. + + The head of the filter chain filter chain. + + + Returns the head Filter. The Filters are organized in a linked list + and so all Filters on this Appender are available through the result. + + + + + + Gets or sets the for this appender. + + The layout of the appender. + + + See for more information. + + + + + + + Gets or sets the name of this appender. + + The name of the appender. + + + The name uniquely identifies the appender. + + + + + + Tests if this appender requires a to be set. + + + + In the rather exceptional case, where the appender + implementation admits a layout but can also work without it, + then the appender should return true. + + + This default implementation always returns false. + + + + true if the appender requires a layout object, otherwise false. + + + + + The default buffer size. + + + The default size of the cyclic buffer used to store events. + This is set to 512 by default. + + + + + Initializes a new instance of the class. + + + + Protected default constructor to allow subclassing. + + + + + + Initializes a new instance of the class. + + the events passed through this appender must be + fixed by the time that they arrive in the derived class' SendBuffer method. + + + Protected constructor to allow subclassing. + + + The should be set if the subclass + expects the events delivered to be fixed even if the + is set to zero, i.e. when no buffering occurs. + + + + + + Flush the currently buffered events + + + + Flushes any events that have been buffered. + + + If the appender is buffering in mode then the contents + of the buffer will NOT be flushed to the appender. + + + + + + Flush the currently buffered events + + set to true to flush the buffer of lossy events + + + Flushes events that have been buffered. If is + false then events will only be flushed if this buffer is non-lossy mode. + + + If the appender is buffering in mode then the contents + of the buffer will only be flushed if is true. + In this case the contents of the buffer will be tested against the + and if triggering will be output. All other buffered + events will be discarded. + + + If is true then the buffer will always + be emptied by calling this method. + + + + + + Initialize the appender based on the options set + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + + + + Close this appender instance. + + + + Close this appender instance. If this appender is marked + as not then the remaining events in + the buffer must be sent when the appender is closed. + + + + + + This method is called by the method. + + the event to log + + + Stores the in the cyclic buffer. + + + The buffer will be sent (i.e. passed to the + method) if one of the following conditions is met: + + + + The cyclic buffer is full and this appender is + marked as not lossy (see ) + + + An is set and + it is triggered for the + specified. + + + + Before the event is stored in the buffer it is fixed + (see ) to ensure that + any data referenced by the event will be valid when the buffer + is processed. + + + + + + Sends the contents of the buffer. + + The first logging event. + The buffer containing the events that need to be send. + + + The subclass must override . + + + + + + Sends the events. + + The events that need to be send. + + + The subclass must override this method to process the buffered events. + + + + + + The size of the cyclic buffer used to hold the logging events. + + + Set to by default. + + + + + The cyclic buffer used to store the logging events. + + + + + The triggering event evaluator that causes the buffer to be sent immediately. + + + The object that is used to determine if an event causes the entire + buffer to be sent immediately. This field can be null, which + indicates that event triggering is not to be done. The evaluator + can be set using the property. If this appender + has the ( property) set to + true then an must be set. + + + + + Indicates if the appender should overwrite events in the cyclic buffer + when it becomes full, or if the buffer should be flushed when the + buffer is full. + + + If this field is set to true then an must + be set. + + + + + The triggering event evaluator filters discarded events. + + + The object that is used to determine if an event that is discarded should + really be discarded or if it should be sent to the appenders. + This field can be null, which indicates that all discarded events will + be discarded. + + + + + Value indicating which fields in the event should be fixed + + + By default all fields are fixed + + + + + The events delivered to the subclass must be fixed. + + + + + Gets or sets a value that indicates whether the appender is lossy. + + + true if the appender is lossy, otherwise false. The default is false. + + + + This appender uses a buffer to store logging events before + delivering them. A triggering event causes the whole buffer + to be send to the remote sink. If the buffer overruns before + a triggering event then logging events could be lost. Set + to false to prevent logging events + from being lost. + + If is set to true then an + must be specified. + + + + + Gets or sets the size of the cyclic buffer used to hold the + logging events. + + + The size of the cyclic buffer used to hold the logging events. + + + + The option takes a positive integer + representing the maximum number of logging events to collect in + a cyclic buffer. When the is reached, + oldest events are deleted as new events are added to the + buffer. By default the size of the cyclic buffer is 512 events. + + + If the is set to a value less than + or equal to 1 then no buffering will occur. The logging event + will be delivered synchronously (depending on the + and properties). Otherwise the event will + be buffered. + + + + + + Gets or sets the that causes the + buffer to be sent immediately. + + + The that causes the buffer to be + sent immediately. + + + + The evaluator will be called for each event that is appended to this + appender. If the evaluator triggers then the current buffer will + immediately be sent (see ). + + If is set to true then an + must be specified. + + + + + Gets or sets the value of the to use. + + + The value of the to use. + + + + The evaluator will be called for each event that is discarded from this + appender. If the evaluator triggers then the current buffer will immediately + be sent (see ). + + + + + + Gets or sets a value indicating if only part of the logging event data + should be fixed. + + + true if the appender should only fix part of the logging event + data, otherwise false. The default is false. + + + + Setting this property to true will cause only part of the + event data to be fixed and serialized. This will improve performance. + + + See for more information. + + + + + + Gets or sets a the fields that will be fixed in the event + + + The event fields that will be fixed before the event is buffered + + + + The logging event needs to have certain thread specific values + captured before it can be buffered. See + for details. + + + + + + + Initializes a new instance of the class. + + + Public default constructor to initialize a new instance of this class. + + + + + Initialize the appender based on the options set + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + + + + Override the parent method to close the database + + + + Closes the database command and database connection. + + + + + + Inserts the events into the database. + + The events to insert into the database. + + + Insert all the events specified in the + array into the database. + + + + + + Adds a parameter to the command. + + The parameter to add to the command. + + + Adds a parameter to the ordered list of command parameters. + + + + + + Writes the events to the database using the transaction specified. + + The transaction that the events will be executed under. + The array of events to insert into the database. + + + The transaction argument can be null if the appender has been + configured not to use transactions. See + property for more information. + + + + + + Formats the log message into database statement text. + + The event being logged. + + This method can be overridden by subclasses to provide + more control over the format of the database statement. + + + Text that can be passed to a . + + + + + Creates an instance used to connect to the database. + + + This method is called whenever a new IDbConnection is needed (i.e. when a reconnect is necessary). + + The of the object. + The connectionString output from the ResolveConnectionString method. + An instance with a valid connection string. + + + + Resolves the connection string from the ConnectionString, ConnectionStringName, or AppSettingsKey + property. + + + ConnectiongStringName is only supported on .NET 2.0 and higher. + + Additional information describing the connection string. + A connection string used to connect to the database. + + + + Retrieves the class type of the ADO.NET provider. + + + + Gets the Type of the ADO.NET provider to use to connect to the + database. This method resolves the type specified in the + property. + + + Subclasses can override this method to return a different type + if necessary. + + + The of the ADO.NET provider + + + + Connects to the database. + + + + + Cleanup the existing connection. + + + Calls the IDbConnection's method. + + + + + The list of objects. + + + + The list of objects. + + + + + + The security context to use for privileged calls + + + + + The that will be used + to insert logging events into a database. + + + + + Database connection string. + + + + + The appSettings key from App.Config that contains the connection string. + + + + + The connectionStrings key from App.Config that contains the connection string. + + + + + String type name of the type name. + + + + + The text of the command. + + + + + The command type. + + + + + Indicates whether to use transactions when writing to the database. + + + + + Indicates whether to reconnect when a connection is lost. + + + + + The fully qualified type of the AdoNetAppender class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Gets or sets the database connection string that is used to connect to + the database. + + + The database connection string used to connect to the database. + + + + The connections string is specific to the connection type. + See for more information. + + + Connection string for MS Access via ODBC: + "DSN=MS Access Database;UID=admin;PWD=;SystemDB=C:\data\System.mdw;SafeTransactions = 0;FIL=MS Access;DriverID = 25;DBQ=C:\data\train33.mdb" + + Another connection string for MS Access via ODBC: + "Driver={Microsoft Access Driver (*.mdb)};DBQ=C:\Work\cvs_root\log4net-1.2\access.mdb;UID=;PWD=;" + + Connection string for MS Access via OLE DB: + "Provider=Microsoft.Jet.OLEDB.4.0;Data Source=C:\Work\cvs_root\log4net-1.2\access.mdb;User Id=;Password=;" + + + + + The appSettings key from App.Config that contains the connection string. + + + + + The connectionStrings key from App.Config that contains the connection string. + + + This property requires at least .NET 2.0. + + + + + Gets or sets the type name of the connection + that should be created. + + + The type name of the connection. + + + + The type name of the ADO.NET provider to use. + + + The default is to use the OLE DB provider. + + + Use the OLE DB Provider. This is the default value. + System.Data.OleDb.OleDbConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + Use the MS SQL Server Provider. + System.Data.SqlClient.SqlConnection, System.Data, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + + Use the ODBC Provider. + Microsoft.Data.Odbc.OdbcConnection,Microsoft.Data.Odbc,version=1.0.3300.0,publicKeyToken=b77a5c561934e089,culture=neutral + This is an optional package that you can download from + http://msdn.microsoft.com/downloads + search for ODBC .NET Data Provider. + + Use the Oracle Provider. + System.Data.OracleClient.OracleConnection, System.Data.OracleClient, Version=1.0.3300.0, Culture=neutral, PublicKeyToken=b77a5c561934e089 + This is an optional package that you can download from + http://msdn.microsoft.com/downloads + search for .NET Managed Provider for Oracle. + + + + + Gets or sets the command text that is used to insert logging events + into the database. + + + The command text used to insert logging events into the database. + + + + Either the text of the prepared statement or the + name of the stored procedure to execute to write into + the database. + + + The property determines if + this text is a prepared statement or a stored procedure. + + + If this property is not set, the command text is retrieved by invoking + . + + + + + + Gets or sets the command type to execute. + + + The command type to execute. + + + + This value may be either (System.Data.CommandType.Text) to specify + that the is a prepared statement to execute, + or (System.Data.CommandType.StoredProcedure) to specify that the + property is the name of a stored procedure + to execute. + + + The default value is (System.Data.CommandType.Text). + + + + + + Should transactions be used to insert logging events in the database. + + + true if transactions should be used to insert logging events in + the database, otherwise false. The default value is true. + + + + Gets or sets a value that indicates whether transactions should be used + to insert logging events in the database. + + + When set a single transaction will be used to insert the buffered events + into the database. Otherwise each event will be inserted without using + an explicit transaction. + + + + + + Gets or sets the used to call the NetSend method. + + + The used to call the NetSend method. + + + + Unless a specified here for this appender + the is queried for the + security context to use. The default behavior is to use the security context + of the current thread. + + + + + + Should this appender try to reconnect to the database on error. + + + true if the appender should try to reconnect to the database after an + error has occurred, otherwise false. The default value is false, + i.e. not to try to reconnect. + + + + The default behaviour is for the appender not to try to reconnect to the + database if an error occurs. Subsequent logging events are discarded. + + + To force the appender to attempt to reconnect to the database set this + property to true. + + + When the appender attempts to connect to the database there may be a + delay of up to the connection timeout specified in the connection string. + This delay will block the calling application's thread. + Until the connection can be reestablished this potential delay may occur multiple times. + + + + + + Gets or sets the underlying . + + + The underlying . + + + creates a to insert + logging events into a database. Classes deriving from + can use this property to get or set this . Use the + underlying returned from if + you require access beyond that which provides. + + + + + Parameter type used by the . + + + + This class provides the basic database parameter properties + as defined by the interface. + + This type can be subclassed to provide database specific + functionality. The two methods that are called externally are + and . + + + + + + Initializes a new instance of the class. + + + Default constructor for the AdoNetAppenderParameter class. + + + + + Prepare the specified database command object. + + The command to prepare. + + + Prepares the database command object by adding + this parameter to its collection of parameters. + + + + + + Renders the logging event and set the parameter value in the command. + + The command containing the parameter. + The event to be rendered. + + + Renders the logging event using this parameters layout + object. Sets the value of the parameter on the command object. + + + + + + The name of this parameter. + + + + + The database type for this parameter. + + + + + Flag to infer type rather than use the DbType + + + + + The precision for this parameter. + + + + + The scale for this parameter. + + + + + The size for this parameter. + + + + + The to use to render the + logging event into an object for this parameter. + + + + + Gets or sets the name of this parameter. + + + The name of this parameter. + + + + The name of this parameter. The parameter name + must match up to a named parameter to the SQL stored procedure + or prepared statement. + + + + + + Gets or sets the database type for this parameter. + + + The database type for this parameter. + + + + The database type for this parameter. This property should + be set to the database type from the + enumeration. See . + + + This property is optional. If not specified the ADO.NET provider + will attempt to infer the type from the value. + + + + + + + Gets or sets the precision for this parameter. + + + The precision for this parameter. + + + + The maximum number of digits used to represent the Value. + + + This property is optional. If not specified the ADO.NET provider + will attempt to infer the precision from the value. + + + + + + + Gets or sets the scale for this parameter. + + + The scale for this parameter. + + + + The number of decimal places to which Value is resolved. + + + This property is optional. If not specified the ADO.NET provider + will attempt to infer the scale from the value. + + + + + + + Gets or sets the size for this parameter. + + + The size for this parameter. + + + + The maximum size, in bytes, of the data within the column. + + + This property is optional. If not specified the ADO.NET provider + will attempt to infer the size from the value. + + + For BLOB data types like VARCHAR(max) it may be impossible to infer the value automatically, use -1 as the size in this case. + + + + + + + Gets or sets the to use to + render the logging event into an object for this + parameter. + + + The used to render the + logging event into an object for this parameter. + + + + The that renders the value for this + parameter. + + + The can be used to adapt + any into a + for use in the property. + + + + + + Appends logging events to the terminal using ANSI color escape sequences. + + + + AnsiColorTerminalAppender appends log events to the standard output stream + or the error output stream using a layout specified by the + user. It also allows the color of a specific level of message to be set. + + + This appender expects the terminal to understand the VT100 control set + in order to interpret the color codes. If the terminal or console does not + understand the control codes the behavior is not defined. + + + By default, all output is written to the console's standard output stream. + The property can be set to direct the output to the + error stream. + + + NOTE: This appender writes each message to the System.Console.Out or + System.Console.Error that is set at the time the event is appended. + Therefore it is possible to programmatically redirect the output of this appender + (for example NUnit does this to capture program output). While this is the desired + behavior of this appender it may have security implications in your application. + + + When configuring the ANSI colored terminal appender, a mapping should be + specified to map a logging level to a color. For example: + + + + + + + + + + + + + + + The Level is the standard log4net logging level and ForeColor and BackColor can be any + of the following values: + + Blue + Green + Red + White + Yellow + Purple + Cyan + + These color values cannot be combined together to make new colors. + + + The attributes can be any combination of the following: + + Brightforeground is brighter + Dimforeground is dimmer + Underscoremessage is underlined + Blinkforeground is blinking (does not work on all terminals) + Reverseforeground and background are reversed + Hiddenoutput is hidden + Strikethroughmessage has a line through it + + While any of these attributes may be combined together not all combinations + work well together, for example setting both Bright and Dim attributes makes + no sense. + + + Patrick Wagstrom + Nicko Cadell + + + + The to use when writing to the Console + standard output stream. + + + + The to use when writing to the Console + standard output stream. + + + + + + The to use when writing to the Console + standard error output stream. + + + + The to use when writing to the Console + standard error output stream. + + + + + + Ansi code to reset terminal + + + + + Initializes a new instance of the class. + + + The instance of the class is set up to write + to the standard output stream. + + + + + Add a mapping of level to color + + The mapping to add + + + Add a mapping to this appender. + Each mapping defines the foreground and background colours + for a level. + + + + + + This method is called by the method. + + The event to log. + + + Writes the event to the console. + + + The format of the output will depend on the appender's layout. + + + + + + Initialize the options for this appender + + + + Initialize the level to color mappings set on this appender. + + + + + + Flag to write output to the error stream rather than the standard output stream + + + + + Mapping from level object to color value + + + + + Target is the value of the console output stream. + + + Target is the value of the console output stream. + This is either "Console.Out" or "Console.Error". + + + + Target is the value of the console output stream. + This is either "Console.Out" or "Console.Error". + + + + + + This appender requires a to be set. + + true + + + This appender requires a to be set. + + + + + + The enum of possible display attributes + + + + The following flags can be combined together to + form the ANSI color attributes. + + + + + + + text is bright + + + + + text is dim + + + + + text is underlined + + + + + text is blinking + + + Not all terminals support this attribute + + + + + text and background colors are reversed + + + + + text is hidden + + + + + text is displayed with a strikethrough + + + + + text color is light + + + + + The enum of possible foreground or background color values for + use with the color mapping method + + + + The output can be in one for the following ANSI colors. + + + + + + + color is black + + + + + color is red + + + + + color is green + + + + + color is yellow + + + + + color is blue + + + + + color is magenta + + + + + color is cyan + + + + + color is white + + + + + A class to act as a mapping between the level that a logging call is made at and + the color it should be displayed as. + + + + Defines the mapping between a level and the color it should be displayed in. + + + + + + An entry in the + + + + This is an abstract base class for types that are stored in the + object. + + + Nicko Cadell + + + + Default protected constructor + + + + Default protected constructor + + + + + + Initialize any options defined on this entry + + + + Should be overridden by any classes that need to initialise based on their options + + + + + + The level that is the key for this mapping + + + The that is the key for this mapping + + + + Get or set the that is the key for this + mapping subclass. + + + + + + Initialize the options for the object + + + + Combine the and together + and append the attributes. + + + + + + The mapped foreground color for the specified level + + + + Required property. + The mapped foreground color for the specified level + + + + + + The mapped background color for the specified level + + + + Required property. + The mapped background color for the specified level + + + + + + The color attributes for the specified level + + + + Required property. + The color attributes for the specified level + + + + + + The combined , and + suitable for setting the ansi terminal color. + + + + + A strongly-typed collection of objects. + + Nicko Cadell + + + + Creates a read-only wrapper for a AppenderCollection instance. + + list to create a readonly wrapper arround + + An AppenderCollection wrapper that is read-only. + + + + + An empty readonly static AppenderCollection + + + + + Initializes a new instance of the AppenderCollection class + that is empty and has the default initial capacity. + + + + + Initializes a new instance of the AppenderCollection class + that has the specified initial capacity. + + + The number of elements that the new AppenderCollection is initially capable of storing. + + + + + Initializes a new instance of the AppenderCollection class + that contains elements copied from the specified AppenderCollection. + + The AppenderCollection whose elements are copied to the new collection. + + + + Initializes a new instance of the AppenderCollection class + that contains elements copied from the specified array. + + The array whose elements are copied to the new list. + + + + Initializes a new instance of the AppenderCollection class + that contains elements copied from the specified collection. + + The collection whose elements are copied to the new list. + + + + Allow subclasses to avoid our default constructors + + + + + + + Copies the entire AppenderCollection to a one-dimensional + array. + + The one-dimensional array to copy to. + + + + Copies the entire AppenderCollection to a one-dimensional + array, starting at the specified index of the target array. + + The one-dimensional array to copy to. + The zero-based index in at which copying begins. + + + + Adds a to the end of the AppenderCollection. + + The to be added to the end of the AppenderCollection. + The index at which the value has been added. + + + + Removes all elements from the AppenderCollection. + + + + + Creates a shallow copy of the . + + A new with a shallow copy of the collection data. + + + + Determines whether a given is in the AppenderCollection. + + The to check for. + true if is found in the AppenderCollection; otherwise, false. + + + + Returns the zero-based index of the first occurrence of a + in the AppenderCollection. + + The to locate in the AppenderCollection. + + The zero-based index of the first occurrence of + in the entire AppenderCollection, if found; otherwise, -1. + + + + + Inserts an element into the AppenderCollection at the specified index. + + The zero-based index at which should be inserted. + The to insert. + + is less than zero + -or- + is equal to or greater than . + + + + + Removes the first occurrence of a specific from the AppenderCollection. + + The to remove from the AppenderCollection. + + The specified was not found in the AppenderCollection. + + + + + Removes the element at the specified index of the AppenderCollection. + + The zero-based index of the element to remove. + + is less than zero + -or- + is equal to or greater than . + + + + + Returns an enumerator that can iterate through the AppenderCollection. + + An for the entire AppenderCollection. + + + + Adds the elements of another AppenderCollection to the current AppenderCollection. + + The AppenderCollection whose elements should be added to the end of the current AppenderCollection. + The new of the AppenderCollection. + + + + Adds the elements of a array to the current AppenderCollection. + + The array whose elements should be added to the end of the AppenderCollection. + The new of the AppenderCollection. + + + + Adds the elements of a collection to the current AppenderCollection. + + The collection whose elements should be added to the end of the AppenderCollection. + The new of the AppenderCollection. + + + + Sets the capacity to the actual number of elements. + + + + + Return the collection elements as an array + + the array + + + + is less than zero + -or- + is equal to or greater than . + + + + + is less than zero + -or- + is equal to or greater than . + + + + + Gets the number of elements actually contained in the AppenderCollection. + + + + + Gets a value indicating whether access to the collection is synchronized (thread-safe). + + true if access to the ICollection is synchronized (thread-safe); otherwise, false. + + + + Gets an object that can be used to synchronize access to the collection. + + + + + Gets or sets the at the specified index. + + The zero-based index of the element to get or set. + + is less than zero + -or- + is equal to or greater than . + + + + + Gets a value indicating whether the collection has a fixed size. + + true if the collection has a fixed size; otherwise, false. The default is false + + + + Gets a value indicating whether the IList is read-only. + + true if the collection is read-only; otherwise, false. The default is false + + + + Gets or sets the number of elements the AppenderCollection can contain. + + + + + Supports type-safe iteration over a . + + + + + + Advances the enumerator to the next element in the collection. + + + true if the enumerator was successfully advanced to the next element; + false if the enumerator has passed the end of the collection. + + + The collection was modified after the enumerator was created. + + + + + Sets the enumerator to its initial position, before the first element in the collection. + + + + + Gets the current element in the collection. + + + + + Type visible only to our subclasses + Used to access protected constructor + + + + + + A value + + + + + Supports simple iteration over a . + + + + + + Initializes a new instance of the Enumerator class. + + + + + + Advances the enumerator to the next element in the collection. + + + true if the enumerator was successfully advanced to the next element; + false if the enumerator has passed the end of the collection. + + + The collection was modified after the enumerator was created. + + + + + Sets the enumerator to its initial position, before the first element in the collection. + + + + + Gets the current element in the collection. + + + + + + + + + Appends log events to the ASP.NET system. + + + + + Diagnostic information and tracing messages that you specify are appended to the output + of the page that is sent to the requesting browser. Optionally, you can view this information + from a separate trace viewer (Trace.axd) that displays trace information for every page in a + given application. + + + Trace statements are processed and displayed only when tracing is enabled. You can control + whether tracing is displayed to a page, to the trace viewer, or both. + + + The logging event is passed to the or + method depending on the level of the logging event. + The event's logger name is the default value for the category parameter of the Write/Warn method. + + + Nicko Cadell + Gert Driesen + Ron Grabowski + + + + Initializes a new instance of the class. + + + + Default constructor. + + + + + + Write the logging event to the ASP.NET trace + + the event to log + + + Write the logging event to the ASP.NET trace + HttpContext.Current.Trace + (). + + + + + + Defaults to %logger + + + + + This appender requires a to be set. + + true + + + This appender requires a to be set. + + + + + + The category parameter sent to the Trace method. + + + + Defaults to %logger which will use the logger name of the current + as the category parameter. + + + + + + + + Buffers events and then forwards them to attached appenders. + + + + The events are buffered in this appender until conditions are + met to allow the appender to deliver the events to the attached + appenders. See for the + conditions that cause the buffer to be sent. + + The forwarding appender can be used to specify different + thresholds and filters for the same appender at different locations + within the hierarchy. + + + Nicko Cadell + Gert Driesen + + + + Interface for attaching appenders to objects. + + + + Interface for attaching, removing and retrieving appenders. + + + Nicko Cadell + Gert Driesen + + + + Attaches an appender. + + The appender to add. + + + Add the specified appender. The implementation may + choose to allow or deny duplicate appenders. + + + + + + Gets an attached appender with the specified name. + + The name of the appender to get. + + The appender with the name specified, or null if no appender with the + specified name is found. + + + + Returns an attached appender with the specified. + If no appender with the specified name is found null will be + returned. + + + + + + Removes all attached appenders. + + + + Removes and closes all attached appenders + + + + + + Removes the specified appender from the list of attached appenders. + + The appender to remove. + The appender removed from the list + + + The appender removed is not closed. + If you are discarding the appender you must call + on the appender removed. + + + + + + Removes the appender with the specified name from the list of appenders. + + The name of the appender to remove. + The appender removed from the list + + + The appender removed is not closed. + If you are discarding the appender you must call + on the appender removed. + + + + + + Gets all attached appenders. + + + A collection of attached appenders. + + + + Gets a collection of attached appenders. + If there are no attached appenders the + implementation should return an empty + collection rather than null. + + + + + + Initializes a new instance of the class. + + + + Default constructor. + + + + + + Closes the appender and releases resources. + + + + Releases any resources allocated within the appender such as file handles, + network connections, etc. + + + It is a programming error to append to a closed appender. + + + + + + Send the events. + + The events that need to be send. + + + Forwards the events to the attached appenders. + + + + + + Adds an to the list of appenders of this + instance. + + The to add to this appender. + + + If the specified is already in the list of + appenders, then it won't be added again. + + + + + + Looks for the appender with the specified name. + + The name of the appender to lookup. + + The appender with the specified name, or null. + + + + Get the named appender attached to this buffering appender. + + + + + + Removes all previously added appenders from this appender. + + + + This is useful when re-reading configuration information. + + + + + + Removes the specified appender from the list of appenders. + + The appender to remove. + The appender removed from the list + + The appender removed is not closed. + If you are discarding the appender you must call + on the appender removed. + + + + + Removes the appender with the specified name from the list of appenders. + + The name of the appender to remove. + The appender removed from the list + + The appender removed is not closed. + If you are discarding the appender you must call + on the appender removed. + + + + + Implementation of the interface + + + + + Gets the appenders contained in this appender as an + . + + + If no appenders can be found, then an + is returned. + + + A collection of the appenders in this appender. + + + + + Appends logging events to the console. + + + + ColoredConsoleAppender appends log events to the standard output stream + or the error output stream using a layout specified by the + user. It also allows the color of a specific type of message to be set. + + + By default, all output is written to the console's standard output stream. + The property can be set to direct the output to the + error stream. + + + NOTE: This appender writes directly to the application's attached console + not to the System.Console.Out or System.Console.Error TextWriter. + The System.Console.Out and System.Console.Error streams can be + programmatically redirected (for example NUnit does this to capture program output). + This appender will ignore these redirections because it needs to use Win32 + API calls to colorize the output. To respect these redirections the + must be used. + + + When configuring the colored console appender, mapping should be + specified to map a logging level to a color. For example: + + + + + + + + + + + + + + The Level is the standard log4net logging level and ForeColor and BackColor can be any + combination of the following values: + + Blue + Green + Red + White + Yellow + Purple + Cyan + HighIntensity + + + + Rick Hobbs + Nicko Cadell + + + + The to use when writing to the Console + standard output stream. + + + + The to use when writing to the Console + standard output stream. + + + + + + The to use when writing to the Console + standard error output stream. + + + + The to use when writing to the Console + standard error output stream. + + + + + + Initializes a new instance of the class. + + + The instance of the class is set up to write + to the standard output stream. + + + + + Initializes a new instance of the class + with the specified layout. + + the layout to use for this appender + + The instance of the class is set up to write + to the standard output stream. + + + + + Initializes a new instance of the class + with the specified layout. + + the layout to use for this appender + flag set to true to write to the console error stream + + When is set to true, output is written to + the standard error output stream. Otherwise, output is written to the standard + output stream. + + + + + Add a mapping of level to color - done by the config file + + The mapping to add + + + Add a mapping to this appender. + Each mapping defines the foreground and background colors + for a level. + + + + + + This method is called by the method. + + The event to log. + + + Writes the event to the console. + + + The format of the output will depend on the appender's layout. + + + + + + Initialize the options for this appender + + + + Initialize the level to color mappings set on this appender. + + + + + + Flag to write output to the error stream rather than the standard output stream + + + + + Mapping from level object to color value + + + + + The console output stream writer to write to + + + + This writer is not thread safe. + + + + + + Target is the value of the console output stream. + This is either "Console.Out" or "Console.Error". + + + Target is the value of the console output stream. + This is either "Console.Out" or "Console.Error". + + + + Target is the value of the console output stream. + This is either "Console.Out" or "Console.Error". + + + + + + This appender requires a to be set. + + true + + + This appender requires a to be set. + + + + + + The enum of possible color values for use with the color mapping method + + + + The following flags can be combined together to + form the colors. + + + + + + + color is blue + + + + + color is green + + + + + color is red + + + + + color is white + + + + + color is yellow + + + + + color is purple + + + + + color is cyan + + + + + color is intensified + + + + + A class to act as a mapping between the level that a logging call is made at and + the color it should be displayed as. + + + + Defines the mapping between a level and the color it should be displayed in. + + + + + + Initialize the options for the object + + + + Combine the and together. + + + + + + The mapped foreground color for the specified level + + + + Required property. + The mapped foreground color for the specified level. + + + + + + The mapped background color for the specified level + + + + Required property. + The mapped background color for the specified level. + + + + + + The combined and suitable for + setting the console color. + + + + + Appends logging events to the console. + + + + ConsoleAppender appends log events to the standard output stream + or the error output stream using a layout specified by the + user. + + + By default, all output is written to the console's standard output stream. + The property can be set to direct the output to the + error stream. + + + NOTE: This appender writes each message to the System.Console.Out or + System.Console.Error that is set at the time the event is appended. + Therefore it is possible to programmatically redirect the output of this appender + (for example NUnit does this to capture program output). While this is the desired + behavior of this appender it may have security implications in your application. + + + Nicko Cadell + Gert Driesen + + + + The to use when writing to the Console + standard output stream. + + + + The to use when writing to the Console + standard output stream. + + + + + + The to use when writing to the Console + standard error output stream. + + + + The to use when writing to the Console + standard error output stream. + + + + + + Initializes a new instance of the class. + + + The instance of the class is set up to write + to the standard output stream. + + + + + Initializes a new instance of the class + with the specified layout. + + the layout to use for this appender + + The instance of the class is set up to write + to the standard output stream. + + + + + Initializes a new instance of the class + with the specified layout. + + the layout to use for this appender + flag set to true to write to the console error stream + + When is set to true, output is written to + the standard error output stream. Otherwise, output is written to the standard + output stream. + + + + + This method is called by the method. + + The event to log. + + + Writes the event to the console. + + + The format of the output will depend on the appender's layout. + + + + + + Target is the value of the console output stream. + This is either "Console.Out" or "Console.Error". + + + Target is the value of the console output stream. + This is either "Console.Out" or "Console.Error". + + + + Target is the value of the console output stream. + This is either "Console.Out" or "Console.Error". + + + + + + This appender requires a to be set. + + true + + + This appender requires a to be set. + + + + + + Appends log events to the system. + + + + The application configuration file can be used to control what listeners + are actually used. See the MSDN documentation for the + class for details on configuring the + debug system. + + + Events are written using the + method. The event's logger name is passed as the value for the category name to the Write method. + + + Nicko Cadell + + + + Initializes a new instance of the . + + + + Default constructor. + + + + + + Initializes a new instance of the + with a specified layout. + + The layout to use with this appender. + + + Obsolete constructor. + + + + + + Writes the logging event to the system. + + The event to log. + + + Writes the logging event to the system. + If is true then the + is called. + + + + + + Immediate flush means that the underlying writer or output stream + will be flushed at the end of each append operation. + + + + Immediate flush is slower but ensures that each append request is + actually written. If is set to + false, then there is a good chance that the last few + logs events are not actually written to persistent media if and + when the application crashes. + + + The default value is true. + + + + + Gets or sets a value that indicates whether the appender will + flush at the end of each write. + + + The default behavior is to flush at the end of each + write. If the option is set tofalse, then the underlying + stream can defer writing to physical medium to a later time. + + + Avoiding the flush operation at the end of each append results + in a performance gain of 10 to 20 percent. However, there is safety + trade-off involved in skipping flushing. Indeed, when flushing is + skipped, then it is likely that the last few log events will not + be recorded on disk when the application exits. This is a high + price to pay even for a 20% performance gain. + + + + + + This appender requires a to be set. + + true + + + This appender requires a to be set. + + + + + + Writes events to the system event log. + + + + The appender will fail if you try to write using an event source that doesn't exist unless it is running with local administrator privileges. + See also http://logging.apache.org/log4net/release/faq.html#trouble-EventLog + + + The EventID of the event log entry can be + set using the EventID property () + on the . + + + The Category of the event log entry can be + set using the Category property () + on the . + + + There is a limit of 32K characters for an event log message + + + When configuring the EventLogAppender a mapping can be + specified to map a logging level to an event log entry type. For example: + + + <mapping> + <level value="ERROR" /> + <eventLogEntryType value="Error" /> + </mapping> + <mapping> + <level value="DEBUG" /> + <eventLogEntryType value="Information" /> + </mapping> + + + The Level is the standard log4net logging level and eventLogEntryType can be any value + from the enum, i.e.: + + Erroran error event + Warninga warning event + Informationan informational event + + + + Aspi Havewala + Douglas de la Torre + Nicko Cadell + Gert Driesen + Thomas Voss + + + + Initializes a new instance of the class. + + + + Default constructor. + + + + + + Initializes a new instance of the class + with the specified . + + The to use with this appender. + + + Obsolete constructor. + + + + + + Add a mapping of level to - done by the config file + + The mapping to add + + + Add a mapping to this appender. + Each mapping defines the event log entry type for a level. + + + + + + Initialize the appender based on the options set + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + + + + Create an event log source + + + Uses different API calls under NET_2_0 + + + + + This method is called by the + method. + + the event to log + + Writes the event to the system event log using the + . + + If the event has an EventID property (see ) + set then this integer will be used as the event log event id. + + + There is a limit of 32K characters for an event log message + + + + + + Get the equivalent for a + + the Level to convert to an EventLogEntryType + The equivalent for a + + Because there are fewer applicable + values to use in logging levels than there are in the + this is a one way mapping. There is + a loss of information during the conversion. + + + + + The log name is the section in the event logs where the messages + are stored. + + + + + Name of the application to use when logging. This appears in the + application column of the event log named by . + + + + + The name of the machine which holds the event log. This is + currently only allowed to be '.' i.e. the current machine. + + + + + Mapping from level object to EventLogEntryType + + + + + The security context to use for privileged calls + + + + + The event ID to use unless one is explicitly specified via the LoggingEvent's properties. + + + + + The event category to use unless one is explicitly specified via the LoggingEvent's properties. + + + + + The fully qualified type of the EventLogAppender class. + + + Used by the internal logger to record the Type of the + log message. + + + + + The maximum size supported by default. + + + http://msdn.microsoft.com/en-us/library/xzwc042w(v=vs.100).aspx + The 32766 documented max size is two bytes shy of 32K (I'm assuming 32766 + may leave space for a two byte null terminator of #0#0). The 32766 max + length is what the .NET 4.0 source code checks for, but this is WRONG! + Strings with a length > 31839 on Windows Vista or higher can CORRUPT + the event log! See: System.Diagnostics.EventLogInternal.InternalWriteEvent() + for the use of the 32766 max size. + + + + + The maximum size supported by a windows operating system that is vista + or newer. + + + See ReportEvent API: + http://msdn.microsoft.com/en-us/library/aa363679(VS.85).aspx + ReportEvent's lpStrings parameter: + "A pointer to a buffer containing an array of + null-terminated strings that are merged into the message before Event Viewer + displays the string to the user. This parameter must be a valid pointer + (or NULL), even if wNumStrings is zero. Each string is limited to 31,839 characters." + + Going beyond the size of 31839 will (at some point) corrupt the event log on Windows + Vista or higher! It may succeed for a while...but you will eventually run into the + error: "System.ComponentModel.Win32Exception : A device attached to the system is + not functioning", and the event log will then be corrupt (I was able to corrupt + an event log using a length of 31877 on Windows 7). + + The max size for Windows Vista or higher is documented here: + http://msdn.microsoft.com/en-us/library/xzwc042w(v=vs.100).aspx. + Going over this size may succeed a few times but the buffer will overrun and + eventually corrupt the log (based on testing). + + The maxEventMsgSize size is based on the max buffer size of the lpStrings parameter of the ReportEvent API. + The documented max size for EventLog.WriteEntry for Windows Vista and higher is 31839, but I'm leaving room for a + terminator of #0#0, as we cannot see the source of ReportEvent (though we could use an API monitor to examine the + buffer, given enough time). + + + + + The maximum size that the operating system supports for + a event log message. + + + Used to determine the maximum string length that can be written + to the operating system event log and eventually truncate a string + that exceeds the limits. + + + + + This method determines the maximum event log message size allowed for + the current environment. + + + + + + The name of the log where messages will be stored. + + + The string name of the log where messages will be stored. + + + This is the name of the log as it appears in the Event Viewer + tree. The default value is to log into the Application + log, this is where most applications write their events. However + if you need a separate log for your application (or applications) + then you should set the appropriately. + This should not be used to distinguish your event log messages + from those of other applications, the + property should be used to distinguish events. This property should be + used to group together events into a single log. + + + + + + Property used to set the Application name. This appears in the + event logs when logging. + + + The string used to distinguish events from different sources. + + + Sets the event log source property. + + + + + This property is used to return the name of the computer to use + when accessing the event logs. Currently, this is the current + computer, denoted by a dot "." + + + The string name of the machine holding the event log that + will be logged into. + + + This property cannot be changed. It is currently set to '.' + i.e. the local machine. This may be changed in future. + + + + + Gets or sets the used to write to the EventLog. + + + The used to write to the EventLog. + + + + The system security context used to write to the EventLog. + + + Unless a specified here for this appender + the is queried for the + security context to use. The default behavior is to use the security context + of the current thread. + + + + + + Gets or sets the EventId to use unless one is explicitly specified via the LoggingEvent's properties. + + + + The EventID of the event log entry will normally be + set using the EventID property () + on the . + This property provides the fallback value which defaults to 0. + + + + + + Gets or sets the Category to use unless one is explicitly specified via the LoggingEvent's properties. + + + + The Category of the event log entry will normally be + set using the Category property () + on the . + This property provides the fallback value which defaults to 0. + + + + + + This appender requires a to be set. + + true + + + This appender requires a to be set. + + + + + + A class to act as a mapping between the level that a logging call is made at and + the color it should be displayed as. + + + + Defines the mapping between a level and its event log entry type. + + + + + + The for this entry + + + + Required property. + The for this entry + + + + + + Appends logging events to a file. + + + + Logging events are sent to the file specified by + the property. + + + The file can be opened in either append or overwrite mode + by specifying the property. + If the file path is relative it is taken as relative from + the application base directory. The file encoding can be + specified by setting the property. + + + The layout's and + values will be written each time the file is opened and closed + respectively. If the property is + then the file may contain multiple copies of the header and footer. + + + This appender will first try to open the file for writing when + is called. This will typically be during configuration. + If the file cannot be opened for writing the appender will attempt + to open the file again each time a message is logged to the appender. + If the file cannot be opened for writing when a message is logged then + the message will be discarded by this appender. + + + The supports pluggable file locking models via + the property. + The default behavior, implemented by + is to obtain an exclusive write lock on the file until this appender is closed. + The alternative models only hold a + write lock while the appender is writing a logging event () + or synchronize by using a named system wide Mutex (). + + + All locking strategies have issues and you should seriously consider using a different strategy that + avoids having multiple processes logging to the same file. + + + Nicko Cadell + Gert Driesen + Rodrigo B. de Oliveira + Douglas de la Torre + Niall Daley + + + + Sends logging events to a . + + + + An Appender that writes to a . + + + This appender may be used stand alone if initialized with an appropriate + writer, however it is typically used as a base class for an appender that + can open a to write to. + + + Nicko Cadell + Gert Driesen + Douglas de la Torre + + + + Initializes a new instance of the class. + + + + Default constructor. + + + + + + Initializes a new instance of the class and + sets the output destination to a new initialized + with the specified . + + The layout to use with this appender. + The to output to. + + + Obsolete constructor. + + + + + + Initializes a new instance of the class and sets + the output destination to the specified . + + The layout to use with this appender + The to output to + + The must have been previously opened. + + + + Obsolete constructor. + + + + + + This method determines if there is a sense in attempting to append. + + + + This method checks if an output target has been set and if a + layout has been set. + + + false if any of the preconditions fail. + + + + This method is called by the + method. + + The event to log. + + + Writes a log statement to the output stream if the output stream exists + and is writable. + + + The format of the output will depend on the appender's layout. + + + + + + This method is called by the + method. + + The array of events to log. + + + This method writes all the bulk logged events to the output writer + before flushing the stream. + + + + + + Close this appender instance. The underlying stream or writer is also closed. + + + Closed appenders cannot be reused. + + + + + Writes the footer and closes the underlying . + + + + Writes the footer and closes the underlying . + + + + + + Closes the underlying . + + + + Closes the underlying . + + + + + + Clears internal references to the underlying + and other variables. + + + + Subclasses can override this method for an alternate closing behavior. + + + + + + Writes a footer as produced by the embedded layout's property. + + + + Writes a footer as produced by the embedded layout's property. + + + + + + Writes a header produced by the embedded layout's property. + + + + Writes a header produced by the embedded layout's property. + + + + + + Called to allow a subclass to lazily initialize the writer + + + + This method is called when an event is logged and the or + have not been set. This allows a subclass to + attempt to initialize the writer multiple times. + + + + + + This is the where logging events + will be written to. + + + + + Immediate flush means that the underlying + or output stream will be flushed at the end of each append operation. + + + + Immediate flush is slower but ensures that each append request is + actually written. If is set to + false, then there is a good chance that the last few + logging events are not actually persisted if and when the application + crashes. + + + The default value is true. + + + + + + The fully qualified type of the TextWriterAppender class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Gets or set whether the appender will flush at the end + of each append operation. + + + + The default behavior is to flush at the end of each + append operation. + + + If this option is set to false, then the underlying + stream can defer persisting the logging event to a later + time. + + + + Avoiding the flush operation at the end of each append results in + a performance gain of 10 to 20 percent. However, there is safety + trade-off involved in skipping flushing. Indeed, when flushing is + skipped, then it is likely that the last few log events will not + be recorded on disk when the application exits. This is a high + price to pay even for a 20% performance gain. + + + + + Sets the where the log output will go. + + + + The specified must be open and writable. + + + The will be closed when the appender + instance is closed. + + + Note: Logging to an unopened will fail. + + + + + + Gets or set the and the underlying + , if any, for this appender. + + + The for this appender. + + + + + This appender requires a to be set. + + true + + + This appender requires a to be set. + + + + + + Gets or sets the where logging events + will be written to. + + + The where logging events are written. + + + + This is the where logging events + will be written to. + + + + + + Default constructor + + + + Default constructor + + + + + + Construct a new appender using the layout, file and append mode. + + the layout to use with this appender + the full path to the file to write to + flag to indicate if the file should be appended to + + + Obsolete constructor. + + + + + + Construct a new appender using the layout and file specified. + The file will be appended to. + + the layout to use with this appender + the full path to the file to write to + + + Obsolete constructor. + + + + + + Activate the options on the file appender. + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + This will cause the file to be opened. + + + + + + Closes any previously opened file and calls the parent's . + + + + Resets the filename and the file stream. + + + + + + Close this appender instance. The underlying stream or writer is also closed. + + + + + Called to initialize the file writer + + + + Will be called for each logged message until the file is + successfully opened. + + + + + + This method is called by the + method. + + The event to log. + + + Writes a log statement to the output stream if the output stream exists + and is writable. + + + The format of the output will depend on the appender's layout. + + + + + + This method is called by the + method. + + The array of events to log. + + + Acquires the output file locks once before writing all the events to + the stream. + + + + + + Writes a footer as produced by the embedded layout's property. + + + + Writes a footer as produced by the embedded layout's property. + + + + + + Writes a header produced by the embedded layout's property. + + + + Writes a header produced by the embedded layout's property. + + + + + + Closes the underlying . + + + + Closes the underlying . + + + + + + Closes the previously opened file. + + + + Writes the to the file and then + closes the file. + + + + + + Sets and opens the file where the log output will go. The specified file must be writable. + + The path to the log file. Must be a fully qualified path. + If true will append to fileName. Otherwise will truncate fileName + + + Calls but guarantees not to throw an exception. + Errors are passed to the . + + + + + + Sets and opens the file where the log output will go. The specified file must be writable. + + The path to the log file. Must be a fully qualified path. + If true will append to fileName. Otherwise will truncate fileName + + + If there was already an opened file, then the previous file + is closed first. + + + This method will ensure that the directory structure + for the specified exists. + + + + + + Sets the quiet writer used for file output + + the file stream that has been opened for writing + + + This implementation of creates a + over the and passes it to the + method. + + + This method can be overridden by sub classes that want to wrap the + in some way, for example to encrypt the output + data using a System.Security.Cryptography.CryptoStream. + + + + + + Sets the quiet writer being used. + + the writer over the file stream that has been opened for writing + + + This method can be overridden by sub classes that want to + wrap the in some way. + + + + + + Convert a path into a fully qualified path. + + The path to convert. + The fully qualified path. + + + Converts the path specified to a fully + qualified path. If the path is relative it is + taken as relative from the application base + directory. + + + + + + Flag to indicate if we should append to the file + or overwrite the file. The default is to append. + + + + + The name of the log file. + + + + + The encoding to use for the file stream. + + + + + The security context to use for privileged calls + + + + + The stream to log to. Has added locking semantics + + + + + The locking model to use + + + + + The fully qualified type of the FileAppender class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Gets or sets the path to the file that logging will be written to. + + + The path to the file that logging will be written to. + + + + If the path is relative it is taken as relative from + the application base directory. + + + + + + Gets or sets a flag that indicates whether the file should be + appended to or overwritten. + + + Indicates whether the file should be appended to or overwritten. + + + + If the value is set to false then the file will be overwritten, if + it is set to true then the file will be appended to. + + The default value is true. + + + + + Gets or sets used to write to the file. + + + The used to write to the file. + + + + The default encoding set is + which is the encoding for the system's current ANSI code page. + + + + + + Gets or sets the used to write to the file. + + + The used to write to the file. + + + + Unless a specified here for this appender + the is queried for the + security context to use. The default behavior is to use the security context + of the current thread. + + + + + + Gets or sets the used to handle locking of the file. + + + The used to lock the file. + + + + Gets or sets the used to handle locking of the file. + + + There are three built in locking models, , and . + The first locks the file from the start of logging to the end, the + second locks only for the minimal amount of time when logging each message + and the last synchronizes processes using a named system wide Mutex. + + + The default locking model is the . + + + + + + Write only that uses the + to manage access to an underlying resource. + + + + + True asynchronous writes are not supported, the implementation forces a synchronous write. + + + + + Exception base type for log4net. + + + + This type extends . It + does not add any new functionality but does differentiate the + type of exception being thrown. + + + Nicko Cadell + Gert Driesen + + + + Constructor + + + + Initializes a new instance of the class. + + + + + + Constructor + + A message to include with the exception. + + + Initializes a new instance of the class with + the specified message. + + + + + + Constructor + + A message to include with the exception. + A nested exception to include. + + + Initializes a new instance of the class + with the specified message and inner exception. + + + + + + Serialization constructor + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + + + Initializes a new instance of the class + with serialized data. + + + + + + Locking model base class + + + + Base class for the locking models available to the derived loggers. + + + + + + Open the output file + + The filename to use + Whether to append to the file, or overwrite + The encoding to use + + + Open the file specified and prepare for logging. + No writes will be made until is called. + Must be called before any calls to , + and . + + + + + + Close the file + + + + Close the file. No further writes will be made. + + + + + + Initializes all resources used by this locking model. + + + + + Disposes all resources that were initialized by this locking model. + + + + + Acquire the lock on the file + + A stream that is ready to be written to. + + + Acquire the lock on the file in preparation for writing to it. + Return a stream pointing to the file. + must be called to release the lock on the output file. + + + + + + Release the lock on the file + + + + Release the lock on the file. No further writes will be made to the + stream until is called again. + + + + + + Helper method that creates a FileStream under CurrentAppender's SecurityContext. + + + + Typically called during OpenFile or AcquireLock. + + + If the directory portion of the does not exist, it is created + via Directory.CreateDirecctory. + + + + + + + + + + Helper method to close under CurrentAppender's SecurityContext. + + + Does not set to null. + + + + + + Gets or sets the for this LockingModel + + + The for this LockingModel + + + + The file appender this locking model is attached to and working on + behalf of. + + + The file appender is used to locate the security context and the error handler to use. + + + The value of this property will be set before is + called. + + + + + + Hold an exclusive lock on the output file + + + + Open the file once for writing and hold it open until is called. + Maintains an exclusive lock on the file during this time. + + + + + + Open the file specified and prepare for logging. + + The filename to use + Whether to append to the file, or overwrite + The encoding to use + + + Open the file specified and prepare for logging. + No writes will be made until is called. + Must be called before any calls to , + and . + + + + + + Close the file + + + + Close the file. No further writes will be made. + + + + + + Acquire the lock on the file + + A stream that is ready to be written to. + + + Does nothing. The lock is already taken + + + + + + Release the lock on the file + + + + Does nothing. The lock will be released when the file is closed. + + + + + + Initializes all resources used by this locking model. + + + + + Disposes all resources that were initialized by this locking model. + + + + + Acquires the file lock for each write + + + + Opens the file once for each / cycle, + thus holding the lock for the minimal amount of time. This method of locking + is considerably slower than but allows + other processes to move/delete the log file whilst logging continues. + + + + + + Prepares to open the file when the first message is logged. + + The filename to use + Whether to append to the file, or overwrite + The encoding to use + + + Open the file specified and prepare for logging. + No writes will be made until is called. + Must be called before any calls to , + and . + + + + + + Close the file + + + + Close the file. No further writes will be made. + + + + + + Acquire the lock on the file + + A stream that is ready to be written to. + + + Acquire the lock on the file in preparation for writing to it. + Return a stream pointing to the file. + must be called to release the lock on the output file. + + + + + + Release the lock on the file + + + + Release the lock on the file. No further writes will be made to the + stream until is called again. + + + + + + Initializes all resources used by this locking model. + + + + + Disposes all resources that were initialized by this locking model. + + + + + Provides cross-process file locking. + + Ron Grabowski + Steve Wranovsky + + + + Open the file specified and prepare for logging. + + The filename to use + Whether to append to the file, or overwrite + The encoding to use + + + Open the file specified and prepare for logging. + No writes will be made until is called. + Must be called before any calls to , + - and . + + + + + + Close the file + + + + Close the file. No further writes will be made. + + + + + + Acquire the lock on the file + + A stream that is ready to be written to. + + + Does nothing. The lock is already taken + + + + + + Releases the lock and allows others to acquire a lock. + + + + + Initializes all resources used by this locking model. + + + + + Disposes all resources that were initialized by this locking model. + + + + + This appender forwards logging events to attached appenders. + + + + The forwarding appender can be used to specify different thresholds + and filters for the same appender at different locations within the hierarchy. + + + Nicko Cadell + Gert Driesen + + + + Initializes a new instance of the class. + + + + Default constructor. + + + + + + Closes the appender and releases resources. + + + + Releases any resources allocated within the appender such as file handles, + network connections, etc. + + + It is a programming error to append to a closed appender. + + + + + + Forward the logging event to the attached appenders + + The event to log. + + + Delivers the logging event to all the attached appenders. + + + + + + Forward the logging events to the attached appenders + + The array of events to log. + + + Delivers the logging events to all the attached appenders. + + + + + + Adds an to the list of appenders of this + instance. + + The to add to this appender. + + + If the specified is already in the list of + appenders, then it won't be added again. + + + + + + Looks for the appender with the specified name. + + The name of the appender to lookup. + + The appender with the specified name, or null. + + + + Get the named appender attached to this appender. + + + + + + Removes all previously added appenders from this appender. + + + + This is useful when re-reading configuration information. + + + + + + Removes the specified appender from the list of appenders. + + The appender to remove. + The appender removed from the list + + The appender removed is not closed. + If you are discarding the appender you must call + on the appender removed. + + + + + Removes the appender with the specified name from the list of appenders. + + The name of the appender to remove. + The appender removed from the list + + The appender removed is not closed. + If you are discarding the appender you must call + on the appender removed. + + + + + Implementation of the interface + + + + + Gets the appenders contained in this appender as an + . + + + If no appenders can be found, then an + is returned. + + + A collection of the appenders in this appender. + + + + + Logs events to a local syslog service. + + + + This appender uses the POSIX libc library functions openlog, syslog, and closelog. + If these functions are not available on the local system then this appender will not work! + + + The functions openlog, syslog, and closelog are specified in SUSv2 and + POSIX 1003.1-2001 standards. These are used to log messages to the local syslog service. + + + This appender talks to a local syslog service. If you need to log to a remote syslog + daemon and you cannot configure your local syslog service to do this you may be + able to use the to log via UDP. + + + Syslog messages must have a facility and and a severity. The severity + is derived from the Level of the logging event. + The facility must be chosen from the set of defined syslog + values. The facilities list is predefined + and cannot be extended. + + + An identifier is specified with each log message. This can be specified + by setting the property. The identity (also know + as the tag) must not contain white space. The default value for the + identity is the application name (from ). + + + Rob Lyon + Nicko Cadell + + + + Initializes a new instance of the class. + + + This instance of the class is set up to write + to a local syslog service. + + + + + Add a mapping of level to severity + + The mapping to add + + + Adds a to this appender. + + + + + + Initialize the appender based on the options set. + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + + + + This method is called by the method. + + The event to log. + + + Writes the event to a remote syslog daemon. + + + The format of the output will depend on the appender's layout. + + + + + + Close the syslog when the appender is closed + + + + Close the syslog when the appender is closed + + + + + + Translates a log4net level to a syslog severity. + + A log4net level. + A syslog severity. + + + Translates a log4net level to a syslog severity. + + + + + + Generate a syslog priority. + + The syslog facility. + The syslog severity. + A syslog priority. + + + + The facility. The default facility is . + + + + + The message identity + + + + + Marshaled handle to the identity string. We have to hold on to the + string as the openlog and syslog APIs just hold the + pointer to the ident and dereference it for each log message. + + + + + Mapping from level object to syslog severity + + + + + Open connection to system logger. + + + + + Generate a log message. + + + + The libc syslog method takes a format string and a variable argument list similar + to the classic printf function. As this type of vararg list is not supported + by C# we need to specify the arguments explicitly. Here we have specified the + format string with a single message argument. The caller must set the format + string to "%s". + + + + + + Close descriptor used to write to system logger. + + + + + Message identity + + + + An identifier is specified with each log message. This can be specified + by setting the property. The identity (also know + as the tag) must not contain white space. The default value for the + identity is the application name (from ). + + + + + + Syslog facility + + + Set to one of the values. The list of + facilities is predefined and cannot be extended. The default value + is . + + + + + This appender requires a to be set. + + true + + + This appender requires a to be set. + + + + + + syslog severities + + + + The log4net Level maps to a syslog severity using the + method and the + class. The severity is set on . + + + + + + system is unusable + + + + + action must be taken immediately + + + + + critical conditions + + + + + error conditions + + + + + warning conditions + + + + + normal but significant condition + + + + + informational + + + + + debug-level messages + + + + + syslog facilities + + + + The syslog facility defines which subsystem the logging comes from. + This is set on the property. + + + + + + kernel messages + + + + + random user-level messages + + + + + mail system + + + + + system daemons + + + + + security/authorization messages + + + + + messages generated internally by syslogd + + + + + line printer subsystem + + + + + network news subsystem + + + + + UUCP subsystem + + + + + clock (cron/at) daemon + + + + + security/authorization messages (private) + + + + + ftp daemon + + + + + NTP subsystem + + + + + log audit + + + + + log alert + + + + + clock daemon + + + + + reserved for local use + + + + + reserved for local use + + + + + reserved for local use + + + + + reserved for local use + + + + + reserved for local use + + + + + reserved for local use + + + + + reserved for local use + + + + + reserved for local use + + + + + A class to act as a mapping between the level that a logging call is made at and + the syslog severity that is should be logged at. + + + + A class to act as a mapping between the level that a logging call is made at and + the syslog severity that is should be logged at. + + + + + + The mapped syslog severity for the specified level + + + + Required property. + The mapped syslog severity for the specified level + + + + + + Appends colorful logging events to the console, using the .NET 2 + built-in capabilities. + + + + ManagedColoredConsoleAppender appends log events to the standard output stream + or the error output stream using a layout specified by the + user. It also allows the color of a specific type of message to be set. + + + By default, all output is written to the console's standard output stream. + The property can be set to direct the output to the + error stream. + + + When configuring the colored console appender, mappings should be + specified to map logging levels to colors. For example: + + + + + + + + + + + + + + + + + + + + + + The Level is the standard log4net logging level while + ForeColor and BackColor are the values of + enumeration. + + + Based on the ColoredConsoleAppender + + + Rick Hobbs + Nicko Cadell + Pavlos Touboulidis + + + + The to use when writing to the Console + standard output stream. + + + + The to use when writing to the Console + standard output stream. + + + + + + The to use when writing to the Console + standard error output stream. + + + + The to use when writing to the Console + standard error output stream. + + + + + + Initializes a new instance of the class. + + + The instance of the class is set up to write + to the standard output stream. + + + + + Add a mapping of level to color - done by the config file + + The mapping to add + + + Add a mapping to this appender. + Each mapping defines the foreground and background colors + for a level. + + + + + + This method is called by the method. + + The event to log. + + + Writes the event to the console. + + + The format of the output will depend on the appender's layout. + + + + + + Initialize the options for this appender + + + + Initialize the level to color mappings set on this appender. + + + + + + Flag to write output to the error stream rather than the standard output stream + + + + + Mapping from level object to color value + + + + + Target is the value of the console output stream. + This is either "Console.Out" or "Console.Error". + + + Target is the value of the console output stream. + This is either "Console.Out" or "Console.Error". + + + + Target is the value of the console output stream. + This is either "Console.Out" or "Console.Error". + + + + + + This appender requires a to be set. + + true + + + This appender requires a to be set. + + + + + + A class to act as a mapping between the level that a logging call is made at and + the color it should be displayed as. + + + + Defines the mapping between a level and the color it should be displayed in. + + + + + + The mapped foreground color for the specified level + + + + Required property. + The mapped foreground color for the specified level. + + + + + + The mapped background color for the specified level + + + + Required property. + The mapped background color for the specified level. + + + + + + Stores logging events in an array. + + + + The memory appender stores all the logging events + that are appended in an in-memory array. + + + Use the method to get + and clear the current list of events that have been appended. + + + Use the method to get the current + list of events that have been appended. Note there is a + race-condition when calling and + in pairs, you better use in that case. + + + Use the method to clear the + current list of events. Note there is a + race-condition when calling and + in pairs, you better use in that case. + + + Julian Biddle + Nicko Cadell + Gert Driesen + + + + Initializes a new instance of the class. + + + + Default constructor. + + + + + + Gets the events that have been logged. + + The events that have been logged + + + Gets the events that have been logged. + + + + + + This method is called by the method. + + the event to log + + Stores the in the events list. + + + + + Clear the list of events + + + Clear the list of events + + + + + Gets the events that have been logged and clears the list of events. + + The events that have been logged + + + Gets the events that have been logged and clears the list of events. + + + + + + The list of events that have been appended. + + + + + Value indicating which fields in the event should be fixed + + + By default all fields are fixed + + + + + Gets or sets a value indicating whether only part of the logging event + data should be fixed. + + + true if the appender should only fix part of the logging event + data, otherwise false. The default is false. + + + + Setting this property to true will cause only part of the event + data to be fixed and stored in the appender, hereby improving performance. + + + See for more information. + + + + + + Gets or sets the fields that will be fixed in the event + + + + The logging event needs to have certain thread specific values + captured before it can be buffered. See + for details. + + + + + + Logs entries by sending network messages using the + native function. + + + + You can send messages only to names that are active + on the network. If you send the message to a user name, + that user must be logged on and running the Messenger + service to receive the message. + + + The receiver will get a top most window displaying the + messages one at a time, therefore this appender should + not be used to deliver a high volume of messages. + + + The following table lists some possible uses for this appender : + + + + + Action + Property Value(s) + + + Send a message to a user account on the local machine + + + = <name of the local machine> + + + = <user name> + + + + + Send a message to a user account on a remote machine + + + = <name of the remote machine> + + + = <user name> + + + + + Send a message to a domain user account + + + = <name of a domain controller | uninitialized> + + + = <user name> + + + + + Send a message to all the names in a workgroup or domain + + + = <workgroup name | domain name>* + + + + + Send a message from the local machine to a remote machine + + + = <name of the local machine | uninitialized> + + + = <name of the remote machine> + + + + + + + Note : security restrictions apply for sending + network messages, see + for more information. + + + + + An example configuration section to log information + using this appender from the local machine, named + LOCAL_PC, to machine OPERATOR_PC : + + + + + + + + + + Nicko Cadell + Gert Driesen + + + + The DNS or NetBIOS name of the server on which the function is to execute. + + + + + The sender of the network message. + + + + + The message alias to which the message should be sent. + + + + + The security context to use for privileged calls + + + + + Initializes the appender. + + + The default constructor initializes all fields to their default values. + + + + + Initialize the appender based on the options set. + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + The appender will be ignored if no was specified. + + + The required property was not specified. + + + + This method is called by the method. + + The event to log. + + + Sends the event using a network message. + + + + + + Sends a buffer of information to a registered message alias. + + The DNS or NetBIOS name of the server on which the function is to execute. + The message alias to which the message buffer should be sent + The originator of the message. + The message text. + The length, in bytes, of the message text. + + + The following restrictions apply for sending network messages: + + + + + Platform + Requirements + + + Windows NT + + + No special group membership is required to send a network message. + + + Admin, Accounts, Print, or Server Operator group membership is required to + successfully send a network message on a remote server. + + + + + Windows 2000 or later + + + If you send a message on a domain controller that is running Active Directory, + access is allowed or denied based on the access control list (ACL) for the securable + object. The default ACL permits only Domain Admins and Account Operators to send a network message. + + + On a member server or workstation, only Administrators and Server Operators can send a network message. + + + + + + + For more information see Security Requirements for the Network Management Functions. + + + + + If the function succeeds, the return value is zero. + + + + + + Gets or sets the sender of the message. + + + The sender of the message. + + + If this property is not specified, the message is sent from the local computer. + + + + + Gets or sets the message alias to which the message should be sent. + + + The recipient of the message. + + + This property should always be specified in order to send a message. + + + + + Gets or sets the DNS or NetBIOS name of the remote server on which the function is to execute. + + + DNS or NetBIOS name of the remote server on which the function is to execute. + + + + For Windows NT 4.0 and earlier, the string should begin with \\. + + + If this property is not specified, the local computer is used. + + + + + + Gets or sets the used to call the NetSend method. + + + The used to call the NetSend method. + + + + Unless a specified here for this appender + the is queried for the + security context to use. The default behavior is to use the security context + of the current thread. + + + + + + This appender requires a to be set. + + true + + + This appender requires a to be set. + + + + + + Appends log events to the OutputDebugString system. + + + + OutputDebugStringAppender appends log events to the + OutputDebugString system. + + + The string is passed to the native OutputDebugString + function. + + + Nicko Cadell + Gert Driesen + + + + Initializes a new instance of the class. + + + + Default constructor. + + + + + + Write the logging event to the output debug string API + + the event to log + + + Write the logging event to the output debug string API + + + + + + Stub for OutputDebugString native method + + the string to output + + + Stub for OutputDebugString native method + + + + + + This appender requires a to be set. + + true + + + This appender requires a to be set. + + + + + + Logs events to a remote syslog daemon. + + + + The BSD syslog protocol is used to remotely log to + a syslog daemon. The syslogd listens for for messages + on UDP port 514. + + + The syslog UDP protocol is not authenticated. Most syslog daemons + do not accept remote log messages because of the security implications. + You may be able to use the LocalSyslogAppender to talk to a local + syslog service. + + + There is an RFC 3164 that claims to document the BSD Syslog Protocol. + This RFC can be seen here: http://www.faqs.org/rfcs/rfc3164.html. + This appender generates what the RFC calls an "Original Device Message", + i.e. does not include the TIMESTAMP or HOSTNAME fields. By observation + this format of message will be accepted by all current syslog daemon + implementations. The daemon will attach the current time and the source + hostname or IP address to any messages received. + + + Syslog messages must have a facility and and a severity. The severity + is derived from the Level of the logging event. + The facility must be chosen from the set of defined syslog + values. The facilities list is predefined + and cannot be extended. + + + An identifier is specified with each log message. This can be specified + by setting the property. The identity (also know + as the tag) must not contain white space. The default value for the + identity is the application name (from ). + + + Rob Lyon + Nicko Cadell + + + + Sends logging events as connectionless UDP datagrams to a remote host or a + multicast group using an . + + + + UDP guarantees neither that messages arrive, nor that they arrive in the correct order. + + + To view the logging results, a custom application can be developed that listens for logging + events. + + + When decoding events send via this appender remember to use the same encoding + to decode the events as was used to send the events. See the + property to specify the encoding to use. + + + + This example shows how to log receive logging events that are sent + on IP address 244.0.0.1 and port 8080 to the console. The event is + encoded in the packet as a unicode string and it is decoded as such. + + IPEndPoint remoteEndPoint = new IPEndPoint(IPAddress.Any, 0); + UdpClient udpClient; + byte[] buffer; + string loggingEvent; + + try + { + udpClient = new UdpClient(8080); + + while(true) + { + buffer = udpClient.Receive(ref remoteEndPoint); + loggingEvent = System.Text.Encoding.Unicode.GetString(buffer); + Console.WriteLine(loggingEvent); + } + } + catch(Exception e) + { + Console.WriteLine(e.ToString()); + } + + + Dim remoteEndPoint as IPEndPoint + Dim udpClient as UdpClient + Dim buffer as Byte() + Dim loggingEvent as String + + Try + remoteEndPoint = new IPEndPoint(IPAddress.Any, 0) + udpClient = new UdpClient(8080) + + While True + buffer = udpClient.Receive(ByRef remoteEndPoint) + loggingEvent = System.Text.Encoding.Unicode.GetString(buffer) + Console.WriteLine(loggingEvent) + Wend + Catch e As Exception + Console.WriteLine(e.ToString()) + End Try + + + An example configuration section to log information using this appender to the + IP 224.0.0.1 on port 8080: + + + + + + + + + + Gert Driesen + Nicko Cadell + + + + Initializes a new instance of the class. + + + The default constructor initializes all fields to their default values. + + + + + Initialize the appender based on the options set. + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + The appender will be ignored if no was specified or + an invalid remote or local TCP port number was specified. + + + The required property was not specified. + The TCP port number assigned to or is less than or greater than . + + + + This method is called by the method. + + The event to log. + + + Sends the event using an UDP datagram. + + + Exceptions are passed to the . + + + + + + Closes the UDP connection and releases all resources associated with + this instance. + + + + Disables the underlying and releases all managed + and unmanaged resources associated with the . + + + + + + Initializes the underlying connection. + + + + The underlying is initialized and binds to the + port number from which you intend to communicate. + + + Exceptions are passed to the . + + + + + + The IP address of the remote host or multicast group to which + the logging event will be sent. + + + + + The TCP port number of the remote host or multicast group to + which the logging event will be sent. + + + + + The cached remote endpoint to which the logging events will be sent. + + + + + The TCP port number from which the will communicate. + + + + + The instance that will be used for sending the + logging events. + + + + + The encoding to use for the packet. + + + + + Gets or sets the IP address of the remote host or multicast group to which + the underlying should sent the logging event. + + + The IP address of the remote host or multicast group to which the logging event + will be sent. + + + + Multicast addresses are identified by IP class D addresses (in the range 224.0.0.0 to + 239.255.255.255). Multicast packets can pass across different networks through routers, so + it is possible to use multicasts in an Internet scenario as long as your network provider + supports multicasting. + + + Hosts that want to receive particular multicast messages must register their interest by joining + the multicast group. Multicast messages are not sent to networks where no host has joined + the multicast group. Class D IP addresses are used for multicast groups, to differentiate + them from normal host addresses, allowing nodes to easily detect if a message is of interest. + + + Static multicast addresses that are needed globally are assigned by IANA. A few examples are listed in the table below: + + + + + IP Address + Description + + + 224.0.0.1 + + + Sends a message to all system on the subnet. + + + + + 224.0.0.2 + + + Sends a message to all routers on the subnet. + + + + + 224.0.0.12 + + + The DHCP server answers messages on the IP address 224.0.0.12, but only on a subnet. + + + + + + + A complete list of actually reserved multicast addresses and their owners in the ranges + defined by RFC 3171 can be found at the IANA web site. + + + The address range 239.0.0.0 to 239.255.255.255 is reserved for administrative scope-relative + addresses. These addresses can be reused with other local groups. Routers are typically + configured with filters to prevent multicast traffic in this range from flowing outside + of the local network. + + + + + + Gets or sets the TCP port number of the remote host or multicast group to which + the underlying should sent the logging event. + + + An integer value in the range to + indicating the TCP port number of the remote host or multicast group to which the logging event + will be sent. + + + The underlying will send messages to this TCP port number + on the remote host or multicast group. + + The value specified is less than or greater than . + + + + Gets or sets the TCP port number from which the underlying will communicate. + + + An integer value in the range to + indicating the TCP port number from which the underlying will communicate. + + + + The underlying will bind to this port for sending messages. + + + Setting the value to 0 (the default) will cause the udp client not to bind to + a local port. + + + The value specified is less than or greater than . + + + + Gets or sets used to write the packets. + + + The used to write the packets. + + + + The used to write the packets. + + + + + + Gets or sets the underlying . + + + The underlying . + + + creates a to send logging events + over a network. Classes deriving from can use this + property to get or set this . Use the underlying + returned from if you require access beyond that which + provides. + + + + + Gets or sets the cached remote endpoint to which the logging events should be sent. + + + The cached remote endpoint to which the logging events will be sent. + + + The method will initialize the remote endpoint + with the values of the and + properties. + + + + + This appender requires a to be set. + + true + + + This appender requires a to be set. + + + + + + Syslog port 514 + + + + + Initial buffer size + + + + + Maximum buffer size before it is recycled + + + + + Initializes a new instance of the class. + + + This instance of the class is set up to write + to a remote syslog daemon. + + + + + Add a mapping of level to severity + + The mapping to add + + + Add a mapping to this appender. + + + + + + This method is called by the method. + + The event to log. + + + Writes the event to a remote syslog daemon. + + + The format of the output will depend on the appender's layout. + + + + + + Initialize the options for this appender + + + + Initialize the level to syslog severity mappings set on this appender. + + + + + + Translates a log4net level to a syslog severity. + + A log4net level. + A syslog severity. + + + Translates a log4net level to a syslog severity. + + + + + + Generate a syslog priority. + + The syslog facility. + The syslog severity. + A syslog priority. + + + Generate a syslog priority. + + + + + + The facility. The default facility is . + + + + + The message identity + + + + + Mapping from level object to syslog severity + + + + + Message identity + + + + An identifier is specified with each log message. This can be specified + by setting the property. The identity (also know + as the tag) must not contain white space. The default value for the + identity is the application name (from ). + + + + + + Syslog facility + + + Set to one of the values. The list of + facilities is predefined and cannot be extended. The default value + is . + + + + + syslog severities + + + + The syslog severities. + + + + + + system is unusable + + + + + action must be taken immediately + + + + + critical conditions + + + + + error conditions + + + + + warning conditions + + + + + normal but significant condition + + + + + informational + + + + + debug-level messages + + + + + syslog facilities + + + + The syslog facilities + + + + + + kernel messages + + + + + random user-level messages + + + + + mail system + + + + + system daemons + + + + + security/authorization messages + + + + + messages generated internally by syslogd + + + + + line printer subsystem + + + + + network news subsystem + + + + + UUCP subsystem + + + + + clock (cron/at) daemon + + + + + security/authorization messages (private) + + + + + ftp daemon + + + + + NTP subsystem + + + + + log audit + + + + + log alert + + + + + clock daemon + + + + + reserved for local use + + + + + reserved for local use + + + + + reserved for local use + + + + + reserved for local use + + + + + reserved for local use + + + + + reserved for local use + + + + + reserved for local use + + + + + reserved for local use + + + + + A class to act as a mapping between the level that a logging call is made at and + the syslog severity that is should be logged at. + + + + A class to act as a mapping between the level that a logging call is made at and + the syslog severity that is should be logged at. + + + + + + The mapped syslog severity for the specified level + + + + Required property. + The mapped syslog severity for the specified level + + + + + + Delivers logging events to a remote logging sink. + + + + This Appender is designed to deliver events to a remote sink. + That is any object that implements the + interface. It delivers the events using .NET remoting. The + object to deliver events to is specified by setting the + appenders property. + + The RemotingAppender buffers events before sending them. This allows it to + make more efficient use of the remoting infrastructure. + + Once the buffer is full the events are still not sent immediately. + They are scheduled to be sent using a pool thread. The effect is that + the send occurs asynchronously. This is very important for a + number of non obvious reasons. The remoting infrastructure will + flow thread local variables (stored in the ), + if they are marked as , across the + remoting boundary. If the server is not contactable then + the remoting infrastructure will clear the + objects from the . To prevent a logging failure from + having side effects on the calling application the remoting call must be made + from a separate thread to the one used by the application. A + thread is used for this. If no thread is available then + the events will block in the thread pool manager until a thread is available. + + Because the events are sent asynchronously using pool threads it is possible to close + this appender before all the queued events have been sent. + When closing the appender attempts to wait until all the queued events have been sent, but + this will timeout after 30 seconds regardless. + + If this appender is being closed because the + event has fired it may not be possible to send all the queued events. During process + exit the runtime limits the time that a + event handler is allowed to run for. If the runtime terminates the threads before + the queued events have been sent then they will be lost. To ensure that all events + are sent the appender must be closed before the application exits. See + for details on how to shutdown + log4net programmatically. + + + Nicko Cadell + Gert Driesen + Daniel Cazzulino + + + + Initializes a new instance of the class. + + + + Default constructor. + + + + + + Initialize the appender based on the options set + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + + + + Send the contents of the buffer to the remote sink. + + + The events are not sent immediately. They are scheduled to be sent + using a pool thread. The effect is that the send occurs asynchronously. + This is very important for a number of non obvious reasons. The remoting + infrastructure will flow thread local variables (stored in the ), + if they are marked as , across the + remoting boundary. If the server is not contactable then + the remoting infrastructure will clear the + objects from the . To prevent a logging failure from + having side effects on the calling application the remoting call must be made + from a separate thread to the one used by the application. A + thread is used for this. If no thread is available then + the events will block in the thread pool manager until a thread is available. + + The events to send. + + + + Override base class close. + + + + This method waits while there are queued work items. The events are + sent asynchronously using work items. These items + will be sent once a thread pool thread is available to send them, therefore + it is possible to close the appender before all the queued events have been + sent. + + This method attempts to wait until all the queued events have been sent, but this + method will timeout after 30 seconds regardless. + + If the appender is being closed because the + event has fired it may not be possible to send all the queued events. During process + exit the runtime limits the time that a + event handler is allowed to run for. + + + + + A work item is being queued into the thread pool + + + + + A work item from the thread pool has completed + + + + + Send the contents of the buffer to the remote sink. + + + This method is designed to be used with the . + This method expects to be passed an array of + objects in the state param. + + the logging events to send + + + + The URL of the remote sink. + + + + + The local proxy (.NET remoting) for the remote logging sink. + + + + + The number of queued callbacks currently waiting or executing + + + + + Event used to signal when there are no queued work items + + + This event is set when there are no queued work items. In this + state it is safe to close the appender. + + + + + Gets or sets the URL of the well-known object that will accept + the logging events. + + + The well-known URL of the remote sink. + + + + The URL of the remoting sink that will accept logging events. + The sink must implement the + interface. + + + + + + Interface used to deliver objects to a remote sink. + + + This interface must be implemented by a remoting sink + if the is to be used + to deliver logging events to the sink. + + + + + Delivers logging events to the remote sink + + Array of events to log. + + + Delivers logging events to the remote sink + + + + + + Appender that rolls log files based on size or date or both. + + + + RollingFileAppender can roll log files based on size or date or both + depending on the setting of the property. + When set to the log file will be rolled + once its size exceeds the . + When set to the log file will be rolled + once the date boundary specified in the property + is crossed. + When set to the log file will be + rolled once the date boundary specified in the property + is crossed, but within a date boundary the file will also be rolled + once its size exceeds the . + When set to the log file will be rolled when + the appender is configured. This effectively means that the log file can be + rolled once per program execution. + + + A of few additional optional features have been added: + + Attach date pattern for current log file + Backup number increments for newer files + Infinite number of backups by file size + + + + + + For large or infinite numbers of backup files a + greater than zero is highly recommended, otherwise all the backup files need + to be renamed each time a new backup is created. + + + When Date/Time based rolling is used setting + to will reduce the number of file renamings to few or none. + + + + + + Changing or without clearing + the log file directory of backup files will cause unexpected and unwanted side effects. + + + + + If Date/Time based rolling is enabled this appender will attempt to roll existing files + in the directory without a Date/Time tag based on the last write date of the base log file. + The appender only rolls the log file when a message is logged. If Date/Time based rolling + is enabled then the appender will not roll the log file at the Date/Time boundary but + at the point when the next message is logged after the boundary has been crossed. + + + + The extends the and + has the same behavior when opening the log file. + The appender will first try to open the file for writing when + is called. This will typically be during configuration. + If the file cannot be opened for writing the appender will attempt + to open the file again each time a message is logged to the appender. + If the file cannot be opened for writing when a message is logged then + the message will be discarded by this appender. + + + When rolling a backup file necessitates deleting an older backup file the + file to be deleted is moved to a temporary name before being deleted. + + + + + A maximum number of backup files when rolling on date/time boundaries is not supported. + + + + Nicko Cadell + Gert Driesen + Aspi Havewala + Douglas de la Torre + Edward Smit + + + + Initializes a new instance of the class. + + + + Default constructor. + + + + + + Cleans up all resources used by this appender. + + + + + The fully qualified type of the RollingFileAppender class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Sets the quiet writer being used. + + + This method can be overridden by sub classes. + + the writer to set + + + + Write out a logging event. + + the event to write to file. + + + Handles append time behavior for RollingFileAppender. This checks + if a roll over either by date (checked first) or time (checked second) + is need and then appends to the file last. + + + + + + Write out an array of logging events. + + the events to write to file. + + + Handles append time behavior for RollingFileAppender. This checks + if a roll over either by date (checked first) or time (checked second) + is need and then appends to the file last. + + + + + + Performs any required rolling before outputting the next event + + + + Handles append time behavior for RollingFileAppender. This checks + if a roll over either by date (checked first) or time (checked second) + is need and then appends to the file last. + + + + + + Creates and opens the file for logging. If + is false then the fully qualified name is determined and used. + + the name of the file to open + true to append to existing file + + This method will ensure that the directory structure + for the specified exists. + + + + + Get the current output file name + + the base file name + the output file name + + The output file name is based on the base fileName specified. + If is set then the output + file name is the same as the base file passed in. Otherwise + the output file depends on the date pattern, on the count + direction or both. + + + + + Determines curSizeRollBackups (only within the current roll point) + + + + + Generates a wildcard pattern that can be used to find all files + that are similar to the base file name. + + + + + + + Builds a list of filenames for all files matching the base filename plus a file + pattern. + + + + + + + Initiates a roll over if needed for crossing a date boundary since the last run. + + + + + Initializes based on existing conditions at time of . + + + + Initializes based on existing conditions at time of . + The following is done + + determine curSizeRollBackups (only within the current roll point) + initiates a roll over if needed for crossing a date boundary since the last run. + + + + + + + Does the work of bumping the 'current' file counter higher + to the highest count when an incremental file name is seen. + The highest count is either the first file (when count direction + is greater than 0) or the last file (when count direction less than 0). + In either case, we want to know the highest count that is present. + + + + + + + Attempts to extract a number from the end of the file name that indicates + the number of the times the file has been rolled over. + + + Certain date pattern extensions like yyyyMMdd will be parsed as valid backup indexes. + + + + + + + Takes a list of files and a base file name, and looks for + 'incremented' versions of the base file. Bumps the max + count up to the highest count seen. + + + + + + + Calculates the RollPoint for the datePattern supplied. + + the date pattern to calculate the check period for + The RollPoint that is most accurate for the date pattern supplied + + Essentially the date pattern is examined to determine what the + most suitable roll point is. The roll point chosen is the roll point + with the smallest period that can be detected using the date pattern + supplied. i.e. if the date pattern only outputs the year, month, day + and hour then the smallest roll point that can be detected would be + and hourly roll point as minutes could not be detected. + + + + + Initialize the appender based on the options set + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + Sets initial conditions including date/time roll over information, first check, + scheduledFilename, and calls to initialize + the current number of backups. + + + + + + + + + .1, .2, .3, etc. + + + + + Rollover the file(s) to date/time tagged file(s). + + set to true if the file to be rolled is currently open + + + Rollover the file(s) to date/time tagged file(s). + Resets curSizeRollBackups. + If fileIsOpen is set then the new file is opened (through SafeOpenFile). + + + + + + Renames file to file . + + Name of existing file to roll. + New name for file. + + + Renames file to file . It + also checks for existence of target file and deletes if it does. + + + + + + Test if a file exists at a specified path + + the path to the file + true if the file exists + + + Test if a file exists at a specified path + + + + + + Deletes the specified file if it exists. + + The file to delete. + + + Delete a file if is exists. + The file is first moved to a new filename then deleted. + This allows the file to be removed even when it cannot + be deleted, but it still can be moved. + + + + + + Implements file roll base on file size. + + + + If the maximum number of size based backups is reached + (curSizeRollBackups == maxSizeRollBackups) then the oldest + file is deleted -- its index determined by the sign of countDirection. + If countDirection < 0, then files + {File.1, ..., File.curSizeRollBackups -1} + are renamed to {File.2, ..., + File.curSizeRollBackups}. Moreover, File is + renamed File.1 and closed. + + + A new file is created to receive further log output. + + + If maxSizeRollBackups is equal to zero, then the + File is truncated with no backup files created. + + + If maxSizeRollBackups < 0, then File is + renamed if needed and no files are deleted. + + + + + + Implements file roll. + + the base name to rename + + + If the maximum number of size based backups is reached + (curSizeRollBackups == maxSizeRollBackups) then the oldest + file is deleted -- its index determined by the sign of countDirection. + If countDirection < 0, then files + {File.1, ..., File.curSizeRollBackups -1} + are renamed to {File.2, ..., + File.curSizeRollBackups}. + + + If maxSizeRollBackups is equal to zero, then the + File is truncated with no backup files created. + + + If maxSizeRollBackups < 0, then File is + renamed if needed and no files are deleted. + + + This is called by to rename the files. + + + + + + Get the start time of the next window for the current rollpoint + + the current date + the type of roll point we are working with + the start time for the next roll point an interval after the currentDateTime date + + + Returns the date of the next roll point after the currentDateTime date passed to the method. + + + The basic strategy is to subtract the time parts that are less significant + than the rollpoint from the current time. This should roll the time back to + the start of the time window for the current rollpoint. Then we add 1 window + worth of time and get the start time of the next window for the rollpoint. + + + + + + This object supplies the current date/time. Allows test code to plug in + a method to control this class when testing date/time based rolling. The default + implementation uses the underlying value of DateTime.Now. + + + + + The date pattern. By default, the pattern is set to ".yyyy-MM-dd" + meaning daily rollover. + + + + + The actual formatted filename that is currently being written to + or will be the file transferred to on roll over + (based on staticLogFileName). + + + + + The timestamp when we shall next recompute the filename. + + + + + Holds date of last roll over + + + + + The type of rolling done + + + + + The default maximum file size is 10MB + + + + + There is zero backup files by default + + + + + How many sized based backups have been made so far + + + + + The rolling file count direction. + + + + + The rolling mode used in this appender. + + + + + Cache flag set if we are rolling by date. + + + + + Cache flag set if we are rolling by size. + + + + + Value indicating whether to always log to the same file. + + + + + Value indicating whether to preserve the file name extension when rolling. + + + + + FileName provided in configuration. Used for rolling properly + + + + + A mutex that is used to lock rolling of files. + + + + + The 1st of January 1970 in UTC + + + + + Gets or sets the strategy for determining the current date and time. The default + implementation is to use LocalDateTime which internally calls through to DateTime.Now. + DateTime.UtcNow may be used on frameworks newer than .NET 1.0 by specifying + . + + + An implementation of the interface which returns the current date and time. + + + + Gets or sets the used to return the current date and time. + + + There are two built strategies for determining the current date and time, + + and . + + + The default strategy is . + + + + + + Gets or sets the date pattern to be used for generating file names + when rolling over on date. + + + The date pattern to be used for generating file names when rolling + over on date. + + + + Takes a string in the same format as expected by + . + + + This property determines the rollover schedule when rolling over + on date. + + + + + + Gets or sets the maximum number of backup files that are kept before + the oldest is erased. + + + The maximum number of backup files that are kept before the oldest is + erased. + + + + If set to zero, then there will be no backup files and the log file + will be truncated when it reaches . + + + If a negative number is supplied then no deletions will be made. Note + that this could result in very slow performance as a large number of + files are rolled over unless is used. + + + The maximum applies to each time based group of files and + not the total. + + + + + + Gets or sets the maximum size that the output file is allowed to reach + before being rolled over to backup files. + + + The maximum size in bytes that the output file is allowed to reach before being + rolled over to backup files. + + + + This property is equivalent to except + that it is required for differentiating the setter taking a + argument from the setter taking a + argument. + + + The default maximum file size is 10MB (10*1024*1024). + + + + + + Gets or sets the maximum size that the output file is allowed to reach + before being rolled over to backup files. + + + The maximum size that the output file is allowed to reach before being + rolled over to backup files. + + + + This property allows you to specify the maximum size with the + suffixes "KB", "MB" or "GB" so that the size is interpreted being + expressed respectively in kilobytes, megabytes or gigabytes. + + + For example, the value "10KB" will be interpreted as 10240 bytes. + + + The default maximum file size is 10MB. + + + If you have the option to set the maximum file size programmatically + consider using the property instead as this + allows you to set the size in bytes as a . + + + + + + Gets or sets the rolling file count direction. + + + The rolling file count direction. + + + + Indicates if the current file is the lowest numbered file or the + highest numbered file. + + + By default newer files have lower numbers ( < 0), + i.e. log.1 is most recent, log.5 is the 5th backup, etc... + + + >= 0 does the opposite i.e. + log.1 is the first backup made, log.5 is the 5th backup made, etc. + For infinite backups use >= 0 to reduce + rollover costs. + + The default file count direction is -1. + + + + + Gets or sets the rolling style. + + The rolling style. + + + The default rolling style is . + + + When set to this appender's + property is set to false, otherwise + the appender would append to a single file rather than rolling + the file each time it is opened. + + + + + + Gets or sets a value indicating whether to preserve the file name extension when rolling. + + + true if the file name extension should be preserved. + + + + By default file.log is rolled to file.log.yyyy-MM-dd or file.log.curSizeRollBackup. + However, under Windows the new file name will loose any program associations as the + extension is changed. Optionally file.log can be renamed to file.yyyy-MM-dd.log or + file.curSizeRollBackup.log to maintain any program associations. + + + + + + Gets or sets a value indicating whether to always log to + the same file. + + + true if always should be logged to the same file, otherwise false. + + + + By default file.log is always the current file. Optionally + file.log.yyyy-mm-dd for current formatted datePattern can by the currently + logging file (or file.log.curSizeRollBackup or even + file.log.yyyy-mm-dd.curSizeRollBackup). + + + This will make time based rollovers with a large number of backups + much faster as the appender it won't have to rename all the backups! + + + + + + Style of rolling to use + + + + Style of rolling to use + + + + + + Roll files once per program execution + + + + Roll files once per program execution. + Well really once each time this appender is + configured. + + + Setting this option also sets AppendToFile to + false on the RollingFileAppender, otherwise + this appender would just be a normal file appender. + + + + + + Roll files based only on the size of the file + + + + + Roll files based only on the date + + + + + Roll files based on both the size and date of the file + + + + + The code assumes that the following 'time' constants are in a increasing sequence. + + + + The code assumes that the following 'time' constants are in a increasing sequence. + + + + + + Roll the log not based on the date + + + + + Roll the log for each minute + + + + + Roll the log for each hour + + + + + Roll the log twice a day (midday and midnight) + + + + + Roll the log each day (midnight) + + + + + Roll the log each week + + + + + Roll the log each month + + + + + This interface is used to supply Date/Time information to the . + + + This interface is used to supply Date/Time information to the . + Used primarily to allow test classes to plug themselves in so they can + supply test date/times. + + + + + Gets the current time. + + The current time. + + + Gets the current time. + + + + + + Default implementation of that returns the current time. + + + + + Gets the current time. + + The current time. + + + Gets the current time. + + + + + + Implementation of that returns the current time as the coordinated universal time (UTC). + + + + + Gets the current time. + + The current time. + + + Gets the current time. + + + + + + Send an e-mail when a specific logging event occurs, typically on errors + or fatal errors. + + + + The number of logging events delivered in this e-mail depend on + the value of option. The + keeps only the last + logging events in its + cyclic buffer. This keeps memory requirements at a reasonable level while + still delivering useful application context. + + + Authentication and setting the server Port are only available on the MS .NET 1.1 runtime. + For these features to be enabled you need to ensure that you are using a version of + the log4net assembly that is built against the MS .NET 1.1 framework and that you are + running the your application on the MS .NET 1.1 runtime. On all other platforms only sending + unauthenticated messages to a server listening on port 25 (the default) is supported. + + + Authentication is supported by setting the property to + either or . + If using authentication then the + and properties must also be set. + + + To set the SMTP server port use the property. The default port is 25. + + + Nicko Cadell + Gert Driesen + + + + Default constructor + + + + Default constructor + + + + + + Sends the contents of the cyclic buffer as an e-mail message. + + The logging events to send. + + + + Send the email message + + the body text to include in the mail + + + + trims leading and trailing commas or semicolons + + + + + Gets or sets a comma- or semicolon-delimited list of recipient e-mail addresses (use semicolon on .NET 1.1 and comma for later versions). + + + + For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses. + + + For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses. + + + + + For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses. + + + For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses. + + + + + + Gets or sets a comma- or semicolon-delimited list of recipient e-mail addresses + that will be carbon copied (use semicolon on .NET 1.1 and comma for later versions). + + + + For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses. + + + For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses. + + + + + For .NET 1.1 (System.Web.Mail): A semicolon-delimited list of e-mail addresses. + + + For .NET 2.0 (System.Net.Mail): A comma-delimited list of e-mail addresses. + + + + + + Gets or sets a semicolon-delimited list of recipient e-mail addresses + that will be blind carbon copied. + + + A semicolon-delimited list of e-mail addresses. + + + + A semicolon-delimited list of recipient e-mail addresses. + + + + + + Gets or sets the e-mail address of the sender. + + + The e-mail address of the sender. + + + + The e-mail address of the sender. + + + + + + Gets or sets the subject line of the e-mail message. + + + The subject line of the e-mail message. + + + + The subject line of the e-mail message. + + + + + + Gets or sets the name of the SMTP relay mail server to use to send + the e-mail messages. + + + The name of the e-mail relay server. If SmtpServer is not set, the + name of the local SMTP server is used. + + + + The name of the e-mail relay server. If SmtpServer is not set, the + name of the local SMTP server is used. + + + + + + Obsolete + + + Use the BufferingAppenderSkeleton Fix methods instead + + + + Obsolete property. + + + + + + The mode to use to authentication with the SMTP server + + + Authentication is only available on the MS .NET 1.1 runtime. + + Valid Authentication mode values are: , + , and . + The default value is . When using + you must specify the + and to use to authenticate. + When using the Windows credentials for the current + thread, if impersonating, or the process will be used to authenticate. + + + + + + The username to use to authenticate with the SMTP server + + + Authentication is only available on the MS .NET 1.1 runtime. + + A and must be specified when + is set to , + otherwise the username will be ignored. + + + + + + The password to use to authenticate with the SMTP server + + + Authentication is only available on the MS .NET 1.1 runtime. + + A and must be specified when + is set to , + otherwise the password will be ignored. + + + + + + The port on which the SMTP server is listening + + + Server Port is only available on the MS .NET 1.1 runtime. + + The port on which the SMTP server is listening. The default + port is 25. The Port can only be changed when running on + the MS .NET 1.1 runtime. + + + + + + Gets or sets the priority of the e-mail message + + + One of the values. + + + + Sets the priority of the e-mails generated by this + appender. The default priority is . + + + If you are using this appender to report errors then + you may want to set the priority to . + + + + + + Enable or disable use of SSL when sending e-mail message + + + This is available on MS .NET 2.0 runtime and higher + + + + + Gets or sets the reply-to e-mail address. + + + This is available on MS .NET 2.0 runtime and higher + + + + + Gets or sets the subject encoding to be used. + + + The default encoding is the operating system's current ANSI codepage. + + + + + Gets or sets the body encoding to be used. + + + The default encoding is the operating system's current ANSI codepage. + + + + + This appender requires a to be set. + + true + + + This appender requires a to be set. + + + + + + Values for the property. + + + + SMTP authentication modes. + + + + + + No authentication + + + + + Basic authentication. + + + Requires a username and password to be supplied + + + + + Integrated authentication + + + Uses the Windows credentials from the current thread or process to authenticate. + + + + + Send an email when a specific logging event occurs, typically on errors + or fatal errors. Rather than sending via smtp it writes a file into the + directory specified by . This allows services such + as the IIS SMTP agent to manage sending the messages. + + + + The configuration for this appender is identical to that of the SMTPAppender, + except that instead of specifying the SMTPAppender.SMTPHost you specify + . + + + The number of logging events delivered in this e-mail depend on + the value of option. The + keeps only the last + logging events in its + cyclic buffer. This keeps memory requirements at a reasonable level while + still delivering useful application context. + + + Niall Daley + Nicko Cadell + + + + Default constructor + + + + Default constructor + + + + + + Sends the contents of the cyclic buffer as an e-mail message. + + The logging events to send. + + + Sends the contents of the cyclic buffer as an e-mail message. + + + + + + Activate the options on this appender. + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + + + + Convert a path into a fully qualified path. + + The path to convert. + The fully qualified path. + + + Converts the path specified to a fully + qualified path. If the path is relative it is + taken as relative from the application base + directory. + + + + + + The security context to use for privileged calls + + + + + Gets or sets a semicolon-delimited list of recipient e-mail addresses. + + + A semicolon-delimited list of e-mail addresses. + + + + A semicolon-delimited list of e-mail addresses. + + + + + + Gets or sets the e-mail address of the sender. + + + The e-mail address of the sender. + + + + The e-mail address of the sender. + + + + + + Gets or sets the subject line of the e-mail message. + + + The subject line of the e-mail message. + + + + The subject line of the e-mail message. + + + + + + Gets or sets the path to write the messages to. + + + + Gets or sets the path to write the messages to. This should be the same + as that used by the agent sending the messages. + + + + + + Gets or sets the file extension for the generated files + + + The file extension for the generated files + + + + The file extension for the generated files + + + + + + Gets or sets the used to write to the pickup directory. + + + The used to write to the pickup directory. + + + + Unless a specified here for this appender + the is queried for the + security context to use. The default behavior is to use the security context + of the current thread. + + + + + + This appender requires a to be set. + + true + + + This appender requires a to be set. + + + + + + Appender that allows clients to connect via Telnet to receive log messages + + + + The TelnetAppender accepts socket connections and streams logging messages + back to the client. + The output is provided in a telnet-friendly way so that a log can be monitored + over a TCP/IP socket. + This allows simple remote monitoring of application logging. + + + The default is 23 (the telnet port). + + + Keith Long + Nicko Cadell + + + + Default constructor + + + + Default constructor + + + + + + The fully qualified type of the TelnetAppender class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Overrides the parent method to close the socket handler + + + + Closes all the outstanding connections. + + + + + + Initialize the appender based on the options set. + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + Create the socket handler and wait for connections + + + + + + Writes the logging event to each connected client. + + The event to log. + + + Writes the logging event to each connected client. + + + + + + Gets or sets the TCP port number on which this will listen for connections. + + + An integer value in the range to + indicating the TCP port number on which this will listen for connections. + + + + The default value is 23 (the telnet port). + + + The value specified is less than + or greater than . + + + + This appender requires a to be set. + + true + + + This appender requires a to be set. + + + + + + Helper class to manage connected clients + + + + The SocketHandler class is used to accept connections from + clients. It is threaded so that clients can connect/disconnect + asynchronously. + + + + + + Opens a new server port on + + the local port to listen on for connections + + + Creates a socket handler on the specified local server port. + + + + + + Sends a string message to each of the connected clients + + the text to send + + + Sends a string message to each of the connected clients + + + + + + Add a client to the internal clients list + + client to add + + + + Remove a client from the internal clients list + + client to remove + + + + Callback used to accept a connection on the server socket + + The result of the asynchronous operation + + + On connection adds to the list of connections + if there are two many open connections you will be disconnected + + + + + + Close all network connections + + + + Make sure we close all network connections + + + + + + Test if this handler has active connections + + + true if this handler has active connections + + + + This property will be true while this handler has + active connections, that is at least one connection that + the handler will attempt to send a message to. + + + + + + Class that represents a client connected to this handler + + + + Class that represents a client connected to this handler + + + + + + Create this for the specified + + the client's socket + + + Opens a stream writer on the socket. + + + + + + Write a string to the client + + string to send + + + Write a string to the client + + + + + + Cleanup the clients connection + + + + Close the socket connection. + + + + + + Appends log events to the system. + + + + The application configuration file can be used to control what listeners + are actually used. See the MSDN documentation for the + class for details on configuring the + trace system. + + + Events are written using the System.Diagnostics.Trace.Write(string,string) + method. The event's logger name is the default value for the category parameter + of the Write method. + + + Compact Framework
+ The Compact Framework does not support the + class for any operation except Assert. When using the Compact Framework this + appender will write to the system rather than + the Trace system. This appender will therefore behave like the . +
+
+ Douglas de la Torre + Nicko Cadell + Gert Driesen + Ron Grabowski +
+ + + Initializes a new instance of the . + + + + Default constructor. + + + + + + Initializes a new instance of the + with a specified layout. + + The layout to use with this appender. + + + Obsolete constructor. + + + + + + Writes the logging event to the system. + + The event to log. + + + Writes the logging event to the system. + + + + + + Immediate flush means that the underlying writer or output stream + will be flushed at the end of each append operation. + + + + Immediate flush is slower but ensures that each append request is + actually written. If is set to + false, then there is a good chance that the last few + logs events are not actually written to persistent media if and + when the application crashes. + + + The default value is true. + + + + + Defaults to %logger + + + + + Gets or sets a value that indicates whether the appender will + flush at the end of each write. + + + The default behavior is to flush at the end of each + write. If the option is set tofalse, then the underlying + stream can defer writing to physical medium to a later time. + + + Avoiding the flush operation at the end of each append results + in a performance gain of 10 to 20 percent. However, there is safety + trade-off involved in skipping flushing. Indeed, when flushing is + skipped, then it is likely that the last few log events will not + be recorded on disk when the application exits. This is a high + price to pay even for a 20% performance gain. + + + + + + The category parameter sent to the Trace method. + + + + Defaults to %logger which will use the logger name of the current + as the category parameter. + + + + + + + + This appender requires a to be set. + + true + + + This appender requires a to be set. + + + + + + Assembly level attribute that specifies a domain to alias to this assembly's repository. + + + + AliasDomainAttribute is obsolete. Use AliasRepositoryAttribute instead of AliasDomainAttribute. + + + An assembly's logger repository is defined by its , + however this can be overridden by an assembly loaded before the target assembly. + + + An assembly can alias another assembly's domain to its repository by + specifying this attribute with the name of the target domain. + + + This attribute can only be specified on the assembly and may be used + as many times as necessary to alias all the required domains. + + + Nicko Cadell + Gert Driesen + + + + Assembly level attribute that specifies a repository to alias to this assembly's repository. + + + + An assembly's logger repository is defined by its , + however this can be overridden by an assembly loaded before the target assembly. + + + An assembly can alias another assembly's repository to its repository by + specifying this attribute with the name of the target repository. + + + This attribute can only be specified on the assembly and may be used + as many times as necessary to alias all the required repositories. + + + Nicko Cadell + Gert Driesen + + + + Initializes a new instance of the class with + the specified repository to alias to this assembly's repository. + + The repository to alias to this assemby's repository. + + + Initializes a new instance of the class with + the specified repository to alias to this assembly's repository. + + + + + + Gets or sets the repository to alias to this assemby's repository. + + + The repository to alias to this assemby's repository. + + + + The name of the repository to alias to this assemby's repository. + + + + + + Initializes a new instance of the class with + the specified domain to alias to this assembly's repository. + + The domain to alias to this assemby's repository. + + + Obsolete. Use instead of . + + + + + + Use this class to quickly configure a . + + + + Allows very simple programmatic configuration of log4net. + + + Only one appender can be configured using this configurator. + The appender is set at the root of the hierarchy and all logging + events will be delivered to that appender. + + + Appenders can also implement the interface. Therefore + they would require that the method + be called after the appenders properties have been configured. + + + Nicko Cadell + Gert Driesen + + + + The fully qualified type of the BasicConfigurator class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Initializes a new instance of the class. + + + + Uses a private access modifier to prevent instantiation of this class. + + + + + + Initializes the log4net system with a default configuration. + + + + Initializes the log4net logging system using a + that will write to Console.Out. The log messages are + formatted using the layout object + with the + layout style. + + + + + + Initializes the log4net system using the specified appender. + + The appender to use to log all logging events. + + + Initializes the log4net system using the specified appender. + + + + + + Initializes the log4net system using the specified appenders. + + The appenders to use to log all logging events. + + + Initializes the log4net system using the specified appenders. + + + + + + Initializes the with a default configuration. + + The repository to configure. + + + Initializes the specified repository using a + that will write to Console.Out. The log messages are + formatted using the layout object + with the + layout style. + + + + + + Initializes the using the specified appender. + + The repository to configure. + The appender to use to log all logging events. + + + Initializes the using the specified appender. + + + + + + Initializes the using the specified appenders. + + The repository to configure. + The appenders to use to log all logging events. + + + Initializes the using the specified appender. + + + + + + Base class for all log4net configuration attributes. + + + This is an abstract class that must be extended by + specific configurators. This attribute allows the + configurator to be parameterized by an assembly level + attribute. + + Nicko Cadell + Gert Driesen + + + + Constructor used by subclasses. + + the ordering priority for this configurator + + + The is used to order the configurator + attributes before they are invoked. Higher priority configurators are executed + before lower priority ones. + + + + + + Configures the for the specified assembly. + + The assembly that this attribute was defined on. + The repository to configure. + + + Abstract method implemented by a subclass. When this method is called + the subclass should configure the . + + + + + + Compare this instance to another ConfiguratorAttribute + + the object to compare to + see + + + Compares the priorities of the two instances. + Sorts by priority in descending order. Objects with the same priority are + randomly ordered. + + + + + + Assembly level attribute that specifies the logging domain for the assembly. + + + + DomainAttribute is obsolete. Use RepositoryAttribute instead of DomainAttribute. + + + Assemblies are mapped to logging domains. Each domain has its own + logging repository. This attribute specified on the assembly controls + the configuration of the domain. The property specifies the name + of the domain that this assembly is a part of. The + specifies the type of the repository objects to create for the domain. If + this attribute is not specified and a is not specified + then the assembly will be part of the default shared logging domain. + + + This attribute can only be specified on the assembly and may only be used + once per assembly. + + + Nicko Cadell + Gert Driesen + + + + Assembly level attribute that specifies the logging repository for the assembly. + + + + Assemblies are mapped to logging repository. This attribute specified + on the assembly controls + the configuration of the repository. The property specifies the name + of the repository that this assembly is a part of. The + specifies the type of the object + to create for the assembly. If this attribute is not specified or a + is not specified then the assembly will be part of the default shared logging repository. + + + This attribute can only be specified on the assembly and may only be used + once per assembly. + + + Nicko Cadell + Gert Driesen + + + + Initializes a new instance of the class. + + + + Default constructor. + + + + + + Initialize a new instance of the class + with the name of the repository. + + The name of the repository. + + + Initialize the attribute with the name for the assembly's repository. + + + + + + Gets or sets the name of the logging repository. + + + The string name to use as the name of the repository associated with this + assembly. + + + + This value does not have to be unique. Several assemblies can share the + same repository. They will share the logging configuration of the repository. + + + + + + Gets or sets the type of repository to create for this assembly. + + + The type of repository to create for this assembly. + + + + The type of the repository to create for the assembly. + The type must implement the + interface. + + + This will be the type of repository created when + the repository is created. If multiple assemblies reference the + same repository then the repository is only created once using the + of the first assembly to call into the + repository. + + + + + + Initializes a new instance of the class. + + + + Obsolete. Use RepositoryAttribute instead of DomainAttribute. + + + + + + Initialize a new instance of the class + with the name of the domain. + + The name of the domain. + + + Obsolete. Use RepositoryAttribute instead of DomainAttribute. + + + + + + Use this class to initialize the log4net environment using an Xml tree. + + + + DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. + + + Configures a using an Xml tree. + + + Nicko Cadell + Gert Driesen + + + + Private constructor + + + + + Automatically configures the log4net system based on the + application's configuration settings. + + + + DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. + + Each application has a configuration file. This has the + same name as the application with '.config' appended. + This file is XML and calling this function prompts the + configurator to look in that file for a section called + log4net that contains the configuration data. + + + + + Automatically configures the using settings + stored in the application's configuration file. + + + + DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. + + Each application has a configuration file. This has the + same name as the application with '.config' appended. + This file is XML and calling this function prompts the + configurator to look in that file for a section called + log4net that contains the configuration data. + + The repository to configure. + + + + Configures log4net using a log4net element + + + + DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. + + Loads the log4net configuration from the XML element + supplied as . + + The element to parse. + + + + Configures the using the specified XML + element. + + + + DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. + + Loads the log4net configuration from the XML element + supplied as . + + The repository to configure. + The element to parse. + + + + Configures log4net using the specified configuration file. + + The XML file to load the configuration from. + + + DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. + + + The configuration file must be valid XML. It must contain + at least one element called log4net that holds + the log4net configuration data. + + + The log4net configuration file can possible be specified in the application's + configuration file (either MyAppName.exe.config for a + normal application on Web.config for an ASP.NET application). + + + The following example configures log4net using a configuration file, of which the + location is stored in the application's configuration file : + + + using log4net.Config; + using System.IO; + using System.Configuration; + + ... + + DOMConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"])); + + + In the .config file, the path to the log4net can be specified like this : + + + + + + + + + + + + + Configures log4net using the specified configuration file. + + A stream to load the XML configuration from. + + + DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. + + + The configuration data must be valid XML. It must contain + at least one element called log4net that holds + the log4net configuration data. + + + Note that this method will NOT close the stream parameter. + + + + + + Configures the using the specified configuration + file. + + The repository to configure. + The XML file to load the configuration from. + + + DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. + + + The configuration file must be valid XML. It must contain + at least one element called log4net that holds + the configuration data. + + + The log4net configuration file can possible be specified in the application's + configuration file (either MyAppName.exe.config for a + normal application on Web.config for an ASP.NET application). + + + The following example configures log4net using a configuration file, of which the + location is stored in the application's configuration file : + + + using log4net.Config; + using System.IO; + using System.Configuration; + + ... + + DOMConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"])); + + + In the .config file, the path to the log4net can be specified like this : + + + + + + + + + + + + + Configures the using the specified configuration + file. + + The repository to configure. + The stream to load the XML configuration from. + + + DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. + + + The configuration data must be valid XML. It must contain + at least one element called log4net that holds + the configuration data. + + + Note that this method will NOT close the stream parameter. + + + + + + Configures log4net using the file specified, monitors the file for changes + and reloads the configuration if a change is detected. + + The XML file to load the configuration from. + + + DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. + + + The configuration file must be valid XML. It must contain + at least one element called log4net that holds + the configuration data. + + + The configuration file will be monitored using a + and depends on the behavior of that class. + + + For more information on how to configure log4net using + a separate configuration file, see . + + + + + + + Configures the using the file specified, + monitors the file for changes and reloads the configuration if a change + is detected. + + The repository to configure. + The XML file to load the configuration from. + + + DOMConfigurator is obsolete. Use XmlConfigurator instead of DOMConfigurator. + + + The configuration file must be valid XML. It must contain + at least one element called log4net that holds + the configuration data. + + + The configuration file will be monitored using a + and depends on the behavior of that class. + + + For more information on how to configure log4net using + a separate configuration file, see . + + + + + + + Assembly level attribute to configure the . + + + + AliasDomainAttribute is obsolete. Use AliasRepositoryAttribute instead of AliasDomainAttribute. + + + This attribute may only be used at the assembly scope and can only + be used once per assembly. + + + Use this attribute to configure the + without calling one of the + methods. + + + Nicko Cadell + Gert Driesen + + + + Assembly level attribute to configure the . + + + + This attribute may only be used at the assembly scope and can only + be used once per assembly. + + + Use this attribute to configure the + without calling one of the + methods. + + + If neither of the or + properties are set the configuration is loaded from the application's .config file. + If set the property takes priority over the + property. The property + specifies a path to a file to load the config from. The path is relative to the + application's base directory; . + The property is used as a postfix to the assembly file name. + The config file must be located in the application's base directory; . + For example in a console application setting the to + config has the same effect as not specifying the or + properties. + + + The property can be set to cause the + to watch the configuration file for changes. + + + + Log4net will only look for assembly level configuration attributes once. + When using the log4net assembly level attributes to control the configuration + of log4net you must ensure that the first call to any of the + methods is made from the assembly with the configuration + attributes. + + + If you cannot guarantee the order in which log4net calls will be made from + different assemblies you must use programmatic configuration instead, i.e. + call the method directly. + + + + Nicko Cadell + Gert Driesen + + + + Default constructor + + + + Default constructor + + + + + + Configures the for the specified assembly. + + The assembly that this attribute was defined on. + The repository to configure. + + + Configure the repository using the . + The specified must extend the + class otherwise the will not be able to + configure it. + + + The does not extend . + + + + Attempt to load configuration from the local file system + + The assembly that this attribute was defined on. + The repository to configure. + + + + Configure the specified repository using a + + The repository to configure. + the FileInfo pointing to the config file + + + + Attempt to load configuration from a URI + + The assembly that this attribute was defined on. + The repository to configure. + + + + The fully qualified type of the XmlConfiguratorAttribute class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Gets or sets the filename of the configuration file. + + + The filename of the configuration file. + + + + If specified, this is the name of the configuration file to use with + the . This file path is relative to the + application base directory (). + + + The takes priority over the . + + + + + + Gets or sets the extension of the configuration file. + + + The extension of the configuration file. + + + + If specified this is the extension for the configuration file. + The path to the config file is built by using the application + base directory (), + the assembly file name and the config file extension. + + + If the is set to MyExt then + possible config file names would be: MyConsoleApp.exe.MyExt or + MyClassLibrary.dll.MyExt. + + + The takes priority over the . + + + + + + Gets or sets a value indicating whether to watch the configuration file. + + + true if the configuration should be watched, false otherwise. + + + + If this flag is specified and set to true then the framework + will watch the configuration file and will reload the config each time + the file is modified. + + + The config file can only be watched if it is loaded from local disk. + In a No-Touch (Smart Client) deployment where the application is downloaded + from a web server the config file may not reside on the local disk + and therefore it may not be able to watch it. + + + Watching configuration is not supported on the SSCLI. + + + + + + Class to register for the log4net section of the configuration file + + + The log4net section of the configuration file needs to have a section + handler registered. This is the section handler used. It simply returns + the XML element that is the root of the section. + + + Example of registering the log4net section handler : + + + +
+ + + log4net configuration XML goes here + + + + + Nicko Cadell + Gert Driesen + + + + Initializes a new instance of the class. + + + + Default constructor. + + + + + + Parses the configuration section. + + The configuration settings in a corresponding parent configuration section. + The configuration context when called from the ASP.NET configuration system. Otherwise, this parameter is reserved and is a null reference. + The for the log4net section. + The for the log4net section. + + + Returns the containing the configuration data, + + + + + + Assembly level attribute that specifies a plugin to attach to + the repository. + + + + Specifies the type of a plugin to create and attach to the + assembly's repository. The plugin type must implement the + interface. + + + Nicko Cadell + Gert Driesen + + + + Interface used to create plugins. + + + + Interface used to create a plugin. + + + Nicko Cadell + Gert Driesen + + + + Creates the plugin object. + + the new plugin instance + + + Create and return a new plugin instance. + + + + + + Initializes a new instance of the class + with the specified type. + + The type name of plugin to create. + + + Create the attribute with the plugin type specified. + + + Where possible use the constructor that takes a . + + + + + + Initializes a new instance of the class + with the specified type. + + The type of plugin to create. + + + Create the attribute with the plugin type specified. + + + + + + Creates the plugin object defined by this attribute. + + + + Creates the instance of the object as + specified by this attribute. + + + The plugin object. + + + + Returns a representation of the properties of this object. + + + + Overrides base class method to + return a representation of the properties of this object. + + + A representation of the properties of this object + + + + Gets or sets the type for the plugin. + + + The type for the plugin. + + + + The type for the plugin. + + + + + + Gets or sets the type name for the plugin. + + + The type name for the plugin. + + + + The type name for the plugin. + + + Where possible use the property instead. + + + + + + Assembly level attribute to configure the . + + + + This attribute may only be used at the assembly scope and can only + be used once per assembly. + + + Use this attribute to configure the + without calling one of the + methods. + + + Nicko Cadell + + + + Construct provider attribute with type specified + + the type of the provider to use + + + The provider specified must subclass the + class. + + + + + + Configures the SecurityContextProvider + + The assembly that this attribute was defined on. + The repository to configure. + + + Creates a provider instance from the specified. + Sets this as the default security context provider . + + + + + + The fully qualified type of the SecurityContextProviderAttribute class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Gets or sets the type of the provider to use. + + + the type of the provider to use. + + + + The provider specified must subclass the + class. + + + + + + Use this class to initialize the log4net environment using an Xml tree. + + + + Configures a using an Xml tree. + + + Nicko Cadell + Gert Driesen + + + + Private constructor + + + + + Automatically configures the log4net system based on the + application's configuration settings. + + + + Each application has a configuration file. This has the + same name as the application with '.config' appended. + This file is XML and calling this function prompts the + configurator to look in that file for a section called + log4net that contains the configuration data. + + + To use this method to configure log4net you must specify + the section + handler for the log4net configuration section. See the + for an example. + + + + + + + Automatically configures the using settings + stored in the application's configuration file. + + + + Each application has a configuration file. This has the + same name as the application with '.config' appended. + This file is XML and calling this function prompts the + configurator to look in that file for a section called + log4net that contains the configuration data. + + + To use this method to configure log4net you must specify + the section + handler for the log4net configuration section. See the + for an example. + + + The repository to configure. + + + + Configures log4net using a log4net element + + + + Loads the log4net configuration from the XML element + supplied as . + + + The element to parse. + + + + Configures the using the specified XML + element. + + + Loads the log4net configuration from the XML element + supplied as . + + The repository to configure. + The element to parse. + + + + Configures log4net using the specified configuration file. + + The XML file to load the configuration from. + + + The configuration file must be valid XML. It must contain + at least one element called log4net that holds + the log4net configuration data. + + + The log4net configuration file can possible be specified in the application's + configuration file (either MyAppName.exe.config for a + normal application on Web.config for an ASP.NET application). + + + The first element matching <configuration> will be read as the + configuration. If this file is also a .NET .config file then you must specify + a configuration section for the log4net element otherwise .NET will + complain. Set the type for the section handler to , for example: + + +
+ + + + + The following example configures log4net using a configuration file, of which the + location is stored in the application's configuration file : + + + using log4net.Config; + using System.IO; + using System.Configuration; + + ... + + XmlConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"])); + + + In the .config file, the path to the log4net can be specified like this : + + + + + + + + + + + + + Configures log4net using the specified configuration URI. + + A URI to load the XML configuration from. + + + The configuration data must be valid XML. It must contain + at least one element called log4net that holds + the log4net configuration data. + + + The must support the URI scheme specified. + + + + + + Configures log4net using the specified configuration data stream. + + A stream to load the XML configuration from. + + + The configuration data must be valid XML. It must contain + at least one element called log4net that holds + the log4net configuration data. + + + Note that this method will NOT close the stream parameter. + + + + + + Configures the using the specified configuration + file. + + The repository to configure. + The XML file to load the configuration from. + + + The configuration file must be valid XML. It must contain + at least one element called log4net that holds + the configuration data. + + + The log4net configuration file can possible be specified in the application's + configuration file (either MyAppName.exe.config for a + normal application on Web.config for an ASP.NET application). + + + The first element matching <configuration> will be read as the + configuration. If this file is also a .NET .config file then you must specify + a configuration section for the log4net element otherwise .NET will + complain. Set the type for the section handler to , for example: + + +
+ + + + + The following example configures log4net using a configuration file, of which the + location is stored in the application's configuration file : + + + using log4net.Config; + using System.IO; + using System.Configuration; + + ... + + XmlConfigurator.Configure(new FileInfo(ConfigurationSettings.AppSettings["log4net-config-file"])); + + + In the .config file, the path to the log4net can be specified like this : + + + + + + + + + + + + + Configures the using the specified configuration + URI. + + The repository to configure. + A URI to load the XML configuration from. + + + The configuration data must be valid XML. It must contain + at least one element called log4net that holds + the configuration data. + + + The must support the URI scheme specified. + + + + + + Configures the using the specified configuration + file. + + The repository to configure. + The stream to load the XML configuration from. + + + The configuration data must be valid XML. It must contain + at least one element called log4net that holds + the configuration data. + + + Note that this method will NOT close the stream parameter. + + + + + + Configures log4net using the file specified, monitors the file for changes + and reloads the configuration if a change is detected. + + The XML file to load the configuration from. + + + The configuration file must be valid XML. It must contain + at least one element called log4net that holds + the configuration data. + + + The configuration file will be monitored using a + and depends on the behavior of that class. + + + For more information on how to configure log4net using + a separate configuration file, see . + + + + + + + Configures the using the file specified, + monitors the file for changes and reloads the configuration if a change + is detected. + + The repository to configure. + The XML file to load the configuration from. + + + The configuration file must be valid XML. It must contain + at least one element called log4net that holds + the configuration data. + + + The configuration file will be monitored using a + and depends on the behavior of that class. + + + For more information on how to configure log4net using + a separate configuration file, see . + + + + + + + Configures the specified repository using a log4net element. + + The hierarchy to configure. + The element to parse. + + + Loads the log4net configuration from the XML element + supplied as . + + + This method is ultimately called by one of the Configure methods + to load the configuration from an . + + + + + + Maps repository names to ConfigAndWatchHandler instances to allow a particular + ConfigAndWatchHandler to dispose of its FileSystemWatcher when a repository is + reconfigured. + + + + + The fully qualified type of the XmlConfigurator class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Class used to watch config files. + + + + Uses the to monitor + changes to a specified file. Because multiple change notifications + may be raised when the file is modified, a timer is used to + compress the notifications into a single event. The timer + waits for time before delivering + the event notification. If any further + change notifications arrive while the timer is waiting it + is reset and waits again for to + elapse. + + + + + + The default amount of time to wait after receiving notification + before reloading the config file. + + + + + Holds the FileInfo used to configure the XmlConfigurator + + + + + Holds the repository being configured. + + + + + The timer used to compress the notification events. + + + + + Watches file for changes. This object should be disposed when no longer + needed to free system handles on the watched resources. + + + + + Initializes a new instance of the class to + watch a specified config file used to configure a repository. + + The repository to configure. + The configuration file to watch. + + + Initializes a new instance of the class. + + + + + + Event handler used by . + + The firing the event. + The argument indicates the file that caused the event to be fired. + + + This handler reloads the configuration from the file when the event is fired. + + + + + + Event handler used by . + + The firing the event. + The argument indicates the file that caused the event to be fired. + + + This handler reloads the configuration from the file when the event is fired. + + + + + + Called by the timer when the configuration has been updated. + + null + + + + Release the handles held by the watcher and timer. + + + + + The implementation of the interface suitable + for use with the compact framework + + + + This implementation is a simple + mapping between repository name and + object. + + + The .NET Compact Framework 1.0 does not support retrieving assembly + level attributes therefore unlike the DefaultRepositorySelector + this selector does not examine the calling assembly for attributes. + + + Nicko Cadell + + + + Interface used by the to select the . + + + + The uses a + to specify the policy for selecting the correct + to return to the caller. + + + Nicko Cadell + Gert Driesen + + + + Gets the for the specified assembly. + + The assembly to use to lookup to the + The for the assembly. + + + Gets the for the specified assembly. + + + How the association between and + is made is not defined. The implementation may choose any method for + this association. The results of this method must be repeatable, i.e. + when called again with the same arguments the result must be the + save value. + + + + + + Gets the named . + + The name to use to lookup to the . + The named + + Lookup a named . This is the repository created by + calling . + + + + + Creates a new repository for the assembly specified. + + The assembly to use to create the domain to associate with the . + The type of repository to create, must implement . + The repository created. + + + The created will be associated with the domain + specified such that a call to with the + same assembly specified will return the same repository instance. + + + How the association between and + is made is not defined. The implementation may choose any method for + this association. + + + + + + Creates a new repository with the name specified. + + The name to associate with the . + The type of repository to create, must implement . + The repository created. + + + The created will be associated with the name + specified such that a call to with the + same name will return the same repository instance. + + + + + + Test if a named repository exists + + the named repository to check + true if the repository exists + + + Test if a named repository exists. Use + to create a new repository and to retrieve + a repository. + + + + + + Gets an array of all currently defined repositories. + + + An array of the instances created by + this . + + + Gets an array of all of the repositories created by this selector. + + + + + + Event to notify that a logger repository has been created. + + + Event to notify that a logger repository has been created. + + + + Event raised when a new repository is created. + The event source will be this selector. The event args will + be a which + holds the newly created . + + + + + + Create a new repository selector + + the type of the repositories to create, must implement + + + Create an new compact repository selector. + The default type for repositories must be specified, + an appropriate value would be . + + + throw if is null + throw if does not implement + + + + Get the for the specified assembly + + not used + The default + + + The argument is not used. This selector does not create a + separate repository for each assembly. + + + As a named repository is not specified the default repository is + returned. The default repository is named log4net-default-repository. + + + + + + Get the named + + the name of the repository to lookup + The named + + + Get the named . The default + repository is log4net-default-repository. Other repositories + must be created using the . + If the named repository does not exist an exception is thrown. + + + throw if is null + throw if the does not exist + + + + Create a new repository for the assembly specified + + not used + the type of repository to create, must implement + the repository created + + + The argument is not used. This selector does not create a + separate repository for each assembly. + + + If the is null then the + default repository type specified to the constructor is used. + + + As a named repository is not specified the default repository is + returned. The default repository is named log4net-default-repository. + + + + + + Create a new repository for the repository specified + + the repository to associate with the + the type of repository to create, must implement . + If this param is null then the default repository type is used. + the repository created + + + The created will be associated with the repository + specified such that a call to with the + same repository specified will return the same repository instance. + + + If the named repository already exists an exception will be thrown. + + + If is null then the default + repository type specified to the constructor is used. + + + throw if is null + throw if the already exists + + + + Test if a named repository exists + + the named repository to check + true if the repository exists + + + Test if a named repository exists. Use + to create a new repository and to retrieve + a repository. + + + + + + Gets a list of objects + + an array of all known objects + + + Gets an array of all of the repositories created by this selector. + + + + + + The fully qualified type of the CompactRepositorySelector class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Notify the registered listeners that the repository has been created + + The repository that has been created + + + Raises the LoggerRepositoryCreatedEvent + event. + + + + + + Event to notify that a logger repository has been created. + + + Event to notify that a logger repository has been created. + + + + Event raised when a new repository is created. + The event source will be this selector. The event args will + be a which + holds the newly created . + + + + + + The default implementation of the interface. + + + + Uses attributes defined on the calling assembly to determine how to + configure the hierarchy for the repository. + + + Nicko Cadell + Gert Driesen + + + + Creates a new repository selector. + + The type of the repositories to create, must implement + + + Create an new repository selector. + The default type for repositories must be specified, + an appropriate value would be . + + + is . + does not implement . + + + + Gets the for the specified assembly. + + The assembly use to lookup the . + + + The type of the created and the repository + to create can be overridden by specifying the + attribute on the . + + + The default values are to use the + implementation of the interface and to use the + as the name of the repository. + + + The created will be automatically configured using + any attributes defined on + the . + + + The for the assembly + is . + + + + Gets the for the specified repository. + + The repository to use to lookup the . + The for the specified repository. + + + Returns the named repository. If is null + a is thrown. If the repository + does not exist a is thrown. + + + Use to create a repository. + + + is . + does not exist. + + + + Create a new repository for the assembly specified + + the assembly to use to create the repository to associate with the . + The type of repository to create, must implement . + The repository created. + + + The created will be associated with the repository + specified such that a call to with the + same assembly specified will return the same repository instance. + + + The type of the created and + the repository to create can be overridden by specifying the + attribute on the + . The default values are to use the + implementation of the + interface and to use the + as the name of the repository. + + + The created will be automatically + configured using any + attributes defined on the . + + + If a repository for the already exists + that repository will be returned. An error will not be raised and that + repository may be of a different type to that specified in . + Also the attribute on the + assembly may be used to override the repository type specified in + . + + + is . + + + + Creates a new repository for the assembly specified. + + the assembly to use to create the repository to associate with the . + The type of repository to create, must implement . + The name to assign to the created repository + Set to true to read and apply the assembly attributes + The repository created. + + + The created will be associated with the repository + specified such that a call to with the + same assembly specified will return the same repository instance. + + + The type of the created and + the repository to create can be overridden by specifying the + attribute on the + . The default values are to use the + implementation of the + interface and to use the + as the name of the repository. + + + The created will be automatically + configured using any + attributes defined on the . + + + If a repository for the already exists + that repository will be returned. An error will not be raised and that + repository may be of a different type to that specified in . + Also the attribute on the + assembly may be used to override the repository type specified in + . + + + is . + + + + Creates a new repository for the specified repository. + + The repository to associate with the . + The type of repository to create, must implement . + If this param is then the default repository type is used. + The new repository. + + + The created will be associated with the repository + specified such that a call to with the + same repository specified will return the same repository instance. + + + is . + already exists. + + + + Test if a named repository exists + + the named repository to check + true if the repository exists + + + Test if a named repository exists. Use + to create a new repository and to retrieve + a repository. + + + + + + Gets a list of objects + + an array of all known objects + + + Gets an array of all of the repositories created by this selector. + + + + + + Aliases a repository to an existing repository. + + The repository to alias. + The repository that the repository is aliased to. + + + The repository specified will be aliased to the repository when created. + The repository must not already exist. + + + When the repository is created it must utilize the same repository type as + the repository it is aliased to, otherwise the aliasing will fail. + + + + is . + -or- + is . + + + + + Notifies the registered listeners that the repository has been created. + + The repository that has been created. + + + Raises the event. + + + + + + Gets the repository name and repository type for the specified assembly. + + The assembly that has a . + in/out param to hold the repository name to use for the assembly, caller should set this to the default value before calling. + in/out param to hold the type of the repository to create for the assembly, caller should set this to the default value before calling. + is . + + + + Configures the repository using information from the assembly. + + The assembly containing + attributes which define the configuration for the repository. + The repository to configure. + + is . + -or- + is . + + + + + Loads the attribute defined plugins on the assembly. + + The assembly that contains the attributes. + The repository to add the plugins to. + + is . + -or- + is . + + + + + Loads the attribute defined aliases on the assembly. + + The assembly that contains the attributes. + The repository to alias to. + + is . + -or- + is . + + + + + The fully qualified type of the DefaultRepositorySelector class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Event to notify that a logger repository has been created. + + + Event to notify that a logger repository has been created. + + + + Event raised when a new repository is created. + The event source will be this selector. The event args will + be a which + holds the newly created . + + + + + + Defined error codes that can be passed to the method. + + + + Values passed to the method. + + + Nicko Cadell + + + + A general error + + + + + Error while writing output + + + + + Failed to flush file + + + + + Failed to close file + + + + + Unable to open output file + + + + + No layout specified + + + + + Failed to parse address + + + + + An evaluator that triggers on an Exception type + + + + This evaluator will trigger if the type of the Exception + passed to + is equal to a Type in . /// + + + Drew Schaeffer + + + + Test if an triggers an action + + + + Implementations of this interface allow certain appenders to decide + when to perform an appender specific action. + + + The action or behavior triggered is defined by the implementation. + + + Nicko Cadell + + + + Test if this event triggers the action + + The event to check + true if this event triggers the action, otherwise false + + + Return true if this event triggers the action + + + + + + The type that causes the trigger to fire. + + + + + Causes subclasses of to cause the trigger to fire. + + + + + Default ctor to allow dynamic creation through a configurator. + + + + + Constructs an evaluator and initializes to trigger on + + the type that triggers this evaluator. + If true, this evaluator will trigger on subclasses of . + + + + Is this the triggering event? + + The event to check + This method returns true, if the logging event Exception + Type is . + Otherwise it returns false + + + This evaluator will trigger if the Exception Type of the event + passed to + is . + + + + + + The type that triggers this evaluator. + + + + + If true, this evaluator will trigger on subclasses of . + + + + + Appenders may delegate their error handling to an . + + + + Error handling is a particularly tedious to get right because by + definition errors are hard to predict and to reproduce. + + + Nicko Cadell + Gert Driesen + + + + Handles the error and information about the error condition is passed as + a parameter. + + The message associated with the error. + The that was thrown when the error occurred. + The error code associated with the error. + + + Handles the error and information about the error condition is passed as + a parameter. + + + + + + Prints the error message passed as a parameter. + + The message associated with the error. + The that was thrown when the error occurred. + + + See . + + + + + + Prints the error message passed as a parameter. + + The message associated with the error. + + + See . + + + + + + Interface for objects that require fixing. + + + + Interface that indicates that the object requires fixing before it + can be taken outside the context of the appender's + method. + + + When objects that implement this interface are stored + in the context properties maps + and + are fixed + (see ) the + method will be called. + + + Nicko Cadell + + + + Get a portable version of this object + + the portable instance of this object + + + Get a portable instance object that represents the current + state of this object. The portable object can be stored + and logged from any thread with identical results. + + + + + + Interface that all loggers implement + + + + This interface supports logging events and testing if a level + is enabled for logging. + + + These methods will not throw exceptions. Note to implementor, ensure + that the implementation of these methods cannot allow an exception + to be thrown to the caller. + + + Nicko Cadell + Gert Driesen + + + + This generic form is intended to be used by wrappers. + + The declaring type of the method that is + the stack boundary into the logging system for this call. + The level of the message to be logged. + The message object to log. + the exception to log, including its stack trace. Pass null to not log an exception. + + + Generates a logging event for the specified using + the and . + + + + + + This is the most generic printing method that is intended to be used + by wrappers. + + The event being logged. + + + Logs the specified logging event through this logger. + + + + + + Checks if this logger is enabled for a given passed as parameter. + + The level to check. + + true if this logger is enabled for level, otherwise false. + + + + Test if this logger is going to log events of the specified . + + + + + + Gets the name of the logger. + + + The name of the logger. + + + + The name of this logger + + + + + + Gets the where this + Logger instance is attached to. + + + The that this logger belongs to. + + + + Gets the where this + Logger instance is attached to. + + + + + + Base interface for all wrappers + + + + Base interface for all wrappers. + + + All wrappers must implement this interface. + + + Nicko Cadell + + + + Get the implementation behind this wrapper object. + + + The object that in implementing this object. + + + + The object that in implementing this + object. The Logger object may not + be the same object as this object because of logger decorators. + This gets the actual underlying objects that is used to process + the log events. + + + + + + Delegate used to handle logger repository creation event notifications + + The which created the repository. + The event args + that holds the instance that has been created. + + + Delegate used to handle logger repository creation event notifications. + + + + + + Provides data for the event. + + + + A + event is raised every time a is created. + + + + + + The created + + + + + Construct instance using specified + + the that has been created + + + Construct instance using specified + + + + + + The that has been created + + + The that has been created + + + + The that has been created + + + + + + Defines the default set of levels recognized by the system. + + + + Each has an associated . + + + Levels have a numeric that defines the relative + ordering between levels. Two Levels with the same + are deemed to be equivalent. + + + The levels that are recognized by log4net are set for each + and each repository can have different levels defined. The levels are stored + in the on the repository. Levels are + looked up by name from the . + + + When logging at level INFO the actual level used is not but + the value of LoggerRepository.LevelMap["INFO"]. The default value for this is + , but this can be changed by reconfiguring the level map. + + + Each level has a in addition to its . The + is the string that is written into the output log. By default + the display name is the same as the level name, but this can be used to alias levels + or to localize the log output. + + + Some of the predefined levels recognized by the system are: + + + + . + + + . + + + . + + + . + + + . + + + . + + + . + + + + Nicko Cadell + Gert Driesen + + + + Constructor + + Integer value for this level, higher values represent more severe levels. + The string name of this level. + The display name for this level. This may be localized or otherwise different from the name + + + Initializes a new instance of the class with + the specified level name and value. + + + + + + Constructor + + Integer value for this level, higher values represent more severe levels. + The string name of this level. + + + Initializes a new instance of the class with + the specified level name and value. + + + + + + Returns the representation of the current + . + + + A representation of the current . + + + + Returns the level . + + + + + + Compares levels. + + The object to compare against. + true if the objects are equal. + + + Compares the levels of instances, and + defers to base class if the target object is not a + instance. + + + + + + Returns a hash code + + A hash code for the current . + + + Returns a hash code suitable for use in hashing algorithms and data + structures like a hash table. + + + Returns the hash code of the level . + + + + + + Compares this instance to a specified object and returns an + indication of their relative values. + + A instance or to compare with this instance. + + A 32-bit signed integer that indicates the relative order of the + values compared. The return value has these meanings: + + + Value + Meaning + + + Less than zero + This instance is less than . + + + Zero + This instance is equal to . + + + Greater than zero + + This instance is greater than . + -or- + is . + + + + + + + must be an instance of + or ; otherwise, an exception is thrown. + + + is not a . + + + + Returns a value indicating whether a specified + is greater than another specified . + + A + A + + true if is greater than + ; otherwise, false. + + + + Compares two levels. + + + + + + Returns a value indicating whether a specified + is less than another specified . + + A + A + + true if is less than + ; otherwise, false. + + + + Compares two levels. + + + + + + Returns a value indicating whether a specified + is greater than or equal to another specified . + + A + A + + true if is greater than or equal to + ; otherwise, false. + + + + Compares two levels. + + + + + + Returns a value indicating whether a specified + is less than or equal to another specified . + + A + A + + true if is less than or equal to + ; otherwise, false. + + + + Compares two levels. + + + + + + Returns a value indicating whether two specified + objects have the same value. + + A or . + A or . + + true if the value of is the same as the + value of ; otherwise, false. + + + + Compares two levels. + + + + + + Returns a value indicating whether two specified + objects have different values. + + A or . + A or . + + true if the value of is different from + the value of ; otherwise, false. + + + + Compares two levels. + + + + + + Compares two specified instances. + + The first to compare. + The second to compare. + + A 32-bit signed integer that indicates the relative order of the + two values compared. The return value has these meanings: + + + Value + Meaning + + + Less than zero + is less than . + + + Zero + is equal to . + + + Greater than zero + is greater than . + + + + + + Compares two levels. + + + + + + The level designates a higher level than all the rest. + + + + + The level designates very severe error events. + System unusable, emergencies. + + + + + The level designates very severe error events. + System unusable, emergencies. + + + + + The level designates very severe error events + that will presumably lead the application to abort. + + + + + The level designates very severe error events. + Take immediate action, alerts. + + + + + The level designates very severe error events. + Critical condition, critical. + + + + + The level designates very severe error events. + + + + + The level designates error events that might + still allow the application to continue running. + + + + + The level designates potentially harmful + situations. + + + + + The level designates informational messages + that highlight the progress of the application at the highest level. + + + + + The level designates informational messages that + highlight the progress of the application at coarse-grained level. + + + + + The level designates fine-grained informational + events that are most useful to debug an application. + + + + + The level designates fine-grained informational + events that are most useful to debug an application. + + + + + The level designates fine-grained informational + events that are most useful to debug an application. + + + + + The level designates fine-grained informational + events that are most useful to debug an application. + + + + + The level designates fine-grained informational + events that are most useful to debug an application. + + + + + The level designates fine-grained informational + events that are most useful to debug an application. + + + + + The level designates the lowest level possible. + + + + + Gets the name of this level. + + + The name of this level. + + + + Gets the name of this level. + + + + + + Gets the value of this level. + + + The value of this level. + + + + Gets the value of this level. + + + + + + Gets the display name of this level. + + + The display name of this level. + + + + Gets the display name of this level. + + + + + + A strongly-typed collection of objects. + + Nicko Cadell + + + + Creates a read-only wrapper for a LevelCollection instance. + + list to create a readonly wrapper arround + + A LevelCollection wrapper that is read-only. + + + + + Initializes a new instance of the LevelCollection class + that is empty and has the default initial capacity. + + + + + Initializes a new instance of the LevelCollection class + that has the specified initial capacity. + + + The number of elements that the new LevelCollection is initially capable of storing. + + + + + Initializes a new instance of the LevelCollection class + that contains elements copied from the specified LevelCollection. + + The LevelCollection whose elements are copied to the new collection. + + + + Initializes a new instance of the LevelCollection class + that contains elements copied from the specified array. + + The array whose elements are copied to the new list. + + + + Initializes a new instance of the LevelCollection class + that contains elements copied from the specified collection. + + The collection whose elements are copied to the new list. + + + + Allow subclasses to avoid our default constructors + + + + + + Copies the entire LevelCollection to a one-dimensional + array. + + The one-dimensional array to copy to. + + + + Copies the entire LevelCollection to a one-dimensional + array, starting at the specified index of the target array. + + The one-dimensional array to copy to. + The zero-based index in at which copying begins. + + + + Adds a to the end of the LevelCollection. + + The to be added to the end of the LevelCollection. + The index at which the value has been added. + + + + Removes all elements from the LevelCollection. + + + + + Creates a shallow copy of the . + + A new with a shallow copy of the collection data. + + + + Determines whether a given is in the LevelCollection. + + The to check for. + true if is found in the LevelCollection; otherwise, false. + + + + Returns the zero-based index of the first occurrence of a + in the LevelCollection. + + The to locate in the LevelCollection. + + The zero-based index of the first occurrence of + in the entire LevelCollection, if found; otherwise, -1. + + + + + Inserts an element into the LevelCollection at the specified index. + + The zero-based index at which should be inserted. + The to insert. + + is less than zero + -or- + is equal to or greater than . + + + + + Removes the first occurrence of a specific from the LevelCollection. + + The to remove from the LevelCollection. + + The specified was not found in the LevelCollection. + + + + + Removes the element at the specified index of the LevelCollection. + + The zero-based index of the element to remove. + + is less than zero + -or- + is equal to or greater than . + + + + + Returns an enumerator that can iterate through the LevelCollection. + + An for the entire LevelCollection. + + + + Adds the elements of another LevelCollection to the current LevelCollection. + + The LevelCollection whose elements should be added to the end of the current LevelCollection. + The new of the LevelCollection. + + + + Adds the elements of a array to the current LevelCollection. + + The array whose elements should be added to the end of the LevelCollection. + The new of the LevelCollection. + + + + Adds the elements of a collection to the current LevelCollection. + + The collection whose elements should be added to the end of the LevelCollection. + The new of the LevelCollection. + + + + Sets the capacity to the actual number of elements. + + + + + is less than zero + -or- + is equal to or greater than . + + + + + is less than zero + -or- + is equal to or greater than . + + + + + Gets the number of elements actually contained in the LevelCollection. + + + + + Gets a value indicating whether access to the collection is synchronized (thread-safe). + + true if access to the ICollection is synchronized (thread-safe); otherwise, false. + + + + Gets an object that can be used to synchronize access to the collection. + + + + + Gets or sets the at the specified index. + + The zero-based index of the element to get or set. + + is less than zero + -or- + is equal to or greater than . + + + + + Gets a value indicating whether the collection has a fixed size. + + true if the collection has a fixed size; otherwise, false. The default is false + + + + Gets a value indicating whether the IList is read-only. + + true if the collection is read-only; otherwise, false. The default is false + + + + Gets or sets the number of elements the LevelCollection can contain. + + + + + Supports type-safe iteration over a . + + + + + Advances the enumerator to the next element in the collection. + + + true if the enumerator was successfully advanced to the next element; + false if the enumerator has passed the end of the collection. + + + The collection was modified after the enumerator was created. + + + + + Sets the enumerator to its initial position, before the first element in the collection. + + + + + Gets the current element in the collection. + + + + + Type visible only to our subclasses + Used to access protected constructor + + + + + A value + + + + + Supports simple iteration over a . + + + + + Initializes a new instance of the Enumerator class. + + + + + + Advances the enumerator to the next element in the collection. + + + true if the enumerator was successfully advanced to the next element; + false if the enumerator has passed the end of the collection. + + + The collection was modified after the enumerator was created. + + + + + Sets the enumerator to its initial position, before the first element in the collection. + + + + + Gets the current element in the collection. + + + + + An evaluator that triggers at a threshold level + + + + This evaluator will trigger if the level of the event + passed to + is equal to or greater than the + level. + + + Nicko Cadell + + + + The threshold for triggering + + + + + Create a new evaluator using the threshold. + + + + Create a new evaluator using the threshold. + + + This evaluator will trigger if the level of the event + passed to + is equal to or greater than the + level. + + + + + + Create a new evaluator using the specified threshold. + + the threshold to trigger at + + + Create a new evaluator using the specified threshold. + + + This evaluator will trigger if the level of the event + passed to + is equal to or greater than the + level. + + + + + + Is this the triggering event? + + The event to check + This method returns true, if the event level + is equal or higher than the . + Otherwise it returns false + + + This evaluator will trigger if the level of the event + passed to + is equal to or greater than the + level. + + + + + + the threshold to trigger at + + + The that will cause this evaluator to trigger + + + + This evaluator will trigger if the level of the event + passed to + is equal to or greater than the + level. + + + + + + Mapping between string name and Level object + + + + Mapping between string name and object. + This mapping is held separately for each . + The level name is case insensitive. + + + Nicko Cadell + + + + Mapping from level name to Level object. The + level name is case insensitive + + + + + Construct the level map + + + + Construct the level map. + + + + + + Clear the internal maps of all levels + + + + Clear the internal maps of all levels + + + + + + Create a new Level and add it to the map + + the string to display for the Level + the level value to give to the Level + + + Create a new Level and add it to the map + + + + + + + Create a new Level and add it to the map + + the string to display for the Level + the level value to give to the Level + the display name to give to the Level + + + Create a new Level and add it to the map + + + + + + Add a Level to the map + + the Level to add + + + Add a Level to the map + + + + + + Lookup a named level from the map + + the name of the level to lookup is taken from this level. + If the level is not set on the map then this level is added + the level in the map with the name specified + + + Lookup a named level from the map. The name of the level to lookup is taken + from the property of the + argument. + + + If no level with the specified name is found then the + argument is added to the level map + and returned. + + + + + + Lookup a by name + + The name of the Level to lookup + a Level from the map with the name specified + + + Returns the from the + map with the name specified. If the no level is + found then null is returned. + + + + + + Return all possible levels as a list of Level objects. + + all possible levels as a list of Level objects + + + Return all possible levels as a list of Level objects. + + + + + + The internal representation of caller location information. + + + + This class uses the System.Diagnostics.StackTrace class to generate + a call stack. The caller's information is then extracted from this stack. + + + The System.Diagnostics.StackTrace class is not supported on the + .NET Compact Framework 1.0 therefore caller location information is not + available on that framework. + + + The System.Diagnostics.StackTrace class has this to say about Release builds: + + + "StackTrace information will be most informative with Debug build configurations. + By default, Debug builds include debug symbols, while Release builds do not. The + debug symbols contain most of the file, method name, line number, and column + information used in constructing StackFrame and StackTrace objects. StackTrace + might not report as many method calls as expected, due to code transformations + that occur during optimization." + + + This means that in a Release build the caller information may be incomplete or may + not exist at all! Therefore caller location information cannot be relied upon in a Release build. + + + Nicko Cadell + Gert Driesen + + + + When location information is not available the constant + NA is returned. Current value of this string + constant is ?. + + + + + Constructor + + The declaring type of the method that is + the stack boundary into the logging system for this call. + + + Initializes a new instance of the + class based on the current thread. + + + + + + Constructor + + The fully qualified class name. + The method name. + The file name. + The line number of the method within the file. + + + Initializes a new instance of the + class with the specified data. + + + + + + The fully qualified type of the LocationInfo class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Gets the fully qualified class name of the caller making the logging + request. + + + The fully qualified class name of the caller making the logging + request. + + + + Gets the fully qualified class name of the caller making the logging + request. + + + + + + Gets the file name of the caller. + + + The file name of the caller. + + + + Gets the file name of the caller. + + + + + + Gets the line number of the caller. + + + The line number of the caller. + + + + Gets the line number of the caller. + + + + + + Gets the method name of the caller. + + + The method name of the caller. + + + + Gets the method name of the caller. + + + + + + Gets all available caller information + + + All available caller information, in the format + fully.qualified.classname.of.caller.methodName(Filename:line) + + + + Gets all available caller information, in the format + fully.qualified.classname.of.caller.methodName(Filename:line) + + + + + + Gets the stack frames from the stack trace of the caller making the log request + + + + + Static manager that controls the creation of repositories + + + + Static manager that controls the creation of repositories + + + This class is used by the wrapper managers (e.g. ) + to provide access to the objects. + + + This manager also holds the that is used to + lookup and create repositories. The selector can be set either programmatically using + the property, or by setting the log4net.RepositorySelector + AppSetting in the applications config file to the fully qualified type name of the + selector to use. + + + Nicko Cadell + Gert Driesen + + + + Private constructor to prevent instances. Only static methods should be used. + + + + Private constructor to prevent instances. Only static methods should be used. + + + + + + Hook the shutdown event + + + + On the full .NET runtime, the static constructor hooks up the + AppDomain.ProcessExit and AppDomain.DomainUnload> events. + These are used to shutdown the log4net system as the application exits. + + + + + + Register for ProcessExit and DomainUnload events on the AppDomain + + + + This needs to be in a separate method because the events make + a LinkDemand for the ControlAppDomain SecurityPermission. Because + this is a LinkDemand it is demanded at JIT time. Therefore we cannot + catch the exception in the method itself, we have to catch it in the + caller. + + + + + + Return the default instance. + + the repository to lookup in + Return the default instance + + + Gets the for the repository specified + by the argument. + + + + + + Returns the default instance. + + The assembly to use to lookup the repository. + The default instance. + + + + Return the default instance. + + the repository to lookup in + Return the default instance + + + Gets the for the repository specified + by the argument. + + + + + + Returns the default instance. + + The assembly to use to lookup the repository. + The default instance. + + + Returns the default instance. + + + + + + Returns the named logger if it exists. + + The repository to lookup in. + The fully qualified logger name to look for. + + The logger found, or null if the named logger does not exist in the + specified repository. + + + + If the named logger exists (in the specified repository) then it + returns a reference to the logger, otherwise it returns + null. + + + + + + Returns the named logger if it exists. + + The assembly to use to lookup the repository. + The fully qualified logger name to look for. + + The logger found, or null if the named logger does not exist in the + specified assembly's repository. + + + + If the named logger exists (in the specified assembly's repository) then it + returns a reference to the logger, otherwise it returns + null. + + + + + + Returns all the currently defined loggers in the specified repository. + + The repository to lookup in. + All the defined loggers. + + + The root logger is not included in the returned array. + + + + + + Returns all the currently defined loggers in the specified assembly's repository. + + The assembly to use to lookup the repository. + All the defined loggers. + + + The root logger is not included in the returned array. + + + + + + Retrieves or creates a named logger. + + The repository to lookup in. + The name of the logger to retrieve. + The logger with the name specified. + + + Retrieves a logger named as the + parameter. If the named logger already exists, then the + existing instance will be returned. Otherwise, a new instance is + created. + + + By default, loggers do not have a set level but inherit + it from the hierarchy. This is one of the central features of + log4net. + + + + + + Retrieves or creates a named logger. + + The assembly to use to lookup the repository. + The name of the logger to retrieve. + The logger with the name specified. + + + Retrieves a logger named as the + parameter. If the named logger already exists, then the + existing instance will be returned. Otherwise, a new instance is + created. + + + By default, loggers do not have a set level but inherit + it from the hierarchy. This is one of the central features of + log4net. + + + + + + Shorthand for . + + The repository to lookup in. + The of which the fullname will be used as the name of the logger to retrieve. + The logger with the name specified. + + + Gets the logger for the fully qualified name of the type specified. + + + + + + Shorthand for . + + the assembly to use to lookup the repository + The of which the fullname will be used as the name of the logger to retrieve. + The logger with the name specified. + + + Gets the logger for the fully qualified name of the type specified. + + + + + + Shuts down the log4net system. + + + + Calling this method will safely close and remove all + appenders in all the loggers including root contained in all the + default repositories. + + + Some appenders need to be closed before the application exists. + Otherwise, pending logging events might be lost. + + + The shutdown method is careful to close nested + appenders before closing regular appenders. This is allows + configurations where a regular appender is attached to a logger + and again to a nested appender. + + + + + + Shuts down the repository for the repository specified. + + The repository to shutdown. + + + Calling this method will safely close and remove all + appenders in all the loggers including root contained in the + repository for the specified. + + + Some appenders need to be closed before the application exists. + Otherwise, pending logging events might be lost. + + + The shutdown method is careful to close nested + appenders before closing regular appenders. This is allows + configurations where a regular appender is attached to a logger + and again to a nested appender. + + + + + + Shuts down the repository for the repository specified. + + The assembly to use to lookup the repository. + + + Calling this method will safely close and remove all + appenders in all the loggers including root contained in the + repository for the repository. The repository is looked up using + the specified. + + + Some appenders need to be closed before the application exists. + Otherwise, pending logging events might be lost. + + + The shutdown method is careful to close nested + appenders before closing regular appenders. This is allows + configurations where a regular appender is attached to a logger + and again to a nested appender. + + + + + + Resets all values contained in this repository instance to their defaults. + + The repository to reset. + + + Resets all values contained in the repository instance to their + defaults. This removes all appenders from all loggers, sets + the level of all non-root loggers to null, + sets their additivity flag to true and sets the level + of the root logger to . Moreover, + message disabling is set its default "off" value. + + + + + + Resets all values contained in this repository instance to their defaults. + + The assembly to use to lookup the repository to reset. + + + Resets all values contained in the repository instance to their + defaults. This removes all appenders from all loggers, sets + the level of all non-root loggers to null, + sets their additivity flag to true and sets the level + of the root logger to . Moreover, + message disabling is set its default "off" value. + + + + + + Creates a repository with the specified name. + + The name of the repository, this must be unique amongst repositories. + The created for the repository. + + + CreateDomain is obsolete. Use CreateRepository instead of CreateDomain. + + + Creates the default type of which is a + object. + + + The name must be unique. Repositories cannot be redefined. + An will be thrown if the repository already exists. + + + The specified repository already exists. + + + + Creates a repository with the specified name. + + The name of the repository, this must be unique amongst repositories. + The created for the repository. + + + Creates the default type of which is a + object. + + + The name must be unique. Repositories cannot be redefined. + An will be thrown if the repository already exists. + + + The specified repository already exists. + + + + Creates a repository with the specified name and repository type. + + The name of the repository, this must be unique to the repository. + A that implements + and has a no arg constructor. An instance of this type will be created to act + as the for the repository specified. + The created for the repository. + + + CreateDomain is obsolete. Use CreateRepository instead of CreateDomain. + + + The name must be unique. Repositories cannot be redefined. + An Exception will be thrown if the repository already exists. + + + The specified repository already exists. + + + + Creates a repository with the specified name and repository type. + + The name of the repository, this must be unique to the repository. + A that implements + and has a no arg constructor. An instance of this type will be created to act + as the for the repository specified. + The created for the repository. + + + The name must be unique. Repositories cannot be redefined. + An Exception will be thrown if the repository already exists. + + + The specified repository already exists. + + + + Creates a repository for the specified assembly and repository type. + + The assembly to use to get the name of the repository. + A that implements + and has a no arg constructor. An instance of this type will be created to act + as the for the repository specified. + The created for the repository. + + + CreateDomain is obsolete. Use CreateRepository instead of CreateDomain. + + + The created will be associated with the repository + specified such that a call to with the + same assembly specified will return the same repository instance. + + + + + + Creates a repository for the specified assembly and repository type. + + The assembly to use to get the name of the repository. + A that implements + and has a no arg constructor. An instance of this type will be created to act + as the for the repository specified. + The created for the repository. + + + The created will be associated with the repository + specified such that a call to with the + same assembly specified will return the same repository instance. + + + + + + Gets an array of all currently defined repositories. + + An array of all the known objects. + + + Gets an array of all currently defined repositories. + + + + + + Internal method to get pertinent version info. + + A string of version info. + + + + Called when the event fires + + the that is exiting + null + + + Called when the event fires. + + + When the event is triggered the log4net system is . + + + + + + Called when the event fires + + the that is exiting + null + + + Called when the event fires. + + + When the event is triggered the log4net system is . + + + + + + The fully qualified type of the LoggerManager class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Initialize the default repository selector + + + + + Gets or sets the repository selector used by the . + + + The repository selector used by the . + + + + The repository selector () is used by + the to create and select repositories + (). + + + The caller to supplies either a string name + or an assembly (if not supplied the assembly is inferred using + ). + + + This context is used by the selector to lookup a specific repository. + + + For the full .NET Framework, the default repository is DefaultRepositorySelector; + for the .NET Compact Framework CompactRepositorySelector is the default + repository. + + + + + + Implementation of the interface. + + + + This class should be used as the base for all wrapper implementations. + + + Nicko Cadell + Gert Driesen + + + + Constructs a new wrapper for the specified logger. + + The logger to wrap. + + + Constructs a new wrapper for the specified logger. + + + + + + The logger that this object is wrapping + + + + + Gets the implementation behind this wrapper object. + + + The object that this object is implementing. + + + + The Logger object may not be the same object as this object + because of logger decorators. + + + This gets the actual underlying objects that is used to process + the log events. + + + + + + Portable data structure used by + + + + Portable data structure used by + + + Nicko Cadell + + + + The logger name. + + + + The logger name. + + + + + + Level of logging event. + + + + Level of logging event. Level cannot be Serializable + because it is a flyweight. Due to its special serialization it + cannot be declared final either. + + + + + + The application supplied message. + + + + The application supplied message of logging event. + + + + + + The name of thread + + + + The name of thread in which this logging event was generated + + + + + + The time the event was logged + + + + The TimeStamp is stored in the local time zone for this computer. + + + + + + Location information for the caller. + + + + Location information for the caller. + + + + + + String representation of the user + + + + String representation of the user's windows name, + like DOMAIN\username + + + + + + String representation of the identity. + + + + String representation of the current thread's principal identity. + + + + + + The string representation of the exception + + + + The string representation of the exception + + + + + + String representation of the AppDomain. + + + + String representation of the AppDomain. + + + + + + Additional event specific properties + + + + A logger or an appender may attach additional + properties to specific events. These properties + have a string key and an object value. + + + + + + Flags passed to the property + + + + Flags passed to the property + + + Nicko Cadell + + + + Fix the MDC + + + + + Fix the NDC + + + + + Fix the rendered message + + + + + Fix the thread name + + + + + Fix the callers location information + + + CAUTION: Very slow to generate + + + + + Fix the callers windows user name + + + CAUTION: Slow to generate + + + + + Fix the domain friendly name + + + + + Fix the callers principal name + + + CAUTION: May be slow to generate + + + + + Fix the exception text + + + + + Fix the event properties. Active properties must implement in order to be eligible for fixing. + + + + + No fields fixed + + + + + All fields fixed + + + + + Partial fields fixed + + + + This set of partial fields gives good performance. The following fields are fixed: + + + + + + + + + + + + + The internal representation of logging events. + + + + When an affirmative decision is made to log then a + instance is created. This instance + is passed around to the different log4net components. + + + This class is of concern to those wishing to extend log4net. + + + Some of the values in instances of + are considered volatile, that is the values are correct at the + time the event is delivered to appenders, but will not be consistent + at any time afterwards. If an event is to be stored and then processed + at a later time these volatile values must be fixed by calling + . There is a performance penalty + for incurred by calling but it + is essential to maintaining data consistency. + + + Nicko Cadell + Gert Driesen + Douglas de la Torre + Daniel Cazzulino + + + + The key into the Properties map for the host name value. + + + + + The key into the Properties map for the thread identity value. + + + + + The key into the Properties map for the user name value. + + + + + Initializes a new instance of the class + from the supplied parameters. + + The declaring type of the method that is + the stack boundary into the logging system for this call. + The repository this event is logged in. + The name of the logger of this event. + The level of this event. + The message of this event. + The exception for this event. + + + Except , and , + all fields of LoggingEvent are filled when actually needed. Call + to cache all data locally + to prevent inconsistencies. + + This method is called by the log4net framework + to create a logging event. + + + + + + Initializes a new instance of the class + using specific data. + + The declaring type of the method that is + the stack boundary into the logging system for this call. + The repository this event is logged in. + Data used to initialize the logging event. + The fields in the struct that have already been fixed. + + + This constructor is provided to allow a + to be created independently of the log4net framework. This can + be useful if you require a custom serialization scheme. + + + Use the method to obtain an + instance of the class. + + + The parameter should be used to specify which fields in the + struct have been preset. Fields not specified in the + will be captured from the environment if requested or fixed. + + + + + + Initializes a new instance of the class + using specific data. + + The declaring type of the method that is + the stack boundary into the logging system for this call. + The repository this event is logged in. + Data used to initialize the logging event. + + + This constructor is provided to allow a + to be created independently of the log4net framework. This can + be useful if you require a custom serialization scheme. + + + Use the method to obtain an + instance of the class. + + + This constructor sets this objects flags to , + this assumes that all the data relating to this event is passed in via the + parameter and no other data should be captured from the environment. + + + + + + Initializes a new instance of the class + using specific data. + + Data used to initialize the logging event. + + + This constructor is provided to allow a + to be created independently of the log4net framework. This can + be useful if you require a custom serialization scheme. + + + Use the method to obtain an + instance of the class. + + + This constructor sets this objects flags to , + this assumes that all the data relating to this event is passed in via the + parameter and no other data should be captured from the environment. + + + + + + Serialization constructor + + The that holds the serialized object data. + The that contains contextual information about the source or destination. + + + Initializes a new instance of the class + with serialized data. + + + + + + Ensure that the repository is set. + + the value for the repository + + + + Write the rendered message to a TextWriter + + the writer to write the message to + + + Unlike the property this method + does store the message data in the internal cache. Therefore + if called only once this method should be faster than the + property, however if the message is + to be accessed multiple times then the property will be more efficient. + + + + + + Serializes this object into the provided. + + The to populate with data. + The destination for this serialization. + + + The data in this event must be fixed before it can be serialized. + + + The method must be called during the + method call if this event + is to be used outside that method. + + + + + + Gets the portable data for this . + + The for this event. + + + A new can be constructed using a + instance. + + + Does a fix of the data + in the logging event before returning the event data. + + + + + + Gets the portable data for this . + + The set of data to ensure is fixed in the LoggingEventData + The for this event. + + + A new can be constructed using a + instance. + + + + + + Returns this event's exception's rendered using the + . + + + This event's exception's rendered using the . + + + + Obsolete. Use instead. + + + + + + Returns this event's exception's rendered using the + . + + + This event's exception's rendered using the . + + + + Returns this event's exception's rendered using the + . + + + + + + Fix instance fields that hold volatile data. + + + + Some of the values in instances of + are considered volatile, that is the values are correct at the + time the event is delivered to appenders, but will not be consistent + at any time afterwards. If an event is to be stored and then processed + at a later time these volatile values must be fixed by calling + . There is a performance penalty + incurred by calling but it + is essential to maintaining data consistency. + + + Calling is equivalent to + calling passing the parameter + false. + + + See for more + information. + + + + + + Fixes instance fields that hold volatile data. + + Set to true to not fix data that takes a long time to fix. + + + Some of the values in instances of + are considered volatile, that is the values are correct at the + time the event is delivered to appenders, but will not be consistent + at any time afterwards. If an event is to be stored and then processed + at a later time these volatile values must be fixed by calling + . There is a performance penalty + for incurred by calling but it + is essential to maintaining data consistency. + + + The param controls the data that + is fixed. Some of the data that can be fixed takes a long time to + generate, therefore if you do not require those settings to be fixed + they can be ignored by setting the param + to true. This setting will ignore the + and settings. + + + Set to false to ensure that all + settings are fixed. + + + + + + Fix the fields specified by the parameter + + the fields to fix + + + Only fields specified in the will be fixed. + Fields will not be fixed if they have previously been fixed. + It is not possible to 'unfix' a field. + + + + + + Lookup a composite property in this event + + the key for the property to lookup + the value for the property + + + This event has composite properties that combine together properties from + several different contexts in the following order: + + + this events properties + + This event has that can be set. These + properties are specific to this event only. + + + + the thread properties + + The that are set on the current + thread. These properties are shared by all events logged on this thread. + + + + the global properties + + The that are set globally. These + properties are shared by all the threads in the AppDomain. + + + + + + + + + Get all the composite properties in this event + + the containing all the properties + + + See for details of the composite properties + stored by the event. + + + This method returns a single containing all the + properties defined for this event. + + + + + + The internal logging event data. + + + + + The internal logging event data. + + + + + The internal logging event data. + + + + + The fully qualified Type of the calling + logger class in the stack frame (i.e. the declaring type of the method). + + + + + The application supplied message of logging event. + + + + + The exception that was thrown. + + + This is not serialized. The string representation + is serialized instead. + + + + + The repository that generated the logging event + + + This is not serialized. + + + + + The fix state for this event + + + These flags indicate which fields have been fixed. + Not serialized. + + + + + Indicated that the internal cache is updateable (ie not fixed) + + + This is a seperate flag to m_fixFlags as it allows incrementel fixing and simpler + changes in the caching strategy. + + + + + Gets the time when the current process started. + + + This is the time when this process started. + + + + The TimeStamp is stored in the local time zone for this computer. + + + Tries to get the start time for the current process. + Failing that it returns the time of the first call to + this property. + + + Note that AppDomains may be loaded and unloaded within the + same process without the process terminating and therefore + without the process start time being reset. + + + + + + Gets the of the logging event. + + + The of the logging event. + + + + Gets the of the logging event. + + + + + + Gets the time of the logging event. + + + The time of the logging event. + + + + The TimeStamp is stored in the local time zone for this computer. + + + + + + Gets the name of the logger that logged the event. + + + The name of the logger that logged the event. + + + + Gets the name of the logger that logged the event. + + + + + + Gets the location information for this logging event. + + + The location information for this logging event. + + + + The collected information is cached for future use. + + + See the class for more information on + supported frameworks and the different behavior in Debug and + Release builds. + + + + + + Gets the message object used to initialize this event. + + + The message object used to initialize this event. + + + + Gets the message object used to initialize this event. + Note that this event may not have a valid message object. + If the event is serialized the message object will not + be transferred. To get the text of the message the + property must be used + not this property. + + + If there is no defined message object for this event then + null will be returned. + + + + + + Gets the exception object used to initialize this event. + + + The exception object used to initialize this event. + + + + Gets the exception object used to initialize this event. + Note that this event may not have a valid exception object. + If the event is serialized the exception object will not + be transferred. To get the text of the exception the + method must be used + not this property. + + + If there is no defined exception object for this event then + null will be returned. + + + + + + The that this event was created in. + + + + The that this event was created in. + + + + + + Gets the message, rendered through the . + + + The message rendered through the . + + + + The collected information is cached for future use. + + + + + + Gets the name of the current thread. + + + The name of the current thread, or the thread ID when + the name is not available. + + + + The collected information is cached for future use. + + + + + + Gets the name of the current user. + + + The name of the current user, or NOT AVAILABLE when the + underlying runtime has no support for retrieving the name of the + current user. + + + + Calls WindowsIdentity.GetCurrent().Name to get the name of + the current windows user. + + + To improve performance, we could cache the string representation of + the name, and reuse that as long as the identity stayed constant. + Once the identity changed, we would need to re-assign and re-render + the string. + + + However, the WindowsIdentity.GetCurrent() call seems to + return different objects every time, so the current implementation + doesn't do this type of caching. + + + Timing for these operations: + + + + Method + Results + + + WindowsIdentity.GetCurrent() + 10000 loops, 00:00:00.2031250 seconds + + + WindowsIdentity.GetCurrent().Name + 10000 loops, 00:00:08.0468750 seconds + + + + This means we could speed things up almost 40 times by caching the + value of the WindowsIdentity.GetCurrent().Name property, since + this takes (8.04-0.20) = 7.84375 seconds. + + + + + + Gets the identity of the current thread principal. + + + The string name of the identity of the current thread principal. + + + + Calls System.Threading.Thread.CurrentPrincipal.Identity.Name to get + the name of the current thread principal. + + + + + + Gets the AppDomain friendly name. + + + The AppDomain friendly name. + + + + Gets the AppDomain friendly name. + + + + + + Additional event specific properties. + + + Additional event specific properties. + + + + A logger or an appender may attach additional + properties to specific events. These properties + have a string key and an object value. + + + This property is for events that have been added directly to + this event. The aggregate properties (which include these + event properties) can be retrieved using + and . + + + Once the properties have been fixed this property + returns the combined cached properties. This ensures that updates to + this property are always reflected in the underlying storage. When + returning the combined properties there may be more keys in the + Dictionary than expected. + + + + + + The fixed fields in this event + + + The set of fields that are fixed in this event + + + + Fields will not be fixed if they have previously been fixed. + It is not possible to 'unfix' a field. + + + + + + Implementation of wrapper interface. + + + + This implementation of the interface + forwards to the held by the base class. + + + This logger has methods to allow the caller to log at the following + levels: + + + + DEBUG + + The and methods log messages + at the DEBUG level. That is the level with that name defined in the + repositories . The default value + for this level is . The + property tests if this level is enabled for logging. + + + + INFO + + The and methods log messages + at the INFO level. That is the level with that name defined in the + repositories . The default value + for this level is . The + property tests if this level is enabled for logging. + + + + WARN + + The and methods log messages + at the WARN level. That is the level with that name defined in the + repositories . The default value + for this level is . The + property tests if this level is enabled for logging. + + + + ERROR + + The and methods log messages + at the ERROR level. That is the level with that name defined in the + repositories . The default value + for this level is . The + property tests if this level is enabled for logging. + + + + FATAL + + The and methods log messages + at the FATAL level. That is the level with that name defined in the + repositories . The default value + for this level is . The + property tests if this level is enabled for logging. + + + + + The values for these levels and their semantic meanings can be changed by + configuring the for the repository. + + + Nicko Cadell + Gert Driesen + + + + The ILog interface is use by application to log messages into + the log4net framework. + + + + Use the to obtain logger instances + that implement this interface. The + static method is used to get logger instances. + + + This class contains methods for logging at different levels and also + has properties for determining if those logging levels are + enabled in the current configuration. + + + This interface can be implemented in different ways. This documentation + specifies reasonable behavior that a caller can expect from the actual + implementation, however different implementations reserve the right to + do things differently. + + + Simple example of logging messages + + ILog log = LogManager.GetLogger("application-log"); + + log.Info("Application Start"); + log.Debug("This is a debug message"); + + if (log.IsDebugEnabled) + { + log.Debug("This is another debug message"); + } + + + + + Nicko Cadell + Gert Driesen + + + Log a message object with the level. + + Log a message object with the level. + + The message object to log. + + + This method first checks if this logger is DEBUG + enabled by comparing the level of this logger with the + level. If this logger is + DEBUG enabled, then it converts the message object + (passed as parameter) to a string by invoking the appropriate + . It then + proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of + the additivity flag. + + WARNING Note that passing an + to this method will print the name of the + but no stack trace. To print a stack trace use the + form instead. + + + + + + + + Log a message object with the level including + the stack trace of the passed + as a parameter. + + The message object to log. + The exception to log, including its stack trace. + + + See the form for more detailed information. + + + + + + + Log a formatted string with the level. + + Logs a formatted message string with the level. + + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + A String containing zero or more format items + An Object to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + A String containing zero or more format items + An Object to format + An Object to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + A String containing zero or more format items + An Object to format + An Object to format + An Object to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + An that supplies culture-specific formatting information + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + Log a message object with the level. + + Logs a message object with the level. + + + + This method first checks if this logger is INFO + enabled by comparing the level of this logger with the + level. If this logger is + INFO enabled, then it converts the message object + (passed as parameter) to a string by invoking the appropriate + . It then + proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of the + additivity flag. + + WARNING Note that passing an + to this method will print the name of the + but no stack trace. To print a stack trace use the + form instead. + + + The message object to log. + + + + + + Logs a message object with the INFO level including + the stack trace of the passed + as a parameter. + + The message object to log. + The exception to log, including its stack trace. + + + See the form for more detailed information. + + + + + + + Log a formatted message string with the level. + + Logs a formatted message string with the level. + + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + A String containing zero or more format items + An Object to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + A String containing zero or more format items + An Object to format + An Object to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + A String containing zero or more format items + An Object to format + An Object to format + An Object to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + An that supplies culture-specific formatting information + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + Log a message object with the level. + + Log a message object with the level. + + + + This method first checks if this logger is WARN + enabled by comparing the level of this logger with the + level. If this logger is + WARN enabled, then it converts the message object + (passed as parameter) to a string by invoking the appropriate + . It then + proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of the + additivity flag. + + WARNING Note that passing an + to this method will print the name of the + but no stack trace. To print a stack trace use the + form instead. + + + The message object to log. + + + + + + Log a message object with the level including + the stack trace of the passed + as a parameter. + + The message object to log. + The exception to log, including its stack trace. + + + See the form for more detailed information. + + + + + + + Log a formatted message string with the level. + + Logs a formatted message string with the level. + + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + A String containing zero or more format items + An Object to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + A String containing zero or more format items + An Object to format + An Object to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + A String containing zero or more format items + An Object to format + An Object to format + An Object to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + An that supplies culture-specific formatting information + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + Log a message object with the level. + + Logs a message object with the level. + + The message object to log. + + + This method first checks if this logger is ERROR + enabled by comparing the level of this logger with the + level. If this logger is + ERROR enabled, then it converts the message object + (passed as parameter) to a string by invoking the appropriate + . It then + proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of the + additivity flag. + + WARNING Note that passing an + to this method will print the name of the + but no stack trace. To print a stack trace use the + form instead. + + + + + + + + Log a message object with the level including + the stack trace of the passed + as a parameter. + + The message object to log. + The exception to log, including its stack trace. + + + See the form for more detailed information. + + + + + + + Log a formatted message string with the level. + + Logs a formatted message string with the level. + + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + A String containing zero or more format items + An Object to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + A String containing zero or more format items + An Object to format + An Object to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + A String containing zero or more format items + An Object to format + An Object to format + An Object to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + An that supplies culture-specific formatting information + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + Log a message object with the level. + + Log a message object with the level. + + + + This method first checks if this logger is FATAL + enabled by comparing the level of this logger with the + level. If this logger is + FATAL enabled, then it converts the message object + (passed as parameter) to a string by invoking the appropriate + . It then + proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of the + additivity flag. + + WARNING Note that passing an + to this method will print the name of the + but no stack trace. To print a stack trace use the + form instead. + + + The message object to log. + + + + + + Log a message object with the level including + the stack trace of the passed + as a parameter. + + The message object to log. + The exception to log, including its stack trace. + + + See the form for more detailed information. + + + + + + + Log a formatted message string with the level. + + Logs a formatted message string with the level. + + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + A String containing zero or more format items + An Object to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + A String containing zero or more format items + An Object to format + An Object to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + A String containing zero or more format items + An Object to format + An Object to format + An Object to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Logs a formatted message string with the level. + + An that supplies culture-specific formatting information + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the String.Format method. See + for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + + + Checks if this logger is enabled for the level. + + + true if this logger is enabled for events, false otherwise. + + + + This function is intended to lessen the computational cost of + disabled log debug statements. + + For some ILog interface log, when you write: + + log.Debug("This is entry number: " + i ); + + + You incur the cost constructing the message, string construction and concatenation in + this case, regardless of whether the message is logged or not. + + + If you are worried about speed (who isn't), then you should write: + + + if (log.IsDebugEnabled) + { + log.Debug("This is entry number: " + i ); + } + + + This way you will not incur the cost of parameter + construction if debugging is disabled for log. On + the other hand, if the log is debug enabled, you + will incur the cost of evaluating whether the logger is debug + enabled twice. Once in and once in + the . This is an insignificant overhead + since evaluating a logger takes about 1% of the time it + takes to actually log. This is the preferred style of logging. + + Alternatively if your logger is available statically then the is debug + enabled state can be stored in a static variable like this: + + + private static readonly bool isDebugEnabled = log.IsDebugEnabled; + + + Then when you come to log you can write: + + + if (isDebugEnabled) + { + log.Debug("This is entry number: " + i ); + } + + + This way the debug enabled state is only queried once + when the class is loaded. Using a private static readonly + variable is the most efficient because it is a run time constant + and can be heavily optimized by the JIT compiler. + + + Of course if you use a static readonly variable to + hold the enabled state of the logger then you cannot + change the enabled state at runtime to vary the logging + that is produced. You have to decide if you need absolute + speed or runtime flexibility. + + + + + + + + Checks if this logger is enabled for the level. + + + true if this logger is enabled for events, false otherwise. + + + For more information see . + + + + + + + + Checks if this logger is enabled for the level. + + + true if this logger is enabled for events, false otherwise. + + + For more information see . + + + + + + + + Checks if this logger is enabled for the level. + + + true if this logger is enabled for events, false otherwise. + + + For more information see . + + + + + + + + Checks if this logger is enabled for the level. + + + true if this logger is enabled for events, false otherwise. + + + For more information see . + + + + + + + + Construct a new wrapper for the specified logger. + + The logger to wrap. + + + Construct a new wrapper for the specified logger. + + + + + + Virtual method called when the configuration of the repository changes + + the repository holding the levels + + + Virtual method called when the configuration of the repository changes + + + + + + Logs a message object with the DEBUG level. + + The message object to log. + + + This method first checks if this logger is DEBUG + enabled by comparing the level of this logger with the + DEBUG level. If this logger is + DEBUG enabled, then it converts the message object + (passed as parameter) to a string by invoking the appropriate + . It then + proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of the + additivity flag. + + + WARNING Note that passing an + to this method will print the name of the + but no stack trace. To print a stack trace use the + form instead. + + + + + + Logs a message object with the DEBUG level + + The message object to log. + The exception to log, including its stack trace. + + + Logs a message object with the DEBUG level including + the stack trace of the passed + as a parameter. + + + See the form for more detailed information. + + + + + + + Logs a formatted message string with the DEBUG level. + + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + The string is formatted using the + format provider. To specify a localized provider use the + method. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a formatted message string with the DEBUG level. + + A String containing zero or more format items + An Object to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + The string is formatted using the + format provider. To specify a localized provider use the + method. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a formatted message string with the DEBUG level. + + A String containing zero or more format items + An Object to format + An Object to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + The string is formatted using the + format provider. To specify a localized provider use the + method. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a formatted message string with the DEBUG level. + + A String containing zero or more format items + An Object to format + An Object to format + An Object to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + The string is formatted using the + format provider. To specify a localized provider use the + method. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a formatted message string with the DEBUG level. + + An that supplies culture-specific formatting information + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a message object with the INFO level. + + The message object to log. + + + This method first checks if this logger is INFO + enabled by comparing the level of this logger with the + INFO level. If this logger is + INFO enabled, then it converts the message object + (passed as parameter) to a string by invoking the appropriate + . It then + proceeds to call all the registered appenders in this logger + and also higher in the hierarchy depending on the value of + the additivity flag. + + + WARNING Note that passing an + to this method will print the name of the + but no stack trace. To print a stack trace use the + form instead. + + + + + + Logs a message object with the INFO level. + + The message object to log. + The exception to log, including its stack trace. + + + Logs a message object with the INFO level including + the stack trace of the + passed as a parameter. + + + See the form for more detailed information. + + + + + + + Logs a formatted message string with the INFO level. + + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + The string is formatted using the + format provider. To specify a localized provider use the + method. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a formatted message string with the INFO level. + + A String containing zero or more format items + An Object to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + The string is formatted using the + format provider. To specify a localized provider use the + method. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a formatted message string with the INFO level. + + A String containing zero or more format items + An Object to format + An Object to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + The string is formatted using the + format provider. To specify a localized provider use the + method. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a formatted message string with the INFO level. + + A String containing zero or more format items + An Object to format + An Object to format + An Object to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + The string is formatted using the + format provider. To specify a localized provider use the + method. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a formatted message string with the INFO level. + + An that supplies culture-specific formatting information + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a message object with the WARN level. + + the message object to log + + + This method first checks if this logger is WARN + enabled by comparing the level of this logger with the + WARN level. If this logger is + WARN enabled, then it converts the message object + (passed as parameter) to a string by invoking the appropriate + . It then + proceeds to call all the registered appenders in this logger and + also higher in the hierarchy depending on the value of the + additivity flag. + + + WARNING Note that passing an to this + method will print the name of the but no + stack trace. To print a stack trace use the + form instead. + + + + + + Logs a message object with the WARN level + + The message object to log. + The exception to log, including its stack trace. + + + Logs a message object with the WARN level including + the stack trace of the + passed as a parameter. + + + See the form for more detailed information. + + + + + + + Logs a formatted message string with the WARN level. + + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + The string is formatted using the + format provider. To specify a localized provider use the + method. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a formatted message string with the WARN level. + + A String containing zero or more format items + An Object to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + The string is formatted using the + format provider. To specify a localized provider use the + method. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a formatted message string with the WARN level. + + A String containing zero or more format items + An Object to format + An Object to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + The string is formatted using the + format provider. To specify a localized provider use the + method. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a formatted message string with the WARN level. + + A String containing zero or more format items + An Object to format + An Object to format + An Object to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + The string is formatted using the + format provider. To specify a localized provider use the + method. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a formatted message string with the WARN level. + + An that supplies culture-specific formatting information + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a message object with the ERROR level. + + The message object to log. + + + This method first checks if this logger is ERROR + enabled by comparing the level of this logger with the + ERROR level. If this logger is + ERROR enabled, then it converts the message object + (passed as parameter) to a string by invoking the appropriate + . It then + proceeds to call all the registered appenders in this logger and + also higher in the hierarchy depending on the value of the + additivity flag. + + + WARNING Note that passing an to this + method will print the name of the but no + stack trace. To print a stack trace use the + form instead. + + + + + + Logs a message object with the ERROR level + + The message object to log. + The exception to log, including its stack trace. + + + Logs a message object with the ERROR level including + the stack trace of the + passed as a parameter. + + + See the form for more detailed information. + + + + + + + Logs a formatted message string with the ERROR level. + + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + The string is formatted using the + format provider. To specify a localized provider use the + method. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a formatted message string with the ERROR level. + + A String containing zero or more format items + An Object to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + The string is formatted using the + format provider. To specify a localized provider use the + method. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a formatted message string with the ERROR level. + + A String containing zero or more format items + An Object to format + An Object to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + The string is formatted using the + format provider. To specify a localized provider use the + method. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a formatted message string with the ERROR level. + + A String containing zero or more format items + An Object to format + An Object to format + An Object to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + The string is formatted using the + format provider. To specify a localized provider use the + method. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a formatted message string with the ERROR level. + + An that supplies culture-specific formatting information + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a message object with the FATAL level. + + The message object to log. + + + This method first checks if this logger is FATAL + enabled by comparing the level of this logger with the + FATAL level. If this logger is + FATAL enabled, then it converts the message object + (passed as parameter) to a string by invoking the appropriate + . It then + proceeds to call all the registered appenders in this logger and + also higher in the hierarchy depending on the value of the + additivity flag. + + + WARNING Note that passing an to this + method will print the name of the but no + stack trace. To print a stack trace use the + form instead. + + + + + + Logs a message object with the FATAL level + + The message object to log. + The exception to log, including its stack trace. + + + Logs a message object with the FATAL level including + the stack trace of the + passed as a parameter. + + + See the form for more detailed information. + + + + + + + Logs a formatted message string with the FATAL level. + + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + The string is formatted using the + format provider. To specify a localized provider use the + method. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a formatted message string with the FATAL level. + + A String containing zero or more format items + An Object to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + The string is formatted using the + format provider. To specify a localized provider use the + method. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a formatted message string with the FATAL level. + + A String containing zero or more format items + An Object to format + An Object to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + The string is formatted using the + format provider. To specify a localized provider use the + method. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a formatted message string with the FATAL level. + + A String containing zero or more format items + An Object to format + An Object to format + An Object to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + The string is formatted using the + format provider. To specify a localized provider use the + method. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Logs a formatted message string with the FATAL level. + + An that supplies culture-specific formatting information + A String containing zero or more format items + An Object array containing zero or more objects to format + + + The message is formatted using the method. See + String.Format for details of the syntax of the format string and the behavior + of the formatting. + + + This method does not take an object to include in the + log event. To pass an use one of the + methods instead. + + + + + + Event handler for the event + + the repository + Empty + + + + The fully qualified name of this declaring type not the type of any subclass. + + + + + Checks if this logger is enabled for the DEBUG + level. + + + true if this logger is enabled for DEBUG events, + false otherwise. + + + + This function is intended to lessen the computational cost of + disabled log debug statements. + + + For some log Logger object, when you write: + + + log.Debug("This is entry number: " + i ); + + + You incur the cost constructing the message, concatenation in + this case, regardless of whether the message is logged or not. + + + If you are worried about speed, then you should write: + + + if (log.IsDebugEnabled()) + { + log.Debug("This is entry number: " + i ); + } + + + This way you will not incur the cost of parameter + construction if debugging is disabled for log. On + the other hand, if the log is debug enabled, you + will incur the cost of evaluating whether the logger is debug + enabled twice. Once in IsDebugEnabled and once in + the Debug. This is an insignificant overhead + since evaluating a logger takes about 1% of the time it + takes to actually log. + + + + + + Checks if this logger is enabled for the INFO level. + + + true if this logger is enabled for INFO events, + false otherwise. + + + + See for more information and examples + of using this method. + + + + + + + Checks if this logger is enabled for the WARN level. + + + true if this logger is enabled for WARN events, + false otherwise. + + + + See for more information and examples + of using this method. + + + + + + + Checks if this logger is enabled for the ERROR level. + + + true if this logger is enabled for ERROR events, + false otherwise. + + + + See for more information and examples of using this method. + + + + + + + Checks if this logger is enabled for the FATAL level. + + + true if this logger is enabled for FATAL events, + false otherwise. + + + + See for more information and examples of using this method. + + + + + + + provides method information without actually referencing a System.Reflection.MethodBase + as that would require that the containing assembly is loaded. + + + + + + When location information is not available the constant + NA is returned. Current value of this string + constant is ?. + + + + + constructs a method item for an unknown method. + + + + + constructs a method item from the name of the method. + + + + + + constructs a method item from the name of the method and its parameters. + + + + + + + constructs a method item from a method base by determining the method name and its parameters. + + + + + + The fully qualified type of the StackFrameItem class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Gets the method name of the caller making the logging + request. + + + The method name of the caller making the logging + request. + + + + Gets the method name of the caller making the logging + request. + + + + + + Gets the method parameters of the caller making + the logging request. + + + The method parameters of the caller making + the logging request + + + + Gets the method parameters of the caller making + the logging request. + + + + + + A SecurityContext used by log4net when interacting with protected resources + + + + A SecurityContext used by log4net when interacting with protected resources + for example with operating system services. This can be used to impersonate + a principal that has been granted privileges on the system resources. + + + Nicko Cadell + + + + Impersonate this SecurityContext + + State supplied by the caller + An instance that will + revoke the impersonation of this SecurityContext, or null + + + Impersonate this security context. Further calls on the current + thread should now be made in the security context provided + by this object. When the result + method is called the security + context of the thread should be reverted to the state it was in + before was called. + + + + + + The providers default instances. + + + + A configured component that interacts with potentially protected system + resources uses a to provide the elevated + privileges required. If the object has + been not been explicitly provided to the component then the component + will request one from this . + + + By default the is + an instance of which returns only + objects. This is a reasonable default + where the privileges required are not know by the system. + + + This default behavior can be overridden by subclassing the + and overriding the method to return + the desired objects. The default provider + can be replaced by programmatically setting the value of the + property. + + + An alternative is to use the log4net.Config.SecurityContextProviderAttribute + This attribute can be applied to an assembly in the same way as the + log4net.Config.XmlConfiguratorAttribute". The attribute takes + the type to use as the as an argument. + + + Nicko Cadell + + + + The default provider + + + + + Protected default constructor to allow subclassing + + + + Protected default constructor to allow subclassing + + + + + + Create a SecurityContext for a consumer + + The consumer requesting the SecurityContext + An impersonation context + + + The default implementation is to return a . + + + Subclasses should override this method to provide their own + behavior. + + + + + + Gets or sets the default SecurityContextProvider + + + The default SecurityContextProvider + + + + The default provider is used by configured components that + require a and have not had one + given to them. + + + By default this is an instance of + that returns objects. + + + The default provider can be set programmatically by setting + the value of this property to a sub class of + that has the desired behavior. + + + + + + provides stack frame information without actually referencing a System.Diagnostics.StackFrame + as that would require that the containing assembly is loaded. + + + + + + When location information is not available the constant + NA is returned. Current value of this string + constant is ?. + + + + + returns a stack frame item from a stack frame. This + + + + + + + The fully qualified type of the StackFrameItem class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Gets the fully qualified class name of the caller making the logging + request. + + + The fully qualified class name of the caller making the logging + request. + + + + Gets the fully qualified class name of the caller making the logging + request. + + + + + + Gets the file name of the caller. + + + The file name of the caller. + + + + Gets the file name of the caller. + + + + + + Gets the line number of the caller. + + + The line number of the caller. + + + + Gets the line number of the caller. + + + + + + Gets the method name of the caller. + + + The method name of the caller. + + + + Gets the method name of the caller. + + + + + + Gets all available caller information + + + All available caller information, in the format + fully.qualified.classname.of.caller.methodName(Filename:line) + + + + Gets all available caller information, in the format + fully.qualified.classname.of.caller.methodName(Filename:line) + + + + + + An evaluator that triggers after specified number of seconds. + + + + This evaluator will trigger if the specified time period + has passed since last check. + + + Robert Sevcik + + + + The default time threshold for triggering in seconds. Zero means it won't trigger at all. + + + + + The time threshold for triggering in seconds. Zero means it won't trigger at all. + + + + + The time of last check. This gets updated when the object is created and when the evaluator triggers. + + + + + Create a new evaluator using the time threshold in seconds. + + + + Create a new evaluator using the time threshold in seconds. + + + This evaluator will trigger if the specified time period + has passed since last check. + + + + + + Create a new evaluator using the specified time threshold in seconds. + + + The time threshold in seconds to trigger after. + Zero means it won't trigger at all. + + + + Create a new evaluator using the specified time threshold in seconds. + + + This evaluator will trigger if the specified time period + has passed since last check. + + + + + + Is this the triggering event? + + The event to check + This method returns true, if the specified time period + has passed since last check.. + Otherwise it returns false + + + This evaluator will trigger if the specified time period + has passed since last check. + + + + + + The time threshold in seconds to trigger after + + + The time threshold in seconds to trigger after. + Zero means it won't trigger at all. + + + + This evaluator will trigger if the specified time period + has passed since last check. + + + + + + Delegate used to handle creation of new wrappers. + + The logger to wrap in a wrapper. + + + Delegate used to handle creation of new wrappers. This delegate + is called from the + method to construct the wrapper for the specified logger. + + + The delegate to use is supplied to the + constructor. + + + + + + Maps between logger objects and wrapper objects. + + + + This class maintains a mapping between objects and + objects. Use the method to + lookup the for the specified . + + + New wrapper instances are created by the + method. The default behavior is for this method to delegate construction + of the wrapper to the delegate supplied + to the constructor. This allows specialization of the behavior without + requiring subclassing of this type. + + + Nicko Cadell + Gert Driesen + + + + Initializes a new instance of the + + The handler to use to create the wrapper objects. + + + Initializes a new instance of the class with + the specified handler to create the wrapper objects. + + + + + + Gets the wrapper object for the specified logger. + + The wrapper object for the specified logger + + + If the logger is null then the corresponding wrapper is null. + + + Looks up the wrapper it it has previously been requested and + returns it. If the wrapper has never been requested before then + the virtual method is + called. + + + + + + Creates the wrapper object for the specified logger. + + The logger to wrap in a wrapper. + The wrapper object for the logger. + + + This implementation uses the + passed to the constructor to create the wrapper. This method + can be overridden in a subclass. + + + + + + Called when a monitored repository shutdown event is received. + + The that is shutting down + + + This method is called when a that this + is holding loggers for has signaled its shutdown + event . The default + behavior of this method is to release the references to the loggers + and their wrappers generated for this repository. + + + + + + Event handler for repository shutdown event. + + The sender of the event. + The event args. + + + + Map of logger repositories to hashtables of ILogger to ILoggerWrapper mappings + + + + + The handler to use to create the extension wrapper objects. + + + + + Internal reference to the delegate used to register for repository shutdown events. + + + + + Gets the map of logger repositories. + + + Map of logger repositories. + + + + Gets the hashtable that is keyed on . The + values are hashtables keyed on with the + value being the corresponding . + + + + + + Formats a as "HH:mm:ss,fff". + + + + Formats a in the format "HH:mm:ss,fff" for example, "15:49:37,459". + + + Nicko Cadell + Gert Driesen + + + + Render a as a string. + + + + Interface to abstract the rendering of a + instance into a string. + + + The method is used to render the + date to a text writer. + + + Nicko Cadell + Gert Driesen + + + + Formats the specified date as a string. + + The date to format. + The writer to write to. + + + Format the as a string and write it + to the provided. + + + + + + String constant used to specify AbsoluteTimeDateFormat in layouts. Current value is ABSOLUTE. + + + + + String constant used to specify DateTimeDateFormat in layouts. Current value is DATE. + + + + + String constant used to specify ISO8601DateFormat in layouts. Current value is ISO8601. + + + + + Renders the date into a string. Format is "HH:mm:ss". + + The date to render into a string. + The string builder to write to. + + + Subclasses should override this method to render the date + into a string using a precision up to the second. This method + will be called at most once per second and the result will be + reused if it is needed again during the same second. + + + + + + Renders the date into a string. Format is "HH:mm:ss,fff". + + The date to render into a string. + The writer to write to. + + + Uses the method to generate the + time string up to the seconds and then appends the current + milliseconds. The results from are + cached and is called at most once + per second. + + + Sub classes should override + rather than . + + + + + + Last stored time with precision up to the second. + + + + + Last stored time with precision up to the second, formatted + as a string. + + + + + Last stored time with precision up to the second, formatted + as a string. + + + + + Formats a as "dd MMM yyyy HH:mm:ss,fff" + + + + Formats a in the format + "dd MMM yyyy HH:mm:ss,fff" for example, + "06 Nov 1994 15:49:37,459". + + + Nicko Cadell + Gert Driesen + Angelika Schnagl + + + + Default constructor. + + + + Initializes a new instance of the class. + + + + + + Formats the date without the milliseconds part + + The date to format. + The string builder to write to. + + + Formats a DateTime in the format "dd MMM yyyy HH:mm:ss" + for example, "06 Nov 1994 15:49:37". + + + The base class will append the ",fff" milliseconds section. + This method will only be called at most once per second. + + + + + + The format info for the invariant culture. + + + + + Formats the as "yyyy-MM-dd HH:mm:ss,fff". + + + + Formats the specified as a string: "yyyy-MM-dd HH:mm:ss,fff". + + + Nicko Cadell + Gert Driesen + + + + Default constructor + + + + Initializes a new instance of the class. + + + + + + Formats the date without the milliseconds part + + The date to format. + The string builder to write to. + + + Formats the date specified as a string: "yyyy-MM-dd HH:mm:ss". + + + The base class will append the ",fff" milliseconds section. + This method will only be called at most once per second. + + + + + + Formats the using the method. + + + + Formats the using the method. + + + Nicko Cadell + Gert Driesen + + + + Constructor + + The format string. + + + Initializes a new instance of the class + with the specified format string. + + + The format string must be compatible with the options + that can be supplied to . + + + + + + Formats the date using . + + The date to convert to a string. + The writer to write to. + + + Uses the date format string supplied to the constructor to call + the method to format the date. + + + + + + The format string used to format the . + + + + The format string must be compatible with the options + that can be supplied to . + + + + + + This filter drops all . + + + + You can add this filter to the end of a filter chain to + switch from the default "accept all unless instructed otherwise" + filtering behavior to a "deny all unless instructed otherwise" + behavior. + + + Nicko Cadell + Gert Driesen + + + + Subclass this type to implement customized logging event filtering + + + + Users should extend this class to implement customized logging + event filtering. Note that and + , the parent class of all standard + appenders, have built-in filtering rules. It is suggested that you + first use and understand the built-in rules before rushing to write + your own custom filters. + + + This abstract class assumes and also imposes that filters be + organized in a linear chain. The + method of each filter is called sequentially, in the order of their + addition to the chain. + + + The method must return one + of the integer constants , + or . + + + If the value is returned, then the log event is dropped + immediately without consulting with the remaining filters. + + + If the value is returned, then the next filter + in the chain is consulted. If there are no more filters in the + chain, then the log event is logged. Thus, in the presence of no + filters, the default behavior is to log all logging events. + + + If the value is returned, then the log + event is logged without consulting the remaining filters. + + + The philosophy of log4net filters is largely inspired from the + Linux ipchains. + + + Nicko Cadell + Gert Driesen + + + + Implement this interface to provide customized logging event filtering + + + + Users should implement this interface to implement customized logging + event filtering. Note that and + , the parent class of all standard + appenders, have built-in filtering rules. It is suggested that you + first use and understand the built-in rules before rushing to write + your own custom filters. + + + This abstract class assumes and also imposes that filters be + organized in a linear chain. The + method of each filter is called sequentially, in the order of their + addition to the chain. + + + The method must return one + of the integer constants , + or . + + + If the value is returned, then the log event is dropped + immediately without consulting with the remaining filters. + + + If the value is returned, then the next filter + in the chain is consulted. If there are no more filters in the + chain, then the log event is logged. Thus, in the presence of no + filters, the default behavior is to log all logging events. + + + If the value is returned, then the log + event is logged without consulting the remaining filters. + + + The philosophy of log4net filters is largely inspired from the + Linux ipchains. + + + Nicko Cadell + Gert Driesen + + + + Decide if the logging event should be logged through an appender. + + The LoggingEvent to decide upon + The decision of the filter + + + If the decision is , then the event will be + dropped. If the decision is , then the next + filter, if any, will be invoked. If the decision is then + the event will be logged without consulting with other filters in + the chain. + + + + + + Property to get and set the next filter + + + The next filter in the chain + + + + Filters are typically composed into chains. This property allows the next filter in + the chain to be accessed. + + + + + + Points to the next filter in the filter chain. + + + + See for more information. + + + + + + Initialize the filter with the options set + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + Typically filter's options become active immediately on set, + however this method must still be called. + + + + + + Decide if the should be logged through an appender. + + The to decide upon + The decision of the filter + + + If the decision is , then the event will be + dropped. If the decision is , then the next + filter, if any, will be invoked. If the decision is then + the event will be logged without consulting with other filters in + the chain. + + + This method is marked abstract and must be implemented + in a subclass. + + + + + + Property to get and set the next filter + + + The next filter in the chain + + + + Filters are typically composed into chains. This property allows the next filter in + the chain to be accessed. + + + + + + Default constructor + + + + + Always returns the integer constant + + the LoggingEvent to filter + Always returns + + + Ignores the event being logged and just returns + . This can be used to change the default filter + chain behavior from to . This filter + should only be used as the last filter in the chain + as any further filters will be ignored! + + + + + + The return result from + + + + The return result from + + + + + + The log event must be dropped immediately without + consulting with the remaining filters, if any, in the chain. + + + + + This filter is neutral with respect to the log event. + The remaining filters, if any, should be consulted for a final decision. + + + + + The log event must be logged immediately without + consulting with the remaining filters, if any, in the chain. + + + + + This is a very simple filter based on matching. + + + + The filter admits two options and + . If there is an exact match between the value + of the option and the of the + , then the method returns in + case the option value is set + to true, if it is false then + is returned. If the does not match then + the result will be . + + + Nicko Cadell + Gert Driesen + + + + flag to indicate if the filter should on a match + + + + + the to match against + + + + + Default constructor + + + + + Tests if the of the logging event matches that of the filter + + the event to filter + see remarks + + + If the of the event matches the level of the + filter then the result of the function depends on the + value of . If it is true then + the function will return , it it is false then it + will return . If the does not match then + the result will be . + + + + + + when matching + + + + The property is a flag that determines + the behavior when a matching is found. If the + flag is set to true then the filter will the + logging event, otherwise it will the event. + + + The default is true i.e. to the event. + + + + + + The that the filter will match + + + + The level that this filter will attempt to match against the + level. If a match is found then + the result depends on the value of . + + + + + + This is a simple filter based on matching. + + + + The filter admits three options and + that determine the range of priorities that are matched, and + . If there is a match between the range + of priorities and the of the , then the + method returns in case the + option value is set to true, if it is false + then is returned. If there is no match, is returned. + + + Nicko Cadell + Gert Driesen + + + + Flag to indicate the behavior when matching a + + + + + the minimum value to match + + + + + the maximum value to match + + + + + Default constructor + + + + + Check if the event should be logged. + + the logging event to check + see remarks + + + If the of the logging event is outside the range + matched by this filter then + is returned. If the is matched then the value of + is checked. If it is true then + is returned, otherwise + is returned. + + + + + + when matching and + + + + The property is a flag that determines + the behavior when a matching is found. If the + flag is set to true then the filter will the + logging event, otherwise it will the event. + + + The default is true i.e. to the event. + + + + + + Set the minimum matched + + + + The minimum level that this filter will attempt to match against the + level. If a match is found then + the result depends on the value of . + + + + + + Sets the maximum matched + + + + The maximum level that this filter will attempt to match against the + level. If a match is found then + the result depends on the value of . + + + + + + Simple filter to match a string in the event's logger name. + + + + The works very similar to the . It admits two + options and . If the + of the starts + with the value of the option, then the + method returns in + case the option value is set to true, + if it is false then is returned. + + + Daniel Cazzulino + + + + Flag to indicate the behavior when we have a match + + + + + The logger name string to substring match against the event + + + + + Default constructor + + + + + Check if this filter should allow the event to be logged + + the event being logged + see remarks + + + The rendered message is matched against the . + If the equals the beginning of + the incoming () + then a match will have occurred. If no match occurs + this function will return + allowing other filters to check the event. If a match occurs then + the value of is checked. If it is + true then is returned otherwise + is returned. + + + + + + when matching + + + + The property is a flag that determines + the behavior when a matching is found. If the + flag is set to true then the filter will the + logging event, otherwise it will the event. + + + The default is true i.e. to the event. + + + + + + The that the filter will match + + + + This filter will attempt to match this value against logger name in + the following way. The match will be done against the beginning of the + logger name (using ). The match is + case sensitive. If a match is found then + the result depends on the value of . + + + + + + Simple filter to match a keyed string in the + + + + Simple filter to match a keyed string in the + + + As the MDC has been replaced with layered properties the + should be used instead. + + + Nicko Cadell + Gert Driesen + + + + Simple filter to match a string an event property + + + + Simple filter to match a string in the value for a + specific event property + + + Nicko Cadell + + + + Simple filter to match a string in the rendered message + + + + Simple filter to match a string in the rendered message + + + Nicko Cadell + Gert Driesen + + + + Flag to indicate the behavior when we have a match + + + + + The string to substring match against the message + + + + + A string regex to match + + + + + A regex object to match (generated from m_stringRegexToMatch) + + + + + Default constructor + + + + + Initialize and precompile the Regex if required + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + + + + Check if this filter should allow the event to be logged + + the event being logged + see remarks + + + The rendered message is matched against the . + If the occurs as a substring within + the message then a match will have occurred. If no match occurs + this function will return + allowing other filters to check the event. If a match occurs then + the value of is checked. If it is + true then is returned otherwise + is returned. + + + + + + when matching or + + + + The property is a flag that determines + the behavior when a matching is found. If the + flag is set to true then the filter will the + logging event, otherwise it will the event. + + + The default is true i.e. to the event. + + + + + + Sets the static string to match + + + + The string that will be substring matched against + the rendered message. If the message contains this + string then the filter will match. If a match is found then + the result depends on the value of . + + + One of or + must be specified. + + + + + + Sets the regular expression to match + + + + The regular expression pattern that will be matched against + the rendered message. If the message matches this + pattern then the filter will match. If a match is found then + the result depends on the value of . + + + One of or + must be specified. + + + + + + The key to use to lookup the string from the event properties + + + + + Default constructor + + + + + Check if this filter should allow the event to be logged + + the event being logged + see remarks + + + The event property for the is matched against + the . + If the occurs as a substring within + the property value then a match will have occurred. If no match occurs + this function will return + allowing other filters to check the event. If a match occurs then + the value of is checked. If it is + true then is returned otherwise + is returned. + + + + + + The key to lookup in the event properties and then match against. + + + + The key name to use to lookup in the properties map of the + . The match will be performed against + the value of this property if it exists. + + + + + + Simple filter to match a string in the + + + + Simple filter to match a string in the + + + As the MDC has been replaced with named stacks stored in the + properties collections the should + be used instead. + + + Nicko Cadell + Gert Driesen + + + + Default constructor + + + + Sets the to "NDC". + + + + + + Write the event appdomain name to the output + + + + Writes the to the output writer. + + + Daniel Cazzulino + Nicko Cadell + + + + Abstract class that provides the formatting functionality that + derived classes need. + + + Conversion specifiers in a conversion patterns are parsed to + individual PatternConverters. Each of which is responsible for + converting a logging event in a converter specific manner. + + Nicko Cadell + + + + Abstract class that provides the formatting functionality that + derived classes need. + + + + Conversion specifiers in a conversion patterns are parsed to + individual PatternConverters. Each of which is responsible for + converting a logging event in a converter specific manner. + + + Nicko Cadell + Gert Driesen + + + + Initial buffer size + + + + + Maximum buffer size before it is recycled + + + + + Protected constructor + + + + Initializes a new instance of the class. + + + + + + Evaluate this pattern converter and write the output to a writer. + + that will receive the formatted result. + The state object on which the pattern converter should be executed. + + + Derived pattern converters must override this method in order to + convert conversion specifiers in the appropriate way. + + + + + + Set the next pattern converter in the chains + + the pattern converter that should follow this converter in the chain + the next converter + + + The PatternConverter can merge with its neighbor during this method (or a sub class). + Therefore the return value may or may not be the value of the argument passed in. + + + + + + Write the pattern converter to the writer with appropriate formatting + + that will receive the formatted result. + The state object on which the pattern converter should be executed. + + + This method calls to allow the subclass to perform + appropriate conversion of the pattern converter. If formatting options have + been specified via the then this method will + apply those formattings before writing the output. + + + + + + Fast space padding method. + + to which the spaces will be appended. + The number of spaces to be padded. + + + Fast space padding method. + + + + + + The option string to the converter + + + + + Write an dictionary to a + + the writer to write to + a to use for object conversion + the value to write to the writer + + + Writes the to a writer in the form: + + + {key1=value1, key2=value2, key3=value3} + + + If the specified + is not null then it is used to render the key and value to text, otherwise + the object's ToString method is called. + + + + + + Write an dictionary to a + + the writer to write to + a to use for object conversion + the value to write to the writer + + + Writes the to a writer in the form: + + + {key1=value1, key2=value2, key3=value3} + + + If the specified + is not null then it is used to render the key and value to text, otherwise + the object's ToString method is called. + + + + + + Write an object to a + + the writer to write to + a to use for object conversion + the value to write to the writer + + + Writes the Object to a writer. If the specified + is not null then it is used to render the object to text, otherwise + the object's ToString method is called. + + + + + + Get the next pattern converter in the chain + + + the next pattern converter in the chain + + + + Get the next pattern converter in the chain + + + + + + Gets or sets the formatting info for this converter + + + The formatting info for this converter + + + + Gets or sets the formatting info for this converter + + + + + + Gets or sets the option value for this converter + + + The option for this converter + + + + Gets or sets the option value for this converter + + + + + + + + + + + Initializes a new instance of the class. + + + + + Derived pattern converters must override this method in order to + convert conversion specifiers in the correct way. + + that will receive the formatted result. + The on which the pattern converter should be executed. + + + + Derived pattern converters must override this method in order to + convert conversion specifiers in the correct way. + + that will receive the formatted result. + The state object on which the pattern converter should be executed. + + + + Flag indicating if this converter handles exceptions + + + false if this converter handles exceptions + + + + + Flag indicating if this converter handles the logging event exception + + false if this converter handles the logging event exception + + + If this converter handles the exception object contained within + , then this property should be set to + false. Otherwise, if the layout ignores the exception + object, then the property should be set to true. + + + Set this value to override a this default setting. The default + value is true, this converter does not handle the exception. + + + + + + Write the event appdomain name to the output + + that will receive the formatted result. + the event being logged + + + Writes the to the output . + + + + + + Converter for items in the ASP.Net Cache. + + + + Outputs an item from the . + + + Ron Grabowski + + + + Abstract class that provides access to the current HttpContext () that + derived classes need. + + + This class handles the case when HttpContext.Current is null by writing + to the writer. + + Ron Grabowski + + + + Derived pattern converters must override this method in order to + convert conversion specifiers in the correct way. + + that will receive the formatted result. + The on which the pattern converter should be executed. + The under which the ASP.Net request is running. + + + + Write the ASP.Net Cache item to the output + + that will receive the formatted result. + The on which the pattern converter should be executed. + The under which the ASP.Net request is running. + + + Writes out the value of a named property. The property name + should be set in the + property. If no property has been set, all key value pairs from the Cache will + be written to the output. + + + + + + Converter for items in the . + + + + Outputs an item from the . + + + Ron Grabowski + + + + Write the ASP.Net HttpContext item to the output + + that will receive the formatted result. + The on which the pattern converter should be executed. + The under which the ASP.Net request is running. + + + Writes out the value of a named property. The property name + should be set in the + property. + + + + + + Converter for items in the ASP.Net Cache. + + + + Outputs an item from the . + + + Ron Grabowski + + + + Write the ASP.Net Cache item to the output + + that will receive the formatted result. + The on which the pattern converter should be executed. + The under which the ASP.Net request is running. + + + Writes out the value of a named property. The property name + should be set in the + property. + + + + + + Converter for items in the ASP.Net Cache. + + + + Outputs an item from the . + + + Ron Grabowski + + + + Write the ASP.Net Cache item to the output + + that will receive the formatted result. + The on which the pattern converter should be executed. + The under which the ASP.Net request is running. + + + Writes out the value of a named property. The property name + should be set in the + property. If no property has been set, all key value pairs from the Session will + be written to the output. + + + + + + Date pattern converter, uses a to format + the date of a . + + + + Render the to the writer as a string. + + + The value of the determines + the formatting of the date. The following values are allowed: + + + Option value + Output + + + ISO8601 + + Uses the formatter. + Formats using the "yyyy-MM-dd HH:mm:ss,fff" pattern. + + + + DATE + + Uses the formatter. + Formats using the "dd MMM yyyy HH:mm:ss,fff" for example, "06 Nov 1994 15:49:37,459". + + + + ABSOLUTE + + Uses the formatter. + Formats using the "HH:mm:ss,yyyy" for example, "15:49:37,459". + + + + other + + Any other pattern string uses the formatter. + This formatter passes the pattern string to the + method. + For details on valid patterns see + DateTimeFormatInfo Class. + + + + + + The is in the local time zone and is rendered in that zone. + To output the time in Universal time see . + + + Nicko Cadell + + + + The used to render the date to a string + + + + The used to render the date to a string + + + + + + Initialize the converter pattern based on the property. + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + + + + Convert the pattern into the rendered message + + that will receive the formatted result. + the event being logged + + + Pass the to the + for it to render it to the writer. + + + The passed is in the local time zone. + + + + + + The fully qualified type of the DatePatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Write the exception text to the output + + + + If an exception object is stored in the logging event + it will be rendered into the pattern output with a + trailing newline. + + + If there is no exception then nothing will be output + and no trailing newline will be appended. + It is typical to put a newline before the exception + and to have the exception as the last data in the pattern. + + + Nicko Cadell + + + + Default constructor + + + + + Write the exception text to the output + + that will receive the formatted result. + the event being logged + + + If an exception object is stored in the logging event + it will be rendered into the pattern output with a + trailing newline. + + + If there is no exception or the exception property specified + by the Option value does not exist then nothing will be output + and no trailing newline will be appended. + It is typical to put a newline before the exception + and to have the exception as the last data in the pattern. + + + Recognized values for the Option parameter are: + + + + Message + + + Source + + + StackTrace + + + TargetSite + + + HelpLink + + + + + + + Writes the caller location file name to the output + + + + Writes the value of the for + the event to the output writer. + + + Nicko Cadell + + + + Write the caller location file name to the output + + that will receive the formatted result. + the event being logged + + + Writes the value of the for + the to the output . + + + + + + Write the caller location info to the output + + + + Writes the to the output writer. + + + Nicko Cadell + + + + Write the caller location info to the output + + that will receive the formatted result. + the event being logged + + + Writes the to the output writer. + + + + + + Writes the event identity to the output + + + + Writes the value of the to + the output writer. + + + Daniel Cazzulino + Nicko Cadell + + + + Writes the event identity to the output + + that will receive the formatted result. + the event being logged + + + Writes the value of the + to + the output . + + + + + + Write the event level to the output + + + + Writes the display name of the event + to the writer. + + + Nicko Cadell + + + + Write the event level to the output + + that will receive the formatted result. + the event being logged + + + Writes the of the + to the . + + + + + + Write the caller location line number to the output + + + + Writes the value of the for + the event to the output writer. + + + Nicko Cadell + + + + Write the caller location line number to the output + + that will receive the formatted result. + the event being logged + + + Writes the value of the for + the to the output . + + + + + + Converter for logger name + + + + Outputs the of the event. + + + Nicko Cadell + + + + Converter to output and truncate '.' separated strings + + + + This abstract class supports truncating a '.' separated string + to show a specified number of elements from the right hand side. + This is used to truncate class names that are fully qualified. + + + Subclasses should override the method to + return the fully qualified string. + + + Nicko Cadell + + + + Initialize the converter + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + + + + Get the fully qualified string data + + the event being logged + the fully qualified name + + + Overridden by subclasses to get the fully qualified name before the + precision is applied to it. + + + Return the fully qualified '.' (dot/period) separated string. + + + + + + Convert the pattern to the rendered message + + that will receive the formatted result. + the event being logged + + Render the to the precision + specified by the property. + + + + + The fully qualified type of the NamedPatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Gets the fully qualified name of the logger + + the event being logged + The fully qualified logger name + + + Returns the of the . + + + + + + Writes the event message to the output + + + + Uses the method + to write out the event message. + + + Nicko Cadell + + + + Writes the event message to the output + + that will receive the formatted result. + the event being logged + + + Uses the method + to write out the event message. + + + + + + Write the method name to the output + + + + Writes the caller location to + the output. + + + Nicko Cadell + + + + Write the method name to the output + + that will receive the formatted result. + the event being logged + + + Writes the caller location to + the output. + + + + + + Converter to include event NDC + + + + Outputs the value of the event property named NDC. + + + The should be used instead. + + + Nicko Cadell + + + + Write the event NDC to the output + + that will receive the formatted result. + the event being logged + + + As the thread context stacks are now stored in named event properties + this converter simply looks up the value of the NDC property. + + + The should be used instead. + + + + + + Property pattern converter + + + + Writes out the value of a named property. The property name + should be set in the + property. + + + If the is set to null + then all the properties are written as key value pairs. + + + Nicko Cadell + + + + Write the property value to the output + + that will receive the formatted result. + the event being logged + + + Writes out the value of a named property. The property name + should be set in the + property. + + + If the is set to null + then all the properties are written as key value pairs. + + + + + + Converter to output the relative time of the event + + + + Converter to output the time of the event relative to the start of the program. + + + Nicko Cadell + + + + Write the relative time to the output + + that will receive the formatted result. + the event being logged + + + Writes out the relative time of the event in milliseconds. + That is the number of milliseconds between the event + and the . + + + + + + Helper method to get the time difference between two DateTime objects + + start time (in the current local time zone) + end time (in the current local time zone) + the time difference in milliseconds + + + + Write the caller stack frames to the output + + + + Writes the to the output writer, using format: + type3.MethodCall3(type param,...) > type2.MethodCall2(type param,...) > type1.MethodCall1(type param,...) + + + Adam Davies + + + + Write the caller stack frames to the output + + + + Writes the to the output writer, using format: + type3.MethodCall3 > type2.MethodCall2 > type1.MethodCall1 + + + Michael Cromwell + + + + Initialize the converter + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + + + + Write the strack frames to the output + + that will receive the formatted result. + the event being logged + + + Writes the to the output writer. + + + + + + Returns the Name of the method + + + This method was created, so this class could be used as a base class for StackTraceDetailPatternConverter + string + + + + The fully qualified type of the StackTracePatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + + + + The fully qualified type of the StackTraceDetailPatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Converter to include event thread name + + + + Writes the to the output. + + + Nicko Cadell + + + + Write the ThreadName to the output + + that will receive the formatted result. + the event being logged + + + Writes the to the . + + + + + + Pattern converter for the class name + + + + Outputs the of the event. + + + Nicko Cadell + + + + Gets the fully qualified name of the class + + the event being logged + The fully qualified type name for the caller location + + + Returns the of the . + + + + + + Converter to include event user name + + Douglas de la Torre + Nicko Cadell + + + + Convert the pattern to the rendered message + + that will receive the formatted result. + the event being logged + + + + Write the TimeStamp to the output + + + + Date pattern converter, uses a to format + the date of a . + + + Uses a to format the + in Universal time. + + + See the for details on the date pattern syntax. + + + + Nicko Cadell + + + + Write the TimeStamp to the output + + that will receive the formatted result. + the event being logged + + + Pass the to the + for it to render it to the writer. + + + The passed is in the local time zone, this is converted + to Universal time before it is rendered. + + + + + + + The fully qualified type of the UtcDatePatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + + + + A flexible layout configurable with pattern string that re-evaluates on each call. + + + This class is built on and provides all the + features and capabilities of PatternLayout. PatternLayout is a 'static' class + in that its layout is done once at configuration time. This class will recreate + the layout on each reference. + One important difference between PatternLayout and DynamicPatternLayout is the + treatment of the Header and Footer parameters in the configuration. The Header and Footer + parameters for DynamicPatternLayout must be syntactically in the form of a PatternString, + but should not be marked as type log4net.Util.PatternString. Doing so causes the + pattern to be statically converted at configuration time and causes DynamicPatternLayout + to perform the same as PatternLayout. + Please see for complete documentation. + + <layout type="log4net.Layout.DynamicPatternLayout"> + <param name="Header" value="%newline**** Trace Opened Local: %date{yyyy-MM-dd HH:mm:ss.fff} UTC: %utcdate{yyyy-MM-dd HH:mm:ss.fff} ****%newline" /> + <param name="Footer" value="**** Trace Closed %date{yyyy-MM-dd HH:mm:ss.fff} ****%newline" /> + </layout> + + + + + + A flexible layout configurable with pattern string. + + + + The goal of this class is to a + as a string. The results + depend on the conversion pattern. + + + The conversion pattern is closely related to the conversion + pattern of the printf function in C. A conversion pattern is + composed of literal text and format control expressions called + conversion specifiers. + + + You are free to insert any literal text within the conversion + pattern. + + + Each conversion specifier starts with a percent sign (%) and is + followed by optional format modifiers and a conversion + pattern name. The conversion pattern name specifies the type of + data, e.g. logger, level, date, thread name. The format + modifiers control such things as field width, padding, left and + right justification. The following is a simple example. + + + Let the conversion pattern be "%-5level [%thread]: %message%newline" and assume + that the log4net environment was set to use a PatternLayout. Then the + statements + + + ILog log = LogManager.GetLogger(typeof(TestApp)); + log.Debug("Message 1"); + log.Warn("Message 2"); + + would yield the output + + DEBUG [main]: Message 1 + WARN [main]: Message 2 + + + Note that there is no explicit separator between text and + conversion specifiers. The pattern parser knows when it has reached + the end of a conversion specifier when it reads a conversion + character. In the example above the conversion specifier + %-5level means the level of the logging event should be left + justified to a width of five characters. + + + The recognized conversion pattern names are: + + + + Conversion Pattern Name + Effect + + + a + Equivalent to appdomain + + + appdomain + + Used to output the friendly name of the AppDomain where the + logging event was generated. + + + + aspnet-cache + + + Used to output all cache items in the case of %aspnet-cache or just one named item if used as %aspnet-cache{key} + + + This pattern is not available for Compact Framework or Client Profile assemblies. + + + + + aspnet-context + + + Used to output all context items in the case of %aspnet-context or just one named item if used as %aspnet-context{key} + + + This pattern is not available for Compact Framework or Client Profile assemblies. + + + + + aspnet-request + + + Used to output all request parameters in the case of %aspnet-request or just one named param if used as %aspnet-request{key} + + + This pattern is not available for Compact Framework or Client Profile assemblies. + + + + + aspnet-session + + + Used to output all session items in the case of %aspnet-session or just one named item if used as %aspnet-session{key} + + + This pattern is not available for Compact Framework or Client Profile assemblies. + + + + + c + Equivalent to logger + + + C + Equivalent to type + + + class + Equivalent to type + + + d + Equivalent to date + + + date + + + Used to output the date of the logging event in the local time zone. + To output the date in universal time use the %utcdate pattern. + The date conversion + specifier may be followed by a date format specifier enclosed + between braces. For example, %date{HH:mm:ss,fff} or + %date{dd MMM yyyy HH:mm:ss,fff}. If no date format specifier is + given then ISO8601 format is + assumed (). + + + The date format specifier admits the same syntax as the + time pattern string of the . + + + For better results it is recommended to use the log4net date + formatters. These can be specified using one of the strings + "ABSOLUTE", "DATE" and "ISO8601" for specifying + , + and respectively + . For example, + %date{ISO8601} or %date{ABSOLUTE}. + + + These dedicated date formatters perform significantly + better than . + + + + + exception + + + Used to output the exception passed in with the log message. + + + If an exception object is stored in the logging event + it will be rendered into the pattern output with a + trailing newline. + If there is no exception then nothing will be output + and no trailing newline will be appended. + It is typical to put a newline before the exception + and to have the exception as the last data in the pattern. + + + + + F + Equivalent to file + + + file + + + Used to output the file name where the logging request was + issued. + + + WARNING Generating caller location information is + extremely slow. Its use should be avoided unless execution speed + is not an issue. + + + See the note below on the availability of caller location information. + + + + + identity + + + Used to output the user name for the currently active user + (Principal.Identity.Name). + + + WARNING Generating caller information is + extremely slow. Its use should be avoided unless execution speed + is not an issue. + + + + + l + Equivalent to location + + + L + Equivalent to line + + + location + + + Used to output location information of the caller which generated + the logging event. + + + The location information depends on the CLI implementation but + usually consists of the fully qualified name of the calling + method followed by the callers source the file name and line + number between parentheses. + + + The location information can be very useful. However, its + generation is extremely slow. Its use should be avoided + unless execution speed is not an issue. + + + See the note below on the availability of caller location information. + + + + + level + + + Used to output the level of the logging event. + + + + + line + + + Used to output the line number from where the logging request + was issued. + + + WARNING Generating caller location information is + extremely slow. Its use should be avoided unless execution speed + is not an issue. + + + See the note below on the availability of caller location information. + + + + + logger + + + Used to output the logger of the logging event. The + logger conversion specifier can be optionally followed by + precision specifier, that is a decimal constant in + brackets. + + + If a precision specifier is given, then only the corresponding + number of right most components of the logger name will be + printed. By default the logger name is printed in full. + + + For example, for the logger name "a.b.c" the pattern + %logger{2} will output "b.c". + + + + + m + Equivalent to message + + + M + Equivalent to method + + + message + + + Used to output the application supplied message associated with + the logging event. + + + + + mdc + + + The MDC (old name for the ThreadContext.Properties) is now part of the + combined event properties. This pattern is supported for compatibility + but is equivalent to property. + + + + + method + + + Used to output the method name where the logging request was + issued. + + + WARNING Generating caller location information is + extremely slow. Its use should be avoided unless execution speed + is not an issue. + + + See the note below on the availability of caller location information. + + + + + n + Equivalent to newline + + + newline + + + Outputs the platform dependent line separator character or + characters. + + + This conversion pattern offers the same performance as using + non-portable line separator strings such as "\n", or "\r\n". + Thus, it is the preferred way of specifying a line separator. + + + + + ndc + + + Used to output the NDC (nested diagnostic context) associated + with the thread that generated the logging event. + + + + + p + Equivalent to level + + + P + Equivalent to property + + + properties + Equivalent to property + + + property + + + Used to output the an event specific property. The key to + lookup must be specified within braces and directly following the + pattern specifier, e.g. %property{user} would include the value + from the property that is keyed by the string 'user'. Each property value + that is to be included in the log must be specified separately. + Properties are added to events by loggers or appenders. By default + the log4net:HostName property is set to the name of machine on + which the event was originally logged. + + + If no key is specified, e.g. %property then all the keys and their + values are printed in a comma separated list. + + + The properties of an event are combined from a number of different + contexts. These are listed below in the order in which they are searched. + + + + the event properties + + The event has that can be set. These + properties are specific to this event only. + + + + the thread properties + + The that are set on the current + thread. These properties are shared by all events logged on this thread. + + + + the global properties + + The that are set globally. These + properties are shared by all the threads in the AppDomain. + + + + + + + + r + Equivalent to timestamp + + + stacktrace + + + Used to output the stack trace of the logging event + The stack trace level specifier may be enclosed + between braces. For example, %stacktrace{level}. + If no stack trace level specifier is given then 1 is assumed + + + Output uses the format: + type3.MethodCall3 > type2.MethodCall2 > type1.MethodCall1 + + + This pattern is not available for Compact Framework assemblies. + + + + + stacktracedetail + + + Used to output the stack trace of the logging event + The stack trace level specifier may be enclosed + between braces. For example, %stacktracedetail{level}. + If no stack trace level specifier is given then 1 is assumed + + + Output uses the format: + type3.MethodCall3(type param,...) > type2.MethodCall2(type param,...) > type1.MethodCall1(type param,...) + + + This pattern is not available for Compact Framework assemblies. + + + + + t + Equivalent to thread + + + timestamp + + + Used to output the number of milliseconds elapsed since the start + of the application until the creation of the logging event. + + + + + thread + + + Used to output the name of the thread that generated the + logging event. Uses the thread number if no name is available. + + + + + type + + + Used to output the fully qualified type name of the caller + issuing the logging request. This conversion specifier + can be optionally followed by precision specifier, that + is a decimal constant in brackets. + + + If a precision specifier is given, then only the corresponding + number of right most components of the class name will be + printed. By default the class name is output in fully qualified form. + + + For example, for the class name "log4net.Layout.PatternLayout", the + pattern %type{1} will output "PatternLayout". + + + WARNING Generating the caller class information is + slow. Thus, its use should be avoided unless execution speed is + not an issue. + + + See the note below on the availability of caller location information. + + + + + u + Equivalent to identity + + + username + + + Used to output the WindowsIdentity for the currently + active user. + + + WARNING Generating caller WindowsIdentity information is + extremely slow. Its use should be avoided unless execution speed + is not an issue. + + + + + utcdate + + + Used to output the date of the logging event in universal time. + The date conversion + specifier may be followed by a date format specifier enclosed + between braces. For example, %utcdate{HH:mm:ss,fff} or + %utcdate{dd MMM yyyy HH:mm:ss,fff}. If no date format specifier is + given then ISO8601 format is + assumed (). + + + The date format specifier admits the same syntax as the + time pattern string of the . + + + For better results it is recommended to use the log4net date + formatters. These can be specified using one of the strings + "ABSOLUTE", "DATE" and "ISO8601" for specifying + , + and respectively + . For example, + %utcdate{ISO8601} or %utcdate{ABSOLUTE}. + + + These dedicated date formatters perform significantly + better than . + + + + + w + Equivalent to username + + + x + Equivalent to ndc + + + X + Equivalent to mdc + + + % + + + The sequence %% outputs a single percent sign. + + + + + + The single letter patterns are deprecated in favor of the + longer more descriptive pattern names. + + + By default the relevant information is output as is. However, + with the aid of format modifiers it is possible to change the + minimum field width, the maximum field width and justification. + + + The optional format modifier is placed between the percent sign + and the conversion pattern name. + + + The first optional format modifier is the left justification + flag which is just the minus (-) character. Then comes the + optional minimum field width modifier. This is a decimal + constant that represents the minimum number of characters to + output. If the data item requires fewer characters, it is padded on + either the left or the right until the minimum width is + reached. The default is to pad on the left (right justify) but you + can specify right padding with the left justification flag. The + padding character is space. If the data item is larger than the + minimum field width, the field is expanded to accommodate the + data. The value is never truncated. + + + This behavior can be changed using the maximum field + width modifier which is designated by a period followed by a + decimal constant. If the data item is longer than the maximum + field, then the extra characters are removed from the + beginning of the data item and not from the end. For + example, it the maximum field width is eight and the data item is + ten characters long, then the first two characters of the data item + are dropped. This behavior deviates from the printf function in C + where truncation is done from the end. + + + Below are various format modifier examples for the logger + conversion specifier. + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Format modifierleft justifyminimum widthmaximum widthcomment
%20loggerfalse20none + + Left pad with spaces if the logger name is less than 20 + characters long. + +
%-20loggertrue20none + + Right pad with spaces if the logger + name is less than 20 characters long. + +
%.30loggerNAnone30 + + Truncate from the beginning if the logger + name is longer than 30 characters. + +
%20.30loggerfalse2030 + + Left pad with spaces if the logger name is shorter than 20 + characters. However, if logger name is longer than 30 characters, + then truncate from the beginning. + +
%-20.30loggertrue2030 + + Right pad with spaces if the logger name is shorter than 20 + characters. However, if logger name is longer than 30 characters, + then truncate from the beginning. + +
+
+ + Note about caller location information.
+ The following patterns %type %file %line %method %location %class %C %F %L %l %M + all generate caller location information. + Location information uses the System.Diagnostics.StackTrace class to generate + a call stack. The caller's information is then extracted from this stack. +
+ + + The System.Diagnostics.StackTrace class is not supported on the + .NET Compact Framework 1.0 therefore caller location information is not + available on that framework. + + + + + The System.Diagnostics.StackTrace class has this to say about Release builds: + + + "StackTrace information will be most informative with Debug build configurations. + By default, Debug builds include debug symbols, while Release builds do not. The + debug symbols contain most of the file, method name, line number, and column + information used in constructing StackFrame and StackTrace objects. StackTrace + might not report as many method calls as expected, due to code transformations + that occur during optimization." + + + This means that in a Release build the caller information may be incomplete or may + not exist at all! Therefore caller location information cannot be relied upon in a Release build. + + + + Additional pattern converters may be registered with a specific + instance using the method. + +
+ + This is a more detailed pattern. + %timestamp [%thread] %level %logger %ndc - %message%newline + + + A similar pattern except that the relative time is + right padded if less than 6 digits, thread name is right padded if + less than 15 characters and truncated if longer and the logger + name is left padded if shorter than 30 characters and truncated if + longer. + %-6timestamp [%15.15thread] %-5level %30.30logger %ndc - %message%newline + + Nicko Cadell + Gert Driesen + Douglas de la Torre + Daniel Cazzulino +
+ + + Extend this abstract class to create your own log layout format. + + + + This is the base implementation of the + interface. Most layout objects should extend this class. + + + + + + Subclasses must implement the + method. + + + Subclasses should set the in their default + constructor. + + + + Nicko Cadell + Gert Driesen + + + + Interface implemented by layout objects + + + + An object is used to format a + as text. The method is called by an + appender to transform the into a string. + + + The layout can also supply and + text that is appender before any events and after all the events respectively. + + + Nicko Cadell + Gert Driesen + + + + Implement this method to create your own layout format. + + The TextWriter to write the formatted event to + The event to format + + + This method is called by an appender to format + the as text and output to a writer. + + + If the caller does not have a and prefers the + event to be formatted as a then the following + code can be used to format the event into a . + + + StringWriter writer = new StringWriter(); + Layout.Format(writer, loggingEvent); + string formattedEvent = writer.ToString(); + + + + + + The content type output by this layout. + + The content type + + + The content type output by this layout. + + + This is a MIME type e.g. "text/plain". + + + + + + The header for the layout format. + + the layout header + + + The Header text will be appended before any logging events + are formatted and appended. + + + + + + The footer for the layout format. + + the layout footer + + + The Footer text will be appended after all the logging events + have been formatted and appended. + + + + + + Flag indicating if this layout handle exceptions + + false if this layout handles exceptions + + + If this layout handles the exception object contained within + , then the layout should return + false. Otherwise, if the layout ignores the exception + object, then the layout should return true. + + + + + + The header text + + + + See for more information. + + + + + + The footer text + + + + See for more information. + + + + + + Flag indicating if this layout handles exceptions + + + + false if this layout handles exceptions + + + + + + Empty default constructor + + + + Empty default constructor + + + + + + Activate component options + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + This method must be implemented by the subclass. + + + + + + Implement this method to create your own layout format. + + The TextWriter to write the formatted event to + The event to format + + + This method is called by an appender to format + the as text. + + + + + + Convenience method for easily formatting the logging event into a string variable. + + + + Creates a new StringWriter instance to store the formatted logging event. + + + + + The content type output by this layout. + + The content type is "text/plain" + + + The content type output by this layout. + + + This base class uses the value "text/plain". + To change this value a subclass must override this + property. + + + + + + The header for the layout format. + + the layout header + + + The Header text will be appended before any logging events + are formatted and appended. + + + + + + The footer for the layout format. + + the layout footer + + + The Footer text will be appended after all the logging events + have been formatted and appended. + + + + + + Flag indicating if this layout handles exceptions + + false if this layout handles exceptions + + + If this layout handles the exception object contained within + , then the layout should return + false. Otherwise, if the layout ignores the exception + object, then the layout should return true. + + + Set this value to override a this default setting. The default + value is true, this layout does not handle the exception. + + + + + + Default pattern string for log output. + + + + Default pattern string for log output. + Currently set to the string "%message%newline" + which just prints the application supplied message. + + + + + + A detailed conversion pattern + + + + A conversion pattern which includes Time, Thread, Logger, and Nested Context. + Current value is %timestamp [%thread] %level %logger %ndc - %message%newline. + + + + + + Internal map of converter identifiers to converter types. + + + + This static map is overridden by the m_converterRegistry instance map + + + + + + the pattern + + + + + the head of the pattern converter chain + + + + + patterns defined on this PatternLayout only + + + + + Initialize the global registry + + + + Defines the builtin global rules. + + + + + + Constructs a PatternLayout using the DefaultConversionPattern + + + + The default pattern just produces the application supplied message. + + + Note to Inheritors: This constructor calls the virtual method + . If you override this method be + aware that it will be called before your is called constructor. + + + As per the contract the + method must be called after the properties on this object have been + configured. + + + + + + Constructs a PatternLayout using the supplied conversion pattern + + the pattern to use + + + Note to Inheritors: This constructor calls the virtual method + . If you override this method be + aware that it will be called before your is called constructor. + + + When using this constructor the method + need not be called. This may not be the case when using a subclass. + + + + + + Create the pattern parser instance + + the pattern to parse + The that will format the event + + + Creates the used to parse the conversion string. Sets the + global and instance rules on the . + + + + + + Initialize layout options + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + + + + Produces a formatted string as specified by the conversion pattern. + + the event being logged + The TextWriter to write the formatted event to + + + Parse the using the patter format + specified in the property. + + + + + + Add a converter to this PatternLayout + + the converter info + + + This version of the method is used by the configurator. + Programmatic users should use the alternative method. + + + + + + Add a converter to this PatternLayout + + the name of the conversion pattern for this converter + the type of the converter + + + Add a named pattern converter to this instance. This + converter will be used in the formatting of the event. + This method must be called before . + + + The specified must extend the + type. + + + + + + The pattern formatting string + + + + The ConversionPattern option. This is the string which + controls formatting and consists of a mix of literal content and + conversion specifiers. + + + + + + The header PatternString + + + + + The footer PatternString + + + + + Constructs a DynamicPatternLayout using the DefaultConversionPattern + + + + The default pattern just produces the application supplied message. + + + + + + Constructs a DynamicPatternLayout using the supplied conversion pattern + + the pattern to use + + + + + + The header for the layout format. + + the layout header + + + The Header text will be appended before any logging events + are formatted and appended. + + The pattern will be formatted on each get operation. + + + + + The footer for the layout format. + + the layout footer + + + The Footer text will be appended after all the logging events + have been formatted and appended. + + The pattern will be formatted on each get operation. + + + + + A Layout that renders only the Exception text from the logging event + + + + A Layout that renders only the Exception text from the logging event. + + + This Layout should only be used with appenders that utilize multiple + layouts (e.g. ). + + + Nicko Cadell + Gert Driesen + + + + Default constructor + + + + Constructs a ExceptionLayout + + + + + + Activate component options + + + + Part of the component activation + framework. + + + This method does nothing as options become effective immediately. + + + + + + Gets the exception text from the logging event + + The TextWriter to write the formatted event to + the event being logged + + + Write the exception string to the . + The exception string is retrieved from . + + + + + + Interface for raw layout objects + + + + Interface used to format a + to an object. + + + This interface should not be confused with the + interface. This interface is used in + only certain specialized situations where a raw object is + required rather than a formatted string. The + is not generally useful than this interface. + + + Nicko Cadell + Gert Driesen + + + + Implement this method to create your own layout format. + + The event to format + returns the formatted event + + + Implement this method to create your own layout format. + + + + + + Adapts any to a + + + + Where an is required this adapter + allows a to be specified. + + + Nicko Cadell + Gert Driesen + + + + The layout to adapt + + + + + Construct a new adapter + + the layout to adapt + + + Create the adapter for the specified . + + + + + + Format the logging event as an object. + + The event to format + returns the formatted event + + + Format the logging event as an object. + + + Uses the object supplied to + the constructor to perform the formatting. + + + + + + Type converter for the interface + + + + Used to convert objects to the interface. + Supports converting from the interface to + the interface using the . + + + Nicko Cadell + Gert Driesen + + + + Interface supported by type converters + + + + This interface supports conversion from arbitrary types + to a single target type. See . + + + Nicko Cadell + Gert Driesen + + + + Can the source type be converted to the type supported by this object + + the type to convert + true if the conversion is possible + + + Test if the can be converted to the + type supported by this converter. + + + + + + Convert the source object to the type supported by this object + + the object to convert + the converted object + + + Converts the to the type supported + by this converter. + + + + + + Can the sourceType be converted to an + + the source to be to be converted + true if the source type can be converted to + + + Test if the can be converted to a + . Only is supported + as the . + + + + + + Convert the value to a object + + the value to convert + the object + + + Convert the object to a + object. If the object + is a then the + is used to adapt between the two interfaces, otherwise an + exception is thrown. + + + + + + Extract the value of a property from the + + + + Extract the value of a property from the + + + Nicko Cadell + + + + Constructs a RawPropertyLayout + + + + + Lookup the property for + + The event to format + returns property value + + + Looks up and returns the object value of the property + named . If there is no property defined + with than name then null will be returned. + + + + + + The name of the value to lookup in the LoggingEvent Properties collection. + + + Value to lookup in the LoggingEvent Properties collection + + + + String name of the property to lookup in the . + + + + + + Extract the date from the + + + + Extract the date from the + + + Nicko Cadell + Gert Driesen + + + + Constructs a RawTimeStampLayout + + + + + Gets the as a . + + The event to format + returns the time stamp + + + Gets the as a . + + + The time stamp is in local time. To format the time stamp + in universal time use . + + + + + + Extract the date from the + + + + Extract the date from the + + + Nicko Cadell + Gert Driesen + + + + Constructs a RawUtcTimeStampLayout + + + + + Gets the as a . + + The event to format + returns the time stamp + + + Gets the as a . + + + The time stamp is in universal time. To format the time stamp + in local time use . + + + + + + A very simple layout + + + + SimpleLayout consists of the level of the log statement, + followed by " - " and then the log message itself. For example, + + DEBUG - Hello world + + + + Nicko Cadell + Gert Driesen + + + + Constructs a SimpleLayout + + + + + Initialize layout options + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + + + + Produces a simple formatted output. + + the event being logged + The TextWriter to write the formatted event to + + + Formats the event as the level of the even, + followed by " - " and then the log message itself. The + output is terminated by a newline. + + + + + + Layout that formats the log events as XML elements. + + + + The output of the consists of a series of + log4net:event elements. It does not output a complete well-formed XML + file. The output is designed to be included as an external entity + in a separate file to form a correct XML file. + + + For example, if abc is the name of the file where + the output goes, then a well-formed XML file would + be: + + + <?xml version="1.0" ?> + + <!DOCTYPE log4net:events SYSTEM "log4net-events.dtd" [<!ENTITY data SYSTEM "abc">]> + + <log4net:events version="1.2" xmlns:log4net="http://logging.apache.org/log4net/schemas/log4net-events-1.2> + &data; + </log4net:events> + + + This approach enforces the independence of the + and the appender where it is embedded. + + + The version attribute helps components to correctly + interpret output generated by . The value of + this attribute should be "1.2" for release 1.2 and later. + + + Alternatively the Header and Footer properties can be + configured to output the correct XML header, open tag and close tag. + When setting the Header and Footer properties it is essential + that the underlying data store not be appendable otherwise the data + will become invalid XML. + + + Nicko Cadell + Gert Driesen + + + + Layout that formats the log events as XML elements. + + + + This is an abstract class that must be subclassed by an implementation + to conform to a specific schema. + + + Deriving classes must implement the method. + + + Nicko Cadell + Gert Driesen + + + + Protected constructor to support subclasses + + + + Initializes a new instance of the class + with no location info. + + + + + + Protected constructor to support subclasses + + + + The parameter determines whether + location information will be output by the layout. If + is set to true, then the + file name and line number of the statement at the origin of the log + statement will be output. + + + If you are embedding this layout within an SMTPAppender + then make sure to set the LocationInfo option of that + appender as well. + + + + + + Initialize layout options + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + + + + Produces a formatted string. + + The event being logged. + The TextWriter to write the formatted event to + + + Format the and write it to the . + + + This method creates an that writes to the + . The is passed + to the method. Subclasses should override the + method rather than this method. + + + + + + Does the actual writing of the XML. + + The writer to use to output the event to. + The event to write. + + + Subclasses should override this method to format + the as XML. + + + + + + Flag to indicate if location information should be included in + the XML events. + + + + + The string to replace invalid chars with + + + + + Gets a value indicating whether to include location information in + the XML events. + + + true if location information should be included in the XML + events; otherwise, false. + + + + If is set to true, then the file + name and line number of the statement at the origin of the log + statement will be output. + + + If you are embedding this layout within an SMTPAppender + then make sure to set the LocationInfo option of that + appender as well. + + + + + + The string to replace characters that can not be expressed in XML with. + + + Not all characters may be expressed in XML. This property contains the + string to replace those that can not with. This defaults to a ?. Set it + to the empty string to simply remove offending characters. For more + details on the allowed character ranges see http://www.w3.org/TR/REC-xml/#charsets + Character replacement will occur in the log message, the property names + and the property values. + + + + + + + Gets the content type output by this layout. + + + As this is the XML layout, the value is always "text/xml". + + + + As this is the XML layout, the value is always "text/xml". + + + + + + Constructs an XmlLayout + + + + + Constructs an XmlLayout. + + + + The LocationInfo option takes a boolean value. By + default, it is set to false which means there will be no location + information output by this layout. If the the option is set to + true, then the file name and line number of the statement + at the origin of the log statement will be output. + + + If you are embedding this layout within an SmtpAppender + then make sure to set the LocationInfo option of that + appender as well. + + + + + + Initialize layout options + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + Builds a cache of the element names + + + + + + Does the actual writing of the XML. + + The writer to use to output the event to. + The event to write. + + + Override the base class method + to write the to the . + + + + + + The prefix to use for all generated element names + + + + + The prefix to use for all element names + + + + The default prefix is log4net. Set this property + to change the prefix. If the prefix is set to an empty string + then no prefix will be written. + + + + + + Set whether or not to base64 encode the message. + + + + By default the log message will be written as text to the xml + output. This can cause problems when the message contains binary + data. By setting this to true the contents of the message will be + base64 encoded. If this is set then invalid character replacement + (see ) will not be performed + on the log message. + + + + + + Set whether or not to base64 encode the property values. + + + + By default the properties will be written as text to the xml + output. This can cause problems when one or more properties contain + binary data. By setting this to true the values of the properties + will be base64 encoded. If this is set then invalid character replacement + (see ) will not be performed + on the property values. + + + + + + Layout that formats the log events as XML elements compatible with the log4j schema + + + + Formats the log events according to the http://logging.apache.org/log4j schema. + + + Nicko Cadell + + + + The 1st of January 1970 in UTC + + + + + Constructs an XMLLayoutSchemaLog4j + + + + + Constructs an XMLLayoutSchemaLog4j. + + + + The LocationInfo option takes a boolean value. By + default, it is set to false which means there will be no location + information output by this layout. If the the option is set to + true, then the file name and line number of the statement + at the origin of the log statement will be output. + + + If you are embedding this layout within an SMTPAppender + then make sure to set the LocationInfo option of that + appender as well. + + + + + + Actually do the writing of the xml + + the writer to use + the event to write + + + Generate XML that is compatible with the log4j schema. + + + + + + The version of the log4j schema to use. + + + + Only version 1.2 of the log4j schema is supported. + + + + + + The default object Renderer. + + + + The default renderer supports rendering objects and collections to strings. + + + See the method for details of the output. + + + Nicko Cadell + Gert Driesen + + + + Implement this interface in order to render objects as strings + + + + Certain types require special case conversion to + string form. This conversion is done by an object renderer. + Object renderers implement the + interface. + + + Nicko Cadell + Gert Driesen + + + + Render the object to a string + + The map used to lookup renderers + The object to render + The writer to render to + + + Render the object to a + string. + + + The parameter is + provided to lookup and render other objects. This is + very useful where contains + nested objects of unknown type. The + method can be used to render these objects. + + + + + + Default constructor + + + + Default constructor + + + + + + Render the object to a string + + The map used to lookup renderers + The object to render + The writer to render to + + + Render the object to a string. + + + The parameter is + provided to lookup and render other objects. This is + very useful where contains + nested objects of unknown type. The + method can be used to render these objects. + + + The default renderer supports rendering objects to strings as follows: + + + + Value + Rendered String + + + null + + "(null)" + + + + + + + For a one dimensional array this is the + array type name, an open brace, followed by a comma + separated list of the elements (using the appropriate + renderer), followed by a close brace. + + + For example: int[] {1, 2, 3}. + + + If the array is not one dimensional the + Array.ToString() is returned. + + + + + , & + + + Rendered as an open brace, followed by a comma + separated list of the elements (using the appropriate + renderer), followed by a close brace. + + + For example: {a, b, c}. + + + All collection classes that implement its subclasses, + or generic equivalents all implement the interface. + + + + + + + + Rendered as the key, an equals sign ('='), and the value (using the appropriate + renderer). + + + For example: key=value. + + + + + other + + Object.ToString() + + + + + + + + Render the array argument into a string + + The map used to lookup renderers + the array to render + The writer to render to + + + For a one dimensional array this is the + array type name, an open brace, followed by a comma + separated list of the elements (using the appropriate + renderer), followed by a close brace. For example: + int[] {1, 2, 3}. + + + If the array is not one dimensional the + Array.ToString() is returned. + + + + + + Render the enumerator argument into a string + + The map used to lookup renderers + the enumerator to render + The writer to render to + + + Rendered as an open brace, followed by a comma + separated list of the elements (using the appropriate + renderer), followed by a close brace. For example: + {a, b, c}. + + + + + + Render the DictionaryEntry argument into a string + + The map used to lookup renderers + the DictionaryEntry to render + The writer to render to + + + Render the key, an equals sign ('='), and the value (using the appropriate + renderer). For example: key=value. + + + + + + Map class objects to an . + + + + Maintains a mapping between types that require special + rendering and the that + is used to render them. + + + The method is used to render an + object using the appropriate renderers defined in this map. + + + Nicko Cadell + Gert Driesen + + + + Default Constructor + + + + Default constructor. + + + + + + Render using the appropriate renderer. + + the object to render to a string + the object rendered as a string + + + This is a convenience method used to render an object to a string. + The alternative method + should be used when streaming output to a . + + + + + + Render using the appropriate renderer. + + the object to render to a string + The writer to render to + + + Find the appropriate renderer for the type of the + parameter. This is accomplished by calling the + method. Once a renderer is found, it is + applied on the object and the result is returned + as a . + + + + + + Gets the renderer for the specified object type + + the object to lookup the renderer for + the renderer for + + + Gets the renderer for the specified object type. + + + Syntactic sugar method that calls + with the type of the object parameter. + + + + + + Gets the renderer for the specified type + + the type to lookup the renderer for + the renderer for the specified type + + + Returns the renderer for the specified type. + If no specific renderer has been defined the + will be returned. + + + + + + Internal function to recursively search interfaces + + the type to lookup the renderer for + the renderer for the specified type + + + + Clear the map of renderers + + + + Clear the custom renderers defined by using + . The + cannot be removed. + + + + + + Register an for . + + the type that will be rendered by + the renderer for + + + Register an object renderer for a specific source type. + This renderer will be returned from a call to + specifying the same as an argument. + + + + + + Get the default renderer instance + + the default renderer + + + Get the default renderer + + + + + + Interface implemented by logger repository plugins. + + + + Plugins define additional behavior that can be associated + with a . + The held by the + property is used to store the plugins for a repository. + + + The log4net.Config.PluginAttribute can be used to + attach plugins to repositories created using configuration + attributes. + + + Nicko Cadell + Gert Driesen + + + + Attaches the plugin to the specified . + + The that this plugin should be attached to. + + + A plugin may only be attached to a single repository. + + + This method is called when the plugin is attached to the repository. + + + + + + Is called when the plugin is to shutdown. + + + + This method is called to notify the plugin that + it should stop operating and should detach from + the repository. + + + + + + Gets the name of the plugin. + + + The name of the plugin. + + + + Plugins are stored in the + keyed by name. Each plugin instance attached to a + repository must be a unique name. + + + + + + A strongly-typed collection of objects. + + Nicko Cadell + + + + Creates a read-only wrapper for a PluginCollection instance. + + list to create a readonly wrapper arround + + A PluginCollection wrapper that is read-only. + + + + + Initializes a new instance of the PluginCollection class + that is empty and has the default initial capacity. + + + + + Initializes a new instance of the PluginCollection class + that has the specified initial capacity. + + + The number of elements that the new PluginCollection is initially capable of storing. + + + + + Initializes a new instance of the PluginCollection class + that contains elements copied from the specified PluginCollection. + + The PluginCollection whose elements are copied to the new collection. + + + + Initializes a new instance of the PluginCollection class + that contains elements copied from the specified array. + + The array whose elements are copied to the new list. + + + + Initializes a new instance of the PluginCollection class + that contains elements copied from the specified collection. + + The collection whose elements are copied to the new list. + + + + Allow subclasses to avoid our default constructors + + + + + + + Copies the entire PluginCollection to a one-dimensional + array. + + The one-dimensional array to copy to. + + + + Copies the entire PluginCollection to a one-dimensional + array, starting at the specified index of the target array. + + The one-dimensional array to copy to. + The zero-based index in at which copying begins. + + + + Adds a to the end of the PluginCollection. + + The to be added to the end of the PluginCollection. + The index at which the value has been added. + + + + Removes all elements from the PluginCollection. + + + + + Creates a shallow copy of the . + + A new with a shallow copy of the collection data. + + + + Determines whether a given is in the PluginCollection. + + The to check for. + true if is found in the PluginCollection; otherwise, false. + + + + Returns the zero-based index of the first occurrence of a + in the PluginCollection. + + The to locate in the PluginCollection. + + The zero-based index of the first occurrence of + in the entire PluginCollection, if found; otherwise, -1. + + + + + Inserts an element into the PluginCollection at the specified index. + + The zero-based index at which should be inserted. + The to insert. + + is less than zero + -or- + is equal to or greater than . + + + + + Removes the first occurrence of a specific from the PluginCollection. + + The to remove from the PluginCollection. + + The specified was not found in the PluginCollection. + + + + + Removes the element at the specified index of the PluginCollection. + + The zero-based index of the element to remove. + + is less than zero. + -or- + is equal to or greater than . + + + + + Returns an enumerator that can iterate through the PluginCollection. + + An for the entire PluginCollection. + + + + Adds the elements of another PluginCollection to the current PluginCollection. + + The PluginCollection whose elements should be added to the end of the current PluginCollection. + The new of the PluginCollection. + + + + Adds the elements of a array to the current PluginCollection. + + The array whose elements should be added to the end of the PluginCollection. + The new of the PluginCollection. + + + + Adds the elements of a collection to the current PluginCollection. + + The collection whose elements should be added to the end of the PluginCollection. + The new of the PluginCollection. + + + + Sets the capacity to the actual number of elements. + + + + + is less than zero. + -or- + is equal to or greater than . + + + + + is less than zero. + -or- + is equal to or greater than . + + + + + Gets the number of elements actually contained in the PluginCollection. + + + + + Gets a value indicating whether access to the collection is synchronized (thread-safe). + + true if access to the ICollection is synchronized (thread-safe); otherwise, false. + + + + Gets an object that can be used to synchronize access to the collection. + + + An object that can be used to synchronize access to the collection. + + + + + Gets or sets the at the specified index. + + + The at the specified index. + + The zero-based index of the element to get or set. + + is less than zero. + -or- + is equal to or greater than . + + + + + Gets a value indicating whether the collection has a fixed size. + + true if the collection has a fixed size; otherwise, false. The default is false. + + + + Gets a value indicating whether the IList is read-only. + + true if the collection is read-only; otherwise, false. The default is false. + + + + Gets or sets the number of elements the PluginCollection can contain. + + + The number of elements the PluginCollection can contain. + + + + + Supports type-safe iteration over a . + + + + + + Advances the enumerator to the next element in the collection. + + + true if the enumerator was successfully advanced to the next element; + false if the enumerator has passed the end of the collection. + + + The collection was modified after the enumerator was created. + + + + + Sets the enumerator to its initial position, before the first element in the collection. + + + + + Gets the current element in the collection. + + + + + Type visible only to our subclasses + Used to access protected constructor + + + + + + A value + + + + + Supports simple iteration over a . + + + + + + Initializes a new instance of the Enumerator class. + + + + + + Advances the enumerator to the next element in the collection. + + + true if the enumerator was successfully advanced to the next element; + false if the enumerator has passed the end of the collection. + + + The collection was modified after the enumerator was created. + + + + + Sets the enumerator to its initial position, before the first element in the collection. + + + + + Gets the current element in the collection. + + + The current element in the collection. + + + + + + + + Map of repository plugins. + + + + This class is a name keyed map of the plugins that are + attached to a repository. + + + Nicko Cadell + Gert Driesen + + + + Constructor + + The repository that the plugins should be attached to. + + + Initialize a new instance of the class with a + repository that the plugins should be attached to. + + + + + + Adds a to the map. + + The to add to the map. + + + The will be attached to the repository when added. + + + If there already exists a plugin with the same name + attached to the repository then the old plugin will + be and replaced with + the new plugin. + + + + + + Removes a from the map. + + The to remove from the map. + + + Remove a specific plugin from this map. + + + + + + Gets a by name. + + The name of the to lookup. + + The from the map with the name specified, or + null if no plugin is found. + + + + Lookup a plugin by name. If the plugin is not found null + will be returned. + + + + + + Gets all possible plugins as a list of objects. + + All possible plugins as a list of objects. + + + Get a collection of all the plugins defined in this map. + + + + + + Base implementation of + + + + Default abstract implementation of the + interface. This base class can be used by implementors + of the interface. + + + Nicko Cadell + Gert Driesen + + + + Constructor + + the name of the plugin + + Initializes a new Plugin with the specified name. + + + + + Attaches this plugin to a . + + The that this plugin should be attached to. + + + A plugin may only be attached to a single repository. + + + This method is called when the plugin is attached to the repository. + + + + + + Is called when the plugin is to shutdown. + + + + This method is called to notify the plugin that + it should stop operating and should detach from + the repository. + + + + + + The name of this plugin. + + + + + The repository this plugin is attached to. + + + + + Gets or sets the name of the plugin. + + + The name of the plugin. + + + + Plugins are stored in the + keyed by name. Each plugin instance attached to a + repository must be a unique name. + + + The name of the plugin must not change one the + plugin has been attached to a repository. + + + + + + The repository for this plugin + + + The that this plugin is attached to. + + + + Gets or sets the that this plugin is + attached to. + + + + + + Plugin that listens for events from the + + + + This plugin publishes an instance of + on a specified . This listens for logging events delivered from + a remote . + + + When an event is received it is relogged within the attached repository + as if it had been raised locally. + + + Nicko Cadell + Gert Driesen + + + + Default constructor + + + + Initializes a new instance of the class. + + + The property must be set. + + + + + + Construct with sink Uri. + + The name to publish the sink under in the remoting infrastructure. + See for more details. + + + Initializes a new instance of the class + with specified name. + + + + + + Attaches this plugin to a . + + The that this plugin should be attached to. + + + A plugin may only be attached to a single repository. + + + This method is called when the plugin is attached to the repository. + + + + + + Is called when the plugin is to shutdown. + + + + When the plugin is shutdown the remote logging + sink is disconnected. + + + + + + The fully qualified type of the RemoteLoggingServerPlugin class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Gets or sets the URI of this sink. + + + The URI of this sink. + + + + This is the name under which the object is marshaled. + + + + + + + Delivers objects to a remote sink. + + + + Internal class used to listen for logging events + and deliver them to the local repository. + + + + + + Constructor + + The repository to log to. + + + Initializes a new instance of the for the + specified . + + + + + + Logs the events to the repository. + + The events to log. + + + The events passed are logged to the + + + + + + Obtains a lifetime service object to control the lifetime + policy for this instance. + + null to indicate that this instance should live forever. + + + Obtains a lifetime service object to control the lifetime + policy for this instance. This object should live forever + therefore this implementation returns null. + + + + + + The underlying that events should + be logged to. + + + + + Default implementation of + + + + This default implementation of the + interface is used to create the default subclass + of the object. + + + Nicko Cadell + Gert Driesen + + + + Interface abstracts creation of instances + + + + This interface is used by the to + create new objects. + + + The method is called + to create a named . + + + Implement this interface to create new subclasses of . + + + Nicko Cadell + Gert Driesen + + + + Create a new instance + + The that will own the . + The name of the . + The instance for the specified name. + + + Create a new instance with the + specified name. + + + Called by the to create + new named instances. + + + If the is null then the root logger + must be returned. + + + + + + Default constructor + + + + Initializes a new instance of the class. + + + + + + Create a new instance + + The that will own the . + The name of the . + The instance for the specified name. + + + Create a new instance with the + specified name. + + + Called by the to create + new named instances. + + + If the is null then the root logger + must be returned. + + + + + + Default internal subclass of + + + + This subclass has no additional behavior over the + class but does allow instances + to be created. + + + + + + Implementation of used by + + + + Internal class used to provide implementation of + interface. Applications should use to get + logger instances. + + + This is one of the central classes in the log4net implementation. One of the + distinctive features of log4net are hierarchical loggers and their + evaluation. The organizes the + instances into a rooted tree hierarchy. + + + The class is abstract. Only concrete subclasses of + can be created. The + is used to create instances of this type for the . + + + Nicko Cadell + Gert Driesen + Aspi Havewala + Douglas de la Torre + + + + This constructor created a new instance and + sets its name. + + The name of the . + + + This constructor is protected and designed to be used by + a subclass that is not abstract. + + + Loggers are constructed by + objects. See for the default + logger creator. + + + + + + Add to the list of appenders of this + Logger instance. + + An appender to add to this logger + + + Add to the list of appenders of this + Logger instance. + + + If is already in the list of + appenders, then it won't be added again. + + + + + + Look for the appender named as name + + The name of the appender to lookup + The appender with the name specified, or null. + + + Returns the named appender, or null if the appender is not found. + + + + + + Remove all previously added appenders from this Logger instance. + + + + Remove all previously added appenders from this Logger instance. + + + This is useful when re-reading configuration information. + + + + + + Remove the appender passed as parameter form the list of appenders. + + The appender to remove + The appender removed from the list + + + Remove the appender passed as parameter form the list of appenders. + The appender removed is not closed. + If you are discarding the appender you must call + on the appender removed. + + + + + + Remove the appender passed as parameter form the list of appenders. + + The name of the appender to remove + The appender removed from the list + + + Remove the named appender passed as parameter form the list of appenders. + The appender removed is not closed. + If you are discarding the appender you must call + on the appender removed. + + + + + + This generic form is intended to be used by wrappers. + + The declaring type of the method that is + the stack boundary into the logging system for this call. + The level of the message to be logged. + The message object to log. + The exception to log, including its stack trace. + + + Generate a logging event for the specified using + the and . + + + This method must not throw any exception to the caller. + + + + + + This is the most generic printing method that is intended to be used + by wrappers. + + The event being logged. + + + Logs the specified logging event through this logger. + + + This method must not throw any exception to the caller. + + + + + + Checks if this logger is enabled for a given passed as parameter. + + The level to check. + + true if this logger is enabled for level, otherwise false. + + + + Test if this logger is going to log events of the specified . + + + This method must not throw any exception to the caller. + + + + + + Deliver the to the attached appenders. + + The event to log. + + + Call the appenders in the hierarchy starting at + this. If no appenders could be found, emit a + warning. + + + This method calls all the appenders inherited from the + hierarchy circumventing any evaluation of whether to log or not + to log the particular log request. + + + + + + Closes all attached appenders implementing the interface. + + + + Used to ensure that the appenders are correctly shutdown. + + + + + + This is the most generic printing method. This generic form is intended to be used by wrappers + + The level of the message to be logged. + The message object to log. + The exception to log, including its stack trace. + + + Generate a logging event for the specified using + the . + + + + + + Creates a new logging event and logs the event without further checks. + + The declaring type of the method that is + the stack boundary into the logging system for this call. + The level of the message to be logged. + The message object to log. + The exception to log, including its stack trace. + + + Generates a logging event and delivers it to the attached + appenders. + + + + + + Creates a new logging event and logs the event without further checks. + + The event being logged. + + + Delivers the logging event to the attached appenders. + + + + + + The fully qualified type of the Logger class. + + + + + The name of this logger. + + + + + The assigned level of this logger. + + + + The level variable need not be + assigned a value in which case it is inherited + form the hierarchy. + + + + + + The parent of this logger. + + + + The parent of this logger. + All loggers have at least one ancestor which is the root logger. + + + + + + Loggers need to know what Hierarchy they are in. + + + + Loggers need to know what Hierarchy they are in. + The hierarchy that this logger is a member of is stored + here. + + + + + + Helper implementation of the interface + + + + + Flag indicating if child loggers inherit their parents appenders + + + + Additivity is set to true by default, that is children inherit + the appenders of their ancestors by default. If this variable is + set to false then the appenders found in the + ancestors of this logger are not used. However, the children + of this logger will inherit its appenders, unless the children + have their additivity flag set to false too. See + the user manual for more details. + + + + + + Lock to protect AppenderAttachedImpl variable m_appenderAttachedImpl + + + + + Gets or sets the parent logger in the hierarchy. + + + The parent logger in the hierarchy. + + + + Part of the Composite pattern that makes the hierarchy. + The hierarchy is parent linked rather than child linked. + + + + + + Gets or sets a value indicating if child loggers inherit their parent's appenders. + + + true if child loggers inherit their parent's appenders. + + + + Additivity is set to true by default, that is children inherit + the appenders of their ancestors by default. If this variable is + set to false then the appenders found in the + ancestors of this logger are not used. However, the children + of this logger will inherit its appenders, unless the children + have their additivity flag set to false too. See + the user manual for more details. + + + + + + Gets the effective level for this logger. + + The nearest level in the logger hierarchy. + + + Starting from this logger, searches the logger hierarchy for a + non-null level and returns it. Otherwise, returns the level of the + root logger. + + The Logger class is designed so that this method executes as + quickly as possible. + + + + + Gets or sets the where this + Logger instance is attached to. + + The hierarchy that this logger belongs to. + + + This logger must be attached to a single . + + + + + + Gets or sets the assigned , if any, for this Logger. + + + The of this logger. + + + + The assigned can be null. + + + + + + Get the appenders contained in this logger as an + . + + A collection of the appenders in this logger + + + Get the appenders contained in this logger as an + . If no appenders + can be found, then a is returned. + + + + + + Gets the logger name. + + + The name of the logger. + + + + The name of this logger + + + + + + Gets the where this + Logger instance is attached to. + + + The that this logger belongs to. + + + + Gets the where this + Logger instance is attached to. + + + + + + Construct a new Logger + + the name of the logger + + + Initializes a new instance of the class + with the specified name. + + + + + + Delegate used to handle logger creation event notifications. + + The in which the has been created. + The event args that hold the instance that has been created. + + + Delegate used to handle logger creation event notifications. + + + + + + Provides data for the event. + + + + A event is raised every time a + is created. + + + + + + The created + + + + + Constructor + + The that has been created. + + + Initializes a new instance of the event argument + class,with the specified . + + + + + + Gets the that has been created. + + + The that has been created. + + + + The that has been created. + + + + + + Hierarchical organization of loggers + + + + The casual user should not have to deal with this class + directly. + + + This class is specialized in retrieving loggers by name and + also maintaining the logger hierarchy. Implements the + interface. + + + The structure of the logger hierarchy is maintained by the + method. The hierarchy is such that children + link to their parent but parents do not have any references to their + children. Moreover, loggers can be instantiated in any order, in + particular descendant before ancestor. + + + In case a descendant is created before a particular ancestor, + then it creates a provision node for the ancestor and adds itself + to the provision node. Other descendants of the same ancestor add + themselves to the previously created provision node. + + + Nicko Cadell + Gert Driesen + + + + Base implementation of + + + + Default abstract implementation of the interface. + + + Skeleton implementation of the interface. + All types can extend this type. + + + Nicko Cadell + Gert Driesen + + + + Interface implemented by logger repositories. + + + + This interface is implemented by logger repositories. e.g. + . + + + This interface is used by the + to obtain interfaces. + + + Nicko Cadell + Gert Driesen + + + + Check if the named logger exists in the repository. If so return + its reference, otherwise returns null. + + The name of the logger to lookup + The Logger object with the name specified + + + If the names logger exists it is returned, otherwise + null is returned. + + + + + + Returns all the currently defined loggers as an Array. + + All the defined loggers + + + Returns all the currently defined loggers as an Array. + + + + + + Returns a named logger instance + + The name of the logger to retrieve + The logger object with the name specified + + + Returns a named logger instance. + + + If a logger of that name already exists, then it will be + returned. Otherwise, a new logger will be instantiated and + then linked with its existing ancestors as well as children. + + + + + Shutdown the repository + + + Shutting down a repository will safely close and remove + all appenders in all loggers including the root logger. + + + Some appenders need to be closed before the + application exists. Otherwise, pending logging events might be + lost. + + + The method is careful to close nested + appenders before closing regular appenders. This is allows + configurations where a regular appender is attached to a logger + and again to a nested appender. + + + + + + Reset the repositories configuration to a default state + + + + Reset all values contained in this instance to their + default state. + + + Existing loggers are not removed. They are just reset. + + + This method should be used sparingly and with care as it will + block all logging until it is completed. + + + + + + Log the through this repository. + + the event to log + + + This method should not normally be used to log. + The interface should be used + for routine logging. This interface can be obtained + using the method. + + + The logEvent is delivered to the appropriate logger and + that logger is then responsible for logging the event. + + + + + + Returns all the Appenders that are configured as an Array. + + All the Appenders + + + Returns all the Appenders that are configured as an Array. + + + + + + The name of the repository + + + The name of the repository + + + + The name of the repository. + + + + + + RendererMap accesses the object renderer map for this repository. + + + RendererMap accesses the object renderer map for this repository. + + + + RendererMap accesses the object renderer map for this repository. + + + The RendererMap holds a mapping between types and + objects. + + + + + + The plugin map for this repository. + + + The plugin map for this repository. + + + + The plugin map holds the instances + that have been attached to this repository. + + + + + + Get the level map for the Repository. + + + + Get the level map for the Repository. + + + The level map defines the mappings between + level names and objects in + this repository. + + + + + + The threshold for all events in this repository + + + The threshold for all events in this repository + + + + The threshold for all events in this repository. + + + + + + Flag indicates if this repository has been configured. + + + Flag indicates if this repository has been configured. + + + + Flag indicates if this repository has been configured. + + + + + + Collection of internal messages captured during the most + recent configuration process. + + + + + Event to notify that the repository has been shutdown. + + + Event to notify that the repository has been shutdown. + + + + Event raised when the repository has been shutdown. + + + + + + Event to notify that the repository has had its configuration reset. + + + Event to notify that the repository has had its configuration reset. + + + + Event raised when the repository's configuration has been + reset to default. + + + + + + Event to notify that the repository has had its configuration changed. + + + Event to notify that the repository has had its configuration changed. + + + + Event raised when the repository's configuration has been changed. + + + + + + Repository specific properties + + + Repository specific properties + + + + These properties can be specified on a repository specific basis. + + + + + + Default Constructor + + + + Initializes the repository with default (empty) properties. + + + + + + Construct the repository using specific properties + + the properties to set for this repository + + + Initializes the repository with specified properties. + + + + + + Test if logger exists + + The name of the logger to lookup + The Logger object with the name specified + + + Check if the named logger exists in the repository. If so return + its reference, otherwise returns null. + + + + + + Returns all the currently defined loggers in the repository + + All the defined loggers + + + Returns all the currently defined loggers in the repository as an Array. + + + + + + Return a new logger instance + + The name of the logger to retrieve + The logger object with the name specified + + + Return a new logger instance. + + + If a logger of that name already exists, then it will be + returned. Otherwise, a new logger will be instantiated and + then linked with its existing ancestors as well as children. + + + + + + Shutdown the repository + + + + Shutdown the repository. Can be overridden in a subclass. + This base class implementation notifies the + listeners and all attached plugins of the shutdown event. + + + + + + Reset the repositories configuration to a default state + + + + Reset all values contained in this instance to their + default state. + + + Existing loggers are not removed. They are just reset. + + + This method should be used sparingly and with care as it will + block all logging until it is completed. + + + + + + Log the logEvent through this repository. + + the event to log + + + This method should not normally be used to log. + The interface should be used + for routine logging. This interface can be obtained + using the method. + + + The logEvent is delivered to the appropriate logger and + that logger is then responsible for logging the event. + + + + + + Returns all the Appenders that are configured as an Array. + + All the Appenders + + + Returns all the Appenders that are configured as an Array. + + + + + + The fully qualified type of the LoggerRepositorySkeleton class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Adds an object renderer for a specific class. + + The type that will be rendered by the renderer supplied. + The object renderer used to render the object. + + + Adds an object renderer for a specific class. + + + + + + Notify the registered listeners that the repository is shutting down + + Empty EventArgs + + + Notify any listeners that this repository is shutting down. + + + + + + Notify the registered listeners that the repository has had its configuration reset + + Empty EventArgs + + + Notify any listeners that this repository's configuration has been reset. + + + + + + Notify the registered listeners that the repository has had its configuration changed + + Empty EventArgs + + + Notify any listeners that this repository's configuration has changed. + + + + + + Raise a configuration changed event on this repository + + EventArgs.Empty + + + Applications that programmatically change the configuration of the repository should + raise this event notification to notify listeners. + + + + + + The name of the repository + + + The string name of the repository + + + + The name of this repository. The name is + used to store and lookup the repositories + stored by the . + + + + + + The threshold for all events in this repository + + + The threshold for all events in this repository + + + + The threshold for all events in this repository + + + + + + RendererMap accesses the object renderer map for this repository. + + + RendererMap accesses the object renderer map for this repository. + + + + RendererMap accesses the object renderer map for this repository. + + + The RendererMap holds a mapping between types and + objects. + + + + + + The plugin map for this repository. + + + The plugin map for this repository. + + + + The plugin map holds the instances + that have been attached to this repository. + + + + + + Get the level map for the Repository. + + + + Get the level map for the Repository. + + + The level map defines the mappings between + level names and objects in + this repository. + + + + + + Flag indicates if this repository has been configured. + + + Flag indicates if this repository has been configured. + + + + Flag indicates if this repository has been configured. + + + + + + Contains a list of internal messages captures during the + last configuration. + + + + + Event to notify that the repository has been shutdown. + + + Event to notify that the repository has been shutdown. + + + + Event raised when the repository has been shutdown. + + + + + + Event to notify that the repository has had its configuration reset. + + + Event to notify that the repository has had its configuration reset. + + + + Event raised when the repository's configuration has been + reset to default. + + + + + + Event to notify that the repository has had its configuration changed. + + + Event to notify that the repository has had its configuration changed. + + + + Event raised when the repository's configuration has been changed. + + + + + + Repository specific properties + + + Repository specific properties + + + These properties can be specified on a repository specific basis + + + + + Basic Configurator interface for repositories + + + + Interface used by basic configurator to configure a + with a default . + + + A should implement this interface to support + configuration by the . + + + Nicko Cadell + Gert Driesen + + + + Initialize the repository using the specified appender + + the appender to use to log all logging events + + + Configure the repository to route all logging events to the + specified appender. + + + + + + Initialize the repository using the specified appenders + + the appenders to use to log all logging events + + + Configure the repository to route all logging events to the + specified appenders. + + + + + + Configure repository using XML + + + + Interface used by Xml configurator to configure a . + + + A should implement this interface to support + configuration by the . + + + Nicko Cadell + Gert Driesen + + + + Initialize the repository using the specified config + + the element containing the root of the config + + + The schema for the XML configuration data is defined by + the implementation. + + + + + + Default constructor + + + + Initializes a new instance of the class. + + + + + + Construct with properties + + The properties to pass to this repository. + + + Initializes a new instance of the class. + + + + + + Construct with a logger factory + + The factory to use to create new logger instances. + + + Initializes a new instance of the class with + the specified . + + + + + + Construct with properties and a logger factory + + The properties to pass to this repository. + The factory to use to create new logger instances. + + + Initializes a new instance of the class with + the specified . + + + + + + Test if a logger exists + + The name of the logger to lookup + The Logger object with the name specified + + + Check if the named logger exists in the hierarchy. If so return + its reference, otherwise returns null. + + + + + + Returns all the currently defined loggers in the hierarchy as an Array + + All the defined loggers + + + Returns all the currently defined loggers in the hierarchy as an Array. + The root logger is not included in the returned + enumeration. + + + + + + Return a new logger instance named as the first parameter using + the default factory. + + + + Return a new logger instance named as the first parameter using + the default factory. + + + If a logger of that name already exists, then it will be + returned. Otherwise, a new logger will be instantiated and + then linked with its existing ancestors as well as children. + + + The name of the logger to retrieve + The logger object with the name specified + + + + Shutting down a hierarchy will safely close and remove + all appenders in all loggers including the root logger. + + + + Shutting down a hierarchy will safely close and remove + all appenders in all loggers including the root logger. + + + Some appenders need to be closed before the + application exists. Otherwise, pending logging events might be + lost. + + + The Shutdown method is careful to close nested + appenders before closing regular appenders. This is allows + configurations where a regular appender is attached to a logger + and again to a nested appender. + + + + + + Reset all values contained in this hierarchy instance to their default. + + + + Reset all values contained in this hierarchy instance to their + default. This removes all appenders from all loggers, sets + the level of all non-root loggers to null, + sets their additivity flag to true and sets the level + of the root logger to . Moreover, + message disabling is set its default "off" value. + + + Existing loggers are not removed. They are just reset. + + + This method should be used sparingly and with care as it will + block all logging until it is completed. + + + + + + Log the logEvent through this hierarchy. + + the event to log + + + This method should not normally be used to log. + The interface should be used + for routine logging. This interface can be obtained + using the method. + + + The logEvent is delivered to the appropriate logger and + that logger is then responsible for logging the event. + + + + + + Returns all the Appenders that are currently configured + + An array containing all the currently configured appenders + + + Returns all the instances that are currently configured. + All the loggers are searched for appenders. The appenders may also be containers + for appenders and these are also searched for additional loggers. + + + The list returned is unordered but does not contain duplicates. + + + + + + Collect the appenders from an . + The appender may also be a container. + + + + + + + Collect the appenders from an container + + + + + + + Initialize the log4net system using the specified appender + + the appender to use to log all logging events + + + + Initialize the log4net system using the specified appenders + + the appenders to use to log all logging events + + + + Initialize the log4net system using the specified appenders + + the appenders to use to log all logging events + + + This method provides the same functionality as the + method implemented + on this object, but it is protected and therefore can be called by subclasses. + + + + + + Initialize the log4net system using the specified config + + the element containing the root of the config + + + + Initialize the log4net system using the specified config + + the element containing the root of the config + + + This method provides the same functionality as the + method implemented + on this object, but it is protected and therefore can be called by subclasses. + + + + + + Test if this hierarchy is disabled for the specified . + + The level to check against. + + true if the repository is disabled for the level argument, false otherwise. + + + + If this hierarchy has not been configured then this method will + always return true. + + + This method will return true if this repository is + disabled for level object passed as parameter and + false otherwise. + + + See also the property. + + + + + + Clear all logger definitions from the internal hashtable + + + + This call will clear all logger definitions from the internal + hashtable. Invoking this method will irrevocably mess up the + logger hierarchy. + + + You should really know what you are doing before + invoking this method. + + + + + + Return a new logger instance named as the first parameter using + . + + The name of the logger to retrieve + The factory that will make the new logger instance + The logger object with the name specified + + + If a logger of that name already exists, then it will be + returned. Otherwise, a new logger will be instantiated by the + parameter and linked with its existing + ancestors as well as children. + + + + + + Sends a logger creation event to all registered listeners + + The newly created logger + + Raises the logger creation event. + + + + + Updates all the parents of the specified logger + + The logger to update the parents for + + + This method loops through all the potential parents of + . There 3 possible cases: + + + + No entry for the potential parent of exists + + We create a ProvisionNode for this potential + parent and insert in that provision node. + + + + The entry is of type Logger for the potential parent. + + The entry is 's nearest existing parent. We + update 's parent field with this entry. We also break from + he loop because updating our parent's parent is our parent's + responsibility. + + + + The entry is of type ProvisionNode for this potential parent. + + We add to the list of children for this + potential parent. + + + + + + + + Replace a with a in the hierarchy. + + + + + + We update the links for all the children that placed themselves + in the provision node 'pn'. The second argument 'log' is a + reference for the newly created Logger, parent of all the + children in 'pn'. + + + We loop on all the children 'c' in 'pn'. + + + If the child 'c' has been already linked to a child of + 'log' then there is no need to update 'c'. + + + Otherwise, we set log's parent field to c's parent and set + c's parent field to log. + + + + + + Define or redefine a Level using the values in the argument + + the level values + + + Define or redefine a Level using the values in the argument + + + Supports setting levels via the configuration file. + + + + + + Set a Property using the values in the argument + + the property value + + + Set a Property using the values in the argument. + + + Supports setting property values via the configuration file. + + + + + + The fully qualified type of the Hierarchy class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Event used to notify that a logger has been created. + + + + Event raised when a logger is created. + + + + + + Has no appender warning been emitted + + + + Flag to indicate if we have already issued a warning + about not having an appender warning. + + + + + + Get the root of this hierarchy + + + + Get the root of this hierarchy. + + + + + + Gets or sets the default instance. + + The default + + + The logger factory is used to create logger instances. + + + + + + A class to hold the value, name and display name for a level + + + + A class to hold the value, name and display name for a level + + + + + + Override Object.ToString to return sensible debug info + + string info about this object + + + + Value of the level + + + + If the value is not set (defaults to -1) the value will be looked + up for the current level with the same name. + + + + + + Name of the level + + + The name of the level + + + + The name of the level. + + + + + + Display name for the level + + + The display name of the level + + + + The display name of the level. + + + + + + Used internally to accelerate hash table searches. + + + + Internal class used to improve performance of + string keyed hashtables. + + + The hashcode of the string is cached for reuse. + The string is stored as an interned value. + When comparing two objects for equality + the reference equality of the interned strings is compared. + + + Nicko Cadell + Gert Driesen + + + + Construct key with string name + + + + Initializes a new instance of the class + with the specified name. + + + Stores the hashcode of the string and interns + the string key to optimize comparisons. + + + The Compact Framework 1.0 the + method does not work. On the Compact Framework + the string keys are not interned nor are they + compared by reference. + + + The name of the logger. + + + + Returns a hash code for the current instance. + + A hash code for the current instance. + + + Returns the cached hashcode. + + + + + + Determines whether two instances + are equal. + + The to compare with the current . + + true if the specified is equal to the current ; otherwise, false. + + + + Compares the references of the interned strings. + + + + + + Provision nodes are used where no logger instance has been specified + + + + instances are used in the + when there is no specified + for that node. + + + A provision node holds a list of child loggers on behalf of + a logger that does not exist. + + + Nicko Cadell + Gert Driesen + + + + Create a new provision node with child node + + A child logger to add to this node. + + + Initializes a new instance of the class + with the specified child logger. + + + + + + The sits at the root of the logger hierarchy tree. + + + + The is a regular except + that it provides several guarantees. + + + First, it cannot be assigned a null + level. Second, since the root logger cannot have a parent, the + property always returns the value of the + level field without walking the hierarchy. + + + Nicko Cadell + Gert Driesen + + + + Construct a + + The level to assign to the root logger. + + + Initializes a new instance of the class with + the specified logging level. + + + The root logger names itself as "root". However, the root + logger cannot be retrieved by name. + + + + + + The fully qualified type of the RootLogger class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Gets the assigned level value without walking the logger hierarchy. + + The assigned level value without walking the logger hierarchy. + + + Because the root logger cannot have a parent and its level + must not be null this property just returns the + value of . + + + + + + Gets or sets the assigned for the root logger. + + + The of the root logger. + + + + Setting the level of the root logger to a null reference + may have catastrophic results. We prevent this here. + + + + + + Initializes the log4net environment using an XML DOM. + + + + Configures a using an XML DOM. + + + Nicko Cadell + Gert Driesen + + + + Construct the configurator for a hierarchy + + The hierarchy to build. + + + Initializes a new instance of the class + with the specified . + + + + + + Configure the hierarchy by parsing a DOM tree of XML elements. + + The root element to parse. + + + Configure the hierarchy by parsing a DOM tree of XML elements. + + + + + + Parse appenders by IDREF. + + The appender ref element. + The instance of the appender that the ref refers to. + + + Parse an XML element that represents an appender and return + the appender. + + + + + + Parses an appender element. + + The appender element. + The appender instance or null when parsing failed. + + + Parse an XML element that represents an appender and return + the appender instance. + + + + + + Parses a logger element. + + The logger element. + + + Parse an XML element that represents a logger. + + + + + + Parses the root logger element. + + The root element. + + + Parse an XML element that represents the root logger. + + + + + + Parses the children of a logger element. + + The category element. + The logger instance. + Flag to indicate if the logger is the root logger. + + + Parse the child elements of a <logger> element. + + + + + + Parses an object renderer. + + The renderer element. + + + Parse an XML element that represents a renderer. + + + + + + Parses a level element. + + The level element. + The logger object to set the level on. + Flag to indicate if the logger is the root logger. + + + Parse an XML element that represents a level. + + + + + + Sets a parameter on an object. + + The parameter element. + The object to set the parameter on. + + The parameter name must correspond to a writable property + on the object. The value of the parameter is a string, + therefore this function will attempt to set a string + property first. If unable to set a string property it + will inspect the property and its argument type. It will + attempt to call a static method called Parse on the + type of the property. This method will take a single + string argument and return a value that can be used to + set the property. + + + + + Test if an element has no attributes or child elements + + the element to inspect + true if the element has any attributes or child elements, false otherwise + + + + Test if a is constructible with Activator.CreateInstance. + + the type to inspect + true if the type is creatable using a default constructor, false otherwise + + + + Look for a method on the that matches the supplied + + the type that has the method + the name of the method + the method info found + + + The method must be a public instance method on the . + The method must be named or "Add" followed by . + The method must take a single parameter. + + + + + + Converts a string value to a target type. + + The type of object to convert the string to. + The string value to use as the value of the object. + + + An object of type with value or + null when the conversion could not be performed. + + + + + + Creates an object as specified in XML. + + The XML element that contains the definition of the object. + The object type to use if not explicitly specified. + The type that the returned object must be or must inherit from. + The object or null + + + Parse an XML element and create an object instance based on the configuration + data. + + + The type of the instance may be specified in the XML. If not + specified then the is used + as the type. However the type is specified it must support the + type. + + + + + + key: appenderName, value: appender. + + + + + The Hierarchy being configured. + + + + + The fully qualified type of the XmlHierarchyConfigurator class. + + + Used by the internal logger to record the Type of the + log message. + + + + + + + + + + + + + + + + + + + + + Delegate used to handle logger repository shutdown event notifications + + The that is shutting down. + Empty event args + + + Delegate used to handle logger repository shutdown event notifications. + + + + + + Delegate used to handle logger repository configuration reset event notifications + + The that has had its configuration reset. + Empty event args + + + Delegate used to handle logger repository configuration reset event notifications. + + + + + + Delegate used to handle event notifications for logger repository configuration changes. + + The that has had its configuration changed. + Empty event arguments. + + + Delegate used to handle event notifications for logger repository configuration changes. + + + + + + Write the name of the current AppDomain to the output + + + + Write the name of the current AppDomain to the output writer + + + Nicko Cadell + + + + Write the name of the current AppDomain to the output + + the writer to write to + null, state is not set + + + Writes name of the current AppDomain to the output . + + + + + + Write the current date to the output + + + + Date pattern converter, uses a to format + the current date and time to the writer as a string. + + + The value of the determines + the formatting of the date. The following values are allowed: + + + Option value + Output + + + ISO8601 + + Uses the formatter. + Formats using the "yyyy-MM-dd HH:mm:ss,fff" pattern. + + + + DATE + + Uses the formatter. + Formats using the "dd MMM yyyy HH:mm:ss,fff" for example, "06 Nov 1994 15:49:37,459". + + + + ABSOLUTE + + Uses the formatter. + Formats using the "HH:mm:ss,fff" for example, "15:49:37,459". + + + + other + + Any other pattern string uses the formatter. + This formatter passes the pattern string to the + method. + For details on valid patterns see + DateTimeFormatInfo Class. + + + + + + The date and time is in the local time zone and is rendered in that zone. + To output the time in Universal time see . + + + Nicko Cadell + + + + The used to render the date to a string + + + + The used to render the date to a string + + + + + + Initialize the converter options + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + + + + Write the current date to the output + + that will receive the formatted result. + null, state is not set + + + Pass the current date and time to the + for it to render it to the writer. + + + The date and time passed is in the local time zone. + + + + + + The fully qualified type of the DatePatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Write an folder path to the output + + + + Write an special path environment folder path to the output writer. + The value of the determines + the name of the variable to output. + should be a value in the enumeration. + + + Ron Grabowski + + + + Write an special path environment folder path to the output + + the writer to write to + null, state is not set + + + Writes the special path environment folder path to the output . + The name of the special path environment folder path to output must be set + using the + property. + + + + + + The fully qualified type of the EnvironmentFolderPathPatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Write an environment variable to the output + + + + Write an environment variable to the output writer. + The value of the determines + the name of the variable to output. + + + Nicko Cadell + + + + Write an environment variable to the output + + the writer to write to + null, state is not set + + + Writes the environment variable to the output . + The name of the environment variable to output must be set + using the + property. + + + + + + The fully qualified type of the EnvironmentPatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Write the current thread identity to the output + + + + Write the current thread identity to the output writer + + + Nicko Cadell + + + + Write the current thread identity to the output + + the writer to write to + null, state is not set + + + Writes the current thread identity to the output . + + + + + + The fully qualified type of the IdentityPatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Pattern converter for literal string instances in the pattern + + + + Writes the literal string value specified in the + property to + the output. + + + Nicko Cadell + + + + Set the next converter in the chain + + The next pattern converter in the chain + The next pattern converter + + + Special case the building of the pattern converter chain + for instances. Two adjacent + literals in the pattern can be represented by a single combined + pattern converter. This implementation detects when a + is added to the chain + after this converter and combines its value with this converter's + literal value. + + + + + + Write the literal to the output + + the writer to write to + null, not set + + + Override the formatting behavior to ignore the FormattingInfo + because we have a literal instead. + + + Writes the value of + to the output . + + + + + + Convert this pattern into the rendered message + + that will receive the formatted result. + null, not set + + + This method is not used. + + + + + + Writes a newline to the output + + + + Writes the system dependent line terminator to the output. + This behavior can be overridden by setting the : + + + + Option Value + Output + + + DOS + DOS or Windows line terminator "\r\n" + + + UNIX + UNIX line terminator "\n" + + + + Nicko Cadell + + + + Initialize the converter + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + + + + Write the current process ID to the output + + + + Write the current process ID to the output writer + + + Nicko Cadell + + + + Write the current process ID to the output + + the writer to write to + null, state is not set + + + Write the current process ID to the output . + + + + + + The fully qualified type of the ProcessIdPatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Property pattern converter + + + + This pattern converter reads the thread and global properties. + The thread properties take priority over global properties. + See for details of the + thread properties. See for + details of the global properties. + + + If the is specified then that will be used to + lookup a single property. If no is specified + then all properties will be dumped as a list of key value pairs. + + + Nicko Cadell + + + + Write the property value to the output + + that will receive the formatted result. + null, state is not set + + + Writes out the value of a named property. The property name + should be set in the + property. + + + If the is set to null + then all the properties are written as key value pairs. + + + + + + A Pattern converter that generates a string of random characters + + + + The converter generates a string of random characters. By default + the string is length 4. This can be changed by setting the + to the string value of the length required. + + + The random characters in the string are limited to uppercase letters + and numbers only. + + + The random number generator used by this class is not cryptographically secure. + + + Nicko Cadell + + + + Shared random number generator + + + + + Length of random string to generate. Default length 4. + + + + + Initialize the converter options + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + + + + Write a randoim string to the output + + the writer to write to + null, state is not set + + + Write a randoim string to the output . + + + + + + The fully qualified type of the RandomStringPatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Write the current threads username to the output + + + + Write the current threads username to the output writer + + + Nicko Cadell + + + + Write the current threads username to the output + + the writer to write to + null, state is not set + + + Write the current threads username to the output . + + + + + + The fully qualified type of the UserNamePatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Write the UTC date time to the output + + + + Date pattern converter, uses a to format + the current date and time in Universal time. + + + See the for details on the date pattern syntax. + + + + Nicko Cadell + + + + Write the current date and time to the output + + that will receive the formatted result. + null, state is not set + + + Pass the current date and time to the + for it to render it to the writer. + + + The date is in Universal time when it is rendered. + + + + + + + The fully qualified type of the UtcDatePatternConverter class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Type converter for Boolean. + + + + Supports conversion from string to bool type. + + + + + + Nicko Cadell + Gert Driesen + + + + Can the source type be converted to the type supported by this object + + the type to convert + true if the conversion is possible + + + Returns true if the is + the type. + + + + + + Convert the source object to the type supported by this object + + the object to convert + the converted object + + + Uses the method to convert the + argument to a . + + + + The object cannot be converted to the + target type. To check for this condition use the + method. + + + + + Exception base type for conversion errors. + + + + This type extends . It + does not add any new functionality but does differentiate the + type of exception being thrown. + + + Nicko Cadell + Gert Driesen + + + + Constructor + + + + Initializes a new instance of the class. + + + + + + Constructor + + A message to include with the exception. + + + Initializes a new instance of the class + with the specified message. + + + + + + Constructor + + A message to include with the exception. + A nested exception to include. + + + Initializes a new instance of the class + with the specified message and inner exception. + + + + + + Serialization constructor + + The that holds the serialized object data about the exception being thrown. + The that contains contextual information about the source or destination. + + + Initializes a new instance of the class + with serialized data. + + + + + + Creates a new instance of the class. + + The conversion destination type. + The value to convert. + An instance of the . + + + Creates a new instance of the class. + + + + + + Creates a new instance of the class. + + The conversion destination type. + The value to convert. + A nested exception to include. + An instance of the . + + + Creates a new instance of the class. + + + + + + Register of type converters for specific types. + + + + Maintains a registry of type converters used to convert between + types. + + + Use the and + methods to register new converters. + The and methods + lookup appropriate converters to use. + + + + + Nicko Cadell + Gert Driesen + + + + Private constructor + + + Initializes a new instance of the class. + + + + + Static constructor. + + + + This constructor defines the intrinsic type converters. + + + + + + Adds a converter for a specific type. + + The type being converted to. + The type converter to use to convert to the destination type. + + + Adds a converter instance for a specific type. + + + + + + Adds a converter for a specific type. + + The type being converted to. + The type of the type converter to use to convert to the destination type. + + + Adds a converter for a specific type. + + + + + + Gets the type converter to use to convert values to the destination type. + + The type being converted from. + The type being converted to. + + The type converter instance to use for type conversions or null + if no type converter is found. + + + + Gets the type converter to use to convert values to the destination type. + + + + + + Gets the type converter to use to convert values to the destination type. + + The type being converted to. + + The type converter instance to use for type conversions or null + if no type converter is found. + + + + Gets the type converter to use to convert values to the destination type. + + + + + + Lookups the type converter to use as specified by the attributes on the + destination type. + + The type being converted to. + + The type converter instance to use for type conversions or null + if no type converter is found. + + + + + Creates the instance of the type converter. + + The type of the type converter. + + The type converter instance to use for type conversions or null + if no type converter is found. + + + + The type specified for the type converter must implement + the or interfaces + and must have a public default (no argument) constructor. + + + + + + The fully qualified type of the ConverterRegistry class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Mapping from to type converter. + + + + + Supports conversion from string to type. + + + + Supports conversion from string to type. + + + + + + Nicko Cadell + Gert Driesen + + + + Can the source type be converted to the type supported by this object + + the type to convert + true if the conversion is possible + + + Returns true if the is + the type. + + + + + + Overrides the ConvertFrom method of IConvertFrom. + + the object to convert to an encoding + the encoding + + + Uses the method to + convert the argument to an . + + + + The object cannot be converted to the + target type. To check for this condition use the + method. + + + + + Interface supported by type converters + + + + This interface supports conversion from a single type to arbitrary types. + See . + + + Nicko Cadell + + + + Returns whether this converter can convert the object to the specified type + + A Type that represents the type you want to convert to + true if the conversion is possible + + + Test if the type supported by this converter can be converted to the + . + + + + + + Converts the given value object to the specified type, using the arguments + + the object to convert + The Type to convert the value parameter to + the converted object + + + Converts the (which must be of the type supported + by this converter) to the specified.. + + + + + + Supports conversion from string to type. + + + + Supports conversion from string to type. + + + + + Nicko Cadell + + + + Can the source type be converted to the type supported by this object + + the type to convert + true if the conversion is possible + + + Returns true if the is + the type. + + + + + + Overrides the ConvertFrom method of IConvertFrom. + + the object to convert to an IPAddress + the IPAddress + + + Uses the method to convert the + argument to an . + If that fails then the string is resolved as a DNS hostname. + + + + The object cannot be converted to the + target type. To check for this condition use the + method. + + + + + Valid characters in an IPv4 or IPv6 address string. (Does not support subnets) + + + + + Supports conversion from string to type. + + + + Supports conversion from string to type. + + + The string is used as the + of the . + + + + + + Nicko Cadell + + + + Can the source type be converted to the type supported by this object + + the type to convert + true if the conversion is possible + + + Returns true if the is + the type. + + + + + + Overrides the ConvertFrom method of IConvertFrom. + + the object to convert to a PatternLayout + the PatternLayout + + + Creates and returns a new using + the as the + . + + + + The object cannot be converted to the + target type. To check for this condition use the + method. + + + + + Convert between string and + + + + Supports conversion from string to type, + and from a type to a string. + + + The string is used as the + of the . + + + + + + Nicko Cadell + + + + Can the target type be converted to the type supported by this object + + A that represents the type you want to convert to + true if the conversion is possible + + + Returns true if the is + assignable from a type. + + + + + + Converts the given value object to the specified type, using the arguments + + the object to convert + The Type to convert the value parameter to + the converted object + + + Uses the method to convert the + argument to a . + + + + The object cannot be converted to the + . To check for this condition use the + method. + + + + + Can the source type be converted to the type supported by this object + + the type to convert + true if the conversion is possible + + + Returns true if the is + the type. + + + + + + Overrides the ConvertFrom method of IConvertFrom. + + the object to convert to a PatternString + the PatternString + + + Creates and returns a new using + the as the + . + + + + The object cannot be converted to the + target type. To check for this condition use the + method. + + + + + Supports conversion from string to type. + + + + Supports conversion from string to type. + + + + + + Nicko Cadell + + + + Can the source type be converted to the type supported by this object + + the type to convert + true if the conversion is possible + + + Returns true if the is + the type. + + + + + + Overrides the ConvertFrom method of IConvertFrom. + + the object to convert to a Type + the Type + + + Uses the method to convert the + argument to a . + Additional effort is made to locate partially specified types + by searching the loaded assemblies. + + + + The object cannot be converted to the + target type. To check for this condition use the + method. + + + + + Attribute used to associate a type converter + + + + Class and Interface level attribute that specifies a type converter + to use with the associated type. + + + To associate a type converter with a target type apply a + TypeConverterAttribute to the target type. Specify the + type of the type converter on the attribute. + + + Nicko Cadell + Gert Driesen + + + + The string type name of the type converter + + + + + Default constructor + + + + Default constructor + + + + + + Create a new type converter attribute for the specified type name + + The string type name of the type converter + + + The type specified must implement the + or the interfaces. + + + + + + Create a new type converter attribute for the specified type + + The type of the type converter + + + The type specified must implement the + or the interfaces. + + + + + + The string type name of the type converter + + + The string type name of the type converter + + + + The type specified must implement the + or the interfaces. + + + + + + A straightforward implementation of the interface. + + + + This is the default implementation of the + interface. Implementors of the interface + should aggregate an instance of this type. + + + Nicko Cadell + Gert Driesen + + + + Constructor + + + + Initializes a new instance of the class. + + + + + + Append on on all attached appenders. + + The event being logged. + The number of appenders called. + + + Calls the method on all + attached appenders. + + + + + + Append on on all attached appenders. + + The array of events being logged. + The number of appenders called. + + + Calls the method on all + attached appenders. + + + + + + Calls the DoAppende method on the with + the objects supplied. + + The appender + The events + + + If the supports the + interface then the will be passed + through using that interface. Otherwise the + objects in the array will be passed one at a time. + + + + + + Attaches an appender. + + The appender to add. + + + If the appender is already in the list it won't be added again. + + + + + + Gets an attached appender with the specified name. + + The name of the appender to get. + + The appender with the name specified, or null if no appender with the + specified name is found. + + + + Lookup an attached appender by name. + + + + + + Removes all attached appenders. + + + + Removes and closes all attached appenders + + + + + + Removes the specified appender from the list of attached appenders. + + The appender to remove. + The appender removed from the list + + + The appender removed is not closed. + If you are discarding the appender you must call + on the appender removed. + + + + + + Removes the appender with the specified name from the list of appenders. + + The name of the appender to remove. + The appender removed from the list + + + The appender removed is not closed. + If you are discarding the appender you must call + on the appender removed. + + + + + + List of appenders + + + + + Array of appenders, used to cache the m_appenderList + + + + + The fully qualified type of the AppenderAttachedImpl class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Gets all attached appenders. + + + A collection of attached appenders, or null if there + are no attached appenders. + + + + The read only collection of all currently attached appenders. + + + + + + This class aggregates several PropertiesDictionary collections together. + + + + Provides a dictionary style lookup over an ordered list of + collections. + + + Nicko Cadell + + + + Constructor + + + + Initializes a new instance of the class. + + + + + + Add a Properties Dictionary to this composite collection + + the properties to add + + + Properties dictionaries added first take precedence over dictionaries added + later. + + + + + + Flatten this composite collection into a single properties dictionary + + the flattened dictionary + + + Reduces the collection of ordered dictionaries to a single dictionary + containing the resultant values for the keys. + + + + + + Gets the value of a property + + + The value for the property with the specified key + + + + Looks up the value for the specified. + The collections are searched + in the order in which they were added to this collection. The value + returned is the value held by the first collection that contains + the specified key. + + + If none of the collections contain the specified key then + null is returned. + + + + + + Base class for Context Properties implementations + + + + This class defines a basic property get set accessor + + + Nicko Cadell + + + + Gets or sets the value of a property + + + The value for the property with the specified key + + + + Gets or sets the value of a property + + + + + + Wrapper class used to map converter names to converter types + + + + Pattern converter info class used during configuration by custom + PatternString and PatternLayer converters. + + + + + + default constructor + + + + + + + + + + + Gets or sets the name of the conversion pattern + + + + The name of the pattern in the format string + + + + + + Gets or sets the type of the converter + + + + The value specified must extend the + type. + + + + + + + + + + + Subclass of that maintains a count of + the number of bytes written. + + + + This writer counts the number of bytes written. + + + Nicko Cadell + Gert Driesen + + + + that does not leak exceptions + + + + does not throw exceptions when things go wrong. + Instead, it delegates error handling to its . + + + Nicko Cadell + Gert Driesen + + + + Adapter that extends and forwards all + messages to an instance of . + + + + Adapter that extends and forwards all + messages to an instance of . + + + Nicko Cadell + + + + The writer to forward messages to + + + + + Create an instance of that forwards all + messages to a . + + The to forward to + + + Create an instance of that forwards all + messages to a . + + + + + + Closes the writer and releases any system resources associated with the writer + + + + + + + + + Dispose this writer + + flag indicating if we are being disposed + + + Dispose this writer + + + + + + Flushes any buffered output + + + + Clears all buffers for the writer and causes any buffered data to be written + to the underlying device + + + + + + Writes a character to the wrapped TextWriter + + the value to write to the TextWriter + + + Writes a character to the wrapped TextWriter + + + + + + Writes a character buffer to the wrapped TextWriter + + the data buffer + the start index + the number of characters to write + + + Writes a character buffer to the wrapped TextWriter + + + + + + Writes a string to the wrapped TextWriter + + the value to write to the TextWriter + + + Writes a string to the wrapped TextWriter + + + + + + Gets or sets the underlying . + + + The underlying . + + + + Gets or sets the underlying . + + + + + + The Encoding in which the output is written + + + The + + + + The Encoding in which the output is written + + + + + + Gets an object that controls formatting + + + The format provider + + + + Gets an object that controls formatting + + + + + + Gets or sets the line terminator string used by the TextWriter + + + The line terminator to use + + + + Gets or sets the line terminator string used by the TextWriter + + + + + + Constructor + + the writer to actually write to + the error handler to report error to + + + Create a new QuietTextWriter using a writer and error handler + + + + + + Writes a character to the underlying writer + + the char to write + + + Writes a character to the underlying writer + + + + + + Writes a buffer to the underlying writer + + the buffer to write + the start index to write from + the number of characters to write + + + Writes a buffer to the underlying writer + + + + + + Writes a string to the output. + + The string data to write to the output. + + + Writes a string to the output. + + + + + + Closes the underlying output writer. + + + + Closes the underlying output writer. + + + + + + The error handler instance to pass all errors to + + + + + Flag to indicate if this writer is closed + + + + + Gets or sets the error handler that all errors are passed to. + + + The error handler that all errors are passed to. + + + + Gets or sets the error handler that all errors are passed to. + + + + + + Gets a value indicating whether this writer is closed. + + + true if this writer is closed, otherwise false. + + + + Gets a value indicating whether this writer is closed. + + + + + + Constructor + + The to actually write to. + The to report errors to. + + + Creates a new instance of the class + with the specified and . + + + + + + Writes a character to the underlying writer and counts the number of bytes written. + + the char to write + + + Overrides implementation of . Counts + the number of bytes written. + + + + + + Writes a buffer to the underlying writer and counts the number of bytes written. + + the buffer to write + the start index to write from + the number of characters to write + + + Overrides implementation of . Counts + the number of bytes written. + + + + + + Writes a string to the output and counts the number of bytes written. + + The string data to write to the output. + + + Overrides implementation of . Counts + the number of bytes written. + + + + + + Total number of bytes written. + + + + + Gets or sets the total number of bytes written. + + + The total number of bytes written. + + + + Gets or sets the total number of bytes written. + + + + + + A fixed size rolling buffer of logging events. + + + + An array backed fixed size leaky bucket. + + + Nicko Cadell + Gert Driesen + + + + Constructor + + The maximum number of logging events in the buffer. + + + Initializes a new instance of the class with + the specified maximum number of buffered logging events. + + + The argument is not a positive integer. + + + + Appends a to the buffer. + + The event to append to the buffer. + The event discarded from the buffer, if the buffer is full, otherwise null. + + + Append an event to the buffer. If the buffer still contains free space then + null is returned. If the buffer is full then an event will be dropped + to make space for the new event, the event dropped is returned. + + + + + + Get and remove the oldest event in the buffer. + + The oldest logging event in the buffer + + + Gets the oldest (first) logging event in the buffer and removes it + from the buffer. + + + + + + Pops all the logging events from the buffer into an array. + + An array of all the logging events in the buffer. + + + Get all the events in the buffer and clear the buffer. + + + + + + Clear the buffer + + + + Clear the buffer of all events. The events in the buffer are lost. + + + + + + Gets the th oldest event currently in the buffer. + + The th oldest event currently in the buffer. + + + If is outside the range 0 to the number of events + currently in the buffer, then null is returned. + + + + + + Gets the maximum size of the buffer. + + The maximum size of the buffer. + + + Gets the maximum size of the buffer + + + + + + Gets the number of logging events in the buffer. + + The number of logging events in the buffer. + + + This number is guaranteed to be in the range 0 to + (inclusive). + + + + + + An always empty . + + + + A singleton implementation of the + interface that always represents an empty collection. + + + Nicko Cadell + Gert Driesen + + + + Initializes a new instance of the class. + + + + Uses a private access modifier to enforce the singleton pattern. + + + + + + Copies the elements of the to an + , starting at a particular Array index. + + The one-dimensional + that is the destination of the elements copied from + . The Array must have zero-based + indexing. + The zero-based index in array at which + copying begins. + + + As the collection is empty no values are copied into the array. + + + + + + Returns an enumerator that can iterate through a collection. + + + An that can be used to + iterate through the collection. + + + + As the collection is empty a is returned. + + + + + + The singleton instance of the empty collection. + + + + + Gets the singleton instance of the empty collection. + + The singleton instance of the empty collection. + + + Gets the singleton instance of the empty collection. + + + + + + Gets a value indicating if access to the is synchronized (thread-safe). + + + true if access to the is synchronized (thread-safe); otherwise, false. + + + + For the this property is always true. + + + + + + Gets the number of elements contained in the . + + + The number of elements contained in the . + + + + As the collection is empty the is always 0. + + + + + + Gets an object that can be used to synchronize access to the . + + + An object that can be used to synchronize access to the . + + + + As the collection is empty and thread safe and synchronized this instance is also + the object. + + + + + + An always empty . + + + + A singleton implementation of the + interface that always represents an empty collection. + + + Nicko Cadell + Gert Driesen + + + + Initializes a new instance of the class. + + + + Uses a private access modifier to enforce the singleton pattern. + + + + + + Copies the elements of the to an + , starting at a particular Array index. + + The one-dimensional + that is the destination of the elements copied from + . The Array must have zero-based + indexing. + The zero-based index in array at which + copying begins. + + + As the collection is empty no values are copied into the array. + + + + + + Returns an enumerator that can iterate through a collection. + + + An that can be used to + iterate through the collection. + + + + As the collection is empty a is returned. + + + + + + Adds an element with the provided key and value to the + . + + The to use as the key of the element to add. + The to use as the value of the element to add. + + + As the collection is empty no new values can be added. A + is thrown if this method is called. + + + This dictionary is always empty and cannot be modified. + + + + Removes all elements from the . + + + + As the collection is empty no values can be removed. A + is thrown if this method is called. + + + This dictionary is always empty and cannot be modified. + + + + Determines whether the contains an element + with the specified key. + + The key to locate in the . + false + + + As the collection is empty the method always returns false. + + + + + + Returns an enumerator that can iterate through a collection. + + + An that can be used to + iterate through the collection. + + + + As the collection is empty a is returned. + + + + + + Removes the element with the specified key from the . + + The key of the element to remove. + + + As the collection is empty no values can be removed. A + is thrown if this method is called. + + + This dictionary is always empty and cannot be modified. + + + + The singleton instance of the empty dictionary. + + + + + Gets the singleton instance of the . + + The singleton instance of the . + + + Gets the singleton instance of the . + + + + + + Gets a value indicating if access to the is synchronized (thread-safe). + + + true if access to the is synchronized (thread-safe); otherwise, false. + + + + For the this property is always true. + + + + + + Gets the number of elements contained in the + + + The number of elements contained in the . + + + + As the collection is empty the is always 0. + + + + + + Gets an object that can be used to synchronize access to the . + + + An object that can be used to synchronize access to the . + + + + As the collection is empty and thread safe and synchronized this instance is also + the object. + + + + + + Gets a value indicating whether the has a fixed size. + + true + + + As the collection is empty always returns true. + + + + + + Gets a value indicating whether the is read-only. + + true + + + As the collection is empty always returns true. + + + + + + Gets an containing the keys of the . + + An containing the keys of the . + + + As the collection is empty a is returned. + + + + + + Gets an containing the values of the . + + An containing the values of the . + + + As the collection is empty a is returned. + + + + + + Gets or sets the element with the specified key. + + The key of the element to get or set. + null + + + As the collection is empty no values can be looked up or stored. + If the index getter is called then null is returned. + A is thrown if the setter is called. + + + This dictionary is always empty and cannot be modified. + + + + Contain the information obtained when parsing formatting modifiers + in conversion modifiers. + + + + Holds the formatting information extracted from the format string by + the . This is used by the + objects when rendering the output. + + + Nicko Cadell + Gert Driesen + + + + Defaut Constructor + + + + Initializes a new instance of the class. + + + + + + Constructor + + + + Initializes a new instance of the class + with the specified parameters. + + + + + + Gets or sets the minimum value. + + + The minimum value. + + + + Gets or sets the minimum value. + + + + + + Gets or sets the maximum value. + + + The maximum value. + + + + Gets or sets the maximum value. + + + + + + Gets or sets a flag indicating whether left align is enabled + or not. + + + A flag indicating whether left align is enabled or not. + + + + Gets or sets a flag indicating whether left align is enabled or not. + + + + + + Implementation of Properties collection for the + + + + This class implements a properties collection that is thread safe and supports both + storing properties and capturing a read only copy of the current propertied. + + + This class is optimized to the scenario where the properties are read frequently + and are modified infrequently. + + + Nicko Cadell + + + + The read only copy of the properties. + + + + This variable is declared volatile to prevent the compiler and JIT from + reordering reads and writes of this thread performed on different threads. + + + + + + Lock object used to synchronize updates within this instance + + + + + Constructor + + + + Initializes a new instance of the class. + + + + + + Remove a property from the global context + + the key for the entry to remove + + + Removing an entry from the global context properties is relatively expensive compared + with reading a value. + + + + + + Clear the global context properties + + + + + Get a readonly immutable copy of the properties + + the current global context properties + + + This implementation is fast because the GlobalContextProperties class + stores a readonly copy of the properties. + + + + + + Gets or sets the value of a property + + + The value for the property with the specified key + + + + Reading the value for a key is faster than setting the value. + When the value is written a new read only copy of + the properties is created. + + + + + + Manages a mapping from levels to + + + + Manages an ordered mapping from instances + to subclasses. + + + Nicko Cadell + + + + Default constructor + + + + Initialise a new instance of . + + + + + + Add a to this mapping + + the entry to add + + + If a has previously been added + for the same then that entry will be + overwritten. + + + + + + Lookup the mapping for the specified level + + the level to lookup + the for the level or null if no mapping found + + + Lookup the value for the specified level. Finds the nearest + mapping value for the level that is equal to or less than the + specified. + + + If no mapping could be found then null is returned. + + + + + + Initialize options + + + + Caches the sorted list of in an array + + + + + + Implementation of Properties collection for the + + + + Class implements a collection of properties that is specific to each thread. + The class is not synchronized as each thread has its own . + + + This class stores its properties in a slot on the named + log4net.Util.LogicalThreadContextProperties. + + + The requires a link time + for the + . + If the calling code does not have this permission then this context will be disabled. + It will not store any property values set on it. + + + Nicko Cadell + + + + Flag used to disable this context if we don't have permission to access the CallContext. + + + + + Constructor + + + + Initializes a new instance of the class. + + + + + + Remove a property + + the key for the entry to remove + + + Remove the value for the specified from the context. + + + + + + Clear all the context properties + + + + Clear all the context properties + + + + + + Get the PropertiesDictionary stored in the LocalDataStoreSlot for this thread. + + create the dictionary if it does not exist, otherwise return null if is does not exist + the properties for this thread + + + The collection returned is only to be used on the calling thread. If the + caller needs to share the collection between different threads then the + caller must clone the collection before doings so. + + + + + + Gets the call context get data. + + The peroperties dictionary stored in the call context + + The method has a + security link demand, therfore we must put the method call in a seperate method + that we can wrap in an exception handler. + + + + + Sets the call context data. + + The properties. + + The method has a + security link demand, therfore we must put the method call in a seperate method + that we can wrap in an exception handler. + + + + + The fully qualified type of the LogicalThreadContextProperties class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Gets or sets the value of a property + + + The value for the property with the specified key + + + + Get or set the property value for the specified. + + + + + + Delegate type used for LogicalThreadContextStack's callbacks. + + + + + Implementation of Stack for the + + + + Implementation of Stack for the + + + Nicko Cadell + + + + The stack store. + + + + + The name of this within the + . + + + + + The callback used to let the register a + new instance of a . + + + + + Internal constructor + + + + Initializes a new instance of the class. + + + + + + Clears all the contextual information held in this stack. + + + + Clears all the contextual information held in this stack. + Only call this if you think that this thread is being reused after + a previous call execution which may not have completed correctly. + You do not need to use this method if you always guarantee to call + the method of the + returned from even in exceptional circumstances, + for example by using the using(log4net.LogicalThreadContext.Stacks["NDC"].Push("Stack_Message")) + syntax. + + + + + + Removes the top context from this stack. + + The message in the context that was removed from the top of this stack. + + + Remove the top context from this stack, and return + it to the caller. If this stack is empty then an + empty string (not ) is returned. + + + + + + Pushes a new context message into this stack. + + The new context message. + + An that can be used to clean up the context stack. + + + + Pushes a new context onto this stack. An + is returned that can be used to clean up this stack. This + can be easily combined with the using keyword to scope the + context. + + + Simple example of using the Push method with the using keyword. + + using(log4net.LogicalThreadContext.Stacks["NDC"].Push("Stack_Message")) + { + log.Warn("This should have an ThreadContext Stack message"); + } + + + + + + Gets the current context information for this stack. + + The current context information. + + + + Gets the current context information for this stack. + + Gets the current context information + + + Gets the current context information for this stack. + + + + + + Get a portable version of this object + + the portable instance of this object + + + Get a cross thread portable version of this object + + + + + + The number of messages in the stack + + + The current number of messages in the stack + + + + The current number of messages in the stack. That is + the number of times has been called + minus the number of times has been called. + + + + + + Gets and sets the internal stack used by this + + The internal storage stack + + + This property is provided only to support backward compatability + of the . Tytpically the internal stack should not + be modified. + + + + + + Inner class used to represent a single context frame in the stack. + + + + Inner class used to represent a single context frame in the stack. + + + + + + Constructor + + The message for this context. + The parent context in the chain. + + + Initializes a new instance of the class + with the specified message and parent context. + + + + + + Get the message. + + The message. + + + Get the message. + + + + + + Gets the full text of the context down to the root level. + + + The full text of the context down to the root level. + + + + Gets the full text of the context down to the root level. + + + + + + Struct returned from the method. + + + + This struct implements the and is designed to be used + with the pattern to remove the stack frame at the end of the scope. + + + + + + The depth to trim the stack to when this instance is disposed + + + + + The outer LogicalThreadContextStack. + + + + + Constructor + + The internal stack used by the ThreadContextStack. + The depth to return the stack to when this object is disposed. + + + Initializes a new instance of the class with + the specified stack and return depth. + + + + + + Returns the stack to the correct depth. + + + + Returns the stack to the correct depth. + + + + + + Implementation of Stacks collection for the + + + + Implementation of Stacks collection for the + + + Nicko Cadell + + + + Internal constructor + + + + Initializes a new instance of the class. + + + + + + The fully qualified type of the ThreadContextStacks class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Gets the named thread context stack + + + The named stack + + + + Gets the named thread context stack + + + + + + + + + + + + + Outputs log statements from within the log4net assembly. + + + + Log4net components cannot make log4net logging calls. However, it is + sometimes useful for the user to learn about what log4net is + doing. + + + All log4net internal debug calls go to the standard output stream + whereas internal error messages are sent to the standard error output + stream. + + + Nicko Cadell + Gert Driesen + + + + Formats Prefix, Source, and Message in the same format as the value + sent to Console.Out and Trace.Write. + + + + + + Initializes a new instance of the class. + + + + + + + + + Static constructor that initializes logging by reading + settings from the application configuration file. + + + + The log4net.Internal.Debug application setting + controls internal debugging. This setting should be set + to true to enable debugging. + + + The log4net.Internal.Quiet application setting + suppresses all internal logging including error messages. + This setting should be set to true to enable message + suppression. + + + + + + Raises the LogReceived event when an internal messages is received. + + + + + + + + + Writes log4net internal debug messages to the + standard output stream. + + + The message to log. + + + All internal debug messages are prepended with + the string "log4net: ". + + + + + + Writes log4net internal debug messages to the + standard output stream. + + The Type that generated this message. + The message to log. + An exception to log. + + + All internal debug messages are prepended with + the string "log4net: ". + + + + + + Writes log4net internal warning messages to the + standard error stream. + + The Type that generated this message. + The message to log. + + + All internal warning messages are prepended with + the string "log4net:WARN ". + + + + + + Writes log4net internal warning messages to the + standard error stream. + + The Type that generated this message. + The message to log. + An exception to log. + + + All internal warning messages are prepended with + the string "log4net:WARN ". + + + + + + Writes log4net internal error messages to the + standard error stream. + + The Type that generated this message. + The message to log. + + + All internal error messages are prepended with + the string "log4net:ERROR ". + + + + + + Writes log4net internal error messages to the + standard error stream. + + The Type that generated this message. + The message to log. + An exception to log. + + + All internal debug messages are prepended with + the string "log4net:ERROR ". + + + + + + Writes output to the standard output stream. + + The message to log. + + + Writes to both Console.Out and System.Diagnostics.Trace. + Note that the System.Diagnostics.Trace is not supported + on the Compact Framework. + + + If the AppDomain is not configured with a config file then + the call to System.Diagnostics.Trace may fail. This is only + an issue if you are programmatically creating your own AppDomains. + + + + + + Writes output to the standard error stream. + + The message to log. + + + Writes to both Console.Error and System.Diagnostics.Trace. + Note that the System.Diagnostics.Trace is not supported + on the Compact Framework. + + + If the AppDomain is not configured with a config file then + the call to System.Diagnostics.Trace may fail. This is only + an issue if you are programmatically creating your own AppDomains. + + + + + + Default debug level + + + + + In quietMode not even errors generate any output. + + + + + The event raised when an internal message has been received. + + + + + The Type that generated the internal message. + + + + + The DateTime stamp of when the internal message was received. + + + + + A string indicating the severity of the internal message. + + + "log4net: ", + "log4net:ERROR ", + "log4net:WARN " + + + + + The internal log message. + + + + + The Exception related to the message. + + + Optional. Will be null if no Exception was passed. + + + + + Gets or sets a value indicating whether log4net internal logging + is enabled or disabled. + + + true if log4net internal logging is enabled, otherwise + false. + + + + When set to true, internal debug level logging will be + displayed. + + + This value can be set by setting the application setting + log4net.Internal.Debug in the application configuration + file. + + + The default value is false, i.e. debugging is + disabled. + + + + + The following example enables internal debugging using the + application configuration file : + + + + + + + + + + + + + Gets or sets a value indicating whether log4net should generate no output + from internal logging, not even for errors. + + + true if log4net should generate no output at all from internal + logging, otherwise false. + + + + When set to true will cause internal logging at all levels to be + suppressed. This means that no warning or error reports will be logged. + This option overrides the setting and + disables all debug also. + + This value can be set by setting the application setting + log4net.Internal.Quiet in the application configuration file. + + + The default value is false, i.e. internal logging is not + disabled. + + + + The following example disables internal logging using the + application configuration file : + + + + + + + + + + + + + + + + + Test if LogLog.Debug is enabled for output. + + + true if Debug is enabled + + + + Test if LogLog.Debug is enabled for output. + + + + + + Test if LogLog.Warn is enabled for output. + + + true if Warn is enabled + + + + Test if LogLog.Warn is enabled for output. + + + + + + Test if LogLog.Error is enabled for output. + + + true if Error is enabled + + + + Test if LogLog.Error is enabled for output. + + + + + + Subscribes to the LogLog.LogReceived event and stores messages + to the supplied IList instance. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Represents a native error code and message. + + + + Represents a Win32 platform native error. + + + Nicko Cadell + Gert Driesen + + + + Create an instance of the class with the specified + error number and message. + + The number of the native error. + The message of the native error. + + + Create an instance of the class with the specified + error number and message. + + + + + + Create a new instance of the class for the last Windows error. + + + An instance of the class for the last windows error. + + + + The message for the error number is lookup up using the + native Win32 FormatMessage function. + + + + + + Create a new instance of the class. + + the error number for the native error + + An instance of the class for the specified + error number. + + + + The message for the specified error number is lookup up using the + native Win32 FormatMessage function. + + + + + + Retrieves the message corresponding with a Win32 message identifier. + + Message identifier for the requested message. + + The message corresponding with the specified message identifier. + + + + The message will be searched for in system message-table resource(s) + using the native FormatMessage function. + + + + + + Return error information string + + error information string + + + Return error information string + + + + + + Formats a message string. + + Formatting options, and how to interpret the parameter. + Location of the message definition. + Message identifier for the requested message. + Language identifier for the requested message. + If includes FORMAT_MESSAGE_ALLOCATE_BUFFER, the function allocates a buffer using the LocalAlloc function, and places the pointer to the buffer at the address specified in . + If the FORMAT_MESSAGE_ALLOCATE_BUFFER flag is not set, this parameter specifies the maximum number of TCHARs that can be stored in the output buffer. If FORMAT_MESSAGE_ALLOCATE_BUFFER is set, this parameter specifies the minimum number of TCHARs to allocate for an output buffer. + Pointer to an array of values that are used as insert values in the formatted message. + + + The function requires a message definition as input. The message definition can come from a + buffer passed into the function. It can come from a message table resource in an + already-loaded module. Or the caller can ask the function to search the system's message + table resource(s) for the message definition. The function finds the message definition + in a message table resource based on a message identifier and a language identifier. + The function copies the formatted message text to an output buffer, processing any embedded + insert sequences if requested. + + + To prevent the usage of unsafe code, this stub does not support inserting values in the formatted message. + + + + + If the function succeeds, the return value is the number of TCHARs stored in the output + buffer, excluding the terminating null character. + + + If the function fails, the return value is zero. To get extended error information, + call . + + + + + + Gets the number of the native error. + + + The number of the native error. + + + + Gets the number of the native error. + + + + + + Gets the message of the native error. + + + The message of the native error. + + + + + Gets the message of the native error. + + + + + An always empty . + + + + A singleton implementation of the over a collection + that is empty and not modifiable. + + + Nicko Cadell + Gert Driesen + + + + Initializes a new instance of the class. + + + + Uses a private access modifier to enforce the singleton pattern. + + + + + + Test if the enumerator can advance, if so advance. + + false as the cannot advance. + + + As the enumerator is over an empty collection its + value cannot be moved over a valid position, therefore + will always return false. + + + + + + Resets the enumerator back to the start. + + + + As the enumerator is over an empty collection does nothing. + + + + + + The singleton instance of the . + + + + + Gets the singleton instance of the . + + The singleton instance of the . + + + Gets the singleton instance of the . + + + + + + Gets the current object from the enumerator. + + + Throws an because the + never has a current value. + + + + As the enumerator is over an empty collection its + value cannot be moved over a valid position, therefore + will throw an . + + + The collection is empty and + cannot be positioned over a valid location. + + + + Gets the current key from the enumerator. + + + Throws an exception because the + never has a current value. + + + + As the enumerator is over an empty collection its + value cannot be moved over a valid position, therefore + will throw an . + + + The collection is empty and + cannot be positioned over a valid location. + + + + Gets the current value from the enumerator. + + The current value from the enumerator. + + Throws an because the + never has a current value. + + + + As the enumerator is over an empty collection its + value cannot be moved over a valid position, therefore + will throw an . + + + The collection is empty and + cannot be positioned over a valid location. + + + + Gets the current entry from the enumerator. + + + Throws an because the + never has a current entry. + + + + As the enumerator is over an empty collection its + value cannot be moved over a valid position, therefore + will throw an . + + + The collection is empty and + cannot be positioned over a valid location. + + + + An always empty . + + + + A singleton implementation of the over a collection + that is empty and not modifiable. + + + Nicko Cadell + Gert Driesen + + + + Initializes a new instance of the class. + + + + Uses a private access modifier to enforce the singleton pattern. + + + + + + Test if the enumerator can advance, if so advance + + false as the cannot advance. + + + As the enumerator is over an empty collection its + value cannot be moved over a valid position, therefore + will always return false. + + + + + + Resets the enumerator back to the start. + + + + As the enumerator is over an empty collection does nothing. + + + + + + The singleton instance of the . + + + + + Get the singleton instance of the . + + The singleton instance of the . + + + Gets the singleton instance of the . + + + + + + Gets the current object from the enumerator. + + + Throws an because the + never has a current value. + + + + As the enumerator is over an empty collection its + value cannot be moved over a valid position, therefore + will throw an . + + + The collection is empty and + cannot be positioned over a valid location. + + + + A SecurityContext used when a SecurityContext is not required + + + + The is a no-op implementation of the + base class. It is used where a + is required but one has not been provided. + + + Nicko Cadell + + + + Singleton instance of + + + + Singleton instance of + + + + + + Private constructor + + + + Private constructor for singleton pattern. + + + + + + Impersonate this SecurityContext + + State supplied by the caller + null + + + No impersonation is done and null is always returned. + + + + + + Implements log4net's default error handling policy which consists + of emitting a message for the first error in an appender and + ignoring all subsequent errors. + + + + The error message is processed using the LogLog sub-system by default. + + + This policy aims at protecting an otherwise working application + from being flooded with error messages when logging fails. + + + Nicko Cadell + Gert Driesen + Ron Grabowski + + + + Default Constructor + + + + Initializes a new instance of the class. + + + + + + Constructor + + The prefix to use for each message. + + + Initializes a new instance of the class + with the specified prefix. + + + + + + Reset the error handler back to its initial disabled state. + + + + + Log an Error + + The error message. + The exception. + The internal error code. + + + Invokes if and only if this is the first error or the first error after has been called. + + + + + + Log the very first error + + The error message. + The exception. + The internal error code. + + + Sends the error information to 's Error method. + + + + + + Log an Error + + The error message. + The exception. + + + Invokes if and only if this is the first error or the first error after has been called. + + + + + + Log an error + + The error message. + + + Invokes if and only if this is the first error or the first error after has been called. + + + + + + The date the error was recorded. + + + + + Flag to indicate if it is the first error + + + + + The message recorded during the first error. + + + + + The exception recorded during the first error. + + + + + The error code recorded during the first error. + + + + + String to prefix each message with + + + + + The fully qualified type of the OnlyOnceErrorHandler class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Is error logging enabled + + + + Is error logging enabled. Logging is only enabled for the + first error delivered to the . + + + + + + The date the first error that trigged this error handler occured. + + + + + The message from the first error that trigged this error handler. + + + + + The exception from the first error that trigged this error handler. + + + May be . + + + + + The error code from the first error that trigged this error handler. + + + Defaults to + + + + + A convenience class to convert property values to specific types. + + + + Utility functions for converting types and parsing values. + + + Nicko Cadell + Gert Driesen + + + + Initializes a new instance of the class. + + + + Uses a private access modifier to prevent instantiation of this class. + + + + + + Converts a string to a value. + + String to convert. + The default value. + The value of . + + + If is "true", then true is returned. + If is "false", then false is returned. + Otherwise, is returned. + + + + + + Parses a file size into a number. + + String to parse. + The default value. + The value of . + + + Parses a file size of the form: number[KB|MB|GB] into a + long value. It is scaled with the appropriate multiplier. + + + is returned when + cannot be converted to a value. + + + + + + Converts a string to an object. + + The target type to convert to. + The string to convert to an object. + + The object converted from a string or null when the + conversion failed. + + + + Converts a string to an object. Uses the converter registry to try + to convert the string value into the specified target type. + + + + + + Checks if there is an appropriate type conversion from the source type to the target type. + + The type to convert from. + The type to convert to. + true if there is a conversion from the source type to the target type. + + Checks if there is an appropriate type conversion from the source type to the target type. + + + + + + + Converts an object to the target type. + + The object to convert to the target type. + The type to convert to. + The converted object. + + + Converts an object to the target type. + + + + + + Instantiates an object given a class name. + + The fully qualified class name of the object to instantiate. + The class to which the new object should belong. + The object to return in case of non-fulfillment. + + An instance of the or + if the object could not be instantiated. + + + + Checks that the is a subclass of + . If that test fails or the object could + not be instantiated, then is returned. + + + + + + Performs variable substitution in string from the + values of keys found in . + + The string on which variable substitution is performed. + The dictionary to use to lookup variables. + The result of the substitutions. + + + The variable substitution delimiters are ${ and }. + + + For example, if props contains key=value, then the call + + + + string s = OptionConverter.SubstituteVariables("Value of key is ${key}."); + + + + will set the variable s to "Value of key is value.". + + + If no value could be found for the specified key, then substitution + defaults to an empty string. + + + For example, if system properties contains no value for the key + "nonExistentKey", then the call + + + + string s = OptionConverter.SubstituteVariables("Value of nonExistentKey is [${nonExistentKey}]"); + + + + will set s to "Value of nonExistentKey is []". + + + An Exception is thrown if contains a start + delimiter "${" which is not balanced by a stop delimiter "}". + + + + + + Converts the string representation of the name or numeric value of one or + more enumerated constants to an equivalent enumerated object. + + The type to convert to. + The enum string value. + If true, ignore case; otherwise, regard case. + An object of type whose value is represented by . + + + + The fully qualified type of the OptionConverter class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Most of the work of the class + is delegated to the PatternParser class. + + + + The PatternParser processes a pattern string and + returns a chain of objects. + + + Nicko Cadell + Gert Driesen + + + + Constructor + + The pattern to parse. + + + Initializes a new instance of the class + with the specified pattern string. + + + + + + Parses the pattern into a chain of pattern converters. + + The head of a chain of pattern converters. + + + Parses the pattern into a chain of pattern converters. + + + + + + Build the unified cache of converters from the static and instance maps + + the list of all the converter names + + + Build the unified cache of converters from the static and instance maps + + + + + + Internal method to parse the specified pattern to find specified matches + + the pattern to parse + the converter names to match in the pattern + + + The matches param must be sorted such that longer strings come before shorter ones. + + + + + + Process a parsed literal + + the literal text + + + + Process a parsed converter pattern + + the name of the converter + the optional option for the converter + the formatting info for the converter + + + + Resets the internal state of the parser and adds the specified pattern converter + to the chain. + + The pattern converter to add. + + + + The first pattern converter in the chain + + + + + the last pattern converter in the chain + + + + + The pattern + + + + + Internal map of converter identifiers to converter types + + + + This map overrides the static s_globalRulesRegistry map. + + + + + + The fully qualified type of the PatternParser class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Get the converter registry used by this parser + + + The converter registry used by this parser + + + + Get the converter registry used by this parser + + + + + + Sort strings by length + + + + that orders strings by string length. + The longest strings are placed first + + + + + + This class implements a patterned string. + + + + This string has embedded patterns that are resolved and expanded + when the string is formatted. + + + This class functions similarly to the + in that it accepts a pattern and renders it to a string. Unlike the + however the PatternString + does not render the properties of a specific but + of the process in general. + + + The recognized conversion pattern names are: + + + + Conversion Pattern Name + Effect + + + appdomain + + + Used to output the friendly name of the current AppDomain. + + + + + date + + + Used to output the current date and time in the local time zone. + To output the date in universal time use the %utcdate pattern. + The date conversion + specifier may be followed by a date format specifier enclosed + between braces. For example, %date{HH:mm:ss,fff} or + %date{dd MMM yyyy HH:mm:ss,fff}. If no date format specifier is + given then ISO8601 format is + assumed (). + + + The date format specifier admits the same syntax as the + time pattern string of the . + + + For better results it is recommended to use the log4net date + formatters. These can be specified using one of the strings + "ABSOLUTE", "DATE" and "ISO8601" for specifying + , + and respectively + . For example, + %date{ISO8601} or %date{ABSOLUTE}. + + + These dedicated date formatters perform significantly + better than . + + + + + env + + + Used to output the a specific environment variable. The key to + lookup must be specified within braces and directly following the + pattern specifier, e.g. %env{COMPUTERNAME} would include the value + of the COMPUTERNAME environment variable. + + + The env pattern is not supported on the .NET Compact Framework. + + + + + identity + + + Used to output the user name for the currently active user + (Principal.Identity.Name). + + + + + newline + + + Outputs the platform dependent line separator character or + characters. + + + This conversion pattern name offers the same performance as using + non-portable line separator strings such as "\n", or "\r\n". + Thus, it is the preferred way of specifying a line separator. + + + + + processid + + + Used to output the system process ID for the current process. + + + + + property + + + Used to output a specific context property. The key to + lookup must be specified within braces and directly following the + pattern specifier, e.g. %property{user} would include the value + from the property that is keyed by the string 'user'. Each property value + that is to be included in the log must be specified separately. + Properties are stored in logging contexts. By default + the log4net:HostName property is set to the name of machine on + which the event was originally logged. + + + If no key is specified, e.g. %property then all the keys and their + values are printed in a comma separated list. + + + The properties of an event are combined from a number of different + contexts. These are listed below in the order in which they are searched. + + + + the thread properties + + The that are set on the current + thread. These properties are shared by all events logged on this thread. + + + + the global properties + + The that are set globally. These + properties are shared by all the threads in the AppDomain. + + + + + + + random + + + Used to output a random string of characters. The string is made up of + uppercase letters and numbers. By default the string is 4 characters long. + The length of the string can be specified within braces directly following the + pattern specifier, e.g. %random{8} would output an 8 character string. + + + + + username + + + Used to output the WindowsIdentity for the currently + active user. + + + + + utcdate + + + Used to output the date of the logging event in universal time. + The date conversion + specifier may be followed by a date format specifier enclosed + between braces. For example, %utcdate{HH:mm:ss,fff} or + %utcdate{dd MMM yyyy HH:mm:ss,fff}. If no date format specifier is + given then ISO8601 format is + assumed (). + + + The date format specifier admits the same syntax as the + time pattern string of the . + + + For better results it is recommended to use the log4net date + formatters. These can be specified using one of the strings + "ABSOLUTE", "DATE" and "ISO8601" for specifying + , + and respectively + . For example, + %utcdate{ISO8601} or %utcdate{ABSOLUTE}. + + + These dedicated date formatters perform significantly + better than . + + + + + % + + + The sequence %% outputs a single percent sign. + + + + + + Additional pattern converters may be registered with a specific + instance using or + . + + + See the for details on the + format modifiers supported by the patterns. + + + Nicko Cadell + + + + Internal map of converter identifiers to converter types. + + + + + the pattern + + + + + the head of the pattern converter chain + + + + + patterns defined on this PatternString only + + + + + Initialize the global registry + + + + + Default constructor + + + + Initialize a new instance of + + + + + + Constructs a PatternString + + The pattern to use with this PatternString + + + Initialize a new instance of with the pattern specified. + + + + + + Initialize object options + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + + + + Create the used to parse the pattern + + the pattern to parse + The + + + Returns PatternParser used to parse the conversion string. Subclasses + may override this to return a subclass of PatternParser which recognize + custom conversion pattern name. + + + + + + Produces a formatted string as specified by the conversion pattern. + + The TextWriter to write the formatted event to + + + Format the pattern to the . + + + + + + Format the pattern as a string + + the pattern formatted as a string + + + Format the pattern to a string. + + + + + + Add a converter to this PatternString + + the converter info + + + This version of the method is used by the configurator. + Programmatic users should use the alternative method. + + + + + + Add a converter to this PatternString + + the name of the conversion pattern for this converter + the type of the converter + + + Add a converter to this PatternString + + + + + + Gets or sets the pattern formatting string + + + The pattern formatting string + + + + The ConversionPattern option. This is the string which + controls formatting and consists of a mix of literal content and + conversion specifiers. + + + + + + String keyed object map. + + + + While this collection is serializable only member + objects that are serializable will + be serialized along with this collection. + + + Nicko Cadell + Gert Driesen + + + + String keyed object map that is read only. + + + + This collection is readonly and cannot be modified. + + + While this collection is serializable only member + objects that are serializable will + be serialized along with this collection. + + + Nicko Cadell + Gert Driesen + + + + The Hashtable used to store the properties data + + + + + Constructor + + + + Initializes a new instance of the class. + + + + + + Copy Constructor + + properties to copy + + + Initializes a new instance of the class. + + + + + + Deserialization constructor + + The that holds the serialized object data. + The that contains contextual information about the source or destination. + + + Initializes a new instance of the class + with serialized data. + + + + + + Gets the key names. + + An array of all the keys. + + + Gets the key names. + + + + + + Test if the dictionary contains a specified key + + the key to look for + true if the dictionary contains the specified key + + + Test if the dictionary contains a specified key + + + + + + Serializes this object into the provided. + + The to populate with data. + The destination for this serialization. + + + Serializes this object into the provided. + + + + + + See + + + + + See + + + + + + See + + + + + + + Remove all properties from the properties collection + + + + + See + + + + + + + See + + + + + + + See + + + + + Gets or sets the value of the property with the specified key. + + + The value of the property with the specified key. + + The key of the property to get or set. + + + The property value will only be serialized if it is serializable. + If it cannot be serialized it will be silently ignored if + a serialization operation is performed. + + + + + + The hashtable used to store the properties + + + The internal collection used to store the properties + + + + The hashtable used to store the properties + + + + + + See + + + + + See + + + + + See + + + + + See + + + + + See + + + + + See + + + + + The number of properties in this collection + + + + + See + + + + + Constructor + + + + Initializes a new instance of the class. + + + + + + Constructor + + properties to copy + + + Initializes a new instance of the class. + + + + + + Initializes a new instance of the class + with serialized data. + + The that holds the serialized object data. + The that contains contextual information about the source or destination. + + + Because this class is sealed the serialization constructor is private. + + + + + + Remove the entry with the specified key from this dictionary + + the key for the entry to remove + + + Remove the entry with the specified key from this dictionary + + + + + + See + + an enumerator + + + Returns a over the contest of this collection. + + + + + + See + + the key to remove + + + Remove the entry with the specified key from this dictionary + + + + + + See + + the key to lookup in the collection + true if the collection contains the specified key + + + Test if this collection contains a specified key. + + + + + + Remove all properties from the properties collection + + + + Remove all properties from the properties collection + + + + + + See + + the key + the value to store for the key + + + Store a value for the specified . + + + Thrown if the is not a string + + + + See + + + + + + + See + + + + + Gets or sets the value of the property with the specified key. + + + The value of the property with the specified key. + + The key of the property to get or set. + + + The property value will only be serialized if it is serializable. + If it cannot be serialized it will be silently ignored if + a serialization operation is performed. + + + + + + See + + + false + + + + This collection is modifiable. This property always + returns false. + + + + + + See + + + The value for the key specified. + + + + Get or set a value for the specified . + + + Thrown if the is not a string + + + + See + + + + + See + + + + + See + + + + + See + + + + + See + + + + + A class to hold the key and data for a property set in the config file + + + + A class to hold the key and data for a property set in the config file + + + + + + Override Object.ToString to return sensible debug info + + string info about this object + + + + Property Key + + + Property Key + + + + Property Key. + + + + + + Property Value + + + Property Value + + + + Property Value. + + + + + + A that ignores the message + + + + This writer is used in special cases where it is necessary + to protect a writer from being closed by a client. + + + Nicko Cadell + + + + Constructor + + the writer to actually write to + + + Create a new ProtectCloseTextWriter using a writer + + + + + + Attach this instance to a different underlying + + the writer to attach to + + + Attach this instance to a different underlying + + + + + + Does not close the underlying output writer. + + + + Does not close the underlying output writer. + This method does nothing. + + + + + + Defines a lock that supports single writers and multiple readers + + + + ReaderWriterLock is used to synchronize access to a resource. + At any given time, it allows either concurrent read access for + multiple threads, or write access for a single thread. In a + situation where a resource is changed infrequently, a + ReaderWriterLock provides better throughput than a simple + one-at-a-time lock, such as . + + + If a platform does not support a System.Threading.ReaderWriterLock + implementation then all readers and writers are serialized. Therefore + the caller must not rely on multiple simultaneous readers. + + + Nicko Cadell + + + + Constructor + + + + Initializes a new instance of the class. + + + + + + Acquires a reader lock + + + + blocks if a different thread has the writer + lock, or if at least one thread is waiting for the writer lock. + + + + + + Decrements the lock count + + + + decrements the lock count. When the count + reaches zero, the lock is released. + + + + + + Acquires the writer lock + + + + This method blocks if another thread has a reader lock or writer lock. + + + + + + Decrements the lock count on the writer lock + + + + ReleaseWriterLock decrements the writer lock count. + When the count reaches zero, the writer lock is released. + + + + + + A that can be and reused + + + + A that can be and reused. + This uses a single buffer for string operations. + + + Nicko Cadell + + + + Create an instance of + + the format provider to use + + + Create an instance of + + + + + + Override Dispose to prevent closing of writer + + flag + + + Override Dispose to prevent closing of writer + + + + + + Reset this string writer so that it can be reused. + + the maximum buffer capacity before it is trimmed + the default size to make the buffer + + + Reset this string writer so that it can be reused. + The internal buffers are cleared and reset. + + + + + + Utility class for system specific information. + + + + Utility class of static methods for system specific information. + + + Nicko Cadell + Gert Driesen + Alexey Solofnenko + + + + Private constructor to prevent instances. + + + + Only static methods are exposed from this type. + + + + + + Initialize default values for private static fields. + + + + Only static methods are exposed from this type. + + + + + + Gets the assembly location path for the specified assembly. + + The assembly to get the location for. + The location of the assembly. + + + This method does not guarantee to return the correct path + to the assembly. If only tries to give an indication as to + where the assembly was loaded from. + + + + + + Gets the fully qualified name of the , including + the name of the assembly from which the was + loaded. + + The to get the fully qualified name for. + The fully qualified name for the . + + + This is equivalent to the Type.AssemblyQualifiedName property, + but this method works on the .NET Compact Framework 1.0 as well as + the full .NET runtime. + + + + + + Gets the short name of the . + + The to get the name for. + The short name of the . + + + The short name of the assembly is the + without the version, culture, or public key. i.e. it is just the + assembly's file name without the extension. + + + Use this rather than Assembly.GetName().Name because that + is not available on the Compact Framework. + + + Because of a FileIOPermission security demand we cannot do + the obvious Assembly.GetName().Name. We are allowed to get + the of the assembly so we + start from there and strip out just the assembly name. + + + + + + Gets the file name portion of the , including the extension. + + The to get the file name for. + The file name of the assembly. + + + Gets the file name portion of the , including the extension. + + + + + + Loads the type specified in the type string. + + A sibling type to use to load the type. + The name of the type to load. + Flag set to true to throw an exception if the type cannot be loaded. + true to ignore the case of the type name; otherwise, false + The type loaded or null if it could not be loaded. + + + If the type name is fully qualified, i.e. if contains an assembly name in + the type name, the type will be loaded from the system using + . + + + If the type name is not fully qualified, it will be loaded from the assembly + containing the specified relative type. If the type is not found in the assembly + then all the loaded assemblies will be searched for the type. + + + + + + Loads the type specified in the type string. + + The name of the type to load. + Flag set to true to throw an exception if the type cannot be loaded. + true to ignore the case of the type name; otherwise, false + The type loaded or null if it could not be loaded. + + + If the type name is fully qualified, i.e. if contains an assembly name in + the type name, the type will be loaded from the system using + . + + + If the type name is not fully qualified it will be loaded from the + assembly that is directly calling this method. If the type is not found + in the assembly then all the loaded assemblies will be searched for the type. + + + + + + Loads the type specified in the type string. + + An assembly to load the type from. + The name of the type to load. + Flag set to true to throw an exception if the type cannot be loaded. + true to ignore the case of the type name; otherwise, false + The type loaded or null if it could not be loaded. + + + If the type name is fully qualified, i.e. if contains an assembly name in + the type name, the type will be loaded from the system using + . + + + If the type name is not fully qualified it will be loaded from the specified + assembly. If the type is not found in the assembly then all the loaded assemblies + will be searched for the type. + + + + + + Generate a new guid + + A new Guid + + + Generate a new guid + + + + + + Create an + + The name of the parameter that caused the exception + The value of the argument that causes this exception + The message that describes the error + the ArgumentOutOfRangeException object + + + Create a new instance of the class + with a specified error message, the parameter name, and the value + of the argument. + + + The Compact Framework does not support the 3 parameter constructor for the + type. This method provides an + implementation that works for all platforms. + + + + + + Parse a string into an value + + the string to parse + out param where the parsed value is placed + true if the string was able to be parsed into an integer + + + Attempts to parse the string into an integer. If the string cannot + be parsed then this method returns false. The method does not throw an exception. + + + + + + Parse a string into an value + + the string to parse + out param where the parsed value is placed + true if the string was able to be parsed into an integer + + + Attempts to parse the string into an integer. If the string cannot + be parsed then this method returns false. The method does not throw an exception. + + + + + + Parse a string into an value + + the string to parse + out param where the parsed value is placed + true if the string was able to be parsed into an integer + + + Attempts to parse the string into an integer. If the string cannot + be parsed then this method returns false. The method does not throw an exception. + + + + + + Lookup an application setting + + the application settings key to lookup + the value for the key, or null + + + Configuration APIs are not supported under the Compact Framework + + + + + + Convert a path into a fully qualified local file path. + + The path to convert. + The fully qualified path. + + + Converts the path specified to a fully + qualified path. If the path is relative it is + taken as relative from the application base + directory. + + + The path specified must be a local file path, a URI is not supported. + + + + + + Creates a new case-insensitive instance of the class with the default initial capacity. + + A new case-insensitive instance of the class with the default initial capacity + + + The new Hashtable instance uses the default load factor, the CaseInsensitiveHashCodeProvider, and the CaseInsensitiveComparer. + + + + + + Gets an empty array of types. + + + + The Type.EmptyTypes field is not available on + the .NET Compact Framework 1.0. + + + + + + The fully qualified type of the SystemInfo class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Cache the host name for the current machine + + + + + Cache the application friendly name + + + + + Text to output when a null is encountered. + + + + + Text to output when an unsupported feature is requested. + + + + + Start time for the current process. + + + + + Gets the system dependent line terminator. + + + The system dependent line terminator. + + + + Gets the system dependent line terminator. + + + + + + Gets the base directory for this . + + The base directory path for the current . + + + Gets the base directory for this . + + + The value returned may be either a local file path or a URI. + + + + + + Gets the path to the configuration file for the current . + + The path to the configuration file for the current . + + + The .NET Compact Framework 1.0 does not have a concept of a configuration + file. For this runtime, we use the entry assembly location as the root for + the configuration file name. + + + The value returned may be either a local file path or a URI. + + + + + + Gets the path to the file that first executed in the current . + + The path to the entry assembly. + + + Gets the path to the file that first executed in the current . + + + + + + Gets the ID of the current thread. + + The ID of the current thread. + + + On the .NET framework, the AppDomain.GetCurrentThreadId method + is used to obtain the thread ID for the current thread. This is the + operating system ID for the thread. + + + On the .NET Compact Framework 1.0 it is not possible to get the + operating system thread ID for the current thread. The native method + GetCurrentThreadId is implemented inline in a header file + and cannot be called. + + + On the .NET Framework 2.0 the Thread.ManagedThreadId is used as this + gives a stable id unrelated to the operating system thread ID which may + change if the runtime is using fibers. + + + + + + Get the host name or machine name for the current machine + + + The hostname or machine name + + + + Get the host name or machine name for the current machine + + + The host name () or + the machine name (Environment.MachineName) for + the current machine, or if neither of these are available + then NOT AVAILABLE is returned. + + + + + + Get this application's friendly name + + + The friendly name of this application as a string + + + + If available the name of the application is retrieved from + the AppDomain using AppDomain.CurrentDomain.FriendlyName. + + + Otherwise the file name of the entry assembly is used. + + + + + + Get the start time for the current process. + + + + This is the time at which the log4net library was loaded into the + AppDomain. Due to reports of a hang in the call to System.Diagnostics.Process.StartTime + this is not the start time for the current process. + + + The log4net library should be loaded by an application early during its + startup, therefore this start time should be a good approximation for + the actual start time. + + + Note that AppDomains may be loaded and unloaded within the + same process without the process terminating, however this start time + will be set per AppDomain. + + + + + + Text to output when a null is encountered. + + + + Use this value to indicate a null has been encountered while + outputting a string representation of an item. + + + The default value is (null). This value can be overridden by specifying + a value for the log4net.NullText appSetting in the application's + .config file. + + + + + + Text to output when an unsupported feature is requested. + + + + Use this value when an unsupported feature is requested. + + + The default value is NOT AVAILABLE. This value can be overridden by specifying + a value for the log4net.NotAvailableText appSetting in the application's + .config file. + + + + + + Utility class that represents a format string. + + + + Utility class that represents a format string. + + + Nicko Cadell + + + + Initialise the + + An that supplies culture-specific formatting information. + A containing zero or more format items. + An array containing zero or more objects to format. + + + + Format the string and arguments + + the formatted string + + + + Replaces the format item in a specified with the text equivalent + of the value of a corresponding instance in a specified array. + A specified parameter supplies culture-specific formatting information. + + An that supplies culture-specific formatting information. + A containing zero or more format items. + An array containing zero or more objects to format. + + A copy of format in which the format items have been replaced by the + equivalent of the corresponding instances of in args. + + + + This method does not throw exceptions. If an exception thrown while formatting the result the + exception and arguments are returned in the result string. + + + + + + Process an error during StringFormat + + + + + Dump the contents of an array into a string builder + + + + + Dump an object to a string + + + + + The fully qualified type of the SystemStringFormat class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Implementation of Properties collection for the + + + + Class implements a collection of properties that is specific to each thread. + The class is not synchronized as each thread has its own . + + + Nicko Cadell + + + + Each thread will automatically have its instance. + + + + + Internal constructor + + + + Initializes a new instance of the class. + + + + + + Remove a property + + the key for the entry to remove + + + Remove a property + + + + + + Get the keys stored in the properties. + + + Gets the keys stored in the properties. + + a set of the defined keys + + + + Clear all properties + + + + Clear all properties + + + + + + Get the PropertiesDictionary for this thread. + + create the dictionary if it does not exist, otherwise return null if does not exist + the properties for this thread + + + The collection returned is only to be used on the calling thread. If the + caller needs to share the collection between different threads then the + caller must clone the collection before doing so. + + + + + + Gets or sets the value of a property + + + The value for the property with the specified key + + + + Gets or sets the value of a property + + + + + + Implementation of Stack for the + + + + Implementation of Stack for the + + + Nicko Cadell + + + + The stack store. + + + + + Internal constructor + + + + Initializes a new instance of the class. + + + + + + Clears all the contextual information held in this stack. + + + + Clears all the contextual information held in this stack. + Only call this if you think that this tread is being reused after + a previous call execution which may not have completed correctly. + You do not need to use this method if you always guarantee to call + the method of the + returned from even in exceptional circumstances, + for example by using the using(log4net.ThreadContext.Stacks["NDC"].Push("Stack_Message")) + syntax. + + + + + + Removes the top context from this stack. + + The message in the context that was removed from the top of this stack. + + + Remove the top context from this stack, and return + it to the caller. If this stack is empty then an + empty string (not ) is returned. + + + + + + Pushes a new context message into this stack. + + The new context message. + + An that can be used to clean up the context stack. + + + + Pushes a new context onto this stack. An + is returned that can be used to clean up this stack. This + can be easily combined with the using keyword to scope the + context. + + + Simple example of using the Push method with the using keyword. + + using(log4net.ThreadContext.Stacks["NDC"].Push("Stack_Message")) + { + log.Warn("This should have an ThreadContext Stack message"); + } + + + + + + Gets the current context information for this stack. + + The current context information. + + + + Gets the current context information for this stack. + + Gets the current context information + + + Gets the current context information for this stack. + + + + + + Get a portable version of this object + + the portable instance of this object + + + Get a cross thread portable version of this object + + + + + + The number of messages in the stack + + + The current number of messages in the stack + + + + The current number of messages in the stack. That is + the number of times has been called + minus the number of times has been called. + + + + + + Gets and sets the internal stack used by this + + The internal storage stack + + + This property is provided only to support backward compatability + of the . Tytpically the internal stack should not + be modified. + + + + + + Inner class used to represent a single context frame in the stack. + + + + Inner class used to represent a single context frame in the stack. + + + + + + Constructor + + The message for this context. + The parent context in the chain. + + + Initializes a new instance of the class + with the specified message and parent context. + + + + + + Get the message. + + The message. + + + Get the message. + + + + + + Gets the full text of the context down to the root level. + + + The full text of the context down to the root level. + + + + Gets the full text of the context down to the root level. + + + + + + Struct returned from the method. + + + + This struct implements the and is designed to be used + with the pattern to remove the stack frame at the end of the scope. + + + + + + The ThreadContextStack internal stack + + + + + The depth to trim the stack to when this instance is disposed + + + + + Constructor + + The internal stack used by the ThreadContextStack. + The depth to return the stack to when this object is disposed. + + + Initializes a new instance of the class with + the specified stack and return depth. + + + + + + Returns the stack to the correct depth. + + + + Returns the stack to the correct depth. + + + + + + Implementation of Stacks collection for the + + + + Implementation of Stacks collection for the + + + Nicko Cadell + + + + Internal constructor + + + + Initializes a new instance of the class. + + + + + + The fully qualified type of the ThreadContextStacks class. + + + Used by the internal logger to record the Type of the + log message. + + + + + Gets the named thread context stack + + + The named stack + + + + Gets the named thread context stack + + + + + + Utility class for transforming strings. + + + + Utility class for transforming strings. + + + Nicko Cadell + Gert Driesen + + + + Initializes a new instance of the class. + + + + Uses a private access modifier to prevent instantiation of this class. + + + + + + Write a string to an + + the writer to write to + the string to write + The string to replace non XML compliant chars with + + + The test is escaped either using XML escape entities + or using CDATA sections. + + + + + + Replace invalid XML characters in text string + + the XML text input string + the string to use in place of invalid characters + A string that does not contain invalid XML characters. + + + Certain Unicode code points are not allowed in the XML InfoSet, for + details see: http://www.w3.org/TR/REC-xml/#charsets. + + + This method replaces any illegal characters in the input string + with the mask string specified. + + + + + + Count the number of times that the substring occurs in the text + + the text to search + the substring to find + the number of times the substring occurs in the text + + + The substring is assumed to be non repeating within itself. + + + + + + Characters illegal in XML 1.0 + + + + + Impersonate a Windows Account + + + + This impersonates a Windows account. + + + How the impersonation is done depends on the value of . + This allows the context to either impersonate a set of user credentials specified + using username, domain name and password or to revert to the process credentials. + + + + + + Default constructor + + + + Default constructor + + + + + + Initialize the SecurityContext based on the options set. + + + + This is part of the delayed object + activation scheme. The method must + be called on this object after the configuration properties have + been set. Until is called this + object is in an undefined state and must not be used. + + + If any of the configuration properties are modified then + must be called again. + + + The security context will try to Logon the specified user account and + capture a primary token for impersonation. + + + The required , + or properties were not specified. + + + + Impersonate the Windows account specified by the and properties. + + caller provided state + + An instance that will revoke the impersonation of this SecurityContext + + + + Depending on the property either + impersonate a user using credentials supplied or revert + to the process credentials. + + + + + + Create a given the userName, domainName and password. + + the user name + the domain name + the password + the for the account specified + + + Uses the Windows API call LogonUser to get a principal token for the account. This + token is used to initialize the WindowsIdentity. + + + + + + Gets or sets the impersonation mode for this security context + + + The impersonation mode for this security context + + + + Impersonate either a user with user credentials or + revert this thread to the credentials of the process. + The value is one of the + enum. + + + The default value is + + + When the mode is set to + the user's credentials are established using the + , and + values. + + + When the mode is set to + no other properties need to be set. If the calling thread is + impersonating then it will be reverted back to the process credentials. + + + + + + Gets or sets the Windows username for this security context + + + The Windows username for this security context + + + + This property must be set if + is set to (the default setting). + + + + + + Gets or sets the Windows domain name for this security context + + + The Windows domain name for this security context + + + + The default value for is the local machine name + taken from the property. + + + This property must be set if + is set to (the default setting). + + + + + + Sets the password for the Windows account specified by the and properties. + + + The password for the Windows account specified by the and properties. + + + + This property must be set if + is set to (the default setting). + + + + + + The impersonation modes for the + + + + See the property for + details. + + + + + + Impersonate a user using the credentials supplied + + + + + Revert this the thread to the credentials of the process + + + + + Adds to + + + + Helper class to expose the + through the interface. + + + + + + Constructor + + the impersonation context being wrapped + + + Constructor + + + + + + Revert the impersonation + + + + Revert the impersonation + + + + + + The log4net Global Context. + + + + The GlobalContext provides a location for global debugging + information to be stored. + + + The global context has a properties map and these properties can + be included in the output of log messages. The + supports selecting and outputing these properties. + + + By default the log4net:HostName property is set to the name of + the current machine. + + + + + GlobalContext.Properties["hostname"] = Environment.MachineName; + + + + Nicko Cadell + + + + Private Constructor. + + + Uses a private access modifier to prevent instantiation of this class. + + + + + The global context properties instance + + + + + The global properties map. + + + The global properties map. + + + + The global properties map. + + + + + + Provides information about the environment the assembly has + been built for. + + + + Version of the assembly + + + Version of the framework targeted + + + Type of framework targeted + + + Does it target a client profile? + + + + Identifies the version and target for this assembly. + + + + + The log4net Logical Thread Context. + + + + The LogicalThreadContext provides a location for specific debugging + information to be stored. + The LogicalThreadContext properties override any or + properties with the same name. + + + The Logical Thread Context has a properties map and a stack. + The properties and stack can + be included in the output of log messages. The + supports selecting and outputting these properties. + + + The Logical Thread Context provides a diagnostic context for the current call context. + This is an instrument for distinguishing interleaved log + output from different sources. Log output is typically interleaved + when a server handles multiple clients near-simultaneously. + + + The Logical Thread Context is managed on a per basis. + + + The requires a link time + for the + . + If the calling code does not have this permission then this context will be disabled. + It will not store any property values set on it. + + + Example of using the thread context properties to store a username. + + LogicalThreadContext.Properties["user"] = userName; + log.Info("This log message has a LogicalThreadContext Property called 'user'"); + + + Example of how to push a message into the context stack + + using(LogicalThreadContext.Stacks["LDC"].Push("my context message")) + { + log.Info("This log message has a LogicalThreadContext Stack message that includes 'my context message'"); + + } // at the end of the using block the message is automatically popped + + + + Nicko Cadell + + + + Private Constructor. + + + + Uses a private access modifier to prevent instantiation of this class. + + + + + + The thread context properties instance + + + + + The thread context stacks instance + + + + + The thread properties map + + + The thread properties map + + + + The LogicalThreadContext properties override any + or properties with the same name. + + + + + + The thread stacks + + + stack map + + + + The logical thread stacks. + + + + + + This class is used by client applications to request logger instances. + + + + This class has static methods that are used by a client to request + a logger instance. The method is + used to retrieve a logger. + + + See the interface for more details. + + + Simple example of logging messages + + ILog log = LogManager.GetLogger("application-log"); + + log.Info("Application Start"); + log.Debug("This is a debug message"); + + if (log.IsDebugEnabled) + { + log.Debug("This is another debug message"); + } + + + + + Nicko Cadell + Gert Driesen + + + + Initializes a new instance of the class. + + + Uses a private access modifier to prevent instantiation of this class. + + + + Returns the named logger if it exists. + + Returns the named logger if it exists. + + + + If the named logger exists (in the default repository) then it + returns a reference to the logger, otherwise it returns null. + + + The fully qualified logger name to look for. + The logger found, or null if no logger could be found. + + + + Returns the named logger if it exists. + + + + If the named logger exists (in the specified repository) then it + returns a reference to the logger, otherwise it returns + null. + + + The repository to lookup in. + The fully qualified logger name to look for. + + The logger found, or null if the logger doesn't exist in the specified + repository. + + + + + Returns the named logger if it exists. + + + + If the named logger exists (in the repository for the specified assembly) then it + returns a reference to the logger, otherwise it returns + null. + + + The assembly to use to lookup the repository. + The fully qualified logger name to look for. + + The logger, or null if the logger doesn't exist in the specified + assembly's repository. + + + + Get the currently defined loggers. + + Returns all the currently defined loggers in the default repository. + + + The root logger is not included in the returned array. + + All the defined loggers. + + + + Returns all the currently defined loggers in the specified repository. + + The repository to lookup in. + + The root logger is not included in the returned array. + + All the defined loggers. + + + + Returns all the currently defined loggers in the specified assembly's repository. + + The assembly to use to lookup the repository. + + The root logger is not included in the returned array. + + All the defined loggers. + + + Get or create a logger. + + Retrieves or creates a named logger. + + + + Retrieves a logger named as the + parameter. If the named logger already exists, then the + existing instance will be returned. Otherwise, a new instance is + created. + + By default, loggers do not have a set level but inherit + it from the hierarchy. This is one of the central features of + log4net. + + + The name of the logger to retrieve. + The logger with the name specified. + + + + Retrieves or creates a named logger. + + + + Retrieve a logger named as the + parameter. If the named logger already exists, then the + existing instance will be returned. Otherwise, a new instance is + created. + + + By default, loggers do not have a set level but inherit + it from the hierarchy. This is one of the central features of + log4net. + + + The repository to lookup in. + The name of the logger to retrieve. + The logger with the name specified. + + + + Retrieves or creates a named logger. + + + + Retrieve a logger named as the + parameter. If the named logger already exists, then the + existing instance will be returned. Otherwise, a new instance is + created. + + + By default, loggers do not have a set level but inherit + it from the hierarchy. This is one of the central features of + log4net. + + + The assembly to use to lookup the repository. + The name of the logger to retrieve. + The logger with the name specified. + + + + Shorthand for . + + + Get the logger for the fully qualified name of the type specified. + + The full name of will be used as the name of the logger to retrieve. + The logger with the name specified. + + + + Shorthand for . + + + Gets the logger for the fully qualified name of the type specified. + + The repository to lookup in. + The full name of will be used as the name of the logger to retrieve. + The logger with the name specified. + + + + Shorthand for . + + + Gets the logger for the fully qualified name of the type specified. + + The assembly to use to lookup the repository. + The full name of will be used as the name of the logger to retrieve. + The logger with the name specified. + + + + Shuts down the log4net system. + + + + Calling this method will safely close and remove all + appenders in all the loggers including root contained in all the + default repositories. + + + Some appenders need to be closed before the application exists. + Otherwise, pending logging events might be lost. + + The shutdown method is careful to close nested + appenders before closing regular appenders. This is allows + configurations where a regular appender is attached to a logger + and again to a nested appender. + + + + + Shutdown a logger repository. + + Shuts down the default repository. + + + + Calling this method will safely close and remove all + appenders in all the loggers including root contained in the + default repository. + + Some appenders need to be closed before the application exists. + Otherwise, pending logging events might be lost. + + The shutdown method is careful to close nested + appenders before closing regular appenders. This is allows + configurations where a regular appender is attached to a logger + and again to a nested appender. + + + + + + Shuts down the repository for the repository specified. + + + + Calling this method will safely close and remove all + appenders in all the loggers including root contained in the + specified. + + + Some appenders need to be closed before the application exists. + Otherwise, pending logging events might be lost. + + The shutdown method is careful to close nested + appenders before closing regular appenders. This is allows + configurations where a regular appender is attached to a logger + and again to a nested appender. + + + The repository to shutdown. + + + + Shuts down the repository specified. + + + + Calling this method will safely close and remove all + appenders in all the loggers including root contained in the + repository. The repository is looked up using + the specified. + + + Some appenders need to be closed before the application exists. + Otherwise, pending logging events might be lost. + + + The shutdown method is careful to close nested + appenders before closing regular appenders. This is allows + configurations where a regular appender is attached to a logger + and again to a nested appender. + + + The assembly to use to lookup the repository. + + + Reset the configuration of a repository + + Resets all values contained in this repository instance to their defaults. + + + + Resets all values contained in the repository instance to their + defaults. This removes all appenders from all loggers, sets + the level of all non-root loggers to null, + sets their additivity flag to true and sets the level + of the root logger to . Moreover, + message disabling is set to its default "off" value. + + + + + + Resets all values contained in this repository instance to their defaults. + + + + Reset all values contained in the repository instance to their + defaults. This removes all appenders from all loggers, sets + the level of all non-root loggers to null, + sets their additivity flag to true and sets the level + of the root logger to . Moreover, + message disabling is set to its default "off" value. + + + The repository to reset. + + + + Resets all values contained in this repository instance to their defaults. + + + + Reset all values contained in the repository instance to their + defaults. This removes all appenders from all loggers, sets + the level of all non-root loggers to null, + sets their additivity flag to true and sets the level + of the root logger to . Moreover, + message disabling is set to its default "off" value. + + + The assembly to use to lookup the repository to reset. + + + Get the logger repository. + + Returns the default instance. + + + + Gets the for the repository specified + by the callers assembly (). + + + The instance for the default repository. + + + + Returns the default instance. + + The default instance. + + + Gets the for the repository specified + by the argument. + + + The repository to lookup in. + + + + Returns the default instance. + + The default instance. + + + Gets the for the repository specified + by the argument. + + + The assembly to use to lookup the repository. + + + Get a logger repository. + + Returns the default instance. + + + + Gets the for the repository specified + by the callers assembly (). + + + The instance for the default repository. + + + + Returns the default instance. + + The default instance. + + + Gets the for the repository specified + by the argument. + + + The repository to lookup in. + + + + Returns the default instance. + + The default instance. + + + Gets the for the repository specified + by the argument. + + + The assembly to use to lookup the repository. + + + Create a domain + + Creates a repository with the specified repository type. + + + + CreateDomain is obsolete. Use CreateRepository instead of CreateDomain. + + + The created will be associated with the repository + specified such that a call to will return + the same repository instance. + + + A that implements + and has a no arg constructor. An instance of this type will be created to act + as the for the repository specified. + The created for the repository. + + + Create a logger repository. + + Creates a repository with the specified repository type. + + A that implements + and has a no arg constructor. An instance of this type will be created to act + as the for the repository specified. + The created for the repository. + + + The created will be associated with the repository + specified such that a call to will return + the same repository instance. + + + + + + Creates a repository with the specified name. + + + + CreateDomain is obsolete. Use CreateRepository instead of CreateDomain. + + + Creates the default type of which is a + object. + + + The name must be unique. Repositories cannot be redefined. + An will be thrown if the repository already exists. + + + The name of the repository, this must be unique amongst repositories. + The created for the repository. + The specified repository already exists. + + + + Creates a repository with the specified name. + + + + Creates the default type of which is a + object. + + + The name must be unique. Repositories cannot be redefined. + An will be thrown if the repository already exists. + + + The name of the repository, this must be unique amongst repositories. + The created for the repository. + The specified repository already exists. + + + + Creates a repository with the specified name and repository type. + + + + CreateDomain is obsolete. Use CreateRepository instead of CreateDomain. + + + The name must be unique. Repositories cannot be redefined. + An will be thrown if the repository already exists. + + + The name of the repository, this must be unique to the repository. + A that implements + and has a no arg constructor. An instance of this type will be created to act + as the for the repository specified. + The created for the repository. + The specified repository already exists. + + + + Creates a repository with the specified name and repository type. + + + + The name must be unique. Repositories cannot be redefined. + An will be thrown if the repository already exists. + + + The name of the repository, this must be unique to the repository. + A that implements + and has a no arg constructor. An instance of this type will be created to act + as the for the repository specified. + The created for the repository. + The specified repository already exists. + + + + Creates a repository for the specified assembly and repository type. + + + + CreateDomain is obsolete. Use CreateRepository instead of CreateDomain. + + + The created will be associated with the repository + specified such that a call to with the + same assembly specified will return the same repository instance. + + + The assembly to use to get the name of the repository. + A that implements + and has a no arg constructor. An instance of this type will be created to act + as the for the repository specified. + The created for the repository. + + + + Creates a repository for the specified assembly and repository type. + + + + The created will be associated with the repository + specified such that a call to with the + same assembly specified will return the same repository instance. + + + The assembly to use to get the name of the repository. + A that implements + and has a no arg constructor. An instance of this type will be created to act + as the for the repository specified. + The created for the repository. + + + + Gets the list of currently defined repositories. + + + + Get an array of all the objects that have been created. + + + An array of all the known objects. + + + + Looks up the wrapper object for the logger specified. + + The logger to get the wrapper for. + The wrapper for the logger specified. + + + + Looks up the wrapper objects for the loggers specified. + + The loggers to get the wrappers for. + The wrapper objects for the loggers specified. + + + + Create the objects used by + this manager. + + The logger to wrap. + The wrapper for the logger specified. + + + + The wrapper map to use to hold the objects. + + + + + Implementation of Mapped Diagnostic Contexts. + + + + + The MDC is deprecated and has been replaced by the . + The current MDC implementation forwards to the ThreadContext.Properties. + + + + The MDC class is similar to the class except that it is + based on a map instead of a stack. It provides mapped + diagnostic contexts. A Mapped Diagnostic Context, or + MDC in short, is an instrument for distinguishing interleaved log + output from different sources. Log output is typically interleaved + when a server handles multiple clients near-simultaneously. + + + The MDC is managed on a per thread basis. + + + + Nicko Cadell + Gert Driesen + + + + Initializes a new instance of the class. + + + Uses a private access modifier to prevent instantiation of this class. + + + + + Gets the context value identified by the parameter. + + The key to lookup in the MDC. + The string value held for the key, or a null reference if no corresponding value is found. + + + + The MDC is deprecated and has been replaced by the . + The current MDC implementation forwards to the ThreadContext.Properties. + + + + If the parameter does not look up to a + previously defined context then null will be returned. + + + + + + Add an entry to the MDC + + The key to store the value under. + The value to store. + + + + The MDC is deprecated and has been replaced by the . + The current MDC implementation forwards to the ThreadContext.Properties. + + + + Puts a context value (the parameter) as identified + with the parameter into the current thread's + context map. + + + If a value is already defined for the + specified then the value will be replaced. If the + is specified as null then the key value mapping will be removed. + + + + + + Removes the key value mapping for the key specified. + + The key to remove. + + + + The MDC is deprecated and has been replaced by the . + The current MDC implementation forwards to the ThreadContext.Properties. + + + + Remove the specified entry from this thread's MDC + + + + + + Clear all entries in the MDC + + + + + The MDC is deprecated and has been replaced by the . + The current MDC implementation forwards to the ThreadContext.Properties. + + + + Remove all the entries from this thread's MDC + + + + + + Implementation of Nested Diagnostic Contexts. + + + + + The NDC is deprecated and has been replaced by the . + The current NDC implementation forwards to the ThreadContext.Stacks["NDC"]. + + + + A Nested Diagnostic Context, or NDC in short, is an instrument + to distinguish interleaved log output from different sources. Log + output is typically interleaved when a server handles multiple + clients near-simultaneously. + + + Interleaved log output can still be meaningful if each log entry + from different contexts had a distinctive stamp. This is where NDCs + come into play. + + + Note that NDCs are managed on a per thread basis. The NDC class + is made up of static methods that operate on the context of the + calling thread. + + + How to push a message into the context + + using(NDC.Push("my context message")) + { + ... all log calls will have 'my context message' included ... + + } // at the end of the using block the message is automatically removed + + + + Nicko Cadell + Gert Driesen + + + + Initializes a new instance of the class. + + + Uses a private access modifier to prevent instantiation of this class. + + + + + Clears all the contextual information held on the current thread. + + + + + The NDC is deprecated and has been replaced by the . + The current NDC implementation forwards to the ThreadContext.Stacks["NDC"]. + + + + Clears the stack of NDC data held on the current thread. + + + + + + Creates a clone of the stack of context information. + + A clone of the context info for this thread. + + + + The NDC is deprecated and has been replaced by the . + The current NDC implementation forwards to the ThreadContext.Stacks["NDC"]. + + + + The results of this method can be passed to the + method to allow child threads to inherit the context of their + parent thread. + + + + + + Inherits the contextual information from another thread. + + The context stack to inherit. + + + + The NDC is deprecated and has been replaced by the . + The current NDC implementation forwards to the ThreadContext.Stacks["NDC"]. + + + + This thread will use the context information from the stack + supplied. This can be used to initialize child threads with + the same contextual information as their parent threads. These + contexts will NOT be shared. Any further contexts that + are pushed onto the stack will not be visible to the other. + Call to obtain a stack to pass to + this method. + + + + + + Removes the top context from the stack. + + + The message in the context that was removed from the top + of the stack. + + + + + The NDC is deprecated and has been replaced by the . + The current NDC implementation forwards to the ThreadContext.Stacks["NDC"]. + + + + Remove the top context from the stack, and return + it to the caller. If the stack is empty then an + empty string (not null) is returned. + + + + + + Pushes a new context message. + + The new context message. + + An that can be used to clean up + the context stack. + + + + + The NDC is deprecated and has been replaced by the . + The current NDC implementation forwards to the ThreadContext.Stacks["NDC"]. + + + + Pushes a new context onto the context stack. An + is returned that can be used to clean up the context stack. This + can be easily combined with the using keyword to scope the + context. + + + Simple example of using the Push method with the using keyword. + + using(log4net.NDC.Push("NDC_Message")) + { + log.Warn("This should have an NDC message"); + } + + + + + + Removes the context information for this thread. It is + not required to call this method. + + + + + The NDC is deprecated and has been replaced by the . + The current NDC implementation forwards to the ThreadContext.Stacks["NDC"]. + + + + This method is not implemented. + + + + + + Forces the stack depth to be at most . + + The maximum depth of the stack + + + + The NDC is deprecated and has been replaced by the . + The current NDC implementation forwards to the ThreadContext.Stacks["NDC"]. + + + + Forces the stack depth to be at most . + This may truncate the head of the stack. This only affects the + stack in the current thread. Also it does not prevent it from + growing, it only sets the maximum depth at the time of the + call. This can be used to return to a known context depth. + + + + + + Gets the current context depth. + + The current context depth. + + + + The NDC is deprecated and has been replaced by the . + The current NDC implementation forwards to the ThreadContext.Stacks["NDC"]. + + + + The number of context values pushed onto the context stack. + + + Used to record the current depth of the context. This can then + be restored using the method. + + + + + + + The log4net Thread Context. + + + + The ThreadContext provides a location for thread specific debugging + information to be stored. + The ThreadContext properties override any + properties with the same name. + + + The thread context has a properties map and a stack. + The properties and stack can + be included in the output of log messages. The + supports selecting and outputting these properties. + + + The Thread Context provides a diagnostic context for the current thread. + This is an instrument for distinguishing interleaved log + output from different sources. Log output is typically interleaved + when a server handles multiple clients near-simultaneously. + + + The Thread Context is managed on a per thread basis. + + + Example of using the thread context properties to store a username. + + ThreadContext.Properties["user"] = userName; + log.Info("This log message has a ThreadContext Property called 'user'"); + + + Example of how to push a message into the context stack + + using(ThreadContext.Stacks["NDC"].Push("my context message")) + { + log.Info("This log message has a ThreadContext Stack message that includes 'my context message'"); + + } // at the end of the using block the message is automatically popped + + + + Nicko Cadell + + + + Private Constructor. + + + + Uses a private access modifier to prevent instantiation of this class. + + + + + + The thread context properties instance + + + + + The thread context stacks instance + + + + + The thread properties map + + + The thread properties map + + + + The ThreadContext properties override any + properties with the same name. + + + + + + The thread stacks + + + stack map + + + + The thread local stacks. + + + + +