gensio_control - Man Page

Set the enable/disable for any NAGLE type algorithms. For put the data should be a string "1" to disable delay, or "0" to enable delay. Return value from a get is a string "1" or "0".

Return information about incoming and outgoing streams for the gensio. This is read(get)-only and returns the value in the data in the form "instream=<n>,ostream=<n>".  Used by SCTP.

Request that a break be sent over the line (primarily for telnet).

Return the object from the certificate from the remote end.  This is primarily for SSL and certauth so the application can validate the certificate's common name, but it can fetch any object from the certificate.

There are two ways to use this interface: fetch by index or fetch by object type.

To fetch by index, just pass in a number in the data, like "0" and it will fetch the value at that index.

To fetch by object type, pass in a number and the object type separated by a comma.  The object type to fetch is SN (short name) or LN (long name) descriptor per /usr/include/openssl/object.h.  Like "CN" or "commonName".  The index should be one less than the start search, you should use -1, for instance to fetch the first index.

The data returned is in the form: "<index>,<sn>,<value>". Where sn is the short name.

In fetch by object type mode, there may be more than one of an object in a certificate, so this interface can handle that. just pass in the index returned by the first into the second call and it will start after that index.  For instance, to fetch the first common name, do (with error checking removed for clarity):

strcpy(data, "-1,CN");
gensio_control(io, 0, true, data, &len)

Say it returns "3,CN,MyName.org"  You would use

strcpy(data, "3,CN");
gensio_control(io, 0, true, data, &len)

to get the next common name, which might be "4,CN,MyName2.org". You get an GE_NOTFOUND at the end.

Returns GE_NOCERT if there is no remote certificate, GE_CERTINVAL if the passed in object name is not valid, and GE_NOTFOUND if the object was not available in the certificate.

Set the certificate authority file to the string in data. If it ends in '/', it is assumed to be a directory, otherwise it is assumed to be a file.  This generally must be done before authorization is done, generally before open or in the GENSIO_EVENT_PRECERT_VERIFY event (see gensio_event(3) for details).

Get/set the username for the gensio, generally the username sent from the client end on a certauth gensio.  This is always a string.

Get/set the password for the gensio, generally the password sent from the client end on a certauth gensio.  This is always a string.  On the server side this will only be available in the GENSIO_EVENT_PASSWORD_VERIFY event. and is cleared outside of that.

Get/set the 2-factor auth data for the gensio, generally the data sent from the client end on a certauth gensio.  This is non-nil terminated binary data, generally.  On the server side this will only be available in the GENSIO_EVENT_PASSWORD_VERIFY event or the GENSIO_2FA_VERIFY event and is cleared outside of that.

On a client, set the service data passed by the gensio to the server. On a server, et the service sent from the gensio client, generally available on a certauth server.  Returns GE_DATAMISSING if a service was not sent.

This is a binary control, so arbitrary data can be passed in the service.

Get the full certificate in text form sent from the other end.

Get the fingerprint for the certificate from the other end.

Set the environment pointer for an exec.  For pty and stdio connecter gensios.  The data is a pointer to an argv array (char * const envp[])

Set the arguments for an exec.  For pty and stdio connecter gensios. The data is a pointer to an argv array (char * const argv[])

On a packet gensio, return the maximum packet size that can be sent. Any write of this amount or less will be sent as a single message that will be delivered as one read on the other end, or it will not be sent at all (zero-byte send count).

On a stdio connectors and pty gensios, the exit code of the process that ran.  This is only valid after close has completed.  An integer string is returned.

Attempt to terminate the task.  The passed in string is converted (strtol) to an integer, if if it non-zero, a forced kill (kill -9) is done, otherwise a normal terminate is done.

On a stdio connectors and pty gensios, do a waitpid on the process. If it has closed, this will return success and the exit code in the string.  Otherwise it will return GE_NOTREADY.

On UDP/AX25 gensios, add a multicast/UI address that the gensio will receive packets on.

On UDP/AX25 gensios, delete a multicast/UI address that the gensio will receive packets on.

On AX25 gensios, return the given UI address.  The data string passed in should be the string representation of a the number (like created with snprintf()) for the particular index you want to fetch.  If you specify a number larger than the number of open listen sockets, GE_NOTFOUND is returned.  The return data is a string holding the address.

On UDP connections, sets whether multicast packets sent on the socket will be received by the same machine.  Takes/returns string boolean "true" or "false".  Defaults to false.

Sets the multicast time-to-live.  Takes/returns a string integer. The default is 1, meaning multicast stays in the local network. Increasing this value increases the number of hops over multicast routers a send packet will traverse.

Return the local address for the connection.  Only for network connections or sound devices.

For network devices, since a single gensio may have more than one local address, this control provides a means to tell which one.  The data string passed in should be the string representation of a the number (like created with snprintf()) for the particular index you want to fetch.  If you specify a number larger than the number of open listen sockets, GE_NOTFOUND is returned.  The return data is a string holding the address.

Note that a single fetched string may contain more than one address. These will be separated by semicolons.  In some cases addresses may change dynamically (like with SCTP), so you get a single set of addresses.

For sound devices, pass in "in" or "out" in the string to get the full card number or name that uniquely identifies the sound card.

For an AX25 gensio, add the given listen address to the addresses that will accept connections for the gensio.

For an AX25 gensio, delete the given listen address to the addresses that will accept connections for the gensio.  This is the address string, not the instance number.

Like Gensio_control_laddr but gets the remote addresses on a gensio.  The gensio may need to be open.  This is only implemented on bottom-level gensios, like serialdev, network interfaces, echo, file, ipmisol, etc.

Return the binary remote address for the given gensio.  Only implemented for network gensios and pty.

Return the local port for the connection.  Only for network connections.  This is useful if you pass in "0" for the port to let the OS chose; you can get the actual port chosen.

Close writing to the gensio, but leave reading along.  This is only for stdio gensios; it lets you close stdin to the subprogram without affecting the subprogram's stdout.

Return the address the connection was made to.  For SCTP. gensio_raddr_to_str() returns all the remote addresses in SCTP's current state.  This will return the addresses that the original connectx was done to.

Return some sort of remote id for what is on the other end of the connection.  Not implemented for most gensios, only for getting the pid on a pty and stdio and the file descriptor on serialdev.

Return auxiliary sent on the connection.  On certauth, this will be sent to the remote end and be available for them.

Return auxiliary received from the other end of the connection.  On certauth, this will be received from the remote end.

Used to get the IOD pointer for the gensio as a raw pointer.  For gensios that have more than one IOD, the string you pass in will be a string number representing which IOD, "0" for the first (stdin), "1" for the second (stdout), and "2" for the third, (stderr).

This enables extra info to be returned on a received UDP packet.  If this is set to non-zero (normal string like "1" passed in), extra fields will be added to the auxdata in received packets.  These field are: "daddr:<address>" with the destination address from the packet and "ifidx:<n>" with the integer interface index the packet was received on.

Out of band (OOB) data is disabled by default on all gensios and setting this to non-zero (normal string like "1" passed in) will enable it.  Note that you should only set this on the gensio you are directly communicating with, it is used between some gensios.

For pty gensios, sets the window size of the virtual window.  The value is a string with four values separated by ":".  The first two are the number of rows and number of columns.  The second two are number of horizontal pixels and number of vertical pixels.  The pixel values are currently ignored by windows.  pixel values do not have to be given, if there are less than 4 values, pixels values are ignored and set to zero.  datalen is ignored.

For pty and stdio gensios (that start another program), this will cause the new program to run in the given directory instead of the current directory.

For sound gensios, return the sample rate for the gensio for input or output.

For sound gensios, return the buffer size in bytes for input our output.  The data will be delivered to upper layer in chunks of this size.

For sound gensios, return the number of channels for the interface for input or output.

For sound gensios, return the format of the user data.  Like "float", "int16be", etc.

The amount of data left to be transmitted.  For sound, this is in frames.

For ax25, this is the number of pending sent frames.  If you pass in a "0", it will count frames for the current conneciton.  If you pass in "1", it will count frames for all connections.

The following set various serial port values.

On the client these set the value or request the value from the other end.  When getting the data value is not used.  When setting the data value is a string with a number or setting.  The response in the done callback reports a string with the set value (which may be different than the requested value) in the same format as the request.

On the server these are used to respond to a client event.  The done callback is ignored.

GENSIO_ACONTROL_SER_BAUD
is the baud rate as a number.  For instance, setting to "1200" sets 1200 baud.  Not all gensio support all baud rates.

GENSIO_ACONTROL_SER_DATASIZE
is the datasize, a number from "5" to "8".  Not all gensio support all data sizes.

GENSIO_ACONTROL_SER_PARITY
sets the parity, one of "none", "odd", "even", "mark" or "space".  You can use gensio_parity_to_str and gensio_str_to_parity to convert between the string and numeric values. gensio_parity_to_str returns NULL if the number isn't value, gensio_str_to_parity returns -1 if the string is not valid.

GENSIO_ACONTROL_SER_STOPBITS
sets the number of stop bits, "1", or "2".

GENSIO_ACONTROL_SER_FLOWCONTROL
sets the flow control type, one of "none", "xonxoff", or "rtscts".  You can use gensio_flowcontrol_to_str and gensio_str_to_flowcontrol to convert between the string and numeric values. gensio_flowcontrol_to_str returns NULL if the number isn't value, gensio_str_to_flowcontrol returns -1 if the string is not valid.

GENSIO_ACONTROL_SER_IFLOWCONTROL
sets the input flow state, one of "none", "dcd", "dtr", or "dsr".  You use the same conversion functions as GENSIO_ACONTROL_SER_FLOWCONTROL for converting between strings and integers.

GENSIO_ACONTROL_SER_SBREAK
Enables or disables the break condition on a serial port.  One of "on" or "off".  You can use gensio_onoff_to_str and gensio_str_to_onoff to convert between the string and numeric values. gensio_onoff_to_str returns NULL if the number isn't value, gensio_str_to_onoff returns -1 if the string is not valid.

GENSIO_ACONTROL_SER_DTR
Enables or disables the DTR line on a serial port.  One of "on" or "off". See GENSIO_ACONTROL_SER_SBREAK for string/integer conversions.

GENSIO_ACONTROL_SER_RTS
Enables or disables the RTS line on a serial port.  One of "on" or "off". See GENSIO_ACONTROL_SER_SBREAK for string/integer conversions.

GENSIO_ACONTROL_SER_CTS
Enables or disables the CTS line on a serial port.  One of "on" or "off".  ipmisol only. See GENSIO_ACONTROL_SER_SBREAK for string/integer conversions.

GENSIO_ACONTROL_SER_DCD_DSR
Enables or disables the DCD and DTR lines on a serial port.  One of "on" or "off".  ipmisol only. See GENSIO_ACONTROL_SER_SBREAK for string/integer conversions.

GENSIO_ACONTROL_SER_RI
Enables or disables the RI line on a serial port.  One of "on" or "off".  ipmisol only. See GENSIO_ACONTROL_SER_SBREAK for string/integer conversions.

GENSIO_ACONTROL_SER_SIGNATURE
Fetches or reports the rfc2217 signature for a serial port.  This is an arbitrary string.  telnet only.

GENSIO_ACONTROL_SER_FLUSH
Sends a flush to the other end and gets the response.

GENSIO_ACONTROL_SER_SET_MODEMSTATE_MASK
Set the modemstate mask on the other end and get the response.  Values to or together are: GENSIO_SER_MODEMSTATE_CTS, GENSIO_SER_MODEMSTATE_DSR, GENSIO_SER_MODEMSTATE_RI, GENSIO_SER_MODEMSTATE_CD.

GENSIO_ACONTROL_SER_SET_LINESTATE_MASK
Set the linestate mask on the other end and get the response.  Values to or together are: GENSIO_SER_LINESTATE_DATA_READY, GENSIO_SER_LINESTATE_OVERRUN_ERR, GENSIO_SER_LINESTATE_PARITY_ERR, GENSIO_SER_LINESTATE_FRAMING_ERR, GENSIO_SER_LINESTATE_BREAK, GENSIO_SER_LINESTATE_XMIT_HOLD_EMPTY, GENSIO_SER_LINESTATE_XMIT_SHIFT_EMPTY, GENSIO_SER_LINESTATE_TIMEOUT_ERR.

These set (on the client) the mask used to monitor various lines on a serial ports.  The bits set will be the ones reported in the corresponding events.  These are numbers in strings, you bitwise or the values together.

GENSIO_CONTROL_SER_SEND_MODEMSTATE
Send a modemstate message to the other end.  In addition to the ones listed for GENSIO_CONTROL_SER_AMODEMSTATE_MASK, you also have bits that tell if the value changed from the last report: GENSIO_SER_MODEMSTATE_CTS_CHANGED, GENSIO_SER_MODEMSTATE_DSR_CHANGED, GENSIO_SER_MODEMSTATE_RI_CHANGED, GENSIO_SER_MODEMSTATE_CD_CHANGED.

GENSIO_CONTROL_SER_SEND_LINESTATE
Send a linestate message to the other end.

This is a set of other operations that can be performed on a serial port.

GENSIO_CONTROL_SER_FLOWCONTROL_STATE

GENSIO_CONTROL_SER_SEND_BREAK
requests a serial break (of arbitrary length) be sent.  The value is not used.