# LibTmux.ControlSignal

- **Module:** LibTmux
- **Package:** LibTmux
- **Language:** Julia
- **Kind:** struct
- **Source:** https://github.com/libtmux/libtmux-julia/blob/f3da513be1225d36d5854cd8db5972c01857578e/src/control.jl#L84
- **Page:** https://libtmux.org/en/julia/latest/reference/libtmux-controlsignal/

```
(var"#ctor-self#"::Type{LibTmux.ControlSignal{C}} where C)(
    connection,
    name,
    state,
    notified,
    request,
    cleanup_queued,
    cleanup_done,
    error
)

LibTmux.ControlSignal(
    connection::C,
    name::String,
    state::Symbol,
    notified::Bool,
    request::Union{Nothing, LibTmux._ControlRequest},
    cleanup_queued::Bool,
    cleanup_done::Bool,
    error::Union{Nothing, Exception}
) where C
```

A bounded, one-use wait signal whose tmux channel belongs to its connection.

## Methods

### `ControlSignal` (overload 1)

```julia
(var"#ctor-self#"::Type{LibTmux.ControlSignal{C}} where C)(
    connection,
    name,
    state,
    notified,
    request,
    cleanup_queued,
    cleanup_done,
    error
)
```

[Source](https://github.com/libtmux/libtmux-julia/blob/f3da513be1225d36d5854cd8db5972c01857578e/src/control.jl#L86).

### `ControlSignal` (overload 2)

```julia
LibTmux.ControlSignal(
    connection::C,
    name::String,
    state::Symbol,
    notified::Bool,
    request::Union{Nothing, LibTmux._ControlRequest},
    cleanup_queued::Bool,
    cleanup_done::Bool,
    error::Union{Nothing, Exception}
) where C
```

[Source](https://github.com/libtmux/libtmux-julia/blob/f3da513be1225d36d5854cd8db5972c01857578e/src/control.jl#L86).

## Parameters

- `connection` (`Any`) (for `ControlSignal(connection, name, state, notified, request, cleanup_queued, cleanup_done, error) [overload 1]`)
- `name` (`Any`) (for `ControlSignal(connection, name, state, notified, request, cleanup_queued, cleanup_done, error) [overload 1]`)
- `state` (`Any`) (for `ControlSignal(connection, name, state, notified, request, cleanup_queued, cleanup_done, error) [overload 1]`)
- `notified` (`Any`) (for `ControlSignal(connection, name, state, notified, request, cleanup_queued, cleanup_done, error) [overload 1]`)
- `request` (`Any`) (for `ControlSignal(connection, name, state, notified, request, cleanup_queued, cleanup_done, error) [overload 1]`)
- `cleanup_queued` (`Any`) (for `ControlSignal(connection, name, state, notified, request, cleanup_queued, cleanup_done, error) [overload 1]`)
- `cleanup_done` (`Any`) (for `ControlSignal(connection, name, state, notified, request, cleanup_queued, cleanup_done, error) [overload 1]`)
- `error` (`Any`) (for `ControlSignal(connection, name, state, notified, request, cleanup_queued, cleanup_done, error) [overload 1]`)
- `connection` (`C`) (for `ControlSignal(connection, name, state, notified, request, cleanup_queued, cleanup_done, error) [overload 2]`)
- `name` (`String`) (for `ControlSignal(connection, name, state, notified, request, cleanup_queued, cleanup_done, error) [overload 2]`)
- `state` (`Symbol`) (for `ControlSignal(connection, name, state, notified, request, cleanup_queued, cleanup_done, error) [overload 2]`)
- `notified` (`Bool`) (for `ControlSignal(connection, name, state, notified, request, cleanup_queued, cleanup_done, error) [overload 2]`)
- `request` (`Union{Nothing, LibTmux._ControlRequest}`) (for `ControlSignal(connection, name, state, notified, request, cleanup_queued, cleanup_done, error) [overload 2]`)
- `cleanup_queued` (`Bool`) (for `ControlSignal(connection, name, state, notified, request, cleanup_queued, cleanup_done, error) [overload 2]`)
- `cleanup_done` (`Bool`) (for `ControlSignal(connection, name, state, notified, request, cleanup_queued, cleanup_done, error) [overload 2]`)
- `error` (`Union{Nothing, Exception}`) (for `ControlSignal(connection, name, state, notified, request, cleanup_queued, cleanup_done, error) [overload 2]`)

## Members

### Other members

- `cleanup_done` (property)
- `cleanup_queued` (property)
- `connection` (property)
- `error` (property)
- `name` (property)
- `notified` (property)
- `request` (property)
- `state` (property)