oc_portman.h File Reference

Module for managing port reservations. More...

#include <oc_errors.h>
#include <oc_module.h>
#include <oc_process.h>

Go to the source code of this file.

Data Structures
struct	oC_PortMan_Config_t
	stores configuration of the module More...

Typedefs
typedef uint32_t	oC_PortMan_Port_t
	stores the port number

Functions
oC_ErrorCode_t	oC_PortMan_TurnOn (void)
	turns on the module More...
oC_ErrorCode_t	oC_PortMan_TurnOff (void)
	turns off the module More...
oC_ErrorCode_t	oC_PortMan_RegisterModule (oC_Module_t Module, const oC_PortMan_Config_t *Config, oC_Time_t Timeout)
	registers module in the port manager More...
oC_ErrorCode_t	oC_PortMan_UnregisterModule (oC_Module_t Module, oC_Time_t Timeout)
	unregisters module in the port manager More...
oC_ErrorCode_t	oC_PortMan_ReservePort (oC_Module_t Module, oC_PortMan_Port_t *Port, oC_Time_t Timeout)
	reserves a port of the given module More...
oC_ErrorCode_t	oC_PortMan_ReleasePort (oC_Module_t Module, oC_PortMan_Port_t Port, oC_Time_t Timeout)
	releases port More...
oC_ErrorCode_t	oC_PortMan_ReleaseAllPortsOf (oC_Module_t Module, oC_Process_t Process, oC_Time_t Timeout)
	releases all ports reserved by a given process More...
bool	oC_PortMan_IsPortReserved (oC_Module_t Module, oC_PortMan_Port_t Port)
	returns true if port is reserved More...
bool	oC_PortMan_IsPortReservedBy (oC_Module_t Module, oC_PortMan_Port_t Port, oC_Process_t Process)
	checks if the given port is reserved by the given process More...

Detailed Description

---

Author

Patryk Kubiak

Note

Copyright (C) 2016 Patryk Kubiak patry.nosp@m.k.ku.nosp@m.biak9.nosp@m.0@gm.nosp@m.ail.c.nosp@m.om

Copyright

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA

Definition in file oc_portman.h.