## Uses of Interface
org.red5.server.messaging.IPipe

Packages that use IPipe
Package | Description
--- | ---
org.red5.server.api.scope |
org.red5.server.messaging |
org.red5.server.scope |
org.red5.server.stream |
org.red5.server.stream.consumer |
org.red5.server.stream.filter |
org.red5.server.stream.provider |

### Uses of IPipe in org.red5.server.api.scope

Subinterfaces of IPipe in org.red5.server.api.scope
Modifier and Type | Interface and Description
--- | ---
`interface` | `IBroadcastScope` Broadcast scope is marker interface that represents object that works as basic scope and has pipe connection event dispatching capabilities.

### Uses of IPipe in org.red5.server.messaging

Classes in org.red5.server.messaging that implement IPipe
Modifier and Type | Class and Description
--- | ---
`class` | `AbstractPipe` Abstract pipe that books providers/consumers and listeners.
`class` | `InMemoryPullPullPipe` A simple in-memory version of pull-pull pipe.
`class` | `InMemoryPushPushPipe` A simple in-memory version of push-push pipe.

Methods in org.red5.server.messaging with parameters of type IPipe
Modifier and Type | Method and Description
--- | ---
`static void` | PipeUtils.`connect(IProvider provider, IPipe pipe, IConsumer consumer)` Connect a provider/consumer with a pipe.
`static void` | PipeUtils.`disconnect(IProvider provider, IPipe pipe, IConsumer consumer)` Disconnect a provider/consumer from a pipe.
`void` | IMessageComponent.`onOOBControlMessage(IMessageComponent source, IPipe pipe, OOBControlMessage oobCtrlMsg)`
`IMessage` | IPullableProvider.`pullMessage(IPipe pipe)`
`IMessage` | IPullableProvider.`pullMessage(IPipe pipe, long wait)`
`void` | IPushableConsumer.`pushMessage(IPipe pipe, IMessage message)` Pushes message through pipe

### Uses of IPipe in org.red5.server.scope

Classes in org.red5.server.scope that implement IPipe
Modifier and Type | Class and Description
--- | ---
`class` | `BroadcastScope` Scope type for publishing that deals with pipe connection events, like async message listening in JMS

### Uses of IPipe in org.red5.server.stream

Fields in org.red5.server.stream declared as IPipe
Modifier and Type | Field and Description
--- | ---
`protected IPipe` | ClientBroadcastStream.`livePipe` Pipe for live streaming

Methods in org.red5.server.stream with parameters of type IPipe
Modifier and Type | Method and Description
--- | ---
`void` | ClientBroadcastStream.`onOOBControlMessage(IMessageComponent source, IPipe pipe, OOBControlMessage oobCtrlMsg)` Out-of-band control message handler
`void` | PlayEngine.`onOOBControlMessage(IMessageComponent source, IPipe pipe, OOBControlMessage oobCtrlMsg)`
`void` | ServerStream.`onOOBControlMessage(IMessageComponent source, IPipe pipe, OOBControlMessage oobCtrlMsg)`
`void` | ClientBroadcastStream.`pushMessage(IPipe pipe, IMessage message)` Currently not implemented
`void` | PlayEngine.`pushMessage(IPipe pipe, IMessage message)` Pushes message through pipe
`void` | ServerStream.`pushMessage(IPipe pipe, IMessage message)` Pushes message through pipe

### Uses of IPipe in org.red5.server.stream.consumer

Methods in org.red5.server.stream.consumer with parameters of type IPipe
Modifier and Type | Method and Description
--- | ---
`void` | ConnectionConsumer.`onOOBControlMessage(IMessageComponent source, IPipe pipe, OOBControlMessage oobCtrlMsg)`
`void` | FileConsumer.`onOOBControlMessage(IMessageComponent source, IPipe pipe, OOBControlMessage oobCtrlMsg)` Out-of-band control message handler
`void` | ConnectionConsumer.`pushMessage(IPipe pipe, IMessage message)` Pushes message through pipe
`void` | FileConsumer.`pushMessage(IPipe pipe, IMessage message)` Push message through pipe

### Uses of IPipe in org.red5.server.stream.filter

Methods in org.red5.server.stream.filter with parameters of type IPipe
Modifier and Type | Method and Description
--- | ---
`void` | StreamBandwidthController.`onOOBControlMessage(IMessageComponent source, IPipe pipe, OOBControlMessage oobCtrlMsg)`

### Uses of IPipe in org.red5.server.stream.provider

Methods in org.red5.server.stream.provider with parameters of type IPipe
Modifier and Type | Method and Description
--- | ---
`void` | ConnectionProvider.`onOOBControlMessage(IMessageComponent source, IPipe pipe, OOBControlMessage oobCtrlMsg)`
`void` | FileProvider.`onOOBControlMessage(IMessageComponent source, IPipe pipe, OOBControlMessage oobCtrlMsg)`
`IMessage` | FileProvider.`pullMessage(IPipe pipe)`
`IMessage` | FileProvider.`pullMessage(IPipe pipe, long wait)`