RESTClient Struct Reference

#include <RESTClient.h>

Overview

An HTTP REST client backed by URLSession.

RESTClient provides synchronous and asynchronous HTTP verb methods (HEAD, GET, OPTIONS, POST, PATCH, PUT, DELETE) dealing in Data * request and response bodies. JSON marshalling is the caller's responsibility, typically via JSONContext. Every verb accepts an optional headers array for attaching additional request headers.

Definition at line 62 of file RESTClient.h.

Inheritance diagram for RESTClient:

Properties
Object	object
	The superclass.
URLSession *	session
	The URLSession backing this client.
Properties inherited from Object
Class *	clazz
	Every instance of Object begins with a pointer to its Class.
unsigned int	magic
	A header to allow introspection of Object types.

Methods
Class *	_RESTClient (void)
	The RESTClient archetype.
int	del (RESTClient *, const char *, const char **, Data **)
	Synchronously performs an HTTP DELETE request.
void	delAsync (RESTClient *, const char *, const char **, RESTClientCompletion, void *)
	Asynchronously performs an HTTP DELETE request.
int	get (RESTClient *, const char *, const char **, Data **)
	Synchronously performs an HTTP GET request.
void	getAsync (RESTClient *, const char *, const char **, RESTClientCompletion, void *)
	Asynchronously performs an HTTP GET request.
int	head (RESTClient *, const char *, const char **)
	Synchronously performs an HTTP HEAD request.
void	headAsync (RESTClient *, const char *, const char **, RESTClientCompletion, void *)
	Asynchronously performs an HTTP HEAD request.
RESTClient *	init (RESTClient *)
	Initializes this RESTClient with the shared URLSession.
RESTClient *	initWithSession (RESTClient *, URLSession *)
	Initializes this RESTClient with the specified URLSession.
int	options (RESTClient *, const char *, const char **, Data **)
	Synchronously performs an HTTP OPTIONS request.
void	optionsAsync (RESTClient *, const char *, const char **, RESTClientCompletion, void *)
	Asynchronously performs an HTTP OPTIONS request.
int	patch (RESTClient *, const char *, const Data *, const char **, Data **)
	Synchronously performs an HTTP PATCH request.
void	patchAsync (RESTClient *, const char *, const Data *, const char **, RESTClientCompletion, void *)
	Asynchronously performs an HTTP PATCH request.
int	post (RESTClient *, const char *, const Data *, const char **, Data **)
	Synchronously performs an HTTP POST request.
void	postAsync (RESTClient *, const char *, const Data *, const char **, RESTClientCompletion, void *)
	Asynchronously performs an HTTP POST request.
int	put (RESTClient *, const char *, const Data *, const char **, Data **)
	Synchronously performs an HTTP PUT request.
void	putAsync (RESTClient *, const char *, const Data *, const char **, RESTClientCompletion, void *)
	Asynchronously performs an HTTP PUT request.
RESTClient *	sharedInstance (void)
Methods inherited from Object
Class *	_Object (void)
	The Object archetype.
Object *	copy (const Object *self)
	Creates a shallow copy of this Object.
void	dealloc (Object *self)
	Frees all resources held by this Object.
String *	description (const Object *self)
int	hash (const Object *self)
Object *	init (Object *self)
	Initializes this Object.
bool	isEqual (const Object *self, const Object *other)
	Tests equality of the other Object.
bool	isKindOfClass (const Object *self, const Class *clazz)
	Tests for Class hierarchy membership.

Protected Attributes
RESTClientInterface *	interface [0]
	The interface type.
Protected Attributes inherited from Object
ObjectInterface *	interface [0]
	The interface type.

Property Details

interface

RESTClientInterface* RESTClient::interface[0]

protected

The interface type.

Definition at line 73 of file RESTClient.h.

object

Object RESTClient::object

The superclass.

Definition at line 67 of file RESTClient.h.

session

URLSession* RESTClient::session

The URLSession backing this client.

Definition at line 78 of file RESTClient.h.

Method Details

_RESTClient()

Class * _RESTClient

(

void

)

The RESTClient archetype.

Returns

The RESTClient Class.

Definition at line 342 of file RESTClient.c.

                         {
 
  static Class *clazz;
  static Once once;
 
  do_once(&once, {
    clazz = _initialize(&(const ClassDef) {
      .name = "RESTClient",
      .superclass = _Object(),
      .instanceSize = sizeof(RESTClient),
      .interfaceSize = sizeof(RESTClientInterface),
      .initialize = initialize,
      .destroy = destroy,
    });
  });
 
  return clazz;
}

del()

int del	(	RESTClient *	self,
		const char *	url,
		const char **	headers,
		Data **	data
	)

Synchronously performs an HTTP DELETE request.

Parameters

self	The RESTClient.
url	The URL string.
headers	A NULL-terminated array of alternating field/value C strings (e.g. { "X-Field", "value", NULL }) to add to the request, or NULL for none.
data	Optionally receives the retained response body. Caller must release.

Returns

The HTTP response status code, or 0 on connection failure.

Definition at line 154 of file RESTClient.c.

                                                                                     {
  return request(self, HTTP_DELETE, url, NULL, headers, data);
}

delAsync()

void delAsync	(	RESTClient *	self,
		const char *	url,
		const char **	headers,
		RESTClientCompletion	completion,
		void *	userData
	)

Asynchronously performs an HTTP DELETE request.

Parameters

self	The RESTClient.
url	The URL string.
headers	A NULL-terminated array of alternating field/value C strings (e.g. { "X-Field", "value", NULL }) to add to the request, or NULL for none.
completion	The completion handler.
userData	User data passed through to completion.

Definition at line 162 of file RESTClient.c.

                                                     {
  requestAsync(self, HTTP_DELETE, url, NULL, headers, completion, userData);
}

get()

int get	(	RESTClient *	self,
		const char *	url,
		const char **	headers,
		Data **	data
	)

Synchronously performs an HTTP GET request.

Parameters

self	The RESTClient.
url	The URL string.
headers	A NULL-terminated array of alternating field/value C strings (e.g. { "X-Field", "value", NULL }) to add to the request, or NULL for none.
data	Optionally receives the retained response body. Caller must release.

Returns

The HTTP response status code, or 0 on connection failure.

Definition at line 171 of file RESTClient.c.

                                                                                     {
  return request(self, HTTP_GET, url, NULL, headers, data);
}

getAsync()

void getAsync	(	RESTClient *	self,
		const char *	url,
		const char **	headers,
		RESTClientCompletion	completion,
		void *	userData
	)

Asynchronously performs an HTTP GET request.

Parameters

self	The RESTClient.
url	The URL string.
headers	A NULL-terminated array of alternating field/value C strings (e.g. { "X-Field", "value", NULL }) to add to the request, or NULL for none.
completion	The completion handler.
userData	User data passed through to completion.

Definition at line 179 of file RESTClient.c.

                                                     {
  requestAsync(self, HTTP_GET, url, NULL, headers, completion, userData);
}

head()

int head	(	RESTClient *	self,
		const char *	url,
		const char **	headers
	)

Synchronously performs an HTTP HEAD request.

Parameters

self	The RESTClient.
url	The URL string.
headers	A NULL-terminated array of alternating field/value C strings (e.g. { "X-Field", "value", NULL }) to add to the request, or NULL for none.

Returns

The HTTP response status code, or 0 on connection failure.

Definition at line 188 of file RESTClient.c.

                                                                         {
  return request(self, HTTP_HEAD, url, NULL, headers, NULL);
}

headAsync()

void headAsync	(	RESTClient *	self,
		const char *	url,
		const char **	headers,
		RESTClientCompletion	completion,
		void *	userData
	)

Asynchronously performs an HTTP HEAD request.

Parameters

self	The RESTClient.
url	The URL string.
headers	A NULL-terminated array of alternating field/value C strings (e.g. { "X-Field", "value", NULL }) to add to the request, or NULL for none.
completion	The completion handler.
userData	User data passed through to completion.

Definition at line 196 of file RESTClient.c.

                                                     {
  requestAsync(self, HTTP_HEAD, url, NULL, headers, completion, userData);
}

init()

RESTClient * init

(

RESTClient *

self

)

Initializes this RESTClient with the shared URLSession.

Parameters

self	The RESTClient.

Returns

The initialized RESTClient, or NULL on error.

Definition at line 205 of file RESTClient.c.

                                          {
  return $(self, initWithSession, $$(URLSession, sharedInstance));
}

initWithSession()

RESTClient * initWithSession	(	RESTClient *	self,
		URLSession *	session
	)

Initializes this RESTClient with the specified URLSession.

Parameters

self	The RESTClient.
session	The URLSession.

Returns

The initialized RESTClient, or NULL on error.

Definition at line 213 of file RESTClient.c.

                                                                          {
 
  self = (RESTClient *) super(Object, self, init);
  if (self) {
    assert(session);
    self->session = retain(session);
  }
  return self;
}

options()

int options	(	RESTClient *	self,
		const char *	url,
		const char **	headers,
		Data **	data
	)

Synchronously performs an HTTP OPTIONS request.

Parameters

self	The RESTClient.
url	The URL string.
headers	A NULL-terminated array of alternating field/value C strings (e.g. { "X-Field", "value", NULL }) to add to the request, or NULL for none.
data	Optionally receives the retained response body. Caller must release.

Returns

The HTTP response status code, or 0 on connection failure.

Definition at line 227 of file RESTClient.c.

                                                                                         {
  return request(self, HTTP_OPTIONS, url, NULL, headers, data);
}

optionsAsync()

void optionsAsync	(	RESTClient *	self,
		const char *	url,
		const char **	headers,
		RESTClientCompletion	completion,
		void *	userData
	)

Asynchronously performs an HTTP OPTIONS request.

Parameters

self	The RESTClient.
url	The URL string.
headers	A NULL-terminated array of alternating field/value C strings (e.g. { "X-Field", "value", NULL }) to add to the request, or NULL for none.
completion	The completion handler.
userData	User data passed through to completion.

Definition at line 235 of file RESTClient.c.

                                                     {
  requestAsync(self, HTTP_OPTIONS, url, NULL, headers, completion, userData);
}

patch()

int patch	(	RESTClient *	self,
		const char *	url,
		const Data *	body,
		const char **	headers,
		Data **	data
	)

Synchronously performs an HTTP PATCH request.

Parameters

self	The RESTClient.
url	The URL string.
body	The request body, or NULL.
headers	A NULL-terminated array of alternating field/value C strings (e.g. { "X-Field", "value", NULL }) to add to the request, or NULL for none.
data	Optionally receives the retained response body. Caller must release.

Returns

The HTTP response status code, or 0 on connection failure.

Definition at line 244 of file RESTClient.c.

                                                                                                         {
  return request(self, HTTP_PATCH, url, body, headers, data);
}

patchAsync()

void patchAsync	(	RESTClient *	self,
		const char *	url,
		const Data *	body,
		const char **	headers,
		RESTClientCompletion	completion,
		void *	userData
	)

Asynchronously performs an HTTP PATCH request.

Parameters

self	The RESTClient.
url	The URL string.
body	The request body, or NULL.
headers	A NULL-terminated array of alternating field/value C strings (e.g. { "X-Field", "value", NULL }) to add to the request, or NULL for none.
completion	The completion handler.
userData	User data passed through to completion.

Definition at line 252 of file RESTClient.c.

                                                     {
  requestAsync(self, HTTP_PATCH, url, body, headers, completion, userData);
}

post()

int post	(	RESTClient *	self,
		const char *	url,
		const Data *	body,
		const char **	headers,
		Data **	data
	)

Synchronously performs an HTTP POST request.

Parameters

self	The RESTClient.
url	The URL string.
body	The request body, or NULL.
headers	A NULL-terminated array of alternating field/value C strings (e.g. { "X-Field", "value", NULL }) to add to the request, or NULL for none.
data	Optionally receives the retained response body. Caller must release.

Returns

The HTTP response status code, or 0 on connection failure.

Definition at line 261 of file RESTClient.c.

                                                                                                        {
  return request(self, HTTP_POST, url, body, headers, data);
}

postAsync()

void postAsync	(	RESTClient *	self,
		const char *	url,
		const Data *	body,
		const char **	headers,
		RESTClientCompletion	completion,
		void *	userData
	)

Asynchronously performs an HTTP POST request.

Parameters

self	The RESTClient.
url	The URL string.
body	The request body, or NULL.
headers	A NULL-terminated array of alternating field/value C strings (e.g. { "X-Field", "value", NULL }) to add to the request, or NULL for none.
completion	The completion handler.
userData	User data passed through to completion.

Definition at line 269 of file RESTClient.c.

                                                     {
  requestAsync(self, HTTP_POST, url, body, headers, completion, userData);
}

put()

int put	(	RESTClient *	self,
		const char *	url,
		const Data *	body,
		const char **	headers,
		Data **	data
	)

Synchronously performs an HTTP PUT request.

Parameters

self	The RESTClient.
url	The URL string.
body	The request body, or NULL.
headers	A NULL-terminated array of alternating field/value C strings (e.g. { "X-Field", "value", NULL }) to add to the request, or NULL for none.
data	Optionally receives the retained response body. Caller must release.

Returns

The HTTP response status code, or 0 on connection failure.

Definition at line 278 of file RESTClient.c.

                                                                                                       {
  return request(self, HTTP_PUT, url, body, headers, data);
}

putAsync()

void putAsync	(	RESTClient *	self,
		const char *	url,
		const Data *	body,
		const char **	headers,
		RESTClientCompletion	completion,
		void *	userData
	)

Asynchronously performs an HTTP PUT request.

Parameters

self	The RESTClient.
url	The URL string.
body	The request body, or NULL.
headers	A NULL-terminated array of alternating field/value C strings (e.g. { "X-Field", "value", NULL }) to add to the request, or NULL for none.
completion	The completion handler.
userData	User data passed through to completion.

Definition at line 286 of file RESTClient.c.

                                                     {
  requestAsync(self, HTTP_PUT, url, body, headers, completion, userData);
}

sharedInstance()

RESTClient * sharedInstance

(

void

)

Returns

The shared RESTClient instance, backed by the shared URLSession.

Definition at line 212 of file Log.c.

                                 {
 
  static Once once;
 
  do_once(&once, {
    _sharedInstance = $(alloc(Log), init);
  });
 
  return _sharedInstance;
}

---

The documentation for this struct was generated from the following files:

• Sources/Objectively/RESTClient.h
• Sources/Objectively/RESTClient.c