| | | 1 | | <# |
| | | 2 | | .SYNOPSIS |
| | | 3 | | Starts the Kestrun server and listens for incoming requests. |
| | | 4 | | .DESCRIPTION |
| | | 5 | | This function starts the Kestrun server, allowing it to accept incoming HTTP requests. |
| | | 6 | | .PARAMETER Server |
| | | 7 | | The Kestrun server instance to start. This parameter is mandatory. |
| | | 8 | | .PARAMETER NoWait |
| | | 9 | | If specified, the function will not wait for the server to start and will return immediately. |
| | | 10 | | .PARAMETER Quiet |
| | | 11 | | If specified, suppresses output messages during the startup process. |
| | | 12 | | .PARAMETER CloseLogsOnExit |
| | | 13 | | If specified, closes all loggers when the server stops. |
| | | 14 | | .PARAMETER PassThru |
| | | 15 | | If specified, the cmdlet will return the modified server instance after starting it. |
| | | 16 | | .EXAMPLE |
| | | 17 | | Start-KrServer -Server $server |
| | | 18 | | Starts the specified Kestrun server instance and listens for incoming requests. |
| | | 19 | | .NOTES |
| | | 20 | | This function is designed to be used after the server has been configured and routes have been added. |
| | | 21 | | It will block the console until the server is stopped or Ctrl+C is pressed. |
| | | 22 | | #> |
| | | 23 | | function Start-KrServer { |
| | | 24 | | [KestrunRuntimeApi('Definition')] |
| | | 25 | | [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSUseShouldProcessForStateChangingFunctions', '')] |
| | | 26 | | [CmdletBinding()] |
| | | 27 | | [Diagnostics.CodeAnalysis.SuppressMessageAttribute('PSAvoidUsingWriteHost', '')] |
| | | 28 | | param( |
| | | 29 | | [Parameter(Mandatory = $false, ValueFromPipeline = $true)] |
| | | 30 | | [Kestrun.Hosting.KestrunHost]$Server, |
| | | 31 | | [Parameter()] |
| | | 32 | | [switch]$NoWait, |
| | | 33 | | [Parameter()] |
| | | 34 | | [switch]$Quiet, |
| | | 35 | | [Parameter()] |
| | | 36 | | [switch]$PassThru, |
| | | 37 | | [Parameter()] |
| | | 38 | | [switch]$CloseLogsOnExit |
| | | 39 | | ) |
| | | 40 | | begin { |
| | | 41 | | # Ensure the server instance is resolved |
| | 0 | 42 | | $Server = Resolve-KestrunServer -Server $Server |
| | 0 | 43 | | $hasConsole = $false |
| | 0 | 44 | | $writeConsole = $false |
| | | 45 | | try { |
| | 0 | 46 | | $null = [Console]::KeyAvailable |
| | 0 | 47 | | $hasConsole = $true |
| | 0 | 48 | | $writeConsole = -not $Quiet.IsPresent |
| | | 49 | | } catch { |
| | 0 | 50 | | Write-KrLog -Level Information -Message 'No console available; running in non-interactive mode.' |
| | | 51 | | } |
| | | 52 | | } |
| | | 53 | | process { |
| | | 54 | | # Generate OpenAPI documents if not already generated |
| | 0 | 55 | | foreach ( $doc in $Server.OpenApiDocumentDescriptor.Keys ) { |
| | 0 | 56 | | if ( -not $Server.OpenApiDocumentDescriptor[$doc].HasBeenGenerated ) { |
| | 0 | 57 | | Build-KrOpenApiDocument -Server $Server -DocId $doc |
| | | 58 | | } |
| | | 59 | | } |
| | | 60 | | # Start the Kestrel server |
| | 0 | 61 | | if ( -not $Quiet.IsPresent ) { |
| | 0 | 62 | | Write-Host "Starting Kestrun server '$($Server.ApplicationName)' ..." |
| | | 63 | | } |
| | 0 | 64 | | $Server.StartAsync() | Out-Null |
| | 0 | 65 | | if ($writeConsole) { |
| | 0 | 66 | | Write-Host 'Kestrun server started successfully.' |
| | 0 | 67 | | foreach ($listener in $Server.Options.Listeners) { |
| | 0 | 68 | | if ($listener.X509Certificate) { |
| | 0 | 69 | | Write-Host "Listening on https://$($listener.IPAddress):$($listener.Port) with protocols: $($listene |
| | | 70 | | } else { |
| | 0 | 71 | | Write-Host "Listening on http://$($listener.IPAddress):$($listener.Port) with protocols: $($listener |
| | | 72 | | } |
| | 0 | 73 | | if ($listener.X509Certificate) { |
| | 0 | 74 | | Write-Host "Using certificate: $($listener.X509Certificate.Subject)" |
| | | 75 | | } else { |
| | 0 | 76 | | Write-Host 'No certificate configured. Running in HTTP mode.' |
| | | 77 | | } |
| | 0 | 78 | | if ($listener.UseConnectionLogging) { |
| | 0 | 79 | | Write-Host 'Connection logging is enabled.' |
| | | 80 | | } else { |
| | 0 | 81 | | Write-Host 'Connection logging is disabled.' |
| | | 82 | | } |
| | | 83 | | } |
| | 0 | 84 | | Write-Host 'Press Ctrl+C to stop the server.' |
| | | 85 | | } |
| | 0 | 86 | | if (-not $NoWait.IsPresent) { |
| | | 87 | | # Intercept Ctrl+C and gracefully stop the Kestrun server |
| | | 88 | | try { |
| | 0 | 89 | | if ($hasConsole) { |
| | 0 | 90 | | [Console]::TreatControlCAsInput = $true |
| | 0 | 91 | | while ($Server.IsRunning) { |
| | 0 | 92 | | if ([Console]::KeyAvailable) { |
| | 0 | 93 | | $key = [Console]::ReadKey($true) |
| | 0 | 94 | | if (($key.Modifiers -eq 'Control') -and ($key.Key -eq 'C')) { |
| | 0 | 95 | | if ($writeConsole) { |
| | 0 | 96 | | Write-Host 'Ctrl+C detected. Stopping Kestrun server...' |
| | | 97 | | } |
| | 0 | 98 | | $Server.StopAsync().Wait() |
| | | 99 | | break |
| | | 100 | | } |
| | | 101 | | } |
| | 0 | 102 | | Start-Sleep -Milliseconds 100 |
| | | 103 | | } |
| | | 104 | | } else { |
| | | 105 | | # Just wait for the server to stop (block until externally stopped) |
| | 0 | 106 | | while ($Server.IsRunning) { |
| | 0 | 107 | | Start-Sleep -Seconds 1 |
| | | 108 | | } |
| | | 109 | | } |
| | | 110 | | } finally { |
| | | 111 | | # Ensure the server is stopped on exit |
| | 0 | 112 | | if ($writeConsole) { |
| | 0 | 113 | | Write-Host 'Stopping Kestrun server...' |
| | | 114 | | } |
| | 0 | 115 | | if ($Server.IsRunning) { |
| | 0 | 116 | | [Kestrun.KestrunHostManager]::StopAsync($Server.ApplicationName).Wait() |
| | | 117 | | } |
| | | 118 | | #$Server.StopAsync().Wait() |
| | 0 | 119 | | [Kestrun.KestrunHostManager]::Destroy($Server.ApplicationName) |
| | | 120 | | |
| | 0 | 121 | | if ($CloseLogsOnExit.IsPresent) { |
| | | 122 | | # Close the Kestrel loggers |
| | 0 | 123 | | Close-KrLogger |
| | | 124 | | } |
| | | 125 | | |
| | 0 | 126 | | if ($writeConsole) { |
| | 0 | 127 | | Write-Host 'Kestrun server stopped.' |
| | | 128 | | } |
| | | 129 | | } |
| | 0 | 130 | | } elseif ($PassThru.IsPresent) { |
| | | 131 | | # if the PassThru switch is specified, return the server instance |
| | 0 | 132 | | return $Server |
| | | 133 | | } |
| | | 134 | | } |
| | | 135 | | } |
| | | 136 | | |