ioctl()

The ioctl() socket call performs special operations on sockets.

Syntax

#include <types.h>
#include <sys\socket.h>
#include <sys\ioctl.h>
#include <net\route.h>
#include <net\if.h>
#include <net\if_arp.h>
int ioctl(s, cmd, data)
int s;
int cmd;
caddr_t data;

Parameters

Socket descriptor. cmd

Command to perform. data

cmd

Description

This call controls the operating characteristics of sockets. The data parameter is a pointer to data associated with the particular command, and its format depends on the command that is requested.

Option

Description

FIOASYNC

Thisoptionhasnoeffect . FIONBIO

data

FIONREAD

data

Internet: The following ioctl commands are supported for the internet domain:

Option

Description

OSIOCGIFADDR

data

OSIOCGIFDSTADDR

data

OSIOCGIFBRDADDR

data

OSIOCGIFCONF

data

OSIOCGIFNETMASK

data

SIOCADDMULTI

data

SIOCADDRT

data

SIOCAIFADDR

data

SIOCARP

data

SIOCATMARK

data

SIOCDARP

data

arpreq

SIOCDELMULTI

data

SIOCDELRT

data

SIOCDIFADDR

data

SIOCGARP

data

SIOCGARP _ TR

data

SIOCGIFADDR

data

SIOCGIFBOUND

data

bindinds

bound

SIOCGIFBRDADDR

data

SIOCGIFCONF

data

SIOCGIFDSTADDR

data

SIOCGIFEFLAGS

data

SIOCGIFFLAGS

data

SIOCGIFMETRIC

data

SIOCGIFMTU

data

SIOCGIFNETMASK

data

SIOCGIFTRACE

data

ifr _ data

SIOCGIFVALID

data

SIOCGMCAST

data

SIOCGMSL

GetstheTCPMaximumSegmentLifetime( MSL )value ,inseconds . SIOCGSTAT

data

SIOCGUNIT

Getstheinterfaceunitnumber . SIOCMULTISBC

UsebroadcastforphysicaltransmissionofIPmulticastdatagrams( RFC1469 ) . SIOCMULTISFA

UsefunctionaladdressforphysicaltransmissionofIPmulticastdatagrams( RFC1469 ) . SIOCSARP

data

arpreq

SIOCSARP _ TR

data

SIOCSHOSTID

data

SIOCSIF802 _ 3

data

SIOCSIFADDR

data

SIOCSIFALLRTB

data

SIOCSIFBRD

data

SIOCSIFBRDADDR

data

SIOCSIFDSTADDR

data

SIOCSIFEFLAGS

data

SIOCSIFFDDI

data

SIOCSIFFLAGS

data

SIOCSIFMETRIC

data

SIOCSIFMTU

data

SIOCSIFNETMASK

data

SIOCSIFNO802 _ 3

data

SIOCSIFNOFDDI

Setsthetoken - ringinterfacetousenoncanonicalformatforARP . SIOCSIFNOREDIR

data

SIOCSIFRUNNINGBLK

data

SIOCSIFTRACE

data

SIOCSIFYESREDIR

data

SIOCSMSL

SetstheTCPMaximumSegmentLifetime( MSL )valueinseconds . SIOCSRDBRD

Enablesloopbackforbroadcastpackets . SIOCSSTAT

data

SIOCSSYN

data

SIOFLUSHRT

Flushestheentireroutingtable ,includingallroutestoallinterfaces . SIOFLUSHRTIFP

data

SIOSTATCNTAT

GetsthecountofARPentries . SIOSTATCNTRT

Getsthecountofentriesintheroutingtable . SIOSTATICMP

data

SIOSTATICMPZ

data

SIOSTATIGMP

data

SIOSTATIGMPZ

data

SIOSTATIP

data

SIOSTATIPZ

data

SIOSTATMBUF

data

SIOSTATTCP

data

SIOSTATTCPZ

data

SIOSTATUDP

data

SIOSTATUDPZ

data

NetBIOS: The following ioctl() calls are supported for the NetBIOS domain:

Option

Description

SIOCGNBNAME

data

SIOCGNCBFN

data

SIOCSNBNAME

data

Return Values

The value 0 indicates success; the value -1 indicates an error. You can get the specific error code by calling sock_errno() or psock_errno().

sock_errno() Value

Description

SOCENOTSOCK

SOCEINVAL

Therequestisnotvalidornotsupported . SOCEOPNOTSUPP

Theoperationisnotsupportedonthesocket . SOCEFAULT

data

Examples

The following is an example of the ioctl() call.

int s;int dontblock;
int rc;
int ioctl(int s, int cmd, caddr_t data);  /* extracted from sys\socket.h */
...
/* Place the socket into nonblocking mode */
dontblock = 1;
rc = ioctl(s, FIONBIO, (char *) &dontblock);
...

Related Calls

os2_ioctl()
sock_errno()

[Back: getsockopt()]
[Next: listen()]