Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ Factory Orchestrator :green_heart: OSS.

* **IpcServiceFramework**

FactoryOrchestrator forks the source of [IpcServiceFramework](https://github.com/jacqueskang/IpcServiceFramework). The fork is equivalent the latest IpcServiceFramework source as of December 2020, with only a project file change to set DisableDynamicCodeGeneration to true so it can be used in .NET Native applications.
FactoryOrchestrator forks the source of [IpcServiceFramework](https://github.com/jacqueskang/IpcServiceFramework). The fork is equivalent the latest IpcServiceFramework source as of December 2020, with additions to support client authentication and logging.

* **Pe-Utility**

Expand Down
2 changes: 0 additions & 2 deletions build/FixupAPIMarkdown.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,13 @@ Param
$ErrorActionPreference = "stop"

Write-Host "Fixing markdown in $DefaultDocumentationFolder."
Write-Host "Replacing 'https://docs.microsoft.com/en-us/dotnet/api/Microsoft.FactoryOrchestrator.Core.' paths..."
Write-Host "Replacing '``1'' strings..."

$mds = Get-ChildItem -Path $DefaultDocumentationFolder -Include "*.md" -Recurse

foreach ($md in $mds)
{
$content = Get-Content $md
$content = $content.Replace("https://docs.microsoft.com/en-us/dotnet/api/Microsoft.FactoryOrchestrator.Core.", "./../../CoreLibrary/Microsoft-FactoryOrchestrator-Core-")
$content = $content.Replace("``1'","'")
Set-Content -Path $md -Value $content
}
18 changes: 9 additions & 9 deletions docs/AddAPILinks.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,15 @@ $regex = '\(.*\)'
$scriptDir = Split-Path $script:MyInvocation.MyCommand.Path
$docPath = [System.IO.Path]::Join($scriptDir, "docs")
$userDocs = Get-ChildItem -Path $docPath -filter "*.md"
$apiDocs = Get-ChildItem -Path $docPath -filter "Microsoft-FactoryOrchestrator-Core-TaskList*.md" -Recurse
$apiDocs += Get-ChildItem -Path $docPath -filter "Microsoft-FactoryOrchestrator-Core-TaskBase*.md" -Recurse
$apiDocs += Get-ChildItem -Path $docPath -filter "Microsoft-FactoryOrchestrator-Core-UWPTask.md" -Recurse
$apiDocs += Get-ChildItem -Path $docPath -filter "Microsoft-FactoryOrchestrator-Core-ExecutableTask.md" -Recurse
$apiDocs += Get-ChildItem -Path $docPath -filter "Microsoft-FactoryOrchestrator-Core-PowerShellTask.md" -Recurse
$apiDocs += Get-ChildItem -Path $docPath -filter "Microsoft-FactoryOrchestrator-Core-ExternalTask.md" -Recurse
$apiDocs += Get-ChildItem -Path $docPath -filter "Microsoft-FactoryOrchestrator-Core-TaskRun*.md" -Recurse
$apiDocs += Get-ChildItem -Path $docPath -filter "Microsoft-FactoryOrchestrator-Client-FactoryOrchestratorClient-*.md" -Recurse
$apiDocs += Get-ChildItem -Path $docPath -filter "Microsoft-FactoryOrchestrator-Client-ServerPoller-*.md" -Recurse
$apiDocs = Get-ChildItem -Path $docPath -filter "TaskList*.md" -Recurse
$apiDocs += Get-ChildItem -Path $docPath -filter "TaskBase*.md" -Recurse
$apiDocs += Get-ChildItem -Path $docPath -filter "UWPTask.md" -Recurse
$apiDocs += Get-ChildItem -Path $docPath -filter "ExecutableTask.md" -Recurse
$apiDocs += Get-ChildItem -Path $docPath -filter "PowerShellTask.md" -Recurse
$apiDocs += Get-ChildItem -Path $docPath -filter "ExternalTask.md" -Recurse
$apiDocs += Get-ChildItem -Path $docPath -filter "TaskRun*.md" -Recurse
$apiDocs += Get-ChildItem -Path $docPath -filter "FactoryOrchestratorClient_*.md" -Recurse
$apiDocs += Get-ChildItem -Path $docPath -filter "ServerPoller_*.md" -Recurse
$apiDocs = $apiDocs | Sort-Object -Descending
$apiNames = @{}

Expand Down
116 changes: 116 additions & 0 deletions docs/docs/ClientLibrary/FactoryOrchestratorClient.md

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
### [Microsoft.FactoryOrchestrator.Client](Microsoft_FactoryOrchestrator_Client.md 'Microsoft.FactoryOrchestrator.Client').[FactoryOrchestratorClient](FactoryOrchestratorClient.md 'Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient')
## FactoryOrchestratorClient.AbortAll() Method
Asynchronously Stops all executing Tasks and/or TaskLists.
```csharp
public System.Threading.Tasks.Task AbortAll();
```
#### Returns
[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task')
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
### [Microsoft.FactoryOrchestrator.Client](Microsoft_FactoryOrchestrator_Client.md 'Microsoft.FactoryOrchestrator.Client').[FactoryOrchestratorClient](FactoryOrchestratorClient.md 'Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient')
## FactoryOrchestratorClient.AbortTaskList(Guid) Method
Asynchronously Stops executing a TaskList.
```csharp
public System.Threading.Tasks.Task AbortTaskList(System.Guid taskListGuid);
```
#### Parameters
<a name='Microsoft_FactoryOrchestrator_Client_FactoryOrchestratorClient_AbortTaskList(System_Guid)_taskListGuid'></a>
`taskListGuid` [System.Guid](https://docs.microsoft.com/en-us/dotnet/api/System.Guid 'System.Guid')
The GUID of the TaskList to stop.

#### Returns
[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task')
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
### [Microsoft.FactoryOrchestrator.Client](Microsoft_FactoryOrchestrator_Client.md 'Microsoft.FactoryOrchestrator.Client').[FactoryOrchestratorClient](FactoryOrchestratorClient.md 'Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient')
## FactoryOrchestratorClient.AbortTaskRun(Guid) Method
Asynchronously Stops executing a TaskRun.
```csharp
public System.Threading.Tasks.Task AbortTaskRun(System.Guid taskRunGuid);
```
#### Parameters
<a name='Microsoft_FactoryOrchestrator_Client_FactoryOrchestratorClient_AbortTaskRun(System_Guid)_taskRunGuid'></a>
`taskRunGuid` [System.Guid](https://docs.microsoft.com/en-us/dotnet/api/System.Guid 'System.Guid')
The GUID of the TaskRun to stop.

#### Returns
[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task')
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
### [Microsoft.FactoryOrchestrator.Client](Microsoft_FactoryOrchestrator_Client.md 'Microsoft.FactoryOrchestrator.Client').[FactoryOrchestratorClient](FactoryOrchestratorClient.md 'Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient')
## FactoryOrchestratorClient.CertificateHash Property
Hash value for server certificate.
```csharp
public string CertificateHash { get; set; }
```
#### Property Value
[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
### [Microsoft.FactoryOrchestrator.Client](Microsoft_FactoryOrchestrator_Client.md 'Microsoft.FactoryOrchestrator.Client').[FactoryOrchestratorClient](FactoryOrchestratorClient.md 'Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient')
## FactoryOrchestratorClient.ClientCertificate Property
Client certificate sent to the device running Factory Orchestrator Service for client authentication.
```csharp
public System.Security.Cryptography.X509Certificates.X509Certificate2 ClientCertificate { get; set; }
```
#### Property Value
[System.Security.Cryptography.X509Certificates.X509Certificate2](https://docs.microsoft.com/en-us/dotnet/api/System.Security.Cryptography.X509Certificates.X509Certificate2 'System.Security.Cryptography.X509Certificates.X509Certificate2')
14 changes: 14 additions & 0 deletions docs/docs/ClientLibrary/FactoryOrchestratorClient_Connect(bool).md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
### [Microsoft.FactoryOrchestrator.Client](Microsoft_FactoryOrchestrator_Client.md 'Microsoft.FactoryOrchestrator.Client').[FactoryOrchestratorClient](FactoryOrchestratorClient.md 'Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient')
## FactoryOrchestratorClient.Connect(bool) Method
Establishes a connection to the Factory Orchestrator Service.
Throws an exception if it cannot connect.
```csharp
public System.Threading.Tasks.Task Connect(bool ignoreVersionMismatch=false);
```
#### Parameters
<a name='Microsoft_FactoryOrchestrator_Client_FactoryOrchestratorClient_Connect(bool)_ignoreVersionMismatch'></a>
`ignoreVersionMismatch` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')
If true, ignore a Client-Service version mismatch.

#### Returns
[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task')
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
### [Microsoft.FactoryOrchestrator.Client](Microsoft_FactoryOrchestrator_Client.md 'Microsoft.FactoryOrchestrator.Client').[FactoryOrchestratorClient](FactoryOrchestratorClient.md 'Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient')
## FactoryOrchestratorClient.Connect(string, string) Method
Asynchronously Connects the specified client to the service.
```csharp
public System.Threading.Tasks.Task Connect(string clientIdentifer, string message="");
```
#### Parameters
<a name='Microsoft_FactoryOrchestrator_Client_FactoryOrchestratorClient_Connect(string_string)_clientIdentifer'></a>
`clientIdentifer` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
Friendly identifier for the client.

<a name='Microsoft_FactoryOrchestrator_Client_FactoryOrchestratorClient_Connect(string_string)_message'></a>
`message` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
An optional message.

#### Returns
[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task')
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
### [Microsoft.FactoryOrchestrator.Client](Microsoft_FactoryOrchestrator_Client.md 'Microsoft.FactoryOrchestrator.Client').[FactoryOrchestratorClient](FactoryOrchestratorClient.md 'Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient')
## FactoryOrchestratorClient.CreateClientFileReader(string) Method
Creates the client file reader.
```csharp
protected virtual System.IO.Stream CreateClientFileReader(string clientFilename);
```
#### Parameters
<a name='Microsoft_FactoryOrchestrator_Client_FactoryOrchestratorClient_CreateClientFileReader(string)_clientFilename'></a>
`clientFilename` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
The client filename.

#### Returns
[System.IO.Stream](https://docs.microsoft.com/en-us/dotnet/api/System.IO.Stream 'System.IO.Stream')
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
### [Microsoft.FactoryOrchestrator.Client](Microsoft_FactoryOrchestrator_Client.md 'Microsoft.FactoryOrchestrator.Client').[FactoryOrchestratorClient](FactoryOrchestratorClient.md 'Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient')
## FactoryOrchestratorClient.CreateClientFileWriter(string) Method
Creates the client file writer. File is overwritten if it exists.
```csharp
protected virtual System.IO.Stream CreateClientFileWriter(string clientFilename);
```
#### Parameters
<a name='Microsoft_FactoryOrchestrator_Client_FactoryOrchestratorClient_CreateClientFileWriter(string)_clientFilename'></a>
`clientFilename` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
The client filename.

#### Returns
[System.IO.Stream](https://docs.microsoft.com/en-us/dotnet/api/System.IO.Stream 'System.IO.Stream')
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
### [Microsoft.FactoryOrchestrator.Client](Microsoft_FactoryOrchestrator_Client.md 'Microsoft.FactoryOrchestrator.Client').[FactoryOrchestratorClient](FactoryOrchestratorClient.md 'Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient')
## FactoryOrchestratorClient.CreateDirectory(string) Method
Creates a directory on the client.
```csharp
protected virtual void CreateDirectory(string path);
```
#### Parameters
<a name='Microsoft_FactoryOrchestrator_Client_FactoryOrchestratorClient_CreateDirectory(string)_path'></a>
`path` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
Directory to create.

Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
### [Microsoft.FactoryOrchestrator.Client](Microsoft_FactoryOrchestrator_Client.md 'Microsoft.FactoryOrchestrator.Client').[FactoryOrchestratorClient](FactoryOrchestratorClient.md 'Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient')
## FactoryOrchestratorClient.CreateIpcException(Exception) Method
Creates a FactoryOrchestratorConnectionException or promotes the Server exception if needed.
```csharp
private System.Exception CreateIpcException(System.Exception ex);
```
#### Parameters
<a name='Microsoft_FactoryOrchestrator_Client_FactoryOrchestratorClient_CreateIpcException(System_Exception)_ex'></a>
`ex` [System.Exception](https://docs.microsoft.com/en-us/dotnet/api/System.Exception 'System.Exception')

#### Returns
[System.Exception](https://docs.microsoft.com/en-us/dotnet/api/System.Exception 'System.Exception')
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
### [Microsoft.FactoryOrchestrator.Client](Microsoft_FactoryOrchestrator_Client.md 'Microsoft.FactoryOrchestrator.Client').[FactoryOrchestratorClient](FactoryOrchestratorClient.md 'Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient')
## FactoryOrchestratorClient.CreateIpcRequest(string) Method
Creates the IPC request.
```csharp
protected static JKang.IpcServiceFramework.IpcRequest CreateIpcRequest(string methodName);
```
#### Parameters
<a name='Microsoft_FactoryOrchestrator_Client_FactoryOrchestratorClient_CreateIpcRequest(string)_methodName'></a>
`methodName` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
Name of the method. The method is assumed to have no parameters.

#### Returns
[JKang.IpcServiceFramework.IpcRequest](https://docs.microsoft.com/en-us/dotnet/api/JKang.IpcServiceFramework.IpcRequest 'JKang.IpcServiceFramework.IpcRequest')
IpcRequest object
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
### [Microsoft.FactoryOrchestrator.Client](Microsoft_FactoryOrchestrator_Client.md 'Microsoft.FactoryOrchestrator.Client').[FactoryOrchestratorClient](FactoryOrchestratorClient.md 'Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient')
## FactoryOrchestratorClient.CreateIpcRequest(string, object[]) Method
Creates the IPC request.
```csharp
protected static JKang.IpcServiceFramework.IpcRequest CreateIpcRequest(string methodName, params object[] args);
```
#### Parameters
<a name='Microsoft_FactoryOrchestrator_Client_FactoryOrchestratorClient_CreateIpcRequest(string_object__)_methodName'></a>
`methodName` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
Name of the method.

<a name='Microsoft_FactoryOrchestrator_Client_FactoryOrchestratorClient_CreateIpcRequest(string_object__)_args'></a>
`args` [System.Object](https://docs.microsoft.com/en-us/dotnet/api/System.Object 'System.Object')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array')
The arguments to the method.

#### Returns
[JKang.IpcServiceFramework.IpcRequest](https://docs.microsoft.com/en-us/dotnet/api/JKang.IpcServiceFramework.IpcRequest 'JKang.IpcServiceFramework.IpcRequest')
IpcRequest object
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
### [Microsoft.FactoryOrchestrator.Client](Microsoft_FactoryOrchestrator_Client.md 'Microsoft.FactoryOrchestrator.Client').[FactoryOrchestratorClient](FactoryOrchestratorClient.md 'Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient')
## FactoryOrchestratorClient.CreateTaskListFromDirectory(string, bool) Method
Asynchronously Creates a new TaskList by finding all .exe, .cmd, .bat, .ps1, and TAEF files in a given folder.
```csharp
public System.Threading.Tasks.Task<Microsoft.FactoryOrchestrator.Core.TaskList> CreateTaskListFromDirectory(string path, bool recursive=false);
```
#### Parameters
<a name='Microsoft_FactoryOrchestrator_Client_FactoryOrchestratorClient_CreateTaskListFromDirectory(string_bool)_path'></a>
`path` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
Path of the directory to search.

<a name='Microsoft_FactoryOrchestrator_Client_FactoryOrchestratorClient_CreateTaskListFromDirectory(string_bool)_recursive'></a>
`recursive` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')
If true, search recursively.

#### Returns
[System.Threading.Tasks.Task&lt;](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task')[TaskList](./../CoreLibrary/TaskList.md 'Microsoft.FactoryOrchestrator.Core.TaskList')[&gt;](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task')
The created TaskList
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
### [Microsoft.FactoryOrchestrator.Client](Microsoft_FactoryOrchestrator_Client.md 'Microsoft.FactoryOrchestrator.Client').[FactoryOrchestratorClient](FactoryOrchestratorClient.md 'Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient')
## FactoryOrchestratorClient.CreateTaskListFromTaskList(TaskList) Method
Asynchronously Creates a TaskList on the Service by copying a TaskList object provided by the Client.
```csharp
public System.Threading.Tasks.Task<Microsoft.FactoryOrchestrator.Core.TaskList> CreateTaskListFromTaskList(Microsoft.FactoryOrchestrator.Core.TaskList list);
```
#### Parameters
<a name='Microsoft_FactoryOrchestrator_Client_FactoryOrchestratorClient_CreateTaskListFromTaskList(Microsoft_FactoryOrchestrator_Core_TaskList)_list'></a>
`list` [TaskList](./../CoreLibrary/TaskList.md 'Microsoft.FactoryOrchestrator.Core.TaskList')
The TaskList to add to the Service.

#### Returns
[System.Threading.Tasks.Task&lt;](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task')[TaskList](./../CoreLibrary/TaskList.md 'Microsoft.FactoryOrchestrator.Core.TaskList')[&gt;](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task-1 'System.Threading.Tasks.Task')
The created Service TaskList.
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
### [Microsoft.FactoryOrchestrator.Client](Microsoft_FactoryOrchestrator_Client.md 'Microsoft.FactoryOrchestrator.Client').[FactoryOrchestratorClient](FactoryOrchestratorClient.md 'Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient')
## FactoryOrchestratorClient.DeleteFileOrFolder(string, bool) Method
Asynchronously Permanently deletes a file or folder. If a folder, all contents are deleted.
```csharp
public System.Threading.Tasks.Task DeleteFileOrFolder(string path, bool deleteInContainer=false);
```
#### Parameters
<a name='Microsoft_FactoryOrchestrator_Client_FactoryOrchestratorClient_DeleteFileOrFolder(string_bool)_path'></a>
`path` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
File or folder to delete

<a name='Microsoft_FactoryOrchestrator_Client_FactoryOrchestratorClient_DeleteFileOrFolder(string_bool)_deleteInContainer'></a>
`deleteInContainer` [System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')
If true, delete the file from the container running on the connected device.

#### Returns
[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task')
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
### [Microsoft.FactoryOrchestrator.Client](Microsoft_FactoryOrchestrator_Client.md 'Microsoft.FactoryOrchestrator.Client').[FactoryOrchestratorClient](FactoryOrchestratorClient.md 'Microsoft.FactoryOrchestrator.Client.FactoryOrchestratorClient')
## FactoryOrchestratorClient.DeleteTaskList(Guid) Method
Asynchronously Deletes a TaskList on the Service.
```csharp
public System.Threading.Tasks.Task DeleteTaskList(System.Guid listToDelete);
```
#### Parameters
<a name='Microsoft_FactoryOrchestrator_Client_FactoryOrchestratorClient_DeleteTaskList(System_Guid)_listToDelete'></a>
`listToDelete` [System.Guid](https://docs.microsoft.com/en-us/dotnet/api/System.Guid 'System.Guid')
The GUID of the TaskList to delete.

#### Returns
[System.Threading.Tasks.Task](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.Tasks.Task 'System.Threading.Tasks.Task')
true if it was deleted successfully.
Loading