ajhttp.c

Function ajHttpGetProxyinfo

Returns a proxy definition (if any). Any proxy string given as an argument overrides any EMBOSS_PROXY definition. This allows strings from DB definitions to override such an envvar.

Prototype

AjBool ajHttpGetProxyinfo (
      const AjPStr dbproxy,
      ajint* proxyport,
      AjPStr* proxyname,
      AjPStr* proxyauth,
      AjPStr* proxycreds
);

Type Name Read/Write Description

const AjPStr dbproxy Input Primary proxy string (if any)

ajint* proxyport Output Proxy port

AjPStr* proxyname Output Proxy name

AjPStr* proxyauth Output Proxy authentication type (if any)

AjPStr* proxycreds Output Proxy auth credentials (if any)

AjBool RETURN ajTrue if a proxy was defined

Type	Name	Read/Write	Description
`const AjPStr`	`dbproxy`	Input	Primary proxy string (if any)
`ajint*`	`proxyport`	Output	Proxy port
`AjPStr*`	`proxyname`	Output	Proxy name
`AjPStr*`	`proxyauth`	Output	Proxy authentication type (if any)
`AjPStr*`	`proxycreds`	Output	Proxy auth credentials (if any)
`AjBool`		RETURN	ajTrue if a proxy was defined

From EMBOSS 6.4.0

Function ajHttpGetVersion

Returns the HTTP version. Any supplied version takes precedence over an EMBOSS_HTTPVERSION definition so allowing DB entries to override such a setting.

Prototype

AjBool ajHttpGetVersion (
      const AjPStr version,
      AjPStr* httpver
);

Type Name Read/Write Description

const AjPStr version Input Version or NULL (or zero-length string)

AjPStr* httpver Output HTTP version

AjBool RETURN ajTrue if a version was defined

Type	Name	Read/Write	Description
`const AjPStr`	`version`	Input	Version or NULL (or zero-length string)
`AjPStr*`	`httpver`	Output	HTTP version
`AjBool`		RETURN	ajTrue if a version was defined

From EMBOSS 6.4.0

Function ajHttpOpen

Opens an HTTP connection

Prototype

FILE* ajHttpOpen (
      const AjPStr dbname,
      const AjPStr host,
      ajint iport,
      const AjPStr get,
      struct AJSOCKET* Psock
);

Type Name Read/Write Description

const AjPStr dbname Input Database name (for error reporting)

const AjPStr host Input Host name

ajint iport Input Port

const AjPStr get Input GET string

struct AJSOCKET* Psock Modify Socket returned to caller

FILE* RETURN Open file on success, NULL on failure

Type	Name	Read/Write	Description
`const AjPStr`	`dbname`	Input	Database name (for error reporting)
`const AjPStr`	`host`	Input	Host name
`ajint`	`iport`	Input	Port
`const AjPStr`	`get`	Input	GET string
`struct AJSOCKET*`	`Psock`	Modify	Socket returned to caller
`FILE*`		RETURN	Open file on success, NULL on failure

From EMBOSS 6.4.0

Function ajHttpOpenProxy

Opens an HTTP connection via a proxy

Prototype

FILE* ajHttpOpenProxy (
      const AjPStr dbname,
      const AjPStr proxyname,
      ajint proxyport,
      const AjPStr proxyauth,
      const AjPStr proxycreds,
      const AjPStr host,
      ajint iport,
      const AjPStr get,
      struct AJSOCKET* Psock
);

Type Name Read/Write Description

const AjPStr dbname Input Databse name (for error reporting)

const AjPStr proxyname Input Proxy name

ajint proxyport Input Proxy port

const AjPStr proxyauth Input Proxy auth type (if any)

const AjPStr proxycreds Input Proxy auth credentials (if any)

const AjPStr host Input Host name

ajint iport Input Port

const AjPStr get Input GET string

struct AJSOCKET* Psock Modify Socket returned to caller

FILE* RETURN Open file on success, NULL on failure

Type	Name	Read/Write	Description
`const AjPStr`	`dbname`	Input	Databse name (for error reporting)
`const AjPStr`	`proxyname`	Input	Proxy name
`ajint`	`proxyport`	Input	Proxy port
`const AjPStr`	`proxyauth`	Input	Proxy auth type (if any)
`const AjPStr`	`proxycreds`	Input	Proxy auth credentials (if any)
`const AjPStr`	`host`	Input	Host name
`ajint`	`iport`	Input	Port
`const AjPStr`	`get`	Input	GET string
`struct AJSOCKET*`	`Psock`	Modify	Socket returned to caller
`FILE*`		RETURN	Open file on success, NULL on failure

From EMBOSS 6.4.0

Function ajHttpUrlrefNew

Initialise a URL components object

Prototype

AjPUrlref ajHttpUrlrefNew (
      void
);

Type Name Read/Write Description

AjPUrlref RETURN URL Components

Type	Name	Read/Write	Description
`AjPUrlref`		RETURN	URL Components

From EMBOSS 6.4.0

Function ajHttpUrlrefDel

Delete URL components object

Prototype

void ajHttpUrlrefDel (
      AjPUrlref* thys
);

Type Name Read/Write Description

AjPUrlref* thys Modify URL components object

void RETURN

Type	Name	Read/Write	Description
`AjPUrlref*`	`thys`	Modify	URL components object
`void`		RETURN

From EMBOSS 6.4.0

Function ajHttpUrlrefParseC

Parse an IPV4/6 URL into its components

Prototype

void ajHttpUrlrefParseC (
      AjPUrlref* parts,
      const char* url
);

Type Name Read/Write Description

AjPUrlref* parts Modify URL components object

const char* url Modify URL

void RETURN

Type	Name	Read/Write	Description
`AjPUrlref*`	`parts`	Modify	URL components object
`const char*`	`url`	Modify	URL
`void`		RETURN

From EMBOSS 6.4.0

Function ajHttpUrlrefSplitPort

Separate any port from a host specification (IPV4/6)

Prototype

void ajHttpUrlrefSplitPort (
      AjPUrlref urli
);

Type Name Read/Write Description

AjPUrlref urli Modify URL components object

void RETURN

Type	Name	Read/Write	Description
`AjPUrlref`	`urli`	Modify	URL components object
`void`		RETURN

From EMBOSS 6.4.0

Function ajHttpUrlrefSplitUsername

Separate any username[:password] from a host specification (IPV4/6)

Prototype

void ajHttpUrlrefSplitUsername (
      AjPUrlref urli
);

Type Name Read/Write Description

AjPUrlref urli Modify URL components object

void RETURN

Type	Name	Read/Write	Description
`AjPUrlref`	`urli`	Modify	URL components object
`void`		RETURN

From EMBOSS 6.4.0

Function ajHttpQueryUrl

Returns the components of a URL (IPV4/6) An equivalent for seqHttpUrl().

Prototype

AjBool ajHttpQueryUrl (
      const AjPQuery qry,
      ajint* iport,
      AjPStr* host,
      AjPStr* urlget
);

Type Name Read/Write Description

const AjPQuery qry Input Database query

ajint* iport Output Port

AjPStr* host Output Host name

AjPStr* urlget Output URL for the HTTP header GET

AjBool RETURN ajTrue if the URL was parsed

Type	Name	Read/Write	Description
`const AjPQuery`	`qry`	Input	Database query
`ajint*`	`iport`	Output	Port
`AjPStr*`	`host`	Output	Host name
`AjPStr*`	`urlget`	Output	URL for the HTTP header GET
`AjBool`		RETURN	ajTrue if the URL was parsed

From EMBOSS 6.4.0

Function ajHttpUrlDeconstruct

Deconstruct a URL (IPV4/6)

Prototype

void ajHttpUrlDeconstruct (
      const AjPStr url,
      ajint* iport,
      AjPStr* host,
      AjPStr* urlget
);

Type Name Read/Write Description

const AjPStr url Input url

ajint* iport Output Port

AjPStr* host Output Host name

AjPStr* urlget Output URL for the HTTP header GET

void RETURN

Type	Name	Read/Write	Description
`const AjPStr`	`url`	Input	url
`ajint*`	`iport`	Output	Port
`AjPStr*`	`host`	Output	Host name
`AjPStr*`	`urlget`	Output	URL for the HTTP header GET
`void`		RETURN

From EMBOSS 6.4.0

Function ajHttpRedirect

Reads the header of http response in given buffer buff, if it includes a redirection response updates the host, port and get parameters using the 'Location' header

Prototype

AjBool ajHttpRedirect (
      AjPFilebuff buff,
      AjPStr* host,
      ajint* port,
      AjPStr* path
);

Type Name Read/Write Description

AjPFilebuff buff Modify file buffer

AjPStr* host Output Host name

ajint* port Output Port

AjPStr* path Output part of URL after port number

AjBool RETURN returns true if the header includes a redirection response

Type	Name	Read/Write	Description
`AjPFilebuff`	`buff`	Modify	file buffer
`AjPStr*`	`host`	Output	Host name
`ajint*`	`port`	Output	Port
`AjPStr*`	`path`	Output	part of URL after port number
`AjBool`		RETURN	returns true if the header includes a redirection response

From EMBOSS 6.4.0

Function ajHttpRead

Reads the header of http response in given buffer buff, if it includes a redirection response updates the host, port and get parameters using the 'Location' header

Prototype

AjPFilebuff ajHttpRead (
      const AjPStr dbhttpver,
      const AjPStr dbname,
      const AjPStr dbproxy,
      const AjPStr host,
      ajint port,
      const AjPStr dbpath
);

Type Name Read/Write Description

const AjPStr dbhttpver Input DB http version

const AjPStr dbname Input DB name

const AjPStr dbproxy Input DB proxy

const AjPStr host Input Host name

ajint port Input Port

const AjPStr dbpath Input part of URL after port number

AjPFilebuff RETURN http response

Type	Name	Read/Write	Description
`const AjPStr`	`dbhttpver`	Input	DB http version
`const AjPStr`	`dbname`	Input	DB name
`const AjPStr`	`dbproxy`	Input	DB proxy
`const AjPStr`	`host`	Input	Host name
`ajint`	`port`	Input	Port
`const AjPStr`	`dbpath`	Input	part of URL after port number
`AjPFilebuff`		RETURN	http response

From EMBOSS 6.4.0