dm_pipe Module

Module for basic subprocess management on Unix. Procedures with name postfix 2 are for bi-directional IPC, all other for uni-directional only.


Uses

  • module~~dm_pipe~~UsesGraph module~dm_pipe dm_pipe module~dm_error dm_error module~dm_pipe->module~dm_error module~dm_kind dm_kind module~dm_pipe->module~dm_kind unix unix module~dm_pipe->unix module~dm_error->module~dm_kind module~dm_ascii dm_ascii module~dm_error->module~dm_ascii iso_fortran_env iso_fortran_env module~dm_kind->iso_fortran_env

Used by

  • module~~dm_pipe~~UsedByGraph module~dm_pipe dm_pipe module~dm_freebsd dm_freebsd module~dm_freebsd->module~dm_pipe module~dm_linux dm_linux module~dm_linux->module~dm_pipe module~dm_plot dm_plot module~dm_plot->module~dm_pipe module~dmpack dmpack module~dmpack->module~dm_pipe module~dmpack->module~dm_freebsd module~dmpack->module~dm_linux module~dmpack->module~dm_plot module~dm_report dm_report module~dmpack->module~dm_report module~dm_report->module~dm_plot proc~dm_system_cpu_cores dm_system_cpu_cores proc~dm_system_cpu_cores->module~dm_freebsd proc~dm_system_cpu_cores->module~dm_linux proc~dm_system_cpu_model dm_system_cpu_model proc~dm_system_cpu_model->module~dm_freebsd proc~dm_system_cpu_model->module~dm_linux proc~dm_system_cpu_temperature dm_system_cpu_temperature proc~dm_system_cpu_temperature->module~dm_freebsd proc~dm_system_cpu_temperature->module~dm_linux proc~dm_system_disk_free dm_system_disk_free proc~dm_system_disk_free->module~dm_freebsd proc~dm_system_disk_free->module~dm_linux proc~dm_system_load_average dm_system_load_average proc~dm_system_load_average->module~dm_freebsd proc~dm_system_load_average->module~dm_linux

Variables

Type Visibility Attributes Name Initial
integer, public, parameter :: PIPE_RDONLY = 1

Read-only access.
integer, public, parameter :: PIPE_WRONLY = 2

Write-only access.

Derived Types

type, public ::  pipe_type

Opaque pipe type. Stores the C pointer of uni-directional pipe.


Functions

public function dm_pipe_is_connected(pipe) result(connected)

Returns .true. if pipe is connected.

Arguments

Type IntentOptional Attributes Name
type(pipe_type), intent(inout) :: pipe

Pipe type.

Return Value logical

public function dm_pipe_execute(command, output, n) result(rc)

Utility function that reads output from pipe. The output must be at least the length of the expected output + 1, due to the returned null-termination. The null character at the end will be removed.

Read more…

Arguments

Type IntentOptional Attributes Name
character(len=*), intent(in) :: command

Command.
character(len=*), intent(inout) :: output

Output string.
integer(kind=i8), intent(out), optional :: n

String length.

Return Value integer

public function dm_pipe_open(pipe, command, access) result(rc)

Opens a process by creating a pipe, forking, and invoking the shell. Access mode has to be either PIPE_RDONLY or PIPE_WRONLY.

Read more…

Arguments

Type IntentOptional Attributes Name
type(pipe_type), intent(inout) :: pipe

Pipe type.
character(len=*), intent(in) :: command

Name or path of binary to open.
integer, intent(in) :: access

Open pipe for reading or writing.

Return Value integer

public function dm_pipe_open2(stdin, stdout, stderr, command) result(rc)

Creates three anonymous pipes for bidirectional IPC (stdin, stdout, stderr).

Read more…

Arguments

Type IntentOptional Attributes Name
type(pipe_type), intent(out) :: stdin

Standard input handle.
type(pipe_type), intent(out) :: stdout

Standard output handle.
type(pipe_type), intent(out) :: stderr

Standard error handle.
character(len=*), intent(in) :: command

Program to invoke.

Return Value integer

public function dm_pipe_read(pipe, output, n) result(rc)

Reads from pipe to buffer output (binary) and returns number of bytes read from buffer.

Read more…

Arguments

Type IntentOptional Attributes Name
type(pipe_type), intent(inout) :: pipe

Bi-directional pipe.
character(len=*), intent(inout), target :: output

Output buffer.
integer(kind=i8), intent(out), optional :: n

Bytes read.

Return Value integer

public function dm_pipe_read_line(pipe, output, n) result(rc)

Reads line string from pipe to buffer output and removes new-line and null-termination.

Read more…

Arguments

Type IntentOptional Attributes Name
type(pipe_type), intent(inout) :: pipe

Bi-directional pipe.
character(len=*), intent(inout) :: output

Output buffer.
integer, intent(out), optional :: n

Bytes read.

Return Value integer

public function dm_pipe_write(pipe, input) result(rc)

Writes bytes to pipe, adds new line and null-termination. The input string is not trimmed.

Read more…

Arguments

Type IntentOptional Attributes Name
type(pipe_type), intent(inout) :: pipe

Pipe type.
character(len=*), intent(in) :: input

Bytes to write to the pipe.

Return Value integer

public function dm_pipe_write2(pipe, input, n) result(rc)

Writes to pipe (binary) and returns the number of bytes written in n. The input string is not trimmed.

Read more…

Arguments

Type IntentOptional Attributes Name
type(pipe_type), intent(inout) :: pipe

Bi-directional pipe.
character(len=*), intent(in), target :: input

Bytes to write to the pipe.
integer(kind=i8), intent(out), optional :: n

Bytes written.

Return Value integer


Subroutines

public subroutine dm_pipe_close(pipe, exit_stat)

Closes pipe to process.

Arguments

Type IntentOptional Attributes Name
type(pipe_type), intent(inout) :: pipe

Pipe type.
integer, intent(out), optional :: exit_stat

Exit status.

public subroutine dm_pipe_close2(pipe, exit_stat)

Closes pipe to process (binary).

Arguments

Type IntentOptional Attributes Name
type(pipe_type), intent(inout) :: pipe

Pipe type.
integer, intent(out), optional :: exit_stat

Exit status.