Provides methods for interacting with Docker networks. More...
Inheritance diagram for DockerSdk.Networks.NetworkAccess:
Public Member Functions | |
| IDisposable | Subscribe (IObserver< NetworkEvent > observer) |
| Subscribes to events about networks. More... | |
| Task< INetwork > | GetAsync (string network, CancellationToken ct=default) |
| Loads an object that can be used to interact with the indicated network. More... | |
| async Task< INetwork > | GetAsync (NetworkReference network, CancellationToken ct=default) |
| Loads an object that can be used to interact with the indicated network. More... | |
| Task< INetworkInfo > | GetInfoAsync (string network, CancellationToken ct=default) |
| Loads detailed information about a Docker network. More... | |
| async Task< INetworkInfo > | GetInfoAsync (NetworkReference network, CancellationToken ct=default) |
| Loads detailed information about a Docker network. More... | |
| Task< IReadOnlyList< INetwork > > | ListAsync (CancellationToken ct=default) |
| Gets a list of Docker networks known to the daemon. More... | |
| async Task< IReadOnlyList< INetwork > > | ListAsync (ListNetworksOptions options, CancellationToken ct=default) |
| Gets a list of Docker networks known to the daemon. More... | |
Detailed Description
Provides methods for interacting with Docker networks.
Member Function Documentation
◆ GetAsync() [1/2]
|
inline |
Loads an object that can be used to interact with the indicated network.
- Parameters
-
network A network name or ID. ct A token used to cancel the operation.
- Returns
- A Task<TResult> that resolves to the network object.
- Exceptions
-
NetworkNotFoundException No such network exists. System.Net.Http.HttpRequestException The request failed due to an underlying issue such as loss of network connectivity. ArgumentNullException The network input is null.
◆ GetAsync() [2/2]
| Task<INetwork> DockerSdk.Networks.NetworkAccess.GetAsync | ( | string | network, |
| CancellationToken | ct = default |
||
| ) |
Loads an object that can be used to interact with the indicated network.
- Parameters
-
network A network name or ID. ct A token used to cancel the operation.
- Returns
- A Task<TResult> that resolves to the network object.
- Exceptions
-
NetworkNotFoundException No such network exists. System.Net.Http.HttpRequestException The request failed due to an underlying issue such as loss of network connectivity. MalformedReferenceException The network reference is improperly formatted. ArgumentNullException The network input is null.
◆ GetInfoAsync() [1/2]
|
inline |
Loads detailed information about a Docker network.
- Parameters
-
network A network name or ID. ct A token used to cancel the operation.
- Returns
- A Task<TResult> that resolves to the details.
- Exceptions
-
NetworkNotFoundException No such network exists. System.Net.Http.HttpRequestException The request failed due to an underlying issue such as network connectivity. ArgumentNullException An input is null.
◆ GetInfoAsync() [2/2]
| Task<INetworkInfo> DockerSdk.Networks.NetworkAccess.GetInfoAsync | ( | string | network, |
| CancellationToken | ct = default |
||
| ) |
Loads detailed information about a Docker network.
- Parameters
-
network A network name or ID. ct A token used to cancel the operation.
- Returns
- A Task<TResult> that resolves to the details.
- Exceptions
-
NetworkNotFoundException No such network exists. System.Net.Http.HttpRequestException The request failed due to an underlying issue such as network connectivity. MalformedReferenceException The network reference is improperly formatted. ArgumentNullException The network input is null.
◆ ListAsync() [1/2]
| Task<IReadOnlyList<INetwork> > DockerSdk.Networks.NetworkAccess.ListAsync | ( | CancellationToken | ct = default | ) |
Gets a list of Docker networks known to the daemon.
- Parameters
-
ct A token used to cancel the operation.
- Returns
- A Task<TResult> that resolves to the list of images.
The sequence of the results is undefined.
- Exceptions
-
System.Net.Http.HttpRequestException The request failed due to an underlying issue such as network connectivity. ArgumentNullException An input is null.
◆ ListAsync() [2/2]
|
inline |
Gets a list of Docker networks known to the daemon.
- Parameters
-
options Filters for the search. ct A token used to cancel the operation.
- Returns
- A Task<TResult> that resolves to the list of images.
The sequence of the results is undefined.
- Exceptions
-
System.Net.Http.HttpRequestException The request failed due to an underlying issue such as network connectivity. ArgumentNullException An input is null.
◆ Subscribe()
| IDisposable DockerSdk.Networks.NetworkAccess.Subscribe | ( | IObserver< NetworkEvent > | observer | ) |
Subscribes to events about networks.
- Parameters
-
observer An object to observe the events.
- Returns
- An IDisposable representing the subscription. Disposing this unsubscribes and releases resources.
The documentation for this class was generated from the following file:
- Networks/NetworkAccess.cs
