Class ZODocker

Inheritance

System.Object

ZODocker

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: ZO.Util

Assembly: Unity.ZeroSim.dll

Syntax

public static class ZODocker

Methods

DockerRun(ZODockerRunParameters)

Docker Run with docker run parameters.

Declaration

public static void DockerRun(ZODockerRunParameters runParameters)

Parameters

Type	Name	Description
ZODockerRunParameters	runParameters

DockerRunRemoteAsync(String, String, String, String, List<ZODocker.VolumeMapEntry>, List<Int32>, List<String>, Boolean, Boolean, Boolean)

Run a remote docker. https://docs.docker.com/engine/reference/commandline/run/

Declaration

public static Task DockerRunRemoteAsync(string uri, string imageName, string containerName, string command, List<ZODocker.VolumeMapEntry> volumes = null, List<int> ports = null, List<string> environments = null, bool setupROS = false, bool setupVNC = false, bool showOutput = false)

Parameters

Type	Name	Description
System.String	uri
System.String	imageName
System.String	containerName
System.String	command
System.Collections.Generic.List<ZODocker.VolumeMapEntry>	volumes
System.Collections.Generic.List<System.Int32>	ports
System.Collections.Generic.List<System.String>	environments	A list of environment variables to set inside the container.
System.Boolean	setupROS	Do any ROS specific setup, such as opening up ports 9090 (ROS Bridge) and 11311 (ROS Master).
System.Boolean	setupVNC	Do any VNC specific setup.
System.Boolean	showOutput

Returns

Type	Description
System.Threading.Tasks.Task

DockerRunRemoteAsync(ZODockerRunParameters)

Run remote docker using ZODockerRunParameters.

Declaration

public static Task DockerRunRemoteAsync(ZODockerRunParameters runParameters)

Parameters

Type	Name	Description
ZODockerRunParameters	runParameters

Returns

Type	Description
System.Threading.Tasks.Task

DockerRunROS(String, String, String, List<ZODocker.VolumeMapEntry>, List<Int32>, List<String>, Boolean, Boolean, Boolean)

Docker run with special ROS specific parameters. https://docs.docker.com/engine/reference/commandline/run/

Declaration

public static void DockerRunROS(string imageName, string containerName, string command, List<ZODocker.VolumeMapEntry> volumes = null, List<int> ports = null, List<string> environments = null, bool runX11 = false, bool setupROS = false, bool showOutput = false)

Parameters

Type	Name	Description
System.String	imageName
System.String	containerName
System.String	command
System.Collections.Generic.List<ZODocker.VolumeMapEntry>	volumes
System.Collections.Generic.List<System.Int32>	ports
System.Collections.Generic.List<System.String>	environments
System.Boolean	runX11
System.Boolean	setupROS
System.Boolean	showOutput

DockerStop(String)

Stop a docker container.

Declaration

public static void DockerStop(string containerName)

Parameters

Type	Name	Description
System.String	containerName	The name of the container.

DockerStopRemoteAsync(String, String)

Stop and remove remote docker.

Declaration

public static Task DockerStopRemoteAsync(string containerName, string uri)

Parameters

Type	Name	Description
System.String	containerName
System.String	uri

Returns

Type	Description
System.Threading.Tasks.Task