Struct ipworksipc::PipeExec

Properties   Methods   Events   Config Settings   Errors  

PipeExec provides an easy way to start and interact with a process over Stdin, Stdout, and Stderr.

Syntax

ipworksipc::PipeExec

Remarks

The PipeExec component provides a way to launch a process and then send/receive data to/from the process. To begin set process_file_name to the path of the process on disk. Optionally set process_args and process_working_dir.

Call start_process to start the process. Next call send to send data to the process. Received data will be provided through the on_stdout and on_stderr events.

To terminate the process call stop_process.

Example Code Pipeexec exec = new Pipeexec(); exec.OnStdout += exec_OnStdout; exec.ProcessFileName = @"C:\Windows\system32\cmd.exe"; exec.ProcessArgs = "/Q"; exec.StartProcess(); exec.Stdin = "dir" + System.Environment.NewLine; while (true) //Wait for output exec.DoEvents(); static void exec_OnStdout(object sender, PipeexecStdoutEventArgs e) { Console.WriteLine(e.Text); }

Object Lifetime

The new() method returns a mutable reference to a struct instance. The object itself is kept in the global list maintained by IPWorksIPC. Due to this, the PipeExec struct cannot be disposed of automatically. Please, call the dispose(&self) method of PipeExec when you have finished using the instance.

Property List

---

The following is the full list of the properties of the struct with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the struct with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the struct with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the struct with short descriptions. Click on the links for further details.

accept_data property (PipeExec Struct)

Indicates whether data reception is currently enabled (the Stdout and Stderr events).

Syntax

fn accept_data(&self) -> Result<bool, IPWorksIPCError> 

Default Value

true

Remarks

This property indicates whether data reception is currently enabled. When False, data reception is disabled and the on_stdout and on_stderr events will not fire. Use the pause_data and process_data methods to control data reception.

This property is read-only.

Data Type

bool

bytes_sent property (PipeExec Struct)

The number of bytes actually sent after a call to the SendStdinText or SendStdinBytes method.

Syntax

fn bytes_sent(&self) -> Result<i32, IPWorksIPCError> 

Default Value

0

Remarks

This property indicates how many bytes were sent after the last call to send_stdin_text or send_stdin_bytes. Please check the send_stdin_text or send_stdin_bytes method for more information. Note: that bytes_sent will always return 0 when the component is operating in synchronous mode (i.e., the timeout property is set to a positive value.)

This property is read-only.

Data Type

i32

eol property (PipeExec Struct)

This property is used to break the incoming data stream into chunks separated by EOL .

Syntax

fn eol(&self) -> Result<Vec<u8>, IPWorksIPCError> 
fn set_eol(&self, value : Vec<u8>) ->  Option<IPWorksIPCError> 
fn set_eol_ref(&self, value : &[u8]) ->  Option<IPWorksIPCError> 

Default Value

""

Remarks

This property is used to define boundaries in the input stream using the value of the property.

This property is especially useful with ASCII files. Setting it to CRLF ("\r\n") enables the incoming ASCII text stream to split into defined lines. In this case, one event is fired for each line received (as well as in packet boundaries). The CRLF ("\r\n") bytes are discarded.

This property is a binary string. Notably, this means that it can be more than one byte long, and it can contain NULL bytes.

Data Type

Vec<u8>

process_args property (PipeExec Struct)

The arguments to pass to the process.

Syntax

fn process_args(&self) -> Result<String, IPWorksIPCError> 
fn set_process_args(&self, value : &str) ->  Option<IPWorksIPCError> 
fn set_process_args_ref(&self, value : &String) ->  Option<IPWorksIPCError> 

Default Value

""

Remarks

This property specifies the arguments that will be passed to the process when it is started.

Data Type

String

process_file_name property (PipeExec Struct)

The path to the file on disk to execute.

Syntax

fn process_file_name(&self) -> Result<String, IPWorksIPCError> 
fn set_process_file_name(&self, value : &str) ->  Option<IPWorksIPCError> 
fn set_process_file_name_ref(&self, value : &String) ->  Option<IPWorksIPCError> 

Default Value

""

Remarks

This property specifies the path to the file on disk that will be executed. process_args optionally specifies the arguments that will be passed. process_working_dir optionally specifies the working directory in which the process will run.

Data Type

String

process_running property (PipeExec Struct)

Whether the process is running.

Syntax

fn process_running(&self) -> Result<bool, IPWorksIPCError> 

Default Value

false

Remarks

This property indicates whether the process specified by process_file_name is running.

After calling start_process this property returns True. After calling stop_process this property returns False.

This property is read-only.

Data Type

bool

process_working_dir property (PipeExec Struct)

The working directory of the process.

Syntax

fn process_working_dir(&self) -> Result<String, IPWorksIPCError> 
fn set_process_working_dir(&self, value : &str) ->  Option<IPWorksIPCError> 
fn set_process_working_dir_ref(&self, value : &String) ->  Option<IPWorksIPCError> 

Default Value

""

Remarks

This property optionally specifies the working directory in which the process will run.

Data Type

String

single_line_mode property (PipeExec Struct)

This property includes a special mode for line-oriented protocols.

Syntax

fn single_line_mode(&self) -> Result<bool, IPWorksIPCError> 
fn set_single_line_mode(&self, value : bool) ->  Option<IPWorksIPCError> 

Default Value

false

Remarks

When this property is set to True, the struct treats the incoming data stream as lines separated by carriage return line feed (CRLF), CR, or LF. The eol property is ignored.

When this property is set to True, accept_data automatically will be set to False. Please refer to the get_line method for more information.

Data Type

bool

timeout property (PipeExec Struct)

This property includes the timeout for the struct.

Syntax

fn timeout(&self) -> Result<i32, IPWorksIPCError> 
fn set_timeout(&self, value : i32) ->  Option<IPWorksIPCError> 

Default Value

60

Remarks

If the timeout property is set to 0, all operations return immediately, potentially failing with a WOULDBLOCK error if data cannot be sent immediately.

If timeout is set to a positive value, data is sent in a blocking manner and the struct will wait for the operation to complete before returning control. The struct will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of timeout seconds.

The struct will use do_events to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If timeout expires, and the operation is not yet complete, the struct fails with an error.

NOTE: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by timeout seconds when any amount of data is successfully sent or received.

The default value for the timeout property is 60 seconds.

Data Type

i32

config method (PipeExec Struct)

Sets or retrieves a configuration setting.

Syntax

fn config(&self, configuration_string : &str) -> Result<String, IPWorksIPCError>

Remarks

config is a generic method available in every struct. It is used to set and retrieve configuration settings for the struct.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

do_events method (PipeExec Struct)

This method processes events from the internal message queue.

Syntax

fn do_events(&self) -> Result<(), IPWorksIPCError>

Remarks

When do_events is called, the struct processes any available events. If no events are available, it waits for a preset period of time, and then returns.

get_line method (PipeExec Struct)

This method gets a line of text from the server.

Syntax

fn get_line(&self) -> Result<String, IPWorksIPCError>

Remarks

This method gets a line of text from the server. This method is an alternative method of receiving data for line-oriented protocols. The struct will block if necessary and then will return the received line. accept_data will be set automatically to True when the method is called, and then will be set to False after a line is received.

Please refer to the single_line_mode property for more information.

interrupt method (PipeExec Struct)

This method interrupts the current action.

Syntax

fn interrupt(&self) -> Result<(), IPWorksIPCError>

Remarks

This method interrupts the current action. If you use send_file to upload a file, the struct will run synchronously until the upload is completed. This method will allow you to stop the file from uploading without disconnecting from the host.

pause_data method (PipeExec Struct)

This method pauses data reception.

Syntax

fn pause_data(&self) -> Result<(), IPWorksIPCError>

Remarks

This method pauses data reception when called. While data reception is paused, the on_stdout and on_stderr events will not fire. Call process_data to reenable data reception.

process_data method (PipeExec Struct)

This method reenables data reception after a call to PauseData.

Syntax

fn process_data(&self) -> Result<(), IPWorksIPCError>

Remarks

This method reenables data reception after a previous call to pause_data. When pause_data is called, data reception is disabled and the on_stdout and on_stderr events no longer fire. Calling this method reenables data reception.

send method (PipeExec Struct)

Sends data over the connected pipe.

Syntax

fn send(&self, text : &[u8]) -> Result<(), IPWorksIPCError>

Remarks

This method sends data to the server.

send_file method (PipeExec Struct)

Sends the file over the connected pipe.

Syntax

fn send_file(&self, file_name : &str) -> Result<(), IPWorksIPCError>

Remarks

This method sends the specified file to the server/process over the connected pipe.

Timeout must be set to a positive value so that the struct will operate synchronously.

send_line method (PipeExec Struct)

This method sends a string followed by a newline.

Syntax

fn send_line(&self, text : &str) -> Result<(), IPWorksIPCError>

Remarks

This method sends a string followed by a newline. This method is used to send data with line-oriented protocols. The line is followed by CRLF ("\r\n") .

Please refer to the get_line method and single_line_mode property for more information.

send_stdin_bytes method (PipeExec Struct)

This method sends binary data over the connected pipe.

Syntax

fn send_stdin_bytes(&self, data : &[u8]) -> Result<(), IPWorksIPCError>

Remarks

This method sends the specified binary data to the server over Stdin. To send text, use the send_stdin_text method instead.

When timeout is set to 0 the struct will behave asynchronously. If you are sending data to the receiving process faster than it can process it, the outgoing queue might fill up. When this happens, the struct fails with error 10035: "[10035] Operation would block" (WSAEWOULDBLOCK). You can check this error, and then try to send the data again. The bytes_sent property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the on_ready_to_send event before attempting to send data again. (However, please note that on_ready_to_send is not fired when part of the data is successfully sent).

send_stdin_text method (PipeExec Struct)

This method sends text over the connected pipe.

Syntax

fn send_stdin_text(&self, text : &str) -> Result<(), IPWorksIPCError>

Remarks

This method sends the specified text to the server over Stdin. To send binary data, use the send_stdin_bytes method instead.

When timeout is set to 0 the struct will behave asynchronously. If you are sending data to the receiving process faster than it can process it, the outgoing queue might fill up. When this happens, the struct fails with error 10035: "[10035] Operation would block" (WSAEWOULDBLOCK). You can check this error, and then try to send the data again. The bytes_sent property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the on_ready_to_send event before attempting to send data again. (However, please note that on_ready_to_send is not fired when part of the data is successfully sent).

start_process method (PipeExec Struct)

Starts the process.

Syntax

fn start_process(&self) -> Result<(), IPWorksIPCError>

Remarks

This method starts the process specified by start_process. After starting the process data may be sent to the process by calling send, send_line, send.

Data received from the process will be available from the on_stdout and on_stderr events.

The following properties are applicable when calling this method:

• process_file_name (required)
• process_args
• process_working_dir

stop_process method (PipeExec Struct)

Stops the process.

Syntax

fn stop_process(&self) -> Result<(), IPWorksIPCError>

Remarks

This method stops the process.

on_error event (PipeExec Struct)

Fired when information is available about errors during data delivery.

Syntax

// PipeExecErrorEventArgs carries the PipeExec Error event's parameters.
pub struct PipeExecErrorEventArgs {
  fn error_code(&self) -> i32
  fn description(&self) -> &String
}

// PipeExecErrorEvent defines the signature of the PipeExec Error event's handler function.
pub trait PipeExecErrorEvent {
  fn on_error(&self, sender : PipeExec, e : &mut PipeExecErrorEventArgs);
}

impl <'a> PipeExec<'a> {
  pub fn on_error(&self) -> &'a dyn PipeExecErrorEvent;
  pub fn set_on_error(&mut self, value : &'a dyn PipeExecErrorEvent);
  ...
}

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the struct fails with an error.

The error_code parameter contains an error code, and the description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

on_ready_to_send event (PipeExec Struct)

Fired when the struct is ready to send data.

Syntax

// PipeExecReadyToSendEventArgs carries the PipeExec ReadyToSend event's parameters.
pub struct PipeExecReadyToSendEventArgs {
}

// PipeExecReadyToSendEvent defines the signature of the PipeExec ReadyToSend event's handler function.
pub trait PipeExecReadyToSendEvent {
  fn on_ready_to_send(&self, sender : PipeExec, e : &mut PipeExecReadyToSendEventArgs);
}

impl <'a> PipeExec<'a> {
  pub fn on_ready_to_send(&self) -> &'a dyn PipeExecReadyToSendEvent;
  pub fn set_on_ready_to_send(&mut self, value : &'a dyn PipeExecReadyToSendEvent);
  ...
}

Remarks

The on_ready_to_send event indicates that the underlying pipe is ready to accept data again after a failed send. The event is also fired immediately after a connection to the remote host is established.

on_stderr event (PipeExec Struct)

Fired when data come in through stderr.

Syntax

// PipeExecStderrEventArgs carries the PipeExec Stderr event's parameters.
pub struct PipeExecStderrEventArgs {
  fn text(&self) -> &[u8]
  fn eol(&self) -> bool
}

// PipeExecStderrEvent defines the signature of the PipeExec Stderr event's handler function.
pub trait PipeExecStderrEvent {
  fn on_stderr(&self, sender : PipeExec, e : &mut PipeExecStderrEventArgs);
}

impl <'a> PipeExec<'a> {
  pub fn on_stderr(&self) -> &'a dyn PipeExecStderrEvent;
  pub fn set_on_stderr(&mut self, value : &'a dyn PipeExecStderrEvent);
  ...
}

Remarks

The on_stderr event is fired every time the process outputs a line in its standard output. The incoming data is provided through the Text parameter.

on_stdout event (PipeExec Struct)

Fired when data come in through stdout.

Syntax

// PipeExecStdoutEventArgs carries the PipeExec Stdout event's parameters.
pub struct PipeExecStdoutEventArgs {
  fn text(&self) -> &[u8]
  fn eol(&self) -> bool
}

// PipeExecStdoutEvent defines the signature of the PipeExec Stdout event's handler function.
pub trait PipeExecStdoutEvent {
  fn on_stdout(&self, sender : PipeExec, e : &mut PipeExecStdoutEventArgs);
}

impl <'a> PipeExec<'a> {
  pub fn on_stdout(&self) -> &'a dyn PipeExecStdoutEvent;
  pub fn set_on_stdout(&mut self, value : &'a dyn PipeExecStdoutEvent);
  ...
}

Remarks

The on_stdout event is fired every time the process outputs a line in its standard output. The incoming data is provided through the Text parameter.

EOL indicates whether or not the eol string was found at the end of Text. If the eol string was found, then EOL is True.

If Text is part of a data portion of length larger than MaxLineLength with no eol strings in it, then EOL is False. NOTE: This means that one or more on_data_in events with EOL set to False can be received during a connection.

If the eol property is "" (empty string), then EOL can be disregarded (it is always True).

Config Settings (PipeExec Struct)

The struct accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the struct, access to these internal properties is provided through the config method.

PipeExec Config Settings

Base Config Settings

Trappable Errors (PipeExec Struct)

PipeExec Errors