Skip to content

Commit

Permalink
.Net Core - Update example to self host the BrowserSubProcess
Browse files Browse the repository at this point in the history
Eliminates the requirements for .Net 4.5.2, the application exe is used as the browsersubprocess.
Additional manual import of CefSharp.BrowserSubProcess.Core is required see csproj file for example

TODO: OffScreen version is crashing on exit so it's been updated, it just isn't using itself as the BrowserSubProcess
  • Loading branch information
amaitland committed Feb 10, 2020
1 parent 2e80bd8 commit 898eb75
Show file tree
Hide file tree
Showing 7 changed files with 163 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,25 @@
<Private>true</Private>
</Reference>
</ItemGroup>

<!-- Include CefSharp.BrowserSubprocess.Core so we can selfhost the BrowserSubProcess using our exe -->
<Choose>
<When Condition="'$(PlatformTarget)' == 'x64'">
<ItemGroup>
<Reference Include="CefSharp.BrowserSubprocess.Core">
<HintPath>$(CefSharpBrowserProcessCore64)</HintPath>
<Private>true</Private>
</Reference>
</ItemGroup>
</When>
<!-- x86, Win32 and AnyCPU -->
<Otherwise>
<ItemGroup>
<Reference Include="CefSharp.BrowserSubprocess.Core">
<HintPath>$(CefSharpBrowserProcessCore32)</HintPath>
<Private>true</Private>
</Reference>
</ItemGroup>
</Otherwise>
</Choose>
</Project>
26 changes: 25 additions & 1 deletion CefSharp.MinimalExample.OffScreen/Program.cs
Original file line number Diff line number Diff line change
Expand Up @@ -15,20 +15,42 @@ public class Program
{
private static ChromiumWebBrowser browser;

public static void Main(string[] args)
public static int Main(string[] args)
{
const string testUrl = "https://www.google.com/";

Console.WriteLine("This example application will load {0}, take a screenshot, and save it to your desktop.", testUrl);
Console.WriteLine("You may see Chromium debugging output, please wait...");
Console.WriteLine();

#if NETCOREAPP
//We are using our current exe as the BrowserSubProcess
//Multiple instances will be spawned to handle all the
//Chromium proceses, render, gpu, network, plugin, etc.
var subProcessExe = new CefSharp.BrowserSubprocess.BrowserSubprocessExecutable();
var result = subProcessExe.Main(args);
if (result > 0)
{
return result;
}
#endif

var settings = new CefSettings()
{
//By default CefSharp will use an in-memory cache, you need to specify a Cache Folder to persist data
CachePath = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData), "CefSharp\\Cache")
};

#if NETCOREAPP
//We use our Applications exe as the BrowserSubProcess, multiple copies
//will be spawned
//TODO: The OffScreen implementation is crashing on Exit (WPF/WinForms are working fine).
//So for now this is commented out and the old .Net CefSharp.BrowserSubProcess.exe
//is used.
//var exePath = System.Diagnostics.Process.GetCurrentProcess().MainModule.FileName;
//settings.BrowserSubprocessPath = exePath;
#endif

//Perform dependency check to make sure all relevant resources are in our output directory.
Cef.Initialize(settings, performDependencyCheck: true, browserProcessHandler: null);

Expand All @@ -45,6 +67,8 @@ public static void Main(string[] args)
// Clean up Chromium objects. You need to call this in your application otherwise
// you will get a crash when closing.
Cef.Shutdown();

return 0;
}

private static void BrowserLoadingStateChanged(object sender, LoadingStateChangedEventArgs e)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,4 +27,25 @@
<Private>true</Private>
</Reference>
</ItemGroup>

<!-- Include CefSharp.BrowserSubprocess.Core so we can selfhost the BrowserSubProcess using our exe -->
<Choose>
<When Condition="'$(PlatformTarget)' == 'x64'">
<ItemGroup>
<Reference Include="CefSharp.BrowserSubprocess.Core">
<HintPath>$(CefSharpBrowserProcessCore64)</HintPath>
<Private>true</Private>
</Reference>
</ItemGroup>
</When>
<!-- x86, Win32 and AnyCPU -->
<Otherwise>
<ItemGroup>
<Reference Include="CefSharp.BrowserSubprocess.Core">
<HintPath>$(CefSharpBrowserProcessCore32)</HintPath>
<Private>true</Private>
</Reference>
</ItemGroup>
</Otherwise>
</Choose>
</Project>
23 changes: 22 additions & 1 deletion CefSharp.MinimalExample.WinForms/Program.cs
Original file line number Diff line number Diff line change
Expand Up @@ -12,17 +12,36 @@ namespace CefSharp.MinimalExample.WinForms
public class Program
{
[STAThread]
public static void Main()
public static int Main(string[] args)
{
//For Windows 7 and above, best to include relevant app.manifest entries as well
Cef.EnableHighDPISupport();

#if NETCOREAPP
//We are using our current exe as the BrowserSubProcess
//Multiple instances will be spawned to handle all the
//Chromium proceses, render, gpu, network, plugin, etc.
var subProcessExe = new CefSharp.BrowserSubprocess.BrowserSubprocessExecutable();
var result = subProcessExe.Main(args);
if (result > 0)
{
return result;
}
#endif

var settings = new CefSettings()
{
//By default CefSharp will use an in-memory cache, you need to specify a Cache Folder to persist data
CachePath = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData), "CefSharp\\Cache")
};

#if NETCOREAPP
//We use our Applications exe as the BrowserSubProcess, multiple copies
//will be spawned
var exePath = System.Diagnostics.Process.GetCurrentProcess().MainModule.FileName;
settings.BrowserSubprocessPath = exePath;
#endif

//Example of setting a command line argument
//Enables WebRTC
settings.CefCommandLineArgs.Add("enable-media-stream", "1");
Expand All @@ -32,6 +51,8 @@ public static void Main()

var browser = new BrowserForm();
Application.Run(browser);

return 0;
}
}
}
2 changes: 2 additions & 0 deletions CefSharp.MinimalExample.Wpf/App.xaml.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ public partial class App : Application
{
public App()
{
#if !NETCOREAPP
var settings = new CefSettings()
{
//By default CefSharp will use an in-memory cache, you need to specify a Cache Folder to persist data
Expand All @@ -21,6 +22,7 @@ public App()

//Perform dependency check to make sure all relevant resources are in our output directory.
Cef.Initialize(settings, performDependencyCheck: true, browserProcessHandler: null);
#endif
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
<ApplicationManifest>app.manifest</ApplicationManifest>
<GenerateAssemblyInfo>false</GenerateAssemblyInfo>
<Platforms>x86;x64</Platforms>
<StartupObject>CefSharp.MinimalExample.Wpf.Program</StartupObject>
</PropertyGroup>

<ItemGroup>
Expand All @@ -29,4 +30,25 @@
<Private>true</Private>
</Reference>
</ItemGroup>

<!-- Include CefSharp.BrowserSubprocess.Core so we can selfhost the BrowserSubProcess using our exe -->
<Choose>
<When Condition="'$(PlatformTarget)' == 'x64'">
<ItemGroup>
<Reference Include="CefSharp.BrowserSubprocess.Core">
<HintPath>$(CefSharpBrowserProcessCore64)</HintPath>
<Private>true</Private>
</Reference>
</ItemGroup>
</When>
<!-- x86, Win32 and AnyCPU -->
<Otherwise>
<ItemGroup>
<Reference Include="CefSharp.BrowserSubprocess.Core">
<HintPath>$(CefSharpBrowserProcessCore32)</HintPath>
<Private>true</Private>
</Reference>
</ItemGroup>
</Otherwise>
</Choose>
</Project>
50 changes: 50 additions & 0 deletions CefSharp.MinimalExample.Wpf/Program.netcore.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
using CefSharp.Wpf;
using System;
using System.IO;

namespace CefSharp.MinimalExample.Wpf
{
public static class Program
{
/// <summary>
/// Application Entry Point.
/// </summary>
[STAThread]
public static int Main(string[] args)
{
//For Windows 7 and above, app.manifest entries will take precedences of this call
Cef.EnableHighDPISupport();

//We are using our current exe as the BrowserSubProcess
//Multiple instances will be spawned to handle all the
//Chromium proceses, render, gpu, network, plugin, etc.
var subProcessExe = new CefSharp.BrowserSubprocess.BrowserSubprocessExecutable();
var result = subProcessExe.Main(args);
if (result > 0)
{
return result;
}

//We use our current exe as the BrowserSubProcess
var exePath = System.Diagnostics.Process.GetCurrentProcess().MainModule.FileName;

var settings = new CefSettings()
{
//By default CefSharp will use an in-memory cache, you need to specify a Cache Folder to persist data
CachePath = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.LocalApplicationData), "CefSharp\\Cache"),
BrowserSubprocessPath = exePath
};

//Example of setting a command line argument
//Enables WebRTC
settings.CefCommandLineArgs.Add("enable-media-stream");

//Perform dependency check to make sure all relevant resources are in our output directory.
Cef.Initialize(settings, performDependencyCheck: true, browserProcessHandler: null);

var app = new App();
app.InitializeComponent();
return app.Run();
}
}
}

0 comments on commit 898eb75

Please sign in to comment.