Hamster-Scripts: Functions (Hamster): News

News

HamNewsPull( <server-list> )
HamNewsPull

Starts the threads, which pull new articles from newsservers.

If <server-list> is omitted or set to an empty string (""), all NNTP-servers defined in Hamster will be used. Otherwise, transfer is restricted to the given servers.

If used, <server-list> has to consist of a semicolon-separated (";") list of servernames. The servernames have to be in the same format as displayed in the Hamster-settings (i.e. servername + "," + port), e.g.: "news.aaa.com,nntp;news.bbb.com,nntp"

Note: Starting with Hamster Vr. 1.3.19, this function was replaced with the NewsJobs*-functions described below and is only simulated internally with these new functions. See the example at "HamNewsJobsStart" for a replacement of this obsolete function.

Returns: 0=OK/Started, <>0=Not started

HamNewsPull
HamNewsPull( "one.newsserv.er,nntp;two.newsserv.er,nntp" )

HamNewsPost( <server-list> )
HamNewsPost

Starts the thread, which posts new articles (if any).

If <server-list> is omitted or set to an empty string (""), all NNTP-servers defined in Hamster may be used. Otherwise, transfer is restricted to the given servers.

If used, <server-list> has to consist of a semicolon-separated (";") list of servernames. The servernames have to be in the same format as displayed in the Hamster-settings (i.e. servername + "," + port), e.g.: "news.aaa.com,nntp;news.bbb.com,nntp"

Note: Starting with Hamster Vr. 1.3.19, this function was replaced with the NewsJobs*-functions described below and is only simulated internally with these new functions. See the example at "HamNewsJobsStart" for a replacement of this obsolete function.

Returns: 0=OK/Started, <>0=Not started

HamNewsPost
HamNewsPost( "one.newsserv.er,nntp;two.newsserv.er,nntp" )

HamNewsJobsClear

Clears the list of news-related jobs.

Returns: 0

HamNewsJobsClear

HamNewsJobsPullDef( <server-list> )
HamNewsJobsPullDef

Fills the list of news-related jobs with the pull-list of the given newsservers (i.e. one job for each group to pull from a server).

If <server-list> is omitted or set to an empty string (""), all groups of all NNTP-servers defined in Hamster will be added. Otherwise, only the groups for the given servers will be added.

If used, <server-list> has to consist of a semicolon-separated (";") list of servernames. The servernames have to be in the same format as displayed in the Hamster-settings (i.e. servername + "," + port), e.g.: "news.aaa.com,nntp;news.bbb.com,nntp"

Returns: <0: Error, >=0: Number of pull-jobs added

HamNewsJobsPullDef
HamNewsJobsPullDef( "one.newsserv.er,nntp;two.newsserv.er,nntp" )

HamNewsJobsPostDef( <server-list> )
HamNewsJobsPostDef

Fills the list of news-related jobs with post-jobs for the given newsservers (i.e. one job for each article waiting to be posted).

If <server-list> is omitted or set to an empty string (""), all NNTP-servers defined in Hamster may be used to post the article. Otherwise, transfer is restricted to one of the given servers.

If used, <server-list> has to consist of a semicolon-separated (";") list of servernames. The servernames have to be in the same format as displayed in the Hamster-settings (i.e. servername + "," + port), e.g.: "news.aaa.com,nntp;news.bbb.com,nntp"

Returns: <0: Error, >=0: Number of post-jobs added

HamNewsJobsPostDef
HamNewsJobsPostDef( "one.newsserv.er,nntp;two.newsserv.er,nntp" )

HamNewsJobsPull( <server>, <group-select> )
HamNewsJobsPull( <server> )

Fills the list of news-related jobs with the pull-list of the given newsserver <server>.

If <group-select> is given, only the groups matching this regular expression are added.

Returns: <0: Error, >=0: Number of pull-jobs added

HamNewsJobsPull( "one.newsserv.er" )
HamNewsJobsPull( "two.newsserv.er", "^alt\." )

HamNewsJobsPost( <server>, <group-select>, <header-select> )
HamNewsJobsPost( <server>, <group-select> )
HamNewsJobsPost( <server> )

Fills the list of news-related jobs with post-jobs for the given newsserver <server>.

If <group-select> is given and not empty, only articles with a newsgroup matching this regular expression are added.

If <header-select> is given, only articles with a header-line matching this regular expression are added.

Note: Hamster does not support "multiple injection", so once an article is added to the list, it is ignored in further assignments.

Note: Hamster only posts to servers, from which a group is also pulled, so regardless which selections you choose, the resulting server/group-combination has to be in Hamster's pull-list, too.

Returns: <0: Error, >=0: Number of post-jobs added

HamNewsJobsPost( "one.newsserv.er", ".*", "^X-Post-To: one.newsserv.er" )
HamNewsJobsPost( "two.newsserv.er", "^alt\." )
HamNewsJobsPost( "one.newsserv.er" )

HamNewsJobsFeed( <server>, <group-select> )
HamNewsJobsFeed( <server> )

Fills the list of news-related jobs with IHAVE-feed-jobs for the given newsserver <server>.

If <group-select> is given and not empty, only articles with a newsgroup matching this regular expression are added.

Returns: <0: Error, >=0: Number of feed-jobs added

HamNewsJobsFeed( "two.newsserv.er", "^hamster\." )
HamNewsJobsFeed( "one.newsserv.er" )

HamNewsJobsStart( <server-list> )
HamNewsJobsStart

Starts transfer-threads for the given servers that have pending news-jobs.

If <server-list> is omitted or set to an empty string (""), threads for all newsservers with pending news-jobs are started. Otherwise, only threads for the given servers are started.

If used, <server-list> has to consist of a semicolon-separated (";") list of servernames. The servernames have to be in the same format as displayed in the Hamster-settings (i.e. servername + "," + port), e.g.: "news.aaa.com,nntp;news.bbb.com,nntp"

Returns: <0: Error, >=0: Number of threads started

# replacement for HamNewsPost and HamNewsPull:
HamNewsJobsClear
HamNewsJobsPostDef
HamNewsJobsPullDef
HamNewsJobsStart

[www.elbiah.de Hamster Playground Documentation]