aboutsummaryrefslogtreecommitdiff
path: root/lib/cmyth
diff options
context:
space:
mode:
authorDavid Teirney <david@teirney.net>2012-06-19 22:55:22 +1200
committerDavid Teirney <david@teirney.net>2012-06-19 22:55:22 +1200
commitbe723245785680b6936a96f7c3d8daede7680ff2 (patch)
treebc53fd434b42229a9efdd3593c284e847fb81293 /lib/cmyth
parent12804fd65b581c06ebac03bd2c9d47b2692e7a39 (diff)
[libcmyth] Cosmetic: match upstream copyright statements and comments for methods.
Diffstat (limited to 'lib/cmyth')
-rw-r--r--lib/cmyth/include/cmyth/cmyth.h25
-rw-r--r--lib/cmyth/include/debug.h2
-rw-r--r--lib/cmyth/include/refmem/atomic.h19
-rw-r--r--lib/cmyth/include/refmem/refmem.h2
-rw-r--r--lib/cmyth/libcmyth/bookmark.c2
-rw-r--r--lib/cmyth/libcmyth/cmyth_local.h2
-rw-r--r--lib/cmyth/libcmyth/commbreak.c2
-rw-r--r--lib/cmyth/libcmyth/connection.c2
-rw-r--r--lib/cmyth/libcmyth/debug.c2
-rw-r--r--lib/cmyth/libcmyth/event.c2
-rw-r--r--lib/cmyth/libcmyth/file.c2
-rw-r--r--lib/cmyth/libcmyth/freespace.c2
-rw-r--r--lib/cmyth/libcmyth/keyframe.c2
-rw-r--r--lib/cmyth/libcmyth/livetv.c2
-rw-r--r--lib/cmyth/libcmyth/mysql_query.c2
-rw-r--r--lib/cmyth/libcmyth/mythtv_mysql.c2
-rw-r--r--lib/cmyth/libcmyth/posmap.c2
-rw-r--r--lib/cmyth/libcmyth/proginfo.c2
-rw-r--r--lib/cmyth/libcmyth/proglist.c2
-rw-r--r--lib/cmyth/libcmyth/rec_num.c2
-rw-r--r--lib/cmyth/libcmyth/recorder.c2
-rw-r--r--lib/cmyth/libcmyth/ringbuf.c2
-rw-r--r--lib/cmyth/libcmyth/safe_string.h2
-rw-r--r--lib/cmyth/libcmyth/socket.c2
-rw-r--r--lib/cmyth/libcmyth/timestamp.c2
25 files changed, 65 insertions, 25 deletions
diff --git a/lib/cmyth/include/cmyth/cmyth.h b/lib/cmyth/include/cmyth/cmyth.h
index c44078f0db..54e7fe5842 100644
--- a/lib/cmyth/include/cmyth/cmyth.h
+++ b/lib/cmyth/include/cmyth/cmyth.h
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2004-2006, Eric Lund, Jon Gettler
+ * Copyright (C) 2004-2012, Eric Lund, Jon Gettler
* http://www.mvpmc.org/
*
* This library is free software; you can redistribute it and/or
@@ -17,6 +17,22 @@
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
+/*! \mainpage cmyth
+ *
+ * cmyth is a library that provides a C language API to access and control
+ * a MythTV backend.
+ *
+ * \section projectweb Project website
+ * http://www.mvpmc.org/
+ *
+ * \section repos Source repositories
+ * http://git.mvpmc.org/
+ *
+ * \section libraries Libraries
+ * \li \link cmyth.h libcmyth \endlink
+ * \li \link refmem.h librefmem \endlink
+ */
+
/** \file cmyth.h
* A C library for communicating with a MythTV server.
*/
@@ -234,7 +250,7 @@ extern cmyth_conn_t cmyth_conn_connect_event(char *server,
unsigned buflen, int tcp_rcvbuf);
/**
- * Create a file connection to a backend.
+ * Create a file connection to a backend for reading a recording.
* \param prog program handle
* \param control control handle
* \param buflen buffer size for the connection to use
@@ -364,6 +380,11 @@ extern char * cmyth_conn_get_setting(cmyth_conn_t conn,
*/
extern cmyth_event_t cmyth_event_get(cmyth_conn_t conn, char * data, int len);
+/**
+ * Selects on the event socket, waiting for an event to show up.
+ * allows nonblocking access to events.
+ * \return <= 0 on failure
+ */
extern int cmyth_event_select(cmyth_conn_t conn, struct timeval *timeout);
/*
diff --git a/lib/cmyth/include/debug.h b/lib/cmyth/include/debug.h
index 72c863a0cf..805964b2e0 100644
--- a/lib/cmyth/include/debug.h
+++ b/lib/cmyth/include/debug.h
@@ -1,4 +1,4 @@
-/** \file mvp_debug.h
+/** \file debug.h
* A C library for generating and controlling debug output
*/
diff --git a/lib/cmyth/include/refmem/atomic.h b/lib/cmyth/include/refmem/atomic.h
index 71d9a6e339..5c107f5845 100644
--- a/lib/cmyth/include/refmem/atomic.h
+++ b/lib/cmyth/include/refmem/atomic.h
@@ -1,3 +1,22 @@
+/*
+ * Copyright (C) 2004-2008, Eric Lund, Jon Gettler
+ * http://www.mvpmc.org/
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 of the License, or (at your option) any later version.
+ *
+ * This library 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
+ */
+
#ifndef __MVP_ATOMIC_H
#define __MVP_ATOMIC_H
diff --git a/lib/cmyth/include/refmem/refmem.h b/lib/cmyth/include/refmem/refmem.h
index 7866469e26..cc8155cba4 100644
--- a/lib/cmyth/include/refmem/refmem.h
+++ b/lib/cmyth/include/refmem/refmem.h
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2004-2006, Eric Lund, Jon Gettler
+ * Copyright (C) 2004-2012, Eric Lund, Jon Gettler
* http://www.mvpmc.org/
*
* This library is free software; you can redistribute it and/or
diff --git a/lib/cmyth/libcmyth/bookmark.c b/lib/cmyth/libcmyth/bookmark.c
index 4681c2105d..466ccb275c 100644
--- a/lib/cmyth/libcmyth/bookmark.c
+++ b/lib/cmyth/libcmyth/bookmark.c
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2005-2006, Jon Gettler
+ * Copyright (C) 2005-2009, Jon Gettler
* http://www.mvpmc.org/
*
* This library is free software; you can redistribute it and/or
diff --git a/lib/cmyth/libcmyth/cmyth_local.h b/lib/cmyth/libcmyth/cmyth_local.h
index f7b85fb3ca..ef5f7c68aa 100644
--- a/lib/cmyth/libcmyth/cmyth_local.h
+++ b/lib/cmyth/libcmyth/cmyth_local.h
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2004-2006, Eric Lund, Jon Gettler
+ * Copyright (C) 2004-2012, Eric Lund, Jon Gettler
* http://www.mvpmc.org/
*
* This library is free software; you can redistribute it and/or
diff --git a/lib/cmyth/libcmyth/commbreak.c b/lib/cmyth/libcmyth/commbreak.c
index e66adf1a68..c04c5eb04c 100644
--- a/lib/cmyth/libcmyth/commbreak.c
+++ b/lib/cmyth/libcmyth/commbreak.c
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2005-2006, Jon Gettler
+ * Copyright (C) 2005-2012, Jon Gettler
* http://www.mvpmc.org/
*
* This library is free software; you can redistribute it and/or
diff --git a/lib/cmyth/libcmyth/connection.c b/lib/cmyth/libcmyth/connection.c
index 918c17fe70..85eddaee9b 100644
--- a/lib/cmyth/libcmyth/connection.c
+++ b/lib/cmyth/libcmyth/connection.c
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2004-2006, Eric Lund, Jon Gettler
+ * Copyright (C) 2004-2012, Eric Lund, Jon Gettler
* http://www.mvpmc.org/
*
* This library is free software; you can redistribute it and/or
diff --git a/lib/cmyth/libcmyth/debug.c b/lib/cmyth/libcmyth/debug.c
index 197801d5a6..3bb9db06ee 100644
--- a/lib/cmyth/libcmyth/debug.c
+++ b/lib/cmyth/libcmyth/debug.c
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2004-2006, Eric Lund
+ * Copyright (C) 2004-2009, Eric Lund
* http://www.mvpmc.org/
*
* This library is free software; you can redistribute it and/or
diff --git a/lib/cmyth/libcmyth/event.c b/lib/cmyth/libcmyth/event.c
index f340ac63be..2208c3e793 100644
--- a/lib/cmyth/libcmyth/event.c
+++ b/lib/cmyth/libcmyth/event.c
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2005-2006, Jon Gettler
+ * Copyright (C) 2005-2012, Jon Gettler
* http://www.mvpmc.org/
*
* This library is free software; you can redistribute it and/or
diff --git a/lib/cmyth/libcmyth/file.c b/lib/cmyth/libcmyth/file.c
index 640f29989a..516da03d59 100644
--- a/lib/cmyth/libcmyth/file.c
+++ b/lib/cmyth/libcmyth/file.c
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2004-2006, Eric Lund
+ * Copyright (C) 2004-2012, Eric Lund
* http://www.mvpmc.org/
*
* This library is free software; you can redistribute it and/or
diff --git a/lib/cmyth/libcmyth/freespace.c b/lib/cmyth/libcmyth/freespace.c
index d800f6842f..ca8e3c3b39 100644
--- a/lib/cmyth/libcmyth/freespace.c
+++ b/lib/cmyth/libcmyth/freespace.c
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2004-2006, Eric Lund
+ * Copyright (C) 2004-2010, Eric Lund
* http://www.mvpmc.org/
*
* This library is free software; you can redistribute it and/or
diff --git a/lib/cmyth/libcmyth/keyframe.c b/lib/cmyth/libcmyth/keyframe.c
index 380398640c..7117683ed7 100644
--- a/lib/cmyth/libcmyth/keyframe.c
+++ b/lib/cmyth/libcmyth/keyframe.c
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2004-2006, Eric Lund
+ * Copyright (C) 2004-2010, Eric Lund
* http://www.mvpmc.org/
*
* This library is free software; you can redistribute it and/or
diff --git a/lib/cmyth/libcmyth/livetv.c b/lib/cmyth/libcmyth/livetv.c
index 91c5620765..31ecb2a4fc 100644
--- a/lib/cmyth/libcmyth/livetv.c
+++ b/lib/cmyth/libcmyth/livetv.c
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2006, Sergio Slobodrian
+ * Copyright (C) 2006-2012, Sergio Slobodrian
* http://www.mvpmc.org/
*
* This library is free software; you can redistribute it and/or
diff --git a/lib/cmyth/libcmyth/mysql_query.c b/lib/cmyth/libcmyth/mysql_query.c
index 6370e134f6..ade4c5c638 100644
--- a/lib/cmyth/libcmyth/mysql_query.c
+++ b/lib/cmyth/libcmyth/mysql_query.c
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2006, Simon Hyde
+ * Copyright (C) 2006-2009, Simon Hyde
* http://www.mvpmc.org/
*
* This library is free software; you can redistribute it and/or
diff --git a/lib/cmyth/libcmyth/mythtv_mysql.c b/lib/cmyth/libcmyth/mythtv_mysql.c
index f23c8a187b..7077dc6390 100644
--- a/lib/cmyth/libcmyth/mythtv_mysql.c
+++ b/lib/cmyth/libcmyth/mythtv_mysql.c
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2004-2006, Eric Lund
+ * Copyright (C) 2004-2012, Eric Lund
* http://www.mvpmc.org/
*
* This library is free software; you can redistribute it and/or
diff --git a/lib/cmyth/libcmyth/posmap.c b/lib/cmyth/libcmyth/posmap.c
index e5ffc96c27..e6929e78c8 100644
--- a/lib/cmyth/libcmyth/posmap.c
+++ b/lib/cmyth/libcmyth/posmap.c
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2004-2006, Eric Lund
+ * Copyright (C) 2004-2010, Eric Lund
* http://www.mvpmc.org/
*
* This library is free software; you can redistribute it and/or
diff --git a/lib/cmyth/libcmyth/proginfo.c b/lib/cmyth/libcmyth/proginfo.c
index 24374aa00e..c249891ee6 100644
--- a/lib/cmyth/libcmyth/proginfo.c
+++ b/lib/cmyth/libcmyth/proginfo.c
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2004-2006, Eric Lund
+ * Copyright (C) 2004-2010, Eric Lund
* http://www.mvpmc.org/
*
* This library is free software; you can redistribute it and/or
diff --git a/lib/cmyth/libcmyth/proglist.c b/lib/cmyth/libcmyth/proglist.c
index fe7557728c..f6d12e27db 100644
--- a/lib/cmyth/libcmyth/proglist.c
+++ b/lib/cmyth/libcmyth/proglist.c
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2004-2006, Eric Lund
+ * Copyright (C) 2004-2010, Eric Lund
* http://www.mvpmc.org/
*
* This library is free software; you can redistribute it and/or
diff --git a/lib/cmyth/libcmyth/rec_num.c b/lib/cmyth/libcmyth/rec_num.c
index ee82f261e7..b78a64e4b0 100644
--- a/lib/cmyth/libcmyth/rec_num.c
+++ b/lib/cmyth/libcmyth/rec_num.c
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2004-2006, Eric Lund
+ * Copyright (C) 2004-2010, Eric Lund
* http://www.mvpmc.org/
*
* This library is free software; you can redistribute it and/or
diff --git a/lib/cmyth/libcmyth/recorder.c b/lib/cmyth/libcmyth/recorder.c
index b6bd987201..02a436b36d 100644
--- a/lib/cmyth/libcmyth/recorder.c
+++ b/lib/cmyth/libcmyth/recorder.c
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2004-2006, Eric Lund, Jon Gettler
+ * Copyright (C) 2004-2009, Eric Lund, Jon Gettler
* http://www.mvpmc.org/
*
* This library is free software; you can redistribute it and/or
diff --git a/lib/cmyth/libcmyth/ringbuf.c b/lib/cmyth/libcmyth/ringbuf.c
index 4279f85935..960f000b0e 100644
--- a/lib/cmyth/libcmyth/ringbuf.c
+++ b/lib/cmyth/libcmyth/ringbuf.c
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2004-2006, Eric Lund
+ * Copyright (C) 2004-2012, Eric Lund
* http://www.mvpmc.org/
*
* This library is free software; you can redistribute it and/or
diff --git a/lib/cmyth/libcmyth/safe_string.h b/lib/cmyth/libcmyth/safe_string.h
index 35dd1be4c6..8110ef658b 100644
--- a/lib/cmyth/libcmyth/safe_string.h
+++ b/lib/cmyth/libcmyth/safe_string.h
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2006, Simon Hyde
+ * Copyright (C) 2006-2009, Simon Hyde
* http://www.mvpmc.org/
*
* This library is free software; you can redistribute it and/or
diff --git a/lib/cmyth/libcmyth/socket.c b/lib/cmyth/libcmyth/socket.c
index 552b88d696..bc5e6d066c 100644
--- a/lib/cmyth/libcmyth/socket.c
+++ b/lib/cmyth/libcmyth/socket.c
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2004-2006, Eric Lund
+ * Copyright (C) 2004-2012, Eric Lund
* http://www.mvpmc.org/
*
* This library is free software; you can redistribute it and/or
diff --git a/lib/cmyth/libcmyth/timestamp.c b/lib/cmyth/libcmyth/timestamp.c
index 43e94c5bbd..02d1b84678 100644
--- a/lib/cmyth/libcmyth/timestamp.c
+++ b/lib/cmyth/libcmyth/timestamp.c
@@ -1,5 +1,5 @@
/*
- * Copyright (C) 2004-2006, Eric Lund
+ * Copyright (C) 2004-2010, Eric Lund
* http://www.mvpmc.org/
*
* This library is free software; you can redistribute it and/or