Here are the classes, structs, unions and interfaces with brief descriptions:
| NExamples | |
| NOnPremise | |
| NAreas | |
| CCalculations | Used to work out the common values for areas in the examples |
| CRectangle | |
| CResult | The result of an area calculation |
| NFiftyOne | |
| NIpIntelligence | |
| NCloud | |
| NData | |
| CCloudCountriesTranslationData | Cloud counterpart of the on-premise FiftyOne.IpIntelligence.Translation.Data.CountriesTranslationData |
| CIpDataCloud | A data class that makes working with IP data from cloud services easier for the user |
| NFlowElements | |
| CCloudCountriesTranslationEngine | Cloud counterpart of the on-premise FiftyOne.IpIntelligence.Translation.FlowElements.CountriesTranslationEngine |
| CCloudCountriesTranslationEngineBuilder | Fluent builder used to create a cloud-based countries translation engine for IP intelligence country name translations |
| CIpiCloudEngine | Engine that takes the JSON response from the CloudRequestEngine and uses it populate a IpDataCloud instance for easier consumption |
| CIpiCloudEngineBuilder | Fluent builder used to create a cloud-based IP intelligence engine |
| NEngine | |
| NOnPremise | |
| NData | |
| CComponentMetaData | Data class that contains meta-data relating to a specific component |
| CComponentMetaDataIpi | Data class that contains meta-data relating to a specific component |
| CFiftyOneAspectPropertyMetaDataIpi | Data class that contains meta-data relating to a specific property |
| CIIpDataOnPremise | Represents a data class that contains IP data from an on-premise IP intelligence engine |
| CProfileMetaData | Data class that contains meta-data relating to a specific profile |
| CPropertyMetaDataIpi | Data class that contains meta-data relating to a specific property |
| CValueMetaData | Data class that contains meta-data relating to a specific value |
| NFlowElements | |
| CIpiOnPremiseEngine | IP intelligence engine |
| CIpiOnPremiseEngineBuilder | Builder for the IpiOnPremiseEngine |
| CIpiOnPremiseEngineBuilderBase< TEngine > | Builder for the IpiOnPremiseEngine |
| NInterop | |
| CIpIntelligenceEngineModule | |
| CIpIntelligenceEngineModulePINVOKE | |
| CSWIGExceptionHelper | |
| CSWIGPendingException | |
| CSWIGStringHelper | |
| CSWIGStringWithLengthHelper | |
| CSWIGTYPE_p_byte | |
| CUTF8Marshaler | A UTF-8 encoding Marshaler to marshal the string being passed between C# and C/C++ layer as UTF-8 encoded |
| NExample | |
| NTests | |
| NCloud | |
| COldEnvironmentNamesTests | Tests that the examples still read the resource key, the data file path and the cloud endpoint from the old names of their environment variables when the new name is not set |
| CTestCloudExamples | Runs the Cloud examples against the real 51Degrees Cloud service (cloud.51degrees.com by default) |
| CTestCloudMixedWebExample | Runs the combined (device detection + IP intelligence) Cloud GettingStarted-Web example in-process against the real 51Degrees Cloud service, then drives it over HTTP exactly as a browser would and asserts the rendered page contains the combined-results layout |
| CTestCloudWebExample | Runs the Cloud GettingStarted-Web example in-process (via its Program.Run entry point, which the example exposes specifically for tests) against the real 51Degrees Cloud service, then drives it over HTTP exactly as a browser would and asserts the rendered page contains the expected IP Intelligence results for a known IP address |
| NOnPremise | |
| CTestAreas | |
| CTestCategories | Test category names used with [TestCategory(...)] so that CI can filter test runs, e.g |
| CTestCompareBadTruths | Checks that a truth record the Compare example can not read or compare is logged and skipped, and the records after it are still compared |
| CTestCompareOddIps | Checks that the IP address values System.Net.IPAddress accepts but which are not ordinary addresses, such as a single number or an address with a scope, pass through the engine without an exception |
| CTestExamples | This test class ensures that the on-premise examples execute successfully and, where practical, produce the output a user would expect |
| CTestExamplesWithoutSettings | Runs each console example as someone who has just cloned the repository does, through its Main method with no arguments and none of the settings the other tests are given |
| CTestGettingStartedOnPremise | End-to-end "happy path" tests for on-premise IP Intelligence that go beyond the smoke tests in TestExamples by asserting on the actual detection results for known IP addresses |
| NExamples | |
| NCloud | |
| NGetAllProperties | |
| CProgram | |
| CExample | |
| NGettingStartedConsole | |
| CProgram | |
| CExample | |
| NGettingStartedWeb | |
| NControllers | |
| CHomeController | |
| NModel | |
| CEvidenceModel | |
| CIndexModel | |
| NPages | |
| CIndexModel | |
| CProgram | |
| CStartup | |
| NMetadata | |
| CProgram | |
| CExample | |
| NMixed | |
| NGettingStartedConsole | |
| CProgram | |
| CExample | |
| CPipelineOptionsExtensions | |
| NMixed | |
| NCloud | |
| NGettingStartedConsole | |
| CConstants | |
| NGettingStartedWeb | |
| NControllers | |
| CHomeController | |
| NModel | |
| CEvidenceModel | |
| CIndexModel | |
| CProgram | |
| CStartup | |
| NOnPremise | |
| NGettingStartedConsole | |
| CConstants | |
| CProgram | |
| CExample | |
| NGettingStartedWeb | |
| NControllers | |
| CHomeController | |
| NModel | |
| CEvidenceModel | |
| CIndexModel | |
| CProgram | |
| CStartup | |
| CPipelineOptionsExtensions | |
| NOnPremise | |
| NCompare | |
| CProgram | |
| CTruth | A record of latitude, longitude, IP address, and a date time that is considered truthful for the purposes of comparing with an IP to location solution result |
| CSkippedTruths | Records the truth records that were skipped because they could not be read or compared |
| CResult | |
| COutput | Classes used when writing out the CSV file both the truth provided and the result from the IP Intelligence service |
| CConsumer | Wrapper for a consumer task that returns a list of records |
| CConfiguration | Configuration passed to the worker host service via dependency injection |
| CWorker | BackgroundService for running the Example |
| CExample | Implementation of the example that can be called from the Program's main method or any other consuming service |
| NGettingStartedAPI | |
| NTests | |
| CLocalMockingTest | |
| CNativeEngineLoadTests | Focused pre-flight checks for the native IP Intelligence engine that this project loads through its ASP.NET Core reference to GettingStarted-API |
| CProgram | Local version of IPI API |
| NGettingStartedConsole | |
| CProgram | |
| CExample | |
| NGettingStartedWeb | |
| NControllers | |
| CHomeController | |
| NModel | |
| CEvidenceModel | |
| CIndexModel | |
| NPages | |
| CIndexModel | |
| CProgram | |
| CStartup | |
| NLocationAnalysis | |
| CProgram | |
| CGroup | The metrics recorded for a single combination of the group key field values |
| CGroupField | A group key field together with a flag indicating whether the property is present in the data file being analyzed |
| CExample | Implementation of the example that can be called from the Program's main method or any other consuming service such as a test |
| NMetadata | |
| CProgram | |
| CExample | |
| NMetrics | |
| CExtensions | |
| CProgram | |
| CCounter | |
| CMetric | |
| CKey | Key used for each metric |
| CKeyFactory | Factory used to create Key |
| CConsumer | |
| CAreaIndex | |
| CConfiguration | |
| CWorker | |
| CExample | |
| NOfflineProcessing | |
| CProgram | |
| CExample | |
| NPerformance | |
| CPerformanceConfiguration | |
| CProgram | |
| CBenchmarkResult | |
| CExample | |
| NSuspicious | |
| CProgram | |
| CExample | |
| NUpdateDataFile | |
| CCompletionListener | Helper class used to wait for data updates to complete and return the status of the update |
| CProgram | |
| CExample | |
| CExampleUtils | |
| CPipelineOptionsExtensions | |
| CConstants | |
| CDataExtensions | |
| CDataFileInfo | |
| CExampleBase | |
| CExampleOptions | |
| CExampleUtils | |
| CPipelineOptionsExtensions | |
| CIpiCloudPipelineBuilder | Builder used to create pipelines with an cloud-based IP intelligence engine |
| CIpiOnPremisePipelineBuilder | Builder used to create pipelines with an on-premise IP intelligence engine |
| CIpiPipelineBuilder | Builder used to create a Pipeline with a IP intelligence engine |
| NFramework_Web | |
| CDefault | |
| CGlobal |
