From 32c65f0ae1071578caf65489e0953f24b8a2023c Mon Sep 17 00:00:00 2001 From: Bryn Lewis Date: Wed, 11 Nov 2026 12:52:51 +1300 Subject: [PATCH 1/4] Add Visual Studio .gitignore rules --- csharp/.gitignore | 425 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 425 insertions(+) create mode 100644 csharp/.gitignore diff --git a/csharp/.gitignore b/csharp/.gitignore new file mode 100644 index 0000000..10ad875 --- /dev/null +++ b/csharp/.gitignore @@ -0,0 +1,425 @@ +## 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/main/VisualStudio.gitignore + +# User-specific files +*.rsuser +*.suo +*.user +*.userosscache +*.sln.docstates +*.env + +# User-specific files (MonoDevelop/Xamarin Studio) +*.userprefs + +# Mono auto generated files +mono_crash.* + +# Build results +[Dd]ebug/ +[Dd]ebugPublic/ +[Rr]elease/ +[Rr]eleases/ + +[Dd]ebug/x64/ +[Dd]ebugPublic/x64/ +[Rr]elease/x64/ +[Rr]eleases/x64/ +bin/x64/ +obj/x64/ + +[Dd]ebug/x86/ +[Dd]ebugPublic/x86/ +[Rr]elease/x86/ +[Rr]eleases/x86/ +bin/x86/ +obj/x86/ + +[Ww][Ii][Nn]32/ +[Aa][Rr][Mm]/ +[Aa][Rr][Mm]64/ +[Aa][Rr][Mm]64[Ee][Cc]/ +bld/ +[Oo]bj/ +[Oo]ut/ +[Ll]og/ +[Ll]ogs/ + +# Build results on 'Bin' directories +**/[Bb]in/* +# Uncomment if you have tasks that rely on *.refresh files to move binaries +# (https://github.com/github/gitignore/pull/3736) +#!**/[Bb]in/*.refresh + +# Cache/options directory generated by Visual Studio since 2015 +.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.* +*.trx + +# NUnit +*.VisualState.xml +TestResult.xml +nunit-*.xml + +# Approval Tests result files +*.received.* + +# 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/ +.artifacts/ + +# ASP.NET Scaffolding +ScaffoldingReadMe.txt + +# StyleCop +StyleCopReport.xml + +# Files built by Visual Studio +*_i.c +*_p.c +*_h.h +*_i.h +*.ilk +*.meta +*.obj +*.idb +*.iobj +*.pch +*.pdb +*.ipdb +*.pgc +*.pgd +*.rsp +# but not Directory.Build.rsp, as it configures directory-level build defaults +!Directory.Build.rsp +*.sbr +*.tlb +*.tli +*.tlh +*.tmp +*.tmp_proj +*_wpftmp.csproj +*.log +*.tlog +*.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 + +# TeamCity is a build add-in +_TeamCity* + +# DotCover is a Code Coverage Tool +*.dotCover + +# AxoCover is a Code Coverage Tool +.axoCover/* +!.axoCover/settings.json + +# Coverlet is a free, cross platform Code Coverage Tool +coverage*.json +coverage*.xml +coverage*.info + +# Visual Studio code coverage results +*.coverage +*.coveragexml + +# NCrunch +_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 +# NuGet Symbol Packages +*.snupkg +# 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 +*.appxbundle +*.appxupload + +# 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 + +# Since there are multiple workflows, uncomment next line to ignore bower_components +# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) +#bower_components/ + +# 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 +*- [Bb]ackup.rdl +*- [Bb]ackup ([0-9]).rdl +*- [Bb]ackup ([0-9][0-9]).rdl + +# 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 6 workspace and project file (working project files containing files to include in project) +*.dsw +*.dsp + +# 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/ + +# 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 +MSBuild_Logs/ + +# AWS SAM Build and Temporary Artifacts folder +.aws-sam + +# NVidia Nsight GPU debugger configuration file +*.nvuser + +# MFractors (Xamarin productivity tool) working folder +**/.mfractor/ + +# Local History for Visual Studio +**/.localhistory/ + +# Visual Studio History (VSHistory) files +.vshistory/ + +# BeatPulse healthcheck temp database +healthchecksdb + +# Backup folder for Package Reference Convert tool in Visual Studio 2017 +MigrationBackup/ + +# Ionide (cross platform F# VS Code tools) working folder +**/.ionide/ + +# Fody - auto-generated XML schema +FodyWeavers.xsd + +# VS Code files for those working on multiple tools +.vscode/* +!.vscode/settings.json +!.vscode/tasks.json +!.vscode/launch.json +!.vscode/extensions.json +!.vscode/*.code-snippets + +# Local History for Visual Studio Code +.history/ + +# Built Visual Studio Code Extensions +*.vsix + +# Windows Installer files from build outputs +*.cab +*.msi +*.msix +*.msm +*.msp + +# Official VS Code C# Dev Kit Extension exclusion +#*.lscache From c8b8a1a90f1cacae0a866796b9a234248742813e Mon Sep 17 00:00:00 2001 From: Bryn Lewis Date: Wed, 11 Nov 2026 13:37:54 +1300 Subject: [PATCH 2/4] Update C# example setup instructions Require .NET 10 and document setting `AISSTREAM_API_KEY` in PowerShell and Command Prompt before running the example. --- README.md | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 96a35cb..6c63fb6 100644 --- a/README.md +++ b/README.md @@ -30,7 +30,23 @@ Run the example: `node main.js`. ### C# Example -To run the C# example, you will need to have .NET 8 installed on your system. +To run the C# example, you will need to have .NET 10 installed on your system. + +The example reads the API key from the `AISSTREAM_API_KEY` environment variable to help prevent accidental commits of API keys. + +#### PowerShell + +```powershell +$env:AISSTREAM_API_KEY = "your-api-key" +dotnet run +``` + +#### Command Prompt + +```cmd +set AISSTREAM_API_KEY=your-api-key +dotnet run +``` ### C Example From f369e73b36cb474a137327914557b7b3f96f8795 Mon Sep 17 00:00:00 2001 From: Bryn Lewis Date: Wed, 11 Nov 2026 13:40:02 +1300 Subject: [PATCH 3/4] Modernize AIS stream sample Read the API key from an environment variable, decode messages as UTF-8, and target .NET 10. --- csharp/Program.cs | 53 ++++++++++++--------------- csharp/aisStream.SimpleExample.csproj | 9 ++++- 2 files changed, 31 insertions(+), 31 deletions(-) diff --git a/csharp/Program.cs b/csharp/Program.cs index bd555f2..014967d 100644 --- a/csharp/Program.cs +++ b/csharp/Program.cs @@ -1,35 +1,28 @@ -using System; -using System.Net.WebSockets; -using System.Text; -using System.Threading; -using System.Threading.Tasks; -namespace aisStream.SimpleExample +CancellationTokenSource source = new(); +var token = source.Token; + +var apiKey = Environment.GetEnvironmentVariable("AISSTREAM_API_KEY") + ?? throw new InvalidOperationException( + "AISSTREAM_API_KEY environment variable is not set."); + +using var ws = new ClientWebSocket(); + +await ws.ConnectAsync(new Uri("wss://stream.aisstream.io/v0/stream"), token); + +await ws.SendAsync(new ArraySegment(Encoding.UTF8.GetBytes($"{{ \"APIKey\": \"{apiKey}\", \"BoundingBoxes\": [[[-11.0, 178.0], [30.0, 74.0]]]}}")), WebSocketMessageType.Text, true, token); + +byte[] buffer = new byte[4096]; + +while (ws.State == WebSocketState.Open) { - internal class Program + var result = await ws.ReceiveAsync(new ArraySegment(buffer), token); + if (result.MessageType == WebSocketMessageType.Close) + { + await ws.CloseAsync(WebSocketCloseStatus.NormalClosure, string.Empty, token); + } + else { - public static async Task Main(string[] args) - { - CancellationTokenSource source = new CancellationTokenSource(); - CancellationToken token = source.Token; - using (var ws = new ClientWebSocket()) - { - await ws.ConnectAsync(new Uri("wss://stream.aisstream.io/v0/stream"), token); - await ws.SendAsync(new ArraySegment(Encoding.UTF8.GetBytes("{ \"APIKey\": \"\", \"BoundingBoxes\": [[[-11.0, 178.0], [30.0, 74.0]]]}")), WebSocketMessageType.Text, true, token); - byte[] buffer = new byte[4096]; - while (ws.State == WebSocketState.Open) - { - var result = await ws.ReceiveAsync(new ArraySegment(buffer), token); - if (result.MessageType == WebSocketMessageType.Close) - { - await ws.CloseAsync(WebSocketCloseStatus.NormalClosure, string.Empty, token); - } - else - { - Console.WriteLine($"Received {Encoding.Default.GetString(buffer, 0, result.Count)}"); - } - } - } - } + Console.WriteLine($"Received {Encoding.UTF8.GetString(buffer, 0, result.Count)}"); } } diff --git a/csharp/aisStream.SimpleExample.csproj b/csharp/aisStream.SimpleExample.csproj index 21114b1..3ab65ed 100644 --- a/csharp/aisStream.SimpleExample.csproj +++ b/csharp/aisStream.SimpleExample.csproj @@ -2,7 +2,14 @@ Exe - net8.0 + net10.0 + enable + enable + + + + + From 5556981b19fe868d9bc0dad10f2795921bbd2676 Mon Sep 17 00:00:00 2001 From: Bryn Lewis Date: Wed, 11 Nov 2026 13:40:35 +1300 Subject: [PATCH 4/4] Ignore Visual Studio workspace files Add `/.vs` to `.gitignore` to keep local settings and cache files out of version control. --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index d7e570f..3f18b41 100644 --- a/.gitignore +++ b/.gitignore @@ -30,3 +30,4 @@ Thumbs.db # Environment files .env .env.* +/.vs