Class: ProcessExecuter::Destinations::MonitoredPipe Private

Inherits:
ProcessExecuter::DestinationBase show all
Defined in:
lib/process_executer/destinations/monitored_pipe.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Handles monitored pipes

Instance Attribute Summary

Attributes inherited from ProcessExecuter::DestinationBase

#data_written, #destination

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ProcessExecuter::DestinationBase

#compatible_with_monitored_pipe?, compatible_with_monitored_pipe?, #initialize, #string

Constructor Details

This class inherits a constructor from ProcessExecuter::DestinationBase

Class Method Details

.handles?(destination) ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Determines if this class can handle the given destination

Parameters:

  • destination (Object) —

    the destination to check

Returns:

  • (Boolean) —

    true if destination is a ProcessExecuter::MonitoredPipe



34
35
36
 
# File 'lib/process_executer/destinations/monitored_pipe.rb', line 34

def self.handles?(destination)
  destination.is_a? ProcessExecuter::MonitoredPipe
end

Instance Method Details

#close

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method returns an undefined value.

Closes the pipe if it's open



26
27
28
 
# File 'lib/process_executer/destinations/monitored_pipe.rb', line 26

def close
  destination.close if destination.state == :open
end

#write(data) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Writes data to the monitored pipe

Examples:

pipe = ProcessExecuter::MonitoredPipe.new
pipe_handler = ProcessExecuter::Destinations::MonitoredPipe.new(pipe)
pipe_handler.write("Data to pipe")

Parameters:

  • data (String) —

    the data to write

Returns:

  • (Object) —

    the return value of the pipe's write method



18
19
20
21
 
# File 'lib/process_executer/destinations/monitored_pipe.rb', line 18

def write(data)
  super
  destination.write data
end