stomp_status.h File Reference

#include <stdlib.h>
#include <stdint.h>
#include <stdio.h>
#include <stdarg.h>

Go to the source code of this file.

Data Structures
struct	stomp_status_t_

Typedefs
typedef enum stomp_status_code_t_	stomp_status_code_t
typedef struct stomp_status_t_	stomp_status_t

Enumerations
enum	stomp_status_code_t_ { STOMP_SUCCESS, STOMP_FAILURE }

Functions
void	stomp_status_set (stomp_status_t *status, stomp_status_code_t code, const char *message,...)
void	stomp_status_reset (stomp_status_t *status)
void	stomp_status_success (stomp_status_t *status)

Typedef Documentation

typedef enum stomp_status_code_t_ stomp_status_code_t

Copyright 2016 Otavio Rodolfo Piske

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

typedef struct stomp_status_t_ stomp_status_t

Status type

Enumeration Type Documentation

enum stomp_status_code_t_

Copyright 2016 Otavio Rodolfo Piske

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Enumerator
STOMP_SUCCESS
STOMP_FAILURE

Function Documentation

void stomp_status_reset

(

stomp_status_t *

status

)

Resets the status

Parameters

status

an instance of the status object to set

void stomp_status_set	(	stomp_status_t *	status,
		stomp_status_code_t	code,
		const char *	message,
			...
	)

Sets the status

Parameters

status	an instance of the status object to set
code	the code to set the object to
message	the status message followed by any other parameter as accepted by vasprintf

Copyright 2016 Otavio Rodolfo Piske

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

void stomp_status_success

(

stomp_status_t *

status

)

Sets the status to success

Parameters

status

an instance of the status object to set