├── images ├── step1.png ├── step2.png ├── step3.png ├── step4.png ├── step5.png ├── step6.png ├── step7.png └── step7b.png ├── src ├── TestDevice │ ├── appsettings.json │ ├── TestDevice.csproj │ └── Program.cs └── DeviceOfflineDetection │ ├── proxies.json │ ├── host.json │ ├── dtos.cs │ ├── DeviceOfflineDetection.csproj │ ├── Dashboard.cs │ ├── ClientFunctions.cs │ ├── DeviceEntity.cs │ └── dashboard.html ├── .vscode ├── settings.json ├── launch.json └── tasks.json ├── DeviceOfflineDetection.sln ├── azure-pipelines.yaml ├── README.md ├── .gitignore ├── azuredeploy.json └── LICENSE /images/step1.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/keesschollaart81/ServerlessDeviceOfflineDetection/HEAD/images/step1.png -------------------------------------------------------------------------------- /images/step2.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/keesschollaart81/ServerlessDeviceOfflineDetection/HEAD/images/step2.png -------------------------------------------------------------------------------- /images/step3.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/keesschollaart81/ServerlessDeviceOfflineDetection/HEAD/images/step3.png -------------------------------------------------------------------------------- /images/step4.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/keesschollaart81/ServerlessDeviceOfflineDetection/HEAD/images/step4.png -------------------------------------------------------------------------------- /images/step5.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/keesschollaart81/ServerlessDeviceOfflineDetection/HEAD/images/step5.png -------------------------------------------------------------------------------- /images/step6.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/keesschollaart81/ServerlessDeviceOfflineDetection/HEAD/images/step6.png -------------------------------------------------------------------------------- /images/step7.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/keesschollaart81/ServerlessDeviceOfflineDetection/HEAD/images/step7.png -------------------------------------------------------------------------------- /images/step7b.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/keesschollaart81/ServerlessDeviceOfflineDetection/HEAD/images/step7b.png -------------------------------------------------------------------------------- /src/TestDevice/appsettings.json: -------------------------------------------------------------------------------- 1 | { 2 | "StartWithDeviceId": 1, 3 | "ConnectionStrings": { 4 | "StorageConnectionString": "****" 5 | } 6 | } 7 | -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | { 2 | "azureFunctions.deploySubpath": "src/DeviceOfflineDetection/bin/Release/netcoreapp2.2/publish", 3 | "azureFunctions.projectLanguage": "C#", 4 | "azureFunctions.projectRuntime": "~2", 5 | "debug.internalConsoleOptions": "neverOpen", 6 | "azureFunctions.preDeployTask": "publish" 7 | } -------------------------------------------------------------------------------- /src/DeviceOfflineDetection/proxies.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "http://json.schemastore.org/proxies", 3 | "proxies": { 4 | "proxy1": { 5 | "matchCondition": { 6 | "methods": [ "GET" ], 7 | "route": "/loaderio-87442badd0ea5cc83aa853511b981eb8" 8 | }, 9 | "responseOverrides": { 10 | "response.body": "loaderio-87442badd0ea5cc83aa853511b981eb8", 11 | "response.headers.Content-Type": "text/plain" 12 | } 13 | } 14 | } 15 | } -------------------------------------------------------------------------------- /src/DeviceOfflineDetection/host.json: -------------------------------------------------------------------------------- 1 | { 2 | "version": "2.0", 3 | "extensions": { 4 | "durableTask": { 5 | "hubName": "Devices", 6 | "storageProvider": { 7 | "partitionCount": 15, 8 | "connectionStringName": "DurableFunctionsStorageAccount" 9 | }, 10 | "extendedSessionsEnabled": true, 11 | "extendedSessionIdleTimeoutInSeconds": 30, 12 | "maxConcurrentActivityFunctions": 250, 13 | "maxConcurrentOrchestratorFunctions": 250 14 | }, 15 | "queues": { 16 | "maxPollingInterval": "00:00:01" 17 | } 18 | } 19 | } -------------------------------------------------------------------------------- /src/DeviceOfflineDetection/dtos.cs: -------------------------------------------------------------------------------- 1 | using Newtonsoft.Json; 2 | using System; 3 | 4 | namespace DeviceOfflineDetection 5 | { 6 | public class OrchestratorArgs 7 | { 8 | public string DeviceId { get; set; } 9 | } 10 | 11 | public class HttpTriggerArgs 12 | { 13 | public string DeviceId { get; set; } 14 | } 15 | 16 | public class StatusUpdateArgs 17 | { 18 | public StatusUpdateArgs(string deviceId, bool online) 19 | { 20 | this.DeviceId = deviceId; 21 | this.Online = online; 22 | } 23 | public string DeviceId { get; set; } 24 | 25 | public bool Online { get; set; } 26 | } 27 | } -------------------------------------------------------------------------------- /.vscode/launch.json: -------------------------------------------------------------------------------- 1 | { 2 | "version": "0.2.0", 3 | "configurations": [ 4 | 5 | { 6 | "name": ".NET Core Launch (console)", 7 | "type": "coreclr", 8 | "request": "launch", 9 | "preLaunchTask": "build", 10 | "program": "${workspaceFolder}/src/TestDevice/bin/Debug/netcoreapp3.0/TestDevice.dll", 11 | "args": [], 12 | "cwd": "${workspaceFolder}/src/TestDevice", 13 | "stopAtEntry": false, 14 | "console": "internalConsole" 15 | }, 16 | { 17 | "name": "Attach to C# Functions", 18 | "type": "coreclr", 19 | "request": "attach", 20 | "processId": "${command:azureFunctions.pickProcess}" 21 | } 22 | ] 23 | } -------------------------------------------------------------------------------- /src/TestDevice/TestDevice.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Exe 5 | netcoreapp3.0 6 | 8.0 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | PreserveNewest 23 | 24 | 25 | 26 | 27 | -------------------------------------------------------------------------------- /.vscode/tasks.json: -------------------------------------------------------------------------------- 1 | { 2 | "version": "2.0.0", 3 | "tasks": [ 4 | { 5 | "label": "clean", 6 | "command": "dotnet clean", 7 | "type": "shell", 8 | "problemMatcher": "$msCompile" 9 | }, 10 | { 11 | "label": "build", 12 | "command": "dotnet build", 13 | "type": "shell", 14 | "dependsOn": "clean", 15 | "group": { 16 | "kind": "build", 17 | "isDefault": true 18 | }, 19 | "problemMatcher": "$msCompile" 20 | }, 21 | { 22 | "label": "clean release", 23 | "command": "dotnet clean --configuration Release", 24 | "type": "shell", 25 | "problemMatcher": "$msCompile" 26 | }, 27 | { 28 | "label": "publish", 29 | "command": "dotnet publish --configuration Release", 30 | "type": "shell", 31 | "dependsOn": "clean release", 32 | "problemMatcher": "$msCompile" 33 | }, 34 | { 35 | "type": "func", 36 | "dependsOn": "build", 37 | "options": { 38 | "cwd": "${workspaceFolder}/src/DeviceOfflineDetection/bin/Debug/netcoreapp2.2" 39 | }, 40 | "command": "host start", 41 | "isBackground": true, 42 | "problemMatcher": "$func-watch" 43 | } 44 | ] 45 | } -------------------------------------------------------------------------------- /src/DeviceOfflineDetection/DeviceOfflineDetection.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | netcoreapp2.2 4 | v2 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | Always 18 | 19 | 20 | 21 | 22 | PreserveNewest 23 | 24 | 25 | PreserveNewest 26 | 27 | 28 | PreserveNewest 29 | Never 30 | 31 | 32 | -------------------------------------------------------------------------------- /src/DeviceOfflineDetection/Dashboard.cs: -------------------------------------------------------------------------------- 1 | using Microsoft.AspNetCore.Http; 2 | using Microsoft.AspNetCore.Mvc; 3 | using Microsoft.Azure.WebJobs; 4 | using Microsoft.Azure.WebJobs.Extensions.Http; 5 | using Microsoft.Azure.WebJobs.Extensions.SignalRService; 6 | using System.IO; 7 | using System.Net; 8 | using System.Net.Http; 9 | using System.Net.Http.Headers; 10 | using System.Text; 11 | 12 | namespace DeviceOfflineDetection 13 | { 14 | public static class DashboardFunctions 15 | { 16 | [FunctionName("negotiate")] 17 | public static SignalRConnectionInfo GetSignalRInfo( 18 | [HttpTrigger(AuthorizationLevel.Anonymous, "post")] HttpRequest req, 19 | [SignalRConnectionInfo(HubName = "devicestatus")] SignalRConnectionInfo connectionInfo) 20 | { 21 | return connectionInfo; 22 | } 23 | 24 | [FunctionName(nameof(Dashboard))] 25 | public static HttpResponseMessage Dashboard( 26 | [HttpTrigger(AuthorizationLevel.Anonymous)] HttpRequest req, 27 | ExecutionContext context) 28 | { 29 | var path = Path.Combine(context.FunctionAppDirectory, "dashboard.html"); 30 | var content = File.ReadAllText(path); 31 | 32 | var result = new HttpResponseMessage(HttpStatusCode.OK); 33 | result.Content = new StringContent(content, Encoding.UTF8, "text/html"); 34 | 35 | return result; 36 | } 37 | } 38 | } -------------------------------------------------------------------------------- /DeviceOfflineDetection.sln: -------------------------------------------------------------------------------- 1 | 2 | Microsoft Visual Studio Solution File, Format Version 12.00 3 | # Visual Studio Version 16 4 | VisualStudioVersion = 16.0.28729.10 5 | MinimumVisualStudioVersion = 10.0.40219.1 6 | Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "DeviceOfflineDetection", "src\DeviceOfflineDetection\DeviceOfflineDetection.csproj", "{BB1C95B7-3951-4963-9944-001A1C1D4531}" 7 | EndProject 8 | Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution Items", "{FECD95BD-F5EE-4200-A616-C6E3D5D0162D}" 9 | ProjectSection(SolutionItems) = preProject 10 | azure-pipelines.yaml = azure-pipelines.yaml 11 | azuredeploy.json = azuredeploy.json 12 | README.md = README.md 13 | EndProjectSection 14 | EndProject 15 | Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "TestDevice", "src\TestDevice\TestDevice.csproj", "{EE63B4A6-1847-4BC5-AAAD-A6617809FF82}" 16 | EndProject 17 | Global 18 | GlobalSection(SolutionConfigurationPlatforms) = preSolution 19 | Debug|Any CPU = Debug|Any CPU 20 | Release|Any CPU = Release|Any CPU 21 | EndGlobalSection 22 | GlobalSection(ProjectConfigurationPlatforms) = postSolution 23 | {BB1C95B7-3951-4963-9944-001A1C1D4531}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 24 | {BB1C95B7-3951-4963-9944-001A1C1D4531}.Debug|Any CPU.Build.0 = Debug|Any CPU 25 | {BB1C95B7-3951-4963-9944-001A1C1D4531}.Release|Any CPU.ActiveCfg = Release|Any CPU 26 | {BB1C95B7-3951-4963-9944-001A1C1D4531}.Release|Any CPU.Build.0 = Release|Any CPU 27 | {EE63B4A6-1847-4BC5-AAAD-A6617809FF82}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 28 | {EE63B4A6-1847-4BC5-AAAD-A6617809FF82}.Debug|Any CPU.Build.0 = Debug|Any CPU 29 | {EE63B4A6-1847-4BC5-AAAD-A6617809FF82}.Release|Any CPU.ActiveCfg = Release|Any CPU 30 | {EE63B4A6-1847-4BC5-AAAD-A6617809FF82}.Release|Any CPU.Build.0 = Release|Any CPU 31 | EndGlobalSection 32 | GlobalSection(SolutionProperties) = preSolution 33 | HideSolutionNode = FALSE 34 | EndGlobalSection 35 | GlobalSection(ExtensibilityGlobals) = postSolution 36 | SolutionGuid = {B47A471F-4A0F-4A9E-8CD3-3428290C1037} 37 | EndGlobalSection 38 | EndGlobal 39 | -------------------------------------------------------------------------------- /src/DeviceOfflineDetection/ClientFunctions.cs: -------------------------------------------------------------------------------- 1 | using System.Threading.Tasks; 2 | using Microsoft.AspNetCore.Mvc; 3 | using Microsoft.Azure.WebJobs; 4 | using Microsoft.Azure.WebJobs.Extensions.DurableTask; 5 | using Microsoft.Azure.WebJobs.Extensions.Http; 6 | using Microsoft.Extensions.Logging; 7 | using Microsoft.WindowsAzure.Storage.Queue; 8 | 9 | namespace DeviceOfflineDetection 10 | { 11 | public static class DeviceOfflineDetectionFunctions 12 | { 13 | [FunctionName(nameof(QueueTrigger))] 14 | public static async Task QueueTrigger( 15 | [QueueTrigger("device-messages", Connection = "AzureWebJobsStorage")] CloudQueueMessage message, 16 | [DurableClient] IDurableEntityClient durableEntityClient, 17 | ILogger log) 18 | { 19 | log.LogInformation($"Receiving message for device {message.AsString}"); 20 | 21 | var entity = new EntityId(nameof(DeviceEntity), message.AsString); 22 | await durableEntityClient.SignalEntityAsync(entity, nameof(DeviceEntity.MessageReceived)); 23 | } 24 | 25 | [FunctionName(nameof(HandleOfflineMessage))] 26 | public static async Task HandleOfflineMessage( 27 | [DurableClient] IDurableEntityClient durableEntityClient, 28 | [QueueTrigger("timeoutQueue", Connection = "AzureWebJobsStorage")]CloudQueueMessage message, 29 | ILogger log 30 | ) 31 | { 32 | var deviceId = message.AsString; 33 | 34 | var entity = new EntityId(nameof(DeviceEntity), deviceId); 35 | await durableEntityClient.SignalEntityAsync(entity, nameof(DeviceEntity.DeviceTimeout)); 36 | 37 | log.LogInformation($"Device ${deviceId} if now offline"); 38 | log.LogMetric("offline", 1); 39 | } 40 | 41 | [FunctionName(nameof(GetStatus))] 42 | public static async Task GetStatus( 43 | [HttpTrigger(AuthorizationLevel.Anonymous, "get")] HttpTriggerArgs args, 44 | [DurableClient] IDurableEntityClient durableEntityClient) 45 | { 46 | var entity = new EntityId(nameof(DeviceEntity), args.DeviceId); 47 | var device = await durableEntityClient.ReadEntityStateAsync(entity); 48 | 49 | return new OkObjectResult(device); 50 | } 51 | } 52 | } -------------------------------------------------------------------------------- /azure-pipelines.yaml: -------------------------------------------------------------------------------- 1 | trigger: 2 | - master 3 | - dev 4 | 5 | variables: 6 | ## 👇 Update with your own values 👇 ## 7 | azureSubscription: 'Microsoft Azure Internal Consumption - Kesch' 8 | functionAppName: 'offlinedetection' 9 | resourceGroupName: 'offlinedetection' 10 | ## ☝ Update with your own values ☝ ## 11 | 12 | vmImageName: 'vs2017-win2016' 13 | 14 | stages: 15 | - stage: Build 16 | displayName: 'Build' 17 | jobs: 18 | 19 | - job: BuildFunctionApp 20 | pool: 21 | vmImage: $(vmImageName) 22 | 23 | steps: 24 | - task: DotNetCoreCLI@2 25 | displayName: 'Build project' 26 | inputs: 27 | projects: '**/DeviceOfflineDetection.csproj' 28 | arguments: '--output $(System.DefaultWorkingDirectory)/publish_output --configuration Release' 29 | 30 | - task: ArchiveFiles@2 31 | displayName: 'Archive files' 32 | inputs: 33 | rootFolderOrFile: '$(System.DefaultWorkingDirectory)/publish_output' 34 | includeRootFolder: false 35 | archiveType: zip 36 | archiveFile: $(Build.ArtifactStagingDirectory)/Functions.zip 37 | replaceExistingArchive: true 38 | 39 | - task: CopyFiles@2 40 | displayName: Stage ARM Template for publishing 41 | inputs: 42 | contents: 'azuredeploy.json' 43 | TargetFolder: $(Build.ArtifactStagingDirectory) 44 | 45 | - publish: $(Build.ArtifactStagingDirectory) 46 | artifact: drop 47 | 48 | - stage: Deploy 49 | displayName: Deploy stage 50 | dependsOn: Build 51 | condition: succeeded() 52 | 53 | jobs: 54 | - deployment: Deploy 55 | displayName: Deploy 56 | environment: 'development' 57 | pool: 58 | vmImage: $(vmImageName) 59 | 60 | strategy: 61 | runOnce: 62 | deploy: 63 | 64 | steps: 65 | - task: AzureResourceManagerTemplateDeployment@3 66 | displayName: 'ARM Template deployment: Resource Group scope' 67 | inputs: 68 | ConnectedServiceName: '$(azureSubscription)' 69 | azureSubscription: '$(azureSubscription)' 70 | resourceGroupName: '$(resourceGroupName)' 71 | location: 'Central US' 72 | csmFile: '$(Pipeline.Workspace)/drop/azuredeploy.json' 73 | overrideParameters: '-functionAppName $(functionAppName)' 74 | 75 | - task: AzureRmWebAppDeployment@4 76 | displayName: 'Azure functions app deploy' 77 | inputs: 78 | azureSubscription: '$(azureSubscription)' 79 | appType: functionApp 80 | WebAppName: $(functionAppName) 81 | enableCustomDeployment: true 82 | deploymentMethod: zipDeploy 83 | package: '$(Pipeline.Workspace)/drop/Functions.zip' 84 | -------------------------------------------------------------------------------- /src/DeviceOfflineDetection/DeviceEntity.cs: -------------------------------------------------------------------------------- 1 | 2 | using System; 3 | using System.Threading.Tasks; 4 | using Microsoft.Azure.WebJobs; 5 | using Microsoft.Azure.WebJobs.Extensions.DurableTask; 6 | using Microsoft.Azure.WebJobs.Extensions.SignalRService; 7 | using Microsoft.Extensions.Logging; 8 | using Microsoft.WindowsAzure.Storage; 9 | using Microsoft.WindowsAzure.Storage.Queue; 10 | using Newtonsoft.Json; 11 | 12 | namespace DeviceOfflineDetection 13 | { 14 | 15 | [JsonObject(MemberSerialization.OptIn)] 16 | public class DeviceEntity 17 | { 18 | [JsonProperty] 19 | public string Id { get; set; } 20 | 21 | [JsonProperty] 22 | public DateTime? LastCommunicationDateTime { get; set; } 23 | 24 | private readonly ILogger logger; 25 | private readonly IDurableEntityContext context; 26 | private readonly IAsyncCollector signalRMessages; 27 | private TimeSpan offlineAfter = TimeSpan.FromSeconds(20); 28 | 29 | public DeviceEntity(string id, ILogger logger, IAsyncCollector signalRMessages, IDurableEntityContext context) 30 | { 31 | this.Id = id; 32 | this.logger = logger; 33 | this.signalRMessages = signalRMessages; 34 | this.context = context; 35 | } 36 | 37 | [FunctionName(nameof(DeviceEntity))] 38 | public static async Task HandleEntityOperation( 39 | [EntityTrigger] IDurableEntityContext context, 40 | [SignalR(HubName = "devicestatus")] IAsyncCollector signalRMessages, 41 | ILogger logger) 42 | { 43 | await context.DispatchAsync(context.EntityKey, logger, signalRMessages, context); 44 | } 45 | 46 | public async Task MessageReceived() 47 | { 48 | this.LastCommunicationDateTime = DateTime.UtcNow; 49 | 50 | var entityId = new EntityId(nameof(DeviceEntity), this.Id); 51 | this.context.SignalEntity(entityId, DateTime.UtcNow.Add(this.offlineAfter), nameof(DeviceTimeout)); 52 | 53 | await this.ReportState("online"); 54 | this.logger.LogInformation($"Device ${this.Id} if now online"); 55 | } 56 | 57 | private async Task ReportState(string state) 58 | { 59 | await this.signalRMessages.AddAsync(new SignalRMessage 60 | { 61 | Target = "statusChanged", 62 | Arguments = new[] { new { deviceId = this.Id, status = state } } 63 | }); 64 | } 65 | 66 | public async Task DeviceTimeout() 67 | { 68 | if (DateTime.UtcNow - LastCommunicationDateTime > offlineAfter) 69 | { 70 | await ReportState("offline"); 71 | } 72 | } 73 | } 74 | } -------------------------------------------------------------------------------- /src/DeviceOfflineDetection/dashboard.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | SignalR Device Status Dashboard 5 | 45 | 46 | 47 |

Devices

48 | 49 |
50 |
    51 |
    52 | 53 | 54 | 87 | 88 | 89 | -------------------------------------------------------------------------------- /src/TestDevice/Program.cs: -------------------------------------------------------------------------------- 1 | using Microsoft.Azure.Storage; 2 | using Microsoft.Azure.Storage.Queue; 3 | using Microsoft.Extensions.Configuration; 4 | using System; 5 | using System.IO; 6 | using System.Linq; 7 | using System.Net; 8 | using System.Net.Http; 9 | using System.Runtime.CompilerServices; 10 | using System.Runtime.InteropServices.ComTypes; 11 | using System.Threading; 12 | using System.Threading.Tasks; 13 | 14 | namespace TestDevice 15 | { 16 | class Program 17 | { 18 | private static CloudQueue Queue; 19 | private static Task MessageSenderTask; 20 | private static CancellationTokenSource CancellationTokenSource = new CancellationTokenSource(); 21 | private static int StartWithDeviceId = 1; 22 | 23 | static void Main(string[] args) 24 | { 25 | ConnectToStorageQueue(); 26 | 27 | while(true) 28 | { 29 | Console.WriteLine("Enter number of devices, 0 to exit"); 30 | var input = Console.ReadLine(); 31 | var devicesCount = int.Parse(input); 32 | 33 | CancellationTokenSource.Cancel(); 34 | MessageSenderTask?.Wait(); 35 | 36 | if (devicesCount == 0) break; 37 | CancellationTokenSource = new CancellationTokenSource(); 38 | 39 | MessageSenderTask = Task.Run(async () => 40 | { 41 | while (!CancellationTokenSource.IsCancellationRequested) 42 | { 43 | var start = DateTime.Now; 44 | 45 | await Task.WhenAll(Enumerable.Range(StartWithDeviceId, devicesCount).Select(async deviceId => { 46 | await Queue.AddMessageAsync(new CloudQueueMessage($"{deviceId}")); 47 | })); 48 | 49 | var duration = DateTime.Now - start; 50 | 51 | Console.WriteLine($"{DateTime.Now:G} Send messages to {devicesCount} Devices in {duration}"); 52 | 53 | if (duration < TimeSpan.FromSeconds(10)) 54 | { 55 | try 56 | { 57 | await Task.Delay(TimeSpan.FromSeconds(10) - duration, CancellationTokenSource.Token); 58 | } 59 | catch (TaskCanceledException) { } 60 | } 61 | } 62 | }); 63 | 64 | } 65 | } 66 | 67 | private static void ConnectToStorageQueue() 68 | { 69 | var configurationRoot = new ConfigurationBuilder() 70 | .SetBasePath(Directory.GetCurrentDirectory()) 71 | .AddJsonFile("appsettings.json", optional: true, reloadOnChange: true) 72 | .Build(); 73 | 74 | StartWithDeviceId = int.Parse(configurationRoot["StartWithDeviceId"]); 75 | 76 | var storageAccount = CloudStorageAccount.Parse(configurationRoot.GetConnectionString("StorageConnectionString")); 77 | var queueClient = storageAccount.CreateCloudQueueClient(); 78 | Queue = queueClient.GetQueueReference("device-messages"); 79 | Queue.CreateIfNotExists(); 80 | } 81 | } 82 | } 83 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Device Offline Detection with Durable Entities 2 | 3 | This is the companion repository for this blogpost: 4 | 5 | http://case.schollaart.net/2019/10/31/device-offline-detection-with-durable-entities.html 6 | 7 | ## Run it yourself 8 | 9 | You have 2 options: 10 | 11 | 1. Create infrastructure with ARM Template and then 'Right Click Deploy' the Function App to it 12 | 2. Fork the repository, use the Azure Pipelines YAML to do all the work 13 | 14 | ### Deployment option 1 15 | 16 | 1. Click the Button below to create the infrastructure in your Azure Subscription 17 | 18 | [![Deploy to Azure](https://azuredeploy.net/deploybutton.png)](https://azuredeploy.net/) 19 | 20 | 2. Clone this repository to your machine 21 | 3. Right Click Deploy via an IDE with Azure Functions Tooling installed 22 | a. VS Code with [read more](https://docs.microsoft.com/en-us/azure/azure-functions/functions-develop-vs-code#publish-to-azure) ([screenshot](images/step7.png)) 23 | b. Visual Studio 2019 [read more](https://docs.microsoft.com/en-us/azure/azure-functions/functions-develop-vs#publish-to-azure) ([screenshot](images/step7b.png)) 24 | 4. Continue reading '[Running it]('running-it')' 25 | 26 | ### Deployment option 2 (via Azure Pipelines) 27 | 28 | - Fork the repository and clone it to your machine 29 | - Go to (or create) an Azure DevOps project where you want the pipline to live 30 | - Make sure you have a Service Connection to an Azure Subscription [read here how to create one](https://docs.microsoft.com/en-us/azure/devops/pipelines/library/connect-to-azure?view=azure-devops) 31 | - Remember the exact name of this Service Connection 32 | - Create the pipeline in Azure DevOps based on [azure-pipelines.yaml](azure-pipelines.yaml). Read how here how to ['Get your first run'](https://docs.microsoft.com/en-us/azure/devops/pipelines/create-first-pipeline?view=azure-devops&tabs=tfs-2018-2#get-your-first-run) 33 | - Step by Step screenshots [1](images/step1.png), [2](images/step2.png), [3](images/step3.png), [4](images/step4.png), [5](images/step5.png) 34 | - Update the variables in the azure-pipelines.yaml, there will be a screen to do that during the Azure DevOps pipeline creation wizard (screenshot 5) 35 | - azureSubscription: The name of the Service Connection 36 | - functionAppName: the name of your test project, make it lowercase no special characters and it has to be globally unique 37 | - resourceGroupName: the resource group to deploy to 38 | - Make sure the build and deploy were succesfull ([screenshot](images/step6.png)) 39 | 40 | ### Running it 41 | 42 | - Go to https://{functionAppName}.azurewebsites.net/api/dashboard, here you should see a Header called 'Devices' 43 | - Update the ConnectionString to the Storage Queue in the TestDevice project 44 | - Go to the Azure Portal and go to the `{functionAppName}st` Storage Account resource (dont mistake it for the storage account ending op `dst`) 45 | - Click on 'Access Keys' and copy the Connection String 46 | - Open this cloned repository/solution on your machine with VS Code or Visual Studio and go to the TestDevice project 47 | - Edit the appsettings.json and update the `StorageConnectionString` 48 | - Run the TestDevice console app [src/TestDevice] (`dotnet run`) and observe the status in the dashboard, for example, start with 200 devices and then change it to 100 -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | ## Ignore Visual Studio temporary files, build results, and 2 | ## files generated by popular Visual Studio add-ons. 3 | 4 | # Azure Functions localsettings file 5 | local.settings.json 6 | 7 | # User-specific files 8 | *.suo 9 | *.user 10 | *.userosscache 11 | *.sln.docstates 12 | 13 | # User-specific files (MonoDevelop/Xamarin Studio) 14 | *.userprefs 15 | 16 | # Build results 17 | [Dd]ebug/ 18 | [Dd]ebugPublic/ 19 | [Rr]elease/ 20 | [Rr]eleases/ 21 | x64/ 22 | x86/ 23 | bld/ 24 | [Bb]in/ 25 | [Oo]bj/ 26 | [Ll]og/ 27 | 28 | # Visual Studio 2015 cache/options directory 29 | .vs/ 30 | # Uncomment if you have tasks that create the project's static files in wwwroot 31 | #wwwroot/ 32 | 33 | # MSTest test Results 34 | [Tt]est[Rr]esult*/ 35 | [Bb]uild[Ll]og.* 36 | 37 | # NUNIT 38 | *.VisualState.xml 39 | TestResult.xml 40 | 41 | # Build Results of an ATL Project 42 | [Dd]ebugPS/ 43 | [Rr]eleasePS/ 44 | dlldata.c 45 | 46 | # DNX 47 | project.lock.json 48 | project.fragment.lock.json 49 | artifacts/ 50 | 51 | *_i.c 52 | *_p.c 53 | *_i.h 54 | *.ilk 55 | *.meta 56 | *.obj 57 | *.pch 58 | *.pdb 59 | *.pgc 60 | *.pgd 61 | *.rsp 62 | *.sbr 63 | *.tlb 64 | *.tli 65 | *.tlh 66 | *.tmp 67 | *.tmp_proj 68 | *.log 69 | *.vspscc 70 | *.vssscc 71 | .builds 72 | *.pidb 73 | *.svclog 74 | *.scc 75 | 76 | # Chutzpah Test files 77 | _Chutzpah* 78 | 79 | # Visual C++ cache files 80 | ipch/ 81 | *.aps 82 | *.ncb 83 | *.opendb 84 | *.opensdf 85 | *.sdf 86 | *.cachefile 87 | *.VC.db 88 | *.VC.VC.opendb 89 | 90 | # Visual Studio profiler 91 | *.psess 92 | *.vsp 93 | *.vspx 94 | *.sap 95 | 96 | # TFS 2012 Local Workspace 97 | $tf/ 98 | 99 | # Guidance Automation Toolkit 100 | *.gpState 101 | 102 | # ReSharper is a .NET coding add-in 103 | _ReSharper*/ 104 | *.[Rr]e[Ss]harper 105 | *.DotSettings.user 106 | 107 | # JustCode is a .NET coding add-in 108 | .JustCode 109 | 110 | # TeamCity is a build add-in 111 | _TeamCity* 112 | 113 | # DotCover is a Code Coverage Tool 114 | *.dotCover 115 | 116 | # NCrunch 117 | _NCrunch_* 118 | .*crunch*.local.xml 119 | nCrunchTemp_* 120 | 121 | # MightyMoose 122 | *.mm.* 123 | AutoTest.Net/ 124 | 125 | # Web workbench (sass) 126 | .sass-cache/ 127 | 128 | # Installshield output folder 129 | [Ee]xpress/ 130 | 131 | # DocProject is a documentation generator add-in 132 | DocProject/buildhelp/ 133 | DocProject/Help/*.HxT 134 | DocProject/Help/*.HxC 135 | DocProject/Help/*.hhc 136 | DocProject/Help/*.hhk 137 | DocProject/Help/*.hhp 138 | DocProject/Help/Html2 139 | DocProject/Help/html 140 | 141 | # Click-Once directory 142 | publish/ 143 | 144 | # Publish Web Output 145 | *.[Pp]ublish.xml 146 | *.azurePubxml 147 | # TODO: Comment the next line if you want to checkin your web deploy settings 148 | # but database connection strings (with potential passwords) will be unencrypted 149 | #*.pubxml 150 | *.publishproj 151 | 152 | # Microsoft Azure Web App publish settings. Comment the next line if you want to 153 | # checkin your Azure Web App publish settings, but sensitive information contained 154 | # in these scripts will be unencrypted 155 | PublishScripts/ 156 | 157 | # NuGet Packages 158 | *.nupkg 159 | # The packages folder can be ignored because of Package Restore 160 | **/packages/* 161 | # except build/, which is used as an MSBuild target. 162 | !**/packages/build/ 163 | # Uncomment if necessary however generally it will be regenerated when needed 164 | #!**/packages/repositories.config 165 | # NuGet v3's project.json files produces more ignoreable files 166 | *.nuget.props 167 | *.nuget.targets 168 | 169 | # Microsoft Azure Build Output 170 | csx/ 171 | *.build.csdef 172 | 173 | # Microsoft Azure Emulator 174 | ecf/ 175 | rcf/ 176 | 177 | # Windows Store app package directories and files 178 | AppPackages/ 179 | BundleArtifacts/ 180 | Package.StoreAssociation.xml 181 | _pkginfo.txt 182 | 183 | # Visual Studio cache files 184 | # files ending in .cache can be ignored 185 | *.[Cc]ache 186 | # but keep track of directories ending in .cache 187 | !*.[Cc]ache/ 188 | 189 | # Others 190 | ClientBin/ 191 | ~$* 192 | *~ 193 | *.dbmdl 194 | *.dbproj.schemaview 195 | *.jfm 196 | *.pfx 197 | *.publishsettings 198 | node_modules/ 199 | orleans.codegen.cs 200 | 201 | # Since there are multiple workflows, uncomment next line to ignore bower_components 202 | # (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) 203 | #bower_components/ 204 | 205 | # RIA/Silverlight projects 206 | Generated_Code/ 207 | 208 | # Backup & report files from converting an old project file 209 | # to a newer Visual Studio version. Backup files are not needed, 210 | # because we have git ;-) 211 | _UpgradeReport_Files/ 212 | Backup*/ 213 | UpgradeLog*.XML 214 | UpgradeLog*.htm 215 | 216 | # SQL Server files 217 | *.mdf 218 | *.ldf 219 | 220 | # Business Intelligence projects 221 | *.rdl.data 222 | *.bim.layout 223 | *.bim_*.settings 224 | 225 | # Microsoft Fakes 226 | FakesAssemblies/ 227 | 228 | # GhostDoc plugin setting file 229 | *.GhostDoc.xml 230 | 231 | # Node.js Tools for Visual Studio 232 | .ntvs_analysis.dat 233 | 234 | # Visual Studio 6 build log 235 | *.plg 236 | 237 | # Visual Studio 6 workspace options file 238 | *.opt 239 | 240 | # Visual Studio LightSwitch build output 241 | **/*.HTMLClient/GeneratedArtifacts 242 | **/*.DesktopClient/GeneratedArtifacts 243 | **/*.DesktopClient/ModelManifest.xml 244 | **/*.Server/GeneratedArtifacts 245 | **/*.Server/ModelManifest.xml 246 | _Pvt_Extensions 247 | 248 | # Paket dependency manager 249 | .paket/paket.exe 250 | paket-files/ 251 | 252 | # FAKE - F# Make 253 | .fake/ 254 | 255 | # JetBrains Rider 256 | .idea/ 257 | *.sln.iml 258 | 259 | # CodeRush 260 | .cr/ 261 | 262 | # Python Tools for Visual Studio (PTVS) 263 | __pycache__/ 264 | *.pyc -------------------------------------------------------------------------------- /azuredeploy.json: -------------------------------------------------------------------------------- 1 | { 2 | "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#", 3 | "contentVersion": "1.0.0.0", 4 | "parameters": { 5 | "functionAppName": { 6 | "type": "string", 7 | "metadata": { 8 | "description": "Name of your project, has to be globally unique!" 9 | } 10 | }, 11 | "location": { 12 | "type": "string", 13 | "defaultValue": "Central US", 14 | "metadata": { 15 | "description": "Select a location for your resources" 16 | } 17 | } 18 | }, 19 | "variables": { 20 | "prefix": "[toLower(parameters('functionAppName'))]", 21 | "functionPlanAppName": "[concat(variables('prefix'),'asp')]", 22 | "functionAppName": "[variables('prefix')]", 23 | "applicationInsightsName": "[concat(variables('prefix'),'ai')]", 24 | "storageAccountName": "[concat(variables('prefix'),'st')]", 25 | "durableStorageAccountName": "[concat(variables('prefix'),'dst')]", 26 | "signalRServiceName": "[concat(variables('prefix'),'asrs')]" 27 | }, 28 | "resources": [ 29 | { 30 | "type": "Microsoft.Storage/storageAccounts", 31 | "sku": { 32 | "name": "Standard_LRS", 33 | "tier": "Standard" 34 | }, 35 | "kind": "Storage", 36 | "name": "[variables('storageAccountName')]", 37 | "apiVersion": "2016-01-01", 38 | "location": "[parameters('location')]", 39 | "properties": {}, 40 | "dependsOn": [] 41 | }, 42 | { 43 | "type": "Microsoft.Storage/storageAccounts", 44 | "sku": { 45 | "name": "Standard_LRS", 46 | "tier": "Standard" 47 | }, 48 | "kind": "Storage", 49 | "name": "[variables('durableStorageAccountName')]", 50 | "apiVersion": "2016-01-01", 51 | "location": "[parameters('location')]", 52 | "properties": {}, 53 | "dependsOn": [] 54 | }, 55 | { 56 | "type": "Microsoft.Web/serverFarms", 57 | "apiVersion": "2016-09-01", 58 | "name": "[variables('functionPlanAppName')]", 59 | "location": "[parameters('location')]", 60 | "properties": { 61 | "name": "[variables('functionPlanAppName')]", 62 | "computeMode": "Dynamic", 63 | "maximumElasticWorkerCount": "20" 64 | }, 65 | "kind": "elastic", 66 | "sku": { 67 | "name": "EP2", 68 | "tier": "ElasticPremium" 69 | } 70 | }, 71 | { 72 | "type": "Microsoft.Web/sites", 73 | "apiVersion": "2016-08-01", 74 | "name": "[variables('functionAppName')]", 75 | "location": "[parameters('location')]", 76 | "kind": "functionapp", 77 | "properties": { 78 | "serverFarmId": "[resourceId('Microsoft.Web/serverfarms', variables('functionPlanAppName'))]", 79 | "siteConfig": { 80 | "appSettings": [ 81 | { 82 | "name": "AzureWebJobsDashboard", 83 | "value": "[concat('DefaultEndpointsProtocol=https;AccountName=', variables('storageAccountName'), ';AccountKey=', listKeys(resourceId('Microsoft.Storage/storageAccounts', variables('storageAccountName')),'2015-05-01-preview').key1)]" 84 | }, 85 | { 86 | "name": "AzureWebJobsStorage", 87 | "value": "[concat('DefaultEndpointsProtocol=https;AccountName=', variables('storageAccountName'), ';AccountKey=', listKeys(resourceId('Microsoft.Storage/storageAccounts', variables('storageAccountName')),'2015-05-01-preview').key1)]" 88 | }, 89 | { 90 | "name": "DurableFunctionsStorageAccount", 91 | "value": "[concat('DefaultEndpointsProtocol=https;AccountName=', variables('durableStorageAccountName'), ';AccountKey=', listKeys(resourceId('Microsoft.Storage/storageAccounts', variables('durableStorageAccountName')),'2015-05-01-preview').key1)]" 92 | }, 93 | { 94 | "name": "FUNCTIONS_EXTENSION_VERSION", 95 | "value": "~2" 96 | }, 97 | { 98 | "name": "APPINSIGHTS_INSTRUMENTATIONKEY", 99 | "value": "[reference(resourceId('Microsoft.Insights/components', variables('applicationInsightsName')), '2014-04-01').InstrumentationKey]" 100 | }, 101 | { 102 | "name": "AzureSignalRConnectionString", 103 | "value": "[concat('Endpoint=https://', variables('signalRServiceName'), '.service.signalr.net;AccessKey=', listKeys(resourceId('Microsoft.SignalRService/SignalR', variables('signalRServiceName')), providers('Microsoft.SignalRService','SignalR').apiVersions[0]).primaryKey)]" 104 | } 105 | ] 106 | } 107 | }, 108 | "dependsOn": [ 109 | "[resourceId('Microsoft.Web/serverfarms', variables('functionPlanAppName'))]", 110 | "[resourceId('Microsoft.Storage/storageAccounts', variables('storageAccountName'))]", 111 | "[resourceId('microsoft.insights/components', variables('applicationInsightsName'))]", 112 | "[resourceId('Microsoft.SignalRService/SignalR', variables('signalRServiceName'))]" 113 | ] 114 | }, 115 | { 116 | "type": "Microsoft.Insights/components", 117 | "apiVersion": "2015-05-01", 118 | "kind": "web", 119 | "name": "[variables('applicationInsightsName')]", 120 | "location": "[parameters('location')]", 121 | "tags": {}, 122 | "properties": { 123 | "ApplicationId": "[variables('applicationInsightsName')]" 124 | }, 125 | "dependsOn": [] 126 | }, 127 | { 128 | "type": "Microsoft.SignalRService/SignalR", 129 | "apiVersion": "2018-10-01", 130 | "name": "[variables('signalRServiceName')]", 131 | "location": "[parameters('location')]", 132 | "sku": { 133 | "name": "Standard_S1", 134 | "tier": "Standard", 135 | "size": "S1", 136 | "capacity": 1 137 | }, 138 | "properties": { 139 | "hostNamePrefix": "[variables('signalRServiceName')]", 140 | "features": [ 141 | { 142 | "flag": "ServiceMode", 143 | "value": "Serverless", 144 | "properties": {} 145 | } 146 | ] 147 | } 148 | } 149 | ], 150 | "outputs": {} 151 | } -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------