├── petabridge_logo.png
├── AkkaHelpers
    ├── packages.config
    ├── ActorPaths.cs
    ├── ActorMetaData.cs
    ├── Properties
    │   └── AssemblyInfo.cs
    └── AkkaHelpers.csproj
├── AkkaHelpers.Tests
    ├── packages.config
    ├── Properties
    │   └── AssemblyInfo.cs
    ├── ActorMetadataTests.cs
    └── AkkaHelpers.Tests.csproj
├── AkkaHelpers.sln
├── .gitignore
├── README.md
└── LICENSE


/petabridge_logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/petabridge/akkadotnet-helpers/HEAD/petabridge_logo.png


--------------------------------------------------------------------------------
/AkkaHelpers/packages.config:
--------------------------------------------------------------------------------
1 | <?xml version="1.0" encoding="utf-8"?>
2 | <packages>
3 |   <package id="Akka" version="1.0.1" targetFramework="net45" />
4 |   <package id="Newtonsoft.Json" version="6.0.8" targetFramework="net45" />
5 | </packages>


--------------------------------------------------------------------------------
/AkkaHelpers.Tests/packages.config:
--------------------------------------------------------------------------------
1 | <?xml version="1.0" encoding="utf-8"?>
2 | <packages>
3 |   <package id="Akka" version="1.0.1" targetFramework="net45" />
4 |   <package id="Newtonsoft.Json" version="6.0.8" targetFramework="net45" />
5 |   <package id="NUnit" version="2.6.4" targetFramework="net45" />
6 | </packages>


--------------------------------------------------------------------------------
/AkkaHelpers/ActorPaths.cs:
--------------------------------------------------------------------------------
 1 | using Akka.Actor;
 2 | 
 3 | namespace AkkaHelpers
 4 | {
 5 |     /// <summary>
 6 |     /// Static helper class used to define paths to fixed-name actors
 7 |     /// (helps eliminate errors when using <see cref="ActorSelection"/>)
 8 |     /// </summary>
 9 |     public static class ActorPaths
10 |     {
11 |         public static readonly ActorMetaData AuthenticatorActor = new ActorMetaData("authenticator");
12 |         public static readonly ActorMetaData FormActor = new ActorMetaData("mainform");
13 |         public static readonly ActorMetaData ValidatorActor = new ActorMetaData("validator", AuthenticatorActor);
14 |         public static readonly ActorMetaData NestedValidatorActor = new ActorMetaData("childValidator", ValidatorActor);
15 | 
16 |     }
17 | }
18 | 


--------------------------------------------------------------------------------
/AkkaHelpers/ActorMetaData.cs:
--------------------------------------------------------------------------------
 1 | using Akka.Actor;
 2 | 
 3 | namespace AkkaHelpers
 4 | {
 5 |     /// <summary>
 6 |     /// Meta-data class. Nested/child actors can build path 
 7 |     /// based on their parent(s) / position in hierarchy.
 8 |     /// </summary>
 9 |     public class ActorMetaData
10 |     {
11 |         public ActorMetaData(string name, ActorMetaData parent = null)
12 |         {
13 |             Name = name;
14 |             Parent = parent;
15 |             // if no parent, we assume a top-level actor
16 |             var parentPath = parent != null ? parent.Path : "/user";
17 |             Path = string.Format("{0}/{1}", parentPath, Name);
18 |         }
19 | 
20 |         public string Name { get; private set; }
21 | 
22 |         public ActorMetaData Parent { get; set; }
23 | 
24 |         public string Path { get; private set; }
25 |     }
26 | }
27 | 


--------------------------------------------------------------------------------
/AkkaHelpers/Properties/AssemblyInfo.cs:
--------------------------------------------------------------------------------
 1 | using System.Reflection;
 2 | using System.Runtime.InteropServices;
 3 | 
 4 | // General Information about an assembly is controlled through the following 
 5 | // set of attributes. Change these attribute values to modify the information
 6 | // associated with an assembly.
 7 | [assembly: AssemblyTitle("Helpers")]
 8 | [assembly: AssemblyDescription("")]
 9 | [assembly: AssemblyConfiguration("")]
10 | [assembly: AssemblyCompany("")]
11 | [assembly: AssemblyProduct("Helpers")]
12 | [assembly: AssemblyCopyright("Copyright ©  2015")]
13 | [assembly: AssemblyTrademark("")]
14 | [assembly: AssemblyCulture("")]
15 | 
16 | // Setting ComVisible to false makes the types in this assembly not visible 
17 | // to COM components.  If you need to access a type in this assembly from 
18 | // COM, set the ComVisible attribute to true on that type.
19 | [assembly: ComVisible(false)]
20 | 
21 | // The following GUID is for the ID of the typelib if this project is exposed to COM
22 | [assembly: Guid("9da0d3f6-de56-418b-a12d-28c3f5e6dfea")]
23 | 
24 | // Version information for an assembly consists of the following four values:
25 | //
26 | //      Major Version
27 | //      Minor Version 
28 | //      Build Number
29 | //      Revision
30 | //
31 | // You can specify all the values or you can default the Build and Revision Numbers 
32 | // by using the '*' as shown below:
33 | // [assembly: AssemblyVersion("1.0.*")]
34 | [assembly: AssemblyVersion("1.0.0.0")]
35 | [assembly: AssemblyFileVersion("1.0.0.0")]
36 | 


--------------------------------------------------------------------------------
/AkkaHelpers.Tests/Properties/AssemblyInfo.cs:
--------------------------------------------------------------------------------
 1 | using System.Reflection;
 2 | using System.Runtime.InteropServices;
 3 | 
 4 | // General Information about an assembly is controlled through the following 
 5 | // set of attributes. Change these attribute values to modify the information
 6 | // associated with an assembly.
 7 | [assembly: AssemblyTitle("AkkaHelpers.Tests")]
 8 | [assembly: AssemblyDescription("")]
 9 | [assembly: AssemblyConfiguration("")]
10 | [assembly: AssemblyCompany("")]
11 | [assembly: AssemblyProduct("AkkaHelpers.Tests")]
12 | [assembly: AssemblyCopyright("Copyright ©  2015")]
13 | [assembly: AssemblyTrademark("")]
14 | [assembly: AssemblyCulture("")]
15 | 
16 | // Setting ComVisible to false makes the types in this assembly not visible 
17 | // to COM components.  If you need to access a type in this assembly from 
18 | // COM, set the ComVisible attribute to true on that type.
19 | [assembly: ComVisible(false)]
20 | 
21 | // The following GUID is for the ID of the typelib if this project is exposed to COM
22 | [assembly: Guid("eddde24b-c158-4c54-b060-199d3911e14a")]
23 | 
24 | // Version information for an assembly consists of the following four values:
25 | //
26 | //      Major Version
27 | //      Minor Version 
28 | //      Build Number
29 | //      Revision
30 | //
31 | // You can specify all the values or you can default the Build and Revision Numbers 
32 | // by using the '*' as shown below:
33 | // [assembly: AssemblyVersion("1.0.*")]
34 | [assembly: AssemblyVersion("1.0.0.0")]
35 | [assembly: AssemblyFileVersion("1.0.0.0")]
36 | 


--------------------------------------------------------------------------------
/AkkaHelpers.sln:
--------------------------------------------------------------------------------
 1 | 
 2 | Microsoft Visual Studio Solution File, Format Version 12.00
 3 | # Visual Studio 2013
 4 | VisualStudioVersion = 12.0.31101.0
 5 | MinimumVisualStudioVersion = 10.0.40219.1
 6 | Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AkkaHelpers.Tests", "AkkaHelpers.Tests\AkkaHelpers.Tests.csproj", "{259774BB-557E-4224-B5B6-FDB8C2629C95}"
 7 | EndProject
 8 | Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "AkkaHelpers", "AkkaHelpers\AkkaHelpers.csproj", "{637C585F-8EA3-4C8C-BB83-F0E5C9855D05}"
 9 | EndProject
10 | Global
11 | 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
12 | 		Debug|Any CPU = Debug|Any CPU
13 | 		Release|Any CPU = Release|Any CPU
14 | 	EndGlobalSection
15 | 	GlobalSection(ProjectConfigurationPlatforms) = postSolution
16 | 		{259774BB-557E-4224-B5B6-FDB8C2629C95}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
17 | 		{259774BB-557E-4224-B5B6-FDB8C2629C95}.Debug|Any CPU.Build.0 = Debug|Any CPU
18 | 		{259774BB-557E-4224-B5B6-FDB8C2629C95}.Release|Any CPU.ActiveCfg = Release|Any CPU
19 | 		{259774BB-557E-4224-B5B6-FDB8C2629C95}.Release|Any CPU.Build.0 = Release|Any CPU
20 | 		{637C585F-8EA3-4C8C-BB83-F0E5C9855D05}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
21 | 		{637C585F-8EA3-4C8C-BB83-F0E5C9855D05}.Debug|Any CPU.Build.0 = Debug|Any CPU
22 | 		{637C585F-8EA3-4C8C-BB83-F0E5C9855D05}.Release|Any CPU.ActiveCfg = Release|Any CPU
23 | 		{637C585F-8EA3-4C8C-BB83-F0E5C9855D05}.Release|Any CPU.Build.0 = Release|Any CPU
24 | 	EndGlobalSection
25 | 	GlobalSection(SolutionProperties) = preSolution
26 | 		HideSolutionNode = FALSE
27 | 	EndGlobalSection
28 | EndGlobal
29 | 


--------------------------------------------------------------------------------
/AkkaHelpers.Tests/ActorMetadataTests.cs:
--------------------------------------------------------------------------------
 1 | using NUnit.Framework;
 2 | 
 3 | namespace AkkaHelpers.Tests
 4 | {
 5 |     [TestFixture]
 6 |     public class ActorMetadataTests
 7 |     {
 8 |         [Test]
 9 |         public void ActorMetadata_should_return_name()
10 |         {
11 |             var actor = ActorPaths.AuthenticatorActor;
12 |             var expectedName = "authenticator";
13 |             Assert.AreEqual(actor.Name, expectedName);
14 |         }
15 | 
16 |         [Test]
17 |         public void ActorMetadata_top_level_actor_should_return_top_level_actor_path()
18 |         {
19 |             var actor = ActorPaths.FormActor; // top-level actor
20 |             var expectedPath = "/user/mainform";
21 |             Assert.AreEqual(actor.Path, expectedPath);
22 |         }
23 | 
24 |         [Test]
25 |         public void ActorMetadata_nested_actor_should_return_nested_actor_path()
26 |         {
27 |             var actor = ActorPaths.ValidatorActor;
28 |             var expectedPath = "/user/authenticator/validator";
29 |             Assert.AreEqual(actor.Path, expectedPath);
30 | 
31 |             var nestedActor = ActorPaths.NestedValidatorActor;
32 |             var expectedPath2 = "/user/authenticator/validator/childValidator";
33 |             Assert.AreEqual(nestedActor.Path, expectedPath2);
34 |         }
35 | 
36 |         [Test]
37 |         public void ActorMetadata_child_actor_should_know_parent()
38 |         {
39 |             var actor = ActorPaths.ValidatorActor;
40 |             var parent = ActorPaths.AuthenticatorActor;
41 |             Assert.AreEqual(actor.Parent, parent);
42 |         }
43 |     }
44 | }
45 | 


--------------------------------------------------------------------------------
/AkkaHelpers/AkkaHelpers.csproj:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="utf-8"?>
 2 | <Project ToolsVersion="12.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
 3 |   <Import Project="$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props" Condition="Exists('$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props')" />
 4 |   <PropertyGroup>
 5 |     <Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
 6 |     <Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>
 7 |     <ProjectGuid>{637C585F-8EA3-4C8C-BB83-F0E5C9855D05}</ProjectGuid>
 8 |     <OutputType>Library</OutputType>
 9 |     <AppDesignerFolder>Properties</AppDesignerFolder>
10 |     <RootNamespace>AkkaHelpers</RootNamespace>
11 |     <AssemblyName>AkkaHelpers</AssemblyName>
12 |     <TargetFrameworkVersion>v4.5</TargetFrameworkVersion>
13 |     <FileAlignment>512</FileAlignment>
14 |   </PropertyGroup>
15 |   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
16 |     <DebugSymbols>true</DebugSymbols>
17 |     <DebugType>full</DebugType>
18 |     <Optimize>false</Optimize>
19 |     <OutputPath>bin\Debug\</OutputPath>
20 |     <DefineConstants>DEBUG;TRACE</DefineConstants>
21 |     <ErrorReport>prompt</ErrorReport>
22 |     <WarningLevel>4</WarningLevel>
23 |   </PropertyGroup>
24 |   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
25 |     <DebugType>pdbonly</DebugType>
26 |     <Optimize>true</Optimize>
27 |     <OutputPath>bin\Release\</OutputPath>
28 |     <DefineConstants>TRACE</DefineConstants>
29 |     <ErrorReport>prompt</ErrorReport>
30 |     <WarningLevel>4</WarningLevel>
31 |   </PropertyGroup>
32 |   <ItemGroup>
33 |     <Reference Include="Akka">
34 |       <HintPath>..\packages\Akka.1.0.1\lib\net45\Akka.dll</HintPath>
35 |     </Reference>
36 |     <Reference Include="Newtonsoft.Json, Version=6.0.0.0, Culture=neutral, PublicKeyToken=30ad4fe6b2a6aeed, processorArchitecture=MSIL">
37 |       <SpecificVersion>False</SpecificVersion>
38 |       <HintPath>..\packages\Newtonsoft.Json.6.0.8\lib\net45\Newtonsoft.Json.dll</HintPath>
39 |     </Reference>
40 |     <Reference Include="System" />
41 |     <Reference Include="System.Core" />
42 |     <Reference Include="System.Xml.Linq" />
43 |     <Reference Include="System.Data.DataSetExtensions" />
44 |     <Reference Include="Microsoft.CSharp" />
45 |     <Reference Include="System.Data" />
46 |     <Reference Include="System.Xml" />
47 |   </ItemGroup>
48 |   <ItemGroup>
49 |     <Compile Include="ActorMetaData.cs" />
50 |     <Compile Include="ActorPaths.cs" />
51 |     <Compile Include="Properties\AssemblyInfo.cs" />
52 |   </ItemGroup>
53 |   <ItemGroup>
54 |     <None Include="packages.config" />
55 |   </ItemGroup>
56 |   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
57 |   <!-- To modify your build process, add your task inside one of the targets below and uncomment it. 
58 |        Other similar extension points exist, see Microsoft.Common.targets.
59 |   <Target Name="BeforeBuild">
60 |   </Target>
61 |   <Target Name="AfterBuild">
62 |   </Target>
63 |   -->
64 | </Project>


--------------------------------------------------------------------------------
/AkkaHelpers.Tests/AkkaHelpers.Tests.csproj:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="utf-8"?>
 2 | <Project ToolsVersion="12.0" DefaultTargets="Build" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
 3 |   <Import Project="$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props" Condition="Exists('$(MSBuildExtensionsPath)\$(MSBuildToolsVersion)\Microsoft.Common.props')" />
 4 |   <PropertyGroup>
 5 |     <Configuration Condition=" '$(Configuration)' == '' ">Debug</Configuration>
 6 |     <Platform Condition=" '$(Platform)' == '' ">AnyCPU</Platform>
 7 |     <ProjectGuid>{259774BB-557E-4224-B5B6-FDB8C2629C95}</ProjectGuid>
 8 |     <OutputType>Library</OutputType>
 9 |     <AppDesignerFolder>Properties</AppDesignerFolder>
10 |     <RootNamespace>AkkaHelpers.Tests</RootNamespace>
11 |     <AssemblyName>AkkaHelpers.Tests</AssemblyName>
12 |     <TargetFrameworkVersion>v4.5</TargetFrameworkVersion>
13 |     <FileAlignment>512</FileAlignment>
14 |   </PropertyGroup>
15 |   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
16 |     <DebugSymbols>true</DebugSymbols>
17 |     <DebugType>full</DebugType>
18 |     <Optimize>false</Optimize>
19 |     <OutputPath>bin\Debug\</OutputPath>
20 |     <DefineConstants>DEBUG;TRACE</DefineConstants>
21 |     <ErrorReport>prompt</ErrorReport>
22 |     <WarningLevel>4</WarningLevel>
23 |   </PropertyGroup>
24 |   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Release|AnyCPU' ">
25 |     <DebugType>pdbonly</DebugType>
26 |     <Optimize>true</Optimize>
27 |     <OutputPath>bin\Release\</OutputPath>
28 |     <DefineConstants>TRACE</DefineConstants>
29 |     <ErrorReport>prompt</ErrorReport>
30 |     <WarningLevel>4</WarningLevel>
31 |   </PropertyGroup>
32 |   <ItemGroup>
33 |     <Reference Include="Akka">
34 |       <HintPath>..\packages\Akka.1.0.1\lib\net45\Akka.dll</HintPath>
35 |     </Reference>
36 |     <Reference Include="Newtonsoft.Json, Version=6.0.0.0, Culture=neutral, PublicKeyToken=30ad4fe6b2a6aeed, processorArchitecture=MSIL">
37 |       <SpecificVersion>False</SpecificVersion>
38 |       <HintPath>..\packages\Newtonsoft.Json.6.0.8\lib\net45\Newtonsoft.Json.dll</HintPath>
39 |     </Reference>
40 |     <Reference Include="nunit.framework">
41 |       <HintPath>..\packages\NUnit.2.6.4\lib\nunit.framework.dll</HintPath>
42 |     </Reference>
43 |     <Reference Include="System" />
44 |     <Reference Include="System.Core" />
45 |     <Reference Include="System.Xml.Linq" />
46 |     <Reference Include="System.Data.DataSetExtensions" />
47 |     <Reference Include="Microsoft.CSharp" />
48 |     <Reference Include="System.Data" />
49 |     <Reference Include="System.Xml" />
50 |   </ItemGroup>
51 |   <ItemGroup>
52 |     <Compile Include="ActorMetadataTests.cs" />
53 |     <Compile Include="Properties\AssemblyInfo.cs" />
54 |   </ItemGroup>
55 |   <ItemGroup>
56 |     <None Include="packages.config" />
57 |   </ItemGroup>
58 |   <ItemGroup>
59 |     <ProjectReference Include="..\AkkaHelpers\AkkaHelpers.csproj">
60 |       <Project>{637C585F-8EA3-4C8C-BB83-F0E5C9855D05}</Project>
61 |       <Name>AkkaHelpers</Name>
62 |     </ProjectReference>
63 |   </ItemGroup>
64 |   <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" />
65 |   <!-- To modify your build process, add your task inside one of the targets below and uncomment it. 
66 |        Other similar extension points exist, see Microsoft.Common.targets.
67 |   <Target Name="BeforeBuild">
68 |   </Target>
69 |   <Target Name="AfterBuild">
70 |   </Target>
71 |   -->
72 | </Project>


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
  1 | ## Ignore Visual Studio temporary files, build results, and
  2 | ## files generated by popular Visual Studio add-ons.
  3 | 
  4 | # User-specific files
  5 | *.suo
  6 | *.user
  7 | *.userosscache
  8 | *.sln.docstates
  9 | 
 10 | # User-specific files (MonoDevelop/Xamarin Studio)
 11 | *.userprefs
 12 | 
 13 | # Build results
 14 | [Dd]ebug/
 15 | [Dd]ebugPublic/
 16 | [Rr]elease/
 17 | [Rr]eleases/
 18 | x64/
 19 | x86/
 20 | build/
 21 | bld/
 22 | [Bb]in/
 23 | [Oo]bj/
 24 | 
 25 | # Visual Studo 2015 cache/options directory
 26 | .vs/
 27 | 
 28 | # MSTest test Results
 29 | [Tt]est[Rr]esult*/
 30 | [Bb]uild[Ll]og.*
 31 | 
 32 | # NUNIT
 33 | *.VisualState.xml
 34 | TestResult.xml
 35 | 
 36 | # Build Results of an ATL Project
 37 | [Dd]ebugPS/
 38 | [Rr]eleasePS/
 39 | dlldata.c
 40 | 
 41 | *_i.c
 42 | *_p.c
 43 | *_i.h
 44 | *.ilk
 45 | *.meta
 46 | *.obj
 47 | *.pch
 48 | *.pdb
 49 | *.pgc
 50 | *.pgd
 51 | *.rsp
 52 | *.sbr
 53 | *.tlb
 54 | *.tli
 55 | *.tlh
 56 | *.tmp
 57 | *.tmp_proj
 58 | *.log
 59 | *.vspscc
 60 | *.vssscc
 61 | .builds
 62 | *.pidb
 63 | *.svclog
 64 | *.scc
 65 | 
 66 | # Chutzpah Test files
 67 | _Chutzpah*
 68 | 
 69 | # Visual C++ cache files
 70 | ipch/
 71 | *.aps
 72 | *.ncb
 73 | *.opensdf
 74 | *.sdf
 75 | *.cachefile
 76 | 
 77 | # Visual Studio profiler
 78 | *.psess
 79 | *.vsp
 80 | *.vspx
 81 | 
 82 | # TFS 2012 Local Workspace
 83 | $tf/
 84 | 
 85 | # Guidance Automation Toolkit
 86 | *.gpState
 87 | 
 88 | # ReSharper is a .NET coding add-in
 89 | _ReSharper*/
 90 | *.[Rr]e[Ss]harper
 91 | *.DotSettings.user
 92 | 
 93 | # JustCode is a .NET coding addin-in
 94 | .JustCode
 95 | 
 96 | # TeamCity is a build add-in
 97 | _TeamCity*
 98 | 
 99 | # DotCover is a Code Coverage Tool
100 | *.dotCover
101 | 
102 | # NCrunch
103 | _NCrunch_*
104 | .*crunch*.local.xml
105 | 
106 | # MightyMoose
107 | *.mm.*
108 | AutoTest.Net/
109 | 
110 | # Web workbench (sass)
111 | .sass-cache/
112 | 
113 | # Installshield output folder
114 | [Ee]xpress/
115 | 
116 | # DocProject is a documentation generator add-in
117 | DocProject/buildhelp/
118 | DocProject/Help/*.HxT
119 | DocProject/Help/*.HxC
120 | DocProject/Help/*.hhc
121 | DocProject/Help/*.hhk
122 | DocProject/Help/*.hhp
123 | DocProject/Help/Html2
124 | DocProject/Help/html
125 | 
126 | # Click-Once directory
127 | publish/
128 | 
129 | # Publish Web Output
130 | *.[Pp]ublish.xml
131 | *.azurePubxml
132 | # TODO: Comment the next line if you want to checkin your web deploy settings 
133 | # but database connection strings (with potential passwords) will be unencrypted
134 | *.pubxml
135 | *.publishproj
136 | 
137 | # NuGet Packages
138 | *.nupkg
139 | # The packages folder can be ignored because of Package Restore
140 | **/packages/*
141 | # except build/, which is used as an MSBuild target.
142 | !**/packages/build/
143 | # Uncomment if necessary however generally it will be regenerated when needed
144 | #!**/packages/repositories.config
145 | 
146 | # Windows Azure Build Output
147 | csx/
148 | *.build.csdef
149 | 
150 | # Windows Store app package directory
151 | AppPackages/
152 | 
153 | # Others
154 | *.[Cc]ache
155 | ClientBin/
156 | [Ss]tyle[Cc]op.*
157 | ~$*
158 | *~
159 | *.dbmdl
160 | *.dbproj.schemaview
161 | *.pfx
162 | *.publishsettings
163 | node_modules/
164 | bower_components/
165 | 
166 | # RIA/Silverlight projects
167 | Generated_Code/
168 | 
169 | # Backup & report files from converting an old project file
170 | # to a newer Visual Studio version. Backup files are not needed,
171 | # because we have git ;-)
172 | _UpgradeReport_Files/
173 | Backup*/
174 | UpgradeLog*.XML
175 | UpgradeLog*.htm
176 | 
177 | # SQL Server files
178 | *.mdf
179 | *.ldf
180 | 
181 | # Business Intelligence projects
182 | *.rdl.data
183 | *.bim.layout
184 | *.bim_*.settings
185 | 
186 | # Microsoft Fakes
187 | FakesAssemblies/
188 | 
189 | # Node.js Tools for Visual Studio
190 | .ntvs_analysis.dat
191 | 
192 | # Visual Studio 6 build log
193 | *.plg
194 | 
195 | # Visual Studio 6 workspace options file
196 | *.opt
197 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Akka.NET Helpers
 2 | This repo is a library of Akka.NET helper classes and design patterns to assist with common production needs.
 3 | 
 4 | ## Helpers & Patterns
 5 | ### Shared ActorPaths
 6 | The "Shared ActorPaths" pattern is a simple way to reduce errors with `ActorSelection`s, usually due to fat-fingering `ActorPath`s.
 7 | 
 8 | > *Read the full context about how and why to use this pattern—and `ActorSelection`s—in [this blog post: "When should I use an ActorSelection?"](https://petabridge.com/blog/when-should-I-use-actor-selection/)*
 9 | 
10 | Best practice is to store the `ActorPath`s in this public static class so that other parts of your code can reference it easily, and you don't have dangling references and hard-to-track down errors when you change an `ActorPath`. Or hardcode one in wrong.
11 | 
12 | For example, we can define the `ActorPath`s that we need to reference in one place and then use them without having to fat-finger the addresses in. This leads to **fewer errors and easier changes**:
13 | 
14 | ```csharp
15 | using Akka.Actor;
16 | 
17 | namespace AkkaHelpers
18 | {
19 |     /// <summary>
20 |     /// Static helper class used to define paths to fixed-name actors
21 |     /// (helps eliminate errors when using <see cref="ActorSelection"/>)
22 |     /// </summary>
23 |     public static class ActorPaths
24 |     {
25 |         public static readonly ActorMetaData AuthenticatorActor = new ActorMetaData("authenticator");
26 |         public static readonly ActorMetaData FormActor = new ActorMetaData("mainform");
27 |         public static readonly ActorMetaData ValidatorActor = new ActorMetaData("validator", AuthenticatorActor);
28 |         public static readonly ActorMetaData NestedValidatorActor = new ActorMetaData("childValidator", ValidatorActor);
29 |     }
30 | }
31 | ```
32 | 
33 | ...and we can then get access to the `ActorPath` we need for an `ActorSelection` like so:
34 | 
35 | ```csharp
36 | Context.ActorSelection(ActorPaths.AuthenticatorActor.Path).Tell(message);
37 | ```
38 | 
39 | #### ***This pattern should be used in conjunction with the following "Actor MetaData" pattern.***
40 | 
41 | [See the "Shared ActorPaths" example code here.](/AkkaHelpers/ActorPaths.cs)
42 | 
43 | ### Actor MetaData
44 | The "Actor MetaData" pattern is a simple way to add extra information which makes the "Shared ActorPaths" pattern much more useful. This enables you to store metadata about an actor path, letting you easily retrieve the actors name, `ActorPath`, and parent, even when you don't have a handle to an actor (e.g. don't have an `IActorRef`).
45 | 
46 | > *Read the full context about how and why to use this pattern—and `ActorSelection`s—in [this blog post: "When should I use an ActorSelection?"](https://petabridge.com/blog/when-should-I-use-actor-selection/)*
47 | 
48 | For example:
49 | 
50 | ```csharp
51 | using Akka.Actor;
52 | 
53 | namespace AkkaHelpers
54 | {
55 |     /// <summary>
56 |     /// Meta-data class. Nested/child actors can build path
57 |     /// based on their parent(s) / position in hierarchy.
58 |     /// </summary>
59 |     public class ActorMetaData
60 |     {
61 |         public ActorMetaData(string name, ActorMetaData parent = null)
62 |         {
63 |             Name = name;
64 |             Parent = parent;
65 |             // if no parent, we assume a top-level actor
66 |             var parentPath = parent != null ? parent.Path : "/user";
67 |             Path = string.Format("{0}/{1}", parentPath, Name);
68 |         }
69 | 
70 |         public string Name { get; private set; }
71 | 
72 |         public ActorMetaData Parent { get; set; }
73 | 
74 |         public string Path { get; private set; }
75 |     }
76 | }
77 | ```
78 | 
79 | [See the "Actor MetaData" example code here.](/AkkaHelpers/ActorMetaData.cs)
80 | <br><br>
81 | 
82 | 
83 | ## About Petabridge
84 | 
85 | ![Petabridge logo](petabridge_logo.png)
86 | 
87 | [Petabridge](https://petabridge.com/) is a company dedicated to making it easier for .NET developers to build distributed applications.
88 | 
89 | Petabridge provides Akka.NET consulting and training, including advanced training in [Akka.Remote](https://petabridge.com/training/akka-remoting/), [Akka.Cluster](https://petabridge.com/training/akka-clustering/), and [Akka.NET Design Patterns](https://petabridge.com/training/akka-design-patterns/)!
90 | 
91 | ---
92 | Copyright 2015 Petabridge, LLC
93 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                                  Apache License
  2 |                            Version 2.0, January 2004
  3 |                         http://www.apache.org/licenses/
  4 | 
  5 |    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
  6 | 
  7 |    1. Definitions.
  8 | 
  9 |       "License" shall mean the terms and conditions for use, reproduction,
 10 |       and distribution as defined by Sections 1 through 9 of this document.
 11 | 
 12 |       "Licensor" shall mean the copyright owner or entity authorized by
 13 |       the copyright owner that is granting the License.
 14 | 
 15 |       "Legal Entity" shall mean the union of the acting entity and all
 16 |       other entities that control, are controlled by, or are under common
 17 |       control with that entity. For the purposes of this definition,
 18 |       "control" means (i) the power, direct or indirect, to cause the
 19 |       direction or management of such entity, whether by contract or
 20 |       otherwise, or (ii) ownership of fifty percent (50%) or more of the
 21 |       outstanding shares, or (iii) beneficial ownership of such entity.
 22 | 
 23 |       "You" (or "Your") shall mean an individual or Legal Entity
 24 |       exercising permissions granted by this License.
 25 | 
 26 |       "Source" form shall mean the preferred form for making modifications,
 27 |       including but not limited to software source code, documentation
 28 |       source, and configuration files.
 29 | 
 30 |       "Object" form shall mean any form resulting from mechanical
 31 |       transformation or translation of a Source form, including but
 32 |       not limited to compiled object code, generated documentation,
 33 |       and conversions to other media types.
 34 | 
 35 |       "Work" shall mean the work of authorship, whether in Source or
 36 |       Object form, made available under the License, as indicated by a
 37 |       copyright notice that is included in or attached to the work
 38 |       (an example is provided in the Appendix below).
 39 | 
 40 |       "Derivative Works" shall mean any work, whether in Source or Object
 41 |       form, that is based on (or derived from) the Work and for which the
 42 |       editorial revisions, annotations, elaborations, or other modifications
 43 |       represent, as a whole, an original work of authorship. For the purposes
 44 |       of this License, Derivative Works shall not include works that remain
 45 |       separable from, or merely link (or bind by name) to the interfaces of,
 46 |       the Work and Derivative Works thereof.
 47 | 
 48 |       "Contribution" shall mean any work of authorship, including
 49 |       the original version of the Work and any modifications or additions
 50 |       to that Work or Derivative Works thereof, that is intentionally
 51 |       submitted to Licensor for inclusion in the Work by the copyright owner
 52 |       or by an individual or Legal Entity authorized to submit on behalf of
 53 |       the copyright owner. For the purposes of this definition, "submitted"
 54 |       means any form of electronic, verbal, or written communication sent
 55 |       to the Licensor or its representatives, including but not limited to
 56 |       communication on electronic mailing lists, source code control systems,
 57 |       and issue tracking systems that are managed by, or on behalf of, the
 58 |       Licensor for the purpose of discussing and improving the Work, but
 59 |       excluding communication that is conspicuously marked or otherwise
 60 |       designated in writing by the copyright owner as "Not a Contribution."
 61 | 
 62 |       "Contributor" shall mean Licensor and any individual or Legal Entity
 63 |       on behalf of whom a Contribution has been received by Licensor and
 64 |       subsequently incorporated within the Work.
 65 | 
 66 |    2. Grant of Copyright License. Subject to the terms and conditions of
 67 |       this License, each Contributor hereby grants to You a perpetual,
 68 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 69 |       copyright license to reproduce, prepare Derivative Works of,
 70 |       publicly display, publicly perform, sublicense, and distribute the
 71 |       Work and such Derivative Works in Source or Object form.
 72 | 
 73 |    3. Grant of Patent License. Subject to the terms and conditions of
 74 |       this License, each Contributor hereby grants to You a perpetual,
 75 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 76 |       (except as stated in this section) patent license to make, have made,
 77 |       use, offer to sell, sell, import, and otherwise transfer the Work,
 78 |       where such license applies only to those patent claims licensable
 79 |       by such Contributor that are necessarily infringed by their
 80 |       Contribution(s) alone or by combination of their Contribution(s)
 81 |       with the Work to which such Contribution(s) was submitted. If You
 82 |       institute patent litigation against any entity (including a
 83 |       cross-claim or counterclaim in a lawsuit) alleging that the Work
 84 |       or a Contribution incorporated within the Work constitutes direct
 85 |       or contributory patent infringement, then any patent licenses
 86 |       granted to You under this License for that Work shall terminate
 87 |       as of the date such litigation is filed.
 88 | 
 89 |    4. Redistribution. You may reproduce and distribute copies of the
 90 |       Work or Derivative Works thereof in any medium, with or without
 91 |       modifications, and in Source or Object form, provided that You
 92 |       meet the following conditions:
 93 | 
 94 |       (a) You must give any other recipients of the Work or
 95 |           Derivative Works a copy of this License; and
 96 | 
 97 |       (b) You must cause any modified files to carry prominent notices
 98 |           stating that You changed the files; and
 99 | 
100 |       (c) You must retain, in the Source form of any Derivative Works
101 |           that You distribute, all copyright, patent, trademark, and
102 |           attribution notices from the Source form of the Work,
103 |           excluding those notices that do not pertain to any part of
104 |           the Derivative Works; and
105 | 
106 |       (d) If the Work includes a "NOTICE" text file as part of its
107 |           distribution, then any Derivative Works that You distribute must
108 |           include a readable copy of the attribution notices contained
109 |           within such NOTICE file, excluding those notices that do not
110 |           pertain to any part of the Derivative Works, in at least one
111 |           of the following places: within a NOTICE text file distributed
112 |           as part of the Derivative Works; within the Source form or
113 |           documentation, if provided along with the Derivative Works; or,
114 |           within a display generated by the Derivative Works, if and
115 |           wherever such third-party notices normally appear. The contents
116 |           of the NOTICE file are for informational purposes only and
117 |           do not modify the License. You may add Your own attribution
118 |           notices within Derivative Works that You distribute, alongside
119 |           or as an addendum to the NOTICE text from the Work, provided
120 |           that such additional attribution notices cannot be construed
121 |           as modifying the License.
122 | 
123 |       You may add Your own copyright statement to Your modifications and
124 |       may provide additional or different license terms and conditions
125 |       for use, reproduction, or distribution of Your modifications, or
126 |       for any such Derivative Works as a whole, provided Your use,
127 |       reproduction, and distribution of the Work otherwise complies with
128 |       the conditions stated in this License.
129 | 
130 |    5. Submission of Contributions. Unless You explicitly state otherwise,
131 |       any Contribution intentionally submitted for inclusion in the Work
132 |       by You to the Licensor shall be under the terms and conditions of
133 |       this License, without any additional terms or conditions.
134 |       Notwithstanding the above, nothing herein shall supersede or modify
135 |       the terms of any separate license agreement you may have executed
136 |       with Licensor regarding such Contributions.
137 | 
138 |    6. Trademarks. This License does not grant permission to use the trade
139 |       names, trademarks, service marks, or product names of the Licensor,
140 |       except as required for reasonable and customary use in describing the
141 |       origin of the Work and reproducing the content of the NOTICE file.
142 | 
143 |    7. Disclaimer of Warranty. Unless required by applicable law or
144 |       agreed to in writing, Licensor provides the Work (and each
145 |       Contributor provides its Contributions) on an "AS IS" BASIS,
146 |       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 |       implied, including, without limitation, any warranties or conditions
148 |       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 |       PARTICULAR PURPOSE. You are solely responsible for determining the
150 |       appropriateness of using or redistributing the Work and assume any
151 |       risks associated with Your exercise of permissions under this License.
152 | 
153 |    8. Limitation of Liability. In no event and under no legal theory,
154 |       whether in tort (including negligence), contract, or otherwise,
155 |       unless required by applicable law (such as deliberate and grossly
156 |       negligent acts) or agreed to in writing, shall any Contributor be
157 |       liable to You for damages, including any direct, indirect, special,
158 |       incidental, or consequential damages of any character arising as a
159 |       result of this License or out of the use or inability to use the
160 |       Work (including but not limited to damages for loss of goodwill,
161 |       work stoppage, computer failure or malfunction, or any and all
162 |       other commercial damages or losses), even if such Contributor
163 |       has been advised of the possibility of such damages.
164 | 
165 |    9. Accepting Warranty or Additional Liability. While redistributing
166 |       the Work or Derivative Works thereof, You may choose to offer,
167 |       and charge a fee for, acceptance of support, warranty, indemnity,
168 |       or other liability obligations and/or rights consistent with this
169 |       License. However, in accepting such obligations, You may act only
170 |       on Your own behalf and on Your sole responsibility, not on behalf
171 |       of any other Contributor, and only if You agree to indemnify,
172 |       defend, and hold each Contributor harmless for any liability
173 |       incurred by, or claims asserted against, such Contributor by reason
174 |       of your accepting any such warranty or additional liability.
175 | 
176 |    END OF TERMS AND CONDITIONS
177 | 
178 |    APPENDIX: How to apply the Apache License to your work.
179 | 
180 |       To apply the Apache License to your work, attach the following
181 |       boilerplate notice, with the fields enclosed by brackets "{}"
182 |       replaced with your own identifying information. (Don't include
183 |       the brackets!)  The text should be enclosed in the appropriate
184 |       comment syntax for the file format. We also recommend that a
185 |       file or class name and description of purpose be included on the
186 |       same "printed page" as the copyright notice for easier
187 |       identification within third-party archives.
188 | 
189 |    Copyright {yyyy} {name of copyright owner}
190 | 
191 |    Licensed under the Apache License, Version 2.0 (the "License");
192 |    you may not use this file except in compliance with the License.
193 |    You may obtain a copy of the License at
194 | 
195 |        http://www.apache.org/licenses/LICENSE-2.0
196 | 
197 |    Unless required by applicable law or agreed to in writing, software
198 |    distributed under the License is distributed on an "AS IS" BASIS,
199 |    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 |    See the License for the specific language governing permissions and
201 |    limitations under the License.
202 | 
203 | 


--------------------------------------------------------------------------------