Table of Contents

Name

linx_get_descriptor() - Get the lower level socket descriptor associated with a LINX endpoint

Synopsis

#include <linx_types.h>
#include <linx.h>

int linx_get_descriptor(LINX *linx);

Description

The linx_get_descriptor() call returns the underlying socket descriptor of a LINX endpoint. This socket descriptor is usually not needed, when using the LINX API.

However, it must be used if the application wants to wait for multiple sockets, maybe of different types, using the generic select(2) call. When a state change occurs, the select(2) call returns and the application can map the descriptor to the correct LINX endpoint (unless it is another socket type). If a state change was reported for a LINX endpoint, the application can use LINX API function calls on this endpoint to take care of the event.

Alternatively use the low level LINX Socket API directly on the underlying socket descriptor.

linx is the handle to the LINX endpoint.

If linx is not a valid LINX endpoint, i.e. created with linx_open(3) then abort(3) is called.

Return Value

Returns a socket descriptor.

Bugs/Limitations

None.

Notes

Never close a LINX socket descriptor with socket functions. This must be handled by linx_close(3) to enforce freeing of the corresponding memory resources of the LINX endpoint.

See Also

linx(7) , linx_open(3) , select(2)

Author

Enea LINX team

Copyright

Copyright (c) 2006-2007, Enea Software AB All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. Neither the name of Enea Software AB nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

Table of Contents